public class

CompensationModule

extends AbstractWorkdayModule
java.lang.Object
   ↳ org.mule.modules.workday.AbstractWorkdayModule
     ↳ org.mule.modules.workday.compensation.CompensationModule
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

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

Summary

Fields
private CompensationPort client The client, mainly for mocking purposes.
private String username The Workday account's username
Public Constructors
CompensationModule()
Public Methods
AddStockGrantResponseType addStockGrant(AddStockGrantRequestType stockGrant)
Adds stock grant for an employee via the Request Stock Option Grant business process.
AssignEligiblePeriodActivitiesForEmployeeResponseType assignEligiblePeriodActivitiesForEmployee(AssignEligiblePeriodActivitiesForEmployeeRequestType assignEligiblePeriodActivitiesForEmployeeRequest)
This operation allows the requesting of a period activity assignment for an employee via the Assign Eligible Period Activities for Employee business process.
void connect(String compensationUser, String compensationPassword, String compensationEndpoint, String compensationWsdlLocation)
Connects to Workday
void disconnect()
Disconnects
GetBenchmarkJobsResponseType getBenchmarkJobs(GetBenchmarkJobsRequestType benchmarkJobsRequest)
Allows ongoing updates to Benchmark Jobs and the Get will provide customers with the ability to extract benchmark jobs out of Workday
CompensationPort getClient()
GetCompensationGradesResponseType getCompensationGrades(GetCompensationGradesRequestType compensationGradesRequest)
Gets compensation grade and grade profile information.
GetCompensationMatrixResponseType getCompensationMatrices(GetCompensationMatrixRequestType compensationMatricesRequest)
Retrieves Merit Increase Matrices (MIMs) for use by merit or bonus plans (percent- and amount-based).
GetCompensationPlansResponseType getCompensationPlans(GetCompensationPlansRequestType compensationPlansRequest)
Gets compensation plan information.
GetCompensationScorecardResultsResponseType getCompensationScorecardResults(GetCompensationScorecardResultsRequestType getCompensationScorecardResultsRequest)
This operation allows the retrieval of one or more scorecard results
String getConnectionIdentifier()
Connection identifier
GetEligibleEarningsResponseType getEligibleEarnings(GetEligibleEarningsRequestType eligibleEarningsRequest)
Gets the eligible earnings data that is associated with an employee.
GetFuturePaymentPlanAssignmentsResponseType getFuturePaymentPlanAssignments(GetFuturePaymentPlanAssignmentsRequestType futurePaymentPlanAssignmentsRequest)
Gets the Future Payment Plan Assignments for Workers.
GetPeriodActivityTasksResponseType getPeriodActivityTasks(GetPeriodActivityTasksRequestType getPeriodActivityTasksRequest)
This operation allows the retrieval of period activity tasks.
GetPreviousSystemCompensationHistoryResponseType getPreviousSystemCompensationHistory(GetPreviousSystemCompensationHistoryRequestType previousSystemCompensationHistoryRequest)
Returns a worker's compensation history from a previous system.
String getUsername()
LaunchEmployeeSeveranceWorksheetResponseType launchEmployeeSeveranceWorksheet(LaunchEmployeeSeveranceWorksheetRequestType launchEmployeeSeveranceWorksheetRequest)
This operation allows the launching of an employee severance worksheet via the Severance Worksheet business process.
ManagePeriodActivityPayAssignmentsResponseType managePeriodActivityPayAssignments(ManagePeriodActivityPayAssignmentsRequestType managePeriodActivityPayAssignmentsRequest)
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.
PutBenchmarkJobResponseType putBenchmarkJob(PutBenchmarkJobRequestType benchmarkJob)
Allows ongoing updates to Benchmark Jobs and the Get will provide customers with the ability to extract benchmark jobs out of Workday.
PutCompensationGradeResponseType putCompensationGrade(PutCompensationGradeRequestType compensationGrade)
Adds/Updates instances of compensation grade and compensation grade profile.
PutMeritIncreaseMatrixResponseType putCompensationMatrix(PutMeritIncreaseMatrixRequestType compensationMatrix)
Creates or modifies data for a Compensation Matrix.
PutCompensationPlanResponseType putCompensationPlans(PutCompensationPlanRequestType compensationPlans)
Puts compensation plan information.
PutCompensationScorecardResultResponseType putCompensationScorecardResult(PutCompensationScorecardResultRequestType putCompensationScorecardResultRequest)
This operation allows the creation or modification of a scorecard result against a specific scorecard
PutEligibleEarningsResponseType putEligibleEarnings(PutEligibleEarningsRequestType eligibleEarnings)
Adds/Updates instances of eligible earnings for an employee, eligible earnings period and any specified percent-based bonus plan.
PutFuturePaymentPlanAssignmentResponseType putFuturePaymentPlanAssignment(PutFuturePaymentPlanAssignmentRequestType futurePaymentPlanAssignment)
Creates Future Payment Plan Assignment for a Worker and Future Payment Plan.
PutPeriodActivityTaskResponseType putPeriodActivityTask(PutPeriodActivityTaskRequestType putPeriodActivityTaskRequest)
This operation adds or updates a period activity task.
PutPreviousSystemCompensationHistoryResponseType putPreviousSystemCompensationHistory(PutPreviousSystemCompensationHistoryRequestType previousSystemCompensationHistory)
Loads compensation history for a Worker that didn't get loaded during the initial implementation period.
RequestBonusPaymentResponseType requestBonusPayment(RequestBonusPaymentRequestType bonusPaymentRequest)
Request bonus payment for an employee via the Request Bonus Payment business process.
RequestCompensationChangeResponseType requestCompensationChange(RequestCompensationChangeRequestType compensationChangeRequest)
Request ad-hoc compensation change for an employee via the Request Compensation Change business process.
RequestEmployeeMeritAdjustmentResponseType requestEmployeeMeritAdjustment(RequestEmployeeMeritAdjustmentRequestType employeeMeritAdjustmentRequest)
Request merit adjustment for an employee via the Request Employee Merit Adjustment business process.
RequestOneTimePaymentResponseType requestOnetimePayment(RequestOneTimePaymentRequestType requestOneTimePaymentRequest)
Request one-time payment for an employee via the Request One-Time Payment business process.
void setClient(Object client)
void setClient(CompensationPort client)
void setUsername(String username)
UpdateStockGrantResponseType updateStockGrant(UpdateStockGrantRequestType stockGrant)
Updates existing stock grants only.
boolean validateConnection()
Validate connection
[Expand]
Inherited Methods
From class org.mule.modules.workday.AbstractWorkdayModule
From class java.lang.Object

Fields

private CompensationPort client

The client, mainly for mocking purposes. *

private String username

The Workday account's username

Public Constructors

public CompensationModule ()

Public Methods

public AddStockGrantResponseType addStockGrant (AddStockGrantRequestType stockGrant)

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

Parameters
stockGrant Request element
Returns
  • element with the Event ID for the Request Stock Grant Event.
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public AssignEligiblePeriodActivitiesForEmployeeResponseType assignEligiblePeriodActivitiesForEmployee (AssignEligiblePeriodActivitiesForEmployeeRequestType assignEligiblePeriodActivitiesForEmployeeRequest)

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

Parameters
assignEligiblePeriodActivitiesForEmployeeRequest AssignEligiblePeriodActivitiesForEmployeeRequestType
Returns
  • AssignEligiblePeriodActivitiesForEmployeeResponseType
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public void connect (String compensationUser, String compensationPassword, String compensationEndpoint, String compensationWsdlLocation)

Connects to Workday

Parameters
compensationUser Workday user
compensationPassword Workday password
compensationEndpoint Workday endpoint
compensationWsdlLocation Workday WSDL location
Throws
ConnectionException

public void disconnect ()

Disconnects

public GetBenchmarkJobsResponseType getBenchmarkJobs (GetBenchmarkJobsRequestType benchmarkJobsRequest)

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

Parameters
benchmarkJobsRequest Request element to get Benchmark Job
Returns
  • Get Benchmark Jobs Response
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public CompensationPort getClient ()

public GetCompensationGradesResponseType getCompensationGrades (GetCompensationGradesRequestType compensationGradesRequest)

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

Parameters
compensationGradesRequest 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.
Returns
  • Response element containing instances of compensation grades and their associated data.
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public GetCompensationMatrixResponseType getCompensationMatrices (GetCompensationMatrixRequestType compensationMatricesRequest)

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

Parameters
compensationMatricesRequest Get Compensation Matrix Request Element
Returns
  • Get Compensation Matrix Response element.
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public GetCompensationPlansResponseType getCompensationPlans (GetCompensationPlansRequestType compensationPlansRequest)

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

Parameters
compensationPlansRequest 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.
Returns
  • Response element containing instances of compensation plans and the associated data.
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public GetCompensationScorecardResultsResponseType getCompensationScorecardResults (GetCompensationScorecardResultsRequestType getCompensationScorecardResultsRequest)

This operation allows the retrieval of one or more scorecard results

Parameters
getCompensationScorecardResultsRequest GetCompensationScorecardResultsRequestType
Returns
  • GetCompensationScorecardResultsResponseType
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public String getConnectionIdentifier ()

Connection identifier

Returns
  • connection identifier

public GetEligibleEarningsResponseType getEligibleEarnings (GetEligibleEarningsRequestType eligibleEarningsRequest)

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

Parameters
eligibleEarningsRequest 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.
Returns
  • Response element containing instances of Eligible Earnings and their associated data.
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public GetFuturePaymentPlanAssignmentsResponseType getFuturePaymentPlanAssignments (GetFuturePaymentPlanAssignmentsRequestType futurePaymentPlanAssignmentsRequest)

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

Parameters
futurePaymentPlanAssignmentsRequest 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.
Returns
  • Get Future Payment Plan Assignments Response element containing retrieved Future Payment Plan Assignments and associated web service request related criteria.
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public GetPeriodActivityTasksResponseType getPeriodActivityTasks (GetPeriodActivityTasksRequestType getPeriodActivityTasksRequest)

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.

Parameters
getPeriodActivityTasksRequest GetPeriodActivityTasksRequestType
Returns
  • GetPeriodActivityTasksResponseType
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public GetPreviousSystemCompensationHistoryResponseType getPreviousSystemCompensationHistory (GetPreviousSystemCompensationHistoryRequestType previousSystemCompensationHistoryRequest)

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

Parameters
previousSystemCompensationHistoryRequest 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.
Returns
  • Response element containing the instances of workers and their previous system compensation history.
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public String getUsername ()

public LaunchEmployeeSeveranceWorksheetResponseType launchEmployeeSeveranceWorksheet (LaunchEmployeeSeveranceWorksheetRequestType launchEmployeeSeveranceWorksheetRequest)

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

Parameters
launchEmployeeSeveranceWorksheetRequest LaunchEmployeeSeveranceWorksheetRequestType
Returns
  • LaunchEmployeeSeveranceWorksheetResponseType
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public ManagePeriodActivityPayAssignmentsResponseType managePeriodActivityPayAssignments (ManagePeriodActivityPayAssignmentsRequestType managePeriodActivityPayAssignmentsRequest)

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.

Parameters
managePeriodActivityPayAssignmentsRequest ManagePeriodActivityPayAssignmentsRequestType
Returns
  • ManagePeriodActivityPayAssignmentsResponseType
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public PutBenchmarkJobResponseType putBenchmarkJob (PutBenchmarkJobRequestType benchmarkJob)

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

Parameters
benchmarkJob Request element to put Benchmark Job.
Returns
  • Response element to put Benchmark Job
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public PutCompensationGradeResponseType putCompensationGrade (PutCompensationGradeRequestType compensationGrade)

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.

Parameters
compensationGrade 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.
Returns
  • element with the reference ID for the compensation grade.
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public PutMeritIncreaseMatrixResponseType putCompensationMatrix (PutMeritIncreaseMatrixRequestType compensationMatrix)

Creates or modifies data for a Compensation Matrix.

Parameters
compensationMatrix A request object to put new merrit increase matrix data.
Returns
  • The response to a request to modify or create compensation matrix data.
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public PutCompensationPlanResponseType putCompensationPlans (PutCompensationPlanRequestType compensationPlans)

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

Parameters
compensationPlans Request element to put Compensation Plan (Bonus, Merit, Allowance, Future Payment, Commission, and Base Pay Plans).
Returns
  • Response element to put Compensation Plan (Bonus, Merit, Allowance, Future Payment, Commission, and Base Pay Plans).
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public PutCompensationScorecardResultResponseType putCompensationScorecardResult (PutCompensationScorecardResultRequestType putCompensationScorecardResultRequest)

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

Parameters
putCompensationScorecardResultRequest PutCompensationScorecardResultRequestType
Returns
  • PutCompensationScorecardResultResponseType
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public PutEligibleEarningsResponseType putEligibleEarnings (PutEligibleEarningsRequestType eligibleEarnings)

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

Parameters
eligibleEarnings 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.
Returns
  • Responds with the reference ID for the Eligible Earnings
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public PutFuturePaymentPlanAssignmentResponseType putFuturePaymentPlanAssignment (PutFuturePaymentPlanAssignmentRequestType futurePaymentPlanAssignment)

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

Parameters
futurePaymentPlanAssignment Request element
Returns
  • response element
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public PutPeriodActivityTaskResponseType putPeriodActivityTask (PutPeriodActivityTaskRequestType putPeriodActivityTaskRequest)

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.

Parameters
putPeriodActivityTaskRequest PutPeriodActivityTaskRequestType
Returns
  • PutPeriodActivityTaskResponseType
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public PutPreviousSystemCompensationHistoryResponseType putPreviousSystemCompensationHistory (PutPreviousSystemCompensationHistoryRequestType previousSystemCompensationHistory)

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.

Parameters
previousSystemCompensationHistory Contains the data for adding, updating or deleting a previous system compensation history entry for a worker.
Returns
  • Response for Put Previous System Compensation History. Returns the worker.
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public RequestBonusPaymentResponseType requestBonusPayment (RequestBonusPaymentRequestType bonusPaymentRequest)

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

Parameters
bonusPaymentRequest Request Bonus Payment business process.
Returns
  • Response element containing the reference to the Bonus Payment Request
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public RequestCompensationChangeResponseType requestCompensationChange (RequestCompensationChangeRequestType compensationChangeRequest)

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

Parameters
compensationChangeRequest Request object
Returns
  • response element
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public RequestEmployeeMeritAdjustmentResponseType requestEmployeeMeritAdjustment (RequestEmployeeMeritAdjustmentRequestType employeeMeritAdjustmentRequest)

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

Parameters
employeeMeritAdjustmentRequest Request element
Returns
  • response object
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public RequestOneTimePaymentResponseType requestOnetimePayment (RequestOneTimePaymentRequestType requestOneTimePaymentRequest)

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

Parameters
requestOneTimePaymentRequest Request One-Time Payment business process.
Returns
  • Response element containing the reference for the one time payment.
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public void setClient (Object client)

Parameters
client

public void setClient (CompensationPort client)

Parameters
client

public void setUsername (String username)

Parameters
username

public UpdateStockGrantResponseType updateStockGrant (UpdateStockGrantRequestType stockGrant)

Updates existing stock grants only.

Parameters
stockGrant Stock grant request
Returns
  • Update Stock Grant Response
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public boolean validateConnection ()

Validate connection

Returns
  • true if the connector is connected