Ready to get started?

Learn more about the CData JDBC Driver for SAP SuccessFactors or download a free trial:

Download Now

Connect to SAP SuccessFactors Data in Squirrel SQL Client

Connect to SAP SuccessFactors data and execute queries in the Squirrel SQL Client.

The CData JDBC Driver for SAP SuccessFactors enables you to execute queries to SAP SuccessFactors data in tools like Squirrel SQL Client. In this article, you will create a JDBC data source for SAP SuccessFactors data and execute queries.

Add the JDBC Driver for SAP SuccessFactors

Follow the steps below to add the driver JAR.

  1. In Squirrel SQL, click Windows -> View Drivers.
  2. Click the plus icon to open the Add Driver wizard.
  3. In the Name box, enter a user-friendly name for the driver; for example, CData JDBC Driver for SAP SuccessFactors.
  4. In the Example URL box, enter jdbc:sapsuccessfactors:
  5. In the Extra Class Path tab, click Add.
  6. In the file explorer dialog that opens, select the JAR file for the driver, located in the lib subfolder of the installation directory.
  7. Click List Drivers to populate the Class Name menu with the class name for the driver, cdata.jdbc.sapsuccessfactors.SAPSuccessFactorsDriver.

Define Connection Properties

Follow the steps below to save connection properties in the driver alias.

  1. Click Windows -> View Aliases.
  2. In the pane that lists the aliases, click the plus icon.
  3. In the Add Alias wizard that opens, the following fields are required for the JDBC driver:

    • Name: Enter a name for the alias; for example, CData SAP SuccessFactors Source.
    • Driver: Select the CData JDBC Driver for SAP SuccessFactors.
    • URL: Enter jdbc:sapsuccessfactors:
    • User Name: Enter the username, which is added to the JDBC URL.
    • Password: Enter the password, which is added to the JDBC URL.
  4. If you want to define any additional properties, click Properties.
  5. In the Driver properties tab of the dialog that appears, select the Use driver properties checkbox.
  6. In the Specify column, select the checkboxes for the required 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.

    Below is a typical connection string:

    jdbc:sapsuccessfactors:User=username;Password=password;CompanyId=CompanyId;Url=https://api4.successfactors.com;
  7. In the dialog that appears after you click OK, click connect to test the connection.

Discover Schemas and Query SAP SuccessFactors Data

After the metadata has loaded, a new tab for the SAP SuccessFactors data source is displayed. On the Objects subtab, you can discover schema information, such as the available tables and views.

To view table data, select the table on the Objects tab. The table data is then loaded in a grid on the Content tab.

To execute an SQL query, enter the query on the SQL tab and then click Run SQL (the runner icon). For example:

SELECT address1, zipCode FROM ExtAddressInfo WHERE city = 'Springfield'