Chat now with support
Chat with Support

Migrator for Notes to Exchange 4.16.3 - Program Parameters Reference Guide

About the Migrator for Notes to Exchange documentation Introduction Parameters for Admin Components Parameters for the Self-Service Desktop Migrator (SSDM)

[PowerShell] section

Type:

Default:

Occurs in:

 

integer

30 or 60 (see below)

NMM, Data Migr, AD Grps, Prov

 

Determines how long (in seconds) Migrator for Notes to Exchange will hold open an idle remote PowerShell connection before closing it. This feature applies only to the duration of an idle state during a connection. Each command run resets this timer to zero, so a series of commands with only short idle periods between commands could keep the connection open indefinitely. The default IdleConnectionTimeoutSeconds=30 is suitable for most environments.

IdleConnectionTimeoutSeconds=0 would tell Migrator for Notes to Exchange to not wait (wait 0 seconds) for a second command after a first, so would close any PowerShell connection immediately after only one command. The default is 30 seconds for migration to a proprietary Exchange, or 60 seconds for migration to Microsoft 365.

Type:

Default:

Occurs in:

 

integer

0 (no limit)

NMM, Data Migr, AD Grps, Prov

 

Determines the migration-server-wide limit for the number of concurrent PowerShell connections Migrator for Notes to Exchange can open. For example, if MaxPowerShellConnections=2, a four-thread migration might proceed like this:

Thread 1: Creates PowerShell connection.
Thread 3: Creates PowerShell connection.
Thread 2: Tries to create a connection, but they are used up so sleeps until a connection is available.
Thread 4: Tries to create a connection, but they are used up so sleeps until a connection is available.
Thread 3: Closes its PowerShell connection.
Thread 2: Wakes up and creates a PowerShell connection.
Thread 3: Tries to create a connection, but they are used up so sleeps until a connection is available.
Thread 2: Closes its PowerShell connection.
Thread 4: Wakes up and creates a PowerShell connection.

Note: The default setting (MaxPowerShellConnections=0) is interpreted as "no limit," effectively turning off this limiting feature.

Type:

Default:

Occurs in:

New in

boolean

0

NMM, Data Migr, AD Grps, Prov

4.16

Determines whether Migrator for Notes to Exchange will use a secure socket layer (SSL) connection to connect to the remote PowerShell session of an on-premises Exchange server. By default (0) the parameter does not use SSL to connect.

[ServerCalFolderFilter] section

Type:

Default:

Occurs in:

 

integer

10

Data Migr

 

A limit to the number of Filter<#> parameters (see below) that the Data Migration Wizard will process in this section. the wizard will read only Filter<#> parameters whose differentiating digits are less than the Count value. For example, if:

[ServerCalFolderFilter]
Count=15
Filter0=~INBOX
Filter1=~CALENDAR


Filter2=~SENT
Filter7=~ROOT
Filter8=~TASKS


Filter12=~TRASH
Filter19=~DRAFTS

... the wizard reads all the parameters except Filter19, since Count=15 and 19 > 15. If unspecified, the Count parameter defaults to 10. If specified, the parameter must occur as the first line of the section, as shown above.

Type:

Default:

Occurs in:

 

string

[none]

Data Migr

 

Identifies a Notes source folder from which server-based calendar-associated mail will be excluded from the migration. The Data Migration Wizard can discriminate between emails associated with calendar items (invitations, acceptance notifications, etc.), and other (non-calendar) emails, and can optionally exclude from the migration either type that originate from one or more designated source folders. Filter parameters in this [ServerCalFolderFilter] section identify the source folders from which server-based calendar-associated emails will be excluded. Other sections in these Default Settings may contain parameters to exclude other item types from certain source folders:

Within each such section, each parameter identifies a single source folder to which the filter will be applied. For example: [ServerCalFolderFilter] Filter0=~INBOX tells the wizard to apply the filter to the Inbox, while the section name in this example tells the wizard that the filter should exclude calendar-associated emails that reside on the server. For each such parameter, the parameter value specifies the mailbox by prepending a tilde character to the mailbox name, as follows:

~INBOX: Inbox
~CALENDAR: Calendar
~SENT: Sent Items

~DRAFTS: Drafts
~ROOT: [Root Dir]

~TASKS: Tasks
~TRASH: Trash

You may define one or more Filter<#> parameters within the section. The digit(s) appended to a Filter<#> key name differentiate one parameter from another. Multiple Filter<#> parameters need not appear in numerical order, and need not form an uninterrupted numeric sequence. For example, a section may contain only:

But the wizard will read only Filter<#> parameters whose differentiating digits are less than a value specified by a Count parameter in the first line of the section. See the Count parameter above for more information.

[ServerData] section

Type:

Default:

Occurs in:

 

boolean

[GUI entry]

Data Migr

 

This value corresponds to a GUI element in the Data Migration Wizard, the Migrate calendar data check box in the Migrate mail data section of the Specify Data for Migration screen. The wizard writes this value to the Task Parameters from an admin's GUI entry; Quest recommends you do not manually enter or change this value except at the direction of Quest Support.

Type:

Default:

Occurs in:

New in:

boolean

0

Data Migr

3.2

Determines whether the wizard should attempt to migrate the encrypted portions of encrypted messages in the source server. Typical usage is described below. This feature can also be applied to encrypted messages in users' archives, by this same parameter name in the [ArchiveData] section of these parameters. The feature is also available for the SSDM (in notesdtapp.ini), but in SSDM the default is 1.

The Data Migration Wizard can migrate the encrypted portion of an encrypted message only if it has the access credentials of the user who is authorized to decrypt the encrypted portion. An encrypted message also contains unencrypted portions, which the wizard can migrate in any case, even if it lacks the credentials to migrate the encrypted portion. In that case, the wizard can migrate the unencrypted portions, skip the encrypted portions, and insert text notices that the encrypted portions could not be migrated.

In most organizations, only the sender or recipient of an encrypted message is authorized to access the encrypted portion, and the wizard will not know those credentials unless the admin account running the wizard happens to be the sender or recipient of the encrypted message. It is possible, but uncommon, for an environment to be configured with broader or even universal access to the encrypted portions of encrypted messages, and in that case the wizard can freely migrate encrypted messages in their entirety. But in the more likely case where the access credentials are much more restrictive, the wizard will be unable to migrate the encrypted portions of encrypted messages.

This MigrateEncryptedMessages parameter lets you choose whether the wizard should even attempt to migrate the encrypted portions of encrypted messages. If access credentials for encrypted messages are more restrictive, the default MigrateEncryptedMessages=0 tells the wizard to not even attempt migrating the encrypted portions, but to just migrate the unencrypted portions with the substitute notice.

This option may improve performance simply by eliminating a wizard function that is rarely if ever needed in that scenario. Many organizations with restrictive access credentials simply use Migrator for Notes to Exchange's SSDM to migrate encrypted messages, since the SSDM will always have the access credentials of the user who is running it.

If MigrateEncryptedMessages=1, the wizard will attempt to migrate the encrypted portions, and will succeed or fail depending on whether the admin account running the wizard has the necessary credentials. If it fails, the wizard will migrate the message, skip the unencrypted portions and insert the substituted notice—the same outcome as for MigrateEncryptedMessages=0.

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

Type:

Default:

Occurs in:

 

boolean

[GUI entry]

Data Migr

 

This value corresponds to a GUI element in the Data Migration Wizard, the Migrate e-mail messages check box in the Migrate mail data section of the Specify Data for Migration screen. The wizard writes this value to the Task Parameters from an admin's GUI entry; Quest recommends you do not manually enter or change this value except at the direction of Quest Support.

Type:

Default:

Occurs in:

New in:

boolean

[GUI entry]

Data Migr

4.2.1

This value corresponds to a GUI element in the Data Migration Wizard, the Migrate task data check box in the Migrate mail data section of the Specify Data for Migration screen. The wizard writes this value to the Task Parameters from an admin's GUI entry; Quest recommends you do not manually enter or change this value except at the direction of Quest Support.

Type:

Default:

Occurs in:

 

boolean

[GUI entry]

Data Migr

 

This value corresponds to a GUI element in the Data Migration Wizard, the Migrate trash folder check box in the Migrate mail data section of the Specify Data for Migration screen. The wizard writes this value to the Task Parameters from an admin's GUI entry; Quest recommends you do not manually enter or change this value except at the direction of Quest Support.

Type:

Default:

Occurs in:

keyword (single digit 0, 1 or 2)

0 (but the wizard initializes the value to 1)

Data Migr

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

Note that the wizard will initialize this parameter to 1 if it is omitted from the task INI file, even though technically the program default is 1. You must explicitly include the parameter in Global Defaults or Task Parameters if you want the wizard to run with MigrateViews=0 or MigrateViews=2.

Type:

Default:

Occurs in:

 

boolean

0

Data Migr

 

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

If the wizard is set to migrate out-of-office messages (OOF=1), the behavior can be configured using the [Exchange] AllowExternalOOF parameter.

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

Type:

Default:

Occurs in:

New in:

boolean

0

Data Migr

4.6

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

SkipEntireEncryptedMessage=1 tells the wizard to skip any encrypted messages entirely 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 wizard processes encrypted messages, see the parameter notes for the MigrateEncryptedMessages parameter earlier in this [ServerData] section.

[ServerMailFolderFilter] section

Type:

Default:

Occurs in:

 

integer

10

Data Migr

 

A limit to the number of Filter<#> parameters (see below) that the Data Migration Wizard will process in this section. the wizard will read only Filter<#> parameters whose differentiating digits are less than the Count value. For example, if:

... the wizard will read all the parameters except Filter19, since Count=15 and 19 > 15. If unspecified, the Count parameter defaults to 10. If specified, the parameter must occur as the first line of the section, as shown above.

Type:

Default:

Occurs in:

 

string

[none]

Data Migr

 

Identifies a Notes source folder from which server-based non-calendar mail will be excluded from the migration. The Migrator for Notes to Exchange can discriminate between emails associated with calendar items (invitations, acceptance notifications, etc.), and other (non-calendar) emails, and can optionally exclude from the migration either type that originate from one or more designated source folders. Filter parameters in this [ServerMailFolderFilter] section identify the source folders from which server-based non-calendar emails will be excluded. Other Migrator for Notes to Exchange parameters may also exclude other item types from certain source folders, in one or more of these sections:

Within each such section, each parameter identifies a single source folder to which the filter will be applied. For example:

... tells the wizard to apply the filter to the Inbox, while the section name in this example tells the wizard that the filter to be applied should exclude mail items (non-calendar-associated emails) that reside on the server. For each such parameter, the parameter value specifies the mailbox by prepending a tilde character to the mailbox name, like these examples:

~INBOX: Inbox
~CALENDAR: Calendar
~SENT: Sent Items
~DRAFTS: Drafts

~ROOT: [Root Dir]
~TASKS: Tasks
~TRASH: Trash

You may define one or more Filter<#> parameters within the section. The digit(s) appended to a Filter<#> key name differentiate one parameter from another. Multiple Filter<#> parameters need not appear in numerical order, and need not form an uninterrupted numeric sequence. For example, a section may contain only:

But the wizard will read only Filter<#> parameters whose differentiating digits are less than a value specified by a Count parameter in the first line of the section. See the Count parameter above for more information.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating