mule-module-workday

1.2

Namespace	http://www.mulesoft.org/schema/mule/workday
Schema Location	http://www.mulesoft.org/schema/mule/workday/1.0/mule-workday.xsd
Version	1.0
Minimum Mule Version	3.2

Module Overview

Workday is an on-demand financial management and human capital management software vendor. The Human Resources Web Service contains operations that expose 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
<workday:config> Configure an instance of this module

Message Processors
<workday: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.
<workday:get-mantain-employee-contracts> This operation will get employee contract information for employees.
<workday: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.
<workday: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:workday="http://www.mulesoft.org/schema/mule/workday"
      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/workday
               http://www.mulesoft.org/schema/mule/workday/1.0/mule-workday.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.
	client		Optional. The client, mainly for mocking purposes.
xs:string	endpoint		The Workday endpoint.
xs:string	password		The Workday account's password
xs:string	username		The Workday account's username
xs:string	version		Workday's version.

Message Processors

<workday: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

config-ref		Optional. Specify which configuration to use.
employeeReference		Optional. A string-object map of employee references
references		Optional. The list of string-object maps of references
filter		Optional. The get-applicants result filter, as an string-object map
group		Optional. The group of applicants, as a string-object map
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

Return Payload

the get-applicants result

<workday:get-mantain-employee-contracts>

This operation will get employee contract information for employees.

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
employeeReference		A list of string-object maps
responseFilterType		A filter type
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

Return Payload

the response

<workday: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

config-ref		Optional. Specify which configuration to use.
hireEmployeeData		The hire employed request payload
autoComplete		Optional. If autocomplete is enabled. Default is false.
runNow		Optional. If process should be run now. Defaults is false
commentData		Optional. An optional comment
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

Return Payload

the hire employee operation result

<workday:put-applicant>

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

XML Sample

INCLUDE_ERROR

Attributes

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
applicant		The new applicant information
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

Return Payload

the new or updated applicant reference

Exception Payload

WorkdayException	if the operation failed.