SAP Knowledge Base Article - Public

3772288 - UI Integration Cards in SAP SuccessFactors: Important Notes and Frequently Asked Questions

Symptom

This KBA explains how SAP SuccessFactors supports UI Integration Cards for displaying data from SAP BTP applications in SuccessFactors pages, including tool purpose, implementation steps overview, important notes and common questions.

Purpose

UI Integration Cards allow customers to display data from SAP BTP or SAP Build applications directly inside SAP SuccessFactors pages, acting as a lightweight “mini application” embedded in the user experience. They are intended to surface organization-specific information from extension applications without requiring users to leave SuccessFactors.

Supported target areas include:

  • Latest People Profile / Full Profile — web and mobile, depending on configuration.
  • Spotlight — web and mobile according to the SAP Community implementation guide.
  • Latest Home Page — web only; Home Page cards are displayed in the Explore More section and are not displayed in the mobile app.

The recommended use case is to display data from a side-by-side extension application running on SAP BTP, for example a custom SAP Build or CAP application.

Environment

SAP SuccessFactors HCM Suite
SAP Business Technology Platform
SAP Business Application Studio / SAP Build
SAP SuccessFactors Extensibility Wizard

Cause

Main Documentation

        

Implementation Steps Overview

  1. Prepare SAP BTP and SAP SuccessFactors connectivity:
    Connect the SAP SuccessFactors system and SAP BTP global account, create or reuse a BTP subaccount, configure IAS, and create a formation of type Integration with SAP Build.

  2. Enable required BTP services and entitlements:
    Ensure SAP Business Application Studio or SAP Build Code is available, and enable the SAP SuccessFactors Extensibility service with the api-access plan.

  3. Create the deployment destination to SAP SuccessFactors:
    Create the SAP SuccessFactors Extensibility service instance. This creates an HTTP destination in the BTP subaccount. Update the destination property WebIDEUsage = SuccessFactorsExtensionCard.

  4. Configure OAuth and permissions in SuccessFactors:
    In SuccessFactors, update the generated OAuth client if required, enable Bind to Users, and grant the required permissions.

  5. Configure destinations in SuccessFactors Security Center:
    Configure destination settings in Admin Center → Security Center → Destination Settings for the BTP application API. The custom BTP application destination uses OIDC Authentication, and the dependency name in IAS must match the dependency name in Security Center.

  6. Create the UI Integration Card:
    From Configure Latest People Profile, use Create Extension, select User Interface Extension, open the generated project in SAP Build / Business Application Studio, and update the card’s manifest.json.

  7. Deploy the card to SAP SuccessFactors:
    Deploy the card from SAP Business Application Studio by right-clicking manifest.json and selecting UI Integration Card: Deploy to SAP SuccessFactors. Once deployed, the card bundle is stored on the SAP SuccessFactors side and can be selected by Card ID and version.

  8. Add the deployed card to the target page:
    Add the card in Configure Latest People Profile or Manage Home Page, depending on the intended placement.

                

Important Notes

Recommended Usage

Customers should use UI Integration Cards primarily to display data from extension applications hosted on SAP BTP.

Building cards based on SuccessFactors APIs or objects inside People Profile or Home Page is not recommended. Where the business requirement is to show custom SuccessFactors-managed data, consider whether standard SuccessFactors options such as creating MDF custom objects and displaying them in Latest People Profile.

        

Supported Hosting and Deployment Model

The supported model is to deploy the UI Integration Card bundle from SAP Business Application Studio / SAP Build into SAP SuccessFactors. The card bundle is then stored and managed on the SuccessFactors side.

Serving the card’s manifest.json and extension.js directly from an HTML5 Application Repository on SAP BTP through a registered destination is currently not supported for this scenario. The destination configured in SuccessFactors Security Center is used for the target application/API from which the card loads data, not for hosting the card bundle itself.

       

Custom JavaScript

Custom JavaScript extensions for UI Integration Cards are supported in SAP SuccessFactors only after the required SuccessFactors-side enablement/review process is completed.

Specifically, the relevant feature toggle must be enabled by SAP. Customers should create a support ticket under the LOD-SF-INT component and reference this KBA. SAP Support will then engage the engineering team to enable the toggle. Until this enablement is completed, deployment of a card bundle containing a JavaScript file may be rejected.

Once enabled, the JavaScript is treated as part of the UI Integration Card execution within the SAP SuccessFactors experience. It is not handled as a separately hosted card bundle loaded from an external HTML5 repository.

However, SAP SuccessFactors does not validate, certify, or support the custom JavaScript logic itself. Because the script is customer-provided code, the customer remains responsible for ensuring that it functions correctly and does not introduce security, performance, stability, or other operational risks.

Resolution

Frequently Asked Questions

1. Is provisioning or a feature toggle required?

For the general UI Integration Card capability, the customer must also complete the required BTP, SuccessFactors, IAS, destination, and permission setup described in the implementation documentation.

For custom JavaScript, a SuccessFactors-side feature toggle is required. If the toggle is not enabled, deployment of a card containing a JavaScript file is rejected. See Important Notes from this KBA.

2. Do JavaScript extensions in UI Integration Cards run in the SAP SuccessFactors page context? 

Refer to Important Notes in this KBA.

3. Who supports custom JavaScript issues?

Refer to Important Notes in this KBA.

4. Can the card bundle be hosted in HTML5 Application Repository on BTP and served through a Destination?

No. This is currently not the supported model.

The card bundle, including manifest.json and any card JavaScript file, must be deployed to SAP SuccessFactors using SAP Business Application Studio / SAP Build. The bundle is then stored on the SuccessFactors side and selected in the SuccessFactors configuration UI. Destinations in SuccessFactors Security Center are used for calling the target BTP application/API that provides card data.

5. Where can UI Integration Cards be shown?

UI Integration Cards can be configured for:

  • Latest People Profile / Full Profile
  • Spotlight, according to the implementation guide
  • Latest Home Page, web only
  • SAP SuccessFactors Mobile for supported People Profile scenarios

6. Are there examples of card extensions accessing SuccessFactors page-level objects?

The documented and recommended approach is to pass supported page context parameters to the card, rather than directly depending on internal page objects.

For Latest People Profile, SAP documents the supported parameter: targetAssignmentUUID/value

This parameter represents the assignment UUID of the employee currently displayed in People Profile and can be forwarded to the BTP application API, for example: <destination-api>?assignmentUUID={parameters>/targetAssignmentUUID/value}

Customers should avoid designing cards that depend on undocumented SuccessFactors page-level JavaScript objects, as these may change and are not the intended extensibility contract.

Keywords

UI Integration Card, SuccessFactors, SAP BTP, SAP Build, Business Application Studio, custom JavaScript, extension.js, manifest.json, HTML5 Application Repository, Destination, Security Center, People Profile, Latest Home Page, OIDC, Extensibility Wizard, SuccessFactors Extensibility Service
, KBA , LOD-SF-INT , Integrations , How To

Product

SAP SuccessFactors HCM Suite all versions