Product Knowledge Base

Space shortcuts

Page tree

Versions Compared

Old Version 101

changes.mady.by.user Robert Ehrlich

Saved on

compared with

New Version 102

changes.mady.by.user Robert Ehrlich

Saved on

Key

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

...

  1. Table variables.
  2. Service variables.
  3. OS environment variables. 

...

Table variables 
Expand
titleVariables: table SCHEDULER_MON_NOTIFICATIONS

 Table of the history of steps of processed orders.

NameDescription 
%MON_N_ID%Unique notification id
%MON_N_SCHEDULER_ID% Id of the JobScheduler
%MON_N_TASK_ID%Id of the JobScheduler task 
%MON_N_STEP% Consecutive number of the order step
%MON_N_ORDER_HISTORY_ID% Id of the JobScheduler order 
%MON_N_JOB_CHAIN_NAME% Name of the job chain of the order 
%MON_N_JOB_CHAIN_TITLE%Title of the job chain of the order  
%MON_N_ORDER_ID% Unique (within the job chain) id of the order 
%MON_N_ORDER_TITLE% Title of the order 
%MON_N_ORDER_START_TIME% Timestamp of the start of the order
%MON_N_ORDER_END_TIME% Timestamp of the end of the order
%MON_N_ORDER_TIME_ELAPSED% The time or difference in seconds between a beginning time and an ending time of the order
%MON_N_ORDER_STEP_STATE% State of the order inside the job chain
%MON_N_ORDER_STEP_START_TIME%Timestamp of the start of the order step 
%MON_N_ORDER_STEP_END_TIME% Timestamp of the end of the order step 
%MON_N_ORDER_STEP_TIME_ELAPSED%The time or difference in seconds between a beginning time and an ending time of the order step 
%MON_N_JOB_NAME%Name of the job 
%MON_N_JOB_TITLE% Title of the job
%MON_N_TASK_START_TIME%Timestamp of the job task start 
%MON_N_TASK_END_TIME% Timestamp of the job task end
%MON_N_TASK_TIME_ELAPSED% The time or difference in seconds between a beginning time and an ending time of the job task
%MON_N_RECOVERED% 

0 = dependent of the %MON_N_ERROR% - ok or error was not recovered,

1 = error was recovered  

%MON_N_ERROR%

0 = ok

1 = error 

%MON_N_ERROR_CODE% Exception-code of the job error 
%MON_N_ERROR_TEXT%Exception message of the job (that processed the order) 
%MON_N_CREATED% Timestamp of the notification initial record 
%MON_N_MODIFIED%Timestamp of the latest changes to this notification record 

...

The default com.sos.scheduler.notification.plugins.notifier.SystemNotifierProcessBuilderPlugin plugin used by the SystemMonitorNotification / Notification / NotificationCommand element sets the following variables as environment variables:

  1. Service variablesTable variablesTables variables
  2. Service variables

These variables can be used when the NotificationCommand calls the notification client not directly, but a shell script, that make the logical implementation for sending of the notification messages.

Table variables

 

Expand
titleVariables

All table variables (see Table variables explanation) are set as environment variables with the prefix:

  • SCHEDULER_MON_TABLE_

e.g.:

  • SCHEDULER_MON_TABLE_MON_N_ID
  • SCHEDULER_MON_TABLE_MON_N_SCHEDULER_ID
  • ...
Service variables
Expand
titleVariables
NameDescription

SCHEDULER_MON_SERVICE_NAME

Current service name. One of both element attributes:

  • SystemMonitorNotification / Notification / NotificationMonitor / @service_name_on_error
  • SystemMonitorNotification / Notification / NotificationMonitor / @service_name_on_success

SCHEDULER_MON_SERVICE_STATUS

Current service status. One of both element attributes or default:

  • SystemMonitorNotification / Notification / NotificationMonitor / @service_status_on_error
  • SystemMonitorNotification / Notification / NotificationMonitor / @service_status_on_success
  • default CRITICAL error
  • default OK       success

SCHEDULER_MON_SERVICE_MESSAGE_PREFIX

  • ERROR      error                           
  • RECOVERED    error recovery                            
  • TIMER             performance check 

SCHEDULER_MON_SERVICE_COMMAND

 Content of the SystemMonitorNotification / Notification / NotificationCommand after substitution
Tables variables

...

titleVariables

All tables variables (see tables variables explanation) are set as environment variables with the prefix:

  • SCHEDULER_MON_TABLE_

e.g.:

...

  

Code Block
languagebash
titleSample NotificationCommand Unix. Script file (/tmp/command.sh).
collapsetrue
1) configured command in the SystemMonitorNotification_<MonitorSystem>.xml file
<NotificationCommand><![CDATA[/tmp/command.sh]</NotificationCommand>
 
2) content of the /tmp/command.sh file
#! /bin/sh 
# Note: "> /tmp/command_output.txt" used to simulate the starting of the notification client
#
echo $SCHEDULER_MON_SERVICE_NAME:$SCHEDULER_MON_SERVICE_STATUS:$SCHEDULER_MON_SERVICE_MESSAGE_PREFIX history id = $SCHEDULER_MON_TABLE_MON_N_ORDER_HISTORY_ID > /tmp/command_output.txt
 

...