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 DBeaver

Manage SAP SuccessFactors data with visual tools in DBeaver like the query browser.

The CData JDBC Driver for SAP SuccessFactors implements JDBC standards that enable third-party tools to interoperate, from wizards in IDEs to business intelligence tools. This article shows how to connect to SAP SuccessFactors data with wizards in DBeaver and browse data in the DBeaver GUI.

Create a JDBC Data Source for SAP SuccessFactors Data

Follow the steps below to load the driver JAR in DBeaver.

  1. Open the DBeaver application and, in the Databases menu, select the Driver Manager option. Click New to open the Create New Driver form.
  2. In the Driver Name box, enter a user-friendly name for the driver.
  3. To add the .jar, click Add File.
  4. In the create new driver dialog that appears, select the cdata.jdbc.sapsuccessfactors.jar file, located in the lib subfolder of the installation directory.
  5. Click the Find Class button and select the SAPSuccessFactorsDriver class from the results. This will automatically fill the Class Name field at the top of the form. The class name for the driver is cdata.jdbc.sapsuccessfactors.SAPSuccessFactorsDriver.
  6. Add jdbc:sapsuccessfactors: in the URL Template field.

Create a Connection to SAP SuccessFactors Data

Follow the steps below to add credentials and other required connection properties.

  1. In the Databases menu, click New Connection.
  2. In the Create new connection wizard that results, select the driver.
  3. On the next page of the wizard, click the driver properties tab.
  4. Enter values for authentication credentials and other properties required to connect to SAP SuccessFactors.

    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.

    Below is a typical connection string:

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

Query SAP SuccessFactors Data

You can now query information from the tables exposed by the connection: Right-click a Table and then click Edit Table. The data is available on the Data tab.