How to connect to Workday Data in DBVisualizer

The CData JDBC Driver for Workday implements JDBC standards to provide connectivity to Workday data in applications ranging from business intelligence tools to IDEs. This article shows how to establish a connection to Workday data in DBVisualizer and use the table editor to edit and save Workday data.

Getting Started

---

Create a New Driver Definition for Workday Data

Follow the steps below to use the Driver Manager to provide connectivity to Workday data from DBVisualizer tools.

1. In DBVisualizer, click Tools -> Driver Manager.
2. Click the plus sign "" to create a new driver.
3. Select "Custom" as the template.
4. On the Driver Settings tab:
   • Set Name to a user-friendly name (e.g. "CData Workday Driver")
   • Set URL Format to jdbc:workday:
   • In Driver artifacts and jar files (jars are loaded in order from top):
     1. Click the plus sign "" -> "Add Files"
     2. Navigate to the "lib" folder in the installation directory (C:\Program Files\CData[product_name] XXXX\)
     3. Select the JAR file (cdata.jdbc.Workday.jar) and click "Open"
     
5. The Driver Class should populate automatically. If not, select class (cdata.jdbc.workday.WorkdayDriver).

Define the Connection to the JDBC Data Source

Close the "Driver Manager" and follow the steps below to save connection properties in the JDBC URL.

1. In the "Databases" tab, click the plus sign "" and select the driver you just created.

2. In the "Connection" section, set the following options:

   • Database Type: If you selected the wizard option, the database type is automatically detected. If you selected the "No Wizard" option, select the Generic or Auto Detect option in the Database Type menu.
   • Driver Type: Select the driver you just created.

   • Database URL: Enter the full JDBC URL. The syntax of the JDBC URL is jdbc:workday: followed by the connection properties in a semicolon-separated list of name-value pairs.

     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.

     

     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.

     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
   • NOTE: Database Userid and Database Password correspond with the User and Password properties for Workday.
3. On the Connection tab, click Connect.

To browse through tables exposed by the Workday JDBC Driver, right-click a table and click "Open in New Tab."

To execute SQL queries, use the SQL Commander tool: Click SQL Commander -> New SQL Commander. Select the Database Connection, Database, and Schema from the available menus.

See the "Supported SQL" chapter in the help documentation for more information on the supported SQL. See the "Data Model" chapter for table-specific information.

More Information & Free Trial