SAP Success Factors + GoodTime Integration Guide

 

 

OAuth workflow:

GoodTime uses OAuth 2 to authenticate SuccessFactors users securely. To Authenticate your org with GoodTime, you must set up a new OAuth 2 Client from within the ATS. In this section, we present the instructions on how to do this.

1. Create a new OAuth2 Client Application

   From the ATS homepage, search for “OAuth”, and click the option “Manage OAuth 2 Client Applications”.

   

2. Create a new Client Application by clicking the "Register Client Application” button.
   
   
   
    
3. Fill in the form, making sure the “Application URL” corresponds to your SuccessFactors instance API URL, ending with the “/oauth/token” path. If you don’t know your API URL, see these SAP support docs.
   
   
   
   
   
   
   
    
4. After filling in the fields, generating the certificate, and clicking “Register,” and then on the next screen add a descriptive name hit "Generate"
   
5. Your created Client Application should look like the screenshot below.
   
   
   
   
   
    
6. Make sure you save the generated API Key, and the generated Certificate
7. Open the downloaded file in any text editor, copy the long string PRIVATE KEY - you will need it in the next step. The string can be very long, make sure to copy it all.
   
8. Share the following information with the GoodTime Professional Services Integration team in order for us to establish your integration between GoodTime and your SAP Success Factors account:
   
    
   1. Company ID: the ID of the company in the SuccessFactors ATS
   2. API Key: the API key available in the OAuth2 Client Application (step 4 screenshot)
   3. Token URL: the “Application URL” field available in the OAuth2 Client Application (step 4 screenshot)
   4. X.509 Certificate: the certificate generated in the OAuth2 Client Application (step 4 screenshot) **Must be the full .pem file
   5. API User ID: the ID of the user with the API permissions who generated the certificate for the Client Application
   6. candidateProfileUrlTemplate: The URL of your SuccessFactors portal
9. Once all steps are completed, GoodTime can begin the data sync. The length of the sync is dependent on how much data (candidates/jobs/users) is in SuccessFactors.

 

OData API Permissions

Goodtime needs permission to read Candidates, Users, and Jobs. To enable that:

Go to Admin Center → Manage Permission Roles → [API Role] → Recruiting Permissions → Candidate and enable “OData API Candidate Export”

This example is for Candidates, but the process is the same for other entities. The screenshots below demonstrate how to enable that step-by-step:

 

 

ODATA API Dictionary Configuration

• SuccessFactors OData API requires extra setup in some cases to use the $expand query param.
• The screenshot below demonstrates that the API request fails when this is not properly set up for the JobRequisition entity.
  

• The 400 response with the code

  COE_PROPERTY_NOT_FOUND

  means one of the attributes used in the $expand query parameter is not configured. In the screenshot example, the JobRequisition entity is missing the config for the “state” field.

• To set up the properties, follow the steps:
  1. Search for “OData API Data Dictionary” in the search bar on the home page of SuccessFactors
     
  2. In the OData API Data Dictionary page, click the “Entity” tab, and search for the entity name in the search field, for example, “JobRequisition”
     

  3. Look for the property name, and make sure the values for columns “sap:visible, sap:sortable, sap:filterable” are set to

     true
     

 

 

Data Entities Synced from SAP Success Factors to GoodTime:

GoodTime ATS integrations operate on a principle of least access, meaning we will only access the data necessary for us to support your scheduling processes and nothin more.  While GoodTime uses API calls to pull basic candidate, job and user data we do not store this information outside of the time needed for it to support the scheduling workflow.  All details of scheduled events are pushed back to your SAP Success Factors account and as such you ATS will always remain the source of truth for candiate and pipeline related information.  GoodTime will simply hold a record of any interview scheduled via GoodTime for your candidates.