Configurer un connecteur personnalisé

Rversion finale: Xanadu

Mis à jour 1 août 2024

7 minutes de lecture

Authentifiez votre connecteur personnalisé en tant que source de données pour permettre l’envoi d’informations d’événement à votre ServiceNow instance. Définissez le connecteur personnalisé en fournissant ses détails et ses champs de mappage. Cela permet aux informations extraites des messages d’événement de votre connecteur personnalisé de renseigner les champs d’événement requis. Enfin, créez et fournissez une URL pour le webhook du connecteur personnalisé.

Avant de commencer

Assurez-vous que le module d’extension Gestion des événements Connecteurs (sn_em_connector) est installé sur l’instance Now Platform . Pour plus d'informations, consultez Configurer Gestion des événements les connecteurs.
Assurez-vous que les éléments de configuration relatifs aux hôtes gérés par votre connecteur personnalisé existent dans l’instance Now Platform . Ces CI peuvent être physiques ou virtuels, et peuvent être créés manuellement ou détectés via la détection d'adresses IP ou Détection dans le cloud. Pour plus d'informations, consultez Accéder aux environnements dans le cloud pour les produits ITOM.

Rôle requis : evt_mgmt_admin

Pourquoi et quand exécuter cette tâche

Pour commencer à transmettre des informations d’événement à votre ServiceNow instance, vous devez définir votre Now Platform instance en tant que point de terminaison REST à l’aide d’un webhook standard sur votre connecteur personnalisé.

En fournissant les détails du connecteur et les champs de mappage, vous définissez le connecteur personnalisé. Les informations extraites des messages d’événement du connecteur personnalisé renseignent ensuite les champs d’événement requis et insèrent l’événement dans la base de données.

L’URL est générée par le code basé sur l’instance ServiceNow et le connecteur personnalisé. Utilisez cette URL pour créer un webhook qui permet à votre connecteur personnalisé d’envoyer des événements à l’instance ServiceNow .

Procédure

Accédez à la Espaces de travail > Espace de travail pour l'exploitation des services.
Dans le volet gauche, sélectionnez l’icône Zone de lancement des intégrations ( )
Dans l’onglet Parcourir les intégrations , sélectionnez la liste déroulante Toutes les intégrations , puis sélectionnez Personnalisé.
Seules les tuiles de connecteur personnalisées sont affichées.

Figure 1. Connecteurs par push
Sélectionnez une mosaïque de type de connecteur personnalisé.
Sur la page Fournir des détails , fournissez les détails du connecteur.

Figure 2. Page des détails des connecteurs personnalisés
1. Dans le champ Nom du connecteur , saisissez un nom d’intégration unique pour le connecteur.
2. Facultatif : Dans le champ Balises , entrez des balises pour faciliter la localisation et l’identification des connecteurs de ce type sur le Liste expressfichier .
  Pour ajouter des balises supplémentaires, sélectionnez l’icône plus ( ) en regard du champ Balises . La fenêtre Add tags (Ajouter des balises) s’ouvre.
  1. Dans le champ Clé , saisissez une clé de balise.
  2. Dans le champ Valeur , saisissez une valeur de balise.
  3. Sélectionnez Ajouter.
3. Facultatif : Dans le champ Description , entrez des informations brèves sur ce connecteur.
4. Dans le champ Source , saisissez le fournisseur utilisé pour collecter des événements à partir de la source d’événement externe.
  
  Le champ Source identifie le connecteur et sert d’identificateur pour reconnaître la source des événements et des alertes une fois que le connecteur est actif.
5. Facultatif : Dans la liste déroulante Groupe d’affectation , sélectionnez le groupe ou l’équipe responsable de la gestion et de la maintenance du connecteur.
Facultatif : Faites glisser ou chargez une image à afficher dans la vignette de votre connecteur.
- Faites glisser une image dans la zone.
- Accédez au fichier image en sélectionnant Charger l’image , puis choisissez le fichier.
La taille maximale du fichier téléchargé est de 1 Mo.
Déterminez si vous souhaitez connecter les événements directement à l’instance ITOM ou via un Serveur MID.
- Pour envoyer des événements directement à l’instance ITOM , sélectionnez Directement à l’instance ITOM.
- Pour envoyer des événements via un Serveur MID, qui traite puis transmet l’événement à l’instance, sélectionnez Via le MID Server.
  
  S’il Serveur MID en existe, dans le champ Sélectionner un MID Server , sélectionnez un écouteur d’événements connecté Serveur MID disponible.
  Si vous devez créer un Serveur MID, sélectionnez l’une des options suivantes.
  - Configurer l'extension du serveur Web MID
  - Configurer le contexte du collecteur d'événements de service Web du MID
  Pour plus d'informations, consultez Configurer l'extension Serveur Web MID et Configurer le contexte du collecteur d'événements MID WebService.
Sélectionnez Suivant.

Sur la page Configurer la méthode d’entrée , sélectionnez une méthode pour collecter les données d’événement.

Méthode	Description
Collecter des événements sources réels pour définir des champs	Sélectionnez Collecter des événements sources réels pour définir des champs. Remarque : En collectant des événements de source réelle à partir de votre connecteur personnalisé, vous augmentez la précision des événements et des alertes en utilisant plusieurs événements comme référence pour définir les champs. Sélectionnez Copier dans le presse-papiers et copiez l’URL. Collez l’URL dans la configuration du webhook de votre connecteur personnalisé pour créer un webhook qui permet à votre connecteur personnalisé d’envoyer des événements à l’instance ServiceNow . Entrez vos informations d’identification d’authentification de base dans la configuration du webhook du système de surveillance (telles que le nom d’utilisateur et le mot de passe). Le webhook permet à votre connecteur personnalisé d’envoyer des événements à l’instance. Sélectionnez Rechercher les événements. Le nombre d’événements affichés. L’événement crée des fichiers JSON que vous pouvez parcourir après avoir sélectionné Suivant.
Utiliser un exemple JSON pour mapper les champs	Sélectionnez Utiliser un exemple JSON pour mapper les champs. Remarque : Sélectionnez cette option uniquement si vous disposez d’un exemple de JSON. Dans la boîte de dialogue Entrer la charge utile , copiez et collez votre exemple de charge utile JSON pour créer et afficher le mappage pour mapper les champs. Sélectionnez Charger JSON. Sélectionnez Modifier ou coller un nouveau fichier JSON pour modifier le fichier JSON que vous avez chargé ou collez-en un nouveau. Sélectionnez Copier dans le presse-papiers et copiez l’URL. Collez l’URL dans la configuration du webhook de votre connecteur personnalisé pour créer un webhook qui permet à votre connecteur personnalisé d’envoyer des événements à l’instance ServiceNow . Entrez vos informations d’identification d’authentification de base dans la configuration du webhook du système de surveillance (telles que le nom d’utilisateur et le mot de passe). Le webhook permet à votre connecteur personnalisé d’envoyer des événements à l’instance.

Méthode

Description

Collecter des événements sources réels pour définir des champs

Sélectionnez Collecter des événements sources réels pour définir des champs.
Remarque :
En collectant des événements de source réelle à partir de votre connecteur personnalisé, vous augmentez la précision des événements et des alertes en utilisant plusieurs événements comme référence pour définir les champs.
Sélectionnez Copier dans le presse-papiers et copiez l’URL.
Collez l’URL dans la configuration du webhook de votre connecteur personnalisé pour créer un webhook qui permet à votre connecteur personnalisé d’envoyer des événements à l’instance ServiceNow . Entrez vos informations d’identification d’authentification de base dans la configuration du webhook du système de surveillance (telles que le nom d’utilisateur et le mot de passe). Le webhook permet à votre connecteur personnalisé d’envoyer des événements à l’instance.
Sélectionnez Rechercher les événements. Le nombre d’événements affichés. L’événement crée des fichiers JSON que vous pouvez parcourir après avoir sélectionné Suivant.

Utiliser un exemple JSON pour mapper les champs

Sélectionnez Utiliser un exemple JSON pour mapper les champs.
Remarque :
Sélectionnez cette option uniquement si vous disposez d’un exemple de JSON.
Dans la boîte de dialogue Entrer la charge utile , copiez et collez votre exemple de charge utile JSON pour créer et afficher le mappage pour mapper les champs.
Sélectionnez Charger JSON.
Sélectionnez Modifier ou coller un nouveau fichier JSON pour modifier le fichier JSON que vous avez chargé ou collez-en un nouveau.
Sélectionnez Copier dans le presse-papiers et copiez l’URL.
Collez l’URL dans la configuration du webhook de votre connecteur personnalisé pour créer un webhook qui permet à votre connecteur personnalisé d’envoyer des événements à l’instance ServiceNow . Entrez vos informations d’identification d’authentification de base dans la configuration du webhook du système de surveillance (telles que le nom d’utilisateur et le mot de passe). Le webhook permet à votre connecteur personnalisé d’envoyer des événements à l’instance.

Sélectionnez Suivant.
La page s’ouvre, dans laquelle vous pouvez mapper les champs.
Sur la page Mapper les champs , dans la colonne Noms des champs de connecteur, entrez au moins une valeur qui correspond aux valeurs de gravité répertoriées dans la colonne ServiceNow Champ Sévérité .
Sur la page Mapper les champs , dans la colonne Noms des champs de connecteur, entrez au moins une valeur qui correspond aux valeurs de gravité répertoriées dans la colonne ServiceNow Champ Sévérité .

Vous pouvez saisir la valeur de gravité à partir de l’exemple de code JSON. Pour définir une valeur de gravité, vous devez connaître la charge utile de votre connecteur personnalisé et les types de gravité qu’il prend en charge. Les valeurs de gravité des événements reçus doivent correspondre aux événements générés dans votre système.

Autorisez le système à créer correctement des événements à partir des données entrantes en mappant les champs de votre exemple de code JSON aux ServiceNow champs. Les informations clés de gravité et de message sont automatiquement remplies pour vous faire gagner du temps et de l’énergie. La clé Message fournit l’identificateur correct des événements, ce qui garantit que la déduplication fonctionne correctement et que des alertes redondantes ne sont pas générées.
Facultatif : Pour afficher plusieurs fichiers JSON, sélectionnez la flèche au-dessus de l’exemple JSON.
Facultatif : Dans la section Autres champs, dans la colonne de votre connecteur , spécifiez les paramètres d’événement personnalisés qui sont facultatifs mais fournissent des informations supplémentaires sur l’événement.
Si vous choisissez de ne pas fournir les informations facultatives, laissez le champ vide.
1. Dans le champ Description , saisissez une description d’alerte explicite.
2. Dans le champ Nom de la mesure , saisissez un nom de mesure vous permettant d’associer des événements aux mesures de performances ou aux KPI qui ont déclenché l’alerte.
3. Dans le champ Nœud , entrez une valeur de nœud à utiliser pour la liaison de CI.
4. Dans le champ Heure de l’événement , entrez l’heure de création de l’événement de connecteur personnalisé.
  Si l’heure de l’événement n’est pas mappée, le système utilisera l’heure de l’événement par défaut.
5. Dans le champ Paramètres de l’heure de l’événement , sélectionnez le format d’heure et le fuseau horaire de l’événement.
  - Format d’heure : champ GlideDateTime au format UTC ou GMT, d’une longueur maximale de 40 caractères.
  - Fuseau horaire : Les heures sont stockées en heure universelle coordonnée (UTC) et sont affichées globalement en fonction du fuseau horaire du système.
Activez et enregistrez le connecteur en sélectionnant Activer , puis OK dans la fenêtre contextuelle de confirmation.
Vous pouvez afficher les détails du connecteur dans l’onglet Détails et vos mappages de champs dans l’onglet Mappage de champs .

Résultats

Une fois le connecteur activé, les événements commencent à circuler depuis la console de votre connecteur personnalisé vers l’instance ServiceNow . Le module d’extension extrait les informations du message d’événement du connecteur personnalisé d’origine pour renseigner les champs d’événement requis et insère l’événement dans la base de données. Pour afficher les événements dans votre Now Platform instance, accédez à Tous les événements. Pour plus d'informations, consultez Afficher les événements.

Que faire ensuite

Pour vérifier que le processus a été mené à bien et que les événements affluent dans le système, affichez les événements connexes dans l’onglet Événements associés . Si la configuration est réussie, passez à Ajouter une automatisation pour établir une automatisation d’alerte. Pour en savoir plus sur l’automatisation des alertes, reportez-vous à la section Automatisation des alertes dans Espace de travail pour l'exploitation des services pour ITOM.