GetBreadcrumbs function

Syntax

GetBreadcrumbs()

Description

Note:

This function has been desupported and is retained for backward compatibility only.

Use the GetBreadcrumbs function to return the user’s current history stack as an array of array of string in reverse order of access—that is, the first history record in the list represents the current content reference. The array of string includes 11 elements as specified in the following table. Specific values are included in the table when they do not vary based on the breadcrumb type; otherwise, blank cells indicate values that are dependent on the specific breadcrumb. For example, breadcrumbs created by PeopleTools do not include certain values such as a page ID or component keys. These and any other unknown values are returned as the literal string “UnknownValue”.

Data Element Breadcrumb Generated by CreateBreadcrumb Content Breadcrumb Generated by PeopleTools Folder Breadcrumb Generated by PeopleTools

Element type

C

C

F

History record ID

     

Portal ID

     

Node ID

     

Component ID

   

UnknownValue

Page ID

 

UnknownValue

UnknownValue

Back label

     

Component mode

 

UnknownValue

UnknownValue

Component keys

 

UnknownValue

UnknownValue

Content URL

      

Query string parameters

  

UnknownValue

UnknownValue

The GetBreadcrumbs function returns a Null value in the following situations:

  • When the history stack is empty—for example, when the function is invoked by an action on a homepage pagelet or tile.

  • When the source content is not displayed in the PeopleSoft portal template—for example, if you display the content in your own portal or if the content is displayed via a direct psc URL.

  • When executing JavaScript fails to retrieve any history stack data.

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

None

Returns

A array of array of string.

Example

In the following example, the invocation of GetBreadcrumbs returns five history records. The first and second history records are application-specific records generated by calls to CreateBreadcrumb. The final three history records represent folder navigation generated automatically by PeopleTools:

[C,PT_ROLEMAINT_GBL_2,EMPLOYEE,QE_LOCAL,MAINTAIN_SECURITY.ROLEMAINT.GBL,ROLEDEFN,Role Maintenance,U,ROLENAME:'ADMINISTRATOR',http://.../MAINTAIN_SECURITY.ROLEMAINT.GBL,UnknownValue]
[C,PT_USERMAINT_GBL,EMPLOYEE,QE_LOCAL,MAINTAIN_SECURITY.USERMAINT.GBL,USER_ROLES,Role Maintenance,U,UnknownValue,http://.../MAINTAIN_SECURITY.USERMAINT.GBL,UnknownValue]
[F,PT_USER_PROFILES,EMPLOYEE,QE_LOCAL,UnknownValue,UnknownValue,User Profiles,UnknownValue,UnknownValue,http://.../WEBLIB_PT_NAV.ISCRIPT1.FieldFormula.IScript_PT_NAV_INFRAME,UnknownValue ]
[F,PT_SECURITY,EMPLOYEE,QE_LOCAL,UnknownValue,UnknownValue,Security,UnknownValue,UnknownValue,http://.../WEBLIB_PT_NAV.ISCRIPT1.FieldFormula.IScript_PT_NAV_INFRAME,UnknownValue]
[F,PT_PEOPLETOOLS,EMPLOYEE,QE_LOCAL,UnknownValue,UnknownValue,PeopleTools,UnknownValue,UnknownValue,http://.../WEBLIB_PT_NAV.ISCRIPT1.FieldFormula.IScript_PT_NAV_INFRAME,UnknownValue]

Related Topics