/ /

Workday Setup

Updated last month

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.


Prerequisites

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

Step 1 — Prepare Workday

  1. 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

      WD.png
      WD1.png

  2. Create the integration security group.

    1. Search for and select the Create Security Group task.

    2. From the Type of Tenanted Security Group dropdown, select Integration System Security Group (Unconstrained).

    3. In the security group members section, add the new Integration System User.

    4. Click Done.
      WD2.png

WD3.png

3. Grant domain security permissions

Grant the security group permission to read essential worker and knowledge base data.

  1. In the Workday app, search for Security Group Membership and Access and run the report.

  2. Search for and select the Security Group created in Step 2.

  3. Click the three dots (…), then select Security Group → Maintain Domain Permissions for Security Group.

  4. 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)

  5. Click OK and Done to save the changes.

    WD4.png
    WD5.png

4. Activate security policy changes

  1. Search for and select the Activate Pending Security Policy Changes task.

  2. Describe your changes in the Comment field for auditing purposes, and click OK.

  3. On the next screen, check the Confirm box and click OK.

5. Generate the refresh token for the ISU

  1. Run the View API Clients report.

  2. Open the API Clients for Integrations tab and select the client from Step 5.

  3. From its related actions menu, select API Client → Manage Refresh Tokens for Integrations.

  4. In the Workday Account field, enter the ISU from Step 1, then click OK.

  5. On the Delete or Regenerate Refresh Token screen, select Generate New Refresh Token and click OK.

  6. On Successfully Regenerated Refresh Token, copy and record the refresh token.
    WD6.png

    WD7.png

Step 2 — Add Workday as a source in Simpplr Enterprise Search Admin Panel

  1. In Simpplr, go to: Manage features → Enterprise search → Add Source. WD8.png

  2. Search for and select Workday.

  3. Enter a Connection Name for this instance.

  4. 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

     WD9.png

  5. 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.

Step 3 — Set the ingestion scope

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.

  1. 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.

  2. 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.

Step 4 — Verify the sync

  1. Monitor progress at: Enterprise Search → Workday → Status.

  2. The dashboard shows sync status, total items indexed, and any errors.

    WD10.png

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.

Related pages

Page

What it covers

Overview - Workday

What the connector indexes and capabilities at a glance

Permissions & Security - Workday

Auth mechanism, credential scope, permission design, supported editions

Content, Sync & Limitations - Workday

Fields synced per content type, sync schedules, data freshness, limitations in detail

Troubleshooting & FAQs - Workday

Connector-specific issues and FAQs

Was this article helpful?
Subscribe to receive updates on this article