Return to Navigation

Understanding the Configurable Toolbar

This section discusses:

There are four parts to the configurable toolbar:

  • Date Time/Time zone/History/Title area.

  • Button bar.

  • Component-specific data.

  • Toolbar footer.

  • Subtabs.

History, Time Zone, and Title Area

The History and time zone drop-down list boxes, along with the page title, are presented at the top of the content area. Like the other tool bar elements, they are not required. This area can include the following elements:

  • Time zone controls

    This includes current date and time information and a time zone selection field to display the date and time in various time zones.

  • History controls

    This contains a list of previously viewed pages (from external components only), so that you can revisit them if necessary. To support the history control and be able to add the current transaction to the navigation history prior to performing a component transfer, specific code must exist on the previous component.

  • Page title

    The page title, if enabled, is shown left-aligned on top of the toolbar buttons. If either the History or time zone field is enabled for the toolbar definition, it appears right-aligned on the same level as the page title. If both are enabled, the time zone field appears at the same level as the page title and beneath the History field.

Button Bar

The button bar is similar to a browser's toolbar. It can include the following elements:

  • PeopleTools actions

    This includes buttons such as Save, Refresh, Add, Next in List, Previous in List, Return to Search, and Update/Display, which map to the corresponding buttons (which are available at the bottom of a page) that are defined in PeopleTools.

  • Custom actions

    This includes buttons that perform application-specific actions, such as cloning a case. Often, clicking a custom button displays a page on which you complete the action.

  • The Personalize action

    This enables users to reconfigure the buttons on the button bar.

You can choose which toolbar elements to display and, for PeopleTools and custom actions, you can define their appearance sequence. There are two kinds of toolbar buttons: primary and secondary. Primary toolbar buttons are orange-colored, rectangular buttons with text label on them. They always appear on the left of the toolbar, and cannot be hidden through user personalizations. Secondary toolbar buttons, on the other hand, can be configured to show only the button icon, the text label, or both. End users can hide secondary toolbar buttons through personalizations, if the buttons are configured to support this functionality in the toolbar definition.

Also, you can modify the delivered toolbar buttons' definitions, or you can create new toolbar buttons using application classes.

See Toolbar Definition - Description Page, Toolbar Definition - Buttons Page.

Component-Specific Data

Under the button bar, the toolbar displays summary information about the object that you are viewing. For example, the Case toolbar shows summary information about the current case. PeopleCode in the underlying component makes this information available.

When you configure a toolbar, you choose which and how summary data appear.

Toolbar Footer

If a page is too long to be displayed in a single browser window and you need to scroll to see the entire page, you can add a toolbar footer so that toolbar buttons are also available when users are at the bottom of the page. The toolbar footer is the same as the toolbar button area at the top of the page. One exception is that the footer has the Top of Page link instead of a Personalize link as you see in the header. When you click the right or left arrow for more buttons in either direction, the other toolbar shifts at the same time.

If you use display templates to render component pages, you can initialize the toolbar from the display template by referencing the toolbar definition ID in it (optional).

Subtabs

If you plan to use subtabs in pages, which are rendered by the toolbar framework, you need to define them in display templates. Subtabs are used to control the visibility of group boxes at the page level. For example, you can define subtabs in the Order component in such a way that a user who is completing an order form can jump easily from the billing section on the entry page to the interaction history section on the history page by selecting the section name from the Go To drop-down list box.

Subtabs that appear on CDM pages are not set up using the display template framework.

See Understanding Display Templates.

To obtain a list of toolbars that the PeopleSoft Customer Relationship Management (CRM) system delivers, and to identify the components, pages, and markets (global or industry-specific) that use them, go to the Toolbar Definition component and click Search without entering search criteria. The system displays all delivered toolbars on the Search Results list.

To review the buttons and display items that are available for use in toolbars, access the Toolbar Button Definition - Buttons page and the Toolbar Content Display Definition page of the selected toolbar definition.

The following list identifies many of the delivered buttons that are used across multiple PeopleSoft CRM applications. The buttons are listed alphabetically. Some icons are used for more than one button.

Note: The Add, Update, Return to Search, Next in List, and Previous in List functions are each associated with two buttons. The button with the RB prefix is used in components that use the configurable search, while the button with the PT prefix is used in components that use the standard PeopleTools search.

Note that clicking the Previous or Next button from a component takes you to the previous or next component record based on the last search result, regardless of any sorting that you may have performed to the result list.

Field or Control

Definition

PT_ADD (Add) icon PT_ADD (Add)

This is mapped to the Add button in PeopleTools.

PT_CORRECTION (Correct History) icon PT_CORRECTION (Correct History)

This is mapped to the Correct History button in PeopleTools.

PT_NEXT_IN_LIST (Next in List) icon PT_NEXT_IN_LIST (Next in List)

This is mapped to the Next in List button in PeopleTools.

PT_NEXT_PAGE (Next Page in Component) icon PT_NEXT_PAGE (Next Page in Component)

This is mapped to the Next Page button in PeopleTools.

PT_PREV_PAGE (Previous Page in Component) icon PT_PREV_PAGE (Previous Page in Component)

This is mapped to the Previous Page button in PeopleTools.

PT_PREVIOUS_IN_LIST (Previous in List) icon PT_PREVIOUS_IN_LIST (Previous in List)

This is mapped to the Previous in List button in PeopleTools.

PT_REFRESH (Refresh) icon PT_REFRESH (Refresh)

This is mapped to the Refresh button in PeopleTools.

PT_RETURN_TO_SEARCH (Return to the Search Page) icon PT_RETURN_TO_SEARCH (Return to the Search Page)

This is mapped to the Return to Search button in PeopleTools.

PT_SAVE (Save) icon PT_SAVE (Save)

This is mapped to the Save button in PeopleTools.

PT_SPELLCHECK (Spell check) icon PT_SPELLCHECK (Spell check)

This is mapped to the Spell Check button in PeopleTools.

PT_UPDATE (Update/Display) icon PT_UPDATE (Update/Display)

This is mapped to the Update/Display button in PeopleTools.

PT_UPDATE_ALL (Update/Display All) icon PT_UPDATE_ALL (Update/Display All)

This is mapped to the Update/Display All button in PeopleTools.

RB_360_SEARCH (360-Degree Search) icon RB_360_SEARCH (360-Degree Search)

This launches the 360-Degree View search page.

RB_360 (360-Degree View) icon RB_360 (360-Degree View)

This launches the 360-Degree View with the context of the customer for the current transaction.

RB_ADD_MODE (Add) icon RB_ADD_MODE (Add)

This version of the Add button is used with components that use the configurable search.

RB_CLONE (Clone Object) icon RB_CLONE (Clone Object)

This clones the current object.

RB_CONVERT (Convert Object) icon RB_CONVERT (Convert Object)

This converts the current object (for example, to convert a lead to an opportunity).

RB_CORRESPONDENCE_REQUEST (Send Correspondence Request) icon RB_CORRESPONDENCE_REQUEST (Send Correspondence Request)

This sends correspondence from the context of the current transaction.

RB_CTI_DIAL (CTI Dialer) icon RB_CTI_DIAL (CTI Dialer)

This launches the CTI dialer.

RB_NEXT_IN_LIST (Next in List) icon RB_NEXT_IN_LIST (Next in List)

This version of the Next in List button is used with components that use the configurable search.

RB_NOTIFY (Send Notification) icon RB_NOTIFY (Send Notification)

This launches the Outbound Notification page for users to compose and send ad hoc notifications to recipients by worklist, email, or both.

RB_PERSONALIZE (Personalize Toolbar) icon RB_PERSONALIZE (Personalize Toolbar)

This displays the page where a user personalizes the toolbar.

RB_PREV_IN_LIST (Previous in List) icon RB_PREV_IN_LIST (Previous in List)

This version of the Previous in List button is used with components that use the configurable search.

RB_RETURN_TO_SEARCH (Return to Search Page) icon RB_RETURN_TO_SEARCH (Return to Search Page)

This version of the Return to Search button is used with components that use the configurable search.

RB_SAVE (Save) icon RB_SAVE (Save)

This triggers the built-in DoSave() function in PeopleTools.

RB_SAVE_NOW (Save) icon RB_SAVE_NOW (Save)

This triggers the built-in DoSaveNow() function in PeopleTools.

RB_TEXTTRAY (Text Tray) icon RB_TEXTTRAY (Text Tray)

This launches the text tray window.

RB_UPDATE_MODE (Update) icon RB_UPDATE_MODE (Update)

This version of the Update button is used with components that use the configurable search.

RB_VIEW_WORKLIST (View Worklist) icon RB_VIEW_WORKLIST (View Worklist)

This displays the user's worklist.

Before you add a custom button to the toolbar of a component, confirm that the component has the PeopleCode to support the action that the button performs. For instance, the RB_CLONE button does not work in the Service Order toolbar because the Service Order component does not have the code that is needed to support cloning.

For a complete list of system-delivered buttons (common and application-specific), access the Toolbar Button Definition component and perform search without entering any search criteria.