Siebel Anywhere Administration Guide > Defining Upgrade Kits >

Defining a Siebel Client Customer Revisions Upgrade Kit


This topic provides specific instructions for defining a Siebel Client Customer Revisions (of type Customer Revision) 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 (U.S. 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 Revision for upgrade kits containing a Siebel SRF or CFG file. (Using a Customer Revision upgrade 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 upgrade kit types, respectively, for these upgrades.

To define a Siebel Client Customer Revisions upgrade kit

  1. Gather the information and files you will need, as described in Planning and Preparing to Use Siebel Anywhere.
  2. Start the Upgrade Kit Wizard, as described 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 server component 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 upgrade 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 more information about these tasks, see Activating, Applying, and Distributing Upgrade Kits.

The 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 Client Customer Revisions Upgrade Kit
Wizard Element
Element Type
Comments

Upgrade Component

Drop-down list

The name of the component the upgrade kit will install or upgrade. Select one of the following:

  • 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

The 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 later screen of the wizard.

Files to Add

Text field

This field is displayed only if you previously selected the Add Files radio button in the Upgrade Kit Wizard.

The 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

This button is displayed only if you previously selected the Add Files radio button in the Upgrade Kit Wizard.

This button displays a standard dialog box for browsing and choosing a file.

Add

Button

This button is displayed only if you previously selected the Add Files radio button in the Upgrade Kit Wizard.

When this button is clicked, the information in the Files To Add field is saved. If the Add button is not clicked, then the information is discarded when you click Next, and an error message is displayed.

Added Files

Drop-down list

This list is displayed only if you previously selected the Add Files radio button in the Upgrade Kit Wizard.

This list displays the names of the files added to the upgrade kit so far. This setting is automatically populated when you enter information in Files to Add and then click the Add button.

Remove

Button

This button is displayed only if you previously selected the Add Files radio button in the Upgrade Kit Wizard.

When this button is 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

Text field

This field is displayed only if you previously selected the Use UNC Path radio button in the Upgrade Kit Wizard.

This field specifies the Universal Naming Convention (UNC) path 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 upgrade kit.

Destination Directory

Text field

This field specifies where the files of the upgrade kit are to be placed on the client computer.

Delete destination file when done

Check box

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

Select file to execute

Drop-down list

Specifies one file in the upgrade kit to be executed as part of the installation of the upgrade 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, then 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

An optional setting that specifies the numeric code that the specified file to execute returns upon successful execution. The default value is 0 (zero). You can also specify multiple comma-separated values. After the file is executed, the Upgrade Wizard checks the actual return code against the value you specify in this setting.

Minimum Old Version

Text field

The earliest component version that can download and install the upgrade kit. When this field is blank, this indicates that there are no prerequisite versions required for using the upgrade kit. The default value is 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

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

New Version

Text field

The version number that the component being upgraded will have after the upgrade kit is installed. The 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. You can also perform activation 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 dependent on another upgrade kit, be sure to clear this check box. For more information about working with dependent upgrade kits, see Controlling the Order of Upgrade Kit Installation.

Apply Versions

Check box

This check box is displayed only if you previously selected the Activate Upgrade Kit check box in the Upgrade Kit Wizard.

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. You can also apply versions 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 dependent on another upgrade kit, then clear this check box. For more information about working with dependent upgrade kits, see Controlling the Order of Upgrade Kit Installation.

Required Upgrade Kit

Check box

This check box is displayed only if you previously selected the Apply Versions check box in the Upgrade Kit Wizard.

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 the value of New Version, but this change is not visible in the Upgrade Kit Wizard.)

Upgrade Kit Title

Text field

An identifier for the upgrade kit. The default value is the value of Upgrade Component Name followed by a space and the value of New Version. However, you can modify the title while defining the upgrade kit. After the upgrade kit is defined, this identifier appears in the Name field of the Upgrade Kits list.

Comments

Text field

This field is available for comments about the upgrade kit. Comments entered here are displayed in the Upgrade Kits list.

Siebel Anywhere Administration Guide Copyright © 2013, Oracle and/or its affiliates. All rights reserved. Legal Notices.