Using Deep Links in Successfactors

Using Deep Links in SuccessFactors

What is a Deep Link?

A deep link is a hyperlink that links directly to a specific page in the SAP SuccessFactors application (e.g., “https://performancemanager4.successfactors.com/sf/personalinfo”), rather than the highest-level page (e.g., “https://performancemanager4.successfactors.com”).

Where to use the Deep Links?

Deep links can be used anywhere hyperlinks are possible. We can use them in offline content, such as your internal documentation, or on intranet sites, like your company portal. They can also be used in third-party applications, such extensions built on the SAP Cloud Platform. We can even use deep links within the SAP SuccessFactors system itself, such as on a custom tile on the home page or in custom navigation links on the Employee Profile.

Deep Links with URL Parameters.

Some deep links can be used with parameters (query strings) that contain additional data that is not present in the hierarchical path structure of the URL.

For example, the following deep link will redirect the user, after logging in, to the Personal Information page for the specified user with a User ID of “jsmith1”:

https://performancemanager4.successfactors.com/sf/personalinfo?selecteduser=jsmith1

Note

Although this example is static and would only be useful for accessing one particular user’s information, a third-party application or extension could be made to dynamically insert into this URL the correct SuccessFactors user ID for any given user. If you are adding a deep link to the SuccessFactors user interface using the Custom Navigation tool, you can use a URL token to do this.

The most commonly accepted parameter is for a “selected user”, defined by their User ID. However, there are a few other types of parameters supported by certain deep links, such as the Session ID of a calibration session, the Position ID on the Succession Org Chart, and the Req ID of a job requisition.

Using Deep Links

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

Procedure

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 deep link immediately following “successfactors.com”, starting with a slash.

For example, to add a deep link 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.

Using URL Parameters

We can use query string parameters in the URL of some pages in the SuccessFactors application.

Procedure

1. Add a ?separator at the end of your URL to indicate the beginning of a query string.
2. Add a supported URL parameter as a name-value pair.

For example:

https://performancemanager4.successfactors.com/sf/personalinfo?selecteduser=jsmith1234

3. Multiple parameters should be separated by an ampersand (&).

For example:

https://performancemanager4.successfactors.com/sf/personalinfo?company=MYCOMPANY&username=jsmith&password=pwd&selecteduser=jsmith1234

List of SAP SuccessFactors Deep Links

The following table lists the deep links available in the SuccessFactors application and their supported URL parameters.