Getting started with Migrate for AODocs – AODocs Knowledge Base

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 dev-migration@altirnao.com.

Migrate for AODocs administrators and Workspace 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: https://migration.aodocs.com

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. If required, change the domain to which you'll migrate your documents: press your avatar and select the required domain.

Note: When you access Migrate for AODocs for the first time, your default domain is selected. When you access Migrate for AODocs subsequently, the last domain you used is selected.

The welcome page opens.

All users can access the quick options:

This is the simplest use case. There's no need to install Gateway. You just select a Drive folder or Google spreadsheet, 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!)

Learn more: Run your migrations in quick mode.

Use this option to open the quick export screen in Bulk Updater where you can export an AODocs view. Your domain is selected by default. All you need to do is select a library and a view. Learn more: Configure and run a simple export in Bulk Updater.

Users with migration accounts also have access to the advanced options (learn more: Add migration accounts):

Use this option to run any migration type.

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

Learn more: Run your migrations in advanced mode.

Use this option to open the advanced export screen in Bulk Updater where you can export and update properties in your AODocs documents. Your domain is selected by default. Configure the advanced export and update options. Learn more: Configure and run an advanced export in Bulk Updater.

Tip: To return to the welcome page when you've selected a mode, press Migrate for AODocs in the top left of the screen.

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.

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

6. Hover over the Gateway icon at the top of the screen and press Connect the Gateway.