INSTALLING


Using the Notes single user to multi-user migration assistant tool

Use this procedure to convert an existing Notes® single user installation or simulated multi-user installation to a true Notes multi-user installation within a single Notes release. After migration you can then upgrade the release level of the Notes multi-user client.

Before you begin


About this task

Procedure

1. Exit the Notes application; Notes cannot be running during the migration.

2. Locate the files MUMigrationAssistant.vbs and MUMigrationAssistant.ini in the Utility folder in the Notes install kit.

3. Open the MUMigrationAssistant.vbs script and review its embedded documentation.

4. Open the MUMigrationAssistant.ini configuration file in a text editor and specify the following values:
OptionDescription
CURRENTINIPATH (Required) Specifies the current NOTES.INI file location. The tool obtains the user's data directory location from their NOTES.INI file.
NOTESPROGRAM(Optional) Specifies the current location of the user's notes.exe file. If not specified, the tool attempts to determines the location first from the Windows registry (HKLM/SOFTWARE/Lotus/Notes/version/Path first for versions 8.5.x and earlier, or HKLM/SOFTWARE/Lotus/Notes/Path for Notes 9.0 or greater), and then from the user's NOTES.INI file.
MULTIUSERBASEDIR(Optional) Specifies the target location for the user's data directory. When you run the tool, it confirms that the specified directory exists and that the tool has read/write permission to the directory. The tool appends Lotus\Notes\Data for versions of Notes prior to 9.0, or appends IBM\Notes\Data for Notes 9.0 or later. When you set this value, you must include %USERNAME% in MULTIUSERBASEDIR. If you do not specify a value for MULTIUSERBASEDIR, the default value CSIDL_APPDATA is used.

Important: If you specify a value for this setting, then you must also specify a value for MULTIUSERCOMMONDIR.

MULTIUSERCOMMONDIR(Optional) Specifies the location for the common shared data directory is located. When you run the tool, it confirms that the users whose data is being moved have read permission to the specified directory.

If you specify a value, the tool checks that the value includes the %USERNAME% environment variable. If you do not specify a value for MULTIUSERCOMMONDIR, the default value CSIDL_COMMON_APPDATA is used.

The tool appends Lotus\Notes\Data for versions of Notes prior to 9.0, or appends IBM\Notes\Data on Notes 9.0 or later.

Important: If you specify a value for this setting, then you must also specify a value for MULTIUSERBASEDIR.

DRYRUN(Optional)
  • True (default) - When you run the tool it generates a report listing the changes that would result from running the tool, but it does not perform the migration.
  • False - When you run the tool it performs the migration
MIGRATE_REGISTRY
  • True - The tool migrates HKLM registry settings and updates desktop shortcuts and start menu shortcuts for all users.
  • False - The tool does not migrate registry settings or update shortcuts.

When migrating from a simulated multi-user Notes installation, you can specify this options at the command prompt when running the cscript command
MIGRATE_USER_REGISTRY
  • True - The tool migrates registry settings and updates desktop shortcuts and start menu shortcuts for the user running the tool only.
  • False - The tool does not migrate registry settings or update shortcuts.

When migrating from a simulated multi-user Notes installation, you can specify this options at the command prompt when running the cscript command
MIGRATE_SHARED_DIR
  • True - The tool migrates the common data files to be shared among all users. These are the files that would be installed to the common shared directory during a Notes multi-user installation
  • False - The tool does not migrate common data files.

If you have other files to move, such as a user's templates, you can list them in a file and specify the location in the next setting, MIGRATE_SHARED_FILES.

To customize the target location for moved files, use the MULTIUSERCOMMONDIR setting.

When migrating from a simulated multi-user Notes installation, you can specify this options at the command prompt when running the cscript command

MIGRATE_SHARED_FILESSpecifies the name and location of the migratefilelist.txt text file that lists other files to move to the target shared directory, for example, user-defined templates or that were not installed by Notes.

To used this setting you must set the value of the previous setting, MIGRATE_SHARED_DIR, to True.

When migrating from a simulated multi-user Notes installation, you can specify this options at the command prompt when running the cscript command

MIGRATE_USERDATA_DIRUse this setting only when migrating a simulated multi-user installation to a true multi-user installation.
  • True - The tool migrates the user's personal data files (for example, user ID, templates, databases) to the directory specified by the MULTIUSERBASEDIR setting. The value should be set to true for every user.
  • False - The tool does not move personal data.

The tool determines the location of the source data directory from the NOTES.INI file and then confirms that each file to be migrated exists in the data directory and that the tool has permission to operate on the files.

You can create a batch file in the StartUp Group or the RunOnce registry key to run the script to migrate data automatically for every user when they log in to Windows for the first time after the migration. If the source data directories for each use reside on separate drives, you must run the tool separately for each user.

If no value is set for MULTIUSERBASEDIR, data is migrated to the location specified by the default user data path. For Notes 8.5x and earlier, the default path is: C:\Documents and Settings\username\Local Settings\Application Data\Lotus\Notes\Data; for Notes 9.0 or later, the default path is: C:\Documents and Settings\username\Local Settings\Application Data\IBM\Notes\Data .

When migrating from a simulated multi-user Notes installation, you can specify this options at the command prompt when running the cscript command


5. Save and close the MUMigrationAssistant.ini file.

6. Close the MUMigrationAssistant.vbs script.

7. Perform a test run of the migration by setting the value of the DRYRUN option in the configuration file to true and then typing the following at the command prompt:


8. Review the output report and determine if any MUMigrationAssistant.ini file adjustments are required. If so, make them now.

9. Perform the migration by setting the value of the DRYRUN option to false in the configuration file and then typing the following at the command prompt:


Results

The tool logs activity to the LotusInstall.log file, which resides in the installing user's My Documents folder and the migrated user's data directory.

Example

Example: Simulated multi-user installation to (true) multi-user installation

In this scenario, several users are configured to work on a single computer using a simulated multi-user environment and a shared drive containing their common and user-specific data files.

Migrate users based on your applicable use case as follows:

Use case 1 - Simple single user to multi-user migration for all versions of Notes

In this use case, Notes 8.5.1 is installed in single user mode with Program Files installed to C:\Program Files\IBM\Lotus Notes and data files installed to C:\Program Files\IBM\Lotus\Notes\Data,

Run the tool to do the following:


The values specified in the MUMigrationAssistant.ini are as follows:

DRYRUN=trueCURRENTINIPATH=C:\Program Files\IBM\Lotus\Notes\Data\notes.iniNOTESPROGRAM=C:\Program Files\IBM\Lotus\NotesIS_SIMULATED_MODE=falseMIGRATE_REGISTRY=trueMIGRATE_USER_REGISTRY=trueMIGRATE_SHARED_DIR=trueMIGRATE_USERDATA_DIR=trueMULTIUSERCOMMONDIR= MULTIUSERBASEDIR=

Note: Leave MULTIUSERBASEDIR and MULTIUSERCOMMONDIR blank to use the default value.

Use case 2 - Simulated multi-user to true multi-user migration - First run of the tool to move all the shared data

In this use case, Notes 8.5.1 is installed in single user mode but each user's data directory are mapped on a network drive. Program Files are installed to C:\Program Files\IBM\Lotus\Notes and data files are installed to H:\data. When the source data directory for all users is local or resides on a common network drive, you can run the tool to move data to the target data directory location for all the users of that Notes client instance.

Run MUMigrationAssistant as an administrator from a system that has access to the mapped data drive(s) for the users. to do the following:


The values specified in the MUMigrationAssistant.ini are as follows:

DRYRUN=trueCURRENTINIPATH=H:\data\notes.iniNOTESPROGRAM=C:\Program Files\IBM\Lotus\NotesIS_SIMULATED_MODE=trueMIGRATE_REGISTRY=trueMIGRATE_USER_REGISTRY=falseMIGRATE_SHARED_DIR=trueMIGRATE_USERDATA_DIR=falseMULTIUSERCOMMONDIR=C:\notes\commonMULTIUSERBASEDIR=H:\data

Use case 3 - Simulated multi-user to true multi-user migration with subsequent running of the tool when each user logs in to move each user's data

In this use case, Notes 8.5.1 is installed in single-user mode, but each user's data directory is resides on a mapped drive. The administrator has migrated the single-user settings on the Notes client to a multi-user installation. (as per Use case 2). Each user now logs in to the system.

Run MUMigrationAssistant when the user logs in to do the following:


The values specified in the MUMigrationAssistant.ini are as follows:

DRYRUN=trueCURRENTINIPATH=H:\data\notes.iniNOTESPROGRAM=C:\Program Files\IBM\Lotus\NotesIS_SIMULATED_MODE=trueMIGRATE_REGISTRY=falseMIGRATE_USER_REGISTRY=trueMIGRATE_SHARED_DIR=falseMIGRATE_USERDATA_DIR=trueMULTIUSERCOMMONDIR=C:\notes\commonMULTIUSERBASEDIR=

Note: Leave MULTIUSERBASEDIR blank at its default value.

Related concepts
Understanding the Notes single user to multi-user migration assistant tool

Related tasks
Installing and upgrading Notes on Windows for multi-user

Related information
Backing up and restoring Notes client data