How to use deep links or access to a specific top level page - pegasystems/uplus-wss GitHub Wiki

Top level pages

The Uplus application has several direct pages that you can access

For the retail bank application only, additional pages for use with the Customer Decision Hub are provided. The 4 offer pages are accessible through a direct link in the top navigation (main menu)

Deep linking

It is also possible to use a deep link to access directly to some of the pages of the application

Account page deep link

To access directly to the account page, you just need to provide the username that should be loaded to get authenticated - you can either pass the username or the pega_userid

index.html?pega_userid=foo or [email protected]

Note on a mobile device, the url above will keep you on the home page but your operator icon will be shown as authenticated If you want to go to the quicklinks page (which is the middle page where all the quicklinks are listed) you need to add the extra parameter todoclass. the value of todoclass should be the same as the setting 'classname' for the ToDo component in the settings page.

for example index.html?pega_userid=foo&todoclass=Data-Portal

Quicklink pages

You can add several quicklinks defined in your applications using the settings page - to directly access one of these quicklinks, you will need to be authenticated (e.g provide a valid user) and provide the class of the quicklink to open. the value of quicklinkclass must be the same as the one defined as 'Classname' under the quicklink setting page. If you have several quicklinks with the same classname, the first one will be used

index.html?pega_userid=foo&quicklinkclass=Work-Test

Note It is possible to pass extra parameter to the quicklink that will be sent directly to the Pega Web Mashup as extra params. The extra params are passed as is to the Mashup iframe. For example

index.html?pega_userid=foo&quicklinkclass=Work-Test&param1=value1&param2=value2

This approach is NOT supported with Constellation and Web-Embed.

Note It is possible to hide a quicklink from the account page by going to the 'Quick Links' page under Settings and checking the checkbox 'Hide from account page' to hide it from the account. The quicklink can still be accessed through the shortcut url using index.html?pega_userid=foo&quicklinkclass=Work-Test

Home hero action

to directly access the home hero action, add the homeHeroAction param to the url - for example:

index.html?homeHeroAction=1&param1=value1

Identify if a deep link is used

The parameter 'isDeepLink=true' when using a deep link like 'index.html?pega_userid=test&quicklinkclass=foo' is automatically sent as true for all Pega Web Mashup configuration sent for the session; that includes the todo list or any quicklinks. The parameter is not sent when the user is not logged in through a deeplink. The deeplink state is reset on logout.

This approach is NOT supported with Constellation and Web-Embed.