Scribd
Upload
3K views

Compound Employee API

The Compound Employee API extracts employee data from SAP SuccessFactors Employee Central. It replicates this data to other SAP and third party systems using SOAP. The API returns hierarchical data for multiple entities in a single call and supports delta transmission to provide only changed data. It has limits on message size, number of rows and employees retrieved, and objects exposed per call to ensure performance. Audit logs capture payload details and usage analytics to help optimize integration.

Uploaded by

Rajesh Kumar
Copyright
© © All Rights Reserved
Available Formats
Download as DOC, PDF, TXT or read online on Scribd
3K views

Compound Employee API

The Compound Employee API extracts employee data from SAP SuccessFactors Employee Central. It replicates this data to other SAP and third party systems using SOAP. The API returns hierarchical data for multiple entities in a single call and supports delta transmission to provide only changed data. It has limits on message size, number of rows and employees retrieved, and objects exposed per call to ensure performance. Audit logs capture payload details and usage analytics to help optimize integration.

Uploaded by

Rajesh Kumar
Copyright
© © All Rights Reserved
Available Formats
Download as DOC, PDF, TXT or read online on Scribd
You are on page 1/ 13

OM

COMPOUND EMPLOYEE API

The Compound Employee application programming interface (API) for SAP Success Factors Employee Central is used to
extract employee data out of Employee Central.

The Compound Employee API is based on the Simple Object Access Protocol (SOAP).

It replicates employee master data from Employee Central to SAP systems, payroll systems, and benefits
systems.

 The API returns all requested data of an employee in a single call providing a
hierarchically structured response.
 The query response comprises all time slices of all entities specified in the
request. You can apply filters in the query request.
 The API replicates only data that has been approved in Employee Central.

Snapshot Transmission Mode:

In this mode, the API returns the data as it was on the snapshot date, considering all changes, corrections, and
deletions.

Delta Transmission Mode:

In this mode, the API only returns employee data that was created, changed, or deleted since the last
replication.
In contrast to full transmission, consumers only get the changed data for an employee including the previous values, with a
clear indication on how to process the data.

Thresholds and Limits of the Compound Employee API


1) Maximum SOAP Message Size:

A maximum SOAP message size (HTTP content size) can’t exceed 5 MB.

2) Maximum Number of Rows :

By default, a maximum of 200 rows is returned in a single query or query More method.
This number can be set to a value from 1 to 800 by specifying the max Rows parameter in
the query method. Reach best performance by setting the max Rows parameter to at least
400 or more.
3) Maximum Number of Employees
Due to performance limitations, we recommend that you don't retrieve more than 20,000 employees per integration
process run.

4) Maximum Number of Objects

The maximum number of objects that can be exposed by the API is limited to 50,000 instances of an individual MDF object
or composite sub object per call. In case this number is exceeded, the API aborts the call and shows an error message
containing the object type in question and the limit applied.

5) Transferring Changed Employees

Ensure that you don't replicate employees many times although their data hasn't changed. Use the last_modified_on
parameter to transfer only employees that have changed since the last process run.
Please note that for last_modified_on queries, it’s only possible to select data changes for up to a maximum of three
months into the past. Any date further in the past isn’t considered.

6) Selecting Single Employees

If you want to select multiple employees, don't query them one by one. Avoid selecting single employees, in particular with
a high request frequency.
A common use case here is to query data of the employees' managers. Use the associated_employee_information segment to
get the managers along with the employees, instead of querying this data separately.

Performance Recommendations for the Compound Employee API


1) Scheduling API Calls

Avoid triggering a large number of queries in parallel. Too many parallel queries can have a negative
impact on performance and can put the stability of your integration at risk.

2) Minimizing Full Extraction Runs

API calls without a last_modified_on select parameter lead to a full extraction of employees, regardless of whether data
has changed since the last replication run. We recommend that you only use such calls in initial load scenarios or when
requesting the segment Employee Data Replication Element in order to fetch entries from the Employee Central Data
Replication Monitor.

3) Mass Updates and Data Extraction Runs

Don't carry out mass updates (for example, using imports) in parallel with a data extraction run performed by the API. Or
else employees might not be picked up due to deferred storage on the database. Meaning that the data hasn't yet been
stored, but extraction is already running.

Audit Log and Metering Details


The SFAPI Audit Log allows access to potentially sensitive data.
The SFAPI Audit log captures payload details for the last 10,000 API calls. The API Metering Details
page in the Audit Log gives you analytics on your API usage for the last 30 days. You can use this
page to see API call history analytics, such as how many times the API was called or what was the
total record counts accessed in your system.

Using the Compound Employee API


The Compound Employee API selects multiple entities related to an employee and returns all data in a hierarchically-
structured response XML with the employee person data as the root node.

Query and Query More

The API query call specifies the entities to be returned plus the selection criteria.

This call returns a limited number of employees.


To retrieve the remaining records, you need to issue a series of query More API calls until all employees are retrieved.

In each call, query More you need to specify the session ID provided by the first query response.

Query Request Structure


The Compound Employee API query request is made up of a SELECT clause, FROM clause, and WHERE clause.

Query Parameters
The <param> tag contains parameters that control the behavior of the CompoundEmployee API.
Server Paging:
API Metadata Access:

The Compound Employee API also operations that returns its Metadata.

You might also like