Connect to SAP SuccessFactors Data in Aqua Data Studio

The CData JDBC Driver for SAP SuccessFactors integrates SAP SuccessFactors data with wizards and analytics in IDEs like Aqua Data Studio. This article shows how to connect to SAP SuccessFactors data through the connection manager and execute queries.

Create a JDBC Data Source

You can use the connection manager to define connection properties and save them in a new JDBC data source. The SAP SuccessFactors data source can then be accessed from Aqua Data Studio tools.

1. In Aqua Data Studio, select Register Server from the Servers menu.
2. In the Register Server form, select the 'Generic - JDBC' connection.
3. Enter the following JDBC connection properties:
   • Name: Enter a name for the data source; for example, SAP SuccessFactors.
   • Driver Location: Click the Browse button and select the cdata.jdbc.sapsuccessfactors.jar file, located in the lib subfolder of the installation directory.
   • Driver: Enter the Driver's class name, cdata.jdbc.sapsuccessfactors.SAPSuccessFactorsDriver.

   • URL: Enter the JDBC URL, which starts with jdbc:sapsuccessfactors: and is followed by a semicolon-separated list of connection properties.

     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.

     Built-in Connection String Designer

     For assistance in constructing the JDBC URL, use the connection string designer built into the SAP SuccessFactors JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

     java -jar cdata.jdbc.sapsuccessfactors.jar
     

     Fill in the connection properties and copy the connection string to the clipboard.

     👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
     A typical JDBC URL is below:

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

   👁 The JDBC data source, defined by the JAR path, driver class, and JDBC URL. (QuickBooks is shown.)
   

Query SAP SuccessFactors Data

You can now query the tables exposed.