Siebel Tools Reference > Logical User Interface Objects Configuration > Defining Toolbars and Menus >

Configuring Keyboard Accelerators


Keyboard accelerators are implemented using the command architecture. They are configured in Siebel Tools using the Accelerator object, which is a child of the Command object. Since accelerators are mapped directly to commands, the scope of the actions represented may be specific to the currently active applet, or it may apply to the application session as a whole. For example, an accelerator to initiate a new query will have specific focus on the current applet, while an accelerator to invoke the Site Map page is independent of the current application context.

Commands must be loaded into the active menu structure at runtime in order to be available. This means that the command represented by each accelerator must be available to the user at a given point in time for the associated keyboard accelerator to be active. For a command to be available to the user, it must be associated with either the application menu or the applet-level menu for the currently active applet. If the command for a particular accelerator should not be visible to the user on the application menu and/or the current applet menu, the command can be defined as hidden in Siebel Tools.

To modify the Key Sequence for an accelerator

  1. Navigate to the Commands object in the Object Explorer view.
  2. Identify and highlight the command to modify.
  3. Select the accelerator that you want to modify (Accelerator is a child object of the Command object).
  4. Modify the Key Sequence property for the accelerator.
  5. See Design Considerations.

  6. Compile and check-in the project.

To add an accelerator

  1. Make sure the action to be performed by the accelerator is represented by a command in the Siebel Repository. If not, you must be add one.
  2. Make sure the command to be mapped to the new accelerator is included as part of the active menu hierarchy, at either the application or applet level, for the application contexts in which the accelerator will be active.
  3. Navigate to the Commands object in the Object Explorer view.
  4. Select the command that you want to modify.
  5. Expand the Command object type, and then select the Accelerator child object.
  6. Add a new record.
  7. Specify the key sequence.
  8. Specify the display name to be associated with the accelerator.
  9. In the Platform field, specify the keyboard enablement mode or modes for which this accelerator will be active.
  10. Compile and check-in the project.

NOTE:  Keyboard accelerators for commands related to the Siebel Communications Server are configured through administrative screens in the application. They are not compiled in the Siebel Repository File using Siebel Tools. Any such accelerators defined through the Siebel Communications Server administrative screens will take precedence over accelerators defined in the Siebel Repository File for identical key sequences. For more information, see Siebel Communications Server Administration Guide

Design Considerations

Key sequences that resemble the underlying command are useful since they help the user remember the accelerator (for example, "Ctrl+N" for "New Record"). However, it can be beneficial to keep several design considerations in mind to help maximize productivity gains when adding or modifying keyboard accelerators.

For applications running extended mode keyboard enablement, take care not to override native browser functionality that the user community uses regularly. For example, "Ctrl-C" copies a text string to the clipboard in Microsoft Internet Explorer 5.5. This could be a useful feature within the Siebel application browser environment for managing text.

Keep related accelerators grouped as much as possible in terms of mapped key sequences. For example, mapping key sequences that all start with "Ctrl+Alt..." for query management functions can assist users in remembering related accelerators.

Take care not to map frequently used commands to key sequences that are similar to those of commands with severe results. For example, mapping a frequently used command to "Ctrl+Alt+X" may lead to unwanted accidental logouts for users if the "Logout" command is mapped to "Ctrl+Shift+X".

Keyboard accelerators for commands related to the Siebel Communications Server are configured through administrative screens in the application. They are not compiled in the Siebel Repository File using Siebel Tools. Any such accelerators defined through the Siebel Communications Server administrative screens will take precedence over accelerators defined in the Siebel Repository File for identical key sequences.

For more information about Keyboard Accelerators, see Applications Administration Guide


 Siebel Tools Reference, Version 7.5, Rev. A 
 Published: 18 April 2003