Lesen und beachten Sie die Automation Anywhere-Dokumentation

Automation Anywhere

Inhalt schließen

Inhalte

Inhalt öffnen

API zum Ex- und Importieren von Bots für das Bot Lifecycle Management (BLM)

  • Aktualisiert: 5/10/2019
    • 11.3.x
    • Managen
    • Enterprise
    • API-Dokumente

API zum Ex- und Importieren von Bots für das Bot Lifecycle Management (BLM)

Mit den APIs zum Exportieren und Importieren von Bots können Sie die BLM-Lösung (Bot Lifecycle Management) Ihres Unternehmens anpassen, um einen ununterbrochenen Lebenszyklus der Automatisierung zu erreichen.

Normalerweise muss der Enterprise Control Room-Nutzer auf andere Mittel als den Enterprise Control Room zurückgreifen (z. B. auf E-Mail), um TaskBots aus einer Umgebung in einer anderen bereitzustellen. Mit den Export-Import-APIs können Sie leicht eine angepasste BLM-Lösung (Bot Lifecycle Management) einführen und so alle möglichen externen Störfaktoren für Ihren Automatisierungslebenszyklus ausschalten.

Als Enterprise Control Room-Nutzer mit den Berechtigung Bots exportieren und Bots herunterladen können Sie einen Bot und seine abhängigen Dateien exportieren. Entsprechend können Sie als Nutzer mit den Berechtigungen Bots importieren und Bots hochladen diesen Bot und seine abhängigen Dateien importieren.

Beispielsweise können Sie die Bots, 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 Automatisierungs-TaskBots einschließlich der abhängigen Dateien in verschiedenen Umgebungen wie Entwicklungs-, Test-, Akzeptanz- und Produktionsumgebung so verwalten, wie es die Automatisierungsanforderungen Ihres Unternehmens verlangen.

Wie Sie die Funktion in der Enterprise Control Room-Nutzeroberfläche verwenden, erfahren Sie unter „Exportieren von Bots“ und „Importieren von Bots“.

Funktionen und Vorteile

  • Rollenbasierte Zugriffssteuerung auf das Bot Lifecycle Management
  • Automatischer Export von Abhängigkeiten (Dateien und Bots)
  • Audit und Nachverfolgbarkeit in Quell- und Zielumgebung für Compliance
  • E-Mail-Benachrichtigung bei der erfolgreichen Ausführung oder beim Fehlschlag des Exports und Imports

Exportieren

  • Der Enterprise Control Room-Nutzer, dessen Anmeldedaten zur Authentifizierung genutzt werden, muss die Berechtigung Bots exportieren haben.
  • Der Enterprise Control Room-Nutzer, dessen Anmeldedaten zur Authentifizierung genutzt werden, muss die Berechtigung Herunterladen für die Bots und mindestens die Berechtigung Ausführen für den exportierten MetaBot und Abhängigkeiten haben.
  • Wenn die Versionskontrolle im Quell-Enterprise Control Room aktiviert ist, muss für alle Bots und Abhängigkeiten, die Sie exportieren möchten, die Produktionsversion festgelegt sein.
  • Das Nutzerkonto, das zur Ausführung der Enterprise Control Room-Dienste verwendet wird, muss Zugriff auf den Speicherort haben, in den das Paket exportiert wird, z. B. den Netzwerkpfad (freigegebenes Laufwerk) oder den Enterprise Control Room-Serverrechner.

Importieren

  • Der Enterprise Control Room-Nutzer, dessen Anmeldedaten zur Authentifizierung genutzt werden, muss die Berechtigung Bots importieren haben.
  • Der Enterprise Control Room-Nutzer, dessen Anmeldedaten zur Authentifizierung genutzt werden, muss die Berechtigung Hochladen für die importierten Bots und Abhängigkeiten haben.
  • Der Enterprise Control Room-Nutzer, der das Dienstprogramm zum Importieren mehrerer Bots ausführt, muss Zugriff auf die von Automation Anywhere bereitgestellte exportierte Paketdatei haben.

API-Endpunkte

  • Exportieren: <Enterprise Control Room-URL>/v1/blm/export

    Beispiel: https://crdevenv.com:81/v1/alm/export

  • Importieren: <Enterprise Control Room-URL>/v1/blm/import

    Beispiel: https://crtestenv.com:82/v1/alm/import

Mit den obigen Endpunkten der BLM-Export-Import-API können Sie einen einzelnen Bot und alle seine Abhängigkeiten exportieren und importieren.

Exportieren von Bots

Exportieren Sie einen einzelnen Bot mit seinen abhängigen Dateien mit der von Automation Anywhere bereitgestellten Export-API:

  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. Referenzbeispiel:

    {

    "username":"cradmin",

    "password":"cr@admin"

    }

  3. Klicken Sie auf Wiedergabe/Start.
  4. Die BLM-Export-API nutzt das Authentifizierungs-Token, das mit der Authentifizierungs-API abgerufen wird. Das Authentifizierungs-Token muss als eine der Header-Eingaben an die BLM-Export-API weitergegeben werden.
  5. Geben Sie Parameter wie filePath, destinationPath und packageName in den Textkörperdaten an, um einen Bot zu exportieren. Die folgende Liste enthält die Parameterbeschreibung:
    • filePath dient zur Angabe des Dateipfads, der mit dem Namen des zu exportierenden Bots endet.
    • destinationPath dient zur Angabe des Zielpfads, in dem das exportierte Paket gespeichert werden soll.
    • packageName dient zur Angabe des Paketnamens, den Sie dem exportierten Paket zuweisen möchten.

      Referenzbeispiel:

      {

      "filePath":"Automation Anywhere\\My Tasks\\Finance\\Account Reconciliation.atmx",

      "destinationPath":"tempshare\\datashare\\Finance Department",

      "packageName":"Finance package"

      }

  6. Klicken Sie auf Wiedergabe/Start.
  7. Sie können die Exportergebnisse an mehreren Orten anzeigen:
    • Antwortdaten, die den packagePath und die Prüfsumme umfassen.
    • Audit-Protokollseite (Landing Page und Detailseite)
    • E-Mail, falls konfiguriert, wenn Sie eine Benachrichtigung zum Erfolg oder Fehlschlag erhalten

Importieren von Bots

Nachdem der Bot 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 in den Textkörperdaten an.

    Referenzbeispiel:

    {

    "username":"cradmin2",

    "password":"cr@admin"

    }

  3. Klicken Sie auf Wiedergabe/Start.
  4. Die BLM-Import-API nutzt das Authentifizierungs-Token, das mit der Authentifizierungs-API abgerufen wird. Das Authentifizierungs-Token muss als eine der Header-Eingaben an die BLM-Import-API weitergegeben werden.
  5. Sobald Ihre Anmeldedaten authentifiziert sind, geben Sie Parameter wie den Paketpfad und die Prüfsumme an, die als Token beim Export in den Textkörperdaten generiert wurde.

    Referenzbeispiel:

    {

    "packagePath":"tempshare\\datashare\\Finance Department\\Finance Package_20171221-154403.aapkg",

    "checksum":"ZLyQ+Lbu2N+beEuXf6qd2Qi9uwi3BZxApn57C7mYjKQ="

    }

Tipp: Sie können die Antwort der BLM-Export-API kopieren und direkt als Eingabe an die BLM-Import-API weitergeben, wenn der Paketpfad übereinstimmt und für den BLM-Import-API-Nutzer zugänglich ist.

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 Stellen Sie sicher, dass die Datei/der Bot in Enterprise Control Room vorhanden ist.
501 Berechtigungsfehler Stellen Sie sicher, dass Sie über die Berechtigungen Bots exportieren/importieren bzw. Hochladen/Herunterladen verfügen.

API-Dienstprogramm zum Exportieren und Importieren

Um mehrere Bots zu exportieren und zu importieren, können Sie das Dienstprogramm von Automation Anywhere verwenden; es besteht aus Batch- und Jar-Dateien.*

* Java-Version 1.8 und höher

Exportieren von Bots

Mit dem Dienstprogramm „Enterprise Control Room Bot Lifecycle Management Export“ können Sie mehrere Bots aus einem Enterprise Control Room-Repository exportieren. So verwenden Sie die Batchdatei zum Exportieren von TaskBots aus dem Enterprise Control Room-Repository:

  1. Öffnen Sie die BLM-Exportbatchdatei, die die zum Exportieren von Bots aus Enterprise Control Room benötigten API-Befehle und Parameter enthält. Diese Datei enthält als Hilfestellung auch Beispielparameter.
    Anmerkung: Das Dienstprogramm verwendet die BLM-Export-API für den Export mehrerer Bots im Hintergrund. Beachten Sie die Voraussetzungen. BLM-Export-Batchdatei
    Tipp: Sie sollten vor dem Exportieren eine Kopie der Batchdatei anlegen.
  2. Sie müssen zum Exportieren der TaskBots und der abhängigen Dateien die folgenden Parameter in der Datei angeben:
    • Enterprise Control Room-Instanz als Parameter source_CR

      Zum Beispiel http://stagingCR-mydomain.com:8081/

    • Eigene Anmeldedaten für Enterprise Control Room als Parameter username und password

      Zum Beispiel username: Mike, password: Mike@123

    • TaskBot-Dateinamen als Parameter export_files. Sie können mehrere Bots/Dateien durch Kommata trennen.

      Zum Beispiel Automation Anywhere\\My Tasks\\Finance Bots\\Account Reconciliation_master.atmx,Automation Anywhere\\My Tasks\\Finance REM Bots\\Comparison Data.atmx

    • TaskBot-Repository-Pfadname als Parameter export_directories. Verwenden Sie diese Option, wenn Sie eine große Anzahl von Bots aus Ordnern exportieren möchten.

      Zum Beispiel Automation Anywhere\\My Tasks\\Utilities Bots\\312018, Automation Anywhere\\My Tasks\\Sample Tasks\\Analytics Tasks

    • CSV-Dateinamen mit dem Pfad als Parameter export_CSVs. Verwenden Sie dies, wenn Sie Bots/Dateien aus einer externen CSV- oder TXT-Datei exportieren möchten.
      • Sie können Dateinamen, Verzeichnisse und CSV-Dateien kombinieren, um mehrere Dateien aus mehreren Quellen zu exportieren.

        Zum Beispiel Automation Anywhere\My Tasks\Finance\Bank Account Reconcilation.atmx, Automation Anywhere\My Tasks\Banking\Audit Certification Generation.atmx, Automation Anywhere\My MetaBots\Import Customer Data.mbot, Automation Anywhere\My Docs\daily sales data.xlsx

      • Sie müssen mindestens einen Parameter übergeben und die Werte für nicht benötigte Parameter leer lassen.

        Zum Beispiel SET export_CSVs=""

    • Name des Pakets als Parameter package_name. Diese Datei wird als komprimierte Datei gespeichert, die zum Importieren der Bots in eine andere Enterprise Control Room-Instanz dient.

      Zum Beispiel Bank Account Reconciliation

    • Zielpfad des Pakets als Parameter package_path.
      Anmerkung: Dies kann entweder ein freigegebenes Laufwerk sein oder der Enterprise Control Room-Rechnerpfad, für den der Enterprise Control Room-Servicenutzer Schreibrechte benötigt.
      Zum Beispiel \\\\Netzwerkfreigabe\\BLM Export Packages
  3. Führen Sie die Batchdatei aus, um den Exportbefehl zu starten.
  4. Stellen Sie sicher, dass sich das Paket an dem im Parameter package_path angegebenen Pfad befindet.

    Dieses Paket wird vom Enterprise Control Room-Nutzer zum Importieren der Bots in eine andere Instanz von Enterprise Control Room verwendet.

Beispielcode

SET source_CR=<Enterprise Control Room-URL>

SET username=<Enterprise Control Room-Nutzername>

SET password=<Enterprise Control Room-Kennwort>

SET export_files="<durch Komma getrennte Liste der zu exportierenden Bots>"

SET export_directories="<durch Komma getrennte Liste der zu exportierenden Verzeichnisse>"

SET export_CSVs="<durch Komma getrennte Liste der CSV-Dateien mit den zu exportierenden Inhalten>"

SET package_name=<Name des Exportpakets>

SET package_path=<Pfad, in den das Paket exportiert wird>

java -jar %utility_path% -Oexport -H%source_CR% -U%username% -P%password% -N%package_name% -K%package_path% -F%export_files% -D%package_path% -C%export_CSVs%

pause

@echo off

REM *****************************SAMPLE PARAMETERS***************************************

REM SET source_CR=http://123.456.78.90:8080

REM SET username=Mike

REM SET password=Mike@123

REM SET export_files="Automation Anywhere\\My Tasks\\Finance Bots\\Account Reconciliation_master.atmx,Automation Anywhere\\My Tasks\\Finance REM Bots\\Comparison Data.atmx"

REM SET export_directories="Automation Anywhere\\My Tasks\\Utilities Bots\\312018"

REM SET export_CSVs="D:\BLM\Account Reconciliation Bots.csv"

REM SET package_name=Bank Account Reconciliation

REM SET package_path=\\\\network_share\\BLM Export Packages

REM SET utility_path=D:\BLM\BLM_Export_Import_Utility-1.0.jar

Importieren von Bots

Mit dem Dienstprogramm „Enterprise Control Room Bot Lifecycle Management Import“ können Sie mehrere Bots in ein Enterprise Control Room-Repository importieren. So verwenden Sie die Batchdatei zum Importieren von TaskBots in das Enterprise Control Room-Repository:

  1. Öffnen Sie die BLM-Importbatchdatei, die die zum Importieren von Bots in Enterprise Control Room benötigten API-Befehle und Parameter enthält. Diese Datei enthält als Hilfestellung auch Beispielparameter.
    Tipp: Sie sollten vor dem Importieren eine Kopie der Batchdatei anlegen.
  2. Sie müssen zum Importieren der TaskBots und der abhängigen Dateien die folgenden Parameter in der Datei angeben:
    1. Enterprise Control Room-Zielinstanz als Parameter target_CR

      Zum Beispiel http://prodCR-mydomain.com:80/

    2. eigene Anmeldedaten für Enterprise Control Room als Parameter username und password

      Zum Beispiel username: John.Smith, password: John@123

    3. absoluter Pfadname des Exportpakets als Parameter package_path

      Zum Beispiel \\\\Netzwerkfreigabe\\BLM Export Packages

  3. Führen Sie die Batchdatei aus, um den Importbefehl zu starten.
  4. Sie können die in das Enterprise Control Room-Bot-Repository importierten Bots anhand der Liste der exportierten oder importierten Bots/Dateien in der Datei BLM Logs.log überprüfen. Diese Datei wird im selben Ordner wie das Dienstprogramm (.jar-Datei) gespeichert.

Beispielcode

SET target_CR=<URL für den Ziel-Enterprise Control Room>

SET username=<Enterprise Control Room-Nutzername>

SET password=<Enterprise Control Room-Kennwort>

SET package_path=<absoluter Pfad für das Exportpaket>

java -jar %utility_path% -Oimport -S%package_path% -U%username% -P%password% -H%target_CR%

pause

@echo off

REM *****************************SAMPLE PARAMETERS***************************************

REM SET target_CR=http://987.654.32.10:8080

REM SET username=John

REM SET password=John@123

REM SET package_path=\\\\network_share\\BLM Export Packages

REM SET utility_path=D:\BLM\BLM_Export_Import_Utility-1.0.jar

Audit-Protokolle

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

Feedback senden