Setting

Definition

Counter is active

Only counters with this box checked will be active.  If a counter is not active, it will not be available to assign to a gauge on the dashboard.

Improves

If the counter is being used to measure a Key Performance Indicator (or other performance indicator), this defines how improvement is interpreted (if the measure increases or decreases)

Date to hit target

If the counter is being used to measure a Key Performance Indicator with a target that has been set, this date is the date when the target is to be achieved.

Use this workflow to request an update to the counter

If the counter cannot be calculated directly by the MIE, then the counter can be set to fire a workflow designed to request the current value from an individual.  The counter owner's name and email address will be forwarded to the workflow.  Be sure to specify an owner if you specify a workflow.

Instructions to be sent to counter owner

These instructions will be forwarded to the workflow thread as V3.

Group (used for workflow processing)

Counters can be grouped together for workflow purposes.  All counters that reference the same group name and the same workflow will be processed by a single workflow thread.  The information about the counters is forwarded to the thread and stored as user variables in the thread.  The workflow can access information about the various counters from the thread's variables.  All counters in the group will have their date last sampled set as well as the corresponding workflow thread number set, at the same time.  The very first counter in the group will cause all counters in the group to be sent to the workflow and marked as processed.  Subsequent counters in the group will be skipped for processing as they will show that they have already been processed.  Counter information is forwarded to the workflow thread using the following user variable names:

CN<#> - counter primary key value

CD<#> - counter description

CC<#> - counter how-to-calculate instructions

<#> ranges from 1 to the number of counters in the group.

Group order

Counters are ordered within their respective workflow groups using this ordering number.  Order is lowest to highest.

Set the xxxxxx value for this counter to this value ...

This applies to all four values.  If a value is entered into this field AND no Condition has been specified for use AND no SQL (ESI access only) has been specified, then this constant value will be assigned to the appropriate destination (min, max, value, or target)

or, set the xxxxxx value to the record count returned by this condition

This applies to all four values.  It lets you define a condition that will be applied and the resulting count of records will be used as the value.

or, set the target to this percentage of maximum

This only applies to the Target value.  Optionally, the target may be calculated as a percentage of the maximum.

or, set the xxxxx to the results of this SQL statement

(Available only to ESI developers)  This applies to all four values.  If SQL is specified, it will be used in lieu of all other calculations.  If the SQL statement contains a "COUNT()" function, "SUM()" function, "MIN()" function, or "MAX()" function, the SQL statement will be applied and the value of the first row, first column will be used as the result (regardless of what that column is called).  Otherwise, the count of records returned by the SQL statement will be used as the result.

or, set the current value based on this calculation strategy

Only applies to the current value.  Allows you to select from a list of pre-defined calculation strategies.  A calculation strategy takes precedence over a direct value, condition, or SQL statement.

Multiply by this value

This applies only to the Value (not the min, max, or target).  Once calculated, the Value is then multiplied by the number entered here.  Enter "1" to cause no change in Value.  Note, this entry accepts General Tags, however the general tag must evaluate to a number.

AND then, <operator> this counter value

After the Value is multiplied by the previous constant, it will then be optionally combined (based on the operator chosen)  with the value from another Counter.  The result of the operation will be saved as the counter's current value.  

Note: Any linked counters will be evaluated at the time the parent counter is evaluated.

After multiplying, add this value

After the Value is adjusted through the previous operation(s), this value will be added.  Enter "0" to cause no change to the Value.  Note, this entry accepts General Tags, however the general tag must evaluate to a number.

AND then, <operator> this counter value

Once the constant value is added, the Value is then optionally  combined (based on the operator chosen) to another Counter.  The result of the operation will be saved as the counter's current value.

Note: Any linked counters will be evaluated at the time the parent counter is evaluated.

Sample every

Defines how frequently the counter is to be evaluated and calculated values updated.  As mentioned previously, when a counter is referenced by a parent counter, it will be evaluated at the same time its parent is, despite these settings.

Date last sampled

Blanking this date and saving the record will cause the Counter to be evaluated the next time Housekeeping runs.

Most recent calculated values

Read-only fields show the most recent calculated values.

Save monthly snapshots

If this box is checked, the counter's values will be saved at the start of each new month in a snapshot table.