Connecteurs de workflow

Ajoutez et utilisez des connecteurs gérés et des connecteurs personnalisés dans la zone Connecteurs de workflow de Workspace ONE Intelligence. Les connecteurs de workflow sont basés sur notre système de gestion des connecteurs (CMS) qui gère toutes les configurations et actions de connecteur gérées pour les services de Workspace ONE sortants et pour les intégrations tierces. Il gère également toutes les configurations et actions de connecteur personnalisées à développer sur l'architecture d'automatisation initiale.

Documentation supplémentaire

Pour plus d'informations sur Freestyle et les workflows, reportez-vous à l'article de blog.

Connecteurs gérés

Les connecteurs gérés, natifs ou tiers, sont pré-amorcés ou ajoutés afin que vous puissiez utiliser leurs actions dans les workflows. Certains exemples de connecteur géré pré-initialisé incluent les services du Hub et Intelligence. Les connecteurs gérés tiers incluent l’API Web Slack et ServiceNow. Les connecteurs personnalisés sont vos propres connexions et actions qui utilisent les API REST pour la communication.

Si vous utilisez Intelligence pour la première fois, vous devez ajouter vos connecteurs gérés en suivant le processus de configuration de ce connecteur. Pour plus d'informations, reportez-vous à la rubrique d'intégration applicable.

Si vous configurez votre connecteur avant la version du CMS, version 23.03.23, aucune action n'est requise.

Modification et suppression

Vous pouvez modifier ou supprimer des connecteurs gérés dans Workspace ONE Intelligence. Si vous supprimez un connecteur géré, ce connecteur peut toujours être sélectionné si vous souhaitez l'ajouter ultérieurement.

Supprimer : pour supprimer un connecteur géré, vous devez supprimer toutes les actions utilisées dans les workflows associés. Vous pouvez également supprimer les workflows associés, mais supprimer avec précaution, car cette action ne peut pas être annulée.
Modifier : vous pouvez modifier certains détails du connecteur géré, mais vous ne pouvez pas modifier les valeurs par défaut des champs d'action.

Connecteurs personnalisés

Ajoutez vos propres connexions et actions aux workflows avec vos systèmes d'entreprise existants et vos services tiers . Les connecteurs personnalisés utilisent les API REST pour la communication et l'outil de développement d'API Postman pour créer des demandes standard.

Configurations requises

Pour ajouter un connecteur personnalisé, importez une collection Postman. Les demandes dans le fichier JSON Postman sont les actions. Une fois que vous avez importé la collection, les actions deviennent disponibles pour une utilisation dans les workflows.

Créez une collection Postman.
Le service que vous prévoyez de connecter doit prendre en charge la REST API et les types de contenu JSON.
Workspace ONE Intelligence a besoin d'accéder aux points de terminaison d'API. Si les services se trouvent derrière un pare-feu, utilisez la passerelle Unified Access Gateway comme proxy inverse. Pour plus d'informations, accédez à Configuration du proxy inverse avec l'API VMware Workspace ONE UEM
Si vous utilisez OAuth2 pour l'authentification, vous devez disposer des détails d'autorisation afin que Workspace ONE Intelligence puisse récupérer, actualiser et accéder aux jetons du service.
- URL du jeton Oauth2
- Client Secret
- ID client
- Type d'autorisation (Informations d'identification du client ou Mot de passe)

Exemples de connecteur personnalisé

Pour obtenir des exemples de connecteurs personnalisés, reportez-vous à notre référentiel GitHub, qui inclut certaines des actions de demande les plus populaires.

Postman pour créer des API REST standard

Workspace ONE Intelligence utilise Postman pour normaliser les API REST que le système utilise pour se connecter et agir avec vos services internes et tiers. Il crée des actions à l'aide d'une interface de modèle REST familière qui permet la réutilisation des actions enregistrées. La version gratuite de Postman dispose des fonctionnalités nécessaires pour créer des collections pour les connecteurs personnalisés.

La version gratuite de l'application dispose des fonctionnalités permettant de créer des collections avec des demandes et de les exporter pour les workflows.

Cette rubrique fournit un aperçu général de ce que vous devez faire pour créer et exporter une collection. Elle doit servir de référence. Consultez le Centre d'apprentissage Postman pour obtenir les dernières instructions sur la configuration du produit Postman.

Obtenez l'application Postman depuis l'adresse https://www.getpostman.com.

Étapes pour utiliser des connecteurs personnalisés

Créez une collection avec des demandes dans Postman et exportez-la.
Ajoutez une connexion personnalisée dans Workspace ONE Intelligence et importez les demandes . Ces demandes sont désormais disponibles en tant qu'actions que vous pouvez utiliser dans les workflows .
Configurez un workflow d'automatisation avec des actions importées pour automatiser une tâche à l'aide de votre connexion personnalisée dans Workspace ONE Intelligence.

Étape 1 : Création de la collection Postman

Utilisez l'application Postman pour créer des API REST standard pour les connecteurs personnalisés. Ce contenu offre un workflow général pour la création et l'exportation de collections Postman en tant que fichiers JSON.

Les collections (actions) Postman pour les connecteurs personnalisés nécessitent désormais un champ ID. L'ID doit être unique par action. Si l'ID existe déjà dans votre instance, Intelligence ignore l'action. Si un ID en double est utilisé dans une importation, un message d'erreur s'affiche.

Vous pouvez ajouter des actions à vos collections avec le même nom et les mêmes descriptions, mais ces actions doivent avoir des ID uniques.

Ajoutez une collection.
Ajoutez et configurez les demandes dans la collection.
- Le nom et la description fournis dans ces demandes sont utilisés dans les actions de workflow dans Workspace ONE Intelligence. Vous pouvez les modifier ultérieurement dans Workspace ONE Intelligence. Voici un exemple d'entrée dans une demande Postman et son interprétation comme action dans les workflows dans Workspace ONE Intelligence.
- Pensez à ajouter des en-têtes tels que Content-Type: application/json. Si vous n'ajoutez pas d'en-têtes pour spécifier le type de contenu JSON, les API utiliseront éventuellement le format XML par défaut, et XML ne fonctionne pas avec les connecteurs personnalisés.
- Ajoutez les en-têtes personnalisés requis par votre API à toutes les demandes de la collection Postman. Des en-têtes personnalisés sont par exemple des types d'authentification uniques basés sur l'en-tête, tels qu'une clé API ou un jeton. Workspace ONE Intelligence conserve tous les en-têtes à l'exception des en-têtes d'authentification. Il remplace les en-têtes d'authentification par vos configurations pour Type d'authentification dans la collection personnalisée. Si Workspace ONE Intelligence remplace l'en-tête d'authentification, le système envoie tout de même votre authentification unique basée sur l'en-tête pour utilisation, car vous l'avez ajoutée à d'autres demandes.
Envoyez la demande pour la valider. La validation génère la réponse.
Enregistrez la réponse comme exemple pour la documentation. Le protocole Open API exige cette étape.
Enregistrez la demande.
Ajoutez d'autres demandes si nécessaire.
Exportez la collection en tant que Collection v2.1.
Ajoutez un ID unique à la collection à l'aide d'un éditeur de fichier et ajoutez-le après l'entrée "name": dans le fichier JSON.

Étape 2 : Ajout du connecteur personnalisé dans Intelligence

Importez votre fichier JSON de collecte Postman dans Intelligence lorsque vous ajoutez un connecteur personnalisé.

Si vous importez une collection Postman avec un ID en double, Intelligence affiche une erreur Invalid Postman JSON file. Modifiez l'une des collections avec un ID unique et réimportez-la dans Intelligence.

Dans Workspace ONE Intelligence, accédez à Intégrations > Connecteurs de workflow, sélectionnez Ajouter puis Ajouter un connecteur personnalisé.
Pour Nom du connecteur, entrez un nom identifiable pour la connexion.
Pour URL de base, entrez l'URL du service afin que Workspace ONE Intelligence puisse s'authentifier. L'URL du service et l'URL de la connexion personnalisée doivent correspondre.
Pour Type d'authentification, sélectionnez le type d'authentification à utiliser pour accéder au service. Workspace ONE Intelligence remplace les en-têtes d'authentification Postman dans les collections avec ce paramètre. Si votre service utilise un type d'authentification basé sur un en-tête unique, ajoutez l'en-tête à toutes vos demandes dans la collection Postman et configurez l'URL de base. Dans ce scénario, Workspace ONE Intelligence utilise les en-têtes configurés dans la collection Postman. Les types d'authentification basés sur l'en-tête utilisent une clé API ou un jeton, par exemple.
- Authentification de base : autorise l'accès à Workspace ONE Intelligence, entrez les informations d'identification.
- Authentification OAuth2 : entrez les détails afin que Workspace ONE Intelligence puisse récupérer, actualiser et accéder aux jetons du service.
- Aucune authentification : si vous ne voulez pas que Workspace ONE Intelligence remplace les en-têtes d'authentification, sélectionnez cet élément de menu.
Pour importer votre fichier JSON Postman, utilisez le lien Sélectionnez à partir de votre ordinateur au milieu de l'interface utilisateur. L'interface utilisateur affiche la collection avec ses demandes. Ces demandes Postman sont désormais disponibles comme actions pour les workflows.
Dans la liste des actions importées, vous pouvez tester, modifier et supprimer l'action.

Étape 3 : Ajout d’un workflow

Suivez le processus décrit dans la rubrique Freestyle Orchestrator pour créer des workflows.

Modification, suppression et test

Vous pouvez modifier, supprimer et tester les connecteurs personnalisés dans Workspace ONE Intelligence. Parce que vous pouvez utiliser des actions dans plusieurs connecteurs, veuillez évaluer les conséquences avant d'effectuer une modification ou une suppression.

Supprimer : pour supprimer un connecteur et les actions associées, vous devez d'abord supprimer les actions de tous les workflows. Une fois toutes les actions supprimées des workflows, le connecteur peut être supprimé. Cette action n'est pas réversible.
Modifier : vous pouvez modifier le nom, la description et les types d'authentification de la connexion à tout moment. Pour modifier les détails de la demande d'action, modifiez la collection Postman, puis réimportez-la dans votre connexion personnalisée. Remarque : Si vous modifiez les types d'authentification et entrez les informations d'identification de manière incorrecte, les actions peuvent ne pas s'exécuter. Effectuez les modifications avec précaution.
Tester : testez les connecteurs personnalisés dans Workspace ONE Intelligence pour vous assurer que Workspace ONE Intelligence et votre service peuvent communiquer.