Connect to Workday Data from a Connection Pool in JBoss

CData JDBC drivers can be configured in JBoss by following the standard procedure for connection pooling. This article details how to access Workday data from a connection pool in JBoss applications. This article details how to use the JBoss Management Interface to configure the CData JDBC Driver for Workday. You will then access Workday data from a connection pool.

Getting Started

---

Create a JDBC Data Source for Workday from the Management Console

Follow the steps below to add the driver JAR and define required connection properties.

1. In the Runtime menu, select the Domain or Server menu, depending on whether you are deploying to a managed domain or to a stand-alone server, and click "Manage deployments" to open the Deployments page.
2. Click Add. In the resulting wizard, add the JAR file and license for the driver, located in the lib subfolder of the installation directory. Finish the wizard with the defaults, select the driver, and click Enable. 👁 The deployed JAR. (Salesforce is shown.)
   
3. In the Configuration menu, click Subsystems -> Connector -> Datasources. This opens the JDBC Datasources page.
4. Click Add and, in the resulting wizard, enter a name for the driver and the JNDI name. For example:

   java:jboss/root/jdbc/Workday

5. Select the driver that you added above.

6. Enter the JDBC URL and the username and password. The syntax of the JDBC URL is jdbc:workday: followed by a semicolon-separated list of connection properties.

   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.)
   

   A typical connection string is below:

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

7. Test the connection and finish the wizard. Select the Workday data source and click Enable.

More JBoss Integration

The steps above show how to configure the driver in a simple connection pooling scenario. For more information, refer to the Data Source Management chapter in the JBoss EAP documentation.