Context
Reading parallel stages from Workday is not directly supported via Workday's API. To read an application's parallel stages, some additional setup is required.
Prerequisites
This guide assumes that you have already completed the connection flow. This is important as you require an ISU (Integration System User) to which you'll assign the custom report.
Additionally, your created ISU should have the following permissions assigned:
- Get Only: Candidate Data: Job Application
You will most likely have already done this if the integration is syncing applications.
Overview
Setting up parallel stages should take no longer than 20 minutes. The required steps to set up reading parallel stages are:
- Creating a custom report that exposes parallel stages
- Sharing the URL to fetch the custom report
Creating the Custom Report
- In Workday, search for Create Custom Report in the search bar and click on the task.
- Set the following settings:
- Report Name: This can be anything, for example, parallel_stages
- Report Type: Advanced
- Enable As Web Service: Checked (This checkbox will only appear after setting the report type)
- Optimized for Performance: Not checked (This checkbox might become checked after setting the Data Source. Double check that it is not checked)
- Data Source: Job Applications (Search for Job Applications and click on the option)
- Press OK at the bottom of the screen to create the report
How to Edit a Custom Report
To add rows you have to click on the plus sign:
To set field values, you have to enter the desired text and select the option from the menu after hitting enter. For column headings, no menu of options will appear as the value is not restricted.
Edit the Custom Report
- In the Columns tab, add the following two rows to your report:
- Job Applications
- Business Object: Job Application
- Field: Workday ID
- Column Heading Override XML Alias: Application_ID
- Parallel Stages
- Business Object: Job Application
- Field: Candidate Parallel Stages
- Column Heading Override XML Alias: Parallel_Stage
- Job Applications
- In the Filter tab, add the following row to your report:
- And/Or: And
- Field: Candidate Parallel Stages
- Operator: is not empty
- In the Share tab, set the Report Definition Sharing Options to Share with specific authorized groups and users, and select the ISU and group that you used to create the integration.
- In the Advanced tab, ensure that Web Services Options still has Enable As Web Service checked.
- Press OK at the bottom of the screen to finalize the report
Getting the Custom Report's URL
- Click on the three dots (related actions) next to your report's name.
- Navigate to Web Service -> View URLs.
- Right-click on the JSON link, and press Copy URL
Sharing the URL
Please reach out to your partner who linked this guide to you, and send them the URL to your custom report.
Combined with the credentials that you entered in the connection flow, this link can be used to retrieve the custom report, including the parallel stages.