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.

Figure 4‒12: Branch by property value 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: The judgment result is true. A numerical comparison is specified in the `condition` property, a value that cannot be compared on a numerical basis is specified in any of the `valueX`, `value1`, and `value2` properties, and 0 is specified in the `defaultReturnCode` property.
1	The plug-in returns 1 when: The judgment result is false. A numerical comparison is specified in the `condition` property, a value that cannot be compared on a numerical basis is specified in any of the `valueX`, `value1`, and `value2` properties, and 1 is specified in the `defaultReturnCode` property.

Return code

Description

The plug-in returns 0 when:

The judgment result is true.
A numerical comparison is specified in the condition property, a value that cannot be compared on a numerical basis is specified in any of the valueX, value1, and value2 properties, and 0 is specified in the defaultReturnCode property.

The plug-in returns 1 when:

The judgment result is false.
A numerical comparison is specified in the condition property, a value that cannot be compared on a numerical basis is specified in any of the valueX, value1, and value2 properties, and 1 is specified in the defaultReturnCode property.

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 ValueX is equal to Value1 (numerical comparison). valueX!=value1 ValueX is not equal to Value1 (numerical comparison). valueX<value1 ValueX is less than Value1 (numerical comparison). valueX>value1 ValueX is greater than Value1 (numerical comparison). valueX<=value1 ValueX is less than or equal to Value1 (numerical comparison). valueX>=value1 ValueX is greater than or equal to Value1 (numerical comparison). valueX>value1 AND valueX<value2 ValueX is greater than Value1 and less than Value2 (numerical comparison). valueX>=value1 AND valueX<value2 ValueX is greater than or equal to Value1, and less than Value2 (numerical comparison). valueX>value1 AND valueX<=value2 ValueX is greater than Value1, and less than or equal to Value2 (numerical comparison). valueX>=value1 AND valueX<=value2 ValueX is greater than or equal to Value1, and less than or equal to Value2 (numerical comparison). valueX<value1 OR valueX>value2 ValueX is less than Value1, or greater than Value2 (numerical comparison). valueX<=value1 OR valueX>value2 ValueX is less than or equal to Value1, or greater than Value2 (numerical comparison). valueX<value1 OR valueX>=value2 ValueX is less than Value1, or greater than or equal to Value2 (numerical comparison). valueX<=value1 OR valueX>=value2 ValueX is less than or equal to Value1, or greater than or equal to Value2 (numerical comparison). valueX equals value1 ValueX and Value1 are equal. This judgment is case sensitive (character string comparison). valueX not equals value1 ValueX and Value1 are not equal. This judgment is case sensitive (character string comparison). valueX contains value1 ValueX contains Value1. This judgment is case sensitive (character string comparison). valueX not contains value1 ValueX does not contain Value1. This judgment is case sensitive (character string comparison).	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. `?dna_service-property-key?` (when referencing the value of a service property) `?dna_reserved-property-key?` (when referencing the value of a reserved property) `literal-string`	--	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. `?dna_service-property-key?` (when referencing the value of a service property) `?dna_reserved-property-key?` (when referencing the value of a reserved property) `literal-string` 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. `?dna_service-property-key?` (when referencing the value of a service property) `?dna_reserved-property-key?` (when referencing the value of a reserved property) `literal-string` 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. `0` Specify 0 when using "The value matched the judgment condition." as the judgment result. `1` Specify 1 when using "The value did not match the judgment condition." as the judgment result. `63` Specify 63 if you want the step to terminate abnormally when the judgment gives a failed result. The plug-in terminates abnormally without executing the branch destination step or the succeeding step.	`63`	Input	R

Related topics

To Page Top