Versions Compared

Key

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

...

ElementElement descriptionDescription
JobChainOptional, once or more inside of NotificationObjects elementRestricts notifications for job chains
TimerOptional, once or more inside of NotificationObjects elementRestricts notifications for performance checks (Timer)
SystemMonitorNotification / Notification / NotificationObjects / JobChain

JobChain support the following attributes:

AttributeUsageDescription
notifications

Optional

Integer

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

Default: 1

scheduler_idOptional

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.

Regular expression can be used.

nameOptional

Job chain name including possible folder names.

Regular expression can be used.

step_fromOptionalRestricts notifications for job chains to a sequence of job nodes that are specified with the step_from and step_to attributes.
step_toOptionalRestricts notifications for job chains to a sequence of job nodes that are specified with the step_from and step_to attributes.
excluded_stepsOptionalSpecifies the steps which will be excluded from the analysing (separated by semicolon)
Code Block
languagexml
titleExample
collapsetrue
<SystemMonitorNotification system_id="OP5">   
  <Notification>       
    <NotificationMonitor service_name_on_error="Errors">
       ...     
    </NotificationMonitor>     
    <NotificationObjects>        
      <!--        
      Send the job chain error, occurrent in the "test/my_jobchain" job chain, to the "Errors" service.        
      -->        
      
Code Block
languagexml
titleExample
collapsetrue
...
<JobChain notifications="2" name="test/my_jobchain"/>
...
<JobChain scheduler_id="scheduler_4444" />
...
<JobChain scheduler_id="scheduler_4444" name="^(test/my)" />
...
<JobChain name="test/my_jobchain" step_from="200"/>
...
<JobChain name="test/my_jobchain" step_to="500"/>
...
<JobChain name="test/my_jobchain" step_from="300" step_to="300"/>
...
<JobChain name="test/my_jobchain" excluded_steps="200;300"/>
.../>     
    </NotificationObjects>   
  </Notification>
</SystemMonitorNotification>  

 

SystemMonitorNotification / Notification / NotificationObjects /

...

JobChain

Timer JobChain support the following attributes:

AttributeUsageDescription
notifications

Optional

Integer

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

Default: 1

namescheduler_idOptionalCorrespondence to Timer name setting defined in the SystemMonitorNotification / Timer element
notify_on_error

Optional

Boolean

Send timer check notification when the configured job chain contains the error notifications.

Default: false

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.

Regular expression can be used.

nameOptional

Job chain name including possible folder names.

Regular expression can be used.

step_fromOptionalRestricts notifications for job chains to a sequence of job nodes that are specified with the step_from and step_to attributes.
step_toOptionalRestricts notifications for job chains to a sequence of job nodes that are specified with the step_from and step_to attributes.
excluded_stepsOptionalSpecifies the steps which will be excluded from the analysing (separated by semicolon)
Code Block
languagexml
titleExample
collapsetrue
...
<JobChain notifications="2" name=
Code Block
languagexml
titleExample
collapsetrue
<SystemMonitorNotification system_id="OP5">
  <Notification>  
    <NotificationMonitor service_name_on_error="Errors">
      ...
    </NotificationMonitor>
    <NotificationObjects>
       <!--
       Send the job chain error, occurrent in the "test/my_jobchain" job chain, to the "Errors" service.
       -->
       />
...
<JobChain scheduler_id="scheduler_4444" />
...
<JobChain scheduler_id="scheduler_4444" name="^(test/my)" />
...
<JobChain name="test/my_jobchain" step_from="200"/>
...
<JobChain name="test/my_jobchain" step_to="500"/>
...
<JobChain name="test/my_jobchain" step_from="300" step_to="300"/>
...
<JobChain name="test/my_jobchain" excluded_steps="200;300"/>
...

 

SystemMonitorNotification / Notification / NotificationObjects / Timer

Timer support the following attributes:

AttributeUsageDescription
notifications

Optional

Integer

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

Default: 1

nameOptionalCorrespondence to Timer name setting defined in the SystemMonitorNotification / Timer element
notify_on_error

Optional

Boolean

Send timer check notification when the configured job chain contains the error notifications.

Default: false

Code Block
languagexml
titleExample
collapsetrue
<SystemMonitorNotification system_id="OP5">
  <Notification>  
    <NotificationMonitor service_name_on_error="Errors">
      ...
    </NotificationMonitor>
    <NotificationObjects>
       <!--
       Send the job chain error, occurrent in     </NotificationObjects>
  </Notification>
 
  <Notification>    
    <NotificationMonitor service_name_on_error="Performance">
      ...
    </NotificationMonitor>
    <NotificationObjects>
       <!--       
       Send the performance check error, occurrent in the "test/my_jobchain" job chain, to the "Performance" service.
       Send of the performance check error to the "Performance" service will be ignored when the "test/my_jobchain" has the job chain, errorto (default notify_on_error = false)the "Errors" service.
       -->
       <Timer<JobChain name="test/my_timerjobchain" />
    </NotificationObjects>
  </Notification>
 
  <Notification>  <Timer name="my_timer">
    <JobChain name=  
    <NotificationMonitor service_name_on_error="Performance">
      ...
    </NotificationMonitor>
    <NotificationObjects>
       <!--       
       Send the performance check error, occurrent in the "test/my_jobchain" />
  </Timer>
</SystemMonitorNotification> 

 

SystemMonitorNotification / Timer 

The following elements must be nested inside a Timer 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 elementMaximum allowed time consumption for job or job chain 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_idOptional

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.

Regular expression can be used.

 nameOptional

Job chain name including possible folder names.

Regular expression can be used.

 step_fromOptionalRestricts checks for job chains to a sequence of job nodes that are specified with the step_from and step_to attributes.
 step_toOptionalRestricts 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 the following attributes:

...

job chain, to the "Performance" service.
       Send of the performance check error to the "Performance" service will be ignored when the "test/my_jobchain" has the job chain error (default notify_on_error = false).
       -->
      <Timer name="my_timer" />
    </NotificationObjects>
  </Notification>
 
  <Timer name="my_timer">
    <JobChain name="test/my_jobchain" />
  </Timer>
</SystemMonitorNotification> 

 

SystemMonitorNotification / Timer 

The following elements must be nested inside a Timer 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 elementMaximum allowed time consumption for job or job chain execution. Allows script code to be executed that returns the maximum execution time required in seconds.
Code Block
languagexml
titleExample
collapsetrue
<SystemMonitorNotification system_id="OP5">
  ...
  <Timer name="my_timer_1">
    <JobChain name="test/my_jobchain_1" />
    <Maximum><Script language="javascript"><![CDATA[1000]]></Script></Maximum>
  </Timer>
  <Timer name="my_timer_2">    
    <JobChain name="test/my_jobchain_2" />
    <Minimum><Script language="javascript"><![CDATA[500]]></Script></Minimum>
    <Maximum><Script language="javascript"><![CDATA[1000]]></Script></Maximum>
  </Timer>
</SystemMonitorNotification> 

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.

Code Block
languagexml
titleExample
collapsetrue
...
<Timer name="my_timer">
... 

 

SystemMonitorNotification / Timer / JobChain

JobChain support the following attributes:

AttributeUsageDescription
 scheduler_idOptional

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.

Regular expression can be used.

 nameOptional

Job chain name including possible folder names.

Regular expression can be used.

 step_fromOptionalRestricts checks for job chains to a sequence of job nodes that are specified with the step_from and step_to attributes.
 step_toOptionalRestricts checks for job chains to a sequence of job nodes that are specified with the step_from and step_to attributes.
Code Block
languagexml
titleExample
collapsetrue
...
<JobChain scheduler_id="scheduler_4444" /> 
... 
<JobChain scheduler_id="scheduler_4444" name="^(test/my)" /> 
... 
<JobChain name="test/my_jobchain" step_from="200"/> 
... 
<JobChain name="test/my_jobchain" step_to="500"/> 
... 
<JobChain name="test/my_jobchain" step_from="300" step_to="300"/>
...

 

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
Code Block
languagexml
titleExample
collapsetrue
...
<Timer name="my_timer">
  ...
  <Maximum><Script language="javascript"><![CDATA[1000]]></Script></Maximum>
</Timer>
... 

 

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
Code Block
languagexml
titleExample
collapsetrue
...
<Timer name="my_timer">
  ...
  <Minimum><Script language="javascript"><![CDATA[1000]]></Script></Minimum>
</Timer>
... 

 

SystemMonitorNotification / Timer / Minimum|Maximum / Script

Script support the following attributes:

AttributeUsageDescription
 languageRequired

Script language name

Supported languages:

  • javascript
  • ECMAScript 
Code Block
languagexml
titleExample
collapsetrue
...
  <Script language="javascript"><![CDATA[1000]]></Script>
 
...
  <Script language="javascript"><![CDATA[                     
    function calculate(){                         
      var fileSize              = new java.lang.Double(%file_size%);                         
      var timerExpiryFactor     = 0.0025;                         
      var timerExpiryTolerance  = timerExpiryFactor*0.1;                         
      var timerExpiry           = new java.lang.Double(timerExpiryFactor+timerExpiryTolerance);                         
      timerExpiry               = timerExpiry*fileSize;                     
      return timerExpiry;                     
    }                         
    calculate();
  ]]></Script>
...

Script language name

Supported languages:

...

Message

Usage

The Message sended to System Monitor can be configured as CDATA element on the following parent nodes:

...