Filtering SuccessFactors Account Aggregation

Use account aggregation filters to limit the employee and user records that the source aggregates.

Filtering Employment Based on assignment_class

The SuccessFactors connector supports filtering specific employment records during employee and user aggregation based on the assignment_class attribute. To apply a filter based on assignment_class, submit the change to the VA using the SailPoint V3 Sources REST API.

PATCH  https://<orgName>.api.cloud.sailpoint.com/v3/sources/<SuccessFactorSourceId>

assignment_class Filter

Description: This attribute is used to filter specific employment records during employee and user aggregation.

Resolution: Use this filter to pull only those employment records that match the desired assignment_class value.

Example: If you want to fetch employment records where the assignment_class is "ST", use the following format:

[
 {
  "op": "add",
  "path": "/connectorAttributes/employmentFilter",
  "value": {
      "employment.assignment_class": "ST"
  }
 }
]

Aggregation Query Filter

The Aggregation Query Filter is used to filter employees when the Account Type to Manage setting is set to Employees.

Viewing the EmpJob Entity

To view the EmpJob entity in your SuccessFactors tenant:

1. Go to Admin Center > ODATA API DATA dictionary > Entity.

2. In the Name field, search for EmpJob.

   

Query Examples

Use the following examples to configure your own aggregation queries.

For more information on the available operators, refer to the $filter section of the SAP SuccessFactors API Reference guide.

• To filter employees from a specific department and division:

  department eq "50000300" and division eq "EXEC"
  

• To filter employees from company A and company B:

  company in "A", "B"
  

• To filter employees based on their start date:

  startDate gt datetime"2023-06-06T00:00:00"
  startDate lt datetime"2023-06-06T00:00:00"
  

  Note

  The date format is the two-letter timezone abbreviation datetime:

  yyyy-MM-dd-THH:MM:SS
  

Finding Proper Values (externalCode) for Query Filter Parameters

In the ODATA API, some properties require external code values to fetch the data.

For example:

company eq "8500"

In this example, 8500 is an external code for the BestRun Australia company.

To get external codes for any property from your SuccessFactors tenant:

1. Go to the Admin Center.
2. Go to Manage Data.
3. Search for the property name. For example, Division, Department, or Position.

4. The adjacent dropdown list contains all the associated values with labels and their codes in parentheses.

   For example, in the following screenshot, Corporate is the label and CORP is its associated code so the filter query would be businessUnit eq "CORP"

   

Property Names and Navigation Path for the External Code

The following table lists property names and their associated navigation path to get the external code:

Property Names and Navigation Path for the External Code from Picklist Center

The following table lists the properties and their associated navigation path for the external code from the Picklist Center:

Validating Query Filters

To validate query filters during test connection processes:

1. In the SailPoint SuccessFactors SaaS connector configuration page, go to Aggregation Settings > Filter Criteria For Employees.
2. Enter the query filter statement you want to validate in the Aggregation Query Filter field.

3. Select Validate Aggregation Query Filter.

   The query validation occurs when the test connection operation is performed.

Additional Parameters

The parameters listed on this page enable you to further customize the account aggregation process.

excludePendingHires

Controls whether the connector aggregates onboarding and future hires during account aggregation.

• true (default) - Onboarding and future hire accounts are included in account aggregation
• false - Onboarding and future hire accounts are excluded from account aggregation

Documentation Feedback

Feedback is provided as an informational resource only and does not form part of SailPoint’s official product documentation. SailPoint does not warrant or make any guarantees about the feedback (including without limitation as to its accuracy, relevance, or reliability). All feedback is subject to the terms set forth at https://developer.sailpoint.com/discuss/tos.