To learn about what's new in this release of the Lotus Quickr Connectors, refer to the following sources:
Some noteworthy changes to the Installer code for the Lotus Quickr Connectors are added support for:
Other changes to the installer code include:
- The Lotus SymphonyTM connector, stand-alone and embedded.
- Installing connectors on Microsoft® Windows® Vista/Windows 7 when User Account Control (UAC) is on
- Installing connectors on Windows 7
- Migrating connector preferences during an upgrade
- Simple and Protected GSS-API Negotiation Mechanism (SPNEGO)
- Enhancement of the silent install; command line parameters have been re-factored. Refer to Silent installation.
- Support for Lotus Notes client multi-user install.
- Added an upgrade mode mechanism that the Installer selects, as follows:
- Major upgrade: Moving from Quickr version 8.1 or 8.2 to version 8.5. The Installer automatically removes the old driver and installs a newer driver.
- Minor upgrade, or patch: Moving from version 8.5 to an 8.5 fix. The Installer replaces old files and keys with newer ones directly.
Also note that an update to the Connectors, that is, Lotus Quickr Connectors 22.214.171.124 (also called HF2), is available and recommended for all environments. You can download Lotus Quickr Connectors 126.96.36.199 from Passport Advantage or IBM Fix Central. Key features of this update are as follows:
- Adds support for the following software:
Lotus Quickr for Domino® 8.5, including support for Trash and Pages features new to Quickr for Domino
Lotus Notes® 8.5.2
Lotus Sametime® Standard 8.5.1
- Introduces backward compatibility with
Lotus Quickr for WebSphere® Portal 188.8.131.52
Lotus Quickr for Lotus Domino 8.2
For requirements information, refer to IBM Lotus Quickr Connectors 8.5 detailed system requirements.
- Provides fixes, including extensive additional testing, against all server backends.
When deploying the Lotus Quickr Connectors, you as an administrator have multiple options to deploy the Connectors to your users. The Installing and upgrading section of the product documentation provides information about user installation or silent installation. Be aware of the following possibilities:
Upgrade. Upgrading a client installed with version 8.1 or 8.2 connectors:
- Quickr Connectors 8.5 supports upgrading from the Quickr Connectors 8.1 or 8.2 series. Upgrading to a different major version of connectors is also known as a major upgrade.
- The process of upgrade install is basically the same as a brand-new install, except that the upgrade will automatically remove your old connectors driver.
- An upgrade keeps the client’s connector settings.
Patching. Applying a fix to the 8.5 connector:
- Patching, or applying an interim fix, is also known as a minor upgrade.
- Quickr Connectors 8.5 supports patching a version 8.5 fix to a client with older 8.5 connector drivers installed.
- A patching keeps the client’s connector settings.
QuickrConfig tool. Administrators can use the QuickrConfig tool to export and import a place list from one system to another. Either a user or a deployment script can run the tool. The tool can be used optionally to export and import user preferences, as well as global defaults and policies. In this way, users can run the tool to back up their configuration, in the event that they need to run a clean install of the connectors. For more information, refer to Pre-configuring users' desktops with connector content.
The following subsections contain a set of detailed explanations as to what is happening during the install process and what is expected.
To install the qkrconn.exe package correctly, you must have administrator privileges (for example, Windows Vista UAC).
If you're uninstalling first, the uninstall should require (not force) a reboot. If you attempt to reinstall without rebooting, you should get the following Pending Reboot message from the Installer program:
"Your previous uninstall is not complete. Reboot your machine to complete the uninstall."
If you do not see that message, stop the install, and then manually reboot before reinstalling. NOTE: Reinstalling the connectors will remove all configuration data.
The Windows Registry install location is captured to the following key (see figure 1):
HKEY_LOCAL_MACHINE\SOFTWARE\IBM\Lotus Quickr\Desktop Integration\InstallLocationFigure 1. Windows Registry key
For 8.5, the default install path for connectors is C:\Program Files\IBM\Places Connectors
For 8.2, the default install path for connectors is C:\Program Files\IBM\Lotus Quickr connectors
For users upgrading from 8.2 to 8.5, the install first removes the existing Lotus Quickr connectors, and then install to the new \Places Connectors directory.
Now let's go step by step through the install process:
1. When you launch qkrconn.exe, you first see the Welcome screen. Click Next to continue (see figure 2).
Figure 2. Welcome screen
2. Accept the terms of the license agreement to enable the Next button (see figure 3).
Figure 3. License Agreement window
Note that non-English languages have an additional button that lets you view the license in English (for example, figure 4 shows Japanese – “View in English”).
Figure 4. Non-English language buttons
3. In this step, select which Connectors you wish to install (see figure 5):
Figure 5. Feature selection window
- The Windows Explorer connector is mandatory.
- By default, all connectors are installed except the Notes-embedded Lotus Symphony. You must explicitly de-select a connector if you do not want to install it.
- The Lotus Symphony connector is composed of a Symphony stand-alone edition and Notes-embedded edition. The embedded edition is by default disabled from install.
- The features selected might have additional requirements; for example, Lotus Notes and Lotus Sametime have install location checks.
- The "Install to:" location set in the registry applies only to Windows Explorer and Microsoft Office connectors.
4. Select the Lotus Notes install location:
Figure 6. Lotus Notes Install Location window
- The location of the Lotus Notes client install on the workstation is predetermined by use of a Registry search. If not found, you can click the Change button to change the location (see figure 6).
- If the location is not found, the Next button is disabled. The only way to advance past this window, if Lotus Notes is not installed, is to de-select the Lotus Notes Feature and Symphony for Notes Embedded Edition Feature from the previous feature selection window above.
What if you get a "Lotus Notes or embedded Symphony cannot be found...." message, as shown in figure 7?
Figure 7. Lotus Notes location not found message
- The window changes if Lotus Notes is not found; it might not be installed or is not installed to the folder you specify.
- If you specified embedded Symphony, but the Notes client does not contain embedded Symphony, then the warning text also shows.
5. Select the install location for Lotus Sametime:
Figure 8. Lotus Sametime Install Location window
- The location of the Sametime client install is predetermined by use of a Registry search. If not found, you can click Change to change the location (see figure 8).
- The Sametime connector is for use only with the stand-alone Sametime Connect client. You should not set the location to the directory of Sametime embedded within Lotus Notes.
- If Sametime is not found, the Next button is disabled. The only way to advance past this window, if Lotus Sametime is not installed, is to de-select the Lotus Sametime Feature from the feature selection window (recall figure 5).
What if you get a "Lotus Sametime cannot be found...." message as shown in figure 9?
Figure 9. Lotus Sametime cannot be found message
- The window changes if Lotus Sametime is not found, either because Lotus Sametime is not installed or it's not installed to the folder you specify.
6. Select the Lotus Symphony Location:
Figure 10. Lotus Symphony Install Location window
- The location for a stand-alone Symphony install is predetermined by use of a Registry search; if not found, click the Change button to change the location (see figure 10).
- If not found, the Next button is disabled. The only way to advance past this window, if Lotus Symphony is not installed, is to de-select the stand-alone Lotus Symphony Feature from the feature selection window.
What if you get a "Lotus Symphony cannot be found....." message, as shown in figure 11?
Figure 11. Symphony Install Location not found
- The window changes if stand-alone Symphony is not found, because either Symphony is not installed or Symphony is not installed to that folder.
7. After identifying locations, the Installer moves to an "In progress" window (see figure 12):
Figure 12. Install in progress
- If there are errors registering components, then the Installer displays additional messages here.
What if you get a Files in Use window, as shown in figure 13?
Figure 13. Files in Use window
- This window shows that applications are in use that might be affected by the install; specifically, in this case the user has Lotus Notes and Microsoft Office open at the same time as running the Connectors install.
- This situation might cause the installation to fail. It is recommended that you close Office, Microsoft Outlook, and Lotus Notes, Sametime, or Symphony before continuing.
8. The final window confirms that the install has completed (see figure 14).
Figure 14. InstallShield Wizard Completed
- For Windows 7 64-bit, the “Launch IBM Lotus Quickr connector for Microsoft Windows Explorer” option is hidden due to the Explorer connector feature being disabled on Windows 7 64-bit.
Uninstall and maintenance
To maintain your connectors install, you can access the Add or Remove Programs panel. There are two options to change the connectors install:
- Maintenance mode, by clicking the Change button
- Uninstall mode, by clicking the Remove button
1. To uninstall the connectors, click the Remove button in the Add or Remove Programs window (see figure 15).
Figure 15. Add or Remove Programs window
2. Click Yes in the confirmation pop-up window to continue the uninstallation (see figure 16).
Figure 16. Add or Remove Programs confirmation pop-up
3. You'll notice that the uninstall process provides a limited user interface (see figure 17). If you need to experience a full UI-based uninstallation, use the Uninstall action in Maintenance mode instead.
Figure 17. Uninstall in progress
1. Use the Add or Remove Programs window to maintain existing connectors install by clicking the Change button (recall figure 15 above).
2. You first see the Welcome screen shown in figure 18; click Next.
Figure 18. Maintenance Welcome screen
3. In the next window, select the maintenance option you want to use, as follows (see figure 19):
Modify. Add or remove features from the install (for example, add the Lotus Notes connector, if not originally installed)
Repair. Reinstall all previously installed features to correct an error.
Remove. Uninstall or remove the program.
Figure 19. Program Maintenance options
- It is recommended that you close Office, Outlook, Notes, Sametime, and Symphony before continuing.
4. Click Next; the uninstall in progress window displays (see figure 20).
Figure 20. Uninstall in progress
5. The uninstall complete window displays; click Finish (see figure 21).
Figure 21. Maintenance complete
6. If you are prompted to reboot during connector install/uninstall/maintenance (see figure 22), do not ignore this message:
Figure 22. Reboot window
- Why is this reboot required? Part of the product integrates with explorer.exe, which is in use and cannot be stopped nicely. Therefore, the simplest approach is to reboot.
- If reboot is ignored, unexpected behavior can occur.
You can apply a fix or interim fix to the Lotus Quickr Connectors 8.5 by using the installer. This section shows the patching process in detail.
1. Launch qkrconn.exe from the fix package to start the process. The installer prompts you to confirm the upgrade if it finds an existing 8.5 driver (see figure 23); click Yes..
Figure 23. Upgrade prompt
2. Next, you see a Welcome screen; click Next (see figure 24).
Figure 24. Welcome screen
4. The upgrading in progress window displays (see figure 25).
Figure 25. Patching in progress
5. When complete, the upgrading complete window displays (see figure 26).
Figure 26. Patching complete
Data collection for troubleshooting
If you encounter problems or errors with the installation of the Lotus Quickr Connectors 8.5, you can collect diagnostic information from the Install Log files.
The Install Log files are located as follows:
- Windows MSI log file is located in %temp%\MSIxxxxx.LOG. For example, C:\Documents and Settings\Administrator\Local Settings\Temp\MSI7c84a.LOG
- The Notes, Sametime, or Symphony provisioning logs can be found under this directory.
- For Notes and for Symphony embedded within Notes, the logs are placed based on the different Notes installation type as follows:
- Notes single-user install logs can be found under NotesDir\Data\workspace\logs
- Notes multiple-user install logs can be found under %userprofile%\Local Settings\Application Data\Lotus\Notes\Data\workspace\logs
- Sametime logs can be found under %appdata%\Lotus\Sametime
If opening a service request with IBM Support, include as much of the following data as possible:
- Symphony stand-alone logs can be found under %userprofile%\IBM\Lotus\Symphony\logs
- Description of the problem, including specific steps to reproduce it
- Windows version information and fix levels
- Version information for the application having issues, such as the Notes client or Microsoft Office version
- Version information for the Connectors. You can find this in the buildinfo.txt file located in the install directory (for example, C:\Program Files\IBM\Lotus Quickr Connectors\buildinfo.txt or C:\Program Files\IBM\Place Connectors\buildinfo.txt).
- The Install Logs described above
- Type of install: Upgrade or new
- Components selected for installation
Known issues and their resolutions are documented in APARs or Support Technotes. You can search through or browse these documents on the Lotus Quickr Connectors Support site. What follows are some known issues at release time, not documented elsewhere:
- If you attempt to register into directories with non-English native characters, the following error occurs: "Error 1904.Module D:\temp\???????????\DIMenu.dll failed to register. HRESULT -2147220473. Contact your support personnel." If this Error 1904 message occurs during install, then uninstall and reinstall in the default directory of C:\Program Files\IBM\Places Connectors.
- A Hebrew install runs in the English language. Full bi-directional (BiDi) support is not available for installation in this release.
- For Windows 7, a brand-new install will always require a reboot.
- For Office 2003, the connector menu is not removed after uninstallation or removal of the Office connector. For workarounds, refer to Support Technote #1420131, "Lotus Quickr connectors Microsoft Word 2003/XP toolbar".
In this article, you saw how to install, upgrade, or uninstall the Lotus Quickr Connectors 8.5. If problems or error occur during installation, you can review the Install Logs to troubleshoot the situation.
About the authors
Ann Hayes is a Software Engineer in IBM Software Group. She has been actively involved with Quickr connectors development for the past three years.
Xue Li is a Software Engineer based at IBM's China Software Development Lab (CSDL) in Shanghai. She works with the Quickr Connectors Install team in the role of Install FVT tester. She joined IBM in 2009 immediately after earning her Master's degree. As an install tester, she has gained much experience with Lotus product deployment, and her interests include test strategy and methodology, and test automation. She has presented at the IBM QSE 2010 Conference and has written articles for developerWorks.
Yi Ting Shan is a Software Engineer at IBM's CSDL in Shanghai, working with the Quickr Connectors Install team.