Integrate SAP SuccessFactors Data in the Pentaho Report Designer

The CData JDBC Driver for SAP SuccessFactors data enables access to live data from dashboards and reports. This article shows how to connect to SAP SuccessFactors data as a JDBC data source and publish reports based on SAP SuccessFactors data in Pentaho.

Connect and Create a Report

1. Copy the JAR file of the driver, located in the lib subfolder of the installation directory, to the \Report-Designer\lib\jdbc\ folder in the Pentaho directory.
2. Run the report-designer.bat file in the \Report-Designer\ folder to open the Report-Designer UI.

3. Create a new data source with the driver by clicking Data -> Add Data Source -> Advanced -> JDBC (Custom) and then creating a new SAP SuccessFactors connection. In the resulting dialog, configure the connection properties as shown below.

   • Custom Connection URL property: Enter the JDBC URL. This 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.

     When you configure the JDBC URL, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

     Below is a typical JDBC URL:

     jdbc:sapsuccessfactors:User=username;Password=password;CompanyId=CompanyId;Url=https://api4.successfactors.com;
   • Custom Driver Class Name: Enter cdata.jdbc.sapsuccessfactors.SAPSuccessFactorsDriver.
   • User Name: The username to authenticate with.
   • Password: The password to authenticate with.

Add SAP SuccessFactors Data to a Report

You are now ready to create a report with SAP SuccessFactors data.

1. Add the SAP SuccessFactors source to your report: Click Data -> Add Data Source -> JDBC and select the data source.

2. Configure the query. This article uses the one below:

   SELECT address1, zipCode FROM ExtAddressInfo WHERE city = 'Springfield'
3. Drag a chart onto your report and double-click it to edit the chart. Run the report to display the chart. You can use the results of this query to create a simple chart for the ExtAddressInfo table.
4. Finally, run the report to see the chart.