付録C.2　DBアダプタの定義

(1)　SQL設計

DBアダプタ定義支援機能を使って，DBアダプタ上で実行するSQL文の内容を設計します。SQL実行文の表や列の名称およびデータなどの可変部分については，引数要素として設計します。

ただし，DBアダプタ定義支援機能で指定できるSQL命令は，デフォルトで次の2つです。

• SELECT

• INSERT

SQLオペレーション定義ファイルでsqloperation_chk属性にNを指定することで，次のSQLをSQL命令に指定できます。

• UPDATE

• DELETE

また，指定できるデータ型は，DB Connectorで使用するJDBCドライバがサポートしているデータ型だけです。

ページの先頭へ

(2)　DBアダプタの設計

DBアダプタの内容を設計します。次の内容について設計してください。

ページの先頭へ

(3)　デバッグ用のDBアダプタの定義ファイルの生成

デバッグに使用するDBアダプタの定義ファイルのひな形を作成します。DBアダプタの定義ファイルは，Eclipse上で作成します。DBアダプタの定義ファイルを新規作成する方法を次に示します。

注意事項

• DBアダプタ定義ファイルの編集中に次のメッセージが表示された場合，［パッケージ・エクスプローラー］ビュー上で，プロジェクトを選択して右クリックし，［更新］メニューを選択してリソースとファイル・システムを同期させてください。

  リソース '<ファイルパス>' はファイル・システムと非同期です。

• DBアダプタ定義ファイルを削除する場合，DBアダプタ定義ファイル作成時に作られた出力先ディレクトリは削除されません。必要に応じて，削除してください。

• DBアダプタ定義ファイルを操作する場合は，HCSCTE-DBEditorパースペクティブ選択時に開かれるビューを使用してください。

1. Eclipse上にプロジェクトを作成します。

   プロジェクトの種類は，HCSCTEプロジェクトを推奨します。HCSCTEプロジェクトの作成方法については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「3.1.1　プロジェクトを作成する」を参照してください。

2. Eclipseのメニューから，［ウィンドウ］−［パースペクティブを開く］−［その他］を選択します。

   ［パースペクティブを開く］ダイアログが表示されます。

3. ［HCSC-DBEditor］を選択し，［開く］ボタンをクリックします。

   ［DBアダプタ開発支援］パースペクティブが表示されます。

4. Eclipseのメニューから，［ファイル］−［新規］−［その他］を選択します。

   ウィザードを選択するダイアログが表示されます。

5. ［HCSCTE-DBEDITOR］の［DBEditor ファイル］を選択して，［次へ］ボタンをクリックします。

   新規DBアダプタ定義ファイルウィザードが表示されます。

6. ［親フォルダを入力または選択］で，DBアダプタの定義ファイルを保存するフォルダを入力または選択します。

7. 保存する定義ファイルのファイル名を［ファイル名］に指定します。

8. ［終了］ボタンをクリックします。

   新しい定義ファイルが作成され，DBアダプタ開発支援画面が表示されます。

   

ページの先頭へ

(4)　デバッグ用のデータベースの設定

DBアダプタの定義ファイルに，使用するデータベースの内容を設定します。本番環境用のデータベースとは別にデバッグ用のデータベースを使用するかどうかによって，設定方法が異なります。デバッグ用のデータベースを使用しない場合は，SQLのデバッグができません。

参考

Service Architectに含まれる構成ソフトウェアのHiRDB/Single Serverをインストールすると，デバッグ用のデータベースとして使用できます。インストールの詳細については，マニュアル「サービスプラットフォーム 開発ガイド 基本開発編」の「2.1.2　インストール」を参照してください。

ページの先頭へ

(5)　SQL文の作成

DBアダプタ上で実行するSQL文を定義します。

1. Eclipse上でDBアダプタの定義ファイルを開きます。

   DBアダプタ開発支援画面が表示されます。

2. ［データソース］プルダウンリストから，使用するデータソースを選択します。

   

3. ［オペレーション］プルダウンリストの横の［追加］ボタンをクリックします。

   追加するオペレーションの名称を定義するダイアログが表示されます。

   

4. 追加するオペレーション名を入力し，［OK］ボタンをクリックします。

   1つのDBアダプタに複数のSQLを定義したい場合は，オペレーションを呼び出すSQLごとに定義します。

5. SQL文の入力フィールドに実行するSQL文を定義します。

   引数要素の定義方法については，「●SQLオペレーション定義ファイルの形式」を参照してください。

注意事項

• 各オペレーションに記述できるSQLは1つだけです。

• ワイルドカード（*）は使用できません。SELECTで検索するカラム名は，すべて記述してください。

• SQL文の最後にセミコロンは不要です。

ページの先頭へ

(6)　SQLのデバッグ

定義したSQLのデバッグを実施します。SQL文中の引数要素については，値を代入して実行します。なお，SQLのデバッグは，本番環境用のデータベースとは別に，デバッグ用のデータベースを用意している場合にだけ実施できます。

次の手順でSQLのデバッグを実施してください。

1. デバッグ用のテーブルを作成します。

   事前にデバッグ用のデータベース上にデバッグで使用するテーブルを作成します。定義したSQLに沿ってテーブルを作成してください。

   作成例

   テーブル名：PURCHASEMASTERTABLE

   テーブル構成：

   ORDERID (VARCHAR)	ORDERNAME (VARCHAR)	PRODUCTCODE (VARCHAR)	PRODUCTNAME (VARCHAR)	NUMBER (INTEGER)
   01	AA001	0A1	NPW	4
   02	AA002	0A1	NPW	3
   03	AA003	0E1	NPW	3
   04	BB001	0E1	NPW	4
   05	BB002	0B1	NPW	5

2. Eclipse上でDBアダプタの定義ファイルを開きます。

   DBアダプタ開発支援画面が表示されます。

   

3. 引数要素を抽出したいSQL文を［オペレーション］プルダウンリストから選択した状態で，ツールバーの［変数の生成］アイコン（［変数］タブに反映されます。

   

4. ［変数］タブの［値］列に，デバッグで使用したい値を入力します。

   設定例

   引数要素名	DBa_inf	data_type	値
   KEYCOLUMN	column	−	ORDERID
   ENZANSHI	preset	−	=
   DATA	data	VARCHAR	'01'

   なお，デバッグ用のデータベースを用意していない場合は，以降の手順を実施できません。［実行するSQL文の表示］アイコン（）をクリックすると，Messagesビューに引数要素に値を代入した状態のSQLが表示されるので，この画面でSQL文が正しいかどうかを確認してください。

   

5. ［コネクション］タブに表示されている，デバッグに使用するデータソースを右クリックし，［接続］を選択します。

   設定した内容でデータベースに接続します。接続が成功すると，Messagesビューに，「INFO: データソース <データソース名> の接続に成功しました。」のメッセージが表示されます。

   なお，SQL文が複数定義されている場合は，SQL文ごとに手順3〜手順5を繰り返してください。

6. ツールバーにある［SQLの実行］アイコン（）をクリックします。

   SQLの実行に失敗した場合は，Messagesビューにエラーメッセージが表示されます。メッセージに従ってSQLおよび引数要素名を修正してください。

   なお，SQLの実行結果は，［実行結果］タブに表示されます。

   

ページの先頭へ

(7)　本番環境用のデータベースの設定

DBアダプタの定義ファイルのデータソースの設定を，本番環境用のデータベースの情報に変更します。

注意事項

本番環境用のデータベースの情報に変更する前に，デバッグで使用したデータリソースを切断しておいてください。データソースの切断方法は，次のとおりです。

1. デバッグで使用したDBアダプタの定義ファイルをEclipse上で開きます。

2. ［コネクション］タブで，デバッグに使用したデータソースを右クリックし，［切断］を選択します。

次の手順でデータベースの情報を変更します。

1. デバッグで使用したDBアダプタの定義ファイルをEclipse上で開きます。

   DBアダプタ開発支援画面が表示されます。

2. ［コネクション］タブに表示されているデータソースを右クリックして，［データソース編集］を選択します。

   ［データソース編集］ダイアログが表示されます。

3. ［DBアダプタ設定］の入力フィールドに本番環境用のデータベースの情報を入力します。

   

4. ［OK］ボタンをクリックします。

   設定した内容が登録されます。

ページの先頭へ

(8)　本番環境用のDBアダプタの定義ファイルの生成

本番環境で使用するDBアダプタの定義ファイルの生成方法を次に示します。

1. Eclipse上で，デバッグ用のDBアダプタの定義ファイルを開きます。

   DBアダプタ開発支援画面が表示されます。

2. ［データソース］プルダウンリストから，本番環境用のDBアダプタの定義ファイルに反映させたいデータソースを選択します。

   

3. ツールバーの［DBアダプタ定義生成］アイコン（）をクリックします。

   ［DBアダプタ定義生成］ダイアログが表示されます。

   

4. ［出力先ディレクトリ］に，本番環境用のDBアダプタの定義ファイルを出力するディレクトリを指定します。

   ［...］ボタンをクリックすると，［出力先ディレクトリ］に次のパスが選択されます。

   ＜Eclipseのプロジェクトのパス＞\＜DBアダプタの定義ファイル名＞_Output

   注意事項

   • 出力先ディレクトリにEclipseのプロジェクトのパスを指定した場合は，Eclipseの機能を使って，DBアダプタの定義ファイルおよび生成結果を一括でインポートおよびエクスポートできます。

   • 出力先ディレクトリ名は，絶対パスをUTF-8で変換したときに155バイト以内になるように指定してください。

5. 生成したいオペレーションのチェックボックスにチェックします。

   1つのDBアダプタに複数のSQL文を定義した場合は，SQLの定義に必要なオペレーションをすべて選択してください。

6. ［終了］ボタンをクリックします。

   指定した出力先ディレクトリに，本番環境で使用するDBアダプタの定義ファイルが出力されます。

   なお，出力先ディレクトリにEclipseのプロジェクトのパスを指定している場合は，DBアダプタの定義ファイルを生成したあとに，出力先となるEclipseのプロジェクトを更新してください。Eclipseのパッケージ・エクスプローラー上に，生成されたDBアダプタの定義ファイルが表示されます。

   生成されるファイルの一覧を次の表に示します。

   表C‒3　生成されるファイルの一覧

   ファイルの種別	ファイル名	数量	備考
   SQLオペレーション定義ファイル	csa_sql_dbadapter.xml	1	−
   アプリケーション統合属性ファイル	cscadapter_property.xml	1	−
   要求電文の標準電文※1	＜オペレーション名＞_Input.xsd	0〜N※2	＜オペレーション名＞は，指定したオペレーション名になります。
   応答電文の標準電文※3	＜オペレーション名＞_Output.xsd	0〜N※2	＜オペレーション名＞は，指定したオペレーション名になります。
   要求電文および応答電文のサービス部品電文	ServiceMessageFile.xsd	1	要求電文および応答電文のサービス部品電文には，同じファイルを使用してください。

   （凡例）

   −：該当する説明はありません。

   注※1

   SQL文中に引数要素がない場合，要求電文の標準電文は生成されません。サービス部品電文だけを使用してください。引数要素がない状態でDBアダプタを呼び出す場合は，Java呼出アクティビティなどで要求電文を生成して，DBアダプタを呼び出します。

   設定例

   　オペレーション名：select_op

   　実行するSQL文：SELECT ORDERID FROM PURCHASEMASTERTABLE

   　Java呼出アクティビティなどで生成する電文：

   　<?xml version="1.0" encoding="UTF-8"?>

   　<DBadapter>

   　　　<DBA_MULTI_SQL>

   　　　　　<select_op>

   　　　　　　　<DBA_IN_DATA/>

   　　　　　</select_op>

   　　　</DBA_MULTI_SQL>

   　</DBadapter>

   注※2

   本番環境用のDBアダプタの定義ファイルを生成したときに指定したオペレーションの数になります。

   注※3

   応答電文の標準電文は，SQL命令がSELECTの場合にだけ出力されます。INSERTの場合は，応答電文のサービス部品電文フォーマットを使用してください。

ページの先頭へ

(9)　本番環境用のDBアダプタの設定

生成した本番環境用のDBアダプタの定義ファイルを使用して，DBアダプタを作成します。

ページの先頭へ