SAP Knowledge Base Article - Public

2318180 - Fields supported in 'Where' clause of Compound Employee API

Symptom

This KBA lists out the Filterable fields or the fields supported in 'Where' clause of Compound Employee API.

In the where expression select parameters and operators can be used to restrict the query response.

The Compound Employee API does not support expressions with complex conditions on several fields and different logical operators

Environment

  • SAP SuccessFactors HXM Suite
    • Compound Employee

Resolution

Select parameter

Remark

Operators

LAST_MODIFIED_ON

Returns all employees, for which any employee data has changed since this date and time.

=, >, >=, <,<=

START_DATE

Returns all employees, for which any employee data gets effective from this date on.

>=

COMPANY_TERRITORY_CODE

Returns all employees that have a job at a company located in the provided country at any point in time. The companies are determined via table FO_LEGAL_ENTITY_T.

=, IN

PERSON_ID

Returns all employees with the respective PERSON_ID.

=, IN NOT IN

PERSON_ID_EXTERNAL

Returns all employees with the respective PERSON_ID_EXTENRAL.

=, IN NOT IN

USER_ID

Returns all employees with the respective USER_ID.

=, IN NOT IN

COMPANY

Returns all employees that have a job at the selected company. The select is based on the external code of the company. All employees will be returned that have at least one time slice with this company. 

=, IN

EMPLOYEE_CLASS

Returns all employees having a job of the respective EMPLOYEE_CLASS. The select is based on the external code of the employee class.

=, IN

DEPARTMENT

Returns all employees having a job in the provided department. The select is based on the external code of the department.

=, IN

DIVISION

Returns all employees having a job in the provided division. The select is based on the external code of the division.

=, IN

BUSINESS_UNIT

Returns all employees having a job in the provided business unit. The select is based on the external code of the business unit-

=, IN

LOCATION

Returns all employees having a job in the provided location. The select is based on the external code of the location.

=, IN

JOB_CODE

Returns all employees having a job with the provided job code. The select is based on the external code of the job code.

=, IN

PAY_GROUP

Returns all employees having a job with the provided pay group. The select is based on the external code of the pay group.

=, IN

COMPENSATION_PAY_GROUP

Returns all employees having a compensation with the provided pay group. The select is based on the external code of the pay group. =, IN
SNAPSHOT_DATE Returns the employee data for a certain point in time.

=

fromDate … toDate

Selects employees that have changes becoming effective within the given period. Additionally, the period is applied as filter to all effective dated segments, so that only timeslices are returned that intersect with the given period.

This select parameter can only be applied when using delta transmission and needs to be combined with ‘last_modified_on’ select parameter.

=
SourceOfRecord Returns all employees having an employment with the provided source of record information. The select is based on the external code of the source of record information. Note: the field needs to be enabled and made visible in data model before this filter parameter can be used. Additionally in data model a picklist needs to be assigned to the sourceOf Record field. =, IN
isContingentWorker

Returns all employees having an employment with the provided value in field IsContingentWorker. Possible comparison values for the IN operator and the equal operator

are ‘true’, ‘t’, ‘1’, ‘yes’ and ‘false’, ‘f’, ‘0’, ‘no’. If the value in the field on the database is undefined (technically spoken

‘null’) this is treated in the same way as if it would be ‘false’. The absence of the ‘isContingentWorker’ condition is treated as isContingentWorker = ‘false’ to preserve compatibility with older integration processes which expect only real employees. In order to select all persons which are contingent workers or not, use the condition isContingentWorker IN (‘true’, ‘false’).

=, IN
replicationTargetSystem Can only be used in combination with the where expression parameter replicationContentType and select item EmployeeDataReplicationElement in the SELECT clause. Defines for which replication target system the Employee Data Replication data shall be retrieved. =
replicationContentType Can only be used in combination with the where expression parameter replicationTargetSystem and the select item EmployeeDataReplicationElement in the SELECT clause. Defines for which replication content type the Employee Data Replication data shall be retrieved. =
hiringNotCompleted Evaluates the indicator property hiringNotCompleted in the EmpEmployment entity in Employee Central, which was introduced for Onboarding (2.0). The property allows for differentiat-ing data records of candidates (that is, new hires that didn't yet complete the Manage Pending Hire process). If hiringNotCompleted is false, the CompoundEmployee API returns only data of hired employees.

=

Note: Possible compari­son values are: false, f, 0, no. That is, you can use the hiringNotCompletedfilter in the WHERE condition only to exclude employments of candidates in the result.

One further parameter plays a special role, since it is not directly applied when selecting the data but used for filtering of the result (see also explanations below).

Filter Parameter

Remark

Operators

EFFECTIVE_END_DATE

The condition is applied as filter to all segments of the employee which are effective dated. Depending on the operator the following results are returned:

‘=’: The query returns the entry of an effective dated segment which is valid on the given date (EFFECTIVE_START_DATE <= given date <= EFFECTIVE_END_DATE).

‘>=’: The query returns only those entries of an effective dated segment that have an EFFECTIVE_END_DATE greater or equal than the given date.

=, >=

 NOTE: Also see the limitations on Compound Employee API when defining multiple parameters in where clause.

See Also

2320830 - Limitations of the Compound Employee API

Keywords

field, where, parameter, filter, select, query, compound employee, compoundemployee, api, call, fetch, operator, sf, , KBA , LOD-SF-INT-API , API & Adhoc API Framework , LOD-SF-INT , Integrations , LOD-SF-INT-CE , Compound Employee API , How To

Product

SAP SuccessFactors HXM Suite all versions