org.mule.modules

mule-module-workday

config

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

Module Overview

The Compensation Web Service contains operations that expose Workday Human Capital Management Business Services compensation-related data.

Summary

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

Message Processors
<wd-compensation:add-stock-grant> Adds stock grant for an employee via the Request Stock Option Grant business process.
<wd-compensation:assign-eligible-period-activities-for-employee> This operation allows the requesting of a period activity assignment for an employee via the Assign Eligible Period Activities for Employee business process.
<wd-compensation:get-benchmark-jobs> Allows ongoing updates to Benchmark Jobs and the Get will provide customers with the ability to extract benchmark jobs out of Workday
<wd-compensation:get-compensation-grades> Gets compensation grade and grade profile information.
<wd-compensation:get-compensation-matrices> Retrieves Merit Increase Matrices (MIMs) for use by merit or bonus plans (percent- and amount-based).
<wd-compensation:get-compensation-plans> Gets compensation plan information.
<wd-compensation:get-compensation-scorecard-results> This operation allows the retrieval of one or more scorecard results
<wd-compensation:get-eligible-earnings> Gets the eligible earnings data that is associated with an employee.
<wd-compensation:get-future-payment-plan-assignments> Gets the Future Payment Plan Assignments for Workers.
<wd-compensation:get-period-activity-tasks> This operation allows the retrieval of period activity tasks.
<wd-compensation:get-previous-system-compensation-history> Returns a worker's compensation history from a previous system.
<wd-compensation:launch-employee-severance-worksheet> This operation allows the launching of an employee severance worksheet via the Severance Worksheet business process.
<wd-compensation:manage-period-activity-pay-assignments> This operation allows the management of period activity based assignments for a given worker and a bounding date range or period via the Manage Period Activity Pay Assignments business process.
<wd-compensation:put-benchmark-job> Allows ongoing updates to Benchmark Jobs and the Get will provide customers with the ability to extract benchmark jobs out of Workday.
<wd-compensation:put-compensation-grade> Adds/Updates instances of compensation grade and compensation grade profile.
<wd-compensation:put-compensation-matrix> Creates or modifies data for a Compensation Matrix.
<wd-compensation:put-compensation-plans> Puts compensation plan information.
<wd-compensation:put-compensation-scorecard-result> This operation allows the creation or modification of a scorecard result against a specific scorecard
<wd-compensation:put-eligible-earnings> Adds/Updates instances of eligible earnings for an employee, eligible earnings period and any specified percent-based bonus plan.
<wd-compensation:put-future-payment-plan-assignment> Creates Future Payment Plan Assignment for a Worker and Future Payment Plan.
<wd-compensation:put-period-activity-task> This operation adds or updates a period activity task.
<wd-compensation:put-previous-system-compensation-history> Loads compensation history for a Worker that didn't get loaded during the initial implementation period.
<wd-compensation:request-bonus-payment> Request bonus payment for an employee via the Request Bonus Payment business process.
<wd-compensation:request-compensation-change> Request ad-hoc compensation change for an employee via the Request Compensation Change business process.
<wd-compensation:request-employee-merit-adjustment> Request merit adjustment for an employee via the Request Employee Merit Adjustment business process.
<wd-compensation:request-onetime-payment> Request one-time payment for an employee via the Request One-Time Payment business process.
<wd-compensation:update-stock-grant> Updates existing stock grants only.

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-compensation="http://www.mulesoft.org/schema/mule/wd-compensation"
      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-compensation
               http://www.mulesoft.org/schema/mule/wd-compensation/current/mule-wd-compensation.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-compensation: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.
compensationUser		Workday user	String	/	UTF-8
compensationPassword		Workday password	String	/	UTF-8
compensationEndpoint		Workday endpoint	String	/	UTF-8
compensationWsdlLocation	https://community.workday.com/custom/developer/API/Compensation/v20/Compensation.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-compensation:config>
         <reconnect count="5" frequency="1000"/>
    </wd-compensation: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-compensation:add-stock-grant>

Adds stock grant for an employee via the Request Stock Option Grant business process.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
stockGrant	#[payload]	Optional. Request element	AddStockGrantRequestType	/
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.
compensationUser		Optional. Workday user	String	/	UTF-8
compensationPassword		Optional. Workday password	String	/	UTF-8
compensationEndpoint		Optional. Workday endpoint	String	/	UTF-8
compensationWsdlLocation	https://community.workday.com/custom/developer/API/Compensation/v20/Compensation.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
AddStockGrantResponseType	element with the Event ID for the Request Stock Grant Event.

Exception Payloads

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

<wd-compensation:assign-eligible-period-activities-for-employee>

This operation allows the requesting of a period activity assignment for an employee via the Assign Eligible Period Activities for Employee business process.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
assignEligiblePeriodActivitiesForEmployeeRequest	#[payload]	Optional. AssignEligiblePeriodActivitiesForEmployeeRequestType	AssignEligiblePeriodActivitiesForEmployeeRequestType	/
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.
compensationUser		Optional. Workday user	String	/	UTF-8
compensationPassword		Optional. Workday password	String	/	UTF-8
compensationEndpoint		Optional. Workday endpoint	String	/	UTF-8
compensationWsdlLocation	https://community.workday.com/custom/developer/API/Compensation/v20/Compensation.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
AssignEligiblePeriodActivitiesForEmployeeResponseType	AssignEligiblePeriodActivitiesForEmployeeResponseType

Exception Payloads

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

<wd-compensation:get-benchmark-jobs>

Allows ongoing updates to Benchmark Jobs and the Get will provide customers with the ability to extract benchmark jobs out of Workday

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
benchmarkJobsRequest	#[payload]	Optional. Request element to get Benchmark Job	GetBenchmarkJobsRequestType	/
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.
compensationUser		Optional. Workday user	String	/	UTF-8
compensationPassword		Optional. Workday password	String	/	UTF-8
compensationEndpoint		Optional. Workday endpoint	String	/	UTF-8
compensationWsdlLocation	https://community.workday.com/custom/developer/API/Compensation/v20/Compensation.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetBenchmarkJobsResponseType	Get Benchmark Jobs Response

Exception Payloads

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

<wd-compensation:get-compensation-grades>

Gets compensation grade and grade profile information. You must have access to the "Set Up: Compensation Packages" domain to access this operation.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
compensationGradesRequest	#[payload]	Optional. Request element to get compensation grade and grade profile information. If no criteria are specified in either the compensation grade request references or compensation grade request criteria elements, all instances of eligible earnings will be returned.	GetCompensationGradesRequestType	/
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.
compensationUser		Optional. Workday user	String	/	UTF-8
compensationPassword		Optional. Workday password	String	/	UTF-8
compensationEndpoint		Optional. Workday endpoint	String	/	UTF-8
compensationWsdlLocation	https://community.workday.com/custom/developer/API/Compensation/v20/Compensation.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetCompensationGradesResponseType	Response element containing instances of compensation grades and their associated data.

Exception Payloads

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

<wd-compensation:get-compensation-matrices>

Retrieves Merit Increase Matrices (MIMs) for use by merit or bonus plans (percent- and amount-based).

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
compensationMatricesRequest	#[payload]	Optional. Get Compensation Matrix Request Element	GetCompensationMatrixRequestType	/
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.
compensationUser		Optional. Workday user	String	/	UTF-8
compensationPassword		Optional. Workday password	String	/	UTF-8
compensationEndpoint		Optional. Workday endpoint	String	/	UTF-8
compensationWsdlLocation	https://community.workday.com/custom/developer/API/Compensation/v20/Compensation.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetCompensationMatrixResponseType	Get Compensation Matrix Response element.

Exception Payloads

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

<wd-compensation:get-compensation-plans>

Gets compensation plan information. Currently supports Bonus, Future Payment, Merit, Allowance, Commission, Period, and Base Pay Plans only.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
compensationPlansRequest	#[payload]	Optional. Request element to get compensation plan information. If no criteria is specified in the compensation plan request references or compensation plan request criteria elements, all compensation plans will be returned.	GetCompensationPlansRequestType	/
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.
compensationUser		Optional. Workday user	String	/	UTF-8
compensationPassword		Optional. Workday password	String	/	UTF-8
compensationEndpoint		Optional. Workday endpoint	String	/	UTF-8
compensationWsdlLocation	https://community.workday.com/custom/developer/API/Compensation/v20/Compensation.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetCompensationPlansResponseType	Response element containing instances of compensation plans and the associated data.

Exception Payloads

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

<wd-compensation:get-compensation-scorecard-results>

This operation allows the retrieval of one or more scorecard results

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
getCompensationScorecardResultsRequest	#[payload]	Optional. GetCompensationScorecardResultsRequestType	GetCompensationScorecardResultsRequestType	/
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.
compensationUser		Optional. Workday user	String	/	UTF-8
compensationPassword		Optional. Workday password	String	/	UTF-8
compensationEndpoint		Optional. Workday endpoint	String	/	UTF-8
compensationWsdlLocation	https://community.workday.com/custom/developer/API/Compensation/v20/Compensation.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetCompensationScorecardResultsResponseType	GetCompensationScorecardResultsResponseType

Exception Payloads

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

<wd-compensation:get-eligible-earnings>

Gets the eligible earnings data that is associated with an employee.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
eligibleEarningsRequest	#[payload]	Optional. Request element to get eligible earnings override information for an employee, eligible earnings override period or percent based bonus plan. If no criteria are specified in either the Eligible Earnings Request References or Eligible Earnings Request Criteria elements, all instances of eligible earnings override will be returned.	GetEligibleEarningsRequestType	/
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.
compensationUser		Optional. Workday user	String	/	UTF-8
compensationPassword		Optional. Workday password	String	/	UTF-8
compensationEndpoint		Optional. Workday endpoint	String	/	UTF-8
compensationWsdlLocation	https://community.workday.com/custom/developer/API/Compensation/v20/Compensation.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetEligibleEarningsResponseType	Response element containing instances of Eligible Earnings and their associated data.

Exception Payloads

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

<wd-compensation:get-future-payment-plan-assignments>

Gets the Future Payment Plan Assignments for Workers. You must have access to the Worker: Compensation by Organization domain.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
futurePaymentPlanAssignmentsRequest	#[payload]	Optional. Request element to get future payment plan assignments. If no criteria are specified then all assignments active for today will be returned, grouped by employee.	GetFuturePaymentPlanAssignmentsRequestType	/
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.
compensationUser		Optional. Workday user	String	/	UTF-8
compensationPassword		Optional. Workday password	String	/	UTF-8
compensationEndpoint		Optional. Workday endpoint	String	/	UTF-8
compensationWsdlLocation	https://community.workday.com/custom/developer/API/Compensation/v20/Compensation.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetFuturePaymentPlanAssignmentsResponseType	Get Future Payment Plan Assignments Response element containing retrieved Future Payment Plan Assignments and associated web service request related criteria.

Exception Payloads

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

<wd-compensation:get-period-activity-tasks>

This operation allows the retrieval of period activity tasks. You must have access to the "Set Up: Work Activity for Pay" domain to access this operation.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
getPeriodActivityTasksRequest	#[payload]	Optional. GetPeriodActivityTasksRequestType	GetPeriodActivityTasksRequestType	/
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.
compensationUser		Optional. Workday user	String	/	UTF-8
compensationPassword		Optional. Workday password	String	/	UTF-8
compensationEndpoint		Optional. Workday endpoint	String	/	UTF-8
compensationWsdlLocation	https://community.workday.com/custom/developer/API/Compensation/v20/Compensation.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetPeriodActivityTasksResponseType	GetPeriodActivityTasksResponseType

Exception Payloads

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

<wd-compensation:get-previous-system-compensation-history>

Returns a worker's compensation history from a previous system. This is data that is usually imported from a previous system.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
previousSystemCompensationHistoryRequest	#[payload]	Optional. Request element used to return a worker's compensation history loaded from a previous system. If no worker reference is requested, then all workers with previous system compensation data will be returned.	GetPreviousSystemCompensationHistoryRequestType	/
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.
compensationUser		Optional. Workday user	String	/	UTF-8
compensationPassword		Optional. Workday password	String	/	UTF-8
compensationEndpoint		Optional. Workday endpoint	String	/	UTF-8
compensationWsdlLocation	https://community.workday.com/custom/developer/API/Compensation/v20/Compensation.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetPreviousSystemCompensationHistoryResponseType	Response element containing the instances of workers and their previous system compensation history.

Exception Payloads

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

<wd-compensation:launch-employee-severance-worksheet>

This operation allows the launching of an employee severance worksheet via the Severance Worksheet business process.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
launchEmployeeSeveranceWorksheetRequest	#[payload]	Optional. LaunchEmployeeSeveranceWorksheetRequestType	LaunchEmployeeSeveranceWorksheetRequestType	/
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.
compensationUser		Optional. Workday user	String	/	UTF-8
compensationPassword		Optional. Workday password	String	/	UTF-8
compensationEndpoint		Optional. Workday endpoint	String	/	UTF-8
compensationWsdlLocation	https://community.workday.com/custom/developer/API/Compensation/v20/Compensation.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
LaunchEmployeeSeveranceWorksheetResponseType	LaunchEmployeeSeveranceWorksheetResponseType

Exception Payloads

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

<wd-compensation:manage-period-activity-pay-assignments>

This operation allows the management of period activity based assignments for a given worker and a bounding date range or period via the Manage Period Activity Pay Assignments business process.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
managePeriodActivityPayAssignmentsRequest	#[payload]	Optional. ManagePeriodActivityPayAssignmentsRequestType	ManagePeriodActivityPayAssignmentsRequestType	/
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.
compensationUser		Optional. Workday user	String	/	UTF-8
compensationPassword		Optional. Workday password	String	/	UTF-8
compensationEndpoint		Optional. Workday endpoint	String	/	UTF-8
compensationWsdlLocation	https://community.workday.com/custom/developer/API/Compensation/v20/Compensation.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
ManagePeriodActivityPayAssignmentsResponseType	ManagePeriodActivityPayAssignmentsResponseType

Exception Payloads

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

<wd-compensation:put-benchmark-job>

Allows ongoing updates to Benchmark Jobs and the Get will provide customers with the ability to extract benchmark jobs out of Workday.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
benchmarkJob	#[payload]	Optional. Request element to put Benchmark Job.	PutBenchmarkJobRequestType	/
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.
compensationUser		Optional. Workday user	String	/	UTF-8
compensationPassword		Optional. Workday password	String	/	UTF-8
compensationEndpoint		Optional. Workday endpoint	String	/	UTF-8
compensationWsdlLocation	https://community.workday.com/custom/developer/API/Compensation/v20/Compensation.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutBenchmarkJobResponseType	Response element to put Benchmark Job

Exception Payloads

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

<wd-compensation:put-compensation-grade>

Adds/Updates instances of compensation grade and compensation grade profile. You must have access to the "Set Up: Compensation Packages" domain to access this operation.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
compensationGrade	#[payload]	Optional. Request element. This web service operation is designed to load compensation grades and the associated compensation grade profiles. A complete set of compensation grade profiles should be passed in with the compensation grade. Any profiles not found in the set will be deleted, new profiles will be added, and the existing profiles will be updated.	PutCompensationGradeRequestType	/
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.
compensationUser		Optional. Workday user	String	/	UTF-8
compensationPassword		Optional. Workday password	String	/	UTF-8
compensationEndpoint		Optional. Workday endpoint	String	/	UTF-8
compensationWsdlLocation	https://community.workday.com/custom/developer/API/Compensation/v20/Compensation.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutCompensationGradeResponseType	element with the reference ID for the compensation grade.

Exception Payloads

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

<wd-compensation:put-compensation-matrix>

Creates or modifies data for a Compensation Matrix.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
compensationMatrix	#[payload]	Optional. A request object to put new merrit increase matrix data.	PutMeritIncreaseMatrixRequestType	/
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.
compensationUser		Optional. Workday user	String	/	UTF-8
compensationPassword		Optional. Workday password	String	/	UTF-8
compensationEndpoint		Optional. Workday endpoint	String	/	UTF-8
compensationWsdlLocation	https://community.workday.com/custom/developer/API/Compensation/v20/Compensation.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutMeritIncreaseMatrixResponseType	The response to a request to modify or create compensation matrix data.

Exception Payloads

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

<wd-compensation:put-compensation-plans>

Puts compensation plan information. Currently supports Bonus, Future Payment, Merit, Allowance, Commission, and Base Pay Plans only.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
compensationPlans	#[payload]	Optional. Request element to put Compensation Plan (Bonus, Merit, Allowance, Future Payment, Commission, and Base Pay Plans).	PutCompensationPlanRequestType	/
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.
compensationUser		Optional. Workday user	String	/	UTF-8
compensationPassword		Optional. Workday password	String	/	UTF-8
compensationEndpoint		Optional. Workday endpoint	String	/	UTF-8
compensationWsdlLocation	https://community.workday.com/custom/developer/API/Compensation/v20/Compensation.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutCompensationPlanResponseType	Response element to put Compensation Plan (Bonus, Merit, Allowance, Future Payment, Commission, and Base Pay Plans).

Exception Payloads

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

<wd-compensation:put-compensation-scorecard-result>

This operation allows the creation or modification of a scorecard result against a specific scorecard

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
putCompensationScorecardResultRequest	#[payload]	Optional. PutCompensationScorecardResultRequestType	PutCompensationScorecardResultRequestType	/
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.
compensationUser		Optional. Workday user	String	/	UTF-8
compensationPassword		Optional. Workday password	String	/	UTF-8
compensationEndpoint		Optional. Workday endpoint	String	/	UTF-8
compensationWsdlLocation	https://community.workday.com/custom/developer/API/Compensation/v20/Compensation.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutCompensationScorecardResultResponseType	PutCompensationScorecardResultResponseType

Exception Payloads

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

<wd-compensation:put-eligible-earnings>

Adds/Updates instances of eligible earnings for an employee, eligible earnings period and any specified percent-based bonus plan.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
eligibleEarnings	#[payload]	Optional. Request element. This web service operation is designed to load eligible earnings overrides for an employee for a specified eligible earnings override period. If bonus plans are specified, then the eligible earnings override will apply only to those specific bonus plans. Alternatively, selecting "Apply to All Bonus Plans" option will enable the eligible earnings override to be applied to all current and future bonus plans assigned to the employee for the specified period.	PutEligibleEarningsRequestType	/
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.
compensationUser		Optional. Workday user	String	/	UTF-8
compensationPassword		Optional. Workday password	String	/	UTF-8
compensationEndpoint		Optional. Workday endpoint	String	/	UTF-8
compensationWsdlLocation	https://community.workday.com/custom/developer/API/Compensation/v20/Compensation.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutEligibleEarningsResponseType	Responds with the reference ID for the Eligible Earnings

Exception Payloads

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

<wd-compensation:put-future-payment-plan-assignment>

Creates Future Payment Plan Assignment for a Worker and Future Payment Plan. You must have access to the Worker:Compensation by Organization domain.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
futurePaymentPlanAssignment	#[payload]	Optional. Request element	PutFuturePaymentPlanAssignmentRequestType	/
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.
compensationUser		Optional. Workday user	String	/	UTF-8
compensationPassword		Optional. Workday password	String	/	UTF-8
compensationEndpoint		Optional. Workday endpoint	String	/	UTF-8
compensationWsdlLocation	https://community.workday.com/custom/developer/API/Compensation/v20/Compensation.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutFuturePaymentPlanAssignmentResponseType	response element

Exception Payloads

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

<wd-compensation:put-period-activity-task>

This operation adds or updates a period activity task. You must have access to the "Set Up: Work Activity for Pay" domain to access this operation.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
putPeriodActivityTaskRequest	#[payload]	Optional. PutPeriodActivityTaskRequestType	PutPeriodActivityTaskRequestType	/
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.
compensationUser		Optional. Workday user	String	/	UTF-8
compensationPassword		Optional. Workday password	String	/	UTF-8
compensationEndpoint		Optional. Workday endpoint	String	/	UTF-8
compensationWsdlLocation	https://community.workday.com/custom/developer/API/Compensation/v20/Compensation.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutPeriodActivityTaskResponseType	PutPeriodActivityTaskResponseType

Exception Payloads

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

<wd-compensation:put-previous-system-compensation-history>

Loads compensation history for a Worker that didn't get loaded during the initial implementation period. It allows free-form text entry of changes that occurred in between the Worker's original hire date and the date that the implementation occurred. Existing entries can be deleted or updated.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
previousSystemCompensationHistory	#[payload]	Optional. Contains the data for adding, updating or deleting a previous system compensation history entry for a worker.	PutPreviousSystemCompensationHistoryRequestType	/
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.
compensationUser		Optional. Workday user	String	/	UTF-8
compensationPassword		Optional. Workday password	String	/	UTF-8
compensationEndpoint		Optional. Workday endpoint	String	/	UTF-8
compensationWsdlLocation	https://community.workday.com/custom/developer/API/Compensation/v20/Compensation.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutPreviousSystemCompensationHistoryResponseType	Response for Put Previous System Compensation History. Returns the worker.

Exception Payloads

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

<wd-compensation:request-bonus-payment>

Request bonus payment for an employee via the Request Bonus Payment business process.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
bonusPaymentRequest	#[payload]	Optional. Request Bonus Payment business process.	RequestBonusPaymentRequestType	/
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.
compensationUser		Optional. Workday user	String	/	UTF-8
compensationPassword		Optional. Workday password	String	/	UTF-8
compensationEndpoint		Optional. Workday endpoint	String	/	UTF-8
compensationWsdlLocation	https://community.workday.com/custom/developer/API/Compensation/v20/Compensation.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
RequestBonusPaymentResponseType	Response element containing the reference to the Bonus Payment Request

Exception Payloads

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

<wd-compensation:request-compensation-change>

Request ad-hoc compensation change for an employee via the Request Compensation Change business process.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
compensationChangeRequest	#[payload]	Optional. Request object	RequestCompensationChangeRequestType	/
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.
compensationUser		Optional. Workday user	String	/	UTF-8
compensationPassword		Optional. Workday password	String	/	UTF-8
compensationEndpoint		Optional. Workday endpoint	String	/	UTF-8
compensationWsdlLocation	https://community.workday.com/custom/developer/API/Compensation/v20/Compensation.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
RequestCompensationChangeResponseType	response element

Exception Payloads

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

<wd-compensation:request-employee-merit-adjustment>

Request merit adjustment for an employee via the Request Employee Merit Adjustment business process.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
employeeMeritAdjustmentRequest	#[payload]	Optional. Request element	RequestEmployeeMeritAdjustmentRequestType	/
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.
compensationUser		Optional. Workday user	String	/	UTF-8
compensationPassword		Optional. Workday password	String	/	UTF-8
compensationEndpoint		Optional. Workday endpoint	String	/	UTF-8
compensationWsdlLocation	https://community.workday.com/custom/developer/API/Compensation/v20/Compensation.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
RequestEmployeeMeritAdjustmentResponseType	response object

Exception Payloads

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

<wd-compensation:request-onetime-payment>

Request one-time payment for an employee via the Request One-Time Payment business process.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
requestOneTimePaymentRequest	#[payload]	Optional. Request One-Time Payment business process.	RequestOneTimePaymentRequestType	/
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.
compensationUser		Optional. Workday user	String	/	UTF-8
compensationPassword		Optional. Workday password	String	/	UTF-8
compensationEndpoint		Optional. Workday endpoint	String	/	UTF-8
compensationWsdlLocation	https://community.workday.com/custom/developer/API/Compensation/v20/Compensation.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
RequestOneTimePaymentResponseType	Response element containing the reference for the one time payment.

Exception Payloads

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

<wd-compensation:update-stock-grant>

Updates existing stock grants only.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
stockGrant	#[payload]	Optional. Stock grant request	UpdateStockGrantRequestType	/
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.
compensationUser		Optional. Workday user	String	/	UTF-8
compensationPassword		Optional. Workday password	String	/	UTF-8
compensationEndpoint		Optional. Workday endpoint	String	/	UTF-8
compensationWsdlLocation	https://community.workday.com/custom/developer/API/Compensation/v20/Compensation.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
UpdateStockGrantResponseType	Update Stock Grant Response

Exception Payloads

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