Invoke Operations Page

Select the operation type and business object on which to perform the operation.

Select the endpoint type:
  • OData: (Open Data Protocol) select this option to search/retrieve a record for the selected object from the SAP SuccessFactors application and create/merge/replace/upsert a record in the SAP SuccessFactors application using the OData API.
  • SOAP: (Simple Object Access Protocol) select this option to search/retrieve a record from the SAP SuccessFactors application and insert/upsert/update/delete a record in/from the SAP SuccessFactors application using the SOAP API.

OData

Element Description
Select Entity Select an entity such as Currency, Job Application, User, and so on.
Filter by entity name Type the initial letters of the entity to filter the display of names in the list.
Select an Operation Type Select an operation name, such as Search, Get, Create, Merge, Replace, or Upsert.

SOAP

Element Description

Select an Operation Type

Select the type of operation to perform on the business objects in an SAP SuccessFactors application:

  • CRUD: Displays the insert, upsert, update, and delete operations to perform on SAP SuccessFactors business objects. Select the operation and the business object on which to perform the operation.

  • SFQL: (SuccessFactors Query Language) enables you to define an SFQL-based query to send a request for querying a particular business object and retrieve the respective object’s information, which is queried from the SAP SuccessFactors application. If you select this option, the page is refreshed to display a text box for entering a query.

    Note: The SAP SuccessFactors Adapter does not currently support the LegacyLearning object.

    • SFQL query statement: Enter a valid SFQL query in the text box. The query can include custom fields and parameters. For example:
      SELECT guid,name FROM Goal$7 WHERE userid = ‘USR-22'

      Use the Find field to search for an entry in the SFQL query and the Go to Line field to go to a specific line in the SFQL query.

      The query can include custom fields and parameters.

      Use the inputBatchSize field to enter a batch size value to fetch a batch of records. You can specify the batch size as per your requirement. You can enter a numeric value between 1 and 800. The default value is 200.

      If you need to fetch more than the inputBatchSize value, use the queryMore operation. When you select SFQL as the operation type, a querySesssionId field is added to the request mapping. The querySessionId element performs the queryMore operation in the ongoing session for the respective query. This can be mapped for passing the sessionId for the ongoing query to fetch another batch of records with the batch size being the inputBatchSize per request.

      To perform a simple query operation without bind parameters, map the querySessionId element in the mapper and pass it as blank in the request payload. If the query response contains more than the inputBatchSize elements, handle this scenario using a while loop instead.

      The queryMore operation, using querySessionId, cannot be performed if the session for an ongoing query has expired or your login session has been renewed. This design is similar because SAP SuccessFactors supports the queryMore operation. The queryMore operation can be implemented only in orchestrated integrations. For a use case that uses the queryMore operation, see About SAP SuccessFactors Adapter Use Cases.

    • Binding Parameters: Displays any binding parameter, if included, in the specified query. For example, ‘firstname’ is a parameter in the following query:
      SELECT firstname,lastname FROM user WHERE firstname = ‘&firstname’ 
      Enter a query with a parameter and press the Refresh button above Binding Parameters. A text box in which to enter a test value for the parameter is displayed.
    • Test My Query: Click to validate the query against the SAP SuccessFactors application. The query response is displayed for a successful query. If the query is invalid, you receive a response for the errors in the query.

Filter by object name

Enter the initial letters of an object name to display a range of objects. You can also select a filter type:

  • All: Displays all objects available for the selected operation.

  • Custom: Displays objects that can be created in the SAP SuccessFactors application for the selected operation. These business objects are identified by special icon (‘-’). For example, Goal-1, DevelopmentGoal-2002.

  • Standard: Displays business objects delivered as part of the SAP SuccessFactors application.

Select Business Objects (sfapiv1 API)

Select a business object from the SAP SuccessFactors application (multiple objects are not supported). The selected operation acts on this business object. The SAP SuccessFactors API version that is displayed is based on the SAP SuccessFactors Cloud application version to which you are connected.

Your Selected Business Objects

Displays the selected business objects.

What is this Object

Describes the selected business object.