Connect to Workday from a Connection Pool in WebLogic

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

Getting Started

---

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.workday.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.workday.jar;%PRE_CLASSPATH%

After making these changes, restart the server.

Create a JDBC Data Source for Workday

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, workdayjdbc.
   • JNDI Name: Enter the path the JDBC data source will be bound to; for example, jdbc/Workday.

   • Database Type: Select Other.

   👁 A user-friendly name and the path to bind to. (Salesforce is shown.)
   

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.workday.WorkdayDriver.

   • URL: Enter the JDBC URL. A typical JDBC URL is below:

     jdbc:workday:User=myuser;Password=mypassword;Tenant=mycompany_gm1;BaseURL=https://wd3-impl-services1.workday.com;ConnectionType=WQL;InitiateOAuth=GETANDREFRESH;

     To connect to Workday, users need to find the Tenant and BaseURL and then select their API type.

     Obtaining the BaseURL and Tenant

     To obtain the BaseURL and Tenant properties, log into Workday and search for "View API Clients." On this screen, you'll find the Workday REST API Endpoint, a URL that includes both the BaseURL and Tenant.

     The format of the REST API Endpoint is: https://domain.com/subdirectories/mycompany, where:

     • https://domain.com/subdirectories/ is the BaseURL.
     • mycompany (the portion of the url after the very last slash) is the Tenant.
     For example, in the REST API endpoint https://wd3-impl-services1.workday.com/ccx/api/v1/mycompany, the BaseURL is https://wd3-impl-services1.workday.com and the Tenant is mycompany.

     Using ConnectionType to Select the API

     The value you use for the ConnectionType property determines which Workday API you use. See our Community Article for more information on Workday connectivity options and best practices.

     API	ConnectionType Value
     WQL	WQL
     Reports as a Service	Reports
     REST	REST
     SOAP	SOAP

     
     

     Authentication

     Your method of authentication depends on which API you are using.

     • WQL, Reports as a Service, REST: Use OAuth authentication.
     • SOAP: Use Basic or OAuth authentication.

     See the Help documentation for more information on configuring OAuth with Workday.

     Built-in Connection String Designer

     For assistance in constructing the JDBC URL, use the connection string designer built into the Workday JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

     java -jar cdata.jdbc.workday.jar
     

     Fill in the connection properties and copy the connection string to the clipboard.

     👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
     
   • Database User Name: Enter the username, if not specified in the JDBC URL.
   • Password: Enter the password, if not specified in the JDBC URL.
   👁 Driver connection properties. (Salesforce is shown.)
   

After selecting the server where you want to deploy the JDBC data source, you can now connect to Workday 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.