SAP Knowledge Base Article - Public

2723468 - How to avoid missing/duplicated data enabling server-side Pagination - SuccessFactors

Symptom

You are calling some SuccessFactors API endpoint but missing or duplicated data is showing up in the API response.

"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
  • Boomi
  • SAP Cloud Integration

Cause

A single OData GET request can return at most 1000 records. When the number of records is higher than that, the remaining records are returned in different API responses ("pages") and this logic is called Pagination.

When the OData GET request goes to the next page some records could be missed or duplicated but you can avoid it by using server-side Pagination.

In addition, enabling Pagination provides OData API call performance boost when querying large data set.

This KBA explains how to use snapshot-based pagination in CPIBoomi, Integration Center (IC) and direct OData API calls.

OBS.: All the other available Pagination types are explained here.

Resolution

OData API calls

Include the parameter paging=snapshot in your OData API call as the example below:

https://api12preview.sapsf.eu/odata/v2/EmpJob?$select=userId&paging=snapshot

 

Boomi

In your SuccessFactors Partner connector settings, enable the "Enable Snapshot Pagination For OData Queries" checkbox.

  Boomi.png

Note: The customPageSize parameter is set to 200 only to show the example and usage of the parameter, this needs to be adopted by the implementation consultant accordingly based on the response time and number of navigation entities being queried.

 

CPI

Check out the KBA 2830254 - How to enable Server Snapshot Based in SuccessFactors OData API using SAP Cloud Platform Integration CPI.

 

Integration Center

In your IC jobs settings, under "Destination Settings" tab, select the "Enable Server Side Pagination" checkbox.

 Integration Center.png

See Also

  • Pagination chapter from SAP SuccessFactors API Reference Guide (OData V2);
  • KBA 2830254 - How to enable Server Snapshot Based in SuccessFactors OData API using SAP Cloud Platform Integration CPI;

Keywords

miss, missing, missed, duplicated, incorrect, inacurate, wrong, different, discrepant, data, value, values, record, records, return, returns, returned, query, get, api, call, slowness, performance, how to, enable, set, use, snapshot, cursor, server, based , KBA , LOD-SF-INT-ODATA , OData API Framework , LOD-SF-INT , Integrations , LOD-SF-INT-INC , Integration Center , LOD-SF-INT-CUS , Boomi & CPI (HCI) Custom Content , LOD-SF-INT-HCI , Standard SF to 3rd Party CPI (HCI) Content , Problem

Product

SAP SuccessFactors HXM Suite all versions