Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Expand
titleList of Order Variables
Expand
titleSample data: Names and Positions
MON_O_HISTORY_IDMON_O_NAMEMON_O_WORKFLOW_POSITIONMON_O_START_WORKFLOW_POSITIONMON_O_END_WORKFLOW_POSITIONMON_O_PARENT_IDMON_O_MAIN_PARENT_ID
318207#2021-07-23#T7052187293-Test00000000700020318207
320121branch11/branch1:011/fork+branch1:2318207318207
320122branch21/branch2:011/fork+branch2:2318207318207
321560branch2b1/fork+branch2:1/branch2b:01/fork+branch2:11/fork+branch2:1/fork+branch2b:0320122318207
321561branch2c1/fork+branch2:1/branch2c:01/fork+branch2:11/fork+branch2:1/fork+branch2c:0320122318207
321682branch1b1/fork+branch1:1/branch1b:01/fork+branch1:11/fork+branch1:1/fork+branch1b:0320121318207
321683branch1c1/fork+branch1:1/branch1c:01/fork+branch1:11/fork+branch1:1/fork+branch1c:0320121318207
NameDescription  Note
MON_O_HISTORY_IDThe Order History ID (unique identifier).
MON_O_CONTROLLER_ID
The JS7 Controller ID.
MON_O_ORDER_IDThe Order ID (unique identifier).
MON_O_WORKFLOW_VERSION_IDThe version identifier of the workflow.
MON_O_WORKFLOW_POSITIONThe order's current position in the workflow.
MON_O_WORKFLOW_PATHThe inventory path of the workflow that the order is executed for.
MON_O_WORKFLOW_FOLDERThe parent folder of a workflow in the inventory.
MON_O_WORKFLOW_NAMEThe identifier of the workflow that the order is executed for.
MON_O_WORKFLOW_TITLEThe title of the workflow that the order is executed for.
MON_O_HAS_CHILDRENThe Boolean value true or false indicates that the current order is a parent order with forked child orders.
MON_O_MAIN_PARENT_IDIf the current order is a nested child order then this identifier points to the monitoring identifier of the main parent order.
MON_O_PARENT_ID

If the current order is a child order then this identifier points to the monitoring identifier of the direct parent order.

Note that child orders can be nested.
MON_O_PARENT_ORDER_IDThe Order ID of the parent order if the current order is a child order.
MON_O_NAME

The Order ID of the current order if this is a main order. If the current order is a child order then the branch name of the child order is returned.


MON_O_SEVERITYThe Order History status.SUCCESSFUL, FAILED, INCOMPLETE
MON_O_STATEThe current order state, see JS7 - Order State Transitions
MON_O_STATE_TIMEThe point in time when the order transitioned to its current state.
MON_O_CURRENT_HOS_IDThe monitoring identifier of the current order step.
MON_O_START_CAUSEThe reason for the start of an order.ORDER, FORK
MON_O_START_TIME_SCHEDULEDThe point in time that the order was scheduled for.
MON_O_START_TIMEThe timestamp when the order started.
MON_O_START_WORKFLOW_POSITIONFor a main order the position in the workflow that the order was started for is returned. For a child order the workflow position related to its branch is returned.
MON_O_START_VARIABLESThe list of order variables in JSON format.{"file":"/tmp/my_file.txt"}
MON_O_END_TIMEThe timestamp for the end of order execution.Note that in the event of job errors, an order might have halted in a failed state and without  providing an end time as the order did not completely execute the workflow.
MON_O_TIME_ELAPSEDThe difference in seconds between the end time and the start time of order execution.
MON_O_END_WORKFLOW_POSITIONFor a main order the last position in the workflow is returned. For a child order the last position of its branch is returned.
MON_O_END_HOS_ID

MON_O_ERRORThe Boolean value true or false that indicates if an error has occurred for the current order.
MON_O_ERROR_CODEA JS7 error code in case that a known error has occurred.
MON_O_ERROR_REASONA predefined reason that indicates the cause of an error, e.g. FAILED.DISRUPTED, FAILED, TIMEDOUT
MON_O_ERROR_RETURN_CODEIn case of errors for shell jobs the operating system exit code is returned. For JITL jobs and for JVM jobs the return code optionally is implemented by the respective Java class.
MON_O_ERROR_STATE

MON_O_ERROR_TEXTThe error message in the event of an error occurring.
MON_O_LOG_IDThe database identifier of the order log.
MON_O_CREATEDThe timestamp that the order monitoring entry has been added.
MON_O_MODIFIEDThe timestamp that the order monitoring entry has been modified.

...

Expand
titleList of Order Step Variables
NameDescription  Note
MON_OS_HISTORY_IDThe Order History identifier for the current order step.
MON_OS_WORKFLOW_POSITIONThe textual position indicator of the order step in the workflow including the branch identifier.
MON_OS_HO_MAIN_PARENT_IDFor a main order the monitoring identifier is returned. For a child the Order History identifier of the main order is returned.
MON_OS_HO_IDThe Order History identifier of the current order.
MON_OS_POSITIONThe numeric position index of the order step in an instruction block within the workflow, e.g. within a Fork Instruction or Lock Instruction.
MON_OS_JOB_NAMEThe name of the job that the order is executing.
MON_OS_JOB_TITLEThe title of the job that the order is executing.
MON_OS_JOB_LABELThe unique label of the job instruction in the workflow.The label is unique for each occurrence of a job in a workflow.
MON_OS_JOB_CRITICALITYThe criticality as defined with the job.NORMAL, CRITICAL
MON_OS_AGENT_IDThe unique identifier of an Agent that is specified when registering an Agent.
MON_OS_AGENT_URIThe URI of the Agent that executes the current job.
MON_OS_SEVERITYThe Order History status of the current order step.SUCCESSFUL, FAILED, INCOMPLETE
MON_OS_START_CAUSEThe cause for the start of the order step.ORDER, FORK
MON_OS_START_TIMEThe timestamp for the start of execution in the current order step.
MON_OS_START_VARIABLESThe list of order variables in JSON format before execution of the current workflow instruction.{"file":"/tmp/my_order_file.txt"}
MON_OS_END_TIMEThe timestamp for the end of execution of the current workflow instruction.
MON_OS_END_VARIABLESThe list of order variables in JSON format resulting after execution of the current workflow instruction.{"file":"/tmp/my_job_file.txt","my_log":"/logs/my_log.log"}
MON_OS_TIME_ELAPSEDThe difference in seconds between the end time and the star time of execution of the current order step.
MON_OS_ERRORThe Boolean value true or false that indicates if an error occurred with the current workflow instruction.
MON_OS_ERROR_CODEA JS7 error code in the event of a known error occuring.
MON_OS_ERROR_REASONA predefined reason that indicates the cause of error, e.g. FAILED.DISRUPTED, FAILED, TIMEDOUT
MON_OS_ERROR_STATEThe order state for the current order step caused by the error, e.g. FAILED, BROKEN.
MON_OS_ERROR_TEXTThe error message in the event of an error occurring in the current order step.
MON_OS_RETURN_CODEFor shell jobs, the operating system exit code is returned.
For JITL jobs and for JVM jobs, the return code optionally is implemented by the relevant Java class.

MON_OS_WARNThe indicator for the type of warning, e.g. LONGER_THAN.

NONE, LONGER_THAN, SHORTER_THAN

RETURN_CODE - Availability starting with JS7 2.4.1:

Jira
serverSOS JIRA
serverId6dc67751-9d67-34cd-985b-194a8cdc9602
keyJOC-1350

STDERR - Availability starting with JS7 2.4.1:

Jira
serverSOS JIRA
serverId6dc67751-9d67-34cd-985b-194a8cdc9602
keyJOC-1363


Deprecated since JS7 2.4.1

Jira
serverSOS JIRA
serverId6dc67751-9d67-34cd-985b-194a8cdc9602
keyJOC-1350
.

Use Notification Variables:  MON_N_WARN

MON_OS_WARN_TEXTThe warning message in the event of a warning occurring.

Deprecated since JS7 2.4.1

Jira
serverSOS JIRA
serverId6dc67751-9d67-34cd-985b-194a8cdc9602
keyJOC-1350
.

Use Notification Variables:  MON_N_WARN_TEXT

MON_OS_LOG_IDThe identifier of the task log.
MON_OS_CREATEDThe timestamp that the monitoring entry has been added.
MON_OS_MODIFIEDThe timestamp that the monitoring entry has been modified.


...