VOOZH about

URL: https://www.cdata.com/kb/tech/workday-jdbc-datagrip.rst

⇱ Query Workday Data in DataGrip

Query Workday Data in DataGrip

👁 Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Create a Data Source for Workday in DataGrip and use SQL to query live Workday data.

DataGrip is a database IDE that allows SQL developers to query, create, and manage databases. When paired with the CData JDBC Driver for Workday, DataGrip can work with live Workday data. This article shows how to establish a connection to Workday data in DataGrip and use the table editor to load Workday data.

About Workday Data Integration

CData provides the easiest way to access and integrate live data from Workday. Customers use CData connectivity to:

  • Access the tables and datasets you create in Prism Analytics Data Catalog, working with the native Workday data hub without compromising the fidelity of your Workday system.
  • Access Workday Reports-as-a-Service to surface data from departmental datasets not available from Prism and datasets larger than Prism allows.
  • Access base data objects with WQL, REST, or SOAP, getting more granular, detailed access but with the potential need for Workday admins or IT to help craft queries.

Users frequently integrate Workday with analytics tools such as Tableau, Power BI, and Excel, and leverage our tools to replicate Workday data to databases or data warehouses. Access is secured at the user level, based on the authenticated user's identity and role.

For more information on configuring Workday to work with CData, refer to our Knowledge Base articles: Comprehensive Workday Connectivity through Workday WQL and Reports-as-a-Service & Workday + CData: Connection & Integration Best Practices.


Getting Started


Create a New Driver Definition for Workday

The steps below describe how to create a new Data Source in DataGrip for Workday.

  1. In DataGrip, click File -> New > Project and name the project 👁 Creating a new DataGrip project.
  2. In the Database Explorer, click the plus icon () and select Driver. 👁 Adding a new Driver.
  3. In the Driver tab:
    • Set Name to a user-friendly name (e.g. "CData Workday Driver")
    • Set Driver Files to the appropriate JAR file. To add the file, click the plus (), select "Add Files," navigate to the "lib" folder in the driver's installation directory and select the JAR file (e.g. cdata.jdbc.workday.jar).
    • Set Class to cdata.jdbc.workday.Workday.jar
  4. Click "Apply" then "OK" to save the Connection 👁 A configured Driver (Salesforce is shown).

Configure a Connection to Workday

  1. Once the connection is saved, click the plus (), then "Data Source" then "CData Workday Driver" to create a new Workday Data Source.
  2. In the new window, configure the connection to Workday with a JDBC URL.

    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.

    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.

    APIConnectionType Value
    WQLWQL
    Reports as a ServiceReports
    RESTREST
    SOAPSOAP

    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.

    👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
  3. Set URL to the connection string, e.g., 
    jdbc:workday:User=myuser;Password=mypassword;Tenant=mycompany_gm1;BaseURL=https://wd3-impl-services1.workday.com;ConnectionType=WQL;InitiateOAuth=GETANDREFRESH;
  4. Click "Apply" and "OK" to save the connection string 👁 A configured Data Source (Salesforce is shown).

At this point, you will see the data source in the Data Explorer.

Execute SQL Queries Against Workday

To browse through the Workday entities (available as tables) accessible through the JDBC Driver, expand the Data Source.

👁 Exploring the data (Salesforce is shown.)

To execute queries, right click on any table and select "New" -> "Query Console."

👁 Opening a new Query Console.

In the Console, write the SQL query you wish to execute. For example: 

SELECT Worker_Reference_WID, Legal_Name_Last_Name FROM Workers WHERE Legal_Name_Last_Name = 'Morgan'
👁 Querying with SQL (Salesforce is shown.)

Download a free, 30-day trial of the CData JDBC Driver for Workday and start working with your live Workday data in DataGrip. Reach out to our Support Team if you have any questions.