Start / End Node
Let's go through all the options for configuring start and end nodes for a process definition.
The start node represents the beginning of a process and it is mandatory to add one when creating a process.
A process can have one or more start nodes. If you defined multiple start nodes, each should have a start condition value configured. When starting a new process instance the desired start condition should be used.
Configuring a start node
Node configuration is done by accessing the Node Config tab. You have the following configuration options for a start node:
- Node name - the name of the node
- Can go back - switching this option to true will allow users to return to this step after completing it
When encountering a step with
canGoBack switched to false, all steps found behind it will become unavailable.
- Swimlane - choose a swimlane (if there are multiple swimlanes on the process) to make sure only certain user roles have access only for certain process nodes- if there are no multiple swimlanes, the value is Default
- Stage - assign a stage to the node
The start condition should be set as a string value. This string value will need to be set on the payload for the start process request on the
To test the start condition, we can send a start request via REST:
Error handling on start condition
If a request is made to start a process with a start condition that does not match any start node, an error will be generated. Let's take the previous example and assume we send an incorrect value for the start condition:
A response with the error code
bad request and title
Start node for process definition not foundwill be sent in this case:
"defaultMessage": "Start node for process definition not found.",
"title": "Start node for process definition not found.",
An end node is used to mark where the process finishes. When the process reaches this node, the process is considered completed and its status will be set to
Configuring an end node
Multiple end nodes can be used to show different end states. The configuration is similar to the start node.