UiPath Marketplace-Benutzerhandbuch

Letzte Aktualisierung 5. Sep. 2024

So starten Sie einen Auftrag

Ein Auftrag ist die Ausführung eines Prozesses mit einem oder mehreren Robotern. Die Implementierung des Prozesses Auftrag starten ermöglicht die Erstellung eines neuen Auftrags als Reaktion auf Ereignisse, die innerhalb Ihrer Plattform (außerhalb der UiPath-Plattform) auftreten.

Endpunkte und Eingaben

Das Starten eines Auftrags erfordert die Verwendung von sowohl GET- als auch POST-Anforderungen an mehrere Orchestrator-API-Endpunkte. Die GET-Anforderungen werden verwendet, um die Eingabeparameterwerte abzurufen, die für die POST-Anforderung an den StartJobs- Endpunkt erforderlich sind.

Was sind die StartJob-Eingabeparameter?

Um POST-Anforderungen erfolgreich an den StartJob- Endpunkt zu senden, müssen Sie mindestens einen ReleaseKey (Prozessbezeichner) und eine Strategie (wie der Prozess ausgeführt werden soll) als Eingabeparameter angeben. Je nach Strategie kann es zusätzliche Eingabeparameter geben, einschließlich JobsCount oder RobotIds.

Wie erhalte ich die Eingabeparameterwerte für „StartJob“?

Um die oben genannten erforderlichen Eingabeparameter abzurufen (d. h. ReleaseKey und Strategy), sammeln Sie die folgenden Informationen:

Prozessname (Process Name)

Der Name des Prozesses, der bei einer erfolgreichen StartJob- Anforderung ausgeführt wird (weitere Informationen zu Prozessen finden Sie unter Über Prozesse im Orchestrator-Handbuch).

Der Prozessname wird verwendet, um den ReleaseKey- Wert abzurufen.

Es kann mehrere Instanzen desselben Prozesses geben, die sich durch die Umgebung unterscheiden, in der sie veröffentlicht werden. Aus diesem Grund kann ein einzelner Process Name zu mehreren ReleaseKeys führen. Für den Fall, dass mehrere ReleaseKeys mit einem Prozess verknüpft sind, kann der EnvironmentName verwendet werden, um den ReleaseKey des Prozesses zu identifizieren, den der Benutzer ausführen möchte ( EnvironmentName wird auch verwendet, um die verfügbaren Roboter zu identifizieren, mehr dazu im nächsten Aufzählungszeichen). .

Um sowohl den ReleaseKey als auch den EnvironmentName für einen bestimmten Prozess abzurufen, senden Sie eine GET-Anforderung an den Releases -Endpunkt, indem Sie den Prozessnamen als Eingabeparameter verwenden (z. B. {{base url}}/odata/Releases?$filter=ProcessKey eq {{ProcessName}}).

Hinweis: Die Antwort der Releases GET-Anforderung enthält auch die Eingabeargumentanforderungen für den spezifischen Prozess. Weitere Informationen finden Sie im Abschnitt Eingabeargumente unten.

Strategy

Gibt an, wie der Auftrag den Prozess ausführt; Es gibt drei Optionen:

1. Spezifisch

Der Prozess wird auf einem oder mehreren bestimmten Robotern ausgeführt.

Wenn Spezifisch ausgewählt ist, erfordert der StartJob- Endpunkt die RobotId des Roboters, den Sie zum Ausführen des Prozesses verwenden möchten.

Um die RobotId abzurufen, senden Sie eine GET-Anforderung an den GetEnvironments- Endpunkt, indem Sie EnvironmentName als Eingabeparameter verwenden (z. B. {{base url}}/odata/Environments?$expand=Robots&$filter=Name eq {{_EnvironmentName_}}).

In der GetEnvironments- Antwort können mehrere RobotIds enthalten sein. Um die richtige RobotId zu identifizieren, können Sie den Roboternamen verwenden. Daher wird empfohlen, diese Informationen zu sammeln, wenn Spezifisch ausgewählt ist.

2. Anzahl der Aufträge

Der Prozess wird mit dem nächsten verfügbaren Roboter eine angegebene Anzahl von Wiederholungen ausgeführt.

Wenn JobsCount ausgewählt ist, muss der Eingabeparameter JobsCount für den StartJob- Endpunkt einen Wert enthalten. Aus diesem Grund wird empfohlen, dass Sie Mittel zur Eingabe einer Zahl bereitstellen.

3. Alle

Der Prozess wird einmal auf allen Robotern ausgeführt.

Eingabeargumente (optional)

Der Prozess, der durch Process Name angegeben wird, kann Eingabeargumente erfordern. Diese Eingabeargumente sind in der Regel Datenfeldern zugeordnet, die einem Anwendungsobjekt zugeordnet sind.

Beispielsweise kann ein Problemverwaltungssystem ein Incident -Objekt haben. Dieses Incident -Objekt enthält mehrere Datenfelder, die für den Prozess relevante Informationen enthalten (z. B. IncidentId, DateCreated, Owner usw.).

Wie oben erwähnt, können Sie bestimmen, ob ein Prozess Eingabeargumente erfordert, indem Sie den Arguments -Block in der GET Releases -Antwort analysieren (siehe Beispielantwort unten).

Um diese Datenfeldwerte in die StartJob POST-Anforderung aufzunehmen, wird empfohlen, dass Sie das Anwendungsobjekt und seine relevanten Datenfelder auswählen können, die für den Prozess erforderlich sind. Wenn der Auftrag aufgerufen wird, ruft der Connector die Datenfeldwerte ab und fügt sie in der POST-Anforderung als InputArgument- Parameterwert hinzu.

Hinweis:

Sie können auch eine GET-Anforderung an den Processes_GetArgumentsByKey- Endpunkt senden, um zu ermitteln, ob ein Prozess über erforderliche Argumente verfügt. Der Vorteil dieses Endpunkts ist, dass die Antwort nur die Argumentdetails enthält (d. h. Eingabe und Ausgabe).

Der Nachteil dieses Endpunkts und der Grund, warum er in unseren Beispielen nicht verwendet wird, ist, dass der Connector zusätzliche GET-Anforderungen stellen muss, um Informationen abzurufen, die bereits in der vorherigen GET Releases -Antwort enthalten waren (die zum Abrufen des ReleaseKey- Werts erforderlich ist). .

{
  "@odata.context": "https://platform.uipath.com/twTenantTest/twTenantTest/odata/$metadata#Releases",
  "@odata.count": 1,
  "value": [
    {
      "Key": "99587436-4ce5-480d-988c-6d7f43787a2c",
      "ProcessKey": "SupportTriage",
      "ProcessVersion": "1.0.1",
      "IsLatestVersion": false,
      "IsProcessDeleted": false,
      "Description": "",
      "Name": "SupportTriage_QuickstartDemo",
      "EnvironmentId": 128912,
      "EnvironmentName": "QuickstartDemo",
      "InputArguments": null,
      "ProcessType": "Process",
      "SupportsMultipleEntryPoints": false,
      "RequiresUserInteraction": true,
      "AutoUpdate": false,
      "JobPriority": "Normal",
      "Id": 312722,
      "Arguments": {
        "Input": "[{\)\)"name\)\)":\)\)"IncidentId\)\)",\)\)"type\)\)":\)\)"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\)\)",\)\)"required\)\)":true,\)\)"hasDefault\)\)":false}]",
        "Output": null
      },
      "ProcessSettings": null
    }{
  "@odata.context": "https://platform.uipath.com/twTenantTest/twTenantTest/odata/$metadata#Releases",
  "@odata.count": 1,
  "value": [
    {
      "Key": "99587436-4ce5-480d-988c-6d7f43787a2c",
      "ProcessKey": "SupportTriage",
      "ProcessVersion": "1.0.1",
      "IsLatestVersion": false,
      "IsProcessDeleted": false,
      "Description": "",
      "Name": "SupportTriage_QuickstartDemo",
      "EnvironmentId": 128912,
      "EnvironmentName": "QuickstartDemo",
      "InputArguments": null,
      "ProcessType": "Process",
      "SupportsMultipleEntryPoints": false,
      "RequiresUserInteraction": true,
      "AutoUpdate": false,
      "JobPriority": "Normal",
      "Id": 312722,
      "Arguments": {
        "Input": "[{\)\)"name\)\)":\)\)"IncidentId\)\)",\)\)"type\)\)":\)\)"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\)\)",\)\)"required\)\)":true,\)\)"hasDefault\)\)":false}]",
        "Output": null
      },
      "ProcessSettings": null
    }

Beispiele

Dieser Abschnitt enthält Links zu Beispiel-Connector-Benutzeroberflächen und die entsprechenden Orchestrator-API-Anforderungen für jedes Eingabefeld.

In diesen Beispielen stellen wir das Konzept eines Templates vor. Eine Vorlage stellt eine Zuordnung eines Anwendungsobjekts und/oder Ereignisses zu einem Prozess oder einer Warteschlange von UiPath dar. Vom Konzept her bietet eine Vorlage Ihnen die Möglichkeit, verschiedene Orchestrator-Ressourcen aufzurufen (z. B. einen Auftrag starten, ein Warteschlangenelement hinzufügen), wenn verschiedene Ereignisse in Ihrer Anwendung auftreten (z. B. neues Objekt erstellt, Objektstatusänderung), während eine einzelne authentifizierte Verbindung aufrechterhalten wird.