Zum Inhalt

B2Brouter JSON Schema einrichten

Die JSON-Anfrage definiert, welche Daten an B2Brouter übermittelt werden. Hierzu wird ein eDocuments-Schema im JSON-Format verwendet. Das Schema enthält alle benötigten JSON-Knoten und legt fest, welche Werte für die einzelnen Felder ermittelt und übertragen werden.

Document Dispatch stellt eine vorkonfigurierte Standardstruktur für die B2Brouter-JSON-Anfrage bereit. Diese Struktur kann als Ausgangspunkt verwendet und bei Bedarf an individuelle Anforderungen angepasst werden. Nach der Erstellung des Schemas sollten Sie die enthaltenen Knoten prüfen und sicherstellen, dass alle für Ihren Anwendungsfall erforderlichen Felder vorhan

Neues JSON-Schema erstellen

Erstellen Sie ein neues JSON-Schema, um die Datenstruktur für die B2Brouter-JSON-Anfrage zu definieren. Nach der Erstellung können Sie die vordefinierte B2Brouter-Struktur erzeugen und anschließend an Ihre individuellen Anforderungen anpassen.

Folgen Sie diesen Schritten, um ein neues JSON-Schema zu erstellen:

  1. Starten Sie das Rollencenter Document Dispatch - Administrator.
  2. Öffnen Sie über die globale Suche die Seite XSD-Schemata.
  3. Wählen Sie Neu aus, um ein neues Schema anzulegen.
  4. Geben Sie einen beliebigen eindeutigen Code für das JSON-Schema an. Der Code dient zur Identifikation des Schemas und zur Unterscheidung von anderen Schemata.
  5. Hinterlegen Sie optional eine Beschreibung. Diese wird in der Schemaübersicht angezeigt und kann verwendet werden, um den Verwendungszweck oder Inhalt des Schemas näher zu beschreiben.
  6. Wählen Sie im Feld Schema Typ den Wert JSON aus.
  7. Führen Sie die Aktion Schemazeilen erstellen aus, um die vordefinierte B2Brouter-JSON-Struktur zu erzeugen.
  8. Passen Sie die erzeugten Knoten und Werte entsprechend Ihren Anforderungen an.

Info

Die von B2Brouter bereitgestellte Struktur kann sich im Laufe der Zeit ändern. Neue Knoten oder Felder können hinzugefügt werden. Prüfen Sie daher regelmäßig, ob Ihr JSON-Schema noch den aktuellen Anforderungen entspricht und ergänzen Sie bei Bedarf fehlende Knoten.

Schemazeilen erstellen

Nach der initialen Erstellung eines JSON-Schemas werden noch keine Knoten angezeigt. Bevor das Schema verwendet oder bearbeitet werden kann, müssen zunächst die erforderlichen Schema-Zeilen erstellt werden. Diese definieren die Struktur des Schemas und legen fest, welche Knoten später verfügbar sind.

Erst nach dem Anlegen der Schema-Zeilen werden die entsprechenden Knoten in der Schemaübersicht angezeigt und können weiter konfiguriert werden.

Folgen Sie diesen Schritten, um JSON-Schema-Zeilen zu erstellen:

  1. Starten Sie das Rollencenter Document Dispatch - Administrator.
  2. Öffnen Sie über die globale Suche die Seite XSD-Schemata.
  3. Öffnen Sie das gewünschte JSON-Schema oder erstellen Sie ein neues Schema mithilfe der Beschreibung Neues JSON-Schema erstellen.
  4. Wählen Sie im Menü Daten die Aktion Schema-Zeilen erstellen aus.
  5. Bestätigen Sie die angezeigten Dialogfenster.
  6. Die Schema-Zeilen werden erstellt und die verfügbaren Knoten anschließend in der Schemaübersicht angezeigt.

JSON-Werttyp festlegen

Für jeden Knoten können Sie den JSON Value Type festlegen. Der Werttyp bestimmt, in welchem Format die Daten im erzeugten JSON ausgegeben werden. Achten Sie darauf, den zum jeweiligen Feld passenden Typ auszuwählen.

  • String für Textwerte
  • Number für numerische Werte
  • Boolean für Wahr-/Falsch-Werte, beispielsweise true/false, Ja/Nein oder 1/0

JSON-Feldinformationen anzeigen

Wählen Sie eine Zeile im JSON-Schema aus und führen Sie die Aktion Information aus. Die Detailinformationen zum ausgewählten JSON-Feld werden in einem separaten Fenster angezeigt und helfen Ihnen, Bedeutung und Verwendung des Feldes besser zu verstehen.

Wert zu einem Knoten hinzufügen

Jedem Knoten kann ein Wert zugewiesen werden. Die Befüllung erfolgt über einen XSD-Datenwert, der zur Laufzeit die entsprechenden Daten aus Business Central in die JSON-Datei übernimmt.

Bereits im Standardumfang von eDocuments stehen zahlreiche vordefinierte Datenwerte zur Verfügung, die direkt ausgewählt und verwendet werden können. So lassen sich viele Felder ohne zusätzlichen Konfigurationsaufwand befüllen.

Info

eDocuments stellt bereits eine Vielzahl von Standard-Datenwerten zur Verfügung. Sollte ein benötigter Wert nicht verfügbar sein, kann dieser durch eine individuelle Erweiterung oder Konfiguration ergänzt werden.

Folgen Sie diesen Schritten, um einem Knoten einen Wert zuzuweisen:

  1. Starten Sie das Rollencenter Document Dispatch - Administrator.
  2. Öffnen Sie über die globale Suche die Seite XSD-Schemata.
  3. Öffnen Sie das gewünschte JSON-Schema.
  4. Wählen Sie den Knoten aus, dem Sie einen Wert zuweisen möchten.
  5. Klicken Sie im Feld Wert auf die Schaltfläche ..., um die verfügbaren XSD-Datenwerte anzuzeigen.
  6. Wählen Sie den gewünschten Datenwert aus.

Info

Die Kontaktfelder transport_type_code und document_type_code werden nicht direkt in den einzelnen Schemazeilen gepflegt. Die Werte werden automatisch aus den Einstellungen des zugeordneten Versandprofils übernommen.

Änderungen an diesen Feldern müssen daher im Versandprofil vorgenommen werden und nicht im JSON-Schema.

B2Brouter-JSON testen

Mit der Aktion B2Brouter-JSON testen können Sie prüfen, ob das aktuelle JSON-Schema gültige Daten für B2Brouter erzeugt. Hierzu wird aus einem ausgewählten Beleg ein JSON-Dokument erstellt und direkt über die B2Brouter-API validiert. So können Sie Konfigurations- oder Mappingfehler bereits während der Einrichtung erkennen, bevor Dokumente produktiv versendet werden.

  1. Starten Sie das Rollencenter Document Dispatch - Administrator.
  2. Öffnen Sie über die globale Suche die Seite XSD-Schemata.
  3. Öffnen Sie das gewünschte JSON-Schema.
  4. Wählen Sie im Menü Daten die Aktion B2Brouter-JSON testen.
  5. Wählen Sie eine beliebige Rechnung aus und bestätigen Sie die Auswahl.

Das System erstellt auf Basis des ausgewählten Belegs die JSON-Daten und übermittelt diese zur Validierung an B2Brouter. Anschließend wird die Testübertragung wieder entfernt und das Validierungsergebnis angezeigt. So erhalten Sie eine direkte Rückmeldung, ob das JSON-Schema den Anforderungen von B2Brouter entspricht.

JSON Exportieren

Mit der Aktion JSON exportieren können Sie direkt aus einem JSON-Schema eine JSON-Datei generieren. Dabei werden die im Schema definierten Knoten, Strukturen und Werte automatisch berücksichtigt. Dies ermöglicht eine einfache Prüfung des Schemas sowie die Erstellung von Beispiel- oder Testdateien für weitere Validierungen und Integrationen.

Folgen Sie diesen Schritten, um eine JSON zu exportieren:

  1. Starten Sie das Rollencenter Document Dispatch - Administrator.
  2. Öffnen Sie über die globale Suche die Seite XSD-Schemata.
  3. Öffnen Sie das gewünschte JSON-Schema.
  4. Wählen Sie im Menü Daten die Aktion JSON Exportieren.
  5. Wählen Sie eine beliebige Rechnung aus und bestätigen Sie die Auswahl.
  6. Die generierte JSON-Datei wird in Ihrem Downloadordner gespeichert.

Schema-Daten-Suche

Mit der Schema-Daten-Suche können Sie gezielt nach Knoten innerhalb eines JSON-Schemas suchen und diese schnell in der Schema-Struktur finden.

Folgen Sie diesen Schritten, um die Schema-Daten-Suche zu nutzen:

  1. Starten Sie das Rollencenter Document Dispatch - Administrator.
  2. Öffnen Sie über die globale Suche die Seite XSD-Schemata.
  3. Öffnen Sie das gewünschte JSON-Schema.
  4. Navigieren Sie zum Feld Schema-Daten-Suche.
  5. Geben Sie den Namen des gewünschten Knotens oder einen Teil des Knotennamens in das Suchfeld ein.
  6. Die Suche wird mit der Enter oder durch verlassen des Feldes ausgeführt. Wird ein passender Knoten im Schema gefunden, wird dieser automatisch in der Schema-Struktur angezeigt.

Hinweis

Sie können die Schema-Daten-Suche auch verwenden, um gezielt nach Business-Transaction-Feldern (BT-Feldern) zu suchen. Dadurch lassen sich die zugehörigen Knoten innerhalb des JSON-Schemas schnell auffinden.

Verknüfte Daten

Mit den verknüpften Daten können Werte für die Schema-Verarbeitung hinterlegt und verwaltet werden. Diese Werte können verwendet werden, um Informationen bereitzustellen, fehlende Angaben zu ergänzen oder bestehende Werte während der Erstellung der XML- oder JSON-Datei durch andere Werte zu ersetzen.

Dadurch lassen sich Schemata flexibel an individuelle Anforderungen anpassen und eine konsistente Ausgabe der Daten sicherstellen. Verknüpfte Daten werden insbesondere für Schema-Knoten verwendet, die bestimmte Werte benötigen oder deren Inhalt abhängig von definierten Regeln angepasst werden soll.

Folgen Sie diesen Schritten um Daten anzupassen:

  1. Starten Sie das Rollencenter Document Dispatch - Administrator.
  2. Öffnen Sie über die globale Suche die Seite XSD-Schemata.
  3. Öffnen Sie das gewünschte JSON-Schema.
  4. Wählen Sie im Menü Daten die Aktion Verknüpfte Daten.

Hier können Sie bestehende Einträge bearbeiten oder neue Zuordnungen anlegen. Die definierten Werte werden bei der Erstellung der XML- oder JSON-Datei automatisch berücksichtigt und entsprechend den hinterlegten Regeln angewendet.

Siehe auch