You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/active-directory/app-provisioning/workday-integration-reference.md
+25-25Lines changed: 25 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,7 +28,7 @@ This article explains how the integration works and how you can customize the pr
28
28
### Restricting Workday API access to Azure AD endpoints
29
29
Azure AD provisioning service uses basic authentication to connect to Workday Web Services API endpoints.
30
30
31
-
To further secure the connectivity between Azure AD provisioning service and Workday, you can restrict access so that the designated integration system user only accesses the Workday APIs from allowed Azure AD IP ranges. Please engage your Workday administrator to complete the following configuration in your Workday tenant.
31
+
To further secure the connectivity between Azure AD provisioning service and Workday, you can restrict access so that the designated integration system user only accesses the Workday APIs from allowed Azure AD IP ranges. Engage your Workday administrator to complete the following configuration in your Workday tenant.
32
32
33
33
1. Download the [latest IP Ranges](https://www.microsoft.com/download/details.aspx?id=56519) for the Azure Public Cloud.
34
34
1. Open the file and search for tag **AzureActiveDirectory**
@@ -37,7 +37,7 @@ To further secure the connectivity between Azure AD provisioning service and Wor
37
37
>
38
38
39
39
1. Copy all IP address ranges listed within the element *addressPrefixes* and use the range to build your IP address list.
40
-
1.Log in to Workday admin portal.
40
+
1.Sign in to Workday admin portal.
41
41
1. Access the **Maintain IP Ranges** task to create a new IP range for Azure data centers. Specify the IP ranges (using CIDR notation) as a comma-separated list.
42
42
1. Access the **Manage Authentication Policies** task to create a new authentication policy. In the authentication policy, use the authentication allow list to specify the Azure AD IP range and the security group that will be allowed access from this IP range. Save the changes.
43
43
1. Access the **Activate All Pending Authentication Policy Changes** task to confirm changes.
@@ -46,10 +46,10 @@ To further secure the connectivity between Azure AD provisioning service and Wor
46
46
47
47
The default steps to [configure the Workday integration system user](../saas-apps/workday-inbound-tutorial.md#configure-integration-system-user-in-workday) grants access to retrieve all users in your Workday tenant. In certain integration scenarios, you may want to limit the access, so that users belonging only to certain supervisory organizations are returned by the Get_Workers API call and processed by the Workday Azure AD connector.
48
48
49
-
You can fulfill this requirement by working with your Workday admin and configuring constrained integration system security groups. For more information on how this is done, please refer to [this Workday community article](https://community.workday.com/forums/customer-questions/620393) (*Workday Community login credentials are required to access this article*)
49
+
You can fulfill this requirement by working with your Workday admin and configuring constrained integration system security groups. For more information, refer to [this Workday community article](https://community.workday.com/forums/customer-questions/620393) (*Workday Community access required for this article*)
50
50
51
-
This strategy of limiting access using constrained ISSG (Integration System Security Groups) is particularly useful in the following scenarios:
52
-
***Phased rollout scenario**: You have a large Workday tenant and plan to perform a phased rollout of Workday to Azure AD automated provisioning. In this scenario, rather than excluding users who are not in scope of the current phase with Azure AD scoping filters, we recommend configuring constrained ISSG so that only in-scope workers are visible to Azure AD.
51
+
This strategy of limiting access using constrained ISSG (Integration System Security Groups) is useful in the following scenarios:
52
+
***Phased rollout scenario**: You have a large Workday tenant and plan to perform a phased rollout of Workday to Azure AD automated provisioning. In this scenario, rather than excluding users who aren't in scope of the current phase with Azure AD scoping filters, we recommend configuring constrained ISSG so that only in-scope workers are visible to Azure AD.
53
53
***Multiple provisioning jobs scenario**: You have a large Workday tenant and multiple AD domains each supporting a different business unit/division/company. To support this topology, you would like to run multiple Workday to Azure AD provisioning jobs with each job provisioning a specific set of workers. In this scenario, rather than using Azure AD scoping filters to exclude worker data, we recommend configuring constrained ISSG so that only the relevant worker data is visible to Azure AD.
54
54
55
55
### Workday test connection query
@@ -145,7 +145,7 @@ Azure AD sends the following *Get_Workers* Workday Web Services request to retri
145
145
</p1:Response_Group>
146
146
</Get_Workers_Request>
147
147
```
148
-
The *Response_Group* node is used to specify which worker attributes to fetch from Workday. For a description of each flag in the *Response_Group* node, please refer to the Workday [Get_Workers API documentation](https://community.workday.com/sites/default/files/file-hosting/productionapi/Human_Resources/v35.2/Get_Workers.html#Worker_Response_GroupType).
148
+
The *Response_Group* node is used to specify which worker attributes to fetch from Workday. For a description of each flag in the *Response_Group* node, refer to the Workday [Get_Workers API documentation](https://community.workday.com/sites/default/files/file-hosting/productionapi/Human_Resources/v35.2/Get_Workers.html#Worker_Response_GroupType).
149
149
150
150
Certain flag values specified in the *Response_Group* node are calculated based on the attributes configured in the Workday Azure AD provisioning application. Refer to the section on *Supported entities* for the criteria used to set the flag values.
151
151
@@ -417,9 +417,9 @@ Let's say you want to retrieve the following data sets from Workday and use them
417
417
* Cost center hierarchy
418
418
* Pay group
419
419
420
-
The above data sets are not included by default.
420
+
The above data sets aren't included by default.
421
421
To retrieve these data sets:
422
-
1.Login to the Azure portal and open your Workday to AD/Azure AD user provisioning app.
422
+
1.Sign in to the Azure portal and open your Workday to AD/Azure AD user provisioning app.
423
423
1. In the Provisioning blade, edit the mappings and open the Workday attribute list from the advanced section.
424
424
1. Add the following attributes definitions and mark them as "Required". These attributes will not be mapped to any attribute in AD or Azure AD. They just serve as signals to the connector to retrieve the Cost Center, Cost Center Hierarchy and Pay Group information.
425
425
@@ -461,40 +461,40 @@ This section covers how you can customize the provisioning app for the following
461
461
462
462
### Support for worker conversions
463
463
464
-
When a worker converts from full-time employee (FTE) to contingent worker (CW) or from contingent worker to employee, the Workday connector automatically detects this change and links the AD account to the active worker profile so that all AD attributes are in sync with the active worker profile. Depending on how worker conversions are processed in Workday, there may be different scenarios to consider.
464
+
This section describes the Azure AD provisioning service support for scenarios when a worker converts from full-time employee (FTE) to contingent worker (CW) or vice versa. Depending on how worker conversions are processed in Workday, there may be different implementation aspects to consider.
465
465
466
466
*[Scenario 1: Backdated conversion from FTE to CW or vice versa](#scenario-1-backdated-conversion-from-fte-to-cw-or-vice-versa)
467
467
*[Scenario 2: Worker employed as CW/FTE today, will change to FTE/CW today](#scenario-2-worker-employed-as-cwfte-today-will-change-to-ftecw-today)
468
468
*[Scenario 3: Worker employed as CW/FTE is terminated, rejoins as FTE/CW after a significant gap](#scenario-3-worker-employed-as-cwfte-is-terminated-rejoins-as-ftecw-after-a-significant-gap)
469
469
*[Scenario 4: Future-dated conversion, when worker is an active CW/FTE](#scenario-4-future-dated-conversion-when-worker-is-an-active-cwfte)
470
470
471
471
#### Scenario 1: Backdated conversion from FTE to CW or vice versa
472
-
Your HR team may backdate a worker conversion transaction in Workday for valid business reasons, such as payroll processing, budget compliance, legal requirements or benefits management. Here is an example to illustrate how provisioning is handled for this scenario.
472
+
Your HR team may backdate a worker conversion transaction in Workday for valid business reasons, such as payroll processing, budget compliance, legal requirements or benefits management. Here's an example to illustrate how provisioning is handled for this scenario.
473
473
474
-
* It's 15-Jan-2022 and Jane Doe is employed as a contingent worker. Her manager agrees to convert her to a full-time employee.
475
-
* The terms of her contract change require backdating the transaction so it aligns with the start of the current month. HR initiates a backdated worker conversion transaction Workday with effective date as 1-Jan-2022. Now there are two worker profiles in Workday for Jane. The CW profile is inactive, while the FTE profile is active.
476
-
* The Azure AD provisioning service will detect this change in the Workday transaction log and automatically provision attributes associated with the new FTE profile in the next sync cycle.
474
+
* It's January 15, 2022 and Jane Doe is employed as a contingent worker. HR offers Jane a full-time position.
475
+
* The terms of Jane's contract change require backdating the transaction so it aligns with the start of the current month. HR initiates a backdated worker conversion transaction Workday on January 15, 2022 with effective date as January 1, 2022. Now there are two worker profiles in Workday for Jane. The CW profile is inactive, while the FTE profile is active.
476
+
* The Azure AD provisioning service will detect this change in the Workday transaction log on January 15, 2022 and automatically provision attributes of the new FTE profile in the next sync cycle.
477
477
* No changes are required in the provisioning app configuration to handle this scenario.
478
478
479
479
#### Scenario 2: Worker employed as CW/FTE today, will change to FTE/CW today
480
480
This scenario is similar to the above scenario, except that instead of backdating the transaction, HR performs a worker conversion that is effective immediately. The Azure AD provisioning service will detect this change in the Workday transaction log and automatically provision attributes associated with active FTE profile in the next sync cycle. No changes are required in the provisioning app configuration to handle this scenario.
481
481
482
482
#### Scenario 3: Worker employed as CW/FTE is terminated, rejoins as FTE/CW after a significant gap
483
-
It is common for workers to start work at a company as a contingent worker, leave the company and then rejoin after several months as a full-time employee. Here is an example to illustrate how provisioning is handled for this scenario.
483
+
It's common for workers to start work at a company as a contingent worker, leave the company and then rejoin after several months as a full-time employee. Here's an example to illustrate how provisioning is handled for this scenario.
484
484
485
-
* It's 1-Jan-2022 and John Smith starts work at as a contingent worker. As there is no AD account associated with John's *WorkerID* (matching attribute), the provisioning service creates a new AD account and links John's contingent worker *WID (WorkdayID)* to his AD account.
486
-
* John's contract ends on 31-Jan-2022. In the provisioning cycle that runs after end of day 31-Jan-2022, John's AD account is disabled.
487
-
* John applies for another position and decides to rejoin the company as full-time employee effective 01-May-2022. HR enters his information as a pre-hire and processes his employment details on 15-Apr-2022. Now there are two worker profiles in Workday for John. The CW profile is inactive, while the FTE profile is active. The two records have the same *WorkerID* but different *WID*s.
488
-
* On 15-Apr-2022, during incremental cycle, the Azure AD provisioning service automatically transfers ownership of the AD account to the active worker profile. In this case, it de-links the contingent worker profile from the AD account and establishes a new link between John's active employee worker profile and his AD account.
485
+
* It's January 1, 2022 and John Smith starts work at as a contingent worker. As tHere's no AD account associated with John's *WorkerID* (matching attribute), the provisioning service creates a new AD account and links John's contingent worker *WID (WorkdayID)* to John's AD account.
486
+
* John's contract ends on January 31, 2022. In the provisioning cycle that runs after end of day January 31, John's AD account is disabled.
487
+
* John applies for another position and decides to rejoin the company as full-time employee effective May 1, 2022. HR enters John's information as a pre-hire on April 15, 2022. Now there are two worker profiles in Workday for John. The CW profile is inactive, while the FTE profile is active. The two records have the same *WorkerID* but different *WID*s.
488
+
* On April 15, during incremental cycle, the Azure AD provisioning service automatically transfers ownership of the AD account to the active worker profile. In this case, it de-links the contingent worker profile from the AD account and establishes a new link between John's active employee worker profile and John's AD account.
489
489
* No changes are required in the provisioning app configuration to handle this scenario.
490
490
491
491
#### Scenario 4: Future-dated conversion, when worker is an active CW/FTE
492
-
Sometimes, a worker may already be an active contingent worker, when HR initiates a future-dated worker conversion transaction. Here is an example to illustrate how provisioning is handled for this scenario and what configuration changes are required to support this scenario.
492
+
Sometimes, a worker may already be an active contingent worker, when HR initiates a future-dated worker conversion transaction. Here's an example to illustrate how provisioning is handled for this scenario and what configuration changes are required to support this scenario.
493
493
494
-
* It's 1-Jan-2022 and John Smith starts work at as a contingent worker. As there is no AD account associated with John's *WorkerID* (matching attribute), the provisioning service creates a new AD account and links John's contingent worker *WID (WorkdayID)* to his AD account.
495
-
* On 15-Jan-2022, HR initiates a transaction to convert John from contingent worker to full-time employee effective 01-Feb-2022.
496
-
* Since Azure AD provisioning service automatically processes future-dated hires, it will process John's new full-time employee worker profile on 15-Jan-2022 and update his profile in AD with full-time employment details even though he is still a contingent worker.
497
-
* To ensure that this does not happen and John's FTE details get provisioned on 01-Feb-2022, perform the following configuration changes.
494
+
* It's January 1, 2022 and John Smith starts work at as a contingent worker. As tHere's no AD account associated with John's *WorkerID* (matching attribute), the provisioning service creates a new AD account and links John's contingent worker *WID (WorkdayID)* to John's AD account.
495
+
* On January 15, HR initiates a transaction to convert John from contingent worker to full-time employee effective February 1, 2022.
496
+
* Since Azure AD provisioning service automatically processes future-dated hires, it will process John's new full-time employee worker profile on January 15, and update John's profile in AD with full-time employment details even though he is still a contingent worker.
497
+
* To avoid this behavior and ensure that John's FTE details get provisioned on February 1, 2022, perform the following configuration changes.
498
498
499
499
**Configuration changes**
500
500
1. Engage your Workday admin to create a provisioning group called "Future-dated conversions".
@@ -516,8 +516,8 @@ Use the steps below to retrieve attributes associated with international job ass
516
516
517
517
1. Set the Workday connection URL uses Workday Web Service API version 30.0 or above. Accordingly set the [correct XPATH values](workday-attribute-reference.md#xpath-values-for-workday-web-services-wws-api-v30) in your Workday provisioning app.
518
518
1. Use the selector `@wd:Primary_Job=0` on the `Worker_Job_Data` node to retrieve the correct attribute.
519
-
***Example 1:** To get `SecondaryBusinessTitle` use the XPATH `wd:Worker/wd:Worker_Data/wd:Employment_Data/wd:Worker_Job_Data[@wd:Primary_Job=0]/wd:Position_Data/wd:Business_Title/text()`
520
-
***Example 2:** To get `SecondaryBusinessLocation` use the XPATH `wd:Worker/wd:Worker_Data/wd:Employment_Data/wd:Worker_Job_Data[@wd:Primary_Job=0]/wd:Position_Data/wd:Business_Site_Summary_Data/wd:Location_Reference/@wd:Descriptor`
519
+
***Example 1:** To get `SecondaryBusinessTitle`, use the XPATH `wd:Worker/wd:Worker_Data/wd:Employment_Data/wd:Worker_Job_Data[@wd:Primary_Job=0]/wd:Position_Data/wd:Business_Title/text()`
520
+
***Example 2:** To get `SecondaryBusinessLocation`, use the XPATH `wd:Worker/wd:Worker_Data/wd:Employment_Data/wd:Worker_Job_Data[@wd:Primary_Job=0]/wd:Position_Data/wd:Business_Site_Summary_Data/wd:Location_Reference/@wd:Descriptor`
0 commit comments