Adding upgrade kits to the Smart Upgrade application

After downloading a Notes® install kit, make the kit available to users by creating a kit document in the Smart Upgrade application 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.

About this task

Specify the location of the Notes® install kit in the Smart Upgrade kit document when setting up Smart Upgrade for users.

Obtain upgrade kits from IBM® developerWorks® downloads. See the link in the related information.

Procedure

  1. In the Domino® Administrator client, open the Smart Upgrade application.
  2. Click New Kit to create a kit document.
  3. On the Basics tab, complete the following fields:
    Table 1. New Smart Upgrade kit fields and actions

    Field

    Action

    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

    • Notes® Standard
    • Notes® Basic

    Source versions

    Enter the current installed Notes® release.

    Note: To find the release number, click Help > About IBM Notes in the Notes® client.

    Operating system

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

    Localization

    Enter or select the language of the Notes® client.

    Install Type

    • Notes-only -- Smart Upgrade will install the Notes-only client kit. The Notes-only kit is for a multi-user install.
    • All client (Notes® client, Domino® Administrator client, Domino® Designer client) -- Smart Upgrade will install the All Client kit. This is not available for Linux or Mac OS platforms. The Notes® All client kit is for a single user install.

    Destination version

    Enter the release number of the upgrade kit.

    If you are using policies, 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 Notes® client when the upgrade is complete.

    Location

    Specify the location of the upgrade kit:

    • Attached to this note -- Choose this option and then, in the Attach upgrade kit here field, attach the upgrade kit or full installation kit.
    • On a shared network drive -- Choose this option and then, in the Full path to upgrade 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 Upgrade kits here

    Attach the upgrade kit. Attach the .EXE file that you downloaded to the document without decompressing the file.

    Optional arguments for shared network drive kit

    Enter optional arguments if you are specifying a shared network kit.

    Message text

    Enter the message that will appear when the 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.

  4. Complete the following fields on the Administration tab.
    Table 2. Administration tab

    Field

    Action

    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.
    Note: If you leave this field blank, the Smart Upgrade kit will be applied to all Notes® users in the Domino® domain.

    Owners

    Enter or select the persons who own the document.

    Administrators

    Enter or select the persons who administer the document.

    Comments

    Enter any helpful comments such as the document history.

  5. Click Save and Close.
  6. You can use a Domino® desktop policy to deploy the upgrade to targeted Notes® users.

Expression rules for use with the Smart Upgrade kit document

About this task

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 Smart Upgrade application. You can use any of the expression rules shown in the table 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.
Table 3. Expression rules

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

You can use any of the expression rules shown in Table 4 when entering the release number in the Source version field of the kit document.

Table 4. Examples of patterns

Pattern

Explanation of match

Release 8.5.3FP3

Version 8.5.3 Fix Pack 3

Release 9.0*

wild card match

Release 8.5.3FP?

? matches any character