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 you're planning to run any of the following migration types:

  • File server
  • CSV
  • SharePoint on premise
  • Lotus Notes

If it isn't, run the command to launch it (see below). 
Learn more: Basic definitions: Gateway

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 if you're planning to run any of the following migration types:
    • File server
    • CSV
    • SharePoint on premise
    • Lotus Notes

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.


The welcome page opens. There are two main modes available in Migrate for AODocs: 

  • Migrate a folder from Drive into AODocs

This is the simplest use case. There's no need to install Gateway. You can just select a folder to import, an AODocs library and a document class. You don't have to edit your import before running it (but you can if you want to!)

  • Access all features: use this option to run any migration type. Learn more: Run your migrations.

Note: Depending on which migration type you choose, you may need to install Gateway

You'll extract a summary of your migration before running it, so you can benefit from all Migrate for AODocs features, such as editing and adding metadata (properties). 

Tip: To return to the welcome page when you've selected a mode, press your user icon in the top right of the screen and select Change mode


Install Gateway

You must install Gateway to run any of the following migration types: 

  • File server
  • CSV
  • SharePoint on premise
  • Lotus Notes

Important: These migration types are grayed out (unavailable) until you 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, not a higher version.

2. Follow the link from the interface to download the latest version of Gateway. A JAR file named 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_x.x.jar

where 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.