Workday RaaS Setup Guide

Follow our setup guide to connect Workday RaaS to Fivetran.

Prerequisites

To connect Workday RaaS to Fivetran, you need:

• An active Workday report URL
• The username and password to access that Workday report URL
• To configure the reports as Advanced type reports to enable web service access

Setup instructions

NOTE: You must add a separate Workday RaaS connection in your Fivetran dashboard for each report. Each Workday RaaS connection will sync its report data to its own table in your destination.

Create new user

1. Log in to your Workday application using an Administrator account.
2. In the application's search box, search for 'create user' and then select Create Integration System User. Fivetran uses the Integration System User to access custom reports.
3. Enter a User Name and Password.
4. Leave the Require New Password at Next Sign In checkbox clear.
5. If you want to use the Basic authentication mode in the Fivetran setup form, select the Do Not Allow UI Sessions checkbox.

   NOTE: If you select the OAuth authentication mode in the Fivetran setup form, do not select the Do Not Allow UI Sessions checkbox. OAuth requires UI sessions.

6. Click OK and then click Done.

Create security group

1. In the Create Security Group window, set the Type of Tenanted Security Group to Integration System Security Group (Unconstrained).
2. Enter a Security Group Name and click OK.
3. In the Edit Integration System Security Group (Unconstrained) window, add the integration system user you created in Step 1 in the Integration System Users field.
4. Click OK.

Add domain security policies

1. Go to Security Group Settings > Maintain Domain Permissions for Security Group.

2. In the Integration Permissions section, in the Domain Security Policies permitting Get access field, select the security domains associated with the reports you want to sync.

   NOTE: For the complete list of security domains associated with the Workday Financial Management and Workday Human Capital Management modules, see our Workday Financial Management setup guide and Workday Human Capital Management setup guide. However, the list of security domains in our setup guides is not comprehensive. Some objects may require additional permissions. To identify the required object permissions, use the View Security for Securable Item task in your Workday tenant.

Activate policies

1. Go to the Activate Pending Security Policy Changes page and click OK.
2. Click Confirm to activate.

Create custom report

1. On the Create Custom Report page, enter the Report Name.

2. In the Report Type drop-down menu, select Advanced.

3. Select the Enable as Web Service option.

4. Add Data Source. Add the fields you want to sync.

   NOTE: You can create one or more custom reports.

Add authorized user to report

In the custom report's Share tab, add the user you created in Step 1 in the Authorized Users field.

Finish custom report configuration

1. In each custom report's Advanced tab, share each report to Report-as-a-WebService.

   

2. For each report, go to Actions --> Web Service --> View URLs. Make a note of the REST URL. You will need it to fill in your Fivetran connection setup form.

   

   IMPORTANT: If you want to incrementally sync your reports, you must specify their query parameters as dynamic values in the report URLs. For more information, see our connector overview documentation.

3. Test each report by pasting it into a new browser session, and log in using the Fivetran ELT web service user. If the Report XML does not display, check your user security settings.

4. Select the primary key(s). To track history of the report data, make a timestamp column part of the composite primary key.

Connect using OAuth

IMPORTANT: Perform this step only if you want to authenticate your account using OAuth. Skip to the next step if you want to use Basic authentication to sync your data. The API client uses rotating refresh tokens and requires you to manually authorize the client while setting up the connection. The API client for integrations uses non-expiring refresh token to set up the connection and thus does not require you to manually authorize the client.

Create custom OAuth client app

Create custom OAuth client app for Integrations

Finish Fivetran configuration

1. In your connection setup form, enter the Destination schema name of your choice.

2. (Hybrid Deployment only) If your destination is configured for Hybrid Deployment, the Hybrid Deployment Agent associated with your destination is pre-selected in the Select an existing agent drop-down menu. To use a different agent, select the agent of your choice, and then select the same agent for your destination.

3. Enter the Destination table name of your choice.

4. Select the authentication mode: Basic or OAuth.

5. (Optional) If you choose Basic, do the following:

   • Enter the Username and Password for the Fivetran ELT user you created.

6. (Optional) If you choose OAuth, do the following:

   • Enter your Workday Tenant. You can find the tenant in your Workday Web Services URL: https://<Workday-host-name>/ccx/service/<Workday-Tenant>/....

   • Enter the Client ID you created.

   • Enter the Client Secret you created.

   • Enter your Workday Hostname. You can find the Workday Hostname in your Workday Web Services URL, in the following format: https://<Workday-host-name>/ccx/service/....

   • In the Authorization URL field, enter the authorization endpoint that you found.

   • Click Authorize to allow Fivetran to access your Workday account using OAuth. You will be redirected to your Workday account to authorize Fivetran's access.

     IMPORTANT: We recommend logging in while in incognito mode to ensure authorization of the correct account.

   • Log in to your Workday account with the integration system user you created in Step 1. Once you have finished, you will be redirected back to Fivetran.

7. Set the Use API Client for Integration toggle button to ON to use the API client for integration that you created.

8. If you choose OAuth and register an API Client for Integration, do the following:

   1. Enter your Workday Tenant. You can find the tenant in your Workday Web Services URL: https://<Workday-host-name>/ccx/service/<Workday-Tenant>/....
   2. Enter the Client ID you created.
   3. Enter the Client Secret you created.
   4. Enter your Workday Hostname. You can find the Workday Hostname in your Workday Web Services URL, in the following format: https://<Workday-host-name>/ccx/service/....
   5. Enter the Refresh Token you generated.

9. Click + Add report.

10. Enter your Destination table name. The name must be unique within the connection and follow Fivetran's naming conventions.

11. Enter the Report URL you found.

12. In the Report Format drop-down menu, select the report format type. The default format is json.

13. If you set the Enable Dynamic Parameters toggle to ON, enter the following information:

    1. In the Enter Report Start Date Field, enter the field which represents when the sync starts from, for example, start_date.
    2. In the Enter Dynamic Parameter Field, enter the field which will be updated dynamically to the current date , for example, end_date.
    3. In the Select report start date, select the date to set the initial date for the sync.
    4. From the Choose sync strategy for your connector dropdown, select your suitable sync strategy to capture updates in the report. For more information, read our Sync strategy documentation.

14. To unpack the nested columns and sync them separately, set the Enable Unpacking Nested Columns toggle to ON. By default, we sync the nested columns as JSON objects into your destination.

    NOTE:

    • We can unpack only the nested columns and not the columns with nested arrays.
    • When we unpack and sync the nested columns, the unpacked values may exceed the column limits of your destination.

15. Select the Primary Keys you want to use. If you do not want to select a Primary Key, set the Use Fivetran Generated Primary Key toggle to ON.

    NOTE: We do not support selecting columns from within nested child objects as primary keys in your Workday RaaS reports.

16. Click Save & Test. Fivetran will take it from here and sync your data from your Workday account.

Related articles

description Connector Overview

account_tree Schema Information

assignment Release Notes

settings API Connection Configuration

home Documentation Home