Console
Start free

SAP Gateway trigger

The SAP Gateway trigger is a Connector Event trigger SAP Gateway connector lets you perform insert, delete, update, and read operations on SAP Gateway data.

Before you begin

  • If you plan to create or configure a new connection for the SAP Gateway trigger, make sure that you have the following IAM role on the project:
  • Grant the following IAM roles to the service account that you want to use for the SAP Gateway trigger:

    • Add the SAP Gateway trigger

    To add a SAP Gateway trigger to your integration, perform the following steps:

    1. In the Google Cloud console, go to the Application Integration page.

      Go to Application Integration

    2. In the navigation menu, click Integrations

      The Integrations List page appears listing all the integrations available in the Google Cloud project.

    3. Select an existing integration or click Create integration to create a new one.

      If you are creating a new integration:

      1. Enter a name and description in the Create Integration pane.
      2. Select a region for the integration.
      3. Select a service account for the integration. You can change or update the service account details of an integration any time from the Integration summary pane in the integration toolbar.
      4. Click Create.

      The newly created integration opens in the integration editor.

    4. In the integration editor navigation bar, click Triggers to view the list of available triggers.
    5. Click and place the SAP Gateway trigger element in the integration editor.

      6. To configure the SAP Gateway trigger, you can either use an existing SAP Gateway connection available in Integration Connectors, or create a new SAP Gateway connection using the inline connection creation option.

    Configure SAP Gateway trigger using an existing connection

    The SAP Gateway trigger is an Connector Event trigger, therefore you can only use a SAP Gateway connection with event subscription enabled to configure the trigger.

    For information about how to configure a SAP Gateway trigger using a new SAP Gateway connection, see Configure SAP Gateway trigger using a new connection

    To configure a SAP Gateway trigger using an existing SAP Gateway connection, perform the following steps:

    1. Click the SAP Gateway trigger element in the integration editor to open the trigger configuration pane.
    2. Click Configure trigger.
    3. Provide the following configuration details in the Connector Event Trigger Editor page:
      1. Region: Select the region of your SAP Gateway connection.
      2. Connection: Select the SAP Gateway connection that you want to use.

        Application Integration only displays those SAP Gateway connections that are active and have an event subscription enabled.

      3. Enter the event type field name. This field identifies the type of event associated with the incoming event request. 
        {
    "event_type": "user.created",
    ...
    // other request fields
    ...
    }
      4. Service Account: Select a service account with the required IAM roles for the SAP Gateway trigger.
    4. Click Done to complete the trigger configuration and close the page.

    Configure SAP Gateway trigger using a new connection

  • Click the SAP Gateway trigger element in the integration editor to open the trigger configuration pane.
  • Click Configure trigger.
  • Skip the Region field.
  • Click Connection and select the Create Connection option from the drop-down menu.
    • In the Connection Details section, complete the following:
  • Connector: Select SAP Gateway from the drop down list of available Connectors.
  • Connector version: Select the Connector version from the drop down list of available versions.
    • In the Connection Name field, enter a name for the Connection instance.

    Connection names must meet the following criteria:

  • Optionally, enter a Description for the connection instance.
  • Service Account: Select a service account that has the required roles.
  • To use the connection for event subscriptions, select Enable event subscription. Selecting this, displays the following options:
  • Namespace: Specify the service namespace you want to retrieve data from. This is required if the service is not specified in the URL.
  • Service: Specify the service you want to retrieve data from. This is required if the service is not specified in the URL.
  • CustomUrlParams: Specify custom query string parameters that are included with the HTTP request. The parameters must be encoded as a query string in the following format: field1=value1&field2=value2. The values in the query string must be URL encoded.
  • Data Format: The data format to retrieve data in. Select either XML or JSON.
  • Use Display Names: Boolean determining whether or not to use SAP labels.
  • Optionally, configure the Connection node settings:

    A node is a unit (or replica) of a connection that processes transactions. More nodes are required to process more transactions for a connection and conversely, fewer nodes are required to process fewer transactions. To understand how the nodes affect your connector pricing, see Pricing for connection nodes. If you don't enter any values, by default the minimum nodes are set to 2 (for better availability) and the maximum nodes are set to 50.

  • Optionally, click + ADD LABEL to add a label to the Connection in the form of a key/value pair.
  • Click NEXT.
  • In the Destinations section, set the URL of your SAP Gateway environment or to the full URL of the OData service. For example format; ${ENVIRONMENT_URL}/sap/opu/odata/${NAMESPACE}/${SERVICE}/ and sample URL is https://sapes5.sapdevcenter.com/sap/opu/odata/IWBEP/GWSAMPLE_BASIC/. Add any additional properties using the CustomUrlParams property.
    1. Destination Type: Select a Destination Type.
      • To specify the destination hostname or IP address, select Host address and enter the address in the Host 1 field.
      • To establish a private connection, select Host Address and add the endpoint attachment created for the SAP Gateway using the HTTPS protocol.

      If you want to establish a public connection to your backend systems with additional security, you can consider configuring static outbound IP addresses for your connections, and then configure your firewall rules to allowlist only the specific static IP addresses.

      To enter additional destinations, click +ADD DESTINATION.

    2. Click NEXT.
  • In the Authentication section, enter the authentication details.
    1. Select an Authentication type and enter the relevant details.

      The following authentication types are supported by the SAP Gateway connection:

      • Username and password
      • Anonymous
      • OAuth 2.0 auth code flow
      • SAP BTP (OAuth 2.0 - client credentials)

      2. To understand how to configure these authentication types, see Configure authentication.

    2. Click NEXT.
  • Review: Review your connection and authentication details.
  • Click Create.

    • Configure authentication

    Enter the details based on the authentication you want to use.

    Configure event subscription

    If you have enabled the event subscription, enter the following values in the Event Subscription Details section:

    1. Select any one of the following authentication types for the event listener.
    2. Enter the event type field name. This field identifies the type of event associated with the incoming event request. 
      {
"event_type": "user.created",
...
// other request fields
...
}
    3. Select Enable private connectivity for secured connectivity between your backend application and your connection. If you select this option, you must perform additional configuration steps after creating the connection. For more information, see Private connectivity for event subscription.
    4. Enter the dead-letter configuration. If you configure dead-letter, the connection writes the unprocessed events to the specified Pub/Sub topic. Enter the following details:
      1. Dead-letter project ID: The Google Cloud project ID where you have configured the dead-letter Pub/Sub topic.
      2. Dead-letter topic: The Pub/Sub topic where you want to write the details of the unprocessed event.

    Configure authentication in SAP

    Configure the authentication in SAP by following the instructions in the Authentication overview for the on-premises or any cloud edition of ABAP SDK for Google Cloud guide.

    Validate the trigger

    To validate the trigger, you can create an ABAP program. The following is a sample ABAP program that you can use as a reference. The ls_event_payload field changes based on your requirements:

    *&---------------------------------------------------------------------*
*& 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.

    Quotas and limits

    For information about quotas and limits, see Quotas and limits.

    What's next

  • Learn about all tasks and triggers.
    • Learn how to test and publish an integration.
  • Learn about error handling.
  • Learn about integration execution logs.