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 from a Connection Pool in WebLogic

Use the CData JDBC Driver for SAP SuccessFactors to connect to SAP SuccessFactors data from Web applications running on WebLogic.

The CData JDBC Driver for SAP SuccessFactors enables you to follow standard procedures to integrate SAP SuccessFactors data into Java Web applications. This article shows how to deploy the CData JDBC Driver for SAP SuccessFactors in WebLogic Server.

Deploy the JDBC Driver in WebLogic Server

To deploy the driver, add the driver JAR to your classpath. The .lic file must be located in the same folder as the JAR. These files are located in the lib subfolder of the installation directory.

If you want to add the driver to all domains, prepend the path to the JAR to the WEBLOGIC_CLASSPATH environment variable in WL_HOME\common\bin\commEnv.cmd/sh. This script is located in WL_HOME\common\bin\. For example:

set WEBLOGIC_CLASSPATH=your-installation-directory\lib\cdata.jdbc.sapsuccessfactors.jar;%WEBLOGIC_CLASSPATH%

In WebLogic 12.2.1 if you want to add the driver to a specific domain, you can simply place the driver JAR and .lic file into DOMAIN_HOME\lib; for example, ORACLE_HOME\user_projects\domains\MY_DOMAIN\lib. These files will be added to the server classpath at startup.

Earlier versions require that you manually add the driver to the classpath: Prepend the following to the PRE_CLASSPATH environment variable in setDomainEnv.cmd/sh. This script is located in the bin subfolder of the folder for that domain.

set PRE_CLASSPATH=your-installation-directory\lib\cdata.jdbc.sapsuccessfactors.jar;%PRE_CLASSPATH%

After making these changes, restart the server.

Create a JDBC Data Source for SAP SuccessFactors

After deploying the driver, log into the WebLogic Administration Console and create the connection.

  1. In the Domain Structure tree, click Services -> Data Sources -> New -> Generic Data Source.
  2. On the JDBC Data Source Properties page, enter the following information:
    • Name: Enter a user-friendly name; for example, sapsuccessfactorsjdbc.
    • JNDI Name: Enter the path the JDBC data source will be bound to; for example, jdbc/SAPSuccessFactors.
    • Database Type: Select Other.

  3. Click Next to use the default options. On the last page, enter the following information and click Test Configuration:

    • Driver Class Name: Enter the driver class, cdata.jdbc.sapsuccessfactors.SAPSuccessFactorsDriver.
    • URL: Enter the JDBC URL. A typical JDBC URL is below:

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

      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.

    • Database User Name: Enter the username, if not specified in the JDBC URL.
    • Password: Enter the password, if not specified in the JDBC URL.

After selecting the server where you want to deploy the JDBC data source, you can now connect to SAP SuccessFactors data.

More WebLogic Integration

The steps above show how configure the driver in a simple connection pooling scenario. For more use cases and information, see the JDBC sections in the WebLogic Data Sources chapter of the Oracle Fusion Middleware documentation.