Cherwell connection

Introduction

A Cherwell connection, created using the Cherwell connector, establishes access to Cherwell. Once a connection is configured, you can create instances of Cherwell activities associated with that connection to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).

Create or edit a Cherwell connection

A new Cherwell connection is created using the Cherwell connector from one of these locations:

• The design component palette's Project endpoints and connectors tab (see Design component palette).
• The Global Connections page (see Create a global endpoint in Global Connections).

An existing Cherwell connection can be edited from these locations:

• The design component palette's Project endpoints and connectors tab (see Design component palette).
• The project pane's Components tab (see Component actions menu in Project pane Components tab).
• The Global Connections page (see Edit a global endpoint in Global Connections).

Configure a Cherwell connection

Each user interface element of the Cherwell connection configuration screen is described below.

• Connection Name: Enter a name to use to identify the connection. The name must be unique for each Cherwell connection and must not contain forward slashes (/) or colons (:). This name is also used to identify the Cherwell endpoint, which refers to both a specific connection and its activities.

• Client ID: Enter the Cherwell client ID that you previously saved. See Cherwell registration.

• Host Name: Enter the Cherwell host name that you previously saved. See Cherwell registration.

• Username: Enter the Cherwell username that you previously saved. See Cherwell registration.

• Password: Enter the Cherwell password that you previously saved. See Cherwell registration.

• Test: Click to verify the connection using the provided configuration. When the connection is tested, the latest version of the connector is downloaded by the agent(s) in the agent group associated with the current environment. This connector supports suspending the download of the latest connector version by using the Disable Auto Connector Update organization policy. When the connection is tested, the latest version of the connector is downloaded by the agent(s) in the agent group associated with the current environment. This connector supports suspending the download of the latest connector version by using the Disable Auto Connector Update organization policy.

• Save Changes: Click to save and close the connection configuration.

• Discard Changes: After making changes to a new or existing configuration, click to close the configuration without saving. A message asks you to confirm that you want to discard changes.

• Delete: After opening an existing connection configuration, click to permanently delete the connection from the project and close the configuration (see Component dependencies, deletion, and removal). A message asks you to confirm that you want to delete the connection.

Next steps

After a Cherwell connection has been created, you place an activity type on the design canvas to create activity instances to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).

Menu actions for a connection and its activity types are accessible from the project pane and design component palette. For details, see Actions menus in Connector basics.

These activity types are available:

• 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 into 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.