6.15.3 コマンドアダプタ実行環境プロパティファイル
- 〈この項の構成〉
(1) 形式
adpcmd.config.command.allow-file-path=実行許可コマンド定義ファイルのパス
［adpcmd.config.process-environment.variable-file-path=プロセス環境変数定義ファイルのパス］
［adpcmd.config.process-environment.working-dir-path=外部コマンドプロセスの作業ディレクトリパス］
［adpcmd.config.timeout.value=外部コマンドプロセスのタイムアウト値］
［adpcmd.config.timeout.enable-kill-process={true｜false}］
［adpcmd.config.stdout.size=応答電文で取得する標準出力の上限サイズ］
［adpcmd.log.messagelog.level={0｜10｜20}］
［adpcmd.log.methodtrace.level={1｜2｜3｜4｜5}］
［adpcmd.log.methodtrace.filenum=メンテナンスログファイルの面数］
［adpcmd.log.methodtrace.filesize=メンテナンスログファイルのファイルサイズ］
［adpcmd.log.exptrace.filenum=例外ログファイルの面数］
［adpcmd.log.exptrace.filesize=例外ログファイルのファイルサイズ］
［adpcmd.log.stderr.enable={true｜false}］
［adpcmd.log.stderr.charset={UTF-8｜MS932｜EUC-JP}］
［adpcmd.log.stderr.filenum=標準エラー出力ログファイルの面数］
［adpcmd.log.stderr.filesize=標準エラー出力ログファイルのファイルサイズ］
(2) 機能
コマンドアダプタごとの構成情報を設定します。
(a) ファイルの種類
コマンドアダプタ実行環境プロパティファイルは，次に示す2種類があります。
-
コマンドアダプタ実行環境プロパティファイル
有効範囲：特定のコマンドアダプタ
-
コマンドアダプタ実行環境共通プロパティファイル
有効範囲：すべてのコマンドアダプタ
作成手順については「6.15.4 コマンドアダプタ実行環境共通プロパティファイル」を参照してください。
これらのファイルが両方設定されている場合，2つのファイルの定義内容がマージされます。
また，1つのマシンに複数のHCSCサーバをセットアップした場合，コマンドアダプタ実行環境プロパティファイルをHCSCサーバごとに定義することもできます。これらのファイルが両方設定されている場合，2つのファイルの定義内容がマージされます。
同じ内容が要求電文，コマンドアダプタ実行環境プロパティファイル，コマンドアダプタ実行環境共通プロパティファイルの間で複数設定された場合，次の表でより優先度の高いものが適用されます。
|
指定個所 |
重複時の優先度 |
|---|---|
|
要求電文 |
高 |
|
コマンドアダプタ実行環境プロパティファイル （HCSCサーバ単位の指定：あり） |
｜ |
|
コマンドアダプタ実行環境共通プロパティファイル （HCSCサーバ単位の指定：あり） |
｜ |
|
コマンドアダプタ実行環境プロパティファイル （HCSCサーバ単位の指定：なし） |
｜ |
|
コマンドアダプタ実行環境共通プロパティファイル （HCSCサーバ単位の指定：なし） |
低 |
(b) 作成手順
コマンドアダプタ実行環境プロパティファイルは次の手順で作成してください。コマンドアダプタ実行環境共通プロパティファイルの作成手順は，「6.15.4 コマンドアダプタ実行環境共通プロパティファイル」を参照してください。
-
次のテンプレートファイルを基に，コマンドアダプタ実行環境プロパティファイルを定義します。
<サービスプラットフォームのインストールディレクトリ>\CSC\custom-adapter\Command\config\templates\serviceid.properties
-
編集後のファイルをファイル名「<サービスID>.properties」で次のディレクトリに格納してください。
- 全HCSCサーバ共通の定義の場合
-
<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥Command¥config
- 特定のHCSCサーバ用の定義の場合
-
<サービスプラットフォームのインストールディレクトリ>¥CSC¥custom-adapter¥Command¥config¥<HCSCサーバ名>
サブディレクトリ<HCSCサーバ名>を作成する際は，Windowsでは大文字・小文字は区別されないので，注意してください。
サブディレクトリ<HCSCサーバ名>には，HCSCサーバの管理者（Service Coordinator管理者）がアクセスできるよう，適切なアクセス権限を設定してください。
(3) 設定できるプロパティ
(a) 実行許可コマンド定義ファイルのパス
adpcmd.config.command.allow-file-path=実行許可コマンド定義ファイルのパス
実行許可コマンド定義ファイルのパスを絶対パスまたは相対パスで指定します。相対パスを指定した場合の基点ディレクトリを次に示します。
<サービスプラットフォームのインストールディレクトリ>\CSC\custom-adapter\Command\config
- 参考
-
<サービスプラットフォームのインストールディレクトリ> が 「C:\Example」で，実行許可コマンド定義ファイル「acc.txt」を「C:\Example\CSC\custom-adapter\Command\config」に作成したと仮定した場合，次の2つの例はどちらを指定しても動作は同じです。
- ● 絶対パス指定の例
-
adpcmd.config.command.allow-file-path=C:\\Example\\CSC\\custom-adapter\\Command\\config\\acc.txt
- ● 相対パス指定の例
-
adpcmd.config.command.allow-file-path=acc.txt
(b) 外部コマンドプロセスの環境設定
adpcmd.config.process-environment.variable-file-path=プロセス環境変数定義ファイルのパス
プロセス環境変数定義ファイルのファイルパスを絶対パスまたは相対パスで指定します。相対パスを指定した場合の基点ディレクトリを次に示します。
<サービスプラットフォームのインストールディレクトリ>\CSC\custom-adapter\Command\config
adpcmd.config.process-environment.working-dir-path=外部コマンドプロセスの作業ディレクトリパス 〜<<<サービスプラットフォームのインストールディレクトリ>\CSC\spool\Command>>
外部コマンドプロセスの作業ディレクトリを絶対パスで指定します。
(c) タイムアウト
adpcmd.config.timeout.value=外部コマンドプロセスのタイムアウト値 〜＜数字＞((0−86400)) <<60>>
外部コマンドプロセスのタイムアウト値（単位：秒）を指定します。
0を指定した場合，プロセスがタイムアウトなしとなり，外部コマンドプロセスが終了するまで待ちます。
- 注意事項
-
サービスプラットフォームでは，運用環境から外部コマンドプロセスを停止する手段を提供していません。したがって，確実に終了する外部コマンドを指定するか，状態が確認できる外部コマンドを作成してください。
adpcmd.config.timeout.enable-kill-process=タイムアウト発生時の外部コマンドプロセス強制終了可否 〜{true｜false} <<true>>
タイムアウトが発生した際に，その時点で外部コマンドプロセスの強制終了を試みるかどうかを指定します。
-
true
強制終了を試みます。
-
false
強制終了しません。
trueの場合でも，外部コマンドプロセスの状態によっては強制終了に失敗するケースがあります。強制終了の成功可否については，メッセージログで確認してください。
falseの場合，コマンドアダプタやHCSCサーバの状態に関係なく，起動した外部コマンドプロセスは処理を継続します。
- 注意事項
-
サービスプラットフォームでは，運用環境から外部コマンドプロセスを停止する手段を提供していません。したがって，確実に終了する外部コマンドを指定するか，状態が確認できる外部コマンドを作成してください。
(d) 応答電文で取得する標準出力の上限サイズ
adpcmd.config.stdout.size=応答電文で取得する標準出力の上限サイズ 〜＜数字＞((0−104857600)) <<2097152>>
応答電文で取得する標準出力の上限サイズ（単位：バイト）を指定します。
0を指定した場合，標準出力を応答電文で取得できません。
外部コマンドプロセスの標準出力への出力データサイズが，このプロパティの指定値を超えた時点で，メッセージログに警告メッセージが出力されます。ただし，0を指定した場合，警告メッセージは出力されません。
(e) ロギング
adpcmd.log.messagelog.level={0｜10｜20} 〜<<10>>
メッセージログの出力レベルを指定します。
出力情報と出力レベルを次の表に示します。
|
出力情報 |
出力内容 |
出力レベル |
||
|---|---|---|---|---|
|
0 |
10 |
20 |
||
|
エラー情報 |
例外または障害の発生原因 |
○ |
○ |
○ |
|
警告情報 |
システムを運用する上で確認する必要がある状態 |
△ |
○ |
○ |
|
インフォメーション |
コマンドアダプタの状態変更（起動および停止） イベント通知（外部コマンドの起動および終了） |
△ |
△ |
○ |
- （凡例）
-
○：すべて出力されます。
△：重要なログメッセージだけ出力されます。
adpcmd.log.methodtrace.level={1｜2｜3｜4｜5} 〜<<3>>
メンテナンスログの出力レベルを指定します。
出力情報と出力レベルを次の表に示します。
|
出力情報 |
出力レベル |
||||
|---|---|---|---|---|---|
|
1 |
2 |
3 |
4 |
5 |
|
|
エラー情報（例外発生原因） |
○ |
○ |
○ |
○ |
○ |
|
主要外部モジュールのインターフェース情報（カスタムアダプタフレームワーク関連） |
× |
○ |
○ |
○ |
○ |
|
外部モジュールのインターフェース情報（外部コマンドプロセス関連） |
× |
× |
○ |
○ |
○ |
|
主要なコンポーネント内インターフェース情報 |
× |
× |
× |
○ |
○ |
|
デバッグ情報 |
× |
× |
× |
× |
○ |
- （凡例）
-
○：出力されます。
×：出力されません。
adpcmd.log.methodtrace.filenum=メンテナンスログファイルの面数 〜＜数字＞((1−16))<<8>>
メンテナンスログの面数を指定します。
adpcmd.log.methodtrace.filesize=メンテナンスログファイルのファイルサイズ 〜＜数字＞((4096−2147483647)) <<2097152>>
メンテナンスログの1面当たりの最大ファイルサイズ（単位：バイト）を指定します。
adpcmd.log.exptrace.filenum=例外ログファイルの面数 〜＜数字＞((1−16))<<8>>
例外ログの面数を指定します。
adpcmd.log.exptrace.filesize=例外ログファイルのファイルサイズ 〜＜数字＞((4096−2147483647)) <<2097152>>
例外ログの1面当たりの最大ファイルサイズ（単位：バイト）で指定します。
adpcmd.log.stderr.enable={true｜false} 〜<<true>>
外部コマンドプロセスの標準エラー出力への出力内容をログファイルに書き込むかを指定します。
-
true
標準エラー出力ログを有効とします。
-
false
標準エラー出力ログを無効とします。
adpcmd.log.stderr.charset={UTF-8｜MS932｜EUC-JP} 〜<<UTF-8>>
外部コマンドプロセスが標準エラー出力へ出力する際の文字コードを指定します。
外部コマンドプロセスがASCII文字だけを出力する場合は，文字コードの指定を省略（デフォルトの設定を利用）できます。
adpcmd.log.stderr.filenum=標準エラー出力ログファイルの面数 〜＜数字＞((1−16)) <<8>>
標準エラー出力ログの面数を指定します。
adpcmd.log.stderr.filesize=標準エラー出力ログファイルのファイルサイズ 〜＜数字＞((4096−2147483647)) <<2097152>>
標準エラー出力ログの1面当たりの最大ファイルサイズ（単位：バイト）を指定します。