Skip to end of metadata
Go to start of metadata

Introduction

When working with connectors, you should understand these basics:

  • Connectivity Resources: Terminology and definitions of various connectivity resources, including connectors, connections, activities, and endpoints.
  • Testing a Connection: How to test a connection to verify endpoint connectivity.
  • Activities as Operation Steps: How to add an activity as a step in an operation to use as a source or target of data.
  • Activity Actions Menu: Actions available on all activities, including viewing/editing, deleting, renaming, viewing dependencies, removing, deploying, adding to a group, and duplicating the activity.

Connectivity Resources

Connectivity resources are first accessed within the Connectivity tab of the design component palette:

  • Connectors: A connector provides the interface for entering user-provided input such as credentials to create an authenticated connection. The exception to this is the API connector, which already has a preconfigured connection. The Connectors filter shows the types of connectors that can be configured. In addition, you can create custom connectors using Connector Builder or the Connector SDK.
  • Connections: A connection is authenticated access to a data resource that has been configured using a connector. The Endpoints filter shows these configured connections. Existing connections (except for the API connection) can be edited by double-clicking on the connection in the palette. Existing connections can be renamed by clicking on the connection name in the palette.
  • Activities: An activity is an interaction with a connection that can be configured with user-provided input such as data structures that represent the request and response schemas for that action. The Endpoints filter shows the configured connections, which can be clicked to reveal the types of activities that can be added to an operation. Those activities are then able to be dragged to operations on the design canvas, where they can be configured by double-clicking on the activity within the operation. Configured activities can act as sources (providing data within an operation) or targets (receiving data within an operation).
  • Endpoints: An endpoint refers to a specific connection and its activities, which are added to an operation and then configured as sources or targets within the operation.

Testing a Connection

Once a connection is configured, you can verify endpoint connectivity by testing the connection.

To test a connection, click the Test button within the connection configuration. If the connection is successful, a message of Connection Success is displayed. If the connection is not successful, details about the error(s) are provided.

Activities as Operation Steps

Operations are formed by arranging activities, scripts, and transformations within an operation container on the design canvas. Activities are said to be used as a source if they provide data within an operation, or a target if they receive data within an operation.

This short demonstration shows a connector being used to configure a connection. Once the connection is established, activities become available to drag to an operation on the design canvas:

Detailed information about this process is covered in Adding Steps to an Operation under Operation Creation and Configuration.

Activity Actions Menu

After an activity has been created, menu actions for that activity are accessible from the project pane in either the Workflows or the Components tabs, or from the design canvas:

  • Project Pane: In the Workflows or Components tab of the project pane, hover over an activity name and click the actions menu icon  to open the actions menu:

     

  • Design Canvas: If the activity has been added to an operation, click an existing activity block to open the actions menu:

These actions are available from all activity actions menus:

  • View/Edit: Opens the activity configuration screen for you to configure the activity. For details, see the documentation on each connector under Connectors.
  • Deploy: Deploys the activity and any components it is dependent on.
  • Configurable Deploy: Opens the deployment screen, where you can select project components to deploy.

These actions are available only from the activity actions menus accessible from the project pane:

  • Delete: Permanently deletes the activity. A message asks you to confirm that you want to delete the activity.
  • Rename: Positions the cursor on the activity name in the project pane for you to make edits.
  • View Dependencies: Changes the view in the project pane to display any other parts of the project that the activity is dependent on.
  • Add to Group: Opens a prompt to create a new custom group or to add the component to an existing group.
  • Duplicate: Creates a copy of the activity as a new, unreferenced component. On creating the component copy, the cursor is positioned on the component name within the project pane for you to rename the component.

This action is available only from the activity actions menu accessible from the design canvas:

  • Remove: Removes the activity as a step in the operation without deleting it from the project. When you remove an activity that is adjacent to a transformation and schemas are provided within that activity, the schemas are no longer referenced by the transformation. Removed components can be accessed or permanently deleted from the project pane.
On This Page

Last updated:  Jun 29, 2020

  • No labels