Mise en route de la synchronisation des processus distants
Apprenez les bases de la configuration d’une intégration de synchronisation de processus distants afin de relier les processus automatisés entre deux instances ou plus ServiceNow® .
Avant de commencer votre intégration de synchronisation de processus distants
- Construire votre intégration, et
- Gestion de votre intégration
La création de votre intégration implique la création et la configuration d’une définition de synchronisation de processus et de ses enregistrements connexes. Pour plus d’informations sur la création de votre intégration de synchronisation de processus distants, suivez un exemple de procédure Créer votre première intégration de synchronisation de processus distants ou découvrez les définitions de synchronisation de processus.
La gestion de votre intégration implique la surveillance des files d’attente sortantes et entrantes et la recherche d’erreurs liées aux définitions de synchronisation des processus déclenchés. Pour plus d’informations sur la façon de surveiller et de vérifier les erreurs avec votre intégration de synchronisation de processus distants, consultez Files d’attente sortantes et files d’attente entrantes et Surveillance et résolution des problèmes liés à votre intégration. Vous pouvez également évaluer périodiquement les flux sortants et entrants qui s’exécutent automatiquement pour votre intégration et déterminer s’il convient d’apporter des modifications à ces flux dans Workflow Studio.
Définitions de synchronisation des processus
| Champ | Description |
|---|---|
| Nom | Saisissez un nom qui décrit précisément la partie de votre processus business gérée par votre instance. Par exemple, si les utilisateurs de votre instance travaillent pour répondre aux demandes de Catalogue de services pour vos clients, saisissez un nom tel que Exécution de demande de Catalogue de services. |
| Description | Vous pouvez également décrire la partie de votre processus business gérée par cette définition de synchronisation de processus. |
| Application | Défini automatiquement sur le périmètre de votre application actuel. |
| Domaine | Si votre processus concerne un domaine spécifique, choisissez un domaine autre que global. Pour plus d’informations, consultez Séparation de domaine pour les fournisseurs de services. |
- Définitions de captures
- Événements de processus
- Systèmes distants
- Flux sortants
- Flux entrants
Définitions de captures
Une définition de capture spécifie quand votre instance doit envoyer des données à une instance distante et quelles données votre instance doit envoyer. Une définition de capture contient les configurations du déclencheur de votre définition de synchronisation des processus et des champs capturés. Le déclencheur spécifie quelle opération d’enregistrement, telle que la création, la mise à jour ou la suppression d’un enregistrement, amène votre instance à envoyer des données à une instance distante. Lorsqu’une définition de capture est déclenchée, elle crée un objet à partir d’un enregistrement source, qui contient les champs capturés. Ensuite, le flux sortant commence à s’exécuter et met en corrélation les champs capturés de l’enregistrement source avec les champs d’un enregistrement connexe sur le système distant.
Un enregistrement de définition de capture comporte les champs suivants :
| Champ | Description |
|---|---|
| Événement de processus | Dans le formulaire de définition de capture, utilisez l’icône Rechercher à l’aide de la liste ( |
| État | Choisissez Actif pour activer cette définition de capture afin que la définition de synchronisation du processus parent se déclenche lorsque les conditions définies dans la section Déclencheur de ce formulaire sont remplies. |
| Ordre | Entrez une valeur pour l’ordre dans lequel vous souhaitez que votre définition de capture se déclenche par rapport aux autres définitions de capture. Les valeurs d’ordre inférieur sont respectées avant les valeurs d’ordre supérieur. |
| Application | Défini automatiquement sur le périmètre de votre application actuel. |
| Domaine | Si votre processus concerne un domaine spécifique, choisissez un domaine autre que global. Pour plus d’informations, consultez Séparation de domaine pour les fournisseurs de services. |
Dans la section Déclencheur, choisissez une table source autorisée dont vous souhaitez déclencher les enregistrements pour la définition de synchronisation de votre processus. Vous pouvez également ajouter des conditions de champ qui, lorsqu’elles sont réunies, déclenchent la définition de synchronisation de votre processus. Lorsque les conditions sont remplies pour le déclencheur spécifié dans votre définition de capture, tous les flux sortants associés à votre définition de synchronisation de processus commencent à s’exécuter. Pour plus d’informations, consultez Flux sortants et flux entrants.
| Champ | Description |
|---|---|
| Nom de la table source | Choisissez une table autorisée dont les enregistrements déclenchent votre définition de synchronisation de processus chaque fois que les enregistrements sont créés, mis à jour et supprimés. |
| Filtre | Utilisez le générateur de conditions pour ajouter des conditions qui, lorsqu’elles sont remplies, déclencheront la définition de synchronisation de votre processus. Par exemple, en sélectionnant entraîne le déclenchement de votre définition de synchronisation de processus chaque fois qu’un enregistrement dans l’état de votre table sélectionnée est mis à jour vers Travail en cours. |
Enfin, dans la section Capture, ajoutez à la liste Sélectionné les champs que vous souhaitez inclure dans la charge utile de votre flux sortant.
| Champ | Description |
|---|---|
| Inclure les champs | Ajoutez des champs à la liste Sélectionné que vous souhaitez synchroniser avec les champs de l’instance distante chaque fois que votre définition de synchronisation de processus se déclenche. Utilisez l’icône Ajouter un élément (icône Remarque :
|
| Inclure les pièces jointes | Si cette option est sélectionnée, toutes les pièces jointes associées aux enregistrements de déclenchement sur votre instance locale se synchronisent avec les pièces jointes des enregistrements corrélés sur l’instance distante. Pour plus d'informations, consultez |
Traiter les événements
Un événement de processus spécifie quelle partie de votre processus business commence dans votre instance locale et se termine dans l’instance distante. L’enregistrement d’événement de processus dans votre instance locale et dans l’instance distante doit porter le même nom, car l’événement de processus représente le lien entre ces instances qui leur permet de partager des parties du même processus business. Un enregistrement d’événement de processus comporte les champs suivants :
| Champ | Description |
|---|---|
| Nom | Saisissez un nom qui décrit la partie de votre processus business qui commence dans votre instance locale et se termine dans l’instance distante. Par exemple, si les utilisateurs de votre instance demandent un logiciel qui sera mis en service dans l’instance distante, vous pouvez nommer l’événement de processus L’utilisateur demande le logiciel. Remarque : Un administrateur de l’instance distante, ou des instances distantes, doit également créer un événement de processus portant le même nom que celui que vous utilisez ici. La création de ces événements de processus dans des instances distinctes crée le lien logique qui vous permet d’intégrer des données entre plusieurs instances. |
| Application | Défini automatiquement sur le périmètre de votre application actuel. |
| Domaine | Si votre processus concerne un domaine spécifique, choisissez un domaine autre que global. Pour plus d’informations, consultez Séparation de domaine pour les fournisseurs de services. |
Systèmes distants
Un système distant contient les configurations des connexions sortantes et entrantes liées à une autre ServiceNow instance. Un enregistrement système distant comporte les champs suivants :
| Champ | Description |
|---|---|
| Nom | Entrez un nom qui décrit l’instance distante. Par exemple, si l’instance est gérée par l’un de vos clients, le client A, saisissez l’instance du client A dans le champ de nom. |
| Description | Vous pouvez éventuellement saisir plus de détails qui décrivent l’objectif général de l’instance distante dans votre processus business. |
| ID externe | Entrez l’ID système de l’enregistrement du système distant qui partage le même événement de processus avec votre instance. Pour obtenir l’ID système d’un enregistrement, sélectionnez Copier sys_id dans le menu contextuel (icône de |
| Application | Défini automatiquement sur le périmètre de votre application actuel. |
| Domaine | Si votre processus concerne un domaine spécifique, choisissez un domaine autre que global. Pour plus d’informations, consultez Séparation de domaine pour les fournisseurs de services. |
| Flux secondaire d’erreur |
Le flux secondaire à exécuter si l’état entrant ou sortant devient erroné. Utilisez l’icône Rechercher à l’aide de la liste (icône
Choisissez le flux secondaire que vous souhaitez exécuter en cas d’échec de la connexion à l’instance distante. Le flux secondaire que vous sélectionnez s’exécute chaque fois que votre instance locale ne peut pas se connecter à l’instance distante après le déclenchement de la définition de synchronisation de votre processus. Il existe un modèle de flux secondaire d’erreur que vous pouvez copier et utiliser pour créer vos propres flux secondaires d’erreur. Le modèle de flux secondaire d’erreur RPS vous permet de sélectionner des méthodes de notification lorsque les états entrant et sortant sont erronés. Vous pouvez afficher le modèle en le parcourant Studio de workflow et en le recherchant dans l’onglet Flux secondaires. Vous pouvez afficher les systèmes distants auxquels votre instance ne parvient pas à se connecter en accédant à . |
| Alias de connexion | Sélectionnez l’icône Rechercher à l’aide de la liste (icône |
| État sortant | Défini sur Désactivé par défaut. Vous pouvez changer la valeur de ce champ en Actif en sélectionnant le lien connexe Valider et activer le système distant dans la vue de formulaire de cet enregistrement de système distant une fois que vous avez terminé de créer l’enregistrement. |
| Utilisateur de l’API entrante | Utilisateur pouvant se connecter à l’instance distante. Cet utilisateur doit avoir des informations d’identification qui correspondent à celles de l’utilisateur ayant le rôle ih_process_sync_api dans l’instance distante. |
| Exécuter les flux entrants en tant que | Sélectionnez l’icône Rechercher à l’aide de la liste (icône |
| État entrant | Défini sur Désactivé par défaut. Vous pouvez changer la valeur de ce champ en Actif en sélectionnant le lien connexe Valider et activer le système distant dans la vue de formulaire de cet enregistrement de système distant une fois que vous avez terminé de créer l’enregistrement. |
Après avoir créé un enregistrement d’événement de processus et un enregistrement système distant, vous pouvez ensuite associer Studio de workflow des flux secondaires à ces enregistrements afin que des actions automatisées s’exécutent chaque fois que votre définition de synchronisation de processus se déclenche.
Flux sortants etflux entrants
- Traiter les données locales, en tant que champs capturés dans la définition de capture, qui seront envoyées à l’instance distante
- Corréler ces données avec les données de l’instance distante
- Envoyer ces données à l’instance distante
Un enregistrement de flux sortant comporte les champs suivants :
| Champ | Description |
|---|---|
| Événement de processus | Sélectionnez l’icône Rechercher à l’aide de la liste (icône |
| Flux secondaire sortant | Sélectionnez l’icône Rechercher à l’aide de la liste ( |
| Système distant | Sélectionnez l’icône Rechercher à l’aide de la liste (icône |
| Application | Défini automatiquement sur le périmètre de votre application actuel. |
| Domaine | Si votre processus concerne un domaine spécifique, choisissez un domaine autre que global. Pour plus d’informations, consultez Séparation de domaine pour les fournisseurs de services. |
- Corréler les données de l’instance locale avec les données envoyées par l’instance distante
- Mapper les champs envoyés de l’instance distante aux champs de l’instance locale
- Traiter les données envoyées de l’instance distante à l’instance locale
Un enregistrement de flux entrant comporte les champs suivants :
| Champ | Description |
|---|---|
| Événement de processus | Sélectionnez l’icône Rechercher à l’aide de la liste (icône |
| Flux secondaire entrant | Sélectionnez l’icône Rechercher à l’aide de la liste (icône |
| Système distant | Sélectionnez l’icône Rechercher à l’aide de la liste (icône |
| Application | Défini automatiquement sur le périmètre de votre application actuel. |
| Domaine | Si votre processus concerne un domaine spécifique, choisissez un domaine autre que global. Pour plus d’informations, consultez Séparation de domaine pour les fournisseurs de services. |
Avant de choisir simplement le modèle de flux sortant de synchronisation de processus distant fourni par le système : de base ou modèle de flux entrant de synchronisation de processus distant : flux secondaires de base pour la définition de synchronisation de votre processus, vous pouvez personnaliser ces flux secondaires dans Studio de workflow.
Synchronisation des pièces jointes
- La première fois qu’un enregistrement de votre intégration se synchronise, toutes les pièces jointes sont envoyées dans la charge utile sortante. Les synchronisations suivantes peuvent envoyer des modifications aux pièces jointes ou à toutes les pièces jointes.
- Les métadonnées de pièce jointe sont toujours envoyées avec la charge utile sortante. Ces métadonnées comprennent une clé synthétique chiffrée, un hachage, un nom de fichier, un type de contenu et une taille.
- L’instance distante décide des pièces jointes à recevoir en comparant chaque hachage et nom de fichier de la charge utile entrante à ceux de l’instance. Ensuite, le processus suivant se produit :
- Le système d’origine valide la clé et envoie les pièces jointes à l’enregistrement de corrélation.
- Le système d’origine informe le système distant que les pièces jointes sont terminées.
- Le système distant déplace les pièces jointes de l’enregistrement de corrélation vers l’enregistrement cible.
Synchronisation des commentaires et des notes de travail
Dans votre intégration, les commentaires et les notes de travail sont synchronisés entre les instances uniquement lorsque des changements sont apportés à ces champs de journal. Les métadonnées de modification sont incluses dans les charges utiles afin que les systèmes distants puissent identifier l’utilisateur qui a créé le commentaire ou la note de travail et quand il a été créé.
Files d’attente sortantes et files d’attente entrantes
Après avoir créé et configuré votre intégration de synchronisation des processus distants en créant et en configurant les enregistrements mentionnés dans les sections précédentes, vous pouvez gérer votre intégration en surveillant la file d’attente sortante et la file d’attente entrante dans votre instance.
Une file d’attente sortante contient l’état, les informations d’erreur, les données de nouvelle tentative et les informations de contexte de flux pour les flux secondaires sortants qui se sont exécutés pour les données qui ont été envoyées hors de votre instance. Pour afficher les enregistrements dans votre file d’attente sortante, accédez à .
Un enregistrement d’état de file d’attente sortante comporte les champs suivants :
| Champ | Description |
|---|---|
| Date de création | Date à laquelle l’action automatisée dans votre intégration s’est produite |
| Info relative à l’erreur | Message d’état de la charge utile sortante |
| Événement de processus | Événement de processus |
| Système distant | Système distant |
| Métadonnées de nouvelle tentative | Métadonnées pour toutes les politiques de nouvelle tentative configurées pour votre charge utile sortante |
| Statut | État du traitement de la charge utile dans la file d’attente sortante. Les options incluent :
|
| Domaine | Domaine dans lequel l’action automatisée de votre intégration s’est exécutée |
| Temps dans la file d’attente | Temps passé à attendre le traitement de l’enregistrement. |
| Durée de traitement | Temps passé à traiter l’enregistrement, en millisecondes. |
| Contexte de flux secondaire sortant | ID système de l’enregistrement d’exécution pour le flux sortant qui a traité la charge utile |
Une file d’attente entrante contient l’état, la séquence de traitement et les informations de corrélation des flux secondaires entrants qui se sont exécutés pour les données envoyées d’une instance distante à votre instance locale. Pour afficher les enregistrements dans votre file d’attente entrante, accédez à .
Un enregistrement de file d’attente entrante comporte les champs suivants :
| Champ | Description |
|---|---|
| Contexte de transformation | ID système de l’enregistrement d’exécution pour le flux entrant qui a traité la charge utile |
| Domaine | Domaine dans lequel l’action automatisée de votre intégration s’est exécutée |
| ID de corrélation local | ID de corrélation sur l’instance locale |
| Opération | Type d’opération d’enregistrement effectuée par l’instance distante, qui a entraîné le déclenchement et l’envoi de données par l’instance distante. Les options incluent :
|
| Charge utile | Chaîne comme charge utile JSON pour les données entrantes |
| Événement de processus | Événement de processus associé à l’action d’intégration |
| ID de corrélation distant | ID de corrélation sur l’instance distante |
| Système distant | Enregistrement du système distant associé à l’instance qui a envoyé les données |
| Séquence | Ordre dans la file d’attente. Un nombre inférieur est traité avant un nombre plus élevé. |
| Temps dans la file d’attente | Temps passé à attendre le traitement de l’enregistrement. |
| Durée de traitement | Temps passé à traiter l’enregistrement, en millisecondes. |
| Statut | État du traitement de la charge utile dans la file d’attente entrante. Les options incluent :
Remarque : Si un enregistrement de file d’attente entrante présente un état d’erreur, changez-le en Prêt pour réessayer de traiter la charge utile entrante. |
Surveillance et résolution des problèmes liés à votre intégration
| Table | Description |
|---|---|
| Statistiques XML | Consultez la process_sync_queue section pour plus d’informations sur les files d’attente sortantes et entrantes de votre intégration, y compris la taille de la file d’attente ainsi que les taux d’erreur et de traitement. |
| File d’attente sortante | Affichez les données de capture pour les enregistrements qui sont indexés pour être envoyés hors de votre instance. |
| État de la file d’attente sortante | Affichez l’état des enregistrements dans la table File d’attente sortante. |
| File d'attente entrante | Affichez la file d’attente entrante et la table d’enregistrement combinées. |
| Journaux | Commencez par activer le débogage en définissant la glide.ih.process.sync.debug propriété système sur true. Ensuite, analysez les journaux à la recherche de messages d’erreur commençant par OutboundQueueDao et InboundQueueDao pour trouver des messages de journal contenant plus d’informations sur les problèmes potentiels de votre intégration. |
- Erreurs de connexion
- Les erreurs de connexion sortantes sont automatiquement réessayées plusieurs fois avant de définir l’état sortant de l’enregistrement du système distant sur Erreur. Si des erreurs continuent de se produire pour une connexion sortante, vérifiez que rien n’a changé avec l’utilisateur de l’API entrante du système distant, comme un changement dans les informations d’identification de l’utilisateur. Ensuite, validez et activez à nouveau l’enregistrement du système distant.
- Erreurs de traitement des données
- Les erreurs de traitement des données se produisent généralement à la suite d’erreurs dans un flux sortant ou entrant. Pour résoudre ces erreurs, vous pouvez ajouter des actions de gestion des erreurs à votre flux, telles qu’une action Journal ou une action Envoyer un e-mail, lorsque l’état du flux passe à Erreur. Vous pouvez également ajouter des actions qui retraitent ou ignorent le traitement des enregistrements dans les tables File d’attente sortante ou File d’attente entrante si une erreur se produit avec le flux.