Cherwell Put Records Activity¶
Introduction¶
A Cherwell Put Records activity, using its Cherwell connection, creates or updates business object records in Cherwell, and is intended to be used as a target to consume data in an operation.
To create or update user records, see Cherwell Post Records Activity.
Create a Cherwell Put Records Activity¶
An instance of a Cherwell Put Records activity is created from a Cherwell connection using its Put 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 Put Records activity can be edited from these locations:
- The design canvas (see Component Actions Menu in Design Canvas).
- The project pane's Components tab (see Component Actions Menu in Project Pane Components Tab).
Configure a Cherwell Put Records Activity¶
Follow these steps to configure a Cherwell Put Records activity:
-
Step 1: Enter a Name
Provide a name for the activity. -
Step 2: Review the Data Schemas
Any request or response schemas generated from the endpoint are displayed.
Step 1: Enter a Name¶
In this step, provide a name for the activity. Each user interface element of this stepis described below.
-
Name: Enter a name to identify the activity. The name must be unique for each Cherwell Put Records activity and must not contain forward slashes (
/) or colons (:). -
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 stepis described below.
- 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 request and response data schemas consist of these nodes and fields:
| Request Schema Node/Field | Description |
|---|---|
| BusObId | The internal ID of a business object type |
| displayName | The display name of a field |
| loginId | Cherwell username |
| password | Cherwell password |
| securityGroupId | The internal ID of a security group |
| userInfoFields | A list of objects related to user information fields |
| userInfo | User information |
| dirty | Flag that field values need to be updated if true |
| Response Schema Node/Field | Description |
|---|---|
| FailedRecords | Failed records |
| Failure | Failure |
| errorMessage | Error message |
| successRecords | Success records |
| success | Success |
| busObPublicId | The public ID of a business object |
-
Refresh: Click the 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 Put 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 Put Records activities can be used as a target with these operation patterns:
- Transformation Pattern
- Two-transformation Pattern (as the first or second target)
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.