Skip to Content

Cherwell Connector

Summary

The Cherwell connector establishes access to Cherwell.

The Cherwell connector provides an interface for creating a Cherwell connection, the foundation used for generating instances of Cherwell activities. These activities, once configured, interact with Cherwell through the connection.

The Cherwell connector is accessed from the design component palette's Project endpoints and connectors tab (see Design Component Palette).

Connector Overview

This connector is used to first configure a Cherwell 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 Cherwell connection and its activities are referred to as a Cherwell endpoint:

Cherwell activity types

  • Post Records: Creates or updates user records in Cherwell, and is intended to be used as a target to consume data in an operation.

  • Put Records: Creates or updates business object records in Cherwell, and is intended to be used as a target to consume data in an operation.

  • Get Records: Retrieves a business object record from Cherwell, and is intended to be used as a source to provide data in an operation.

  • Delete Records: Deletes business object records by record ID from Cherwell and is intended to be used as a target in an operation.

Note

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

The Cherwell 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.

The Cherwell connector uses the Cherwell REST API CSM 9.5.0. Refer to the API documentation for information on the schema nodes and fields.

Troubleshooting

If you experience issues with the Cherwell connector, these troubleshooting steps are recommended:

  1. Click the Test button in the connection configuration to ensure the connection is successful and to ensure the latest version of the connector is downloaded to the agent (unless using the Disable Auto Connector Update organization policy).

  2. Check the operation logs for any information written during execution of the operation.

  3. Enable operation debug logging (for Cloud Agents or for Private Agents) to generate additional log files and data.

  4. If using Private Agents, you can check the agent logs for more information.