SAP Knowledge Base Article - Public

2788044 - How to query Compa-ratio and Range Penetration via OData API

Symptom

This document provides information on how to query transient values from the Compensantion Information portlet on Employee Central.

Environment

SuccessFactors BizX - all versions.

Resolution

In order to query these transient values it is recommended to use the entity empCompensationCalculated.

This entity exposes a transient value that you see in the Compensation Information portlet.
For information about the entity metadata and supported operations, please refer to your OData API dictionary in the Admin Center or use the Entity query:https://<hostname>/odata/v2/Entity('<Your Entity')?$format=json

Use Cases

https://<hostname>/odata/v2/ EmpCompensation?$filter=userId%20eq %20'TestUser'& $expand=empCompensationCalculatedNav

- This API call retrieves the empCompensationCalculated value as an $expand of EmpCompensation.

Tell Me More

This transient value is calculated by:

  • GetCompaRatioByUserDateAndSeq - This calculates the Compa-Ratio field that you see in the Compensation Information portlet.
  • GetRangePenetrationByUserDateAndSeq - This calculates the Range Penetration field that you see on the Compensation Information portlet. Neither Compa-Ratio nor Range Penetration is stored on the database so both fields are treated as transient fields. If you want to expose their values, you need to use empCompensationCalculated.

It has been designed for use in UI scenarios and is not suitable for mass data replication.

See Also

Find more information on the SAP SuccessFactors Employee Central OData API: Reference Guide

Keywords

Comp-Ratio; Range Penetration; compInfo; Compensation Information portlet; OData; Transient fields; , KBA , LOD-SF-INT , SF Integrations - EC Payroll, Boomi/ HCI, API , LOD-SF-INT-ODATA , OData API Framework , How To

Product

SAP SuccessFactors HCM Core all versions