The change in status for a job in plan creates an event. Whenever the monitored job
changes its status, an event is created, and you can configure the event conditions to match
such an event. When all the event conditions are satisfied, it triggers the job stream. You
can configure the event conditions to trigger an event whenever the monitored job changes
its status or only when it changes to a specific status.
Overview
You can configure the event conditions with the different statuses of a job. You can
customize both mandatory and optional attribute filters to define specific
conditions to trigger an event. This configuration empowers you to tailor events
according to specific preferences or requirements, that enhances the flexibility and
adaptability.
The mandatory attribute filters that you must provide to configure the event are:
-
- Workstation
- Specify the workstation of the job stream that contains the job
to be monitored. This detail must be preceded by the workstation
folder details. The supported value type is string and for
available operators see Event driven orchestration configuration attributes.
Wildcard characters are permitted.
- The multipleFilters property is enabled and if required,
you can provide multiple filters or values separated by a
semicolon (;) for a single instance of the workstation
attribute.
- The singlePredicate property is disabled, so you can
also add multiple instances of the workstation attribute.
Note: To add a workstation that is not saved
in the folder specified by the
current_folder property in the
config.yaml file, provide the
complete path to the workstation folder.
Example: If the
RS_AGT_1
workstation is saved under
FOLDER1 under the root folder
and the folder specified by the
current_folder property in
the
config.yaml differs, then
specify the workstation as follows in the event
definition:
/FOLDER1/RS_AGT_1
-
- Job stream
- Specify the job stream that contains the job to be monitored.
This detail must be preceded by the job stream folder details.
The supported value type is string and for available operators
see Event driven orchestration configuration attributes. Wildcard characters are
permitted.
- The multipleFilters property is enabled and if required,
you can provide multiple filters or values separated by a
semicolon (;) for a single instance of the job stream attribute.
- The singlePredicate property is disabled, so you can
also add multiple instances of the job stream attribute.
Note: To add a job stream that is not saved
in the folder specified by the
current_folder property in the
config.yaml file, provide the
complete path to the job stream folder.
Example: If the
JOBSTREAM_AGT
job stream is saved
in the
FOLDER1 under the root
folder and the folder specified by the
current_folder property in
config.yaml differs, then
specify the job stream as follows in the event
definition:
/FOLDER1/JOBSTREAM_AGT
-
- Job
- Specify the name of the job that is monitored for a change in
its status. When the specified status or statuses for the job is
reached, it satisfies the condition. If you do not specify any
value for internal or external status,
whenever the job changes its status the filter is considered
satisfied. The supported value type is string and for available
operators see Event driven orchestration configuration attributes. Wildcard
characters are permitted.
- The multipleFilters property is enabled and if required,
you can provide multiple filters or values separated by a
semicolon (;) for a single instance of the job attribute.
- The singlePredicate property is disabled, so you can
also add multiple instances of the job attribute.
The optional attribute filters that you can add to trigger the event only for
specific scenarios are:
-
- Job workstation
- Specify the workstation where the job to be monitored runs. This
detail must be preceded by the workstation folder details. The
supported value type is string and for available operators see
Event driven orchestration configuration attributes. Wildcard characters are
permitted.
- The multipleFilters property is enabled and if required,
you can provide multiple filters or values separated by a
semicolon (;) for a single instance of the job workstation
attribute.
- The singlePredicate property is disabled, so you can
also add multiple instances of the job workstation
attribute.
Note: To add a workstation that is not saved
in the folder specified by the
current_folder property in the
config.yaml file, provide the
complete path to the workstation folder.
Example: If the
RS_AGT_1
workstation is saved under
FOLDER1 under the root folder
and the folder specified by the
current_folder property in
the
config.yaml differs, then
specify the workstation as follows in the event
definition:
/FOLDER1/RS_AGT_1
-
- Priority
- Specify the priority of the job. You can specify any value
between 0-101. If you add a value, the change in status of the
monitored job only with that priority satisfies the condition.
The supported value type is nonnegativeinteger and for available
operators see Event driven orchestration configuration attributes. Wildcard
characters are not permitted.
- The multipleFilters property is enabled and you can
specify single or multiple values or a specific range separated
by a semicolon (;) for a single instance of the priority
attribute.
- The singlePredicate property is disabled, so you can
also add multiple instances of the priority attribute.
-
- Return code
- Only valid for completed or abended jobs. Specify the value,
only if you expect to trigger the event when the job is
completed or abended. The supported value type is numeric and
for available operators see Event driven orchestration configuration attributes.
Wildcard characters are not permitted.
- The multipleFilters property is enabled and you can
specify single or multiple values or a specific range separated
by a semicolon (;) for a single instance of return code
attribute.
- The singlePredicate property is disabled, so you can
also add multiple instances of the Return code attribute.
-
- External status
- Specify an external status for the job to set as an event
condition. The supported value type is string and for available
operators see Event driven orchestration configuration attributes. Wildcard
characters are not permitted.
- You can add a single status or multiple statuses as an array.
For example, if you want to add multiple statuses, specify as
External status={BLOCKED,CANCELLED}
. When
any one of the specified status is reached, it satisfies the
condition. If you do not specify any value, whenever there is a
change in job status, the filter is considered satisfied. The
available external statuses that you can give are:
- BLOCKED
- CANCELLED
- ERROR
- READY
- RUNNING
- SUCCESSFUL
- SUPPRESS
- WAITING
-
- Internal status
- Specify an internal status for the job to set as an event
condition. The supported value type is string and for available
operators see Event driven orchestration configuration attributes. Wildcard
characters are not permitted.
- You can add single or multiple statuses as an array. For
example, if you want to add multiple statuses, specify as
Internal status={BLOCKED,CANCELLED}
. When
any one of the specified status is reached, it satisfies the
condition. If you do not specify any value, whenever there is a
change in job status, the filter is considered satisfied. The
available internal statuses that you can give are:
- ABEND
- ABENP
- CANCL
- EXEC
- END
- FAIL
- FENCE
- HOLD
- INTRO
- PEND
- READY
- SUCC
- SUCCP
- SUSP
- SUPPR
- STUCK
- WAIT
-
- Internal sub status
- You can use this optional attribute to further configure the
event conditions for HOLD,
READY and
SUCC statuses. The supported
value type is string and for available operators see Event driven orchestration configuration attributes. Wildcard characters are not
permitted.
- You can add single or multiple options from the following sub
statuses as an array. For example, if you want to add multiple
statuses, specify as
Internal sub
status={HOLD_WAITING_FOR_FILE,
HOLD_WAITING_FOR_PROMPT}
. If any one is matched the
filter is considered satisfied. The available internal sub
statuses that you can give are:
- HOLD_WAITING_FOR_FILE
- HOLD_WAITING_FOR_PREDECESSOR
- HOLD_WAITING_FOR_PROMPT
- HOLD_WAITING_FOR_TIME
- HOLD_PRIORITY_ZERO
- READY_SUBMITTED
- READY_SUPPRESSED
- READY_WAITING_FOR_AGENT
- READY_WAITING_FOR_LIMIT
- READY_WAITING_FOR_RESOURCES
- SUCC_COMPLETED
- SUCC_DO_NOT_RUN
-
- Recoverable
- This optional attribute is only valid if the job you want to
monitor has recovery or rerun option. The supported value type
is boolean and for available operators see Event driven orchestration configuration attributes. Wildcard characters are not
permitted.
- You can either give
true
or
false
, if the job has any one of the
following:
- Recovery options stop and
continue with a
recovery job.
- Rerun option.
-
- Output conditions
- You can specify the name of the output conditions of the
monitored job, if any exist. Make sure to add only those output
conditions that are satisfied for the job. The supported value
type is string and for available operators see Event driven orchestration configuration attributes. Wildcard characters are not
permitted. You can add single or multiple values and if any one
is matched, the filter is considered satisfied.
- The singlePredicate property is disabled, so you can
also add multiple instances for the same attribute.