Connectors task

You're viewing Apigee X documentation.
View Apigee Edge documentation.

The Connectors task lets you configure a connection using any supported Connector type previously configured in the Connectors UI. With a connection, you can quickly and easily call out to Google Cloud services and third-party business applications from your integration.

Before you begin

Before you can use the Connectors task in Apigee Integration, you must create a Connector using the Connectors UI in the Cloud console. For the steps required, see Create and manage connections. Once a Connector is configured, you can use the Connectors task to create a connection of that type in your integration.

Supported Connectors types include the following:

Configure the Connectors task

This page describes the general steps required to configure the Connectors task in Apigee Integration. Some configuration details will vary, depending upon the connection type selected in the task. For detailed descriptions of the steps required to configure the Connectors task for each connection type, see:

To configure the Connectors task:

  1. Go to the Apigee UI and sign in.
  2. Select your organization using the drop-down menu in the upper left corner of the UI.
  3. Click Develop > Integrations.
  4. Search for or select the integration to edit from the Integrations list and click to open the integration designer.
  5. Click +Add a task/trigger > Tasks to view the list of available tasks.
  6. Drag the Connectors element to the integration designer.
  7. Click the Connectors task element on the designer to view the Connectors task configuration pane.
  8. Optionally, click the to edit the task name. This enables you to change the task name from the generic Connectors to a meaningful name for your integration.
  9. On the Configuration tab in the Configuration section, click the Configure task button to open the Configure connector task pane.
    1. In the Connection column, choose the connection type you created in the Connectors UI from the list of available connections.
    2. Once a connection is chosen, the Type column appears. Select either an Entity or Action from the list of available Entities and Actions.
      • An Entity can be thought of as an object, or a collection of properties, in the connected application or service, that can be exposed to an integration through the Connector interface.

        Selecting an Entity from the available list generates a list of available Operations that are available for the Entity.

        Select an Operation from the available list. You can restrict the number of records for an operation by adding a filter. For more information, see Add a filter for an operation.

      • An Action is a first class function that is made available to the integration through the Connector interface. Functions are defined in the connected application or service and define a change or series of changes that can be made to an entity or entities.

        Select an Action from the available list.

    3. Click Done to complete the connection configuration and close the pane.
  10. The Connectors task configuration pane also displays Task Input variables and Task Output variables automatically generated by the Entity and Operation or Action selected in the previous step for use in the connection. These variables are configurable and are accessible as inputs to the current task or outputs to subsequent tasks or conditionals configured in the current integration.

    To configure the Task Input or Task Output:

    1. Click on the Connector input payload or Connector output payload variable pill to open the Configure Variable pane.
    2. Configure the JSON payload or default value as desired.
    3. Select the Use as an input to integration checkbox or the Use as an output to integration, as desired.
    4. Click Save.

Add a filter for an operation

You can restrict the records that will be processed by the Connectors task by adding a Filter clause in the Task Input. For example, in case of a delete operation, you can add a filter to delete records with a specific orderId. The Filter clause can be applied only for the following entity operations:

  • List
  • Delete
  • Update

When you select any of these operations, the Task Input section displays the Filter clause field automatically.

To add a filter, perform the following steps:

  1. In the Task Input section, click filterClause (Connectors).
  2. In the Configure Variable window, enter the filter condition in the Default Value field.

    For examples of filter clauses, see Filter clause examples.

  3. Click Save.

Filter clause examples

You can think of filter as a WHERE clause in a SQL query. A filter clause has the following format:

<FIELD_NAME> <CONDITION> <FILTER_VALUE>

The following are examples of a filter clause:

  • OwnerId = '0053t000007941XAAQ'
  • PoNumber < 2345
  • OrderNumber = 00110 AND StatusCode = 'Draft'
  • TotalAmount > 2500
  • ShippingPostalCode = 94043 OR ShippingPostalCode = 77002

Retry on failure

You can configure various retry strategies to handle errors in a task. The retry strategies allow you to specify how to rerun the task in case of an error. For more information, see Error handling strategies.