Search

Workday

Workday

Setup Guide

Follow these steps to connect Workday to your CData Connect Cloud account:

  1. Open the Connections page of the CData Connect Cloud dashboard.

  2. Click + Add Connection in the upper-right corner.

  3. Type Workday into the search field, then click the data source name.

  4. On the Basic Settings tab of the new connection, enter a connection name or keep the default name.

  5. Set your Connection Type from the drop-down list.

    • WQL—this connection exposes Workday data sources as read-only views using the Workday Query Language (WQL) service.

    • Reports—this connection exposes Workday reports as views using Reports as a Service (RaaS). The Reports connection has an additional Custom Report URL field. Enter the URL of the report that shows all Reports as a Service (RaaS) reports.

    • REST—this connection exposes Workday data as tables and views using the REST API.

    • SOAP—this connection exposes Workday data as views using the SOAP API.

  6. Choose an Auth Scheme for your connection type and follow the instructions below.

Authentication Methods

OAuth

To connect Workday to CData Connect Cloud using OAuth, you must first create an OAuth app in Workday. Create an OAuth app in Workday shows how to create a standard OAuth app. For other types of OAuth custom apps, refer to this information page.

The Callback URL, or Redirect URL, is the URL you need (https://oauth.cdata.com/oauth/) when setting up your OAuth app. Copy this URL and paste it into your OAuth app.

  1. Enter the following information:

    • OAuth Client Id—the client Id assigned when you register your application with an OAuth authorization server.

    • OAuth Client Secret—the client secret assigned when you register your application with an OAuth authorization server.

    • Base URL—the base URL for the Workday connection. To obtain the Base URL, log in to Workday and search for View API Clients. In the listed values, find the Workday REST API Endpoint. For example, in the URL https://wd3-impl-services1.workday.com/ccx/service/mycompany_gms1/Human_Resources, https://wd3-impl-services1.workday.com is the Base URL.

    • Tenant—the tenant for the account. The tenant is found in your Tenant Setup page in Workday. It is used when constructing a URL to retrieve data from Workday. For example, in the URL https://wd3-impl-services1.workday.com/ccx/service/mycompany_gms1/Human_Resources, mycompany_gms1 is the tenant.

  2. Click Sign in to connect securely through OAuth. This action opens the Workday sign-in page in a new tab.

  3. Log in to your Workday account and provide the requested permissions (if applicable).

  4. At the top of the CData Connect Cloud Add Workday Connection page, click Save & Test.

    • If the connection test succeeds, a message indicates that your connection has been created. The Status on the Edit Connection page also changes to Authenticated.

    • If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. CData Connect Cloud displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the Sign in button. Correct the errors and try again.

OAuthISU

  1. Enter the following information:

    • OAuth Client Id—the client Id assigned when you register your application with an OAuth authorization server.

    • OAuth Client Secret—the client secret assigned when you register your application with an OAuth authorization server.

    • OAuth Refresh Token—the refresh token for the corresponding OAuth access token. Set up an OAuth Refresh Token if authenticating with Integration System Users (ISUs).

    • Base URL—the base URL for the Workday connection. To obtain the Base URL, log in to Workday and search for View API Clients. In the listed values, find the Workday REST API Endpoint. For example, in the URL https://wd3-impl-services1.workday.com/ccx/service/mycompany_gms1/Human_Resources, https://wd3-impl-services1.workday.com is the Base URL.

    • Tenant—the tenant for the account. The tenant is found in your Tenant Setup page in Workday. It is used when constructing a URL to retrieve data from Workday. For example, in the URL https://wd3-impl-services1.workday.com/ccx/service/mycompany_gms1/Human_Resources, mycompany_gms1 is the tenant.

  2. At the top of the CData Connect Cloud Add Workday Connection page, click Save & Test.

    • If the connection test succeeds, a message indicates that your connection has been created. The Status on the Edit Connection page also changes to Authenticated.

    • If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. CData Connect Cloud displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the Sign in button. Correct the errors and try again.

OAuthJWT

  1. Enter the following information:

    • OAuth Client Id—the client Id assigned when you register your application with an OAuth authorization server.

    • OAuth Client Secret—the client secret assigned when you register your application with an OAuth authorization server.

    • OAuth JWT Cert—the contents of the JWT certificate file. An sample format is provided.

    • OAuth JWT Cert Type—the type of key store containing the JWT Certificate. Select the type from the drop-down list.

    • OAuth JWT Issuer—the issuer of the Java Web Token. This is typically either the client Id or the email address of the OAuth application.

    • OAuth JWT Subject—the user subject for which the application is requesting delegated access. This is typically either the user account name or email address.

    • OAuth JWT Cert Password—(optional) the password for the OAuth JWT certificate. Enter a password if the certificate store requires it.

    • OAuth JWT Cert Subject—(optional) the subject of the OAuth JWT certificate. If omitted, the first certificate in the certificate store is used.

    • Base URL—the base URL for the Workday connection. To obtain the Base URL, log in to Workday and search for View API Clients. In the listed values, find the Workday REST API Endpoint. For example, in the URL https://wd3-impl-services1.workday.com/ccx/service/mycompany_gms1/Human_Resources, https://wd3-impl-services1.workday.com is the Base URL.

    • Tenant—the tenant for the account. The tenant is found in your Tenant Setup page in Workday. It is used when constructing a URL to retrieve data from Workday. For example, in the URL https://wd3-impl-services1.workday.com/ccx/service/mycompany_gms1/Human_Resources, mycompany_gms1 is the tenant.

  2. At the top of the CData Connect Cloud Add Workday Connection page, click Save & Test.

    • If the connection test succeeds, a message indicates that your connection has been created. The Status on the Edit Connection page also changes to Authenticated.

    • If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. CData Connect Cloud displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the Sign in button. Correct the errors and try again.

AzureAD

The Callback URL, or Redirect URL, is the URL you need (https://oauth.cdata.com/oauth/) when setting up your OAuth app. Copy this URL and paste it into your OAuth app.

  1. Enter the following information:

    • SSO Properties—additional properties required to connect to the identity provider in a semicolon-separated list.

    • OAuth Client Id—the client Id assigned when you register your application with an OAuth authorization server.

    • Base URL—the base URL for the Workday connection. To obtain the Base URL, log in to Workday and search for View API Clients. In the listed values, find the Workday REST API Endpoint. For example, in the URL https://wd3-impl-services1.workday.com/ccx/service/mycompany_gms1/Human_Resources, https://wd3-impl-services1.workday.com is the Base URL.

    • Tenant—the tenant for the account. The tenant is found in your Tenant Setup page in Workday. It is used when constructing a URL to retrieve data from Workday. For example, in the URL https://wd3-impl-services1.workday.com/ccx/service/mycompany_gms1/Human_Resources, mycompany_gms1 is the tenant.

  2. Click Sign in to connect securely through OAuth. This action opens the Workday sign-in page in a new tab.

  3. Log in to your Workday account and provide the requested permissions (if applicable).

  4. At the top of the CData Connect Cloud Add Workday Connection page, click Save & Test.

    • If the connection test succeeds, a message indicates that your connection has been created. The Status on the Edit Connection page also changes to Authenticated.

    • If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. CData Connect Cloud displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the Sign in button. Correct the errors and try again.

Basic (SOAP Connection Type Only)

  1. Enter the following information:

    • User—the Workday username for authentication

    • Password—the user password

    • Base URL—the base URL for the Workday connection. To obtain the Base URL, log in to Workday and search for View API Clients. In the listed values, find the Workday REST API Endpoint. For example, in the URL https://wd3-impl-services1.workday.com/ccx/service/mycompany_gms1/Human_Resources, https://wd3-impl-services1.workday.com is the Base URL.

    • Tenant—the tenant for the account. The tenant is found in your Tenant Setup page in Workday. It is used when constructing a URL to retrieve data from Workday. For example, in the URL https://wd3-impl-services1.workday.com/ccx/service/mycompany_gms1/Human_Resources, mycompany_gms1 is the tenant.

  2. At the top of the CData Connect Cloud Add Workday Connection page, click Save & Test.

    • If the connection test succeeds, a message indicates that your connection has been created. The Status on the Edit Connection page also changes to Authenticated.

    • If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. CData Connect Cloud displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the Sign in button. Correct the errors and try again.

Create an OAuth App in Workday

OAuth connections to Workday require a custom OAuth application. Follow these steps to create a standard OAuth app:

  1. Login to your Workday account. In the search box at the top of the page, enter Register API Client.

  2. Select the Register API Client form.

  3. Enter a name for the app in the Client Name field.

  4. For the grant type, select Authorization Code.

  5. For the access token type, select Bearer.

  6. In the Redirection URI field, enter https://oauth.cdata.com/oauth/

  7. In the Scope section, enable the Custom Objects > System scope. CData Connect Cloud uses system endpoints to list views and columns.

  8. Add any additional scopes that you require. If you are uncertain about which scopes to include, you can select every scope under each subsection.

  9. Select the Include Workday Owned Scope checkbox.

  10. Click OK to save the app.

  11. Workday loads the View API Client page that contains information about the new app. Copy the Client ID and Client Secret for use in CData Connect Cloud.

More Information

For more information about interactions between CData Connect Cloud and Workday, see this information page.