Page History

...

<SystemMonitorNotification system_id="op5"> 
  <Notification> 
    <NotificationMonitor service_name_on_error="JobScheduler Monitoring Errors"> 
      ... 
    </NotificationMonitor> 
    <NotificationObjects>
      <!-- Send the job error, occurrent in the "test/my_job" order job, to the "JobScheduler Monitoring Errors" service. -->        
      <Job name="test/my_job" /> 
      <!-- Send the job chain error, occurrent in the "test/my_jobchain" job chain, to the "JobScheduler Monitoring Errors" service. --> 
      <JobChain name="test/my_jobchain" /> 
    </NotificationObjects> 
 </Notification> 
</SystemMonitorNotification>  

SystemMonitorNotification / Notification / NotificationObjects / Job 

Note:

This element specifies the order-controlled or standalone jobs for which notifications are being sent to a system monitor.

...

...

<SystemMonitorNotification system_id="op5"> 
  <Notification> 
    <NotificationMonitor service_name_on_error="JobScheduler Monitoring Errors"> 
      ... 
    </NotificationMonitor> 
    <NotificationObjects>
      <!-- Send the job error, occurrent in the 

...

Job supports the following attributes:

...
<Job notifications="2" name="test/my_job"/>
...
<Job scheduler_id="scheduler_4444" />
...
<Job scheduler_id="scheduler_4444" name="test/my_.*" />
... 
 order job, to the "JobScheduler Monitoring Errors" service. -->        
      <Job name="test/my_job" return_code_from="5"/> 
...  
<Job name=      <!-- Send the job chain error, occurrent in the "test/my_job" return_code_to="10"/>
...  
<Jobjobchain" job chain, to the "JobScheduler Monitoring Errors" service. --> 
      <JobChain name="test/my_jobjobchain" return_code_from="5" return_code_to="5"/>  
...
/> 
    </NotificationObjects> 
 </Notification> 
</SystemMonitorNotification>  

SystemMonitorNotification / Notification / NotificationObjects /

...

Job 

Note:

This element specifies the order-controlled or standalone jobs for which notifications are being sent to a system monitor.

Support for standalone jobs starting with

Job 

...

JobChain supports the following attributes:

...
<Job notifications="2" 

...
<JobChain notifications="2" name="test/my_jobchainjob"/>
...
<JobChain<Job scheduler_id="scheduler_4444" />
...
<JobChain<Job scheduler_id="scheduler_4444" name="test/my_.*" />
... 
<JobChain<Job name="test/my_jobchainjob" return_code_from="5"/> 
...  
<JobChain<Job name="test/my_jobchainjob" return_code_to="10"/>
...  
<JobChain<Job name="test/my_jobchainjob" return_code_from="5" return_code_to="5"/>  
...
<JobChain name="test/my_jobchain" step_from="200"/>
...
<JobChain name="test/my_jobchain" step_to="500"/>
...
<JobChain name="test/my_jobchain" step_from="300" step_to="300"/>
...
<JobChain name="test/my_jobchain" excluded_steps="200;300"/>
...

SystemMonitorNotification / Notification / NotificationObjects / TimerRef

TimerRef supports the following attributes:

SystemMonitorNotification / Notification / NotificationObjects / JobChain

JobChain supports the following attributes:

...
<JobChain notifications="2" name="test/my_jobchain"/>
...
<JobChain scheduler_id="scheduler_4444" />
...
<JobChain scheduler_id="scheduler_4444" name="test/my_.*" />
... 
<JobChain name="test/my_jobchain" return_code_from="5"/> 
... 
<JobChain name="test/my_jobchain" return_code_to="10"/>
... 

<SystemMonitorNotification system_id="op5"> 
  <Notification> 
    <NotificationMonitor service_name_on_error="JobScheduler Monitoring Error"> 
      ... 
    </NotificationMonitor> 
    <NotificationObjects> 
     <!-- 
     Send the job chain error, occurring in the "test/my_jobchain" job chain, to the "JobScheduler Monitoring Errors" service. 
     --> 
     <JobChain name="test/my_jobchain" return_code_from="5" return_code_to="5"/> 
    </NotificationObjects> 
  </Notification>   
 
  <Notification> 
    <NotificationMonitor service_name_on_error="JobScheduler Monitoring Performance"> 
      ... 
    </NotificationMonitor> 
    <NotificationObjects> 
      <!-- 
      Sends the performance check error, occurring in the 
...
<JobChain name="test/my_jobchain" step_from="200"/>
...
<JobChain name="test/my_jobchain" step_to="500"/>
...
<JobChain name="test/my_jobchain" job chain, to the "JobScheduler Monitoring Performance" service. 
      Sends the performance check error to the "JobScheduler Monitoring Performance" service will be ignored when the "step_from="300" step_to="300"/>
...
<JobChain name="test/my_jobchain" excluded_steps="200;300"/>
...

SystemMonitorNotification / Notification / NotificationObjects / TimerRef

TimerRef supports the following attributes:

<SystemMonitorNotification system_id="op5"> 
  <Notification> 
    <NotificationMonitor service_name_on_error="JobScheduler Monitoring Error"has the job chain error (default notify_on_error = false). 
      --> 
      <TimerRef ref="my_timer" /> ... 
    </NotificationObjects>NotificationMonitor> 
 </Notification>     <NotificationObjects> 
     <!-- 
 <Timer name="my_timer"> 
     Send the job chain error, occurring in the "test/my_jobchain" job chain, to the "JobScheduler Monitoring Errors" service. 
     --> 
     <TimerJobChain<JobChain name="test/my_jobchain" /> 
    </Timer> 
</SystemMonitorNotification> 

NotificationObjects> 
  </Notification>   
 
  <Notification> 
    <NotificationMonitor service_name_on_error="JobScheduler Monitoring Performance"> 
      ... 
    </NotificationMonitor> 
    <NotificationObjects> 
      <!-- 
      Sends the performance check error, occurring in the "test/my_jobchain" job chain, to the "JobScheduler Monitoring Performance" service. 
      Sends the performance check error to the "JobScheduler Monitoring Performance" service will be ignored when the "test/my_jobchain" has the job chain error (default notify_on_error = false). 
      --> 
      <TimerRef ref="my_timer" /> 
    </NotificationObjects> 
 </Notification>   
 
 <Timer name="my_timer"> 
    <TimerJobChain name="test/my_jobchain" /> 
 </Timer> 
</SystemMonitorNotification> 

SystemMonitorNotification / Notification / NotificationObjects / MasterMessage

MasterMessage includes problems detected by a JobScheduler Master, e.g. database connection lost.

Requirements:

•   ./config/factory.ini configuration file:

  • mail_queue_only=true

  • mail_queue_dir setting specifies a directory to store the JobScheduler mails

  • mail_on_warning=true

  • mail_on_error=true

MasterMessage supports the following attributes:

SystemMonitorNotification / Notification / NotificationObjects / TaskWarning

TaskWarning includes job execution warning messages.

Requirements:

•  ./config/factory.ini configuration file:

  • mail_queue_only=true

  • mail_queue_dir setting specifies a directory to store the JobScheduler mails

  • mail_on_warning=true

TaskWarning supports the following attributes:

SystemMonitorNotification / Notification / NotificationObjects / TaskIfLongerThan

TaskIfLongerThan includes the feature to send notification in case that the execution of job requires a longer duration than expected.

Requirements:

• The Job configuration contains the warn_if_longer_than setting.  
• ./config/factory.ini configuration file:

  • mail_queue_only=true

  • mail_queue_dir setting specifies a directory to store the JobScheduler mails

  • mail_on_warning=true

TaskIfLongerThan supports the following attributes:

SystemMonitorNotification / Notification / NotificationObjects / TaskIfShorterThan

 TaskIfShorterThan includes the feature to send notification in case that the execution of job requires a shorter duration than expected.

 Requirements:

• The Job configuration contains the warn_if_shorter_than setting.  

• ./config/factory.ini configuration file:

  • mail_queue_only=true

  • mail_queue_dir setting specifies a directory to store the JobScheduler mails

  • mail_on_warning=true

 TaskIfShorterThan supports the following attributes:

SystemMonitorNotification / Timer 

...

<?xml version="1.0" encoding="ISO-8859-1"?> 
<job  title="Sample Job with Store Result Monitor" order="yes" stop_on_error="no" tasks="1">     
  <params>
     <!--
     set the scheduler_notification_result_parameters parameter
     -->         
    <param name="scheduler_notification_result_parameters" value="file_size"/>     
  </params>     
  
  <!--
  calculate and create the new order parameter if necessary
  -->
  <script language="java:javascript"><![CDATA[             
      function spooler_process(){                                  
        var order    = spooler_task.order;                 
        var params   = spooler.create_variable_set();                 
        params.merge(spooler_task.params);                 
        params.merge(order.params);                      
        
        // parameter scheduler_file_path was set in the previous job chain step
        var file     = new java.io.File(params.value("scheduler_file_path"));                 
        var fileSize = file.length()/1024;                 
        order.params.set_var("file_size",fileSize.toString());                          
      return true;             
      }]]>     
   </script>          
 
   <!-- 
   set the StoreResultsJobJSAdapterClass as a monitor
   the StoreResultsJobJSAdapterClass as a monitor
   -->     
   <monitor  name="notification_monitor" ordering="1">         
     	<!-- JobScheduler version 1.9.x, 1.10.x
	<script java_class="com.sos.scheduler.notification.jobs.result.StoreResultsJobJSAdapterClass" language="java"/>
        -->
   
        <!-- JobScheduler version 1.11.x, 1.12.x --> 
    
   <monitor <script namejava_class="notification_monitorcom.sos.jitl.notification.jobs.result.StoreResultsJobJSAdapterClass" orderinglanguage="1java"/> 
   </monitor>

   <run_time  
     	<!-- JobScheduler version 1.9.x, 1.10.x
	<script java_class="com.sos.scheduler.notification.jobs.result.StoreResultsJobJSAdapterClass" language="java"/>
        -->
   
        <!-- JobScheduler version 1.11.x, 1.12.x --> 
        <script java_class="com.sos.jitl.notification.jobs.result.StoreResultsJobJSAdapterClass" language="java"/> 
   </monitor>

   <run_time /> 
</job> 

...

Usage

The Message can be configured on the following parent nodes as a CDATA element :

• SystemMonitorNotification / Notification / NotificationInterface

• SystemMonitorNotification / Notification / NotificationCommand
• SystemMonitorNotification / Notification / NotificationMail 
  • Subject

  • Body
• SystemMonitorNotification / Notification / NotificationJMS / Message


The Message can contain: 

• Fixed values
• Variables

...

/> 
</job> 

Message

Anchor
message message

Usage

The Message can be configured on the following parent nodes as a CDATA element :

• SystemMonitorNotification / Notification / NotificationInterface

• SystemMonitorNotification / Notification / NotificationCommand
• SystemMonitorNotification / Notification / NotificationMail 
  • Subject

  • Body
• SystemMonitorNotification / Notification / NotificationJMS / Message


The Message can contain: 

• Fixed values
• Variables

Example: <![CDATA[ scheduler id = ${MON_N_SCHEDULER_ID}  ]]>

Variables

All variables (except OS environment variables) must be defined by using of the

${<variable name>}

syntax.

Note:

• Syntax for the JobScheduler version 1.10.6 and higher. Syntax for the JobScheduler version 1.10.4, 1.10.5 (see below) is still supported.
• Syntax for the JobScheduler version 1.10.4, 1.10.5:  {<variable name>}
• Syntax for the JobScheduler previous versions: %<variable name>%

The order of the substitution the variables values is:

1. Table variables.
2. Service variables.
3. JOC Cockpit variables.
4. OS environment variables.
   
   

Table variables

${MON_N_ID}

...

...

Variables

...

...

syntax.

Note:

• Syntax for the JobScheduler version 1.10.6 and higher. Syntax for the JobScheduler version 1.10.4, 1.10.5 (see below) is still supported.
• Syntax for the JobScheduler version 1.10.4, 1.10.5:  {<variable name>}
• Syntax for the JobScheduler previous versions: %<variable name>%

The order of the substitution the variables values is:

...

Table variables

${MON_N_ID}

HISTORY_ID}, job_chain = ${MON_N_

JOB_CHAIN_

NAME}(${MON_N_

ORDER_

ID}), error = ${MON_N_

ERROR_

TEXT}

 scheduler id = ${MON_N_SCHEDULER_

ID}, history id = ${MON_N_ORDER_

${MON_SN_

OBJECT_

 scheduler id = ${MON_N_SCHEDULER_ID}, history id = ${MON_N_ORDER_HISTORY_ID}, job_chain = ${MON_N_JOB_CHAIN_NAME}(${MON_N_ORDER_ID}), error = ${MON_N_ERROR_TEXT}

TYPE}

${MON_SN_OBJECT_TYPE_NAME}

${MON_SN_TITLE}

${MON_SN_OBJECT_TYPE}

${MON_SN_RETURN_CODE_FROM} 

${MON_SN_RETURN_CODE_TO}

 step from = ${MON_SN_STEP_FROM}, step to = ${MON_SN_STEP_TO}, notification = ${MON_SN_CURRENT_NOTIFICATION} (of ${MON_SN_NOTIFICATIONS})

...