4.2.16 Branch by property value plug-in
Function
This plug-in compares the value of a service property, the value of a reserved property, a literal string, or any combination thereof against a specified value. The result of the comparison determines which step JP1/AO executes next.
A branch by property value plug-in connects to two branch destination steps: A succeeding step, and a step that is only executed when the judgment condition is met. If the input value matches the judgment condition, JP1/AO executes the branch destination step and the succeeding step, in that order. If the input value does not match the judgment conditions, JP1/AO executes the succeeding step only.
A branch by property value plug-in combines the functionality of a test value plug-in and a branch by returncode plug-in.
Cautionary notes
-
When you execute this plug-in, the information output to the task log reflects the execution of the test value plug-in. The branch by property value plug-in does not contribute to the task log.
-
If execution of a task is stopped during plug-in execution, the task enters Completed status after the branch by property value plug-in finishes processing.
-
If you forcibly terminate a task while the plug-in is executing, the status of the task, the return code, and the status of the step depend on the execution status of the test value plug-in and the branch by returncode plug-in.
- If the test value plug-in has not finished processing:
-
The processing being executed is terminated. JP1/AO does not wait for the test value plug-in to finish processing. The task enters Failed status. A return code of 80 appears for the step in the Flow area of the Tasks window. The return code output to the task log depends on the timing with which the task was forcibly terminated.
- If the test value plug-in has finished but the branch by returncode plug-in has not:
-
The task enters Completed status after waiting for the branch by returncode plug-in to finish processing. The return code and step status displayed in the Flow area of the Tasks window are those in effect when the test value plug-in was executed.
Version
01.10.01
Tag
Control Flow
Return codes
Return code |
Description |
---|---|
0 |
The plug-in returns 0 when:
|
1 |
The plug-in returns 1 when:
|
Property list
The following table describes the properties.
Property key |
Property name |
Description |
Default value |
I/O type |
Required |
---|---|---|---|---|---|
condition |
Condition |
Specify the judgment condition for the valueX property. You can select from the following conditions:
|
valueX=value1 |
Input |
R |
valueX |
ValueX |
Specify a value as the basis for comparison, using no more than 1,024 characters. You can use the following formats individually or combined.
|
-- |
Input |
R |
value1 |
Value1 |
Specify the value against which to compare the valueX property, using no more than 1,024 characters. You can use the following formats individually or together.
The value is mapped to value1 in the condition property. |
-- |
Input |
O |
value2 |
Value2 |
Specify the value against which to compare the valueX property, using no more than 1,024 characters. You can use the following formats individually or together.
The value is mapped to value2 in the condition property. The value in this property takes effect when value2 is specified in the condition property. |
-- |
Input |
O |
defaultReturnCode |
Default Return Code On Error |
This property specifies the value returned by the plug-in when a numerical comparison is specified in the condition property, and a value that cannot be compared on a numerical basis is specified in any of the valueX, value1, and value2 properties.
|
63 |
Input |
R |
Related topics