org.mule.modules

mule-module-workday

config

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

Module Overview

The Recruiting Web Service contains operations that expose Workday Human Capital Management Business Services data for integration with Talent Management and Applicant Tracking systems.

Summary

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

Message Processors
<wd-recruiting:create-job-requisition> Creates a job requisition for a position in a position management supervisory organization.
<wd-recruiting:create-position> Creates/opens a position for a supervisory organization using the position management staffing model.
<wd-recruiting:edit-job-requisition> Edits an existing job requisition.
<wd-recruiting:edit-position-restrictions> Edits an existing position restriction.
<wd-recruiting:get-applicants> Returns information for applicants specified in the request.
<wd-recruiting:get-headcounts> Returns headcount information along with the identification of the workers filling headcount positions.
<wd-recruiting:get-job-requisitions> Returns information for job requisitions and provides a reference to the related position.
<wd-recruiting:get-organizations-recruiting> Returns organization information for a type of organization.
<wd-recruiting:get-positions> Returns information for position management positions.
<wd-recruiting:get-server-timestamp-recruiting> This operation retrieves Workday's current system datetime.
<wd-recruiting:put-applicant> Adds a new applicant (or updates an existing applicant) with the information supplied in the request.

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-recruiting="http://www.mulesoft.org/schema/mule/wd-recruiting"
      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-recruiting
               http://www.mulesoft.org/schema/mule/wd-recruiting/current/mule-wd-recruiting.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-recruiting: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.
recruitingUser		Workday user	String	/	UTF-8
recruitingPassword		Workday password	String	/	UTF-8
recruitingEndpoint		Workday endpoint	String	/	UTF-8
recruitingWsdlLocation	https://community.workday.com/custom/developer/API/Recruiting/v20/Recruiting.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-recruiting:config>
         <reconnect count="5" frequency="1000"/>
    </wd-recruiting: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-recruiting:create-job-requisition>

Creates a job requisition for a position in a position management supervisory organization. The position must not have any open requisitions, and the tenant must have the Enable Job Requisitions flag set to true. Requisitions cannot be reloaded into the system.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
requisitionRequest	#[payload]	Optional. Wrapper for Create Job Requisition Web Service	CreateRequisitionRequestType	/
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.
recruitingUser		Optional. Workday user	String	/	UTF-8
recruitingPassword		Optional. Workday password	String	/	UTF-8
recruitingEndpoint		Optional. Workday endpoint	String	/	UTF-8
recruitingWsdlLocation	https://community.workday.com/custom/developer/API/Recruiting/v20/Recruiting.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
CreateJobRequisitionResponseType	Responds with the event id for the Create Job Requisition Event and the Job Requisition Reference.

Exception Payloads

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

<wd-recruiting:create-position>

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.
createPositionRequest	#[payload]	Optional. The request object for the operation	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.
recruitingUser		Optional. Workday user	String	/	UTF-8
recruitingPassword		Optional. Workday password	String	/	UTF-8
recruitingEndpoint		Optional. Workday endpoint	String	/	UTF-8
recruitingWsdlLocation	https://community.workday.com/custom/developer/API/Recruiting/v20/Recruiting.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
CreatePositionResponseType	The response from the operation

Exception Payloads

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

<wd-recruiting:edit-job-requisition>

Edits an existing job requisition. The job requisition must be open.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
jobRequisition	#[payload]	Optional. Wrapper for Edit Job Requisition Request	EditJobRequisitionRequestType	/
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.
recruitingUser		Optional. Workday user	String	/	UTF-8
recruitingPassword		Optional. Workday password	String	/	UTF-8
recruitingEndpoint		Optional. Workday endpoint	String	/	UTF-8
recruitingWsdlLocation	https://community.workday.com/custom/developer/API/Recruiting/v20/Recruiting.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
EditJobRequisitionResponseType	response element

Exception Payloads

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

<wd-recruiting:edit-position-restrictions>

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.
editPositionRestrictionsRequest	#[payload]	Optional. The request object for the operation	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.
recruitingUser		Optional. Workday user	String	/	UTF-8
recruitingPassword		Optional. Workday password	String	/	UTF-8
recruitingEndpoint		Optional. Workday endpoint	String	/	UTF-8
recruitingWsdlLocation	https://community.workday.com/custom/developer/API/Recruiting/v20/Recruiting.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
EditPositonRestrictionResponseType	The response from the operation

Exception Payloads

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

<wd-recruiting:get-applicants>

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.
getApplicantsRequest	#[payload]	Optional. The request object for the operation	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.
recruitingUser		Optional. Workday user	String	/	UTF-8
recruitingPassword		Optional. Workday password	String	/	UTF-8
recruitingEndpoint		Optional. Workday endpoint	String	/	UTF-8
recruitingWsdlLocation	https://community.workday.com/custom/developer/API/Recruiting/v20/Recruiting.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetApplicantsResponseType	The response from the operation

Exception Payloads

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

<wd-recruiting:get-headcounts>

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.
getHeadcountsRequest	#[payload]	Optional. The request object for the operation	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.
recruitingUser		Optional. Workday user	String	/	UTF-8
recruitingPassword		Optional. Workday password	String	/	UTF-8
recruitingEndpoint		Optional. Workday endpoint	String	/	UTF-8
recruitingWsdlLocation	https://community.workday.com/custom/developer/API/Recruiting/v20/Recruiting.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetHeadcountsResponseType	The response from the operation

Exception Payloads

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

<wd-recruiting:get-job-requisitions>

Returns information for job requisitions and provides a reference to the related position.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
jobRequisitionsRequest	#[payload]	Optional. Request element to get job requisitions and their associated data.	GetJobRequisitionsRequestType	/
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.
recruitingUser		Optional. Workday user	String	/	UTF-8
recruitingPassword		Optional. Workday password	String	/	UTF-8
recruitingEndpoint		Optional. Workday endpoint	String	/	UTF-8
recruitingWsdlLocation	https://community.workday.com/custom/developer/API/Recruiting/v20/Recruiting.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetJobRequisitionsResponseType	Response element containing instances of Job Requisitions and their associated data.

Exception Payloads

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

<wd-recruiting:get-organizations-recruiting>

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.
recruitingUser		Optional. Workday user	String	/	UTF-8
recruitingPassword		Optional. Workday password	String	/	UTF-8
recruitingEndpoint		Optional. Workday endpoint	String	/	UTF-8
recruitingWsdlLocation	https://community.workday.com/custom/developer/API/Recruiting/v20/Recruiting.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-recruiting:get-positions>

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.
getPositionsRequest	#[payload]	Optional. The request object for the operation	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.
recruitingUser		Optional. Workday user	String	/	UTF-8
recruitingPassword		Optional. Workday password	String	/	UTF-8
recruitingEndpoint		Optional. Workday endpoint	String	/	UTF-8
recruitingWsdlLocation	https://community.workday.com/custom/developer/API/Recruiting/v20/Recruiting.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetPositionsResponseType	The response from the operation

Exception Payloads

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

<wd-recruiting:get-server-timestamp-recruiting>

This operation retrieves Workday's current system datetime.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
serverTimestampGet	#[payload]	Optional. The request object for the operation	ServerTimestampGetType	/
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.
recruitingUser		Optional. Workday user	String	/	UTF-8
recruitingPassword		Optional. Workday password	String	/	UTF-8
recruitingEndpoint		Optional. Workday endpoint	String	/	UTF-8
recruitingWsdlLocation	https://community.workday.com/custom/developer/API/Recruiting/v20/Recruiting.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
ServerTimestampType	The response from the operation

Exception Payloads

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

<wd-recruiting:put-applicant>

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.
putApplicantRequest	#[payload]	Optional. The request object for the operation	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.
recruitingUser		Optional. Workday user	String	/	UTF-8
recruitingPassword		Optional. Workday password	String	/	UTF-8
recruitingEndpoint		Optional. Workday endpoint	String	/	UTF-8
recruitingWsdlLocation	https://community.workday.com/custom/developer/API/Recruiting/v20/Recruiting.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutApplicantResponseType	The response from the operation

Exception Payloads

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

mule-module-workday

Module Overview

Summary

Configuration

Connection Pool

Reconnection Strategies

Configuration

Message Processors

<wd-recruiting:create-job-requisition>

XML Sample

Attributes

Returns

Exception Payloads

<wd-recruiting:create-position>

XML Sample

Attributes

Returns

Exception Payloads

<wd-recruiting:edit-job-requisition>

XML Sample

Attributes

Returns

Exception Payloads

<wd-recruiting:edit-position-restrictions>

XML Sample

Attributes

Returns

Exception Payloads

<wd-recruiting:get-applicants>

XML Sample

Attributes

Returns

Exception Payloads

<wd-recruiting:get-headcounts>

XML Sample

Attributes

Returns

Exception Payloads

<wd-recruiting:get-job-requisitions>

XML Sample

Attributes

Returns

Exception Payloads

<wd-recruiting:get-organizations-recruiting>

XML Sample

Attributes

Returns

Exception Payloads

<wd-recruiting:get-positions>

XML Sample

Attributes

Returns

Exception Payloads

<wd-recruiting:get-server-timestamp-recruiting>

XML Sample

Attributes

Returns

Exception Payloads

<wd-recruiting:put-applicant>

XML Sample

Attributes

Returns

Exception Payloads

Message Sources

Transformers