- Getting started
- Data security and compliance
- Organizations
- Authentication and security
- Licensing
- Tenants and services
- Accounts and roles
- AI Trust Layer
- External applications
- Notifications
- Logging
- Troubleshooting
- Migrating to Automation Cloud™
- About migrating to Automation Cloud™
- Using the Automation Cloud Migration Tool
- Manual migration
Using the Automation Cloud Migration Tool
The Automation Cloud Migration Tool is a desktop application designed to simplify the process of migration from one deployment option to another. The tool automates various migration steps, making it easier to transition either your standalone or Automation Suite Orchestrator to Automation Cloud, Automation Cloud Public Sector, or Automation Suite.
Instructions on this page apply for migrating your on-premises Orchestrator, either standalone or via Automation Suite, to Automation CloudTM.
When planning your migration from on-premises Orchestrator to Automation CloudTM, it is advisable that you take the following steps:
-
Upgrade to a supported on-premises Orchestrator version.
-
Migrate from classic to modern folders, as classic folders have restrictions in Automation CloudTM.
-
Run the migration tool to migrate from on-premises Orchestrator to Automation CloudTM.
-
While other sequences are technically possible, this is the most common approach.
-
The Automation Cloud Migration Tool operates independently and does not conform to our standard Product Lifecycle.
To use the migration tool, you must meet the following criteria:
-
Your standalone Orchestrator version must be supported. For specific version details, refer to our Product Lifecycle documentation.
-
You need a Pro, Pro Trial, or Enterprise license in Automation Cloud. While you can use the tool during a Pro Trial for evaluation, some limitations may apply, such as tenant and robot license restrictions. For more information, see our Licensing documentation.
Before opening the Automation Cloud Migration Tool, make the following preparations:
-
Check that the Enterprise or Enterprise Trial licensing plan is active in Automation CloudTM (Admin > Licenses).
-
Make sure you have sufficient robot licenses to match the number of robots being migrated (Admin > Licenses > Robots & Services). The tool migrates robots as long as there are licenses available, after which it starts to skip robots.
-
Make sure you have administrator credentials for the on-premises Orchestrator
-
Make sure you have View permission for all entities being migrated. If you do not have the View permission for some entities, those entities will not be migrated.
-
Make sure you are an organization administrator in Automation Cloud to register the tool as an external application.
-
Make sure the machine you run the Automation Cloud Migration Tool on meets the following requirements:
-
Can connect to the on-premises Orchestrator;
-
Can access Automation CloudTM (has internet access and a supported browser);
-
Runs the Windows operating system;
-
Has .NET Core Desktop Runtime for x64 installed.
-
-
Download the migration tool on the machine that meets the requirements in the previous step.
When using the migration tool, the following entities are automatically created in Automation CloudTM to mirror your Orchestrator setup:
Entity |
Migrated |
Not migrated |
---|---|---|
Settings |
Yes, with exceptions | Some on-premises settings, such as passwords and certain settings exposed to tenants |
Packages | All packages and package versions |
Entities that rely on external package feeds requiring authentication Note:
Authentication is required after migration is completed for external package feeds configured with basic authentication |
Libraries | Tenant-level feeds only | Entities that rely on libraries with host-level configurations or inaccessible external libraries |
Calendars |
Yes |
N/A |
Machines |
Yes Note:
Potential machine slot assignments limitations due to missing licenses |
Machine keys |
Folders |
Yes | Personal workspace folders |
Environments | Yes, for classic folders. |
N/A (for modern folders) |
Robots (classic) |
Yes Note:
Potential robot creation limitations due to missing licenses | Skipped when licenses run out, with an error logged for each skipped robot |
Robots (modern) |
Yes Note:
If certain conditions are met, robots are associated with an on-premises user that has an email address, and that same email was already invited to Automation CloudTM and is associated to a user. |
Skipped when licenses run out, with an error logged for each skipped robot Fails if a user in Automation CloudTM does not exist |
Environment associations | The robot-environment mapping |
N/A |
Processes |
Yes Note:
The migration tool may refer to processes as releases |
N/A |
Queues |
Yes |
N/A |
Triggers |
Yes, but they are set as disabled |
N/A |
Assets | Certain asset types are fully supported, with some considerations for credential assets | Per-user asset values in modern folders |
Folder feeds |
Yes |
N/A |
The migration tool does not migrate the following entities:
-
User and robot accounts
-
Role assignments
-
Queue items
-
Action catalogs
-
Webhooks
-
Testing entities (test sets, test cases, test executions, test schedules, test data queues)
-
Storage buckets
-
Logs
The migration tool must connect to the Orchestrator service API in Automation CloudTM to create the migrated entities. It uses the OAuth flow for this and, therefore, must be registered as an external application.
To register the Automation Cloud Migration Tool as an external application, take the following steps:
-
Add the tool as a new external application by following the instructions in Adding an external application. Make sure to use the following configuration:
-
Type: Non-confidential
-
Resources: Orchestrator API
-
User scopes:
OR.Folders
,OR.Settings
,OR.Robots
,OR.Machines
,OR.Execution
,OR.Assets
,OR.Users
,OR.Jobs
, andOR.Queues
. -
Redirect URL:
http://127.0.0.1:8888/auth/
-
-
Save the Application ID for later use.
The migration tool can migrate one tenant at a time. You can run the tool for each of your tenants. With each run, the tool performs the following operations:
-
Connects to your on-premises Orchestrator to export entities for the given tenant.
-
Connects to Automation CloudTM to import and create the migrated entities in Orchestrator.
For more information about entities that are subject to migration, see Entities migrated by the migration tool.
Because the Automation Cloud Migration Tool cannot migrate all data, there are some final tasks that you must perform manually.
- In Automation CloudTM, select the tenant that was the import target, and 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 migrated by the migration tool 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 the previous files, it would be helpful to know the following:
-
The version of your on-premises Orchestrator;
-
Your Automation CloudTM organization and tenant names.