3.3.6 TP1アダプタを定義する
TP1アダプタの定義方法について説明します。
- 〈この項の構成〉
(1) 電文フォーマットの作成
サービスリクエスタ,TP1アダプタ,およびサービスの間でやり取りされる電文フォーマットを作成します。電文フォーマットの作成方法については,マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「4. 電文フォーマットの作成」を参照してください。
(2) データ変換の定義
データ変換定義画面で,変換元の電文フォーマット定義ファイルおよび変換先の電文フォーマット定義ファイルを設定して,データ変換を定義します。
データ変換の定義方法については,マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「7. データ変換の定義」を参照してください。
(3) サービスアダプタ定義画面での操作
TP1アダプタを定義する場合の手順を次に示します。
-
サービスアダプタ定義画面を表示します。
サービスアダプタ定義画面の表示方法については,「3.3.1(4) サービスアダプタ定義画面の表示」を参照してください。
-
サービス部品制御情報の[サービス名]および[サービスID]を必要に応じて編集します。
-
サービス部品制御情報の[追加]ボタンをクリックして,オペレーションを追加します。
-
オペレーション情報の[通信モデル]のドロップダウンリストから,「同期」または「非同期」を選択します。
-
要求電文について,手順6.から手順15.までを実施します。
-
次に示す操作をします。
- 標準電文のフォーマットを指定する場合
-
手順7.〜9.を実施して,手順10.に進みます。
- 標準電文のフォーマットを指定しない場合
-
手順10.に進みます。
-
標準電文の[使う]チェックボックスをチェックします。
-
標準電文の[参照]ボタンをクリックして,[電文フォーマット]に標準電文のフォーマットを指定します。
指定できる電文フォーマットの形式については,マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「2.6.5 XMLスキーマの適用範囲」を参照してください。
-
標準電文の[表示]ボタンをクリックします。
電文フォーマットがXML形式の場合,標準電文のフォーマットが表示されます。必要に応じて指定した標準電文のフォーマットを確認してください。
-
サービス部品電文の[参照]ボタンをクリックして,[電文フォーマット]にサービス部品電文のフォーマットを指定します。
-
サービス部品電文の[表示]ボタンをクリックします。
電文フォーマットがXML形式の場合,サービス部品電文のフォーマットが表示されます。必要に応じて指定したサービス部品電文のフォーマットを確認してください。
-
次に示す操作をします。
- 標準電文の[使う]チェックボックスをチェックした場合
-
手順13.〜15.を実施して,手順16.に進みます。
- 標準電文の[使う]チェックボックスをチェックしない場合
-
手順16.に進みます。
-
データ変換定義のファイル名を入力します。
-
[編集]ボタンをクリックします。
データ変換定義画面が表示されます。初めて定義する場合は,[ルート要素選択]ダイアログが表示されます。
-
標準電文とサービス電文の内容をマッピングします。
-
応答電文についても,手順6.から手順15.までを実施します。
-
サービスアダプタ定義(詳細)タブをクリックします。
サービスアダプタ定義(詳細)画面が表示されます。
-
サービスアダプタ(EJB-JARファイル)の名称を確認します。
-
ユーティリティクラス(JARファイル)に次のユーティリティクラスが追加されていることを確認します。
-
adptp1pc.jar(プロトコルコンバータアーカイブファイル)
-
-
独自定義ファイルに次のファイルが追加されていることを確認します。
-
adptp1_config.xml(TP1アダプタ通信構成定義ファイル)
-
customadapter_properties.xml(TP1アダプタ環境定義ファイル)
-
(4) TP1アダプタ環境定義ファイルの編集
TP1アダプタの環境定義に必要な情報は,XML形式のTP1アダプタ環境定義ファイルに定義します。
TP1アダプタ環境定義ファイルの編集手順を示します。
-
サービスアダプタ定義画面(詳細)の[独自定義ファイル]で「customadapter_properties.xml」を選択し,[編集]ボタンをクリックします。
TP1アダプタ環境定義ファイルを編集するためのエディタが起動します。
-
エディタ上でTP1アダプタ環境定義ファイルを編集します。
TP1アダプタ環境定義ファイルの詳細は,マニュアル「サービスプラットフォーム リファレンス」の「3.4.2 TP1アダプタ環境定義ファイル」を参照してください。
-
Eclipseのメニューから[ファイル]−[保管]を選択し,定義内容を保存します。
(5) TP1アダプタ通信構成定義ファイルの編集
TP1アダプタの通信構成定義に必要な情報は,XML形式のTP1アダプタ通信構成定義ファイルに定義します。
TP1アダプタ通信構成定義ファイルの編集手順を示します。
-
サービスアダプタ定義画面(詳細)の[独自定義ファイル]で「adptp1_config.xml」を選択し,[編集]ボタンをクリックします。
TP1アダプタ通信構成定義ファイルを編集するためのエディタが起動します。
-
エディタ上でTP1アダプタ通信構成定義ファイルを編集します。
TP1アダプタ通信構成定義ファイルの詳細は,マニュアル「サービスプラットフォーム リファレンス」の「3.4.3 TP1アダプタ通信構成定義ファイル」を参照してください。
-
Eclipseのメニューから[ファイル]−[保管]を選択し,定義内容を保存します。
(6) TP1アダプタの設定項目の反映
TP1アダプタを選択した状態で,「保存」メニューを選択すると設定項目を保存できます。このときに保存されるファイルがEARファイルです。EARファイルは運用環境から利用できます。
(7) TP1アダプタ実行環境プロパティファイルの作成
TP1アダプタ実行環境プロパティファイルの作成方法について説明します。
TP1アダプタ実行環境プロパティファイルは,サンプルファイルを利用して作成します。サンプルファイルの格納先を次に示します。
<サービスプラットフォームのインストールディレクトリ>\CSC\custom-adapter\TP1\config\templates\adptp1.properties
TP1アダプタ実行環境プロパティファイルの作成手順を次に示します。
-
サンプルファイルをコピーして,次のディレクトリに格納します。
-
全HCSCサーバ共通の定義の場合
<サービスプラットフォームのインストールディレクトリ>\CSC\custom-adapter\TP1\config
-
特定のHCSCサーバ用の定義の場合
<サービスプラットフォームのインストールディレクトリ>\CSC\custom-adapter\TP1\config\<HCSCサーバ名>※
注※ サブディレクトリ<HCSCサーバ名>は,ユーザが作成してください。Windowsの場合,ディレクトリ名は大文字と小文字は区別しません。また,HCSCサーバ用のディレクトリには,HCSCサーバの管理者のアクセス権限を設定する必要があります。
-
-
サンプルファイルの名称を<サービスID>.propertiesに変更します。
-
定義内容を編集して保存します。
TP1アダプタ実行環境プロパティファイルは,TP1アダプタを開始する際に実行環境に反映されます。TP1アダプタ実行環境プロパティファイルの内容を変更する場合は,TP1アダプタを停止してから作業を行います。TP1アダプタを再開始すると,変更内容が実行環境に反映されます。
TP1アダプタ実行環境プロパティファイルの詳細は,マニュアル「サービスプラットフォーム リファレンス」の「6.7.1 TP1アダプタ実行環境プロパティファイル」を参照してください。
(8) TP1/Client/J環境定義の設定
TP1アダプタのRPC通信で使用するサービス要求方式によって,Service Architectで指定する環境定義の値が異なります。必ず各サービス要求方式に対応するTP1/Client/J環境定義を指定してください。
ここで説明する以外のTP1/Client/J環境定義については,マニュアル「サービスプラットフォーム 解説」の「付録A.1 TP1/Client/Jの機能」を参照してください。
TP1/Client/J環境定義は,TP1アダプタを開始する際に実行環境に反映されます。TP1/Client/J環境定義の内容を変更する場合は,TP1アダプタを停止してから作業を行います。TP1アダプタを再開始すると,変更内容が実行環境に反映されます。
(a) リモートAPI機能を使用する場合
リモートAPI機能を使用する場合,RPC接続の確立方式および常設コネクションの管理方法によって,TP1/Client/Jで指定する環境定義の値が異なります。TP1アダプタの通信構成定義およびTP1/Client/J環境定義の対応を次の表に示します。
リモートAPI機能を使用する場合のTP1/Client/J環境定義を次の表に示します。
(b) ネームサービス機能を使用する場合
ネームサービス機能を使用する場合,TP1アダプタの通信構成定義のconnect_mode要素にSTANDを指定します。ネームサービス機能を使用する場合のTP1/Client/J環境定義を次の表に示します。
(c) スケジューラダイレクト機能を使用する場合
スケジューラダイレクト機能を使用する場合,TP1アダプタの通信構成定義のconnect_mode要素にSTANDを指定します。スケジューラダイレクト機能を使用する場合のTP1/Client/J環境定義を次の表に示します。
(d) 通信先を指定した接続をする場合
TP1アダプタで通信相手と通信先を指定した接続をする場合,TP1アダプタの通信構成定義のconnect_mode要素にSTATICを指定します。通信先を指定した接続をする場合のTP1/Client/J環境定義を次の表に示します。
TP1/Client/J環境定義 |
指定値 |
説明 |
---|---|---|
dcnamuse |
N(使用しない) |
ネームサービス機能の使用の有無を指定します。 |
dcrapdirect |
N(使用しない) |
リモートAPI機能の使用の有無を指定します。 |
dcscddirect |
Y(使用する) |
スケジューラダイレクト機能の使用の有無を指定します。 |
- 注意事項
-
次の表に示すオペランドの定義項目は使用されません。接続先のホスト名,ポート番号の情報は,TP1アダプタの通信構成定義のstatic_hostおよびstatic_port要素を使用します。また,dcrapautoconnectオペランドの定義は無効となります。
表3‒20 通信先指定による接続時に使用されないTP1/Client/J環境定義 TP1/Client/J環境定義
指定値
説明
dchost
ホスト名,スケジューラダイレクトサービスのポート番号
スケジューラダイレクトサービスが存在する接続先システムのホスト名,およびスケジューラダイレクトサービスのポート番号
dcscdport
スケジューラダイレクトサービスのポート番号
スケジューラダイレクトサービスのポート番号