This guide is self-contained — every permission and scope required is listed in the steps below. For why each permission is needed, the permission design, and the full security details, see Permissions & Security - Workday.
Who you need to be
A Workday administrator holding the Integration Security domain (Integration functional area) — to create the Integration System User and register the API client
The Security Configuration domain (System functional area) — to create the integration security group and activate pending policy changes
The Set Up: Tenant Setup - Security and Security Administration domains (System functional area) — to register the API client
In Simpplr: permission to manage Enterprise Search sources
Create the Integration System User. Run the Create Integration System User task and complete it as follows:
User Name — a unique name, for example ISU_Simpplr_Search
New Password and New Password Verify — set a password
Require New Password at Next Sign In — do not select
Session Timeout Minutes — set to 0, so the integration session does not expire
Do Not Allow UI Sessions — select
Create the integration security group.
Search for and select the Create Security Group task.
From the Type of Tenanted Security Group dropdown, select Integration System Security Group (Unconstrained).
In the security group members section, add the new Integration System User.
Click Done.
Grant the security group permission to read essential worker and knowledge base data.
In the Workday app, search for Security Group Membership and Access and run the report.
Search for and select the Security Group created in Step 2.
Click the three dots (…), then select Security Group → Maintain Domain Permissions for Security Group.
Under Integration Permissions, add the following domains and select Permitting Get access for each:
Worker Data: Workers
Help Article REST API (For knowledge base articles)
Click OK and Done to save the changes.
4. Activate security policy changes
Search for and select the Activate Pending Security Policy Changes task.
Describe your changes in the Comment field for auditing purposes, and click OK.
On the next screen, check the Confirm box and click OK.
5. Generate the refresh token for the ISU
Run the View API Clients report.
Open the API Clients for Integrations tab and select the client from Step 5.
From its related actions menu, select API Client → Manage Refresh Tokens for Integrations.
In the Workday Account field, enter the ISU from Step 1, then click OK.
On the Delete or Regenerate Refresh Token screen, select Generate New Refresh Token and click OK.
On Successfully Regenerated Refresh Token, copy and record the refresh token.
In Simpplr, go to: Manage features → Enterprise search → Add Source.
Search for and select Workday.
Enter a Connection Name for this instance.
Enter the values gathered in Step 1:
Workday host — the API host, for example https://wd2-impl-services1.workday.com
Tenant name
Client ID
Client secret
Refresh token
Click Save configuration and confirm. Simpplr validates the credentials by calling Workday at this point, so an incorrect host, tenant, or credential is reported here rather than at the first sync.
Note: This creates the connector, but data sync does not begin yet. You can set the ingestion scope in the next step before the first sync runs.
This connector has no content filters to configure. What gets indexed is decided in Workday: only article versions whose status is Published and whose audience includes Public, and only those updated within the last 2 years.
Set Audience configuration (optional) — restrict the connector to a specific Simpplr audience. Only members of the selected audience will be able to find this content in Enterprise Search. If left unset, all users with access can search this content. Because Workday article permissions are not synced, this is the only way to narrow who can discover these articles within Simpplr.
Click Save and sync — this saves the configuration and initiates the first full sync.
Alternatively, click Exit to save and resume setup later. To start the sync manually, go to Enterprise Search → Workday → Status and click Sync now.
Monitor progress at: Enterprise Search → Workday → Status.
The dashboard shows sync status, total items indexed, and any errors.
What success looks like:
Shortly after the connector is initialised, the status shows In progress and the item count begins increasing.
When the initial full sync completes, the status shows Success and Workday Help articles appear in Enterprise Search for users with access.
Workday Help libraries are usually curated rather than large, so the initial full sync typically completes in minutes rather than hours
If the sync fails, indexes nothing, or indexes far fewer articles than you expected, see Troubleshooting & FAQs - Workday. For issues common to all connectors, see Troubleshooting - Enterprise Search Connectors.
Page | What it covers |
|---|---|
What the connector indexes and capabilities at a glance | |
Auth mechanism, credential scope, permission design, supported editions | |
Fields synced per content type, sync schedules, data freshness, limitations in detail | |
Connector-specific issues and FAQs |