Configure Metering & Consumptions

Metering Configuration

The metering configurations define the behavior that the recorded measurement should have specified for filtering criteria.

Except for formatting errors, all the measurement received is uploaded to the system and subsequently validated. If it is valid and can be used by the rest of the processes.

First of all the validation process select the right validation criteria to apply to the meter reading, for that use the selection / filtering criteria defined on Metering Validation Settings.

Filtering Criteria:

• Device Record Type: Business Line of the meter device.

• Device Type: Type of device.

• Device Model: Device Model.

Selection Priority:

• Weight: A weight is defined to the configuration so that if several filtering criteria are met at the same time, the system takes the one that is defined with the highest weight, that is, the most priority. This situation can occur in multiple business cases such as defining a general behavior for a line of business and another for a specific type or model of device in that line of business, the system will identify both configurations as valid or applicable and will keep the one that has the greatest weight defined.

Validation parameters:

Required parameters:

• Fieldset: The defined set of fields containing the measurement is defined in the “Metering” object for this configuration. It must exist as a Fieldset in the “Metering” object in order to be used. In this way we can define time recorders, by period, daily, etc… on the same metering object.

• Negative values: It is allowed to mark whether or not negative values are accepted in the fields of the fieldset in the recorded measure.

• Null values: It is allowed to mark whether or not null values are accepted in the fields of the fieldset in the recorded measure.

Optional parameters:

• Valid max range: The maximum numeric value allowed in fieldset value fields.

• Valid min range: The minimum numeric value allowed in fieldset value fields.

Consumption Configuration

The Consumption Configuration defines both the behavior that the calculated/recorded consumption must have and the configuration to be used for the consumption calculation specified for filtering criteria.

Except for formatting errors, all consumption received or calculated is recorded in the system and subsequently validated. If it is valid and can be used by the rest of the processes

First of all the validation process select the right validation criteria to apply to the consumption register, for that use the selection / filtering criteria defined on Metering Validation Settings.

Filtering Criteria:

• Device Record Type: Business Line of the meter device.

• Device Type: Type of device.

• Device Model: Device Model.

Selection Priority:

• Weight: A weight is defined to the configuration so that if several filtering criteria are met at the same time, the system takes the one that is defined with the highest weight, that is, the most priority. This situation can occur in multiple business cases such as defining a general behavior for a line of business and another for a specific type or model of device in that line of business, the system will identify both configurations as valid or applicable and will keep the one that has the greatest weight defined.

Validation parameters:

Required parameters:

• Fieldset: The defined set of fields containing the measurement is defined in the “Consumption” object for this configuration. It must exist as a Fieldset in the “Consumption” object in order to be used. In this way we can define time recorders, by period, daily, etc… on the same metering object.

• Calculation Mode: Different consumption calculation mode

  • DIFV: Vertical Difference between values. Calculation method based on the difference between the same value field between previous and current record

  • KEEP: Avoid calculation, only keeps the same value received as calculated consumption. Apply in scenarios when the usage log is received directly

• Get Mode: How to obtain consumption. This is the default method to use when using the getConsumptions method unless a specific method is specified in the method call RANGE: Default method. The system returns a consumption list with one record for each record of the “Consumption” object, i.e. one for each range recorded in the system. In this way, for example, for the application of calculations, you will receive a list of consumptions on which to apply the calculations for each one, taking into account each date range of each consumption.

  • TOTAL: The system returns a single consumption record by summarizing the values of each record in each field of the fieldset.

  • DAILY: The system returns a record for each day of the recorded consumption ranges by applying linear proration per day of each fieldset value field.

• Range Type: Type of range selection to use in meterings to apply consumption calculation.

  • MAXPREV_AND_MAXIN: To calculate consumption for a period between to dates, the system takes all validated meterings from the last metering prior to the start date of the range to the last one recorded within the range.

  • MAXPREV_AND_MINPOST: To calculate consumption for a period, the system takes all meterings from the last validated metering prior to the start date of the range to the first validated metering recorded after the end date of the calculation range.

  • MININ_MINPOST: To perform the consumption calculation of a period, the system takes all meterings from the first metering recorded on a date greater than or equal to the start date of the range to the first metering recorded after the end date of the calculation range.

  • MININ_MAXIN: To calculate consumption for a period, the system takes all meteirngs from the first metering recorded on a date greater than or equal to the start date of the range to the last one recorded within the range.

• Ordering: Specify type of order to apply to effective date and time fields in order to apply consumption calculation between meterings. Values (ASC/DESC).

Optional parameters:

• Group by field: You can define a field of the “Consumption” object from which you want to group the blocks of readings and calculate the specific consumption of each block using only the readings associated with the same value of the specified field. This parameter allows you to calculate the consumption between readings of the same period, block, etc. or any field in the Metering object. The value of this field will be included as “Block” in the generated usage dto. It’s incompatible with the use of split consumption due that both methods distribute consumptions in different blocks.

• Split Block Method: Method to be used to divide consumption by blocks. This parameter is incompatible with “Group by field” as it will apply a specific block division method to generate the different “Consumption” records of each block. Split Consumption process is deeply described in it’s own documentation section.