Siebel Anywhere Administration Guide > Defining Upgrade Kits >

Defining a Siebel Customer Revisions Upgrade Kit


This section provides specific instructions for defining a Siebel Customer Revisions upgrade kit using the Upgrade Kit Wizard. These instructions can be used for the following types of upgrade components, where (base) indicates a language-independent component, and _[language-code] indicates a component that applies to a particular language represented by a code such as ENU (English) or DEU (German):

  • Siebel Client Customer Revisions (base)
  • Siebel Client Customer Revisions_[language-code]

These instructions can also be used for custom components.

CAUTION:  Do not use the upgrade kit type Customer Revisions for upgrade kits containing a Siebel SRF or CFG file. (Using a Customer Revisions kit type to deliver a Siebel SRF or CFG file can result in upgrade failures or incorrect version checking and version numbering.) Instead, use the Siebel Client Repository File and Siebel Client CFG kit types, respectively, for these upgrades.

To define a Siebel Customer Revisions upgrade kit

  1. Gather the information you will need, as described in Upgrade Planning and Preliminary Tasks.
  2. Start the Upgrade Kit Wizard using the instructions in Running the Upgrade Kit Wizard.
  3. Use the information you have gathered and the information in Table 22 to respond to the prompts in the Upgrade Kit Wizard.
  4. When you have finished specifying data about the upgrade kit you are defining, click Finish to pass the request to the Upgrade Kit Builder and to exit from the Upgrade Kit Wizard.

    A new row for the new upgrade kit appears in the Upgrade Kits list, with Status set to Request Submitted. For more information about the kit information available in this list and other lists, see Viewing Upgrade Kit Properties.

    After you define your upgrade kit, you must proceed to activate, apply, and distribute it. For information on these tasks, see Activating, Applying, and Distributing Upgrade Kits.

Information in Table 22 is presented in approximately the sequence used by the Upgrade Kit Wizard.

Table 22.  Upgrade Kit Wizard Elements for a Siebel Customer Revisions Upgrade Kit
Wizard Element
Element Type
Comments

Upgrade Component

Drop-down list

Name of the component the upgrade kit will install or upgrade:

For customer revisions, select one of the following, as needed:

  • Siebel Client Customer Revisions
  • Siebel Client Customer Revisions_[language-code]

For a custom component, select the name of the component you created.

Select File Uploading Method

Radio button

Method for specifying files to include in the upgrade kit. Select one of the following:

  • Add Files. Use when the number of files to be added is small.
  • Use UNC Path. Use when the number of files to be added is large. Gather all the files to be added into one directory before proceeding, as you will specify the directory in a following screen of the wizard.

Files to Add

Text field

Displayed only if the Add Files radio button was selected in an earlier Upgrade Kit Wizard screen. Names of files to include in the upgrade kit. This field is populated either by entering one file name and path, or by clicking Browse and choosing a file from the directory listings displayed. In either case, click the Add button after specifying each path and file name combination. Repeat to add more files.

Browse

Button

Displayed only if the Add Files radio button was selected in an earlier Upgrade Kit Wizard screen. Displays a standard dialog box for browsing and choosing a file.

Add

Button

Displayed only if the Add Files radio button was selected in an earlier Upgrade Kit Wizard screen. When this button is clicked, the information in the Files To Add field is saved. If the Add button is not clicked, the information is discarded when you click Next, and an error message is displayed.

Added Files

Drop-down list

Displayed only if the Add Files radio button was selected in an earlier Upgrade Kit Wizard screen. Displays the names of the files added to the kit so far. Automatically populated when you enter information in Files to Add and then click the Add button.

Remove

Button

Displayed only if the Add Files radio button was selected in an earlier Upgrade Kit Wizard screen. When clicked, the Upgrade Kit Wizard discards the file information currently selected and displayed in the Added Files drop-down list. Other items in the drop-down list are not affected.

UNC Path for File Directory

 

Displayed only if the Use UNC Path radio button was selected in an earlier Upgrade Kit Wizard screen. Specifies the location of a directory that contains all the files to include in the upgrade kit. All the files in the directory you specify will be included in the kit.

Destination Directory

Text field

Specifies where the files of the upgrade kit are to be placed on the client machine.

Delete destination file when done

Check box

When this check box is selected, the upgrade kit files will be deleted, automatically, after the kit is installed.

Select file to execute

Drop-down list

Specifies one file in the upgrade kit to be executed as part of installation of the kit. Available values are the values stored in the Added Files field.

Be sure you specify a file that can be executed, such as a .bat or .exe file. If you specify a file that cannot be executed, such as a .txt file or a CFG file, the upgrade kit will not install properly.

Enter command line arguments

Text field

Specifies any command line arguments to use when running the file chosen in the Select file to execute drop-down list.

Acceptable Return Code

Numeric field

Optionally specifies the numeric code that the selected file to execute will return upon successful execution. Default value is zero.

Minimum Old Version

Text field

Earliest component version that can download and install the upgrade kit. When this field is blank, indicates that there are no prerequisite versions required for using the kit. Defaults to the current component version recorded in the database. For more information about choosing version values, see Determining Version Setting Values.

Maximum Old Version

Text field

Latest component version that can download and install the upgrade kit. When this field is blank, indicates that there are no prerequisite versions required for using the kit. For more information about choosing version values, see Determining Version Setting Values.

New Version

Text field

Version number that the component being upgraded will have after the upgrade kit is installed. Default value is 1 greater than the current version for the component to be upgraded. For more information about choosing version values, see Determining Version Setting Values.

Activate Upgrade Kit

Check box

When this check box is selected, the files to be included in the upgrade kit will be compressed into a single archive on the Siebel File System automatically. Activation can also be performed manually, as described in Activating, Applying, and Distributing Upgrade Kits.

For most upgrade kits, it is recommended that you select this check box. However, if you are creating an upgrade kit that is dependant on another upgrade kit, be sure to clear this check box. For information about working with dependent kits, see Controlling the Order of Kit Installation.

Apply Versions

Check box

Displayed only if Activate Upgrade Kit check box was selected in an earlier Upgrade Kit Wizard screen. When this check box is selected, the compiled information string in the database will be updated automatically with the component version information for this upgrade kit. Applying versions can also be performed manually, as described in Activating, Applying, and Distributing Upgrade Kits.

For most upgrade kits, it is recommended that you select this check box. However, if you are creating an upgrade kit that is dependant on another upgrade kit, be sure to clear this check box. For information about working with dependent kits, see Controlling the Order of Kit Installation.

Required Upgrade Kit

Check box

When this check box is selected, the upgrade kit will be required regardless of previous versions installed. (Min Version and Max Version are set equal to New Version, but this change is not visible in the Upgrade Kit Wizard.) Displayed only if Apply Versions check box was selected in an earlier Upgrade Kit Wizard screen.

Upgrade Kit Title

Text field

Identifier for the upgrade kit. Defaults to Upgrade Component Name value followed by a space and the New Version value, but can be modified during the kit definition process. After the kit is defined, this identifier appears in the Name field of the Upgrade Kits list.

Comments

Text field

Available for comments about the upgrade kit. Comments entered here are displayed in the Upgrade Kits list.

Siebel Anywhere Administration Guide