Viewing Upgrade Kit Properties

After you use the Upgrade Kit Wizard to define an upgrade kit, information about the upgrade kit becomes visible in your Siebel application. Two general types of information are available:

Information that applies to the upgrade kit as a whole, and the components that it will upgrade. See "Properties of the Entire Upgrade Kit and Its Components".
Information that applies to upgrade kit items and item parameters. See "Properties of Upgrade Kit Items and Upgrade Kit Item Parameters".

Properties of the Entire Upgrade Kit and Its Components

The following procedure describes how to view and interpret information that applies to the upgrade kit as a whole and the components that it will upgrade.

To view the properties of an existing upgrade kit and its components

Navigate to the Administration - Siebel Anywhere screen, then the Upgrade Kits view.

The Upgrade Kits list and the Upgrade Kit Components list appear.
In the Upgrade Kits list, select the record for the upgrade kit for which you want to view properties. For more information, see the following tables:
- For more information about the fields in the Upgrade Kits list, which displays each upgrade kit defined in the Siebel Business Applications, see Table 4-10.
- For more information about how to interpret various values that are displayed in the Status field of this list, see Table 4-11.
- For more information about the fields in the Upgrade Kit Components list, which displays the components associated with the selected upgrade kit, see Table 4-12.

Table 4-10 Fields in the Upgrade Kits List

Field	Comments
Name	The name of the upgrade kit (called Upgrade Kit Title in the Upgrade Kit Wizard). The default name includes the component name and version in the upgrade kit. You can specify a different name when defining the upgrade kit. However, it is recommended that you use descriptive names if you do not accept the default wording. Also see Table 3-1 for additional limitations for a name. The name cannot be modified after the upgrade kit has been defined.
Status	For descriptions of Status field values, see Table 4-11.
Archive Kit Name	The name of the compressed file containing the upgrade kit.
File Size	The size of the physical file containing the upgrade kit.
Comments	This field is available for comments.
Modified	The date and time this record was last modified.
Compiled Information	The compiled string that includes all information about the upgrade kit.

The Status field indicates whether the upgrade kit has the status of Request Submitted (that is, waiting for processing by the server), In Progress (in process of being created), Pending, Active, Error, and so on. Table 4-11 describes the values of the Status field.

Table 4-11 Status Field Values in the Upgrade Kits List

Value	Description
Active	The upgrade kit is ready to be applied and distributed.
Error	An error occurred while the upgrade kit was being created.
Inactive	The upgrade kit is on hold and is not ready for further processing. The first step to activate the upgrade kit is to change its status to Pending. Then you can activate it.
In Progress	The creation of a new upgrade kit is underway on the server.
Pending	The upgrade kit was successfully created and is ready to be activated.
Request Submitted	The request has been submitted to the server to create the new upgrade kit.

Table 4-12 describes the fields in the Upgrade Kit Components list, which displays the components associated with the upgrade kit. The components are automatically created by the Upgrade Kit Wizard when you click Auto Create on the Upgrade Kits list.

When you select the new upgrade kit in the Upgrade Kit list, you will notice that two records appear in the Upgrade Kit Components list. The first record is the component to be upgraded. The second is the Siebel Upgrade Wizard. Including the Siebel Upgrade Wizard component reinforces using the correct version of the Upgrade Wizard for the upgrade.

Caution:

Do not delete the default records in the Upgrade Kit Components list. These records store key information about how components work, and provide models that you might eventually need for setting up custom components.

Table 4-12 Fields in the Upgrade Kit Components List

Field Name	Comments
Name	The name of the component.
Min Old Version	The minimum component version that a subscriber must have to install this upgrade kit.
Max Old Version	The maximum component version that a subscriber might have to install this upgrade kit.
New Version	The version of this component the user will have after installing the upgrade kit.
Comments	This field is available for comments.

The settings in the Upgrade Kit Components list also control the upgrade kit sequence (the order of upgrades), when multiple upgrade kits are used together. For example, if Upgrade Kit 1 must be installed before Upgrade Kit 2, then you can add component Upgrade Kit 1 upgrades as components of Upgrade Kit 2. For details, see "Controlling the Order of Upgrade Kit Installation".

Properties of Upgrade Kit Items and Upgrade Kit Item Parameters

Each upgrade kit item defines an action in an upgrade kit and requires certain parameters to operate. For example, a file copy action needs the file to copy and the destination for the copy. The following procedure describes how to view and interpret information that applies to items and item parameters within a selected upgrade kit.

Note:

It is recommended that you do not add, update, or delete any records in the Upgrade Kit Items list and Upgrade Kit Item Parameters list in the Upgrade Kit Items view. The records in these lists are created automatically, and changing them in any way can damage the selected upgrade kit.

To view properties of an existing upgrade kit's items and item parameters

Navigate to the Administration - Siebel Anywhere screen, then the Upgrade Kit Items view.

The Upgrade Kits list, the Upgrade Kit Items list, and the Upgrade Kit Item Parameters list appear.

For more information about the fields in the Upgrade Kits list, see Table 4-10 and Table 4-11.

For more information about the fields in the Upgrade Kit Items list, which displays the individual items that define actions to be executed by a selected upgrade kit, see Table 4-13.

For more information about the fields in the Upgrade Kit Item Parameters list, which displays the parameters associated with a selected upgrade kit item, see Table 4-14.

Table 4-13 Fields in the Upgrade Kit Items List

Field Name	Comments
Comments	This field is available for comments.
Estimated Disk Space	The disk space required to download and execute an item (optional). When the upgrade kit is created, the default value for this field is 0. You can enter a new value (in bytes) before activating the upgrade kit. Before a subscriber installs the upgrade kit, the Upgrade Wizard validates that the specified amount of free disk space is available. If adequate disk space is not available, then the Upgrade Wizard returns an error message.
Item Type	The type of item to execute.
Sequence	The order in which the Upgrade Wizard executes the item.
Title	The title of the item, which is displayed in the Upgrade Wizard.

Each upgrade kit item defines an action in an upgrade kit and requires certain parameters to operate. For example, a file copy action needs the file to copy and the destination for the copy. The Upgrade Kit Item Parameters list includes the parameters associated with each upgrade kit item. Table 4-14 describes the fields of this list.

Table 4-14 Fields in the Upgrade Kit Item Parameters List

Field Name	Comments
Attachment Name	The name of the file associated with this item.
Comments	This field is available for comments.
Date	The date and time when the file is attached.
File Ext	The extension of the file associated with this item.
Name	The name of the parameter.
Size	The size of the file associated with this item.
Value	The value of the parameter.