Zum Inhalt

eDocuments-Schema

Erstellung eines eDocuments-Schemas

Um ein neues eDocuments-Schema in Business Central zu erstellen, gehen Sie wie folgt vor:

  1. Öffnen Sie Microsoft Dynamics 365 Business Central.
  2. Klicken Sie im Rollencenter auf das Suchsymbol (Lupe).
  3. Geben Sie „eDocuments-Schema“ in das Suchfeld ein.
  4. Wählen Sie die Aktion Neu aus.
  5. Ein leeres eDocuments-Schema wird erstellt.
  6. Wählen Sie den Schematyp aus. Wählen Sie XML für eine XML-Ausgabe oder JSON für eine JSON-Ausgabe.
  7. Sie können das Schema nun nach Ihren Anforderungen konfigurieren.

Info

Es stehen auch vordefinierte Schemata zur Verfügung, die über den Document Dispatch Konfigurationsassistenten importiert werden können.

Update Schema Lines

Zunächst werden neue Data Types definiert. Diese neu angelegten Data Types können anschließend über Update Schema Lines in das bestehende Schema übernommen werden. Während dieses Vorgangs werden die vorhandenen Schema Lines entsprechend verschoben, um Platz für die neu hinzugefügten Zeilen zu schaffen. Dadurch bleibt die bestehende Wertezuordnung unverändert, während lediglich die Struktur der Schema Lines aktualisiert wird.

Schematyp

Das Feld Schematyp legt fest, ob das Schema für eine XML- oder JSON-Ausgabe verwendet wird. Das Feld ist in der Schemaliste und auf der Schemaseite verfügbar.

Wenn der Schematyp geändert wird, aktualisiert sich die Seite automatisch. XML-spezifische Bereiche werden bei JSON-Schemata ausgeblendet, während JSON-spezifische Felder und Aktionen verfügbar werden.

Bei JSON-Schemata wird der Bereich Use UBL ausgeblendet. JSON-bezogene Felder im Versandprofil werden mit den für die B2Brouter-Ausgabe erforderlichen Standardwerten vorbelegt. Der Transport Type Code wird auf peppol gesetzt und der Document Type Code auf xml.ubl.invoice.bis3. Diese Felder können im JSON-Modus nicht bearbeitet werden.

Standardschemazeilen erstellen

Die Aktion zum Erstellen von Standardschemaknoten unterstützt XML- und JSON-Schemata.

  • Bei XML-Schemata erstellt die Aktion die Standardzeilen für das XML-Schema.
  • Bei JSON-Schemata erstellt die Aktion die Standardzeilen für das JSON-Schema.

Wenn bereits Standardzeilen für ein JSON-Schema vorhanden sind, kann das System fragen, ob die vorhandenen Zeilen gelöscht und neu erstellt werden sollen. Wenn Sie diese Bestätigung ablehnen, bleiben die vorhandenen Schemazeilen unverändert.

JSON-Schemazeilen konfigurieren

JSON-Schemazeilen enthalten das Feld JSON Value Type. Dieses Feld steuert, wie der Wert in die JSON-Ausgabe geschrieben wird:

JSON Value Type Verhalten in der JSON-Ausgabe
String Der Wert wird mit Anführungszeichen geschrieben.
Number Der Wert wird ohne Anführungszeichen geschrieben. Wenn der Wert nicht als Zahl gelesen werden kann, wird 0 ausgegeben.
Boolean Der Wert wird als true oder false ohne Anführungszeichen geschrieben. Werte wie true, 1, yes und ja werden als true behandelt.

JSON-Schemata können verschachtelte Objekte und Arrays enthalten. Dies wird zum Beispiel für Rechnungszeilen, Steuern, Zu- und Abschläge, Zahlungsfälligkeiten, Rechnungsreferenzen, zusätzliche Artikeleigenschaften, Kontakte, Bankkonten, Dritte und Belegreferenzen verwendet.

Bei Array-Strukturen kann eDocuments die Array-Einträge anhand des eingerichteten Datenmappings wiederholen. Wenn für ein Array kein Mapping eingerichtet ist, wird ein einzelner Array-Eintrag erstellt.

Optionale JSON-Knoten und Eigenschaften werden übersprungen, wenn kein Wert oder Standardwert vorhanden ist und die Mindestanzahl auf 0 gesetzt ist.

JSON-Feldinformationen

Bei JSON-Schemazeilen zeigt die Aktion Information eine Beschreibung des ausgewählten JSON-Felds auf Basis der B2Brouter-API-Spezifikation an. Dadurch können Administratoren direkt auf der Schemaseite nachvollziehen, welches Feld sie konfigurieren.

Schemadatensuche

Die Schemadatensuche ist eine Funktion innerhalb des eDocuments-Schemas. Sie dient dazu, die Navigation und das Auffinden spezifischer Schemadaten erheblich zu erleichtern. Besonders bei komplexen oder umfangreichen Schemata ist die Suche eine essenzielle Hilfe, um gezielt nach Einträgen zu suchen und deren Struktur nachvollziehen zu können.

Durch den Einsatz der Suche kann nach dem Namen oder dem Wert einzelner Schemadaten gefiltert werden. Wird ein Treffer gefunden, zeigt das System zusätzlich auch die zugehörigen untergeordneten Elemente (Subkategorien) an, um die Daten im strukturellen Kontext besser verstehen zu können.

Verwendung der Schema-Daten-Suche

Um die Schema-Daten-Suche innerhalb eines eDocuments-Schemas zu nutzen, gehen Sie wie folgt vor:

  1. Öffnen Sie über die Suche den Eintrag „Simova Apps eDocuments - Schema“.
  2. Wählen Sie das gewünschte Schema aus der Liste aus.
  3. Die Schema-Daten-Suche befindet sich im Bereich „General“.
  4. Bitte beachten Sie, dass die Suche groß- und kleinschreibungssensitiv ist.
  5. Geben Sie den gewünschten Suchbegriff ein und drücken Sie Enter, um die Suche zu starten.
  6. Die Suchergebnisse zeigen alle passenden Einträge inklusive ihrer untergeordneten Elemente an. So können Sie gezielt nach bestimmten Datenstrukturen innerhalb des Schemas suchen.

Info

  • Die Suchfunktion unterscheidet zwischen Groß- und Kleinschreibung.
  • Die Suche ist nur auf die Daten innerhalb des aktuell geöffneten eDocuments-Schemas beschränkt.
  • Werden keine Ergebnisse angezeigt, überprüfen Sie bitte die Schreibweise oder den Umfang des eingegebenen Suchbegriffs.

Funktionsweise

Die Suche durchsucht die im eDocuments-Schema enthaltenen Schemadaten dynamisch nach den eingegebenen Begriffen. Dabei werden sowohl Bezeichner (z. B. Elementnamen) als auch zugewiesene Werte berücksichtigt – sofern diese vorhanden sind.

Nutzung der Suche

So verwenden Sie die Schemadatensuche:

Geben Sie einen Suchbegriff ein. Daraufhin werden alle passenden Einträge inklusive ihrer untergeordneten Elemente angezeigt. Dies ermöglicht eine gezielte Analyse und erleichtert die Bearbeitung der Datenstruktur.

Suche zurücksetzen

Um die Suche zurückzusetzen und alle Schemadaten erneut vollständig anzuzeigen, löschen Sie einfach den eingegebenen Text aus dem Suchfeld. Das System aktualisiert daraufhin automatisch die Ansicht und zeigt alle verfügbaren Einträge uneingeschränkt an.