Connectors task

The Connectors task lets you quickly and securely connect to the various Google Cloud services and other business applications from your integration using the out-of-the-box connectors available in Integration Connectors.

For the list of all the supported connectors for Application Integration, see Connector reference.

Before you begin

  • Make sure that you have the Connectors Admin (roles/connectors.admin) IAM role granted on your Google Cloud project. For information about granting roles, see Manage access.
  • Learn about the general concepts of Integration Connectors.
  • To connect to Google Cloud services and other business applications using a connector, ensure that you have attached a user-managed service account to your integration. If your integration does not have user-managed service account configured, then by default the default service account (service-PROJECT_NUMBER@gcp-sa-integrations.iam.gserviceaccount.com) is used for authentication.
  • Ensure that your service account has the required IAM role. For information about granting roles to a service account, see Manage access to service accounts.

Add a Connectors task

To add the Connectors task to your integration, do the following:

  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 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 Tasks to view the list of available tasks and connectors.

    5. image showing connectors task

  5. If you want to configure a new connection, click and place the Connectors element in the integration editor. Then, click Configure connector to configure the connection.

    image showing connector task listing image showing connector task listing

  6. If you have an existing connection, click the Connectors tab to view the recently created connections. You can also search for a connector, connection, or task by entering the name in the Search field.

    image showing search capability for connectors task

  7. Click and place the configured Connectors element in the integration editor. For information about how to configure a connector task, see Configure the Connectors task.

Configure the Connectors task

To configure a Connectors task, do the following:

  1. Click the Connectors task element on the designer to view the Connectors task configuration pane.

    Optionally, click to rename the task name.

  2. Click Configure connector.
  3. You can either select an existing connection in the region or create a new connection. To configure an existing connection, complete the following steps in the Connectors Task Editor page.

    The following image shows a sample layout of the Connectors Task Editor page. image showing Configure connector task dialog image showing Configure connector task dialog

    1. In the Select connection section, select the region of the connection.
    2. Choose an existing connection from the list of available connections in the selected region.
    3. Click Next.
    4. From the Type list, select Entities or Actions.
      • If you select Entities, the list of supported entities for the connection is displayed in the Set entities/actions section. Select an entity followed by the Operation that you want to perform on that entity.
      • If you select Actions, the list of supported actions for the connection is displayed in the Set entities/actions column. Select an action for the connection.
        • The supported entities and actions are based on the connector type. For the list of all the supported connectors for Application Integration, see Connector reference. To view the supported actions and entities for a connector, see the specific connector documentation.

        If the connector supports custom SQL queries, you can select the Execute custom query option from the Actions list. For information about how to add custom SQL query for your connector, see Action: Execute custom SQL query.

    5. Click Done to complete the connection configuration and close the pane.

Configure task input and output variables

The Connectors task configuration pane displays Task Input and Task Output variables that are automatically generated based on the Entity and Operation or Action selected in the Configure connector task dialog. These variables are configurable and are accessible as inputs to the current task, as outputs to subsequent tasks, or as conditionals in the current integration.

To configure the Task Input or Task Output variables, click the respective variable to open the Configure Variable pane and perform the following steps:

  1. Enter the variable value in the Default Value field.
  2. (Optional) Select Use as an input to integration or Use as an output to integration.
  3. Click Save.

For more information about the input and output parameters of the Connectors task, see Entity operations.

Configure authentication override

To enable the connection to accept different backend authentication dynamically during runtime, ensure that in Integration Connectors, you have selected the Enable Authentication Override option for your connection.

To configure the authentication override, do the following:

  1. Click the connectors task element on the designer to view the Connectors task configuration pane.
  2. Expand the Task input section. The End user credentials field is set to a dynamicAuthConfig variable.

    End user credentials End user credentials

    Then, do the following:

    1. Click the dynamicAuthConfig variable. The Edit variable pane appears.

      For overriding the authentication, you must provide the authentication values when you test the integration.

      Edit dynamic euc variable Edit dynamic euc variable

      To do so, follow these steps:

      1. From the Variable type list, select Input to Integration.
      2. In the JSON schema options, you can verify the authentication type configured for the connection. Use this schema to override the authentication value when you test the integration.

        Test integration for auth override Test integration for auth override

    Alternatively, you can pass the authentication as the HTTP header by selecting the Use HTTPS Header for Auth Config checkbox in the Task input section of the Connectors task configuration pane.

    The dynamic authentication header should be in the following JSON format:

    {"task1":{"oauth2_auth_code_flow.access_token": "token_value"},"task2":{"oauth2_auth_code_flow.userename": "username_value"}}

    In this format, taskN corresponds to the Task ID in integrationVersion.

    Test integration by passing the authentication as the HTTP header Test integration by passing authentication as the HTTP header

Entity operations and actions

You can perform CRUD (Create, Read, Update, Delete) operations on the entities of a connector. Each of these entity operations has a different set of input and output parameters. The following table lists the input and output parameters for the various entity operations.

Operation name Input parameters Output parameters
List
  • listEntitiesPageSize
  • listEntitiesPageToken
  • listEntitiesSortByColumns
  • filterClause