Cloud Software Group, Inc. EBX®
Insight Add-on Documentation > Indicator Portfolio Reference
Navigation modeInsight Add-on Documentation > Indicator Portfolio Reference

Indicators applied to a field

Field last modification date [ON] F-I01

Property

Specification

Code

[ON] F-I01

Name

Field last modification date

Use other indicators

N/A

Specification

Computes the last modification date of a field. This date is updated in real-time using a trigger on the table.

For modifications on a table performed by methods that do not activate triggers (archive import, dataspace merges) the indicator must use table history to find the date of the last modification. Table history is used when the indicator is executed 'on demand' and only if the 'Use history when not real-time' input parameter is set to 'True'.

Field filter predicate

yes

Linked records

no

Applied to D.E.C. type

Field

Output parameters

'Field last modification date': timestamp

Storage procedure

Any resulting value is stored

Reporting table

'Flat data report' - One record is saved in the Flat data report table.

Input parameters

'Use history when not real-time ': boolean

  • If set to 'True': table history is used when execution is set to 'on demand'.

  • If set to 'False': table history is not used when execution is set to 'on demand'.

Setting this option to 'True' is useful for updating the indicator result when a modification has occurred in the table that bypasses the trigger.

Computation frequency

'Real-time', 'On demand'

Periodicity of control and watchdog

Periodicity of control=no

Minimum threshold=no

Maximum threshold=no

Tolerance number=no

Probe

Trigger

Save last value only

Configuration

Email alert

Configuration

Data view

ONFieldLastModificationDate

Field updated [ON] F-I02

Property

Specification

Code

[ON] F-I02

Name

Field updated

Use other indicators

[ON] F-I01 Field last modification date

Specification

Check if the field has been updated during a certain period compared to the current date of the indicator execution. This computation relies on the result values of F-I01 ('Field last modification date').

Field filter predicate

no

Linked records

no

Applied to D.E.C. type

Field

Output parameters

'Field updated': boolean

  • 'True': the field has been updated

  • 'False': the field has not been updated

'Date difference (in days)': integer. Number of days since the indicator execution until the field was last modified.

Storage procedure

Any resulting value is stored

Reporting table

'Flat data report' - One record is saved in the Flat data report table.

Input parameters

Void

Computation frequency

'On demand'

Periodicity of control and watchdog

Periodicity of control=no

Minimum threshold=no

Maximum threshold=yes, label=Maximum of days without modification

Tolerance number=no

Probe

no

Save last value only

Configuration

Email alert

Configuration

Data view

ONFieldUpdated

Empty field [ON] F-I03

Property

Specification

Code

[ON] F-I03

Name

Empty field

Use other indicators

N/A

Specification

Compute whether a field is empty for every record of a table. It is executed in real-time when a record is updated and 'on demand' to check all records at once.

Field filter predicate

yes

Linked records

Records with empty fields will-be stored

Applied to D.E.C. type

Field

Output parameters

''Empty field': boolean

  • True': the field is empty.

  • 'False': the field is not empty.

Storage procedure

Any resulting value is stored

Reporting table

'Flat data report' - One record is saved in the Flat data report table.

Input parameters

'Keep True outcome': boolean

  • 'True': when the option 'save last value only' is true then every 'true' outcome value will be stored. Only 'false' outcome are updated.

  • 'False': the behaviour of the option 'save last value only' is as usual.

Setting this option to 'True' is useful for keeping the history for all instances of 'True' results without keeping the history for 'False' results.

Default value='False'

Computation frequency

'Real-time', 'On demand'

Periodicity of control and watchdog

Periodicity of control=no

Minimum threshold=no

Maximum threshold=no

Tolerance number=no

Probe

Trigger

Save last value only

Configuration

Email alert

Configuration

Data view

ONEmptyField

Number of active users on a field by operation [ON] F-I04

Property

Specification

Code

[ON] F-I04

Name

Number of active users on a field by operation

Use other indicators

N/A

Specification

This indicator uses the data history.

This indicator computes the number of active users by operation on a field during a certain period of time. This computation relies on the EBX® history on the table. The computation is applied for the create, update and delete operations, not for the read.

The periodicity of control is used to define the time lag for the computation: from the current execution date of the indicator to the periodicity of control. The computation is performed in an 'absolute' mode, not on a rolling basis. For example:

- periodicity of control = 'monthly',

- current execution date = January 20, 2014

The computation procedure is as follows:

- the data history is used from the oldest date just before the current month January 2014,

- from this oldest date, every data history is used to get the number of creation, deletion and modification that have been occurred by user up to the current execution date January 20, 2014.

The indicator saves three couples of values: (Nb. of creation, Nb. of user), (Nb. of modification, Nb. of user), (Nb. of deletion, Nb. of user)

When the periodicity of control is equal to 'any' then all time is considered.

Field filter predicate

yes

Linked records

no

Applied to D.E.C. type

Field

Output parameters

"Number of creation": Integer, "Number of user": Integer,

"Number of modification": Integer, "Number of user": Integer,

"Number of deletion": Integer, "Number of user": Integer

Storage procedure

Any resulting value is stored

Reporting table

'Flat data report' - One record is saved in the Flat data report table.

Input parameters

Void

Computation frequency

'On demand'

Periodicity of control and watchdog

Periodicity of control=yearly, semester, quarterly, monthly, weekly, daily, any

Minimum threshold=no

Maximum threshold=no

Tolerance number=no

Probe

no

Save last value only

Configuration

Email alert

Configuration

Data view

ONNbActiveUsersOnFieldByOperation

Frequency by value [ON] F-I05

Property

Specification

Code

[ON] F-I05

Name

Frequency by value

Use other indicators

N/A

Specification

The indicator computes the highest and the lowest frequency values for the field.

The maximum of output for both highest and lowest frequency values is configured through an input parameter. The possible field data types are: Integer, Decimal, String, Date, Time, and Date time. The indicator does not apply to other data types.

Example for a table with the field age as follows (total records: 354)

1 record with age = 10, 3 records with age = 40, 4 records with age = 70, 6 records with age = 41, 10 records with age = 45, 30 records with age = 46, 100 records with age = 33, 200 records with age = 16

The output 'field value, frequency, number of records' are as follows:

(16, 56.49%, 200) - (33, 28.24%, 100) - (46, 8.47%, 30) - (10, 0.28%, 1) -

(40, 0.84%, 3) - (70, 1.12%, 4)

Field filter predicate

yes

Linked records

Records belongs to one of these states will be stored:

  • Records of the highest frequency

  • Records of the lowest frequency

  • Records of either the highest frequency or the lowest frequency

Applied to D.E.C. type

Field

Output parameters

'Most frequent value': String

''Most frequent frequency': Decimal

''Most frequent Nb. record': Integer

''Least frequent value': String

''Least frequent frequency': Decimal

''Least frequent Nb. record': Integer

Storage procedure

Any resulting value is stored

Reporting table

'Flat data report' - Multiple records are saved in the Flat data report table depending on the configured maximum output number.

Input parameters

"Maximum of output for highest/lowest frequency values": Integer, default value is 3, the maximum is 20

Computation frequency

'On demand'

Periodicity of control and watchdog

Periodicity of control=no

Minimum threshold=no, Maximum threshold=no, Tolerance number=no

Probe

no

Save last value only

Configuration

Email alert

Configuration

Data view

ONFrequencyByValue

Field value outside a limit [ON] F-I06

Property

Specification

Code

[ON] F-I06

Name

Field value outside a limit

Use other indicators

N/A

Specification

Applied to field of type Integer and Decimal only.

The indicator computes if the field value has reached the maximum and/or minimum values configured as thresholds.

Field filter predicate

yes

Linked records

no

Applied to D.E.C. type

Field

Output parameters

'Value outside the limit': Boolean

  • 'True': the field value is outside the limit.

  • 'False': the field value is not outside the limit.

'Field value": Decimal

Storage procedure

Any resulting value is stored

Reporting table

'Flat data report' - One record is saved in the Flat data report table.

Input parameters

Void

Computation frequency

'Real time"

Periodicity of control and watchdog

Periodicity of control=no

Minimum threshold=yes, label=Minimum value, default value = 10

Maximum threshold=yes, label=Maximum value, default value = 20

Tolerance number=no

Probe

Trigger (create, update)

Save last value only

Configuration

Email alert

Configuration

Data view

ONFieldValueOutsideLimit

Field size outside a limit [ON] F-I07

Property

Specification

Code

[ON] F-I07

Name

Field size outside a limit

Use other indicators

N/A

Specification

Applied to field of type string only.

The indicator computes if the field size has reached the maximum and/or minimum sizes configured as thresholds.

Field filter predicate

yes

Linked records

no

Applied to D.E.C. type

Field

Output parameters

'Size outside the limit': Boolean

  • 'True': the size value is outside the limit.

  • 'False': the size value is not outside the limit.

'Field value": String

Storage procedure

Any resulting value is stored

Reporting table

'Flat data report' - One record is saved in the Flat data report table.

Input parameters

Void

Computation frequency

'Real time"

Periodicity of control and watchdog

Periodicity of control=no

Minimum threshold=yes, label=Minimum size, default value = 10

Maximum threshold=yes, label=Maximum size, default value = 20

Tolerance number=no

Probe

Trigger (create, update)

Save last value only

Configuration

Email alert

Configuration

Data view

ONFieldSizeOutsideLimit

Field min-max modifications for a period [ON] F-I08

Property

Specification

Code

[ON] F-I08

Name

Field min-max modifications for a period of time

Use other indicators

N/A

Specification

This indicator uses the data history.

For a period of time, the indicator computes the number of modifications applied to the field and compares it against the minimum and maximum thresholds. The configuration uses the periodicity of control and watchdog (maximum and minimum thresholds).

The computation is performed in an "absolute" mode, and not on a rolling basis. For example, for the periodicity "monthly", if the indicator is executed on April 5 then the period is the five first days of April.

When the periodicity of control is equal to "any" then all time is considered.

Field filter predicate

yes

Linked records

Modified records will be stored.

Applied to D.E.C. type

Field

Output parameters

"Below min. modifications": Boolean

  • "True": the number of modifications during the period is below the minimum threshold".

  • "False": the number of modification during the period is above the minimum threshold or equal to".

"Above max. modifications": Boolean

  • "True": the number of modifications during the period is above the maximum threshold".

  • "False": the number of modifications during the period is below the maximum threshold or equal to".

"Nb. of modifications during the period": Integer

Storage procedure

Any resulting value is stored

Reporting table

'Flat data report' - One record is saved in the Flat data report table.

Input parameters

Void

Computation frequency

"On demand"

Periodicity of control and watchdog

Periodicity of control=yearly, semester, quarterly, monthly, weekly, daily, any

Minimum threshold=yes, label=Minimum modification, default value = 10

Maximum threshold=yes, label=Maximum modification, default value = 20

Tolerance number=no

Probe

no

Save last value only

Configuration

Email alert

Configuration

Data view

ONFieldMinMaxModificationsForPeriodTime

Field with the highest frequency for a period [ON] F-I09

Property

Specification

Code

[ON] F-I09

Name

Field with the highest frequency for a period

Use other indicators

N/A

Specification

The indicator computes the highest frequency value for the field during a period of time. This period is configured by the periodicity of control.

The possible field data types are: Integer, Decimal, String, Date, Time, and Date time. The indicator does not apply to other data types. Empty values are not considered to compute the highest frequency.

The result is compared against the minimum and maximum thresholds that are configured as watchdogs. The computation is performed in an 'absolute' mode, and not on a rolling basis. For example, for the periodicity 'monthly', if the indicator is executed on April 5 then the period is the five first days of April.

When the periodicity of control is equal to 'any' then all time is considered. Example

  • 10 records in a table => 5 records with field value = 'A', 3 records with field value = 'B', and 2 records with field value = 'C.

  • Then the result of the indicator is: Most frequent value = 'A', Most frequent frequency = '50%', Most frequent Nb. records = "5".

Field filter predicate

yes

Linked records

Records with the highest frequency will be stored.

Applied to D.E.C. type

Field

Output parameters

'Below min. highest frequency': Boolean

  • 'True': the highest frequency is below the minimum threshold.

  • 'False': the highest frequency is above the minimum threshold or equal to

'Above max. highest frequency': Boolean

  • 'True': the highest frequency is above the maximum threshold

  • 'False': the highest frequency is below the maximum threshold or equal to

"Most frequent value": String, "Most frequent frequency": Decimal, "Most frequent Nb. records": Integer

Storage procedure

Any resulting value is stored

Reporting table

'Flat data report' - One record is saved in the Flat data report table.

Input parameters

Void

Computation frequency

'On demand'

Periodicity of control and watchdog

Periodicity of control=yearly, semester, quarterly, monthly, weekly, daily, any

Minimum threshold=yes, label=Minimum highest frequency, default value = 5

Maximum threshold=yes, label=Maximum highest frequency, default value = 10

Tolerance number=no

Probe

no

Save last value only

Configuration

Email alert

Configuration

Data view

ONFieldWithHighestFrequencyForPeriod

Field with the lowest frequency for a period [ON] F-I10

Property

Specification

Code

[ON] F-I10

Name

Field with the lowest frequency for a period

Use other indicators

N/A

Specification

The indicator computes the lowest frequency value for the field during a period of time. This period is configured by the periodicity of control. The possible field data types are: Integer, Decimal, String, Date, Time, and Date time. The indicator does not apply to other data types. Empty values are not considered to compute the lowest frequency.

The result is compared against the minimum and maximum thresholds that are configured as watchdogs.

The computation is performed in an 'absolute' mode, and not on a rolling basis. For example, for the periodicity 'monthly', if the indicator is executed on April 5 then the period is the five first days of April.

When the periodicity of control is equal to 'any' then all time is considered. Example

  • 10 records in a table => 5 records with field value = 'A', 3 records with field value = 'B', and 2 records with field value = 'C.

  • Then the result of the indicator is: Least frequent value = 'C', Least frequent frequency = '20%', Least frequent Nb. records = "2"

Field filter predicate

yes

Linked records

Records with the lowest frequency will be stored.

Applied to D.E.C. type

Field

Output parameters

'Below min. lowest frequency': Boolean

  • 'True': the lowest frequency is below the minimum threshold.

  • 'False': the lowest frequency is above the minimum threshold or equal to

'Above max. lowest frequency': Boolean

  • 'True': the lowest frequency is above the maximum threshold

  • 'False': the lowest frequency is below the maximum threshold or equal to

"Least frequent value": string, "Least frequent frequency": Decimal, "Least frequent Nb. records": integer

Storage procedure

Any resulting value is stored

Reporting table

'Flat data report' - One record is saved in the Flat data report table.

Input parameters

Void

Computation frequency

'On demand'

Periodicity of control and watchdog

Periodicity of control=yearly, semester, quarterly, monthly, weekly, daily, any

Minimum threshold=yes, label=Minimum lowest frequency, default value = 5

Maximum threshold=yes, label=Maximum lowest frequency, default value = 10

Tolerance number=no

Probe

no

Save last value only

Configuration

Email alert

Configuration

Data view

ONFieldWithLowestFrequencyForPeriod

Boolean field statistics [ON] F-I11

Property

Specification

Code

[ON] F-I11

Name

Boolean field statistics

Use other indicators

N/A

Specification

The indicator saves the value of the fields every time it changes from 'True', 'False' and 'Undefined'.

The type of the field must be 'Boolean'.

Field filter predicate

yes

Linked records

no

Applied to D.E.C. type

Field

Output parameters

'True value': Boolean

'False value': Boolean

'Undefined value': Boolean

Storage procedure

Any resulting value is stored

Reporting table

'Flat data report' - One record is saved in the Flat data report table.

Input parameters

Void

Computation frequency

'Real time'

Periodicity of control and watchdog

Periodicity of control=no

Minimum threshold=no

Maximum threshold=no

Tolerance number=no

Probe

Trigger (create, update)

Save last value only

Configuration

Email alert

Configuration

Data view

ONBooleanFieldStatistics

Boolean field occurrences within the table scope [ON] F-I12

Property

Specification

Code

[ON] F-I12

Name

Boolean field occurrences within the table scope

Use other indicators

N/A

Specification

The indicator computes the number of 'True', 'False' and 'Undefined' values for the field on the scope of the whole table. The type of the field must be 'Boolean'.

Field filter predicate

yes

Linked records

Records belonging to one of these states will be stored:

  • Records with 'True' value (default option)

  • Records with 'False' value

  • Records with 'Undefined' value

Applied to D.E.C. type

Field

Output parameters

'Nb. of true': Integer

'Nb. of false': Integer

'Nb. of undefined': Integer

Storage procedure

Any resulting value is stored

Reporting table

'Flat data report' - One record is saved in the Flat data report table.

Input parameters

Void

Computation frequency

'On demand'

Periodicity of control and watchdog

Periodicity of control=no

Minimum threshold=no

Maximum threshold=no

Tolerance number=no

Probe

no

Save last value only

Configuration

Email alert

Configuration

Data view

ONBooleanFieldOccurrencesWithinTableScope

Group of fields' completeness [ON] F-I13

Property

Specification

Code

[ON] F-I13

Name

Group of fields' completeness

Use other indicators

N/A

Specification

The indicator computes the completeness of the group of fields.

For example, if the group contains 5 fields and two are empty then the result is 60%. The computation is performed at the level of a group of fields for a record. This is not an average at the scope of the whole table.

Field filter predicate

yes

Linked records

no

Applied to D.E.C. type

Group of fields

Output parameters

''Group of fields completeness rate': Decimal

Storage procedure

Any resulting value is stored

Reporting table

'Flat data report' - One record is saved in the Flat data report table.

Input parameters

Void

Computation frequency

'Real time'

Periodicity of control and watchdog

Periodicity of control=no

Minimum threshold=no

Maximum threshold=no

Tolerance number=no

Probe

Trigger (create, update)

Save last value only

Configuration

Email alert

Configuration

Data view

ONGroupOfFieldsCompleteness

Oversee string field value [ON] F-I14

Property

Specification

Code

[ON] F-I14

Name

Oversee string field value

Use other indicators

N/A

Specification

When the field value is equal to one of the values defined as input parameters then the indicator saves this information.

This indicator works for field of type "String" only.

To allow statistics the indicator saves systematically, through a boolean result, if the field is equal or not to one of the values defined as input parameters.

Field filter predicate

yes

Linked records

no

Applied to D.E.C. type

Field

Output parameters

"Oversee check": Boolean

  • "True": the value of the field is within one of defined as input parameters

  • "False": the value of the field is not within the list defined as input parameters

"Oversee value": String

Storage procedure

Any resulting value is stored

Reporting table

'Flat data report' - One record is saved in the Flat data report table.

Input parameters

"Value to oversee": String[*]

"Case sensitive": Boolean

  • "True": the control is case sensitive

  • "False": the control is not case sensitive

"Is empty value": Boolean

  • "True": accept case empty value

  • "False": do not accept case empty

Computation frequency

"Real time"

Periodicity of control and watchdog

Periodicity of control=no

Minimum threshold=no

Maximum threshold=no

Tolerance number=no

Probe

Trigger (create, update)

Save last value only

Configuration

Email alert

Configuration

Data view

ONOverseeStringFieldValue

Oversee boolean field value [ON] F-I15

Property

Specification

Code

[ON] F-I15

Name

Oversee boolean field value

Use other indicators

N/A

Specification

When the field value is equal to one of the values defined as input parameters then the indicator saves this information. A maximum of three values can be configured.

This indicator works for field of type "Boolean" only.

To allow statistics the indicator saves systematically, through a boolean result, if the field is equal or not to one of the values defined as input parameters.

Field filter predicate

yes

Linked records

no

Applied to D.E.C. type

Field

Output parameters

"Oversee check": Boolean

  • "True": the value of the field is within one of defined as input parameters

  • "False": the value of the field is not within the list defined as input parameters

"Oversee value": String

Storage procedure

Any resulting value is stored

Reporting table

'Flat data report' - One record is saved in the Flat data report table.

Input parameters

"Value to oversee": Boolean (only "True", "False" and "Undefined" are permitted)

Computation frequency

"Real time"

Periodicity of control and watchdog

Periodicity of control=no

Minimum threshold=no

Maximum threshold=no

Tolerance number=no

Probe

Trigger (create, update)

Save last value only

Configuration

Email alert

Configuration

Data view

ONOverseeBooleanFieldValue

Oversee date field value [ON] F-I16

Property

Specification

Code

[ON] F-I16

Name

Oversee date field value

Use other indicators

N/A

Specification

When the field value is equal to one of the values defined as input parameters then the indicator saves this information.

This indicator works for field of type "Date" only.

To allow statistics the indicator saves systematically, through a boolean result, if the field is equal or not to one of the values defined as input parameters.

Field filter predicate

yes

Linked records

no

Applied to D.E.C. type

Field

Output parameters

"Oversee check": Boolean

  • "True": the value of the field is within one of defined as input parameters

  • "False": the value of the field is not within the list defined as input parameters

"Oversee value": Date

Storage procedure

Any resulting value is stored

Reporting table

'Flat data report' - One record is saved in the Flat data report table.

Input parameters

"Value to oversee": Date[*]

"Is empty value": Boolean

  • "True": accept case empty value

  • "False": do not accept case empty value

Computation frequency

"Real time"

Periodicity of control and watchdog

Periodicity of control=no

Minimum threshold=no

Maximum threshold=no

Tolerance number=no

Probe

Trigger (create, update)

Save last value only

Configuration

Email alert

Configuration

Data view

ONOverseeDateFieldValue

Oversee numeric field value [ON] F-I17

Property

Specification

Code

[ON] F-I17

Name

Oversee numeric field value

Use other indicators

N/A

Specification

When the field value is equal to one of the values defined as input parameters then the indicator saves this information.

This indicator works for field of types "Integer" and "Decimal" only.

To allow statistics the indicator saves systematically, through a Boolean result, if the field is equal or not to one of the values defined as input parameters.

Field filter predicate

yes

Linked records

no

Applied to D.E.C. type

Field

Output parameters

"Oversee check": Boolean

  • "True": the value of the field is within one of defined as input parameters

  • "False": the value of the field is not within the list defined as input parameters

"Oversee value": Decimal (if Integer then it is converted into Decimal)

Storage procedure

Any resulting value is stored

Reporting table

'Flat data report' - One record is saved in the Flat data report table.

Input parameters

"Value to oversee": Decimal[*]

"Is empty value": Boolean

  • "True": accept case empty value

  • "False": do not accept case empty value

Computation frequency

"Real time"

Periodicity of control and watchdog

Periodicity of control=no

Minimum threshold=no

Maximum threshold=no

Tolerance number=no

Probe

Trigger (create, update)

Save last value only

Configuration

Email alert

Configuration

Data view

ONOverseeNumericFieldValue

Number of missing values for a field [ON] F-I18

Property

Specification

Code

[ON] F-I18

Name

Number of missing values for a field

Use other indicators

N/A

Specification

This indicator computes the number of times the field value is empty on the whole scope of the table. It also give the percentage of empty field value based on the number of total records in the table.

Input parameters are used to give the string values that are considered as missing values (E.g. Unknown, Not available, etc.).

Field filter predicate

yes

Linked records

Records with missing values will be stored.

Applied to D.E.C. type

Field

Output parameters

"Number of missing value": Integer

"Percentage of missing value": Decimal

Storage procedure

Any resulting value is stored

Reporting table

'Flat data report' - One record is saved in the Flat data report table.

Input parameters

"Value similar to empty": String[*]

"Is empty value": Boolean

  • "True": accept case empty value

  • "False": do not accept case empty

Computation frequency

"On demand"

Periodicity of control and watchdog

Periodicity of control=no

Minimum threshold=no

Maximum threshold=no

Tolerance number=no

Probe

no

Save last value only

Configuration

Email alert

Configuration

Data view

ONNbMissingValuesForField

Missing time series for a field [ON] F-I19

Property

Specification

Code

[ON] F-I19

Name

Missing time series for a field

Use other indicators

N/A

Specification

This indicator is applied to a field of type Date and Date time. It allows one to check if the time between the two nearest dates in the future and the past exceeded a certain duration. The indicator works on the date and date time. For instance: (R2, date = May 10, 2014), (R3, date = May 11, 2014), (R1, date = June 06, 2014), (R5, date = June 07, 2014), (R4, date = June 22, 2014). With a duration "1 day", then depending on the record on which the indicator is executed here are the results:

  • On record 01, result in future = not exceeded, result in past = exceeded

  • On record 02, result in future = not exceeded, result in past = not exceeded

  • On record 03, result in future = exceeded, result in past = not exceeded

Field filter predicate

yes

Linked records

no

Applied to D.E.C. type

Field

Output parameters

"Record predicate": String. Record on which the indicator is executed

"Is missing time series in the future": Boolean - True: the time between the two records is over the duration in the future - False: the time between the two records in not over the duration in the future

"Missing time record in the future": String (empty if no missing time in the future)

"Exceeded time in the future": Integer (empty if no missing time in the future)

"Is missing time series in the past": Boolean

  • True: the time between the two records is over the duration in the past

  • False: the time between the two records in not over the duration in the past

"Missing time record in the past": String (empty if no missing time in the past)

"Exceeded time in the past": Integer (empty if no missing time in the past)

Storage procedure

"Real-time": the results are systematically saved. "On demand": the results are saved in case of at least a "Is missing time series"="True"

Reporting table

'Flat data report' - Multiple records are saved in the Flat data report table.

Input parameters

"Maximum duration in the future": Integer, default value = 1 day

"Maximum duration in the past": Integer, default value = 1 day

"Maximum output when 'on demand' execution": Integer, default value = 20

"Is ASC": "True": sort records by ascending, "False": sort records by descending

Computation frequency

"Real-time"; "On demand"

Periodicity of control and watchdog

Periodicity of control=no, Minimum threshold=no, Maximum threshold=no, Tolerance number=no

Probe

Trigger (create, update)

Save last value only

Configuration

Email alert

Configuration

Data view

ONMissingTimeSeriesForField

Number of records by group [ON] F-I20

Property

Specification

Code

[ON] F-I20

Name

Number of records by group

Use other indicators

N/A

Specification

This indicator computes the number of records in the table by group. This group is configured by selecting a field in the table (Applied to type D.E.C Field). For instance, the table 'Client' has a field 'FKTypeClient'. This field is used to group the number of records by type of clients.

It is possible to configure the maximum number of groups to compute. When the actual number of groups in the table is higher than this maximum, a default group is created to compute all the remaining records.

A parameter allows you to decide if the groups are fed in priority with the highest number of records or the lowest ones.

Field filter predicate

yes

Linked records

Records belonging to these states will be stored:

  • Records of each group (default option)

  • Records of the highest group

  • Records of lowest group

Remaining records of other groups are not stored.

Applied to D.E.C. type

Field

Output parameters

"Group": String

"Number of records': Integer

Storage procedure

Any resulting value is stored

Reporting table

'Flat data report' - One record is saved in the Flat data report table for each group.

Input parameters

"Other group name ": String

"Maximum number of groups ": Integer. If undefined or '0' then it means unbounded.

"Is highest groups fed in priority': Boolean. If 'Yes' then the highest groups are fed in priority, otherwise this is the lowest ones

Computation frequency

"On demand"

Periodicity of control and watchdog

Periodicity of control=no

Minimum threshold=no

Maximum threshold=no

Tolerance number=no

Probe

no

Save last value only

Configuration

Email alert

Configuration

Data view

ONOperationNumberOfRecordsByGroup

Translation rate applied to a field [ON] F-I21

Property

Specification

Code

[ON] F-I21

Name

Translation rate applied to a field

Use other indicators

N/A

Specification

This indicator computes the translation rate of a field in a table. The field is a group or complex data type. It represents a label or a label and description. Only the label is used to compute the result.

The first occurrence gives the main language, the second the translation. The translation rate is a ratio between the translation per record and the total record in the table.

The translation is not available when:

- at least one occurrence is empty.

- the first and second occurrence are same.

Field filter predicate

yes

Linked records

Records without the translation will be stored.

Applied to D.E.C. type

Field (is complex data type)

Output parameters

"Translation rate": Percentage

Storage procedure

Any resulting value is stored

Reporting table

'Flat data report' - One record is saved in the Flat data report table.

Input parameters

Void

Computation frequency

"On demand"

Periodicity of control and watchdog

Periodicity of control=no

Minimum threshold=no

Maximum threshold=no

Tolerance number=no

Probe

no

Save last value only

Configuration

Email alert

Configuration

Data view

ONTranslationRateAppliedToAField

Simple statistics on field value [ON] F-I22

Property

Specification

Code

[ON] F-I22

Name

Simple statistics on field value

Use other indicators

N/A

Specification

This indicator computes a set of elementary statistics on a field value as described below. The examples are based on the following list of records and values for a field: "a, a, b, c, d, e, e, e, null".

  • Number of values: computes the number of records with a not null or empty field value. Eg. result = 8.

  • Number of null / empty values: computes the number of records with a null or empty field value. Eg. result = 1.

  • Number of different values. Eg. result = 5.

  • Number of unique values: Eg. result = 3.

  • Number of duplicate values: Eg. result = 2.

  • Number of equal values: Counts the number of times a value occurs. The value to search for is passed as input to the indicator. Using the current example, if a value of 'e' is used, the result would be 3. If left empty, the indicator returns a value of '0', This parameter can be very useful when counting the number of times a default value appears.

Field filter predicate

yes

Linked records

"Records with values not null or empty": Boolean

"Records with null or empty values": Boolean

"Records with different values": Boolean

"Records with unique values": Boolean

"Records with duplicate values": Boolean

"Records with values equal to a value": Boolean

Applied to D.E.C. type

Field

Output parameters

"Number of values": Integer

"Number of null or empty values": Integer

"Number of different values": Integer

"Number of unique values": Integer

"Number of duplicated values": Integer

"Number of values equals to a value": Integer

Storage procedure

Any resulting value is stored

Reporting table

'Flat data report' - One record is saved in the Flat data report table.

Input parameters

"Count number of values": Boolean

"Count number of null or empty values": Boolean

"Count number of different values": Boolean

"Count number of unique values": Boolean

"Count number of duplicated values": Boolean

"Count number of values equals to a value": Boolean

"Values similar to empty": String[*]

"Is undefined boolean considered null or empty": Boolean, default value = No

"Value to count': String

Computation frequency

"On demand"

Periodicity of control and watchdog

Periodicity of control=none

Minimum threshold=no, Maximum threshold=no, Tolerance number=no

Probe

no

Save last value only

Configuration

Email alert

Configuration

Data view

ONSimpleStatisticsOnFieldValue

Simple statistics on string (text) field value [ON] F-I23

Property

Specification

Code

[ON] F-I23

Name

Simple statistics on string (text) field values

Use other indicators

N/A

Specification

This indicator computes a set of elementary statistics on a field value with a data type of string (text) to get the following information on its size:

  • Length.

  • For a maximum set of values (configured by Input parameters): highest length, lowest length.

Field filter predicate

yes

Linked records

Records of the highest length.

Records of the lowest length.

Applied to D.E.C. type

Field (String, Text)

Output parameters

''Highest length': Integer

''Lowest length': Integer

Storage procedure

Any resulting value is stored

Reporting table

'Flat data report' - Multiple records are saved in the Flat data report table depending on the configured maximum output number.

Input parameters

"Count null characters as 1 size": Boolean, default value = Yes

"Count white spaces as 1 size": Boolean, default value = Yes

"Maximum number of outputs for highest/lowest length": Integer, default value is 3, the maximum is 20

Computation frequency

"On demand"

Periodicity of control and watchdog

Periodicity of control=none

Minimum threshold=no, Maximum threshold=no, Tolerance number=no

Probe

no

Save last value only

Configuration

Email alert

Configuration

Data view

ONSimpleStatisticsOnStringTextFieldValue

Simple statistics on numeric field value [ON] F-I24

Property

Specification

Code

[ON] F-I24

Name

Simple statistics on numeric field values

Use other indicators

N/A

Specification

This indicator computes a set of elementary statistics on a field value with a numeric data type (Integer, Decimal) to get the following results:

  • Average value.

  • Median value. When odd series the median value is the middle value of the series. When pair series the median value is the average of the two values of the middle of the series.

  • First quartile. Q1 = ¼ * Nb. of values. The first quartile is equal to the value in the Q1 position in the ordered series of value (rounded up in case of decimal).

  • Third quartile. Q3 = ¾ * Nb. of values. The third quartile is equal to the value in the Q3 position in the ordered series of value (rounded up in case of decimal).

  • Range value. Difference between the biggest value minus the lowest value.

Field filter predicate

yes

Linked records

N/A

Applied to D.E.C. type

Field (Integer, Decimal)

Output parameters

''Average": Decimal

''Median": Decimal

''First quartile": Decimal

''Third quartile": Decimal

''Range": Decimal

Storage procedure

Any resulting value is stored

Reporting table

'Flat data report' - One record is saved in the Flat data report table.

Input parameters

"Count null / empty values': Boolean, default value = No

"Values similar to empty": Decimal[*]

Computation frequency

"On demand"

Periodicity of control and watchdog

Periodicity of control=none

Minimum threshold=no, Maximum threshold=no, Tolerance number=no

Probe

no

Save last value only

Configuration

Email alert

Configuration

Data view

ONSimpleStatisticsOnNumericFieldValue

Field compliance against a pattern [ON] F-I25

Property

Specification

Code

[ON] F-I25

Name

Field compliance against a pattern

Use other indicators

N/A

Specification

This indicator computes the number of times a field is compliant with a regular expression pattern that is configured when defining the indicator:

  • Number of valid values.

  • Number of invalid values.

Field filter predicate

yes

Linked records

Records with valid values: Boolean

Records with invalid values: Boolean

Applied to D.E.C. type

Field

Output parameters

''Number of valid value": Integer

''Number of invalid value": Integer

Storage procedure

Any resulting value is stored

Reporting table

'Flat data report' - One record is saved in the Flat data report table.

Input parameters

"Regular expression to check": String

Computation frequency

"On demand"

Periodicity of control and watchdog

Periodicity of control=none

Minimum threshold=no, Maximum threshold=no, Tolerance number=no

Probe

no

Save last value only

Configuration

Email alert

Configuration

Data view

ONComplianceAgainstAPattern

Time series compliance [ON] F-I27

Property

Specification

Code

[ON] F-I27

Name

Time series compliance

Use other indicators

N/A

Specification

This indicator checks whether dates are within an interval that is configured when defining the indicator. It also checks that a field start date is before the end date:

  • Number of invalid dates.

  • Number of start dates not before the end date.

Field filter predicate

yes

Linked records

Records with date outside the interval: Boolean

Records with start date not before the end date: Boolean

Applied to D.E.C. type

Field (Date, Date-time)

Output parameters

''Number of invalid date": Integer

''Number of start date not before the end date": Integer

Storage procedure

Any resulting value is stored

Reporting table

'Flat data report' - One record is saved in the Flat data report table.

Input parameters

"Checking based on date interval": Boolean, default value = Yes

"Interval - Start date": Timestamp

"Interval - End date": Timestamp

"Checking based on start date before end date": Boolean, default value = Yes

"End date field": Field of type date in the related D.E.C. table

Computation frequency

"On demand"

Periodicity of control and watchdog

Periodicity of control=none

Minimum threshold=no, Maximum threshold=no, Tolerance number=no

Probe

no

Save last value only

Configuration

Email alert

Configuration

Data view

ONTimeSeriesCompliance

Statistics on field interval value [ON] F-I28

Property

Specification

Code

[ON] F-I28

Name

Statistics on field interval value

Use other indicators

N/A

Specification

This indicator computes the number of times a field value is within a pre-defined interval:

  • Number of values under the minimum.

  • Number of values above the maximum.

  • Number of values in the interval.

Field filter predicate

yes

Linked records

Records with value under the minimum: Boolean

Records with value above the maximum: Boolean

Records with value within the interval: Boolean

Applied to D.E.C. type

Field (Integer, Decimal)

Output parameters

''Number of value under the minimum": Integer

''Number of value above the maximum": Integer

"Number of value within the interval": Integer

Storage procedure

Any resulting value is stored

Reporting table

'Flat data report' - One record is saved in the Flat data report table.

Input parameters

"Min. value": Decimal

"Max. value": Decimal

"Is min. value within the interval": Boolean, default value = Yes

"Is max. value within the interval": Boolean, default value = Yes

Computation frequency

"On demand"

Periodicity of control and watchdog

Periodicity of control=none

Minimum threshold=no, Maximum threshold=no, Tolerance number=no

Probe

no

Save last value only

Configuration

Email alert

Configuration

Data view

ONStatisticsOnFieldIntervalValue

Statistics on field relation [ON] F-I29

Property

Specification

Code

[ON] F-I29

Name

Statistics on field relation

Use other indicators

N/A

Specification

This indicator computes the number of times a relation (foreign key) is null, broken or normal.

Field filter predicate

yes

Linked records

Records with null relations.

Records with broken relations.

Records with normal relations.

Applied to D.E.C. type

Field (Foreign keys)

Output parameters

''Number of null relations": Integer

''Number of broken relations": Integer

"Number of normal relations": Integer

Storage procedure

Any resulting value is stored

Reporting table

'Flat data report' - One record is saved in the Flat data report table.

Input parameters

N/A

Computation frequency

"On demand"

Periodicity of control and watchdog

Periodicity of control=none

Minimum threshold=no, Maximum threshold=no, Tolerance number=no

Probe

no

Save last value only

Configuration

Email alert

Configuration

Data view

ONStatisticsOnFieldRelation

Field value completeness [ON] F-I31

Property

Specification

Code

[ON] F-I31

Name

Field value completeness

Use other indicators

N/A

Specification

This indicator computes the percentage of fulfillment of a field against all records in the table.

Field filter predicate

yes

Linked records

Records with null or empty values will be stored.

Applied to D.E.C. type

Field

Output parameters

''Percentage of fulfillment": Decimal

''Number of records with null or empty values": Integer

Storage procedure

Any resulting value is stored

Reporting table

'Flat data report' - One record is saved in the Flat data report table.

Input parameters

"Values similar to empty": String[*]

Computation frequency

"On demand"

Periodicity of control and watchdog

Periodicity of control=none

Minimum threshold=no, Maximum threshold=no, Tolerance number=no

Probe

no

Save last value only

Configuration

Email alert

Configuration

Data view

ONFieldValueCompleteness

Most frequent field values [ON] F-I32

Property

Specification

Code

[ON] F-I32

Name

Most frequent field values

Specification

The indicator computes the most frequent values for a field. You configure the maximum number of outputs using the indicator's input parameter. The following provides an example using a table's Age field (50 total records):

  • 10 records with age = 25

  • 20 records with age = 30

  • 15 records with age = 35

  • 5 records with age = 40

If you set the maximum number of outputs to 2, the indicator would output the two most frequently occurring value pairs: (20,30) and (15,35)

When the maximum number of outputs is unbounded, all of the value pairs would be output in descending order.

Applies to

Integer, Decimal, String, Boolean, Date, Time, and Date time, XML Name

Linked records

Yes.

Applied to D.E.C. type

Field

Output parameters

Most frequent values

Number of records (a count of the number of occurrences of each value): integer

Input parameters

Maximum number of output (the number of values to display, starting with the most frequently occurring):

  • Default value: 3

  • Min value: 1

  • Max value: unbounded

Available display modes

Bar, pie, line, and spark line charts

Least frequent field values [ON] F-I33

Property

Specification

Code

[ON] F-I33

Name

Least frequent field values

Specification

The indicator computes the least frequent values for a field. You configure the maximum number of outputs using the indicator's input parameter. The following provides an example using a table's Age field (50 total records):

  • 10 records with age = 25

  • 20 records with age = 30

  • 15 records with age = 35

  • 5 records with age = 40

If you set the maximum number of outputs to 2, the indicator would output the two least frequently occurring value pairs: (5,40) and (10,25)

When the maximum number of outputs is unbounded, all of the value pairs would be output in ascending order.

Applies to

Integer, Decimal, String, Boolean, Date, Time, and Date time, XML Name

Linked records

Yes.

Applied to D.E.C. type

Field

Output parameters

Least frequent values

Number of records (a count of the number of occurrences of each value): integer

Input parameters

Maximum number of output (the number of values to display, starting with the most frequently occurring):

  • Default value: 3

  • Min value: 1

  • Max value: unbounded

Available display modes

Bar, pie, line, and spark line charts

Number of not null values for a field [ON] F-I34

Property

Specification

Code

[ON] F-I34

Name

Number of not null values for a field

Specification

The indicator returns the number of not null values.

Applies to

Integer, Decimal, String, Boolean, Date, Time, and Date time

Linked records

Yes.

Applied to D.E.C. type

Field

Output parameters

Number of not null values.

Input parameters

None

Available display modes

Digital (default), line chart, bar chart, sparkline

Number of distinct values for a field [ON] F-I35

Property

Specification

Code

[ON] F-I35

Name

Number of distinct values for a field

Specification

The indicator computes the number of distinct value for a field.

Applies to

Integer, Decimal, String, Boolean, Date, Time, and Date time

Linked records

Yes.

Applied to D.E.C. type

Field

Output parameters

Number of distinct values.

Input parameters

None

Available display modes

Digital (default), line chart, bar chart, sparkline

Number of unique values for a field [ON] F-I36

Property

Specification

Code

[ON] F-I36

Name

Number of unique values for a field

Specification

The indicator computes the number of values which occur only one time among all values.

Applies to

Integer, Decimal, String, Boolean, Date, Time, and Date time

Linked records

Yes.

Applied to D.E.C. type

Field

Output parameters

Number of unique values.

Input parameters

None

Available display modes

Digital (default), line chart, bar chart, sparkline

Number of not unique values for a field [ON] F-I37

Property

Specification

Code

[ON] F-I37

Name

Number of not unique values for a field

Specification

The indicator computes the number of values which occur more than one time among all values.

Applies to

Integer, Decimal, String, Boolean, Date, Time, and Date time

Linked records

Yes.

Applied to D.E.C. type

Field

Output parameters

Number of not unique values.

Input parameters

None

Available display modes

Digital (default), line chart, bar chart, sparkline

Field maximum length [ON] F-I38

Property

Specification

Code

[ON] F-I38

Name

Field maximum length

Specification

The indicator returns the length of the longest field value.

Applies to

String

Linked records

Yes.

Applied to D.E.C. type

Field

Output parameters

Length of the longest field value.

Input parameters

Count null characters as 1 size (default value: Yes)

Count white spaces as 1 size (default value: Yes)

Available display modes

Digital (default), line chart, bar chart, sparkline

Field minimum length [ON] F-I39

Property

Specification

Code

[ON] F-I39

Name

Field minimum length

Specification

The indicator computes the length of the shortest field value.

Applies to

String

Linked records

Yes.

Applied to D.E.C. type

Field

Output parameters

Length of the shortest field value

Input parameters

Count null characters as 1 size (default value: Yes)

Count white spaces as 1 size (default value: Yes)

Available display modes

Digital (default), line chart, bar chart, sparkline

Field average length [ON] F-I40

Property

Specification

Code

[ON] F-I40

Name

Field average length

Specification

The indicator computes the average length of a field value.

Applies to

String

Linked records

Yes.

Applied to D.E.C. type

Field

Output parameters

Average length of a field value: sum of length of all distinct values of a field divided by the number of distinct values

Input parameters

Count null characters as 1 size (default value: Yes)

Count white spaces as 1 size (default value: Yes)

Available display modes

Digital (default), line chart, bar chart, sparkline

Average field value [ON] F-I41

Property

Specification

Code

[ON] F-I41

Name

Average field value

Specification

The indicator computes the sum of all values of the field in the table divided by the number of non-null values. If all values are null, the result is ‘NULL’.

Applies to

Integer, Decimal

Linked records

No

Applied to D.E.C. type

Field

Output parameters

Average of a field's values.

Input parameters

None

Available display modes

Digital, line chart, bar chart, spark line chart

Median field value [ON] F-I42

Property

Specification

Code

[ON] F-I42

Name

Median field value

Specification

The indicator computes the median of a numeric series. It returns the value which divides all the values sorted in 2 sub lists of the same size. If the number of values is odd, the result is the middle value of the list of all the values sorted. If the number of values is even, the result is the mean of the two values in the middle of the list of all the values sorted. If all values are null, the result is ‘NULL’.

Applies to

Integer, Decimal

Linked records

No

Applied to D.E.C. type

Field

Output parameters

Median of a field's values.

Input parameters

None

Available display modes

Digital, line chart, bar chart, spark line chart

Field value range [ON] F-I43

Property

Specification

Code

[ON] F-I43

Name

Field value range

Specification

The indicator computes the difference between the highest value and the lowest value of a numeric series.

Applies to

Integer, Decimal

Linked records

No

Applied to D.E.C. type

Field

Output parameters

Range of a field's values.

Input parameters

None

Available display modes

Digital, line chart, bar chart, spark line chart

Highest field value [ON] F-I44

Property

Specification

Code

[ON] F-I44

Name

Highest field value

Specification

The indicator returns the highest value among all values of a field. If all values are null, the result is ‘NULL’.

Applies to

Integer, Decimal

Linked records

Yes

Applied to D.E.C. type

Field

Output parameters

Highest field value.

Input parameters

None

Available display modes

Digital (default), line chart, bar chart, sparkline

Lowest field value [ON] F-I45

Property

Specification

Code

[ON] F-I45

Name

Lowest field value

Specification

The indicator returns the lowest value among all values of a field. If all values are null, the result is ‘NULL’.

Applies to

Integer, Decimal

Linked records

Yes

Applied to D.E.C. type

Field

Output parameters

Lowest field value.

Input parameters

None

Available display modes

Digital (default), line chart, bar chart, sparkline