org.mule.modules

mule-module-workday

config

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

Module Overview

The Staffing Module exposes operations over Workday Human Capital Management Business Services data, including Employee, Contingent Worker and Organization information. This Web Service can be used for integration with enterprise systems including corporate directories, data analysis tools, email or other provisioning sub-systems, or any other systems needing Worker and/or Organization data.

Summary

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

Message Processors
<wd-staffing:add-additional-job> Adds an additional job for an existing employee.
<wd-staffing:add-retiree-status> Changes the status of a previously terminated worker to retiree.
<wd-staffing:assign-organization> Assigns company, cost center, region, fund, grant, business unit, program, and custom organizations configured for staffing usage to a staffing position.
<wd-staffing:assign-organization-roles> Assigns organization roles to one or more workers.
<wd-staffing:change-job> Perform a job change on an employee or contingent worker.
<wd-staffing:close-position-or-headcount-restriction> This operation will invoke the Business Process to Close a Position or Headcount Restriction.
<wd-staffing:contract-contingent-worker> Contracts an existing applicant into a contingent worker position, headcount, or job.
<wd-staffing:create-position-staffing> Creates/opens a position for a supervisory organization using the position management staffing model.
<wd-staffing:edit-position> Edits a filled position.
<wd-staffing:edit-position-restrictions-staffing> Edits an existing position restriction.
<wd-staffing:edit-service-dates> Sets a worker's service dates.
<wd-staffing:end-additional-job> Ends an employee's additional job.
<wd-staffing:end-contingent-worker-contract> Ends a contingent worker's contract.
<wd-staffing:get-applicants-staffing> Returns information for applicants specified in the request.
<wd-staffing:get-citizenship-statuses> Returns citizenship status details for the requested status.
<wd-staffing:get-headcounts-staffing> Returns headcount information along with the identification of the workers filling headcount positions.
<wd-staffing:get-job-classification-groups-staffing> Returns job classification group data.
<wd-staffing:get-job-families-staffing> Returns job family data.
<wd-staffing:get-job-family-groups-staffing> Returns job family and job family group data.
<wd-staffing:get-organizations-staffing> Returns organization information for a type of organization.
<wd-staffing:get-positions-staffing> Returns information for position management positions.
<wd-staffing:get-worker-documents> Returns worker document data.
<wd-staffing:get-workers-staffing> Returns information for specified workers.
<wd-staffing:hire-employee> Hires an applicant (new or existing) into an employee position, headcount, or job.
<wd-staffing:maintain-employee-contracts> Adds or updates employee contracts.
<wd-staffing:put-applicant-staffing> Adds a new applicant (or updates an existing applicant) with the information supplied in the request.
<wd-staffing:put-citizenship-status> Adds or updates citizenship status.
<wd-staffing:put-job-classification-group-staffing> Adds or updates a job classification group and/or job classifications.
<wd-staffing:put-job-family-group-staffing> Adds or updates a job family group.
<wd-staffing:put-job-family-staffing> Adds or updates a job family.
<wd-staffing:put-worker-document> Adds or updates a worker document.
<wd-staffing:remove-retiree-status> Removes the retirement status from a retired employee.
<wd-staffing:switch-primary-job> This operation will invoke the business process to switch a workers primary job with one of their additional jobs.
<wd-staffing:terminate-employee> Terminates an employee.

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-staffing="http://www.mulesoft.org/schema/mule/wd-staffing"
      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-staffing
               http://www.mulesoft.org/schema/mule/wd-staffing/current/mule-wd-staffing.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-staffing: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.
staffingUser		Workday user	String	/	UTF-8
staffingPassword		Workday password	String	/	UTF-8
staffingEndpoint		Workday endpoint	String	/	UTF-8
staffingWsdlLocation	https://community.workday.com/custom/developer/API/Staffing/v20/Staffing.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-staffing:config>
         <reconnect count="5" frequency="1000"/>
    </wd-staffing: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-staffing:add-additional-job>

Adds an additional job for an existing employee. Uses the Add Additional Job business process.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
additionalJob	#[payload]	Optional. Wrapper for additionalJobRequest	AddAdditionalJobRequestType	/
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.
staffingUser		Optional. Workday user	String	/	UTF-8
staffingPassword		Optional. Workday password	String	/	UTF-8
staffingEndpoint		Optional. Workday endpoint	String	/	UTF-8
staffingWsdlLocation	https://community.workday.com/custom/developer/API/Staffing/v20/Staffing.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
AddAdditionalJobEventResponseType	Responds with the Event ID for the Add Additional Employee Job Event and the job reference.

Exception Payloads

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

<wd-staffing:add-retiree-status>

Changes the status of a previously terminated worker to retiree. Uses the Add Retiree Status business process.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
retireeStatus	#[payload]	Optional. Wrapper for AddRetireeStatusRequestType	AddRetireeStatusRequestType	/
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.
staffingUser		Optional. Workday user	String	/	UTF-8
staffingPassword		Optional. Workday password	String	/	UTF-8
staffingEndpoint		Optional. Workday endpoint	String	/	UTF-8
staffingWsdlLocation	https://community.workday.com/custom/developer/API/Staffing/v20/Staffing.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
AddRetireeStatusResponseType	element with information in Add Retiree Status event

Exception Payloads

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

<wd-staffing:assign-organization>

Assigns company, cost center, region, fund, grant, business unit, program, and custom organizations configured for staffing usage to a staffing position. Uses the Change Organization Assignments for Worker business process.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
organization	#[payload]	Optional. Wrapper for AssignOrganizationRequestType	AssignOrganizationRequestType	/
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.
staffingUser		Optional. Workday user	String	/	UTF-8
staffingPassword		Optional. Workday password	String	/	UTF-8
staffingEndpoint		Optional. Workday endpoint	String	/	UTF-8
staffingWsdlLocation	https://community.workday.com/custom/developer/API/Staffing/v20/Staffing.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
AssignOrganizationResponseType	Responds with the Event ID for the Assign Organization Event.

Exception Payloads

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

<wd-staffing:assign-organization-roles>

Assigns organization roles to one or more workers. Uses the Assign Organization Roles for Worker business process.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
organizationRoles	#[payload]	Optional. Wrapper for AssignOrganizationRolesRequestType	AssignOrganizationRolesRequestType	/
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.
staffingUser		Optional. Workday user	String	/	UTF-8
staffingPassword		Optional. Workday password	String	/	UTF-8
staffingEndpoint		Optional. Workday endpoint	String	/	UTF-8
staffingWsdlLocation	https://community.workday.com/custom/developer/API/Staffing/v20/Staffing.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
AssignOrganizationRolesResponseType	element with the Event ID for the Assign Organization Roles business process event.

Exception Payloads

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

<wd-staffing:change-job>

Perform a job change on an employee or contingent worker. Uses the Change Job business process. The types of changes include transfer, promotion, demotion, lateral moves and any other change of data on the job.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
job	#[payload]	Optional. Job request object	ChangeJobRequestType	/
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.
staffingUser		Optional. Workday user	String	/	UTF-8
staffingPassword		Optional. Workday password	String	/	UTF-8
staffingEndpoint		Optional. Workday endpoint	String	/	UTF-8
staffingWsdlLocation	https://community.workday.com/custom/developer/API/Staffing/v20/Staffing.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
ChangeJobResponseType	element with the Event ID of the Change Job and any exceptions.

Exception Payloads

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

<wd-staffing:close-position-or-headcount-restriction>

This operation will invoke the Business Process to Close a Position or Headcount Restriction.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
closePositionOrHeadcountRestrictionRequest	#[payload]	Optional. The request object for the operation	ClosePositionOrHeadcountRestrictionRequestType	/
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.
staffingUser		Optional. Workday user	String	/	UTF-8
staffingPassword		Optional. Workday password	String	/	UTF-8
staffingEndpoint		Optional. Workday endpoint	String	/	UTF-8
staffingWsdlLocation	https://community.workday.com/custom/developer/API/Staffing/v20/Staffing.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
ClosePositionOrHeadcountRestrictionResponseType	The response from the operation

Exception Payloads

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

<wd-staffing:contract-contingent-worker>

Contracts an existing applicant into a contingent worker position, headcount, or job. Uses the Contract Contingent Worker business process

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
contingentWorker	#[payload]	Optional. Wrapper for ContractContingentWorkerRequestType	ContractContingentWorkerRequestType	/
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.
staffingUser		Optional. Workday user	String	/	UTF-8
staffingPassword		Optional. Workday password	String	/	UTF-8
staffingEndpoint		Optional. Workday endpoint	String	/	UTF-8
staffingWsdlLocation	https://community.workday.com/custom/developer/API/Staffing/v20/Staffing.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
ContractContingentWorkerResponseType	Responds with the event id of the contract contingent worker event.

Exception Payloads

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

<wd-staffing:create-position-staffing>

Creates/opens a position for a supervisory organization using the position management staffing model. Uses the Create Position business process. There are several sub-operations within this operation. Existing positions cannot be re-loaded into the system. You must use the Edit Position Restrictions operation to change a created position.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
position	#[payload]	Optional. Wrapper for Create Open Position Web Service.	CreatePositionRequestType	/
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.
staffingUser		Optional. Workday user	String	/	UTF-8
staffingPassword		Optional. Workday password	String	/	UTF-8
staffingEndpoint		Optional. Workday endpoint	String	/	UTF-8
staffingWsdlLocation	https://community.workday.com/custom/developer/API/Staffing/v20/Staffing.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
CreatePositionResponseType	Responds with the event id for the Position Request Event and the Position Opening Reference (if the event was completed).

Exception Payloads

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

<wd-staffing:edit-position>

Edits a filled position. Uses the Edit Position business process.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
position	#[payload]	Optional. Wrapper for EditPositionRequestType	EditPositionRequestType	/
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.
staffingUser		Optional. Workday user	String	/	UTF-8
staffingPassword		Optional. Workday password	String	/	UTF-8
staffingEndpoint		Optional. Workday endpoint	String	/	UTF-8
staffingWsdlLocation	https://community.workday.com/custom/developer/API/Staffing/v20/Staffing.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
EditPositionEventResponseType	Responds with the Event ID for the Edit Position Event.

Exception Payloads

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

<wd-staffing:edit-position-restrictions-staffing>

Edits an existing position restriction. Uses the Edit Position Restrictions business process.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
positionRestrictions	#[payload]	Optional. Wrapper element for Edit Position Restrictions Web Service.	EditPositionRestrictionsRequestType	/
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.
staffingUser		Optional. Workday user	String	/	UTF-8
staffingPassword		Optional. Workday password	String	/	UTF-8
staffingEndpoint		Optional. Workday endpoint	String	/	UTF-8
staffingWsdlLocation	https://community.workday.com/custom/developer/API/Staffing/v20/Staffing.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
EditPositonRestrictionResponseType	element with the event ID of the Position Restrictions Edit Event, the Position Restriction being edited and the workflow state of the event.

Exception Payloads

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

<wd-staffing:edit-service-dates>

Sets a worker's service dates. Uses the Edit Service Dates business process

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
serviceDates	#[payload]	Optional. Wrapper for EditServiceDatesRequestType	EditServiceDatesRequestType	/
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.
staffingUser		Optional. Workday user	String	/	UTF-8
staffingPassword		Optional. Workday password	String	/	UTF-8
staffingEndpoint		Optional. Workday endpoint	String	/	UTF-8
staffingWsdlLocation	https://community.workday.com/custom/developer/API/Staffing/v20/Staffing.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
EditServiceDatesResponseType	Responds with the Event ID for the Service Dates Change Event.

Exception Payloads

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

<wd-staffing:end-additional-job>

Ends an employee's additional job. Uses the End Additional Job business process

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
additionalJob	#[payload]	Optional. Wrapper for End Additional Job Web Service.	EndAdditionalJobRequestType	/
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.
staffingUser		Optional. Workday user	String	/	UTF-8
staffingPassword		Optional. Workday password	String	/	UTF-8
staffingEndpoint		Optional. Workday endpoint	String	/	UTF-8
staffingWsdlLocation	https://community.workday.com/custom/developer/API/Staffing/v20/Staffing.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
EndAdditionalEmployeeJobEventResponseType	element with the Event ID for the End Additional Job Event.

Exception Payloads

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

<wd-staffing:end-contingent-worker-contract>

Ends a contingent worker's contract. Uses the End Contingent Worker Contract Business Process

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
contingentWorkerContract	#[payload]	Optional. Wrapper for End Contingent Worker Contract web service and its sub-processes.	EndContingentWorkerContractRequestType	/
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.
staffingUser		Optional. Workday user	String	/	UTF-8
staffingPassword		Optional. Workday password	String	/	UTF-8
staffingEndpoint		Optional. Workday endpoint	String	/	UTF-8
staffingWsdlLocation	https://community.workday.com/custom/developer/API/Staffing/v20/Staffing.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
EndContingentWorkerContractResponseType	element with the event id for the End Contract Event.

Exception Payloads

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

<wd-staffing:get-applicants-staffing>

Returns information for applicants specified in the request. If the request does not specify an applicant, this operation returns information for all applicants..

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
applicantsRequest	#[payload]	Optional. Wrapper element for Applicant Request.	GetApplicantsRequestType	/
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.
staffingUser		Optional. Workday user	String	/	UTF-8
staffingPassword		Optional. Workday password	String	/	UTF-8
staffingEndpoint		Optional. Workday endpoint	String	/	UTF-8
staffingWsdlLocation	https://community.workday.com/custom/developer/API/Staffing/v20/Staffing.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetApplicantsResponseType	Wrapper element for the Applicant Information returned as a result of a Get Applicant request.

Exception Payloads

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

<wd-staffing:get-citizenship-statuses>

Returns citizenship status details for the requested status. If the request does not specify a citizenship status, the operations returns details for all citizenship statuses.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
citizenshipStatusesRequest	#[payload]	Optional. Element containing the references of the Citizenship Statuses requested.	GetCitizenshipStatusesRequestType	/
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.
staffingUser		Optional. Workday user	String	/	UTF-8
staffingPassword		Optional. Workday password	String	/	UTF-8
staffingEndpoint		Optional. Workday endpoint	String	/	UTF-8
staffingWsdlLocation	https://community.workday.com/custom/developer/API/Staffing/v20/Staffing.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetCitizenshipStatusesResponseType	Response Element for Get Citizenship Statuses.

Exception Payloads

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

<wd-staffing:get-headcounts-staffing>

Returns headcount information along with the identification of the workers filling headcount positions.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
headcountsRequest	#[payload]	Optional. Request element to get Headcounts and their associated data.	GetHeadcountsRequestType	/
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.
staffingUser		Optional. Workday user	String	/	UTF-8
staffingPassword		Optional. Workday password	String	/	UTF-8
staffingEndpoint		Optional. Workday endpoint	String	/	UTF-8
staffingWsdlLocation	https://community.workday.com/custom/developer/API/Staffing/v20/Staffing.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetHeadcountsResponseType	Response element containing instances of headcounts and their associated data.

Exception Payloads

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

<wd-staffing:get-job-classification-groups-staffing>

Returns job classification group data.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
getJobClassificationGroupsRequest	#[payload]	Optional. The request object for the operation	GetJobClassificationGroupsRequestType	/
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.
staffingUser		Optional. Workday user	String	/	UTF-8
staffingPassword		Optional. Workday password	String	/	UTF-8
staffingEndpoint		Optional. Workday endpoint	String	/	UTF-8
staffingWsdlLocation	https://community.workday.com/custom/developer/API/Staffing/v20/Staffing.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetJobClassificationGroupsResponseType	The response from the operation

Exception Payloads

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

<wd-staffing:get-job-families-staffing>

Returns job family data.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
getJobFamiliesRequest	#[payload]	Optional. The request object for the operation	GetJobFamiliesRequestType	/
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.
staffingUser		Optional. Workday user	String	/	UTF-8
staffingPassword		Optional. Workday password	String	/	UTF-8
staffingEndpoint		Optional. Workday endpoint	String	/	UTF-8
staffingWsdlLocation	https://community.workday.com/custom/developer/API/Staffing/v20/Staffing.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetJobFamiliesResponseType	The response from the operation

Exception Payloads

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

<wd-staffing:get-job-family-groups-staffing>

Returns job family and job family group data.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
getJobFamilyGroupsRequest	#[payload]	Optional. The request object for the operation	GetJobFamilyGroupsRequestType	/
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.
staffingUser		Optional. Workday user	String	/	UTF-8
staffingPassword		Optional. Workday password	String	/	UTF-8
staffingEndpoint		Optional. Workday endpoint	String	/	UTF-8
staffingWsdlLocation	https://community.workday.com/custom/developer/API/Staffing/v20/Staffing.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetJobFamilyGroupsResponseType	The response from the operation

Exception Payloads

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

<wd-staffing:get-organizations-staffing>

Returns organization information for a type of organization. If the request does not specify an organization, the operation returns information for all organizations.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
getOrganizationsRequest	#[payload]	Optional. The request object for the operation	GetOrganizationsRequestType	/
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.
staffingUser		Optional. Workday user	String	/	UTF-8
staffingPassword		Optional. Workday password	String	/	UTF-8
staffingEndpoint		Optional. Workday endpoint	String	/	UTF-8
staffingWsdlLocation	https://community.workday.com/custom/developer/API/Staffing/v20/Staffing.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetOrganizationsResponseType	The response from the operation

Exception Payloads

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

<wd-staffing:get-positions-staffing>

Returns information for position management positions. If a position is filled, identifies the worker filling the position.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
positionsRequest	#[payload]	Optional. Request element to get position management positions and their associated data.	GetPositionsRequestType	/
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.
staffingUser		Optional. Workday user	String	/	UTF-8
staffingPassword		Optional. Workday password	String	/	UTF-8
staffingEndpoint		Optional. Workday endpoint	String	/	UTF-8
staffingWsdlLocation	https://community.workday.com/custom/developer/API/Staffing/v20/Staffing.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetPositionsResponseType	element containing instances of positions and their associated data.

Exception Payloads

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

<wd-staffing:get-worker-documents>

Returns worker document data.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
workerDocumentsRequest	#[payload]	Optional. Request element for Get Worker Documents.	GetWorkerDocumentsRequestType	/
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.
staffingUser		Optional. Workday user	String	/	UTF-8
staffingPassword		Optional. Workday password	String	/	UTF-8
staffingEndpoint		Optional. Workday endpoint	String	/	UTF-8
staffingWsdlLocation	https://community.workday.com/custom/developer/API/Staffing/v20/Staffing.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetWorkerDocumentsResponseType	Response element for Get Worker Documents.

Exception Payloads

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

<wd-staffing:get-workers-staffing>

Returns information for specified workers. If the request does not specify a worker, then the operation returns information for all workers.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
getWorkersRequest	#[payload]	Optional. The request object for the operation	GetWorkersRequestType	/
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.
staffingUser		Optional. Workday user	String	/	UTF-8
staffingPassword		Optional. Workday password	String	/	UTF-8
staffingEndpoint		Optional. Workday endpoint	String	/	UTF-8
staffingWsdlLocation	https://community.workday.com/custom/developer/API/Staffing/v20/Staffing.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetWorkersResponseType	The response from the operation

Exception Payloads

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

<wd-staffing:hire-employee>

Hires an applicant (new or existing) into an employee position, headcount, or job. Uses the Hire 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.
employee	#[payload]	Optional. Request object	HireEmployeeRequestType	/
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.
staffingUser		Optional. Workday user	String	/	UTF-8
staffingPassword		Optional. Workday password	String	/	UTF-8
staffingEndpoint		Optional. Workday endpoint	String	/	UTF-8
staffingWsdlLocation	https://community.workday.com/custom/developer/API/Staffing/v20/Staffing.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
HireEmployeeEventResponseType	element containing the Event ID for the Hire Employee Event.

Exception Payloads

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

<wd-staffing:maintain-employee-contracts>

Adds or updates employee contracts. Uses the Maintain Employee Contracts business process.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
employeeContractsRequest	#[payload]	Optional. Wrapper element for MaintainEmployeeContractsRequestType	MaintainEmployeeContractsRequestType	/
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.
staffingUser		Optional. Workday user	String	/	UTF-8
staffingPassword		Optional. Workday password	String	/	UTF-8
staffingEndpoint		Optional. Workday endpoint	String	/	UTF-8
staffingWsdlLocation	https://community.workday.com/custom/developer/API/Staffing/v20/Staffing.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
MaintainEmployeeContractsResponseType	Employee Contract that was added or updated

Exception Payloads

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

<wd-staffing:put-applicant-staffing>

Adds a new applicant (or updates an existing applicant) with the information supplied in the request.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
applicant	#[payload]	Optional. Wrapper element for the Put Applicant Request Information.	PutApplicantRequestType	/
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.
staffingUser		Optional. Workday user	String	/	UTF-8
staffingPassword		Optional. Workday password	String	/	UTF-8
staffingEndpoint		Optional. Workday endpoint	String	/	UTF-8
staffingWsdlLocation	https://community.workday.com/custom/developer/API/Staffing/v20/Staffing.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutApplicantResponseType	Wrapper element for the Put Applicant Returned data.

Exception Payloads

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

<wd-staffing:put-citizenship-status>

Adds or updates citizenship status.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
citizenshipStatus	#[payload]	Optional. Request element for the Put Citizenship Status operation	PutCitizenshipStatusRequestType	/
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.
staffingUser		Optional. Workday user	String	/	UTF-8
staffingPassword		Optional. Workday password	String	/	UTF-8
staffingEndpoint		Optional. Workday endpoint	String	/	UTF-8
staffingWsdlLocation	https://community.workday.com/custom/developer/API/Staffing/v20/Staffing.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutCitizenshipStatusResponseType	Response element for the Put Citizenship Status operation.

Exception Payloads

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

<wd-staffing:put-job-classification-group-staffing>

Adds or updates a job classification group and/or job classifications.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
putJobClassificationGroupRequest	#[payload]	Optional. The request object for the operation	PutJobClassificationGroupRequestType	/
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.
staffingUser		Optional. Workday user	String	/	UTF-8
staffingPassword		Optional. Workday password	String	/	UTF-8
staffingEndpoint		Optional. Workday endpoint	String	/	UTF-8
staffingWsdlLocation	https://community.workday.com/custom/developer/API/Staffing/v20/Staffing.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutJobClassificationGroupResponseType	The response from the operation

Exception Payloads

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

<wd-staffing:put-job-family-group-staffing>

Adds or updates a job family group. Also adds or removes a group's associated job families.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
putJobFamilyGroupRequest	#[payload]	Optional. The request object for the operation	PutJobFamilyGroupRequestType	/
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.
staffingUser		Optional. Workday user	String	/	UTF-8
staffingPassword		Optional. Workday password	String	/	UTF-8
staffingEndpoint		Optional. Workday endpoint	String	/	UTF-8
staffingWsdlLocation	https://community.workday.com/custom/developer/API/Staffing/v20/Staffing.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutJobFamilyGroupResponseType	The response from the operation

Exception Payloads

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

<wd-staffing:put-job-family-staffing>

Adds or updates a job family.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
putJobFamilyRequest	#[payload]	Optional. The request object for the operation	PutJobFamilyRequestType	/
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.
staffingUser		Optional. Workday user	String	/	UTF-8
staffingPassword		Optional. Workday password	String	/	UTF-8
staffingEndpoint		Optional. Workday endpoint	String	/	UTF-8
staffingWsdlLocation	https://community.workday.com/custom/developer/API/Staffing/v20/Staffing.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutJobFamilyResponseType	The response from the operation

Exception Payloads

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

<wd-staffing:put-worker-document>

Adds or updates a worker document. The operation adds documents not associated with events and those documents are not secured by the events. .

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
workerDocument	#[payload]	Optional. Request element for Put Worker Document	PutWorkerDocumentRequestType	/
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.
staffingUser		Optional. Workday user	String	/	UTF-8
staffingPassword		Optional. Workday password	String	/	UTF-8
staffingEndpoint		Optional. Workday endpoint	String	/	UTF-8
staffingWsdlLocation	https://community.workday.com/custom/developer/API/Staffing/v20/Staffing.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutWorkerDocumentResponseType	Response element for Put Worker Document.

Exception Payloads

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

<wd-staffing:remove-retiree-status>

Removes the retirement status from a retired employee. Uses the Remove Retiree Status business process.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
retireeStatus	#[payload]	Optional. Wrapper for RemoveRetireeStatusRequestType	RemoveRetireeStatusRequestType	/
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.
staffingUser		Optional. Workday user	String	/	UTF-8
staffingPassword		Optional. Workday password	String	/	UTF-8
staffingEndpoint		Optional. Workday endpoint	String	/	UTF-8
staffingWsdlLocation	https://community.workday.com/custom/developer/API/Staffing/v20/Staffing.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
RemoveRetireeStatusResponseType	element containing information on Remove Retiree Status event.

Exception Payloads

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

<wd-staffing:switch-primary-job>

This operation will invoke the business process to switch a workers primary job with one of their additional jobs. Uses the Switch Primary Job business process.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
switchPrimaryJobRequest	#[payload]	Optional. The request object for the operation	SwitchPrimaryJobRequestType	/
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.
staffingUser		Optional. Workday user	String	/	UTF-8
staffingPassword		Optional. Workday password	String	/	UTF-8
staffingEndpoint		Optional. Workday endpoint	String	/	UTF-8
staffingWsdlLocation	https://community.workday.com/custom/developer/API/Staffing/v20/Staffing.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
SwitchPrimaryJobEventResponseType	The response from the operation

Exception Payloads

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

<wd-staffing:terminate-employee>

Terminates an employee.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
employee	#[payload]	Optional. Wrapper for Terminate Employee Web Service and its sub-processes.	TerminateEmployeeRequestType	/
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.
staffingUser		Optional. Workday user	String	/	UTF-8
staffingPassword		Optional. Workday password	String	/	UTF-8
staffingEndpoint		Optional. Workday endpoint	String	/	UTF-8
staffingWsdlLocation	https://community.workday.com/custom/developer/API/Staffing/v20/Staffing.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
TerminateEmployeeEventResponseType	element with the Event ID for the Terminate Employee Event along with the worker reference.

Exception Payloads

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