Follow

Basic Steps to Install Lotus Notes 8.5.1 (or later) Multi-User on Citrix XenApp (REVISED)

Problem

What are the steps to install Lotus Notes 8.5.1 or later releases Multi-user installation, with a customized data directory, on a Citrix XenApp Server for new or existing Lotus Notes installs?

Environment

Lotus Notes 8.5.1 and later releases

Citrix XenApp 4.5, 5.0, 6.0 and 6.5 releases

 

Resolving the problem

 


!!!!!! Important Note !!!!!

This technote provides detailed steps on installing the Multi-user Lotus Notes Client 8.5.1 or later releases on a Citrix/XenApp Server. This is a command line install, and is the only installation method supported in these versions.

Single user installation techniques, used in previous versions of Lotus Notes, should not be used with this method. This includes any logon scripts that create the data directories, and their contents, for Lotus Notes. This is not required with the Multi-user installation or architecture.

In order to ensure a successful installation, the following steps must be followed. Adding additional steps, or attempting to migrate steps from the Single User install technique will result in installation failures.

 

Table of Contents:

Steps to Complete Prior to Install

Description of Installation MSI Parameters

New Lotus Notes 8.5.x Client Installs

Upgrading Lotus Notes to 8.5.x from an older release

 

 

Steps to Complete Prior To Install:

  1. Confirm that the version of Lotus Notes you will install is supported on the Windows Server build and Citrix XenApp build in your environment.

    The following technote provides the supported Lotus Notes, Windows Server, and Citrix XenApp releases:

    Supported configurations and support policy for Citrix products 1098489
  2. Identify the location where the user's data directory is currently stored or will be stored. If the user's data directory contains (or will contain) their OS profile name, then you should use the !USERNAME! in the command line path to use the user's OS profile name.

    This will be the path you'll use in the "MULTIUSERBASEDIR=" MSI install command line parameter.

    Example: MULTIUSERBASEDIR=C:\Documents and Settings\!USERNAME!\Lotus\Notes\data
  3. New Multi-User Migration Assistant (MUMA)

    The Lotus Notes 8.5.3 installation package provides a new utility called the Multi-User Migration Assistant (MUMA). MUMA can migrate a user's data directory a single user install data structure to a multi-user install data structure programmatically using Visual Basic Script (VBS).

    This utility can also be used with Citrix Single User installs, which was a single user install simulated to worked for multiple users, and was the procedure recommended in Lotus Notes 8.5 and earlier releases.

    You can use the MUMA utility to automatically migrate the user's data path from these Citrix single user install to the genuine multi-user install outlined in this technote.

    Using the Lotus Notes single user to multi-user migration assistant (MUMA) tool
  4. Identify the location you will use for the SharedDataDirectory, where the template, modem, dictionary files, help files, etc are stored.
  5. If your existing Notes Data directory paths do not include \lotus\notes\data, then you will need to create a plan to migrate the user's current data directory, to include the lotus\notes\data path.

    The MSI will automatically append lotus\notes\data to the path used in the MULTIUSERBASEDIR.

    The following Technote provides more information regarding this configuration requirement:

    MultiUserBaseDir appends 'Lotus\Notes\Data' to customized path specified for Notes multi-user data directory

    Starting in IBM Notes 9, MULTIUSERBASEDIR appends 'IBM\Notes\data' to the customized path specified for the Notes multi-user data directory.

    For more information see Technote 1422525 "MultiUserBaseDir appends 'Lotus\Notes\Data' to customized path specified for Notes multi-user data directory"
  6. Store the installation package, and run setup.exe local on the Citrix server.

    If this file is stored on a remote file share, and you run setup.exe from a network drive, you will receive the error "File not found: C:\Program Files\IBM\Lotus\Notes\framework\.provisioning_rc Provisioning..."
  7. Extract the installation package to access setup.exe. You must use setup.exe in the command line, and not the installation package provided on Passport Advantage or other media.

 

Description of Installation MSI Parameters:

 

Starting in Lotus Notes 8.5.1 or later releases, there are new MSI install parameters which can be used, specifically in a Citrix environment, to install Lotus Notes Multi-user install, configure it to recognize it's installing on a Citrix/Terminal Server, and modify the default locations of the Multi-user Data directory and the SharedDataDirectory (where the template files, modem files, notes.ini "shell", etc are stored).

 

CITRIX=1

Makes the MSI “Terminal Services” aware, and places the notes.ini in the correct location, and sets the Multi-user registry keys to the appropriate values.

SETMULTIUSER=1
Sets the MSI's table value MULTIUSER to the value of “1”, and will perform a multi-user install. This parameter was introduced in Lotus Notes 8.0.2.

MULTIUSERBASEDIR=<path>

Indicates the path where the user's data directory will be stored. Environment variables can be used in the path, for example MULTIUSERBASEDIR=C:\!USERNAME!. There's no need to add Lotus\Notes\data to this path. The MSI will automatically append Lotus\Notes\data.

From the example above, once the client installation completes, and the user launches Notes for the first time, the data directory will be stored in C:\<OS User Name>\Lotus\Notes\Data.

Note: If the users do not have access to create directories in your specified location, then the Lotus\Notes\data directory must be created manually prior to the user launching Lotus Notes.

Note: All environment variables must be enclosed in exclamation points (i.e. !environment_variable!).

MULTIUSERCOMMONDIR=<path>

Specifies the location of the templates, help files, modem files, etc, and the SharedDataDirectory= path in the notes.ini.

Note: To use spaces in the MULTIUSERCOMMONDIR= parameter, you must use double backslashes (\\) when leading this parameter with a backslash.

Example of syntax:

setup.exe /s /v"SETMULTIUSER=1 MULTIUSERBASEDIR=H:\notesinstall\ MULTIUSERCOMMONDIR=\"c:\\Program Files (x86)\\Notes\" CITRIX=1"


New Lotus Notes 8.5.x Client Installs



IMPORTANT NOTE : The MSI will automatically append \lotus\notes\data to any path you enter in the MULTIUSERBASEDIR MSI command line parameter.

Please see Technote 1422525 titled " MultiUserBaseDir appends 'Lotus\Notes\Data' to customized path specified for Notes multi-user data directory" for more information.

Command Line Syntax Example:

setup.exe /s /v"SETMULTIUSER=1 MULTIUSERBASEDIR=\"c:\Documents and Settings\!USERNAME!\" MULTIUSERCOMMONDIR=c:\Notes\common CITRIX=1"

Note: The backslash ( \ ) in MULTIUSERBASEDIR= \ is required for any file paths that contain spaces. In the example above, the folder D ocuments and Settings has spaces. File paths with spaces must also be enclosed in quotations, per the example.

However, you cannot use a leading backslash with the MULTIUSERCOMMONDIR installation parameter (e.g. MULTIUSERCOMMONDIR=\"C:\Notes Path\common") . This issue has been reported to Quality Engineering in SPR RCFE8RSR6F, and is currently under investigation.

Once this installation completes using the above command line, the client will be a Multi-user install, on a Citrix Server. The data directory will be under C:\Documents and Settings\<OS_Username>\Lotus\Notes\data (note the appendage of \lotus\notes\data), and the SharedDataDirectory will be located in C:\Notes\common

You can use the typical MSI silent install parameters (i.e. /qb, /qb+, /qb!, /qn) with this installation, if needed.

Upgrading Lotus Notes to 8.5.x from an older release

The general steps are the same for existing installs. However, you must uninstall your existing build of Lotus Notes. In addition, you must identify the current path of the user's data directory.

IMPORTANT NOTE:

The MSI will automatically append \lotus\notes\data to any path you enter in the MULTIUSERBASEDIR MSI command line parameter.

Please see Technote 1422525 titled " MultiUserBaseDir appends 'Lotus\Notes\Data' to customized path specified for Notes multi-user data directory" for more information.

Below is an example where the original data directory is w:\notes\data, and w:\ points to the user's OS profile (i.e C:\Documents and settings\<user name>)

Command Line Syntax Example:

setup.exe /s /v"SETMULTIUSER=1 MULTIUSERBASEDIR=w:\ MULTIUSERCOMMONDIR=c:\Notes\common CITRIX=1"

Once this installation completes using the above command line, the client will be a Multi-user install, on a Citrix Server. The data directory will be under w:\Lotus\Notes\data, where w:\ points to the user's OS profile under C:\Documents and Settings\<username>. The SharedDataDirectory will be located in C:\Notes\common.

Upgrades from 8.5.1 to a later release
If you are upgrading from 8.5.1 to a later release, and used the exact steps as explained above to install 8.5.1, then you can just run the installation of 8.5.x with the CITRIX=1 switch.

Example: setup.exe /v"CITRIX=1"

If the above steps were not used for a Multi-user install of 8.5.1 on Citrix, then you must first uninstall 8.5.1, and follow the steps for an Existing Installation.

Related information

MultiUserBaseDir appends 'Lotus\Notes\Data' to customiz
In a Notes multi-user install on Citrix Notes uninstall
Using MULTIUSERBASEDIR with network drive destination r
Can you specify the location of the Data directories in
Running Notes multi-user on Citrix using a custom data

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.
Powered by Zendesk