Configuring a Connection
After Installing the Connector you can connect and create a Data Source for data in Workday.
Setting Up a Data Source
Complete the following steps to connect to the data:
- Under Connect | To a Server, click More....
- Select the data source called Workday by CData.
- Enter the information required for the connection.
- Click Sign In.
- If necessary, select a Database and Schema to discover what tables and views are available.
Using the Connection Builder
The connector makes the most common connection properties available directly in Tableau. However, it can be difficult to use if you need to use more advanced settings or need to troubleshoot connection issues. The connector includes a separate connection builder that allows you to create and test connections outside of Tableau.
There are two ways to access the connection builder:
- On Windows, use a shortcut called Connection Builder in the Start menu, under the CData Tableau Connector for Workday folder.
- You can also start the connection builder by going to the driver install directory and running the .jar file in the lib directory.
In the connection builder, you can set values for connection properties and click Test Connection to validate that they work. You can also use the Copy to Clipboard button to save the connection string. This connection string can be given to the Connection String option included in the connector connection window in Tableau.
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 connector opens Workday's OAuth endpoint in your default browser. Log in and grant permissions to the application.
After you grant permissions to the application, the connector then completes the OAuth process:
- The connector obtains an access token from Workday and uses it to request data.
- The OAuth values are saved in the path specified in OAuthSettingsLocation. These values persist across connections.
When the access token expires, the connector refreshes it automatically.
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.
Next Step
See Using the Connector to create data visualizations.