JSON Converter 2.0
Arbeiten mit JSON-Dateien in der X4 Suite
JSON ist ein Dateiformat zur Übertragung von Datenobjekten. Ein Datenobjekt besteht aus Attribut-Wert-Paarungen und Array-Datentypen. JSON ist bei der asynchronen Kommunikation zwischen Browser und Server sehr verbreitet.
In diesem Tutorial erfahren Sie, wie Sie mit dem JSON Converter 2.0 der X4 Suite JSON-Datei in eine XML-Datei und umgekehrt konvertieren können. Dafür bietet der Adapter verschiedene Operationen.
Sie können ein Template zu diesem Tutorial über den Button herunterladen. Entpacken Sie einfach die .zip-Datei und ziehen Sie das Template mit der Dateiendung .x4projecttemplate per Drag & Drop in den Repository Navigator des X4 Designers.
Anwendungsfall
Mit JSON-Dateien arbeiten
X4 Suite-Komponenten
X4 Suite-Adapter
Voraussetzungen
Sie benötigen:
- X4 Suite in Version 6.0 oder höher
- Eine JSON-Datei, die Sie in eine XML-Datei umwandeln. Im Download-Paket zu diesem Tutorial ist die Beispieldatei MediaCollection.json enthalten.
- Eine XML-Datei, die Sie in eine JSON-Datei umwandeln. Im Download-Paket zu diesem Tutorial ist die Beispieldatei MediaCollection.xml enthalten.
Projekt erstellen
Erstellen Sie ein neues ESB-Projekt mit dem Namen JSONConverter.
Fügen Sie die Datei, die Sie umwandeln möchten, per Drag & Drop dem Ordner Resources hinzu.
JSON nach XML konvertieren
In diesem Abschnitt erfahren Sie, welche Schritte notwendig sind, um eine JSON-Datei in eine XML-Datei zu konvertieren.
Legen Sie einen JSON Converter 2.0 mit dem Namen JSON_To_XML_Adapter.fa an.
Der Adapter wird im Adapter Editor geöffnet und die möglichen Parameter werden angezeigt.
Nehmen Sie die Parametrierung des Adapters so vor, dass eine JSON-Datei in eine XML-Datei umgewandelt wird.
Für unser Beispiel müssen folgende Parameter gesetzt werden:
allowBareObjectKeys: Deaktiviert - Erlaubt keine Object Keys, die nicht in Anführungszeichen stehen.escapeStringsInXML: Aktiviert - Nicht-XML-Zeichen werden escaped.emptyStringAsNull: Deaktiviert - Leere Zeichenketten werden nicht als null ausgegeben.
TIPP: Über das Menü Help > X4 Suite Help und der anschließenden Suche nach dem JSON Converter 2.0 rufen Sie die Hilfe zum Adapter auf.
Erstellen Sie eine leere XML-Datei mit dem Namen MediaCollectionOutputXML.xml.
INFO: Die Datei enthält außer der XML-Deklaration und einem Wurzelelement keinen Inhalt. Der Inhalt wird später durch den Prozess erzeugt und geschrieben.
Erstellen Sie einen neuen Prozess ConvertJSONToXML.
Fügen Sie die JSON-Datei, die Sie in eine XML-Datei umwandeln möchten, per Drag & Drop aus dem X4 Repository zum Prozess hinzu.
INFO: Die Datei-Property Operation ist standardmäßig auf Read. Somit muss die Property zum Einlesen der Datei nicht mehr verändert werden.
Fügen Sie den bereits parametrierten Adapter JSON_To_XML_Adapter.fa per Drag & Drop aus dem X4 Repository zum Prozess hinzu und setzen Sie die Adapter-Property Operation auf JSON2XML.
Fügen Sie die leere XML-Datei MediaCollectionOutput.xml per Drag & Drop aus dem X4 Repository zum Prozess hinzu und setzen Sie die Property Operation auf Write.
INFO: Dateien mit der Property Operation Write werden jedes Mal überschrieben, wenn der Adapter einen neuen Output generiert.
Der modellierte Prozess sieht nun so aus:
Speichern Sie den Prozess.
Führen Sie den Prozess mit Start without debugging aus und testen Sie das Ergebnis.
Der Prozess erzeugt eine XML-Datei, die die konvertierten JSON-Daten enthält.
TIPP: Wenn Sie den Prozess im Debug-Modus ausführen, können Sie das Ergebnis jedes einzelnen Prozessschrittes nachvollziehen.
Sie wissen nun, wie Sie den JSON Converter 2.0 verwenden können, um eine JSON-Datei in eine XML-Datei umzuwandeln.
XML nach JSON konvertieren
In diesem Abschnitt erfahren Sie, welche Schritte notwendig sind, um eine XML-Datei in eine JSON-Datei zu konvertieren.
Legen Sie einen JSON Converter 2.0 mit dem Namen XML_To_JSON_Adapter.fa an.
Der Adapter wird im Adapter Editor geöffnet und die möglichen Parameter werden angezeigt.
Nehmen Sie die Parametrierung des Adapters so vor, dass eine XML-Datei in eine JSON-Datei umgewandelt wird.
Für unser Beispiel müssen folgende Parameter gesetzt werden:
allowBareObjectKeys: Deaktiviert - Erlaubt keine Object Keys, die nicht in Anführungszeichen stehen. Legt fest, wie Object Keys, die nicht in Anführungszeichen stehen, behandelt werden.escapeStringsInXML: Deaktiviert - Nicht-XML-Zeichen werden gefiltert.emptyStringAsNull: Aktiviert - Leere Zeichenketten werden als null ausgegeben.
TIPP: Über das Menü Help > X4 Suite Help und der anschließenden Suche nach dem JSON Converter 2.0 rufen Sie die Hilfe zum Adapter auf.
Erstellen Sie eine leere JSON-Datei (Textdatei) mit dem Namen MediaCollectionOutputJSON.json.
INFO: Die Datei enthält keinen Inhalt. Der Inhalt wird später durch den Prozess erzeugt und geschrieben.
Erstellen Sie einen neuen Prozess ConvertXMLToJSON.
Fügen Sie die XML-Datei, die Sie in eine JSON-Datei umwandeln möchten, per Drag & Drop aus dem X4 Repository zum Prozess hinzu.
INFO: Die Property Operation ist standardmäßig auf Read. Somit muss die Property zum Einlesen der Datei nicht mehr verändert werden.
Fügen Sie den bereits parametrierten Adapter XML_To_JSON_Adapter.fa per Drag & Drop aus dem X4 Repository zum Prozess hinzu und setzen Sie die Adapter-Property Operation auf XML2JSON.
Fügen Sie die leere JSON-Datei MediaCollectionOutputJSON.json per Drag & Drop aus dem X4 Repository zum Prozess hinzu und setzen Sie die Property Operation auf Write.
INFO: Dateien mit der Property Operation Write werden jedes Mal überschrieben, wenn der Adapter einen neuen Output generiert.
Der modellierte Prozess sieht nun so aus:
Speichern Sie den Prozess.
Führen Sie den Prozess mit Start without debugging aus und testen Sie das Ergebnis.
Der Prozess erzeugt eine JSON-Datei, die die konvertierten XML-Daten enthält.
TIPP: Wenn Sie den Prozess im Debug-Modus ausführen, können Sie das Ergebnis jedes einzelnen Prozessschrittes nachvollziehen.
Sie wissen nun, wie Sie den JSON Converter 2.0 verwenden können, um eine XML-Datei in eine JSON-Datei umzuwandeln.