Workday

​

Overview

Our Workday integration allows you to connect your Workday instance with Apriora through an Integration System User (ISU). This integration enables secure data exchange between the systems while maintaining proper access controls and permissions. OAuth is required for this integration to work. There are three main steps to configuring the Workday Integration:

1. Workday Security Configuration
   • Create the Integration System User (ISU)
   • Create a security group and assign the ISU to it
   • Assign domain security policies to the security group
   • Activate security policies
   • Register the API Client
2. Workday Assessment Configuration
   • Setup Statuses
   • Setup Assessment
   • Business Process Configuration
3. Apriora Configuration

​

Workday Security Configuration

​

Create the Integration System User (ISU)

First, you’ll need to create a dedicated Integration System User in your Workday tenant. Log in to your Workday tenant with administrator credentials and search for Create Integration in the Workday search box. Select the Create Integration System User task.

• Name the user Apriora_Integration_User.
• When creating the password, avoid using special characters like &, =, ?, %, /, and \.
• Make sure that the Require New Password at Next Sign In box is not checked.
• Make sure the Session Timeout Minutes is set to 0.
• Check the box, Do Not Allow UI Sessions to prevent the integration user from logging in to Workday using a web browser.
• Click OK and then Done to create the user.

​

Create a Security Group

Next, create a security group and assign your Integration System User to it. Search for Create Security Group in the Workday search box and select the task.

• Select the type as Integration System Security Group (Unconstrained).
• Name the group Apriora_Integration_SG.
• Click OK to create the group.
• In the Edit Integration System Security Group (Unconstrained) screen, make sure the ISU account Apriora_Integration_User is included in the security group.
• Click OK, then Done.

​

Assign Domain Security Policies

Then, you need to assign the required permissions to the security group you just created. There are three domains that require permissions. These are the minimum permissions required for the integration to work:

Functional Area	Domain Security Policy	Operation
Recruiting	Candidate Data: Job Application	Get
Recruiting	Candidate Data: Assessment Results	Get, Put
Contact Information	Person Data: Work Contact Information	Get

For each domain you must do the following:

• Find the domain using the View Domain report.
• Using the related actions, go to Domain > Edit Security Policy Permissions.
• Using the + button in the top left of the Integration Permissions table, add the security group you just created as a new row with the appropriate Get and Put permissions.
• Click OK to save the changes.

​

Activate Security Policies

After updating the security policies to all of the domains in the table above, you need to activate your security policy changes.

• Go to the Activate Pending Security Policy Changes task.
• Enter a description of the changes and click OK to review the policies.
• Check the Confirm box and click OK to activate the policies.

​

Register the API Client

In order for the integration to use the OAuth authentication flow, you will need to create a new API Client for Apriora, and generate a refresh token associated with the ISU. Make sure you are logged in to your Workday tenant with administrator credentials, and access the Register API Client for Integrations task.

• Set the Client Name as Apriora.
• Make sure that the Non-Expiring Refresh Tokens box is checked and the Refresh Token Timeout is set to 0.
• Set the Scope (Functional Areas) to contain Contact Information and Recruiting.
• Make sure that the Include Workday Owned Scope box is checked.
• Click OK to register the API Client.
• Before clicking Done, copy and store the Client ID and Client Secret somewhere (You can only view the Client Secret once, at the time of creation).

• After clicking Done you should be taken to the View API Clients screen.
• Copy and store the Token Endpoint thats visible at the top of the screen.
• Make sure you are in the API Clients for Integrations tab, and locate the Apriora row.
• Using the related actions, go to API Client > Manage Refresh Tokens for Integrations.

• For the Workday Account, select the Apriora_Integration_User you just created.
• Click OK.

• Check the Generate New Refresh Token box.
• Click OK.
• Copy and store the new Refresh Token from the table.

​

Workday Assessment Configuration

​

Setup Statuses

The next step is to setup the assessment statuses in Workday. The Overall Status relates to the current state of the Candidate’s interview, while the Test Status is used once the interview is completed and evaluated. You will need to create the following statuses:

Assessment Status Name	Reference ID	Overall Status	Test Status
Apriora - Trigger Invite	Apriora_Trigger_Invite	Yes
Apriora - Error	Apriora_Error	Yes
Apriora - Triggered	Apriora_Triggered	Yes
Apriora - Invite Sent	Apriora_Invite_Sent		Yes
Apriora - Interview Scheduled	Apriora_Scheduled		Yes
Apriora - Interview Missed	Apriora_Missed		Yes
Apriora - Interview Incomplete	Apriora_Incomplete		Yes
Apriora - Interview Complete	Apriora_Complete		Yes
Apriora - Shortlisted	Apriora_Shortlisted		Yes
Apriora - Rejected	Apriora_Rejected		Yes

• Go to the Maintain Assessment Status task.
• Click on the + button at the top to add new statuses.
• Add each status from the table above using the given name, and status type.
• Click OK to save the new statuses.

After the page saves, you will need to edit the reference ID for each status.

• Using the related action, go to Integration IDs > Edit Reference ID.

• For the given status, copy and paste the reference ID from the table above into the Reference ID Value field.

• Click OK to save the changes.

​

Setup Assessment

Now you will need to setup the Apriora assessment in Workday. You can use this using the Maintain Recruiting Assessment Tests task.

• Use the + button at the top to add a new Assessment Test.
• Name the test Apriora Interview and click OK to save the new assessment.
• You also need to edit the reference ID for the assessment. Using the related action, go to Integration IDs > Edit Reference ID.
• Set the Reference ID Value to be apriora_interview
• Click OK to save the changes.

​

Business Process Configuration

​

Apriora Configuration

The last step is to enter all the Workday credentials and WSDL Service URL in Apriora.

• Make sure you are logged in to Apriora as an Admin.
• Go to the Settings page and click on the Integrations tab, then click on Workday.

• Enter the Client ID, Client Secret, Token Endpoint, and Refresh Token from the previous steps
• Enter your WSDL Service URL. This will be in the format: https://<baseurl>/ccx/service/<tenant>/<service>/v<version>?wsdl.
• Click on the Test Connection button to ensure that the credentials are correct.
• Once the connection is validated, click on the Connect button to save the credentials and enable the Workday integration.