NOTE:

• Fields marked with ‘*’ cannot be altered once data has been captured for that Metric.
• To be able to use Metric Unit, the users need access to the Unit of Measure component. For Standard Configuration, you can use the below role otherwise a new role has to be configured.
  Unit of Measure - RW_for_Relationships - R_for_Fields - NAA

Page 1: Metrics

Field

Explanation

Active

Determines if a Metric is active or not. Data will be collected only for Active Metrics which are associated with a Campaign.

Metric Group

Select the Metric Group to which the current Metric is related.

Applicable Reporting Framework

Link the Metric through to one or more Reporting Framework sections, to assist with reporting and disclosures

Metric Name

Enter a unique Name for the Metric.

This name needs to be clear enough so that a user can provide the correct input.

Description

Optional: you can provide a more details description for the current Metric.

Any information entered here will be shown as a tool-tip on the Metrics data entry screens.

Input Type *

Each Metric can be one of the following Input Types:

• Text (Memo with unlimited characters)
• Integer
• Decimal
• Yes/No

Frequency *

For each Metric, you need to define the Frequency in which an answer will need to be provided. The options are:

• Month
• Quarter
• Year

Metric Unit *

Unit of Measure (UoM) that the Metric data is required in. Data provided in other units will be converted to this Unit .

The UoM themselves can be defined by navigating to:
Administration Unit of Measure.

Note: dynamically visible when Input Type = Decimal.

Metric Polarity *

For reporting purposes, this defines whether the Metric is viewed as a

• Positive (e.g. 'Number of Audits performed') or as a
• Negative (e.g. 'Number of Complaints received')

measure.

Note: dynamically visible for all Input Types, except Text.

Variation % Threshold

If the entered data deviates by more than [Variation % Threshold] from the previous time period for the same location, the user will be forced to enter a comment to explain the reason for the variation.

• To deactivate this check:
  Set Variation % Threshold = [blank]
• A value of 0 would mean that entries have to be identical to the previous value.

Note: dynamically visible when the Input Type = Decimal or Integer

Metric Type *

Select one of the following options:

• User Data Entry:
  When the value is provided by the user
• System Calculated:
  Select this option if you want the system to calculate the Metric, based on data already existing in your database, rather than needing to be entered by users.
• User Formula:
  By selecting this option you can define a mathematical formula which will calculate this Metric.
  

Validation: Metrics with an [Input Type] of "Text" or "Yes/No" can only be of Type ‘User Data Entry’.

Statistical Type

For reporting purposes, this field determines what type of calculations need to be performed on the Metric value. The two options are:

• Sum
• Average

Calculation Type *

Select how you want to calculate this Calculated Metric:
Average*, Count, Max, Min, Sum

*) About Averages:
By default, the system will include records with a NULL value in the number field into the count upon which the average is calculated.
If you want to only include records where the field actually has a value entered, you need to apply the appropriate filter condition (see below)

Note: dynamically visible and mandatory to fill in for "System Calculated" Measures.

Component *

Select the Component which contains the field needing to be calculated.

Note: dynamically visible and mandatory to fill in for "System Calculated" Metrics.

Calculation Data Unit *

This is the Data Unit for the Input of the Metric. It will then be converted to the Metric Unit (see above).

Note: dynamically visible for "System Calculated" Metrics and mandatory to fill in if [Metric Unit] is selected.

Page 2: Calculated Metric Fields

Field

Explanation

Location Relationship *

Find and select the relationship from which the system can determine the Location which is linked to the calculated metric data.

For example, to calculate Emissions you can use the following examples (with the base component being "Emissions Result Output Value"):

Emissions Result Output Value/Parent Result/Emission Source/Location

Date Field *

Find and select the Date Field from which the system can determine in which Time Period a calculated metric data will fall, for example:

Emissions Result Output Value/Parent Result/Time Period:To

Value Field *

Select the field which will be used for the calculation of the value, for example:

Emissions Result Output Value:Value

Note: dynamically visible for all Calculation Types, except Count.

Filter Condition *

Optional: you can define a Condition to only take records into account for the calculation if it meets the defined criteria. For example:

Emissions Result Output Value/Parent Result/Emission Source:Name EQUALS Mobile Equipment (Diesel)

Page 2: Formula Metric Fields

Field

Explanation

Formula Code *

The formula builder allows users to create mathematical formulas using any of the following operators/functions:
+, -, *, /, SQRT, log, log10, exp, use of brackets ()

The Formula Code can use other existing numeric metrics.

Selecting the (i) button beneath the formula builder will list all currently available Metrics you can use for calculations.

You can highlight the Metric Id and copy it into the Formula Builder.

For some examples about Entering Formulas, please follow this link.

The indicator beneath the input field depicts if the code entered

• Has a mathematically valid syntax
• References valid Metrics

Formula Text *

This is a read-only field depicting the formula in its pure text form.