Skip to Content

SAP SuccessFactors connector

Summary

The SAP SuccessFactors connector establishes access to SAP SuccessFactors Human Experience Management (HXM) Suite.

The SAP SuccessFactors connector provides an interface for creating an SAP SuccessFactors connection, the foundation used for generating instances of SAP SuccessFactors activities. These activities, once configured, interact with SAP SuccessFactors through the connection.

The SAP SuccessFactors connector is accessed from the design component palette's Project endpoints and connectors tab (see Design component palette).

Connector overview

This connector is used to first configure an SAP SuccessFactors connection. Activity types associated with that connection are then used to create instances of activities that are intended to be used as sources (to provide data in an operation) or targets (to consume data in an operation).

Together, a specific SAP SuccessFactors connection and its activities are referred to as an SAP SuccessFactors endpoint:

SAP SuccessFactors activity types

  • Query: Retrieves object data from SAP SuccessFactors and is intended to be used as a source in an operation.

  • Create: Creates object data in SAP SuccessFactors and is intended to be used as a target in an operation.

  • Update: Updates object data in SAP SuccessFactors and is intended to be used as a target in an operation.

  • Delete: Deletes object data from SAP SuccessFactors and is intended to be used as a target in an operation.

Note

This connector is a Connector SDK-based connector, which may be referred to by Jitterbit when communicating changes made to connectors built with the Connector SDK.

Prerequisites and supported API versions

The SAP SuccessFactors connector requires the use of an agent version 10.1 or later. These agent versions automatically download the latest version of the connector when required.

The SAP SuccessFactors connector uses the SAP SuccessFactors HXM Suite OData API v2. Refer to the API documentation for information on the schema nodes and fields.

To use this connector with OAuth 2.0 authentication in the connection, you must have an SAP SuccessFactors client ID and private key (as described in Prerequisites).

Note

Basic authentication is deprecated by SAP SuccessFactors.

Rate limits

SAP SuccessFactors HXM Suite OData API v2 enforces a rate limit of 40 requests per second. For more information on the rate limit, see Access Limits.

Troubleshooting

If you experience issues with the SAP SuccessFactors connector, these troubleshooting steps are recommended:

  1. Click the Test button in the connection configuration to ensure the connection is successful and to ensure the latest version of the connector is downloaded to the agent (unless using the Disable Auto Connector Update organization policy).

  2. Check the operation logs for any information written during execution of the operation.

  3. Enable operation debug logging (for cloud agents or for private agents) to generate additional log files and data.

  4. If using private agents, you can enable connector verbose logging for this connector using this specific configuration entry of logger name and level:

    <logger name="org.jitterbit.connector.sap.successfactors" level="DEBUG"/>
    
  5. If using private agents, you can check the agent logs for more information.

  6. For additional troubleshooting considerations, see Operation troubleshooting.