Synchronize Zelo with Workday directories using JSON endpoints

Introduction

This guide outlines how to synchronize Zelo with Workday directories.

To synchronize an organization’s users and groups provisioned for Zelo, we need the following information from the organization:

The Workday Custom Report JSON endpoint
The Workday Custom Group Report JSON endpoint
Username for accessing the Custom Report endpoint
Password for accessing the Custom Report endpoint

Create an Integration System User

It’s recommended that the organization creates an Integration System User within Workday. The Integration System User will be used to access Custom Reports.

A screenshot of the "Create Integration System User" form in the Workday Dashboard.

If you’ve finished the setup, and everything works as expected but fields are missing from the Report, ensure that the user created has access to access to the fields.

A screenshot showing user access to a report in the Workday Dashboard.

Create a Security Group

Create a new security group in Workday. Set the Type of Tenanted Security Group to Integration System Security Group (Unconstrained). Then add a name for the Security Group and select OK.

A screenshot showing the "Create Security Group" form in the Workday Dashboard.

Next, for Integration System Users, add the integration system user you created in the previous step, and select OK.

A screenshot showing where to add the Integration System User in the Workday Dashboard.

Add domain security policies to the Security Group

Next, you’ll need to add domain security policies to the newly created security group. You can access this on the Security Group Settings → Maintain Domain Permissions for Security Group page.

A screenshot showing where to find the "Maintain Domain Permissions for Security Group" option in the Workday Dashboard.

You’ll need to permit the following domain security policies to have “Get” access under Integration Permissions:

Person Data: Work Contact Information
Workday Accounts
Worker Data: Active and Terminated Workers
Worker Data: All Positions
Worker Data: Business Title on Worker Profile
Worker Data: Current Staffing Information
Worker Data: Public Worker Reports
Worker Data: Workers

A screenshot showing Integration Permissions in the Workday Dashboard.

To activate these new security settings, you need to go to the Activate Pending Security Policy Changes page and click OK.

A screenshot showing the Activate Pending Security Policy Changes page in the Workday Dashboard.

Then, select the Confirm checkbox to finish activating.

A screenshot showing where to confirm the Active Pending Security Policy Changes in the Workday Dashboard.

Create and Populate Custom Reports

You will need to create two Custom Reports. The first Custom Report will be used for syncing User information. The second report will be used for syncing Group information.

When creating the report, make sure to select the Advanced report type and to have the Enable as Web Service box checked.

A screenshot showing the "Create Custom Report" page in the Workday Dashboard.

You need to add information for certain fields to the report. You can do this by directly adding columns to the report for the attributes in Workday with column heading names specified as follows:

employee_id
user_name
primary_work_email
first_name
last_name
job_title
group_name

A screenshot showing an example of Custom User Report in the Workday Dashboard.

Along the same lines as the User Report, Zelo looks for the following information in the Group Report:

group_name

Add an authorized user

If an Integration System User was created, the organization will want to have that user added as an authorized user. This can be found under the Share tab from within a Report.

A screenshot showing the "Share" tab in the Workday Dashboard.

Get the RaaS endpoint

Now that the Report itself is setup and access to it had been configured, the organization will need to get the RaaS endpoint. The page with the endpoints can be found under Actions → Web Service → View URLs.

A screenshot showing where to find the view URLs option in the Workday Dashboard.

Once on the URLs page, the one that Zelo will need is listed under the JSON section.

A screenshot showing the View URLs Web Service page in the Workday Dashboard.

Zelo set-up

When provided the JSON endpoints, username and password, Zelo will set up the sync on the application side and confirm a successful sync.

View users and groups in Zelo

Now, whenever the organization assigns users or groups to your Zelo, this can be monitored by navigating to the "Recipients" page in Zelo.

Frequently asked questions

How often does Zelo perform a sync?

Zelo directory synchronization polls in every 30 minutes starting from the time of the initial sync.