Dataverse

Dataverse コネクタを使用すると、カスタムテーブルに対して挿入、削除、更新、読み取りオペレーションを実行できます。

始める前に

Dataverse コネクタを使用する前に、次の作業を行います。

Google Cloud プロジェクトで次の操作を行います。
- コネクタを構成するユーザーに roles/connectors.admin IAM ロールを付与します。
- コネクタに使用するサービスアカウントに、次の IAM ロールを付与します。
  - roles/secretmanager.viewer
  - roles/secretmanager.secretAccessor
  サービスアカウントは特別なタイプの Google アカウントで、Google API のデータにアクセスするのに認証を受ける必要がある人間以外のユーザーを表します。サービスアカウントがない場合は、サービスアカウントを作成する必要があります。詳細については、サービスアカウントを作成するをご覧ください。
- 次のサービスを有効にします。
  - secretmanager.googleapis.com（Secret Manager API）
  - connectors.googleapis.com（Connectors API）
  サービスを有効にする方法については、サービスを有効にするをご覧ください。
以前にプロジェクトでこうしたサービスを有効にしていない場合は、コネクタを構成するときにそれを有効にすることを求められます。

コネクタを構成する

コネクタを構成するには、データソース（バックエンドシステム）への接続を作成する必要があります。接続はデータソースに特有です。つまり、多数のデータソースがある場合は、データソースごとに別々の接続を作成する必要があります。接続を作成する手順は次のとおりです。

Cloud コンソールで、[Integration Connectors] > [接続] ページに移動し、Google Cloud プロジェクトを選択または作成します。
[接続] ページに移動
[+ 新規作成] をクリックして [接続の作成] ページを開きます。
[ロケーション] セクションで、接続のロケーションを選択します。
1. リージョン: プルダウンリストからロケーションを選択します
  サポートされているすべてのリージョンの一覧については、ロケーションをご覧ください。
2. [NEXT] をクリックします。
[接続の詳細] セクションで、次の操作を行います。
1. コネクタ: 使用可能なコネクタのプルダウンリストから [Dataverse] を選択します。
2. コネクタのバージョン: 使用可能なバージョンのプルダウンリストからコネクタのバージョンを選択します。
3. [接続名] フィールドに、接続インスタンスの名前を入力します。
  接続名は次の条件を満たす必要があります。
  - 接続名には英字、数字、ハイフンを使用できます。
  - 文字は小文字のみを使用できます。
  - 接続名の先頭には英字を設定し、末尾には英字または数字を設定する必要があります。
  - 接続名は 63 文字以内で指定してください。
4. 必要に応じて、接続インスタンスの [説明] を入力します。
5. 必要に応じて、Cloud Logging を有効にして、ログレベルを選択します。デフォルトのログレベルは Error に設定されています。
6. サービスアカウント: 必要なロールを持つサービスアカウントを選択します。
7. 必要に応じて、接続ノードの設定を構成します。
  - ノードの最小数: 接続ノードの最小数を入力します。
  - ノードの最大数: 接続ノードの最大数を入力します。
  ノードは、トランザクションを処理する接続の単位（またはレプリカ）です。1 つの接続でより多くのトランザクションを処理するには、より多くのノードが必要になります。逆に、より少ないトランザクションを処理するには、より少ないノードが必要になります。ノードがコネクタの料金に与える影響については、接続ノードの料金をご覧ください。値を入力しない場合は、デフォルトで最小ノード数は 2 に設定され（可用性を高めるため）、最大ノード数は 50 に設定されます。
8. Azure テナント: データへのアクセスに使用される Microsoft Online テナント。指定しない場合、デフォルトのテナントが使用されます。
9. 組織の URL: Microsoft Dataverse データの URL。たとえば、https://abc123.crm.dynamics.com/ です。
10. テナント: データへのアクセスに使用されている Microsoft テナント。指定しない場合は、デフォルトのプロジェクトが使用されます。
11. 必要に応じて、[API バージョン] フィールドで、使用する API のバージョンを指定します。API の新しいバージョンがリリースされた場合は、このフィールドでそのバージョンを指定できます。
12. 必要に応じて、プロバイダがオペレーションに表示名を使用できるようにするには、[表示名を使用する] を選択します。
13. スキーマ: 使用するスキーマを選択します。
14. 必要に応じて、[+ ラベルを追加] をクリックして Key-Value ペアの形式でラベルを接続に追加します。
15. [SSL 構成] セクションで、信頼モデルを選択します。
  - 公開: デフォルトのトラストストアから選択された公開証明書。
  - 非公開: 自己署名証明書または非公開認証局が発行した証明書
  - 安全でない接続: すべての証明書を信頼します。公開または非公開の信頼モデルを使用することをおすすめします。
[認証] セクションで、認証の詳細を入力します。これらの認証タイプの構成方法については、認証を構成するをご覧ください。
[次へ] をクリックします。
Review: 接続と認証の詳細を確認します。
[作成] をクリックします。

認証を構成する

使用する認証に基づいて詳細を入力します。

クライアント ID: アクセストークンのリクエストに使用されるクライアント ID。
スコープ: 必要なスコープのカンマ区切りのリスト。
クライアントシークレット: アクセストークンのリクエストに使用されるクライアントシークレット。
承認 URL: クライアントの作成時に生成された承認 URL。

システムの上限

Dataverse コネクタは、ノードごとに 1 秒あたり 25 件のトランザクションを処理することができ、この上限を超えるトランザクションはすべてスロットリングされます。デフォルトでは、Integration Connectors は、接続に 2 つのノードを割り当てます（可用性を高めるため）。

Integration Connectors に適用される上限の詳細については、上限をご覧ください。

注: Integration Connectors ノードの数は、使用状況に応じて動的に自動スケーリングされます。ただし、自動スケーリングを待たずに大量の容量を確保する場合は、接続の最小ノード値を調整できます。1 つの接続により多くのトランザクションを処理するには、より多くのノードが必要です。逆に、接続が処理するトランザクションが少ない場合は、必要なノードの数が少なくなります。ノードの値を構成するには、次の手順を行います。

従量課金制をご利用のお客様は、接続の編集ページでノードの最小値と最大値を構成します。
サブスクリプションベースで利用されているお客様は、サポートにお問い合わせください。

ノードが処理できる最大トランザクションは、さまざまな要因によって異なります。そのため、スループットを高めるために最小ノードを調整する前に、バックエンドシステムが必要なトラフィックを処理するために最適に設定されているかどうかを確認することをおすすめします。

エンティティ、オペレーション、アクション

すべての Integration Connectors が、接続されたアプリケーションのオブジェクトを抽象化するレイヤを提供します。アプリケーションのオブジェクトには、この抽象化を通じてのみアクセスできます。抽象化は、エンティティ、オペレーション、アクションとして公開されます。

エンティティ: エンティティは、接続されているアプリケーションやサービスのオブジェクト、またはプロパティのコレクションと考えることができます。エンティティの定義は、コネクタによって異なります。たとえば、データベースコネクタでは、テーブルがエンティティであり、ファイルサーバーコネクタでは、フォルダがエンティティです。また、メッセージングシステムコネクタでは、キューがエンティティです。
ただし、コネクタでいずれのエンティティもサポートされていない、またはエンティティが存在しない可能性があります。その場合、Entities リストは空になります。
オペレーション: エンティティに対して行うことができるアクティビティです。エンティティに対して次のいずれかのオペレーションを行うことができます。
- リスト
- 取得
- 作成
- 更新
- 削除
使用可能なリストからエンティティを選択すると、そのエンティティで使用可能なオペレーションのリストが生成されます。オペレーションの詳細については、コネクタタスクのエンティティオペレーションをご覧ください。ただし、コネクタがどのエンティティオペレーションもサポートしていない場合、サポートされていないオペレーションは Operations リストに含まれません。
アクション: コネクタインターフェースを介して統合で使用できる最初のクラス関数です。アクションを使用すると、1 つまたは複数のエンティティに対して変更を加えることができます。また、使用できるアクションはコネクタごとに異なります。通常、アクションには、いくつかの入力パラメータと出力パラメータがあります。ただし、コネクタがどのアクションもサポートしていない可能性があります。その場合は、Actions リストが空になります。

操作

Dataverse コネクタには、ListAssociations や ListNavigationProperties などのアクションが用意されています。アクションの構成方法については、アクションの例をご覧ください。

アクションの例

このセクションでは、このコネクタでいくつかのアクションを実行する方法について説明します。

例 - ListAssociations

[Configure connector task] ダイアログで、[Actions] をクリックします。
[ListAssociations] アクションを選択してから、[完了] をクリックします。
[コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。
```
 {
  FromId:"etywe325632io100",
  FromTable:"Customers",
  "NavigationProperty":"asyncoperations"
  }
```

エンティティオペレーションの例

例 - すべてのカスタムテーブルレコードを一覧表示する

この例では、User defined エンティティ内のすべてのレコードを一覧表示します。

[Configure connector task] ダイアログで、[Entities] をクリックします。
Entity リストから [カスタムテーブル名] を選択します。
[LIST] オペレーションを選択してから、[完了] をクリックします。

例 - ID に基づいてユーザーを取得する

この例では、Users エンティティから newTableId を 568ea947-e03d-ef11-8409-7c1e5217e912 として取得します。

[Configure connector task] ダイアログで、[Entities] をクリックします。
Entity から Custom Table を選択します。
[GET] オペレーションを選択してから、[完了] をクリックします。
[コネクタタスクの [タスク入力 セクションで [entityId] をクリックし、[デフォルト値] フィールドに 568ea947-e03d-ef11-8409-7c1e5217e912 を入力します。
ここで、newTableId は Custom Table エンティティの主キー値です。
[完了] をクリックします。

Terraform を使用して接続を作成する

Terraform リソースを使用して、新しい接続を作成できます。

Terraform 構成を適用または削除する方法については、基本的な Terraform コマンドをご覧ください。

接続作成用の Terraform テンプレートのサンプルを表示するには、サンプルテンプレートをご覧ください。

Terraform を使用してこの接続を作成する場合は、Terraform 構成ファイルで次の変数を設定する必要があります。

パラメータ名	データ型	必須	説明
データベース	STRING	False	SAP HANA データベースの名前。
browsable_schemas	STRING	False	このプロパティは、利用可能なスキーマのサブセットに報告されるスキーマを制限します。例: BrowsableSchemas=SchemaA,SchemaB,SchemaC。
include_system_objects	BOOLEAN	False	includeSystemObjects を True に設定して、Hana システムスキーマとテーブルを取得します。
include_table_types	BOOLEAN	False	true に設定すると、プロバイダが個々のテーブルとビューのタイプを報告します。
session_variables	STRING	False	現在の接続に設定するセッション変数のカンマ区切りのリスト。
enable_logging	ENUM	False	1（最も詳細ではない）から 5（最も詳細）のいずれかを選択することで、接続中のログの詳細度を有効にします。この機能は、エラーメッセージなどの予期しない動作のトラブルシューティングに役立ちます。ただし、このオプションを使用すると、コネクタとバックエンド間のすべての通信の詳細（リクエスト、レスポンス、SSL 証明書など）がログに記録されます。そのため、本番環境でこの機能を使用することはおすすめしません。サポートされている値: 1、2、3、4、5。

統合で Dataverse 接続を使用する

接続を作成すると、Apigee Integration と Application Integration の両方で使用できるようになります。この接続は、コネクタタスクを介して統合で使用できます。

Apigee Integration で Connectors タスクを作成して使用する方法については、Connectors タスクをご覧ください。
Application Integration で Connectors タスクを作成して使用する方法については、Connectors タスクをご覧ください。

Google Cloud コミュニティの助けを借りる

Google Cloud コミュニティの Cloud フォーラムで質問を投稿したり、このコネクタについてディスカッションしたりできます。