org.mule.modules

mule-module-workday

config

Namespace	http://www.mulesoft.org/schema/mule/wd-benefits
Schema Location	http://www.mulesoft.org/schema/mule/wd-benefits/current/mule-wd-benefits.xsd (View Schema)
Schema Version	2.0
Minimum Mule Version	3.4

Module Overview

The Benefits Administration Web Service contains operations that expose Workday Human Capital Management Business Services benefits-related data.

Summary

Configuration
<wd-benefits:config> Configure an instance of this module

Message Processors
<wd-benefits:add-dependent> Adds a Dependent.
<wd-benefits:change-benefit-jobs> Specifies the benefit jobs for a worker.
<wd-benefits:change-benefits> Initiates the "Change Benefits for Life Event" business process allowing changes to benefit elections for an employee.
<wd-benefits:edit-dependent> Updates a dependent.
<wd-benefits:enroll-in-retirement-savings-plans> Allows for enrollment into Retirement Savings Plans.
<wd-benefits:get-benefit-annual-credits> This service operation retrieves Benefits Annual Credits for one or more employees.
<wd-benefits:get-benefit-annual-rates> Retrieves Benefits Annual Rates for one or more employees.
<wd-benefits:get-benefit-individual-rates> Retrieves Benefits Individual Rates for one or more employees..
<wd-benefits:grant-cobra-eligibility> A transaction to modify existing COBRA Eligibility or add new COBRA Eligibility Entries
<wd-benefits:put-benefit-annual-credit> This service operation creates a Benefit Annual Credit for one or more employees.
<wd-benefits:put-benefit-annual-rate> Creates a Benefit Annual Rate for one or more employees.
<wd-benefits:put-benefit-individual-rate> This service operation updates Benefits Individual Rates for one or more employees.
<wd-benefits:put-postal-code-set> Adds new postal codes to an existing postal code set, or to create a new postal code set.
<wd-benefits:put-worker-wellness-data> This service operation creates/updates Wellness Data for a given worker.

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-benefits="http://www.mulesoft.org/schema/mule/wd-benefits"
      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-benefits
               http://www.mulesoft.org/schema/mule/wd-benefits/current/mule-wd-benefits.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-benefits: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
config-ref		Optional. Specify which configuration to use.
benefitsUser		Workday user	String	/	UTF-8
benefitsPassword		Workday password	String	/	UTF-8
benefitsEndpoint		Workday endpoint	String	/	UTF-8
benefitsWsdlLocation	https://community.workday.com/custom/developer/API/Benefits_Administration/v20/Benefits_Administration.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:

The type of exception
Number and frequency of reconnection attempts
The notifications generated, and more

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-benefits:config>
         <reconnect count="5" frequency="1000"/>
    </wd-benefits:config>

Reconnect Attributes
Name	Default Value	Description
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-benefits:add-dependent>

Adds a Dependent.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
dependent	#[payload]	Optional. Wrapper Element for the Add Dependent web service operation. The earliest effective date provided for an address will apply to all addresses, emails, web addresses, instant messengers and phone numbers.	AddDependentRequestType	/
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.
benefitsUser		Optional. Workday user	String	/	UTF-8
benefitsPassword		Optional. Workday password	String	/	UTF-8
benefitsEndpoint		Optional. Workday endpoint	String	/	UTF-8
benefitsWsdlLocation	https://community.workday.com/custom/developer/API/Benefits_Administration/v20/Benefits_Administration.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
AddDependentResponseType	Wrapper element for the response to an Add Dependent web service operation request.

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-benefits:change-benefit-jobs>

Specifies the benefit jobs for a worker.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
benefitJobs	#[payload]	Optional. Contains the request to change a worker's benefit jobs. Changing a worker's benefit jobs changes how the CRFs for benefit eligibility behave. If a worker has benefit jobs specified, then only the specified jobs will be used in the CRF calculations used to evaluate their benefit eligibility. If benefit jobs are not specified, then the HR Primary job is used for those CRFs.	ChangeBenefitJobsRequestType	/
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.
benefitsUser		Optional. Workday user	String	/	UTF-8
benefitsPassword		Optional. Workday password	String	/	UTF-8
benefitsEndpoint		Optional. Workday endpoint	String	/	UTF-8
benefitsWsdlLocation	https://community.workday.com/custom/developer/API/Benefits_Administration/v20/Benefits_Administration.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
ChangeBenefitJobsResponseType	Response to the Add Worker Benefit Jobs web service.

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-benefits:change-benefits>

Initiates the "Change Benefits for Life Event" business process allowing changes to benefit elections for an employee. This service does not support incremental updates or defaults.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
benefits	#[payload]	Optional. Change benefits request	ChangeBenefitsRequestType	/
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.
benefitsUser		Optional. Workday user	String	/	UTF-8
benefitsPassword		Optional. Workday password	String	/	UTF-8
benefitsEndpoint		Optional. Workday endpoint	String	/	UTF-8
benefitsWsdlLocation	https://community.workday.com/custom/developer/API/Benefits_Administration/v20/Benefits_Administration.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
ChangeBenefitsResponseType	response object

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-benefits:edit-dependent>

Updates a dependent.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
dependent	#[payload]	Optional. Wrapper element for the Edit Dependent web service operation.	EditDependentRequestType	/
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.
benefitsUser		Optional. Workday user	String	/	UTF-8
benefitsPassword		Optional. Workday password	String	/	UTF-8
benefitsEndpoint		Optional. Workday endpoint	String	/	UTF-8
benefitsWsdlLocation	https://community.workday.com/custom/developer/API/Benefits_Administration/v20/Benefits_Administration.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
EditDependentResponseType	Wrapper element for the response to an Edit Dependent web service operation request.

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-benefits:enroll-in-retirement-savings-plans>

Allows for enrollment into Retirement Savings Plans. It updates incrementally from existing elections and carries forward prior elections unless they are explicitly changed or waived.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
retirementSavingsPlans	#[payload]	Optional. Enroll in Retirement Savings Plans Request	EnrollInRetirementSavingsPlansRequestType	/
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.
benefitsUser		Optional. Workday user	String	/	UTF-8
benefitsPassword		Optional. Workday password	String	/	UTF-8
benefitsEndpoint		Optional. Workday endpoint	String	/	UTF-8
benefitsWsdlLocation	https://community.workday.com/custom/developer/API/Benefits_Administration/v20/Benefits_Administration.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
EnrollInRetirementSavingsPlansResponseType	Enroll in Retirement Savings Plans Response

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-benefits:get-benefit-annual-credits>

This service operation retrieves Benefits Annual Credits for one or more employees.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
getBenefitAnnualCreditsRequest	#[payload]	Optional. Wrapped element for the Get Benefit Annual Credits Request information	GetBenefitAnnualCreditsRequestType	/
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.
benefitsUser		Optional. Workday user	String	/	UTF-8
benefitsPassword		Optional. Workday password	String	/	UTF-8
benefitsEndpoint		Optional. Workday endpoint	String	/	UTF-8
benefitsWsdlLocation	https://community.workday.com/custom/developer/API/Benefits_Administration/v20/Benefits_Administration.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetBenefitAnnualCreditsResponseType	Wrapped element for the Get Benefit Annual Credits Response information

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-benefits:get-benefit-annual-rates>

Retrieves Benefits Annual Rates for one or more employees.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
benefitAnnualRatesRequest	#[payload]	Optional. Wrapper element for Get Benefit Annual Rates Request.	GetBenefitAnnualRatesRequestType	/
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.
benefitsUser		Optional. Workday user	String	/	UTF-8
benefitsPassword		Optional. Workday password	String	/	UTF-8
benefitsEndpoint		Optional. Workday endpoint	String	/	UTF-8
benefitsWsdlLocation	https://community.workday.com/custom/developer/API/Benefits_Administration/v20/Benefits_Administration.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetBenefitAnnualRatesResponseType	Wrapper element for Get Benefit Annual Rates Response.

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-benefits:get-benefit-individual-rates>

Retrieves Benefits Individual Rates for one or more employees..

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
benefitIndividualRatesRequest	#[payload]	Optional. Request element	GetBenefitIndividualRatesRequestType	/
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.
benefitsUser		Optional. Workday user	String	/	UTF-8
benefitsPassword		Optional. Workday password	String	/	UTF-8
benefitsEndpoint		Optional. Workday endpoint	String	/	UTF-8
benefitsWsdlLocation	https://community.workday.com/custom/developer/API/Benefits_Administration/v20/Benefits_Administration.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetBenefitIndividualRatesResponseType	response element

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-benefits:grant-cobra-eligibility>

A transaction to modify existing COBRA Eligibility or add new COBRA Eligibility Entries

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
grantCobraElegibilityRequest	#[payload]	Optional. Grant COBRA Eligibility request	GrantCOBRAEligibilityRequestType	/
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.
benefitsUser		Optional. Workday user	String	/	UTF-8
benefitsPassword		Optional. Workday password	String	/	UTF-8
benefitsEndpoint		Optional. Workday endpoint	String	/	UTF-8
benefitsWsdlLocation	https://community.workday.com/custom/developer/API/Benefits_Administration/v20/Benefits_Administration.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GrantCOBRAEligibilityResponseType	response element

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-benefits:put-benefit-annual-credit>

This service operation creates a Benefit Annual Credit for one or more employees.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
putBenefitAnnualCreditRequest	#[payload]	Optional. Wrapped element for the Put Benefit Annual Credit Request information	PutBenefitAnnualCreditRequestType	/
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.
benefitsUser		Optional. Workday user	String	/	UTF-8
benefitsPassword		Optional. Workday password	String	/	UTF-8
benefitsEndpoint		Optional. Workday endpoint	String	/	UTF-8
benefitsWsdlLocation	https://community.workday.com/custom/developer/API/Benefits_Administration/v20/Benefits_Administration.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutBenefitAnnualCreditResponseType	Wrapped element for the Put Benefit Annual Credit Response information

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-benefits:put-benefit-annual-rate>

Creates a Benefit Annual Rate for one or more employees.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
benefitAnnualRateRequest	#[payload]	Optional. Wrapper element for the Put Benefit Annual Rate Request information.	PutBenefitAnnualRateRequestType	/
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.
benefitsUser		Optional. Workday user	String	/	UTF-8
benefitsPassword		Optional. Workday password	String	/	UTF-8
benefitsEndpoint		Optional. Workday endpoint	String	/	UTF-8
benefitsWsdlLocation	https://community.workday.com/custom/developer/API/Benefits_Administration/v20/Benefits_Administration.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutBenefitAnnualRateResponseType	Wrapper element for the Put Benefit Annual Rate Response information.

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-benefits:put-benefit-individual-rate>

This service operation updates Benefits Individual Rates for one or more employees.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
putBenefitIndividualRateRequest	#[payload]	Optional. Wrapped element for the Put Benefit Individual Rate Request information	PutBenefitIndividualRateRequestType	/
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.
benefitsUser		Optional. Workday user	String	/	UTF-8
benefitsPassword		Optional. Workday password	String	/	UTF-8
benefitsEndpoint		Optional. Workday endpoint	String	/	UTF-8
benefitsWsdlLocation	https://community.workday.com/custom/developer/API/Benefits_Administration/v20/Benefits_Administration.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutBenefitIndividualRateResponseType	Wrapped element for the Put Benefit Individual Rate Response information

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-benefits:put-postal-code-set>

Adds new postal codes to an existing postal code set, or to create a new postal code set.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
postalCodeSetRequest	#[payload]	Optional. Wrapper element for the Put Postal Code Set request.	PutPostalCodeSetRequestType	/
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.
benefitsUser		Optional. Workday user	String	/	UTF-8
benefitsPassword		Optional. Workday password	String	/	UTF-8
benefitsEndpoint		Optional. Workday endpoint	String	/	UTF-8
benefitsWsdlLocation	https://community.workday.com/custom/developer/API/Benefits_Administration/v20/Benefits_Administration.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutPostalCodeSetResponseType	Wrapper element for the Put Postal Code Set Returned data.

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

<wd-benefits:put-worker-wellness-data>

This service operation creates/updates Wellness Data for a given worker.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
putWorkerWellnessDataRequest	#[payload]	Optional. Wrapped element for the Put Worker Wellness Data Request information	PutWorkerWellnessDataRequestType	/
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.
benefitsUser		Optional. Workday user	String	/	UTF-8
benefitsPassword		Optional. Workday password	String	/	UTF-8
benefitsEndpoint		Optional. Workday endpoint	String	/	UTF-8
benefitsWsdlLocation	https://community.workday.com/custom/developer/API/Benefits_Administration/v20/Benefits_Administration.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutWorkerWellnessDataResponseType	Wrapped element for the Put Worker Wellness Data Response information

Exception Payloads

Payload Class	Description
WorkdayException	If an error during the operation occurs this exception is thrown

mule-module-workday

Module Overview

Summary

Configuration

Connection Pool

Reconnection Strategies

Configuration

Message Processors

<wd-benefits:add-dependent>

XML Sample

Attributes

Returns

Exception Payloads

<wd-benefits:change-benefit-jobs>

XML Sample

Attributes

Returns

Exception Payloads

<wd-benefits:change-benefits>

XML Sample

Attributes

Returns

Exception Payloads

<wd-benefits:edit-dependent>

XML Sample

Attributes

Returns

Exception Payloads

<wd-benefits:enroll-in-retirement-savings-plans>

XML Sample

Attributes

Returns

Exception Payloads

<wd-benefits:get-benefit-annual-credits>

XML Sample

Attributes

Returns

Exception Payloads

<wd-benefits:get-benefit-annual-rates>

XML Sample

Attributes

Returns

Exception Payloads

<wd-benefits:get-benefit-individual-rates>

XML Sample

Attributes

Returns

Exception Payloads

<wd-benefits:grant-cobra-eligibility>

XML Sample

Attributes

Returns

Exception Payloads

<wd-benefits:put-benefit-annual-credit>

XML Sample

Attributes

Returns

Exception Payloads

<wd-benefits:put-benefit-annual-rate>

XML Sample

Attributes

Returns

Exception Payloads

<wd-benefits:put-benefit-individual-rate>

XML Sample

Attributes

Returns

Exception Payloads

<wd-benefits:put-postal-code-set>

XML Sample

Attributes

Returns

Exception Payloads

<wd-benefits:put-worker-wellness-data>

XML Sample

Attributes

Returns

Exception Payloads

Message Sources

Transformers