ProcessReadIndex[].Type*

Art des Indexdatenlesers, d.h. das zu lesende Datenformat:

Der Indexdatenleser FileName interpretiert die Daten abweichend von den anderen Lesern nicht inhaltlich, sondern extrahiert nur Werte aus dem Eingabedateipfad oder Eingabedateinamen.

Einige Indexdatenleser, z. B. WebService oder die Leser für die E-Rechnungsformate, sind spezialisierte Formen des generischen Lesers Json und Xml. Im Vergleich zu den generischen Lesern erleichtern diese spezialisierten Leser die Konfiguration, da in diesen Fällen der Aufbau der Datenstrukturen bekannt ist.

ProcessReadIndex[].ConditionMacro

optionaler Feldmakroausdruck, wenn die Verarbeitung eines Indexdatenlesers nur unter bestimmten Bedingungen ausgeführt werden soll

Der Feldmakroausdruck muss einen entsprechenden Wahrheitswert zurückliefern. Bei fehlendem Eigenschaftswert gilt die Bedingung implizit als erfüllt.

ProcessReadIndex[].FileFilter(%)

Namensfilter zur Auswahl der auszulesenden Indexdatei aus den Dateianlagen des Dokumentes

Bei fehlendem Wert wird standardmäßig ein Filterwert gesetzt, der zu dem betreffenden Datenformat passt, z. B. *.json für das JSON-Format.

Für die Extraktion der Indexdaten wird grundsätzlich nur die erste gefundene Dateianlage herangezogen, die dem Filtermuster entspricht. Bei Mehrdeutigkeiten findet zur Ermittlung der Datei eine Priorisierung statt. Eine Datei, die aus den Eingabedaten explizit als Indexdatei oder als Primärdatei bekannt ist, wird im Vergleich zu einer Datei, die eine ergänzende Anlage zu einer solchen Datei ist, priorisiert.

Wenn einem Indexdatenleser gemäß Filter eine Datei übergeben wird, die nicht vom passenden Typ ist, läuft die Verarbeitung in der Regel auf einen Fehler. Nur für die E-Rechnungsformate PEPPOL, XRechnung und ZUGFeRD findet vorab eine explizite Prüfung auf ein gültiges Format statt, um eine Datei zu überspringen, anstatt einen Fehler zu werfen.

ProcessReadIndex[].ReadMultiValues

Wahrheitswert, ob mehrere Werte in ein einzelnes Zielfeld übernommen werden

Standardwert: false (nur der erste Wert wird übernommen)

Diese Eigenschaft ist relevant, wenn für eine Eingabefelddefinition mehrere Werte in einer Indexdatei gefunden werden, das Zielfeld dafür aber ein einzelnes Feld ist. Das kann ein Kopfdatenfeld sein oder auch ein Positionsdatenfeld, wenn innerhalb einer Positionszeile mehrere Werte für ein Feld gefunden werden. Diese Eigenschaft wird von den folgenden Indexdatenlesern unterstützt:

Die Übernahme mehrerer Werte erfolgt in Form eines Arrays, und zwar dynamisch in Abhängigkeit von der Anzahl tatsächlich gelesener Werte. Wenn mehrere Werte gelesen werden, wird somit ein Array übernommen. Wenn nur ein Wert gelesen wird, wird ein Einzelwert übernommen. Bei der Weiterverarbeitung der Werte kann eine Fallunterscheidung erforderlich sein oder eine Konvertierung in ein einheitliches Format. Mit der Prüfung !IsArray() und der anschließenden Ausführung des Makros ToArray() kann ein Einzelwert in ein Array überführt werden. Alternativ kann ein Array mit der Feldmakrofunktion ToText() in einen Einzelwert konvertiert werden, der durch Trennzeichen separiert ist.

ProcessReadIndex[].Field[].Name*

ProcessReadIndex[].Field[].InputName

ProcessReadIndex[].Field[].InputFormat

Definition der Zuordnung von einzulesenden Feldern zu deren Zielfeldern im Feldkatalog

Unter .Name ist der Name des Zielfeldes analog zur gleichnamigen Eigenschaft im Feldkatalog anzugeben. Unter .InputName ist die Definition des betreffenden Quellfeldes aus den Indexdaten anzugeben. Die zu verwendende Syntax ist abhängig vom Datenformat und wird im Kontext des jeweiligen Indexdatenlesers beschrieben.

Wenn die Benennung des Zielfelds im Feldkatalog identisch zu der Benennung des Quellfelds ist, kann der .InputName weggelassen werden. Der Name des Zielfelds wird dann als Standardwert herangezogen. Der Wert kann allerdings nur weggelassen werden, wenn der .InputName abhängig vom Datenformat keine spezielle Syntax erfordert, sondern analog zum Zielfeld aus einem einfachen Feldnamen besteht.

Die Bedeutung eines .InputFormat ist kontextabhängig. Prinzipiell wird ein typisierter Wert aus den Indexdaten unverändert als dieser Typ in das Zielfeld übernommen. Wenn es keine direkte Entsprechung gibt, wird der Wert als ein äquivalenter Typ übernommen. Wenn der Quelltyp ein String ist, der Zieltyp hingegen nicht (Eigenschaft FieldCatalog[].Field[].InitType), wird versucht, den String anhand des definierten Eingabeformats zu parsen und in den gewünschten Zieltyp zu konvertieren. Das ist beispielsweise bei dem generischen XML-Indexdatenleser erforderlich, weil keine XML-Schemata ausgewertet werden und somit alle Indexdaten technisch nur Textzeichenfolgen darstellen. Beim spezialisierten XRechnung-XML-Leser sind die konkreten Indexfelder und deren Datentypen hingegen bekannt und können somit direkt typgerecht eingelesen werden.

Die Syntax für das Eingabeformat ist abhängig vom Zieldatentyp. Wenn kein Eingabeformat definiert ist, wird mit einem generischen Parser versucht, den Indexwert dem Datentyp entsprechend zu interpretieren.

Folgende Syntax ist für die Zieldatentypen zu verwenden: