B2Brouter JSON Schema instellen

De JSON-aanroep definieert welke gegevens naar B2Brouter worden verzonden. Hiervoor wordt een eDocuments-schema in JSON-formaat gebruikt. Het schema bevat alle benodigde JSON-knooppunten en legt vast welke waarden voor de afzonderlijke velden moeten worden bepaald en verzonden.

Document Dispatch biedt een vooraf geconfigureerde standaardstructuur voor de B2Brouter-JSON-aanroep. Deze structuur kan als uitgangspunt worden gebruikt en indien nodig worden aangepast aan individuele vereisten. Na het maken van het schema moet u de opgenomen knooppunten controleren en ervoor zorgen dat alle voor uw gebruiksgeval vereiste velden aanwezig zijn.

Nieuw JSON-schema aanmaken

Maak een nieuw JSON-schema aan om de gegevensstructuur voor de B2Brouter-JSON-aanroep te definiëren. Na het aanmaken kunt u de vooraf gedefinieerde B2Brouter-structuur genereren en vervolgens aanpassen aan uw individuele vereisten.

Volg deze stappen om een nieuw JSON-schema aan te maken:

Start het rolcentrum Document Dispatch - Administrator.
Open via de globale zoekfunctie de pagina XSD-schema's.
Kies Nieuw om een nieuw schema aan te maken.
Geef een willekeurige unieke Code voor het JSON-schema op. De code dient ter identificatie van het schema en om het te onderscheiden van andere schema's.
Voeg optioneel een Beschrijving toe. Deze wordt weergegeven in het schema-overzicht en kan worden gebruikt om het doel of de inhoud van het schema nader te beschrijven.
Kies in het veld Schema Type de waarde JSON.
Voer de actie Schema-regels aanmaken uit om de vooraf gedefinieerde B2Brouter-JSON-structuur te genereren.
Pas de aangemaakte knooppunten en waarden aan volgens uw vereisten.

Info

De door B2Brouter aangeboden structuur kan in de loop van de tijd veranderen. Nieuwe knooppunten of velden kunnen worden toegevoegd. Controleer daarom regelmatig of uw JSON-schema nog aan de huidige vereisten voldoet en vul indien nodig ontbrekende knooppunten aan.

Schema-regels aanmaken

Na de initiële creatie van een JSON-schema worden er nog geen knooppunten weergegeven. Voordat het schema kan worden gebruikt of bewerkt, moeten eerst de vereiste schema-regels worden aangemaakt. Deze definiëren de structuur van het schema en leggen vast welke knooppunten later beschikbaar zijn.

Pas nadat de schema-regels zijn aangemaakt, worden de bijbehorende knooppunten in het schema-overzicht weergegeven en kunnen ze verder worden geconfigureerd.

Volg deze stappen om JSON-schema-regels aan te maken:

Start het rolcentrum Document Dispatch - Administrator.
Open via de globale zoekfunctie de pagina XSD-schema's.
Open het gewenste JSON-schema of maak een nieuw schema aan met behulp van de beschrijving Nieuw JSON-schema aanmaken.
Kies in het menu Gegevens de actie Schema-regels aanmaken.
Bevestig de weergegeven dialoogvensters.
De schema-regels worden aangemaakt en de beschikbare knooppunten worden vervolgens in het schema-overzicht weergegeven.

JSON-waarde type instellen

Voor elk knooppunt kunt u het JSON Value Type instellen. Het waarde type bepaalt in welk formaat de gegevens in de gegenereerde JSON worden weergegeven. Zorg ervoor dat u het type kiest dat bij het betreffende veld past.

String voor tekstwaarden
Number voor numerieke waarden
Boolean voor waar/onwaar-waarden, bijvoorbeeld true/false, Ja/Nee of 1/0

JSON-veld informatie weergeven

Kies een regel in het JSON-schema en voer de actie Informatie uit. De detailinformatie over het geselecteerde JSON-veld wordt in een apart venster weergegeven en helpt u de betekenis en het gebruik van het veld beter te begrijpen.

Waarde aan een knooppunt toevoegen

Aan elk knooppunt kan een waarde worden toegewezen. De invulling gebeurt via een XSD-gegevenswaarde, die tijdens runtime de bijbehorende gegevens uit Business Central in het JSON-bestand overneemt.

Al in de standaardomvang van eDocuments zijn er tal van vooraf gedefinieerde gegevenswaarden beschikbaar die direct kunnen worden geselecteerd en gebruikt. Zo kunnen veel velden zonder extra configuratie-inspanning worden ingevuld.

Info

eDocuments biedt al een verscheidenheid aan standaard-gegevenswaarden. Als een benodigde waarde niet beschikbaar is, kan deze worden aangevuld door een individuele uitbreiding of configuratie.

Volg deze stappen om een waarde aan een knooppunt toe te wijzen:

Start het rolcentrum Document Dispatch - Administrator.
Open via de globale zoekfunctie de pagina XSD-schema's.
Open het gewenste JSON-schema.
Kies het knooppunt waaraan u een waarde wilt toewijzen.
Klik in het veld Waarde op de knop ... om de beschikbare XSD-gegevenswaarden weer te geven.
Kies de gewenste gegevenswaarde.

Info

De contactvelden transport_type_code en document_type_code worden niet rechtstreeks in de afzonderlijke schema-regels beheerd. De waarden worden automatisch overgenomen uit de instellingen van het bijbehorende verzendprofiel.

Wijzigingen aan deze velden moeten daarom in het verzendprofiel worden aangebracht en niet in het JSON-schema.

B2Brouter-JSON testen

Met de actie B2Brouter-JSON testen kunt u controleren of het huidige JSON-schema geldige gegevens voor B2Brouter genereert. Hiervoor wordt uit een geselecteerde factuur een JSON-document aangemaakt en direct via de B2Brouter-API gevalideerd. Zo kunt u configuratie- of mappingfouten al tijdens de opzet herkennen, voordat documenten productief worden verzonden.

Start het rolcentrum Document Dispatch - Administrator.
Open via de globale zoekfunctie de pagina XSD-schema's.
Open het gewenste JSON-schema.
Kies in het menu Gegevens de actie B2Brouter-JSON testen.
Kies een willekeurige factuur en bevestig de selectie.

Het systeem genereert op basis van de geselecteerde factuur de JSON-gegevens en verzendt deze ter validatie naar B2Brouter. Vervolgens wordt de testoverdracht weer verwijderd en het validatieresultaat weergegeven. Zo ontvangt u directe feedback of het JSON-schema voldoet aan de vereisten van B2Brouter.

JSON Exporteren

Met de actie JSON exporteren kunt u direct uit een JSON-schema een JSON-bestand genereren. Hierbij worden de in het schema gedefinieerde knooppunten, structuren en waarden automatisch in aanmerking genomen. Dit maakt een eenvoudige controle van het schema mogelijk, evenals de creatie van voorbeeld- of testbestanden voor verdere validaties en integraties.

Volg deze stappen om een JSON te exporteren:

Start het rolcentrum Document Dispatch - Administrator.
Open via de globale zoekfunctie de pagina XSD-schema's.
Open het gewenste JSON-schema.
Kies in het menu Gegevens de actie JSON Exporteren.
Kies een willekeurige factuur en bevestig de selectie.
Het gegenereerde JSON-bestand wordt opgeslagen in uw downloadmap.

Schema-gegevens-zoek

Met de Schema-gegevens-zoek kunt u gericht naar knooppunten binnen een JSON-schema zoeken en deze snel in de schema-structuur vinden.

Volg deze stappen om de Schema-gegevens-zoek te gebruiken:

Start het rolcentrum Document Dispatch - Administrator.
Open via de globale zoekfunctie de pagina XSD-schema's.
Open het gewenste JSON-schema.
Navigeer naar het veld Schema-gegevens-zoek.
Voer de naam van het gewenste knooppunt of een deel van de knooppuntnaam in het zoekveld in.
De zoekopdracht wordt uitgevoerd met de Enter-toets of door het veld te verlaten. Als er een passend knooppunt in het schema wordt gevonden, wordt dit automatisch in de schema-structuur weergegeven.

Opmerking

U kunt de Schema-gegevens-zoek ook gebruiken om gericht naar Business-Transaction-velden (BT-velden) te zoeken. Hierdoor kunnen de bijbehorende knooppunten binnen het JSON-schema snel worden gevonden.

Verknüpfte gegevens

Met de verknüpfte gegevens kunnen waarden voor de schema-verwerking worden opgeslagen en beheerd. Deze waarden kunnen worden gebruikt om informatie te verstrekken, ontbrekende gegevens aan te vullen of bestaande waarden tijdens de creatie van het XML- of JSON-bestand door andere waarden te vervangen.

Hierdoor kunnen schema's flexibel worden aangepast aan individuele vereisten en kan een consistente uitvoer van de gegevens worden gegarandeerd. Verknüpfte gegevens worden met name gebruikt voor schema-knooppunten die bepaalde waarden vereisen of waarvan de inhoud afhankelijk van gedefinieerde regels moet worden aangepast.

Volg deze stappen om gegevens aan te passen:

Start het rolcentrum Document Dispatch - Administrator.
Open via de globale zoekfunctie de pagina XSD-schema's.
Open het gewenste JSON-schema.
Kies in het menu Gegevens de actie Verknüpfte gegevens.

Hier kunt u bestaande vermeldingen bewerken of nieuwe toewijzingen aanmaken. De gedefinieerde waarden worden automatisch in aanmerking genomen bij de creatie van het XML- of JSON-bestand en worden toegepast volgens de opgeslagen regels.

Zie ook

B2Brouter verzendprofiel instellen