Migrator for Notes to Exchange 4.16.1 - Program Parameters Reference Guide

[Screens] section

These are all "multiple-choice" parameters. For any of the parameters in this [Screens] section, the three valid values are:

Chapter 4 of the Migrator for Notes to Exchange Scenarios Guide explains how these parameters relate to others to customize the SSDM.

Determines whether, or under what circumstances, the Select Date and Size Filters screen will appear in program runs. See For all parameters... at the beginning of this [Screens] section for valid parameter values. For example: Filter=show

The default value “no-op” is a fourth valid value (for this Filter parameter only). The “no-op” setting is functionally equivalent to “silent,” but signifies that the parameter value is unassigned—in which case the screen will not appear in a program run.

Determines whether, or under what circumstances, the Migration Report screen (the "Finished" screen) will appear in program runs. See For all parameters... at the beginning of this [Screens] section for valid parameter values. For example: Finished=skip

Determines whether, or under what circumstances, the Specify Notes Login Information screen will appear in program runs. See For all parameters... at the beginning of this [Screens] section for valid parameter values. For example: Login=skip

Determines whether, or under what circumstances, the Specify Data for Migration screen will appear in program runs. See For all parameters... at the beginning of this [Screens] section for valid parameter values. For example: MigrateWhat=skip

Determines whether, or under what circumstances, the Select Profile screen will appear in program runs. See For all parameters... at the beginning of this [Screens] section for valid parameter values. For example: Profile=show

Determines whether, or under what circumstances, the Migrating Data screen (the "Progress" screen) will appear in program runs. See For all parameters... at the beginning of this [Screens] section for valid parameter values. Since this screen does not collect any information, the skip and silent options are equivalent. For example: Progress=skip

Determines whether, or under what circumstances, the Specify Directory for Migrated Archive screen will appear in program runs. See For all parameters... at the beginning of this [Screens] section for valid parameter values. For example: PstDir=skip

Determines whether, or under what circumstances, the Select Notes Address Books to Migrate screen will appear in program runs. See For all parameters... at the beginning of this [Screens] section for valid parameter values. For example: SelectAddrBook=show

Determines whether, or under what circumstances, the Select Notes Archive Files to Migrate screen will appear in program runs. See For all parameters... at the beginning of this [Screens] section for valid parameter values. For example: SelectArchive=show

Determines whether, or under what circumstances, the Select Notes Local Mail File Replica to Migrate screen will appear in program runs. See For all parameters... at the beginning of this [Screens] section for valid parameter values. For example: SelectMailFile=show

Determines whether, or under what circumstances, the Selection Summary screen will appear in program runs. See For all parameters... at the beginning of this [Screens] section for valid parameter values. Since this screen does not collect any information, the skip and silent options are equivalent. For example: Summary=skip

Determines whether, or under what circumstances, the Welcome screen will appear in program runs. See For all parameters... at the beginning of this [Screens] section for valid parameter values. Since this screen does not collect any information, the skip and silent options are equivalent. For example: Welcome=skip

[ServerData] section

Determines whether the program will migrate server calendar data. For example: MigrateCalData=0 tells the program to not migrate server calendar data. By default (MigrateCalData=1), the program will migrate server calendar data.

Determines whether the SSDM should attempt to migrate the encrypted portions of encrypted messages in the source server mail. This feature can also be applied to encrypted messages in the source archives, by this same parameter name in the [ArchiveData] section of notesdtapp.ini. The feature is also available for the Data Migration Wizard (same parameters in the same sections, but in Migrator for Notes to Exchange's Global Defaults and Task Parameters), but in the wizard the default is 0.

The SSDM can migrate the encrypted portion of an encrypted message if it has the access credentials of the user who is authorized to decrypt the encrypted portion. This is the typical case for most organizations who use the SSDM, where individual users run the SSDM under their own login credentials, to migrate their own data. But in the rare case where the access credentials for a user's encrypted data are different from the credentials of whoever is running the program, this parameter lets you control how the SSDM should handle encrypted data. If the program attempts to migrate an encrypted message but lacks the necessary credentials, it can migrate the unencrypted portions, skip the encrypted portions, and insert text notices to explain that the encrypted portions could not be migrated.

On the other hand: MigrateEncryptedMessages=0 tells the SSDM to not even attempt migrating the encrypted portions, but to just migrate the unencrypted portions and insert the notice text. If MigrateEncryptedMessages=1, the program will attempt to migrate the encrypted portions, and will succeed or fail depending on whether the account running the SSDM has the necessary credentials. If it fails, the SSDM will migrate the message, skip the unencrypted portion and insert the notice—the same outcome as for MigrateEncryptedMessages=0.

A related Migrator for Notes to Exchange parameter lets you tell the SSDM to skip an entire message (both encrypted and unencrypted portions) if the program is already configured to skip the encrypted portion (only) by MigrateEncryptedMessages=0. See SkipEntireEncryptedMessage in this same [ServerData] section for more information.

This value corresponds to a GUI element in the SSDM: the Migrate local mail file replica check box of the Specify Data for Migration screen. The SSDM writes this value to notesdtapp.ini from a user's GUI entry; Quest recommends you do not manually enter or change this value except at the explicit direction of Quest Support staff.

Determines whether the program will migrate server task data. For example: MigrateTaskData=0 tells the program to not migrate server tasks. By default (MigrateTaskData=1), the program will migrate server tasks.

... tells the program to migrate the server trash folder if the Specify Data for Migration screen does not appear, or sets the associated check box in that screen to be marked by default. A value of 0 tells the program to not migrate the server trash folder, or sets the associated check box to be unmarked by default. The most common use of this parameter is to provide the necessary entry value when the program is configured to hide the Specify Data screen. Chapter 4 of the Migrator for Notes to Exchange Scenarios Guide explains how this parameter relates to others used to customize the SSDM.

Determines whether and how the SSDM will migrate archive items that occur within Notes views. For example: MigrateViews=1 tells the program to migrate items only from the first view in which they are found. Valid parameter values are:

Note that the program will initialize this parameter to 1 if it is omitted from notesdtapp.ini, even though technically the program default is 0. You must explicitly include the parameter in notesdtapp.ini if you want the SSDM to run with MigrateViews=0 or MigrateViews=2.

Determines whether the program will migrate out-of-office messages. For example: OOF=1 tells the program to migrate out-of-office messages. By default (OOF=0), the program will not migrate out-of-office messages

NOTE: Migration of out-of-office messages (OOF=1) is not supported if the migration target is set to Personal folder (.pst).

Determines whether the SSDM will skip entire encrypted messages (skip both encrypted and unencrypted portions) in the source server data if the SSDM is already configured to skip the encrypted portions by MigrateEncryptedMessages=0 (also in this [ServerData] section).

… tells the program to skip any encrypted messages in their entirety if MigrateEncryptedMessages=0. This SkipEntireEncryptedMessage parameter is irrelevant and ignored if MigrateEncryptedMessages=1.

For more information about how encrypted messages are migrated, and how this SkipEntireEncryptedMessage parameter helps control how the SSDM processes encrypted messages, see the parameter notes for MigrateEncryptedMessages earlier in this [ServerData] section.

[SSDMThrottle] section

Determines whether the SSDM will use any of the throttling features, whereby an admin can regulate end users' use of the SSDM to avoid processing bottlenecks that might otherwise occur if too many users try to use the SSDM simultaneously. For example:

… tells the SSDM program to use the throttling features, as configured by an administrator in the SSDM Throttling Utility. (The SSDM Throttling Utility is fully documented in the Migrator for Notes to Exchange Administration Guide.) By default these features are disabled (UseThrottle=0).

If UseThrottle=1, a value must also be specified for the WebServiceUrl parameter, also in this [SSDMThrottle] section.

Specifies the URL to the web service for the SSDM throttling features, as configured by an administrator in the SSDM Throttling Utility. (The SSDM Throttling Utility is fully documented in the Migrator for Notes to Exchange Administration Guide.) For example:

A value for the WebServiceUrl parameter becomes mandatory if UseThrottle=1 (also in this [SSDMThrottle] section).

[Status] section

All these are internal scratch parameter (see Transient “scratch” parameters).