デザイン > サービスコネクタのデザイン > データアクセスサービスコネクタの作成
  

データアクセスサービスコネクタの作成

Secure Agentでデータアクセスサービスコネクタを作成し、データベースから直接データにアクセスできます。
データアクセスサービスコネクタを使用して、次のデータベースに接続できます。
注: パーソナルアクセストークン(PAT)を使用してDatabricksデータベースに接続します。Databricksへの接続に関するさまざまな制限の詳細については、Databricksのルールとガイドラインを参照してください。
データアクセスサービスコネクタは、データベースと直接対話するためのプロパティを定義し、変数を指定することで作成できます。また、データアクセスサービスコネクタと関連付けられたアクションを定義することもできます。
データアクセスサービスコネクタを作成する前に、必要なJDBC JARファイルを次のディレクトリにコピーし、Secure Agentを再起動する必要があります。
<Secure Agentのインストールディレクトリ>/apps/process-engine/ext
使用するデータベースに基づいて、以下のJDBC JARファイルをダウンロードします。
データベース名
JARファイル
Databricks
DatabricksJDBC42.jar
IBM DB2
db2jcc4.jar
MySQL
mysql-connector-java-5.1.40-bin.jar
Oracle
ojdbc8.jar
SQL Server
sqljdbc41.jar
注: JARファイルは、使用するデータベースのバージョンとの互換性がある必要があります。
データアクセスサービスコネクタを作成するには、次の手順を実行します。
  1. 1アプリケーションの統合で、[新規] > [サービスコネクタ]をクリックします。
  2. 2[新しいアセット]ダイアログボックスで、[フォームを使用したデータアクセスサービスコネクタ]をクリックし、[作成]をクリックします。
  3. この図は、[新しいアセット]ダイアログボックスを示しています。

プロパティの定義

データアクセスサービスコネクタを作成してプロパティを定義するには、次の手順を実行します。
  1. 1アプリケーションの統合で、[新規] > [サービスコネクタ] > [フォームを使用したデータアクセスサービスコネクタ] > [作成]をクリックします。
  2. データアクセスサービスコネクタエディタが表示されます。
    次の図は、データアクセスサービスコネクタエディタを示しています。
    この図は、データアクセスサービスコネクタエディタを示しています。
  3. 2[定義]タブで、データアクセスサービスコネクタについて次の基本プロパティを定義します。
  4. アプリケーション接続に関連するプロパティの詳細については、「デザイン」を参照してください
    アプリケーション接続をパブリッシュした後に、アプリケーション接続の[プロパティの詳細]ページで、ODataサービスURLとOData Swagger URLを確認できます。
  5. 3[接続プロパティ]セクションで、外部データベースに接続するための次の全般プロパティを定義します。
  6. 4必要に応じて、[接続プロパティ]セクションで、次の詳細プロパティを定義します。

変数の指定

データアクセスサービスコネクタを設定するには、変数を指定して出力フィールドを定義することが必要になる場合があります。

ビルトイン変数

次の変数は、XQuery式を使用してデータアクセスサービスコネクタで参照できます。
変数
変数型
説明
$VariableName
すべての接続プロパティ
入力フィールドと出力フィールドは、この形式を使用して指定できます。
$Response
出力フィールドマッピング
応答XMLデータが含まれます。これは、データアクセスサービスコネクタの[テスト結果]タブに表示されます。

アクションの定義

[アクション]タブでは、データアクセスサービスコネクタと関連付けられた1つ以上のアクションを作成して記述できます。
次の図は、[アクション]タブを示しています。
この図は、[アクション]タブを示しています。
編集する行をクリックするか、[+]をクリックして新しい行を追加し、[アクション]タブで次の情報を入力します。
各アクションについて、[入力][SQLバインディング][出力][テスト結果]の各タブに追加の詳細を指定します。

[入力]タブ

[入力]タブを使用して、データの送信先サービスに固有の入力データ項目を定義します。
次の図は、[入力]タブを示しています。
この図は、[入力]タブを示しています。
各項目に対し、次のプロパティを入力します。
[+]アイコンを使用し、新しい項目を追加します。[X]をクリックして現在の行を削除します。

[SQLバインディング]タブ

データアクセスサービスコネクタの各アクションについて、[SQLバインディング]タブを使用して、データソースからデータにアクセスするための複数のSQLクエリを指定します。SQLエントリが作成されると、タブには、SQL名、SQLテキスト、式のカラムの大文字と小文字、クエリタイプ、SQLクエリによって返される最大行数、最大待機時間(秒)などの詳細が表示されます。
複数のクエリを追加すると、テーブルに表示されているクエリの順序でSQL文が実行されます。矢印ボタンを使用してクエリを上下に移動できます。SQLクエリを削除することもできます。
SQLエントリの行を追加するには、[SQLバインディング]タブの[+]をクリックします。各SQLクエリの次の詳細を入力します。
SQL名前
SQLクエリの名前。
SQLテキスト
少なくとも1行を返す有効なSQL文。
カラムの大文字と小文字
式内の文字を小文字または大文字に変換する必要があるか、または変更しないままにするかを指定します。デフォルトは[小文字]です。
タイプ
次のいずれかの値を選択します。
結果セットあり
将来の使用のために予約済み。
最大行数
SQLクエリによって返され、SQL応答ペイロードに表示できる最大行数。デフォルトは100行です。最大行数は10,000行以下にする必要があります。
最大待機時間(秒)
データベースクライアントがセッションをタイムアウトするまでにデータベースからの応答を待機できる最大時間(秒)。
注: アプリケーション統合は、すべてのSQLクエリを実行した後にコミットを実行しません。SQLクエリが失敗した場合のロールバックを支援するために、コミットはすべてのSQLクエリが実行された後の最後にのみ行われます。一部のデータベースでは、CREATE TABLE、DROP TABLEなどのDDL文に対して暗黙的なコミットが発生します。これらの実行はロールバックできません。

データアクセスコネクタのストアドプロシージャの出力フィールド設定

データアクセスサービスコネクタでストアドプロシージャを使用する場合は、出力フィールドを設定できます。
ストアドプロシージャでは、MySQL、SQL Server、Oracle、PostgreSQL、またはDB2など、使用するDBMSに応じていくつかの方法で出力フィールドを定義することができます。出力フィールドを使用して、データを呼び出し元のアプリケーションに戻すこともできます。ストアドプロシージャにより、データベースに対して複数のクエリを実行する代わりに、1回の呼び出しで複数の出力フィールドを返すことで、ネットワークトラフィックを削減します。

ストアドプロシージャでの出力フィールドの設定

データアクセスサービスコネクタでストアドプロシージャを使用するときに出力フィールドを設定するには、次の手順を実行します。
    1[SQLバインディング]タブで、[+]アイコンをクリックしてSQLエントリを追加します。
    2[編集]アイコンをクリックして、SQLクエリを編集します。
    複数のSQLクエリを設定するための[SQLの作成]ページが表示されます。
    3SQLクエリの名前を入力します。
    4[型]リストで、[ストアドプロシージャ]を選択します。
    次の画像に示すように、[SQLの作成]ページの名前が[ストアドプロシージャの呼び出し]に変わります。
    5[ストアドプロシージャ]フィールドに、次の形式でクエリを入力します。
    <SQL文> <ストアドプロシージャの名前>(?);
    例えば、次のサンプルに示すようにクエリを入力します。
    CALL GetTotalSales(?)
    注: [ストアドプロシージャ]テキストボックスに指定する? 記号の数は、[出力フィールド]セクションで定義する出力フィールドの数と一致している必要があります。ストアドプロシージャでINOUTパラメータを指定することはできません。
    6[出力フィールド]セクションで、[+]をクリックします。
    7それぞれの出力フィールドに対して次のプロパティを設定します。
    8カラムのケースを選択します。
    9SQLクエリによって返され、SQL応答ペイロードに表示できる最大行数を入力します。
    10データベースクライアントがセッションをタイムアウトするまでにデータベースからの応答を待機できる最大時間(秒)を入力します。
    11[作成]をクリックします。
    次の画像に、ストアドプロシージャにサンプル値が指定された[ストアドプロシージャの呼び出し]ページを示します。
    この画像は、ストアドプロシージャにサンプル値が指定された[ストアドプロシージャの呼び出し]ページを示しています。
    上記の例では、ユーザーは[ストアドプロシージャ]フィールドに次のクエリを入力しています。
    CALL GetTotalSales(?);
    対応する出力フィールドが、[出力フィールド]セクションに表示されています。そして、この出力フィールドは、次の図に示すようにデータアクセスサービスコネクタのプロパティページの[出力]タブにあるサービスコネクタの出力フィールドにマッピングされています。
    この画像は、[出力]タブのサービスコネクタの出力フィールドにマッピングされた出力フィールドを示しています。
    出力フィールドには、次のデータ型のリストを設定することができます。
    次のスニペットは、CALL GetTotalSales(?)ストアドプロシージャが実行されたときの出力のサンプルの応答を示しています。

    {
    "outSPProcess":"<multiDataAccessResponse xmlns:aetgt=\"http:\/\/schemas.informatica.com\/socrates\/data-services\/2014\/05\/business-connector-model.xsd\" xmlns:bconn=\"http:\/\/schemas.informatica.com\/socrates\/data-services\/2014\/05\/business-connector-model.xsd\"><dataAccessResponse><result><statementId>StoredProc_WithOutputFields<\/statementId><row><TotalSales>3.00<\/TotalSales><\/row><\/result><\/dataAccessResponse><\/multiDataAccessResponse>"
    }

複数のSQLクエリの設定

SQLクエリを追加および編集するには、次の手順を実行します。
    1[SQLバインディング]タブで、[+]アイコンをクリックしてSQLエントリを追加します。
    SQLエントリがテーブルに追加されます。
    2[編集]アイコンをクリックして、SQLクエリを編集します。
    [SQLの作成]ページが表示されます。次の図は、複数のSQLクエリを設定できる[SQLの作成]ページを示しています。この図は、[SQLの作成]ページを示しています。
    3[SQLの作成]ページで、SQL名、SQLクエリ、クエリのカラムの大文字と小文字、クエリタイプ、最大行数、最大待機時間などのSQLクエリのプロパティを設定します。
    SQLクエリを使用することで、SELECT、INSERT、DELETE、UPDATEなどのさまざまなデータ操作を実行できます。SQLクエリの入力フィールドをパラメータ化することができます。次の構文を使用して、実行時に入力フィールドをパラメータ化します。
    '{$<input_field_name>}'
    例えば、empIdが入力フィールドの名前である場合は、次のSQLクエリを入力してempIdフィールドをパラメータ化します。
    select * from employee.contact where id = '{$empid}'
    4[作成]をクリックします。

SQLクエリの応答形式

データアクセスサービスコネクタでは、単一および複数のSQLクエリに対するXML応答は、multiDataAccessResponseタグから始まります。
次のスニペット例は、プロセスまたはデータアクセスサービスの出力としての形式を示しています。

<multiDataAccessResponse xmlns:aetgt="http://schemas.informatica.com/socrates/data-services/2014/05/business-connector-model.xsd"
xmlns:bconn="http://schemas.informatica.com/socrates/data-services/2014/05/business-connector-model.xsd">
<dataAccessResponse>
<result>
<statementId>SQL Name 1</statementId>
<row>
<updatedRows>0</updatedRows>
</row>
</result>
</dataAccessResponse>
<dataAccessResponse>
<result>
<statementId>SQL Name 2</statementId>
<row>
<updatedRows>1</updatedRows>
</row>
</result>
</dataAccessResponse>
</multiDataAccessResponse>
次のスニペット例は、応答ペイロードとしてのXML形式を示しています。

<multiDataAccessResponse>
<dataAccessResponse>
<result statementId="SQL Name 1">
<row>
<updatedRows>0</updatedRows>
</row>
</result>
</dataAccessResponse>
<dataAccessResponse>
<result statementId="SQL Name 2">
<row>
<updatedRows>1</updatedRows>
</row>
</result>
</dataAccessResponse>
</multiDataAccessResponse>

[出力]タブ

[出力]タブを使用して、データアクセスサービスコネクタがデータベースから返されたデータをどのように解析するかを定義します。
次の図は、[出力]タブを示しています。
この図は、[出力]タブを示しています。
各出力データ項目について、次のプロパティを指定します。

プロセスオブジェクトの作成

[プロセスオブジェクト]タブでは、データアクセスサービスコネクタの1つ以上のプロセスオブジェクトを定義して、データをグループ化し、構造化オブジェクトを作成できます。データアクセスサービスコネクタで定義されたプロセスオブジェクトは、データアクセスサービスコネクタを使用するプロセスで利用可能になります。例えば、データベースが名前、住所、電話番号などの人口統計情報を返す場合、この情報を格納する単一の人口統計的プロセスオブジェクトを作成できます。
[アクション/出力]タブを使用して、データベースから返された1つ以上のデータ要素と各プロセスオブジェクトを関連付けることができます。
データアクセスサービスコネクタのプロセスオブジェクトを作成するには、次の手順を実行します。
  1. 1データアクセスサービスコネクタを作成するか、既存のコネクタを開きます。
  2. 2[プロセスオブジェクト]タブをクリックします。
  3. 3[+]をクリックして新しいプロセスオブジェクトを追加するか、既存のプロセスオブジェクトをリストから選択します。各プロセスオブジェクトは、タブ内に行項目として表示されます。
  4. 次の図は、[プロセスオブジェクト]タブを示しています。
    この図は、[プロセスオブジェクト]タブを示しています。
  5. 4[プロパティ]タブで、各プロセスオブジェクトに対し、次の詳細を指定します。
  6. 5[フィールド]タブで、各プロセスオブジェクトに対し、次の詳細を指定します。

データアクセスサービスコネクタのテスト

データアクセスサービスコネクタエディタを使用するときは、[テスト]をクリックしてデータベースに要求を送信し、応答データを[テスト結果]タブに表示します。
応答に1つ以上の添付ファイルが含まれている場合は、それらの添付ファイルをダウンロードすることもできます。
注: [応答ペイロード]および[SQL応答]セクションには最大10,000件のレコードが表示されます。[SQLバインディング]タブで、10,000を超える値を制限に指定することはできません。
次の図は、[テスト結果]タブを示しています。
プロセスオブジェクトの生成
通常プロセスオブジェクトは、特定の要素セットに結び付けられます。場合によっては、多数の同一のオブジェクトを持ち、それぞれが1つの要素セットに適用されることがあります。例えば、返されるデータを定義するときに、返されるデータのサブセットを定義することのみを目的とするプロセスオブジェクトを作成します。これらのオブジェクトは再利用不可能であり、単一のプロセスオブジェクトフィールドのみが使用できます。オブジェクト名は、フィールドの名前でもあります。
再利用可能なオブジェクトを作成することもできます。例えば、NetSuiteのrefType要素には、nameとinternalIDという2つのフィールドがあります。これら2つのフィールドをそれぞれが含む多数のオブジェクトを作成するのでなく、1つの再利用可能なプロセスオブジェクトを作成できます。
  1. 1[プロセスオブジェクトの生成]をクリックして、データアクセスサービスコネクタ用に定義したプロセスオブジェクトを表示します。
  2. 2再利用可能にするプロセスオブジェクトを選択し、[次へ]をクリックします。
  3. Process Designerに、生成されたプロセスオブジェクトの一覧が表示されます。
  4. 3[完了]をクリックします。

応答ペイロード内のメタデータパラメータ

特定のアプリケーション接続のメタデータの詳細を表示するには、メタデータパラメータを使用します。出力には、データと一緒に保存されているデータまたはデータセットに関するコンテキスト情報が含まれます。
アプリケーション接続のメタデータの詳細を表示するには、次のURIを使用します。
https://<Informatica Intelligent Cloud Services URL>/active-bpel/odata/v4/<app connection name>/$metadata
次のスニペット例は、応答ペイロードの形式を示しています。 この図は、応答ペイロード内のメタデータパラメータを示しています。
多数のテーブルを含むデータベースからメタデータを適切に取得するには、アプリ接続で接続プロパティを定義するときに、[テーブルを含める]または[テーブルを除外]フィールドを使用してテーブルをフィルタリングします。

応答ペイロード内のOData拡張パラメータ

アプリケーション接続をパブリッシュした後、OData拡張パラメータを使用して、データに対してネストされたクエリを実行できます。サービス呼び出しでは、ナビゲーションプロパティの1レベルまでをクエリできます。
OData拡張パラメータを含む次のURIを使用します。
https://<Informatica Intelligent Cloud Services URL>/active-bpel/odata/v4/<app connection name>/<table name>?$expand=*
次のスニペット例は、拡張クエリの出力を示しています。
この図は、拡張パラメータを示しています。

Databricksのルールとガイドライン

データアクセスサービスコネクタを使用してDatabricksデータベースに接続する場合は、次のルールとガイドラインを考慮してください。