Use Updategrams with SAP SuccessFactors Data

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 updategrams to insert, update, and delete SAP SuccessFactors data. This guide shows how to use the CData BizTalk Adapter for SAP SuccessFactors to generate updategram schemas and instances.

In this article, you will create updategrams that can be executed by the CData BizTalk Adapter for SAP SuccessFactors. You will design a schema and use it as a template for generating insert, update, and delete updategrams.

Add the Adapter for SAP SuccessFactors to Your Project

Use the Add Adapter wizard to add the adapter to a BizTalk Server project in Visual Studio. You will use the adapter to query SAP SuccessFactors for metadata about the table you want to modify.

  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 CData BizTalk Adapter for SAP SuccessFactors from the list view.
  4. In the Port menu, leave the selection blank. Or, select a receive location or send port that has been configured to use the adapter.
  5. When you click Next, the Schema Wizard is displayed.

Generate a Schema for an Updategram

Follow the steps below to create a schema in a BizTalk Server project in Visual Studio.

  1. If you have not already done so, add the SAP SuccessFactors adapter to your project.
  2. On the Connection String page of the Add Adapter wizard, enter authentication credentials and other connection properties, if they were not already configured in the send port or 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.

    See the "BizTalk Configuration" chapter in the help documentation for more information on the required connection properties.

  3. On the Schema Information page, click Send Port in the General Options section. Select Updategram from the CommandType menu. If you are using the adapter in a solicit-response send port, disable the One-Way option.
  4. On the next page, Statement Information, select the type of the updategram: Insert, Update, or Delete. Select the Table name and the columns you want to include in the schema. If you want to update or delete, the Id column is required.

    Note: When you create the updategram, you are limited to modifying the columns you include in the schema.

  5. Click Next to view a summary of the schema and finish the wizard to create the schema. The resulting .xsd file is added to your project.

Generate Insert, Update, and Delete Instance Messages

After you create the updategram schema, you can use the .xsd file to generate the updategram: Right-click the .xsd file and select Generate Instance. You can also use this file as a template to manually create updategrams. Below are example generated updategram instances for inserts, updates, and deletes:

Insert

An example of INSERT is below. In this instance, there is only an after block, which specifies how the data will change.

<ns0:parameters xmlns:ns0="http://www.cdata.com/SAPSuccessFactorsProvider"> <ns0:sync> <ns0:before></ns0:before> <ns0:after> <ns0:ExtAddressInfo address1="address1_0" zipCode="zipCode_1" /> </ns0:after> </ns0:sync> </ns0:parameters>

Update

An example of UPDATE is below. In this instance, there is both a before block (how the data currently exists in the table) and an after block (how the data will change).

<ns0:parameters xmlns:ns0="http://www.cdata.com/SAPSuccessFactorsProvider"> <ns0:sync> <ns0:before> <ns0:ExtAddressInfo Id=001d000000YBRseAAH></ns0:ExtAddressInfo> </ns0:before> <ns0:after> <ns0:ExtAddressInfo address1="address1_0" zipCode="zipCode_1" ></ns0:ExtAddressInfo> </ns0:after> </ns0:sync> </ns0:parameters>

Delete

An example for DELETE is below. The after block will be empty to show that it is removing the item.

<ns0:parameters xmlns:ns0="http://www.cdata.com/SAPSuccessFactorsProvider"> <ns0:sync> <ns0:before> <ns0:ExtAddressInfo Id=001d000000YBRseAAH></ns0:ExtAddressInfo> </ns0:before> <ns0:after></ns0:after> </ns0:sync> </ns0:parameters>

Processing Schemas

To use updategrams to insert, update, or delete SAP SuccessFactors records, see the tutorial.