Parameters reference
The syntax and meaning of the branch job parameters.
Parameter types
There are two types of parameters:
- Fixed
- You can specify fixed parameters only once in one job.
- Indexed
- You can specify indexed parameters multiple times in one job, or not specify them at all.
Fixed parameters
You can specify the following fixed parameters:
- CONDITION_SWITCH
- The type of condition that is run against the parent job. It can
have the following values:
- PARENT_SUCCESS
- The condition is TRUE when the parent ends in the SUCC state. This is the default value. For a description of this condition, see Scenarios based on condition type.
- PARENT_ABEND
- The condition is TRUE when the parent ends with the ABEND state. For a description of this condition, see Parent abend.
- COMPLEX
- The condition is built from one or multiple subconditions connected with Boolean operators (AND or OR) and is evaluated with Boolean logic. For a description of this condition, see Complex scenario - Multiple conditions.
- ACTION_SWITCH
- The action to perform on the stop branch. It can have the following
values:
- CANCEL
- The stop branch is canceled. This is the default value.
- PAUSE
- The stop branch is paused. For a description of this condition, see Pause and Release actions scenario.
- SIGNAL
- No branch is canceled. A recommendation requiring your confirmation is stored in the job log. For a description of this condition, see Signal action scenario.
Indexed parameters
Use indexed parameters only with the parameter CONDITION_SWITCH=COMPLEX specified (otherwise, they are ignored during branching process).
When you specify CONDITION_SWITCH=COMPLEX, the branch job evaluates a complex condition (a condition with one or more subconditions). Each subcondition has its own index, which starts with number 1 and is incremental.
PATTERN_2=find this row and number in this row
VALUE_2=50
ARITHMETICAL_OPERATOR_2=-lt
Group the parameters relating to one subcondition by using the same index. subconditions are evaluated separately and then connected together by Boolean operators. The complex condition is then evaluated.
Index usage examples
The following example shows the parameters to specify if you want to search for three patterns in the parent job log. The index acts as the incremental counter. The parameters belong to three separate subconditions:
PATTERN_1=first pattern to find
PATTERN_2=second pattern to find
PATTERN_3=third pattern to find
PATTERN_1=Free space on Primary device
VALUE_1=50
ARITHMETICAL_OPERATOR_1=-gt
Indexed parameters meaning
The following list describes the indexed parameters and their possible values. You can use all these parameters to create a single subcondition.
- PATTERN_i
- Search for a text pattern (for example, ended successfully).
If the pattern is found, the condition result is TRUE. For the PATTERN_i parameter, you can specify the following additional parameters. If PATTERN_i is not specified, they are ignored.
- VALUE_i
- Can be either STRING or NUMERIC. This is determined automatically
when reading the particular value parameter during the branch job
startup.
The value specified by VALUE_i is searched for in the same row identified by the search for the string indicated by PATTERN_i.
Two types of value are possible and they are determined automatically by parsing the content of the VALUE_i parameter:- String value
- Searches for another text pattern within the same row.
If both patterns are found within the same row, the condition result is TRUE.
For a description of this function, see Complex branch - Pattern within pattern row.
- Numeric value
- Searches for the numeric value within the same row.
The arithmetical operator you specified is then used to perform the arithmetical comparison. If the arithmetical comparison succeeded, the condition is TRUE. A specific arithmetical operator is defined for each numeric value.
For a description of this function, see Complex branch - Numeric value comparison.
- ARITHMETICAL_OPERATOR_i
- The operator used for the arithmetical comparison.
- NEGATE_CONDITION_RESULT_i
- This argument negates the result of the particular subcondition, meaning that it swaps the TRUE or FALSE result of the subcondition.
- BOOLEAN_OPERATOR_i
- The defined subconditions are joined together by the Boolean operator
AND or OR. You can use the Boolean operator because i=2.
This means that the index of the Boolean operator must be at least
2.
For example, you have two parameters in the list. Each of them represents one subcondition. Each subcondition is evaluated separately and their result is returned as either TRUE or FALSE. To evaluate the whole condition, you must join the particular results together.
The meaning of BOOLEAN_OPERATOR_i is that the connect result of this subcondition with the result of the preceding subcondition uses the Boolean operator AND or OR.
Reference tables
Table 1 describes the parameters, their possible values, and default.
Parameter name | Possible values | Default value |
---|---|---|
CONDITION_SWITCH | PARENT_SUCCESS PARENT_ABEND COMPLEX |
PARENT_SUCCESS |
ACTION_SWITCH | CANCEL PAUSE SIGNAL |
CANCEL (for branch
jobs) SIGNAL(for signal jobs) |
PATTERN_i, where i is the incremental index | Any string | |
VALUE_i, where i is the incremental index | Any string Any numeric value (integer or real) |
|
ARITHMETICAL_OPERATOR_i, where i is the incremental index | -lt -le -eq -ne -ge -gt |
-eq |
IS_CASE_SENSITIVE_i, where i is the incremental index | YES NO |
YES |
IS_REGULAR_EXPRESSION_i, where i is the incremental index | YES NO |
NO |
NEGATE_CONDITION_RESULT_i, where i is the incremental index | YES NO |
NO |
BOOLEAN OPERATOR_i, where i is the incremental index | && || |
&& |
The values for arithmetical and Boolean operators use UNIX syntax. Their meanings are shown in Table 2.
Parameter UNIX value | Parameter value interpretation | Parameter value meaning |
---|---|---|
-lt | < | Less than |
-le | <= | Less or equal |
-eq | = | Equal |
-ne | != | Not equal |
-ge | >= | Greater or equal |
-gt | > | Greater than |
&& | AND | Logical AND |
|| | OR | Logical OR |