XML definition

The XML definition must conform to the following structure:

</readings>

</columns>

</file>

</files>

</configuration>

A CSV file can be generated for each <file> definition. As this element may appear multiple times within <files>, several CSV files can be generated per XML definition and, consequently, per workflow assignment.

One or more <export…> elements can be contained within the <file> element. These specify the metering points to be exported. These elements can also be used multiple times within the <file> tag, meaning that each CSV file can contain multiple metering points.

This element must be the first element and may only appear once within a <configuration> element.

Attribute
id	Required	Unique identification of the element

Child elements: <reading>

This element must appear as the second element after <readings>. It may only appear once within a <configuration> element.

Attribute
id	Required	Unique identification of the element

Child elements: <column>

<files>

This element must be the third element after <readings> and <columns>. It may only appear once within a <configuration> element.

Attribute	Use	Description
delimiter	Required	Delimiter, e.g. , / ; TAB Global setting; can be overridden in the <file> element.
column-headers	Required	true or false – Output column headers
force-export	Required	true or false – Output even if the available data do not meet the <min-status>
export-start	Required	Basis for the start time, C: Continuous, H: Hour, D: Day, M: Month, Y: Year
export-offset	Required	Offset from the start time (-xD or -xM), e.g. -1M (previous month), -10D (10 days ago)
export-duration	Required	Time range to be exported. C (up to now), or intervals such as 1M (1 month)
export-interval	Required	Granularity of the rows. P (Period), H (Hourly), D (Daily), M (Monthly)
header	Required	String at the start of the CSV document.
footer	Required	String at the end of the CSV document.
min-status	Required	Data quality threshold (0=original value, 1=replacement value, 2=forecast value, 3=invalid value, 4=missing value).
culture	Optional

Child elements: <file>

This element may appear multiple times within the <readings> tag. One measured variable and one aggregation function are defined per element.

Attribute
id	Required	Unique identification of the column
obis-code	Required	OBIS code of the measured variable.
function	Required	Aggregation functions: SUM, MIN, MAX, AVG

Child element: None

This element may appear multiple times within the <columns> tag. One column is defined for each element.

Attribute
id	Required; String	Unique identification of the column
header	Required, String	Header text
ref	Optional, String	Reference to visual energy objects: MP.ID => Metering point ID MP.NAME => Metering point name MP.NUMBER => Meter number MP.INSTALLATIONPOINT => Installation location LOCALSTART => Start timestamp (local time at the metering point) LOCALEND => End timestamp (local time at the metering point) UTCSTART => Start timestamp (UTC) UTCEND => End timestamp (UTC) VALUE => Value UNIT => Unit of measured variable STATUS => Status of the measured value TOTALSTATUS => Overall status of the output LOCATION => Location
index	Optional, integer	If the parent <columns> element contains columns from different <reading> elements, then the index must identify the <reading>. The numbering starts at 0 and corresponds to the order of the <reading> elements.
format	Optional, String	Standard .NET formats. N2 = 2 decimal places, F3 = fixed-point (without a thousands separator, 3 decimal places)
const	Optional, String	Specifies constant strings.

Child elements: None

<file>

This element may appear multiple times within a <files> tag. One CSV file is exported for each element.

Attribute
filename-pattern	Required	Definition of the CSV filename. This allows the filename to be generated dynamically using D, DD, M, MM, MMM and YYYY.
delimiter	Optional	Delimiter, e.g., / ; F; can be overridden in the <file> element.
column-headers	Optional	true or false – Output column headers. If specified, this overrides the global value of the <files> element.
force-export	Optional	true or false – Output even if the available data do not meet the <min-status> If specified, this overrides the global value of the <files> element.
export-start	Optional	Basis for the start time, C: Continuous, H: Hour, D: Day, M: Month, Y: Year If specified, this overrides the global value of the <files> element.
export-offset	Optional	Offset from the start time, e.g. -1M (previous month), -10D (10 days ago) If specified, this overrides the global value of the <files> element.
export-duration	Optional	Time range to be exported. C (up to now), or intervals such as 1M (1 month)
export-interval	Optional	Granularity of the rows. P (Period), H (Hourly), D (Daily), M (Monthly). If specified, this overrides the global value of the <files> element.
header	Optional	String at the start of the CSV document. If specified, this overrides the global value of the <files> element.
footer	Optional	String at the end of the CSV document.
min-status	Optional	Data quality threshold (0=original value, 1=replacement value, 2=forecast value, 3=invalid value, 4=missing value). If specified, this overrides the global value of the <files> element.
readings-id	Required	Definition of the measured variable
columns-id	Required	Definition of column elements. Refers to the ID of a <column> element

Child elements: <export>

This element may appear multiple times within the <file> tag. Each element defines one metering point.

Attribute
Tag	Optional	Description
mpid	Required	Metering point ID (e.g. DE9999997925637431071810725725270)
last export	Optional

Child elements: none

XML definition

See also