Aller au contenu principal

Configuration

DYCE Connector for Jira Service Management se connecte à Jira Service Management au moyen d'une application OAuth 2.0 (3LO) Atlassian. La configuration consiste à enregistrer cette application dans Atlassian, puis à exécuter l'assistant Intégration du connecteur DYCE pour Jira dans Business Central, qui crée la configuration OAuth2, le mappage de table et l'autorisation en un seul processus guidé.

Prérequis​

Enregistrement de l'application OAuth 2.0 dans Atlassian​

  1. Ouvrez l'Atlassian Developer Console et créez une nouvelle OAuth 2.0 integration.
  2. Sous Permissions, ajoutez les API Jira Service Management dont le connecteur a besoin et accordez les portées requises indiquées ci-dessous.
  3. Sous Authorization, définissez la Callback URL sur :
    https://app.dyce.cloud/jira/oauth/callback
    Business Central ne pouvant pas recevoir directement une redirection du navigateur, le rappel est traité par une page DYCE Connect. Cette page affiche le code d'autorisation, qui est ensuite recopié dans Business Central pour terminer l'authentification.
  4. Notez le Client ID et générez un Client secret. Atlassian n'affiche le secret qu'une seule fois : il doit donc être conservé en lieu sûr jusqu'à sa saisie dans Business Central.

Portées requises​

Les portées requises dépendent de ce qui est synchronisé : uniquement les champs standard des organisations et des clients, ou également des champs de détail (personnalisés) mappés. L'assistant d'intégration propose un jeu minimal de portées de départ à son étape Portées et autorisation (manage:jira-organization, manage:jira-service-management-project, read:jira-user, read:servicedesk-request, write:jira-service-management-request, offline_access) ; pour une configuration complète, utilisez plutôt les portées ci-dessous.

Portées pour la synchronisation des organisations et des clients​

PortéeObjet
offline_accessObtenir un jeton d'actualisation afin que les jetons d'accès puissent être renouvelés automatiquement
read:jira-userLire les informations des utilisateurs Jira (utilisé pour tester la connexion)
read:jira-workAccès général en lecture à Jira
read:servicedesk-requestLire les demandes du service desk
write:servicedesk-requestCréer et mettre à jour les demandes du service desk
manage:servicedesk-customerCréer et gérer les clients Jira Service Management (synchronisation contact → client Jira)
read:servicedesk:jira-service-managementLire les service desks (espaces)
write:servicedesk:jira-service-managementGérer les service desks
read:servicedesk.organization:jira-service-managementLire les organisations liées à un service desk
write:servicedesk.organization:jira-service-managementLier des organisations à des service desks (attribution d'espaces)
delete:servicedesk.organization:jira-service-managementDélier des organisations de service desks
read:organization:jira-service-managementLire les organisations
write:organization:jira-service-managementCréer et mettre à jour des organisations (synchronisation client → organisation)
delete:organization:jira-service-managementSupprimer des organisations

Portées supplémentaires - uniquement en cas d'utilisation de champs de détail​

Les mappages de champs dont la Catégorie de champ est Champ personnalisé sont envoyés via l'API des champs de détail des organisations/clients de Jira au lieu de l'appel standard de création/mise à jour, et nécessitent donc ces portées supplémentaires. Si aucun champ personnalisé n'est mappé, elles peuvent être omises :

PortéeObjet
read:organization.detail:jira-service-managementLire les champs de détail des organisations
write:organization.detail:jira-service-managementÉcrire les champs de détail des organisations
read:organization.detail-field:jira-service-managementLire les définitions des champs de détail des organisations
read:customer.detail:jira-service-managementLire les champs de détail des clients
write:customer.detail:jira-service-managementÉcrire les champs de détail des clients
read:customer.detail-field:jira-service-managementLire les définitions des champs de détail des clients
Créer la configuration Service Management

La page Liste des configurations OAuth2 Jira propose également une action Créer la configuration Service Management, qui crée une configuration OAuth2 prête à l'emploi dans laquelle toutes les portées ci-dessus - y compris les portées des champs de détail - sont déjà appliquées.

Exécution de l'assistant d'intégration​

Ouvrez Intégration du connecteur DYCE pour Jira depuis la page Configuration assistée, ou recherchez-le directement (Alt+Q). L'assistant guide à travers quatre étapes :

  1. Configuration OAuth
    Réutiliser une configuration OAuth2 existante et activée, ou en créer une nouvelle en indiquant un Code de configuration, l'ID client fourni par Atlassian, l'URL de base (par défaut https://api.atlassian.com), l'URL du point de terminaison de jeton (par défaut https://auth.atlassian.com/oauth/token) et si les jetons doivent être actualisés automatiquement. Ouvrir les configurations OAuth permet de vérifier ou d'ajuster la configuration sur la page de liste complète.
  2. Mappage de table
    Réutiliser un mappage de table existant, ou en créer un nouveau en choisissant la Table source BC, le Type d'entité Jira, une Description et, si besoin, en activant un nom combiné. Les mappages de champs du nouveau mappage de table peuvent être configurés directement à cette étape. Ouvrir la configuration d'entité affiche le point de terminaison REST Jira utilisé pour le type d'entité choisi ; pour plus de détails, voir Mappage de tables et de champs.
  3. Portées et autorisation
    L'assistant liste son jeu de départ de portées requises et, si Appliquer automatiquement les portées requises reste activé, les écrit dans la configuration OAuth2. Saisissez le Secret client et sélectionnez Démarrer l'autorisation pour lancer le processus de consentement Atlassian décrit ci-dessous. Vérifiez ensuite les portées requises et complétez la configuration OAuth2 si des champs de détail (personnalisés) doivent être mappés.
  4. Résumé
    Affiche le statut de la configuration OAuth2 et du mappage, le statut de l'ID Cloud et le point de terminaison utilisé. À partir de là, Initialiser la file d'attente des travaux et Démarrer la file d'attente des travaux mettent en place le traitement en arrière-plan - voir File d'attente des travaux pour le détail de ces actions. Sélectionnez Terminer pour fermer l'assistant.

Autorisation auprès d'Atlassian​

La sélection de Démarrer l'autorisation (ou d'Authentifier sur la page Liste des configurations OAuth2 Jira, décrite ci-dessous) exécute le processus suivant :

  1. Business Central ouvre le navigateur par défaut sur la page d'autorisation Atlassian.
  2. Ouvrez une session avec un compte Atlassian ayant accès au site Jira Service Management et approuvez les portées demandées.
  3. Atlassian redirige vers la page de rappel DYCE Connect, qui affiche un code d'autorisation.
  4. De retour dans Business Central, confirmez que le code est visible, puis collez-le dans la boîte de dialogue Saisir le code d'autorisation.
  5. Business Central échange le code contre un jeton d'accès et un jeton d'actualisation, les enregistre de manière sécurisée et récupère l'ID Cloud et l'URL du site du site Jira.

Une fois l'authentification effectuée, les jetons d'accès sont actualisés automatiquement avant leur expiration tant que Actualisation automatique des jetons reste activé ; voir File d'attente des travaux pour la configuration du seuil d'actualisation.

Gestion des configurations OAuth2​

Plusieurs configurations OAuth2 peuvent être gérées sur la page Liste des configurations OAuth2 Jira, par exemple pour se connecter à plusieurs sites Jira. Chaque configuration affiche son URL de base, son ID client, le paramètre Actualisation automatique des jetons, les Portées OAuth actuelles et indique si un secret client, un jeton d'accès ou un jeton d'actualisation est enregistré, ainsi que les horodatages Dernière actualisation du jeton et Expiration du jeton.

Actions disponibles :

  • Créer la configuration Service Management - crée une configuration préremplie avec le jeu complet de portées Jira Service Management (voir l'astuce ci-dessus), y compris les portées nécessaires uniquement pour les champs de détail.
  • Authentifier - exécute le processus d'autorisation décrit ci-dessus.
  • Actualiser le jeton - actualise manuellement le jeton d'accès à l'aide du jeton d'actualisation enregistré.
  • Tester le jeton - appelle l'API Jira pour vérifier que le jeton enregistré fonctionne toujours.
  • Effacer les jetons - supprime les jetons d'accès et d'actualisation enregistrés, par exemple avant une nouvelle authentification avec d'autres portées.
remarque

Une configuration OAuth2 ne peut être ni supprimée ni renommée tant qu'elle est référencée par un mappage de table Jira.

Autorisations​

Trois ensembles d'autorisations sont fournis avec DYCE Connector for Jira Service Management. Pour examiner en détail les autorisations contenues dans chacun d'eux, ouvrez la page Ensembles d'autorisations (Alt+Q) et utilisez l'action Autorisations.

  • DYCEJiraRead (DYCE Connecteur Jira Lecture)
    Accès en lecture seule à toutes les tables du connecteur Jira : configuration OAuth2, mappages de tables et de champs, configuration d'entité, règles d'activation, espaces attribués, ainsi que la file d'attente des messages et ses journaux. Inclus automatiquement dans l'ensemble d'autorisations standard D365 Basic - Read.
  • DYCEJiraEdit (DYCE Connecteur Jira Édition)
    Ajoute les droits d'insertion, de modification et de suppression pour les données de synchronisation : file d'attente des messages, journal détaillé des messages, demandes de suivi des modifications et actions de suivi. Cet ensemble d'autorisations est nécessaire pour activer ou désactiver la synchronisation et déclencher une synchronisation manuelle sur un client ou un contact, ainsi que pour gérer les messages comme décrit dans Comprendre les messages. Il inclut DYCE Connecteur Jira Lecture et est inclus automatiquement dans l'ensemble d'autorisations standard D365 BASIC.
  • DYCEJiraAdmin (DYCE Connecteur Jira Admin)
    Ajoute les droits d'insertion, de modification et de suppression pour les données de configuration : configuration OAuth2, mappages de tables et de champs, configuration d'entité, attributions de règles d'activation et attributions d'espaces. Il inclut DYCE Connecteur Jira Édition et est inclus automatiquement dans l'ensemble d'autorisations standard D365 SETUP.

Les ensembles d'autorisations s'appuient les uns sur les autres dans cet ordre : Lecture, Édition, Admin. Chacun est ajouté automatiquement à l'ensemble d'autorisations standard Business Central correspondant ; la plupart des utilisateurs n'ont donc pas besoin de se voir attribuer explicitement un ensemble d'autorisations spécifique à DYCE - seuls les utilisateurs ne disposant d'aucun des ensembles d'autorisations standard D365 ci-dessus en ont besoin.

Pour plus d'informations sur les ensembles d'autorisations, consultez cette partie de la documentation Microsoft.