Skip to main content

xSuite Interface Windows Prism 5.x – Online-Hilfe

Eingabeformat "Json"

Dieses Eingabeformat ermöglicht die Auftrennung einer JSON-Datei, die einen Dokumentenstapel repräsentiert, in die Einzeldokumente. Außerdem ermöglicht dieses Eingabeformat das Extrahieren oder Hinzufügen von zugehörigen Dateianlagen zur JSON-Datei.

Eigenschaft

Beschreibung

InputFormat[].DocProperty

optionale Definition der Eigenschaft in einer JSON-Datei, anhand derer diese Datei in separate dokumentspezifische Teile zertrennt wird

Standardmäßig wird davon ausgegangen, dass eine JSON-Datei nur ein Dokument enthält.

Bei der Aufteilung wird das Ursprungsdokument verworfen und stattdessen für jedes neue Teildokument eine Kopie des Ursprungsdokuments generiert. Der dokumentspezifische Teil der ursprünglichen JSON-Datei wird der Kopie als weitere Anlage hinzugefügt.

Das Dokument und die Anlage erhalten den Namenszusatz .splitN, wobei N eine laufende Nummer darstellt.

Als Syntax für die Angabe der Eigenschaft ist JSONPath zu verwenden. Dies ist die gleiche Syntax, die auch für die Extraktion von Indexdaten verwendet wird (siehe JSON-Indexdatenleser). Wenn das JSON-Objekt beispielsweise ein Documents-Array mit den einzelnen Dokumenten enthält, kann der Eigenschaftswert $.Documents lauten.

{ "Documents": [ {…}, {…} ] }

InputFormat[].AttachFileMode

Modus, wie zusätzliche Dateianlagen aus der JSON-Datei extrahiert oder zu dieser hinzugefügt werden:

  • None: kein Extrahieren/Hinzufügen (Standardwert)

  • Name: anhand des Namens der JSON-Datei

  • Reference: anhand der Referenz in der JSON-Datei

  • Embedded: Binärdaten eingebettet in die JSON-Datei

Die Modi Name und Reference erfordern eine dateisystembasierte Eingabe der JSON-Datei, da auch die zusätzlichen Dateianlagen nur im Dateisystem gesucht werden.

InputFormat[].AttachFileProperty(*)

Diese Eigenschaft ist für die Modi Reference und Embedded relevant.

Teilparameter in JSONPath-Syntax für die Definition der Eigenschaften, die Daten zu den Dateianlagen enthalten

  1. File*: relativer/absoluter Dateipfad bzw. Base64-kodierte Binärdaten der Dateianlage

  2. Name: Name der Dateianlage

  3. Type: Typ oder MIME-Typ der Dateianlage

Die Parameter 2 und 3 sind nur für den Modus Embedded relevant. Hier sind für sämtliche Parameter absolute Pfade anzugeben, da die JSONPath-Syntax keine Referenz auf das übergeordnete Element kennt.

Weitere Teilparameter frei wählbaren Namens sind zulässig. Diese Parameter werden den Dateianlagen als Metadaten hinzugefügt.

InputFormat[].AttachFileRefMacro(*)

Feldmakroausdruck, der im Modus Name einen Dateinamen oder ein Namensmuster, optional auch mit relativem/absolutem Ordnerpfad, zurückliefern muss, um die Dateianlagen zu finden

Dieser Ausdruck kann optional auch im Modus Reference genutzt werden, um den extrahierten Wert inhaltlich aufzubereiten.

In dem Makroausdruck sind Dateivariablen wie FilePath, FileName und FileBaseName nutzbar, die sich auf die JSON-Datei beziehen. Mit @FileBaseName + ".pdf" kann beispielsweise eine PDF-Datei referenziert werden, die den gleichen Basisnamen hat wie die JSON-Datei.

In diesem Abschnitt: