Aller au contenu

Configuration du module B2Brouter

Dans la section Configuration de B2Brouter, vous configurez la connexion à votre compte B2Brouter. Vous y saisissez les informations d'identification requises, déterminez si l'environnement de production ou de test doit être utilisé, et pouvez vérifier l'état de connexion de votre configuration.

Information

Avant de pouvoir configurer la configuration de B2Brouter, vous devez d'abord créer un compte B2Brouter et terminer la configuration initiale dans B2Brouter.

Pour des informations sur l'inscription et les premières étapes de configuration, consultez B2Brouter - S'inscrire en tant qu'utilisateur

Configurer la connexion à B2Brouter

Dans la section Informations principales B2Brouter, vous saisissez les informations d'identification pour la connexion à votre compte B2Brouter.

  1. Ouvrez le centre de rôles Document Dispatch - Administrateur.
  2. Ouvrez sous Configuration la Configuration du module.
  3. Naviguez vers la section Configuration de B2Brouter.
  4. Saisissez les données de production :
    • Identifiant de compte
    • Clé API
  5. Saisissez éventuellement les données de staging :
    • Identifiant de compte (Staging)
    • Clé API (Staging)
  6. Activez le Mode test si vous souhaitez travailler avec le staging.
  7. Vérifiez les indicateurs de connexion :
    • État API (Production)
    • État API (Staging)

Remarque

Vous pouvez trouver l'Identifiant de compte et la Clé API en vous connectant à B2Brouter et en accédant à la section Développeur. Ouvrez l'onglet Clés API.

L'Identifiant de compte ainsi que la Clé API affichée sont nécessaires pour la configuration de la connexion B2Brouter dans Document Dispatch.

Si vous souhaitez utiliser un environnement de staging, celui-ci doit d'abord être créé dans votre compte B2Brouter.

La section Configuration de B2Brouter contient les informations de compte que Document Dispatch utilise lors de l'envoi de factures électroniques à B2Brouter.

Champ Description
Identifiant de compte Indique le compte B2Brouter pour les envois de production.
Clé API Indique la clé API pour les envois de production.
Identifiant de compte (Staging) Indique le compte B2Brouter pour les envois de test.
Clé API (Staging) Indique la clé API pour les envois de test.
Mode test Envoie les requêtes B2Brouter à l'environnement de staging au lieu de l'environnement de production.
État API Production Affiche l'état de connexion pour la configuration de production.
État API Staging Affiche l'état de connexion pour la configuration de staging.

Afficher le compteur B2Brouter dans la Factbox (optionnel)

Vous pouvez afficher un compteur B2Brouter supplémentaire dans la Factbox. Cela permet aux utilisateurs de voir directement sur l'enregistrement actuel combien d'entrées B2Brouter associées existent, sans avoir à quitter l'aperçu.

  1. Ouvrez le centre de rôles Document Dispatch - Administrateur.
  2. Ouvrez dans la section Configuration la Configuration du module.
  3. Naviguez vers la section Affichage de l'état qui se trouve dans la configuration de la Factbox.
  4. Activez l'option Compteur B2Brouter Envoyé.

Information

Le compteur B2Brouter affiche le nombre total de toutes les entrées B2Brouter pour l'enregistrement actuel. Toutes les entrées B2Brouter sont prises en compte, quel que soit leur statut de traitement, par exemple les entrées traitées avec succès, en attente ou erronées.

Cela facilite la distinction des entrées B2Brouter par rapport aux autres entrées d'envoi ou de document.

Activer le mode test B2Brouter

Avec le Mode test, vous pouvez vérifier la connexion à B2Brouter dans un environnement de test séparé (Staging), sans transférer de données vers l'environnement de production. Cela permet de tester en toute sécurité les modifications de configuration et les processus avant le fonctionnement en direct.

Lorsque le Mode test est activé, Document Dispatch utilise le compte de staging et la clé API de staging associée. Si le Mode test est désactivé, la communication se fait via le compte de production et la clé API de production.

Suivez ces étapes pour activer le mode test B2Brouter :

  1. Ouvrez le centre de rôles Document Dispatch - Administrateur.
  2. Ouvrez dans la section Configuration la Configuration du module.
  3. Naviguez vers la section Configuration de B2Brouter.
  4. Activez le commutateur Mode test pour utiliser la communication avec l'environnement de staging de B2Brouter.

Important

Le Mode test ne fonctionne que si un Identifiant de compte (Staging) valide et une Clé API (Staging) associée ont été saisies.

Si aucune donnée d'accès de staging valide n'est présente, un message d'erreur « La clé API doit être spécifiée. » apparaîtra lors de l'envoi de test.

Avant d'envoyer des factures, assurez-vous que le bon environnement est sélectionné. Les factures envoyées avec des données d'accès de production seront transférées vers l'environnement de production de B2Brouter.

Vérifier la disponibilité de B2Brouter

Avec la vérification de disponibilité, vous pouvez contrôler si les informations d'identification B2Brouter saisies sont valides et si une connexion peut être établie avec l'environnement sélectionné. Les champs d'état affichés indiquent si la configuration a été vérifiée avec succès et si la communication avec B2Brouter est possible.

La disponibilité pour l'environnement de production B2Brouter et l'environnement de staging B2Brouter est affichée séparément.

L'affichage de l'état est automatiquement mis à jour dès que vous modifiez l'identifiant de compte ou la clé API. Cela vous permet de vérifier directement la validité des informations d'identification saisies.

État Description
Erreur L'Identifiant de compte ou la Clé API spécifiée est invalide.
Non configuré Aucune information d'identification n'a été saisie.
Connecté Les informations d'identification saisies sont valides et Document Dispatch est connecté avec succès à B2Brouter.

Formule de mise à jour de l'état B2Brouter

Avec ce champ, vous pouvez définir quelle période doit être prise en compte lors de la mise à jour de l'état B2Brouter. Cela permet de limiter le nombre d'entrées d'envoi à vérifier et de restreindre la mise à jour de l'état aux entrées pertinentes. Seules les entrées d'envoi qui ont déjà été transmises à B2Brouter sont prises en compte.

Pour que la mise à jour de l'état soit exécutée, le poste de file d'attente de tâches Document Dispatch Update B2Brouter Status doit être défini sur Prêt. Si le champ est vide, toutes les entrées d'envoi transmises à B2Brouter seront prises en compte, quel que soit leur date de création.

Suivez ces étapes pour restreindre la mise à jour de l'état B2Brouter aux entrées d'envoi :

  1. Ouvrez le centre de rôles Document Dispatch - Administrateur.
  2. Ouvrez dans la section Configuration la Configuration du module.
  3. Naviguez vers la section Configuration de B2Brouter.
  4. Saisissez dans le champ Formule de mise à jour de l'état la formule de date -2D.

Cela signifie que lors de la mise à jour de l'état B2Brouter, seules les entrées d'envoi créées au cours des deux derniers jours seront prises en compte.

Voir aussi