Versions Compared

Key

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

...

AttributeUsageDescription
notifications

optional

integer

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

Default: 1

 scheduler_id optional 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 optional Job chain name including possible folder names
 step_from optional Restricts notifications for job chains to a sequence of job nodes that are specified with the step_from and step_to attributes.
 step_to optional Restricts notifications for job chains to a sequence of job nodes that are specified with the step_from and step_to attributes.
 excluded_steps optional 
 SystemMonitorNotification/Notification/NotificationObjects/Timer

...

AttributeUsageDescription
notifications

optional

integer

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

Default: 1

 nameoptionalCorrespondence to Timer defined in the SystemMonitorNotification/Timer element
 notify_on_error

optional

boolean

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

Default: false

 SystemMonitorNotification/Timer 

...

The following elements must be nested inside a NotificationObjects element:

ElementElement descriptionDescription
JobChainOnce or more inside of Timer elementRestricts notifications for job chains
MinimumOptional or once inside of Timer elementMinimum required time consumption for job or job chain execution. Allows script code to be executed that returns the minimum execution time required in seconds.
MaximumOptional or once inside of Timer element Maximum 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.

 

execution. Allows script code to be executed that returns the maximum execution time required in seconds.

 

Timer support the following attributes:

AttributeUsageDescription
 namerequired

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

The name must be unique across all timers definitions.

SystemMonitorNotification/Timer/JobChain

JobChain support the following attributes:

AttributeUsageDescription
 scheduler_id optional 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 optional Job chain name including possible folder names
 step_from optional Restricts checks for job chains to a sequence of job nodes that are specified with the step_from and step_to attributes.
 step_to optional Restricts checks for job chains to a sequence of job nodes that are specified with the step_from and step_to attributes.
SystemMonitorNotification/Timer/Minimum

The following elements must be nested inside a Minimum element:

ElementElement descriptionDescription
ScriptOnce inside of Minimum elementScript code in one of the supported languages
SystemMonitorNotification/Timer/Maximum

The following elements must be nested inside a Maximum element:

ElementElement descriptionDescription
ScriptOnce inside of Maximum elementScript code in one of the supported languages
SystemMonitorNotification/Timer/Minimum|Maximum/Script

 

Script support Timer support the following attributes:

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

The name must be unique across all timers definitions.
AttributeUsageDescription namerequired
 language required

script language name

Supported languages:

  • javascript
  • ECMAScript 

Status
colourYellow
titleTODO

Here you go an example of an XML file used for notifying a specific System Monitor (op5 Monitor) and using NotificationCommand:

...

  • System Monitor: The step of notifying JobScheduler through an acknowledgement in the System Monitor is an execution of a script. This is nothing else than a notification, like sending a mail for instance, but instead, another action is executed, which is the execution of the script that contacts JobScheduler and add an order to the JobChain ResetNotifications described above.