Connect to Workday Data from PowerBuilder via JDBC

The CData JDBC driver for Workday is a standards-based control that can be used from any platform or development technology that supports JDBC, including PowerBuilder. This article shows how to use the CData JDBC Driver for Workday in PowerBuilder.

This article shows how to create a basic PowerBuilder application that uses the CData JDBC Driver for Workday to perform reads and writes.

Getting Started

---

Connect to Workday Data from PowerBuilder

Follow the steps below to use the Database Painter tool to create a database profile based on an JDBC URL for Workday. You can use a database profile to save connection properties. In the Database Painter, you can graphically manipulate data as well as execute SQL queries.

1. Add the driver JAR to the PowerBuilder classpath. Set the CLASSPATH system environment variable to the path to the driver JAR, located in the lib subfolder of the installation directory.

   Note: If you are using PowerBuilder Classic, you can also add the path to the driver JAR by clicking Tools -> System Options -> Java.

2. Click Tools -> Database Painter.
3. Right-click the JDBC node and click New Profile.
4. In the Database Profile Setup dialog, enter the following:
   • Profile Name: Enter a user-friendly name for the profile.
   • Driver Name: Enter the class name of the driver, cdata.jdbc.workday.WorkdayDriver
   • URL: Enter 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. 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;

   👁 The JDBC data source defined in the Database Profile Setup dialog. (Salesforce is shown.)
   
5. To view and modify a table, right-click a table and then click Edit Data -> Grid.

Using Workday Data with PowerBuilder Controls

You can use standard PowerBuilder objects to connect to JDBC data sources and execute queries. The following example shows how to retrieve Workday data into a DataWindow. You can add the following code to the open method:

SQLCA.DBMS = "JDBC"
SQLCA.AutoCommit = False
SQLCA.DBParm = "Driver='cdata.jdbc.workday.WorkdayDriver',URL='jdbc:workday:User=myuser;Password=mypassword;Tenant=mycompany_gm1;BaseURL=https://wd3-impl-services1.workday.com;ConnectionType=WQL;InitiateOAuth=GETANDREFRESH;";
CONNECT USING SQLCA;
dw_workers.SetTransObject(SQLCA);
dw_workers.Retrieve();