The information below is for when configuring G Suite (Google Apps) as destination platform for a migration.
- Domain Name – the name of the Google domain to migrate to. This may be either a primary or secondary domain. Note: you can only migrate users to one domain at a time. If you have both primary and secondary domain users, they must be processed in separate migrations.
- Admin Email – the login name of a super admin account for the primary G Suite domain. If you are migrating from multiple workstations, specify one super admin per workstation.
- Test User Email – an email address to test in the domain to be migrated
Service Account Details
- Service Account Email Address – the email address of the service account used for migrations. See the section on preparing the source/destination Google account for details of service accounts.
- Private Key Path – the location of the private key file for the service account.
All communication with the Google servers is performed over http/https using JSON or XML to encode the content. The importing of messages and other items to Google may be done in various ways depending on the size of the data, or the type of item being imported. Some things may be performed alone, such as creating calendars, but others are sent in batches, such as email messages or appointments. Changing the settings in this section should be made with care so as not to disrupt network communications.
- Migration Base URL 1.0 – the base URL for email migration using v1 of the email migration API. This should only be changed for specialized migration scenarios and for normal migrations should not be altered.
- Migration Base URL 2.0 – the base URL for email migration using v2 of the email migration API. This should only be changed for specialized migration scenarios and for normal migrations should not be altered.
- Timeout – the time in milliseconds that the tool has to complete sending a transaction to Google before an error occurs. This should be set high enough so that large amounts of data can be sent (further description is available in ‘Migration Strategies’). If a transaction fails using the provided timeout, it will be re-attempted using a larger timeout. While errors occur this will continue with increasing lengths of timeout, up to the retry count. It is better to set this to a very high value to ensure requests get through.
- Maximum Batch Size – this is the maximum size, in bytes, of a single transaction with the Google servers. Note: The absolute maximum size of any transaction that G Suite allows is 32MB. Because of the way that messages are created and encoded (XML OR JSON, which is then Base 64 encoded) it is not usually possible to know the exact size of a message until it is created. Messages can be sent in batches, which also make it more difficult to establish the exact size of each transaction. Large batches also increase memory usage significantly and it is recommended that the maximum value of 5MB is used. This setting also has an impact on how long a single message will take to transmit to G Suite and can therefore affect the requirements for the Timeout setting.
- Maximum Batch Count – the number of items that will be sent in a batch when transferring contacts and calendar items.
- Retry Count – the number of times a transaction with the Google servers will be retried if it fails.
Note: A transaction could fail for one of a few reasons. If the transport layer fails, that is a transaction could not get through to the Google servers or the transaction times out, then the transaction will be attempted again until the retry count is met – with an increasing timeout value each time. Another possible reason for failure is that the client is sending too many requests per second. In this case, an exponential backoff system is employed where the tool waits for a period before retying any failed transactions (or parts of transactions).
- Gzip Transfers – before sending any data over the Internet to Google, gzip the content. This should generally be left to true unless there is a specific reason for changing the setting.
- Modify Request – leave at the default unless instructed by support.
- Custom Headers – adds custom headers to Google API requests, for debugging only.