Chat now with support
Chat with Support

On Demand Migration for Email Current - User Guide

Introduction Preparing Migrations Test and Pilot Migrations Configuring and Running Migrations Post Migration Third Party Assessments and Certifications Glossary

Managing Migration Templates

The migration template facilitates the creation of migration plan by specifying the connection properties and optional parameters for the migration.

The migration template can be only created from an existing migration plan:

  1. On the Dashboard page, select a migration plan from which you want to create a template, and click Save as Template.
  2. In the Save as Template dialog box, specify a name for the template.
  3. (Optional) To copy the connections and options from the migration plan, select the corresponding check boxes.
  4. Click Save.

To view all of your existing templates and manage them, click Manage Templates in the Dashboard page to open the Manage Templates page where you can edit, delete or create a plan from a template.

On Demand Migration for Email provides an audit trail of these activities on the templates with audit logs:

  • Creating, editing, deleting a template
  • Creating a migration plan from a template

To view the audit log, click Download Audit Logs on the page to save it as a .csv file.



Note: You must have the "Manage Templates" permissions to create, edit, delete a template and download audit logs. Without these rights, you can only view the template or create a plan from it.

For existing customers: "Manage Templates" permission is not set by default. Use ODME administrative account to create a new role and assign this permission to users in the On Demand portal. Then you need to log out and log in again to apply the new permission.

Editing or deleting a template will not affect any migration plans that were created from that template. Changes to the template affect only those migration plans that are created subsequent to the changes.

Connecting to Email Services

To set up a migration, you must specify the connection properties for your source email service and target email service. This is done in the Connections tab.

When connecting to email services, be aware of the following:

  • For all email services except G Suite and Sun ONE/iPlanet, you can connect to an email service either by specifying the login credentials of an administrator account, or you can select the option to migrate using the end-user credentials of each mailbox (source or target or both). If you select the Use end-user credentials option, you must specify the password for each mailbox when you add them to the migration plan, as described in the section, Adding Mailboxes.
    For Microsoft 365, you can also use Modern Authentication. The Use Modern Authentication option lets you grant consent to ODME instead of providing Administrative credentials with Application Impersonation rights. The Use Modern Authentication option is enabled for any newly created plan by default.

Note: Connecting to POP and IMAP email services is always done through end-user credentials.

  • Each mailbox in a source email service can be migrated successfully a total of 10 times with a maximum extraction limit of 500 GB across all migrations. This includes mailboxes that have 10 different date filters. This limit applies even if the 10 migrations do not migrate the same message more than once.
  • For each Microsoft-based email service, a total number of mailboxes that can be migrated concurrently is limited per administrator (G Suite and Sun ONE/iPlanet have no such limitation). For details, see topic below.

Connecting to the Source Email Service

Refer to the sections below for instructions specific to your source email service.

G Suite

Connecting to a G Suite source email service from ODME is a two-stage process based on the OAuth 2 protocol:

First, sign in with a super admin account so that ODME can verify your access.

Once this account has been verified, configure API settings in the Google Admin Console to grant access to ODME's service account.


Important: Be aware of the following:

  • The OAuth 2 protocol used to connect to a G Suite email service replaces the OAuth Consumer Key and Consumer Secret method used in previous versions of ODME. Any connections to G Suite in migration plans created prior to ODME version 1.7 must be updated with the OAuth 2 connection procedure described below.
  • IMAP must be enabled at the Organization level for ODME to connect to G Suite and run migrations.
Signing In

To sign in to G Suite:

  1. In the System field, select Google G Suite.


Note: If running a migration plan created prior to ODME 1.7, the System Field displays Google G Suite (deprecated), meaning the connection properties used to connect to G Suite in previous versions of ODME no longer apply. Click Upgrade to update the connection properties.

  1. Click Sign in to Google.

This opens the standard Google sign in UI.

  1. Follow the Google prompts to sign in as a user with super admin rights and to grant ODME access permissions.

After completing the G Suite sign in process, ODME verifies that the user is a super admin (You will see a green success message once the sign-in process is complete). At this point you are redirected back to the ODME Connections tab, which now displays your super admin's username.


Note: The Change User link allows the user to sign in as a different super admin and migrate from another G Suite account.

Configuring API Access

ODME connects to Google's APIs using an OAuth 2.0 service account. This account is identified by a client name shown on the Connections screen after you sign into G Suite. Below the client name is a set of URLs (called scopes) that represent the APIs ODME will access. You need to add the client name and scopes to the Google admin console to allow ODME to retrieve data using these APIs.

To Configure API Access:

  1. In the Connections tab, use the Copy to Clipboard links to copy the values in the Client Name and API Scopes fields.
  2. Click Manage Google API Client Access.

This opens the page in the Google Admin console.


Note: If the proper page is not displayed, from the admin console home page, go to the Security section (If not shown, its icon may be in the More Controls drawer at the bottom of the screen.) Click the Show More link and then select Advanced Settings. Finally, click the Manage API Client Access link.

Paste the text copied from the Client Name and API Scopes fields in the Connections tab to their respective fields in the Google Admin console. Then click Authorize.


Caution: You may receive connection validation and migration errors if API scopes are not granted correctly and if certain mail item API are turned off at the domain level or for particular mailboxes. To resolve this, make sure that all the scopes have been granted and enable all mail item migrations for all mailboxes. However, if you want to turn off migrations for particular mail items, such as Calendars or Contacts, uncheck the mail item in its migration types, and ODME will no longer validate that API connection or migrate the item. If a mail item is turned off, you have several choices:

  • Leave the mail item turned off (item will not migrate)
  • If the mail item is disabled at the domain level, enable it for the entire domain
  • If the mail item is disabled for particular users:
    • Enable the item for those users
    • Move those users into a new plan that has item turned off.
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating