Additional Configuration Parameters
Add any of the following entries to the application Debug page as needed to configure parameters related to connector operations, aggregation, delta aggregation, and provisioning.

Boolean attribute to decide whether to perform aggregation depending on the LATEST_WORKER_RECORD calculated field result or not.
<entry key="disableMultipleWorkerRecords" value="true"/>

This list contains events from which workers can be hired in Workday and these events will be used while fetching future hiring workers.
For example:
<entry key="Future_Hire_Events">
<value>
<List>
<String>Contract Contingent Worker</String>
<String>Onboarding</String>
<String>Hire Employee</String>
</List>
</value>
</entry>
Default value:
<String>Contract Contigent Worker</String>
<String>Hire Employee</String>
<String>Onboarding</String>

Boolean attribute to decide whether to skip future termination events while requesting the future data.
<entry key="SKIP_FUTURE_TERMINATION_RECORDS" value="true"/>

Limits the aggregation of termination records based on offset days provided in the application. Default value: 60 days
For example, <entry key="Past_Termination_Offset" value="100"/>
In this example, the aggregation will fetch the terminated records for the last 100 days only.
For multiple termination records for a worker, if the user experiences a problem of an incorrect termination record getting picked up during aggregation, refer to the following troubleshooting point:
Error: Incorrect termination record getting picked up during aggregation for multiple termination records of a worker.

This list contains workers that can be terminated in Workday and these events will be used while fetching future terminating workers.
For example:
<entry key="Future_Termination_Events">
<value>
<List>
<String>End Contingent Worker Contract</String>
<String>Terminate Employee</String>
</List>
</value>
</entry>
Default value:
<String>Terminate Employee</String>
<String>End Contingent Worker Contract</String>

Used for fetching past inactive workers up to the day of full aggregation. This list contains termination events through which workers were terminated in Workday.
Default certain events will be provided in this list.
<entry key="Termination_Events ">
<value>
<List>
<String>End Contingent Worker Contract</String>
<String>Terminate Employee</String>
</List>
</value>
</entry>

The list will contain additional attributes to be populated when certain workers are terminating in the future. Four default attributes will be in the list.
For example:
<entry key="Termination_Attributes">
<value>
<List>
<String>TERMINATION_DATE</String>
<String>LAST_DAY_OF_WORK</String>
<String>CONTRACT_END_DATE</String>
<String>PRIMARY_TERMINATION_REASON_REFERENCE</String>
</List>
</value>
</entry>
Note
By default, the above mentioned attributes will be a part of the future Termination Attributes. Additional attributes can be appended in the above list.

(Supported only for Workday 30.1 API version onwards) These APIs would be used by default in all the new workday
To enable contact change the API on the existing
<entry key="useChangeContactInfoAPI" value="true"/>
The new API used to update the contact information has a strict validation on the format of contact used during provisioning. SailPoint recommends to include the country code as a prefix (country code should be in sync with home or work country address) along with the contact number to be provisioned.
Aggregation

(Applicable only if IMAGE data must be included in the response)
When set to true as follows in Configure_Response_Group, includes the IMAGE data in the group response:
<entry key="Include_Photo" value="true"/>

Indicates the number of threads executing workday aggregation tasks in a parallel way. this attribute can be set as follows in the application debug page:
<entry key="aggregationThreadSize" value="4"/>
Default: 4 (Can be reduced or increased)

When set to true includes the reference descriptors in the response:
<entry key="Include_Reference_Descriptors_In_Response" value="true"/>
The XPATH of the respective attribute must be modified as mentioned in the following example for the COUNTRY attribute:
<entry key="COUNTRY" value="ns1:Worker_Data/ns1:Personal_Data/ns1:Contact_Data/ns1:Address_Data/ns1:Country_Reference/@ns1:Descriptor"/>
Note
Using this flag impacts performance.
Delta Aggregation

To aggregate an account using delta aggregation that has been back dated (for example, account details such as termination date which has been set prior to the last aggregation):
<entry key="pastEffectiveDateOffset" value="30"/>
In the above example, the connector includes account updates up to 30 days old in delta aggregation.

This list contains events that will be used while performing delta aggregation.
This list can be extended or any event can be removed from the existing events list.
<entry key="Delta_Aggregation_Events">
<value>
<List>
<String>Hire Employee</String>
<String>Onboarding</String>
<String>Terminate Employee</String>
<String>End Contingent Worker Contract</String>
<String>Change Personal Information</String>
<String>Contact Information Event</String>
<String>Change Job</String>
<String>Change Legal Name</String>
<String>Change Business Title</String>
<String>Add Retiree Status</String>
<String>Assign Organization Roles</String>
<String>Change Owner</String>
<String>Assign Superior</String>
<String>EMERGENCY_CONTACT_EVENT</String>
<String>Change Organization Assignments for Worker</String>
<String>Change Primary Address</String>
<String>Contract Contingent Worker</String>
<String>Create Change Order from Contingent Worker Contract</String>
<String>Create Primary Address</String>
<String>Edit Worker Additional Data</String>
<String>Maintain Employee Contracts</String>
<String>End Additional Job</String>
<String>Change Marital Status</String>
<String>Move to New Manager</String>
<String>Assign Worker</String>
<String>Move Workers Staffing</String>
<String>Assign Workers</String>
<String>New Hire Provisioning</String>
<String>Change Preferred Name</String>
<String>Request Worker</String>
<String>Submit Resignation</String>
<String>Transfer Contingent Worker</String>
<String>Transfer Employee</String>
</List>
</value>
</entry>
Note
To include or exclude any events in delta aggregation for the existing application, add the Delta _Aggregation_Events entry and modify accordingly.
Provisioning

Used in the provisioning policy to update contact details on a specified date.
The allowed date formats are as follows:
-
yyyy-MM-DD
-
yyyy-MM-DD+TZ
Note
The+TZ
represents a positive differential from UTC. For example,2025-02-15+05:30
would be interpreted as February 12, 2025, in a timezone that is 5 hours and 30 minutes ahead of UTC (e.g., India Standard Time - IST). -
yyyy-MM-DD-TZ
Note
The-TZ
represents a negative differential from UTC. For example,2025-02-15-06:00
would be interpreted as February 12, 2025, in a timezone that is 6 hours behind UTC (e.g., Central Standard Time - CST). -
yyyy-MM-DDTHH:mm:ss.msTZ
Note
TheT
serves as a separator between the date and time values, and must be included.

If the Worker is a future hire and the Effective_Date_For_Contact_Update
parameter is not provided in the provisioning policy then the connector uses the Worker's hire date as the effective date to update the contact details.

When set to true
this enables auto-approval on the contact change business process.
In scenarios where approvals are mandatory and you want to skip them while updating the attributes from the
<entry key="autoComplete" value="true"/>
Default: false
Additional attributes for filter supported in Workday aggregation

The Configure_Response_Group map contains the list of attributes that can be customized based on the requirements. It will filter out the non required data from aggregation.
This is used to improve the performance of the Workday
Note
The