SAP Knowledge Base Article - Public

2089418 - Quick Links and Deep-Linking within the SuccessFactors Application - BizX Platform

Symptom

  • Deep Linking
  • Are we able to provide deep links to pages within the application?
  • If we are using SSO are we still able to use deep linking?
  • Can we add quick links on the home page to other pages?

"Image/data in this KBA is from SAP internal systems, sample data, or demo systems. Any resemblance to real data is purely coincidental."

Environment

SAP SuccessFactors HCM Suite

Resolution

Deep linking and Quick links are slightly different in nature. When we refer to quick links we are referring to links within the application such as a link on your home page or company resources that take you to another page within the application, whereas deep linking refers to links stored outside of the application before you have logged in, like a bookmark in your browser or a link from your company intranet portal, that you click on to bring you to a specific page within the application.

IMPORTANT NOTE: Deeplinks in SuccessFactors have different behaviours across the SuccessFactors Suite and as a result, module specific queries should be routed to the relevant SAP SuccessFactors Module Team.

Quick Links Within The Application

You can add quick links on your home page in the Welcome Portlet or on the Company Resources Page, or maybe even in a Performance Form, that take you to another specific page within the SuccessFactors Application.

For example, you might want to add a link from the home page to the Directory/Faces page. You could do this by using the following link: /xi/ui/empdir/pages/employeeDirHome.xhtml?bplte_company=yourcompanyidhere (this link example is for v11 or v12 clients)

Please see the attached document that provides a number of creative examples of how you can add custom links.

Examples: Please note that we provide the following examples with the understanding and condition that the platform specifications can change and these links may no longer work. We do not make any commitment to support any custom link like those provided below, or any custom links you may add to your pages or provide to end-users. The only fully supported navigational links are those links, tabs and buttons that exist within the product that are provided out-of-the-box.
Additionally some links may not work for your version or configuration! We do not support trying to make these work in all situations and are provided relative to a standard implementation.

Help & Tutorials: /xi/ui/helptraining/pages/help_home.xhtml
Company Resources: /xi/ui/company/pages/companyResource.xhtml
Employee Files: /xi/ui/empfile/pages/employeeFiles.xhtml

Analytics/Reports: /acme?fbacme_n=analytics
Dashboards: /acme?fbacme_n=dashboard
Reports Help & Tutorials: /xi/ui/helptraining/pages/help_rpt.xhtml

Calibration: /xi/ui/calibration/pages/sessionList.xhtml

Compensation: /acme?fbacme_n=my_forms&inbox_fbfl_ftype=Compensation
Compensation Executive Review: /acme?fbacme_n=compensation&fbcomp_param_action=comp_exec_template_list
Compensation Help & Tutorials: /xi/ui/helptraining/pages/help_comp.xhtml

Goals: /sf/goals
Goals Status Report: /xi/ui/ge/pages/statusreport/statusreport_wrapper.xhtml
Goals Execution Map: /xi/ui/ge/pages/executionmap/executionmap.xhtml
Goals Meeting Agenda: /xi/ui/ge/pages/meetingagenda/meetingagenda.xhtml
Goals Help & Tutorials: /xi/ui/helptraining/pages/help_goals.xhtml

Performance Reviews: /sf/pmreviews
Performance Team Overview: /xi/ui/pm2/pages/teamoverview/teamoverview.xhtml
Help & Tutorials for PM: /xi/ui/helptraining/pages/help_pm.xhtml

Recruiting: /acme?fbacme_n=recruiting&recruiting_ns=sourcePortlet

Succession Org Chart: /xi/ui/orgchart/pages/succession_orgchart.xhtml
Succession Lineage Chart: /xi/ui/orgchart/pages/lineageReport.xhtml
Directory Page: /xi/ui/empdir/pages/employeeDirHome.xhtml
Org Chart: /xi/ui/orgchart/pages/orgchart/orgchart.xhtml
Succession Help & Tutorials: /xi/ui/helptraining/pages/help_succession.xhtml

 

Deep Links From Outside the Application

The SuccessFactors Application does provide limited deep-linking support for SSO and non-sso instances. Not all pages and features can be directly linked to, and we recommend that you only link to the main module pages.

Note: Although you may be able to build a custom URL that successfully opens the page you need, unsupported deep-links may in the future break should changes be made to the SuccessFactors Application. SuccessFactors support is not required to fix any such custom deeplinks you may have used. Typically we only support deep-links to the main modules.

Please see SuccessFactors Deep Links for a list of supported deeplinks. As each client can have different modules and configurations, not all links provided may work. Trial and error will provide immediate insight into which deep-links are valid for your specific instance.

Using Deep Links

To use a deeplink, add it to the base URL of your SuccessFactors instance.

  1. Determine the base URL used in your system. The base URL can vary slightly by customer and by region but always ends in "successfactors.com".

    For example, if your main SuccessFactors login page is

    https://performancemanager4.successfactors.com/login#/companyEntry, then your base URL is 
    https://performancemanager4.successfactors.com

  2. Insert the deeplink immediately following "successfactors.com", starting with a slash.

    For example, to add a deeplink to the logged-in user's development plan, you would use:

    https://performancemanager4.successfactors.com/sf/devplan

  3. Insert the resulting URL as a hyperlink in the desired location.

 

SSO and Deep Linking Within the Application

To support deep linking into the application we provide some alias urls to target specific parts of the application. The following parameter is used to determine the endpoint:
Parameter     Description
pm_actstr     Defines the endpoint the users will initially see when the user enters the application.

Note SAML has a different method of deep linking. See the SAML section for details.

We currently support the following values like this for pm_actstr:

  • /sf/pmreviews  
    • This takes you to the Performance/Review tab.
    • We have a complete list of these values here

 

Email Notifications

See KBA 2091967 - SSO: Links in email notifications are taking to the SuccessFactors login screen - Platform

SAML SSO

Deep Linking with SAML can be accomplished to in the same way.


https://performancemanager.successfactors.com/sf/devplan?company=COMPANYID&loginMethod=SSO
https://performancemanager.successfactors.com/sf/orgchart?company=COMPANYID&loginMethod=SSO

Note: Don't forget to include the loginMethod=SSO parameter.

See Also

KBA 2278694 - Is it Possible to log in Directly to SAP Jam? 

2802025 - How to build Deeplink to Report Center - BizX Platform

Keywords

Deeplinking, deep link, sso, email, e-mail , KBA , sf sso , LOD-SF-PLT , Foundational Capabilities & Tools , LOD-SF-PLT-DEP , SSO Deeplink , How To

Product

SAP SuccessFactors HCM Suite all versions

Attachments

Deep_Link_Support_in_SFSF.xls
Welcome_Portlet_Samples.ppt