Subscribe

UiPath Automation Cloud

The UiPath Automation Cloud Guide

Check the current status of Automation Cloud here.

Using the Migration Tool

The Automation Cloud Migration Tool is a desktop application that you can use to automatically perform some of the migration steps when you want to move your on-premises Orchestrator to Automation Cloud.

📘

Note:

You can only use the Automation Cloud Migration Tool if:

  • your on-premises Orchestrator version is 2019.10.x, 2020.10.x, or 2021.4.x
  • you have an Enterprise or Enterprise Trial license in Automation Cloud. You can use the tool and migrate while on the Enterprise Trial plan, for evaluation purposes, but migration can be only partially successful due to limitations such as the number of tenants or number of robot licenses that are available on this plan. For more information, see About Licensing.

 

Entities Being Migrated


When you run the Automation Cloud Migration Tool, it automatically creates the following entities in Automation Cloud to match your on-premises Orchestrator setup:

Entity

Migrated

Not Migrated

Settings

Yes, with exceptions (see on the right).

Some on-premises settings that are exposed to the tenant on the read path cannot be modified in cloud, like host logo and color. Passwords in the Settings table cannot be exported because the API removes the values from the response. As a result no passwords will be migrated. This affects email alerts (SMTP password) and external feeds with basic authentication.

Packages

Migrates all packages and all package versions.
If a package feed is external and configured with basic authentication, the credentials will need to be input after the migration completes.

If a package feed is external and not accessible over the internet, entities that rely on these packages are not migrated.

Libraries

Tenant-level feeds only.

If a library feed is at the host level or is external and not accessible over the internet, entities that rely on these libraries are not migrated.

Calendars

Yes

N/A

Machines

Yes, but if there are not enough licenses to accommodate Machine slot assignments, the Machine will be imported with all slots set to 0.

Machine keys are not migrated.

Folders

Yes

Personal workspace folders are not migrated.

Environments

Yes, for classic folders.

N/A for modern folders.

Robots (classic)

Yes, but if there are not enough licenses to accommodate robot creation, the robot is skipped during import.

Skipped when licenses run out and an error is logged for each.

Robots (modern)

Modern robots are migrated if they are associated with an on-premises user that has an email address, and that same email was already invited to Automation Cloud, which creates the user.

  • If the user doesn’t exist in Automation Cloud, that specific robot migration fails.
  • Skipped when licenses run out and an error is logged for each.

Environment associations

The robot-environment mapping is migrated.

N/A

Processes

Processes are migrated. The tool may refer to these as Releases.

N/A

Queues

Yes

N/A

Triggers

Triggers are migrated, but are all set as disabled.

Assets

  • Boolean, Text, and Integer asset types are fully supported.
  • Credential assets are also migrated, but a dummy password is used because passwords cannot be migrated by the tool. You will need to manually update the passwords in cloud for each credential asset after migration. Credential assets are assigned to the default credential store (the Orchestrator database) in cloud.
  • Per-robot values are also migrated, but if the robot wasn’t migrated, this value is skipped and an import warning is logged.

Per-user asset values in modern folders are not supported. The asset is imported with the default value or skipped if none is set.

Machine associations

Robot-machine mappings are migrated.

N/A

 

Entities Not Migrated

The following entities are not migrated by the tool:

  • Folder feeds
  • Users
  • Queue items
  • Action catalogs
  • Webhooks
  • Testing entities (test sets, test cases, test executions, test schedules, test data queues)
  • Logs

 

Prerequisites


Before opening the tool, make the following preparations:

  1. Check that the Enterprise or Enterprise Trial licensing plan in active in Automation Cloud (Admin > Licenses).
  2. Make sure you have sufficient robot licenses in Automation Cloud to match the number of robots being migrated (Admin > Licenses > Robots & Services). The tool only migrates robots as long as there are licenses available, after which it starts to skip robots.
  3. You must have administrator credential for the on-premises Orchestrator and View access to all entities being migrated. If you don't have the View permission for some entities, those entities are not migrated.
  4. You must be an organization administrator in Automation Cloud.
  5. To run the tool, you need a machine that:
    a. can connect to the on-premises Orchestrator
    b. can access Automation Cloud (has internet access and a supported browser)
    c. has the Windows operating system
    d. has .NET Core Desktop Runtime for x64 installed.
  6. Download the tool on the above-mentioned machine:

 

Registering the Tool as an External Application

The migration tool needs to connect to the Orchestrator service API in Automation Cloud to create the migrated entities. It uses the OAuth flow for this and therefore must be registered in Automation Cloud as an external application.

  1. Follow these instructions to add the tool as a new external application with the following specifics:
    • Type: Non-confidential
    • Resources: Orchestrator API
    • User scopes: OR.Folders, OR.Settings, OR.Robots, OR.Machines, OR.Execution, OR.Assets, OR.Users, OR.Jobs, and OR.Queues.
    • Redirect URL: http://127.0.0.1:8888/auth/
  2. Save the Application ID for later use.

 

Running the Tool


The tool can migrate one tenant at a time. You can run the tool for each of your tenants. With each run, the tool:

  • Connects to your on-premises Orchestrator to export entities for the given tenant.
  • Connects to Automation Cloud to import and create the migrated entities in Orchestrator service.

For more information about entities that are subject to migration, see Entities Being Migrated.

  1. Extract the ZIP file you downloaded for the tool and then run the tool EXE.
  2. For the activation method, choose Connect to On-Premises Orchestrator:
  1. Fill in the information to allow the tool to connect to your on-premises Orchestrator:

Make sure that the credentials you provide are for an administrator account that also has View permissions on all the entities you want to migrate.

  1. Click Start Export to connect to on-premises Orchestrator and download the setup information.
    The export begins and may take a while to complete:

When finished, the export summary lists all entities that were successfully exported:

You can click Open File to view the local file created for the export summary, which includes a few more details.

  1. Click Home to return to the first screen.
  2. For the activation method, this time choose Connect to Automation Cloud.
  3. Fill in the information to allow the tool to connect to Automation Cloud to upload the setup information:

Field

Details

Client Application Id

The Application ID value associated with the external application registration in Automation Cloud.
You can find this value on the Admin > External Applications page.

Account Logical Name

The organization-specific part of your Automation Cloud URL. Organization administrators can find this information in the URL field under Admin > Organization Settings.
You do not need to include the full URL, only the editable part, which is specific to your organization.

Tenant Name

The exact name of the Automation Cloud tenant where you want to add the migrated information. The migrated data will be visible in the Orchestrator service associated to that tenant.

  1. Click Start Import to connect to Automation Cloud and start to migrate the information to the target Orchestrator service.
    The import begins and may take a while to complete:

To connect to Automation Cloud using OAuth, a user with the adequate permissions for the scopes added when you registered the external application must log in to Automation Cloud. When they do, a new window opens with a success message if the OAuth flow was successful:

When finished, the import summary lists all entities that were successfully imported into the Orchestrator service in Automation Cloud:

Anything that was not imported is listed as an error and partial imports are listed as warnings. You can click View Report for more details about exactly which entities encountered an error or warning.

  1. When ready, click Done to close the tool.

👍

Tip:

If needed, you can run the tool again to migrate data for additional tenants.

 

Post-migration Tasks


Because the tool cannot migrate everything, there are some final tasks that you must perform manually.

  1. In Automation Cloud, select the tenant that was the import target and then open Orchestrator. Check that folders and entities were successfully migrated. You can use the import summary to check the specific items that had warnings or errors.
  2. Allocate robot and service licenses for Orchestrator. Machines are created and licensed while available licenses exist, but after licenses run out, machines continue to be created without licenses, so you must update them to allocate the adequate number of licenses.
  3. Manually upload any library feeds that the tool did not migrate.
  4. If any robots were skipped during export or import, manually create them.
  5. Create any webhooks, task catalogs, credential stores, or other information that the tool does not migrate. The section Entities Being Migrated also includes a list of what the tool does not migrate.
  6. Manually connect robots to the cloud Orchestrator service.
  7. Manually enable triggers as needed.
  8. Check any locations in Orchestrator where a password is required and add it: Robots, Settings, and Credential Assets.

 

Getting Help


If you need assistance with an issue encountered during export, import, or after import, open a Support ticket and include the following files:

  • Log file (in the logs sub-folder)
  • Export report file (in the MigrationAssets sub-folder)
  • Import report file (in the MigrationAssets sub-folder)

In addition to these files, it would be helpful to know:

  • The version of your on-premises Orchestrator
  • Your Automation Cloud organization and tenant names.

Updated 26 days ago


Using the Migration Tool


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.