SAP Gateway トリガー

SAP Gateway トリガーは、コネクタイベントトリガーです。SAP Gateway コネクタを使用すると、SAP Gateway データに対して、挿入、削除、更新、読み取りオペレーションを実行できます。

始める前に

SAP Gateway トリガーの新しい接続を作成または構成する場合は、プロジェクトに対して次の IAM ロールがあることを確認してください。
- コネクタ管理者（roles/connectors.admin）
SAP Gateway トリガーに使用するサービスアカウントに、次の IAM ロールを付与します。
- Application Integration の起動元（ roles/integrations.integrationInvoker ）

SAP Gateway トリガーを追加する

統合に SAP Gateway トリガーを追加する手順は次のとおりです。

Google Cloud コンソールで [Application Integration] ページに移動します。
Application Integration に移動
ナビゲーションメニューで [統合] をクリックします。
[統合リスト] ページが開き、Google Cloud プロジェクトで使用可能なすべての統合が一覧表示されます。
既存の統合を選択するか、[統合の作成] をクリックして新しい統合を作成します。
新しい統合を作成する場合:
1. [統合の作成] ペインで名前と説明を入力します。
2. 統合のリージョンを選択します。
  注: [リージョン] プルダウンには、Google Cloud プロジェクトにプロビジョニングされたリージョンのみが表示されます。新しいリージョンをプロビジョニングするには、[リージョンを有効にする] をクリックします。詳細については、新しいリージョンを有効にするをご覧ください。
3. 統合用のサービスアカウントを選択します。統合のサービスアカウントの詳細は、統合ツールバーの [統合の概要] ペインでいつでも変更または更新できます。
  注: サービスアカウントを選択するオプションは、選択したリージョンで統合ガバナンスを有効にしている場合にのみ表示されます。
4. [作成] をクリックします。
統合エディタで統合が開きます。
統合エディタのナビゲーションバーで、[トリガー] をクリックして、使用可能なトリガーのリストを表示します。
統合エディタで、[SAP Gateway トリガー] 要素をクリックして配置します。

SAP Gateway トリガーを構成するには、Integration Connectors で使用可能な既存の SAP Gateway 接続を使用するか、インライン接続作成オプションを使用して新しい SAP Gateway 接続を作成します。

既存の接続を使用して SAP Gateway トリガーを構成する

SAP Gateway トリガーはコネクタイベントトリガーであるため、トリガーの構成にはイベントサブスクリプションを有効にした SAP Gateway 接続のみが使用できます。

新しい SAP Gateway 接続を使用して SAP Gateway トリガーを構成する方法については、新しい接続を使用して SAP Gateway トリガーを構成するをご覧ください。

既存の SAP Gateway 接続を使用して SAP Gateway トリガーを構成するには、次の操作を行います。

統合エディタの SAP Gateway トリガー要素をクリックして、トリガー構成ペインを開きます。
[トリガーの構成] をクリックします。
[Connector Event Trigger Editor] ページで、構成の詳細を次のとおりに入力します。
1. リージョン: SAP Gateway 接続のリージョンを選択します。
2. 接続: 使用する SAP Gateway 接続を選択します。
  Application Integration には、アクティブであり、イベントサブスクリプションが有効になっている SAP Gateway 接続のみが表示されます。
3. イベントタイプのフィールド名を入力します。このフィールドは、受信イベントリクエストに関連付けられているイベントのタイプを識別します。
```
{
    "event_type": "user.created",
    ...
    // other request fields
    ...
    }
```
4. サービスアカウント: SAP Gateway トリガーに必要な IAM ロールを持つサービスアカウントを選択します。
[Done] をクリックしてトリガーの構成を完了し、ページを閉じます。

新しい接続を使用して SAP Gateway トリガーを構成する

統合エディタの SAP Gateway トリガー要素をクリックして、トリガー構成ペインを開きます。
[トリガーの構成] をクリックします。
[リージョン] フィールドはスキップします。
[接続] をクリックし、プルダウンメニューから [接続を作成] オプションを選択します。
[接続の詳細] セクションで、次の操作を行います。
1. Connector: 使用可能なコネクタのプルダウンリストから [SAP Gateway] を選択します。
2. コネクタのバージョン: 使用可能なバージョンのプルダウンリストからコネクタのバージョンを選択します。
3. [接続名] フィールドに、接続インスタンスの名前を入力します。
  接続名は次の条件を満たす必要があります。
  - 接続名には英字、数字、ハイフンを使用できます。
  - 文字は小文字のみを使用できます。
  - 接続名の先頭には英字を設定し、末尾には英字または数字を設定する必要があります。
  - 接続名は 49 文字以内で指定してください。
  - イベントサブスクリプションをサポートするコネクタの場合、接続名の先頭に接頭辞「goog」は使用できません。
4. 必要に応じて、接続インスタンスの [説明] を入力します。
5. サービスアカウント: 必要なロールを持つサービスアカウントを選択します。
6. イベントサブスクリプションの接続を使用するには、[イベントサブスクリプションを有効にする] を選択します。これを選択すると、次のオプションが表示されます。
  - エンティティとアクションを使用したイベントサブスクリプションを有効にする: このオプションを選択すると、イベントサブスクリプションとコネクタオペレーション（エンティティとアクション）の両方に対して接続が使用されます。
  - イベントサブスクリプションのみを有効にする: イベントサブスクリプションに対してのみ接続を使用するには、このオプションを選択します。このオプションを選択した場合は、[次へ] をクリックして、イベントサブスクリプションを構成します。
7. Namespace: データを取得するサービスの名前空間を指定します。これは、URL でサービスが指定されていない場合に必要です。
8. Service: データを取得するサービスを指定します。これは、URL でサービスが指定されていない場合に必要です。
9. CustomUrlParams: HTTP リクエストに含まれるカスタムクエリ文字列パラメータを指定します。パラメータは、field1=value1&field2=value2 の形式のクエリ文字列としてエンコードする必要があります。クエリ文字列の値は、URL エンコードされている必要があります。
10. Data Format: データを取得するデータ形式。XML または JSON を選択します。
11. 表示名を使用する: SAP ラベルを使用するかどうかを決定するブール値。
12. 必要に応じて、接続ノードの設定を構成します。
  - ノードの最小数: 接続ノードの最小数を入力します。
  - ノードの最大数: 接続ノードの最大数を入力します。
  ノードは、トランザクションを処理する接続の単位（またはレプリカ）です。1 つの接続でより多くのトランザクションを処理するには、より多くのノードが必要になります。逆に、より少ないトランザクションを処理するには、より少ないノードが必要になります。ノードがコネクタの料金に与える影響については、接続ノードの料金をご覧ください。値を入力しない場合は、デフォルトで最小ノード数は 2 に設定され（可用性を高めるため）、最大ノード数は 50 に設定されます。
13. 必要に応じて、[+ ラベルを追加] をクリックして Key-Value ペアの形式でラベルを接続に追加します。
14. [NEXT] をクリックします。
[Destinations] セクションで、SAP Gateway 環境の URL または OData サービスの完全な URL を設定します。形式の例は ${ENVIRONMENT_URL}/sap/opu/odata/${NAMESPACE}/${SERVICE}/、URL の例は https://sapes5.sapdevcenter.com/sap/opu/odata/IWBEP/GWSAMPLE_BASIC/ です。CustomUrlParams プロパティを使用してプロパティを追加します。
1. 宛先の種類: 宛先の種類を選択します。
  - リストから [ホストアドレス] を選択し、宛先のホスト名または IP アドレスを指定します。
  - バックエンドシステムへのプライベート接続を確立する場合は、リストからエンドポイントアタッチメントを選択し、次にエンドポイントアタッチメントリストから必要なエンドポイントアタッチメントを選択します。
    注: エンドポイントアタッチメントの作成方法については、PSC サービスアタッチメントとエンドポイントアタッチメントをご覧ください。エンドポイントアタッチメントを作成すると、[エンドポイントアタッチメント] リストに表示されます。
  セキュリティをさらに強化してバックエンドシステムへのパブリック接続を確立する場合は、接続用の静的アウトバウンド IP アドレスの構成を検討してから、特定の静的 IP アドレスのみを許可リストに登録するようファイアウォールルールを構成します。
  
  他の宛先を入力するには、[+ 宛先を追加] をクリックします。
2. [NEXT] をクリックします。
[認証] セクションで、認証の詳細を入力します。
1. [認証タイプ] を選択し、関連する詳細を入力します。
  SAP Gateway 接続でサポートされる認証タイプは、次のとおりです。
  - ユーザー名とパスワードを指定する
  - Anonymous
2. [NEXT] をクリックします。
Review: 接続と認証の詳細を確認します。
[作成] をクリックします。

認証を構成する

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

ユーザー名とパスワード
- ユーザー名: コネクタのユーザー名
- パスワード: コネクタに関連付けられたパスワードを含む Secret Manager の Secret。

Anonymous
匿名ログインを使用する場合は、[Not Available] を選択します。
- API Key: 現在認証されているユーザーの API キー。

イベントサブスクリプションを構成する

イベントサブスクリプションを有効にしている場合は、[イベントサブスクリプションの詳細] セクションに次の値を入力します。

イベントリスナーに次のいずれかの認証タイプを選択します。
注: 認証を構成する前に、イベントリスナーエンドポイントがあることを確認してください。このエンドポイントは、接続を作成した後に使用できます。エンドポイントを表示するには、[すべての接続] ページに移動し、表示する接続をクリックします。エンドポイントは [接続の詳細] セクションに表示されます。
- Google 認証このオプションを有効にする場合、JSON Web Token を使用して認証するの手順に沿って、ABAP SDK の認証を構成します。また、サービスアカウントに、アクセストークンが認証に使用される roles/connectors.listener ロールがあることを確認します。
- API キー認証このオプションを選択する場合は、API キーを作成して、Secret Manager シークレットとしてキーを保存している必要があります。詳細については、API キーを作成するをご覧ください。
イベントタイプのフィールド名を入力します。このフィールドは、受信イベントリクエストに関連付けられているイベントのタイプを識別します。
```
{
"event_type": "user.created",
...
// other request fields
...
}
```
バックエンドアプリケーションと接続間を安全に接続するには、[プライベート接続を有効にする] を選択します。このオプションを選択した場合は、接続の作成後に追加の構成手順を実行する必要があります。詳細については、イベントサブスクリプションのプライベート接続をご覧ください。
デッドレター構成を入力します。デッドレターを構成すると、指定された Pub/Sub トピックに未処理のイベントが書き込まれます。次の詳細情報を入力します。
1. デッドレタープロジェクト ID: デッドレター Pub/Sub トピックを構成した Google Cloud プロジェクト ID。
2. デッドレタートピック: 未処理イベントの詳細を書き込む Pub/Sub トピック。

SAP で認証を構成する

オンプレミスまたはクラウドエディションの ABAP SDK for Google Cloud の認証の概要ガイドの手順に沿って、SAP で認証を構成します。

トリガーを検証する

トリガーを検証するには、ABAP プログラムを作成します。以下は、参照として使用できる ABAP プログラムのサンプルです。ls_event_payload フィールドは、要件に応じて変更されます。

*&---------------------------------------------------------------------*
*& Report ZR_TEST_INT_CONNECTOR
*&---------------------------------------------------------------------*
*&
*&---------------------------------------------------------------------*
REPORT zr_test_int_connector.
PARAMETERS: p_auth TYPE char1 RADIOBUTTON GROUP rbg1 USER-COMMAND uc DEFAULT 'X',
 p_apik TYPE char1 RADIOBUTTON GROUP rbg1.
DATA:
 lv_p_projects_id TYPE string,
 lv_p_locations_id TYPE string,
 lv_p_connections_id TYPE string,
 ls_input TYPE /goog/cl_connectors_v1=>ty_103.
TYPES: BEGIN OF event_payload,
 event_type TYPE string,
 event_id TYPE string,
 name TYPE string,
 org_id TYPE string,
 END OF event_payload.
DATA: ls_event_payload TYPE event_payload.
ls_event_payload = VALUE #(
 event_type = 'create-entity'
 event_id = '1'
 name = 'demo-org'
 org_id = 'SAP'
 ).
TRY.
 IF p_Auth = abap_true.
 DATA(lv_client_key) = 'IC_DEMO_GOOGLE_AUTH'.
 lv_p_connections_id = 'conn-event-triggers-from-sap-gateway'.
 ELSE.
 lv_client_key = 'IC_DEMO_GOOGLE_APIK'.
 lv_p_connections_id = 'conn-event-triggers-from-sap-gateway-apik'.
 ENDIF.
* Open HTTP Connection
 DATA(lo_client) = NEW /goog/cl_connectors_v1( iv_key_name = CONV #( lv_client_key ) ).
* Populate relevant parameters
 lv_p_projects_id = lo_client->gv_project_id.
 lv_p_locations_id = 'us-central1'.
 GET REFERENCE OF ls_event_payload INTO ls_input-payload .
* Call API method: connectors.projects.locations.connections.listenEvent
 CALL METHOD lo_client->listen_event_connections
 EXPORTING


iv_p_projects_id = lv_p_projects_id
 iv_p_locations_id = lv_p_locations_id
 iv_p_connections_id = lv_p_connections_id
 is_input = ls_input
 IMPORTING
* es_raw =
 es_output = DATA(ls_output)
 ev_ret_code = DATA(lv_ret_code)
 ev_err_text = DATA(lv_err_text)
 es_err_resp = DATA(ls_err_resp).
 IF lo_client->is_success( lv_ret_code ).
 MESSAGE 'Success' TYPE 'S'.
 ELSE.
 MESSAGE lv_err_text TYPE 'E'.
 ENDIF.
* Close HTTP Connection
 lo_client->close( ).
 CATCH /goog/cx_sdk INTO DATA(lo_exception).
 MESSAGE lo_exception->get_text( ) TYPE 'E'.
ENDTRY.

割り当てと上限

割り当てと上限については、割り当てと上限をご覧ください。

次のステップ

すべてのタスクとトリガーを確認する。
インテグレーションをテストして公開する方法について学習する。

エラー処理について学習する。
統合の実行ログについて学習する。