6Configuring User Interface Elements
Configuring User Interface Elements
This chapter provides information about configuring user interface elements for communications features. It includes the following topics:
About Communications Panel and Communications Toolbar Configuration
This topic describes how the communications toolbar is displayed within the communications panel, explains how the communications toolbar buttons relate to commands defined for the communications configuration, and provides information about modifying the communications toolbar for your agents.
This topic contains the following information:
About the Communications Panel and Communications Toolbar Display
Enabling the Communications Panel for Applications and Agents
For information about enabling communications activities through the communications toolbar, see Enabling Session Communications.
For information about using the communications toolbar, see Using the Communications Toolbar.
The communications toolbar is defined and configured, in part, within Siebel Tools, like other toolbars in the Siebel applications. Within Siebel Tools, the Communication toolbar object definition contains, or is linked to, a series of other object definitions, including toolbar items, commands, and bitmaps.
These object definitions, combined with associated business service methods, communications commands, and icons specified in cascading style sheet (CSS) files, determine the functioning and appearance of the communications toolbar for your agents.
Customers can customize the appearance of the communications toolbar. For more information, see Modifying the Appearance of an Existing Toolbar Button.
The communications toolbar connects to the Siebel application interface using HTTP. Toolbar functions are determined by communications events and commands, which interact with communications drivers loaded by the Communications Session Manager component. Communications between the driver and applicable middleware is subject to the implementation of the driver.
For more information about configuring object definitions for toolbars, toolbar items, commands, and bitmaps, see the developer documentation on the Siebel Bookshelf.
Related Topics
Modifying the Communications Toolbar
Related Books
Configuring Siebel Business Applications
Configuring Siebel Open UI
Using Siebel Tools
Siebel Developer's Reference
Siebel Fundamentals Guide
About the Communications Panel and Communications Toolbar Display
The communications toolbar appears by default at the start of a panel on the side of the Siebel application display area. This panel, which is called the communications panel, can be accessed by clicking the communications icon on the menu toolbar in the Siebel client.
In addition to the communications toolbar, the communications panel also includes the customer dashboard and the chat panel. Whether each of these elements appears within the communications panel is subject to the existing mechanisms that control the display of these elements. For example, the communications toolbar and the chat panel appear if the user is defined as an agent in an applicable communications configuration. The dashboard appears for all agents.
Agents can modify the display of the entire communications panel. In addition to being able to hide or display the panel, agents can dock the panel or undock the panel for a floating display, choose the dock location for the panel, or choose a wide or narrow display for the panel.
Within the communications panel, agents can modify the display of each element, such as the communications toolbar. Options include displaying more or less of the toolbar.
Developers can modify the display of the communications panel and its elements. For example, by modifying the applicable style sheet, they can modify which items appear when an agent displays more or less of the toolbar. Or, by modifying the Siebel web template CCFrameContentHI, they can modify the order of the elements within the communications panel.
Related Topics
Enabling the Communications Panel for Applications and Agents
Modifying the Communications Toolbar
Integrating with the Customer Dashboard
Displaying the Communications Panel and the Communications Toolbar
Related Books
Configuring Siebel Open UI
Siebel Chat Guide
Siebel Fundamentals Guide
Enabling the Communications Panel for Applications and Agents
For many of the Siebel CRM applications, such as Siebel Call Center, the communications panel is already configured to display for agents in the manner described in About the Communications Panel and Communications Toolbar Display.
The communications panel is defined as a view named Communication Panel View. If an application that your agents will use does not already have Communication Panel View associated with the screen CommSrv Administration Screen, then you must create this association in Siebel Tools. Then deploy the Siebel runtime repository to all applicable servers. For more information about these activities, see documentation for Siebel Tools.
Also, for an agent to be able to see the communications panel, one of the agent’s responsibilities must include the view Communication Panel View. If necessary, update all applicable responsibilities to include this view. For information about working with responsibilities, see Siebel Security Guide.
Related Topic
About the Communications Panel and Communications Toolbar Display
Related Books
Configuring Siebel Business Applications
Using Siebel Tools
Siebel Security Guide
Communications Toolbar Items, Commands, and Methods
The following table displays information about elements associated with the communications toolbar items. Starting from first column, the table displays each toolbar item name, the associated Siebel Tools command name, and the business service method associated with the command (where applicable).
The methods listed in the following table are those of the Communications Client business service. The Default column indicates whether the toolbar button appears in the toolbar by default. An asterisk (*) indicates that the button is part of a submenu. Each business service method name also corresponds to the name of a communications command. Communications configurations provided with Siebel Business Applications include commands with these names. For more information about these commands, see Commands.
Table Communications Toolbar Items, Commands, and Methods
Toolbar Item | Tools Command (Display Name) | Business Service Method Or Communications Command | Default |
---|---|---|---|
Accept Email |
Accept Incoming Email |
AcceptEmailGroup |
Yes* |
Accept Misc Work |
Accept Miscellaneous Work Item |
AcceptMiscWorkGroup |
No* |
Accept Phone |
Answer Phone Call |
AnswerCallGroup |
Yes* |
Accept Work |
Accept Work Item |
AcceptWorkGroup |
Yes |
Blind Transfer |
Blind Transfer Work Item |
BlindTransferGroup |
Yes |
Consultive Conference |
Consultative Conference Work Item |
ConferenceTransferGroup |
Yes |
Consultative Transfer |
Consultative Transfer Work Item |
ConsultativeTransferGroup |
Yes |
Forward Work |
Forward Work Item |
ForwardWorkGroup |
Yes |
Hold Work |
Hold Work Item |
SuspendWorkGroup |
Yes |
Initiate Email |
Initiate Email |
SendEmailGroup |
Yes* |
Initiate Fax |
Initiate Fax |
SendFaxGroup |
Yes* |
Initiate Phone |
Initiate Phone Call |
MakeCallGroup |
Yes* |
Initiate SMS |
Initiate SMS |
SendSMSGroup |
Yes* |
Initiate Work |
Initiate Work Item |
InitiateWorkGroup |
Yes |
InQueue Time |
InQueue Time |
Not applicable |
Yes |
Media Indicator |
Media Indicator |
Not applicable |
Yes |
Not Ready |
Not Ready State |
NotReadyGroup |
Yes |
Not Ready Email |
Not Ready for Email |
NotReadyForEmailGroup |
Yes* |
Not Ready Phone |
Not Ready for Phone |
NotReadyForPhoneGroup |
Yes* |
Release Work |
Release Work Item |
ReleaseWorkGroup |
Yes |
Resume Work |
Resume Work Item |
ResumeWorkGroup |
Yes |
Retrieve Work |
Retrieve Work Item |
RetrieveWorkGroup |
Yes |
SignOff |
Communication Sign Off |
SignOffGroup |
Yes |
SignOn |
Communication Sign On |
SignOnGroup |
Yes |
Work Item List |
Work Item List |
WorkItemList |
Yes |
Working Time |
Not applicable |
Not applicable |
Yes |
Communications Toolbar Commands and Bitmaps
The following table displays the names of the bitmap object definitions that are associated with the Siebel Tools commands for the communications toolbar items. Starting from first column, the table displays the same Siebel Tools command names shown in the previous table, the name of the bitmap object definition specified for HTML Bitmap, and the name of the bitmap object specified for HTML Disabled Bitmap. HTML Bitmap is for controls in an enabled state, while HTML Disabled Bitmap is for controls in a disabled state.
As noted in Modifying the Appearance of an Existing Toolbar Button, the toolbar icons are also specified in the CSS file. To use custom icons, you create a custom CSS file for this purpose.
As noted, the following table displays the names of the bitmap object definitions that are associated with the Siebel Tools commands for the communications toolbar items.
Table Communications Toolbar Commands and Bitmaps
Tools Command (Display Name) | HTML Bitmap | HTML Disabled Bitmap |
---|---|---|
Accept Incoming Email |
Comm Email |
Comm Email Disabled |
Accept Miscellaneous Work Item |
Comm Misc Work |
Comm Misc Work Disabled |
Accept Work Item |
Comm Accept Work |
Comm Accept Work Disabled |
Answer Phone Call |
Comm Phone |
Comm Phone Disabled |
Blind Transfer Work Item |
Comm Blind Transfer |
Comm Blind Transfer Disabled |
Communication Sign On |
Comm SignOn |
Comm SignOn Disabled |
Communication Sign Off |
Comm SignOff |
Comm SignOff Disabled |
Consultative Conference Work Item |
Comm Consultive Conference |
Comm Consultive Conference Dis |
Consultative Transfer Work Item |
Comm Consultive Transfer |
Comm Consultive Transfer Disab |
Forward Work Item |
Comm Forward Work |
Comm Forward Work Disabled |
Hold Work Item |
Comm Hold Work |
Comm Hold Work Disabled |
Initiate Email |
Comm Email |
Comm Email Disabled |
Initiate Fax |
Comm Fax |
Comm Fax Disabled |
Initiate Phone Call |
Comm Phone |
Comm Phone Disabled |
Initiate SMS |
Comm SMS |
Comm SMS Disabled |
Initiate Work Item |
Comm Initiate Work |
Comm Initiate Work Disabled |
InQueue Time |
Comm InQueue Time |
Comm InQueue Time |
Media Indicator |
Comm Phone |
Comm Phone |
Not Ready for Email |
Comm Email |
Comm Email Disabled |
Not Ready for Phone |
Comm Phone |
Comm Phone Disabled |
Not Ready State |
Comm Not Ready |
Comm Not Ready Disabled |
Release Work Item |
Comm Release Work |
Comm Release Work Disabled |
Resume Work Item |
Comm Resume Work |
Comm Resume Work Disabled |
Retrieve Work Item |
Comm Retrieve Work |
Comm Retrieve Work Disabled |
Work Item List |
Not applicable |
Not applicable |
Modifying the Communications Toolbar
This topic describes how to modify the communications toolbar. It contains the following information:
In implementing Siebel Communications Server, you can modify communications toolbar functionality in several ways. Several types of modifications that might apply to your implementation are described in the linked topics.
For more information about configuring the communications toolbar in Siebel Tools, see the developer documentation on the Siebel Bookshelf.
Related Topic
About the Communications Panel and Communications Toolbar Display
Related Books
Configuring Siebel Business Applications
Configuring Siebel Open UI
Using Siebel Tools
Siebel Developer's Reference
Modifying the Function of an Existing Toolbar Button
You can modify the function of an existing communications toolbar button in several different ways. You can:
Change which communications command an existing communications toolbar button invokes
Change which device command an existing communications toolbar button invokes
Change which business service method an existing communications toolbar button invokes
Modifying Communications Command for Existing Toolbar Button
If you created a command in the communications configuration and you want a communications toolbar button to invoke this communications command instead of an existing command, then rename your commands so that the new command uses the name of the command that is currently associated with the toolbar button.
Renaming commands in the communications configuration has less impact on an upgrade effort than modifying object definitions in Siebel Tools.
Renaming commands in the communications configuration can be used whether you are only implementing a custom command or you are both implementing a custom command and invoking a device command supported by a custom communications driver, as described in Modifying Device Command for Existing Toolbar Button.
For more information about communications commands, see Commands.
Modifying Device Command for Existing Toolbar Button
If you are using a custom communications driver, created using the Adaptive Communications API, in order to extend or replace the functionality of a driver provided with Siebel Business Applications, then you can reuse the existing communications toolbar configuration, and you can reuse existing commands from the configuration data provided with Siebel Business Applications. Of course, you can also create new communications commands, as described earlier in this topic.
If your communications driver supports different device command names than do the drivers provided with Siebel Business Applications, then specify your own driver’s device commands in your communications commands. Alternatively, for commands that do not specify a device command and do not execute something else such as a business service method or script, the application attempts to execute a device command with the same name as the communications command. For more information about device commands, see Commands. For more information about Adaptive Communications, see Developing a Communications Driver.
Modifying Business Service Method for Existing Toolbar Button
If you have created a custom business service, and you want an existing communications toolbar button to invoke a method for this service, then you must use Siebel Tools to modify the command object definition that is associated with the toolbar item, to specify the new business service and method. This approach is of limited practical value, however, because you can customize the function of a button without using Siebel Tools.
For more information about how business service methods are specified for the toolbar buttons, see Communications Toolbar Items, Commands, and Methods.
Modifying the Appearance of an Existing Toolbar Button
Customers can customize the appearance of the communications toolbar. To do this, customers must create their own customized CSS file in which custom icons are specified and then associate this CSS file to the application theme for which these customizations are to be enabled. For more information about performing this type of customization, see Configuring Siebel Open UI.
Moving, Adding, or Removing a Toolbar Button
You can customize the communications toolbar to add a new toolbar button or to remove an existing button. You can:
Move a toolbar button or other control on the communications toolbar
You can move a toolbar control, in relation to other controls, by modifying the value of the Position field for the applicable toolbar item in Siebel Tools.
Remove a toolbar button or other control from the communications toolbar
You can prevent a control from appearing in the communications toolbar by setting the Inactive flag to True for the applicable toolbar item in Siebel Tools.
Add a new button to the communications toolbar
If you add a new toolbar button to the communications toolbar, then you must also add, or reuse, all associated object definitions in Siebel Tools and images specified in the applicable CSS file. The scope of what you have to do depends on the purpose of the new button.
Communications Toolbar Buttons and Commands
This topic provides an overview of the following:
How communications commands are invoked from the communications toolbar
About command parameters that affect toolbar commands
About how group commands function to support the communications toolbar, especially in a multichannel environment
This topic contains the following information:
How Communications Toolbar Buttons Work
When an agent clicks a communications toolbar button, the Siebel client attempts to execute a command, corresponding to the method name, from the communications configuration.
If no matching command is found, then the communications driver (a profile for which is associated with the configuration) that supports a device command with the same name as the method executes that device command.
If a command invokes a subcommand, business service method, or script, then it does not have to execute a device command. All other commands generally execute a specified device command.
A communications command executing a device command can be explicitly associated with a profile for the driver that supports that device command. This can help to avoid possible collisions where the same device command is supported by multiple drivers and can also help the administrator to keep track of the intended functions of commands in a complex, multichannel environment.
For more information about the DeviceCommand parameter, see Command Parameters. For available device commands that might apply to your deployment, see Special Commands for Device Commands.
Command Parameters Affecting Communications Toolbar Buttons
The presence and visual appearance of items in the communications toolbar are determined in part by a set of related command parameters defined for the communications commands that are accessible through the toolbar:
Description. Provides the text to be displayed as ToolTip text for the toolbar button for the command. Many references to toolbar buttons by name are based on the ToolTip text specified with this parameter. For more information, see ToolTip Text for the Communications Toolbar.
Hidden. Although this parameter has no direct effect on the communications toolbar, it is typically set to True for a command that is to appear in the communications toolbar (and that is not to appear in the Communications submenu).
LocalMenu. Although this parameter has no direct effect on the communications toolbar, it is typically set to False, or omitted from the command, for a command that is to appear in the communications toolbar (and that is not to appear in the applet-level menu).
For more information about these parameters, see Command Parameters Affecting Communications Menu Items and Command Parameters.
Communications Group Commands in the Communications Toolbar
In the communications configurations provided with Siebel Business Applications, commands whose names end in Group are commands that can contain several subcommands. Most of the communications toolbar buttons invoke group commands. A group command can invoke another group command.
When a group command is executed, such as might occur when the user clicks the associated toolbar button, one of its subcommands is typically invoked, based on the current context. Alternatively, you can configure a group command to execute all subcommands, where this is appropriate. The order that you specify for each subcommand determines the sequence in which the subcommands are checked to find one that matches the context. For more information about group commands and subcommands, see Hierarchical Commands (Commands and Subcommands).
ToolTip Text for the Communications Toolbar
The ToolTips displayed when the agent points to a communications toolbar button are usually derived from the command in the communications configuration. They might also be obtained from the communications driver, or from the associated command object definition in Siebel Tools.
The ToolTip text is derived in this fashion:
For the communications command (which might be a subcommand of another command) that the toolbar button represents, the value of the command parameter Description is used as the ToolTip text. Obtaining text from the context-appropriate subcommand allows the ToolTip text itself to vary by context. For the MakeCallToContact command, for example, Make Call to Contact is the ToolTip text.
If the command parameter Description is not used for the communications command that the toolbar button represents, then any ToolTip text defined in the communications driver for the associated device command is used. Such text might also be context-sensitive, depending on the driver implementation.
Note: In order to update the description of a device command, a driver must use the client handle method CacheCommandInformation. In turn, this description is used for the ToolTip text.If neither of the previous two sources provides ToolTip text, then any ToolTip text is used that is defined for the command object definition in Siebel Tools. Such text cannot be context-sensitive, because only a single string is defined for the toolbar button.
Communications drivers and configurations provided with Siebel Business Applications provide ToolTip text. If you use such a driver, then ToolTip text derived from Siebel Tools is not used.
Configuring Communications Menu Commands
This topic contains the following information:
Describes the Communications submenu and communications commands in the applet-level menu
Explains how items in these menus relate to commands defined for the communications configuration
Provides instructions and guidelines for modifying communications menu commands:
For information about using the communications menu commands, see Using Communications Menu Commands.
Command Parameters Affecting Communications Menu Items
The presence and visual appearance of items in the Communications submenu and applet-level menu are determined by a set of related command parameters defined for the communications commands that are to appear in the affected menus. For more information, see Command Parameters.
The following list describes the command parameters:
Hidden. Set to False, or omitted from the command, for a command to appear in the Communications submenu. Set to True for a command that is intended to appear in the applet-level menu or the communications toolbar, or that is not to appear directly in the user interface.
HotKey. Specifies the key combination that serves as a keyboard accelerator for the command’s menu item.
Keyboard shortcuts defined for communications commands do not use as input any data entered into the text entry field in the communications toolbar.
Note: If you specify keyboard shortcuts, using the HotKey parameter, that conflict with keyboard shortcuts specified in Siebel Tools, then these shortcuts take precedence over the shortcuts from Siebel Tools for the agent’s session.HotKeyText. Specifies locale-dependent text to represent the keyboard accelerator for the command’s menu item. The keyboard accelerator itself is specified using the HotKey parameter. This locale-dependent text appears in the Communications submenu.
LocalMenu. Set to True for a command to appear in the applet-level menu. Set to False, or omitted from the command, for all other commands.
MenuPosition. Specifies the position of the command’s submenu item, relative to the other submenu items in the Communications submenu, or the position of the command’s menu item relative to other menu items in the applet-level menu. This parameter supports multiple menu levels.
Title. Provides the text of the command’s menu item in the Communications submenu or in the applet-level menu.
Communications Group Commands in Menus
In the communications configurations provided with Siebel Business Applications, the commands whose names end in GroupInMenu or GroupInLocalMenu might specify several subcommands, one of which is invoked when the menu item is chosen, based on the current context.
The order specified for each subcommand determines the sequence in which the subcommands are checked to find one that matches the context.
The GroupInMenu commands are for the Communications submenu, and the GroupInLocalMenu commands are for the applet-level menu.
For example, MakeCallGroupInLocalMenu has several subcommands defined, each of which specifies another command, such as MakeCallToAccount, MakeCallToContact, and so on. When the agent chooses Make Call in the applet-level menu, one of these subcommands is invoked, according to the current context.
If the agent is viewing a contact record, for example, then Contact is the current business component. Because this business component is specified in the command data defined for MakeCallToContact, a match is found in this command.
For more information about group commands and subcommands, see Hierarchical Commands (Commands and Subcommands).
Communications Menu Items and Device Commands
When an agent chooses a communications command from the Communications submenu or the applet-level menu, the corresponding command is executed from the communications configuration. The communications driver (a profile for which is associated with the configuration) that supports the device command specified for the communications command executes that device command.
If a command invokes a subcommand, business service method, or script, then it need not execute a device command. All other commands generally execute a specified device command.
A communications command executing a device command can be associated with a profile for the driver that supports that device command. This can help to avoid possible collisions where the same device command is supported by multiple drivers and can also help the administrator to keep track of the intended functions of commands in a complex, multichannel environment.
For more information about the DeviceCommand parameter, see Command Parameters. See also Special Commands for Device Commands.
Configuring Communications List of Values Types
This topic describes how to configure communication List of Values types. It contains the following information:
Records defined for various List of Values types determine what values can be selected in certain fields (drop-down lists) in the Administration - Communications screen.
List of Values records of the same type and, where applicable, with the same Parent LIC (Language-Independent Code) value are listed together in particular drop-down lists. A List of Values record must also be set to Active in order to appear in the user interface.
Typically, List of Values records provided with Siebel Business Applications serve your needs without alteration. However, depending on your implementation, you might have to include custom content in a particular List of Values. To include custom content, you add a List of Values record, or modify an existing List of Values record to change its display value.
In particular, if you are implementing a custom communications driver, then you must create records for several List of Values types.
Some of the List of Values types for which you can provide your own values are described in the topics that follow. Your deployment might require you to add or modify records for additional List of Values types that are not described in this chapter.
To add or modify List of Values records, you use the Administration - Data screen and the List of Values Explorer and List of Values views.
List of Values Type for Channel Type
This topic identifies the List of Values type for specifying the channel type for communications drivers.
If the available communications channel types do not meet your needs for your communications drivers, and you want to add or modify channels, then you must add or modify records to include the values that you require. The applicable List of Values type is COMM_MEDIA_TYPE. The Parent LIC value is set to COMM for values to be displayed only in the Channel Type field in the Communications Drivers applet (in the Communications Drivers and Profiles view in the Administration - Communications screen). For more information about defining drivers, see Configuring Communications Drivers and Profiles.
List of Values Type for ACD Queues
If you are supporting the voice channel (using Siebel CTI), and supporting ACD queues for your agents, then you might require particular values to appear in the ACD Queue field in the ACD Queues applet. The ACD Queues applet appears in the Agent General Profile view, in the Administration - Communications screen.
To specify your custom values, add or modify records for the List of Values type named CTI_ACD_QUEUES. For more information about specifying agents and ACD queues, see Specifying Agents.
List of Values Type for Reason Code
If you are supporting reason codes for your call or contact center agents to specify when they are not ready to receive communications work items, then you might require particular values to appear in the applet Transfer Multiple LOV Popup Applet. This applet appears when agents specify the Not Ready state for any or all supported communications channels. By default, this applet is multiselect enabled.
To specify your custom values, add or modify records for the List of Values type named REASON_CODE. For more information about how agents specify the Not Ready state, see Using the Communications Toolbar.
List of Values Types for Event Parameters
This topic identifies List of Values types for parameters for event handlers, event responses, and event logs.
For more information about specifying events, see Defining Communications Events.
List of Values Type for Event Handler Parameters
If you use a custom communications driver, then you require particular values to appear in the Name field (drop-down list) in the Event Handler Parameters applet. This applet appears in the All Event Handlers view, in the Administration - Communications screen.
To specify your custom values, add or modify records for the List of Values type named COMM_EVTHNDLR_PARAM.
List of Values Type for Event Response Parameters
If you use a custom communications driver, then you require particular values to appear in the Name field (drop-down list) in the Event Response Parameters applet. This applet appears in the All Event Responses view, in the Administration - Communications screen.
To specify your custom values, add or modify records for the List of Values type named COMM_EVTRESP_PARAM.
List of Values Type for Event Log Parameters
If you use a custom communications driver, then you require particular values to appear in the Name field (drop-down list) in the Event Log Parameters applet. This applet appears in the All Event Logs view, in the Administration - Communications screen.
To specify your custom values, add or modify records for the List of Values type named COMM_EVTLOG_PARAM.
List of Values Types for Command Parameters
This topic identifies List of Values types that parameters for commands and command data use.
For more information about specifying commands, see Defining Communications Commands.
List of Values Type for Command Parameters
If you use a custom communications driver, then you require particular values to appear in the Name field (drop-down list) in the Command Parameters applet. This applet appears in the All Commands view, in the Administration - Communications screen.
To specify your custom values, add or modify records for the List of Values type named COMM_CMD_PARAM.
List of Values Type for Command Data Parameters
If you use a custom communications driver, then you require particular values to appear in the Name field (drop-down list) in the Command Data Parameters applet. This applet appears in the All Command Data view, in the Administration - Communications screen.
To specify your custom values, add or modify records for the List of Values type named COMM_CMDDATA_PARAM.