Introduction:

Over the years I got many questions how to rollout out Lotus Notes in connection with the InstallShield Tuner. This article here will describe how to use the InstallShield Tuner to build a customized Lotus Notes Installer.
If you have questions regarding this howto you can write me a email. I will keep this article up to date, so please come back to check for updates.
I will use steps in this tutorial/howto with "snapshots" (every step will be done in a different folder). So if something goes wrong you could go back to this snapshot without losing all changes you have done.

 

Note:
This howto will be constantly updated if problems are found or if there are additional steps to perform. So please do not share the howto as PDF, use only a bookmark/link.
 

Current Document Version:
V4.1 from 2010-10-03
(http://www.lotus-expert.com/en/articles/sntt-customize-client-installation.html)

 


A.) Preparations: Preparing the system

1a.) You need:

- A windows XP PC (Vista and Windows 7 should work too but wasn´t tested).

- Needed space 20GB

- Installshield Tuner (installed on the Windows XP PC):

For Notes 6.x:

  • Download "InstallShield tuner for Notes Win32 English" (C47CQNA).

For Notes 7.x and 8.0.x
  • Download "Install Shield Tuner for Lotus Notes Windows 2000, 2003 English". (C84T5NA).

For Notes 8.5.x
Currently, there is no Install Shield Tuner for 8.5x, and you must use the Tuner available for 7.x and 8.0.x

 

- A Lotus Notes Installation Kit:

1b.) Create a folder called MyNotesCustomization on C: (C:\MyNotesCustomization). Ensure that you have write / full access to the working directory.

1c.) Extract the "Lotus Notes Installation Kit" to C:\MyNotesCustomization\user_client_original.

1d.) [Optional] Create a C:\MyNotesCustomization\plugins\Dictionaries and copy all *.dic files from a domino 8.5 server (you need to install the webparts, no running webserver needed, but it must be installed)

1e.) Extract the NotesCustomizationKit_1_0.zip (In that example the file can be found here C:\MyNotesCustomization\user_client_original\deploy\NotesCustomizationKit_1_0.zip) to C:\MyNotesCustomization

1f.) Download the following two files ftp://ftp.info-zip.org/pub/infozip/win32/zip300xn.zip and ftp://ftp.info-zip.org/pub/infozip/win32/unz600xn.exe. Extract the unzip.exe and zip.exe from the ZIP files to C:\MyNotesCustomization. If you wish you can extract the complete ZIP files into that folder.

1g.) Optional (only needed if you wish to change the eclipse components)

Download and install the latest Java JDK.

1h.) Optional (only needed if you wish to change the eclipse components)

Set the JAVA_HOME directory environment variable, on the machine(s) on which you'll be installing Notes, to point to the JDK folder under which the keytool resides. A sample command line is shown below. In this example the needed bin\keytool would be resident in the indicated JAVA_HOME variable's directory.

set JAVA_HOME=C:\Program Files\Java\jdk

1i.) You need to change ZIP files, so download and install a appropriated software for that. In this guide / howto I will use WinRar which you can get here because it made things really easy.


B.) Preparations: Create a signer certificate

Note: This step is not needed if you didn´t wish to add own eclipse features and/or if you didn´t wish to edit existing ones.

Ba.) Create a keystore and generate the key pair. A sample command line is shown:

%JAVA_HOME%\bin\keytool -genkey -dname "cn=Bob, ou=Sales, o=foo, c=US" -alias "my self signed cert" -keypass mypassword -keystore C:\sign-plugin\abx\mykeystore -storepass password -keyalg "RSA" -validity 360

Bb.) Create a listing of the newly created self-signed certificate/key pair. A sample command line is shown:

%JAVA_HOME%\bin\keytool -list -v -alias "my self signed cert" -keystore C:\sign-plugin\abx\mykeystore -storepass password

Bc.) For the feature you'll be adding to the install kit, sign its updatesite JAR files (in the features folder and in the plugins folder) using the self-signed certificate/key pair. Sample command lines for signing JAR files in the features folder and plugins folder are shown:

%JAVA_HOME%\bin\jarsigner -verbose -keystore C:\sign-plugin\abx\mykeystore -storepass password -keypass mypassword C:\sign-plugin\abx\mytestUpdatesite\features\com.ibm.sign.demo.feature_1.0.0.jar "my self signed cert"

Bd.) Export a trust certificate that can authenticate your public key. A sample command line is shown (see notes 2 for the storepass):

%JAVA_HOME%\bin\keytool -export -alias "my self signed cert" -file myselfsignedcert.cer -keystore C:\sign-plugin\abx\mykeystore -storepass password

Be.) Add the exported trust certificate to the Notes install kit keystore to enable trust for your public key at install. A sample command line is shown (see notes 2 for the storepass):

%JAVA_HOME%\bin\keytool.exe -import -keystore "C:\sign-plugin\abx\AllClient.msi.w32\deploy\.keystore.JCEKS.IBM_J9_VM.install" -storetype JCEKS -alias "my self signed cert" -file myselfsignedcert.cer -storepass ""

Bf.) List the entries in the Notes install kit keystore. A sample command line is shown (see notes 2 for the storepass):

%JAVA_HOME%\bin\keytool.exe -list -v -keystore "C:\sign-plugin\abx\AllClient.msi.w32\deploy\.keystore.JCEKS.IBM_J9_VM.install" -storetype JCEKS -alias "my self signed cert" -storepass ""

 

Note 1: See "How to add a certificate to the Lotus Notes 8 installation media kit file using keytool.exe (Technote 1305165)" for more information.

Note 2: For 8.02 FP2 and above, the original IBM keystore has the password "changeit".

Note 3: This section used parts from the "Signing and adding new features to the kit" Notes Admin topic which can be found here.


 

1.) Removing features via trimUpdateSite.exe

In this section we will remove features from the Notes install kit via trimUpdateSite.exe, if you didn´t delete the feature from the installation kit you can skip that point.

Note: If you didn´t perform this step in the first place you need to remove the features by hand. In this section we will remove the connection features and the Sametime 8.0.2 client (we will replace it with sametime 8.5.1 in a later step) from a Lotus Notes 8.5.2 version. If you use a older Lotus Notes Version, it might happen that some screenshots aren´t similar to your one.

1a.) Copy all files from C:\MyNotesCustomization\user_client_original to C:\MyNotesCustomization\step1

1b.) Navigate to C:\MyNotesCustomization and start the trimUpdateSite.exe

1c.) Navigate to C:\MyNotesCustomization\step1 using the trimUpdateSite.exe and select the updateSite.zip.

Choose updateSite.zip

1d.) Now select the features you wish to delete from the installation kit and press on "process selections".

Choose updateSite.zip

1e.) After the trimUpdateSite.exe removed the files [this action can take some minutes] you can go the the next steps.

Choose updateSite.zip

 


 

2.) Eclipse Installation Features


The installation from the eclipse features like Activities, Composite Application Editor, Sametime and Symphony where controlled via a XML file. If you followed this howto/guideline this file can be found here C:\MyNotesCustomization\step2\deploy\install.xml. To change this file you need to edit it with the notepad editor.

I will show you here how to install Symphony as default (with Lotus Notes 8.5.2). But the steps are the same for the other eclipse components and versions.

Search for the line:

<installfeature default="false" description="%Editors.description" id="Editors" name="%Editors.name" required="false" show="true" version="8.5.2.20100811-1131">

With show="true" or show="false" you can control if the user see this feature in the installation menu. true means show it, and false means hide it.

With default="true" or default="false" you can control if the feature is installed via default. True means yes it is, false means no it isn´t.

With required="true" or required="false" you can control if the feature is required or no. True means yes it is, flase means no it isn´t and the user can deselect it during installation.

In our example above we would like to Install Symphony as defaut and the user shouldn´t be able to deselect it (we will hide it). So we will change our line to:

<installfeature default="true" description="%Editors.description" id="Editors" name="%Editors.name" required="true" show="false" version="8.5.2.20100811-1131">

Here is the list for the other eclipse features. Search for the description to find the correct line.

Symphony
description="%Editors.description"

Composite Application Editor
description="%CAE.description"

Activities (also known as "IBM Connections")
description="%Activities.description"

Sametime
description="%Sametime.description"

FeedReader
description="%Feedreader.description"

 


 

3.) Adding dictionaries (optional)

In this step we will add some dictionaries to the installation. If you need you can use this step as an example how to add some other files to the installation kit.

3a.) Copy all files from C:\MyNotesCustomization\step2 to C:\MyNotesCustomization\step3

3b.) Start the Installation Tuner

3c.) create a new MST

Create a new .mst

3d.) drag and drop the files into the data directory

Add .dic files

3e.) go to the "Additional Tools" -> "Direct Editor" Section and open the "Component" table.

3f.) Search for "CST_COMPONENT" and change the value in the Directory column (from normally "DATADIR") to "VDIR_SHARED"

Add .dic files

Note: You can use "VDIR_SHARED" for both, the multiuser and the singleuser installation.

3g.) close the Lotus Notes Installshield tuner and save the .mst

 


 

4.) Changing default installation path

In this step we will change the default installation path.

4a.) Copy the elements from C:\MyNotesCustomization\step3 to C:\MyNotesCustomization\step4

4b.) Start the Lotus Notes Installshield Tuner and select the .mst from the step4 folder.

4c.) Go to the "Product Properties" section and change the "Default Destination Path" in this example we install Lotus Notes to C:\Lotus\Notes because of the reason that there are many OS languages our there. You can have a "C:\Programme" or "C:\Program Files" or ... folder. To make your live easier you should use a path which is the same on every OS. This would help you when you deal with the scriptable setup for example.

multi vs. single user

4d.) go to the "Setup Properties" and change the red marked path names.

multi vs. single user

4e.) close the Lotus Notes Installshield tuner and save the .mst

 


 

5.) Changing the Installationsfeatures

In this step we will change the installation features which can be selected by the user.

5a.) Copy the elements from C:\MyNotesCustomization\step4 to C:\MyNotesCustomization\step5

5b.) Start the Lotus Notes Installshield Tuner and select the .mst from the step5 folder.

5c.) Go to "Organization" -> "Features" and select for example the spell checker. With 1 you can control if the user can see this feature or not. With 2 you can control if the feature is installed or not. You can hide a feature with this options but let it install as default. Or you can allow a user to select if this feature is installed or not. The option is to change the options here and controll with the in section "Use the.mst" described steps if you changed the correct options.

multi vs. single user

5d.) close the Lotus Notes Installshield tuner and save the .mst

Attention:

Do not change the core parts (change only the options which you see in the original installer). It might result in various problems.

 


6.) Adding Notes.ini Options

In this step we will add some notes.ini settings so that the users will get them as default settings.

6a.) Copy the elements from C:\MyNotesCustomization\step5 to C:\MyNotesCustomization\step6

6b.) Start the Lotus Notes Installshield Tuner and select the .mst from the step6 folder.

6c.) Go to the "System Configuration" -> "ini File" -> and select the program folder from the menu.

Adding Notes.ini Options

6d.) Open ProgramFilesFolder -> IBM -> Lotus -> Notes and create a new Notes.ini file.

Adding Notes.ini Options

6e.) Rename file to notes.ini and create a new Notes Section.

Adding Notes.ini Options

6f.) Set the values which you need...

Adding Notes.ini Options

6g.) Locate the Additional Tools section, and then click the Direct Editor item in the Additional Tools section.

6h.) In the center pane, select the Component table, and then scroll down the component list until you locate CST_COMPONENT1 (if you skipped step 3 this is the CST_COMPONENT entry).

6i.) Change the value in the Directory_ column from NOTES to the new value VDIR_INI (for all entries).

Adding Notes.ini Options

6j.) In the center pane, select the table and then scroll down the component list until you locate INIFILE.

6k.) Change the value in the DirProperty column from NOTES to the new value VDIR_INI.

Adding Notes.ini Options

 

Note1: Depending on previous steps it might be that CST_COMPONENT1 isn´t existing, or it has no value Notes. If this is the case for you then change only the line which starts with CST_COMPONENT and has the NOTES value in it.

Note2: You can use "VDIR_INI" for both, the multiuser and the singleuser installation.

6l.) close the Lotus Notes Installshield tuner and save the .mst

 


7.) multi-user vs. single-user installation

In this step we will change the installation type.

7a.) Copy the elements from C:\MyNotesCustomization\step6 to C:\MyNotesCustomization\step7

7b.) Start the Lotus Notes Installshield Tuner and select the .mst from the step7 folder.

7c.) Click Application Configuration

7d.) Click Setup Properties

7e.) Change the value in the ApplicationUsers property to:

  • "OnlyCurrentUser" for a single-user installation or
  • "AllUsers" for a multi-user installation

This is similar to the settings which can be chosen during the client installation:

(1) "Only for me (Single User Install)" and
(2) "Anyone who uses this computer (Multi-User Install)."

multi vs. single user

7f.) close the Lotus Notes Installshield tuner and save the .mst


8.) scriptable setup

The scriptable setup option uses a setting in the NOTES.INI file to provide information to the client setup wizard. During installation, the wizard displays only those panels that users need. The NOTES.INI setting ConfigFile= points to a text file that contains the required parameters. The wizard reads this text file and completes the setup. The user is able to bypass the wizard screens for which parameters have been provided.

8a.) Copy the elements from C:\MyNotesCustomization\step7 to C:\MyNotesCustomization\step8

8b.) Create a company_notes.cfg (you can change this name if you like) file in C:\MyNotesCustomization\plugins

8c.) edit this file and add the needed info's (You can find more infos in the Lotus Domino Admin Help file). Here are some sample settings:

Domino.Port=TCPIP
Domino.Name=domino-01/srv/company
Domino.Server=1
AdditionalServices=-1
AdditionalServices.NetworkDial=0
Directory.Name=Bigfoot
Directory.Server=ldap.bigfoot.com
IM.Server=sametime-01/srv/company
IM.Port=1533
IM.ConnectWhen=0
IM.Protocol=0
IM_ENABLE_SSO=1
IM_No_Setup=1
IM.ConnectWhen=0
Replication.Schedule=0

8e.) Now start the Lotus Notes Installshield Tuner and load the .mst file from the step8 folder. Drag and drop your config file from the source folder (green arrow) to our destination folder (red arrow).

Add a config file

8f.) go to the "system configuration" -> "INI Files" Section, expand the Programm folder and navigate to your notes.ini

8g.) add a new line in our notes.ini (see screenshot for more info's) which points to you config file.

Add a config file

8h.) close the Lotus Notes Installshield tuner and save the .mst

 


9.) Changing the shortcuts

In this step we will change the shortcuts. In this example we will remove the Mailminder entry.

9a.) Copy the elements from C:\MyNotesCustomization\step8 to C:\MyNotesCustomization\step9

9b.) Start the Lotus Notes Installshield Tuner and select the .mst from the step9 folder.

9c.) go to "System Configuration -> Shortcuts"

9d.) Remove the Notes Mailminder entry (delete it)

multi vs. single user

9e.) close the Lotus Notes Installshield tuner and save the .mst

 


10.) Add a tempfolder (optional)

Sometimes it is better to have a tempfolder which can be easier accessed by the user or the support staff. Many companys move the Notes Cache files to this folder (see notes.ini entrys in step 6). So its easier for them to find the cache.ndk and delete it, or inform advise the user via phone to do it.

10a.) Copy the elements from C:\MyNotesCustomization\step9 to C:\MyNotesCustomization\step10

10b.) Start the Lotus Notes Installshield Tuner and select the .mst from the step10 folder.

10c.) Go to the "System Configuration" -> "Files and Folder" section and create a new Folder on the destinations computer.

Add a tempfolder

10d.) Go to the "Additional Tools" -> "Direct Editor" Section. And open the Component table. If you followed this HowTo you need to search for the CST_COMPONENT2 entry (otherwise the number might be different).

Remember what you see in the Directory column. In our example this is "NewFolder1".

Add a tempfolder

10e.) Go to the "Additionals Tools" -> "Direct Editor" Section. And open the LockPermission table. If you followed this HowTo you need to search for the NewFolder1 entry (the one from step 6b.). Because of the reason that we wish to create a new tempfolder we set the access to FullAccess for Everyone.

Add a tempfolder

10f.) close the Lotus Notes Installshield tuner and save the .mst

 


11. Add xtaf dictionaries to installation package

Note 1: I will use Lotus Notes 8.5.2 in that section / example.

Beginning with Lotus Notes 8.5.1 there is now a new spell check engine which used the (so called) xtaf dictionaries (you can read more about it here). These dictionaries are used by the standard client (not the basic one) and the build in components like sametime. In this section I will describe how to add these dictionaries into the Lotus Notes installation kit.

11a.) Copy the elements from C:\MyNotesCustomization\step10 to C:\MyNotesCustomization\step11

11b.) get the NotesCustomizationKit_1_0.zip file from the Utility folder from the Notes Admin Installation package and extract the content to: C:\MyNotesCustomization [if not already done during the preparations]

11c.) Download the xtaf dictionaries from the IBM Passport website (the file is called Notes_XTAFDictionaries_852_WinLnx_Ml.zip) and extract the content to: C:\MyNotesCustomization\XTAF_Dics

11d.) Copy the dictionary (the single file updateSite_<lang>.zip) you wish to add from C:\MyNotesCustomization\XTAF_Dics\Apps\Dictionaries\XTAF to C:\MyNotesCustomization\deploy. For this example we will copy the updateSite_nl.zip which holds the dutch language.

11e.) Rename the updateSite_nl.zip to updateSite.zip

11f.) Open the updateSite.zip with WinRar (or any other appropriated software) and navigate to the features\com.ibm.langware.v5.dic.nl_NL.feature_<version>.jar JAR file and extract that file to C:\MyNotesCustomization\temp.

11g.) Navigate now to C:\MyNotesCustomization\temp (do NOT close WinRar) and change the filename from com.ibm.langware.v5.dic.nl_NL.feature_<version>.jar to com.ibm.langware.v5.dic.nl_NL.feature_<version>.zip

11h.) Open com.ibm.langware.v5.dic.nl_NL.feature_<version>.zip with WinRar and extract the feature.xml to C:\MyNotesCustomization\temp.

11i.) Open the feature.xml (do NOT close WinRar) with Notepad (I prefer NotePad+) and change the feature colocation-affinity="com.ibm.rcp.site.anchor.user.feature" to feature colocation-affinity="com.ibm.rcp.platform.feature" and save the file. You can read more about that here (technote 1440976).

11j.) now open the WinRar windows where you edit the com.ibm.langware.v5.dic.nl_NL.feature_<version>.zip and replace the already existing feature.xml with the one which was changed by you. After that delete the META-INF folder (it holds the jar signature) from the ZIP file. After that step close this WinRar windows now and save the com.ibm.langware.v5.dic.nl_NL.feature_<version>.zip when asked.

11k.) now rename com.ibm.langware.v5.dic.nl_NL.feature_<version>.zip to com.ibm.langware.v5.dic.nl_NL.feature_<version>.jar

11l.) Because of the reason that you changed the JAR file you need to sign the JAR now with your certificate (see "Preparations: Create a signer certificate"), otherwise the Notes installer will not accept the so changed file, because the signature is now damaged (a security feature from JAR files). To sign the JAR file run now the following command:

"C:\Program Files\Java\jdk\bin\jarsigner" -verbose -keystore C:\MyNotesCustomization\mykeystore -storepass password -keypass mypassword C:\MyNotesCustomization\temp\*.jar "my self signed cert"

Please note: Your keystore name, the certificate and the password might be another one, so you need to adjust the line above so that it fits your needs.

11m.) After the JAR file is signed now, open the WinRar windows which has the updateSite.zip open and replace the features\com.ibm.langware.v5.dic.nl_NL.feature_<version>.jar with your changed one. Close this WinRar windows and save the file if asked. Delete now all files in C:\MyNotesCustomization\temp.

11n.) Open C:\MyNotesCustomization\deploy\updateSite.zip and extract the install.xml to C:\MyNotesCustomization\deploy\deploy

11o.) now we can try a dry run (nothing is changed in that step). To perform the try run open a comandprompt (cmd) and navigate to C:\MyNotesCustomization and use the following command line:

addtoKit -d -n C:\MyNotesCustomization\deploy C:\MyNotesCustomization\step11

You will then see some debug outputs and can control if there are any errors.

11p.) If you are happy with the output from the last step go ahead and add the dictionary to the kit via:

addtoKit -d C:\MyNotesCustomization\deploy C:\MyNotesCustomization\step11

11q.) If you like you can now check if the dictionary was added successfully to the kit. Open the deploy\install.xml file and check if you can find a similar section like:

<installfeature mergeaction="add" default="true" description="Platform.XPD.Dictionary feature. Select this feature to install spell check dictionary." id="Platform.XPD.Dictionary.de" required="true" show="false" version="7.1.1.201006221804">
<requirements>
<feature id="com.ibm.langware.v5.dic.de_DE_Reform.feature" download-size="809" match="perfect" size="1170" url="jar:${installer.root}/updateSite.zip!/" version="7.1.1.201006221804"/>
<feature id="com.ibm.langware.v5.dic.de_CH.feature" download-size="769" match="perfect" size="1109" url="jar:${installer.root}/updateSite.zip!/" version="7.1.1.201006221804"/>
</requirements>
</installfeature>

11r.) If you wish to add other xtaf dictionary repead step 11d ... 11q

 

Note 1:

See also Technote 1440976 (Customizing Lotus Notes multi-user install kit for correct XTAF dictionary installation) for more informations.

Note 2:

If you didn´t sign the changed JAR file the installer will fail with the error message: "failed to install. The reason provided is CWPST1012E: Plugin has been corrupted" and some client components will then not work correctly!

 


12. Updating the Sametime embedded client

In this section we will add the Sametime 8.5.1 embedded Sametime client to a Lotus Notes 8.5.2 installation kit. Before you can do that please be sure you removed the Sametime 8.0.2 from the installation kit. For other Notes Client and/or Sametime Client versions, the following steps might be similar (except some text strings)

12a.) Copy the files from C:\MyNotesCustomization\step11 to C:\MyNotesCustomization\step12

12b.) Download the package CZII3ML (IBM Lotus Sametime Standard V8.5.1 Connect Clients Standalone, Notes, Network Installer, Mobile Windows Mac Linux Multilingual) from the IBM Passport Advantage Website [or you can use the CD/DVD].

12c.) Extract the CZII3ML to C:\Temp\Sametime851

12d.) Navigate to "C:\Temp\Sametime851\SametimeStandardClient\sametimeclient.for.notes\Windows" and run the sametime-connect-for-notes.exe

12e.) Unpack the files to C:\MyNotesCustomization\IBM Lotus Sametime Embedded 8.5.1

12f.) Copy the sametime.embedded.addon.win32.20100731-1716.zip from C:\Temp\Sametime851\SametimeStandardClient\sametimeclient.for.notes\Windows to C:\MyNotesCustomization\deploy.

12g.) Rename sametime.embedded.addon.win32.20100731-1716.zip to updateSite.zip

12h.) Copy the C:\MyNotesCustomization\IBM Lotus Sametime Embedded 8.5.1\deploy\install.addon.xml to C:\MyNotesCustomization\deploy\deploy\install.xml

12i.) Now edit the C:\MyNotesCustomization\deploy\deploy\install.xml and change every reference from sametime.embedded.addon.win32.20100731-1716.zip to updateSite.zip. BE CAREFULL! and save the file.

12j.) run the following command to test everything (dryrun, no change, only a test):

addtoKit -d -n C:\MyNotesCustomization\deploy C:\MyNotesCustomization\step12

If you are happy with the output you can add the Sametime client to the installation kit via:

addtoKit -d C:\MyNotesCustomization\deploy C:\MyNotesCustomization\step12

12k.) open now the C:\MyNotesCustomization\step12\deploy\install.xml with notepad

12l.) search for Sametime

12m.) You will find now a section similar like the following:

<installfeature default="true" id="Sametime" name="Sametime" required="true" show="false" version="8.5.2.20100811-1131">
<requirements>

after the lines you can find the following 9 lines:

<feature download-size="158" id="com.ibm.collaboration.realtime.browser.feature" match="greaterOrEqual" shared="true" size="131" url="jar:${installer.root}/updateSite.zip!/" version="8.0.2.20100802-0849"/>
<feature download-size="211" id="com.ibm.collaboration.realtime.chat.logging.feature" match="greaterOrEqual" shared="true" size="184" url="jar:${installer.root}/updateSite.zip!/" version="8.0.2.20100802-0849"/>
<feature download-size="218" id="com.ibm.collaboration.realtime.core.feature" match="greaterOrEqual" shared="true" size="222" url="jar:${installer.root}/updateSite.zip!/" version="8.0.2.20100802-0849"/>
<feature download-size="396" id="com.ibm.collaboration.realtime.im.community.feature" match="greaterOrEqual" shared="true" size="369" url="jar:${installer.root}/updateSite.zip!/" version="8.0.2.20100802-0849"/>
<feature download-size="409" id="com.ibm.collaboration.realtime.messages.feature" match="greaterOrEqual" shared="true" size="382" url="jar:${installer.root}/updateSite.zip!/" version="8.0.2.20100802-0849"/>
<feature download-size="213" id="com.ibm.collaboration.realtime.people.feature" match="greaterOrEqual" shared="true" size="186" url="jar:${installer.root}/updateSite.zip!/" version="8.0.2.20100802-0849"/>
<feature download-size="242" id="com.ibm.collaboration.realtime.rtc.core.feature" match="greaterOrEqual" shared="true" size="245" url="jar:${installer.root}/updateSite.zip!/" version="8.0.2.20100802-0849"/>
<feature download-size="1214" id="com.ibm.collaboration.realtime.ui.feature" match="greaterOrEqual" shared="true" size="1224" url="jar:${installer.root}/updateSite.zip!/" version="8.0.2.20100802-0849"/>
<feature download-size="104" id="com.ibm.rcp.realtime.livenames.feature" match="greaterOrEqual" shared="true" size="77" url="jar:${installer.root}/updateSite.zip!/" version="8.0.2.20100802-0849"/>

 

delete these lines, or comment them out like:

<!--
Removed lines, because of updated Sametime client to 8.5.1
<feature download-size="158" id="com.ibm.collaboration.realtime.browser.feature" match="greaterOrEqual" shared="true" size="131" url="jar:${installer.root}/updateSite.zip!/" version="8.0.2.20100802-0849"/>
<feature download-size="211" id="com.ibm.collaboration.realtime.chat.logging.feature" match="greaterOrEqual" shared="true" size="184" url="jar:${installer.root}/updateSite.zip!/" version="8.0.2.20100802-0849"/>
<feature download-size="218" id="com.ibm.collaboration.realtime.core.feature" match="greaterOrEqual" shared="true" size="222" url="jar:${installer.root}/updateSite.zip!/" version="8.0.2.20100802-0849"/>
<feature download-size="396" id="com.ibm.collaboration.realtime.im.community.feature" match="greaterOrEqual" shared="true" size="369" url="jar:${installer.root}/updateSite.zip!/" version="8.0.2.20100802-0849"/>
<feature download-size="409" id="com.ibm.collaboration.realtime.messages.feature" match="greaterOrEqual" shared="true" size="382" url="jar:${installer.root}/updateSite.zip!/" version="8.0.2.20100802-0849"/&g

Introduction:

Over the years I got many questions how to rollout out Lotus Notes in connection with the InstallShield Tuner. This article here will describe how to use the InstallShield Tuner to build a customized Lotus Notes Installer.
If you have questions regarding this howto you can write me a email. I will keep this article up to date, so please come back to check for updates.
I will use steps in this tutorial/howto with "snapshots" (every step will be done in a different folder). So if something goes wrong you could go back to this snapshot without losing all changes you have done.

 

Note:
This howto will be constantly updated if problems are found or if there are additional steps to perform. So please do not share the howto as PDF, use only a bookmark/link.
 

Current Document Version:
V4.1 from 2010-10-03
(http://www.lotus-expert.com/en/articles/sntt-customize-client-installation.html)

 


A.) Preparations: Preparing the system

1a.) You need:

- A windows XP PC (Vista and Windows 7 should work too but wasn´t tested).

- Needed space 20GB

- Installshield Tuner (installed on the Windows XP PC):

For Notes 6.x:

  • Download "InstallShield tuner for Notes Win32 English" (C47CQNA).

For Notes 7.x and 8.0.x
  • Download "Install Shield Tuner for Lotus Notes Windows 2000, 2003 English". (C84T5NA).

For Notes 8.5.x
Currently, there is no Install Shield Tuner for 8.5x, and you must use the Tuner available for 7.x and 8.0.x

 

- A Lotus Notes Installation Kit:

1b.) Create a folder called MyNotesCustomization on C: (C:\MyNotesCustomization). Ensure that you have write / full access to the working directory.

1c.) Extract the "Lotus Notes Installation Kit" to C:\MyNotesCustomization\user_client_original.

1d.) [Optional] Create a C:\MyNotesCustomization\plugins\Dictionaries and copy all *.dic files from a domino 8.5 server (you need to install the webparts, no running webserver needed, but it must be installed)

1e.) Extract the NotesCustomizationKit_1_0.zip (In that example the file can be found here C:\MyNotesCustomization\user_client_original\deploy\NotesCustomizationKit_1_0.zip) to C:\MyNotesCustomization

1f.) Download the following two files ftp://ftp.info-zip.org/pub/infozip/win32/zip300xn.zip and ftp://ftp.info-zip.org/pub/infozip/win32/unz600xn.exe. Extract the unzip.exe and zip.exe from the ZIP files to C:\MyNotesCustomization. If you wish you can extract the complete ZIP files into that folder.

1g.) Optional (only needed if you wish to change the eclipse components)

Download and install the latest Java JDK.

1h.) Optional (only needed if you wish to change the eclipse components)

Set the JAVA_HOME directory environment variable, on the machine(s) on which you'll be installing Notes, to point to the JDK folder under which the keytool resides. A sample command line is shown below. In this example the needed bin\keytool would be resident in the indicated JAVA_HOME variable's directory.

set JAVA_HOME=C:\Program Files\Java\jdk

1i.) You need to change ZIP files, so download and install a appropriated software for that. In this guide / howto I will use WinRar which you can get here because it made things really easy.


B.) Preparations: Create a signer certificate

Note: This step is not needed if you didn´t wish to add own eclipse features and/or if you didn´t wish to edit existing ones.

Ba.) Create a keystore and generate the key pair. A sample command line is shown:

%JAVA_HOME%\bin\keytool -genkey -dname "cn=Bob, ou=Sales, o=foo, c=US" -alias "my self signed cert" -keypass mypassword -keystore C:\sign-plugin\abx\mykeystore -storepass password -keyalg "RSA" -validity 360

Bb.) Create a listing of the newly created self-signed certificate/key pair. A sample command line is shown:

%JAVA_HOME%\bin\keytool -list -v -alias "my self signed cert" -keystore C:\sign-plugin\abx\mykeystore -storepass password

Bc.) For the feature you'll be adding to the install kit, sign its updatesite JAR files (in the features folder and in the plugins folder) using the self-signed certificate/key pair. Sample command lines for signing JAR files in the features folder and plugins folder are shown:

%JAVA_HOME%\bin\jarsigner -verbose -keystore C:\sign-plugin\abx\mykeystore -storepass password -keypass mypassword C:\sign-plugin\abx\mytestUpdatesite\features\com.ibm.sign.demo.feature_1.0.0.jar "my self signed cert"

Bd.) Export a trust certificate that can authenticate your public key. A sample command line is shown (see notes 2 for the storepass):

%JAVA_HOME%\bin\keytool -export -alias "my self signed cert" -file myselfsignedcert.cer -keystore C:\sign-plugin\abx\mykeystore -storepass password

Be.) Add the exported trust certificate to the Notes install kit keystore to enable trust for your public key at install. A sample command line is shown (see notes 2 for the storepass):

%JAVA_HOME%\bin\keytool.exe -import -keystore "C:\sign-plugin\abx\AllClient.msi.w32\deploy\.keystore.JCEKS.IBM_J9_VM.install" -storetype JCEKS -alias "my self signed cert" -file myselfsignedcert.cer -storepass ""

Bf.) List the entries in the Notes install kit keystore. A sample command line is shown (see notes 2 for the storepass):

%JAVA_HOME%\bin\keytool.exe -list -v -keystore "C:\sign-plugin\abx\AllClient.msi.w32\deploy\.keystore.JCEKS.IBM_J9_VM.install" -storetype JCEKS -alias "my self signed cert" -storepass ""

 

Note 1: See "How to add a certificate to the Lotus Notes 8 installation media kit file using keytool.exe (Technote 1305165)" for more information.

Note 2: For 8.02 FP2 and above, the original IBM keystore has the password "changeit".

Note 3: This section used parts from the "Signing and adding new features to the kit" Notes Admin topic which can be found here.


 

1.) Removing features via trimUpdateSite.exe

In this section we will remove features from the Notes install kit via trimUpdateSite.exe, if you didn´t delete the feature from the installation kit you can skip that point.

Note: If you didn´t perform this step in the first place you need to remove the features by hand. In this section we will remove the connection features and the Sametime 8.0.2 client (we will replace it with sametime 8.5.1 in a later step) from a Lotus Notes 8.5.2 version. If you use a older Lotus Notes Version, it might happen that some screenshots aren´t similar to your one.

1a.) Copy all files from C:\MyNotesCustomization\user_client_original to C:\MyNotesCustomization\step1

1b.) Navigate to C:\MyNotesCustomization and start the trimUpdateSite.exe

1c.) Navigate to C:\MyNotesCustomization\step1 using the trimUpdateSite.exe and select the updateSite.zip.

Choose updateSite.zip

1d.) Now select the features you wish to delete from the installation kit and press on "process selections".

Choose updateSite.zip

1e.) After the trimUpdateSite.exe removed the files [this action can take some minutes] you can go the the next steps.

Choose updateSite.zip

 


 

2.) Eclipse Installation Features


The installation from the eclipse features like Activities, Composite Application Editor, Sametime and Symphony where controlled via a XML file. If you followed this howto/guideline this file can be found here C:\MyNotesCustomization\step2\deploy\install.xml. To change this file you need to edit it with the notepad editor.

I will show you here how to install Symphony as default (with Lotus Notes 8.5.2). But the steps are the same for the other eclipse components and versions.

Search for the line:

<installfeature default="false" description="%Editors.description" id="Editors" name="%Editors.name" required="false" show="true" version="8.5.2.20100811-1131">

With show="true" or show="false" you can control if the user see this feature in the installation menu. true means show it, and false means hide it.

With default="true" or default="false" you can control if the feature is installed via default. True means yes it is, false means no it isn´t.

With required="true" or required="false" you can control if the feature is required or no. True means yes it is, flase means no it isn´t and the user can deselect it during installation.

In our example above we would like to Install Symphony as defaut and the user shouldn´t be able to deselect it (we will hide it). So we will change our line to:

<installfeature default="true" description="%Editors.description" id="Editors" name="%Editors.name" required="true" show="false" version="8.5.2.20100811-1131">

Here is the list for the other eclipse features. Search for the description to find the correct line.

Symphony
description="%Editors.description"

Composite Application Editor
description="%CAE.description"

Activities (also known as "IBM Connections")
description="%Activities.description"

Sametime
description="%Sametime.description"

FeedReader
description="%Feedreader.description"

 


 

3.) Adding dictionaries (optional)

In this step we will add some dictionaries to the installation. If you need you can use this step as an example how to add some other files to the installation kit.

3a.) Copy all files from C:\MyNotesCustomization\step2 to C:\MyNotesCustomization\step3

3b.) Start the Installation Tuner

3c.) create a new MST

Create a new .mst

3d.) drag and drop the files into the data directory

Add .dic files

3e.) go to the "Additional Tools" -> "Direct Editor" Section and open the "Component" table.

3f.) Search for "CST_COMPONENT" and change the value in the Directory column (from normally "DATADIR") to "VDIR_SHARED"

Add .dic files

Note: You can use "VDIR_SHARED" for both, the multiuser and the singleuser installation.

3g.) close the Lotus Notes Installshield tuner and save the .mst

 


 

4.) Changing default installation path

In this step we will change the default installation path.

4a.) Copy the elements from C:\MyNotesCustomization\step3 to C:\MyNotesCustomization\step4

4b.) Start the Lotus Notes Installshield Tuner and select the .mst from the step4 folder.

4c.) Go to the "Product Properties" section and change the "Default Destination Path" in this example we install Lotus Notes to C:\Lotus\Notes because of the reason that there are many OS languages our there. You can have a "C:\Programme" or "C:\Program Files" or ... folder. To make your live easier you should use a path which is the same on every OS. This would help you when you deal with the scriptable setup for example.

multi vs. single user

4d.) go to the "Setup Properties" and change the red marked path names.

multi vs. single user

4e.) close the Lotus Notes Installshield tuner and save the .mst

 


 

5.) Changing the Installationsfeatures

In this step we will change the installation features which can be selected by the user.

5a.) Copy the elements from C:\MyNotesCustomization\step4 to C:\MyNotesCustomization\step5

5b.) Start the Lotus Notes Installshield Tuner and select the .mst from the step5 folder.

5c.) Go to "Organization" -> "Features" and select for example the spell checker. With 1 you can control if the user can see this feature or not. With 2 you can control if the feature is installed or not. You can hide a feature with this options but let it install as default. Or you can allow a user to select if this feature is installed or not. The option is to change the options here and controll with the in section "Use the.mst" described steps if you changed the correct options.

multi vs. single user

5d.) close the Lotus Notes Installshield tuner and save the .mst

Attention:

Do not change the core parts (change only the options which you see in the original installer). It might result in various problems.

 


6.) Adding Notes.ini Options

In this step we will add some notes.ini settings so that the users will get them as default settings.

6a.) Copy the elements from C:\MyNotesCustomization\step5 to C:\MyNotesCustomization\step6

6b.) Start the Lotus Notes Installshield Tuner and select the .mst from the step6 folder.

6c.) Go to the "System Configuration" -> "ini File" -> and select the program folder from the menu.

Adding Notes.ini Options

6d.) Open ProgramFilesFolder -> IBM -> Lotus -> Notes and create a new Notes.ini file.

Adding Notes.ini Options

6e.) Rename file to notes.ini and create a new Notes Section.

Adding Notes.ini Options

6f.) Set the values which you need...

Adding Notes.ini Options

6g.) Locate the Additional Tools section, and then click the Direct Editor item in the Additional Tools section.

6h.) In the center pane, select the Component table, and then scroll down the component list until you locate CST_COMPONENT1 (if you skipped step 3 this is the CST_COMPONENT entry).

6i.) Change the value in the Directory_ column from NOTES to the new value VDIR_INI (for all entries).

Adding Notes.ini Options

6j.) In the center pane, select the table and then scroll down the component list until you locate INIFILE.

6k.) Change the value in the DirProperty column from NOTES to the new value VDIR_INI.

Adding Notes.ini Options

 

Note1: Depending on previous steps it might be that CST_COMPONENT1 isn´t existing, or it has no value Notes. If this is the case for you then change only the line which starts with CST_COMPONENT and has the NOTES value in it.

Note2: You can use "VDIR_INI" for both, the multiuser and the singleuser installation.

6l.) close the Lotus Notes Installshield tuner and save the .mst

 


7.) multi-user vs. single-user installation

In this step we will change the installation type.

7a.) Copy the elements from C:\MyNotesCustomization\step6 to C:\MyNotesCustomization\step7

7b.) Start the Lotus Notes Installshield Tuner and select the .mst from the step7 folder.

7c.) Click Application Configuration

7d.) Click Setup Properties

7e.) Change the value in the ApplicationUsers property to:

  • "OnlyCurrentUser" for a single-user installation or
  • "AllUsers" for a multi-user installation

This is similar to the settings which can be chosen during the client installation:

(1) "Only for me (Single User Install)" and
(2) "Anyone who uses this computer (Multi-User Install)."

multi vs. single user

7f.) close the Lotus Notes Installshield tuner and save the .mst


8.) scriptable setup

The scriptable setup option uses a setting in the NOTES.INI file to provide information to the client setup wizard. During installation, the wizard displays only those panels that users need. The NOTES.INI setting ConfigFile= points to a text file that contains the required parameters. The wizard reads this text file and completes the setup. The user is able to bypass the wizard screens for which parameters have been provided.

8a.) Copy the elements from C:\MyNotesCustomization\step7 to C:\MyNotesCustomization\step8

8b.) Create a company_notes.cfg (you can change this name if you like) file in C:\MyNotesCustomization\plugins

8c.) edit this file and add the needed info's (You can find more infos in the Lotus Domino Admin Help file). Here are some sample settings:

Domino.Port=TCPIP
Domino.Name=domino-01/srv/company
Domino.Server=1
AdditionalServices=-1
AdditionalServices.NetworkDial=0
Directory.Name=Bigfoot
Directory.Server=ldap.bigfoot.com
IM.Server=sametime-01/srv/company
IM.Port=1533
IM.ConnectWhen=0
IM.Protocol=0
IM_ENABLE_SSO=1
IM_No_Setup=1
IM.ConnectWhen=0
Replication.Schedule=0

8e.) Now start the Lotus Notes Installshield Tuner and load the .mst file from the step8 folder. Drag and drop your config file from the source folder (green arrow) to our destination folder (red arrow).

Add a config file

8f.) go to the "system configuration" -> "INI Files" Section, expand the Programm folder and navigate to your notes.ini

8g.) add a new line in our notes.ini (see screenshot for more info's) which points to you config file.

Add a config file

8h.) close the Lotus Notes Installshield tuner and save the .mst

 


9.) Changing the shortcuts

In this step we will change the shortcuts. In this example we will remove the Mailminder entry.

9a.) Copy the elements from C:\MyNotesCustomization\step8 to C:\MyNotesCustomization\step9

9b.) Start the Lotus Notes Installshield Tuner and select the .mst from the step9 folder.

9c.) go to "System Configuration -> Shortcuts"

9d.) Remove the Notes Mailminder entry (delete it)

multi vs. single user

9e.) close the Lotus Notes Installshield tuner and save the .mst

 


10.) Add a tempfolder (optional)

Sometimes it is better to have a tempfolder which can be easier accessed by the user or the support staff. Many companys move the Notes Cache files to this folder (see notes.ini entrys in step 6). So its easier for them to find the cache.ndk and delete it, or inform advise the user via phone to do it.

10a.) Copy the elements from C:\MyNotesCustomization\step9 to C:\MyNotesCustomization\step10

10b.) Start the Lotus Notes Installshield Tuner and select the .mst from the step10 folder.

10c.) Go to the "System Configuration" -> "Files and Folder" section and create a new Folder on the destinations computer.

Add a tempfolder

10d.) Go to the "Additional Tools" -> "Direct Editor" Section. And open the Component table. If you followed this HowTo you need to search for the CST_COMPONENT2 entry (otherwise the number might be different).

Remember what you see in the Directory column. In our example this is "NewFolder1".

Add a tempfolder

10e.) Go to the "Additionals Tools" -> "Direct Editor" Section. And open the LockPermission table. If you followed this HowTo you need to search for the NewFolder1 entry (the one from step 6b.). Because of the reason that we wish to create a new tempfolder we set the access to FullAccess for Everyone.

Add a tempfolder

10f.) close the Lotus Notes Installshield tuner and save the .mst

 


11. Add xtaf dictionaries to installation package

Note 1: I will use Lotus Notes 8.5.2 in that section / example.

Beginning with Lotus Notes 8.5.1 there is now a new spell check engine which used the (so called) xtaf dictionaries (you can read more about it here). These dictionaries are used by the standard client (not the basic one) and the build in components like sametime. In this section I will describe how to add these dictionaries into the Lotus Notes installation kit.

11a.) Copy the elements from C:\MyNotesCustomization\step10 to C:\MyNotesCustomization\step11

11b.) get the NotesCustomizationKit_1_0.zip file from the Utility folder from the Notes Admin Installation package and extract the content to: C:\MyNotesCustomization [if not already done during the preparations]

11c.) Download the xtaf dictionaries from the IBM Passport website (the file is called Notes_XTAFDictionaries_852_WinLnx_Ml.zip) and extract the content to: C:\MyNotesCustomization\XTAF_Dics

11d.) Copy the dictionary (the single file updateSite_<lang>.zip) you wish to add from C:\MyNotesCustomization\XTAF_Dics\Apps\Dictionaries\XTAF to C:\MyNotesCustomization\deploy. For this example we will copy the updateSite_nl.zip which holds the dutch language.

11e.) Rename the updateSite_nl.zip to updateSite.zip

11f.) Open the updateSite.zip with WinRar (or any other appropriated software) and navigate to the features\com.ibm.langware.v5.dic.nl_NL.feature_<version>.jar JAR file and extract that file to C:\MyNotesCustomization\temp.

11g.) Navigate now to C:\MyNotesCustomization\temp (do NOT close WinRar) and change the filename from com.ibm.langware.v5.dic.nl_NL.feature_<version>.jar to com.ibm.langware.v5.dic.nl_NL.feature_<version>.zip

11h.) Open com.ibm.langware.v5.dic.nl_NL.feature_<version>.zip with WinRar and extract the feature.xml to C:\MyNotesCustomization\temp.

11i.) Open the feature.xml (do NOT close WinRar) with Notepad (I prefer NotePad+) and change the featurecolocation-affinity="com.ibm.rcp.site.anchor.user.feature" to feature colocation-affinity="com.ibm.rcp.platform.feature" and save the file. You can read more about that here (technote 1440976).

11j.) now open the WinRar windows where you edit the com.ibm.langware.v5.dic.nl_NL.feature_<version>.zip and replace the already existing feature.xml with the one which was changed by you. After that delete the META-INF folder (it holds the jar signature) from the ZIP file. After that step close this WinRar windows now and save the com.ibm.langware.v5.dic.nl_NL.feature_<version>.zip when asked.

11k.) now rename com.ibm.langware.v5.dic.nl_NL.feature_<version>.zip to com.ibm.langware.v5.dic.nl_NL.feature_<version>.jar

11l.) Because of the reason that you changed the JAR file you need to sign the JAR now with your certificate (see "Preparations: Create a signer certificate"), otherwise the Notes installer will not accept the so changed file, because the signature is now damaged (a security feature from JAR files). To sign the JAR file run now the following command:

"C:\Program Files\Java\jdk\bin\jarsigner" -verbose -keystore C:\MyNotesCustomization\mykeystore -storepass password -keypass mypassword C:\MyNotesCustomization\temp\*.jar "my self signed cert"

Please note: Your keystore name, the certificate and the password might be another one, so you need to adjust the line above so that it fits your needs.

11m.) After the JAR file is signed now, open the WinRar windows which has the updateSite.zip open and replace the features\com.ibm.langware.v5.dic.nl_NL.feature_<version>.jar with your changed one. Close this WinRar windows and save the file if asked. Delete now all files in C:\MyNotesCustomization\temp.

11n.) Open C:\MyNotesCustomization\deploy\updateSite.zip and extract the install.xml to C:\MyNotesCustomization\deploy\deploy

11o.) now we can try a dry run (nothing is changed in that step). To perform the try run open a comandprompt (cmd) and navigate to C:\MyNotesCustomization and use the following command line:

addtoKit -d -n C:\MyNotesCustomization\deploy C:\MyNotesCustomization\step11

You will then see some debug outputs and can control if there are any errors.

11p.) If you are happy with the output from the last step go ahead and add the dictionary to the kit via:

addtoKit -d C:\MyNotesCustomization\deploy C:\MyNotesCustomization\step11

11q.) If you like you can now check if the dictionary was added successfully to the kit. Open the deploy\install.xml file and check if you can find a similar section like:

<installfeature mergeaction="add" default="true" description="Platform.XPD.Dictionary feature. Select this feature to install spell check dictionary." id="Platform.XPD.Dictionary.de" required="true" show="false" version="7.1.1.201006221804">
<requirements>
<feature id="com.ibm.langware.v5.dic.de_DE_Reform.feature" download-size="809" match="perfect" size="1170" url="jar:${installer.root}/updateSite.zip!/" version="7.1.1.201006221804"/>
<feature id="com.ibm.langware.v5.dic.de_CH.feature" download-size="769" match="perfect" size="1109" url="jar:${installer.root}/updateSite.zip!/" version="7.1.1.201006221804"/>
</requirements>
</installfeature>

11r.) If you wish to add other xtaf dictionary repead step 11d ... 11q

 

Note 1:

See also Technote 1440976 (Customizing Lotus Notes multi-user install kit for correct XTAF dictionary installation) for more informations.

Note 2:

If you didn´t sign the changed JAR file the installer will fail with the error message: "failed to install. The reason provided is CWPST1012E: Plugin has been corrupted" and some client components will then not work correctly!

 


12. Updating the Sametime embedded client

In this section we will add the Sametime 8.5.1 embedded Sametime client to a Lotus Notes 8.5.2 installation kit. Before you can do that please be sure you removed the Sametime 8.0.2 from the installation kit. For other Notes Client and/or Sametime Client versions, the following steps might be similar (except some text strings)

12a.) Copy the files from C:\MyNotesCustomization\step11 to C:\MyNotesCustomization\step12

12b.) Download the package CZII3ML (IBM Lotus Sametime Standard V8.5.1 Connect Clients Standalone, Notes, Network Installer, Mobile Windows Mac Linux Multilingual) from the IBM Passport Advantage Website [or you can use the CD/DVD].

12c.) Extract the CZII3ML to C:\Temp\Sametime851

12d.) Navigate to "C:\Temp\Sametime851\SametimeStandardClient\sametimeclient.for.notes\Windows" and run the sametime-connect-for-notes.exe

12e.) Unpack the files to C:\MyNotesCustomization\IBM Lotus Sametime Embedded 8.5.1

12f.) Copy the sametime.embedded.addon.win32.20100731-1716.zip from C:\Temp\Sametime851\SametimeStandardClient\sametimeclient.for.notes\Windows to C:\MyNotesCustomization\deploy.

12g.) Rename sametime.embedded.addon.win32.20100731-1716.zip to updateSite.zip

12h.) Copy the C:\MyNotesCustomization\IBM Lotus Sametime Embedded 8.5.1\deploy\install.addon.xml to C:\MyNotesCustomization\deploy\deploy\install.xml

12i.) Now edit the C:\MyNotesCustomization\deploy\deploy\install.xml and change every reference from sametime.embedded.addon.win32.20100731-1716.zip to updateSite.zip. BE CAREFULL! and save the file.

12j.) run the following command to test everything (dryrun, no change, only a test):

addtoKit -d -n C:\MyNotesCustomization\deploy C:\MyNotesCustomization\step12

If you are happy with the output you can add the Sametime client to the installation kit via:

addtoKit -d C:\MyNotesCustomization\deploy C:\MyNotesCustomization\step12

12k.) open now the C:\MyNotesCustomization\step12\deploy\install.xml with notepad

12l.) search for Sametime

12m.) You will find now a section similar like the following:

<installfeature default="true" id="Sametime" name="Sametime" required="true" show="false" version="8.5.2.20100811-1131">
<requirements>

after the lines you can find the following 9 lines:

<feature download-size="158" id="com.ibm.collaboration.realtime.browser.feature" match="greaterOrEqual" shared="true" size="131" url="jar:${installer.root}/updateSite.zip!/" version="8.0.2.20100802-0849"/>
<feature download-size="211" id="com.ibm.collaboration.realtime.chat.logging.feature" match="greaterOrEqual" shared="true" size="184" url="jar:${installer.root}/updateSite.zip!/" version="8.0.2.20100802-0849"/>
<feature download-size="218" id="com.ibm.collaboration.realtime.core.feature" match="greaterOrEqual" shared="true" size="222" url="jar:${installer.root}/updateSite.zip!/" version="8.0.2.20100802-0849"/>
<feature download-size="396" id="com.ibm.collaboration.realtime.im.community.feature" match="greaterOrEqual" shared="true" size="369" url="jar:${installer.root}/updateSite.zip!/" version="8.0.2.20100802-0849"/>
<feature download-size="409" id="com.ibm.collaboration.realtime.messages.feature" match="greaterOrEqual" shared="true" size="382" url="jar:${installer.root}/updateSite.zip!/" version="8.0.2.20100802-0849"/>
<feature download-size="213" id="com.ibm.collaboration.realtime.people.feature" match="greaterOrEqual" shared="true" size="186" url="jar:${installer.root}/updateSite.zip!/" version="8.0.2.20100802-0849"/>
<feature download-size="242" id="com.ibm.collaboration.realtime.rtc.core.feature" match="greaterOrEqual" shared="true" size="245" url="jar:${installer.root}/updateSite.zip!/" version="8.0.2.20100802-0849"/>
<feature download-size="1214" id="com.ibm.collaboration.realtime.ui.feature" match="greaterOrEqual" shared="true" size="1224" url="jar:${installer.root}/updateSite.zip!/" version="8.0.2.20100802-0849"/>
<feature download-size="104" id="com.ibm.rcp.realtime.livenames.feature" match="greaterOrEqual" shared="true" size="77" url="jar:${installer.root}/updateSite.zip!/" version="8.0.2.20100802-0849"/>

 

delete these lines, or comment them out like:

<!--
Removed lines, because of updated Sametime client to 8.5.1
<feature download-size="158" id="com.ibm.collaboration.realtime.browser.feature" match="greaterOrEqual" shared="true" size="131" url="jar:${installer.root}/updateSite.zip!/" version="8.0.2.20100802-0849"/>
<feature download-size="211" id="com.ibm.collaboration.realtime.chat.logging.feature" match="greaterOrEqual" shared="true" size="184" url="jar:${installer.root}/updateSite.zip!/" version="8.0.2.20100802-0849"/>
<feature download-size="218" id="com.ibm.collaboration.realtime.core.feature" match="greaterOrEqual" shared="true" size="222" url="jar:${installer.root}/updateSite.zip!/" version="8.0.2.20100802-0849"/>
<feature download-size="396" id="com.ibm.collaboration.realtime.im.community.feature" match="greaterOrEqual" shared="true" size="369" url="jar:${installer.root}/updateSite.zip!/" version="8.0.2.20100802-0849"/>
<feature download-size="409" id="com.ibm.collaboration.realtime.messages.feature" match="greaterOrEqual" shared="true" size="382" url="jar:${installer.root}/updateSite.zip!/" version="8.0.2.20100802-0849"/>
<feature download-size="213" id="com.ibm.collaboration.realtime.people.feature" match="greaterOrEqual" shared="true" size="186" url="jar:${installer.root}/updateSite.zip!/" version="8.0.2.20100802-0849"/>
<feature download-size="242" id="com.ibm.collaboration.realtime.rtc.core.feature" match="greaterOrEqual" shared="true" size="245" url="jar:${installer.root}/updateSite.zip!/" version="8.0.2.20100802-0849"/>
<feature download-size="1214" id="com.ibm.collaboration.realtime.ui.feature" match="greaterOrEqual" shared="true" size="1224" url="jar:${installer.root}/updateSite.zip!/" version="8.0.2.20100802-0849"/>
<feature download-size="104" id="com.ibm.rcp.realtime.livenames.feature" match="greaterOrEqual" shared="true" size="77" url="jar:${installer.root}/updateSite.zip!/" version="8.0.2.20100802-0849"/>
-->

 

Attention:

There are now multiple Sametime sections. One for the old 8.0.2 Sametime client (which you have removed/commented out) and one for the new Sametime 8.5.1 client. So do not remove the wrong one!

 

Note 1:

You can find more infos about this step here: http://www-01.ibm.com/support/docview.wss?uid=swg21420476

Note 2:

There exist a Sametime update for the 8.5.1 client on IBM fix central. You can download the package 8.5.1.0-Lotus-ST-IF-BAFV-889LLP [part sametime.embedded.addon.win32_20100828-0545.zip] (see technote 1446604) from here. You can use the content from that file for the integration/update.

 

 

 


13. Use the .mst

There are different ways how to use the MST file which you created during the setup. In this howto I will show you two possible options (a batchfile and a modifized setup.ini).

13 I a.) Batchfiles:

To use the .mst file (but allow user to choose some options) create a file called start.cmd with the following content:

-----

@echo off
Echo we will now install lotus notes silently without user interaction.
start /b msiexec /i "Lotus Notes 8.5.msi" TRANSFORMS="company_custom_inst.mst"

----

to install the lotus notes client silently via batchfile create a file called start.cmd with the following content:

---

@echo off
Echo we will now install lotus notes silently without user interaction.
start /b msiexec /i "Lotus Notes 8.5.msi" /qb+ TRANSFORMS="company_custom_inst.mst"

---

 

13 II a.) modifize setup.ini

Another way to install lotus notes is to modifize the setup.ini

13 II b.) open the setup.ini in the lotus notesfolder

13 II c.) change the "CmdLine=" entry to "CmdLine= TRANSFORMS=mytransformfile.mst /qb+" to install Lotus Notes silently without user interaction or to "CmdLine= TRANSFORMS=mytransformfile.mst" if you wish to allow the user to change some options during installation.

 

Note:

If you wish to create a log you can use this CmdLine:

CmdLine=/l*v %TEMP%\notes852.log TRANSFORMS=custom.mst

 


Known Errors:

 

Subscript out of Range:

This error message can occour if you doesn´t followed the exact steps. Try to save your changes after every step. Normaly if you see this error message your MST file got damaged and couldn´t be used for a installation (some added files will not be found).

 

CAB file to big:

It seamed the Max Filesize from the .CAB which can be created with the Installshield Tuner is 25-27MB. If you create a bigger file this can result in problems during the installation.

 

*.dic & *.cfg in the same folder

If you put the *.dic files and the *.cfg file into the same folder, this guide here will not work, because of the reason that the data pathname might change from installation to installation.

 

...failed to install. The reason provided is CWPST1012E: Plugin has been corrupted

This problem happen if you have added any JAR file with AddToKit.exe to your Notes Installation Kit where the signer from the JAR file (for example you changed the xtaf dictionaries like written here) isn´t included in the installer keyring. In that case the signature didn´t any longer fit from the file. To solve the issue please read the section "Preparations: Create a signer certificate" and sign the changed JAR file your your certificate and add the certificate to the installer keystore (...\deploy\extras\.keystore.JCEKS.IBM_J9_VM.install).

 


Document History:

Ver 1.0 -> 2009-02-26 Initial Version

Ver 2.0 -> 2009-08-12 Added section for eclipse features

Ver 2.2 -> 2009-11-12 Added section for *.dic (basic) dictionary files

Ver 3.0 -> 2010-08-25 Added section for xtaf (standard) dictionary files

Ver 4.0 -> 2010-09-02 Added section for "Removing features via trimUpdateSite.exe"

Ver 4.1 -> 2010-10-03 Added section for "Create a signer certificate"

Ver 4.2 -> 2010-10-24 Changed section for xtaf (standard) dictionary files (solved mutliuser issues)

 


Other infos / Related links:


Adding a customized bookmark.ntf to a transform (.mst) file for a Notes 7.x multi- or single-user silent install
http://www-01.ibm.com/support/docview.wss?uid=swg21255661

How to enable Windows Installer logging
http://support.microsoft.com/kb/223300

How to enable Client Single Logon feature using an MST during a silent install
http://www-01.ibm.com/support/docview.wss?uid=swg21180920

How to add a Notes.ini parameter during Notes 6.x installation or upgrade
http://www-01.ibm.com/support/docview.wss?uid=swg21198514

How to add a Notes.ini parameter during Notes 7.x installation or upgrade
http://www-01.ibm.com/support/docview.wss?uid=swg21221836

Methods to add Sametime 8.5 client to the Notes 8.5.1 client platform
http://www-01.ibm.com/support/docview.wss?uid=swg21420476

Making Lotus Notes 8.5.1 and greater language spell check dictionaries available to users
http://www-10.lotus.com/ldd/dominowiki.nsf/dx/10212009084839AMWEBH2G.htm