Universal accumulative reading meter connector specification
The universal accumulative reading meter connector specification is used when source systems provide accumulative meter readings, and IBM® Envizi ESG Suite calculates the interval consumption.
File name and tab name
- File name has the format EnviziAccum_XXXX:
- XXXX can include any characters, including spaces.
- File type is CSV or XLSX.
- For example, a typical valid file name might be EnviziAccum_DemoCorpUS_20230822_140655835.csv or EnviziAccum_DemoCorpUS_20230822_140655835.xlsx.
Each file name should contain a unique organization and location identifier, and a date timestamp that indicates when the file was created. The information is not used for file processing but it is useful to troubleshoot data loading issues.
Connector information
- The connector loads data into meters.
- The connector expects accumulative meter readings in the source file, and calculates consumption and demand for each interval based on the difference between meter readings.
- The connector reads a maximum of seven columns from A to G in the CSV or XLSX file template.
- The connector loads data by matching fields in the source file with a specific Envizi ESG Suite serial number, as indicated in the Data field mappings section:
- No two meters in Envizi ESG Suite can ever have the same serial number.
- If a matching serial number cannot be found, data is not loaded for the given rows.
Because the connector calculates interval consumption and demand based on the previous meter readings, it is important that files are received in the correct order with the oldest readings received first. Unexpected results might occur if files are received in a different order.
Column headings
| Column | Heading |
|---|---|
| A | Organization |
| B | Meter ID |
| C | Timestamp |
| D | Data Type |
| E | Value |
| F | Units |
| G | Quality |
Data rows
After incoming files have passed all the previous file validation criteria, each row of data is checked to see whether it is valid for loading into Envizi ESG Suite. The connector identifies valid data rows if they meet all the following criteria:
- An Envizi ESG Suite meter serial number is found that matches the following format: Organization_Meter ID
- The data type and units are a recognized combination
- The timestamp is in a valid format
Data field mappings
After a data row is identified, data row handlers determine what happens with the data and where it is stored in Envizi ESG Suite.
| Envizi ESG Suite column | Source file column | Source file name | Data format | Notes and assumptions |
|---|---|---|---|---|
| Serial No | 1-A 2-B |
Organization Meter ID |
Text Text |
The connector searches for an Envizi meter serial number that matches
the following format:
Example:
|
| Reading Timestamp | 3-C | Timestamp | DateTime | Format is yyyy-mm-dd hh:mm:ss (24-hour format)The timestamp is rounded to the nearest 15-minute interval (00, 15, 30, 45) Supported interval periods for the file are 15 minutes , 30 minutes and hourly. The time that is provided must reflect the local site time without any adjustments for daylight savings. |
| Meter Data Type | 4-D | Data Type | Text | See the following Supported data types and units section for details. |
| Reading Value | 5-E | Value | Decimal (up to 4 dp) | Values are read as the accumulative meter readings taken at the Timestamp in column
3-C. The connector calculates the difference between the current reading and the previous reading to determine the interval consumption. |
| Units | 6-F | Units | Text | See the following Supported data types and units section for details. |
| Estimated | 7-G | Quality | "A" or "E" | Optional. Used to identify if the data point is an actual reading or an estimated reading |
Supported data types and units
| Source file data type | Source file units | Envizi ESG Suite component | Envizi ESG Suite utility group | Notes and assumptions |
|---|---|---|---|---|
| Electricity | kWh | Accumulation Meter - Electricity (kWh) | Electricity | If both kWh and kVARh exist for an interval, the following measures are calculated:
Demand UOMs = kW and kVA |
| Electricity | kVARh | Accumulation Meter - Electricity (kWh) | Electricity | Demand UOM = kVAR |
| Natural Gas | cf | Accumulation Meter - Natural Gas (cf) | Natural Gas | Demand UOM = cf/h |
| Natural Gas | ccf | Accumulation Meter - Natural Gas (ccf) | Natural Gas | Demand UOM = ccf/h |
| Natural Gas | GJ | Accumulation Meter - Natural Gas (GJ) | Natural Gas | Demand UOM = GJ/h |
| Natural Gas | MJ | Accumulation Meter - Natural Gas (MJ) | Natural Gas | Demand UOM = MJ/h |
| Natural Gas | m3 | Accumulation Meter - Natural Gas (m3) | Natural Gas | Demand UOM = m3/h |
| Natural Gas | kWh | Accumulation Meter - Natural Gas (m3) | Natural Gas | Demand UOM = kW |
| Water | L | Accumulation Meter - Water (L) | Water | Demand UOM = L/h |
| Water | kL | Accumulation Meter - Water (kL) | Water | Demand UOM = kL/h |
| Water | m3 | Accumulation Meter - Water (m3) | Water | Demand UOM = m3/h |
| Domestic Water | gal | Accumulation Meter - Domestic Water (gal) | Water | Demand UOM = gal/h |
| Domestic Water | cf | Accumulation Meter - Domestic Water (cf) | Water | Demand UOM = cf/h |
| Blowdown Water | gal | Accumulation Meter - Blowdown Water (gal) | Water | Demand UOM = gal/h |
| Makeup Water | gal | Accumulation Meter - Makeup Water (gal) | Water | Demand UOM = gal/h |
| Cooling Tower Water | gal | Accumulation Meter - Cooling Water (gal) | Water | Demand UOM = gal/h |
| Irrigation Water | gal | Accumulation Meter - Irrigation Water (gal) | Water | Demand UOM = gal/h |
| Fuel Oil | gal | Accumulation Meter - Fuel Oil (gal) | Fuel | Demand UOM = gal/h |
| Liquid Propane | cf | Accumulation Meter - Liquid Propane (cf) | Fuel | Demand UOM = cf/h |
| Liquid Propane | ccf | Accumulation Meter - Liquid Propane (ccf) | Fuel | Demand UOM = ccf/h |
| Steam | lbs | Accumulation Meter - Steam (lbs) | Thermal | Demand UOM = lbs/h |
| Chilled Water | Btu | Accumulation Meter - Chilled Water (Btu) | Thermal | Demand UOM = Btu/h |
| Chilled Water | kBtu | Accumulation Meter - Chilled Water (kBtu) | Thermal | Demand UOM = kBtu/h, where kBtu = 1,000x Btu |
| Chilled Water | ton hours | Accumulation Meter - Chilled Water (ton hours) | Thermal | Demand UOM = tons |
| Hot Water | Btu | Accumulation Meter - Hot Water (Btu) | Thermal | Demand UOM = Btu/h |
| Hot Water | kBtu | Accumulation Meter - Hot Water (kBtu) | Thermal | Demand UOM = kBtu/h |
| Hot Water | ton hours | Accumulation Meter - Hot Water (ton hours) | Thermal | Demand UOM = tons |
| Thermal | kWh | Accumulation Meter - Thermal (kWh) | Thermal | Demand UOM = kW |
Data validation
In the following section, last good value refers to the last valid calculated interval consumption and demand for any meter. The last good value might be used as an estimate to replace the calculated consumption and demand for an interval if the following data validation checks fail.
| Data validation check | Description and action |
|---|---|
| Null value | Null values are considered invalid data. The connector logs an error and skips the row. Subsequently, values are estimated when a valid meter reading is received. |
| Non-numeric value | Non-numeric values are considered invalid data. The connector logs an error and skips the row. Subsequently, values are estimated when a valid meter reading is received. |
| Negative value | Negative values, for example, negative meter readings, are considered invalid data. The connector logs an error and skips the row. Subsequently, values are estimated when a valid meter reading is received. |
| Decreasing value | Negative consumption, for example, decreasing meter readings, are considered data anomalies.
The connector processes the row based on the following criteria:
Envizi ESG Suite suppresses issues and alerts from being generated when data is flagged as estimated. |
| Data spike | A data spike is a large increase in value that is more likely to represent a data anomaly or
meter fault, rather than an actual increase in consumption or demand. Envizi ESG Suite detects data spikes by comparing the calculated demand for the current interval with the maximum historical demand over a look-back period, where the default is the previous 30 days. If the demand for the current interval is greater than the maximum historical demand by a specified margin, where the default multiplier is 10, the calculated consumption and demand for the interval is replaced with the last good value and the data is flagged as estimated. Envizi ESG Suite suppresses issues and alerts from being generated when data is flagged as estimated. Note: The data spike validation logic provides good
results for meters with regular load profiles but can be triggered unintentionally for meters with
irregular load profiles. You can configure the following options at the organization level to suit
your organization's preferences:
|
Gap filling
The connector is able to apply a linear interpolation estimation method to backfill data gaps
that are less than or equal to [24 hours (default), 48 hours, 72 hours]. Data gaps
that are longer than the selected period are not filled but can be covered by Configuring meter data accruals.
Overwriting of data
If data is loaded for a specific interval and then reissued in a subsequent file, the most recent data, if valid, overwrites the existing data.
Example file format
The following screenshot shows an example file for loading meter data:
