Skip to end of metadata
Go to start of metadata

Connectors

Overview

A connector provides the interface for creating an authenticated connection to a data resource outside of Jitterbit Harmony. Some connectors are built for a specific application (for example, Salesforce), while others are standards-based, such as JDBC-compliant databases, REST, or SOAP.

In Cloud Studio, connectors are first configured to create connections. Activities associated with connections are then added to operations on the design canvas and configured as sources or targets in an operation. Together, a specific connection and its activities are referred to as an endpoint.

Connector Classifications

Each endpoint is documented individually but can be classified by its use.

API

This endpoint is used in conjunction with a Jitterbit Custom API that is configured through the API Manager. Associated activities include request and response activities. Schemas are defined by files provided by the user.

Short-Term Storage

These connectors are typically used when you want to store files temporarily for use in a downstream operation. Associated activities include read and write activities. However, written files cannot be relied upon to be present after operation execution, with the exception of local storage with some additional configuration. Schemas are defined by files provided by the user.

Long-Term Storage

These connectors are typically used for long-term or permanent storage of files that reside within endpoints that have controlled ownership. Associated activities include read and write activities. Schemas are defined by files provided by the user.

The database connector can also be considered a long-term storage connector but offers more functionality than the other long-term storage connectors. The database connector is used to access relational database management systems (RDMS) using third-party drivers. Activities include query, insert, and update (Jitterbit Harmony also supports upsert through a combination of these). Schemas are queried from the database using the chosen driver.

Service-Based

These connectors are used with a service that provides the metadata needed for the connection and activities. In the case of SOAP services, this metadata is provided in a WSDL and schemas are queried from the service. In the case of HTTP/REST services, you configure various activities based on testing and research of the service and provide the schemas.

Application

These connectors are used for interaction with specific apps, incorporating application-specific logic for connecting to the endpoint and for various activities that are unique to each endpoint. Schemas are queried from each application.

If you do not see the type of connector you want to use, you can also create a Custom Connector.

File-Based vs. Server-Based

In addition to the above classifications, connectors can also be referred to as file-based or server-based.

A server-based endpoint refers to an endpoint whose schemas are generated directly from the endpoint, such as is the case with SOAPdatabase, NetSuite, and Salesforce endpoints, as well as many application-specific endpoints and some custom endpoints.

In contrast, a file-based endpoint refers to an endpoint whose schemas are provided by the user, such as API, file share, FTP, HTTP, local storagetemporary storage, and variable endpoints. 

Accessing 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.

Adding an Activity to 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.

On This Page

Search in This Topic

Last updated:  Nov 08, 2019

  • No labels