Success Factors Integration SFAPI/Odata Tools
SFAPI/Odata Tools provide some features query builder,job status and entity defintion(data dictionay).
This was very useful in SF and HCM integration project. i will show you two functions. rest you can explore yourself.
https://sfapitoolsflms.hana.ondemand.com/SFIntegration/
link to access sfapi tools
https://sfapitoolsflms.hana.ondemand.com/SFIntegration/sfapitools.jsp
1. **Improved** OData Query Tool – Graphical OData Query Builder.
2. SFAPI Async Job Management (SFAPI Login Required)
click on option four.
1. **Improved** OData Query Tool – Graphical OData Query Builder.
this helps you view the entity records. you have option of building your query. select your entity which you want to query. here i am using User entity.
you will get list of fields available under entity. select your entity and list of fields to display.
when you place the cursor on the filed, it will show you the properties. if Filterable is true, you can select it under query.
if you place the cursor on the filterable field , it will allow you to enter the data in operand box.
you can even group the records, using “OR and AND condition.
execute the query, it will show you list of records, with selected columns.
if you click on user it will show your entire data for that user.
json message
if you want to select the records without any filter, you can do that.
next blog SFAPI Async Job Management i will explain about sfapi job management.
Regards,
Muni.
Ref:
Hands-On – Testing Integration with Succe… | SCN
Hands-On – Testing Integration with SuccessFactors OData API
Hi,
i have some tech issues with **Improved** OData Query Tool – Graphical OData Query Builder.
All the fields in any API are undefined. Who knows why this happened?
Hi Alex,
are you able to fix the issue.
you May raise SAP ticket to API team on this.
Thanks ,
In case it helps to the audience, herewith is another session showcasing the way the calls can be made to Successfactors to gather the data from the instance.
SAP Successfactors SFAPI execution details from SOAP UI
Hi Muni,
The link https://sfapitoolsflms.hana.ondemand.com/SFIntegration/sfapitools.jsp is no more available - do you know the new one ?
regards,
Thomas
Hi Thomas,
Not sure why this link has been brought down. I got this link from SAP support team when i was having issue in compensation integration scenario.
I would ask you to check with sap support team by raising ticket.
Regards,
Muni
For the reader’s benefit, following video offers good help:
SAP Successfactors SFAPI execution details from SOAP UI
And another video also helps gain insight in the Effective Dating aspect of Successfactors, it is explored via Odata APIs:
SAP Successfactors Effective Dating Basic Concept
For any kind of integration with SAP Successfactors , this is the must have course.
The course Details at: https://www.youtube.com/watch?v=1OtUTsHi_jE
Such a comprehensive course and taught in from the scratch, just the one I would recommend for any integration consultant and architect; its made available with money back guarantee , like it or money will be returned in 30 days.
Following is the course content, wherein more than 90% of the sessions are having hands on practical sessions and not only involving ppt slides:
Section 1: Introduction
1. Introduction
Section 2: SFAPI : Successfactors SFAPI URI and wsdl
2. What is the Data Center URL
3. Data Center URL significance
4. Gathering Data Center URL
5. Gathering Data Center URL continuation
6.* Further Steps , SFAPI URL and others
7. Formulation of SFAPI URL
8. SFAPI wsdl
9. SFAPI Enabled?
Section 3: Soap UI Set Up
10. SOAP UI Download and Install
11. SOAP UI Configuration changes, in view of Successfactors' TLS v1.0 disablement
Section 4*: Creating an API User ID to make SFAPI call
12. Creating an User ID for the SFAPI calls
13. Creating User IDs via Option 1(Provisioning)
14. Creating API User IDs via Option 2.1 (Successfactors Application UI)
15. Creating API User IDs Option 2.2 (Import Employee via SFSF Application UI)
Section 5*: Setting the Password for the API User
16. Setting the Passwords for the API User IDs created above
17. Setting the Password for the API User - Option 1.1
18. Setting the Password for the API User - Option 1.2
19. Setting the Password for the API User - Option 2
20. Setting Password for the User - Option 3 and 4
21. Considerations when SSO is enabled
22. Considerations for SSO - Enabling the loginMethod field
23. Making First SFAPI call !
Section 6: SFAPI Methods And Parameters
24. SFAPI Methods
25. Understanding SFAPI wsdl
26. Preparation for the Hands ON Sessions on API calls
27. Setting API User login exception
28. Making the call to SFSF to retrieve the List of the SFAPI SFObjects
29. Making the SFAPI Call for Session Management and MetaData Inspection methods
30. SFAPI call for Data Query Category (query and queryMore)
31. SFAPI call for Data Manipulation Category (upsert call)
32. SFAPI Call for Asynchronous Operations
Section 7: OData : Tools to make the OData call
33. Postman Set Up
34. SOAPUI : Making Rest Calls from SoapUI
35. Advanced Rest Client from Chrome
36. Chrome/FireFox Browser
Section 8: Odata Basics (with relation to Successfactors Odata service)
37. Odata Introduction and Structure Components
38. OData Basics : Service Document vs. Service Metadata Document
39. OData Basics : Entity Metadata Document-comparison with other documents
40. OData Basics : How to gather Service Document , Service and Entity Metadata Docs
41. OData Basics : Understanding Service Metadata Document - EntitySets , EntityType
42. OData Basics : Understanding Service Metadata Document - AssociationSet and Type
43. OData Basics : Understanding Service Metadata Document - Navigation Property
44. OData Basics : Understanding Service Metadata Document - Function Imports
45. OData Basics : Understanding Entity Metadata Document
Section 9: OData URI
46. OData URI : Introduction and How to gather the service root uri for Odata calls
47. OData URI : URI and its components - All components
48. OData URI : URI and its components - Resource Path -part I
49. OData URI : URI and its components - Resource Path -part II
50. OData URI : URI and its components - Query Options
Section 10: OData Query Options
51. OData Query Options: $orderby
52. OData Query Options: $top and $skip
53. OData Query Options: $top + $skip combined with $orderby
54. OData Query Options: $filter - Introduction
55. OData Query Options: $filter-supported Logical Operators
56. OData Query Options: $filter-supported Arithematic Operators
57. OData Query Options: $filter-supported Grouping ,Customized & String Operators
58. DateTime and DateTimeOffset DataType fields
59. OData Query Options: $filter - supported DateTime Operators -Part I
60. Time DataType fields
61. OData Query Options: $filter-supported DateTime Operators -Part II
62. OData Query Options: $filter-supported Numeric Datatypes
63. OData Query Options: $filter-supported Boolean Datatype
64. OData Query Options: $expand
65. OData Query Options: $format
66. OData Query Options: $select
67. OData Query Options: $inlinecount
Section 11: OData API User Permissions
68. OData : creating an API user and assigning the password
Section 12: Effective Dated Entities
69. Effective Dated Entities - What are They?
70. Effective Dated Entities - How are they defined?
71. Effective Dated Entities - The Concept
72. Effective Dated Entities - Advanced Concept
73. Different Modes in which Data can be entered in Successfactors
74. Concept of fromDate, toDate and asOfDate for Effective Dated Entities
75. Concept of fromDate, toDate and asOfDate for Advanced Effective Dated Entities
76. Initial data entry : Impact on effective dated objects
77. Correction Mode data entry : Impact on effective dated objects
78. Edit Mode data entry : Impact on effective dated objects
79. Insert and Delete Mode data entry :Impact on effective dated objects
Section 13: Effective Dated Entities behavior with Navigation
80. Effective Dated Entities behavior with Navigation : Rules
81. Effective Dated Entities behavior with Navigation : Advanced navigation concepts
Section 14: Effective Dated Entities : How can they be queried
82. Effective Date Entities: multiple parameters available to query 'em
83. Effective Dated Entities: Querying involving from/to/asOfDate
84. Effective Dated Entities: Querying involving start/endDate
85. Effective Dated Entities: Logic system follows when from/to/asOfDate are present
86. Effective Dated Entities: lastModifiedOn\DateTime parameters Rules
87. Effective Dated Entities-filter by lastModifiedDateTime scenarios Part-I
88. Effective Dated Entities-filter by lastModifiedDateTime scenarios Part-II
89. Effective Dated Entities-filter by lastModifiedDateTime scenarios Part-III
90. Effective Date Entities-filter by lastModifiedDateTime - Final Algorithm
Section 15: Effective Date Entities - Behavior with $expand
91. Effective Dated Entities behavior with $expand - Rules
92. Effective Dated Entities behavior with $expand - Further understanding - partI
93. Effective Dated Entities behavior with $expand - Further understanding - partII
Section 16: OData APIs : Push Operations
94. OData APIs : Push Operations : Overview
Section 17: OData APIs : Push Operations : INSERT
95. Section Overview : OData APIs : INSERT
96. INSERT : Is the operation supported by entity, required fields, URI, HTTP Verb
97. INSERT : Request Body : Are all fields supported for the operation?
98. INSERT : Allowable Field Values - Data Types and MaxLength
99. INSERT : Allowable Field Values - PickLists
100. INSERT : Allowable Field Values - MDF Objects
101. INSERT : Allowable Field Values - Navigation Links
102. INSERT : Allowable Field Values - OptionId or ExternalCode (PickList values)
103. INSERT : Perform Insert on the Entity via OData API
104. INSERT : Can Multiple Calls be posted in one OData Call
Section 18: OData APIs : Operations on Links
105. OData APIs : Links Overview
106. OData APIs : Query Operation On Links/Navigation
107. OData APIs : Create Operation on Links
108. OData APIs : Delete Operation On Links
109. OData APIs : Update Operation On Links
Section 19: OData APIs : Push Operations: UPDATE
110. UPDATE : Perform Update on the Entity via OData API
111. UPDATE : Perform a Replace Operation
112. UPDATE : Perform a Merge Operation
113. UPDATE : Some additional differences between Replace and Update Operation
Section 20: OData APIs : Push Operations : UPSERT
114. UPSERT : Introduction and initial call
115. UPSERT : Demystifying User and PerPerson relationship - a specific challenge
116. UPSERT : Further discussion over Upsert
117. UPSERT : processing parameter purgeType (full)
118. UPSERT : Which all entities support purgeType=full
119. UPSERT : processing parameter purgeType (incremental)
120. UPSERT : purgeType behavior with NO_OVERWRITE property of Entity
121. UPSERT : Understanding the EmpGlobalAssignment Object
122. UPSERT : processing parameter suppressUpdateOfIdenticalData
123. UPSERT : processing parameter fileLocale
124. UPSERT : Multiple Requests in one call
125. UPSERT : Multiple Inline Entity Types in one call -Part 1
126. UPSERT : Multiple Inline Entity Types in one call -Part 2
127. UPSERT : Avenue for Performance Improvement of Upsert call
Section 21: OData APIs : Operation : DELETE
128. DELETE : Deleting the entities
129. Use Case : Creating and Querying PickList entries
130. Use Case : Function Import : Add or remove users from the Static Group