Nutzen von API-Workflows

Verbrauchen von API-Workflows von Orchestrator

So führen Sie Ihre veröffentlichten API-Workflows über den Orchestrator aus:

1. Wechseln Sie in Ihrer Automation Cloud Orchestrator zu dem Ordner, in dem der API-Workflowprozess vorhanden ist.
2. Navigieren Sie zu Automatisierungen > Prozesse.
3. Wählen Sie für den gewünschten API-Workflowprozess die Option Auftrag starten am Ende der entsprechenden Zeile aus.
4. Geben Sie auf der geöffneten Seite Folgendes an:
   • Optionen für das Ausführungsziel
   • Optionen für Runtime-Argumente . Der Abschnitt Eingabe stellt das Eingabeschema Ihrer API-Anforderung dar und ermöglicht Ihnen die Angabe von Eigenschaften, die als Eingaben für die Ausführung verwendet werden sollen.
5. Um Ihren Prozess auszuführen, wählen Sie Starten.

Nachdem Ihr Workflow erfolgreich ausgeführt wurde, können Sie die generierte Antwort in den Workflow-Ausführungsdetails anzeigen: Automatisierungen > Aufträge.

Aufrufen von API-Workflows in einem Agent

Erweitern Sie die Funktion Ihrer UiPath Agents, indem Sie API-Workflows als Tools integrieren. Agents fragen diese Workflows automatisch ab, um relevanten Kontext zu sammeln, was eine genaue Kontrolle über die Daten ermöglicht, die Ihren Agents und KI-Modellen zur Verfügung stehen.

Das folgende Szenario veranschaulicht, wie ein API-Workflow von Workday abgerufene Daten transformieren kann, wobei die offengelegten Informationen für Agents auf Namen und E-Mail-Adressen beschränkt werden. In der Workday-Sandbox ist Bedy Liu als Vorgesetzter mit zugewiesenen direkten Vorgesetzten und Kollegen konfiguriert. Beispielabfragen für den Agent:

• „Wer ist an Bedy Liu?“
• „Stellen Sie alle Kollegen für Bedy Liu bereit.“
• „Hat einer von den Kollegen von Bedy Liu Berichte?“

Wichtig: Der Agent speichert Ihre Workday-Anmeldeinformationen nicht, kann Workday nicht direkt abfragen und verwendet ausschließlich die vom API-Workflow zurückgegebenen Antworten.

Bevor Sie beginnen, stellen Sie sicher, dass die folgenden Voraussetzungen erfüllt sind:

• Sie haben Ihren Workday-API-Workflow im Orchestrator veröffentlicht. Bestätigen Sie, dass der Workflow bei der Ausführung über den Orchestrator erfolgreich ausgeführt wird.
• Ihrem Mandanten werden Platform Units zugewiesen.
• Um dem angegebenen Beispiel für die Workday-Integration zu folgen, stellen Sie sicher, dass Ihr Workflow Folgendes enthält:
  • Ein Eingabeschema mit Feldern für Vorname und Nachname.
  • Ein Ausgabeschema, das Arrays für Peers und direkte Berichte enthält.

1. Erstellen Sie Ihren Agent manuell. Alternativ können Sie den Autopilot-Generator mit der folgenden Eingabeaufforderung verwenden:

   „Abfragen Sie Workday nach Manager-, Berichten und Kollegen.“

   Ihr Agent wird mit Autopilot erstellt, das die Prompts und die Konfiguration des Agents vorschlägt. In diesem Beispiel wurden die vorgeschlagenen Prompts zunächst akzeptiert, aber der Benutzer-Prompt wurde später vereinfacht, um nur die Variable {{ klicken }} zu enthalten.

2. Definieren Sie im Bereich Data Manager Ihres Agents eine Eingabeeigenschaft mit dem Namen query vom Typ String. Dadurch wird sichergestellt, dass Ihr Benutzer-Prompt eine gültige Referenz enthält.
   
3. Wählen Sie In der Cloud debuggen aus. Sie werden aufgefordert, die Abfrage für Ihren Benutzer-Prompt anzugeben. Das Panel Ausführungsablaufverfolgung zeigt jedoch, dass der Agent derzeit keinen Zugriff auf Workday hat, sodass er noch keine Antwort bereitstellen kann.
4. Wählen Sie im Abschnitt Tools Ihres Agents Tool hinzufügen > API-Workflow.
5. Wählen Sie den vorhandenen API-Workflow aus (denjenigen, der Workday abfragt) und geben Sie eine Beschreibung dafür an. Es empfiehlt sich, genügend Details anzugeben, damit der Agent den Workflow automatisch basierend auf Ihrem Prompt konfigurieren kann. Eine eindeutige Beschreibung enthält in der Regel Details zu Ihren Eingabeparametern. Zum Beispiel:
   „ Nimmt den Vor- und Nachnamen eines Mitarbeiters als Eingabe und gibt in der Antwort seine direkten Vorgesetzten und Kollegen an. Die Namenseingabe ist der Vorgesetzte, nach dem wir in Workday suchen.“
6. Führen Sie Ihren Agent erneut aus, indem Sie In der Cloud debuggen auswählen. Geben Sie die folgende Abfrage an: „Wer meldet sich bei Weby Liu?“. Das Panel Ausführungsablaufverfolgung identifiziert jetzt, dass der Agent den API-Workflow aufruft, einschließlich:
   • Die an den API-Workflow gesendete Anforderung
   • Die erhaltene Antwort vom API-Workflow
   • Wie der Agent die Antwort verwendet, um Ihre Anfrage zu erfüllen

Herzlichen Glückwunsch!

Jetzt können Sie Variationen Ihres Agent-Benutzerprompts erstellen. Je nach Abfrage kann der Agent mehrere Aufrufe an Ihren API-Workflow auslösen, bevor er eine vollständige Antwort liefert.

Verwenden von API-Workflows als Aufgaben in Maestro

API-Workflows kapseln als Aufgaben in Maestro detaillierte API-Verketten und Datentransformationen. Dadurch bleibt der primäre Maestro-Prozess klar, präzise und leicht zu befolgen. Durch die Isolierung bestimmter API-Interaktionen innerhalb von API-Workflows behalten Sie die Lesbarkeit bei und fördern die Wiederverwendbarkeit über mehrere Prozesse hinweg.

Das folgende Szenario veranschaulicht, wie Maestro Workday-APIs aufruft und dann eine Slack-Teambenachrichtigung sendet, wenn ein Mitarbeiter beendet wurde.

Bevor Sie beginnen, stellen Sie sicher, dass die folgenden Voraussetzungen erfüllt sind:

• Sie haben Ihren Workday-API-Workflow im Orchestrator veröffentlicht. Bestätigen Sie, dass der Workflow bei der Ausführung über den Orchestrator erfolgreich ausgeführt wird.

  Stellen Sie sicher, dass Ihr API-Workflow Folgendes enthält:

  • Ein Eingabeschema mit Feldern für Vorname und Nachname.
  • Ein Ausgabeschema, das Arrays für Peers und direkte Berichte enthält.

Schritt 1: Erstellen eines agentischen Prozesses

1. Erstellen Sie einen agentischen Prozess.
2. Fügen Sie das Element Startereignis hinzu. Nennen Sie sie „Mitarbeiter eingestellt“.
   1. Wählen Sie für die Eigenschaft Aktion des Startereignisses die Option Auf Connector-Ereignis warten aus.
   2. Wählen Sie für die Eigenschaft Connector die Option Workday REST – Worker Created. Dies ist das Ereignis, das den Prozess auslöst.
3. Fügen Sie ein Element Aufgabe hinzu und verbinden Sie das Ereignis damit. Nennen Sie es „Mitarbeiterbeziehungen finden“.
4. Fügen Sie ein weiteres Element Aufgabe hinzu, nennen Sie es „Benachrichtigungen senden“, und verbinden Sie das Element Mitarbeiterbeziehungen suchen damit.
5. Fügen Sie ein Endereignis hinzu. Nennen Sie sie „Benachrichtigung gesendet“.

Das ist die Prozesseinrichtung. Jedes Mal, wenn ein neuer Mitarbeiter eingestellt wird, löst der Prozess den API-Workflow aus, der Mitarbeiterinformationen wie ihre Berichtsstruktur und die zugehörigen Beziehungen abruft.

Schritt 2: Konfigurieren der Aufgabe Mitarbeiterbeziehung suchen

Der vom agentischen Prozess benötigte API-Workflow befindet sich in der Aufgabe Mitarbeiterbeziehungen suchen. So konfigurieren Sie sie:

1. Wählen Sie die Aufgabe Mitarbeiterbeziehungen suchen aus.
2. Wählen Sie für die Eigenschaft Aktion die Option Starten und auf API-Workflow warten aus.
3. Wählen Sie für die Eigenschaft API-Workflow den veröffentlichten Workday-API-Workflow aus. Im Eigenschaftenbereich werden Eingaben und Ausgaben für den ausgewählten Workflow angezeigt. In diesem Beispiel:
   • Eingaben beinhalten Nachname und Vorname.
   • Die Ausgaben enthalten Details für Manager, Peers und Berichte.
4. Konfigurieren Sie Eingaben wie folgt:
   • Vorname als Variable aus dem Antwortobjekt des Startereignisses . Öffnen Sie den Ausdrucks-Editor, wählen Sie Variable einfügen aus und navigieren Sie zu eingestellter Mitarbeiter > Antwort > Arbeitskraft > Vollständiger Name der Arbeitskraft. Fügen Sie dann Split(' ')[0] zum Ausdruck hinzu. Sie sollte folgendermaßen aussehen:

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

     Dabei ist worker das Antwortobjekt aus der Antwort des Startereignisses und.Split(' ')[0] teilt den vollständigen Namen durch das Leerzeichen und ruft den ersten Teil des vollständigen Namens ab.
   • Nachname als Variable aus dem Antwortobjekt des Startereignisses . Öffnen Sie den Ausdrucks-Editor, wählen Sie Variable einfügen aus und navigieren Sie zu eingestellter Mitarbeiter > Antwort > Arbeitskraft > Vollständiger Name der Arbeitskraft. Fügen Sie dann Split(' ')[1] zum Ausdruck hinzu. Sie sollte folgendermaßen aussehen:

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

     Dabei ist worker das Antwortobjekt aus der Antwort des Startereignisses und.Split(' ')[1] teilt den vollständigen Namen durch das Leerzeichen und ruft den zweiten Teil des vollständigen Namens ab.

Schritt 3: Anpassen der Aufgabe zum Senden einer Benachrichtigung

In diesem Schritt konfigurieren Sie die Aufgabe Benachrichtigung senden so, dass Daten verwendet werden, die aus dem in Schritt 2 ausgeführten API-Workflow zurückgegeben werden.

1. Wählen Sie die Aufgabe Benachrichtigung senden aus .
2. Wählen Sie für die Eigenschaft Aktion die Option Connector-Ereignis ausführen.
3. Wählen Sie für die Eigenschaft Connector die Option Slack aus und konfigurieren Sie es für die Verwendung Ihrer Verbindung.
4. Wählen Sie für die Eigenschaft Aktivität die Option Nachricht an Kanal senden.
5. Geben Sie für Kanalname/-ID die ID des Slack-Kanals ein, an den die Benachrichtigung gesendet werden soll.
6. Wählen Sie für die Eigenschaft Nachricht die Ausgabevariablen aus Schritt 2 aus: Manager, Peers und Berichte.
7. Wählen Sie für die Eigenschaft Senden als die Option Bot aus.

Schritt 4: Testen Ihres agentischen Prozesses

Um diesen agentischen Prozess erfolgreich zu testen, stellen Sie sicher, dass Sie Zugriff auf Ihre Workday-Sandbox-Umgebung haben.

Wählen Sie Testen aus, um Ihren Workflow zu validieren. Maestro fordert Sie auf, zwei wichtige Verbindungen bereitzustellen:

• Slack-Verbindung –Erforderlich für die Aufgabe Benachrichtigung senden .
• Workday-Verbindung –Für das Startereignis erforderlich .

Wichtig: Maestro fordert keine Verbindungen für den API-Workflow an, da diese Verbindungen innerhalb des API-Workflows selbst separat verwaltet werden.