Prerequisites

• Ensure you are an admin of your Workday account before starting.
  1. After logging into Workday, search for "View API Clients"
  2. If you can not see this menu item, you are not an admin of the Workday account.
     
  3. If you do not see this menu item, figure out who your Workday Admin is and ask them to give your account sufficient permissions or to take over the integration process.

Find your Workday Service URL

1. Click on the "Search" field at the top and enter "View API Clients"
2. Click on the task "View API Clients" that just appeared
3. At the top of the page that just appeared find and copy the "Workday REST API Endpoint"

Add an integration system user (ISU)

1. Click on the "Search" field at the top and enter "Create Integration System User"
2. Click on the task "Create Integration System User" that just appeared
3. In the dialog that just opened, enter a username and generate a secure password.
   You can leave the other fields untouched
4. At the bottom of the dialog, click "OK"

Add the ISU to your list of system users

While the newly created ISU will work for linking your Workday account its password will expire after some time unless you add it to your list of system users.

Create a security group and assign the ISU to it

1. Click on the "Search" field at the top and enter "Create Security Group"
2. Click the task "Create Security Group" that just appeared
3. On the page that just appeared locate the dropdown "Type of Tenanted Security Group" and select "Integration System Security Group (Unconstrained)"
4. For the "Name" enter the value of the "User Name" when creating the ISU earlier (in this case it would be test_isu, but yours will be different)
5. At the bottom of the page, click "OK"
6. On the next page, the only thing you have to do is go to the field "Integration System Users" and add the user you created earlier. You can do this by clicking on the field and typing in the name of the ISU (in this case test_isu)
7. After that, go ahead and click "OK"

Add the required permissions to the security group

1. Click on the "Search" field at the top and enter "Maintain Permission for Security Group"
2. Click on the task "Maintain Permission for Security Group" that just appeared
3. In the window that just appeared, make sure you have the option "Maintain" selected
4. Click the field "Source Security Group", enter the name of the group (in this case test_isu) and hit enter. Then click on the security group to select it.
5. Click "OK"
6. In the window that just appeared, you can add the permissions you want for the ISU. You can find the list of permissions needed in the connection flow.
   
   
   
   If you want to know why each permission is needed, see below under "Documentation of possible permissions"
   
   
   For each permission, repeat the following process:
   
   1. Make sure the tab "Domain Security Policy Permissions" is selected
   2. Click on the icon with the "+" on it
   3. Click on the cell in the column "View/Modify Access"
      If the permission says "Get:", select "Get Only". Otherwise select "Get and Put"
      
   4. Click on the cell in the column "Domain Security Policy",
      
      type in the name of the policy (i.e. "Integration: Build"), hit enter and click on the item that just appeared in a list

Activate your changes

After making any changes to your Workday security policy settings, make sure to apply those changes by executing the "Activate Pending Security Policy Changes" task. Without that, none of your changes with take effect.

1. Click on the "Search" field at the top and enter "Activate Pending Security Policy Changes"
2. Click on the task "Activate Pending Security Policy Changes" that just appeared
3. In the window that just appeared, add any comment for applying the changes (i.e. "Grant ISU test_isu necesssary permissions for integratons"
4. Click "OK"
5. In the new window, check the box "Confirm"
6. Click "OK"

Create an API client

Please note that this step is only necessary if you want to read/write absences data from your Workday instance. In all other cases you can skip the steps below

1. Click on the "Search" field at the top and enter "Register API Client for Integrations"
2. Click on the task "Register API Client for Integrations" that just appeared
3. In the window that just appeared, enter a "Client Name", i.e. "test_isu API client"
4. Make sure the option "Non-Expiring Refresh Tokens" is turned on
5. For the field "Scope (Functional Areas)", enter the values
   Tenant Non-Configurable
   Staffing
   Time Off and Leave
   System
6. Click "OK"
7. In the new window, copy the Client ID and Client Secret for later use, then do not click "Done"
8. Still on the same page, click the three dots at the top, then "API Client" > "Manage Refresh Tokens for Integrations"
9. In the new window, enter the name of the ISU that you created earlier
10. Click "OK"
11. In the new window, check the box for "Generate New Refresh Token"
12. Click "OK"
13. In the new window, copy the refresh token and store it for later use

Documentation of possible permissions

Custom Reports

Instead of granting the ISU access to the API, it is possible to create Custom Reports in Workday and to share access to the reports with the ISU. This allows minimal authorization, as the ISU can then strictly access only its shared reports, and the fields specified in those reports.

1. Search for "Create Custom Report" in Workday and click on the item:
   
   
   
2. Fill in the information as follows:
   Report Name: INTEGRATION_REPORT_WORKER
   Report Type: Advanced
   Enable As Web Service: Checked
   Data Source: Indexed All Workers
   
   
   
3. Once you've filled in the necessary information, click on OK to save the new report:
   
   
   
4. On the next page, remove the previously selected data source, then search for "All workers" and select this menu item (if you want the report to access only a subset of users, you can select your filtered data source instead):
   
   
   
5. Next, return to the connection instructions. Based on the fields required, you'll find instructions to set up all the necessary fields that will be required for the report.
   
   
6. Following the instructions, add each necessary field under the "Columns" and "Group Column Headings" section found in the report below.
   1. Please find the documentation for all the necessary fields here.
   2. Ensure that you enter the following data as instructed for each field:
      • Business Object
      • Field
      • Column Heading Override
      • Column Heading Override XML Alias
        
        
        
7. Once you have finished setting up the fields, go to the "Share" tab and grant access to the group and ISU you have previously created for the integration:
   

Documentation of Custom Report fields