Aggregation of Additional Schema Attributes Using SFAPI

The SuccessFactors source supports the aggregation of additional schema attributes.

In the SuccessFactors source UI, on the Additional Attribute Mapping panel, in the Schema Attribute field, enter the name of the additional attribute. In the Navigation Path (SFAPI Path) field, enter the navigation path of the attribute as defined in SFAPI (SuccessFactors Data API). For example:


The SFAPI is SuccessFactors Data API. It is a SOAP Web Service designed for importing and exporting data to and from your SuccessFactors instance.

To aggregate the value of the additional schema attributes for an account:

  1. Add the entry key of schema attribute and its respective path. For the navigation path, perform the following steps:

    • On a SuccessFactors managed system, navigate to Admin Centre > SFAPI Data Dictionary.
    • Search the CompoundEmployee in the list.
    • Expand the CompoundEmployee entity that displays the attribute fields with their respective information.
    • Search for the attribute you want to add. Its path will be displayed in the Name field.

    For example:

    Label: Nationality

    Path: /person/personal_information/nationality

    This is the SFAPI path that must be copied and entered in the Navigation Path (SFAPI Path) field in the source UI.

  2. Add the same attribute name entry in SuccessFactors source account schema. For more information on adding account schema attribute, refer to Adding Attributes to a Source Schema.


  • Ensure that the names of additional attributes and details are added in both the source account schema and the source UI fields, respectively.

  • This would aggregate the attributes that are returned from the Compound Employee API from the following entities.

    • person
    • personal_information
    • address_information
    • email_information
    • phone_information
    • employment_information
    • job_information

Additional Information

If there are multiple information types associated with supported entities like personal_information, address_information, email_information, phone_information, then to aggregate the data from the specific type of information, you can configure a path in the attribute mapping.

For example, there are two address information types in the following node. The first is type "home" and second is type "Payroll".



If you want to fetch the country of type 'Payroll', then the navigation path / SFAPI path will be:

/person/address_information[address_type= "Payroll"]/country

The SuccessFactors source aggregates the "PrimaryEmailAddress". To aggregate different type of email address, the navigation path would be:


where, O indicates the email address of type "Office".

Additional Attributes with XPath

The SuccessFactors source supports the SFAPI path value in XPath 2.0 format to aggregate the additional attributes.

The supported additional attributes are part of following entity:







Compound Employee API sub-structures



To aggregate the value of additional account schema attributes for Compound Employee API sub-structures, you must add the attribute name to the account schema and the corresponding navigational path. The following Compound Employee API substructures are standard:

  • person

  • personal_information

  • address_information

  • phone_information

  • email_information

  • person_relation

  • employment_information

  • job_information

  • compensation_information

  • paycompensation_recurring

  • paycompensation_non_recurring

  • payment_information

  • accompanying_dependent

  • alternative_cost_distribution

  • job_relation

  • direct_deposit

  • national_id_card

  • deduction_recurring

  • deduction_non_recurring

  • global_assignment_information

  • ItDeclaration

  • dependent_information

  • personal_documents_information

  • EmployeeDataReplicationElement

  • associated_employee_information

  • emergency_contact_primary

  • DRTMPurgeStatusOverview

You can include additional sub-structures by providing the sub-structure name in the Include Compound Employee API Entities field on the SuccessFactors source UI. To add multiple entities, separate the names with commas. For example: WorkOrder, SecondaryAssignments.

The SuccessFactors Connector provides support for the aggregation of additional account schema attributes for user management that belongs to the user entity with Navigation Target property as blank.

User attributes must use the user prefix. For example,

On the SuccessFactors managed system:

  1. Go to Admin Center.

  2. Search for and select SFAPI Data Dictionary. The SFAPI Data Dictionary page is displayed.

  3. Search for and expand the CompoundEmployee entity to display the attribute fields.

  4. Find the required attribute and the path displayed under the Name field and copy the path. For example,

Label: Nationality

Name (Path): /person/personal_information/nationality

The Name path is the required field value for Navigation Path (SFAPI Path).

On the SuccessFactors source UI, in the Additional Attribute Mapping sub-panel, set the following:



Include Compound Employee API Entities

Enter the name of Compound Employee API extended sub-structures/Entities (separated by comma) to query for additional attributes.

Attribute Mapping

Define the schema attribute name along with navigation path that connector will aggregate from the SuccessFactors managed system.

Specifying Values from Multiple Sub-Structures

By default, the SuccessFactors source aggregates the values without applying logic. It fetches the value that matches the specified

SFAPI path. If an attribute value is including multiple sub-structures and you want to aggregate the data from a specific

entity, you can provide the XPath 2.0 value.

Use Case 1:

If you want to aggregate the country value for address_type but address_type could have multiple values such as home or payroll. To specify the payroll address, the Navigation Path (SFAPI Path) would be:

/person/address_information[address_type= "Payroll"]/country

Use Case 2:

By default, the SuccessFactors source aggregates the PrimaryEmailAddress. If you want to return specific email addresses, such as the Office type email address, use this Navigation Path (SFAPI Path):


where O represents that the email address is of type Office.

Use Case 3:

An employee is being promoted and you want to aggregate information based on the future position to trigger approvals by the future manager. In this use case, the employee has two sets of job information - the current and future. To fetch the future manager information, use this Navigation Path (SFAPI Path):

/person/employment_information/job_information[xs:date(start_date) ge currentdate()]/ manager_person_id_external

Use Case 4:

A user has concurrent assignments and you want aggregate the primary position. The Navigation Path (SFAPI Path) would be:

/person/employment_information[not(SecondaryAssignmentPeriod)]/job_information [xs:date(start_date) le current-date()and xs:date(end_date) ge current-date ()]/position

Future Actions

Future Actions attribute stores information about the Future Actions in the following JSON format:

{"Actions": [{"ActionType" : "<ActionCode>","ActionReason" : "<Action Reason value>","ActionStartDate" : "<Start date>","ActionEndDate" : "<End date>"}]}

For example, you can use the following:

{"Actions": [{"ActionType" : "SCWK","ActionReason" : "Start CWK","ActionStartDate" : "2018-08-26","ActionEndDate" : "2018-09-08"}]}

The Future Actions attribute aggregates future employment actions only.