XML-Definition

Die XML-Definition muss folgender Struktur entsprechen:

<configuration>

<readings>

<reading>

</readings>

<columns>

<column…/>

</columns>

<files>

<file…>

<export…/>

</file>

</files>

</configuration>

Für jede <file> Definition kann eine CSV-Datei ausgegeben werden. Da dieses Element mehrfach in <files> vorhanden sein kann, können also pro XML-Definition und damit je Workflow-Zuordnung mehrere CSV-Datei erzeugt werden.

Innerhalb des <file> Elements können ein oder Mehrere <export ..> Elemente eingeschlossen sein. Diese legen die zu exportierenden Zählpunkte fest. Auch diese können mehrfach innerhalb des <file> Tags verwendet werden, so dass pro CSV-Datei mehrere Zählpunkte enthalten sein können.

<readings>

Dieses Element muss als erstes und darf nur einmal in einem <configuration> Element enthalten sein.

attribute

 

 

id

Required

Eindeutige Identifikation des Elements

Kind-Elemente: <reading>

<columns>

Dieses Element muss als zweites Element nach <readings> vorkommen. Es darf nur einmal in einem <configuration> Element enthalten sein.

attribute

 

 

id

Required

Eindeutige Identifikation des Elements

Kind-Elemente: <column>

<files>

Dieses Element muss drittes Element nach <readings> und <columns> vorhanden sein. Es darf nur einmal in einem <configuration> Element enthalten sein.

attribute

Use

Beschreibung

delimiter

Required

Trennzeichen z.B. , / ; TAB
Globale Angabe, kann im Element <file> überschrieben werden.

column-headers

Required

true oder false – Ausgabe von Kopfzeilen je Spalte

force-export

Required

true oder false – Ausgabe auch wenn vorhandenen Daten den <min-status> nicht erfüllen.

export-start

Required

Basis für den Startzeitpunk, C: Fortlaufend, H: Stunde, D: Tag, M: Monat, Y: Jahr

export-offset

Required

Versatz zum Startzeitpunkt (-xD oder -xM), z.B. -1M (Vormonat), -10D (10 Tage zurück)

export-duration

Required

Zeitraum, der exportiert wird. C (bis jetzt), oder Intervalle wie 1M (1 Monat)

export-interval

Required

Granularität der Zeilen. P (Periode), H (Stündlich), D (Täglich), M (Monatlich)

header

Required

Zeichenfolge am Anfang des CSV-Dokumentes.

footer

Required

Zeichenfolge am Ende des CSV-Dokumentes.

min-status

Required

Schwellenwert für die Datenqualität (0=Original, 1=Ersatzwert, 2=Prognose, 3=gestörter Wert, 4=fehlender Wert).

culture

Optional

 

Kind-Elemente: <file>

<reading>

Dieses Element darf mehrfach in <readings> Tag- enthalten sein. Pro Element wird eine Messgröße und Aggregats-Funktion definiert.

attribute

 

 

id

Required

Eindeutige Identifikation der Spalte

obis-code

Required

OBIS-Code der Messgröße.

function

Required

Aggregatsfunktion: SUM, MIN, MAX, AVG

Kinde-Element: Keine

<column>

Dieses Element darf mehrfach in <columns> Tag- enthalten sein. Pro Element wird eine Spalte definiert.

attribute

 

 

id

Required; String

Eindeutige Identifikation der Spalte

header

Required, String

Text der Kopfzeilen

ref

Optional, String

Referenz auf visual energy Objekte:

MP.ID => Zählpunkts-ID
MP.NAME => Zählpunkts-Name
MP.NUMBER => Zähler-Nummer
MP.INSTALLATIONPOINT => Installationsort
LOCALSTART => Start-Zeitstempel (Lokalzeit vom ZP)l
LOCALEND => End-Zeitstempel (Lokalzeit vom ZP)
UTCSTART => Start-Zeitstempel (UTC)
UTCEND => End-Zeitstempel (UTC)
VALUE => Wert
UNIT => Einheit der Messgröße
STATUS => Status des Messwertes
TOTALSTATUS => Gesamt-Status der Ausgabe
LOCATION => Standort

index

Optional, Integer

Wenn das übergeordnete <columns> Element Spalten unterschiedlicher <reading> Elemente enthält, dann muss der Index das <reading> identifizieren. Die Nummerierung beginnt bei 0 und entspricht der Reihenfolge der <reading> Elemente.

format

Optional, String

Standard .NET Formate. N2 = 2 Nachkommastellen, F3 = Festkomma (ohne Tausendertrennzeichen, 3 Nachkommastellen

const

Optional, String

Angabe von konstanten Zeichenfolgen.

Kind-Elemente: Keine

<file>

Dieses Element darf mehrfach in einem <files> Tag enthalten sein. Pro Element wird eine CSV-Datei exportiert.

attribute

 

 

filename-pattern

Required

Definition des Dateinamens der CSV-Datei. Ermöglicht durch die Verwendung von D, DD, M, MM, MMM, YYYY den Dateinamen auch individuell zu generieren.

delimiter

Optional

Trennzeichen z.B. , / ;
F, kann im Element <file> überschrieben werden.

column-headers

Optional

true oder false – Ausgabe von Kopfzeilen je Spalte.

Wenn angegeben, dann überschreibt dies den globalen Wert des Elements <files>.

force-export

Optional

true oder false – Ausgabe auch wenn vorhandenen Daten den <min-status> nicht erfüllen.

Wenn angegeben, dann überschreibt dies den globalen Wert des Elements <files>.

export-start

Optional

Basis für den Startzeitpunk, C: Fortlaufend, H: Stunde, D: Tag, M: Monat, Y: Jahr

Wenn angegeben, dann überschreibt dies den globalen Wert des Elements <files>.

export-offset

Optional

Versatz zum Startzeitpunkt, z.B. -1M (Vormonat), -10D (10 Tage zurück)

Wenn angegeben, dann überschreibt dies den globalen Wert des Elements <files>.

export-duration

Optional

Zeitraum, der exportiert wird. C (bis jetzt), oder Intervalle wie 1M (1 Monat)

export-interval

Optional

Granularität der Zeilen. P (Periode), H (Stündlich), D (Täglich), M (Monatlich) Wenn angegeben, dann überschreibt dies den globalen Wert des Elements <files>.

header

Optional

Zeichenfolge am Anfang des CSV-Dokumentes.

Wenn angegeben, dann überschreibt dies den globalen Wert des Elements <files>.

footer

Optional

Zeichenfolge am Ende des CSV-Dokumentes.

min-status

Optional

Schwellenwert für die Datenqualität (0=Original, 1=Ersatzwert, 2=Prognose, 3=gestörter Wert, 4=fehlender Wert).

Wenn angegeben, dann überschreibt dies den globalen Wert des Elements <files>.

readings-id

Required

Definition der Messgröße

columns-id

Required

Definition der Spalten-Elemente. Verweist auf die ID eines <column> Elementes

Kind-Elemente: <export>

<export>

Dieses Element darf mehrfach in <file> Tag- enthalten sein. Pro Element wird ein Zählpunkt definiert.

attribute

 

 

tag

Optional

Bezeichnung

mpid

Required

Zählpunkts-ID (z.B. DE9999997925637431071810725725270)

last-export

Optional

 

Kinde-Elemente: keine