Create custom activities using custom activity designer templates
You can create and update different types of custom activities in the Workflow Editor using a custom template.
Before you begin
Roles required: workflow_admin or activity_creator
About this task
The Activity Designer contains common steps which are applicable to all the activities that you create. This procedure guides you through the common steps and the order they should be set up. You specify an activity template before you create a custom activity.
Procedure
Navigate to All > Orchestration > Workflow Editor.
The Welcome tab of the Workflow Editor opens.
On the Custom tab in the palette, click + to create a new activity select the appropriate template from the list.
Arrow pointing to the plus sign on the Custom tab
The Activity Designer form appears, with a stage indicator at the top. All new activities start at the **General** stage. The current stage shows with a blue underscore.
Activity designer stage indicator
Add the general properties.
This information is standard for each custom activity, include a name, description, and other related information.
Create the template Create input variables for the template.
Create the variables to pass into the activity in the Inputs form of the activity designer.
Add a pre-processing script.
For input validation or transforming input data, you might need a pre-processing script.
Note: This step is not included in the Run Script activity.
Click Continue to open the Execution Command form, then fill out the Execution Command step based on the corresponding execution templates:
In the Outputs form, define local and/or output variables.
Local variables can be used for temporary storage when cascading parsing rules. For example, you might extract an XML payload from within a JSON payload. A local variable can access the XML document and use that as a source for another parsing rule. The graphic shows a Local1 variable source to parse data for Output2.
Drop-down list for defining a local variable
- Use one of the options to assign values to Outputs.
| Parsing rule | You can create a parsing rule and map them to the output fields by dragging and dropping the variables into the parsing rules structure. The REST, SOAP, and JDBC templates provide auto-mapping to create the parsing rules automatically. If available from the test inputs form, auto-mapping should be used when possible. |
| Post-processing | Post-processing scripts allow you to code your own output data validation, output parsing code, and related tasks. Post-processing executes after the execution command results have been returned and before the parsing rules and conditions are run. Click Go to Post-Processing (Advanced) to create a post-processing script. Note: If you create a script, this step reflects as a stage in the indicator. |
Click Continue to open the Conditions form to create exit condition rules for your activity and then click Save.
General properties for activity designer templates
The following General Property fields are common to all activity designer templates.- Create input variables
Create the variables to pass into the activity in the Inputs form of the activity designer. - Data encryption for activity variables
You can protect sensitive data passed from Orchestration activities by encrypting input and output variables. - Activity designer template pre-processing fields
Use the Pre Processing form of the activity designer to define a script to run before the activity executes. - Template post-processing fields
From the Post Processing form in the activity designer you can define a script to run after the activity executes. - Auto-map activity output variables
You can map parameter values in a test payload to variables in the Outputs tab automatically. - Create an output variable
The Outputs form in the designer contains a variable builder for creating data structures of objects and arrays. - Create a parsing rule
Populate output variables defined in a custom activity with payload data returned from an inputs test on an external host or endpoint. - Activity conditions
Create the exit conditions for your activity in the Condition column and set the order for each..
Parent Topic:Orchestration activity designer