Getting started with Migrate for AODocs

Migrate for AODocs is a tool that allows you to migrate files and folders into your AODocs libraries.

Important: Migrate for AODocs is currently available for our service teams only. For EAP access, contact

Migrate for AODocs administrators and G Suite admins must set up Migrate for AODocs before users can access and use it. Learn more: Administrators: Set up and manage Migrate for AODocs.

This article explains how to get started with Migrate for AODocs when the initial setup by administrators is complete.

 Link to access Migrate for AODocs 
 Access Migrate for AODocs for the first time
           Install Gateway


Link to access Migrate for AODocs 

1. Follow this link:

2. If prompted, sign in with your Google account.

3. Check that Gateway is running. If it isn't, re-run the command to launch it (see below). 
Learn more: Basic definitions: Gateway

Important: Gateway must be running to use Migrate for AODocs.

Access Migrate for AODocs for the first time

You must perform these extra setup steps the first time you use Migrate for AODocs:

  • Grant permissions to access the Cloud API
  • Install and activate Gateway

Note: You only need to run these setup steps once. When you've completed them, you can access Migrate for AODocs directly and start migrating right away!

1. Access Migrate for AODocs and sign in.

2. Grant the permissions required to access Migrate for AODocs.

3. Grant the permissions required for the Cloud API.

Note: The Cloud API is needed so Migrate for AODocs can create documents. It accesses the migration spreadsheet that lists your documents and it connects Migrate for AODocs to AODocs.

4. Select a domain and a workspace, then press Save.


This is the first time you're accessing Migrate for AODocs, so you don't have any current migrations and Gateway isn't yet connected. 


Install Gateway

Before you can use Migrate for AODocs, you must install Gateway.

Important: You can’t use Migrate for AODocs if you don’t install Gateway.

Learn more: Basic definitions: Gateway

1. If you don’t have the Java Development Kit installed, follow this link to install it or access the same link from the interface.

Note: You must install Java Development Kit version 11 or higher.

2. Follow the link from the interface to download the latest version of Gateway. A JAR file named gateway_gateway_x.x.jar is downloaded (where x.x is the version number).

3. Open a terminal window and navigate to the folder where the JAR file is located. For example, if your file is in the downloads folder, run the command: cd downloads

4. Run this command:

java -jar gateway_gateway_x.x.jar

where gateway_gateway_x.x is the name of the file you downloaded.

Note: You must leave the terminal window open during the migration. If you close it, Gateway stops and the migration is interrupted. To resume the migration, you must run the command again then re-select the domain and workspace.

5. A login prompt opens. Log in to your account and grant the required permissions

6. Press Connect the Gateway.


The icon at the top of the screen indicates the status of Gateway:

gateway_connected.png Gateway is connected. Press to check its status.
gateway_not_connected.png Gateway is not connected or not initialized. Press to connect it.
gateway_not_synchronized.png Gateway is connected but not initialized. Press to initialize it.
gateway_loading.png Migrate for AODocs is checking the status of Gateway.

Note: If you close your terminal window, Gateway stops running. If you do this, the next time you use Migrate for AODocs, you must rerun Gateway.

What next?

The setup is complete and you’re now ready to run your migrations!

Was this article helpful? 0 out of 0 found this helpful
If you didn’t find what you were looking for, don’t hesitate to leave a comment!
Have more questions? Submit a request



Please sign in to leave a comment.