JobScheduler Monitoring Configuration Reference - NotificationObjects

Diagram

Elements

NotificationObjects - NotificationObjectsType
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.
Element	Type	Required	Description
Job	Occurrence: 0..unbounded	Optional	References Configuration and Use Cases: Job Schema: Job, Job Notes Specifies the order-controlled or standalone jobs for which notifications are being sent to a system monitor. The element can be repeatedly used to specifiy a number of job. Support for standalone jobs starting with the release 1.11.5. 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. notifications - specifies the number of transfers the same notification to a System Monitor. By default one notification only will be sent. 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. return_code_from - restricts notifications for jobs for a particular return code range. return_code_to - restricts notifications for jobs for a particular return code range. name Job name including possible folder names. Java regular expression can be used. notifications Specifies the number of transfers the same notification to a System Monitor. By default one notification only will be sent. 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. return_code_from Restricts notifications for jobs for a particular return code range. return_code_to Restricts notifications for jobs for a particular return code range.
JobChain	Occurrence: 0..unbounded	Optional	References Configuration and Use Cases: JobChain Schema: JobChain, JobChain 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. Default behaviour for repeatedly failed job chain steps: when an error reoccurrs in the same job node for which a notification has already been sent then this order state is considered being previously notified and no new notification will be sent. See child element NotifyRepeatedError 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. notifications - specifies the number of transfers the same notification to a System Monitor. 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. return_code_from - restricts notifications for jobs for a particular return code range. return_code_to - restricts notifications for jobs for a particular return code range. 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. excluded_steps - specifies the steps which will be excluded from notifications. Multiple entries are separated by semicolon. Child elements: NotifyRepeatedError - send notifications for all errors that occur, do not suppress errors for repeatedly failed executions. name Job chain name including possible folder names. Java regular expression can be used. notifications Specifies the number of transfers the same notification to a System Monitor. By default one notification only will be sent. 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. return_code_from Restricts notifications for job chains for a particular return code range. return_code_to Restricts notifications for job chains for a particular return code range. 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. excluded_steps Specifies the steps which will be excluded from the analyzing (separated by semicolon).
NotifyRepeatedError	Occurrence: 0..1	Optional	References Configuration and Use Cases: NotifyRepeatedError Schema: NotifyRepeatedError, NotifyRepeatedError Release: Availability starting with 1.12.10: JITL-534 Notes Send notifications for all errors that occur, do not suppress errors for repeatedly failed executions.
NotifyByIntervention	Occurrence: 0..1	Optional	References Configuration and Use Cases: NotifyByIntervention Schema: NotifyByIntervention, NotifyByIntervention Release: Availability starting with 1.12.10: JITL-534 Notes Send notifications for errors that occur due to repeated failed executions if the restart was caused by manual intervention.
NotifyByPeriod	Occurrence: 0..1	Optional	References Configuration and Use Cases: NotifyByPeriod Schema: NotifyByPeriod, NotifyByPeriod Release: Availability starting with 1.12.10: JITL-534 Notes Send notifications for errors that occur due to repeatedly failed executions if a configurable period of time is exceeded. Attributes: period - the period between notifications is calculated from the time of the last failed execution for which a notification has been sent and the time of the current failed execution. Possible values: <n> - duration in seconds, e.g.: 60 <n>m - duration in minutes, e.g.: 30m <n>h - duration in hours, e.g.: 24h <n>d - duration in days, e.g.: 30d <n>w - duration in weeks, e.g.: 4w Combined values (with blank as separator): e.g.: 2h 30m 30s period Possible values: <n> - duration in seconds, e.g.: 60 <n>m - duration in minutes, e.g.: 30m <n>h - duration in hours, e.g.: 24h <n>d - duration in days, e.g.: 30d <n>w - duration in weeks, e.g.: 4w Combined values (with blank as separator): e.g.: 2h 30m 30s
TimerRef	Occurrence: 0..unbounded	Optional	References Configuration and Use Cases: TimerRef Schema: TimerRef, TimerRef Notes Corresponds with Timer setting defined in the SystemMonitorNotification / Timer element. The element can be repeatedly used to specifiy a number of timers. Attributes: ref - corresponds with Timer name setting defined in the SystemMonitorNotification / Timer element. notifications - specifies the number of transfers the same notification to a System Monitor. notify_on_error - send timer check notification when the configured job chain contains the error notifications. ref Corresponds with Timer name setting defined in the SystemMonitorNotification / Timer element. notifications Specifies the number of transfers the same notification to a System Monitor. By default one notification only will be sent. notify_on_error Send timer check notification when the configured job chain contains the error notifications.
MasterMessage	Occurrence: 0..1	Optional	References Configuration and Use Cases: MasterMessage Schema: MasterMessage, MasterMessage Release: Availability starting with 1.12.9: JS-1837 Notes 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 Attributes: 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. notifications - specifies the number of transfers the same notification to a System Monitor. By default one notification only will be sent. 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. notifications Specifies the number of transfers the same notification to a System Monitor. By default one notification only will be sent.
TaskWarning	Occurrence: 0..1	Optional	References Configuration and Use Cases: TaskWarning Schema: TaskWarning, TaskWarning Release: Availability starting with 1.12.9: JS-1837 Notes 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 Attributes: 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. notifications - specifies the number of transfers the same notification to a System Monitor. By default one notification only will be sent. 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. notifications Specifies the number of transfers the same notification to a System Monitor. By default one notification only will be sent.
TaskIfLongerThan	Occurrence: 0..1	Optional	References Configuration and Use Cases: TaskIfLongerThan Schema: TaskIfLongerThan, TaskIfLongerThan Release: Availability starting with 1.12.9: JITL-522 Notes 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 Attributes: 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. notifications - specifies the number of transfers the same notification to a System Monitor. By default one notification only will be sent. 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. notifications Specifies the number of transfers the same notification to a System Monitor. By default one notification only will be sent.
TaskIfShorterThan	Occurrence: 0..1	Optional	References Configuration and Use Cases: TaskIfShorterThan Schema: TaskIfShorterThan, TaskIfShorterThan Release: Availability starting with 1.12.9: JITL-522 Notes 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 Attributes: 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. notifications - specifies the number of transfers the same notification to a System Monitor. By default one notification only will be sent. 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. notifications Specifies the number of transfers the same notification to a System Monitor. By default one notification only will be sent.

Space shortcuts

Page tree