Common Connections and Activities¶
Connectors establish access to endpoints and run on Harmony Agents. These pages document characteristics common to many of the Jitterbit Harmony Cloud Studio connectors.
A connector provides an interface for creating a connection, the foundation used for generating instances of connector activities. These activities, once configured, interact with an endpoint through the connection.
A connector is accessed from the design component palette's Connections tab (see Design Component Palette).
A connector is used to first configure a connection. Activity types associated with that connection are then used to create instances of activities that are intended to be used as sources (to provide data in an operation) or targets (to consume data in an operation).
Together, a specific connection and its activities are referred to as an endpoint. The activities available depend on the connector. This example shows an Active Campaign endpoint with its activities:
The available activity types depend on the individual connector. For many connectors, these activities are available:
Query: Retrieves an object from an endpoint and is intended to be used as a source in an operation. (Generically documented as Query Activities.)
Create: Creates an object in an endpoint and is intended to be used as a target in an operation. (Generically documented as Create Activities.)
Update: Updates an object in an endpoint and is intended to be used as a target in an operation. (Generically documented as Update Activities.)
Delete: Deletes an object from an endpoint and is intended to be used as a target in an operation. (Generically documented as Delete Activities.)
Execute: Executes a procedure in an endpoint and is intended to be used as a target in an operation. (Generically documented as Execute Activities.)
This connector is a Connector SDK-based connector, which may be referred to by Jitterbit when communicating changes made to connectors built with the Connector SDK.
Prerequisites and Supported API Versions¶
A connector requires the use of an agent version 10.1 or later. These agent versions automatically download the latest version of the connector when required. Certain connectors may require a specific or later agent version.
Depending on the connector, schemas may be generated directly from the endpoint, fixed in the connector, or provided by the user. When generated directly from the endpoint, many connectors use a REST API and JDBC driver. Refer to the API documentation, as available, for information on the schema nodes and fields.
Limitations and Supported Features¶
See the documentation for each connector as to any limitations and as to the supported features of the connector endpoint.
Depending on the usage, connectors do not support table and field names that are not valid XML names if they appear as fields or nodes in a schema. A workaround is to rename any table or field names that do not comply with the XML specification.
If you experience issues with a connector, these troubleshooting steps are recommended:
Ensure the connection is successful by using the Test button in the configuration screen. If the connection is not successful, the error returned may provide an indication as to the problem.
Check the operation logs for any information written during execution of the operation.
Enable operation debug logging (for Cloud Agents or for Private Agents) to generate additional log files and data.
If using Private Agents, many connectors support enabling connector verbose logging using the specific configuration entry of logger name and level described in the documentation for each connector.
If using Private Agents, you can check the agent logs for more information.