SAP Knowledge Base Article - Public

2251702 - OData API Integration with SuccessFactors

Symptom

  • The OData API is a solution with allows to export, create and update operations in the Recruiting Module.
  • This KB article explains what OData API is and what possibilities it offers when in use with the Recruiting Management Module.
  • Note the OData API does not replace the SFAPI solution. It is an alternate integration.

Environment

SAP SuccessFactors Recruiting

Resolution

What is OData API?

  • The OData / Common Data API is a new API for accessing objects in the SuccessFactors HXM Suite.
  • This API can be used both by SuccessFactors/SAP module engineering teams, and by customers and partners for external integrations.
  • The API provides a REST based web service following the OData protocol.
  • OData (Open Data) is a web protocol for querying and updating data. For more information on OData, see http://www.odata.org
  • OData API allows export, create and update operations. Meaning clients/Partners can use this API to create/update information about the Requisition, Applications and Candidate data entity including:
  1. Basic Requisition data (custom & standard fields)
  2. Application attachments (standard & custom)
  3. Questions
  4. Multiple Job Languages
  5. Basic Application data (custom & standard fields)
  6. Batch Operations for Applications
  7. Candidate Entity: Candidate Comments, Candidate tags, Forward Candidate to Requisition

OData API allows following actions within Recruiting:

- Job Profile Builder (UPDATE/CREATE)
- Headers & Footers (UPDATE/CREATE)
- Workflow/route maps (UPDATE/CREATE)
- Batch processing (UPDATE/CREATE)
- Re-assigning job requisitions (UPDATE/CREATE)
- Application audit (READ only)
- Application snapshot (READ only)
- Candidate batch processing (UPDATE/CREATE)
- Querying the referral table of the forwarded candidates (READ only)
- Offer Approval (READ/UPDATE/CREATE)
   -> Implemented as JobOffer
- Pre-screening questions (READ)
   -> New prescreen entity to allow for easy reporting off of application questions and answers
       = JobReqScreeningQuestion - questions related to a Job Requisition
       = JobReqScreeningQuestionChoice - the possible choices of MULTI_CHOICE and RATING related to a JobReq Question
       = JobApplicationQuestionResponse - the questions' responses
- Offer Letter (READ/UPDATE/CREATE)
   -> Implemented as OfferLetter
   -> sendMailOfferLetter - function import to send an offer letter via email
- Application Portlet: Onboarding (READ/UPDATE)
   -> JobApplicationOnboardingData - the onboarding portlet of a job application
   -> JobApplicationOnboardingStatus - the status of a job application onboarding
- Application Portlet: Jobs Applied (READ)
   -> Implemented as a navigation inside Candidate entity. Can be found as "jobsApplied" inside the Candidate entity.
- Initiate Onboarding (CREATE)
   -> initiateOnboarding (function import for initiating onboarding)
- Interview Central (READ)
   -> ApplicationInterview - has the information of the interview related to an application
   -> InterviewOverallAssessment - has the overall ratings and navigation for the individual assessments of an interview
   -> InterviewIndividualAssessment - has the rating and competency information of an individual assessment of an interview
- Templates (Job requisition, Application and Offer Detail) (READ)
   -> These entities are not readable as a regular entity, they are listed on OData API Dictionary, with the template's properties:
        = JobAppTemplate_<TemplateName>
        = JobReqTemplate_<TemplateName>
        = JobOfferTemplate_<TemplateName>

Use cases:

  • You can build a custom integration to create requisitions within RCM from a third party system
  • You can build a custom integration to send recruiting information along with attachments into a third party system
  • You can update requisitions within the BizX application form a third party system
  • You can build a custom integration to create Applications within RCM from a third party system.
  • You can build a custom integration to send Application information along with attachments to a third party system
  • You can update Applications within RCM from a third party system

Not supported yet (but on the Roadmap):

  • Recruiting Groups
  • Application portlets (offer, correspondence, background)

Configuration:

The configuration of the OData API Integration requires Professional Services engagement.

Granting permissions in the instance:

  • RBP:  Role > User Permissions > Recruiting Permissions > OData API Requisition Export
  • Non-RBP: Recruiting Permissions > OData API Requisition Export
  • RBP:  Role > User Permissions > Recruiting Permissions > OData API Requisition Create
  • Non-RBP: Recruiting Permissions > OData API Requisition Create
  • RBP:  Role > User Permissions > Recruiting Permissions > OData API Requisition Update
  • Non-RBP: Recruiting Permissions > OData API Requisition Update
  • RBP:  Role > User Permissions > Recruiting Permissions > OData API Application Export
  • Non-RBP: Recruiting Permissions > OData API Application Export
  • RBP:  Role > User Permissions > Recruiting Permissions > OData API Application Create
  • Non-RBP: Recruiting Permissions > OData API Application Create
  • RBP:  Role > User Permissions > Recruiting Permissions > OData API Application Update
  • Non-RBP: Recruiting Permissions > OData API Application Update

Keywords

sf, success factors, RCM, o data, configuration, configure, integrate, set up , KBA , LOD-SF-RCM-API , Webservices & APIs , LOD-SF-INT-RCM , RCM-Any Integration , How To

Product

SAP SuccessFactors Recruiting all versions