6-4 オプションで指定できるパラメーター値

ここでは、オプションで指定できるパラメーター値について、説明します。

パラメーター名 説明
FormName[n]= [XML様式ファイル名の指定] XML様式ファイル名を指定します。
FormMode= [XML様式ファイルのモードの指定] XML様式ファイルのモードを指定します。
XML様式ファイルのフィールド名= [印字する文字列] パラメーターとして固定した値をXML様式ファイルへ渡す場合に使用します。
NODATA_MSG= / NODATA_FIELD= [NoDataMessage データ行なし表示] クエリーの結果でデータ行がない場合に、このパラメーターを指定することにより印刷エラーとせずに、フォーム上に指定された文字列を出力します。
QueryName[n]= [クエリー様式ファイル名の指定] クエリー様式ファイル名を指定します。
DBQ= [データベース接続文字列] データベース接続文字列を指定します。
{パラメーター名}= 値[クエリー接続用パラメーター] THIN接続用パラメーターとしてホスト名、ポート番号、インスタンス名、またはサービス名など、接続に必要な情報を指定します。
UID= [データベースに接続する際のユーザーIDの指定] OracleデータベースへのユーザーIDを指定します。
PWD= [データベースに接続する際のパスワードの指定] Oracleデータベースへのパスワードを指定します。
Condition=[抽出条件の指定] Query Designerで指定した抽出条件に追加で条件を指定したい場合に、使用します。
[型|変数名]=値 [抽出条件の指定:変数名] SVFX-Designerで抽出条件に変数名を指定したクエリーを作成した場合に、使用します。
PRE_PROC= [前処理プロシージャ] パラメーター入手後、SVF実行前にRunさせるSQLプロシージャ名を、指定します。
POST_PROC= [後処理プロシージャ] パラメーター入手後、SVFで実行されるクエリーのデータ取得後にRunさせるSQLプロシージャ名を、指定します。
-t [タイムアウト値の設定] タイムアウト値を設定する場合に使用します。
-p [ポート番号の変更] ポート番号を変更することによって、接続する待ち受けプログラムを変更できます。
-k [キープアライブ値の設定] アプリケーションの終了待ちの間、動作確認パケットを交換しSVF側が動作していることを確認する間隔を分単位で指定します。
Port= [プリンター名] Java環境設定で作成したプリンター名で指定します。
Copies= [複写枚数] 印刷部数を指定します。
PageMask= [印字綴りページ番号の指定] 綴りを複数ページ指定しているXML様式ファイルで、印字対象とする綴りページを指定します。
AdjustmX/AdjustmY= [印字位置調整 0.1mm単位] 印字位置を調整します。
CalcMode= [計算モード] 最大33桁(整数部+小数部)の十進数演算ライブラリをサポートします。
ENCODING= [エンコーディング] エンコーディングを指定します。
LOCALE= [ロケール] ロケールを指定します。
FILE_ENCODING= [パラメーターファイルのエンコーディング] パラメーターファイルのエンコーディングを指定します。

FormName[n]= [XML様式ファイル名の指定]

XML様式ファイル名を指定します。

設定例1
  • パラメーターの名前 XML様式ファイル
  • パラメーターの値 FormName=seikyu.xml
設定例2

1つのコンカレントプログラムから複数のXML様式ファイル名を使用して印刷する場合
XML様式ファイル(n個目)FormName[n]=XML様式ファイル名

  • パラメーターの名前 XML様式ファイル2
  • パラメーターの値 FormName2=seikyu.xml
  • パラメーターの名前 XML様式ファイル3
  • パラメーターの値 FormName3=mitumori.xml

FormMode= [XML様式ファイルのモードの指定]

XML様式ファイルのモードを指定します。XML様式ファイルで指定したフィールドのキー順にソートするか、しないかを指定します。初期設定では、「Mode5」のソートが設定されています。

  • Mode4 ソートしません
  • Mode5 ソートします
設定例
  • パラメーターの名前 XML様式ファイルのモード指定
  • パラメーターの値 FormMode= 4


モードの詳細については、『SVF Java PRODUCTS API関数リファレンスマニュアル』の「VrSetForm」の項を参照してください。

XML様式ファイルのフィールド名= [印字する文字列]

パラメーターとして固定した値をXML様式ファイルへ渡す場合に使用します。

設定例

パラメーターの名前 印字する文字列

  • パラメーターの値 [YOTEI]=04/01
  • パラメーターの値 [NAMAE]=ORACLE
参考

XML様式ファイルに指定したフィールド名がない場合は、無効です。

NODATA_MSG= / NODATA_FIELD= [NoDataMessage データ行なし表示]

通常、クエリーの結果でデータ行がない場合は、画面に「印刷エラー[-554]」と表示されますが、このパラメーターを指定することにより印刷エラーとせずに、フォーム上に指定された文字列を出力して印刷します。

  • NODATA_MSG=で文字列を指定し、かつNODATA_FIELD=でフィールド名を指定します。NODATA_FIELD=で指定したフィールド名に対し、NODATA_MSG=で指定した文字列を印刷します。
  • NODATA_MSG=で文字列を指定しない場合は帳票を印刷して正常終了します。
  • NODATA_MSG=PARAMと指定した場合は、コンカレントで指定したパラメーターすべてをNODATA_FIELD=フィールド名で指定されたフィールドへ印刷します。
設定例
  • パラメーターの名前 NODATA_MSG
  • パラメーターの値 NODATA_MSG=PARAM
  • パラメーターの値 NODATA_MSG=対象データがありません
  • パラメーターの名前 NODATA_FIELD
  • パラメーターの値 NODATA_FIELD=備考

QueryName[n]= [クエリー様式ファイル名の指定]

クエリー様式ファイル名を指定します。

設定例1
  • パラメーターの名前 クエリー様式ファイル
  • パラメーターの値 QueryName=seikyu.vrq
設定例2

1つのコンカレントプログラムから複数のクエリー様式ファイル名を使用して印刷する場合
クエリー様式ファイル(n個目) QueryName[n]=クエリー様式ファイル名

  • パラメーターの名前 クエリー様式ファイル2
  • パラメーターの値 QueryName2=seikyu.vrq
  • パラメーターの名前 クエリー様式ファイル3
  • パラメーターの値 QueryName3=mitumori.xml

DBQ= [データベース接続文字列]

データベース接続文字列を指定します。クエリー様式ファイルを設計したコンピューターと印刷実行コンピューターでデータベース接続文字列が異なる場合に使用します。
SVF for Oracle E-Business Suite/Java Editionからvfreport.properties.*ファイル内の情報を利用してDB接続する場合、パラメーターの設定方法については、「クエリー接続用パラメーター」の項を参照してください。

設定例

OCI接続時

  • パラメーターの名前 データベース接続文字列の指定
  • パラメーターの値 DBQ=Wingarc

THIN接続時

  • パラメーターの名前 接続サーバー名の指定
  • パラメーターの値 DBQ=10.17.100.221

{パラメーター名}= 値[クエリー接続用パラメーター]

OCIは任意のネットサービス名で接続します。サービス名は「Net8 Configuration Assistant」という管理ツールによって設定されます。一方、THINではそうした管理は一切行われません。そのため、ホスト名、ポート番号、インスタンス名、またはサービス名など、接続に必要な情報を明確に指定する必要があります。

{$KIND}=パラメーターを指定した場合には、VRQファイル内の接続情報ではなく、SVF環境設定ファイル(vfreport.properties.*ファイル内)の情報を利用して、DBへの接続します。

vfreport.properties.*ファイルでTHIN接続の設定をするには、以下の設定が必要です。
接続するサーバーのサーバー名(IPアドレス)、リスンポート番号とサービス名(インスタンス名)のデフォルト値を設定します。

Query.Driver.ORCL.THIN=...(省略)...DBQ=localhost,PORT=1521,SID=ORCL...(省略)...

DBQ 接続サーバー名(IPアドレス)
PORT ポート番号(標準は1521)
SID サービス名(インスタンス名)を設定(標準はORCL)

設定例
  • パラメーターの名前 接続サーバーの指定
  • パラメーターの値 DBQ=10.17.100.221
  • パラメーターの名前 THINドライバーの選択
  • パラメーターの値 {$KIND}=ORCL.THIN
  • パラメーターの名前 ポート番号の設定
  • パラメーターの値 {PORT}=1521
  • パラメーターの名前 SIDの設定
  • パラメーターの値 {SID}=ORCL

THIN接続する際の設定方法の詳細については、『SVF Java PRODUCTS API関数リファレンスマニュアル』の「VrSetQuery」の項を参照してください。
また、各パラメーターは、svfoa.def内でデフォルトパラメーター定義として、またはparam.txt内でパラメーターテキスト定義としても指定できます。設定方法の詳細については、「6-6 パラメーターテキストの使用方法」および「6-7 デフォルトパラメーターの定義」を参照してください。

注意
  • THIN接続する場合、DBサーバーとJDBCドライバーのDB対応バージョンがあっている必要があります。マイナーバージョンを含め、正確にバージョンをあわせてください。使用するJDBCドライバーは、接続するOracleサーバーのセットアップ時に使用したメディアに含まれているものを推奨します。オラクル社のホームページなどからダウンロードする場合は、対応DBバージョンについて十分な注意が必要です。
  • {}が特殊記号として通らない場合は、「¥」を付加すると認識できます。
  • 実行時に利用するJavaVMのバージョンによって、利用可能なJDBCドライバーファイルが異なります。必ず、オラクル社が推奨している組み合わせとなるJDBCドライバーファイルを使用してください。


vfreport.properties.*ファイルでOCI接続の設定をするには、以下の設定が必要です。

Query.Driver.ORCL.OCI8=0,2,oracle.jdbc.driver.OracleDriver,jdbc:oracle:oci8:@{0},DBQ,DSN

DBQ データベース接続文字列の指定

設定例
  • パラメーターの名前 データベース接続文字列の指定
  • パラメーターの値 DBQ=WingArc
  • パラメーターの名前 OCI接続ドライバーの選択
  • パラメーターの値 {$KIND}=ORCL.OCI8

UID= [データベースに接続する際のユーザーIDの指定]

OracleデータベースへのユーザーIDを指定します。初期設定を変更する場合は、指定してください。

設定例

UID=scott

PWD= [データベースに接続する際のパスワードの指定]

Oracleデータベースへのパスワードを指定します。初期設定を変更する場合は、指定してください。

設定例

PWD=tiger

Condition= [抽出条件の指定]

Query Designerで指定した抽出条件に追加で条件を指定したい場合に、使用します。

  • パラメーターの値 Condition=[DBテーブル名].DB列名=値
  • パラメーターの値 Condition=[DBテーブル名].DB列名 between 値1 and 値2

注意事項

  • [DBテーブル名]は、同じ列名がある場合に記述が必要です。
  • Condition=で指定されたパラメーターは、実行時にSQL文のWHERE句の部分に設定されるため、WHERE句で指定可能な構文である必要があります。
  • Condition=で指定されたパラメーターは、設計時に指定された条件にAND条件として追加されます。
    複数の条件を追加する場合には、それぞれの条件をAND、またはORで連結してまとめて指定します。

    設定例1
    • パラメーターの名前 得意先名選択
    • パラメーターの値 Condition=[TOKUISAKI]='wingarc'
    設定例2
    • パラメーターの名前 見積り番号選択
    • パラメーターの値 Condition='[COLUMN2] BETWEEN 100 AND 200'
  • 設計時のSQL文とパラメーター実行後の実行SQL文の違いについて
    設計時のSQL文は、クエリー設計画面で[SQLの実行]アイコンをクリックして確認できます。

    SELECT
     DB1.COLUMN1
     DB1.COLUMN2
     DB1.TOKUISAKI
    FROM
     TABLE1 DB1
    WHERE
     DB1.COLUMN1='1'
    

    設定例1のパラメーターで、Condition=[TOKUISAKI]='wingarc'を指定した場合のSQL文は以下のとおりです。

    SELECT
     DB1.COLUMN1
     DB1.COLUMN2
     DB1.TOKUISAKI
    FROM
     TABLE1 DB1
    WHERE
     DB1.COLUMN1='1'
     AND DB1.TOKUISAKI='wingarc'  (この部分が追加されます。)
    

    設定例2のパラメーターで、Condition='[COLUMN2] BETWEEN 100 AND 200'を指定した場合のSQL文は以下のとおりです。

    SELECT
     DB1.COLUMN1
     DB1.COLUMN2
     DB1.TOKUISAKI
    FROM
     TABLE1 DB1
    WHERE
     DB1.COLUMN1='1'
     AND DB1.COLUMN2 BETWEEN 100 AND 200  (この部分が追加されます。)
    
  • 抽出条件を指定したときに、該当するデータがなく、データベースの結果行がない場合は、エラーコード「-554」が戻ります。

[型|変数名]=値 [抽出条件の指定:変数名]

SVFX-Designerで抽出条件に変数名を指定したクエリーを作成した場合に、使用します。
Query Designerで作成するクエリー様式ファイル上に設定された抽出条件の内容により、指定するパラメーターが異なります。

型文字 説明
X 文字型
9 数値型
D 日付型(YYYY-MM-DD)
T 時刻型(HH:MM:SS)
S タイムスタンプ型(YYYY-MM-DD HH:MM:SS)
B 論理型
設定例1

Query Designerで得意先フィールドの抽出条件として、変数名を[X|name|]と設計した場合

  • パラメーターの名前 得意先名選択
  • パラメーターの値 [X|name]='wingarc'
設定例2

Query Designerで見積り番号フィールドの抽出条件として、変数名を[9|no|]と設計した場合

  • パラメーターの名前 見積り番号選択
  • パラメーターの値 [9|no]=1000
設定例3

Query Designerで見積り番号フィールドの抽出条件として、変数名をBETWEEN [9|no1|] AND [9|no2|]と設計した場合

  • パラメーターの名前 見積り番号開始コード選択
  • パラメーターの値 [9|no]1=10
  • パラメーターの名前 見積り番号終了コード選択
  • パラメーターの値 [9|no]2=30 
参考
  • 「型文字|変数名=値」はQuery Designerで変数名を指定したときのみ有効です。
  • 環境によっては「|」が文字列として指定できない場合があります。その場合は、「|」の前に「¥」を指定します。
    例  [9¥|no]=10
    または、パラメーター全体を「'」、または「"」でくくります。
    例  '[9|no]=10' または "[9|no]=10"

PRE_PROC= [前処理プロシージャ]

パラメーター入手後、SVF実行前にRunさせるSQLプロシージャ名を指定します。また、指定したSQLプロシージャへパラメーターを渡す場合は、このパラメーター設定基準に従って指定することにより、コンカレントプログラムで指定したパラメーターがSQLプロシージャに渡ります。

設定例
  • パラメーターの名前 前処理プロシージャ
  • パラメーターの値 PRE_PROC=arp_consinv.report(PRINT_OPTION,TYPE, CURRENCY, CUST_NAME, CUST_NUM, 'PENDING')

PRINT_OPTION、TYPE、CURRENCY、CUST_NAME、CUST_NUMはそれぞれパラメーターをコンカレントプログラムで設定しておきます。
パラメーターがない場合でも、()は必須です。

注意

前処理プロシージャの処理に失敗した場合には、クエリー実行時に接続処理内で実行されるSQL文としてDBサーバーに渡るため、エラーを戻り値として返します。
SQLプロシージャ内でエラーが発生すると、SVFのデバッグログに例外が出力されますので、デバッグログ上で確認できます。

POST_PROC= [後処理プロシージャ]

パラメーター入手後、SVFで実行されるクエリーのデータ取得後にRunさせるSQLプロシージャ名を指定します。また、指定したSQLプロシージャへパラメーターを渡す場合は、このパラメーター設定基準に沿って指定することにより、コンカレントプログラムで指定したパラメーターがSQLプロシージャに渡ります。
SVFは、データベースからデータの取得が終了すると、Oracle E-Business Suiteとの接続を切断するため、印刷終了まで接続しておくことはできません。そのため、後処理プロシージャはデータ取得後に動作します。

設定例
  • パラメーターの名前 後処理プロシージャ
  • パラメーターの値 POST_PROC=arp_consinv.report(PRINT_OPTION,TYPE, CURRENCY, CUST_NAME, CUST_NUM, 'PRINTED')

PRINT_OPTION、TYPE、CURRENCY、CUST_NAME、CUST_NUMはそれぞれパラメーターをコンカレントプログラムで設定しておきます。
パラメーターがない場合でも、()は必須です。

注意

クエリーのデータ取得後に実行されるため、SVFはSQLプロシージャのエラー値を取得して戻すことができません。
そのため、SVFの印刷処理が正常終了し、EBS側に正常終了の戻り値が返った場合でもSQLプロシージャ側でエラーが発生する場合がありますので、使用する際には注意が必要です。
SQLプロシージャ内でエラーが発生した場合には、SVFのデバッグログに例外が出力されますので、デバッグログ上で確認できます。

-t [タイムアウト値の設定]

タイムアウト値を設定する場合に使用します。初期値として10分が設定されます。
SVF for Oracle EBS Connect実行部の設定ファイルを作成した場合は、AppTimeoutMinで指定した値が初期値として設定されます。設定ファイルの作成方法、および設定内容については、「第2章 インストールとアンインストール」の「2-3-1 動作設定ファイルでの設定内容」を参照してください。 
プリントサーバーからの応答が、設定されたタイムアウト値(分)の間にない場合は、異常終了とみなされます。
出力処理件数が多く出力処理に時間がかかる場合、-tパラメーターを使用してタイムアウト値を長くします。このパラメーターを設定する場合は、必ず第5パラメーターとして、Org_idの次に指定する必要があります。
プリントサーバーでの実行結果は、EBSサーバーに戻ります。タイムアウト値の時間内にSVFの処理が終了せず、印刷実行結果が戻らない場合は、[-8] APP_WAIT_TIMEOUTのエラーになります。

設定例
  • パラメーターの名前 タイムアウト値の設定
  • パラメーターの値 -t30
    印刷実行コンピューターからの応答を30分待つように設定します。

-p [ポート番号の変更]

ポート番号を変更することによって、接続する待ち受けプログラムを変更できます。
ポート番号は、初期値として3456が設定されています。
SVF for Oracle EBS Connect実行部の設定ファイルを作成した場合は、「Port」で指定した値が初期値としえて設定されます。設定ファイルの作成方法、および設定内容については、「第2章 インストールとアンインストール」の「2-3-1 動作設定ファイルでの設定内容」を参照してください。

設定例
  • $body

    *パラメーターの名前* ポートの変更

  • パラメーターの値 -p7890

-k [キープアライブ値の設定]

アプリケーションの終了待ちの間、動作確認パケットを交換しSVF側が動作していることを確認する間隔を分単位で指定します。指定できる値は、0~intの上限値÷1000÷60です。
-tパラメーターと同時に指定できます。両方指定した場合は、-kパラメーターで指定した時間ごとに接続確認を行いながら、-tパラメーターで指定した時間が経過したところでエラーになります。
初期値としては設定されていません。SVF for Oracle EBS Connect実行部の設定ファイルを作成した場合は、KeepAliveIntervalMinで指定した値が初期値として設定されます。設定ファイルの作成方法、および設定内容については、「第2章 インストールとアンインストール」の「2-3-1 動作設定ファイルでの設定内容」を参照してください。

設定例
  • パラメーターの名前 接続確認時間の設定
  • パラメーターの値 -k10

Port= [プリンター名]

Java環境設定で作成したプリンター名で指定します。

設定例
  • パラメーターの名前 プリンター名
  • パラメーターの値 Port=CanonLBP
  • パラメーターの値 Port=PDF

Copies= [複写枚数]

印刷部数を指定します。指定しない場合は、XML様式ファイル設計時に設定した印刷部数に従って印刷します。両方で指定されている場合は、このパラメーターが優先されます。

設定例
  • パラメーターの名前 複写枚数
  • パラメーターの値 Copies=1
  • パラメーターの値 Copies=2

PageMask= [印字綴りページ番号の指定]

綴りを複数ページ指定しているXML様式ファイルで、印字対象とする綴りページを指定します。
XML様式ファイル内で設定された綴りページに対し、1/0のFLGを文字列として指定します。

  • 1 印字するページ
  • 0 印字しないページ
設定例

綴りページ「4」を設定したXML様式ファイルに対して、綴りの1Pageと3Pageのみ出力したい場合

  • パラメーターの名前 綴りページ番号の設定
  • パラメーターの値 VrPage='1010'

使用方法の詳細については、『SVF Java PRODUCTS API関数リファレンスマニュアル』の「VrPage」の項を参照してください。

AdjustmX/AdjustmY= [印字位置調整 0.1mm単位]

印字位置を調整します。

  • AdjustmX 左右の印字位置調整値を0.1mm単位に指定します(正数 右方向、負数 左方向)。
  • AdjustmY 上下の印字位置調整値を0.1mm単位に指定します(正数 下方向、負数 上方向)。
設定例
  • パラメーターの名前 印字位置調整X座標
  • パラメーターの値 AdjustmX=-40 左方向に4mm調整して印刷します。
  • パラメーターの名前 印字位置調整Y座標
  • パラメーターの値 AdjustmY=-40 上方向に4mm調整して印刷します。

使用方法の詳細については、『SVF Java PRODUCTS API関数リファレンスマニュアル』の「VrAdjustm」の項を参照してください。

CalcMode= [計算モード]

最大33桁(整数部+小数部)の十進数演算ライブラリをサポートします。15桁以上の数値データを扱う場合に使用します。
この設定がない場合には、各実行環境の設定ファイルの内容に従います。両方で指定されている場合は、CalcMode=パラメーターで設定された内容が優先されます。

設定例
  • パラメーターの名前 演算ライブラリ
  • パラメーターの値 CalcMode=0 Double型演算
  • パラメーターの値 CalcMode=1 多倍精度十進数浮動小数点演算

使用方法の詳細、および環境設定ファイルの設定方法については、『SVF Java PRODUCTS API関数リファレンスマニュアル』の「VrSetCalcMode」の項を参照してください。

ENCODING= [エンコーディング]

エンコーディングを指定します。

設定例
  • パラメーターの名前 エンコーディング
  • パラメーターの値 ENCODING=MS932

使用方法の詳細については、『SVF Java PRODUCTS API関数リファレンスマニュアル』の「VrInit」の項を参照してください。

LOCALE= [ロケール]

ロケールを指定します。

設定例
  • パラメーターの名前 ロケール
  • パラメーターの値 LOCALE=ja

使用方法の詳細については、『SVF Java PRODUCTS API関数リファレンスマニュアル』の「VrSetLocale」の項を参照してください。

FILE_ENCODING= [パラメーターファイルのエンコーディング]

パラメーターファイルのエンコーディングを指定します。

設定例
  • パラメーターの名前 パラメーターファイルのエンコーディング
  • パラメーターの値 FILE_ENCODING=MS932