Workflow Activities

Workflow End Point Task

Call an end point with the specified parameters. Your end point will need to be published to the serverlibrary..

Property	Description
ID	An optional unique ID for this element. The modeller will assign a random ID if left blank
Name	A name for this element
Description	An optional description for this element
Asynchronous	When execution reaches a task that has been marked as asynchronous the engine will commit the current transaction and schedule a background job to continue the process from the asynchronous task
End Point Name	A pop-up explorer that lets you pick the end point to call. You can also enter a ${...} expression that resolves to the name of an end point
End Point Parameters	The parameters that will be passed to the end point. See below for further information
Return Variable	The process variable that the result of the call will be stored in
Transient Return Variable?	If enabled, the result will be stored as a transient process variable instead of a persistent one. Transient variables are not saved to the database or process history, and are only visible until the process reaches its next wait state
Error Variable	The process variable that any error will be stored in
Error Handling	There are three possible error handling mechanisms: None - whichever strategy is used, a process variable is set with a user-specified name "Error Variable" on the main properties tab. If an error transition or BPMN error is not specified, it is the responsibility of the workflow to determine that an error has occurred by checking this variable. Follow error transition - an outgoing flow from the API Server Task is given a specific label which is also given as the Error Transition property on the advanced properties tab. If an error is returned from the API call this flow will be followed instead of the default flow (note that the "happy path" must be set to be the default flow for this to work). Throw BPMN error - the BPMN error specified on the advanced tab is thrown when the API call returns an error. This can then be caught by an Boundary error event, or other error catching event

End Point Parameters

The task provides a request builder to help set the parameters that will be passed to your end point.

When first launched, the Parameters tab will include an object with all of the parameters marked as required in the end point's schema. The other tabs let you view any help that has been written for the end point, it's schema, and examples taken from any saved tests.

Using Variables

The values of process variables can be accessed in your end point parameters.

Process variables that have string values can be accessed using "#myVariable#". Process variables with number values don't need quotes, so #myNumberVariable#.

For example, a script task in the model could set:

execution.setVariable("subject", "test"); execution.setVariable("to", "[email protected]"); execution.setVariable("body", "body content set separately");

Each of these values could be added to the parameters as: