Verwalten von API-Workflows

Erstellen von API-Workflows

So erstellen Sie eine API-Workflowlösung:

1. Öffnen Sie Studio Web in Ihrer Automation Cloud™-Organisation.
2. Wählen Sie Neuen erstellen > API-Workflow aus. Es öffnet sich eine neue Lösung, auf der die Designerfläche des API-Workflows angezeigt wird.

Definieren von Eingabeschemas

API-Workflows fungieren als APIs selbst und können ein Eingabeschema erfordern, um die erwarteten Eingabeparameter zu definieren. Das Eingabeschema gibt die Datenstruktur an, die ein externer Dienst beim Auslösen des Workflows bereitstellen muss.

Sie können das Eingabeschema konfigurieren, indem Sie eine JSON hochladen oder Eingabeparameter manuell definieren.

1. Öffnen Sie in Ihrem API-Workflow-Projekt den Bereich Data Manager .
2. Wählen Sie die Registerkarte Eingabe aus.

   Um ein JSON-Schema hochzuladen, folgen Sie Schritt 3.

   Um Eingabeparameter manuell zu definieren, folgen Sie Schritt 4.

3. Um ein JSON-Schema mit bereits definierten Eingabeparametern hochzuladen, wählen Sie Aus Nutzlast generieren aus.
   1. Geben Sie das JSON-Objekt mit der erwarteten Eingabe an.
   2. Wählen Sie Schema generieren aus.
   3. Überprüfen Sie das generierte Schema und fügen Sie bei Bedarf Beschreibungen zu den Eigenschaften hinzu.
4. Um Eingabeparameter manuell zu definieren, wählen Sie Eigenschaft hinzufügen.
   1. Konfigurieren Sie die Eigenschaftsdetails:
      • Name– Definiert den Eigenschaftsschlüssel
      • Typ– Wählen Sie aus String, Zahl, Integer, Boolescher Wert, Objekt, Array, Datum-Uhrzeit, Datum, Uhrzeit.
        Wichtig: Wenn Sie ein Objekt oder ein Array verwenden, definieren Sie die Eigenschaften für die verschachtelten Elemente.
      • Erforderlich– Wählen Sie dieses Feld aus, um die Eigenschaft als erforderlich zu markieren.
   2. Wiederholen Sie den Schritt, bis Sie alle Eingabeparameter definiert haben.

Definieren von Ausgabeschemas

Das Ausgabeschema definiert die Struktur der vom API-Workflow zurückgegebenen Daten und stellt sicher, dass jeder Dienst, der den Workflow aufruft, das Ausgabeformat im Voraus versteht. Das Ausgabeschema kann Daten enthalten, die explizit im Schema selbst definiert sind, z. B. IDs oder vom Benutzer bereitgestellte Werte, sowie Ausgaben, die dynamisch aus Workflow-Schritten generiert werden, z. B. API-Antworten oder berechnete Werte.

Sie können das Ausgabeschema konfigurieren, indem Sie eine JSON hochladen oder Ausgabeparameter manuell definieren.

1. Öffnen Sie in Ihrem API-Workflow-Projekt den Bereich Data Manager .
2. Wählen Sie die Registerkarte Ausgabe aus.

   Um ein JSON-Schema hochzuladen, folgen Sie Schritt 3.

   Um Ausgabeparameter manuell zu definieren, folgen Sie Schritt 4.

3. Um ein JSON-Schema mit bereits definierten Ausgabeparametern hochzuladen, wählen Sie Aus Nutzlast generieren aus.
   1. Geben Sie das JSON-Objekt mit der erwarteten Ausgabe an.
   2. Wählen Sie Schema generieren aus.
   3. Überprüfen Sie das generierte Schema und fügen Sie bei Bedarf Beschreibungen zu den Eigenschaften hinzu.
4. Um Ausgabeparameter manuell zu definieren, wählen Sie Eigenschaft hinzufügen.
   1. Konfigurieren Sie die Eigenschaftsdetails:
      • Name– Definiert den Eigenschaftsschlüssel
      • Typ– Wählen Sie aus String, Zahl, Integer, Boolescher Wert, Objekt, Array, Datum-Uhrzeit, Datum, Uhrzeit.
        Wichtig: Wenn Sie ein Objekt oder ein Array verwenden, definieren Sie die Eigenschaften für die verschachtelten Elemente.
      • Erforderlich– Wählen Sie dieses Feld aus, um die Eigenschaft als erforderlich zu markieren.
   2. Wiederholen Sie den Schritt, bis Sie alle Ausgabeparameter definiert haben.

Verwenden des Ausdrucks-Editors

Der Ausdrucks-Editor hilft Ihnen, auf Daten innerhalb von API-Workflows zuzugreifen, sie auszuwerten und zu bearbeiten. Damit können Sie bedingte Logik erstellen, Aktivitätsfelder konfigurieren oder JavaScript-Aktivitäten schreiben.

Ausdrucks-Editor-Layout

Das Layout des Ausdrucks-Editors enthält die folgenden Panels:

Bereich	Beschreibung
Eingabe	Das Hauptpanel ist das Eingabepanel, in das Sie Ihre JavaScript- oder JQ-Ausdrücke schreiben. Dieses Panel enthält eine integrierte Syntaxprüfung, die Fehler in Ihrer Ausdruckssyntax identifiziert und hervorhebt.
Autopilot-Ausdrucksgenerator	Der Autopilot-Ausdrucksgenerator befindet sich unten im Eingabebereich und hilft Ihnen, Workflow-Ausdrücke in natürlicher Sprache zu erstellen, anstatt JavaScript zu schreiben. Autopilot versteht den Kontext Ihres Workflows und ermöglicht es Ihnen, auf Objekte und Workflow-Schritte zu verweisen, indem Sie einfach das gewünschte Ergebnis beschreiben.
Aktivitätstesteingabe	Auf der rechten Seite des Code-Bereichs können Sie im Aktivitätstest-Eingabebereich Testdaten überprüfen, die aus früheren Workflow-Ausführungen generiert wurden. Es enthält Beispieldaten, die Sie zum Erstellen und Validieren von Ausdrücken verwenden können, und interagiert direkt mit dem Ausdrucksausgabebereich, um sicherzustellen, dass Ihre Ausdrücke die gewünschten Ergebnisse liefern.
Ausdrucksausgabe	Der Bereich Ausdrucksausgabe zeigt das Ergebnis Ihres Ausdrucks basierend auf den Daten aus den Eingabedaten des Aktivitätstests an. Auf diese Weise können Sie überprüfen, ob Ihr Ausdruck das erwartete Ergebnis generiert. Wenn Ihr Ausdruck Fehler aufweist, wird im Abschnitt Ausdrucksausgabe der fehlerhafte Ausdruck hervorgehoben und eine entsprechende Fehlermeldung angezeigt. Das Ergebnis wird automatisch aktualisiert, wenn Sie den Ausdruck im Eingabebereich ändern.

Zugriff auf Daten mit JavaScript

Es gibt zwei Zugriffspunkte für Workflow-Daten:

• $workflow– Bezieht sich auf die Konfiguration auf Workflowebene.
• $context– Bezieht sich auf die Konfiguration auf Aktivitätsebene.
• $input– Bezieht sich auf die zuvor ausgeführte Aktivitätskonfiguration.

Wichtig: Verwenden Sie den Testeingabebildschirm im Ausdruckseditor, um beim Erstellen Ihrer Ausdrücke auf Schritteigenschaften zu verweisen.

Zugriffspunkte	Beschreibung	Verwendung
$workflow.input	Speichert das Anforderungsschema und alle in der Testkonfiguration definierten Werte.	Um auf Testkonfigurationsdaten im Ausdruckseditor zuzugreifen, geben Sie die folgende Syntax ein und ersetzen Sie {property_name} durch die spezifische Eigenschaft, auf die Sie verweisen möchten: $workflow.input.{property_name}
$context	Speichert die Eingabe- und Ausgabedaten für jeden Workflow-Schritt. Um in Ihren Ausdrücken auf diese Eigenschaften zu verweisen, führen Sie zuerst den Workflow aus und debuggen Sie ihn . Dadurch werden Eingaben und Ausgaben auf Schrittebene generiert, die auf dem Bildschirm Testeingabe sichtbar sind.	Um auf die Ausgabeantwortdaten eines bestimmten Schritts zuzugreifen, verwenden Sie das folgende Syntaxmuster im Ausdruckseditor und ersetzen Sie {step_name} und {property_name} durch Ihre Schritt- bzw. Eigenschaftsnamen: $context.outputs.{step_name}.content.{property_name}
$input	Speichert Daten, die direkt vom vorherigen Schritt an den aktuellen Schritt übergeben wurden. Verwenden Sie $input , um auf Eigenschaften aus dem vorherigen Schritt zu verweisen, ohne durch die gesamte $context zu navigieren.	Um auf Eigenschaften aus dem vorherigen Schritt zuzugreifen, verwenden Sie die folgende Syntax und ersetzen Sie {property_name}durch die Eigenschaft, auf die Sie verweisen möchten: $input.{property_name}

Testen von API-Workflows

Für eine erfolgreiche API-Workflow-Integration testen Sie Ihren Workflow frühzeitig und häufig. Regelmäßige Tests helfen Ihnen, Fehler schnell zu identifizieren und zu beheben. Funktionen wie IntelliSense, automatische Vervollständigung, Autopilot und der Aktivitätstest-Eingabebildschirm hängen von Testdaten ab. Führen Sie den Workflow regelmäßig mit der Schaltfläche Testen aus, um diese Daten zu generieren.

Tests stellen sicher:

• Ihre Datenzuordnungen zwischen Workflow-Schritten sind korrekt und verhindern unerwartetes Verhalten.
• API-Anforderungen sind korrekt konfiguriert, um zuverlässige Antworten zu gewährleisten.
• Ihr Workflow führt wie vorgesehen aus, wodurch das Risiko unerwarteter Fehler in der Produktion reduziert wird.

Grundlegendes zur Version von Ausführungsausgaben

Das Panel Ausführungsausgabe enthält detaillierte Informationen zur Workflowausführung.

Eingabe- und Ausgabedaten der Aktivität

Diese Daten sind pro ausgewählter Aktivität verfügbar und bieten:

• Eingabedaten –Informationen, die ein Schritt von der vorherigen Aktivität erhält.
• Ausgabedaten –Informationen, die vom aktuellen Schritt erzeugt und an die nächste Aktivität übergeben werden.

Überprüfen Sie Eingabe-/Ausgabedaten, um genaue Zuordnungen und Datentransformationen zu bestätigen.

Informationen zur API-Anforderung

Wenn Workflows mit APIs interagieren, überprüfen Sie die folgenden Anforderungsdetails:

• URL anfordern –Bestätigen, dass dynamische URL-Parameter korrekt aufgelöst werden.
• Header–Stellen Sie sicher, dass Authentifizierung und Inhaltstyp-Header entsprechend festgelegt sind.
• Query Parameters –Überprüfen Sie, ob Filter und Parameter korrekt formatiert sind.
• Textinhalt– Validieren Sie, dass die JSON-Struktur den API-Anforderungen entspricht.

Erfolgreiche API-Anforderungen

Erweitern Sie bei erfolgreichen API-Anforderungen jeden Schritt, um Folgendes zu überprüfen:

• Anforderungsdetails– URL, Header, Abfrageparameter und Textinhalt.
• Antwortdetails–Statuscode, Header und Antwortinhalt.
• Ausgabedaten –Informationen, die vom API-Aufruf zur Verwendung in nachfolgenden Workflow-Schritten generiert werden.

Debuggen

Befolgen Sie die folgenden Richtlinien, um Workflow-Fehler effizient zu identifizieren und zu debuggen:

• Fehlerindikatoren
  • Schritte, bei denen Fehler auftreten, zeigen ein Fehlersymbol an.
  • Wählen Sie den Schritt, um detaillierte Fehlermeldungen und -ausgaben anzuzeigen.
• Häufige Debugging-Schritte
  • Validierung von API-Anforderungen– Stellen Sie sicher, dass Anforderungsdetails wie URLs, Header, Parameter und Textinhalt mit der API-Dokumentation übereinstimmen.
  • Fehlermeldungen überprüfen– Untersuchen Sie Fehlermeldungen auf Hinweise zu Authentifizierungsfehlern, falschen Nutzdaten oder Skriptfehlern.

Hinzufügen einer Debugkonfiguration

Sie können Ihren API-Workflow iterativ erstellen und testen und jeden Schritt validieren, während Sie neue Aktivitäten hinzufügen. Um diese Tests effektiv auszuführen, können Sie bestimmte Eingabedaten mithilfe der Debug-Konfigurationsfunktion definieren. Auf diese Weise können Sie eine JSON-Eingabe einmal festlegen und in allen nachfolgenden Testausführungen wiederverwenden. Sie können während der Workflowausführung über das $workflow.input -Objekt auf die emulierten Daten zugreifen.

So fügen Sie eine Debug-Konfiguration hinzu:

1. Öffnen Sie oben auf der Arbeitsfläche Ihres API-Workflow-Designers die Dropdownliste Debuggen und wählen Sie dann Debugkonfiguration aus.
2. Geben Sie im sich öffnenden Fenster die Testeingabedaten im JSON-Format an.
3. Speichern Sie Ihre Testkonfiguration.
4. Nach dem Speichern können Sie im Ausdrucks-Editor mithilfe der Referenz $workflow.input.{propertyname} auf die Testkonfiguration zugreifen. Darüber hinaus wird die Debugkonfiguration auch im Ausdruckseditor im Eingabebereich des Aktivitätstests angezeigt.

Debuggen Sie Ihren API-Workflow

So debuggen Sie Ihren API-Workflow:

1. Öffnen Sie Ihren API-Workflow. Stellen Sie sicher, dass Ihr Workflow vollständig konfiguriert und einsatzbereit ist.
2. Wenn Ihr Workflow von Eingabedaten abhängt, z. B. aus einem externen System, definieren Sie die Debugkonfiguration vor dem Testen. Dadurch wird sichergestellt, dass jeder Schritt die erforderlichen Daten erhält.
3. Debuggen Sie Ihren Workflow. Die Schaltfläche Debuggen befindet sich oben auf der Seite. Wählen Sie ihn aus, um den Workflow auszuführen und Echtzeitergebnisse anzuzeigen.
4. Sobald das Debuggen gestartet wurde, wird der Bereich Ausgabe auf der rechten Seite des Bildschirms angezeigt. Hier können Sie den Ausführungsstatus jedes Schritts eindeutig als Erfolg, Fehler oder ausstehend sehen.

Veröffentlichen von API-Workflows

Wichtig: Testen Sie vor der Veröffentlichung Ihren API-Workflow sowohl mit Erfolgs- als auch mit Fehlerszenarien, um zu bestätigen, dass jedes Szenario korrekt ausgeführt wird.

So veröffentlichen Sie Ihre API-Workflowlösung:

1. Wählen Sie auf der Arbeitsfläche Ihres API-Workflow-Designers die Option Veröffentlichen aus.
2. Wählen Sie den Ort aus, an dem Ihr API-Workflow veröffentlicht werden soll:
   • Der Feed Ihres persönlichen Arbeitsbereichs in Orchestrator
   • Ihr Orchestrator-Mandantenfeed
3. Geben Sie andere Details an, die für Ihren API-Workflow wichtig sind, z. B. Änderungsprotokoll und Version.
4. Wählen Sie Veröffentlichen aus. Eine Benachrichtigung informiert Sie über die erfolgreiche Veröffentlichung Ihres API-Workflows.

Wenn Sie in Ihrem persönlichen Arbeitsbereich-Feed veröffentlicht haben, ist der Workflow im Orchestrator unter Mein Arbeitsbereich > Automatisierungen > Prozesse sichtbar. API-Workflows sind durch den Typ API identifizierbar.

Wenn Sie in Ihrem Mandanten-Feed veröffentlicht haben, ist der Workflow im Orchestrator unter Mandant > Lösungen sichtbar. API-Workflows sind durch den Typ API identifizierbar.

Bereitstellen von API-Workflows

Nachdem Sie Ihren API-Workflow im Feed Ihrer Einstellung veröffentlicht haben, müssen Sie die Lösung bereitstellen.

Bereitstellen von API-Workflows aus dem Feed Ihres persönlichen Arbeitsbereichs

Durch das Veröffentlichen in Ihrem persönlichen Arbeitsbereich wird der API-Workflow als Prozess in Orchestrator > Mein Arbeitsbereich > Unterordner Ihres API-Workflownamens > Automatisierungen > Prozesse vorbereitet.

Wichtig: Ein dedizierter Unterordner wird automatisch in Ihrem persönlichen Arbeitsbereichsordner erstellt.

Bereitstellen von API-Workflows aus Ihrem Mandantenfeed

Beim Veröffentlichen in Ihrem Orchestrator-Mandanten wird das API-Workflowpaket zu Orchestrator > Mandant > Lösungen hochgeladen.

So stellen Sie sie als Prozess bereit:

1. Gehen Sie zu Orchestrator > Mandant > Lösungen.
2. Wählen Sie für das API-Workflowpaket, das Sie zuvor in Ihrem Mandantenfeed veröffentlicht haben, das Drei-Punkte-Menü und dann Paket bereitstellen aus.
3. Konfigurieren Sie im Assistenten Lösungsversion bereitstellen die folgenden Details:
   1. Bereitstellungsname– Fügen Sie den Namen hinzu, der auf allen Seiten angezeigt werden soll, die Prozesse erwähnen, auflisten oder überwachen. Wenn dies leer gelassen wird, wird der Name des Pakets verwendet.
   2. Zielordner– Geben Sie den Ordner an, der als übergeordneter Ordner für den Lösungsstamm verwendet werden soll. Die Lösung wird nicht im ausgewählten Ordner bereitgestellt, aber ein neuer untergeordneter Ordner wird erstellt.
   3. Als neuen Stammordner unter dem Mandanten installieren– Aktivieren Sie dieses Kontrollkästchen, um die Lösung als neuen Stammordner unter dem aktuellen Mandanten zu installieren.
   4. Name des Lösungsstammordners– ändern Sie den Namen des Stammordners.
4. Wählen Sie Überprüfung aus. Sie können Ihre Lösung jetzt als Entwurf speichern oder sie validieren und fortfahren.
5. Wählen Sie Bereitstellen aus . Jetzt finden Sie Ihren Workflow als Prozess in dem Ordner, der unter Schritt 3 > Automatisierungen > Prozesse angegeben ist. Sie können einen API-Workflow anhand des Typs API identifizieren.
6. Wählen Sie Bereitstellung aktivieren aus, um die Bereitstellung Ihres API-Workflows abzuschließen.

Best Practices

• Definieren Sie klare Eingabe- und Ausgabeschemas , damit andere UiPath-Produkte Ihren Workflow verstehen und mit ihm interagieren können.
• Nutzen Sie die schnelle Ausführungsgeschwindigkeit von API-Workflows, um Eingabe- und Ausgabenutzlast während der Entwurfszeit zu testen.
• Verwenden Sie Autopilot, um kontextbezogene Ausdrücke und JavaScript-Code zu generieren.
• Validieren Sie Ausdrücke im Ausdrucks-Editor-Ausgabebereich, um Syntax- oder Logikprobleme vor der Laufzeit zu erkennen.
• Interagieren Sie mit Eingabe- und Ausgabedaten im Bereich Ausführungsausgabe, indem Sie Werte erweitern, reduzieren oder in die Zwischenablage kopieren.
• Beenden Sie den Workflow frühzeitig, indem Sie eine Antwortaktivität konfigurieren, entweder Erfolg oder Fehler.
• Verwenden Sie in Loop -Aktivitäten, nämlich For Each und Do While, $input anstelle von $context, um auf die vorherige Objektausgabe zuzugreifen.
• Verwenden Sie die HTTP -Aktivität, um APIs direkt aufzurufen, wenn ein Connector nicht die erforderliche Funktionalität bietet. Wählen Sie zwischen der nativen HTTP- Aktivität oder der Connector-spezifischen Aktivität HTTP Request aus.
• Geben Sie Authentifizierungstoken in der Headers -Eigenschaft der HTTP- Aktivität an:

  { 
      Authorization: "<my_token>",
      "Content-Type": "application/json"
  }

  Verwenden Sie für die Standardauthentifizierung Folgendes:

  { Authorization: "Basic " + btoa("<username>:<pass>")}