3.4.3 TP1アダプタ通信構成定義ファイル
- 〈この項の構成〉
(1) 形式
(2) 機能
TP1アダプタの通信構成定義に必要な情報は,XML形式のTP1アダプタの通信構成定義ファイルに定義します。次に示すディレクトリに格納されているサンプルファイルを利用して作成します。
<サービスプラットフォームのインストールディレクトリ>\CSC\custom-adapter\TP1\config\templates\adptp1_config.xml
このファイルは,開発環境でパッケージングしたあと,実行環境にインポートすることで,実行環境に反映されます。内容を変更する場合は,開発環境で再度パッケージングして実行環境にインポートしてください。
指定を省略する場合は,開始タグおよび終了タグを含めて省略してください。開始タグおよび終了タグの記述を残して要素の値だけを省略することはできません。
<active_mode>および<standcon_mode>を省略する場合の指定例を次に示します。
- 誤った指定例
: <connect_mode>STAND</connect_mode> <active_mode></active_mode> <standcon_mode></standcon_mode> <con_pool_num>64</con_pool_num> :
- 正しい指定例
: <connect_mode>STAND</connect_mode> <con_pool_num>64</con_pool_num> :
なお,一部の要素の値は,TP1アダプタ接続先動的変更機能を使って動的に変更することもできます。詳細については,マニュアル「サービスプラットフォーム 解説」の「2.7.6 TP1アダプタの接続先動的変更」を参照してください。
(3) ファイルの格納先
サンプルファイルは任意の名称で任意のディレクトリに保存してください。その後,TP1アダプタ環境定義ファイルの<entry key="adptp1_deffile">(TP1アダプタ通信構成定義ファイルのファイル名)で指定したファイル名を指定してください。
(4) 設定できる要素
<?xml version="1.0" encoding="UTF-8"?>
XMLファイルであることを示すXML宣言です。
<adaptertp1_properties>
TP1アダプタの通信構成定義のルート要素です。
<service_group> 〜<識別子>((1−31文字))
サービスグループ名を指定する要素です。この要素の値に接続先システムのサービスグループ名を指定してください。
MHP(Message Handling Program)を接続先としたTCP/IP接続の場合,この要素の値は無効となります。MHP以外の場合はこの要素は省略できません。
<operation>
オペレーション情報のルート要素です。この要素はオペレーションの数だけ定義できます。
MHPを接続先としたTCP/IP接続の場合,この要素は無効となり,この要素をルートとする要素の値も無効となります。MHP以外の場合はこの要素は省略できません。
-
<op_name> 〜<英数字>((1−256文字))
オペレーション名を指定する要素です。この要素の値に,サービスリクエスタからサービスを要求するときに指定するオペレーション名を指定してください。オペレーション名は重複しないよう指定してください。
-
<service_group> 〜<識別子>((1−31文字))
サービスグループ名を指定する要素です。この要素は省略できます。省略した場合は,ルート要素直下の<service_group>の値が適用されます。
この要素の値に接続先システムのサービスグループ名を指定してください。
-
<service> 〜<識別子>((1−31文字))
サービス名を指定する要素です。この要素は省略できません。
この要素の値に接続先システムのサービスグループに登録されているサービス名を指定してください。
-
<watch_time> 〜<符号なし整数>((0−65535))(単位:秒)<<180>>
応答監視時間を指定する要素です。この要素は省略できます。
この要素の値に,TP1アダプタから通信先のOpenTP1システムに対してサービス要求を行ってから応答を受信するまでの監視時間の最大値を指定します。なお,0を指定した場合は,応答を受信するまで無限に待ちます。
この要素の指定値は,TP1アダプタへサービス要求を行ったときに発生するOpenTP1システムとの通信にだけ有効です。有効範囲の詳細は,マニュアル「サービスプラットフォーム 解説」の「2.7.3 HCSCサーバからTP1アダプタを使ったTP1サービス部品の呼び出し」の通信処理の開始中および停止中に監視時間として適用される値について説明している表,および通信処理の運用中に監視時間に適用される値について説明している表を参照してください。
ここで指定した値は,TP1アダプタ接続先動的変更機能で動的に変更することもできます。
<connect_mode> 〜{STAND|RAP|STATIC|TCPIP}
接続方式を指定する要素です。この要素は省略できません。
この要素の値に,OpenTP1システムと接続するときの接続方式を指定してください。通信先を指定した接続を指定する場合は,STATICを指定してください。
指定できる値および意味は次のとおりです。
-
STAND:通常RPC接続
-
RAP:リモートAPI接続
-
STATIC:通信先を指定したRPC接続
-
TCPIP:MHPを接続先としたTCP/IP接続
- 注意事項
-
この要素に「STATIC」を指定した場合は,active_mode要素およびstandcon_mode要素の設定が無効となります。
<active_mode> 〜{STAND|EACH}<<STAND>>
確立方式を指定する要素です。この要素の指定値は,リモートAPI接続(connect_mode要素の設定値がRAP)の場合だけ有効です。この要素は省略できます。
この要素の値に,リモートAPI接続時に確立するコネクションの常設または非常設を指定してください。
指定できる値および意味は次のとおりです。
-
STAND:常設コネクション
-
EACH:非常設コネクション
<standcon_mode> 〜{AUTO|MANUAL}<<AUTO>>
常設コネクションの管理方法を指定する要素です。この要素の指定値は,リモートAPI接続で常設コネクションを確立する場合だけ有効です。この要素は省略できます。
この要素の値に,リモートAPI接続時に確立する常設コネクションの管理方法を指定してください。
指定できる値は次のとおりです。
-
AUTO:オートコネクトモード
-
MANUAL:非オートコネクトモード
<static_host> 〜<文字列>((1−255文字))
通信先を指定した接続をする場合の接続先のホスト名を指定する要素です。この要素は省略できます。
この要素の値に,接続先スケジュールサーバのホスト名を指定してください。
この要素の指定値は,RPCで通信先を指定した接続をする場合だけ有効です。そのため,次のどちらかに該当する場合は指定しても無効です。
-
ネームサービス,スケジューラダイレクト機能,またはリモートAPI機能を使用したRPCで接続する場合
-
MHPを接続先としたTCP/IP接続をする場合
ここで指定した値は,TP1アダプタ接続先動的変更機能で動的に変更することもできます。
<static_port> 〜<符号なし整数>((5001−65535))
通信先を指定した接続をする場合の接続先のポート番号を指定する要素です。この要素は省略できます。
この要素の値に,接続先スケジュールサーバのポート番号を指定してください。
この要素の指定値は,RPCで通信先を指定した接続をする場合だけ有効です。そのため,次のどちらかに該当する場合は指定しても無効です。
-
ネームサービス,スケジューラダイレクト機能,またはリモートAPI機能を使用したRPCで接続する場合
-
MHPを接続先としたTCP/IP接続をする場合
ここで指定した値は,TP1アダプタ接続先動的変更機能で動的に変更することもできます。
<con_pool_num> 〜<符号なし整数>((1−1024))
コネクションリソースのプーリング数を指定する要素です。この要素は省略できません。
この要素の値には,次の両方の条件を満たす数値を指定してください。
-
サービスアダプタ定義画面で指定する最大インスタンス数(TP1アダプタの最大インスタンス数)と同じ数値を指定してください。
最大インスタンス数より少ない数値を指定すると,サービス実行要求の受け付け数がこの要素の指定値を超えた場合,コネクションリソースが割り当てられなくなり,要求されたサービスがエラーとなります。
最大インスタンス数より多い数値を指定すると,差分のコネクションリソースが未使用のまま,余分なメモリを消費した状態となります。
-
接続先システムの同時処理数(RPC同時処理数またはTCP/IP同時処理数)の最大数を超えない値を指定してください。
<send_buff_size> 〜<符号なし整数>((1−8388608))(単位:バイト)<<4096>>
送信バッファサイズを指定する要素です。この要素は省略できます。
この要素の値に,接続先OpenTP1システムに要求する送信メッセージの最大長を指定してください。
なお,TP1/Client/J環境定義ファイルのdccltrpcmaxmsgsizeオペランドで指定されている値より大きな値を指定することはできません。TP1/Client/J環境定義ファイルについては,マニュアル「サービスプラットフォーム 解説」の「付録A.2 TP1/Client/Jの定義」を参照してください。
<recv_buff_size> 〜<符号なし整数>((1−8388608))(単位:バイト)<<4096>>
受信バッファサイズを指定する要素です。この要素は省略できます。
この要素の値に,接続先OpenTP1システムから受信メッセージの最大長を指定してください。
なお,TP1/Client/J環境定義ファイルのdccltrpcmaxmsgsizeオペランドで指定されている値より大きな値を指定することはできません。TP1/Client/J環境定義ファイルについては,マニュアル「サービスプラットフォーム 解説」の「付録A.2 TP1/Client/Jの定義」を参照してください。
<tcpip_wait_time> 〜<数字>((-1−65535))(単位:秒)<<180>>
メッセージ受信時の最大待ち時間を指定する要素です。この要素は,MHPを接続先としたTCP/IP接続を利用する場合だけ有効です。それ以外の場合で値を設定しても無効となります。この要素は省略できます。
この要素の値に,MHPから送信されたメッセージがTP1アダプタで受信完了するまでの,待ち時間の最大値を指定します。指定値に応じて次のように動作します。
-
-1を指定した場合
受信が完了するまで無限に待ち続けます。
-
0を指定した場合
メッセージ受信実行時にすでにメッセージが届いていれば受信します。
受信するメッセージが無かった場合は例外が発生し,TP1アダプタは応答領域にFault情報を設定して応答を返します。
-
1から65535までの数値を指定した場合
指定した秒数だけメッセージの受信を待ちます。指定した秒数を過ぎてもメッセージの受信が完了しない場合は例外が発生し,TP1アダプタは応答領域にFault情報を設定して応答を返します。
ここで指定した値は,TP1アダプタ接続先動的変更機能で動的に変更することもできます。