Compound Employee API Sub-Structures

To aggregate the value of additional account schema attributes for Compound Employee API sub-structures, you need to add the attribute name to the account schema and the navigational path. The following Compound Employee API sub-structures 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

Including Additional Sub-Structures

You can include additional sub-structures by providing the sub-structure name in the Include Compound Employee API Entities field. Separate the multiple names with commas. For example:

WorkOrder, SecondaryAssignments

In SuccessFactors:

To find the value for Navigation Path (SFAPI Path):

  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) in SailPoint.

In SailPoint:

  1. Go to Applications > Application Definition then select SuccessFactors from the list.

  2. Select the Configuration tab.

  3. In the Additional Attribute Mapping section:

    1. Add a name for the Schema Attribute.

      For example: Nationality

    2. Add the Navigation Path (SFAPI Path) that you copied from SuccessFactors.

Specifying Values Included in Multiple Sub-Structures

By default, the connector aggregates the values without logic. It fetches the value that matches the specified SFAPI path. If an attribute value includes multiple sub-structures and you want to aggregate the data from a specific entity, you can provide the XPath 2.0 value.

Example:

You want to aggregate the country value for address_type but it has multiple values such as home or payroll. To specify the payroll address, configure the Navigation Path (SFAPI Path) as follows:

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

Example:

By default, the SuccessFactors connector aggregates the PrimaryEmailAddress attribute. To return specific email addresses, such as the Office type email address, configure the Navigation Path (SFAPI Path) as follows:

/person/email_information[email_type=''O'']/email_address

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

Example:

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 scenario, the employee has two sets of job information - current and future. To aggregate the future manager information, configure the Navigation Path (SFAPI Path) as follows:

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

Example:

A user has concurrent assignments and you want aggregate the primary position. To aggregate the primary position, configure the Navigation Path (SFAPI Path) as follows:

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