Versions Compared

Key

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

...

ElementElement descriptionDescription
NotificationMonitorOnce inside a Notification elementSpecifies the System Monitor interface that is being used for messages: either by a Plugin Interface or by command line invocation (requires NCSA client installation)
NotificationObjectsOnce inside a Notification elementSpecifies the JobChains and the Timers definitions

...

NotificationMonitor support the following attributes:

Note:

  • attributes service_name_on_error and service_name_on_success
    • at least one of these attributes must be configured
    • both attributes can be configured together
AttributeUsageDescription
service_name_on_errorOptionalThis setting specifies the service that is configured in the Service Monitor for messages of job runs with errors and for job recovery messages. The service name must match the corresponding setting in the System Monitor.
service_name_on_successOptionalThis setting specifies the service that is configured in the Service Monitor for receiving informational messages on successful job runs. The service name must match the corresponding setting in the System Monitor
service_status_on_errorOptional

This setting specifies the service status code for error messages.

Default: CRITICAL

service_status_on_successOptional

This setting specifies the service status code for success messages

Default: OK

...

AttributeUsageDescription
monitor_hostOptionalRequiredThis setting specifies the hostname or ip address of System Monitor host.
monitor_portOptionalRequiredThis setting specifies the TCP port that the System Monitor would listen to.
monitor_passwordOptional 
monitor_connection_timeoutOptional 
monitor_response_timeoutOptional 
monitor_encryptionOptional

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 algorhythm for encryption

service_hostOptionalThis setting specifies the name of the host that executes the passive check. The name must match the corresponding setting in the System Monitor.
pluginOptionalDefault: com.sos.scheduler.notification.plugins.notifier.SystemNotifierSendNscaPlugin

...

AttributeUsageDescription
pluginoptionalOptionalDefault: com.sos.scheduler.notification.plugins.notifier.SystemNotifierProcessBuilderPlugin

...

AttributeUsageDescription
notifications

optionalOptional

integerInteger

Specifies the number of notifications that are sent to a System Monitor.

Default: 1

 scheduler_id optionalOptional Notifications are restricted to the JobScheduler instance with the given identification. By default notifications will be sent for all JobScheduler instances that would log into the same database.
 name optionalOptional Job chain name including possible folder names
 step_from optionalOptional Restricts notifications for job chains to a sequence of job nodes that are specified with the step_from and step_to attributes.
 step_to optionalOptional Restricts notifications for job chains to a sequence of job nodes that are specified with the step_from and step_to attributes.
 excluded_steps optionalOptional 
SystemMonitorNotification/Notification/NotificationObjects/Timer

...

AttributeUsageDescription
notifications

optionalOptional

integerInteger

Specifies the number of notifications that are sent to a System Monitor.

Default: 1

 nameoptionalOptionalCorrespondence to Timer defined in the SystemMonitorNotification/Timer element
 notify_on_error

optionalOptional

booleanBoolean

Send timer check notification if the error ocurred in the configured timer job chain (steps)

Default: false

...

AttributeUsageDescription
 namerequiredRequired

Correspondence to Timer used in the SystemMonitorNotification/Notification/NotificationObjects/Timer element.

The name must be unique across all timers definitions.

...

AttributeUsageDescription
 scheduler_id optionalOptional Notifications are restricted to the JobScheduler instance with the given identification. By default notifications will be sent for all JobScheduler instances that would log into the same database.
 name optionalOptional Job chain name including possible folder names
 step_from optionalOptional Restricts checks for job chains to a sequence of job nodes that are specified with the step_from and step_to attributes.
 step_to optionalOptional Restricts checks for job chains to a sequence of job nodes that are specified with the step_from and step_to attributes.

...

AttributeUsageDescription
 language requiredRequired

script Script language name

Supported languages:

  • javascript
  • ECMAScript 

...