Query SAP SuccessFactors Data in DataGrip

DataGrip is a database IDE that allows SQL developers to query, create, and manage databases. When paired with the CData JDBC Driver for SAP SuccessFactors, DataGrip can work with live SAP SuccessFactors data. This article shows how to establish a connection to SAP SuccessFactors data in DataGrip and use the table editor to load SAP SuccessFactors data.

Create a New Driver Definition for SAP SuccessFactors

The steps below describe how to create a new Data Source in DataGrip for SAP SuccessFactors.

1. In DataGrip, click File -> New > Project and name the project
2. In the Database Explorer, click the plus icon () and select Driver.
3. In the Driver tab:
   • Set Name to a user-friendly name (e.g. "CData SAP SuccessFactors Driver")
   • Set Driver Files to the appropriate JAR file. To add the file, click the plus (), select "Add Files," navigate to the "lib" folder in the driver's installation directory and select the JAR file (e.g. cdata.jdbc.sapsuccessfactors.jar).
   • Set Class to cdata.jdbc.sapsuccessfactors.SAPSuccessFactors.jar
   Additionally, in the advanced tab you can change driver properties and some other settings like VM Options, VM environment, VM home path, DBMS, etc
   • For most cases, change the DBMS type to "Unknown" in Expert options to avoid native SQL Server queries (Transact-SQL), which might result in an invalid function error
4. Click "Apply" then "OK" to save the Connection

Configure a Connection to SAP SuccessFactors

1. Once the connection is saved, click the plus (), then "Data Source" then "CData SAP SuccessFactors Driver" to create a new SAP SuccessFactors Data Source.
2. In the new window, configure the connection to SAP SuccessFactors with a JDBC URL.

   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.

   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.
3. Set URL to the connection string, e.g., jdbc:sapsuccessfactors:User=username;Password=password;CompanyId=CompanyId;Url=https://api4.successfactors.com;
4. Click "Apply" and "OK" to save the connection string

At this point, you will see the data source in the Data Explorer.

Execute SQL Queries Against SAP SuccessFactors

To browse through the SAP SuccessFactors entities (available as tables) accessible through the JDBC Driver, expand the Data Source.

To execute queries, right click on any table and select "New" -> "Query Console."

In the Console, write the SQL query you wish to execute. For example: SELECT address1, zipCode FROM ExtAddressInfo WHERE city = 'Springfield'

Download a free, 30-day trial of the CData JDBC Driver for SAP SuccessFactors and start working with your live SAP SuccessFactors data in DataGrip. Reach out to our Support Team if you have any questions.