20Configuring Menus, Toolbars, and Icons
Configuring Menus, Toolbars, and Icons
This chapter describes how to configure menus, toolbars, and icons. It includes the following topics:
For more information, see Localizing an Application Menu.
About Menus and Toolbars
This topic describes menus and toolbars. It includes the following information:
Menus and toolbars are user interface elements that allow the user to do something. For example:
The application menu is a menu that allows the user to perform a task consistently across a Siebel application. Siebel CRM displays it in a frame near the title bar of the Siebel client in the browser window. This menu includes submenus, such as File, Edit, View, Navigate, Query, Tools, and Help.
The application toolbar is a toolbar that allows the user to access commonly performed tasks. Siebel CRM displays it just beneath the primary tab bar, as illustrated in the following figure. Some icons on the application toolbar are redundant with menu items that the application menu contains.
Applet Menu
An applet can contain a menu. An applet menu is a contextual menu that includes a number of menu items. Each menu item that an applet menu contains allows the user to perform a task in the context of the applet. Siebel CRM locates the applet menu in the applet. To view an example applet menu, you can open the Siebel client, click the Accounts screen tab, and then the Accounts List link. In the Accounts List applet, click Menu. The menu that Siebel CRM displays is an example of an applet menu. If you click it, then Siebel CRM displays a pop-up contextual menu.
How Siebel CRM Handles a Menu or Toolbar Action
If the user clicks a menu item or toolbar icon, then Siebel CRM calls a method. This method can exist in one of the following ways:
In a service that resides on the browser or server
In a class that resides in the browser application, such as an applet or business component class
In a class that resides in the server infrastructure, such as a Siebel Web Engine frame manager
Siebel CRM defines the menu item or toolbar icon to target the following items:
A method name
A method handler
A service (optional)
A web template involves toolbar tags. For more information, see Using Web Templates to Configure Toolbars and Siebel Developer's Reference.
Objects That Siebel CRM Uses in a Menu or Toolbar
This topic describes the objects that Siebel CRM uses in a menu or toolbar.
Command Object Type
A command is an object that specifies the method that Siebel CRM calls when the user chooses an application menu item or an applet menu item, or clicks a toolbar icon. It specifies the bitmap that Siebel CRM displays for a toolbar icon. A menu item or toolbar item references a command. An applet menu does not reference a command.
For more information, see Creating a Command Object and Properties of a Command.
Toolbar Object Type
A toolbar is an object that provides a named toolbar that the user can activate or deactivate. You can associate or remove a toolbar item object definition. A toolbar object must exist for each toolbar that Siebel CRM displays.
For more information, see Properties of a Toolbar.
HTML and Java Usage
An HTML toolbar is a type of toolbar that typically defines toolbar functionality for Siebel CRM. Each button Siebel CRM displays in an HTML toolbar is a static image that you can dim to indicate that the button is not available. Program logic on the browser does not manipulate an HTML toolbar.
A communication toolbar is a type of toolbar that Siebel CRM displays that you can modify in reply to an event. For example, Siebel Call Center displays a blinking icon on a communication toolbar to indicate an incoming telephone call. A communication toolbar uses Java. You must enter a class name in the Class property for a toolbar that uses Java. For more information, see Siebel CTI Administration Guide.
Menu and Menu Item Object Types
A menu is an object that defines a named menu that Siebel CRM displays in the Siebel client. You can add or remove menu items for each menu.
A menu item is an object that associates a command object definition with a menu item object definition. This association places a menu item in a position. The command object definition that the menu contains defines the method for this menu item. For more information, see Properties of a Toolbar Item.
Toolbar Item Object Type
A toolbar item is an object that associates a command with a toolbar. This association places a toolbar icon on the toolbar in a location relative to the other toolbar icons that Siebel CRM displays on this toolbar. The toolbar object is the parent of the toolbar item. For more information, see Properties of a Toolbar Item.
Applet Method Menu Item Object Type
An applet method menu item is an object that is a child of an applet. It defines a menu item that resides in the applet menu for the parent applet. For more information, see Properties of an Applet Method Menu Item.
Class Method Menu Item Object Type
A class method menu item is an object that is a child of a class. It adds or suppresses a menu item that Siebel CRM displays on an applet menu for Siebel Web Engine applets of the defined applet class and subclasses. For more information, see Properties of an Applet Method Menu Item.
About the Method, Business Service, and Target Properties of the Command Object
You can use the Method, Business Service, and Target properties of a command for application menus, applet menus, or toolbars. The target property specifies the object or service that processes the method that the command calls.
How Siebel CRM Redirects a Method
In some situations, if the target cannot handle a method, then Siebel CRM redirects the method to an underlying object or service. This object or service can be one of the following:
A mirror instance of the object. This instance exists on the Siebel Server.
An inherited class.
In these situations, Siebel CRM redirects the method.
Options for the Business Service Property
If the Business Service property identifies a business service, then this business service handles the method depending on the following situations:
Siebel CRM receives the call from an application menu or application toolbar. Siebel CRM uses the object manager service to handle the method. It does not retarget the call.
Siebel CRM receives the call from an applet menu. The method handler does a SetBC call to set to the business component that the applet reference, and then calls the object manager service. It does not retarget the call.
Options for the Target Property
This topic describes the options that are available for the Target property. If you use the Object List Editor, then the Target property for the Command object displays six values. If you use the Command Wizard to create a new Command object, then Browser and Server are the only values available of these six values.
Target Property Set to Browser
If you set the Target Property to Browser, then the following situation applies:
Siebel CRM does not run the server PreInvokeMethod.
The method handler for this target exists on the browser as the JavaScript application, a JavaScript applet, or a JavaScript service.
You must define a method name in the Method property.
If the Business Service property specifies a business service, then Siebel CRM targets this business service.
If the Business Service property does not specify a business service, then Siebel CRM does one on the following:
Siebel CRM receives the call from an application menu or application toolbar. Siebel CRM targets to the method that the JavaScript application defines. For example, if you configure Siebel CRM to use the ActiveBusObject and RaiseErrorText application methods in a server script, then these methods must include a Browser target.
Siebel CRM receives the call from an applet menu. Siebel CRM targets to the method that the JavaScript applet defines. If Siebel CRM cannot use this configuration to handle the call, then it retargets the call to the method that it defines in the corresponding JavaScript business component. It does no inheritance or retargeting.
Target Property Set to Server
If you set the Target Property to Server, then Siebel CRM does not run the browser PreInvokeMethod, and Siebel CRM calls a method in a C++ class that resides on the Siebel Server on a service or on the infrastructure. If the Service property is not defined, then Siebel CRM targets the method to the infrastructure. This targeting depends on the following:
Siebel CRM receives the call from an application menu or toolbar. Siebel CRM handles the method in the following order of priority:
Uses the Siebel Web Engine UDF loader on the Siebel Server
Uses the model
Siebel CRM receives the call from applet menu. Siebel CRM handles the method in the following order of priority:
Uses the applet class that the applet references
Retargets, if necessary, successively up through the applet class hierarchy to CSSSWEFrame
If still not handled, retargets to the business component class of the business component that the applet references, and successively up through the business component class hierarchy to CSSBusComp
Summary of the Target and Business Service Properties
The following table summarizes the Target and Business Service properties.
Table Summary of Target and Business Service Properties
| Menu or Toolbar | Target Property | Business Service Property | Result |
|---|---|---|---|
Application menu or toolbar |
Server |
Contains a value |
The business service that the Business Service property defines determines the method handler that calls the service on the Siebel Server. It does not retarget. |
Does not contain a value |
Siebel CRM uses the method handler as the base functionality that it associates with an application object. |
||
Browser |
Contains a value |
The business service that the Business Service property defines determines the targets that Siebel CRM uses for the method. It does not retarget. |
|
Does not contain a value |
Siebel CRM targets to the method that the JavaScript application defines. It does not retarget. |
||
Applet menu |
Server |
Contains a value |
The business service that the Business Service Property defines determines the service that the method handler calls on the Siebel Server. It does not retarget. |
Does not contain a value |
The method handler is initially the applet class that the applet references. Siebel CRM retargets it successively up through the applet class hierarchy to the CSSSWEFrame class. If still not handled, then it retargets to the business component class of the business component that the applet references, and successively upwards through the business component class hierarchy to the CSSBusComp class. |
||
Browser |
Contains a value |
The business service that the Business Service Property defines determines the service that the method handler calls on the browser. It does not retarget. |
|
Does not contain a value |
Targets to the method that the JavaScript applet defines. If not handled, then retargets to the method that the corresponding JavaScript business component defines. No inheritance or more retargeting occurs. |
Configuring Menus and Toolbars
This topic describes how to configure menus and toolbars. It includes the following information:
Creating a Command Object
This topic describes how to create a command object. For more information, see About the Method, Business Service, and Target Properties of the Command Object.
To create a command object
In Siebel Tools, click the File menu, and then click New Object.
Click the Command icon, and then click OK.
In the Command dialog box, do the following:
Enter the project.
Enter a unique name for the command object.
Choose the browser or the Siebel Server to handle the method that the command calls.
Click Next.
In the next dialog box, do the following:
Choose the object that handles the command. If a business service handles the command, then choose the business service from the list. You must know if the business service is available for your choice of browser or for the Siebel Server.
Enter the method that the command calls. You must choose a method that is available to the business service or Siebel application.
Optional. Provide the argument that Siebel CRM sends to the method. The argument must be correct for the chosen method.
Click Next.
In the Window dimensions dialog box, do the following:
Specify to run or not run the command in a new browser window. If Siebel CRM runs the command in a new browser window, then define the height and width for the window.
Optional. Define the HTML bitmap and the tooltip text that Siebel CRM displays on the toolbar button that is associated with the command.
Click Next.
In the Command dialog box, review your entries.
If you must make any modifications, then click Back.
Click Finish.
Creating a New Toolbar
You can create a new toolbar for Siebel CRM.
To create a new toolbar
In Siebel Tools, display the Toolbar object type.
For more information, see Displaying Object Types You Use to Configure Siebel CRM.
In the Object Explorer, click Toolbar.
In the Toolbars list, add a new record.
Define the name of the new toolbar in the Name property.
Add a tag to the Container Page or to one of the child templates that you are using so that Siebel CRM can display the toolbar in the Siebel client.
For more information, see About the Container Page and Siebel Developer's Reference.
Adding a New Toolbar Icon to a Predefined Toolbar
You can add a new toolbar icon to a predefined toolbar.
To add a new toolbar icon to a predefined toolbar
In Siebel Tools, display the Toolbar object type and all child object types of the Toolbar object type.
For more information, see Displaying Object Types You Use to Configure Siebel CRM.
Verify that the bitmap image you must use for the toolbar icon currently exists as a child bitmap of the Command Icons bitmap category.
If it does not exist, then create a bitmap in this bitmap category. For more information, see Overview of Configuring Icons That Siebel CRM Displays in Siebel Clients. If it does exist, then note the name of the bitmap.
Verify that the method that this toolbar icon calls currently exists.
If the method that this toolbar icon calls does not exist, then do the following:
Add a Siebel Visual Basic or Siebel eScript script to the PreInvokeMethod.
Write an If or Case statement in the script that references MethodName. Write the instructions for that MethodName in the If or Case statement.
Modify the last line of PreInvokeMethod from ContinueOperation to CancelOperation.
Create a new command object:
In the Object Explorer, click Command.
In the Commands list, add a new command.
Define the required properties.
For more information, see Properties of a Command.
In the Object Explorer, click Toolbar.
In the Toolbars list, locate the toolbar where Siebel CRM must add the new toolbar item.
In the Object Explorer, expand the Toolbar tree, and then click Toolbar Item.
In the Toolbar Items list, add a new toolbar item, and then define the required properties.
You must use a button. You cannot use other types of elements, such as a combo box or label. For more information, see Properties of a Toolbar Item, and Article ID 517909.1 on My Oracle Support.
Activating Menu Items and Toolbars
Siebel CRM calls CanInvokeMethod for each item before it displays the menu or toolbar. If CanInvokeMethod returns FALSE, then Siebel CRM does the following:
Does not display the menu item or toolbar item.
Retargets CanInvokeMethod from the browser application to the applet class hierarchy that resides on the Siebel Server, and then to the business component class hierarchy.
For more information, see About the Method, Business Service, and Target Properties of the Command Object.
To activate menu items and toolbars
Use CanInvokeMethod to activate or deactivate the menu items that Siebel CRM displays in an application menu or applet menu, or the toolbar items that it displays in a toolbar in the Siebel client.
Creating an Applet Menu
You can modify an applet menu that comes predefined with Siebel CRM. You can create a custom applet menu. The Applet Method Menu Wizard allows you to modify an applet method menu. To create an applet method menu, Siebel CRM uses the menu items from the class where the applet belongs and the super class of the applet. It explicitly creates menu items for the applet. You can use the wizard to do the following:
Suppress inherited method menu items.
Resurrect inherited method menu items.
Create a new method menu item for an applet.
Delete a predefined method menu item of an applet.
To use the Applet Method Menu Wizard
In Siebel Tools, click the File menu, and then click New Object.
In the New Object Wizards dialog box, in the General Tab, click Applet Method Menu, and then click OK.
In the Applet Method Menu dialog box, do the following:
In the project window, choose the project that is defined in the Project property of the applet.
In the applet name window, choose the applet you must modify, and then click Next.
In the Applet Method Menu dialog box, do one of the following:
To display a menu item, move the item to the Selected Menu Items window.
To suppress display of a menu item, move it out of the Selected Menu Items Window.
Do one of the following:
Click Finish.
If you click Finish, then Siebel Tools saves all the modifications that you made to the Siebel repository, displays the object definition for the applet in the Applets list, and then exits this procedure.
Choose Create New Menu Item, and then click Next.
If you choose Create New Menu Item, then Siebel Tools replaces the Finish button with the Next button.
To create a new object definition for a method menu item, choose an entry from the Select the Command to be Executed by This Menu Item window.
In the Enter the Text to be Displayed for This Menu Item window, define the text to display for this method menu item, and then click Next.
Siebel Tools displays the Method Menu Item dialog box. You can examine the properties that you defined. Click Back to return to the appropriate dialog box to make a correction.
Click Create Menu Item to create the method menu item.
Siebel Tools creates the item.
Click Next.
Siebel Tools displays the method menu item you just defined in the Selected Menu Items window of the Applet Method Menu dialog box.
Click Finish.
Siebel Tools displays the Applet Layout.
To use the Applet Method Menu in Web Tools
Open your Workspace. To use Workspaces, see Using Siebel Tools.
Navigate to Settings and then to Object Explorer.
Select Applet and then click the Applet Method Menu Item.
In the Applets applet, query on required project.
Select the required applet from the search result.
In the Applet Method Menu Items applet, view details of selected applet.
To perform other functions on the Applet or its method item, use the applet menu in respective applet.
Activating or Suppressing an Applet Menu Item
You can modify an applet menu item that comes predefined with Siebel CRM. You can define a custom applet menu item. For an example, see the topic about defining a menu item to start a task UI in Siebel Business Process Framework: Task UI Guide.
You can activate or suppress individual applet menu items. You can use the configurations that this topic describes only for applet menus. You cannot use these configurations for application menus or for toolbars.
Siebel CRM includes some applet menu items in almost all applets, such as Copy, Edit, and Delete. It includes other applet menu items in almost all list applets, such as Columns Displayed. You can activate an applet menu to make a menu item available globally for applets of a class and subclass. You can then suppress it in applets where Siebel CRM must not display the menu item.
To activate or suppress an applet menu item
Do one of the following:
Set the Suppress Menu Item property in the class method menu item.
Use an applet method menu item.
Adding an Applet Menu Item
You can add a class method menu item for a predefined menu item for an applet class, but Siebel CRM does not include this menu item as an applet method menu item in an applet where the menu item must display. You can create an applet method menu item only in the following situations:
To add a menu item to the applet that the applet class does not already provide.
To suppress display of an applet menu item that the applet normally inherits. In this situation, you can do the following:
Create an applet method menu item object definition with the same name as the applet menu item you must suppress.
Make sure the Suppress Menu Item property contains a check mark.
Using JavaScript to Configure a Toolbar
You can configure a JavaScript toolbar or create a new JavaScript toolbar.
To use JavaScript to configure a toolbar
Create a JavaScript file.
You use this file to define a custom JavaScript toolbar class that is a subclass of JSSToolbar.
Copy the JavaScript file to the following directory on the Siebel Application Interface:
ORACLE_HOME\scriptsIn Siebel Tools, display the DLL object type and the Class object type.
For more information, see Displaying Object Types You Use to Configure Siebel CRM.
Create a DLL object:
In the Object Explorer, click DLL.
In the DLLs list, add a new record using values from the following table.
Property Value Name
Enter a name for the DLL object. For example,
BarcodeToolbar.Project
Choose a project that is currently locked in the Siebel Repository.
File Name
Enter the file name that references the JavaScript file. For example,
barcodeToolbar.js.
Create a Class object:
In the Object Explorer, click Class.
In the Classes list, add a new record using values from the following table.
Property Value Name
Enter the name of the class that is defined in the JavaScript file. For example,
JSSBarcodeToolbar.Project
Choose the project that you defined in Step 3.
DLL
Choose the name of the DLL object that you defined in Step 3.
High Interactivity Enabled
1
If you create a new toolbar, then create a Toolbar object.
Make sure you set the Class property to the class defined in the JavaScript file. For example, JSSBarcodeToolbar. For more information, see Creating a New Toolbar.
Add new toolbar items.
For more information, see Adding a New Toolbar Icon to a Predefined Toolbar.
If you create a new toolbar, then add a <div od-type="toolbar> tag to the appropriate web template.
Make sure you set the name property that you define in the <div od-type="toolbar> tag to the name of the Toolbar object that you created in Step 6. For more information, see Using Web Templates to Configure Toolbars.
Add <div od-type="toolbaritem> tags to the <div od-type="toolbar> tag.
For more information, see Using Web Templates to Configure Toolbars.
Configuring Icons
This topic describes how to configure icons that Siebel CRM displays in the Siebel client. It includes the following information:
Overview of Configuring Icons That Siebel CRM Displays in Siebel Clients
The following table describes the object types that Siebel CRM uses to display images in the Siebel client.
Table Object Types Siebel CRM Uses to Display Images
| Object Type | Description |
|---|---|
Bitmap |
Allows you to associate an image file, such as a GIF file or JPEG file, with a Siebel object, such as a button control or field. It fulfills the following roles:
A bitmap includes the following properties that Siebel CRM commonly uses:
You do not use the other properties of the bitmap with a Web image. Example properties include Data and Transparent Color. |
Bitmap Category |
Allows you to group image files together according to function. Includes the following bitmap categories:
|
HTML Hierarchy Bitmap |
Allows you to configure Siebel CRM to display an image in a hierarchical applet, such as a tree applet. |
Icon Map |
Allows you to configure Siebel CRM to display an image for a field value. Includes the child Icon object type. |
How Siebel CRM Handles Image Files
Siebel CRM handles image files differently, depending on the file type:
Imports BMP images into the Siebel repository. Sets the File Name field of the bitmap to read-only.
Stores GIF and JPG files in the
public\imagesfolder of your Siebel installation. The bitmap references these files. Does not store GIF and JPG files in the Siebel repository.
Siebel CRM only defines images that it associates with Siebel objects as bitmap objects in the Siebel repository. Example objects include icon maps, page tabs, and so on. It does not associate some images in web templates, such as static images, with Siebel objects. It does not define these images as bitmap objects in the Siebel repository. It defines these objects in the configuration file that it uses for the Siebel application.
The Siebel Web Engine (SWE) uses the HTML img tag to display a bitmap.
Displaying Object Types You Use to Configure Icons
You must display the object types that you use to configure icons in the Siebel client.
To display object types you use to configure icons
Display the following object types:
Bitmap Category
Child objects of the Bitmap Category
Icon Map
Child objects of the Icon Map
HTML Hierarchy Bitmap
For more information, see Displaying Object Types You Use to Configure Siebel CRM.
Configuring a Bitmap Category and a Bitmap
You can configure a bitmap category and a bitmap.
To configure a bitmap category and a bitmap
Display object types you use to configure icons.
For more information, see Displaying Object Types You Use to Configure Icons.
In Siebel Tools, in the Object Explorer, click Bitmap Category.
In the Bitmap Categories list, create a new bitmap category or choose a predefined bitmap category.
In the Object Explorer, expand the Bitmap Category tree, and then click Bitmap.
In the Bitmaps list, create a new bitmap using values from the following table.
Property Description Name
Enter the name of the bitmap.
Alt Text
Enter alternative text that Siebel CRM uses in place of the name property for a bitmap.
File Name
Do one of the following:
To create a bitmap for a BMP file, leave the File Name property empty.
To create a bitmap for a GIF file, enter the name of the image file in the File Name property. If the image resides in a subfolder of the image folder, then include this subfolder. For example, for an image named image.gif:
That resides in the
eapps/public/imagesfolder, set the File Name property toimage.gif.That resides in the
eapps/public/images/bttnsfolder, set the File Name property tobttns/image.gif.
Height
Enter the height of the bitmap, in pixels.
Width
Enter the width of the bitmap, in pixels.
If you must create a bitmap for a BMP file, then do the following:
Right-click the record in the Bitmaps list, and then click Import Bitmap.
In the Open dialog box, locate the BMP file that you must import, and then click Open.
Depending on the image you choose, Siebel Tools sets some properties, such as Height and Width. It imports the BMP file into the Siebel repository the next time you do a compile.
Displaying an Icon on a Button
To display an icon instead of text on a button, you can associate a bitmap object with a button control, similar to a Toolbar icon. Unlike a Toolbar icon, a bitmap button control is a command button in the applet. For example, the More/Less button uses a bitmap object with a button control. Siebel CRM displays the More/Less button in the second quadrant of many applets. The control uses the BTTNS_MORE bitmap object that is part of the HTML Control Icons bitmap category.
To display an icon on a button
Create a bitmap object.
For more information, see Configuring a Bitmap Category and a Bitmap.
In the Object Explorer, click Applet.
In the Applets list, locate the applet that contains the control you must modify.
In the Object Explorer, expand the Applet tree, and then click Control.
In the Controls list, locate the control you must modify.
Define properties for the control using values from the following table.
Property Description HTML Bitmap
Choose the bitmap object Siebel CRM must use if the button is active.
HTML Disable Bitmap
Choose the bitmap object Siebel CRM must use if the button is not active.
For more information, see About Applet Controls and List Columns.
Displaying an Icon as a Link
To display an icon as a link, you must make sure the properties are set correctly. Siebel CRM uses the contents of the Caption property of the control as the label for the link in the following situations:
The HTML Type property of the control is set to Button.
The HTML Bitmap and HTML Disabled Bitmap properties are not set.
To display an icon as a link
Perform the procedure described in Displaying an Icon on a Button, but make sure you set the HTML Type property of the control to Link.
Using Custom HTML Types with a Link
You can use the HTML Bitmap and HTML Disabled Bitmap properties with custom HTML types. If you use the following tag in the definition of the custom HTML type in the SWF (Siebel Web Format) file, then the Siebel Web Engine uses the bitmaps:
<div od-type="Data" type="Link">
These bitmaps must exist in the HTML Control Icons bitmap category.
Using Icons to Represent Values in a Field
An icon map is an object that allows you to represent the values that Siebel CRM displays in a control or list column as icons. Each icon map includes a collection of child icon objects. Siebel CRM associates these icon objects with the bitmap object that defines the image for the icon, and corresponds to a field value. The Icon Map property of a control or list column allows you to define the icon map that Siebel CRM uses to display the values in a field.
The example in this topic uses the Status list column on the Activity List Applet. Assume that the Status field can include the following values:
Not Started
In Progress
Done
You must configure the Status field to display an icon for each of these values.
If you must configure Siebel CRM to use a custom icon in a list applet, then you must size the icon according to the row font size that the list applet uses. For example, an eight point font is typical for Siebel CRM. If you use an eight point font, then the icon must be 23 pixels wide by 14 pixels high. If you modify the list applet row font size dynamically, or if you place an icon that is larger than 23 pixels by 14 pixels in a row, then Siebel CRM scrambles the list applet rows.
To use icons to represent values in a field
Create a bitmap category named Activity Status Icons.
For more information, see Configuring a Bitmap Category and a Bitmap.
In the Bitmaps list, create three new bitmap objects for each image that you must display using values from the following table.
Name File Name Not Started
notstarted.gif
In Progress
inprogress.gif
Done
done.gif
For more information, see Configuring a Bitmap Category and a Bitmap.
In the Object Explorer, click Icon Map.
In the Icon Maps list, create a new icon map named Activity Status.
In the Object Explorer, expand the Icon Map tree, and then click Icon.
In the Icons list, create three new icon objects for each field value using values from the following table.
Name Bitmap Category Bitmap Not Started
Activity Status Icon
Not Started
In Progress
Activity Status Icon
In Progress
Done
Activity Status Icon
Done
Note how you must set the following properties:
Name. Set to the name of the field value.
Bitmap Category. Set to the bitmap category that you must use for the field value.
Bitmap. Set to the bitmap object that you must use for the field value.
In the Object Explorer, click Applet, and then locate the Activity List Applet in the Applets list.
In the Object Explorer, expand the Applet tree, expand the List tree, and then click List Column.
In the List Columns list, query the Name property for Status.
Set the HTML Icon Map property to Activity Status.
This step configures Siebel CRM to use the icon map that you created in Step 3. For more information, see Using a Default Icon in an Icon Map.
Compile and test your modifications.
For more information, see Using Siebel Tools.
Using a Default Icon in an Icon Map
If you use icons to represent values in a field, then the Siebel Web Engine displays the image that the bitmap references if the field value matches one of the icons you define. If the field value does not match any of the icons you define, then the Siebel Web Engine uses text to display the actual field value.
You can create an icon named Default in an icon map. If the field value does not match any of the icons, then Siebel CRM uses the Default icon to represent values in the field. This feature is useful to create an icon that Siebel CRM uses if a field might contain different values, such as URLs.
To use a default icon in an icon map
Create or locate an icon map that contains only one icon, named Default.
For more information, see Using Icons to Represent Values in a Field.
Define the control or list column using values from the following table.
Property Description HTML Type
Set to URL.
HTML Icon Map
Set to an icon map that contains only one icon, named Default.
Configuring Icons in a Tree Applet
An HTML hierarchy bitmap is an object that defines the icons that Siebel CRM displays in a hierarchical object, such as a tree applet. To view an example, do the following:
In the Siebel client, click the Accounts screen tab, and then click the Explorer link.
Siebel CRM displays the tree portion of the Account Tree Applet. The HTML hierarchy bitmap defines the icons that Siebel CRM uses to represent the folders, the plus symbol, and the minus symbol in the Account Tree Applet.
You can configure other graphic elements in the tree applet. For more information, see Configuring the Graphic Elements of a Tree Applet.
To configure icons in a tree applet
Open Siebel Tools.
If an existing bitmap does not meet your requirements, then you must modify an existing or create a new bitmap.
The HTML hierarchy bitmap references bitmaps in a bitmap category. For more information, see Configuring a Bitmap Category and a Bitmap.
If an existing HTML hierarchy bitmap does not meet your requirements, then you must modify an existing or create a new HTML hierarchy bitmap.
You can specify the icons that an HTML hierarchy bitmap references. For more information, see Properties of an HTML Hierarchy Bitmap.
In the Object Explorer, click Applet.
In the Applets list, locate the applet that contains the tree you must modify.
In the Object Explorer, expand the Applet tree, and then click Tree.
In the Trees list, locate the tree you must modify, and then set properties for the tree using values from the following table.
Property Value HTML Hierarchy Bitmap
Enter the name of any HTML hierarchy bitmap.
To modify an object in a list, do Step 6 and Step 7 for a list object. For more information, see How Applet Objects Reference an HTML Hierarchy Bitmap.
Optional. Define the tree node.
The tree node object is a child of the tree object. It includes the optional HTML Open Bitmap and HTML Close Bitmap properties:
If you define these properties, then Siebel CRM uses them for the node where the properties are defined. This is useful if different nodes must display different icons.
If you do not define these properties, then Siebel CRM uses the Open Bitmap and Close Bitmap properties of the HTML Hierarchy Bitmap object.
For more information, see Configuring a Tree Applet.
Compile and test your modifications.
For more information, see Using Siebel Tools.
How Applet Objects Reference an HTML Hierarchy Bitmap
The tree and list objects are child objects of the applet object. They include the HTML Hierarchy Bitmap property. You can set this property to the name of any HTML hierarchy bitmap object. This allows different object definitions of the tree object and list object to share the same bitmaps.
A predefined tree applet references the bitmap objects that the following HTML hierarchy bitmap defines:
HTML Hierarchy Icons
Properties of an HTML Hierarchy Bitmap
The following table describes properties that Siebel CRM commonly uses with an HTML hierarchy bitmap.
Table Properties That Siebel CRM Commonly Uses With an HTML Hierarchy Bitmap
| Property | Description |
|---|---|
Name |
The name for the HTML hierarchy bitmap object. |
Collapse Bitmap, Collapse Elbow Bitmap, Collapse Tee Bitmap |
Icons to collapse a node. |
Expand Bitmap, Expand Elbow Bitmap, Expand Tee Bitmap |
Icons to expand a node. |
Elbow Bitmap, Tee Bitmap |
Icons to create an elbow (L) or a Tee (T). |
Bar Bitmap |
Icon to create a vertical line. |
Space Bitmap |
Icon to create an indent. |
Open Bitmap |
Icon for a node that Siebel CRM displays in an expanded state. |
Close Bitmap |
Icon for a node that Siebel CRM displays in a collapsed state. |
Leaf Bitmap |
Icon for a leaf node. |
Arrow Down Bitmap, Arrow Up Bitmap |
Icons to scroll a tree up or down. |