Mise en route de Remote Process Sync
Apprenez les bases de la configuration d’une intégration de synchronisation des processus distants afin de lier les processus automatisés entre deux instances ou plus ServiceNow® .
Avant de commencer votre intégration Remote Process Sync
- Création de 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 façon de commencer à créer votre intégration de synchronisation de processus distante, suivez un exemple de la procédure Créez votre première intégration Remote Process Syncà suivre ou découvrez les définitions de synchronisation de processus.
La gestion de votre intégration implique de surveiller les files d’attente sortantes et entrantes et de rechercher les erreurs liées à toutes les définitions de synchronisation de processus déclenchées. Pour plus d’informations sur la façon de surveiller et de vérifier les erreurs avec votre intégration de synchronisation des 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 Concepteur de flux.
Définitions de synchronisation des processus
| Champ | Description |
|---|---|
| Nom | Saisissez un nom qui décrit avec précision la partie du processus business gérée par votre instance. Par exemple, si les utilisateurs de votre instance travaillent pour répondre à des demandes de Service Catalog pour vos clients, saisissez un nom tel que Exécution de la demande de Service Catalog. |
| Description | Vous pouvez également décrire la partie de votre processus business que cette définition de synchronisation de processus gère. |
| Application | Défini automatiquement sur votre périmètre d’application actuel. |
| Domaine | Si votre processus se rapporte à un domaine spécifique, choisissez un domaine autre que Global. Pour plus d’informations, consultez Domain Separation 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 et des champs capturés de votre définition de synchronisation de processus. Le déclencheur spécifie l’opération d’enregistrement, telle que la création, la mise à jour ou la suppression d’un enregistrement, qui entraîne l’envoi de données à une instance distante par votre instance. Lorsqu’une définition de capture est déclenchée, elle crée un objet à partir d’un enregistrement source, qui contient des champs capturés. Ensuite, le flux sortant commence à s’exécuter et met en corrélation les champs capturés à partir 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 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érieures sont respectées avant les valeurs d’ordre supérieures. |
| Application | Défini automatiquement sur votre périmètre d’application actuel. |
| Domaine | Si votre processus se rapporte à un domaine spécifique, choisissez un domaine autre que Global. Pour plus d’informations, consultez Domain Separation pour les fournisseurs de services. |
Dans la section Déclencher, choisissez une table source autorisée dont vous souhaitez activer les enregistrements dans votre définition de synchronisation de processus. Vous pouvez également ajouter des conditions de champ qui, lorsqu’elles sont remplies, déclenchent votre définition de synchronisation de 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éclencheront votre définition de synchronisation de processus chaque fois que les enregistrements seront créés, mis à jour et supprimés. |
| Filtre | Utilisez le créateur de condition pour ajouter des conditions qui, lorsqu’elles sont remplies, déclencheront votre définition de synchronisation de processus. Par exemple, sélectionner entraîne le déclenchement de votre définition de synchronisation de processus chaque fois qu’un enregistrement de l’état de la table sélectionnée est mis à jour sur Travail en cours. |
Enfin, dans la section Capturer, ajoutez à la liste sélectionnée les champs que vous souhaitez inclure dans la charge utile de votre flux sortant.
| Champ | Description |
|---|---|
| Inclure les champs | Ajoutez à la liste Sélectionné les champs 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 ( Remarque :
|
| Inclure les pièces jointes | Si cette option est sélectionnée, toutes les pièces jointes associées au déclenchement d’enregistrements sur votre instance locale seront synchronisées 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 de l’é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 désigne 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 | Entrez 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 un 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 votre périmètre d’application actuel. |
| Domaine | Si votre processus se rapporte à un domaine spécifique, choisissez un domaine autre que Global. Pour plus d’informations, consultez Domain Separation pour les fournisseurs de services. |
Systèmes distants
Un système distant contient les configurations des connexions sortantes et entrantes associées à une autre ServiceNow instance. Un enregistrement de 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 également saisir plus de détails décrivant 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 ( |
| Application | Défini automatiquement sur votre périmètre d’application actuel. |
| Domaine | Si votre processus se rapporte à un domaine spécifique, choisissez un domaine autre que Global. Pour plus d’informations, consultez Domain Separation pour les fournisseurs de services. |
| Flux secondaire d'erreur | Sélectionnez l’icône Référencer à l’aide de la liste ( |
| Alias de connexion | Sélectionnez l’icône Rechercher à l’aide de la liste ( |
| État sortant | Défini sur Désactivé par défaut. Vous pouvez faire passer la valeur de ce champ à 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 qui peut se connecter à l’instance distante. Cet utilisateur doit disposer d’informations d’identification qui correspondent à celles de l’utilisateur disposant du rôle ih_process_sync_api dans l’instance distante. |
| Exécuter les flux entrants en tant que | Sélectionnez l’icône |
| État entrant | Défini sur Désactivé par défaut. Vous pouvez faire passer la valeur de ce champ à 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 de système distant, vous pouvez associer Concepteur de flux 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 et fluxentrants
- Traiter les données locales, en tant que champs capturés dans la définition de capture, qui seront envoyés à 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 |
| Flux secondaire sortant | Sélectionnez l’icône Référencer à l’aide de la liste ( |
| Système distant | Sélectionnez l’icône Référencer à l’aide de la liste ( |
| Application | Défini automatiquement sur votre périmètre d’application actuel. |
| Domaine | Si votre processus se rapporte à un domaine spécifique, choisissez un domaine autre que Global. Pour plus d’informations, consultez Domain Separation 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 depuis l’instance distante vers les 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 |
| Flux secondaire entrant | Sélectionnez l’icône |
| Système distant | Sélectionnez l’icône |
| Application | Défini automatiquement sur votre périmètre d’application actuel. |
| Domaine | Si votre processus se rapporte à un domaine spécifique, choisissez un domaine autre que Global. Pour plus d’informations, consultez Domain Separation pour les fournisseurs de services. |
Avant de choisir simplement le modèle de flux sortant de synchronisation des processus distants fourni par le système, de base ou le modèle de flux entrant de synchronisation des processus distants - flux secondaires de base pour votre définition de synchronisation de processus, vous pouvez personnaliser ces flux secondaires dans Concepteur de flux.
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 transmet 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.
Synchroniser les commentaires et les 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 journal. Les métadonnées de changement sont incluses dans les charges utiles afin que les systèmes distants puissent identifier quel utilisateur 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éé 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 ensuite 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 des nouvelles tentatives 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 |
|---|---|
| Créé | Date à laquelle l’action automatisée de 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 |
| Contexte de flux secondaire sortant | ID système de l’enregistrement d’exécution du 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 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 |
|---|---|
| Séquence | Ordre dans la file d’attente. Un nombre inférieur est traité avant un nombre supérieur. |
| 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, modifiez l’état sur Prêt pour réessayer de traiter la charge utile entrante. |
| Événement de processus | Événement de processus associé à l’action d’intégration |
| Opération | Type d’opération d’enregistrement effectuée par l’instance distante qui a provoqué le déclenchement et l’envoi de données par l’instance distante. Les options incluent :
|
| Contexte de transformation | ID système de l’enregistrement d’exécution pour le flux entrant qui a traité la charge utile |
| ID de corrélation local | ID de corrélation sur l’instance locale |
| 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 |
| Domaine | Domaine dans lequel l’action automatisée de votre intégration s’est exécutée |
| Charge utile | Chaîne en tant que charge utile JSON pour les données entrantes |
Surveillance et résolution des problèmes liés à votre intégration
| Table | Description |
|---|---|
| Statistiques XML | Consultez la process_sync_queue section pour obtenir des 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 préparé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 vrai. Ensuite, analysez les journaux pour rechercher les messages d’erreur commençant par OutboundQueueDao et InboundQueueDao pour trouver des messages de journal contenant plus d’informations sur les problèmes potentiels avec votre intégration. |
- Erreurs de connexion
- Les erreurs de connexion sortante font l’objet de plusieurs tentatives automatiques 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 de journal ou une action d’envoi d’e-mail, lorsque l’état du flux passe sur 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.