Cherwell: Input
Description
Use the step to get the Cherwell records based on the form name and query criteria provided. The result returns the form field values for fields specified in the output Field Name.
Configurations
Step name: Specify a unique name for the step.
| Field name | Description |
|---|---|
| Step name | Specify a unique name for the step |
| CONNECTION tab: | Connection fields |
| URL | Specify URL to access Cherwell. The field is mandatory. |
| Username | Specify the Cherwell username. The field is mandatory. |
| Password | Specify the Cherwell password for the user. The password is encrypted (*****) and also stored in encrypted format in the psw file. The field is mandatory. |
| Client ID | Specify a Cherwell Client ID. The Client ID is used to communicate with the Cherwell instance. The field is mandatory. Note: CSM Administrator (Orange client) and CSM client (Blue client) tools can be installed for administration and development purposes. Generate a Cherwell client ID from Orange Client using the navigation, CSM Administrator tool → Security → REST API client. |
| Test Connection | Click to verify if the connection is available or not. If no values are provided or some values are missing, then it will display the validation error message. For verification purpose, the fields coming from previous steps are not allowed since field values can only be accessed when workflow is in Running state. Static values and environment variables are allowed. |
| INPUT tab: | Input Fields |
| Form Name | Specify the Cherwell form name or business object from which the record details will be fetched. The field is mandatory. |
| Get Forms | Click to populate the forms of the connected Cherwell Server depending on access or permissions of the user. If any required field values are missing, then it will display validation error message. Select a form to populate the Form Name field. |
| Criteria Query | Specify the criteria query in json format. Following, is a sample json with two conditions. The first condition is ‘Status’ equals (eq) ‘Assigned’ and the second statement is ‘Created Date Time’ later than(lt) ‘6/20/2016 8:59:17 PM’.[{"displayName": "Status","operator": "eq","value": "Assigned"},{"displayName": "Created Date Time","operator": "lt","value": "6/20/2016 8:59:17 PM"}] The criteria query will filter rows fulfilling the following two conditions. |
| Fetch Records Batch Size | Specify the batch size to fetch records. The fetched records in the batch are then available to the next step in workflow while the next batch is being fetched in the step. Thus, parallel execution of records is achieved. The default Records Batch Size is 10. The batch size should be a positive number. |
| Get Top N Records | Specify the number of latest records to be fetched. |
| OUTPUT tab: | Output Fields |
| Field Name | Displays the name of the fields fetched from the business object as per the Criteria Query. Click the column and in the dialog that appears the list of available form fields of the provided Business Object Name are displayed. |
| Output Field | Specify an output field name for containing Cherwell field values. |
| Get HTML | Select Yes or no from the list. If a field in a Business object accepts Rich Text Format (RTF) input (Text and images) then such input is stored in HTML format internally. To fetch the stored content in RTF (in html format) you may select Yes. If Yes is selected for fields that do not have RTF input, it returns null. Some examples of business object fields accepting RTF input are, Incident: Description, Change: Description, Problem: Description, Knowledge Article: Body Text. |