Lotusphere IBM Collaboration Solutions Development Lab

Size: px

Start display at page:

Download "Lotusphere IBM Collaboration Solutions Development Lab"

Alaina Jones
6 years ago
Views:

1 Lotusphere 2012 IBM Collaboration Solutions Development Lab Lab 01 Building Custom Install Kits for IBM Lotus Notes Clients 1

2 Introduction: Beginning with IBM Lotus Notes Client version 8.0, customizing the client installation kit was made easier since moving to the Eclipse platform. Administrators can customize the client install kit to add or remove various features and components. This allows for more control of the options that are presented to the user during installation and the items that are displayed on the Notes Sidebar, after the installation is complete. There are a number of ways to customize the IBM Lotus Notes Installation kits. This lab will cover 2 of the different methods. The first is to edit with the IBM Lotus Notes install manifest (INSTALL.XML) and the second is to use UpdateSiteMgr.exe. The method you choose depends on the requirements for your environment. If you wish to change which options are displayed to the user during the install, editing the INSTALL.XML would be good for this. If you wish to replace the version of Sametime or Symphony that gets installed, UpdateSiteMgr.exe would be used. Changing the version of the product included in the install kit, will save time from having to perform additional installations to move to the next version. This lab is divided into 3 Modules: Module 1 covers what can be removed Module 2 covers removing items from install kit and remove them from the Notes sidebar Module 3 replacing the embedded version of IBM Sametime to IBM Sametime Objectives: In this lab, you will learn how to: 1) Identify which programs/components get loaded during a normal Notes Client Install 2) Remove unused programs from the Notes Client Install kit 3) Replace the embedded version of IBM Sametime with IBM Sametime

3 Module 1: Determining What to Install and What to Remove Procedure: This module covers how to determine which features can be removed from the IBM Lotus Notes Client Kit. To change the options presented to the user during the Lotus Notes Client Install, it's important to understand the Notes Install Manifest, INSTALL.XML. This file is used to determine which features are required, which are optional and which should be shown or not during the installation of the Notes Client. Only features containing the <installfeature> property required= false in the Notes Install manifest file should ever be removed. Those that can be removed will include the Composite Applications Editor, Lotus Symphony, Connections (Activities), embedded Sametime and for single user install, Domino Designer and Domino Administrator. Note: Domino Designer and Domino Administrator, and as of Notes 8.5.1, Lotus Symphony require the additional step of using the tuner to create a transform file that disables their install completely. This transform file must be included in the notes Install kit during the install. Using the transform file will not be covered in this lab. The following example shows the Feature tag for Lotus Symphony from INSTALL.XML. <installfeature default="false" description="%editors.description" id="editors" name="%editors.name" required="false" show="true" version=" "> Setup Information: The required install files for IBM Lotus Notes Client have been copied C:\Install directory. Notepad++ has been installed as the text editor to use for the modules. 1. Launch Notepad ++ from the Desktop or using Start, All Programs, Notepad++ 2. Open Install.XML file in the C:\Install\Notes853\deploy directory in edit mode 3. Using the application menus, select Search, then Find 4. Select the Mark tab 5. Enter installfeature in the 'Find what:' field 3

4 6. Select Mark all 7. Notice that every occurrence of installfeature is now highlighted 8. Choose OK 9. Choose Close 10. Examine each instance of installfeature to determine which options are set to required= false. Only items set to required = false should be altered. 4

5 Here's an example of the INSTALL.XML file showing the <Feature> tag for Platform.XPD. Notice this feature is required but will not be shown during the Client Installation feature selection panel an option to chose. 5

6 Procedure: Module 2: Changing What is Available to Install This module covers changing the items that appear to the user during the IBM Lotus Notes Client install. Use the instructions below to disable Activities, the Composite Applications Editor and the Feedreader from the Notes Client Feature Installation dialogue within the installation program. 1. Launch Notepad ++ from the Desktop or using Start, All Programs, Notepad++ 2. Open the Install.XML file in the C:\Install\Notes853\deploy directory in edit mode 3. Using the application menu, select Search then Find 4. Enter %Activities in the 'Find what :' field, select Find Next then Close This will locate the Activities feature tag line 5. Edit the installfeature line so that show= true becomes show= false <installfeature default="false" description="%activities.description" id="activities" name="%activities.name" required="false" show="false" version=" "> 6. Save your changes - File, Save 7. Using the application menu, select Search then Find 8. Enter %CAE in the 'Find what :' field, select Find Next, then Close. 6

name" required="false" show="true" version="8.5.3.20110916-0921"> 10. Save your changes - File, Save 11. Using the application menu, select Search then Find 12.

7 This will locate the Composite Applications Editor feature tag line 9. Edit the installfeature line so that show= true becomes show= false <installfeature default="true" description="%cae.description" id="cae" name="%cae.name" required="false" show="true" version=" "> 10. Save your changes - File, Save 11. Using the application menu, select Search then Find 12. Enter %Feedreader in the 'Find what :' field, select Find Next, then Close This will locate the Feedreader feature tag line 13. Edit the installfeature line so that show= true becomes show= false <installfeature default="true" description="%feedreader.description" id="feedreader" name="%feedreader.name" required="false" show="true" version=" "> 7

$Using Windows Explorer, navigate to the C:\Install\Notes853 directory 17.$ Double click setup.exe to launch the IBM Lotus Notes Client installation 18.

Double click setup.exe to launch the IBM Lotus Notes Client installation 18.

8 14. Save your changes - File, Save 15. Close out of Notepad Using Windows Explorer, navigate to the C:\Install\Notes853 directory 17. Double click setup.exe to launch the IBM Lotus Notes Client installation 18. On the Welcome to the Installation Wizard for Lotus Notes screen, Select Next > 8

9 19. Select I accept the terms in the license agreement. Select Next > 20. Change Install this application for: to Only for Me (Single User Install), accept the default installation location path, Select Next > 9

10 21. Notice that Activities, Composite Application Editor and the Feedreader are not displayed as installable features, Select Next > 22. Accept the defaults and click Install 10

11 23. There will be a number of screen changes while the product is installed. This step may take up to 10 minutes to finish. Several different screens will appear... 11

12 24. Click Finish when complete. 12

13 Module 3: Replacing the Embedded Version of Sametime Procedure: This module covers removing the embedded version of IBM Sametime 8.5.1, that ships with IBM Lotus Notes Client install kit and re-packaging the kit with the embedded version of IBM Lotus Sametime Client. The steps below require access to the install code for both IBM Lotus Notes Standard Client and IBM Sametime Client. The embedded version of Sametime will need to be deleted from the Notes Client kit and then Sametime can be added to the kit. A utility called UpdateSiteMgr.exe will be used to delete and add Sametime to the Notes Client kit. Note: In lieu of time, the Notes Client and Sametime Client installation files have been provided as archive files and also extracted. If you want to skip extracting the archive files, feel free to move to step #9 to begin this module. If you wish to complete these steps on your own, you will need to download the following files from Passport Advantage, CI1L4EN and CZYF7ML. 1. Launch Windows Explorer and navigate to the C:\Software\ directory 2. Run lotus_notes853_win_en.exe to extract the installation files to a directory. Choose Unpack the files used to perform the installation to a location specified below. Use C:\NewKit\Notes853 as shown below: 3. The files will be extracted to the directory specified. 13

$Switch back to Windows Explorer and navigate to the C:\Software\ST852 directory 6. Change directories to the sametimeclient.for.notes\windows directory 7. Run sametime-connect-for-notes.$

14 4. When the Notes Client installation process begins, click Cancel. It is not required that you complete the installation at this time. 5. Switch back to Windows Explorer and navigate to the C:\Software\ST852 directory 6. Change directories to the sametimeclient.for.notes\windows directory 7. Run sametime-connect-for-notes.exe to extract the required files to a directory. Choose Unpack the files used to perform the installation to a location specified below, Click Next > Use C:\NewKit\ST852 as shown below. 14

$Using Windows Explorer, navigate to the C:\NewKit\Notes853\Utilities directory. 10. Locate the file named NotesCustomizationKit_1_0.zip and extract the file named UpdateSiteMgr.$ $exe to the root of the Notes directory. For this lab, extract files to C:\NewKit\Notes853.$

15 8. Once the Sametime installation starts, click Cancel. It is not required that you complete the installation process at this time. 9. Using Windows Explorer, navigate to the C:\NewKit\Notes853\Utilities directory. 10. Locate the file named NotesCustomizationKit_1_0.zip and extract the file named UpdateSiteMgr.exe to the root of the Notes directory. For this lab, extract files to C:\NewKit\Notes853. This tool will be used to remove the embedded version of Sametime from the Notes Client Kit as well as to update the kit with the newer version of the embedded Sametime Client. 11. Launch a Windows Command Prompt by doing Run, Program, CMD 12. Change directory to C:\NewKit\Notes At the command prompt, run UpdateSiteMgr.exe -r Sametime. This will remove Sametime from the Notes Installation Kit. This step may take several minutes. 15

$14. Change directory to C:\NewKit\ST852 15.$ $zip to updatesite.zip deploy\install.addon.$

16 14. Change directory to C:\NewKit\ST Copy the following 2 files as noted below: sametime.embedded.addon.win zip to updatesite.zip deploy\install.addon.xml to deploy\install.xml 16

17 16. Change directory to C:\NewKit\Notes There's a known issue with UpdateSiteMgr.exe where remnants of the previous version of Sametime are left behind. This will need to be cleaned up manually by editing the Install Manifest file (Install.XML) or using TrimUpdateSite tool (available in Notes 8.5.2) before running the installation kit. Note: Beginning in IBM Lotus Notes Standard Client, TrimUpdateSite and AddToSite utilities have been combined into UpdateSiteMgr.exe. See Technote # for details. 18. Launch Notepad++ and edit C:\NewKit\Notes853\deploy\install.xml 19. Remove the following lines (Lines 249 through 257) from the file: <feature download-size="195" id="com.ibm.collaboration.realtime.browser.feature" match="greaterorequal" shared="true" size="163" url="jar:$ {installer.root}/updatesite.zip!/" version=" "/> <feature download-size="286" id="com.ibm.collaboration.realtime.chat.logging.feature" match="greaterorequal" shared="true" size="254" url="jar:$ {installer.root}/updatesite.zip!/" version=" "/> <feature download-size="339" id="com.ibm.collaboration.realtime.core.feature" match="greaterorequal" shared="true" size="354" url="jar:${installer.root}/updatesite.zip!/" version=" "/> <feature download-size="582" id="com.ibm.collaboration.realtime.im.community.feature" match="greaterorequal" shared="true" size="550" url="jar:${installer.root}/updatesite.zip!/" version=" "/> <feature download-size="408" id="com.ibm.collaboration.realtime.messages.feature" match="greaterorequal" shared="true" size="376" url="jar:${installer.root}/updatesite.zip!/" version=" "/> <feature download-size="342" id="com.ibm.collaboration.realtime.people.feature" match="greaterorequal" shared="true" size="310" url="jar:${installer.root}/updatesite.zip!/" version=" "/> <feature download-size="206" id="com.ibm.collaboration.realtime.rtc.core.feature" 17

match="greaterorequal" shared="true" size="201" url="jar:${installer.root}/updatesite.zip!/" version="8.5.1.20110812-1126"/> <feature download-size="1358" id="com.ibm.collaboration.realtime.ui.

feature" match="greaterorequal" shared="true" size="90" url="jar:${installer.root}/updatesite.zip!/" version="8.5.1.20110812-1126"/> 20.

18 match="greaterorequal" shared="true" size="201" url="jar:${installer.root}/updatesite.zip!/" version=" "/> <feature download-size="1358" id="com.ibm.collaboration.realtime.ui.feature" match="greaterorequal" shared="true" size="1392" url="jar:$ {installer.root}/updatesite.zip!/" version=" "/> <feature download-size="122" id="com.ibm.rcp.realtime.livenames.feature" match="greaterorequal" shared="true" size="90" url="jar:${installer.root}/updatesite.zip!/" version=" "/> 20. Now that you have successfully removed Sametime, it's time to add the new version to the kit. Run UpdateSiteMgr.exe to add Sametime embedded client into the Notes Client Kit. updatesitemgr.exe..\st852 C:\NewKit\Notes Verify the updatesitemgr.zip and install.xml were modified. 22. Run setup.exe from C:\NewKit\Notes853 to use the new installation kit. 18

19 Summary: In this lab, you learned to customize the IBM Lotus Notes Client Installation Kit. You learned the importance of the Install Manifest, install.xml and what features can and can not be removed. In addition, you learned how to create a custom kit, removing and adding applications using UpdateSiteMgr.exe as well as updating the embedded version of IBM Sametime. Additional Resources: Customizing the Notes install manifest for supplied Eclipse features: What's New in Lotus Notes 8.5.3? Adding and removing components from the Notes install kit using UpdateSiteMgr tool: Wiki Articles: Roadmap: Customizing your Notes client installation: Combining Notes and Sametime into one kit : IBM Corporation All Rights Reserved. The information contained in this publication is provided for informational purposes only. While efforts were made to verify the completeness and accuracy of the information contained in this publication, it is provided AS IS without warranty of any kind, express or implied. In addition, this information is based on IBM s current product plans and strategy, which are subject to change by IBM without notice. IBM shall not be responsible for any damages arising out of the use of, or otherwise related to, this publication or any other materials. Nothing contained in this publication is intended to, nor shall have the effect of, creating any warranties or representations from IBM or its suppliers or licensors, or altering the terms and conditions of the applicable license agreement governing the use of IBM software. References in this presentation to IBM products, programs, or services do not imply that they will be available in all countries in which IBM operates. Product release dates and/or capabilities referenced in this presentation may change at any time at IBM s sole discretion based on market opportunities or other factors, and are not intended to be a commitment to future product or feature availability in any way. Nothing contained in these materials is intended to, nor shall have the effect of, stating or implying that any activities undertaken by you will result in any specific sales, revenue growth or other results. IBM, the IBM logo, Lotus, Lotus Notes, Notes, Domino, WebSphere and Lotusphere are trademarks of International Business Machines Corporation in the United States, other countries, or both. 19

Lotusphere IBM Collaboration Solutions Development Lab

Lotusphere IBM Collaboration Solutions Development Lab Lotusphere 2012 IBM Collaboration Solutions Development Lab Lab#4 IBM Sametime Unified Telephony Lite telephony integration and integrated telephony presence with PBX 1 Introduction: IBM Sametime Unified