Execute Stored Procedures to SAP SuccessFactors in BizTalk

Ready to get started?

Download for a free trial:

Download Now

Learn more:

SAP SuccessFactors BizTalk Adapter

Powerful BizTalk Adapters that allow you to easily connect BizTalk Server with live SAP SuccessFactors data through standard orchestrations.

Use the SAP SuccessFactors Adapters to synchronize with SAP SuccessFactors Benefits, Compensation, Jobs, etc. Perfect for data synchronization, local back-ups, workflow automation, and more!



You can use stored procedures provided by the CData BizTalk Adapter for SAP SuccessFactors to automate working with SAP SuccessFactors data in BizTalk. Stored procedures implement actions available in the underlying API.

Stored procedures implement SAP SuccessFactors actions that cannot be represented as SELECT, INSERT, UPDATE, and DELETE statements. This article shows how to generate a schema for a stored procedure. You can use the schema to execute the stored procedure from a send port.

Add the Adapter to Your Project

Use the Add Adapter wizard to add the adapter to a BizTalk Server project in Visual Studio. The adapter will return metadata about the inputs of the stored procedure and its results. This metadata is needed to create the schema.

  1. Right-click on the project in the Solution Explorer and click Add -> Add Generated Items.
  2. Select Add Adapter Metadata in the resulting dialog box.
  3. In the resulting Add Adapter wizard, select the adapter from the list.
  4. In the Port menu, leave the selection blank. Or, select a receive location or send port that has been configured to use the SAP SuccessFactors Adapter.
  5. On the Connection String page, enter authentication credentials and other connection properties if they were not already configured in the send port or the receive location.

    Below is a typical connection string:

    User=username;Password=password;CompanyId=CompanyId;Url=https://api4.successfactors.com;

    You can authenticate to SAP Success Factors using Basic authentication or OAuth with SAML assertion.

    Basic Authentication

    You must provide values for the following properties to successfully authenticate to SAP Success Factors. Note that the provider will reuse the session opened by SAP Success Factors using cookies. Which means that your credentials will be used only on the first request to open the session. After that, cookies returned from SAP Success Factors will be used for authentication.

    • Url: set this to the URL of the server hosting Success Factors. Some of the servers are listed in the SAP support documentation (external link).
    • User: set this to the username of your account.
    • Password: set this to the password of your account.
    • CompanyId: set this to the unique identifier of your company.

    OAuth Authentication

    You must provide values for the following properties, which will be used to get the access token.

    • Url: set this to the URL of the server hosting Success Factors. Some of the servers are listed in the SAP support documentation (external link).
    • User: set this to the username of your account.
    • CompanyId: set this to the unique identifier of your company.
    • OAuthClientId: set this to the API Key that was generated in API Center.
    • OAuthClientSecret: the X.509 private key used to sign SAML assertion. The private key can be found in the certificate you downloaded in Registering your OAuth Client Application.
    • InitiateOAuth: set this to GETANDREFRESH.

Generate the Schema

After you enter connection properties in the Add Adapter wizard, the Schema wizard is displayed.

  1. On the next page, Schema Information, select the Send Port that you have configured to use the SAP SuccessFactors Adapter.
  2. If you have configured the CData SAP SuccessFactors Adapter in a solicit-response send port, disable the One-Way option.
  3. In the Command Type menu, select Stored Procedure.
  4. Select the stored procedure from the menu and enter the values for the input parameters.
  5. Confirm the settings in the summary displayed by the wizard and click Finish to generate the schema.xsd file.

Processing Schemas

To use schemas in a simple BizTalk application, see the tutorial.