cscgenbinary(バイナリフォーマット定義ファイルからバイナリ電文の生成)
形式
(1)コマンドに引数を直接指定する場合
cscgenbinary -format <バイナリフォーマット定義ファイルのパス> {-outbinfile <出力バイナリファイルのパス> [-inxmlfile <入力XMLファイルのパス>] | -outxmlfile <出力XMLファイルのパス>} [-genproperty <バイナリ電文生成定義ファイルのパス>] [-uocclass <文字コード変換UOCのクラス名> [-uocproperty <文字コード変換UOCの独自定義ファイルのパス>]] [-codetablerootpath <コード変換テーブルの格納パスのルートパス>] [-debugtrace [-debugtracefilepath <デバッグ情報の出力先パス>]] [-cscdtsysprop <データ変換用システムプロパティファイルのパス>] [-undefinedcode {ERROR|REPLACE}]
(2)コマンドの引数をファイルに指定する場合
cscgenbinary -f <バイナリ電文生成コマンドプロパティファイルのパス>
機能
バイナリフォーマット定義ファイルからバイナリ電文を生成します。
このコマンドは,次の場所に格納されています。
<サービスプラットフォームのインストールディレクトリ>\CSCTE\bin
コマンドを実行する場合は,この場所まで移動するかパスを指定してください。
コマンドの引数の指定方法には次の2種類があります。
-
コマンドに引数を直接指定する方法
コマンド実行時に引数を指定する方法です。-fオプションと一緒に指定すると,直接指定した引数はすべて無効となり,-fオプションに指定したバイナリ電文生成コマンドプロパティファイルに記載された引数が有効になります。
-
コマンドの引数をファイルに指定する方法
コマンドの引数をバイナリ電文生成コマンドプロパティファイルにプロパティ形式で列記し,そのファイル名を-fオプションで指定する方法です。
システム環境変数COSMINEXUS_HOMEが正しく設定されていない場合,コマンドを実行するとエラーになります。
cscgenbinaryコマンドの使用方法については,マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「10.5.7 cscgenbinaryコマンドの使用方法」を参照してください。
引数
(1)コマンドに引数を直接指定する場合
-format <バイナリフォーマット定義ファイルのパス>
エディタでの検証が完了しているバイナリフォーマット定義ファイル(.fdx)のパスを絶対パスまたは相対パスで指定します。拡張子の大文字・小文字は区別しません。この引数は省略できません。
-outbinfile <出力バイナリファイルのパス>
出力バイナリファイルのパスを絶対パスまたは相対パスで指定します。出力先のディレクトリが存在しない場合はエラーになります。
-outbinfileオプション(出力バイナリファイルのパス)と-outxmlfileオプション(出力XMLファイルのパス)は,どちらか一方を指定してください。
指定したパスに同名のファイルが存在する場合,ファイルを上書きします。同名のファイルが存在しない場合は,ファイルを新たに作成します。
-inxmlfile <入力XMLファイルのパス>
XMLファイルからバイナリ電文を生成する場合に,入力XMLファイルのパスを絶対パスまたは相対パスで指定します。この引数は省略できます。
-outxmlfileオプションと同時に指定すると,この引数の指定は無効になります。
指定する入力XMLファイルは,バイナリフォーマット定義ファイル(-formatオプションで指定)を基にcscfdx2xsdコマンドで生成したXMLスキーマファイルに沿っている必要があります。XMLスキーマファイルに沿っていない場合は動作を保証しません。
-outxmlfile <出力XMLファイルのパス>
出力XMLファイルのパスを絶対パスまたは相対パスで指定します。出力先のディレクトリが存在しない場合はエラーになります。この引数は省略できません。
-outbinfileオプション(出力バイナリファイルのパス)と-outxmlfileオプション(出力XMLファイルのパス)は,どちらか一方を指定してください。
指定したパスに同名のファイルが存在する場合,ファイルを上書きします。同名のファイルが存在しない場合は,ファイルを新たに作成します。
-genproperty <バイナリ電文生成定義ファイルのパス>
バイナリ電文生成定義ファイルのパスを絶対パスまたは相対パスで指定します。この引数は省略できます。
-inxmlfileオプションと同時に指定すると,この引数の指定は無効になります。
バイナリ電文生成定義ファイルは,単純内容要素の要素値をデフォルト値から変更したい場合に作成します。バイナリ電文生成定義ファイルについては,「3.19.4 バイナリ電文生成定義ファイル」を参照してください。
-uocclass <文字コード変換UOCのクラス名>
文字コード変換UOCのクラス名を完全修飾名で指定します。この引数は省略できます。
なお,文字コード変換UOCのクラス名は,次に示すファイルまたはコマンドでも指定できます。指定が重複した場合に適用される優先順位を次に示します。
優先順位 |
プロパティファイル名/コマンド名 |
該当するプロパティ名/引数名 |
---|---|---|
1 |
データ変換用システムプロパティファイル |
csc.dt.ownCodeConverter.className |
2 |
バイナリ電文生成コマンドプロパティファイル |
csctransform.uoc.class |
3 |
cscgenbinaryコマンド |
-uocclass |
データ変換用システムプロパティファイルのcsc.dt.ownCodeConverter.classNameの設定については,「3.19.2 データ変換用システムプロパティファイル」を参照してください。
なお,文字コード変換UOCを使用する場合は,文字コード変換UOCのjarファイルをシステム環境変数CSC_DATA_TRANSFORM_CLASSPATHに設定してください。外部のjarファイルに定義されているクラスをカスタムファンクションや文字コード変換UOCから呼び出す場合も,該当するjarファイルを環境変数に設定する必要があります。
-uocproperty <文字コード変換UOCの独自定義ファイルのパス>
-uocclassオプションが指定されている場合に,文字コード変換UOCの独自定義ファイルのパスを絶対パスまたは相対パスで指定します。この引数は省略できます。
-uocclassオプションが指定されていない場合は,この引数の指定は無効となります。-uocclassオプションを指定してこの引数を省略した場合は,独自定義ファイルを読み込まない状態で文字コード変換UOCのクラスがデータ変換時に実行されます。
-codetablerootpath <コード変換テーブルの格納パスのルートパス>
コード変換ライブラリで使用するコード変換テーブル格納パスのルートパスを絶対パスまたは相対パスで指定します。この引数は省略できます。
-debugtrace
デバッグ情報を出力する場合に指定します。この引数は省略できます。
-debugtracefilepath <デバッグ情報の出力先パス> 〜<<コマンドを実行したカレントディレクトリ>>
-debugtraceオプションを指定している場合,デバッグ情報の出力先パスを絶対パスまたは相対パスで指定します。この引数は省略できます。
この引数を設定していない場合,デバッグ情報の出力先を指定していない場合,または指定したディレクトリが存在しない場合は,コマンドを実行したカレントディレクトリにデバッグ情報が出力されます。
-cscdtsysprop <データ変換用システムプロパティファイルのパス>
データ変換用システムプロパティファイルのパスを絶対パスまたは相対パスで指定します。この引数は省略できます。
データ変換用システムプロパティファイルは,Service Platformのデータ変換のシステムプロパティを指定したファイルです。指定方法については,「3.19.2 データ変換用システムプロパティファイル」を参照してください。
-undefinedcode {ERROR|REPLACE} 〜<<ERROR>>
バイナリデータの文字コード変換時に未定義の文字コードを検出した場合の動作を指定します。この引数は省略できます。
指定できる値は次のとおりです。
-
ERROR
未定義の文字コードを検出した時点でエラーとし,処理を終了します。
-
REPLACE
未定義部分の文字コードを空白の文字コードに置換して処理を継続します。
(2)コマンドの引数をファイルに指定する場合
-f <バイナリ電文生成コマンドプロパティファイルのパス>
バイナリ電文生成コマンドプロパティファイルのパスを相対パスまたは絶対パスで指定します。このオプションを指定している場合は,ほかのオプションを指定しても無視されます。
- バイナリ電文生成コマンドプロパティファイル
-
cscgenbinaryコマンドの引数をJavaのプロパティファイル形式で列記したファイルです。使用できる文字コードはUTF-8だけです。
バイナリ電文生成コマンドプロパティファイルの定義方法については,「3.19.3 バイナリ電文生成コマンドプロパティファイル」を参照してください。
戻り値
戻り値 |
意味 |
---|---|
0 |
正常終了しました。 |
1 |
異常終了しました。 |
注意事項
-
コマンドの実行時にスタックオーバーフローやOOM(Out Of Memory)が発生した場合,システム環境変数CSC_DATA_TRANSFORM_OPTにJavaVM起動オプションを指定して,スタック領域やヒープ領域の値を設定してください。
システム環境変数に指定できるJavaVM起動オプションを次に示します。
JavaVM起動オプション
説明
-Xms
ヒープ領域(New領域+Old領域)の初期値
-Xmx
ヒープ領域(New領域+Old領域)の最大値
-Xss
スレッドのスタックサイズ
-XX:MetaspaceSize
Metaspace領域に起因するFullGCの基準値の指定
-XX:MaxMetaspaceSize
Metaspace領域の最大値の指定
-
パスをワイルドカードで指定した場合の動作は保証しません。