JobScheduler Monitoring Interface - Configuration Reference

Diagram

Unable to render 'XSD Viewer' macro

Could not find the given XSD (xsd_macro34c15a8d21e47afd35f0365c56f78c41.png) on page (JobScheduler Monitoring Interface - Configuration Reference)

Elements

SystemMonitorNotification
References Configuration and Use Cases: SystemMonitorNotification Schema: SystemMonitorNotification, SystemMonitorNotification Notes The root element of a NOTIFICATION configuration. JobScheduler releases before 1.13.1 A configuration file is used by the SystemNotifier job chain that reports the notifications as configured to a System Monitor. A number of configurations can be stored with different configuration files that are specified as a parameter to the SystemNotifier order. As an identification of the configuration from an individual file the attribute system_id should be used to specify a unique identifier. JobScheduler releases starting from 1.13.1 Usage of the configuration files in the config/notification folder has been deprecated. The functionality to manage the System Monitor configuration is directly available from JOC Cockpit. The NOTIFICATION configuration is forwarded by the Joc Cockpit to the respective JobScheduler Master. The value of the attribute system_id will in this case be ignored. The SystemNotifier job chain will use MonitorSystem as identifier instead. system_id JobScheduler releases before 1.13.1 Identifier for the system monitor that is used with this configuration. The identifier is a unique name that is required if you use multiple configuration files for a number of system monitors. JobScheduler releases starting from 1.13.1 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.
Element	Type	Required	Description
Attribute: system_id	NMTOKEN	Required	JobScheduler releases before 1.13.1 Identifier for the system monitor that is used with this configuration. The identifier is a unique name that is required if you use multiple configuration files for a number of system monitors. JobScheduler releases starting from 1.13.1 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.
Notification	Occurrence: 1..unbounded	Required	References Configuration and Use Cases: Notification Schema: Notification, Notification Notes Specifies a System Monitor notification that includes NotificationInterface - use of the built-in interface for Nagios (and clones) with a NotificationInterface element. This interface does not require external components such as the System Monitor Client, e.g. the nsca_send utility. NotificationCommand - use of a System Monitor command line client that is invoked by JobScheduler. For Nagios (and clones) this could be e.g. the nsca_send utility. NotificationMail - use of a System Monitor mail client that is invoked by JobScheduler. The JobScheduler Monitoring Interface will use the interfaces or command line tool to report messages to the respective System Monitor. name Notification description name
NotificationMonitor	Occurrence: 1	Required	References Configuration and Use Cases: NotificationMonitor Schema: NotificationMonitor, NotificationMonitor Notes Specifies the System Monitor that is being used for notification: either by a Plugin Interface or by command line invocation. service_name_on_error This setting is used for Nagios or derivative software and specifies the service status code for error messages. service_name_on_success This setting is used for Nagios or derivative software and 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_error This setting is used for Nagios or derivative software and 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_status_on_success This setting is used for Nagios or derivative software and specifies the service status code for success messages.
NotificationObjects	[NotificationObjectsType] Occurrence: 1	Required	References Configuration and Use Cases: NotificationObjects Schema: NotificationObjects, NotificationObjects Notes Specifies the objects that are being used for messages: Job, JobChains, Timers, MasterMessage, TaskWarning, TaskIfLongerThan, TaskIfShorterThan. Notifications can be restricted to certain jobs or job chains for which messages are forwarded to a specific System Monitor or System Monitor service. TimerRef includes checks that verify if a certain threshold has been exceeded by a minimum or maximum value. Such checks can include to verify the duration of a job chain or specific values that are reported by jobs. MasterMessage includes problems detected by a JobScheduler Master, e.g. database connection lost. TaskWarning includes job execution warning messages. TaskIfLongerThan includes the feature to send notification in case that the execution of job requires a longer duration than expected. TaskIfShorterThan includes the feature to send notification in case that the execution of job requires a shorter duration than expected.
Timer	Occurrence: 0..unbounded	Optional	References Configuration and Use Cases: Timer Schema: Timer, Timer Notes A timer implements a performance check that validates if the execution of a job chain took longer or shorter than expected. Each timer is assigned a unique identification with its name attribute. The timer contains <Minimum> and <Maximum> child elements that implement scripts to return the required and allowed value. name Corresponds to Timer used in the SystemMonitorNotification / Notification / NotificationObjects / Timer element. The name must be unique across all timers definitions.
TimerJob	Occurrence: 0..unbounded	Optional	References Configuration and Use Cases: TimerJob Schema: TimerJob, TimerJob Release: Availability starting with 1.11.5: JITL-401 Notes Specifies the jobs for which notifications are being sent to a system monitor. The element can be repeatedly used to specifiy a number of jobs. Attributes: name - accepts a regular expression to specify a number of jobs that match the given pattern, e.g. jobs that are located in the same root folder. scheduler_id - restricts notifications to the JobScheduler instance with the given identification. By default notifications will be sent for all JobScheduler instances that log into the same database. name Job name including possible folder names. Java regular expression can be used. scheduler_id 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. Java regular expression can be used.
TimerJobChain	Occurrence: 0..unbounded	Optional	References Configuration and Use Cases: TimerJobChain Schema: TimerJobChain, TimerJobChain Notes Specifies the job chains for which notifications are being sent to a system monitor. The element can be repeatedly used to specifiy a number of job chains. Attributes: name - accepts a regular expression to specify a number of job chains that match the given pattern, e.g. job chains that are located in the same root folder. scheduler_id - restricts notifications to the JobScheduler instance with the given identification. By default notifications will be sent for all JobScheduler instances that log into the same database. step_from - restricts notifications for job chains to a sequence of job nodes that are specified with the step_from and step_to attributes. step_to - restricts notifications for job chains to a sequence of job nodes that are specified with the step_from and step_to attributes. name Job chain name including possible folder names. Java regular expression can be used. scheduler_id 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. Java regular expression can be used. step_from Restricts notifications for job chains to a sequence of job nodes that are specified with the step_from and step_to attributes. step_to Restricts notifications for job chains to a sequence of job nodes that are specified with the step_from and step_to attributes.
Minimum	Occurrence: 1	Required	References Configuration and Use Cases: Minimum Schema: Minimum, Minimum Notes Minimum required time consumption for job or job chain execution. Allows script code to be executed that returns the minimum execution time required in seconds.
Maximum	Occurrence: 0..1	Optional	References Configuration and Use Cases: Maximum Schema: Maximum, Maximum Notes Maximum allowed time consumption for job or job chain execution. Allows script code to be executed that returns the maximum execution time required in seconds.
Maximum	Occurrence: 1	Required	References Configuration and Use Cases: Maximum Schema: Maximum, Maximum Notes Maximum allowed time consumption for job or job chain execution. Allows script code to be executed that returns the maximum execution time required in seconds.

Pages

Navigation

Space shortcuts

Page tree