Manage Workday Data in DBArtisan as a JDBC Source

The CData JDBC Driver for Workday seamlessly integrates Workday data into database management tools like DBArtisan by enabling you to access Workday data as a database. This article shows how to create a JDBC source for Workday in DBArtisan. You can then edit data visually and execute standard SQL.

Getting Started

---

Integrate Workday Data into DBArtisan Projects

Follow the steps below to register Workday data as a database instance in your project:

1. In DBArtisan, click Data Source -> Register Datasource.
2. Select Generic JDBC.
3. Click Manage.
4. In the resulting dialog, click New. Enter a name for the driver and click Add. In the resulting dialog, navigate to the driver JAR. The driver JAR is located in the lib subfolder of the installation directory. 👁 The JDBC driver definition in the Register Datasource wizard. (Salesforce is shown.)
   
5. In the Connection URL box, enter credentials and other required connection properties in the JDBC URL.

   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.

   👁 Required JDBC connection properties in the Register Datasource wizard. (Salesforce is shown.)
   

   Below is a typical connection string:

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

6. Finish the wizard to connect to Workday data. Workday entities are displayed in the Datasource Explorer.

You can now work with Workday data as you work with any other database. See the driver help documentation for more information on the queries supported by the Workday API.