データソース定義を設定する¶
ここでは、データソース定義の設定方法ついて説明します。
データソース定義とは¶
データソース定義は、外部連携する場合のインターフェースを抽象化し、Webサービスでも、テーブルでも、同じインタフェースで連携する抽象化層の定義です。データソース定義では、外部連携機能を設定します。
データソース定義の設定方法¶
「データソース - 新規登録」画面の機能と各部の説明¶
「データソース - 新規登録」画面の内容は以下の通りです。
データソース種別
データソースの種別を選択します。データソースの種別は、以下の通りです。
- テナントDBクエリ：テナントDBからデータを取得します。
- シェアードDBクエリ：シェアードDBからデータを取得します。
- REST：REST APIを使用して、Webサービスを利用できるように設定します。
- SOAP：WSDLを使用して、Webサービスを利用できるように設定します。
- JAVA：Javaプログラムを連携できるように設定します。
- CSVインポート：CSVのインポートができるように設定します。
- CSVエクスポート：CSVのエクスポートができるように設定します。
データソース名
データソース定義の名称を入力します。ここで設定した名称がデータマッパーなどで表示されます。備考
登録するデータソースの説明を入力します。他のロケール
クリックすると表示しているロケール以外のロケールに個別にデータソース名や備考の入力欄を表示します。コラム
データソース種別「ルール」は、OpenRules 機能強化モジュールを導入した場合のみ利用できます。ルールの設定などの詳細については「OpenRules 簡易操作ガイド」を参照してください。
「データソース - 新規登録」画面の操作手順¶
「テナントDBクエリ」を設定する場合を例に、「データソース - 新規登録」画面の操作手順について説明します。
「サイトマップ」→「IM-BIS」→「システム管理者」→「マスタ管理」→「外部連携」→「データソース定義」をクリックします。
「データソース - 一覧」画面で「登録」をクリックします。
「データソース種別」で任意のデータソース種別を選択します。
任意の「データソース名」、「備考」を入力して「登録」をクリックします。
階層化したリクエストパラメータ、レスポンスフィールドの設定方法¶
呼び出す対象のパラメータ・フィールドの設定が、階層構造となる場合には、呼び出し先で指定した階層に合わせて設定します。階層構造となるパラメータ・フィールドの定義と、データソース定義の設定例は、以下の図の通りです。
上記の図のように設定すると、データマッパーでは、ツリー形式で階層化して表示します。
コラム
レスポンスで名称を入力せずに設定したパラメータ・フィールドはデータマッパー上で以下のように表示します。
- データ型が「object」の場合、「OBJECT」と表示します。
- データ型が「array」の場合、「ARRAY」と表示します。
- データ型が「string」「number」「date」「boolean」のいずれかの場合、「VALUE」と表示します。
BIS業務管理者が、各データソース定義を利用するための設定をする¶
登録したデータソース定義をBIS業務管理者が利用するためには、登録後に以下のリンク先の手順に従って、管理グループの管理対象に追加してください。