Configure Connection

Workday guide

Arrange Workday API access, configure tenant credentials in NIM, and validate worker retrieval and intended email updates.

Before you beginDirect link to Before you begin

Follow the Workday API access setup documentation with your Workday administrator to configure integration access for your environment.

NIM requires Hostname, Tenant ID, Username, and Password.

Obtain tenant and account detailsDirect link to Obtain tenant and account details

Work with your administrator to configure API access using the Workday documentation.
Obtain the Hostname, Tenant ID, and integration account Username and Password for the intended environment.
Confirm permission to retrieve workers and the response groups included in the connection test below.
If your process updates worker email information, arrange the corresponding write permissions and store credentials securely.

Enter the connection settingsDirect link to Enter the connection settings

In NIM Studio, open Systems > Overview and add a Workday system, or select the existing system.
Open Connection, enter the following settings, and save.

NIM setting	Value
Hostname	The Workday service host for your environment, using the format expected by the Connection screen.
Tenant ID	The Workday tenant identifier supplied by your administrator.
Username	The account authorized for the integration, in the format required by your tenant.
Password	The corresponding account password.

Test SOAP worker retrievalDirect link to Test SOAP worker retrieval

Select Test Connection. NIM attempts to retrieve workers with a Get_Workers_Request using version v42.1, page 1, and count 1, without excluding inactive workers. The following example shows the request body; the bsvc namespace is declared for clarity.

<bsvc:Get_Workers_Request xmlns:bsvc="urn:com.workday/bsvc" bsvc:version="v42.1">
    <bsvc:Response_Filter>
        <bsvc:Page>1</bsvc:Page>
        <bsvc:Count>1</bsvc:Count>
    </bsvc:Response_Filter>
    <bsvc:Request_Criteria>
        <bsvc:Exclude_Inactive_Workers>false</bsvc:Exclude_Inactive_Workers>
    </bsvc:Request_Criteria>
    <bsvc:Response_Group>
        <bsvc:Include_Reference>true</bsvc:Include_Reference>
        <bsvc:Include_Personal_Information>true</bsvc:Include_Personal_Information>
        <bsvc:Include_Employment_Information>true</bsvc:Include_Employment_Information>
        <bsvc:Include_Compensation>true</bsvc:Include_Compensation>
        <bsvc:Include_Organizations>true</bsvc:Include_Organizations>
        <bsvc:Include_Roles>true</bsvc:Include_Roles>
        <bsvc:Include_Management_Chain_Data>true</bsvc:Include_Management_Chain_Data>
        <bsvc:Include_User_Account>true</bsvc:Include_User_Account>
        <bsvc:Include_Worker_Documents>true</bsvc:Include_Worker_Documents>
    </bsvc:Response_Group>
</bsvc:Get_Workers_Request>

Confirm that the test succeeds. If it fails, verify the Hostname, Tenant ID, credentials, network access, and account permissions for the requested worker data.
Collect the worker data required by your process and validate identity matching and field mappings before enabling downstream provisioning.
Test an intended email change with a safe worker record and verify the result in Workday before enabling automated email updates.

The connection test checks worker retrieval. Validate email write permissions and any other data required by your process separately.

Step 1 of 3