Retrieving and Installing Upgrade Kits

This topic describes how to retrieve and install upgrade kits. This task is a step in "Process of Retrieving, Installing, and Testing Upgrade Kits".

The procedure for retrieving an upgrade kit depends on its type:

• Optional upgrade kits can be manually retrieved and installed by Siebel client subscribers through the Component Upgrades view.

• Required upgrade kits are automatically retrieved when mobile users synchronize or log into the application and when the server starts up or Replication Agent synchronizes with Siebel Server.

For each applicable Siebel client type, upgrade kits are retrieved as follows:

• Mobile Web Clients request the files from the Siebel Remote Server. The Remote Server retrieves the files from the Siebel File System.

• Developer Web Clients retrieve upgrade kits (.saf files) directly from the Siebel File System or by using the File System Manager, depending on the settings defined in the active CFG file.

Subscribers use the Upgrade Wizard to install upgrade kits after they are retrieved. The process for invoking the Upgrade Wizard varies by subscriber type:

• For client subscribers, the Upgrade Wizard is invoked automatically after an upgrade is retrieved.

• For Siebel Server subscribers, the Upgrade Wizard is invoked manually (see "Retrieving Upgrade Kits for Siebel Regional Node Servers").

The process for retrieving and installing upgrade kits by Siebel Client subscribers is described in the following topics:

• "Retrieving Optional Upgrade Kits for Developer Web Clients"

• "Retrieving Required Upgrade Kits"

Note: When a Siebel Repository File upgrade kit is retrieved and installed, the size of the downloaded SRF file might differ from the original size of the SRF file included in the upgrade kit. The size change is related to details of how compression and decompression are implemented, and does not normally indicate an error. To check for correct file size and timestamp, use the size and timestamp from a test Mobile Web Client as the standard for other subscribers.

Retrieving Optional Upgrade Kits for Mobile Web Clients

This topic describes how to retrieve and install an optional upgrade kit for a Mobile Web Client. Optional upgrade kits are only for client subscribers. Upgrade kits for server subscribers must always be required.

This topic is part of "Retrieving and Installing Upgrade Kits".

Note: Siebel Web Clients (the client type that is not installed using a Siebel installer) are not Siebel Anywhere subscribers.

The following procedure describes how to retrieve and install an optional upgrade kit for a Mobile Web Client.

Note: The following procedure restarts the Mobile Web Client computer. It is recommended that users save their work and exit from other applications before starting this procedure.

To retrieve an optional upgrade kit for a Mobile Web Client 

1. Invoke the Mobile Web Client.

2. Choose File, then Synchronize, and then Database.

3. In the Siebel Remote dialog box, click Synchronize.

   Synchronization takes place and is complete when the opposing arrows (red and blue) in the lower-right corner of the screen disappear.

4. Navigate to the User Preferences screen, then the Component Upgrades view.

5. In the Component Upgrades list, select the desired upgrade component, and check the check box under the Upgrade column.

   A check appears. The Status field value is Upgrade Available for those components where optional upgrade kits are available. For more information about possible values for the Status field, see Table 5-1.

6. Click Upgrade Selected Components to display the Siebel Anywhere Kit Download dialog box, and then complete the following substeps:

   1. Follow the instructions in the Siebel Anywhere Kit Download dialog box to start a Siebel Remote session and retrieve the upgrade kit necessary to upgrade your system.

   2. Click OK to close the Siebel Anywhere Kit Download dialog box.

7. Synchronize again as in Steps 2 and 3 to retrieve the corresponding upgrade kits.

8. Click Upgrade Selected Components again to invoke the Upgrade Wizard for the desired upgrade component.

   After the Upgrade Wizard completes, it will automatically restart the Mobile Web Client.

9. Log in, repeat Step 4 and, from the Component Upgrades list, verify the Status is Version OK for the desired upgrade component. Table 5-1 describes the fields in the Component Upgrades list.

Table 5-1 Fields in the Component Upgrades List

Field Name	Comments
Upgrade	Check this field to upgrade the component.
Component Name	The name of the upgrade component.
Status	The status of the upgrade component. Values can include the following: Upgrade Available. An optional upgrade kit is available for this component. Upgrade Required. A required upgrade kit is available for this component. Version OK. The version of this upgrade component is current. Upgrade Not Available. The upgrade component is outdated and must be updated; however, no upgrade kit is available to do this. Contact your Siebel administrator.
Current Version	The version of the component on the client computer.
Minimum Version	The minimum required version of the component.
Maximum Version	The maximum required version of the component.
Upgrade Size (bytes)	The size of the upgrade kit.
Download Time (mins)	The estimated time to download the upgrade kit.

Retrieving Optional Upgrade Kits for Developer Web Clients

Siebel Developer Web Clients can retrieve optional upgrade kits as described in the following procedure.

This topic is part of "Retrieving and Installing Upgrade Kits".

To retrieve an optional upgrade kit for a Developer Web Client  

1. Start the Developer Web Client.

2. Navigate to the User Preferences screen, then the Component Upgrades view.

   In the Component Upgrades list, the upgrade status is Upgrade Available for those components where optional upgrade kits are available. If you do not see the Upgrade Available status for the component you want to upgrade, then contact your Siebel administrator, because this discrepancy might indicate a configuration problem.

   After the administrator corrects the problem, refresh your own view of the Component Upgrades list and reinspect the upgrade status for components that have optional upgrade kits.

3. In the Component Upgrades list, select the desired upgrade component, and select the check box in the Upgrade column for the desired upgrade component.

4. Click Upgrade Selected Components.

   This will download the upgrade kit, shut down the Developer Web Client application, and start the Upgrade Wizard. After the Upgrade Wizard completes, it will automatically restart the Developer Web Client application. For some Third Party Software upgrade kits, the client computer might shut down and restart.

5. Log in and, from the Component Upgrades list, verify the Status is Version OK for the desired upgrade component.

Retrieving Required Upgrade Kits

Both Mobile and Developer Web Clients perform a version check during login to a Siebel application. Mobile Web Clients also perform a version check during synchronization.

This topic is part of "Retrieving and Installing Upgrade Kits".

If the version check detects that an upgrade is required, then a dialog box appears asking the user whether to upgrade or not. If the user chooses Yes, then the upgrade kit will be downloaded. The following procedures for both the Mobile and Developer Web Clients illustrate this point.

Upgrade kits are not automatically retrieved upon version check. A prompt appears, asking if the user would like to retrieve the upgrade kit. The upgrade kit is downloaded only if the user clicks yes to download the upgrade kit.

The version check verifies the components used by the client configuration; multiple required components can be displayed in the dialog box.

Note: Synchronizing a Mobile Web Client automatically includes copying version information for Siebel Anywhere from the server to the local database. This allows each Mobile Web Client to detect new required and optional upgrades for the client's configuration without waiting for individual database transactions concerning versions to be synchronized.

If the user answers Yes, then every required upgrade kit for the components used by the client configuration is automatically retrieved and the Upgrade Wizard is started.

If the user answers No, then the Developer Web Client starts in read-only mode against the server database, and the Mobile Web Client starts in read-only mode against the local database.

If the user answers No, then the user's session continues in read-only mode against either the local or server database, until the upgrade has been completed. A prompt notifies the user of this status.

While operating in read-only mode, both Developer and Mobile Web Client users can view screens, views and data as usual, but they cannot make changes. Mobile Web Client users can synchronize, but can only download files; they cannot send, receive, or apply database changes. Read-only mode prevents users from corrupting data with an outdated or invalid Siebel application configuration.

Both Developer and Mobile Web Client users exit read-only mode when the Siebel application is restarted following a successful upgrade. At that point, a Mobile Web Client user can perform a full synchronization, sending to the Siebel Server any local database changes that predate the upgrade.

Retrieving Required Upgrade Kits for Mobile Web Clients

If a user starts the Mobile Web Client in read-only mode, then the user is prompted to upgrade at each synchronization session.

The version check for Mobile Web Clients occurs during synchronization. If the version check detects the need for an upgrade, then the user receives a prompt indicating a possible upgrade. The remote user logs in again to synchronize the server and local database.

To retrieve required upgrade kits for Mobile Web Clients 

1. Invoke the Mobile Web Client.

2. Choose File, then Synchronize, and then Database.

   A dialog box appears indicating there is a required upgrade available.

3. From the dialog box, click Yes and follow the prompts to invoke the Upgrade Wizard.

   The Upgrade Wizard will shut down the Siebel client, install the upgrade kit, and automatically restart the client unless there is an error while installing the upgrade kit.

4. Log in to the Siebel application.

5. Navigate to the User Preferences screen, then the Component Upgrades view.

6. Verify that the Status and Current Version columns contain the updated information.

Retrieving Required Upgrade Kits for Developer Web Clients

Retrieving Developer Web Clients is similar to that of Mobile Web Clients, except version checking only occurs during login.

To retrieve required upgrade kits for Developer Web Clients 

1. Start the Developer Web Client.

   Logging in will trigger a version check and will prompt for retrieval of a required upgrade kit. If you choose not to upgrade at this time, then you can only operate in read-only mode.

2. Click Yes.

   The Siebel client downloads the appropriate upgrade kits.

   After the retrieval is complete, the client invokes the Upgrade Wizard before exiting. After the client exits, the Upgrade Wizard applies the upgrade kits and automatically restarts the client when it is done.

3. Log in to the Siebel application.

4. Navigate to the User Preferences screen, then the Component Upgrades view.

5. In the Component Upgrades list, verify that Status is Version OK.