3.19.3 バイナリ電文生成コマンドプロパティファイル
- 〈この項の構成〉
(1) 形式
csctransform.format=バイナリフォーマット定義ファイルのパス csctransform.output.binary.data=出力バイナリファイルのパス csctransform.output.xml.data=出力XMLファイルのパス [csctransform.input.xml.data=入力XMLファイルのパス] [csctransform.generate.property=バイナリ電文生成定義ファイルのパス] [csctransform.uoc.class=文字コード変換UOCのクラス名] [csctransform.uoc.property=文字コード変換UOCの独自定義ファイルのパス] [csctransform.code.table.root.path=コード変換テーブルの格納パスのルートパス] [csctransform.debugtrace={ON|OFF}] [csctransform.debugtrace.filepath=デバッグ情報の出力先パス] [csctransform.system.properties=データ変換用システムプロパティファイルのパス] [csctransform.undefined.code={ERROR|REPLACE}]
(2) 機能
cscgenbinaryコマンドの引数をプロパティ形式でファイルに設定します。設定したファイルは,cscgenbinaryコマンドの実行時に-fオプションで指定できます。cscgenbinaryコマンドについては,「cscgenbinary(バイナリフォーマット定義ファイルからバイナリ電文の生成)」を参照してください。
- cscgenbinaryコマンドの引数との対応
-
このファイルで設定するプロパティと,cscgenbinaryコマンドの引数との対応を次に示します。
項番
プロパティのキー名
対応するコマンド引数
設定内容
1
csctransform.format
-format
バイナリフォーマット定義ファイルのパス
2
csctransform.output.binary.data
-outbinfile
出力バイナリファイルのパス
3
csctransform.output.xml.data
-outxmlfile
出力XMLファイルのパス
4
csctransform.input.xml.data
-inxmlfile
入力XMLファイルのパス
5
csctransform.generate.property
-genproperty
バイナリ電文生成定義ファイルのパス
6
csctransform.uoc.class
-uocclass
文字コード変換UOCのクラス名
7
csctransform.uoc.property
-uocproperty
文字コード変換UOCの独自定義ファイルのパス
8
csctransform.code.table.root.path
-codetablerootpath
コード変換テーブルの格納パスのルートパス
9
csctransform.debugtrace
-debugtrace
デバッグ情報の出力有無
10
csctransform.debugtrace.filepath
-debugtracefilepath
デバッグ情報の出力先パス
11
csctransform.system.properties
-cscdtsysprop
データ変換用システムプロパティファイルのパス
12
csctransform.undefined.code
-undefinedcode
未定義の文字コードへの対処
- ファイルの編集方法
-
ファイルはJavaのプロパティファイル形式で設定します。使用できる文字コードはUTF-8だけです。
次に示すテンプレートファイルを編集して,任意のファイル名で保存してください。
- テンプレートファイルの場所
<サービスプラットフォームのインストールディレクトリ>\CSCTE\template\cscdt_cscgenbinary.properties
(3) 設定できるプロパティ
csctransform.format=バイナリフォーマット定義ファイルのパス
エディタでの検証が完了しているバイナリフォーマット定義ファイルのパスを絶対パスまたは相対パスで指定します。
指定できるファイルの拡張子は「.fdx」だけです。拡張子の大文字・小文字は区別しません。
csctransform.output.binary.data=出力バイナリファイルのパス
出力バイナリファイルのパスを絶対パスまたは相対パスで指定します。出力先のディレクトリが存在しない場合はエラーになります。
csctransform.output.binary.data(出力バイナリファイルのパス)とcsctransform.output.xml.data(出力XMLファイルのパス)は,どちらか一方を指定してください。
指定したパスに同名のファイルが存在する場合,ファイルを上書きします。同名のファイルが存在しない場合は,ファイルを新たに作成します。
csctransform.output.xml.data=出力XMLファイルのパス
出力XMLファイルのパスを絶対パスまたは相対パスで指定します。出力先のディレクトリが存在しない場合はエラーになります。
csctransform.output.binary.data(出力バイナリファイルのパス)とcsctransform.output.xml.data(出力XMLファイルのパス)は,どちらか一方を指定してください。
指定したパスに同名のファイルが存在する場合,ファイルを上書きします。同名のファイルが存在しない場合は,ファイルを新たに作成します。
csctransform.input.xml.data=入力XMLファイルのパス
XMLファイルからバイナリ電文を生成する場合に,入力XMLファイルのパスを絶対パスまたは相対パスで指定します。
csctransform.output.xml.dataと同時に指定すると,このプロパティの指定は無効になります。
指定する入力XMLファイルは,バイナリフォーマット定義ファイル(csctransform.formatで指定)を基にcscfdx2xsdコマンドで生成したXMLスキーマファイルに沿っている必要があります。XMLスキーマファイルに沿っていない場合は動作を保証しません。
csctransform.generate.property=バイナリ電文生成定義ファイルのパス
バイナリ電文生成定義ファイルのパスを絶対パスまたは相対パスで指定します。
csctransform.input.xml.dataと同時に指定すると,このプロパティの指定は無効になります。
バイナリ電文生成定義ファイルは,単純内容要素の要素値をデフォルト値から変更したい場合に作成します。バイナリ電文生成定義ファイルについては,「3.19.4 バイナリ電文生成定義ファイル」を参照してください。
csctransform.uoc.class=文字コード変換UOCのクラス名
文字コード変換UOCのクラス名を完全修飾名で指定します。
文字コード変換UOCのクラス名は,次に示すファイルまたはコマンドでも指定できます。指定が重複した場合に適用される優先順位を次に示します。
優先順位 |
プロパティファイル名/コマンド名 |
該当するプロパティ名/引数名 |
---|---|---|
1 |
データ変換用システムプロパティファイル |
csc.dt.ownCodeConverter.className |
2 |
バイナリ電文生成コマンドプロパティファイル |
csctransform.uoc.class |
3 |
cscgenbinaryコマンド |
-uocclass |
データ変換用システムプロパティファイルのcsc.dt.ownCodeConverter.classNameの設定については,「3.19.2 データ変換用システムプロパティファイル」を参照してください。cscgenbinaryコマンドについては,「cscgenbinary(バイナリフォーマット定義ファイルからバイナリ電文の生成)」を参照してください。
なお,文字コード変換UOCを使用する場合は,文字コード変換UOCのjarファイルをシステム環境変数CSC_DATA_TRANSFORM_CLASSPATHに設定してください。外部のjarファイルに定義されているクラスをカスタムファンクションや文字コード変換UOCから呼び出す場合も,該当するjarファイルを環境変数に設定する必要があります。
csctransform.uoc.property=文字コード変換UOCの独自定義ファイルのパス
文字コード変換UOCの独自定義ファイルのパスを絶対パスまたは相対パスで指定します。
csctransform.uoc.classプロパティが設定されていない場合は,このプロパティの指定は無効となります。csctransform.uoc.classプロパティを指定してこの引数を省略した場合は,独自定義ファイルを読み込まない状態で文字コード変換UOCのクラスがデータ変換時に実行されます。
csctransform.code.table.root.path=コード変換テーブルの格納パスのルートパス
コード変換ライブラリで使用するコード変換テーブルの格納パスのルートパスを絶対パスまたは相対パスで指定します。
csctransform.debugtrace={ON|OFF} 〜<<OFF>>
デバッグ情報を出力するか指定します。
-
ON
出力します。
-
OFF
出力しません。
csctransform.debugtrace.filepath=デバッグ情報の出力先パス 〜<<cscgenbinaryコマンドの実行カレントディレクトリ>>
デバッグ情報の出力先パスを絶対パスまたは相対パスで指定します。
csctransform.debugtraceプロパティに「ON」を指定した場合だけ有効です。
次の場合はデフォルト値が適用され,cscgenbinaryコマンドを実行したカレントディレクトリにデバッグ情報が出力されます。
-
このプロパティを設定していない
-
このプロパティにデバッグ情報の出力先を指定していない
-
指定したディレクトリが存在しない
csctransform.system.properties=データ変換用システムプロパティファイルのパス
データ変換用システムプロパティファイルに設定したService Platformのシステムプロパティを有効にする場合,ファイルのパスを絶対パスまたは相対パスで指定します。
データ変換用システムプロパティファイルの設定内容については,「3.19.2 データ変換用システムプロパティファイル」を参照してください。
csctransform.undefined.code={ERROR|REPLACE} 〜<<ERROR>>
バイナリデータの文字コード変換時に未定義の文字コードを検出した場合の動作を指定します。
-
ERROR
検出時にエラーとなり処理を終了します。
-
REPLACE
未定義部分の文字コードを空白の文字コードに置換して処理を継続します。
(4) 注意事項
-
パスをワイルドカードで指定した場合の動作は保証しません。
-
パスのセパレータに「\」を使用する場合はエスケープしてください。