Product Administration Guide > Siebel Configurator Web Templates >

Modifying the Display Name of Items

This topic explains how to modify the display name of an item, such as an attribute, relationship, linked item, or resource. A common reason for doing this is that you want the item name that the customer sees to be different than the name you have in the product table for a specific version of the customizable product.

For example, a computer component is called 256 MB disk drive in the product table. However, in an upcoming offering, you want to call this item the Standard 256 MB Disk. Rather than change the item name in the product table, you can change it using the Properties view. This change is specific to the customizable product and is stored with it when you release the product. You can use the Properties view to change item names with each release of a customizable product, without having to change the item name in the product table.

To change the display name of an item, you insert a variable in the UI control Web template that governs display of the item. This variable tells the Web Engine to get the item name from a defined UI property.

To change the display name of a relationship item in the form, perform the following tasks:

1. Creating a New UI Control Template. You do this by saving a copy of the UI control template you selected in the User Interface view. Then you insert a variable name in the new template.
2. Assigning the New UI Control Template. Assign the new template to the item.
3. Defining a UI Property for the Item. Define a UI Property for the item.

Creating a New UI Control Template

You must create a new UI control template to customize the display of an item. You do this by copying an existing template. Then you insert a UI property name variable into the copy. Finally, you assign the new template as the UI control template for the item.

To insert a UI property variable into a Web template, you must locate the swe.control element that governs the display of the item. The UI control Web templates all have the same basic layout:

• A swe.include statement reads in a header file. This file places the relationship name at the top of the form that will contain the items.
• A swe for-each loop iterates through the relationship in the customizable product and loads its items into an array.
• A second swe for-each loop reads the array and constructs the form.
• A variable called DisplayValue near the beginning of the second swe for-each loop defines what item name appears next to each instance of the control in the form.
• The DisplayValue variable is set equal to a swe.control element that contains an attribute CfgFieldName= "CxObjName". Replace CxObjName with the name of the UI property variable. The name must be preceded with a period (.). For example: ".NewName".

To create a new UI control template

1. Navigate to the Administration - Product screen, then the Product Definitions view.
2. In the Product list, select and lock the desired customizable product.
3. In the Versions list, click the Work Space version.
4. Click the User Interface view tab.
5. Click the group name containing the item whose display you want to modify.

   The items belonging to the group you select display in the Group Item List.

6. In the Group Item List, select the item you want to modify, for example a relationship.
7. In the record you selected, click the select button in the UI control field.

   The Pick UI Style dialog box displays. The control you have selected for the group member is highlighted.

8. Write down the filename of the Web template that governs the display of this control.

   The filename is shown in the Template field. The filename ends in .swt.

9. Open the Web template in a text editor and save it to a new filename.

   The Web templates are located in <install-dir>\webtempl (NT path syntax) where <install-dir> is the path to the Siebel installation directory. The filename should begin with eCfg and end with .swt. For example: eCfgport_modifiedcheckbox.swt

10. In the new template, locate the correct swe.control element containing the CfgFieldName= "CxObjName" attribute.
11. Replace "CxObjName" with a UI property variable name and save the file.

    The variable name must begin with a period (.). For example: ".NewName". Verify the variable name is enclosed in quotes.

Assigning the New UI Control Template

To assign the new Web template to a group item, you first add the template to the Pick UI Style dialog box. Then you select it as the template for an item in the group.

To assign the new UI control template

1. In the User Interface view Group List, click the group name containing the item whose display you want to modify.

   The items belonging to the group you select display in the Group Item List.

2. In the Group Item List, click the item you want to modify.

   This selects the record.

3. In the record you selected, click the select button in the UI control field.

   The Pick UI Style dialog box appears.

4. In the dialog box, click New and fill out the form for adding a new template and click OK.
   • Name. Enter a descriptive name. For example: Modified Check Box.
   • Template. Enter the filename of the template you created.
   • Description (Optional). Enter a brief description of the template.
5. In the Pick UI Style dialog box, click the template you added and click OK.

   This assigns the new template to the item and closes the dialog box.

6. In Group Item List, save the revised record.

Defining a UI Property for the Item

The last step is to assign the variable in the new Web template to the item. Then you enter a value for the variable. The value you enter is what displays in a configuration session.

For example, if you assigned the template to a relationship, you must define a UI property for each item in the relationship.

To define a UI Property for the item

1. Click the Properties view tab.
2. In the box displaying the contents of the customizable product, select the item on which you want to define the UI property.
3. In Item Display Properties, click New.

   A new record appears.

4. Fill out the record.
   • Name. Enter the name of the UI property variable. Do not include the period (.) that begins the name.
   • Value. Enter the value you want to the variable to have for this item.
5. Save the new record.
6. Open the Item Display Properties menu and click Validate.

   This starts a configuration session. Verify that the item names display correctly.