Parameters
Database - Path to the desired database, including the ".nsf" extension. Paths should typically be relative to the Notes/Domino data directory, though full absolute paths can be used to access a local database.
As an alternative to specifying a database path in a connection string, developers can specify "$usermail" as an alias for mail file of the current user. For example, a connection string may include the parameter "database=$usermail". If a server is not specified in the connection string, then Migrator for Notes to SharePoint will attempt to open the user’s mail file on their default mail server. If a server (or "server=local") is specified, then Migrator for Notes to SharePoint will attempt to open the user’s mail file on the specified server first and then fail over to the user’s default mail server.
ReplicaID - Replica ID of the database as a 16 digit hexadecimal number. If both the database and replicaid are specified, multiple attempts to connect will be made before giving up.
Server - Name of server where desired database is located. This can be a short name or fully distinguished hierarchical name. Use "local" or simply omit this parameter when connecting to local database.
AltServer - Name of alternate server to be tried if database cannot be opened at server. This can be a short name or fully distinguished hierarchical name. Use "local" when connecting to a local database.
ImpersonateName - The fully distinguished user name you wish to use to access databases, for example "Joe Cool/Proposion" or "CN=Joe Cool/O=Acme". To enable impersonation for server databases, you need to edit the server's Server document. In the Domino Directory, go to the Security section, and add the user name (from the Notes ID that your .NET process will be using) to the "Trusted Servers" field. This requires Domino 6.0 or higher.
NameServer - Specifies which server to use for looking up users while validating user names and looking up the current user’s mail file. If the "NameServer" parameter is not specified, the default server (where the current database resides) will be used instead.
CacheSize - The number of records that will be loaded into memory at once by the data reader. This value will not impact final results but could impact the memory footprint and performance. The default is 10.
Command line options
The Migrator for Notes to SharePoint command line interface can be very useful for scripting jobs from other programs or from scheduling tools such as Windows Scheduler or Domino agents.
NMSPCMD.EXE is installed in our bin directory (typically C:\Program Files (x86)\Quest\Migrator for Notes to SharePoint\Bin).
Migrator for Notes to SharePoint supports the following command line options, which allow it to run in batch mode:
The parts in [ square brackets ] are optional overrides to the job options or global defaults. These overrides allow you to run the same job multiple times specifying different sources and targets each time.
The source can be any connection string that you see on the Notes, QuickPlace, Quickr or Domino.Doc tabs. The target should be the full path to the list or library.
Options in detail:
-target <listUrl>: Overrides the SharePoint Target Site and List in the Job Definition.
-export <outfile>: Perform a partial migration job writing intermediate results to the named XML data file.
-import <infile>: Perform a partial migration job using the named XML data file as a data input.
-defaultuser <username>: The “If lookup mapping fails” user mapping option is overridden to be “Substitute the default user”, using the username that is passed as the default user.
-filesfolder <>: When used, the attachments will be written to a separate "_Files" folder rather than the default intermediate data file. The abbreviated “-ff” can be used as well.
-formula <>: This argument allows whatever formula specified in the current job to be overridden.
-view <>: This argument allows whatever view specified in the current job to be overridden.
-form <formName>: This argument allows you to migrate documents associated to specified forms. If specifying multiple forms, separate form names by commas and put the whole string in double quotes.
-unid <unids>: Overrides the option "Select records/pages based on UNID" in the Source Data Definition. Separate multiple UNIDs using semicolons.
-options <optionsname>: Applies a saved options file by the options name.
NMSPCMD.EXE returns one of the following exit codes:
These error codes make it possible for scripts to detect the results and respond accordingly. Note that the resulting XML log file will usually contain a LogSummary section that provides further details.
Examples:
Connecting the Console to alternate Repository database
The Migrator for Notes to SharePoint Console now supports the ability to read a repository database argument from the command-line. Using the -rd command line option, you can launch the Console and specify an alternate repository database for the Console to connect to.
To use this feature, open a command prompt and launch the console using the following command:
The console will start with the database you specified. As long as you don’t save your configuration, your former repository will be used the next time you start the console without the “–rd” parameter.
To indicate an alternate repository is loaded, the Root Node label in the navigation tree will have the repository name appended. For example, "Migrator for Notes to SharePoint (TempRepository.nsf)".
Notes source data definition file format
Migrator for Notes to SharePoint stores Source Data Definitions as simple XML files (with a default extension of .PMSRC). You can edit these files using XML editors and even plain text editors. In addition, you can easily distribute them to other users.
By default, Data Definitions live in the DataDefinitions sub directory of your Migrator for Notes to SharePoint program directory, but you can change this location if you want to. See Customizing global options for more details.
Here is an example of a Source Data Definition file:
