org.mule.modules

mule-module-workday

config

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

Module Overview

Workday Integrations Module contains operations related to all Integrations within the Workday system.

Summary

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

Message Processors
<wd-integration:approve-business-process> Approves a business process, if approvable, by the user
<wd-integration:cancel-business-process> Cancels a business process, if cancelable, by the user
<wd-integration:deny-business-process> Denies a business process, if deniable, by the user
<wd-integration:get-eib-definitions> Retrieves data related to an EIB definition.
<wd-integration:get-event-detail> Retrieves data (e.g.
<wd-integration:get-event-documents> Retrieves data related to any Documents that may be available to an Integration Event.
<wd-integration:get-integration-events> Retrieves data related to an execution of an Integration Event.
<wd-integration:get-integration-system-users> Retrieves data related to Workday Accounts associated to an Integration System.
<wd-integration:get-integration-systems> Retrieves data related to an Integration System.
<wd-integration:get-references> Provides a list of values for a business object in Workday given its "Reference ID Type".
<wd-integration:get-sequence-generators> Retrieves data related to a Sequence Generator (e.g ID Definition).
<wd-integration:get-subscriptions> Retrieves data related to Subscriptions, both for an Integration System and for Transaction Log service configuration.
<wd-integration:increment-sequence-generator> Increments a Sequence Generator and persists the data within Workday.
<wd-integration:launch-eib> Launchs an EIB Integration.
<wd-integration:launch-integration> Launchs an Integration.
<wd-integration:put-integration-event> Creates and/or update data related to an Integration Event.
<wd-integration:put-integration-message> Adds a message to either an Integration System or Integration Event which allows for status, information and error details to be communicated back to Workday.
<wd-integration:put-integration-system> Creates and/or update data related to an Integration System.
<wd-integration:put-integration-system-user> Creates and/or update data related to Workday Accounts associated to an Integration System.
<wd-integration:put-reference> Updates the Reference IDs on a business object for a Reference ID Type.
<wd-integration:put-sequence-generator> Creates and/or update data related to a Sequence Generator (e.g ID Definition).
<wd-integration:put-subscription> Creates and/or update data related to Subscriptions, both for an Integration System and for Transaction Log service configuration.
<wd-integration:rescind-business-process> Rescinds a business process, if rescindable by the user

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-integration="http://www.mulesoft.org/schema/mule/wd-integration"
      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-integration
               http://www.mulesoft.org/schema/mule/wd-integration/current/mule-wd-integration.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-integration: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.
integrationUser		Workday user	String	/	UTF-8
integrationPassword		Workday password	String	/	UTF-8
integrationEndpoint		Workday endpoint	String	/	UTF-8
integrationWsdlLocation	https://community.workday.com/custom/developer/API/Integrations/v20/Integrations.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-integration:config>
         <reconnect count="5" frequency="1000"/>
    </wd-integration: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-integration:approve-business-process>

Approves a business process, if approvable, by the user

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
businessProcess	#[payload]	Optional. Request element for the Approve Business Process operation	ApproveBusinessProcessRequestType	/
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.
integrationUser		Optional. Workday user	String	/	UTF-8
integrationPassword		Optional. Workday password	String	/	UTF-8
integrationEndpoint		Optional. Workday endpoint	String	/	UTF-8
integrationWsdlLocation	https://community.workday.com/custom/developer/API/Integrations/v20/Integrations.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
ApproveBusinessProcessResponseType	Wrapper that contains all sub response elements.

Exception Payloads

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

<wd-integration:cancel-business-process>

Cancels a business process, if cancelable, by the user

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
request	#[payload]	Optional. Cancel Business Process Request	CancelBusinessProcessRequestType	/
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.
integrationUser		Optional. Workday user	String	/	UTF-8
integrationPassword		Optional. Workday password	String	/	UTF-8
integrationEndpoint		Optional. Workday endpoint	String	/	UTF-8
integrationWsdlLocation	https://community.workday.com/custom/developer/API/Integrations/v20/Integrations.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
CancelBusinessProcessResponseType	Cancel Business Process Response

Exception Payloads

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

<wd-integration:deny-business-process>

Denies a business process, if deniable, by the user

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
request	#[payload]	Optional. Element for the Deny Business Process operation	DenyBusinessProcessRequestType	/
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.
integrationUser		Optional. Workday user	String	/	UTF-8
integrationPassword		Optional. Workday password	String	/	UTF-8
integrationEndpoint		Optional. Workday endpoint	String	/	UTF-8
integrationWsdlLocation	https://community.workday.com/custom/developer/API/Integrations/v20/Integrations.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
DenyBusinessProcessResponseType	Wrapper that contains all sub response elements.

Exception Payloads

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

<wd-integration:get-eib-definitions>

Retrieves data related to an EIB definition. An EIB definition will include the Integration System and a Data Source, Transformation and Transport Protocol definition.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
eibDefinitionsRequest	#[payload]	Optional. Get EIB Definitions Request	GetEIBDefinitionsRequestType	/
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.
integrationUser		Optional. Workday user	String	/	UTF-8
integrationPassword		Optional. Workday password	String	/	UTF-8
integrationEndpoint		Optional. Workday endpoint	String	/	UTF-8
integrationWsdlLocation	https://community.workday.com/custom/developer/API/Integrations/v20/Integrations.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetEIBDefinitionsResponseType	Get EIB Definitions Response

Exception Payloads

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

<wd-integration:get-event-detail>

Retrieves data (e.g. Creation Date, Event State, Event Target, etc..) related to Workday Business Process Event (e.g. Hire Employee, Enter Time Off, etc...)

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
eventDetailRequest	#[payload]	Optional. Get_Event_Details request element	GetEventDetailsRequestType	/
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.
integrationUser		Optional. Workday user	String	/	UTF-8
integrationPassword		Optional. Workday password	String	/	UTF-8
integrationEndpoint		Optional. Workday endpoint	String	/	UTF-8
integrationWsdlLocation	https://community.workday.com/custom/developer/API/Integrations/v20/Integrations.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetEventDetailsResponseType	Get_Event_Details response element

Exception Payloads

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

<wd-integration:get-event-documents>

Retrieves data related to any Documents that may be available to an Integration Event.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
eventDocumentsRequest	#[payload]	Optional. Get Event Documents Request element	GetEventDocumentsRequestType	/
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.
integrationUser		Optional. Workday user	String	/	UTF-8
integrationPassword		Optional. Workday password	String	/	UTF-8
integrationEndpoint		Optional. Workday endpoint	String	/	UTF-8
integrationWsdlLocation	https://community.workday.com/custom/developer/API/Integrations/v20/Integrations.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetEventDocumentsResponseType	Get Event Documents Response element

Exception Payloads

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

<wd-integration:get-integration-events>

Retrieves data related to an execution of an Integration Event. Data included will be Integration System, Launch datetime, Triggering User, Status and Runtime Parameters.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
integrationEventsRequest	#[payload]	Optional. Request element for the Get Integration Events operation	GetIntegrationEventsRequestType	/
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.
integrationUser		Optional. Workday user	String	/	UTF-8
integrationPassword		Optional. Workday password	String	/	UTF-8
integrationEndpoint		Optional. Workday endpoint	String	/	UTF-8
integrationWsdlLocation	https://community.workday.com/custom/developer/API/Integrations/v20/Integrations.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetIntegrationEventsResponseType	Get Integration Events Response

Exception Payloads

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

<wd-integration:get-integration-system-users>

Retrieves data related to Workday Accounts associated to an Integration System.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
integrationSystemUsersRequest	#[payload]	Optional. Get Integration System Users Request element	GetIntegrationSystemUsersRequestType	/
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.
integrationUser		Optional. Workday user	String	/	UTF-8
integrationPassword		Optional. Workday password	String	/	UTF-8
integrationEndpoint		Optional. Workday endpoint	String	/	UTF-8
integrationWsdlLocation	https://community.workday.com/custom/developer/API/Integrations/v20/Integrations.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetIntegrationSystemUsersResponseType	response element

Exception Payloads

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

<wd-integration:get-integration-systems>

Retrieves data related to an Integration System. Data returned within the response includes Services associated and enabled, Attribute/Map values, Service configurations and Custom Services Attributes, Maps and Launch Parameters.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
integrationSystemsRequest	#[payload]	Optional. Request element used to find and get Integration Systems and their associated data.	GetIntegrationSystemsRequestType	/
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.
integrationUser		Optional. Workday user	String	/	UTF-8
integrationPassword		Optional. Workday password	String	/	UTF-8
integrationEndpoint		Optional. Workday endpoint	String	/	UTF-8
integrationWsdlLocation	https://community.workday.com/custom/developer/API/Integrations/v20/Integrations.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetIntegrationSystemsResponseType	Response element containing instances of Integration System and each of its associated data.

Exception Payloads

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

<wd-integration:get-references>

Provides a list of values for a business object in Workday given its "Reference ID Type". The "Reference ID Type" for each referenced business object can be retrieved within our API Documentation. For example, the "Reference ID Type" for a Location reference is "Location_ID". So, if we call "Get References" with "Location_ID" you will get back the list of all locations (and their Workday and Reference IDs).

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
referencesRequest	#[payload]	Optional. Request element	GetReferencesRequestType	/
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.
integrationUser		Optional. Workday user	String	/	UTF-8
integrationPassword		Optional. Workday password	String	/	UTF-8
integrationEndpoint		Optional. Workday endpoint	String	/	UTF-8
integrationWsdlLocation	https://community.workday.com/custom/developer/API/Integrations/v20/Integrations.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetReferencesResponseType	response element

Exception Payloads

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

<wd-integration:get-sequence-generators>

Retrieves data related to a Sequence Generator (e.g ID Definition). Data associated to a Sequence Generator includes the formatting, syntax, last date used, increment value, etc. Sequence Generators are typically associated with Integrations utilizing a Sequence Generator Service.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
sequenceGeneratorsRequest	#[payload]	Optional. Sequence Generator request element.	GetSequenceGeneratorsRequestType	/
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.
integrationUser		Optional. Workday user	String	/	UTF-8
integrationPassword		Optional. Workday password	String	/	UTF-8
integrationEndpoint		Optional. Workday endpoint	String	/	UTF-8
integrationWsdlLocation	https://community.workday.com/custom/developer/API/Integrations/v20/Integrations.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetSequenceGeneratorsResponseType	Response element containing instances of Sequence Generator and each of its associated data.

Exception Payloads

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

<wd-integration:get-subscriptions>

Retrieves data related to Subscriptions, both for an Integration System and for Transaction Log service configuration. A Subscription includes an association with 1 or more Transaction/Business Process Types.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
subscriptionsRequest	#[payload]	Optional. Get Subscriptions Request	GetSubscriptionsRequestType	/
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.
integrationUser		Optional. Workday user	String	/	UTF-8
integrationPassword		Optional. Workday password	String	/	UTF-8
integrationEndpoint		Optional. Workday endpoint	String	/	UTF-8
integrationWsdlLocation	https://community.workday.com/custom/developer/API/Integrations/v20/Integrations.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
GetSubscriptionsResponseType	Get Subscriptions Response

Exception Payloads

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

<wd-integration:increment-sequence-generator>

Increments a Sequence Generator and persists the data within Workday. The response is the fully formatted value of the Sequence Generator after the increment.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
sequenceGeneratorRequest	#[payload]	Optional. Request element for Increment of Sequence Generator.	IncrementSequenceGeneratorRequestType	/
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.
integrationUser		Optional. Workday user	String	/	UTF-8
integrationPassword		Optional. Workday password	String	/	UTF-8
integrationEndpoint		Optional. Workday endpoint	String	/	UTF-8
integrationWsdlLocation	https://community.workday.com/custom/developer/API/Integrations/v20/Integrations.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
IncrementSequenceGeneratorResponseType	Response element for Increment of Sequence Generator.

Exception Payloads

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

<wd-integration:launch-eib>

Launchs an EIB Integration. The request has the ability to accept override Runtime Parameters that should be used within the integration processing. If no override is provided within the request, the System Default, which has been defined on the EIB Definition, will be used. The result of this operation will be the creation of an Integration Event along with the processing of the integration itself.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
launchEibRequest	#[payload]	Optional. Launch EIB Request	LaunchEIBRequestType	/
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.
integrationUser		Optional. Workday user	String	/	UTF-8
integrationPassword		Optional. Workday password	String	/	UTF-8
integrationEndpoint		Optional. Workday endpoint	String	/	UTF-8
integrationWsdlLocation	https://community.workday.com/custom/developer/API/Integrations/v20/Integrations.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
LaunchEIBResponseType	Launch EIB Response

Exception Payloads

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

<wd-integration:launch-integration>

Launchs an Integration. The request has the ability to accept Runtime Parameters and the Workday Account that should be used within the integration processing. The result of this operation will be the creation of an Integration Event along with the processing of the integration itself.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
LaunchIntegrationRequest	#[payload]	Optional. Launch Integration Event Request	LaunchIntegrationEventRequestType	/
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.
integrationUser		Optional. Workday user	String	/	UTF-8
integrationPassword		Optional. Workday password	String	/	UTF-8
integrationEndpoint		Optional. Workday endpoint	String	/	UTF-8
integrationWsdlLocation	https://community.workday.com/custom/developer/API/Integrations/v20/Integrations.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
LaunchIntegrationEventResponseType	Launch Integration Event Response

Exception Payloads

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

<wd-integration:put-integration-event>

Creates and/or update data related to an Integration Event. Data included will be Integration System, Launch datetime, Triggering User, Status and Runtime Parameters.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
integrationEvent	#[payload]	Optional. Integration event request element.	PutIntegrationEventRequestType	/
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.
integrationUser		Optional. Workday user	String	/	UTF-8
integrationPassword		Optional. Workday password	String	/	UTF-8
integrationEndpoint		Optional. Workday endpoint	String	/	UTF-8
integrationWsdlLocation	https://community.workday.com/custom/developer/API/Integrations/v20/Integrations.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutIntegrationEventResponseType	Integration Event response element

Exception Payloads

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

<wd-integration:put-integration-message>

Adds a message to either an Integration System or Integration Event which allows for status, information and error details to be communicated back to Workday.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
integrationMessageRequest	#[payload]	Optional. Integration Message request element.	PutIntegrationMessageRequestType	/
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.
integrationUser		Optional. Workday user	String	/	UTF-8
integrationPassword		Optional. Workday password	String	/	UTF-8
integrationEndpoint		Optional. Workday endpoint	String	/	UTF-8
integrationWsdlLocation	https://community.workday.com/custom/developer/API/Integrations/v20/Integrations.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutIntegrationMessageResponseType	Integration Message response element.

Exception Payloads

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

<wd-integration:put-integration-system>

Creates and/or update data related to an Integration System. Data returned within the response includes Services associated and enabled, Attribute/Map values, Service configurations and Custom Services Attributes, Maps and Launch Parameters.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
integrationSystemRequest	#[payload]	Optional. Integration System request element.	PutIntegrationSystemRequestType	/
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.
integrationUser		Optional. Workday user	String	/	UTF-8
integrationPassword		Optional. Workday password	String	/	UTF-8
integrationEndpoint		Optional. Workday endpoint	String	/	UTF-8
integrationWsdlLocation	https://community.workday.com/custom/developer/API/Integrations/v20/Integrations.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutIntegrationSystemResponseType	Integration System Response element

Exception Payloads

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

<wd-integration:put-integration-system-user>

Creates and/or update data related to Workday Accounts associated to an Integration System.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
integrationSystemUserRequest	#[payload]	Optional. Put Integration System User Request element	PutIntegrationSystemUserRequestType	/
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.
integrationUser		Optional. Workday user	String	/	UTF-8
integrationPassword		Optional. Workday password	String	/	UTF-8
integrationEndpoint		Optional. Workday endpoint	String	/	UTF-8
integrationWsdlLocation	https://community.workday.com/custom/developer/API/Integrations/v20/Integrations.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutIntegrationSystemUserResponseType	Put Integration System User Response element

Exception Payloads

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

<wd-integration:put-reference>

Updates the Reference IDs on a business object for a Reference ID Type. Currently, updating Reference IDs for most, but not all Reference ID Types is supported.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
referenceRequest	#[payload]	Optional. Request element for Put Reference.	PutReferenceRequestType	/
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.
integrationUser		Optional. Workday user	String	/	UTF-8
integrationPassword		Optional. Workday password	String	/	UTF-8
integrationEndpoint		Optional. Workday endpoint	String	/	UTF-8
integrationWsdlLocation	https://community.workday.com/custom/developer/API/Integrations/v20/Integrations.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutReferenceResponseType	Response element for Put Reference.

Exception Payloads

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

<wd-integration:put-sequence-generator>

Creates and/or update data related to a Sequence Generator (e.g ID Definition). Data associated to a Sequence Generator includes the formatting, syntax, last date used, increment value, etc. Sequence Generators are typically associated with Integrations utilizing a Sequence Generator Service.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
sequenceGeneratorRequest	#[payload]	Optional. Sequence Generator Request element	PutSequenceGeneratorRequestType	/
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.
integrationUser		Optional. Workday user	String	/	UTF-8
integrationPassword		Optional. Workday password	String	/	UTF-8
integrationEndpoint		Optional. Workday endpoint	String	/	UTF-8
integrationWsdlLocation	https://community.workday.com/custom/developer/API/Integrations/v20/Integrations.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutSequenceGeneratorResponseType	Sequence Generator Response element

Exception Payloads

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

<wd-integration:put-subscription>

Creates and/or update data related to Subscriptions, both for an Integration System and for Transaction Log service configuration. A Subscription includes an association with 1 or more Transaction/Business Process Types.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
subscriptionRequest	#[payload]	Optional. Put Subscription Request	PutSubscriptionRequestType	/
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.
integrationUser		Optional. Workday user	String	/	UTF-8
integrationPassword		Optional. Workday password	String	/	UTF-8
integrationEndpoint		Optional. Workday endpoint	String	/	UTF-8
integrationWsdlLocation	https://community.workday.com/custom/developer/API/Integrations/v20/Integrations.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
PutSubscriptionResponseType	Put Subscription Response

Exception Payloads

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

<wd-integration:rescind-business-process>

Rescinds a business process, if rescindable by the user

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
rescindBusinessProcessRequest	#[payload]	Optional. Rescind Business Process Request	RescindBusinessProcessRequestType	/
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.
integrationUser		Optional. Workday user	String	/	UTF-8
integrationPassword		Optional. Workday password	String	/	UTF-8
integrationEndpoint		Optional. Workday endpoint	String	/	UTF-8
integrationWsdlLocation	https://community.workday.com/custom/developer/API/Integrations/v20/Integrations.wsdl	Optional. Workday WSDL location	String	/	UTF-8

Returns

Return Type	Description
RescindBusinessProcessResponseType	Rescind Business Process Response

Exception Payloads

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