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.
  • Actions Menus: How to access a menu of actions to take on connections, activity types, and activity instances.

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 a connection. The Connectors filter shows the available connectors. You can also create custom connectors.
  • Connections: A connection is a component that is created from a connector and provides access to a data resource. The Endpoints filter shows the available connections.
  • Activities: An activity is a component that is created from a connection and configured to interact with an endpoint. The Endpoints filter shows the connections, which can be clicked to reveal the activity types. The activity types are used to create an instance of an activity in a project. Activity instances can act as sources (providing data) or targets (receiving data).
  • Endpoints: An endpoint refers to a specific connection and its activities.

Testing a Connection

Once a connection is created, 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.

You can also test a connection from the project pane using a connection's actions menu (see Connection Actions Menu below).

Activities as Operation Steps

Operations are formed by arranging activities, scripts, and transformations within an operation on the design canvas.

Once a connection is established, activity types associated with the connection become available to place in an operation on the design canvas. When an activity type is placed on the design canvas, this creates an instance of an activity that can then be configured to use as a source (to provide data) or as a target (to receive data) in an operation.

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

Actions Menus

Connections, activity types, and activity instances each have a menu where you can access actions relevant to these items.

Connection Actions Menu

After creating a connection, menu actions for that connection are accessible from these locations:

These menu actions are available from all connection actions menus:

  • View/Edit or Edit: Opens the configuration screen for the connection. For configuration details, see the documentation for the endpoint connection under Connectors.
  • Test: Tests the connection. This action is the same as clicking the Test button available in a connection configuration screen (see documentation on the specific endpoint connection under Connectors).

These menu actions are available only from the design component palette's Connectivity tab:

Activity Type Actions Menu

The actions menu on each activity type associated with a connection is accessible only from the design component palette's Connectivity tab (see Activity Type Actions Menu in Design Component Palette). This menu action is available:

  • Copy: Places a copy of the activity type on your clipboard to be used to create an activity instance (see Component Reuse).

Activity Actions Menu

After an activity instance has been created, menu actions for that activity are accessible from these locations:

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.
  • Cut: Places a copy of the component on your clipboard and deletes the original component from the project (see Component Reuse).
  • Copy: Places a copy of the component on your clipboard (see Component Reuse).
  • Deploy: Shows these menu actions:
    • Deploy: Deploys the activity and any components it is dependent on (see Component Deployment).
    • Configurable Deploy: Opens the deployment screen, where you can select components to deploy (see Component Deployment).
  • Remove: Removes references to the activity from the design canvas (see Component Dependencies, Deletion, and Removal).

These actions are available only from the activity actions menus accessible from the project pane's Workflows and Components tabs:

These actions are available only from the activity actions menus accessible from the project pane's Components tab:

  • Duplicate: Creates a new, unreferenced activity using the same configuration as the original activity (see Component Reuse).
  • Add to Group: Opens a dialog to create a new custom group or to add the component to an existing group (see Component Groups).

  • No labels