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

This article explains how to get started with Migrate for AODocs.

 Access Migrate for AODocs 
 Before you start
           AODocs side
           Customer side
 Set up Migrate for AODocs
           Install Gateway
           Activate the Cloud API
           Add uploader accounts and AODocs storage accounts in Migrate for AODocs
 What next?


Access Migrate for AODocs

1. Follow this link:

2. Sign in with your Google account.

3. Check that Gateway is running. If it isn’t, run the command:

java -jar bulk_gateway.jar

where is your professional account.

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

Before you start

AODocs side

Before you use Migrate for AODocs, the Support team will:

  • configure your domains in Migrate for AODocs
  • add a list of Migrate for AODocs administrators who can create migration groups on your domain

Note: The Migrate for AODocs Support team can add as many domains and Migrate for AODocs administrators as you need.

Any problems? Contact the Migrate for AODocs Support team by email at

Customer side

Create your uploader accounts

Before you use Migrate for AODocs, your G Suite admin must create one or more standard Google accounts which serve as technical accounts (uploader accounts) to run your migrations.

When you perform actions in Migrate for AODocs (such as create and edit the migration spreadsheet) you use your professional account. Uploader accounts are used only to upload files into Google Drive (learn more: What is Migrate for AODocs?) because this process may overload the My Drive of your professional accounts. You mustn’t use your professional accounts to upload documents to Google Drive during the migration process.

Uploader accounts are temporary: when your migration is complete, you can delete them so they no longer consume licenses.

– You can’t use an uploader account for more than one migration at a time.
– You can’t use more than five uploader accounts for each professional account.

Tip: Typically, for 100 migrations, you may use two different professional accounts, each with five uploader accounts. This lets you run 50 migrations sequentially for each professional account at the same time.

Learn more: Add uploader accounts and AODocs storage accounts in Migrate for AODocs.


Create your migration groups

A Migrate for AODocs administrator must create at least one migration group.

Migration groups allow you to organize your migration process according to your business case. Migration groups can be composed of more than one migration.

For example: You can create one migration group per geographical location (Paris and London). You can then run two separate migrations for the London migration group: one for your local file structure and one for your SharePoint file structure; and run just one SharePoint migration for the Paris migration because you don’t have any local files to migrate.

– To delete migration groups, contact the Migrate for AODocs Support team by email at
– You can’t rename migration groups.

To create a migration group:

1. Follow this link to the API explorer.

2. Enter your domain.

3. Enter a name for your new migration group.

4. By default, the expiration duration of your migration group is 1 year. If required, enter a date (format YYYY-MM-DD) to change the expiration duration.

5. Leave fields blank.

6. Press Authorize and execute.


7. Press Authorize and execute in the confirmation pop-up. 


You receive confirmation that your migration group has been created.

Set up Migrate for AODocs

There are a few setup steps the first time you use Migrate for AODocs. You only need to set up Migrate for AODocs once. When you’ve completed these steps, 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. Install Gateway.

4. In Migrate for AODocs, select a domain and a migration group. Learn more: Before you start.

5. Press Save.


6. Activate the Cloud API.

7. At any moment you can open the menu for your account and press Configuration to check the status of:

  • Gateway
  • Migrate for AODocs user interface
  • Cloud API

The status page looks like this when everything is working OK!


Tip: Press Import into AODocs in the blue banner to return to the Migrate for AODocs migration features.

Install Gateway

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

Gateway is a tool that runs locally during the extraction and upload phases. Learn more: What is Migrate for AODocs?

Gateway allows Migrate for AODocs to access the local data that you want to import into AODocs. You must install Gateway even if you’re migrating from Google Drive because in certain cases you still need to access local data. For example, migration can take a long time, so you may want to quit Migrate for AODocs and close Chrome. You can leave Gateway running so your migration continues.

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


1. Follow the link from the pop-up to download the latest version of Gateway. A JAR file named bulk_gateway.jar is downloaded.

2. If you don’t have the Java Development Kit installed, follow this link to install it.

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

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 bulk_gateway.jar

where is your professional account (not an uploader account).

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 migration group.

5. A login prompt opens. Log in to your account.

6. Grant the required permissions

Gateway is installed and running and you’re redirected to the Migrate for AODocs homepage.

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.

Activate the Cloud API

When you have installed Gateway and accessed Migrate for AODocs, you must activate the application programming interface (API) by confirming your permissions.

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.

1. Open the menu for your account and select Configuration. The Status page indicates the status of:

  • Gateway
  • Migrate for AODocs user interface
  • Cloud API


2. Press Grant permissions.

Note: If required, you can access the API explorer: follow the link next to URL.

3. A login prompt opens. Log in to your account.

4. Confirm the permissions. The Migrate for AODocs interface opens.

Add uploader accounts and AODocs storage accounts in Migrate for AODocs

Before running a migration, you must add the uploader accounts you’ll use to upload the files to Google Drive.

To run incremental migrations, you must also add your AODocs storage account to the list of uploader accounts.

Important: Don’t use your AODocs storage account as an uploader account when you run a migration for the first time. AODocs storage accounts are used only for incremental migrations.

1. Open the menu for your account and select Configuration.

2. Enter the email address of an uploader account that your G Suite admin created.

3. Press the Add button.

4. A login prompt opens. Log in to the uploader account and grant the required permissions.

5. Repeat steps 2 to 4 for each uploader account you want to use for your migrations.



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.