Skip to Content

Cherwell Get Records activity

Introduction

A Cherwell Get Records activity, using its Cherwell connection, retrieves a business object record from Cherwell, and is intended to be used as a source to provide data in an operation.

Create a Cherwell Get Records activity

An instance of a Cherwell Get Records activity is created from a Cherwell connection using its Get Records activity type.

To create an instance of an activity, drag the activity type to the design canvas or copy the activity type and paste it on the design canvas. For details, see Creating an activity instance in Component reuse.

An existing Cherwell Get Records activity can be edited from these locations:

Configure a Cherwell Get Records activity

Follow these steps to configure a Cherwell Get Records activity:

Step 1: Enter a name and object ID

In this step, provide a name for the activity and enter a business object ID. Each user interface element of this step is described below.

Cherwell Get Records activity configuration step 1

Tip

Fields with a variable icon Variable icon support using global variables, project variables, and Jitterbit variables. Begin either by typing an open square bracket [ into the field or by clicking the variable icon to display a list of the existing variables to choose from.

  • Name: Enter a name to identify the activity. The name must be unique for each Cherwell Get Records activity and must not contain forward slashes (/) or colons (:).

  • Object ID: Enter a busObId that points to an existing business object on the Cherwell server.

  • Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.

  • Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 2: Review the data schemas

Any request or response schemas generated from the endpoint are displayed. Each user interface element of this step is described below.

Cherwell Get Records activity configuration step 2

  • Data Schemas: These data schemas are inherited by adjacent transformations and are displayed again during transformation mapping.

!!! note Data supplied in a transformation takes precedence over the activity configuration.

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.

The response data schema consists of these nodes and fields:

Response Schema Node/Field Description
busObPublicId Public ID of the business object record to be retrieved
BusObRecID ID of the business object record to be retrieved
dirty Flag that field values need to be updated if true
displayName The display name of a field
fieldId The internal ID of a field
name The display name of a field
value A string used to identify a value or to filter results

  • Refresh: Click the refresh icon Refresh icon or the word Refresh to regenerate schemas from the Cherwell endpoint. This action also regenerates a schema in other locations throughout the project where the same schema is referenced, such as in an adjacent transformation.

  • Back: Click to temporarily store the configuration for this step and return to the previous step.

  • Finished: Click to save the configuration for all steps and close the activity configuration.

  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Next steps

After configuring a Cherwell Get Records activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure the operation settings, which include the ability to chain operations together that are in the same or different workflows.

Menu actions for an activity are accessible from the project pane and the design canvas. For details, see Activity actions menu in Connector basics.

Cherwell Get Records activities can be used as a source with these operation patterns:

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the operation logs.