SAP SuccessFactors

Entities, operations, and actions

All the Integration Connectors provide a layer of abstraction for the objects of the connected application. You can access an application's objects only through this abstraction. The abstraction is exposed to you as entities, operations, and actions.

• Entity: An entity can be thought of as an object, or a collection of properties, in the connected application or service. The definition of an entity differs from a connector to a connector. For example, in a database connector, tables are the entities, in a file server connector, folders are the entities, and in a messaging system connector, queues are the entities.

  However, it is possible that a connector doesn't support or have any entities, in which case the Entities list will be empty.

• Operation: An operation is the activity that you can perform on an entity. You can perform any of the following operations on an entity:
  • List
  • Get
  • Create
  • Update
  • Delete

  Selecting an entity from the available list, generates a list of operations available for the entity. For a detailed description of the operations, see the Connectors task's entity operations. However, if a connector doesn't support any of the entity operations, such unsupported operations aren't listed in the Operations list.

• Action: An action is a first class function that is made available to the integration through the connector interface. An action lets you make changes to an entity or entities, and vary from connector to connector. Normally, an action will have some input parameters, and an output parameter. However, it is possible that a connector doesn't support any action, in which case the Actions list will be empty.

System limitations

The SAP SuccessFactors connector can process 10 transaction per second, per node, and throttles any transactions beyond this limit. By default, Integration Connectors allocates 2 nodes (for better availability) for a connection.

For information on the limits applicable to Integration Connectors, see Limits.

Actions

This section lists all the actions supported by the SuccessFactors connection.

UpsertEntity action

This action lets you upsert a record for an entity.

Input parameters of the UpsertEntity action

Output parameters of the UpsertEntity action

This action returns the status 200 (OK) with a response body indicating all Upsert results.

For example on how to configure the UpsertEntity action, see Examples.

Action examples

This section describes how to perform some of the actions in this connector.

Example - Update a record in the PerPersonal entity

The following example updates a record in the PerPersonal entity.

1. In the Configure connector task dialog, click Actions.
2. Select the UpsertEntity action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   "entityType": "PerPersonal",
   "payload": {
     "personIdExternal": "109031",
     "startDate": "1800-01-01 00:00:00.0",
     "firstName": "John",
     "lastName": "Job",
     "nationality": "IND"
     }
   }

If the action is successful, the connector task's connectorOutputPayload field will have a value similar to the following:

[{
  "personIdExternal": "109031",
  "startDate": "1989-12-31 23:00:00.0"
}]

Example - Update a record in the PaymentInformationDetailV3 entity

The following example updates a record in the PaymentInformationDetailV3 entity.

1. In the Configure connector task dialog, click Actions.
2. Select the UpsertEntity action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "entityType": "PaymentInformationDetailV3",
     "payload": {
       "PaymentInformationV3_effectiveStartDate": "2015-01-21 00:00:00.0",
       "PaymentInformationV3_worker": "82096",
       "externalCode": 563.0,
       "currency": "EUR"
     }
   }

If the action is successful, the connector task's connectorOutputPayload field will have a value similar to the following:

[{
  "externalCode": 563.0,
  "PaymentInformationV3_effectiveStartDate": "2015-01-20 23:00:00.0",
  "PaymentInformationV3_worker": "82096"
}]

Example - Create a record in an entity

The following example creates a record in the TodoEntryV2 entity.

1. In the Configure connector task dialog, click Actions.
2. Select the UpsertEntity action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
     "entityType": "TodoEntryV2",
     "payload": {
       "todoEntryName": "Finish Your Tasks",
       "status": 1.0,
       "categoryId": "41",
       "LinkeduserNav": {
         "__metadata": {
           "uri": "https://apisalesdemo2.successfactors.eu/odata/v2/User('613577712')",
           "type": "SFOData.User"
         }
       }
     }
   }

If the action execution is successful, the connector task's connectorOutputPayload field will have a value similar to the following:

[{
  "todoEntryId": 221443.0
}] 

Entity examples

Example - List records of an entity

This example lists the records of the FOCompany entity.

1. In the Configure connector task dialog, click Entities.
2. Select FOCompany from the Entity list.
3. Select the LIST operation, and then click Done.
4. In the Task Input section of the Connectors task, you can set the filterClause as per your requirement.

   For example, setting the filter clause to externalCode='5100' and startDate='1900-01-01 00:00:00', lists only those records whose externalCode is 5100 and startDate is 1900-01-01 00:00:00.

Example - Get a record from an entity

This example fetches a record from the User entity.

1. In the Configure connector task dialog, click Entities.
2. Select User from the Entity list.
3. Select the GET operation, and then click Done.
4. In the Task Input section of the Connectors task, click EntityId and then enter 103032 in the Default Value field.

   Here, 103032 is the primary key of the Users entity.

Example - Delete a record from an entity

This example deletes a record from the FOCompany entity.

1. In the Configure connector task dialog, click Entities.
2. Select FOCompany from the Entity list.
3. Select the DELETE operation, and then click Done.
4. In the Task Input section of the Connectors task, click entityId and then enter 113132 in the Default Value field.

   Alternately, if the entity has composite primary Keys instead of specifying the entityId, you can set the filterClause. For example, externalCode='5100' and startDate='1900-01-01 00:00:00'.

Example - Create a record in an entity

1. In the Configure connector task dialog, click Entities.
2. Select FOCompany from the Entity list.
3. Select the Create operation, and then click Done.
4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   "externalCode": "1000",
   "startDate": "1900-01-01 00:00:00.0",
   "standardHours": 40.0,
   "status": "I",
   "currency": "EUR",
   "country": "DEU"
   }

   If the integration is successful, the connector task's connectorOutputPayload field will have a value similar to the following:

   {
   "externalCode": "1000",
   "startDate": "1900-01-01 00:00:00.0"
   }

Example - Create a record in the TimeZone entity

1. In the Configure connector task dialog, click Entities.
2. Select TimeZone from the Entity list.
3. Select the Create operation, and then click Done.
4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   "effectiveStartDate": "2023-08-16 00:00:00.0",
   "externalCode": "10013",
   "effectiveStatus": "A",
   "utcDstOffset": "UTC+01:00",
   "utcOffset": "+0100"
   }

   If the integration is successful, the connector task's connectorOutputPayload field will have a value similar to the following:

   {
   "effectiveStartDate": "2023-08-16 00:00:00.0",
   "externalCode": "10013"
   }

Example - Update a record in an entity

This example updates a record in the FOCompany entity.

1. In the Configure connector task dialog, click Entities.
2. Select FOCompany from the Entity list.
3. Select the Update operation, and then click Done.
4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   "description": "BestRun India"
   }

5. In the Task Input section of the Connectors task, click entityId and then enter 103032 in the Default Value field.

   Alternately, if the entity has composite primary Keys instead of specifying the entityId, you can set the filterClause. For example, externalCode='5100' and startDate='1900-01-01 00:00:00'.

If the integration is successful, the connector task's connectorOutputPayload field will have a value similar to the following:

{
"externalCode": "5100",
"startDate": "1900-01-01 00:00:00.0"
}

Use the SAP SuccessFactors connection in an integration

After you create the connection, it becomes available in both Apigee Integration and Application Integration. You can use the connection in an integration through the Connectors task.

• To understand how to create and use the Connectors task in Apigee Integration, see Connectors task.
• To understand how to create and use the Connectors task in Application Integration, see Connectors task.