Configuration Parameters

Unique endpoint URL to connect SuccessFactors system through API

For example, https://<hostname>.successfactors.com:<port>

Select the authentication type provided by SuccessFactors

Authorization grant to used to obtain access token

Enter the company ID for user provisioning. During the SuccessFactors solution licensing, a unique company ID is provided. The OData API uses the company ID attribute to validate your access token.

Enter the client identifier (a unique string) issued by the authorization server to your client application during the registration process. You obtained the client ID while performing the procedure specified in Register a Client Application in SuccessFactors.

Note
Client ID information is required for OAuth 2.0 authentication.

ID of the user with the required permissions mentioned in Required Permissions

Extracted key from X.509 Certificate of SuccessFactors using OAuth 2.0 client application

Note
Private key information is required for OAuth 2.0 authentication for accessing SuccessFactors OData API.

SuccessFactors picklist mapping for update operations only. Enter the picklist mapping as per your tenant configuration. For multiple entries use new line as a separator. For example:

BusinessEmail =<Picklist optionID>

BusinessPhone=<Picklist optionID>

Enable to aggregate Future Hires.

Enable Aggregate Primary Employment to include Primary Employment attributes in employee aggregation. This applies to active and future-dated employees.

If you disable Aggregate Primary Employment, the source aggregates the most recent employment attributes. Aggregate Primary Employment is disabled by default.

Indicates the number of days to aggregate the future hires. This field supports the following values

• Default – 30

• 0 – Aggregate no future hires

• A positive value – Indicates the number of days ahead of the current date to aggregate future hires

• -1 – Aggregates all future hires until 9999-12-31

Enable to aggregate inactive employee records

Enter the number of past days to aggregate inactive employees. This field supports the following values:

• Default – 30

• 0 – Aggregates only active Employees

• Any positive value – Indicates the number of retroactive days to aggregate inactive accounts

• -1 – Aggregates all inactive employees

In the Aggregation Query Filter field, enter a query filter for employees. The aggregation query filter is only applicable for the EmpJob entity and only property names with a sap:filterable value of true can be used in the filter query. For more information and examples, refer to Aggregation Query Filter.

Enable Validate Aggregation Query Filter to validate the entered query filter when the test connection is performed.

Enable to aggregate inactive users

Enable Aggregate Primary Employment to include Primary Employment attributes in user aggregation. This applies to active and future-dated users.

If you disable Aggregate Primary Employment, the source aggregates the most recent employment attributes. By default, Aggregate Primary Employment is disabled.

Enter the name of the compound employee API extended sub-structures/entities to query for additional attributes. Use commas to separate multiple values.

Older SuccessFactors connectors will have predefined values for Include Compound Employee API Entities. To add new attributes to the managed system, make sure the attribute used as a column in the SOAP query returns a valid result. If the SOAP query response is valid, then that attribute can be added to the Include Compound Employee API Entities field.

For example:

If the SecondaryAssignments attribute is added to Include Compound Employee API Entities, then the following query execution in the SOAP tool should return a valid result.

select person,personal_information,address_information,email_information,phone_information,employment_information,job_information,compensation_information,paycompensation_recurring,paycompensation_non_recurring,accompanying_dependent,alternative_cost_distribution,job_relation,BenefitsIntegrationOneTimeInfo,BenefitsIntegrationRecurringInfo,deduction_recurring,deduction_non_recurring,global_assignment_information,ItDeclaration,personal_documents_information,associated_employee_information,person_relation,payment_information,direct_deposit,EmpCostAssignment,national_id_card,dependent_information,emergency_contact_primary,DRTMPurgeStatusOverview,SecondaryAssignments from CompoundEmployee where isContingentWorker in(‘true’,‘false’) and user_id IN(‘xyz’,) ORDER BY start_date DESC