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.
– To activate the batch migration feature on your domain, contact your account manager or or reach out to us at sales@aodocs.com.
The batch migration spreadsheet contains the instructions about how to handle your source data during batch migrations. Learn more: Configure and run batch migrations.
Notes about formatting:
–The same formatting rules apply to the batch migration spreadsheet as the Bulk Updater spreadsheet. Learn more: Formatting rules.
– The values TRUE and FALSE aren't case sensitive. All other values are case sensitive, and you must enter them as indicated.
This article describes the different sheets in the batch migration spreadsheet.
Columns to define in the data sheet only
Columns to define in the data sheet only
Each row in the data sheet corresponds to a single migration.
The columns below can only be defined in the data sheet. They are specific to individual migrations. For each column you can find a description of what it contains and details about how to define values.
name column (mandatory)
| What it contains: |
Name of the migration that you will create and run. |
| Details: |
Each migration must have a unique name within a single batch migration spreadsheet. |
folder column (mandatory)
| What it contains: |
The location of the source files to migrate.
|
| Details: |
Enter a different folder for each migration. All migrations in a given batch must be of the same type. |
bindingId column (advanced)
| What it contains: |
ID of the custom binding you want to use for your migration. The list of custom bindings are in the customBinding sheet. |
| Details: |
Enter the ID of a binding that exists in the customBinding sheet. If you don't enter an ID, there is no pre-filter on the properties in your source data; all properties are added to the migration spreadsheet. |
versions column (advanced)
| What it contains: |
Maximum number of versions to extract from the source. |
| Details: |
Enter a value between 1 and 100 inclusive. If you don't enter a value, no versioning is included in your migration. |
sharepointLists column (mandatory for Sharepoint migrations)
| What it contains: |
List of list IDs or names exported in the migration. |
| Details: |
For Sharepoint migrations only. Enter the list IDs or names separated by pipe symbols (|). For example: ee3f3e5a-a8ba-4803-a44c-0d78acfc9408|9fc63472-0e3d-4e6b-8d70-b15203579146 |
site column (for Sharepoint migrations)
| What it contains: |
Subsite relative to the root site defined in the folder column. |
| Details: | For Sharepoint migrations only. |
Columns to define in the data sheet or config sheet
The columns below can be defined in:
- the data sheet if they apply to individual migrations
or - the config sheet if they apply to the entire batch of migrations
For each column you can find a description of what it contains and details about how to define values.
source column (mandatory)
| What it contains: |
Define the type of storage for your migration spreadsheet:
|
| Details: |
Learn more: Define the type of storage for your migration spreadsheet. Tip: If you create your batch migration spreadsheet using the Draft feature, the value of the type column is already filled in. Note: You're recommended to define the source column in the config sheet. |
group column (mandatory)
| What it contains: |
The Migrate for AODocs workspace in the domain where you will run the migration. |
| Details: | Enter the value of the required workspace, respecting upper and lower case. |
attachmentStorageType column (mandatory)
| What it contains: |
Define the type of storage for your migrated files. Possible values:
|
| Details: |
Learn more: Note: attachmentStorageType and libraryStorageType should correspond. |
attachmentStorageBucket
| What it contains: | Defines the Google Cloud Storage bucket or Azure container |
| Details: |
Learn more about the format to use: |
libraryId column (mandatory if libraryName not defined)
Important: To specify the destination library, you must define either:
– libraryID to migrate to an existing library
or
– libraryName and one of libraryType / libraryTemplate / librarySourceId to create a new library into which to migrate
| What it contains: |
The ID of an existing AODocs library into which you want to migrate your data. |
| Details: |
Learn about how to identify your library ID. Note: If you enter the library ID you mustn't define libraryName. |
libraryName column (mandatory if libraryId not defined)
| What it contains: |
The name of the library to create for a migration. |
| Details: |
Note: If you define libraryName you: |
libraryType column (mandatory if libraryName defined)
| What it contains: |
The type of library to create. Possible values:
|
| Details: |
Note: If you define libraryType you: |
libraryTemplate column
| What it contains: |
ID of the template from which to create a new library. |
| Details: |
Note: If you define libraryTemplate you: Learn more: |
librarySourceId column
| What it contains: |
The ID of the library to copy to create a new library. |
| Details: |
Note: If you define librarySourceId you: Learn more: |
classId column
| What it contains: |
The ID of the document class of your library into which you want to migrate your data. |
| Details: |
Learn about how to identify your class ID. Note: If you define classID, you must also define libraryID. |
templateId column
| What it contains: |
ID of the document template used to create documents in your migration. |
| Details: |
Learn more: |
forceGateway column
| What it contains: |
Forces the migration to be processed using Gateway even if processing in the cloud is possible. Possible values:
|
| Details: |
Learn more: Enforce Gateway processing |
straightforward column
| What it contains: |
Define whether the migration pauses at the upload and setup stages so you can edit the migration spreadsheet during the migration. Possible values:
|
| Details: |
Learn more about editing before import. If you create a draft, the value of the straightforward column is TRUE. If empty, the value is FALSE (default). |
libraryStorageAccount column
| What it contains: |
If you choose to create a new library, define the storage account to associate with the library you create. |
| Details: |
If empty, the default storage account is used. Learn more: What is the storage account? Notes: If you define libraryStorageAccount, you must also define libraryName and not libraryId. |
libraryStorageType column
| What it contains: |
If you choose to create a new library, define its storage type. Possible values:
|
| Details: |
Note: libraryStorageType and attachmentStorageType should correspond. Learn more: What's the difference between Google Cloud Storage (GCS) and Google Drive storage? |
fromCreatedDate column (advanced, for file server and Sharepoint migrations)
| What it contains: |
To filter documents to migrate between a period of time: from the date the document was created |
| Details: |
For file server and Sharepoint migrations only. Enter a date in the format: 2021-12-31 |
fromModifiedDate column (advanced, for file server and Sharepoint migrations)
| What it contains: |
To filter documents to migrate between a period of time: from the date the document was last modified |
| Details: |
For file server and Sharepoint migrations only. Enter a date in the format: 2021-12-31 |
toCreatedDate column (advanced, for file server and Sharepoint migrations)
| What it contains: |
To filter documents to migrate between a period of time: to the date the document was created |
| Details: |
For file server and Sharepoint migrations only. Enter a date in the format: 2021-12-31 |
toModifiedDate column (advanced, for file server and Sharepoint migrations)
| What it contains: |
To filter documents to migrate between a period of time: to the date the document was last modified |
| Details: |
For file server and Sharepoint migrations only. Enter a date in the format: 2021-12-31 |
skipHiddenFiles column (advanced, for file server migrations)
| What it contains: |
Define whether to allow the migration of hidden and system files. Possible values:
|
| Details: |
For file system migrations only. Learn more: Skip hidden and system files. |
forms column (for Lotus Notes migrations)
| What it contains: |
List of Lotus forms you want to export. |
| Details: |
Enter the list IDs separated by pipe symbols (|). For example: Documentation|Invoices|Policies |
user column (mandatory for Sharepoint migrations)
| What it contains: |
Username of the Microsoft administrator account used to perform the extraction from Sharepoint. |
| Details: |
Enter an email address. For Sharepoint migrations only. Note: You're recommended to define the source column in the config sheet. |
password column (mandatory for Sharepoint migrations)
| What it contains: |
Password of the Microsoft administrator account defined in the user column |
| Details: |
For Sharepoint migrations only. Note: You're recommended to define the source column in the config sheet. |
cache column (for Sharepoint migrations)
| What it contains: |
Define wether to use local or cloud cache.
|
| Details: |
Learn more: Choose whether to enable the cache. For Sharepoint migrations only. Note: You're recommended to define the source column in the config sheet. |
extractAsTitle column (for Sharepoint migrations)
| What it contains: |
Define the Sharepoint property used as the title in AODocs. Possible values:
|
| Details: |
Learn more: Specify what to extract as the title. For Sharepoint migrations only. Note: You're recommended to define the source column in the config sheet. |
extensionsToConvert column (advanced)
| What it contains: |
List of Google extensions to convert. Possible values:
|
| Details: |
For migrations into libraries using Google Drive storage. Enter the required extensions separated by pipes (|). Note: You're recommended to define the source column in the config sheet. |
Columns to define in the config sheet only
The columns below can only be defined in the config sheet. They apply to all the migrations in the batch. For each column you can find a description of what it contains and details about how to define values.
type column (mandatory)
| What it contains: |
The type of source files. Possible values:
|
| Details: |
Tip: If you create your batch migration spreadsheet using the Draft feature, the value of the type column is already filled in. |
oauth2 column (mandatory for Sharepoint migrations)
| What it contains: |
Define whether to use Sharepoint online or on premise. Possible values:
|
| Details: |
For Sharepoint migrations only. |
soap column (mandatory for Sharepoint migrations)
| What it contains: |
Define whether to use soap API requests. Possible values:
|
| Details: |
For Sharepoint migrations only. |
The customBinding sheet
The customBinding sheet works in a similar way for your batch migrations as the binding sheet in standard migrations.
The customBinding sheet defines the specific columns that the data sheet of each migration spreadsheet in your batch will contain. You can define the source property names, the target property types and names and their default values.
This allows you to pre-filter your source data so you don't include any unwanted properties.
You can define as many bindings as you like, with different names. Then, in the bindingID column in the data sheet, define the binding ID you want to use for each migration.
In the example below there are two bindings defined in the customBinding sheet.
In the data sheet, the bindingIDs are defined for different migrations. If no bindingID is defined for a migration, all the properties of the source data are included in the migration.
The customMapping sheet
The customMapping sheet works in a similar way for your batch migrations as the mapping sheet in standard migrations. The custom mapping applies to all migrations in the batch.
The report sheet
The report sheet appears as soon as you run a batch and is updated as the batch progresses. It allows you to follow the creation of the migrations in your batch. As your migrations are created, you can see their status switch to DONE. If you chose to create new libraries, their IDs are filled in as soon as they are created.
Important: The status DONE means that the migrations are created, not that the migrations themselves are complete.
Note: The data and config tabs are locked when you create the batch migrations.