SuccessFactors Data Integration (API)

Instructions for setting up the connection from One Model to SuccessFactors.

The preferred method of ingesting SuccessFactors data into One Model are the SuccessFactors oData API and SFAPI.  This method offers a secure repeatable process for extracting data with minimal additional effort.  Once the connector is configured, the One Model system is able to reach out to your SuccessFactors instance and pull data, rather than the customer having to configure extracts and transfers.  One Model's SuccessFactors connector offers full control over which entities and which columns are extracted.  All standard fields as well as customized fields including any use of the MDF framework can be extracted using this API connector.

SuccessFactors LMS data is currently not available via the SuccessFactors API - and may be requested from SAP SuccessFactors Professional Services via SAP SuccessFactors Learning Data Services.

Setup
These are the high level steps that must be completed in order to allow One Model to extract your SuccessFactors data:

  1. Create a user in SuccessFactors that can be used by One Model to extract data using the oData API and SFAPI

  2. Grant the user the necessary privileges (covered below)

  3. Configure the SuccessFactors authentication information within One Model

  4. Configure the Tables and Columns that you would like to extract from SuccessFactors

  5. Run the Connector!

SuccessFactors Permissions

The permissions necessary in SuccessFactors will be dependent on which module(s) you're interested in.  For most modules you can turn off access to specific fields you don’t want One Model to access, such as SSN.  The following is an example of the permissions for the Recruiting module.  Other modules will follow a similar pattern.

If you have questions while setting up permissions in SuccessFactors, someone on the One Model team will be happy to assist.  The team has a lot of experience with SuccessFactors.

Approved IP Addresses

In SuccessFactors, any user that does not have an expiring password needs to be given a list of IP addresses that this user can be accessed from. If you would like to configure your SuccessFactors user in this way, which will create a more stable Integration, these addresses can be provided by the One Model team.

Using OAuth 2.0

SuccessFactors has deprecated and is now moving to only support OAuth 2.0 for API Connections. To configure OAuth for SuccessFactors, follow the steps outlined in the SuccessFactors documentation (available here). To Migrate your SuccessFactors Connector in One Model to use OAuth, connect with your One Model Customer Success team to update the connector to make the new OAuth configuration available.

The only fields you will need to input into SuccessFactors are:

  1. Application Unique Name: This is whatever you want it to be, as it only shows in your SuccessFactors Instance. We recommend One Model or One Model Production

  2. Application URL: This can be any URL in your One Model instance. We recommend your home page.

  3. X.509 Certificate: This is generated as part of the SuccessFactors documentation (linked above).

Once this is complete, you will need the APIKey, and the Secret Key that were generated by SuccessFactors from the above process:

  • The API Key is created when you Register your OAuth Client Application.

  • The Secret Key is found when you create your X.509 certificate. This must be saved when the Certificate is created (or re-created) as it is not available later on.

In One Model

Create Data Source

Now that the user is set up and permissioned, let's configure and test the connection. Go to the Data Sources page within One Model, select "Add Data Source", and click SuccessFactors. You will then see the following configurable options:

 

Add the URI, SuccessFactors Company ID, and the User that has been setup with the correct permissions in SuccessFactors, then add the API Key and Secret Key configured before. Once this is done, select "Configure Entities", and the list of Entities available from your SuccessFactors Instance will be downloaded. Configure the ones you'd like to include, and Save your new connector.

Available entities

The following is a sample list of entities available.  Any of the entities can be expanded and specific columns can be selected/deselected.

 

Updating entities selection

SuccessFactors does not allow securing of individual MDF objects if server-side paging is used. To secure the SuccessFactors connector so that additional and unexpected endpoints cannot be added by a user who does not have the SuccessFactors user credentials, One Model has created a feature that allows users to secure their SuccessFactors connectors in the form of a configuration setup which is called Require Secret Key to edit Data Source.


If Require Secret Key to edit Data Source is checked on the configuration, updating the entities selection will require the password or Secret Key to save the changes. Otherwise, the entities can be freely updated when this configuration is disabled.

Scheduling

Both destructive and incremental extracts can be scheduled concurrently in One Model.  After the initial destructive extract, incremental extracts can be scheduled on a more frequent basis than destructive extracts.

 

 

 

Was this article helpful?

0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.