FireDAC Components for SAP SuccessFactors

Build 20.0.7654

Establishing a Connection

You can create and manage connections with the Data Explorer and the FireDAC Connection Editor wizards. See Connection Definitions for more information on creating connections from code and creating persistent, private, or temporary connections.

The CData FireDAC Components for SAP SuccessFactors communicates to SAP SuccessFactors over the OData API. By default, it is enabled. However, if you need to provide additional permissions, please follow the steps from SAP laid out in their support here.

Connecting to SAPSuccessFactors

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

Basic Authentication

You must provide values for the following properties to successfully authenticate to SAP SuccessFactors. Note that the provider will reuse the session opened by SAP SuccessFactors 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 SuccessFactors will be used for authentication.

  • Url, set this to the url of the server hosting Success Factors. Some of the servers are listed here.
  • 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.

  • OAuthGrantType, set this to CLIENT if you are working with an LMS (Learning Micro Services) in order to authenticate to the service. For all the other OData services use SAML. Default value for this property is SAML. Note that this property is only available for OAuth authentication.
  • Url, set this to the url of the server hosting Success Factors. Some of the servers are listed here. In case of connecting to a LMS (Learning Micro Service) the full URL should be specified including the service name.
  • 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.

Using the FireDAC Connection Editor

Complete the following steps to use the FireDAC Connection Editor to assign a SAP SuccessFactors connection to a TFDConnection object:

  1. Open a project and drop a TFDPhysCDataSAPSuccessFactorsDriverLink from the Tool Palette onto the Form Designer.
  2. Drop a TFDConnection object onto the Form Designer.
  3. Double-click the TFDConnection and select CDataSAPSuccessFactors in the Driver Id menu.
  4. Define the necessary connection properties.
  5. To execute ad-hoc SQL statements based on this connection, enter SQL commands on the SQL Script tab.
  6. In the Form Designer, select the TFDConnection object and set the Connected property to true.

Using the Data Explorer

Complete the following steps to use the Data Explorer to define persistent connections that can be shared across applications and projects:

  1. Click View > Tool Windows > Data Explorer in RAD Studio and expand the FireDAC node.
  2. Right-click the CData SAP SuccessFactors Data Source node and click Add New Connection.
  3. Enter a name for the connection. The FireDAC Connection Editor opens.

Working with Persistent Connections

The connections you define in the Data Explorer can be assigned to a TFDConnection object by specifying the connection name in the TFDConnection object's ConnectionDefName property.

Browsing Data and Metadata

The Data Explorer also provides options for browsing SAP SuccessFactors objects at design time:

  • Expand the CData SAP SuccessFactors Data Source node in the Data Explorer to view the defined connections.
  • Expand a connection node to find the database objects available for a connection.
  • Drill down to a database object to find metadata such as primary keys.
  • To display data, double-click a table or view or right-click and click View.

Copyright (c) 2020 CData Software, Inc. - All rights reserved.
Build 20.0.7654