Summary: Configuration | Message Processors

org.mule.modules

mule-module-workday

2.2

Namespace	http://www.mulesoft.org/schema/mule/wd-staffing
Schema Location	http://www.mulesoft.org/schema/mule/wd-staffing/2.0/mule-wd-staffing.xsd
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: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/2.0/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 necesary 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
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
config-ref		Optional. Specify which configuration to use.

Child Elements

<wd-staffing:employeeReference> Optional. A string-object map of employee references
<wd-staffing:references> Optional. The list of string-object maps of references
<wd-staffing:filter> Optional. The get-applicants result filter, as an string-object map
<wd-staffing:group> Optional. The group of applicants, as a string-object map

Return Payload

the get-applicants result

Exception Payload

	if operation fails
Exception

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

This operation will get employee contract information for employees.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.

Child Elements

<wd-staffing:employeeReference> A list of string-object maps
<wd-staffing:responseFilterType> A filter type

Return Payload

the response

Exception Payload

	if operation fails
Exception

<wd-staffing:get-positions>

This operations answers the available positions

XML Sample

INCLUDE_ERROR

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.

Child Elements

<wd-staffing:criteria> Optional. Utilize the Request Criteria element to search the transaction log for specific instance(s) of a Position.
<wd-staffing:references> Optional. Utilize the Request References element to retrieve a specific instance(s) of Position and its associated data.
<wd-staffing:responseFilter> 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.
<wd-staffing:responseGroup> 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

Return Payload

the GetPositions response

Exception Payload

	if operation fails
Exception

<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
config-ref		Optional. Specify which configuration to use.
autoComplete		Optional. If autocomplete is enabled. Default is false.
runNow		Optional. If process should be run now. Defaults is false

Child Elements

<wd-staffing:hireEmployeeData> The hire employed request payload
<wd-staffing:commentData> Optional. An optional comment

Return Payload

the hire employee operation result

Exception Payload

	if operation fails
Exception

<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	Default Value	Description
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
workdayId		Optional. The optional Workday id. Must be specified if attempting to update an existing applicant and applicant id is not specified

Child Elements

<wd-staffing:applicant> The new applicant information

Return Payload

the new or updated applicant reference

Exception Payload

	if the operation failed.
	if operation fails
Exception