Configuration du schéma JSON de B2Brouter
La demande JSON définit quelles données sont transmises à B2Brouter. Pour cela, un schéma eDocuments au format JSON est utilisé. Le schéma contient tous les nœuds JSON nécessaires et précise quelles valeurs doivent être déterminées et transmises pour chaque champ.
Document Dispatch fournit une structure standard préconfigurée pour la demande JSON de B2Brouter. Cette structure peut être utilisée comme point de départ et adaptée aux exigences individuelles si nécessaire. Après la création du schéma, vous devez vérifier les nœuds inclus et vous assurer que tous les champs nécessaires pour votre cas d'utilisation sont présents.
Créer un nouveau schéma JSON
Créez un nouveau schéma JSON pour définir la structure des données pour la demande JSON de B2Brouter. Après la création, vous pouvez générer la structure B2Brouter prédéfinie et ensuite l'adapter à vos exigences individuelles.
Suivez ces étapes pour créer un nouveau schéma JSON :
- Démarrez le centre de rôles Document Dispatch - Administrator.
- Ouvrez la page XSD-Schemata via la recherche globale.
- Sélectionnez Nouveau pour créer un nouveau schéma.
- Indiquez un Code unique pour le schéma JSON. Le code sert à identifier le schéma et à le distinguer des autres schémas.
- Facultativement, fournissez une Description. Celle-ci sera affichée dans l'aperçu du schéma et peut être utilisée pour décrire l'objectif ou le contenu du schéma.
- Dans le champ Type de schéma, sélectionnez la valeur JSON.
- Exécutez l'action Créer des lignes de schéma pour générer la structure JSON prédéfinie de B2Brouter.
- Adaptez les nœuds et valeurs générés selon vos besoins.
Info
La structure fournie par B2Brouter peut changer au fil du temps. De nouveaux nœuds ou champs peuvent être ajoutés. Vérifiez donc régulièrement si votre schéma JSON répond encore aux exigences actuelles et complétez les nœuds manquants si nécessaire.
Créer des lignes de schéma
Après la création initiale d'un schéma JSON, aucun nœud n'est encore affiché. Avant que le schéma puisse être utilisé ou modifié, les lignes de schéma requises doivent d'abord être créées. Celles-ci définissent la structure du schéma et précisent quels nœuds seront disponibles par la suite.
Ce n'est qu'après la création des lignes de schéma que les nœuds correspondants seront affichés dans l'aperçu du schéma et pourront être configurés davantage.
Suivez ces étapes pour créer des lignes de schéma JSON :
- Démarrez le centre de rôles Document Dispatch - Administrator.
- Ouvrez la page XSD-Schemata via la recherche globale.
- Ouvrez le schéma JSON souhaité ou créez un nouveau schéma en utilisant la description Créer un nouveau schéma JSON.
- Dans le menu Données, sélectionnez l'action Créer des lignes de schéma.
- Confirmez les fenêtres de dialogue affichées.
- Les lignes de schéma sont créées et les nœuds disponibles sont ensuite affichés dans l'aperçu du schéma.
Définir le type de valeur JSON
Pour chaque nœud, vous pouvez définir le Type de valeur JSON. Le type de valeur détermine dans quel format les données seront émises dans le JSON généré. Assurez-vous de sélectionner le type approprié pour chaque champ.
- String pour les valeurs textuelles
- Number pour les valeurs numériques
- Boolean pour les valeurs vrai/faux, par exemple
true/false,Oui/Nonou1/0
Afficher les informations sur les champs JSON
Sélectionnez une ligne dans le schéma JSON et exécutez l'action Information. Les détails concernant le champ JSON sélectionné s'affichent dans une fenêtre séparée et vous aident à mieux comprendre la signification et l'utilisation du champ.
Ajouter une valeur à un nœud
Une valeur peut être attribuée à chaque nœud. Le remplissage se fait via une valeur de données XSD, qui récupère les données correspondantes de Business Central dans le fichier JSON à l'exécution.
De nombreuses valeurs de données prédéfinies sont déjà disponibles dans l'étendue standard d'eDocuments, qui peuvent être sélectionnées et utilisées directement. Ainsi, de nombreux champs peuvent être remplis sans effort de configuration supplémentaire.
Info
eDocuments fournit déjà une multitude de valeurs de données standard. Si une valeur nécessaire n'est pas disponible, elle peut être complétée par une extension ou une configuration individuelle.
Suivez ces étapes pour attribuer une valeur à un nœud :
- Démarrez le centre de rôles Document Dispatch - Administrator.
- Ouvrez la page XSD-Schemata via la recherche globale.
- Ouvrez le schéma JSON souhaité.
- Sélectionnez le nœud auquel vous souhaitez attribuer une valeur.
- Cliquez sur le bouton ... dans le champ Valeur pour afficher les valeurs de données XSD disponibles.
- Sélectionnez la valeur de données souhaitée.
Info
Les champs de contact transport_type_code et document_type_code ne sont pas directement gérés dans les lignes de schéma individuelles. Les valeurs sont automatiquement récupérées à partir des paramètres du profil d'expédition associé.
Les modifications apportées à ces champs doivent donc être effectuées dans le profil d'expédition et non dans le schéma JSON.
Tester le JSON de B2Brouter
Avec l'action Tester le JSON de B2Brouter, vous pouvez vérifier si le schéma JSON actuel génère des données valides pour B2Brouter. Pour cela, un document JSON est créé à partir d'un document sélectionné et validé directement via l'API de B2Brouter. Vous pouvez ainsi détecter les erreurs de configuration ou de mappage dès la configuration, avant que les documents ne soient envoyés en production.
- Démarrez le centre de rôles Document Dispatch - Administrator.
- Ouvrez la page XSD-Schemata via la recherche globale.
- Ouvrez le schéma JSON souhaité.
- Dans le menu Données, sélectionnez l'action Tester le JSON de B2Brouter.
- Sélectionnez une facture quelconque et confirmez la sélection.
Le système crée les données JSON sur la base du document sélectionné et les transmet à B2Brouter pour validation. Ensuite, le transfert de test est supprimé et le résultat de la validation est affiché. Vous recevez ainsi un retour direct sur la conformité du schéma JSON aux exigences de B2Brouter.
Exporter JSON
Avec l'action Exporter JSON, vous pouvez générer directement un fichier JSON à partir d'un schéma JSON. Les nœuds, structures et valeurs définis dans le schéma sont automatiquement pris en compte. Cela permet une vérification simple du schéma ainsi que la création de fichiers d'exemple ou de test pour d'autres validations et intégrations.
Suivez ces étapes pour exporter un JSON :
- Démarrez le centre de rôles Document Dispatch - Administrator.
- Ouvrez la page XSD-Schemata via la recherche globale.
- Ouvrez le schéma JSON souhaité.
- Dans le menu Données, sélectionnez l'action Exporter JSON.
- Sélectionnez une facture quelconque et confirmez la sélection.
- Le fichier JSON généré sera enregistré dans votre dossier de téléchargements.
Recherche de données de schéma
Avec la Recherche de données de schéma, vous pouvez rechercher spécifiquement des nœuds au sein d'un schéma JSON et les trouver rapidement dans la structure du schéma.
Suivez ces étapes pour utiliser la recherche de données de schéma :
- Démarrez le centre de rôles Document Dispatch - Administrator.
- Ouvrez la page XSD-Schemata via la recherche globale.
- Ouvrez le schéma JSON souhaité.
- Naviguez jusqu'au champ Recherche de données de schéma.
- Saisissez le nom du nœud souhaité ou une partie du nom du nœud dans le champ de recherche.
- La recherche est exécutée en appuyant sur Entrée ou en quittant le champ. Si un nœud correspondant est trouvé dans le schéma, il sera automatiquement affiché dans la structure du schéma.
Remarque
Vous pouvez également utiliser la Recherche de données de schéma pour rechercher spécifiquement des champs de transaction commerciale (champs BT). Cela permet de localiser rapidement les nœuds associés au sein du schéma JSON.
Données liées
Avec les données liées, des valeurs pour le traitement du schéma peuvent être stockées et gérées. Ces valeurs peuvent être utilisées pour fournir des informations, compléter des informations manquantes ou remplacer des valeurs existantes lors de la création du fichier XML ou JSON par d'autres valeurs.
Cela permet d'adapter les schémas de manière flexible aux exigences individuelles et d'assurer une sortie cohérente des données. Les données liées sont particulièrement utilisées pour les nœuds de schéma qui nécessitent des valeurs spécifiques ou dont le contenu doit être ajusté en fonction de règles définies.
Suivez ces étapes pour ajuster les données :
- Démarrez le centre de rôles Document Dispatch - Administrator.
- Ouvrez la page XSD-Schemata via la recherche globale.
- Ouvrez le schéma JSON souhaité.
- Dans le menu Données, sélectionnez l'action Données liées.
Ici, vous pouvez modifier les entrées existantes ou créer de nouvelles associations. Les valeurs définies seront automatiquement prises en compte lors de la création du fichier XML ou JSON et appliquées conformément aux règles établies.