| Namespace | http://www.mulesoft.org/schema/mule/wd-absence |
|---|---|
| Schema Location | http://www.mulesoft.org/schema/mule/wd-absence/current/mule-wd-absence.xsd (View Schema) |
| Schema Version | 2.0 |
| Minimum Mule Version | 3.4 |
The Absence Management Web Service contains operations that expose absence-related data, including Employee Time Off and Absence Inputs for time off and accrual adjustments and overrides, and Leave Requests, in Workday Human Capital Management Business Services.
| Configuration | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Configure an instance of this module
| |||||||||||
| Message Processors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Adjusts an existing time off entry.
| |||||||||||
Adds new time off entries.
| |||||||||||
Gets information for Accrual or Time Off Adjustments/Overrides for employees
and/or batch id's specified in the request or information for all if no
criteria is specified in the request.
| |||||||||||
Gets Time Off Plan Override Balances for an Employee and Time Off
Plan with the supplied information.
| |||||||||||
Retrieves the dynamic Time Off Plan Balances by Worker and Time Off Plan.
| |||||||||||
Adds a new Accrual or Time Off Adjustment/Override for an Employee (or updates an existing Adjustment/Override)
with the supplied information.
| |||||||||||
Adds or update a new Time Off Plan Override Balance record for a given Employee and Time Off Plan.
| |||||||||||
Adds new leave of absence requests.
| |||||||||||
Adds new return from leave of absence requests.
| |||||||||||
To use the this module within a flow the namespace to the module must be included. The resulting flow will look similar to the following:
<mule xmlns="http://www.mulesoft.org/schema/mule/core"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:wd-absence="http://www.mulesoft.org/schema/mule/wd-absence"
xsi:schemaLocation="
http://www.mulesoft.org/schema/mule/core
http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/wd-absence
http://www.mulesoft.org/schema/mule/wd-absence/current/mule-wd-absence.xsd">
<!-- here goes your flows and configuration elements -->
</mule>
This connector offers automatic connection management via the use of a connection pool. The pool will act a storage mechanism for all the connections that are in-use by the user of this connector.
Prior to execution of a processor, the connector will attempt to lookup an already established connection and if one doesn't exists it will create one. That lookup mechanism is done in the connection pool via the use of connection variables declared as keys.
The user of the connector can configure the pool by adding a connection-pooling-profile to the connector configuration like this:
<wd-absence:connection-pooling-profile maxActive="10" maxIdle="10"
exhaustedAction="WHEN_EXHAUSTED_GROW" maxWait="120" minEvictionMillis="60000" evictionCheckIntervalMillis="30000"/>
The following is a list of connection attributes, each connection attribute can be configured at the config element level or they can also be added to each processor. If they are used at the processor level they get the benefit of full expression resolution.
| Connection Attributes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
| Optional. Specify which configuration to use. | |||||||||||
| Workday user | String | */* | UTF-8 | ||||||||
| Workday password | String | */* | UTF-8 | ||||||||
| Workday endpoint | String | */* | UTF-8 | ||||||||
| Optional. Workday WSDL location | String | */* | UTF-8 | ||||||||
Reconnection Strategies specify how a connector behaves when its connection fails. You can control how Mule attempts to reconnect by specifying a number of criteria:
With a reconnection strategy, you can better control the behavior of a failed connection, by configuring it, for example, to re-attempt the connection only once every 15 minutes, and to give up after 30 attempts. You can also send an automatic notification to your IT administrator whenever this reconnection strategy goes into effect. You can even define a strategy that attempts to reconnect only during business hours. Such a setting can prove useful if your server is frequently shut down for nightly maintenance.
A reconnection strategy that allows the user to configure how many times a reconnection should be attempted and how long to wait between attempts.
<wd-absence:config>
<reconnect count="5" frequency="1000"/>
</wd-absence:config>
| Reconnect Attributes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Name | Default Value | Description | |||||||||
| Optional. How often (in ms) to reconnect | |||||||||||
| Optional. How many reconnection attempts to make | |||||||||||
For more information about reconnection strategies in Mule, or even how to write your own custom reconnection strategy please check this section.
Adjusts an existing time off entry. The adjusted units must be passed in (and not the corrected units). This operation uses the Correct Time Off business process event.
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| #[payload] | Optional. Request object | AdjustTimeOffRequestType | */* | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. Workday user | String | */* | UTF-8 | ||||||||
| Optional. Workday password | String | */* | UTF-8 | ||||||||
| Optional. Workday endpoint | String | */* | UTF-8 | ||||||||
| https://community.workday.com/custom/developer/API/Absence_Management/v20/Absence_Management.wsdl | Optional. Workday WSDL location | String | */* | UTF-8 | |||||||
| Return Type | Description |
|---|---|
| TimeOffEventResponseType | response element |
| Payload Class | Description |
|---|---|
| WorkdayException | If an error during the operation occurs this exception is thrown |
Adds new time off entries. It uses the Request Time Off business process event.
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| #[payload] | Optional. Request element | EnterTimeOffRequestType | */* | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. Workday user | String | */* | UTF-8 | ||||||||
| Optional. Workday password | String | */* | UTF-8 | ||||||||
| Optional. Workday endpoint | String | */* | UTF-8 | ||||||||
| https://community.workday.com/custom/developer/API/Absence_Management/v20/Absence_Management.wsdl | Optional. Workday WSDL location | String | */* | UTF-8 | |||||||
| Return Type | Description |
|---|---|
| TimeOffEventResponseType | response |
| Payload Class | Description |
|---|---|
| WorkdayException | If an error during the operation occurs this exception is thrown |
Gets information for Accrual or Time Off Adjustments/Overrides for employees and/or batch id's specified in the request or information for all if no criteria is specified in the request.
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| #[payload] | Optional. Request element | GetAbsenceInputsRequestType | */* | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. Workday user | String | */* | UTF-8 | ||||||||
| Optional. Workday password | String | */* | UTF-8 | ||||||||
| Optional. Workday endpoint | String | */* | UTF-8 | ||||||||
| https://community.workday.com/custom/developer/API/Absence_Management/v20/Absence_Management.wsdl | Optional. Workday WSDL location | String | */* | UTF-8 | |||||||
| Return Type | Description |
|---|---|
| GetAbsenceInputsResponseType | response |
| Payload Class | Description |
|---|---|
| WorkdayException | If an error during the operation occurs this exception is thrown |
Gets Time Off Plan Override Balances for an Employee and Time Off Plan with the supplied information.
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| #[payload] | Optional. Request element | GetOverrideBalancesRequestType | */* | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. Workday user | String | */* | UTF-8 | ||||||||
| Optional. Workday password | String | */* | UTF-8 | ||||||||
| Optional. Workday endpoint | String | */* | UTF-8 | ||||||||
| https://community.workday.com/custom/developer/API/Absence_Management/v20/Absence_Management.wsdl | Optional. Workday WSDL location | String | */* | UTF-8 | |||||||
| Return Type | Description |
|---|---|
| GetOverrideBalancesResponseType | response |
| Payload Class | Description |
|---|---|
| WorkdayException | If an error during the operation occurs this exception is thrown |
Retrieves the dynamic Time Off Plan Balances by Worker and Time Off Plan.
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| #[payload] | Optional. Request element | GetTimeOffPlanBalancesRequestType | */* | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. Workday user | String | */* | UTF-8 | ||||||||
| Optional. Workday password | String | */* | UTF-8 | ||||||||
| Optional. Workday endpoint | String | */* | UTF-8 | ||||||||
| https://community.workday.com/custom/developer/API/Absence_Management/v20/Absence_Management.wsdl | Optional. Workday WSDL location | String | */* | UTF-8 | |||||||
| Return Type | Description |
|---|---|
| GetTimeOffPlanBalancesResponseType | response element |
| Payload Class | Description |
|---|---|
| WorkdayException | If an error during the operation occurs this exception is thrown |
Adds a new Accrual or Time Off Adjustment/Override for an Employee (or updates an existing Adjustment/Override) with the supplied information. NOTE : This web service went through a breaking change for Workday 16. In Workday 14 and 15, unbounded Absence_Input_Line_Data elements were allowed within an Absence_Input_Data element. Going forward, Workday 16 does use Absence_Input_Line_Data elements and the data has been moved to the Absence_Input_Data parent element. If the older Workday schema is submitted, the first Absence_Input_Line_Data element is used and transformed internally to the updated schema. All nested Absence_Input_Line_Data elements beyond the first are ignored.
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| #[payload] | Optional. Request | PutAbsenceInputRequestType | */* | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. Workday user | String | */* | UTF-8 | ||||||||
| Optional. Workday password | String | */* | UTF-8 | ||||||||
| Optional. Workday endpoint | String | */* | UTF-8 | ||||||||
| https://community.workday.com/custom/developer/API/Absence_Management/v20/Absence_Management.wsdl | Optional. Workday WSDL location | String | */* | UTF-8 | |||||||
| Return Type | Description |
|---|---|
| PutAbsenceInputResponseType | response element |
| Payload Class | Description |
|---|---|
| WorkdayException | If an error during the operation occurs this exception is thrown |
Adds or update a new Time Off Plan Override Balance record for a given Employee and Time Off Plan.
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| #[payload] | Optional. Request element | PutOverrideBalanceRequestType | */* | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. Workday user | String | */* | UTF-8 | ||||||||
| Optional. Workday password | String | */* | UTF-8 | ||||||||
| Optional. Workday endpoint | String | */* | UTF-8 | ||||||||
| https://community.workday.com/custom/developer/API/Absence_Management/v20/Absence_Management.wsdl | Optional. Workday WSDL location | String | */* | UTF-8 | |||||||
| Return Type | Description |
|---|---|
| PutOverrideBalanceResponseType | response |
| Payload Class | Description |
|---|---|
| WorkdayException | If an error during the operation occurs this exception is thrown |
Adds new leave of absence requests. It uses the Request Leave of Absence business process event and its sub business processes.
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| #[payload] | Optional. Request element | RequestLeaveOfAbsenceRequestType | */* | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. Workday user | String | */* | UTF-8 | ||||||||
| Optional. Workday password | String | */* | UTF-8 | ||||||||
| Optional. Workday endpoint | String | */* | UTF-8 | ||||||||
| https://community.workday.com/custom/developer/API/Absence_Management/v20/Absence_Management.wsdl | Optional. Workday WSDL location | String | */* | UTF-8 | |||||||
| Return Type | Description |
|---|---|
| RequestLeaveOfAbsenceResponseType | response element |
| Payload Class | Description |
|---|---|
| WorkdayException | If an error during the operation occurs this exception is thrown |
Adds new return from leave of absence requests. It uses the Request Return from Leave of Absence business process event and its sub business processes.
INCLUDE_ERROR
| Name | Default Value | Description | Java Type | MIME Type | Encoding | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Optional. Specify which configuration to use. | |||||||||||
| #[payload] | Optional. Request element | RequestReturnFromLeaveOfAbsenceRequestType | */* | ||||||||
| Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation. | |||||||||||
| Optional. Workday user | String | */* | UTF-8 | ||||||||
| Optional. Workday password | String | */* | UTF-8 | ||||||||
| Optional. Workday endpoint | String | */* | UTF-8 | ||||||||
| https://community.workday.com/custom/developer/API/Absence_Management/v20/Absence_Management.wsdl | Optional. Workday WSDL location | String | */* | UTF-8 | |||||||
| Return Type | Description |
|---|---|
| RequestReturnFromLeaveOfAbsenceResponseType | response |
| Payload Class | Description |
|---|---|
| WorkdayException | If an error during the operation occurs this exception is thrown |