API data migration from Enterprise 10 to Enterprise 11 Control Room

As a Control Room administrator with View and Manage Migration role permissions, use the Migration APIs to migrate data from Enterprise 10 to the latest Enterprise 11 Enterprise Control Room.

The Migration APIs allow you to,

  1. Save / update connection configuration to the 10.x Control Room database
  2. Save / update connection configuration to the 2.x Bot Insight database, if available
  3. Specify option to migrate data based on Roles, Users or Bots
  4. Fetch list of data based on option specified for migration that is, Roles, Users, or Bots
  5. View the migration progress summary
  6. View migration statistics of number of entities that succeeded / failed per migration
  7. Fetch list of new and updated bots from 10.x Control Room post migration
  8. Migrate files in bulk from the 10.x Control Room My docs folder post migration

Alternately, you can use the Migration wizard given in Administration > Migration module to migrate the data from the Control Room user interface. Refer Migration Overview for details.

Note: The examples provided in this article are for reference only.

API End Point

Use the following end points to access the API:

  1. For migration process use <Control Room URL>/v2/migration
  2. For migrating files from the My Docs folder of source 10.x Control Room after the migration process has completed use <Control Room URL>/v1/migration

For example,

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

Migration Process APIs

The Migration APIs allow you to migrate 10.x Control Room data to 11.x Control Room using the end point mentioned earlier.

Before accessing the Migration API's you must first use the authentication API and pass it as a token to use a particular Migration API.

  1. Use the POST method to generate a token using the end point http(s)://<hostname:port>/v1/authentication. For this provide the Control Room instance as Server Name /Hostname /IP and the Port number.

    For example,https://crdevenv.com:81/v1/authentication

  2. Provide the following request payload in Headers

    "X-Authorization" : "Authorization token"

    "Content-Type" : "application/json"

  3. Provide the following request payload in Body:

    {

    "username": "<Username>",

    "password": "<Password>"

    }

    For example,

    {

    "usename": "Ellie.Brown",

    "password": "12345678"

    }

1. Connect to source Control Room database

This API allows you to save and update the connection configuration to the source 10.x Control Room database.

  1. Provide the "X-Authorization" and "Content Type" parameters in Headers.
  2. Provide credential parameters in Body
  3. Use the POST method to connect to the 10.x Control Room database using the end point http(s)://<hostname:port>/v2/migration/connection

    For example,https://crdevenv.com:81/v2/migration/connection

  4. Provide the following request parameters in Body:

    {

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

    }

    For example,

    {

    "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. Click Send.

Parameter Description

Parameter Description
host Source Control Room database host name
port Source Control Room database port number
databaseName Source Control Room database name
username Username to connect to database
password Password to connect to database
integratedSecurity An indicator whether to use Windows authentication when connecting to source database. Set this to true if you want use Windows authentication. The default value is false
encrypt An indicator whether to use secure connection to source database. Set this to true if you want to use a secure connection. The default value is false
privateKey The private key to decrypt credential values in source database. This is available for configuration during the initial Control Room setup.
repoPath The shared repository path where Control Room 10.x repository is stored

2. Get stored connection details

This API allows you to fetch the stored connection details of source 10.x Control Room database from where the data can be migrated.

  1. Provide the "X-Authorization" and "Content Type" parameters in Headers.
  2. Provide credential parameters in Body
  3. Use the GET method to fetch the connection configuration of 10.x Control Room database using the end point http(s)://<hostname:port>/v2/migration/connection

    For example, https://crdevenv.com:81/v2/migration/connection

  4. Click Send
  5. You can view the result in Body data:

    {

    "host": "productlt",

    "port": 1433,

    "databaseName": "CR104MIG",

    "username": "",

    "password": "",

    "integratedSecurity": true,

    "encrypt": false,

    "privateKey": "",

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

    }

Parameter Description

Parameter Description
host Source database host
port Source database port
databaseName Source database name
username Username to connect to source database
password Password to connect to source database
integratedSecurity An indicator whether to use Windows authentication when connecting to source database, default value is false
encrypt An indicator whether to use secure connection to source database, default value is false
privateKey Private key to decrypt credential values in source database
repoPath The shared repository path where Control Room 10.x repository is stored

3. Connect to 2.x Bot Insight database, if available

This API allows you to connect to the source 2.x Bot Insight database if available, to migrate analytics data.

  1. Provide the "X-Authorization" and "Content Type" parameters in Headers.
  2. Provide credential parameters in Body.
  3. Use the POST method to connect to the Bot Insight database using the end point http(s)://<hostname:port>/v2/migration/connection /botinsight

    For example, https://crdevenv.com:81/v2/migration/connection/botinsight

  4. Provide following request parameters in Body:

    {

    "host": "string",

    "port": 0,

    "databaseName": "string",

    "username": "string",

    "password": "string",

    "integratedSecurity": true,

    "encrypt": true,

    "serverUrl": "string"

    }

    For example,

    {</