Versions Compared

Key

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

...

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.MINOR, NORMAL, MAJOR, 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.


MON_OS_JOB_TAGS

The list of tags assigned a job. The syntax is:

MON_OS_JOB_TAGS=[<group>:]<tag[,tag]>[[;<group>:]<tag>]

Example:

MON_OS_JOB_TAGS=critical_without_group,priority_without_group;Notification:critical,priority;SLA:level1,penalty

The environment variable holds

  • two tags critical_without_group and priority_without_group
  • one group Notification that includes two tags critical and priority
  • one group SLA that includes two tags level1 and penalty

Available from 

Jira
serverSOS JIRA
columnIdsissuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId6dc67751-9d67-34cd-985b-194a8cdc9602
keyJOC-1812

Order Notification JOC Cockpit Variables

...