Exploring Compound Employee API Extensibility Features

Objective

After completing this lesson, you will be able to identify SAP SuccessFactors Compound Employee API extensibility features and capabilities.

Introduction

The following contents covers an overview of the SAP SuccessFactors Compound Employee API Extensibilities.

Compound Employee API - Metadata

  • The Compound Employee API operations 'describe' and 'describeEx' return metadata such as <field> elements for segment names or custom fields
  • This Metadata can be also found in the SFAPI Data Dictionary
  • The Metadata contains the following information:
    • ﹤field﹥ elements for all segment names in the SELECT clause
    • ﹤field﹥ elements for all selection fields that can be used in the WHERE clause. The ﹤supportedOperator﹥ tags reflect the operators that can be used with the field
    • ﹤field﹥ elements for all standard fields contained in all segments occurring in the result structure
    • ﹤field﹥ elements for all custom fields that are enabled in the data model

Compound Employee API Metadata - Example

Example:

XML code snippet displaying fields: employment_id, segment, and first_name with data types and attributes.

Example - SFAPI Data Dictionary View:

CompoundEmployee fields table listing attributes like name, data type, and additional properties for each.

Compound Employee API - Extensibility Overview

Extensibility is supported in different ways :

  • Custom fields are supported for all segments
  • Standard MDF objects can be extended to support custom MDF child relation
  • Support for standard or custom MDF objects as select item

Compound Employee API - Extensibility Items

MDF objects fulfilling the following requirements can be registered and used :

  • Object has a user relation
  • API visibility is Read Only or Editable
  • The object is not a composite object
  • MDF Version History is set to Complete History
SuccessFactors Admin Center: Compound Employee API Object Types showing Object Type List for WorkOrder.