Utiliser des workflows d’API

Utiliser les workflows d’API à partir d’Orchestrator

Pour exécuter vos workflows d'API publiés à partir d'Orchestrator :

1. Dans votre Automation Cloud Orchestrator, accédez au dossier où existe le processus de workflow d'API.
2. Navigate to Automations > Processes.
3. Pour le processus de workflow d’API souhaité, sélectionnez Démarrer une tâche à la fin de la ligne correspondant.
4. Sur la page qui s'ouvre, indiquez :
   • Options de la cible dʹexécution
   • Options d’arguments du runtime . La section Entrée représente votre schéma d'entrée de la requête d'API et vous permet de spécifier les propriétés à utiliser comme entrées pour l'exécution.
5. Pour exécuter votre processus, sélectionnez Start.

Une fois votre workflow exécuté avec succès, vous pouvez afficher la réponse générée dans les détails de l'exécution du workflow : Automatisations > Tâches.

Invoquer des workflows d'API dans un agent

Élargissez les fonctionnalités de vos agents UiPath en intégrant des workflows d'API en tant qu'outils. Les agents interrogent automatiquement ces workflows pour recueillir le contexte pertinent et permettent un contrôle précis des données disponibles pour vos agents et vos modèles d'IA.

Le scénario suivant montre comment un workflow d'API peut transformer les données récupérées à partir de Workday, en limitant les informations exposées aux agents à des noms et des adresses e-mail uniquement. Dans la sandbox Workday, Beyondy Tony est configuré en tant que gestionnaire avec des rapports directs et des pairs attribués. Exemples de requêtes pour l'agent :

• « Qui rapporte des tâches à Tony  déjà ? »
• « Indiquer tous les pairs de Tony riau. »
• « Y a-t-il des rapports ?
  Important :

  L'agent ne stocke pas vos informations d'identification Workday et s'appuie uniquement sur les réponses renvoyées par le workflow de l'API.

Avant de commencer, assurez-vous que les conditions préalables suivantes sont remplies :

• Vous avez publié votre workflow d’API Workday dans Orchestrator. Confirmez que le workflow s'exécute correctement lorsqu'il est exécuté à partir d'Orchestrator.
• Les Platform Units sont attribuées à votre locataire.
• Pour suivre l'exemple d'intégration Workday fourni, assurez-vous que votre workflow inclut les éléments suivants :
  • Un schéma d'entrée avec des champs pour le prénom et le nom.
  • Un schéma de sortie contenant des tableaux pour les pairs et les rapports directs.

1. Créez votre agent manuellement. Vous pouvez également utiliser le générateur Autopilot avec l’invite suivante : « Demander des détails sur Workday pour le gestionnaire, les rapports et les pairs » Votre agent est créé avec Autopilot, qui suggère les requêtes et la configuration de l’agent. Dans cet exemple, les invites suggérées ont été initialement acceptées, mais l' invite utilisateur a été simplifiée par la suite pour contenir uniquement la variable {{ query }} .

2. Dans le panneau Data manager de votre agent, définissez une propriété Input appelée query, de type String. Cela garantit que votre invite utilisateur contient une référence valide.

3. Sélectionnez Déboguer sur le cloud. Vous êtes invité à fournir la requête pour votre invite utilisateur. Cependant, le panneau Traçage de l'exécution indique que l'agent n'a actuellement pas accès à Workday, il ne peut donc pas encore fournir de réponse.

4. Dans la section Tools de votre agent, sélectionnez Add tool > Workflow d'API.

5. Sélectionnez le workflow d'API existant et fournissez-en une description. Nous vous recommandons de fournir suffisamment de détails pour que l'agent puisse configurer automatiquement le workflow en fonction de votre invite. Une description claire comprend généralement des détails sur vos paramètres d'entrée. Par exemple : « Prend un prénom et un nom de travail en tant qu’entrée et fournit ses rapports directs et pairs dans la réponse. Le nom saisi est le gestionnaire que nous rechercherons dans Workday. »

6. Exécutez à nouveau votre agent en sélectionnant Déboguer sur le cloud. Fournissez la requête suivante : « Qui fait rapport à Backy Hub ? ». Le panneau Traçage de l'exécution identifie désormais que l'agent appelle le workflow de l'API, y compris :

   • La requête envoyée au workflow d’API
   • La réponse reçue depuis le workflow d’API
   • Comment l’agent utilisera la réponse pour remplir votre requête

Félicitations !

Vous pouvez désormais créer des variations de la requête utilisateur de votre agent. En fonction de la requête, l'agent peut déclencher plusieurs appels vers votre workflow d'API avant de fournir une réponse complète.

Utiliser des workflows d'API en tant que tâches dans Maestro

Les workflows d'API, sous forme de tâches dans Maestro, encapsulent le chaînage d'API détaillé et les transformations de données. Le processus Maestro principal ainsi est clair, concis et facile à suivre. En isoler les interactions d'API spécifiques dans les workflows d'API, vous maintenez la lisibilité et la réutilisation à travers plusieurs processus.

Le scénario suivant montre comment Maestro appelle les API Workday, puis envoie une notification à l'équipe Slack chaque fois qu'un employé a terminé.

Avant de commencer, assurez-vous que les conditions préalables suivantes sont remplies :

• Vous avez publié votre workflow d’API Workday dans Orchestrator. Confirmez que le workflow s'exécute correctement lorsqu'il est exécuté à partir d'Orchestrator. Assurez-vous que votre workflow d'API inclut les éléments suivants :
  • Un schéma d'entrée avec des champs pour le Prénom et le Nom de famille.
  • Un schéma de sortie contenant des tableaux pour les pairs et les rapports directs.

Étape 1 : créer un processus agentique

1. Créez un processus agentique.
2. Ajoutez un élément Start Event . Nommez-le « Employé employé ».
   1. Pour la propriété Action de l' événement Démarrer, sélectionnez Attendre l'événement du connecteur.
   2. Pour la propriété Connecteur , sélectionnez Workday REST - Worker Created. Il s'agit de l'événement qui déclenche le processus.
3. Ajoutez un élément Task et connectez-le à l' événement Start . Nommez-le « Rechercher des relations avec les employés ».
4. Ajoutez un autre élément Tâche , nommez-le « Envoyer des notifications » et connectez-y l'élément Rechercher des relations d'employés.
5. Ajoutez un événement de fin. Nommez-la « Notification envoyée ».

Il s'agit de la configuration du processus. Chaque fois qu'un nouvel employé est embauché, le processus déclenche le workflow d'API, qui récupère les informations sur les employés telles que leur structure de reporting et les relations associées.

Étape 2 : configuration de la tâche de recherche d'une relation de travail entre employés

Le workflow d'API requis par le processus agentique se situe dans la tâche Find Employing Relations. Voici comment la configurer :

1. Sélectionnez la tâche Rechercher des relations d’employés .

2. Pour la propriété Action , sélectionnez Démarrer et attendre le workflow d’API.

3. Pour la propriété Workflow d’API , sélectionnez le workflow d’API Workday publié. Le panneau des propriétés affiche les entrées et les sorties du workflow sélectionné. Pour cet exemple :

   • Les entrées incluent le nom de famille et le prénom.
   • Les sorties incluent des détails pour le Gestionnaire, les Pes et les Rapports.

4. Configurez les entrées comme suit :

   • Prénom en tant que variable de l'objet Réponse de l' événement Démarrer . Ouvrez l' éditeur d'expressions, sélectionnez Insérer une variable et accédez à Employé > Réponse > Travailleur > Nom complet du travail. Ajoutez ensuite Split(' ')[0] à l'expression. Il devrait ressembler à ceci :

     vars.response_1.worker.descriptor.Split(' ')[0]
     

   Où worker est l'objet de réponse de la réponse de l' événement Start , et.Split(' ')[0] fractionne le nom complet par le caractère espace et récupère la première partie du nom complet.

   • Nom de famille en tant que variable de l'objet Start Event Response. Ouvrez l' éditeur d'expressions, sélectionnez Insérer une variable et accédez à Employé > Réponse > Travailleur > Nom complet du travail. Ajoutez ensuite Split(' ')[1] à l'expression. Il devrait ressembler à ceci :

   vars.response_1.worker.descriptor.Split(' ')[1]
   

   Où worker est l'objet de réponse de la réponse de l' événement Start , et.Split(' ')[1] fractionne le nom complet par le caractère espace et récupère la deuxième partie du nom complet.

Étape 3 : Personnalisation de la tâche Envoyer une notification

Dans cette étape, vous configurez la tâche Envoyer une notification pour utiliser les données renvoyées par le workflow d'API exécuté à l'étape 2.

1. Sélectionnez la tâche Envoyer une notification .
2. Pour la propriété Action , sélectionnez Exécuter l'événement du connecteur.
3. Pour la propriété Connecteur , sélectionnez Slack et configurez-le pour utiliser votre connexion.
4. Pour la propriété Activité , sélectionnez Envoyer un message au canal.
5. Pour le Nom/ID du canal, écrivez l'ID du canal Slack où la notification doit être envoyée.
6. Pour la propriété Message , sélectionnez les variables de sortie dans Étape 2 : Gestionnaire, Pes et Rapports.
7. Pour la propriété Envoyer en tant que , sélectionnez bot.

Étape 4 : Tester votre processus agentique

Afin de tester avec succès ce processus agentique, veillez à avoir accès à votre environnement de sandbox Workday.

Sélectionnez Tester pour valider votre workflow. Maestro vous invite à fournir deux connexions essentielles :

• Slack Connection : requis par la tâche Send Notification .
• Connexion à Workday : requise par l’ événement de démarrage.
  Important :

  Maestro ne demande pas de connexions pour le workflow d'API, car ces connexions sont gérées séparément dans le workflow d'API lui-même.