Lotus Domino Administrator 8 Help - Adding update kits to the Lotus Notes Smart Upgrade database

NOTES CLIENT INSTALLATION AND SMART UPGRADE

Adding update kits to the Lotus Notes Smart Upgrade database
You can download update kits as they become available from IBM® Lotus® developerWorks http://www.lotus.com/ldd/smartupgrade. After downloading a kit, make the kit available to users by creating a Kit document in the Smart Upgrade database and then either attaching the kit to the Kit document or storing the kit in a directory on a shared network drive that users can access. You specify the location of the kit in the Smart Upgrade Kit document when setting up Smart Upgrade for users. You can provide upgrade kits for upgrading just the IBM® Lotus® Notes® client or for upgrading all clients.

When you attach kits to a Smart Upgrade Kit document, attach only one kit per document.

Smart Upgrade kit recognition

Smart Upgrade contains the Smart Upgrade kit recognition feature. Smart Upgrade can determine whether to install a Notes client-only kit or an Allclients kit for each user. The installer sets the value of the InstallType= setting in the NOTES.INI file each time a Notes client or All client installation or upgrade is performed. Smart Upgrade compares the Install Type value in the Smart Upgrade Kit document to the InstallType field in the NOTES.INI file and installs the update kit that matches the Install Type specified in the NOTES.INI file. Smart Upgrade recognition makes it easy to upgrade users who have more than one computer with different client install types, that is, a user can have one computer running Notes client only and another computer running All clients. You can use Smart Upgrade to upgrade both computers for this user.

Note IBM® Lotus® Domino™ 6.5.5 clients and earlier can have only one Smart Upgrade kit per user, per source version. If you attempt to configure multiple source kits, that is Notes client only and All clients for a release of Domino that is pre-Domino 6.5.5, an error message appears indicating that duplicate kits have been found for that user in the Smart Upgrade database and Smart Upgrade will fail.

Smart Upgrade recognition upgrades one install type, for example, Notes client only to a newer release of the same install type. You cannot use Smart Upgrade to install a Notes client only install and then use it later to perform an All clients install for the same user on the same computer. If you want to change install types, you must manually upgrade the client to the desired install type.

If you are using a Macintosh operating system, the Install Type field is not modifiable and is set to Notes client only.

The following values can be used with the NOTES.INI InstallType= setting:

InstallType=2 -- All client install
InstallType=6 -- Notes client only install

Note In Domino 7.0 and later, the Smart Upgrade kits are available in English and other languages (for language packs).

Adding the update kit

1. In the Domino Administrator client, open the Lotus Notes Smart Upgrade database that you created.

2. Click New Kit to create a Kit document.

3. On the Basics tab, complete the following fields:

In this field Do this

Kit description Enter a brief description of the kit. After completing this document, this kit description is used to identify the Smart Upgrade Kit document.

Enable this kit for use Select the Enabled check box to make the kit available to authorized users.

Configuration Choose one:

Notes Standard -- You are running the "standard" configuration of Lotus Notes-- this means that you can access applications on both Domino servers and IBM® WebSphere® Portal servers.
Notes Basic -- You are running the "basic" configuration of Lotus Notes -- this means that all the server-based applications you can access reside on a Domino server.

Source versions Enter your current Notes client release, or you can enter a series of Notes clients releases.
See the topic Expression rules for use with the Smart Upgrade Kit document for information on acceptable formats for entering the source version.
Note To find the current Notes client release number, check the About Notes document. To open the document, choose Help - About Notes.

Operating system Enter or select the operating system for which the kit is intended.

Localization Enter or select the language of the Notes Client.

Release 6.5.4/6.0.5 or previous This field displays only if you are using Microsoft® Windows®. If you are using Notes Domino release 6.5.4, 6.0.5, or previous, click this check box. Smart Upgrade does not recognize whether All client install or Notes client install applies for these releases.
Install Type field only appears if this box is not selected.

Install Type Choose one:

Notes client only -- Smart Upgrade will install only the Notes client kit.
All client (Notes client, Administrator client, Designer) -- Smart Upgrade will install the All Client kit.

Destination version Enter the release number of the update kit.
The value of this field must match the value in the Deploy Versions field of the desktop policy settings document.

Restart Notes after update Click the Restart check box to restart the user's updated Notes client when the upgrade is complete.

Location Choose one of these to specify the location of the upgrade kit:

Attached to this note -- Choose this option and then, in the "Attach update kit here" field, attach the update kit or full installation kit.
On a shared network drive -- Choose this option and then, in the "Full path to update kit" field, enter the file path to the file SETUP.EXE. When you use the shared network drive option, decompress the file, then copy all files in the installation kit to the directory specified. Follow this convention:
\\networkfileservername\shareddirectoryname\setup.exe
Shared network drive and attached kit with failover -- Choose this option and then select the file to attach that contains the Smart Upgrade Kit and enter the full file path name to the file, SETUP.EXE. The "Shared network drive and attached kit with failover" option provides both fields of information to users. The Smart Upgrade process checks whether a "Full Path Kit" is available. If the Full Path Kit is available, it is used; if it is not available, the attachment kit is used.

Attach Update Kits here Attach the update kit or a full installation kit. Attach the EXE file that you downloaded to the document without decompressing the file. If you are using Domino 6.5.5 or later, you can attach either a Notes client only kit or an All clients kit.

Optional arguments for shared network drive kit Enter optional arguments if you are specifying a shared network kit. For information regarding optional arguments, see the subtopic "Using optional arguments when running Smart Upgrade."

Message text Enter the message that will appear when Lotus Notes Smart Upgrade prompts users to upgrade their Notes clients.

Optional arguments for attached kit Enter optional arguments if you are using an attached kit. For information regarding optional arguments, see the subtopic "Using optional arguments when running Smart Upgrade."

4. Complete these fields on the Administration tab:

In this field Do this

Allowed Users & Servers Enter or select the users or servers allowed to upgrade their Notes clients. To include all users in your organization, enter a value using the following format:
*/OrgUnit/Organization/CountryCode
Note When you enter a value in this field, also add LocalDomainServers to this field because this is a "Readers" field. If LocalDomainServers is not included in the entries in this field, the kit will not replicate to other Domino servers in the domain.

Owners Enter or select the persons who own this document.

Administrators Enter or select the persons who administer the document.

Comments (Optional) Enter comments such as the update history for this document.

5. Click Save and Close.

6. Create a desktop policy to deploy the update.

Expression rules for use with the Smart Upgrade Kit document

Domino compares the release number of the user's Notes client to the release number specified in the Source Version field of the Kit document in the Lotus Notes Smart Upgrade database. You can use any of the expression rules shown in the table below, when entering the release number in the Source Version field of the Kit document.

Note Use the expression rules in this table only in the Source version field of the Smart Upgrade Kit document.

Character Description

Any character, for example, C Matches any single non-special character. In this example, it matches C

\C Matches the single character even if it is a special character. In this example, it matches C

? Matches any single character

{ABN} Matches any character in the set (A,B,N)

{!ABN} Matches any character not in the set (A,B,N)

{A-FH-K} Matches any character in the set (A...F,H...K)

+C Matches any number of occurrences of the pattern C

* Matches any string (shorthand for ?)

! Complements logical meaning of this template

| Performs logical "or" of two templates

& Performs logical "and" of two templates

Examples

Domino compares the release number of the user's Notes client to the release number specified in the Source Version field of the Kit document in the Lotus Notes Smart Upgrade database. You can use any of the expression rules shown in the table below when entering the release number in the Source version field of the Kit document.

Each matching pattern in the following string matches the source version string:

"Build V604_10072003NP"

Pattern Explanation of match

Build V604_10072003NP “Build V604_10072003NP”

* wild card match

Build V604_1+072+03NP “+0” matches “00”

??????V604??????????? ? matches any character

+? V604_10072003NP “+?” matches “Build “

Build V604_+{0-9N}NP “+{0-9N}” matches tail “10072003NP”

*V604_+{0-7}NP “_+{0-7}” matches string “10072003”

*V604_10072003+{N-P} “{N-P}” matches “NP”

+{A-Za-z} V604_+{0-7}NP “+{A-Za-z}” matches “Build”

Build V604_+{0-7}NP “0-7” matches “10072003”

Build V604_10072003+{!0-9 } “+{!0-9 }” matches any string not containing a digit

Build V604_+{!A-Z}NP “_+{!A-Z}” matches any string that does not contain any letters A through Z, inclusive.

See also

Before you upgrade the Notes client

Using Notes Smart Upgrade

Glossary

Feedback on Help or Product Usability?

Help on Help

All Help Contents

Glossary

In this field	Do this
Kit description	Enter a brief description of the kit. After completing this document, this kit description is used to identify the Smart Upgrade Kit document.
Enable this kit for use	Select the Enabled check box to make the kit available to authorized users.
Configuration	Choose one: Notes Standard -- You are running the "standard" configuration of Lotus Notes-- this means that you can access applications on both Domino servers and IBM® WebSphere® Portal servers. Notes Basic -- You are running the "basic" configuration of Lotus Notes -- this means that all the server-based applications you can access reside on a Domino server.
Source versions	Enter your current Notes client release, or you can enter a series of Notes clients releases. See the topic Expression rules for use with the Smart Upgrade Kit document for information on acceptable formats for entering the source version. Note To find the current Notes client release number, check the About Notes document. To open the document, choose Help - About Notes.
Operating system	Enter or select the operating system for which the kit is intended.
Localization	Enter or select the language of the Notes Client.
Release 6.5.4/6.0.5 or previous	This field displays only if you are using Microsoft® Windows®. If you are using Notes Domino release 6.5.4, 6.0.5, or previous, click this check box. Smart Upgrade does not recognize whether All client install or Notes client install applies for these releases. Install Type field only appears if this box is not selected.
Install Type	Choose one: Notes client only -- Smart Upgrade will install only the Notes client kit. All client (Notes client, Administrator client, Designer) -- Smart Upgrade will install the All Client kit.
Destination version	Enter the release number of the update kit. The value of this field must match the value in the Deploy Versions field of the desktop policy settings document.
Restart Notes after update	Click the Restart check box to restart the user's updated Notes client when the upgrade is complete.
Location	Choose one of these to specify the location of the upgrade kit: Attached to this note -- Choose this option and then, in the "Attach update kit here" field, attach the update kit or full installation kit. On a shared network drive -- Choose this option and then, in the "Full path to update kit" field, enter the file path to the file SETUP.EXE. When you use the shared network drive option, decompress the file, then copy all files in the installation kit to the directory specified. Follow this convention: \\networkfileservername\shareddirectoryname\setup.exe Shared network drive and attached kit with failover -- Choose this option and then select the file to attach that contains the Smart Upgrade Kit and enter the full file path name to the file, SETUP.EXE. The "Shared network drive and attached kit with failover" option provides both fields of information to users. The Smart Upgrade process checks whether a "Full Path Kit" is available. If the Full Path Kit is available, it is used; if it is not available, the attachment kit is used.
Attach Update Kits here	Attach the update kit or a full installation kit. Attach the EXE file that you downloaded to the document without decompressing the file. If you are using Domino 6.5.5 or later, you can attach either a Notes client only kit or an All clients kit.
Optional arguments for shared network drive kit	Enter optional arguments if you are specifying a shared network kit. For information regarding optional arguments, see the subtopic "Using optional arguments when running Smart Upgrade."
Message text	Enter the message that will appear when Lotus Notes Smart Upgrade prompts users to upgrade their Notes clients.
Optional arguments for attached kit	Enter optional arguments if you are using an attached kit. For information regarding optional arguments, see the subtopic "Using optional arguments when running Smart Upgrade."

In this field	Do this
Allowed Users & Servers	Enter or select the users or servers allowed to upgrade their Notes clients. To include all users in your organization, enter a value using the following format: /OrgUnit/Organization/CountryCode Note* When you enter a value in this field, also add LocalDomainServers to this field because this is a "Readers" field. If LocalDomainServers is not included in the entries in this field, the kit will not replicate to other Domino servers in the domain.
Owners	Enter or select the persons who own this document.
Administrators	Enter or select the persons who administer the document.
Comments	(Optional) Enter comments such as the update history for this document.

Character	Description
Any character, for example, C	Matches any single non-special character. In this example, it matches C
\C	Matches the single character even if it is a special character. In this example, it matches C
?	Matches any single character
{ABN}	Matches any character in the set (A,B,N)
{!ABN}	Matches any character not in the set (A,B,N)
{A-FH-K}	Matches any character in the set (A...F,H...K)
+C	Matches any number of occurrences of the pattern C
*	Matches any string (shorthand for ?)
!	Complements logical meaning of this template
\|	Performs logical "or" of two templates
&	Performs logical "and" of two templates

Pattern	Explanation of match
Build V604_10072003NP	“Build V604_10072003NP”
*	wild card match
Build V604_1+072+03NP	“+0” matches “00”
??????V604???????????	? matches any character
+? V604_10072003NP	“+?” matches “Build “
Build V604_+{0-9N}NP	“+{0-9N}” matches tail “10072003NP”
*V604_+{0-7}NP	“_+{0-7}” matches string “10072003”
*V604_10072003+{N-P}	“{N-P}” matches “NP”
+{A-Za-z} V604_+{0-7}NP	“+{A-Za-z}” matches “Build”
Build V604_+{0-7}NP	“0-7” matches “10072003”
Build V604_10072003+{!0-9 }	“+{!0-9 }” matches any string not containing a digit
Build V604_+{!A-Z}NP	“_+{!A-Z}” matches any string that does not contain any letters A through Z, inclusive.