Context

When reading job questionnaires from Workday's API, Workday only returns a basic title for each question (e.g. "Professional Experience"). For applicants to have the best user experience, we recommend following this guide to additionally sync the question's descriptions (e.g. "Describe your relevant past professional experiences").

Prerequisites

The ISU you created in the connection flow should have the following permissions assigned:

• Get Only: Questionnaire

Overview

Following this guide should take no longer than 20 minutes. The required steps to set up reading question descriptions are:

1. Creating a custom report that exposes question descriptions
2. Sharing the URL to fetch the custom report

Creating the Custom Report

1. In Workday, search for Create Custom Report in the search bar and click on the task.
2. Set the following settings:
   
   
   
   
   • Report Name: This can be anything, for example, question_descriptions
   • Report Type: Advanced
   • Enable As Web Service: Checked (This checkbox will only appear after setting the report type)
   • Optimized for Performance: Not checked
   • Data Source: Questionnaires (This option will only be available if you have Optimized for Performance unchecked)
     
     
3. 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

1. In the Columns tab, add the following rows to your report:
   
   
   • Questionnaire IDs
     • Business Object: Questionnaire
     • Field: Workday ID
     • Column Heading Override XML Alias: Questionnaire_ID
   • Question ID
     • Business Object: Questions
     • Field: Workday ID
     • Column Heading Override XML Alias: Question_ID
   • Question Name
     • Business Object: Questions
     • Field: Question Name
     • Column Heading Override XML Alias: Question_Name
   • Question Body
     • Business Object: Questions
     • Field: Question Body
     • Column Heading Override XML Alias: Question_Body
       
   • Question Type
     • Business Object: Questions
     • Field: Question Type
     • Column Heading Override XML Alias: Question_Type
       
       
   • In the Group Column Headings table
     
     • Business Object: Questions
     • Column Heading Override XML Alias: Questions
2. 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.
   
   
   
   
3. In the Advanced tab, ensure that Web Services Options still has Enable As Web Service checked.
   
   
   
   
4. Press OK at the bottom of the screen to finalize the report

Getting the Custom Report's URL

1. Click on the three dots (related actions) next to your report's name.
   
   
   
   
2. Navigate to Web Service -> View URLs.
   
   
   
   
3. Right-click on the JSON link, and press Copy URL
   
   
4. Enter the URL in the connection flow