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.2

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:get-applicants> Gets information for applicants specified in the request or information for all applicants if no criteria or applicant is specified in the request.
<wd-staffing:get-mantain-employee-contracts> This operation will get employee contract information for employees.
<wd-staffing:get-positions> This operations answers the available positions
<wd-staffing:get-workers> Answers the available workers
<wd-staffing:hire-employee> This operation will hire an existing applicant or a new applicant into an employee position, headcount, or job using the Hire Employee business process event and its relevant sub business processes.
<wd-staffing:put-applicant> This operation adds a new Applicant (or updates an existing Applicant) with the supplied information.

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>

This module is configured using the config element. This element must be placed outside of your flows and at the root of your Mule application. You can create as many configurations as you deem necessary as long as each carries its own name.

Each message processor, message source or transformer carries a config-ref attribute that allows the invoker to specify which configuration to use.

Attributes
Type	Name	Default Value	Description	Java Type	MIME Type	Encoding
xs:string	name		Optional. Give a name to this configuration so it can be later referenced.
xs:string	endpoint		The Staffing endpoint.
xs:string	password		The Workday account's password
xs:string	username		The Workday account's username

Message Processors

<wd-staffing:get-applicants>

Gets information for applicants specified in the request or information for all applicants if no criteria or applicant is specified 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.

Child Elements

Name	Description	Java Type
<wd-staffing:employee-reference>	Optional. A string-object map of employee references	Map<String, Object>
<wd-staffing:references>	Optional. The list of string-object maps of references	List<Map<String, Object>>
<wd-staffing:filter>	Optional. The get-applicants result filter, as an string-object map	Map<String, Object>
<wd-staffing:group>	Optional. The group of applicants, as a string-object map	Map<String, Object>

Returns

Return Type	Description
GetApplicantsResponseType	the get-applicants result

Exception Payloads

Payload Class	Description
Exception	if operation fails

<wd-staffing:get-mantain-employee-contracts>

This operation will get employee contract information for employees.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.

Child Elements

Name	Default Value	Description	Java Type
<wd-staffing:employee-reference>		A list of string-object maps	List<Map<String, Object>>
<wd-staffing:response-filter-type>		A filter type	Map<String, Object>

Returns

Return Type	Description
GetMaintainEmployeeContractsResponseType	the response

Exception Payloads

Payload Class	Description
Exception	if operation fails

<wd-staffing:get-positions>

This operations answers the available positions

XML Sample

INCLUDE_ERROR

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.

Child Elements

Name	Description	Java Type
<wd-staffing:criteria>	Optional. Utilize the Request Criteria element to search the transaction log for specific instance(s) of a Position.	Map<String, Object>
<wd-staffing:references>	Optional. Utilize the Request References element to retrieve a specific instance(s) of Position and its associated data.	List<Map<String, Object>>
<wd-staffing:response-filter>	Optional. The "Response_Filter" element contains common WWS information that allows you control the response data that you will be provided including As_Of_Date, As_Of_Entry_Moment, and Page attributes.	Map<String, Object>
<wd-staffing:response-group>	Optional. The response group allows for the response data to be tailored to only included elements that the user is looking for. If no response group is provided in the request the only the following elements will be returned: Reference and Position Definition Data	Map<String, Object>

Returns

Return Type	Description
GetPositionsResponseType	the GetPositions response

Exception Payloads

Payload Class	Description
Exception	if operation fails

<wd-staffing:get-workers>

Answers the available workers

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.

Child Elements

Name	Description	Java Type
<wd-staffing:criteria>	Optional. Utilize the Request Criteria element to search the transaction log for specific instance(s) of a Worker.	Map<String, Object>
<wd-staffing:references>	Optional. Utilize the Request References element to retrieve a specific instance(s) of Worker and its associated data.	List<Map<String, Object>>
<wd-staffing:response-filter>	Optional. The "Response_Filter" element contains common WWS information that allows you control the response data that you will be provided including As_Of_Date, As_Of_Entry_Moment, and Page attributes.	Map<String, Object>
<wd-staffing:response-group>	Optional. The response group allows for the response data to be tailored to only included elements that the user is looking for. If no response group is provided in the request the only the following elements will be returned: Reference, Personal Data, Employment Data, Compensation Data, Organization Data, and Role Data.	Map<String, Object>

Returns

Return Type	Description
GetWorkersResponseType	the GetWorkers response

Exception Payloads

Payload Class	Description
Exception	if operation fails

<wd-staffing:hire-employee>

This operation will hire an existing applicant or a new applicant into an employee position, headcount, or job using the Hire Employee business process event and its relevant sub business processes.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type
config-ref		Optional. Specify which configuration to use.
autoComplete	false	Optional. If autocomplete is enabled. Default is false.	boolean	/
runNow	false	Optional. If process should be run now. Defaults is false	boolean	/

Child Elements

Name	Default Value	Description	Java Type
<wd-staffing:hire-employee-data>		The hire employed request payload	Map<String, Object>
<wd-staffing:comment-data>		Optional. An optional comment	Map<String, Object>

Returns

Return Type	Description
HireEmployeeEventResponseType	the hire employee operation result

Exception Payloads

Payload Class	Description
Exception	if operation fails

<wd-staffing:put-applicant>

This operation adds a new Applicant (or updates an existing Applicant) with the supplied information.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
applicantId	Optional. The optional applicant id. Must be specified if attempting to update an existing applicant and Workday id is not specified	String	/	UTF-8
workdayId	Optional. The optional Workday id. Must be specified if attempting to update an existing applicant and applicant id is not specified	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<wd-staffing:applicant>		The new applicant information	Map<String, Object>

Returns

Return Type	Description
ApplicantObjectType	the new or updated applicant reference

Exception Payloads

Payload Class	Description
Exception	if operation fails

mule-module-workday

Module Overview

Summary

Configuration

Message Processors

<wd-staffing:get-applicants>

XML Sample

Attributes

Child Elements

Returns

Exception Payloads

<wd-staffing:get-mantain-employee-contracts>

XML Sample

Attributes

Child Elements

Returns

Exception Payloads

<wd-staffing:get-positions>

XML Sample

XML Sample

Attributes

Child Elements

Returns

Exception Payloads

<wd-staffing:get-workers>

XML Sample

Attributes

Child Elements

Returns

Exception Payloads

<wd-staffing:hire-employee>

XML Sample

Attributes

Child Elements

Returns

Exception Payloads

<wd-staffing:put-applicant>

XML Sample

Attributes

Child Elements

Returns

Exception Payloads

Message Sources

Transformers