The Custom Completion Status node allows you to define a custom status to signify the completion of an analysis. The intent of this status is to be something that represents more than just a binary success/failure of the analysis - which is already represented by the analysis's result code. When using a Custom Completion Status node, you can define logic within your analysis to output a status that represents a specific condition. You can then use that status within a process model.
When a Custom Completion Status node is added as the endpoint of an analysis, it will make the values from the first row of every field in the node accessible within a process model.
Creating a Custom Completion Status
For example, suppose you have created an Analysis that concludes by creating a single row representing a number of conditions that are derived from computations performed on fields within previous nodes.
|
condition1 |
condition2 |
measure1 |
|---|---|---|
|
true |
true |
100 |
To utilize a Custom Completion Status node, you could create additional columns using expressions that evaluate to String values, which represent conditions.
For example, consider the following expression for a new field called ‘customStatus':
IF((condition1 = true && condition2 = true && measure1 > 90), ‘good', ‘bad')
For this data set, the expression would evaluate to ‘good':
|
condition1 |
condition2 |
measure1 |
customStatus |
|---|---|---|---|
|
true |
true |
100 |
good |
Using a Custom Completion Status in a Process Model
Within a Process Model, you could then access the customStatus field and its value by creating a literal variable within any node. The variable needs to have the same name as the field's name in the Analysis. Once this is setup, the variable will contain the same value as is held in the first row of its associated field in the Custom Completion Status node within the Analysis. From here, the variable can then be used to implement logic within the Process Model.
A variable with the same name as was used for the Custom Completion Status Field (customStatus) is created at the beginning of the Process Model.
customStatus is passed as a Property Reference variable into the Execute Stage Task.
An expression, such as {input}.customStatus = ‘good' is used in the Exclusive Gateway.
If the expression from c evaluates to true, the Process Model will end successfully. Otherwise, an email is sent using a Notify Task and the Process Model ends in error.
Accessing status variables directly in Notify Tasks
If you do not want to use your status variable to perform any logic within your Process Model, and you simply need to use it in messaging, you may refer to the variable directly by name within a Notify task's messaging parameters, using the following syntax: ${variableName}