Migrator for Notes to Exchange 4.15.2 - Program Parameters Reference Guide

[Exchange] section

When the SSDM migrates an archive to a PST file, the SSDM by default registers the PST file in the Outlook profile that was selected for the migration. To prevent the generated PST file from being registered in the Outlook profile, set this parameter to 0.

In Notes and iNotes, when users set a task reminder to X days, hours, minutes before or after the task start date, the alarm notification is triggered X days, hours, minutes before or after 12:01 PM of the task start date.

When this parameter is set to the default value (1), after migration the alarm notification is triggered X days, hours, minutes before or after 12:00 AM instead of 12:01 PM.

To retain the Notes task alarm behavior and trigger the alarm before or after 12:01 PM, set this parameter to 0.

Determines whether HTML information in the Description field of calendar appointments and tasks will migrate. The default:

… tells the SSDM to migrate such information. The feature can be disabled by AllowHTMLCalendarBodies=0.

Tells the SSDM whether to automatically write the display names of Notes' email 2 and email 3 in the form Display Name (SMTP Address)— e.g., Joe Example (joeex@email.com). This feature, intended to make the type-ahead feature easier to use, can be enabled by

… but is off (0) by default.

Tells the program whether to look up SMTP addresses in user archives in the Exchange GAL, to get Exchange addresses — e.g., so free-busy lookups will succeed. This feature is enabled by default, but can be disabled by setting the parameter to 0. For example, to migrate data to PST files without connecting to the Exchange server, set:

... and also, in the [General] section:

Specifies the method the SSDM should use to process a recurring meeting series that contains more occurrences in Notes than the 999 maximum allowed by Exchange. Without this new control, attempts to migrate such meetings to Exchange 2010 would fail when the number of recurring instances exceeded the Exchange maximum. For example:

... tells the SSDM to convert the item to a recurring series with no end date, which migrates cleanly.

The parameter value is a keyword that must be one of these single digits:

A migrated appointment will appear in Outlook with the same number of occurrences as in Notes, until the recurrence pattern is edited by the user, at which time it will assume the option set by this parameter.

Specifies the method the SSDM should use to process a recurring meeting series that contains more occurrences.

Instructs the SSDM to authenticate users with Office 365 Modern Authentication (i.e., ADAL authentication) prior to migrating data to their Office 365 mailboxes. Use this option when migrating to an Office 365 tenant where Modern Authentication has been enabled. This option should not be enabled when migrating to an on-premises Exchange server.

When this option is enabled, the following parameters must also be configured:

NOTE: These parameters are configured by the MNE Migration Console on the Exchange Server page when the Apply button is clicked.

Enables or disables the option of extracting images from Notes messages and replacing them with OLE Device Independent Bitmap object attachments. This option makes images renderable in both OWA and the Office web client, and also improves image compression by a factor of two. The feature is enabled by default (1), or set ExtractEmbeddedImages=0 to disable it.

If the OLE Device Independent Bitmap uses significantly more storage than the original source image, you may be able to reduce the storage requirements by using the parameter MaxExtractedImageArea.

Specifies a comma delimited list of MAPI error codes for the MAPI Retry feature. MAPI Retry is a feature of MNE that attempts to recover from intermittent or brief network connectivity issues. The errors that are included in this list are errors that are typically returned from MAPI API functions when network connection issues do occur. If MNE encounters one of the MAPI errors listed in the MAPIErrorsToRetry setting, it will attempt to recover using the algorithm described below.

The full list of parameters used to customize the MAPI Retry feature is below.

Determines the number of additional attempts that MNE will make to recover from a MAPI API function that fails with one of the errors listed in the MAPIErrorsToRetry parameter. If a MAPI retry error occurs, MNE waits for the amount of time specified by the MessageRetryWait parameter, and attempts to execute the MAPI API function again.

If the API function continues to fail and returns MAPI retry errors, once the MAPIRetryCount limit is reached MNE makes a new attempt to store the message using a new MAPI session, as described by the MessageRetryCount parameter.

If this parameter is not set, it defaults to the value that is specified by the MessageRetryCount parameter.

This setting is applied when [Exchange] ExtractEmbeddedImages is enabled.

During migration, images that are extracted from emails are converted into BMP images before being stored in Exchange as message attachments. Converting an image to BMP format can often result in an image whose data size is many times larger than the original image. Unfortunately, due to technical limitations of the RTF format, it is not possible to use other, more efficient image formats that support data compression.

To mitigate the impact to the target mailbox size of emails that contain large embedded images, the MaxExtractedImageArea setting can be used to specify the maximum allowable image area, in pixels, of the generated BMP image. During the conversion, if the limit would be exceeded, the embedded image is removed from the body of the email and it is replaced with the original image from the Notes source stored to the migrated message as a standard file attachment.

For example, to specify that all images lager than 640 x 480 (307200) pixels should be removed from the email body and migrated as file attachments, set MaxExtractedImageArea=307200.

By migrating the source image in its original format, the source image’s data compression can be retained with no loss in image quality. While the image will no longer be displayed in the actual body of the email in Outlook or OWA, it is still possible to open the images from the email client to view the content of the image.

When MaxExtractedImageArea=0, the image is migrated to Exchange with no size limit applied.

Determines the maximum number of times that MNE will attempt to reconnect the MAPI session if a message fails to migrate due to one of the errors that are specified by the MAPIErrorsToRetry parameter. MNE pauses between each reconnect attempt for the number of seconds specified by the MessageRetryWait parameter.

If MNE is unable to open a new MAPI session after MaxSessionReconnectCount attempts, the migration is aborted.

If a message fails to migrate due to one of the MAPI errors specified by the MAPIErrorsToRetry parameter, this parameter determines the maximum number of additional attempts that MNE will make to store the message. When MNE fails to store a migrated message to the target mailbox due to a MAPI retry error, MNE closes the existing MAPI session, opens a new session, and then attempts to store the message again.

If MNE is unable to open a new MAPI session, it continues to make additional attempts to connect with MAPI, as described by the MaxSessionReconnectCount parameter. MNE pauses between each reconnect attempt for the number of seconds specified by the MessageRetryWait parameter.

If MNE is able to successfully open new MAPI sessions, but attempts to store the message continue to fail and the MessageRetryCount limit is reached, MNE logs the MAPI error and the failure to migrate the current message. MNE then proceeds to the next message to be migrated.

Sets the delay (in seconds) between retry attempts for MAPI API functions that fail with one of the errors specified by the MAPIErrorsToRetry parameter, as documented by the MAPIRetryCount parameter.

The parameter also specifies the delay (in seconds) between MAPI session reconnect attempts, as documented by the MessageRetryCount parameter.

Determines whether the SSDM will migrate the FYI attendees of a Notes meeting to the bcc field in Exchange, where they will appear as Resources, instead of to the cc field. This option keeps FYI attendees hidden if the organizer later changes the meeting, since Exchange sends notifications of such changes, and those notices would otherwise disclose the FYI attendees as Optional Attendees.

By default (MigrateMeetingFYIAsResource=1), the SSDM migrates FYI attendees of a Notes meeting to the bcc field in Exchange. You can disable the feature (0) to make the SSDM migrate FYI attendees to the cc field.

Identifies the Office 365 URL that provides Modern Authentication services. This setting is updated by the Migration Console when the Apply button is pressed on the Exchange Server page. The URL associated with the selected Office 365 Environment is chosen from the list of URL’s in the [MsOnlineAuthorityUrls] section.

Identifies the Office 365 tenant ID in Modern Authentication requests that are sent to Office 365. This setting is updated by the Migration Console when the Apply button is pressed on the Exchange Server page.

For example:
O365Tenant=consoso.onmicrosoft.com

Identifies the base URL for the Office 365 tenant’s mail API’s, such as O365 REST API and EWS. This setting is updated by the Migration Console when the Apply button is pressed on the Exchange Server page. The URL associated with the selected Office 365 Environment is chosen from the list of URL’s in the [OutlookRestApiUrls] section.

... tells the SSDM to clear the contents of Personal Address Books in Exchange before migrating corresponding PABs from Notes—useful if, for example, you had already migrated PABs, but then wanted to migrate them again. The default PurgePABS=0 disables the feature, so no PABs are cleared. This feature clears only Exchange PABs that correspond to Notes PABs about to be migrated, and will not clear any other existing Exchange PABs.

Tells the Data Migration Wizard which of two methods to use, to avoid creating duplicate items in Exchange when an item that has already been migrated to Exchange is queued to migrate again. For example:

... tells the wizard to delete the Exchange copy of the item and then remigrate it from Notes.

The parameter value is a single-digit integer, which must be one of these three valid values:

A single digit, 0–7, that specifies which (if any) of migrating mail, appointment and task items the SSDM should pass through Microsoft’s rich-text converter—which in many cases will refine the exported compound document format from Notes’ own converter. The parameter value must be one of these digits:

Tells the program whether to look up SMTP addresses in server mail in the Exchange GAL, to get Exchange addresses — for example, so free-busy lookups will succeed. This feature is enabled by default, but can be disabled by setting the parameter to 0. For example, to migrate data to PST files without connecting to the Exchange server, set parameters as shown in the example above for ArchiveResolveAttendees.

When migrating to on-premises Exchange or Office 365 targets, MIME encoded HTML emails may not display correctly in the email client if there is a mismatch between the character encoding declared in the HEAD element of the HTML message and the character encoding declared in the MIME headers. When a mismatch occurs, the message displays as garbled text.

To correct this issue, enable the parameter by specifying the character set used by the HTML HEAD element that is causing a problem. For example:

UpdateHtmlWithMismatchedCharset=UTF-16

When the parameter is enabled, MNE checks for the character set in the HTML HEAD element and when found, the character set is replaced with the MIME header character set.

The parameter is disabled by default. Only enable the parameter if corrupted characters are observed in migrated messages.

NOTE: If errors occur during the parsing of the HTML, NME migrates the message with no modification.

UpdateHtmlWithMismatchedCharset=UTF-16

UpdateHtmlWithMismatchedCharset=US-ASCII

MIME encoded HTML emails often have the charset encoding declared in two places. The first is within the MIME headers and the second is within the HEAD element of the HTML message itself. With properly formatted emails, these two charset declarations are identical. Some HTML emails have been found where the charset declaration in the MIME headers and the charset declaration in the HTML message do not match. Typically in these cases, the HTML charset declaration is not in the HEAD element where it is expected, but instead it appears later in the document, possibly in the BODY element. While these emails may not be technically valid, they are still handled properly by most email clients.

A new behavior has been observed in Office 365 where the Exchange server attempts to correct the discrepancy in the charset declarations by removing the HTML charset declaration that conflicts with the MIME header charset declaration, and inserting a new HTML charset declaration in the HEAD element that matches the charset of the MIME header. In these cases the charset declaration will no longer match the actual encoding of the HTML body and as a result, non-ASCII characters are corrupted in the rendering of the email message.

To correct this issue, enable the UpdateHtmlWithMissingCharset option. With this option enabled, MNE checks for the presence of a charset declaration in the HTML HEAD element during the migration process. If missing, NME inserts a charset declaration using the charset value from the MIME message header. While this charset declaration may not match the actual encoding of the message, it makes Office 365 think that everything is proper, and prevents Office 365 from removing the correct charset declaration that appears later in the document. The second charset declaration in the body overrides the newly inserted one that is declared in the HEAD element. As a result, the email message renders properly in the email client.

If any parsing errors occur during the parsing of the HTML, NME migrates the message with no modifications.

This option is off by default. This option adds some minimal overhead to the migration process. It should only be enabled if corrupted characters are observed in the migrated messages.

The issue has only been observed when migrating to Office 365, but it could potentially be introduced in a later update to on-premises Exchange.

[Filter] section

This value specifies the max size limit for attachments—that is, the program will migrate only attachments that are smaller than the size designated here, in KB. For example: AttachSize=8000 tells the program to not migrate attachments larger than 8000 KB.

This value corresponds to a GUI element in the SSDM: the Migrate only calendar data ... dated on or after field in the Select Date and Size Filters screen, which specifies the earliest items that the program will migrate (will migrate only items that are timestamped on or after the designated date). The SSDM writes this value to the Task Parameters from the user's GUI entry; Quest recommends you do not manually enter or change this value except at the direction of Quest Support.

This parameter specifies the earliest items that the program will migrate (items that are timestamped on or after the designated date). When set to NONE, all mail and calendar items are migrated.

Quest recommends you do not manually enter or change this value except at the direction of Quest Support.

This value corresponds to a GUI element in the SSDM: the Migrate only messages ... dated on or after field in the Select Date and Size Filters screen, which specifies the earliest items that the program will migrate (will migrate only items that are timestamped on or after the designated date). The SSDM writes this value to the Task Parameters from the user's GUI entry; Quest recommends you do not manually enter or change this value except at the direction of Quest Support.

This value corresponds to a GUI element in the SSDM: the Migrate only calendar data ... dated on or before field in the Select Date and Size Filters screen, which specifies the latest items that the program will migrate (will migrate only items that are timestamped on or before the designated date). The SSDM writes this value to the Task Parameters from the user's GUI entry; Quest recommends you do not manually enter or change this value except at the direction of Quest Support.

This parameter specifies the latest items that the program will migrate (items that are timestamped on or before the designated date). When set to NONE, all mail and calendar items are migrated.

Quest recommends you do not manually enter or change this value except at the direction of Quest Support.

This value corresponds to a GUI element in the SSDM: the Migrate only messages ... dated on or before field in the Select Date and Size Filters screen, which specifies the latest items that the program will migrate (will migrate only items that are timestamped on or before the designated date). The SSDM writes this value to the Task Parameters from the user's GUI entry; Quest recommends you do not manually enter or change this value except at the direction of Quest Support.

[Filters] section

Each line specifies a folder name. The specified folder is excluded from the migration. For example:

[Filters]

Filter0=Folder1

Filter1=Folder2

Folders can be included or excluded by setting [Filters], [FolderTreeFilters], and [IncludeFoldersAndViews]. The precedence order is [Filters] > [IncludeFoldersAndViews] > [FolderTreeFilters].

[FolderTreeFilters] section

Each line specifies a folder name. The specified folder and all sub folders are excluded from the migration. For example:

[FolderTreeFilters]

Filter0=Folder1\sub1

Filter1=Folder2\sub1

Folders can be included or excluded by setting [Filters], [FolderTreeFilters], and [IncludeFoldersAndViews]. The precedence order is [Filters] > [IncludeFoldersAndViews] > [FolderTreeFilters].