Cosminexus V9 BPM/ESB基盤 サービスプラットフォーム 開発ガイド 受付・アダプタ定義編
コマンドアダプタの定義方法について説明します。
コマンドアダプタでは,要求電文と応答電文の2種類の電文があります。それぞれの内容について説明します。
電文フォーマット作成手順の詳細は,マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「4. 電文フォーマットの作成」を参照してください。
サービス呼出アクティビティを使用して,コマンドアダプタに渡す要求電文のXMLデータフォーマットと指定値について説明します。
名前空間名は「http://www.hitachi.co.jp/soft/xml/cosminexus/csc/adapter/cmd/request」です。
表3-104 要求電文フォーマット
タグ名 | 種別 | 出現回数※ | 説明 | |||
---|---|---|---|---|---|---|
<request> | − | 1 | − | |||
|
<command-line> | − | 1 | − | ||
|
<command> | string | 1 | 外部コマンドのファイルパスを指定するタグです。 | ||
<argument<N>> | string | 0または1 | 外部コマンドのコマンドライン引数を指定するタグです。 argument<N>にそれぞれ1つずつ指定します。 <N>の部分は,1,2,…,100のどれかを指定します。 <N> の部分は昇順に出現する必要があります。 出現する<N>が連続値である必要はありません。 要素値が空文字列の要素は,引数として採用しません。 |
|||
<config> | − | 0または1 | 外部コマンドプロセスに関する動作オプションを設定するタグです。 各子要素で値を指定した場合,コマンドアダプタ実行環境プロパティファイルの対応するプロパティ値は無効になります。 各子要素がない場合,コマンドアダプタ実行環境プロパティファイルの対応するプロパティ値が有効になります。 コマンドアダプタ実行環境プロパティファイルの詳細は,マニュアル「サービスプラットフォーム リファレンス」の「コマンドアダプタ実行環境プロパティファイル」を参照してください。 |
|||
|
<timeout> | − | 0または1 | 外部コマンドプロセスのタイムアウトに関する情報を指定するタグです。 | ||
|
<value> | int | 0または1 | タイムアウト時間(秒)を指定するタグです。 指定可能値は,0〜86400です。 0を指定した場合,外部コマンドプロセスのタイムアウトを使用しません。 要素値が空要素の場合はエラーになります。 対応するコマンドアダプタ実行環境プロパティファイルのプロパティはadpcmd.config.timeout.valueです。詳細は,マニュアル「サービスプラットフォーム リファレンス」の「コマンドアダプタ実行環境プロパティファイル」を参照してください。 |
||
<enable-kill-process> | boolean | 0または1 | タイムアウト発生時の外部コマンドプロセス強制終了の実施可否を指定するタグです。 指定可能値は,trueまたはfalseです(大文字可)。 trueを指定した場合,タイムアウト発生時にプロセスの強制終了を試みます。 要素値が空要素の場合はエラーになります。 対応するコマンドアダプタ実行環境プロパティファイルのプロパティはadpcmd.config.timeout.enable-kill-processです。詳細は,マニュアル「サービスプラットフォーム リファレンス」の「コマンドアダプタ実行環境プロパティファイル」を参照してください。 |
|||
<process-environment> | − | 0または1 | 外部コマンドプロセスの環境に関する情報を設定するタグです。 | |||
|
<variable-file-path> | string | 0または1 | プロセス環境変数定義ファイルのファイルパスを指定するタグです。 絶対パスで指定してください。 HCSCサーバマシンのファイルを指定してください。 ファイルパスを指定した場合,コマンドアダプタ実行環境プロパティファイルで指定したプロセス環境変数定義ファイルの内容はすべて無視されます。 要素値が空要素の場合はエラーになります。 対応するコマンドアダプタ実行環境プロパティファイルのプロパティはadpcmd.config.process-environment.variable-file-pathです。詳細は,マニュアル「サービスプラットフォーム リファレンス」の「コマンドアダプタ実行環境プロパティファイル」を参照してください。 |
||
<working-dir-path> | string | 0または1 | 外部コマンドプロセスの作業ディレクトリを指定するタグです。 絶対パスで指定してください。 HCSCサーバマシンに存在するディレクトリを指定してください。 要素値が空要素の場合はエラーになります。 対応するコマンドアダプタ実行環境プロパティファイルのプロパティはadpcmd.config.process-environment.working-dir-pathです。詳細は,マニュアル「サービスプラットフォーム リファレンス」の「コマンドアダプタ実行環境プロパティファイル」を参照してください。 |
サービス呼出アクティビティを使用して,コマンドアダプタから受け取る応答電文のバイナリデータフォーマットについて説明します。
図3-30 応答電文のバイナリフォーマットの構造
表3-105 応答電文のバイナリデータフォーマットの詳細
情報 | サイズ (バイト) |
説明 |
---|---|---|
終了コード | 4 | 外部コマンドプロセスの終了コードです。 符号付2進整数(リトルエンディアン)で表現した値が格納されています。 |
[標準出力への出力結果]領域のサイズ | 4 | 標準出力への出力結果として応答電文に格納されているサイズ(バイト)です。 符号付2進整数(リトルエンディアン)で表現した値が格納されています。 サイズの最小値は0,サイズの最大値はコマンドアダプタ実行環境プロパティファイルのadpcmd.config.stdout.sizeキーで指定した値です。 |
標準出力への出力結果 | 可変 | 外部コマンドプロセスが標準出力に出力した内容です。 |
<サービスプラットフォームのインストールディレクトリ>/CSC/custom-adapter/Command/schema/adpcmd_response_ms932.fdx <サービスプラットフォームのインストールディレクトリ>/CSC/custom-adapter/Command/schema/adpcmd_response_utf8.fdx
コマンドアダプタを定義する場合の手順を次に示します。
作成および編集する定義ファイルの種類を次に示します。
各定義ファイルの作成手順および編集手順を次に示します。
コマンドアダプタ実行環境プロパティファイルは,コマンドアダプタを開始する際に実行環境に反映されます。このため,コマンドアダプタ実行環境プロパティファイルの内容を変更する場合は,いったんコマンドアダプタを停止する必要があります。
コマンドアダプタ実行環境共通プロパティファイルで編集できる定義内容は,コマンドアダプタ実行環境プロパティファイルと同じです。
コマンドアダプタ実行環境共通プロパティファイルは,コマンドアダプタを開始する際に実行環境に反映されます。このため,コマンドアダプタ実行環境共通プロパティファイルの内容を変更する場合は,いったんコマンドアダプタを停止する必要があります。
All Rights Reserved. Copyright (C) 2012, 2019, Hitachi, Ltd.