org.mule.modules

mule-module-workday

config

Namespacehttp://www.mulesoft.org/schema/mule/wd-absence
Schema Locationhttp://www.mulesoft.org/schema/mule/wd-absence/current/mule-wd-absence.xsd  (View Schema)
Schema Version2.0
Minimum Mule Version3.4

Module Overview

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.

Summary

Configuration
<wd-absence:config>
Configure an instance of this module
Message Processors
<wd-absence:adjust-time-off>
Adjusts an existing time off entry.
<wd-absence:enter-time-off>
Adds new time off entries.
<wd-absence:get-absence-inputs>
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.
<wd-absence:get-override-balances>
Gets Time Off Plan Override Balances for an Employee and Time Off Plan with the supplied information.
<wd-absence:get-time-off-plan-balances>
Retrieves the dynamic Time Off Plan Balances by Worker and Time Off Plan.
<wd-absence:put-absence-input>
Adds a new Accrual or Time Off Adjustment/Override for an Employee (or updates an existing Adjustment/Override) with the supplied information.
<wd-absence:put-override-balance>
Adds or update a new Time Off Plan Override Balance record for a given Employee and Time Off Plan.
<wd-absence:request-leave-of-absence>
Adds new leave of absence requests.
<wd-absence:request-return-from-leave-of-absence>
Adds new return from leave of absence requests.

Configuration

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>

Connection Pool

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
NameDefault ValueDescriptionJava TypeMIME TypeEncoding
config-ref Optional. Specify which configuration to use.
absenceUser Workday user String */* UTF-8
absencePassword Workday password String */* UTF-8
absenceEndpoint Workday endpoint String */* UTF-8
absenceWsdlLocation https://community.workday.com/custom/developer/API/Absence_Management/v20/Absence_Management.wsdl Optional. Workday WSDL location String */* UTF-8

Reconnection Strategies

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.

Configuration

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
NameDefault ValueDescription
frequency 2000 Optional. How often (in ms) to reconnect
count 2 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.

Message Processors

<wd-absence:adjust-time-off>

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.

XML Sample
INCLUDE_ERROR

Attributes
NameDefault ValueDescriptionJava TypeMIME TypeEncoding
config-ref Optional. Specify which configuration to use.
timeOffRequest #[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.
absenceUser Optional. Workday user String */* UTF-8
absencePassword Optional. Workday password String */* UTF-8
absenceEndpoint Optional. Workday endpoint String */* UTF-8
absenceWsdlLocation https://community.workday.com/custom/developer/API/Absence_Management/v20/Absence_Management.wsdl Optional. Workday WSDL location String */* UTF-8
Returns
Return Type Description
TimeOffEventResponseType response element
Exception Payloads
Payload ClassDescription
WorkdayException If an error during the operation occurs this exception is thrown

<wd-absence:enter-time-off>

Adds new time off entries. It uses the Request Time Off business process event.

XML Sample
INCLUDE_ERROR

Attributes
NameDefault ValueDescriptionJava TypeMIME TypeEncoding
config-ref Optional. Specify which configuration to use.
timeOffRequest #[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.
absenceUser Optional. Workday user String */* UTF-8
absencePassword Optional. Workday password String */* UTF-8
absenceEndpoint Optional. Workday endpoint String */* UTF-8
absenceWsdlLocation https://community.workday.com/custom/developer/API/Absence_Management/v20/Absence_Management.wsdl Optional. Workday WSDL location String */* UTF-8
Returns
Return Type Description
TimeOffEventResponseType response
Exception Payloads
Payload ClassDescription
WorkdayException If an error during the operation occurs this exception is thrown

<wd-absence:get-absence-inputs>

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.

XML Sample
INCLUDE_ERROR

Attributes
NameDefault ValueDescriptionJava TypeMIME TypeEncoding
config-ref Optional. Specify which configuration to use.
absenceInputsRequest #[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.
absenceUser Optional. Workday user String */* UTF-8
absencePassword Optional. Workday password String */* UTF-8
absenceEndpoint Optional. Workday endpoint String */* UTF-8
absenceWsdlLocation https://community.workday.com/custom/developer/API/Absence_Management/v20/Absence_Management.wsdl Optional. Workday WSDL location String */* UTF-8
Returns
Return Type Description
GetAbsenceInputsResponseType response
Exception Payloads
Payload ClassDescription
WorkdayException If an error during the operation occurs this exception is thrown

<wd-absence:get-override-balances>

Gets Time Off Plan Override Balances for an Employee and Time Off Plan with the supplied information.

XML Sample
INCLUDE_ERROR

Attributes
NameDefault ValueDescriptionJava TypeMIME TypeEncoding
config-ref Optional. Specify which configuration to use.
overrideBalancesRequest #[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.
absenceUser Optional. Workday user String */* UTF-8
absencePassword Optional. Workday password String */* UTF-8
absenceEndpoint Optional. Workday endpoint String */* UTF-8
absenceWsdlLocation https://community.workday.com/custom/developer/API/Absence_Management/v20/Absence_Management.wsdl Optional. Workday WSDL location String */* UTF-8
Returns
Return Type Description
GetOverrideBalancesResponseType response
Exception Payloads
Payload ClassDescription
WorkdayException If an error during the operation occurs this exception is thrown

<wd-absence:get-time-off-plan-balances>

Retrieves the dynamic Time Off Plan Balances by Worker and Time Off Plan.

XML Sample
INCLUDE_ERROR

Attributes
NameDefault ValueDescriptionJava TypeMIME TypeEncoding
config-ref Optional. Specify which configuration to use.
timeOffBalancesRequest #[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.
absenceUser Optional. Workday user String */* UTF-8
absencePassword Optional. Workday password String */* UTF-8
absenceEndpoint Optional. Workday endpoint String */* UTF-8
absenceWsdlLocation https://community.workday.com/custom/developer/API/Absence_Management/v20/Absence_Management.wsdl Optional. Workday WSDL location String */* UTF-8
Returns
Return Type Description
GetTimeOffPlanBalancesResponseType response element
Exception Payloads
Payload ClassDescription
WorkdayException If an error during the operation occurs this exception is thrown

<wd-absence:put-absence-input>

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.

XML Sample
INCLUDE_ERROR

Attributes
NameDefault ValueDescriptionJava TypeMIME TypeEncoding
config-ref Optional. Specify which configuration to use.
absenceInput #[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.
absenceUser Optional. Workday user String */* UTF-8
absencePassword Optional. Workday password String */* UTF-8
absenceEndpoint Optional. Workday endpoint String */* UTF-8
absenceWsdlLocation https://community.workday.com/custom/developer/API/Absence_Management/v20/Absence_Management.wsdl Optional. Workday WSDL location String */* UTF-8
Returns
Return Type Description
PutAbsenceInputResponseType response element
Exception Payloads
Payload ClassDescription
WorkdayException If an error during the operation occurs this exception is thrown

<wd-absence:put-override-balance>

Adds or update a new Time Off Plan Override Balance record for a given Employee and Time Off Plan.

XML Sample
INCLUDE_ERROR

Attributes
NameDefault ValueDescriptionJava TypeMIME TypeEncoding
config-ref Optional. Specify which configuration to use.
overrideBalance #[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.
absenceUser Optional. Workday user String */* UTF-8
absencePassword Optional. Workday password String */* UTF-8
absenceEndpoint Optional. Workday endpoint String */* UTF-8
absenceWsdlLocation https://community.workday.com/custom/developer/API/Absence_Management/v20/Absence_Management.wsdl Optional. Workday WSDL location String */* UTF-8
Returns
Return Type Description
PutOverrideBalanceResponseType response
Exception Payloads
Payload ClassDescription
WorkdayException If an error during the operation occurs this exception is thrown

<wd-absence:request-leave-of-absence>

Adds new leave of absence requests. It uses the Request Leave of Absence business process event and its sub business processes.

XML Sample
INCLUDE_ERROR

Attributes
NameDefault ValueDescriptionJava TypeMIME TypeEncoding
config-ref Optional. Specify which configuration to use.
leaveOfAbsenceRequest #[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.
absenceUser Optional. Workday user String */* UTF-8
absencePassword Optional. Workday password String */* UTF-8
absenceEndpoint Optional. Workday endpoint String */* UTF-8
absenceWsdlLocation https://community.workday.com/custom/developer/API/Absence_Management/v20/Absence_Management.wsdl Optional. Workday WSDL location String */* UTF-8
Returns
Return Type Description
RequestLeaveOfAbsenceResponseType response element
Exception Payloads
Payload ClassDescription
WorkdayException If an error during the operation occurs this exception is thrown

<wd-absence:request-return-from-leave-of-absence>

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.

XML Sample
INCLUDE_ERROR

Attributes
NameDefault ValueDescriptionJava TypeMIME TypeEncoding
config-ref Optional. Specify which configuration to use.
returnFromLeaveOfAbsenceRequest #[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.
absenceUser Optional. Workday user String */* UTF-8
absencePassword Optional. Workday password String */* UTF-8
absenceEndpoint Optional. Workday endpoint String */* UTF-8
absenceWsdlLocation https://community.workday.com/custom/developer/API/Absence_Management/v20/Absence_Management.wsdl Optional. Workday WSDL location String */* UTF-8
Returns
Return Type Description
RequestReturnFromLeaveOfAbsenceResponseType response
Exception Payloads
Payload ClassDescription
WorkdayException If an error during the operation occurs this exception is thrown

Message Sources

Transformers