ParseConsumptionRecord@1
Node ParseConsumptionRecord@1 parses an EDA consumption record (DATEN_CRMSG, schema ConsumptionRecord 01.41) into a list of EnergyData objects with the individual energy quantities. Unlike AggregateConsumptionRecord@1, the quantities are not aggregated and every meter code of the message is kept.
Adapter Prerequisites
Node Configuration
For fields path, targetPath, targetValueWriteMode, and targetValueKind, see Overview.
transformations:
- type: ParseConsumptionRecord@1
path: $.message.RawMessage # raw XML of the consumption record
meteringPointRtIdPath: $.meteringPoint.RtId # RtId of the metering point entity
targetPath: $.energyData
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
path | string | No | $ | Path to the raw XML of the consumption record |
meteringPointRtIdPath | string | Yes¹ | - | Path to the RtId of the metering point the quantities belong to |
targetPath | string | No | $ | Path where the list of EnergyData objects is written |
¹ Not marked as required in the schema, but enforced at runtime: without meteringPointRtIdPath the node fails with MeteringPointRtIdPath must be set in the configuration.
Behavior
- If the raw XML is empty or missing, or no RtId is found at
meteringPointRtIdPath, the node writes nothing and the pipeline continues. - For each
Energyblock and eachEnergyData(meter code) of the message, oneEnergyDataobject is written. - A unit other than kWh or MWh fails the node.
Output
A list of EnergyData objects (PascalCase property names in the data context):
| Property | Description |
|---|---|
MeteringPointRtId | RtId read from meteringPointRtIdPath |
MeteringPointNumber | Metering point of the message |
CreationTime | DocumentCreationDateTime of the message; a correction carries a later value than the message it corrects |
PeriodStart | Start of the metering period |
PeriodEnd | End of the metering period |
MeterCode | Meter code (OBIS code), e.g. 1-1:2.9.0 G.03 |
QuantityUnit | kWh or MWh |
EnergyQuantities | Energy quantities with MeteringPointRtId, MeteringPointNumber, From, To, Quantity and Quality (0 unknown, 1 L1, 2 L2, 3 L3) |
The configuration properties are documented in the API reference, the output in EnergyData.
Complete sample of pipeline configuration
This sample parses a consumption record that is passed to the pipeline together with the RtId of its metering point and keeps the newest data per period.
triggers:
- type: FromPipelineDataEvent@1
transformations:
- type: ParseConsumptionRecord@1
path: $.message.RawMessage
meteringPointRtIdPath: $.meteringPoint.RtId
targetPath: $.energyData
- type: FilterEnergyData@1
path: $.energyData
targetPath: $.energyData