Skip to Content
Technical Articles
Author's profile photo Jayesh Kulkarni

Integration of SAP UI5/FIORI apps with SAP SuccessFactor

Hi All,

This blog post is regarding integrating the SAP UI5/FIORI app with SAP SuccessFactors. I was working on a project where some custom application was needed to achieve a task which was not possible by SuccessFactors alone. The solution was to make a custom UI5 app and deploy it as a tile within SuccessFactors with navigation to external URL which will make this task possible. I have gone through lots of blogs to accomplish this. But unfortunately, there is no complete blog to achieve this task. Somehow, I was able to complete this task. I will take you through the steps involve in achieving this task.

 

Introduction: 

SuccessFactors come with API Centre which has OData API Data Dictionary  where you will find the entities of all the SuccessFactors modules. My requirement was to use the RCM Module of SuccessFactors and use JobApplication, JobRequistion & OfferLetter  entities in my read & insert operation.

Prerequisites:

  • SAP Cloud Platform account with SAP WEB IDE
  • SAP SuccessFactors API Centre Access
  • Provision to create/update data in SuccessFactors from OData API

API%20Centre

API Centre

 

Steps:

Step1: Add details of your SuccessFactors system in SCP destinations as below

 

                SCP%20Destinations

SCP Destinations

 

 

Note: User field in destinations has to be in the form of User@CompanyID

 

Step2: Get all the required Integration permissions in SuccessFactors Admin Centre

Permissions%20in%20Admin%20Centre

Permissions in Admin Centre

Step3: Get the required entities from OData API Data Dictionary and Check which operations are supported for that particular entity Eg. Query, Insert, Merge, Replace, Upsert, Delete.

 

OData%20API%20Data%20Dictionary

OData API Data Dictionary

 

Step4:  Add below code in controller of UI5 app  for Query (Read) operation.

 

Step5:  Add below code in controller of UI5 app for Insert (POST) Operation

Insert%28POST%29%20operation

Insert(POST) operation

Note: Pass all the mandatory (sap: required) values in the payload, otherwise you will get an error. You can check which fields are mandatory in sap: required column in OData API Data Dictionary. Likewise, you can perform all the operations also like Upsert, Merge, Delete etc.

Step6: Deploy your application to SAP Cloud Platform and copy the app URL generated and create a custom Tile on SuccessFactors using Manage Home Page option and Paste app URL in navigation tab

ManageHome%20Page%20in%20SuccessFactors

ManageHome Page in SuccessFactors

Click%20on%20Add%20Custom%20Tile

Click on Add Custom Tile

Paste%20your%20URL%20in%20Navigation%20tab

Paste your URL in Navigation tab

Save your changes !!

Note: You can check error logs in OData API Audit Logs in API Centre, if you face any issue while performing any operation.

I hope this blog post will be useful for the developers trying to integrate SuccessFactors with UI5/FIORI apps. Please provide your valuable feedback if you find this blog post helpful.

 

Regards

Jayesh Kulkarni

 

 

 

 

 

Assigned tags

      3 Comments
      You must be Logged on to comment or reply to a post.
      Author's profile photo Dominik Meier
      Dominik Meier

      Dear Jayesh,

      thx a lot for your post. I was a bit wondering, why you used SAP WEB IDE & SAP SuccessFactors API Centre Access.

      Can the same be achieved via SAP Business Application Studio & SAP API Business Hub?

      Thx,

      Dominik

      Author's profile photo Jayesh Kulkarni
      Jayesh Kulkarni
      Blog Post Author

      Hi Dominik,

       

      Sorry for replying late!

      It should be possible to achieve the same with BAS and API Business Hub.

      For me, I was working on an engagement where SAP SuccessFactors API was used widely as a product and they want the custom app to appear in their SAP SuccessFactors product.

       

      Regards,

      Jayesh

       

      Author's profile photo Mamatha Majji
      Mamatha Majji

      Hi Jayesh,

      Nice blog and concept of integrating UI5 app in Success factors is very helpful who is new to it.

      I have doubt like can we move or update from one Success Factor Demo system to another System using BAS and by doing OData service calls using OData API of SF.

      My Requirement is I have two Company Id's for two Success factors Demo systems I have to move(post) data from one demo system to another system.

      By adding destination of SF I can able to read the SF API data in my UI5 App  using Odata service calls in BAS but while doing Update Operation I am getting "500" error as Internal server Error.

      Could you pls give me clarity that  is it possible to move data from one SF system to another.

      Thanks in Advance,

      Regards,

      Mamatha