Page History

...

will be sent:
- when a job chain state(step) or standalone job (JobScheduler versions releases from 1.12) ends without error
will not be sent:
- when a notification maximum has been reached
  - see SystemMonitorNotification / Notification / NotificationObjects / Job / @notifications
- when the @return_code_from or @return_code_to settings have been configured and the return code of the job is out of the configured range
  - see SystemMonitorNotification / Notification / NotificationObjects / Job / @return_code_from | @return_code_to

...

We recommend that the XML Editor is used generate monitoring configuration objects. This editor automatically uses an XSD Schema to generate configuration suggestions and validate configurations, and its use is intended to provide a significant reduction in the time required to develop and test a configuration.

XSD Schema locations

https://www.sos-berlin.com/schema/jobscheduler/SystemMonitorNotification_v1.0.xsd
JobScheduler releases before 1.13.1
- <scheduler_data>/config/notification/SystemMonitorNotification_v1.0.xsd
https:/
JobScheduler releases starting from 1.13.1
- <scheduler_data>/config/live/sos/.configuration/notification
/www.sos-berlin.com/schema/jobscheduler
- /SystemMonitorNotification_v1.0.xsd

Configuration

JobScheduler

Activation of Monitoring Interface

JobScheduler version releases before 1.9.x, 1.10.x11
- see JobScheduler - Job Chains
JobScheduler version releases starting from 1.11.x, 1.12.x
- Set param sos.use_notification true (config/scheduler.xml)
- see JobScheduler - Job Chains

Note:

JobScheduler releases before 1.13.1
- SystemMonitorNotification_<MonitorSystem>.xml file(s) (see below) must be configured before activtion.
JobScheduler releases starting from 1.13.1
- SystemMonitorNotification_<MonitorSystem>.xml file(s) (see below) must be configured before activtion or
- The NOTIFICATION configuration was forwarded by the Joc Cockpit to the respective JobScheduler Master.

SystemMonitorNotification files

JobScheduler releases before 1.13.1

Location: <scheduler_data>/config/notification

File Description

SystemMonitorNotification_v1.0.xsd

The XML Schema file defines which values are allowed in your XML files for the JobScheduler monitoring.

That means that to configure the JobScheduler objects you want to monitor and the System Monitor you just have to modify your SystemMonitorNotification_<MonitorSystem>.xml files but not the XML schema file.

SystemMonitorNotification_<MonitorSystem>.xml

Configuration file for each System Monitor.

Specifies the delivery way to System Monitor.
Specifies notification for error or success conditions
Specifies notification to measure performance of JobScheduler objects

SystemMonitorNotificationTimers.xml

Configuration file for all System Monitors.

Specifies notification to measure performance of JobScheduler objects

This file is optional and contains the definitions of the SystemMonitorNotification / Timer elements.

SystemMonitorNotification Elements

JobScheduler releases starting from 1.13.1

Note: Usage of the configuration files in the <scheduler_data>/config/notification folder has been deprecated.

Location: <scheduler_data>/config/live/sos/.configuration/notification

File Description

SystemMonitorNotification_v1.0.xsd

The XML Schema file defines which values are allowed in your XML files for the JobScheduler monitoring.

notification.xml

Configuration file for System Monitors:

Specifies the delivery way to System Monitor.
Specifies notification for error or success conditions
Specifies notification to measure performance of JobScheduler objects
this file is an automatically generated file and will be overridden when the configuration is deployed

SystemMonitorNotification Elements

The configuration The configuration element descriptions are organized into the following major categories:

...

SystemMonitorNotification supports the following attributes:

Attribute JobScheduler release Usage Description

system_id

before 1.13.1

required

System Monitor identifier.

See JobScheduler - Job Chains customization

Note:

attribute system_id

in case of the SystemMonitorNotificationTimers.xml the value of this attribute is not important and can have any value.
- e.g.: timers

Attribute Usage Description

system_id

required

System Monitor identifier.

See JobScheduler - Job Chains customization

starting from 1.13.1

required

If a configuration is created by JOC Cockpit the value of the attribute system_id will be ignored.
- The SystemNotifier job chain will use MonitorSystem as identifier instead.

Code Block

language	xml
title	Example
collapse	true

<SystemMonitorNotification system_id="op5">
...

...

Attribute	Usage	Description
`monitor_host`	Required	This setting specifies the host name or ip address of System Monitor host.
`monitor_port`	Required	This setting specifies the TCP port that the System Monitor would listen to.
`monitor_password`	Optional	This setting specifies the password for NSCA - password configured in the ncsa.cfg file.
`monitor_connection_timeout`	Optional	This setting specifies the connection timeout in ms. Default: `5000`
`monitor_response_timeout`	Optional	This setting specifies the response timeout in ms.
`monitor_encryption`	Optional	This setting specifies that the communication with the System Monitor is encrypted. By default no encryption is used. `NONE` - no encryption `XOR` - XOR encryption `TRIPLE_DES` - use of triple des algorithm for encryption
`service_host`	Required	This setting specifies the name of the host that executes the passive check. The name must match the corresponding setting in the System Monitor.
`plugin`	Optional	Default: JobScheduler version releases before 1.9.x, 1.10.x11 `com.sos.scheduler.notification.plugins.notifier.SystemNotifierSendNscaPlugin` JobScheduler version releases starting from 1.11.x, 1.12.x `com.sos.jitl.notification.plugins.notifier.SystemNotifierSendNscaPlugin`

...

Attribute Usage Description

plugin

Optional

Default:

JobScheduler version JobScheduler releases before 1.9.x, 1.10.x 11
- com.sos.scheduler.notification.plugins.notifier.SystemNotifierProcessBuilderPlugin
JobScheduler version releases starting from 1.11.x, 1.12.x
- com.sos.jitl.notification.plugins.notifier.SystemNotifierProcessBuilderPlugin

...

set the scheduler_notification_result_parameters parameter (see job documentation jobs/JobSchedulerNotificationStoreResultsJob.xml)
set the StoreResultsJobJSAdapterClass as monitor
- JobScheduler version releases before 1.9.x, 1.10.x11
  - com.sos.scheduler.notification.jobs.result.StoreResultsJobJSAdapterClass
- JobScheduler version releases starting from 1.11.x, 1.12.x
  - com.sos.jitl.notification.jobs.result.StoreResultsJobJSAdapterClass

Code Block

language	xml
title	Example (order job)
collapse	true

<?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
   -->     
   <monitor  name="notification_monitor" ordering="1">         
     	<!-- JobScheduler version 1.9.x,releases before 1.10.x11
	<script java_class="com.sos.scheduler.notification.jobs.result.StoreResultsJobJSAdapterClass" language="java"/>
        -->
   
        <!-- JobScheduler releases versionstarting from 1.11.x, 1.12.x --> 
        <script java_class="com.sos.jitl.notification.jobs.result.StoreResultsJobJSAdapterClass" language="java"/> 
   </monitor>

   <run_time /> 
</job>

...

Expand

title	Variables

Name Description

${SERVICE_NAME}

Current service name. One of both element attributes:

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

${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

${SERVICE_MESSAGE_PREFIX}

Message prefix

SUCCESS success (JobScheduler versions releases from 1.10.11 and , 1.12.8, 1.13)
ERROR error
RECOVERED error recovery
TIMER performance check

...

The following job chains are provided and should be configured accordingly:

sos / notification / CheckHistory (JobScheduler

...

releases before 1.

...

11)

See <scheduler_install>/jobs/JobSchedulerNotificationCheckHistoryJob.xml

This is the main job that analyze the JobScheduler history tables und write results into the notification tables.
- Job read all history entries for the job chains, configured in the SystemMonitorNotification XML files.
- Job execute the performance checks for the defined Timers
Order Check
- configure repeat interval for order run time, e.g. every two minutes.

sos / notification / CheckHistory (JobScheduler

...

releases starting from 1.11

...

)

Job chain removed
Set param sos.use_notification true (config/scheduler.xml)

...

Sends notifications to a specific System Monitor.
Order MonitorSystem
- JobScheduler version releases before 1.9.x, 1.10.x11
  - configures a repeat interval for the order run time that is not less than the interval that has been chosen for triggering the job chain sos/notification/CheckHistory

...

Space shortcuts

Page tree

Versions Compared

Old Version 199

New Version 200

Key

XSD Schema locations

Configuration

JobScheduler

Activation of Monitoring Interface

SystemMonitorNotification files

JobScheduler releases before 1.13.1

SystemMonitorNotification Elements

JobScheduler releases starting from 1.13.1

SystemMonitorNotification Elements

sos / notification / CheckHistory (JobScheduler

releases before 1.

11)

sos / notification / CheckHistory (JobScheduler

releases starting from 1.11

)