...
| 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 |
|
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 JOC Cockpit Variables |
|---|
|
| Name | Description | Note |
|---|
JOC_ID
| The identifier assigned the JOC Cockpit instance | Availability starting with JOC-1447. | JOC_TITLE | The title assigned the JOC Cockpit instance | The title is visible from the JOC Cockpit widget in the Dashboard view. | JOC_URI | The URL by which JOC Cockpit is available |
| JOC_REVERSE_PROXY_URI | The URL to access JOC Cockpit by a proxy | Availability starting with JOC-1381. |
|
Order Notifications
Notification Variables
The following variables are available from the configuration and can be used with Message elements and with Command elements.
| Expand |
|---|
| title | List of Notification Variables |
|---|
|
| Name | Description | Possible Values |
|---|
MON_N_ID | The unique identifier of the monitoring entry. |
| MON_N_TYPE | The message type corresponds to the specified type with the Notification element. | SUCCESS, WARNING, ERROR, RECOVERED | MON_N_STATUS | A numeric status identifier that can be used for integration with a System Monitor. | 0-OK, 1-WARNING, 2-CRITICAL, 3- UNKNOWN | MON_N_RANGE | An indicator for the monitor scope including jobs and workflows. | WORKFLOW, WORKFLOW_JOB | MON_N_NOTIFICATION_ID | The notification_id of the Notification XML element in use. |
| MON_N_RECOVERED_ID | The identifier of a monitoring entry that previously reported an error and that is considered recovered by the current monitoring entry. |
| MON_N_WARN | The indicator for the type of warning, e.g. LONGER_THAN. | NONE, LONGER_THAN, SHORTER_THAN, RETURN_CODE,STDERR
Availability starting with JS7 2.4.1: | Jira |
|---|
| server | SOS JIRA |
|---|
| serverId | 6dc67751-9d67-34cd-985b-194a8cdc9602 |
|---|
| key | JOC-1350 |
|---|
|
| Jira |
|---|
| server | SOS JIRA |
|---|
| serverId | 6dc67751-9d67-34cd-985b-194a8cdc9602 |
|---|
| key | JOC-1363 |
|---|
|
| MON_OS_WARN_TEXT | The warning message in the event of a warning occurring. | Availability starting with JS7 2.4.1: | Jira |
|---|
| server | SOS JIRA |
|---|
| serverId | 6dc67751-9d67-34cd-985b-194a8cdc9602 |
|---|
| key | JOC-1350 |
|---|
|
| Jira |
|---|
| server | SOS JIRA |
|---|
| serverId | 6dc67751-9d67-34cd-985b-194a8cdc9602 |
|---|
| key | JOC-1363 |
|---|
|
| MON_N_CREATED | The timestamp that the monitoring entry has been added. |
|
|
Order Variables
The following variables are available from orders and can be used with Message elements and with Command elements.
| Expand |
|---|
| title | List of Order Variables |
|---|
|
| Expand |
|---|
| title | Sample data: Names and Positions |
|---|
| | MON_O_HISTORY_ID | MON_O_NAME | MON_O_WORKFLOW_POSITION | MON_O_START_WORKFLOW_POSITION | MON_O_END_WORKFLOW_POSITION | MON_O_PARENT_ID | MON_O_MAIN_PARENT_ID |
|---|
| 318207 | #2021-07-23#T7052187293-Test0000000070 | 0 | 0 | 2 | 0 | 318207 | | 320121 | branch1 | 1/branch1:0 | 1 | 1/fork+branch1:2 | 318207 | 318207 | | 320122 | branch2 | 1/branch2:0 | 1 | 1/fork+branch2:2 | 318207 | 318207 | | 321560 | branch2b | 1/fork+branch2:1/branch2b:0 | 1/fork+branch2:1 | 1/fork+branch2:1/fork+branch2b:0 | 320122 | 318207 | | 321561 | branch2c | 1/fork+branch2:1/branch2c:0 | 1/fork+branch2:1 | 1/fork+branch2:1/fork+branch2c:0 | 320122 | 318207 | | 321682 | branch1b | 1/fork+branch1:1/branch1b:0 | 1/fork+branch1:1 | 1/fork+branch1:1/fork+branch1b:0 | 320121 | 318207 | | 321683 | branch1c | 1/fork+branch1:1/branch1c:0 | 1/fork+branch1:1 | 1/fork+branch1:1/fork+branch1c:0 | 320121 | 318207 |
|
| Name | Description | Note |
|---|
MON_O_HISTORY_ID | The Order History ID (unique identifier). |
| MON_O_CONTROLLER_ID
| The JS7 Controller ID. |
| MON_O_ORDER_ID | The Order ID (unique identifier). |
| MON_O_WORKFLOW_VERSION_ID | The version identifier of the workflow. |
| MON_O_WORKFLOW_POSITION | The order's current position in the workflow. |
| MON_O_WORKFLOW_PATH | The inventory path of the workflow that the order is executed for. |
| MON_O_WORKFLOW_FOLDER | The parent folder of a workflow in the inventory. |
| MON_O_WORKFLOW_NAME | The identifier of the workflow that the order is executed for. |
| MON_O_WORKFLOW_TITLE | The title of the workflow that the order is executed for. |
| MON_O_HAS_CHILDREN | The Boolean value true or false indicates that the current order is a parent order with forked child orders. |
| MON_O_MAIN_PARENT_ID | If 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_ID | The 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_SEVERITY | The Order History status. | SUCCESSFUL, FAILED, INCOMPLETE | MON_O_STATE | The current order state, see JS7 - Order State Transitions |
| MON_O_STATE_TIME | The point in time when the order transitioned to its current state. |
| MON_O_CURRENT_HOS_ID | The monitoring identifier of the current order step. |
| MON_O_START_CAUSE | The reason for the start of an order. | ORDER, FORK | MON_O_START_TIME_SCHEDULED | The point in time that the order was scheduled for. |
| MON_O_START_TIME | The timestamp when the order started. |
| MON_O_START_WORKFLOW_POSITION | For 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_VARIABLES | The list of order variables in JSON format. | {"file":"/tmp/my_file.txt"} | MON_O_END_TIME | The 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_ELAPSED | The difference in seconds between the end time and the start time of order execution. |
| MON_O_END_WORKFLOW_POSITION | For 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_ERROR | The Boolean value true or false that indicates if an error has occurred for the current order. |
| MON_O_ERROR_CODE | A JS7 error code in case that a known error has occurred. |
| MON_O_ERROR_REASON | A predefined reason that indicates the cause of an error, e.g. FAILED. | DISRUPTED, FAILED, TIMEDOUT | MON_O_ERROR_RETURN_CODE | In 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_TEXT | The error message in the event of an error occurring. |
| MON_O_LOG_ID | The database identifier of the order log. |
| MON_O_CREATED | The timestamp that the order monitoring entry has been added. |
| MON_O_MODIFIED | The timestamp that the order monitoring entry has been modified. |
|
|
Order Step Variables
The following variables are available from order steps, e.g. from jobs executed with a workflow and can be used with Message elements and with Command 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. | |
|
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 JOC Cockpit Variables |
|---|
|
| Name | Description | Note |
|---|
JOC_HREF_JOB
| The JOC Cockpit URL that points to the Workflows view with the respective job. | This URL can be used to navigate in JOC Cockpit to the respective Task History entry. | JOC_HREF_JOB_LOG | The JOC Cockpit URL that is used view the job's task log. | This URL can be used to navigate in JOC Cockpit to the respective Task History entry and to immediately view the log. | JOC_HREF_ORDER | The JOC Cockpit URL that points to the Order History view. | This URL can be used to navigate in JOC Cockpit to the respective Order History entry. | JOC_HREF_ORDER_LOG | The JOC Cockpit URL that is used to view the Order log. | This URL can be used to navigate in JOC Cockpit to the respective Order History entry and to immediately view the log. | JOC_HREF_WORKFLOW | The JOC Cockpit URL that points to the Workflows view for the given order. | This URL can be used to navigate in JOC Cockpit to the respective entry in the Workflows view. |
Reverse Proxy. Availability starting with JOC-1381. | Name | Description | Note |
|---|
JOC_REVERSE_PROXY_HREF_JOB
| The JOC Cockpit URL that points to the Workflows view with the respective job. | This URL can be used to navigate in JOC Cockpit to the respective Task History entry. | JOC_REVERSE_PROXY_HREF_JOB_LOG | The JOC Cockpit URL that is used view the job's task log. | This URL can be used to navigate in JOC Cockpit to the respective Task History entry and to immediately view the log. | JOC_REVERSE_PROXY_HREF_ORDER | The JOC Cockpit URL that points to the Order History view. | This URL can be used to navigate in JOC Cockpit to the respective Order History entry. | JOC_REVERSE_PROXY_HREF_ORDER_LOG | The JOC Cockpit URL that is used to view the Order log. | This URL can be used to navigate in JOC Cockpit to the respective Order History entry and to immediately view the log. | JOC_REVERSE_PROXY_HREF_WORKFLOW | The JOC Cockpit URL that points to the Workflows view for the given order. | This URL can be used to navigate in JOC Cockpit to the respective entry in the Workflows view. |
|
System Notifications
System Variables
The following variables are available for System Notifications and can be used with Command elements and with Message elements.
| Expand |
|---|
| title | List of System Variables |
|---|
|
|
| Expand |
|---|
| title | List of System Variables |
|---|
|
| Name | Description | Note |
|---|
JOC_TITLE | The title assigned the JOC Cockpit instance | The title is visible from the JOC Cockpit widget in the Dashboard view | JOC_URI | The URL by which JOC Cockpit is available | JOC_REVERSE_PROXY_URI | The URL to access JOC Cockpit by a proxy |
|---|
MON_SN_CATEGORY
| The category is JOC for messages related to JOC Cockpit classes and System for OS related messages |
| MON_SN_TYPE | The message type is WARNING or ERROR |
| MON_SN_SECTIONSOURCE | The identifier within a category that specifies the package source in which a problem occurred | For example section source ControllerApi for problems related to communication with the Controller. Availability starting with JOC-1447. Old name: MON_SN_SECTION | MON_SN_NOTIFIER | The Java class that caused the notification |
| MON_SN_TIME | The point in time when an error or warning did occur |
| MON_SN_MESSAGE | The message provided with the error or warning |
| MON_SN_EXCEPTION | The exception name provided that the System error or warning is related to Java classes |
|
|
...