peoplecodeapi

CreateBreadcrumb

Mon 01 January 2018

Syntax 

CreateBreadcrumb(Back_label, history_ID, portal_ID, node_ID, component, page_ID, page_title, comp_mode [, comp_keys] [, qry_string])

Description

Note: This function has been deprecated and is retained for backward compatibility only.

Use the CreateBreadcrumb function to inject a history record containing application-specific data into the user’s Back button history stack. Optionally, the HTML representing the new history record can be returned as a String value. The result of the function depends on the context from which it is invoked:

  • When navigating to a content reference from the menu, the application-specific history record generated by CreateBreadcrumb is used instead of the history record generated by PeopleTools.

  • If the history record is generated as the result of a related action, the history record generated by CreateBreadcrumb is used instead of the history record generated by the related action.

  • If the generated history record duplicates an existing history record in the history stack (identical history record ID), the original history record is deleted from its position in the list and the generated history record is appended to the end of the list.

  • However, if the history record is generated by a pagelet or tile on a homepage or dashboard, the history stack list is not updated.

Note: This function cannot be invoked from a fluid component. In addition, this function cannot be invoked after the content is displayed via a direct psc URL.

Parameters

Field or Control

Definition

Back_label

Specifies a label for the Back button as a String value.

history_ID

Specifies a unique ID for the history record as a String value.

portal_ID

Specifies the portal to be used to construct the content URL as a String value.

This portal ID can be specified as a literal string, by using the %Portal system variable, or by using the Portal. PORTAL_NAME reserved word.

node_ID

Specifies the portal to be used to construct the content URL as a String value.

This node ID can be specified as a literal string, by using the %Node system variable, or by using the Node. NODE_NAME reserved word.

component

Specifies the component to be used to construct the content URL as a String value. The component parameter is constructed from three values ( MENU . COMPONENT . MKT ) as follows:

  • MENU: This menu ID can be specified as a literal string, by using the %Menu system variable, or by using the MenuName. MENU_NAME reserved word.

  • COMPONENT: This component ID can be specified as a literal string, by using the %Component system variable, or by using the Component. COMPONENT_NAME reserved word.

  • MKT: This market ID can be specified as a literal string, by using the %Market system variable, or by using the Market. MARKET_NAME reserved word.

page_ID

Specifies the current page in the component as a String value.

This page ID can be specified as a literal string, by using the %Page system variable, or by using the Page. PAGE_NAME reserved word.

page_title

Specifies a title for the page as a String value.

comp_mode

Specifies the mode for the component as a single-character String value. Valid modes are:

  • "A" ( add)

  • "U" (update)

  • "L" (update/display all)

  • "C" (correction)

  • "E" (data entry)

You can also specify a empty string ("") for this value.

comp_keys

Specifies optional component keys and key values to be used to select a unique row at level zero in the current component as a String value. Specify keys and values in the following recommended format: 

KEY1_NAME:'KEY1_VALUE';KEY2_NAME:'KEY2_VALUE';...
qry_string

Specifies optional query string parameters to be appended to the content URL as a String value in standard query string format: 

param1=value1&param2=value2&...

Returns

(Optional) A String value.