Automatically updating Sametime 7.5.x Connect clients

Technote (FAQ)


Question

How can a Lotus Sametime server administrator push down automatic updates to Sametime 7.5.x clients?

Answer


Sametime 7.5.x has a new feature that allows administrators to automatically force updates to all of the Sametime 7.5.x Connect clients within the environment.
In general, these updates or patches will come in the form of updated plugins.

In order to automatically force these updated plugins to propagate to all of the 7.5.x Connect clients within the environment, the following steps should be taken.


Summary of steps
  1. Compose a file site.xml. This file (the "update site") will determine which plugins are pushed down to the Connect clients.

  2. Move the site.xml file to a web server that will host the updated plugins.

  3. Configure the Sametime server to force clients to check the site.xml for mandatory plugin updates.

  4. With release 7.5.1, there is the additional step of filling out the provisioning URL in the Policy configuration.


Detailed instructions



1. Setting up an update site

In general, an update site (site.xml) is provided to an administrator when they receive a client-side patch from IBM Support. Therefore, there is no need for the administrator to manually create site.xml.

However, in cases where site.xml is not provided, and a plugin update is available and necessary, the administrator must create their own site.xml using the following instructions.

The Sametime server administrator must set up an update site and fill it with all of the mandatory features which will be updated by all clients connecting to it. This site should be an .xml file with the following template text in it:
    <?xml version="1.0" encoding="UTF-8" ?>
    <site>
    <feature url = "" id="" version="">
    <category = "" />
    </feature>
    <category-def name="" label="" />
    </site>
* To create an .xml file, create a text document and rename it to “site.xml”.

    XML tag definitions:
    feature url = relative path to the update file
    id = typically this parameter is set to the name of the plugin feature
    version = the version number of the update
    category = name of the category type
    category-def name = corresponding category with a label assigned

Note: The update file being pointed to by the feature url should be named in the format id_version (for example, ThinkBox_1.1.0.2.zip).
    <!--- Example site.xml -->
    <?xml version="1.0" encoding="UTF-8" ?>
    <site>
    <feature url=" features/com.ibm.collaboration.realtime.quickresponse.feature_1.1.0.jar"
      id=" com.ibm.collaboration.realtime.quickresponse.feature"
      version=" 1.1.0">
    <category name=" Other" />
    </feature>
    <category-def name=" Other" label=" Other" />
    </site>
It is always good to check if the xml file has been generated properly. If the xml file is not generated correctly you will get an error saying “The xml file cannot be displayed” when you try to open the xml file in a browser.


For more information on creating update sites, please visit Eclipse.


2. Determining the location of the update site and the updated plugins

This step assumes the Sametime server will host the update site and the updated plugins.
Note: It is not required that the Sametime server host the update site and the updated plugins. In fact, any web server that can be reached by the users can be used to host the update site and plugins.

However, using the Sametime server to host these files makes these updates instantly available to all those users who can connect to the Sametime server.

  1. Create a directory on your Sametime server where you will store the client updates. For example, create a directory named STclientupdate in the Domino web server's root directory:

    <server_data_directory>/domino/html/STclientupdate

    Note: Do not create the directory anywhere within the following directory, as this may cause problems with future Sametime upgrades:

    <server_data_directory>/domino/html/sametime


  2. Store the site.xml and the corresponding plugin updates within the new directory that has been created.

    You can create the site and corresponding folders (features and plugins are the recommended names) in the server root. This way, the changes made to the server resources will be instantly visible to any users who can connect to the server. On a Domino Sametime 7.5 server, this location is:

    \Lotus\Domino\data\domino\html\


3. Setting new server attribute for the update site URL

The administrator must set a new server attribute for the update site url so that clients who log into the server as their primary server will check the server attribute and get the mandatory updates from there. Take the following steps to set the server attribute.
  1. Using a Notes client, open the stconfig.nsf file located on the Sametime 7.5 server.

  2. Double-click the 'CommunityClient' document.

  3. Edit the "URL for UIM Provisioning" field by adding the full path to the update site. Make sure you include http:// in the link. The field does not automatically add it.

    Example:
    URL for UIM Proviosioning: http:// /STclientupdate/site.xml
  4. Save the changes. Restart the server.

The server is now setup to force automatic updates to all 7.5.x Connect clients that login to this specific Sametime server. Note that this step (Step 3) should be performed on all Sametime chat servers in the environment that Sametime 7.5 clients connect to.


4. Provisioning URL in the Policy
With release 7.5.1, there is the additional step of filling out the provisioning URL in the Policy configuration.


User experience

When a user restarts his client and logs into the pre-configured server as their default community, the following occurs:
  1. The client logs-in.

  2. After 60 seconds, the client checks for the server attribute discussed earlier. If it is found, all of the features on the site are compared to the existing found features. If there are some that are missing (they exist on the server but do not exist on the client) the features are downloaded and installed without the user knowing about it, or being able to stop it. This is done in a different thread from the main thread so it should not impact the user experience dramatically (some network traffic will occur here, since the client is contacting the server and the update site, querying for features to install).

  3. If the Sametime client finds updates to install, it downloads them and installs them. It then asks the user to restart the Sametime client.

    What the user sees:

    After all the automatic push updates have been downloaded, the client will see the following message:

    New Administrator updates have been found and downloaded to your client. Please restart the client now.

    This is a non-intrusive message. The user can select to "wait 5 minutes." This clears the message immediately, but the message will return in five minutes. This process can be selected indefinately; however, it is best to press the "Restart Now" button which will restart the Sametime client. The computer is not rebooted, only the Sametime client is restarted.

    This was put in place because the download process of updates can be a time-consuming event. This allows the user to finish up any open chats before the Sametime client is restarted.

    If the updates have a problem, the user sees an error on the Sametime client.


Rate this page:

(0 users)Average rating

Document information


More support for:

Lotus End of Support Products
Lotus Sametime

Software version:

7.5, 7.5.1

Operating system(s):

Windows

Reference #:

1246886

Modified date:

2008-05-28

Translate my page

Machine Translation

Content navigation