Lesen und beachten Sie die Automation Anywhere-Dokumentation

Automation Anywhere

Inhalt schließen

Inhalte

Inhalt öffnen

API für die Datenmigration von Enterprise Control Room 10.x zu Enterprise Control Room 11.x

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

API für die Datenmigration von Enterprise Control Room 10.x zu Enterprise Control Room 11.x

Als Enterprise Control Room-Administrator mit der Rollenberechtigung zum Anzeigen und Verwalten von Migrationen können Sie mit den Migrations-APIs Daten von Enterprise Control Room 10.x zur aktuellen Version Enterprise Control Room 11.x migrieren.

Die Migrations-APIs bieten folgende Möglichkeiten:

  1. Speichern/Aktualisieren der Verbindungskonfiguration in der Datenbank von Enterprise Control Room 10.x
  2. Speichern/Aktualisieren der Verbindungskonfiguration in der Datenbank von Bot Insight 2.x, sofern verfügbar
  3. Angeben von Option zum Migrieren von Daten basierend auf Rollen, Nutzern oder Bots
  4. Abrufen einer Liste mit Daten basierend auf der für die Migration angegebenen Option, d. h. Rollen, Nutzer oder Bots
  5. Anzeigen einer Übersicht über den Migrationsfortschritt
  6. Anzeigen der Migrationsstatistik mit der Anzahl der Entitäten pro Migration, die erfolgreich/fehlerhaft migriert wurden
  7. Abrufen einer Liste mit neuen und aktualisierten Bots von Enterprise Control Room 10.x nach der Migration
  8. Massenmigration von Dateien aus dem Enterprise Control Room 10.x-Ordner „My Docs“ nach der Migration

Alternativ können Sie die Daten über die Nutzeroberfläche von Enterprise Control Room mit dem Migrationsassistenten (Administration > Migration) migrieren. Details finden Sie unter Migration – Übersicht.

Anmerkung: Die Beispiele in diesem Thema dienen lediglich als Referenz.

API-Endpunkt

Greifen Sie über die folgenden Endpunkte auf die API zu:

  1. Verwenden Sie für den Migrationsprozess <Enterprise Control Room-URL>/v2/migration.
  2. Verwenden Sie zum Migrieren von Dateien aus dem Ordner My Docs der Enterprise Control Room 10.x-Quelle nach Abschluss der Migration <Enterprise Control Room-URL>/v1/migration.

Beispiel:

https://crdevenv.com:81/v2/migration

Migrationsprozess-APIs

Mit den Migrations-APIs können Sie Daten mit dem zuvor genannten Endpunkt von Enterprise Control Room 10.x zu Enterprise Control Room 11.x migrieren.

Bevor Sie auf die Migrations-APIs zugreifen können, müssen Sie zuerst die Authentifizierungs-API verwenden und sie als Token übergeben, um eine bestimmte Migrations-API verwenden zu können.

  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. Geben Sie die folgende Anfrage-Payload in Headern an:

    "X-Authorization": "Authorization token"

    "Content-Type": “application/json“

  3. Geben Sie die folgende Anfrage-Payload im Textkörper an:

    {

    "username": "<Nutzername>",

    "password": "<Kennwort>"

    }
    • Beispiel:

      {

      "usename": "Ellie.Brown",

      "password": "12345678"

      }

1. Verbindung zur Enterprise Control Room-Quelldatenbank herstellen

Mit dieser API können Sie die Verbindungskonfiguration in der Enterprise Control Room 10.x-Quelldatenbank speichern und aktualisieren.

  1. Geben Sie die Parameter „X-Authorization“ und „Content Type“ in Headern an.
  2. Geben Sie im Textkörper die Parameter für die Anmeldedaten an.
  3. Verwenden Sie die POST-Methode, um mit dem Endpunkt http(s)://<Hostname:Port>/v2/migration/connection eine Verbindung zur Datenbank von Enterprise Control Room 10.x herzustellen.
    • Zum Beispielhttps://crdevenv.com:81/v2/migration/connection
  4. Geben Sie die folgenden Parameter für die Anfrage-Payload im Textkörper an:

    {

    "host": "string", "port": 0, "databaseName": "string", "username": "string", "password": "string", "integratedSecurity": true, "encrypt": true, "privateKey": "string", "repoPath": "string"

    }
    • Beispiel:

      {

      "host": "PRODUCTLT",

      "port": 1433,

      "databaseName": "CR104MIG",

      "username": "Ellie.Brown",

      "password": "12345678",

      "integratedSecurity": true,

      "encrypt": true,

      "privateKey": "ABC123",

      "repoPath": "D:\\Data\Automation Anywhere Server Files"

      }

  5. Klicken Sie auf Senden.

Parameterbeschreibung

Parameter Beschreibung
host Hostname der Enterprise Control Room-Quelldatenbank
port Port-Nummer der Enterprise Control Room-Quelldatenbank
databaseName Name der Enterprise Control Room-Quelldatenbank
username Nutzername für die Verbindung zur Datenbank
password Kennwort für die Verbindung zur Datenbank
integratedSecurity Gibt an, ob die Verbindung zur Quelldatenbank mit der Windows-Authentifizierung hergestellt werden soll. Verwenden Sie true, wenn Sie die Windows-Authentifizierung verwenden möchten. Der Standardwert lautet false.
encrypt Gibt an, ob eine sichere Verbindung zur Quelldatenbank verwendet werden soll. Legen Sie true fest, wenn Sie eine sichere Verbindung verwenden möchten. Der Standardwert lautet false.
privateKey Der private Schlüssel zum Entschlüsseln der Anmeldedaten in der Quelldatenbank. Diesen können Sie während der Ersteinrichtung von Enterprise Control Room konfigurieren.
repoPath Der freigegebene Repository-Pfad, in dem das Enterprise Control Room 10.x-Repository gespeichert wird

2. Gespeicherte Verbindungsdetails abrufen

Mit dieser API können Sie die gespeicherten Verbindungsdetails aus der Enterprise Control Room 10.x-Quelldatenbank abrufen, aus der die Daten migriert werden sollen.

  1. Geben Sie die Parameter „X-Authorization“ und „Content Type“ in Headern an.
  2. Geben Sie im Textkörper die Parameter für die Anmeldedaten an.
  3. Verwenden Sie die GET-Methode, um mithilfe des Endpunkts http(s)://<Hostname:Port>/v2/migration/connection die Verbindungskonfiguration der Enterprise Control Room 10.x-Datenbank abzurufen.
    • Zum Beispielhttps://crdevenv.com:81/v2/migration/connection
  4. Klicken Sie auf Senden
  5. Sie können die Ergebnisse in den Textkörperdaten anzeigen:

    {

    "host": "productlt",

    "port": 1433,

    "databaseName": "CR104MIG",

    "username": "",

    "password": "",

    "integratedSecurity": true,

    "encrypt": false,

    "privateKey": "",

    "repoPath": "D:\\DATA\AUTOMATION ANYWHERE SERVER FILES"

    }

Parameterbeschreibung

Parameter Beschreibung
host Hostname der Quelldatenbank
port Port der Quelldatenbank
databaseName Name der Quelldatenbank
username Nutzername für die Verbindung zur Quelldatenbank
password Kennwort für die Verbindung zur Quelldatenbank
integratedSecurity Gibt an, ob die Verbindung zur Quelldatenbank mit der Windows-Authentifizierung hergestellt werden soll (Standardwert: false)
encrypt Gibt an, ob die Verbindung zur Quelldatenbank über eine sichere Verbindung hergestellt werden soll (Standardwert: false)
privateKey Privater Schlüssel zum Entschlüsseln der Anmeldedaten in der Quelldatenbank
repoPath Der freigegebene Repository-Pfad, in dem das Enterprise Control Room 10.x-Repository gespeichert wird

3. Verbindung zur Bot Insight 2.x-Datenbank herstellen, sofern verfügbar

Mit dieser API können Sie gegebenenfalls eine Verbindung zur Bot Insight 2.x-Quelldatenbank herstellen, um Analysedaten zu migrieren.

  1. Geben Sie die Parameter „X-Authorization“ und „Content Type“ in Headern an.
  2. Geben Sie im Textkörper die Parameter für die Anmeldedaten an.
  3. Verwenden Sie die POST-Methode, um mit dem Endpunkt http(s)://<Hostname:Port>/v2/migration/connection /botinsight eine Verbindung zur Bot Insight-Datenbank herzustellen.
    • Zum Beispiel: https://crdevenv.com:81/v2/migration/connection/botinsight
  4. Geben Sie die folgenden Parameter für die Anfrage-Payload im Textkörper an:

    {

    "host": "string",

    "port": 0,

    "databaseName": "string",

    "username": "string",

    "password": "string",

    "integratedSecurity": true,

    "encrypt": true,

    "serverUrl": "string"

    }
    • Beispiel:

      {

      "host": "Productlt",

      "port": 8091,

      "databaseName": "BotInsight",

      "username": "Ellie.Brown",

      "password": "12345678",

      "integratedSecurity": true,

      "encrypt": true,

      "serverUrl": "https://productlt.aae.com:82/analytics"

      }

  5. Klicken Sie auf Senden
  6. Die Verbindungsparameter werden erfolgreich gespeichert, wenn der Antwortstatus 200 Successful operation lautet.

Parameterbeschreibung

Parameter Beschreibung
host Hostname der Bot Insight-Quelldatenbank
port Port-Nummer der Bot Insight-Quelldatenbank
databaseName Name der Bot Insight-Quelldatenbank
username Nutzername für die Verbindung zur Datenbank
password Kennwort für die Verbindung zur Datenbank
integratedSecurity Gibt an, ob die Verbindung zur Quelldatenbank mit der Windows-Authentifizierung hergestellt werden soll. Verwenden Sie true, wenn Sie die Windows-Authentifizierung verwenden möchten. Der Standardwert lautet false.
encrypt Gibt an, ob eine sichere Verbindung zur Quelldatenbank verwendet werden soll. Legen Sie true fest, wenn Sie eine sichere Verbindung verwenden möchten. Der Standardwert lautet false.
serverUrl Server-URL, unter der sich der Bot Insight Visualization ServerPort befindet

4. Gespeicherte Verbindungsdetails abrufen

Mit dieser API können Sie die gespeicherten Verbindungsdetails aus der Bot Insight 2.x-Quelldatenbank abrufen, aus der die Daten migriert werden sollen.

  1. Geben Sie die Parameter „X-Authorization“ und „Content Type“ in Headern an.
  2. Geben Sie im Textkörper die Parameter für die Anmeldedaten an.
  3. Verwenden Sie die GET-Methode, um mithilfe des Endpunkts http(s)://<Hostname:Port>/v2/migration/connection/botinsight die Verbindungskonfiguration der Enterprise Control Room 10.x-Datenbank abzurufen.
    • Zum Beispiel: https://crdevenv.com:81/v2/migration/connection/botinsight
  4. Klicken Sie auf Senden
  5. Die Verbindungsparameter werden erfolgreich gespeichert, wenn der Antwortstatus 200 Migration config lautet.
  6. Sie können die Ergebnisse in den Textkörperdaten anzeigen:

    {

    "host": "Productlt",

    "port": 8091,

    "databaseName": "BotInsight",

    "username": "Ellie.Brown",

    "password": "12345678",

    "integratedSecurity": true,

    "encrypt": true,

    "serverUrl": "https://productlt.aae.com:82/analytics"

    }

Parameterbeschreibung

Parameter Beschreibung
host Hostname der Bot Insight-Quelldatenbank
port Port-Nummer der Bot Insight-Quelldatenbank
databaseName Name der Bot Insight-Quelldatenbank
username Nutzername für die Verbindung zur Datenbank
password Kennwort für die Verbindung zur Datenbank
integratedSecurity Gibt an, ob die Verbindung zur Quelldatenbank mit der Windows-Authentifizierung hergestellt werden soll. Verwenden Sie true, wenn Sie die Windows-Authentifizierung verwenden möchten. Der Standardwert lautet false.
encrypt Gibt an, ob eine sichere Verbindung zur Quelldatenbank verwendet werden soll. Legen Sie true fest, wenn Sie eine sichere Verbindung verwenden möchten. Der Standardwert lautet false.
serverUrl Server-URL, unter der sich der Bot Insight Visualization ServerPort befindet

5. Liste der in der Quelldatenbank für die Migration verfügbaren Entitäten mit dem TYPE-Parameter

Diese API gibt eine Liste der in der Quelldatenbank für die Migration verfügbaren Entitäten nach dem TYPE-Parameter zurück. Mit einer beliebigen Option – Rolle, Nutzer, Bot oder Zeitplan – können Sie alle Daten migrieren, die dem ausgewählten Parameter zugeordnet sind.

Anmerkung: Verwenden Sie für die selektive Migration von Daten, d. h. die Auswahl bestimmter Daten anhand des angegebenen Parameters, den Migrationsassistenten von Enterprise Control Room.
  1. Geben Sie in Headern die „X-Autorisierung“-Parameter an.
  2. Verwenden Sie die GET-Methode, um eine Verbindung zur Enterprise Control Room-Datenbank mit folgendem Endpunkt herzustellen: http(s)://<Hostname:Port>/v2/migration/connection /entities, gefolgt vom TYPE-Parameter, der eine der folgenden Optionen enthalten kann: Rollen, Nutzer, Bots oder Planungen.
    • Zum Beispiel https://crdevenv.com:81/v2/migration/connection/entities?Type=ROLE
  3. Klicken Sie auf „Senden“.
  4. Die Daten werden zurückgegeben, wenn der Antwortstatus 200 lautet.
  5. Die Liste der Entitäten, die auf dem TYPE-Parameter basieren, wird im Textkörper angezeigt.

    {

    "entities":

    [

    { "id": "0", "type": "ROLE", "sourceId": "1", "targetId": "0", "name": "Admin", "status": "SUCCESS", "reason": "" },

    { "id": "0", "type": "ROLE", "sourceId": "2", "targetId": "0", "name": "Basic", "status": "SUCCESS", "reason": "" },

    { "id": "0", "type": "ROLE", "sourceId": "3", "targetId": "0", "name": "IQBotValidator", "status": "SUCCESS", "reason": "" },

    { "id": "0", "type": "ROLE", "sourceId": "4", "targetId": "0", "name": "AnalyticsExperts", "status": "SUCCESS", "reason": "" },

    { "id": "0", "type": "ROLE", "sourceId": "5", "targetId": "0", "name": "AnalyticsConsumers", "status": "SUCCESS", "reason": "" },

    { "id": "0", "type": "ROLE", "sourceId": "6", "targetId": "0", "name": "BotAgentUser", "status": "SUCCESS", "reason": "" },

    { "id": "0", "type": "ROLE", "sourceId": "7", "targetId": "0", "name": "BotFarmAdmin", "status": "SUCCESS", "reason": "" },

    { "id": "0", "type": "ROLE", "sourceId": "8", "targetId": "0", "name": "IQBotServices", "status": "SUCCESS", "reason": "" },

    { "id": "0", "type": "ROLE", "sourceId": "9", "targetId": "0", "name": "Bot Creator 10x", "status": "SUCCESS", "reason": "" },

    { "id": "0", "type": "ROLE", "sourceId": "10", "targetId": "0", "name": "Bot Runner 10x", "status": "SUCCESS", "reason": "" },

    { "id": "0", "type": "ROLE", "sourceId": "11", "targetId": "0", "name": "Bot Scheduler 10x", "status": "SUCCESS", "reason": "" }

    ]

    }

Parameterbeschreibung

Parameter Beschreibung
id Migrations-ID
type Typ der für die Migration ausgewählten Entität: Rolle, Nutzer oder Bot
sourceId ID der Entität in der Quelldatenbank
targetId ID der Entität nach der Migration zur Zieldatenbank
name Name der Entität in der Quelldatenbank
status Migrationsstatus dieser Entität
reason Grund für die fehlerhafte Migration dieser Entität

6. Migrationsdaten anhand von Nutzereingaben vorbereiten

Mit dieser API können Sie Entitäten mit zugehörigen Daten auf Grundlage des Unterabschnitts des für die Migration angegebenen Entitätstyps migrieren.

  1. Geben Sie die Parameter „X-Authorization“ und „Content Type“ in Headern an.
  2. Verwenden Sie die POST-Methode, um die Daten mithilfe des Endpunkts http(s)://<Hostname:Port>/v2/migration/prepare zu migrieren.
    • Zum Beispiel: https://crdevenv.com:81/v2/migration/prepare
  3. Geben Sie die folgende Anfrage-Payload im Textkörper an:

    {

    "selected":

    [

    { "type": "<Entitätstyp>",

    "sourceId": "string" }

    ],

    "excludes": [ "<Entitätstyp>"

    ]

    }
    • Beispiel:

      { "selected": [ { "type": "ROLE", "sourceId": "12" } ], "excludes": [ "BOT" ] }

  4. Klicken Sie auf „Senden“.
  5. Die Daten werden für die Migration erfolgreich aufgelistet, wenn der Antwortstatus 200 lautet.
  6. Das Ergebnis wird im Textkörper angezeigt.

    { "selected":

    [

    { "type": "ROLE", "sourceId": "12" } ],

    "excludes": [ "BOT" ]

    }

Parameterbeschreibung

Parameter Beschreibung
type Typ der für die Migration ausgewählten Entität: Rolle, Nutzer oder Bot und Planungen
sourceId ID der Entität in der Quelldatenbank
excludes

Der Name der Entität, die von der Migration ausgeschlossen wird. Die Optionen sind in Abhängigkeit vom ausgewählten Entitätstyp verfügbar.

Wenn Sie also Rolle oder Nutzer auswählen, können Sie Bots und Planungen ausschließen; und wenn Sie Bots und Planungen auswählen, können Sie MetaBots ausschließen und/oder vorhandene Bots überschreiben.

7. Migration starten

Mit dieser API können Sie den Migrationsprozess starten.

  1. Geben Sie in Headern die „X-Autorisierung“-Parameter an.
  2. Verwenden Sie die POST-Methode, um die Daten mithilfe des Endpunkts http(s)://<Hostname:Port>/v2/migration/start/async zu migrieren.
    • Zum Beispiel: https://crdevenv.com:81/v2/migration/start/async

  3. Klicken Sie auf „Senden“.
  4. Die Datenmigration startet erfolgreich, wenn der Antwortstatus 200 Successful operation lautet.
  5. Das Ergebnis wird in den Textkörperdaten angezeigt.

    {

    "id": 1,

    "name": "2018.07.17.16.13.48.ellie.brown",

    "createdBy": 1,

    "migrationType": "ROLE_EXCLUDE_BOT_SCHEDULE"

    }

Parameterbeschreibung

Parameter Beschreibung
id Migrations-ID
name Name des Nutzers, der die Migration initiiert hat
createdBy ID der Entität, die die Migration gestartet hat, d. h. des Enterprise Control Room-Administrators
migrationType Der ausgewählte Migrationstyp: Rolle, Nutzer oder Bots und Planungen

8. Migrationsobjekt nach ID

Diese API listet die Migrationsobjektdetails basierend auf der ID auf, die mit der API zum Starten der Migration generiert wird.

  1. Geben Sie in Headern die „X-Autorisierung“-Parameter an.
  2. Verwenden Sie die GET-Methode, um Objektdetails anhand der ID unter Verwendung des Endpunkts http(s)://<Hostname:Port>/v2/migration/<id> abzurufen.
    • Beispiel: https://crdevenv.com:81/v2/migration/9

  3. Klicken Sie auf „Senden“.
  4. Die Objektdetails werden erfolgreich aufgelistet, wenn der Antwortstatus 200 lautet.
  5. Die Details werden in den Textkörperdaten angezeigt:

    {

    "id": "9",

    "name": "2018.07.17.16.13.48.ellie.brown",

    "startTime": "2018-07-17T10:43:48.127Z",

    "endTime": "2018-07-17T10:43:49.833Z",

    "createdBy": "1",

    "migrationType": "ROLE_EXCLUDE_BOT_SCHEDULE",

    "entities": []

    }

Parameterbeschreibung

Parameter Beschreibung
id Migrations-ID
name Name des Nutzers, der die Migration initiiert hat
startTime Der Zeitpunkt, zu dem die Migration eingeleitet wurde
endTime Der Zeitpunkt, zu dem die Migration beendet wurde
createdBy ID der Entität, die die Migration gestartet hat, d. h. des Enterprise Control Room-Administrators
entities Liste der während des Migrationsprozesses migrierten Entitäten
migrationType Der ausgewählte Migrationstyp: Rolle, Nutzer oder Bots und Planungen

9. Migrationsfortschritt

Mit dieser API können Sie den Fortschritt der laufenden Migration anzeigen.

  1. Geben Sie die Parameter „X-Authorization“ und „Content Type“ in Headern an.
  2. Geben Sie im Textkörper die Parameter für die Anmeldedaten an.
  3. Verwenden Sie die GET-Methode, um Objektdetails anhand der ID unter Verwendung des Endpunkts http(s)://<Hostname:Port>/v2/migration/pogress abzurufen.
    • Zum Beispiel: https://crdevenv.com:81/v2/migration/progress

  4. Klicken Sie auf „Senden“.
  5. Die Objektdetails werden erfolgreich aufgelistet, wenn der Antwortstatus 200 lautet.
  6. Die Details werden in den Textkörperdaten angezeigt:

    {

    "migration":

    { "id": "10", "name": "2018.07.17.16.55.59.ellie.brown", "startTime": "2018-07-17T11:25:59.800Z", "endTime": "2018-07-17T11:26:16.002Z", "createdBy": "1", "migrationType": "BOT_EXCLUDE_MetaBot", "entities": [] },

    "current": "SCHEDULE",

    "progress":

    {

    "BOT": { "total": "10", "successful": "7", "failed": "0", "skipped": "3" },

    "SCHEDULE": { "total": "8", "successful": "8", "failed": "0", "skipped": "0" }

    }

    }

Parameterbeschreibung

Parameter Beschreibung
id Migrations-ID
name Angezeigter Migrationsname
startTime Zeitstempel beim Start des Migrationsprozesses
endTime Zeitstempel beim Ende des Migrationsprozesses (Null, wenn die Migration läuft)
createdBy ID des Nutzers, der den Migrationsprozess erstellt/gestartet hat
current Art der Entität, die gerade migriert wird: ROLE, USER, CREDENTIAL, BOT oder SCHEDULE
progress

Fortschritt der Entitäten:

  • total: Gesamtanzahl der zu migrierenden Entitäten eines bestimmten Typs
  • successful: Anzahl der erfolgreich migrierten Entitäten
  • failed: Anzahl der fehlerhaft migrierten Entitäten
  • skipped: Anzahl der Entitäten, die während der Migration ausgelassen wurden

10. Migrationsstatistik – Anzahl der Entitäten pro Migration, die erfolgreich/fehlerhaft migriert wurden

Mit dieser API können Sie die Anzahl der erfolgreich oder fehlerhaft migrierten Entitäten pro Migration anzeigen.

  1. Geben Sie in Headern die „X-Autorisierung“-Parameter an.
  2. Verwenden Sie die GET-Methode, um Objektdetails anhand der ID unter Verwendung des Endpunkts http(s)://<Hostname:Port>/v2/migration/statistics abzurufen.
    • Zum Beispiel: https://crdevenv.com:81/v2/migration/statistics

  3. Klicken Sie auf „Senden“.
  4. Die Objektdetails werden erfolgreich aufgelistet, wenn der Antwortstatus 200 lautet.
  5. Die Details werden in den Textkörperdaten angezeigt:

    {

    "items": [

    { "id": "1", "name": "2018.07.13.11.14.59.ellie.brown", "startTime": "2018-07-13T05:44:59.787Z", "endTime": "2018-07-13T06:56:25.537Z", "createdBy": "1", "duration": "4285s", "numSuccess": 0, "numFailed": 0, "numSkipped": 0 },

    { "id": "2", "name": "2018.07.13.12.28.08.ellie.brown", "startTime": "2018-07-13T06:58:09.283Z", "endTime": "2018-07-13T06:58:12.910Z", "createdBy": "1", "duration": "3s", "numSuccess": 1, "numFailed": 1, "numSkipped": 0 },

    { "id": "3", "name": "2018.07.13.12.40.34.ellie.brown", "startTime": "2018-07-13T07:10:34.470Z", "endTime": "2018-07-13T07:10:40.060Z", "createdBy": "1", "duration": "5s", "numSuccess": 10, "numFailed": 0, "numSkipped": 0 },

    { "id": "4", "name": "2018.07.13.12.42.19.ellie.brown", "startTime": "2018-07-13T07:12:20.007Z", "endTime": "2018-07-13T07:12:23.107Z", "createdBy": "1", "duration": "3s", "numSuccess": 0, "numFailed": 0, "numSkipped": 6 },

    { "id": "5", "name": "2018.07.13.13.39.53.ellie.brown", "startTime": "2018-07-13T08:09:53.113Z", "endTime": "2018-07-13T08:10:02.673Z", "createdBy": "1", "duration": "9s", "numSuccess": 4, "numFailed": 0, "numSkipped": 0 }

    ]

    }

Parameterbeschreibung

Parameter Beschreibung
id Migrations-ID
name Angezeigter Migrationsname
startTime Zeitstempel beim Start des Migrationsprozesses
endTime Zeitstempel beim Ende des Migrationsprozesses (Null, wenn die Migration läuft)
createdBy ID des Nutzers, der das Objekt erstellt hat
duration Migrationsdauer in Sekunden oder Nanosekunden
numSuccess Anzahl der erfolgreich migrierten Elemente
numFailed Anzahl der Elemente, deren Migration fehlgeschlagen ist
numSkipped Anzahl der Elemente, die während der Migration ausgelassen wurden

APIs nach dem Migrationsprozess

Verwenden Sie die APIs nach Abschluss des Migrationsprozesses für folgende Aktionen:

  1. Importieren von Dateien aus dem Enterprise Control Room 10.x-Ordner „My Docs“
  2. Rufen Sie die Liste der neuen oder geänderten Bots von Enterprise Control Room 10.x seit der letzten Migrationsausführung ab.
    Anmerkung: Bevor Sie auf die APIs zugreifen, müssen Sie zuerst die Authentifizierungs-API verwenden und als Token übergeben, um eine bestimmte Migrations-API zu verwenden.
  3. 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

  4. Geben Sie die folgende Anfrage-Payload in Headern an:

    "X-Authorization": "Authorization token"

    "Content-Type": “application/json“

  5. Geben Sie die folgende Anfrage-Payload im Textkörper an:

    {

    "username": "<Nutzername>",

    "password": "<Kennwort>"

    }

  • Beispiel:

    {

    "usename": "Ellie.Brown",

    "password": "12345678"

    }

Wichtig: Wenn bei der Verwendung einer oder aller APIs nach der Migration der Fehlercode 404 angezeigt wird, rufen Sie mit der API erneut die Liste der Stammordner aus Enterprise Control Room 10.x ab, d. h. http(s)://<Hostname:Port>/v1/migration/legacyrepository/rootDirectories.

A. Importieren von Dateien aus dem Ordner „My Docs“

Mit einer bestimmten Gruppe von APIs können Sie Dateien aus dem Enterprise Control Room 10.x-Ordner „My Docs“ migrieren. Mit diesen APIs können Sie eine große Anzahl von Dateien importieren, die entweder in Bots als Abhängigkeiten oder in eigenständigen Aufgaben verwendet werden können, die hilfreich für die Automatisierung sind.

1. Liste der Stammordner aus Enterprise Control Room 10.x abrufen

Mit dieser API können Sie die Liste der im Enterprise Control Room 10.x-Repository verfügbaren Ordner abrufen. Dies hilft Ihnen, die Ordnerstruktur im Quell-Enterprise Control Room nachzuvollziehen.

  1. Geben Sie in Headern die „X-Autorisierung“-Parameter an.
  2. Verwenden Sie die GET-Methode, um Objektdetails anhand der ID unter Verwendung des Endpunkts http(s)://<Hostname:Port>/v1/migration/legacyrepository/rootDirectories, gefolgt von dem Parameter excludeMetaBot), abzurufen.
    • Zum Beispiel: https://crdevenv.com:81/v1/migration/legacyrepository/rootDirectories?excludeMetaBot=true

  3. Klicken Sie auf „Senden“.
  4. Die Objektdetails werden erfolgreich aufgelistet, wenn der Antwortstatus 200 lautet.
  5. Die Details werden in den Textkörperdaten angezeigt:

    [

    { "name": "My Docs", "path": "Automation Anywhere\\My Docs" },

    { "name": "My Exes", "path": "Automation Anywhere\\My Exes" },

    { "name": "My Reports", "path": "Automation Anywhere\\My Reports" },

    { "name": "My Scripts", "path": "Automation Anywhere\\My Scripts" },

    { "name": "My Tasks", "path": "Automation Anywhere\\My Tasks" },

    { "name": "My Workflow", "path": "Automation Anywhere\\My Workflow" }

    ]

Parameterbeschreibung

Parameter Beschreibung
name Name des Verzeichnisses/Ordners
path Verzeichnis-/Ordnerpfad

2. Liste der Unterordner eines Stammordners aus Control Room 10.x abrufen

Mit dieser API können Sie die Liste der Unterordner für einen bestimmten Stammordner abrufen, der im Enterprise Control Room 10.x-Repository verfügbar ist. Das hilft Ihnen, die Ordnerstruktur im Quell-Enterprise Control Room nachzuvollziehen.

  1. Geben Sie in Headern die „X-Autorisierung“-Parameter an.
  2. Verwenden Sie die GET-Methode, um Objektdetails anhand der ID unter Verwendung des Endpunkts http(s)://<Hostname:Port>/v1/migration/legacyrepository/childDirectories, gefolgt von dem Parameter path, abzurufen.
    • Zum Beispiel: https://crdevenv.com:81/v1/migration/legacyrepository/childDirectories?path=Automation Anywhere\My Docs

  3. Klicken Sie auf „Senden“.
  4. Die Objektdetails werden erfolgreich aufgelistet, wenn der Antwortstatus 200 lautet.
  5. Die Details werden in den Textkörperdaten angezeigt:

    {

    "folders":

    [

    { "name": "Log-Files", "path": "Automation Anywhere\\My Docs\\Log-Files" }

    ]

    }

Parameterbeschreibung

Parameter Beschreibung
folders Liste der Unterverzeichnisse
name Name des Verzeichnisses/Ordners
path Verzeichnis-/Ordnerpfad

3. Liste der Dateien in einem bestimmten Ordner abrufen

Mit dieser API können Sie die Liste der Dateien abrufen, die in einem bestimmten Ordner im Enterprise Control Room-Quell-Repository verfügbar sind.

  1. Geben Sie in Headern die „X-Autorisierung“-Parameter an.
  2. Verwenden Sie die GET-Methode, um Objektdetails anhand der ID unter Verwendung des Endpunkts http(s)://<Hostname:Port>/v1/migration/legacyrepository/childFiles, gefolgt von den Parametern path und excludeMetaBot), abzurufen.
    • https://crdevenv.com:81/v1/migration/legacyrepository/childFiles?path=Automation Anywhere\My Docs\Log-Files&excludeMetaBot=false

  3. Klicken Sie auf „Senden“.
  4. Die Objektdetails werden erfolgreich aufgelistet, wenn der Antwortstatus 200 lautet.
  5. Die Details werden in den Textkörperdaten angezeigt:

    {

    "files":

    [

    { "id": "280", "name": "ActiveMQServer-2018-Jul-17-2.log.zip", "path": "Automation Anywhere\\My Docs\\Log-Files\\ActiveMQServer-2018-Jul-17-2.log.zip" },

    { "id": "281", "name": "IgniteServer-2018-Jul-17-4.log.zip", "path": "Automation Anywhere\\My Docs\\Log-Files\\IgniteServer-2018-Jul-17-4.log.zip" },

    { "id": "283", "name": "WebCR_Ignite-2018-Jul-17-4.log.zip", "path": "Automation Anywhere\\My Docs\\Log-Files\\WebCR_Ignite-2018-Jul-17-4.log.zip" },

    { "id": "284", "name": "WebCR_License-2018-Jul-17-4.log.zip", "path": "Automation Anywhere\\My Docs\\Log-Files\\WebCR_License-2018-Jul-17-4.log.zip" },

    { "id": "292", "name": "WebCR_Migration-2018-Jul-17-4.log", "path": "Automation Anywhere\\My Docs\\Log-Files\\WebCR_Migration-2018-Jul-17-4.log" },

    { "id": "285", "name": "WebCR_Migration-2018-Jul-17-4.log.zip", "path": "Automation Anywhere\\My Docs\\Log-Files\\WebCR_Migration-2018-Jul-17-4.log.zip" },

    { "id": "293", "name": "WebCR_Migration-2018-Jul-17-4.txt", "path": "Automation Anywhere\\My Docs\\Log-Files\\WebCR_Migration-2018-Jul-17-4.txt" }

    ]

    }

Parameterbeschreibung

Parameter Beschreibung
files Liste der untergeordneten Dateien
id Datei-ID des Bots
name Name des Verzeichnisses/Ordners
path Verzeichnis-/Ordnerpfad

4. Einen Ordner in Enterprise Control Room 10.x nach Namen suchen

Mit dieser API können Sie einen Ordner anhand des angegebenen Namens im Enterprise Control Room-Quell-Repository My Docs suchen.

  1. Geben Sie in Headern die „X-Autorisierung“-Parameter an.
  2. Verwenden Sie die GET-Methode, um Objektdetails anhand der ID unter Verwendung des Endpunkts http(s)://<Hostname:Port>/v1/migration/legacyrepository/folders, gefolgt von dem Parameter „taskName“, abzurufen.
    • Zum Beispiel: https://crdevenv.com:81/v1/migration/legacyrepository/folders?taskName=Import-Table

  3. Klicken Sie auf „Senden“.
  4. Die Objektdetails werden erfolgreich aufgelistet, wenn der Antwortstatus 200 lautet.
  5. Die Details werden in den Textkörperdaten angezeigt:

    {

    "paths":

    [ "Automation Anywhere\\My Docs\\Import-Table" ]

    }

Parameterbeschreibung

Parameter Beschreibung
paths Auflistung des Verzeichnis-/Ordnerpfads

5. Eine Liste von Dateien für einen bestimmten Ordner in Enterprise Control Room 10.x abrufen

Mit dieser API können Sie die Liste der Dateien abrufen, die in einem bestimmten Ordner im Enterprise Control Room-Quell-Repository My Docs verfügbar sind.

  1. Geben Sie in Headern die „X-Autorisierung“-Parameter an.
  2. Verwenden Sie die POST-Methode, um eine Liste der Dateien für einen bestimmten Ordner mithilfe des Endpunkts http(s)://<Hostname:Port>/v1/legacyrepository/files abzurufen.
    • Zum Beispiel: https://crdevenv.com:81/v1/legacyrepository/files

  3. Geben Sie die Liste der Ordnerpfade als Anfrage-Payload im Textkörper an.

    [

    "string"

    ]
    • Zum Beispiel werden die verfügbaren Dateien folgendermaßen aufgelistet:

      [

      "Automation Anywhere\\My Docs\\Import-Table"

      ]

  4. Klicken Sie auf „Senden“.
  5. Die Objektdetails werden erfolgreich aufgelistet, wenn der Antwortstatus 200 lautet.
  6. Die Antwortdetails werden in den Textkörperdaten angezeigt:

    {

    "files":

    [

    { "id": 1281, "type": "BOT", "sourceId": "1281", "targetId": 0, "name": "Automation Anywhere\\My Docs\\Import-Table\\Import-Table.txt", "status": "SUCCESS", "reason": "" },

    { "id": 293, "type": "BOT", "sourceId": "293", "targetId": 0, "name": "Automation Anywhere\\My Docs\\Import-Table\\WebCR_Migration-2018-Jul-17-4.txt", "status": "SUCCESS", "reason": "" }

    ]

    }

Parameterbeschreibung

Parameter Beschreibung
files Liste der untergeordneten Dateien
type Dateityp
sourceId ID der Entität in der Quelldatenbank
targetId ID der Entität nach der Migration zur Zieldatenbank
name Name des Verzeichnisses/Ordners
status Status der Antwort: SUCCESS, SKIPPED oder FAILED
reason Beschreibung der Ursache für den Status FAILED oder SKIPPED

B. Migrieren der seit der letzten Migration zu Version 11.x neu erstellten oder geänderten Bots in Version 10.x

Mit dieser API können Sie eine Liste von Bots abrufen, die im Quell-Enterprise Control Room 10.x neu erstellt oder geändert wurden, nachdem die Daten bereits zum Ziel-Enterprise Control Room 11.x migriert wurden. Sie können damit Ihre 10.x-Umgebung weiter verwenden, während Sie die 11.x-Umgebung produktionsbereit machen.

  1. Geben Sie in Headern die „X-Autorisierung“-Parameter an.
  2. Verwenden Sie die POST-Methode, um Objektdetails anhand der ID unter Verwendung des Endpunkts http(s)://<Hostname:Port>/v1/legacyrepository/changedfiles abzurufen.
    • Zum Beispiel: https://crdevenv.com:81/v1/legacyrepository/changedfiles
  3. Geben Sie die Liste der Ordnerpfade als Anfrage-Payload im Textkörper an.

    {

    "changeSince": "<Datum und Uhrzeit der letzten Migration>"

    }

    • Zum Beispiel werden die Bot-Namen, die nach der Migration aktualisiert wurden, folgendermaßen aufgeführt:

      {

      "changeSince":"2018-06-25T12:05:00+05:30"

      }

    Tipp: Geben Sie nicht den Parameter changeSince zur Berücksichtigung der Differenz für das Datum und die Uhrzeit der letzten Migration an.
  4. Klicken Sie auf „Senden“.
  5. Die Objektdetails werden erfolgreich aufgelistet, wenn der Antwortstatus 200 lautet.
  6. Die Antwortdetails werden in den Textkörperdaten angezeigt:

    {

    "changedfiles":

    [

    { "type": "BOT", "sourceId": "6", "name": "Automation Anywhere\\My Tasks\\Sample Tasks\\Import-Table.atmx" },

    { "type": "BOT", "sourceId": "7", "name": "Automation Anywhere\\My Tasks\\Sample Tasks\\List-Variable.atmx" }

    ]

    }

Parameterbeschreibung

Parameter Beschreibung
changedFiles Liste der Entitäten, die seit der letzten Migrationsausführung geändert wurden oder neu hinzugekommen sind
type Entitätstyp
sourceId ID der Entität in der Quelldatenbank
name Name des Verzeichnisses/Ordners

API-Antwortcodes

Http(s)-Statuscode Antwort/Beschreibung Maßnahme
200 Vorgang erfolgreich n. v.
400 Ungültige Anforderung Mit gültigen Parametern erneut versuchen
401 Authentifizierung erforderlich Versuchen Sie es erneut, indem Sie Authentifizierungsparameter angeben.
403 Nicht autorisierter Zugriff Sie müssen über die erforderlichen Berechtigungen zum Ausführen dieses Vorgangs verfügen.
404 Nicht gefunden Die angeforderten Daten müssen in Enterprise Control Room vorhanden sein.
409 Konflikt Die angegebenen Parameter müssen korrekt sein
500 Interner Serverfehler Der Server muss betriebsbereit sein
501 Berechtigungsfehler Sicherstellen, dass Sie über die erforderliche Berechtigung verfügen

Audit-Protokolle

Das Auditprotokoll enthält einen Eintrag für jede migrierte Entität.

Auditprotokoll mit Details zu jeder migrierten Entität

Wenn der Migrationsprozess gestartet wird, wird im Auditprotokoll ein Eintrag Migration gestartet protokolliert. Analog wird bei Abschluss des Migrationsprozesses ein Eintrag Migration abgeschlossen protokolliert. Zwischen diesen beiden Einträgen werden Migrationseinträge für jede zu migrierende Entität protokolliert, z. B. die Vorgänge Erstellen, Aktualisieren oder Hochladen.

Klicken Sie auf , um Details dieses Prozesses anzuzeigen.
Feedback senden