Cloud Software Group, Inc. EBX®
Insight Add-on Documentation > User Guide
Navigation modeInsight Add-on Documentation > User Guide

Correlated watchdog configuration

Global view

These settings allow you to configure the Watchdog indicator and Correlated watchdog.

Watchdog indicator

To define a Watchdog indicator you can either reuse the watchdog defined with the corresponding indicator definition (based on a simple output parameter) or declare a more complicated logic relying on a logical expression.

Property

Definition

Code

The code must respect the naming convention applied to the identifier (primary key).

Label

Any name is possible.

Indicator

The Indicator definition on which the watchdog is defined.

Email template

The template used to send the email in case the watchdog indicator is raised.

Is active

If set to 'Yes': the watchdog indicator is active.

If set to 'No': the watchdog indicator doesn't execute.

Default value: Yes

Threshold defined at indicator's level

If set to 'Yes': the watchdog declared at the 'Indicator definition' level is reused. It is a ready-to-use watchdog that directly relies on the test of a boolean output parameter.

If set to 'No': the watchdog is defined through a logical expression using thresholds and allows you to do more than testing a boolean output. See the 'Watchdog threshold' property.

Watchdog threshold

Allows you to define a logical expression using threshold statements that determine whether a watchdog indicator should be raised.

Table 44: Watchdog - Watchdog indicator

Watchdog threshold

This table allows you to declare the logical expression of the watchdog threshold. It is composed using one to many specified thresholds.

Property

Definition

Watchdog indicator

Link to the watchdog indicator

Threshold statement

Link to the watchdog statement that participates in the watchdog threshold

Logical operator

The logical operator used to build the logical expression based on the thresholds. 'void' or 'not' is used for the first statement.

Table 45: Watchdog - Watchdog threshold

Threshold statement

A Threshold statement defines a formula that compares an indicator's output parameter to a pre-defined value. The comparison returns a boolean value that determines whether to raise a watchdog indicator.

Property

Definition

Code

The code must respect the naming convention applied to the identifier (primary key)

Indicator

The indicator on which this threshold statement applies.

Output parameter

The first output parameter of this threshold statement.

Comparison operator

The comparison operator to use.

Value

The value to compare

Output parameter 2

The second output parameter in case the indicator has one or more outputs with the same type as the first output parameter. This is used only when the 'Value' property is empty.

Table 46: Watchdog - Threshold statement

Correlated watchdog

You can use this table to define correlated watchdog indicators.

Property

Definition

Code

The code must respect the naming convention applied to the identifier (primary key)

Label

Name of this correlated watchdog indicator.

Dataset storage

The dataset storage containing the watchdog indicator results to be correlated.

Is timeless

If set to 'True': the watchdog accepts results from any time interval.

If set to 'False': the results must be within the configured interval to be accepted (see the 'Correlation time' property). If they are not, then the correlated watchdog won't fire.

Default value: True

Correlation time

The time interval for the results to be accepted.

This field is only shown if 'Is timeless' property is set to 'False'.

Watchdog indicator emails inactive

When a correlated watchdog indicator is evaluated, watchdog indicators which are parts of the correlation may have been executed right before the correlated watchdog indicator. Set this option to 'True' to prevent emails associated with child watchdog indicators to be sent if the parent correlated watchdog indicator has been raised.

Default value: True

Email template

The template used to send the email when this correlated watchdog indicator is raised.

Is active

Determines whether this correlated watchdog indicator is active or not.

Default value: True

Watchdogs to correlate

This group allows you to declare the logical expression of the correlated watchdog threshold. It is composed using one to many specified watchdog indicators.

  • Watchdog indicator: Link to the watchdog indicator

  • Indicator on D.E.C.: Link to the indicator on D.E.C.

  • Logical operator: Link to the logical operator. 'void' or 'not' is mandatory and can only be used once.

Correlated watchdogs

Displays the watchdog thresholds associated with occurences of the 'Watchdogs to correlate' group.

Table 47: Watchdog - Correlated watchdog

Watchdog indicator email

You can use this table to subscribe recipients to watchdog indicator email alerts. When selecting main and copied recipients, you can add individual user profiles or role profiles to email all in a group.

Property

Definition

Watchdog indicator

Link to the watchdog indicator.

Recipients

Main recipients.

Copies

Recipients as copies.

Blank copies

Additional hidden recipients.

Is active

If set to True: the email is sent.

If set to False: the email notification is stopped.

Default value: True

Table 48: Watchdog - Watchdog indicator email

Correlated watchdog email

You can use this table to subscribe recipients to correlated watchdog indicator email alerts.

The structure of this table is similar to that of the Watchdog indicator email table. The only difference is the Watchdog indicator field is replaced by the Correlated watchdog as the email subscription applied to a correlated watchdog indicator.

Property

Definition

Correlated watchdog indicator

Link to the correlated watchdog.

Recipients

Main recipients.

Copies

Recipients as copies.

Blank copies

Additional hidden recipients.

Is active

If set to True: the email is sent.

If set to False: the email notification is stopped.

Default value: True

Table 49: Watchdog - Correlated watchdog email

Reference data tables

Table

Definition

Comparison operator

Defines the operators used to compare values.

Logical operator

Defines the operators used to combine the logical values.

Email template

This table defines the text templates which are sent in email subscriptions in case correlated watchdog indicators or watchdog indicators are raised.

This is similar to the 'Email template' table from the 'Indicators' group.

Table 50: Watchdog - Reference data tables