...
| Expand |
|---|
| title | List of Common Variables |
|---|
|
| Name | Description | Possible Values | Note |
|---|
MON_TIME_ZONE | Time zone used for formatting notification dates. | Any valid time zone. | JOC-1307 |
|
Common JOC Cockpit Variables
The following variables are available for access to JOC Cockpit and can be used with Command elements and with Message elements.
...
| Expand |
|---|
| title | List of Order Step Variables |
|---|
|
| Name | Description | Note |
|---|
MON_OS_HISTORY_ID | The Order History identifier for the current order step. |
| MON_OS_WORKFLOW_POSITION | The textual position indicator of the order step in the workflow including the branch identifier. |
| MON_OS_HO_MAIN_PARENT_ID | For a main order the monitoring identifier is returned. For a child the Order History identifier of the main order is returned. |
| MON_OS_HO_ID | The Order History identifier of the current order. |
| MON_OS_POSITION | The 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_NAME | The name of the job that the order is executing. |
| MON_OS_JOB_TITLE | The title of the job that the order is executing. |
| MON_OS_JOB_LABEL | The 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_CRITICALITY | The criticality as defined with the job. | NORMAL, CRITICAL | MON_OS_AGENT_ID | The unique identifier of an Agent that is specified when registering an Agent. |
| MON_OS_AGENT_URI | The URI of the Agent that executes the current job. |
| MON_OS_SEVERITY | The Order History status of the current order step. | SUCCESSFUL, FAILED, INCOMPLETE | MON_OS_START_CAUSE | The cause for the start of the order step. | ORDER, FORK | MON_OS_START_TIME | The timestamp for the start of execution in the current order step. |
| MON_OS_START_VARIABLES | The list of order variables in JSON format before execution of the current workflow instruction. | {"file":"/tmp/my_order_file.txt"} | MON_OS_END_TIME | The timestamp for the end of execution of the current workflow instruction. |
| MON_OS_END_VARIABLES | The 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_ELAPSED | The difference in seconds between the end time and the star time of execution of the current order step. |
| MON_OS_ERROR | The Boolean value true or false that indicates if an error occurred with the current workflow instruction. |
| MON_OS_ERROR_CODE | A JS7 error code in the event of a known error occuring. |
| MON_OS_ERROR_REASON | A predefined reason that indicates the cause of error, e.g. FAILED. | DISRUPTED, FAILED, TIMEDOUT | MON_OS_ERROR_STATE | The order state for the current order step caused by the error, e.g. FAILED, BROKEN. |
| MON_OS_ERROR_TEXT | The error message in the event of an error occurring in the current order step. |
| MON_OS_RETURN_CODE | 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 relevant Java class. |
| MON_OS_WARN | The 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 |
|---|
| server | SOS JIRA |
|---|
| serverId | 6dc67751-9d67-34cd-985b-194a8cdc9602 |
|---|
| key | JOC-1350 |
|---|
|
STDERR - Availability starting with JS7 2.4.1: | Jira |
|---|
| server | SOS JIRA |
|---|
| serverId | 6dc67751-9d67-34cd-985b-194a8cdc9602 |
|---|
| key | JOC-1363 |
|---|
|
Deprecated since JS7 2.4.1 | Jira |
|---|
| server | SOS JIRA |
|---|
| serverId | 6dc67751-9d67-34cd-985b-194a8cdc9602 |
|---|
| key | JOC-1350 |
|---|
|
. Use Notification Variables: MON_N_WARN | MON_OS_WARN_TEXT | The warning message in the event of a warning occurring. | Deprecated since JS7 2.4.1 | Jira |
|---|
| server | SOS JIRA |
|---|
| serverId | 6dc67751-9d67-34cd-985b-194a8cdc9602 |
|---|
| key | JOC-1350 |
|---|
|
. Use Notification Variables: MON_N_WARN_TEXT | MON_OS_LOG_ID | The identifier of the task log. |
| MON_OS_CREATED | The timestamp that the monitoring entry has been added. |
| MON_OS_MODIFIED | The timestamp that the monitoring entry has been modified. | |
|
Order Notification JOC Cockpit Variables
The following variables are available for access to JOC Cockpit and can be used with Command elements and with Message elements.
...