SAP Knowledge Base Article - Public

2249034 - How to enable Compound Employee API - SuccessFactors HXM Suite

Symptom

You need to enable the Compound Employee API in your SF instance.

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 HXM Suite
    • Compound Employee

Resolution

To enable Compound Employee in your SF instance, follow these steps:

  1. Provisioning

    If you have access to SuccessFactors Provisioning, the following options needs to be enabled:

    1. SFAPI
    2. Employee Central SOAP API
    3. Employee Profile Data Audit

    In case you don't have access to provisioning, kindly create a Support Incident with SAP/SuccessFactors requesting for the above features to be enabled in the backend.

  2. Employee Profile Data Audit: Activation of the Audit Log

    For data compliance, you need to activate the data audit log. Once it is on, all employee data changes are recorded and you can see history. If the audit log is not activated, the compound SF API will return an error message.

  3. Permissions for the API User

    Role Based Permissions needs to be enabled to add the API roles to the API User.

    Go to Admin Center. In the Tools search field, enter Permission and add the following permissions:

    General User Permission
        API User Login
    Employee Central API
        Employee Central HRIS SOAP API

     1.PNG

    Note: The SFAPI Compound Employee was developed to be used by admins, and the main use of this API is to sync SF EC data with SAP ERP HCM/ECP.

    In the chapters below of the handbook, you will see details regarding the permissions:

    1. Granting Permissions for Full Access to the CompoundEmployee API
    2. Granting Permissions for Restricted Access to the CompoundEmployee API

    You can restrict the SFAPI Compound Employee by country/departments, but you cannot restrict the portlets returned in the response. That means, once you have the access, your select statement of the SFAPI CE can include any portlet and it will return any portlet if you have access for that person. In another words, in the SFAPI Compound Employee, we can only apply RBP on target population, not on the specific portlets or fields.

See Also

Compound Employee Guide: Setting Up the CompoundEmployee API

Keywords

restrict, api, compoundemployee, compound employee, ce, limit, rbp, role based permissions, permission, access, object, segment, data, target population, provisioning, enable, activate, on, , KBA , LOD-SF-INT-EC , Employee Central SFAPI & OData Entities , How To

Product

SAP SuccessFactors HXM Suite all versions