- Overview
- Data security and compliance
- Organizations
- Tenants
- Licensing
- Accounts and roles
- External applications
- Logging
- Migrating to cloud
- Manual migration
- Using the Migration Tool
Using the Migration Tool
The instructions on this page only apply if you are migrating standalone Orchestrator to Automation Cloud™.
If you want to use this tool to migrate to Automation Suite, see the Automation Suite instructions instead.
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.
You can only use the Automation Cloud Migration Tool if:
- your standalone Orchestrator version is supported.
For details, see Product lifecycle.
-
you have a Pro, Pro Trial, or Enterprise license in Automation Cloud.
You can use the tool and migrate while on the Pro Trial plan, for evaluation purposes. However, 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.
We recommend the following order when considering an upgrade or migration:
- Upgrade to a supported standalone Orchestrator version.
-
Migrate from classic to modern folders. This step is required due to classic folder restrictions in Orchestrator in Automation Cloud.
-
Use this tool to migrate from standalone Orchestrator to Automation Cloud.
Other sequences are technically possible, but this is the most common migration/upgrade approach.
When you run the Automation Cloud Migration Tool, it automatically creates the following entities in Automation Cloud to match your standalone 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 |
Before opening the tool, make the following preparations:
- Check that the Enterprise or Enterprise Trial licensing plan in active in Automation Cloud (Admin > Licenses).
- 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.
- You must have administrator credentials for the on-premises Orchestrator and the View permission for all entities being migrated. If you don't have the View permission for some entities, those entities are not migrated.
- You must be an organization administrator in Automation Cloud to register the tool as an external application.
- To run the tool, you need a machine that:
- can connect to the on-premises Orchestrator
- can access Automation Cloud (has internet access and a supported browser)
- has the Windows operating system
- has .NET Core Desktop Runtime for x64 installed.
- Download the tool on the above-mentioned machine: Download the Migration 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.
Because the tool cannot migrate everything, there are some final tasks that you must perform manually.
- 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.
- 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.
- Manually upload any library feeds that the tool did not migrate.
- If any robots were skipped during export or import, manually create them.
- 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.
- Manually connect robots to the cloud Orchestrator service.
- Manually enable triggers as needed.
- Check any locations in Orchestrator where a password is required and add it: Robots, Settings, and Credential Assets.
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.