Skip to main content

7-2 共通の関数

Universal Connect/Xで指定できる一般的な関数と、指定方法について説明します。

各引数の詳細は『SVF Java PRODUCTS API関数 リファレンスマニュアル』の「3-2 共通関数」を参照してください。

関数名

機能

SVF Cloud連携時の使用可否

VrSetDocName2

スプール文書名の指定

12517642_12517953.png

VrSetUserName

ユーザー名の指定

12517642_12517953.png

VrSetForm

XML様式ファイルの指定

12517642_12517953.png

VrSetPrinter

出力先の指定

12517642_12517953.png

VrAdjustd2

印字位置調整(ドット単位)の設定

12517642_12517953.png

VrAdjustm2

印字位置調整(1/10ミリ単位)の設定

12517642_12517953.png

VrSetCalcMode

10進演算ライブラリサポートの指定

12517642_12517953.png

OutputSpoolMode

スプールモードの指定

12517642_12518003.png

VrSetSpoolFileName2

出力ファイル名の指定

12517642_12517953.png

VrCopy

出力部数の指定

12517642_12517953.png

VrSetLocale

SVFロケールの指定

12517642_12517953.png

SvfEncode

SVFエンコーディングの指定

12517642_12517953.png

SetSchema

複数コマンド使用時の固定長スキーマの指定

12517642_12518003.png

VrComout=ALNK n

自動リンクフィールドの動作方式の設定

12517642_12517953.png

VrComout=REDU n

拡大縮小モードの指定

12517642_12517953.png

VrSetDocName2

機能

スプール文書名の指定

関数

  • CSV

    VrSetDocName2=name

  • XML

    <document name="name">

引数

  • name

    文書名

説明

スプールする文書データに文書名を指定します。

また、SVF for PDFで作成されたPDF文書のプロパティにタイトルを指定します。

invoiceAgent 文書管理にアーカイブする場合は、帳票のファイル名(拡張子を含まない)を指定します。

使用例

  • CSV

    VrSetDocName2=仕訳日記帳

  • XML

    <document name="仕訳日記帳">

VrSetUserName

機能

ユーザー名の指定

関数

  • CSV

    VrSetUserName=user

  • XML

    <document username="user">

引数

  • user

    ユーザー名

説明

スプールする文書データにユーザー名を指定します。

使用例

  • CSV

    VrSetUserName=Wingarc

  • XML

    <document username="Wingarc">

VrSetForm

機能

XML様式ファイルの指定

関数

  • CSV

    VrSetForm=XMLName,mode

  • XML

    <form file="XMLName" mode="mode">

引数

  • XMLName

    XML様式ファイル名(パス名は省略可)

  • mode

    • 4: ソートしない

    • 5: ソートする

説明

動作設定で指定されているXML様式ファイル名の設定ではなく、ここで指定されたXMLNameで実行します。パス名を省略する場合の参照先は、[実行様式ファイル検索パス]の設定に従います。

[実行様式ファイル検索パス]の設定方法については、「4-3-1 [ジョブ]の操作と設定」の 「実行様式ファイル検索パス]」を参照してください。

また、modeは動作設定画面の出力モードの設定で、4か5のどちらかを指定します。4の場合は「ソートしない」、5の場合は「ソートする」で設定されます。

使用例

  • CSV

    VrSetForm=c:¥svf¥sample_ja.xml,5

  • XML

    <form file="c:¥svf¥sample_ja.xml" mode="5">

VrSetPrinter

機能

出力先の指定

関数

  • CSV

    VrSetPrinter=printer,port

  • XML

    <document printer="printer" port="port">

引数

  • printer

    プリンター機種名

  • port

    プリンター名

説明

動作設定で指定されている出力先の設定ではなく、ここで指定されたprinter(プリンター機種名)とport(プリンター名)に出力します。「printer」は指定しなくても「port」から自動設定されますので、通常指定する必要はありません。

使用例

  • CSV

    VrSetPrinter=,PDF

  • XML

    <document printer="" port="PDF">

注意

印刷実行とファイル出力をこの関数で切り替えて行う場合は、必ず「OutputSpoolMode(CSV)、outputspoolmode(XML)」を併用するか、動作設定で[スプールモード]を「環境設定に従う」に設定してください。また、ファイルを作成する場所やファイル名を指定したい場合は、「VrSetSpoolFileName2(CSV)、file(XML)」を併用してください。

VrAdjustd2

機能

印字位置調整(ドット単位)の設定

関数

  • CSV

    VrAdjustd2=x,y

  • XML

    <form adjustd2="x,y">

引数

  • x

    左右調整値(正=右方向、負=左方向)

  • y

    上下調整値(正=下方向、負=上方向)

説明

印字位置をドット単位で移動します。設定値は、印刷実行処理の1要求時の間だけ有効です。

使用例

  • CSV

    VrAdjustd2=10,15

  • XML

    <form adjustd2="10,15">

VrAdjustm2

機能

印字位置調整(1/10ミリ単位)の設定

関数

  • CSV

    VrAdjustm2=x,y

  • XML

    <form adjustm2="x,y">

引数

  • x

    左右調整値(正=右方向、負=左方向)

  • y

    上下調整値(正=下方向、負=上方向)

説明

印字位置を1/10ミリ単位で移動します。設定値は、印刷実行処理の1要求時の間だけ有効です。

使用例

  • CSV

    VrAdjustm2=10,15

  • XML

    <form adjustm2="10,15">

VrSetCalcMode

機能

10進演算ライブラリサポートの指定

関数

  • CSV

    VrSetCalcMode=mode

  • XML

    <form calc="mode">

引数

  • mode

    • 0: DOUBLE型演算(デフォルト)

    • 1: 多倍精度10進浮動小数点型演算

説明

15桁以上の数値データを扱う場合に指定します。この関数を使用することで、最大33バイトの数値データを演算できます。

使用例

  • CSV

    VrSetCalcMode=1

  • XML

    <form calc="1">

OutputSpoolMode

機能

スプールモードの指定

関数

  • CSV

    OutputSpoolMode=mode

  • XML

    <document outputspoolmode="mode">

引数

  • mode

    • 1: 印刷を行う

    • 2: ファイル出力を行う

    • 3: 圧縮してファイル出力を行う

    • 4: 環境設定に従う

説明

環境設定上で指定されているスプールモードの設定ではなく、ここで指定されたスプールモードに従って出力します。

使用例

  • CSV

    OutputSpoolMode=3

  • XML

    <document outputspoolmode="3">

注意

  • SVF for Web/Clientを利用している場合は、この関数を指定してファイル圧縮をするか、動作設定で[スプールモード]を[ファイルを圧縮して出力する]に設定してください。

  • ファイル出力するプリンター機種を選択している場合は、[印刷する]に指定をしても動作しません。

VrSetSpoolFileName2

機能

出力ファイル名の指定

関数

  • CSV

    VrSetSpoolFileName2=PDFFileName

  • XML

    <document file="PDFFileName">

引数

  • PDFFileName

    作成するファイル名およびパス

説明

動作設定で指定されている出力ファイル名ではなく、ここで指定されたPDFFileNameでファイルを作成します。

使用例

  • CSV

    VrSetSpoolFileName2=c:¥svf¥abc.pdf

  • XML

    <document file="c:¥svf¥abc.pdf">

注意

  • パスを指定せず、ファイル名のみを指定した場合には、データファイルが存在しているディレクトリにファイルが作成されます。

  • ファイル出力処理以外のJOBを実行する場合は、使用できません。

VrCopy

機能

出力部数の指定

関数

  • CSV

    VrCopy=n

  • XML

    <form copies="n">

引数

  • n

    部数

説明

同一ページを指定した部数印刷します。

使用例

  • CSV

    VrCopy=5

  • XML

    <form copies="5">

注意

部数を指定していないにもかかわらず同じページが何枚も出力されてしまう場合には、デバイスのパネルからステータスシートを出力し、「コピー枚数」や「印刷部数」などの項目を確認してください。複数枚指定されていると、その枚数分出力されます。

VrSetLocale

機能

SVFロケールの指定

関数

  • CSV

    VrSetLocale=locale

  • XML

    <form svflocale="locale">

引数

  • locale

    SVFが対応しているロケールを指定します。

説明

動作設定で指定した「SVFロケール」の設定を変更する場合に使用します。指定可能なロケールは、『SVF Java PRODUCTS API関数 リファレンスマニュアル』の「3-2 共通関数」を参照してください。

使用例

  • CSV

    VrSetLocale=ja

  • XML

    <form svflocale="ja">

SvfEncode

機能

SVFエンコーディングの指定

関数

  • CSV

    SvfEncode=encode

  • XML

    <form svfencode="encode">

引数

  • encode

    エンコーディング

説明

動作設定で定義した「SVFエンコーディング」の設定を変更する場合に使用します。

使用例

  • CSV

    SvfEncode=MS932

  • XML

    <form svfencode="MS932">

SetSchema

機能

複数コマンド使用時の固定長スキーマの指定

関数

  • CSV

    SetSchema=schema

引数

  • schema

    スキーマファイル内のデータファイル定義名

説明

複数コマンドが埋め込まれた固定長ファイルのスキーマ情報を指定します。

使用例

  • CSV

    SetSchema=abc.csv

注意

  • 指定したデータファイルディレクトリのschema.iniを使用する必要があります。

  • 動作設定で[ファイル定義]に /*FLD*/ を指定し、[CSV 複数コマンド処理モード]にチェックを付けてください。

VrComout=ALNK n

機能

自動リンクフィールドの動作方式の設定

関数

  • CSV

    VrComout=ALNK parameter

  • XML

    <document vrcomout="ALNK parameter">

引数

  • n

    自動リンクフィールドの動作方式

説明

自動リンクフィールドの動作方式を設定します。詳細は『SVF Java PRODUCTS API関数 リファレンスマニュアル』の「3-2 共通関数」を参照してください。

使用例

  • CSV

    VrComout=ALNK 3

  • XML

    <document vrcomout="ALNK 3">

VrComout=REDU n

機能

拡大縮小モードの指定

関数

  • CSV

    VrComout=REDU parameter

  • XML

    <document vrcomout="REDU parameter">

引数

  • n

    出力する用紙サイズを指定します。ここで指定したサイズに拡大、あるいは縮小されて出力されます。

    0

    拡大/縮小しない

    1

    はがき

    2

    A5

    3

    A4

    4

    A3

    5

    B5

    6

    B4

    7

    レター

説明

出力先に対し、拡大縮小モードを設定します。詳細は『SVF Java PRODUCTS API関数 リファレンスマニュアル』の「3-2 共通関数」を参照してください。

使用例

  • CSV

    VrComout=REDU 3

  • XML

    <document vrcomout="REDU 3">