This form allows you to change indicators.

Header

• Indicator: Identifier of the indicator.
• Name: Name of the indicator; it will be displayed in the dashboards.
• Status: If the indicator is inactive, it will not be offered on the dashboards.
• Icon: Icon displayed when the value of the indicator is "normal" (not to be monitored, not an alert). Indicate the path to the icon on the server where CARL Source is installed; see Icon.
  The icon allows users who view the dashboards to quickly identify alarming values or values to be monitored.
• Standard: If this box is checked, the indicator supplied with CARL Source is not modifiable.
• Balloon help: Text displayed when the mouse hovers over the indicator, if its value is "normal" (not to be monitored, no alert)

Limit values

• Monitoring floor, ceiling, alert floor, ceiling: Values beyond which the indicator requires monitoring or expresses a state of alert.
  • You may fill in just the upper limit.
  • The INDICATORMAIL standard job can be used to send an email notification if the indicator value is out of bounds.
  Example:

If you fill in 7 for the monitoring upper limit, a value of 7, 8, or more will be reported as a monitoring value.

• Monitoring or alert icon: If the value is outside the limits, the indicator will be displayed with the icon corresponding to the monitoring or alert icon.
• Balloon help: Text displayed when the mouse hovers if the value is outside the limits.
• Message template: For automatically sending an email if the value is outside the limits.
  To that end, an Automatic job for running the CSJOBINDICATORMAIL job needs to have been created.
  For the configuration of the message template, see Dynamic Message and Examples of message templates.
  If a type of entity is specified in the indicator, the message template must refer to the same type of entity.

Calculation definition

• Type of entity: To be filled in if an entity is a setting of the indicator: the keyword {entityCode} or {entityId} is used in the criteria or the query.

Case of query indicator

• Query: SQL query text, standard or understandable by the DBMS on which CARL Source is installed, see Query indicator. No creation possible for this type of query indicator, only Standard query indicators are authorized for read-only.

Case of filter indicator

• Filter criteria: Values of the criteria forming the indicator; see Filter indicator.
  The operator is indicated for criteria coming from an advanced filter. It can then be changed by clicking on the value.

Access and updating

• Updated every: The default update period is 0, i.e., the indicator value is recalculated at each display request.
  If the indicator takes a long time to calculate and does not change much over time, you can specify a refresh period
  → The indicator will only be re-evaluated by the system if the number of hours elapsed since the last calculation is greater than the number indicated.
  
• Confidentiality: A criterion for limiting the display of the indicator depending on the user's technical access group; see Data access group. Confidentiality must be defined as an access criterion on indicators.
  Confidentiality is a configurable list of values.

Case of filter indicator

• Custom form: Custom form to be opened when the user clicks on the indicator from the dashboard.

History

• History stored every: The default logging period is 0, i.e., the values of the indicator are not logged.
  To store historical indicator values, enter a history frequency (expressed as a number of days).
  The minimum frequency, below which history storage is not permitted, is 1 day.
  When a history frequency is entered, the Indicator [History] tab is automatically added.
  The INDICATORHISTO standard job can be used to calculate the indicator history.

Test

• Test: When you click on the "Test" button, a pop-up is displayed to test the current value of the indicator.
  If the indicator has settings (Entity, User), enter them then then click on the "Calculate" button."
  → The value calculated as a function of your settings (if applicable) is displayed, together with the corresponding icon.
  → The value calculated is shown in a gauge, which also displays the thresholds (if entered in the [General] tab).
  The gauge showing the current value of an indicator may also be displayed in a portlet on the home portal, see Home screen.