Lesen und beachten Sie die Automation Anywhere-Dokumentation

Automation Anywhere

Inhalt schließen

Inhalte

Inhalt öffnen

API zum Ex- und Importieren von Workload-Management-Konfigurationen (WLM)

  • Aktualisiert: 5/10/2019

    API zum Ex- und Importieren von Workload-Management-Konfigurationen (WLM)

    Als Enterprise Control Room-Administrator oder Nutzer mit der Berechtigung zum Exportieren und Importieren von Bots können Sie Workload-Konfigurationen exportieren und importieren, um geprüfte Konfigurationen von einer Umgebung in eine andere zu verschieben.

    Beispielsweise können Sie die Warteschlangen, die bereits verifiziert und bereit für die Produktion sind, aus der Staging-Umgebung in die Produktionsumgebung verschieben.

    Mit der Enterprise Control Room-Export-Import-REST-API können Sie Ihre Automatisierungen einschließlich der abhängigen Dateien in verschiedenen Umgebungen wie Entwicklungs-, Test-, Akzeptanz- und Produktionsumgebung so verwalten, wie es die Automatisierungsanforderungen Ihres Unternehmens verlangen.

    Funktionen und Vorteile

    • rollenbasierte Zugriffssteuerung für das Workload-Management-Modul
    • Audit und Nachverfolgbarkeit in Quell- und Zielumgebung für Compliance

    Voraussetzungen

    Exportieren

    • Enterprise Control Room-Nutzer, deren Anmeldedaten für die Authentifizierung verwendet werden, müssen entweder ADMINISTRATOREN sein oder über die Berechtigung Bots exportieren verfügen.
    • Enterprise Control Room-Nutzer müssen entweder Warteschlangenadministrator oder Eigentümer der Warteschlange sein, um eine bestimmte Warteschlange exportieren zu können.
    • Da Angaben zu Eigentümern, Verbrauchern und Teilnehmern von Warteschlangen nicht exportiert werden, müssen Sie diese nach dem Importieren manuell hinzufügen.
    • Das Nutzerkonto, das zum Ausführen der Enterprise Control Room-Dienste verwendet wird, muss Lese-/Schreibzugriff auf den Ordner haben, in den das Paket exportiert wird, also den Anwendungspfad (Netzwerkpfad (freigegebenes Laufwerk) oder lokal).

      Beispiel:

      C:\Users\Public\Documents\Server Files\wlm-files\export

    • Es können maximal 200 Warteschlangen in ein Paket exportiert werden.
    • Warteschlangen im Entwurfsstatus können nicht exportiert werden.
    • Der gesamte Exportvorgang schlägt fehl, wenn der Export einer einzelnen Warteschlange fehlschlägt.

    Importieren

    • Der Enterprise Control Room-Nutzer, dessen Anmeldedaten zur Authentifizierung genutzt werden, muss die Berechtigung Bots importieren haben.
    • Der Enterprise Control Room-Warteschlangenadministrator kann alle Warteschlangen importieren.
    • Der Enterprise Control Room-Nutzer, der die APIs zum Importieren mehrerer Bots verwendet, muss über die Berechtigungen Lesen/Schreiben für den Ordner verfügen, in dem das exportierte Paket von Automation Anywhere bereitgestellt wird, also den Anwendungspfad (Netzwerkpfad (freigegebenes Laufwerk) oder lokal).

      Beispiel:

      C:\Users\Public\Documents\Server Files\wlm-files\import

    • Der Nutzer, der das Paket importiert, wird standardmäßig zum Besitzer der importierten Warteschlange. Fügen Sie von Hand Teilnehmer, Verbraucher oder zusätzliche Eigentümer für importierte Warteschlangen hinzu.
    • Wenn eine Warteschlangenkategorie bereits im Rahmen eines früheren Imports erstellt wurde, verwenden nachfolgende Importe diese Warteschlangenkategorie, solange alle Spaltennamen und -typen übereinstimmen.

    API-Endpunkte

    1. Exportieren: <Enterprise Control Room-URL>/v1/wlm/queues

      Zum Beispiel https://crdevenv.com:81/v1/wlm/queues

    2. Importieren: <Enterprise Control Room-URL>/v1/wlm/queues

      Beispiel:

      https://crtestenv.com:82/v1/wlm/queues

    Mit den obigen Endpunkten der WLM-Export-Import-API können Sie Warteschlangen exportieren und importieren.

    Exportieren von Warteschlangen

    So exportieren Sie Warteschlangen mithilfe der Export-API in Automation Anywhere:

    1. Verwenden Sie die POST-Methode, um ein Token anhand des Endpunkts https://<Hostname:Port>/v1/authentication zu generieren. Geben Sie hierzu die Enterprise Control Room-Instanz als Servernamen/Hostnamen/IP und die Port-Nummer an.

      Zum Beispiel https://crdevenv.com:81/v1/authentication

    2. Nutzen Sie die POST-Methode, und geben Sie die Parameter für die Anmeldedaten in den Textkörperdaten an.

      Beispiel:

      {

      "username":"Mike.Lee",

      "password":"1234567890"

      }

    3. Klicken Sie auf Wiedergabe/Starten/Senden.
    4. Die Workload-Export-API nutzt das Authentifizierungs-Token, das mit der Authentifizierungs-API abgerufen wird. Das Authentifizierungs-Token muss als eine der Header-Eingaben an die Workload-Export-API weitergegeben werden.
    5. Geben Sie die Anforderungsparameter X-Authorization, Accept und queue-ids als Kopfzeilen an.

      Beispiel:

      {

      "X-Authorization":"von Enterprise Control Room nach der Anmeldung ausgegebenes Autorisierungstoken",

      "Accept":"application/json/file",

      "queue-ids":"1,2,3,4,5"

      }

    6. Klicken Sie auf „Wiedergabe/Starten/Senden“.
    7. Die Aktion war erfolgreich, wenn der Antwortstatus 200 OK lautet
    8. Kopieren Sie den Paketnamen aus dem Antwortframe. Damit können Sie das Warteschlangenpaket importieren.
      Tipp: Stellen Sie sicher, dass das Importpaket die richtige Erweiterung aufweist: .wlmpkg

      Kopieren Sie beispielsweise den Dateinamen aus dem Parameter content-disposition:

      cache-control → no-cache, no-store, max-age=0, must-revalidate

      content-disposition → attachment; filename=WorkloadPackage_20180524_180900.wlmpkg

      content-length → 887

      content-type → application/aapkg

      date → Thu, 24 May 2018 12:39:00 GMT

      expires → 0

      pragma → no-cache

      x-frame-options → SAMEORIGIN

    Importieren von Warteschlangen

    Nachdem das Warteschlangenpaket erfolgreich auf ein Netzlaufwerk oder in einen Enterprise Control Room-Rechnerpfad exportiert wurde, kann ein anderer autorisierter Nutzer das Paket mit der Import-API in einen anderen Enterprise Control Room importieren:

    1. Verwenden Sie die POST-Methode, um ein Token anhand des Endpunkts https://<Hostname:Port>/v1/authentication zu generieren. Geben Sie die Enterprise Control Room-Instanz als Servernamen/Hostnamen/IP und die Portnummer an.

      Zum Beispiel https://crtestenv.com:82/v1/authentication

    2. Nutzen Sie die POST-Methode, und geben Sie die Parameter für die Anmeldedaten im Anforderungstext an.

      Referenzbeispiel:

      {

      "username":"Tom.Watson",

      "password":"1234567890"

      }

    3. Klicken Sie auf „Wiedergabe/Starten/Senden“.
    4. Die Workload-Import-API nutzt das Authentifizierungs-Token, das mit der Authentifizierungs-API abgerufen wird. Das Authentifizierungs-Token muss als eine der Header-Eingaben an die Workload-Import-API weitergegeben werden.
    5. Geben Sie die Anforderungsparameter X-Authorization und Content-Type als Kopfzeilen an.

      Beispiel:

      "X-Authorization":"von Enterprise Control Room nach der Anmeldung ausgegebenes Autorisierungstoken",

      "Content-Type":"multipart/form-data"

    6. Geben Sie nun die Parameter Content-Disposition: form-data; name="upload"; filename="{Dateiname}" an, um das Warteschlangenpaket im Anfragetext zu importieren.

      Beispiel:

      Content-Disposition: form-data;

      name="upload"; filename="{WorkloadPackage_20180524_180900.wlmpkg}"

    7. Klicken Sie auf „Wiedergabe/Starten/Senden“.
    8. Die Aktion war erfolgreich, wenn der Antwortstatus 200 OK lautet

    API-Antwortcodes

    Http(s)-Statuscode Antwort/Beschreibung Maßnahme
    200 Paket erfolgreich erstellt n.v.
    400 Fehlerhafter Anfrageparameter Mit gültigen Parametern erneut versuchen
    404 Datei nicht gefunden Sicherstellen, dass die Warteschlange in Enterprise Control Room vorhanden ist
    501 Berechtigungsfehler Sicherstellen, dass Sie über die erforderliche Berechtigung verfügen

    Audit-Protokolle

    Beim Exportieren oder Importieren von Warteschlangen wird ein Audit-Eintrag auf der Enterprise Control Room-Seite Audit-Protokoll erzeugt.

    Feedback senden