Linux DSN Configuration

This section describes how to set up ODBC connectivity and configure DSNs on several Linux distributions: Debian-based systems, like Ubuntu, and Red Hat Linux platforms, like Red Hat Enterprise Linux (RHEL), CentOS, and Fedora.

Minimum Linux Versions

Here are the minimum supported versions for Red Hat-based and Debian-based systems:


OS	Min. Version
Ubuntu	11.04
Debian	7
RHEL	6.9
CentOS	6.9
Fedora	13
SUSE	12.1

Installing the Driver Dependencies

Run the following commands as root or with sudo to install the necessary dependencies:

Debian/Ubuntu:

apt-get install libc6 libstdc++6 zlib1g libgcc1

RHEL/CentOS/Fedora:
```
yum install glibc libstdc++ zlib libgcc
```

Here are the corresponding libraries required by the driver:


Debian/Ubuntu Package	RHEL/CentOS/Fedora Package	File
libc6	glibc	linux-vdso.1
libc6	glibc	libm.so.6
libc6	glibc	librt.so.1
libc6	glibc	libdl.so.2
libc6	glibc	libpthread.so.0
libc6	glibc	libc.so.6
libc6	glibc	ld-linux-x86-64.so.2
libstdc++6	libstdc++	libstdc++.so.6
zlib1g	zlib	libz.so.1
libgcc1	libgcc	libgcc_s.so.1

Installing the Driver

You can use standard package management systems to install the driver.

On Debian-based systems, like Ubuntu, run the following command with root or sudo:

dpkg -i /path/to/driver/setup/WorkdayODBCDriverforUnix.deb

On systems that support the RPM package format, run the following command with root or sudo:

rpm -ivh /path/to/driver/WorkdayODBCDriverforUnix.rpm

Licensing the Driver

Run the following commands to license the driver. To activate a trial, omit the <key> input.

cd /opt/cdata/cdata-odbc-driver-for-workday/bin/
sudo ./install-license.sh <key>

Connecting through the Driver Manager

The driver manager loads the driver and passes function calls from the application to the driver. You need to register the driver with the driver manager and you define DSNs in the driver manager's configuration files.

The driver installation registers the driver with the unixODBC driver manager and creates a system DSN. The unixODBC driver manager can be used from Python and from many other applications. Your application may embed another driver manager.

Creating the DSN

See Using unixODBC to install unixODBC and configure DSNs. See Using the DataDirect Driver Manager to create a DSN to connect to OBIEE, Informatica, and SAS.

Connecting to Workday

This section describes how to set the connection parameters for the four Workday APIs, and how to obtain the Tenant and BaseURL. Once the parameters for the desired API are set, and you have created a custom OAuth and/or Azure AD API client, you are ready to connect.

Connection Prerequisites


API	Prerequisites	Connection Parameters
WQL	Enable WQL service (See below)	ConnectionType: WQL
Reports as a Service	Set up catalog report (see Fine-Tuning Data Access)	ConnectionType: Reports
REST	Automatically enabled	ConnectionType: REST
SOAP	Automatically enabled	See Authenticating to Workday SOAP API, below

Obtaining the BaseURL and Tenant

To obtain the BaseURL and Tenant properties, log into Workday and search for View API Clients. On this screen, Workday displays 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.

Enabling WQL Service

To connect through the Workday WQL API, you must first enable the WQL Service:

Open Workday.
In the search bar, enter View Domain.
At the prompt, enter Workday Query Language.
Check the Allowed Security Group Types to see if one of them includes the user you are connecting with.

Authenticating to Workday

Except for Basic authentication, most Workday connections require the creation of an OAuth-based custom API Client application to authenticate. This includes enterprise installations where users connect via their Azure AD credentials.

The following content describes how to authenticate in a non-SSO environment (separate logins for each application accessed), which requires a custom OAuth API client. For details regarding authenticating in an SSO environment, and information about creating both types of custom API client applications to connect to Workday, see Creating a Custom API Client Application.

Creating a Custom OAuth Application

This section describes how to authenticate in an environment without SSO, using an OAuth-based API client.

OAuth connections require that you write a custom OAuth application. For information about how to create a custom OAuth application, see Creating a Custom API Client Application.

For a complete list of connection string properties available in Workday, see Connection.

Note: If you want to connect via SOAP, you can use Basic authentication, which doesn't require a custom OAuth application. See Authenticating to Workday SOAP API.

Desktop Applications

To authenticate with the credentials for a custom OAuth application, you must get and refresh the OAuth access token. After you do that, you are ready to connect.

Get and refresh the OAuth access token:

InitiateOAuth: GETANDREFRESH. Used to automatically get and refresh the OAuthAccessToken.
OAuthClientId: The client Id assigned when you registered your application.
OAuthClientSecret: The client secret that was assigned when you registered your application.
CallbackURL: The redirect URI that was defined when you registered your application.

When you connect, the driver opens Workday's OAuth endpoint in your default browser. Log in and grant permissions to the application.

When the access token expires, the driver refreshes it automatically.

Headless Machines

If you need to log in to a resource that resides on a headless machine, you must authenticate on another device that has an internet browser. You can do this in either of the following ways:

Option 1: Obtain the OAuthVerifier value.
Option 2: Install the driver on a machine with an internet browser and transfer the OAuth authentication values after you authenticate through the usual browser-based flow.

After you execute either Option 1 or Option 2, configure the driver to automatically refresh the access token on the headless machine.

Option 1: Obtaining and Exchanging a Verifier Code

To obtain a verifier code, you must authenticate at the OAuth authorization URL. Do the following:

Authenticate from the machine with an internet browser, and obtain the OAuthVerifier connection property.

Set the following properties:
- InitiateOAuth: OFF.
- OAuthClientId: The client Id assigned when you registered your application.
- OAuthClientSecret: The client secret assigned when you registered your application.
Call the GetOAuthAuthorizationURL stored procedure. The stored procedure returns the CallbackURL established when the custom OAuth application was registered. (See Creating a Custom API Client Application.)

Copy this URL and paste it into a new browser tab.
Log in and grant permissions to the driver. The OAuth application redirects you the redirect URI, with a parameter called code appended. Note the value of this parameter; you will need it later, to configure the OAuthVerifier connection property.
Exchange the OAuth verifier code for OAuth refresh and access tokens. On the headless machine, set the following connection properties to obtain the OAuth authentication values:
- InitiateOAuth: REFRESH.
- OAuthVerifier: The noted verifier code (the value of the code parameter in the redirect URI).
- OAuthSettingsLocation: Persist the encrypted OAuth authentication values to the specified file.
- OAuthClientId: The client Id in your custom OAuth application settings.
- OAuthClientSecret: The client secret in the custom OAuth application settings.
Test the connection to generate the OAuth settings file.
After you re-set the following properties, you are ready to connect:
- InitiateOAuth: REFRESH.
- OAuthSettingsLocation: The file containing the encrypted OAuth authentication values. To enable the automatic refreshing of the access token, be sure that this file gives read and write permissions to the driver.
- OAuthClientId: The client Id assigned when you registered your application.
- OAuthClientSecret: The client secret assigned when you registered your application.

Option 2: Transferring OAuth Settings

Prior to connecting on a headless machine, you must install and create a connection with the driver on a device that supports an internet browser. Set the connection properties as described above in "Desktop Applications".

After completing the instructions in "Desktop Applications", the resulting authentication values are encrypted and written to the path specified by OAuthSettingsLocation. The default filename is OAuthSettings.txt.

Test the connection to generate the OAuth settings file, then copy the OAuth settings file to your headless machine.

To connect to data via the headless machine, set the following connection properties:

InitiateOAuth: REFRESH
OAuthSettingsLocation: The path to the OAuth settings file you copied from the machine with the browser. To enable automatic refreshing of the access token, ensure that this file gives read and write permissions to the driver.
OAuthClientId: The client Id assigned when you registered your custom OAuth application.
OAuthClientSecret: The client secret assigned when you registered your custom OAuth application.

Authenticating With OAuth

Before you connect, set the following variables:

OAuthClientId: The client Id assigned when you registered your custom OAuth application.
OAuthClientSecret: The client secret assigned when you registered your custom OAuth application.

Click Connect to Workday to open the OAuth endpoint in your default browser. Log in and grant permissions to the application.

The driver then completes the OAuth process as follows:

Extracts the access token from the callback URL.
Obtains a new access token when the old one expires.
Saves OAuth values so that they persist across connections.

Authenticating as a Normal User

To authenticate as a normal user in Workday, you must first create an API Client, as described in Creating a Custom API Client Application.

After you have an API client configured, set the following properties to connect using Workday credentials:

ConnectionType and any related properties
AuthScheme: OAuth.
OAuthClientId: The Client ID obtained from the View API Client page.
OAuthClientSecret: The Client Secret obtained from the View API Client page. If you are using a public client, leave this blank.
Tenant: The tenant for the account.
BaseURL: The base URL for the REST API Endpoint in the View API Clients page.

If you created an API client for use with AzureAD, set the following properties:

ConnectionType and any related properties
AuthScheme: AzureAD.
OAuthClientId: The Client ID obtained from the View API Client page.
Tenant: The tenant for the account.
BaseURL: The base URL for the REST API Endpoint in the View API Clients page.
SSOProperties: The Azure-specific properties used for SSO, including the AzureTenant, AzureClientId, AzureClientSecret and Resource.

Authenticating as an ISU

To authenticate as an ISU, you must first create either an API Client or an API Client for Integrations, as described in Creating a Custom API Client Application. You can create either an API Client for Integrations or an API Client using the JWT bearer grant type.

If you created an API Client for Integrations, set the following properties to connect:

ConnectionType and any related properties
AuthScheme: OAuthISU.
OAuthClientId: The Client ID obtained from the View API Client page.
OAuthClientSecret: The Client Secret obtained from the View API Client page.
OAuthRefreshToken: The refresh token obtained from the Manage Refresh Tokens for Integrations page.
Tenant: The tenant for the account.
BaseURL: The base URL for the REST API Endpoint in the View API Clients page.

If you created an API Client with JWT, set the following properties to connect:

ConnectionType and any related properties
AuthScheme: OAuthJWT.
OAuthJWTCertType: The certificate type. If you created the certificate with keytool or openssl pkcs12, this should be PFXFILE.
OAuthJWTCert: The path of the certificate file you created.
OAuthJWTCertPassword: The password of the certificate file you created.
OAuthJWTIssuer: The Client ID obtained from the View API Client page.
OAuthJWTSubject: The username of the ISU you are using.
Tenant: The tenant for the account.
BaseURL: The base URL for the REST API Endpoint in the View API Clients page.

Authenticating to Workday SOAP API

Connections using the SOAP API support all the same authentication schemes that the WQL and reporting services do, in addition to basic authentication. Each of the above configurations can be used with SOAP by setting the UseWQL property to false.

Basic Authentication

To use basic authentication (which does not require configuring an API client) set the following connection parameters:

ConnectionType: SOAP.
AuthScheme: Basic.
User: The Workday user account name.
Password: The password used to authenticate the user.
Tenant: The tenant for the account.
BaseURL: The base URL for the REST API Endpoint in the View API Clients page.

Other authentication methods are configured the same way as for the WQL and reporting services.

Refreshing OAuth Values

The driver can refresh the temporary OAuth access tokens obtained during the browser-based OAuth authentication exchange. By default, the driver saves the encrypted tokens in the odbc.ini file corresponding to the DSN. Access to this odbc.ini file can be restricted in the case of System DSNs.

To enable the automatic token exchange, you can give the driver write access to the system odbc.ini. Or, you can set the OAuthSettingsLocation connection property to an alternate file path, to which the driver would have read and write access.

    OAuthSettingsLocation=/tmp/oauthsettings.txt

Installing Dependencies for OAuth Authentication

The OAuth authentication standard requires the authenticating user to interact with Workday, using a web-browser. If the first OAuth interaction is to be done on the same machine the driver is installed on, for example, a desktop application, the driver needs access to the xdg-open program, which opens the default browser.

To satisfy this dependency, install the corresponding package with your package manager:


Debian/Ubuntu Package	RHEL/CentOS/Fedora Package	File
xdg-utils	xdg-utils	xdg-open

Set the Driver Encoding

The ODBC drivers need to specify which encoding to use with the ODBC Driver Manager. By default, the CData ODBC Drivers for Unix are configured to use UTF-16 which is compatible with unixODBC, but other Driver Managers may require alternative encoding.

Alternatively, if you are using the ODBC driver from an application that uses the ANSI ODBC API it may be necessary to set the ANSI code page. For example, to import Japanese characters in an ANSI application, you can specify the code page in the config file '/opt/cdata/cdata-odbc-driver-for-workday/lib/cdata.odbc.workday.ini':

[Driver]
AnsiCodePage = 932

ODBC Driver for Workday