public class

IntegrationsModule

extends AbstractWorkdayModule
java.lang.Object
   ↳ org.mule.modules.workday.AbstractWorkdayModule
     ↳ org.mule.modules.workday.integrations.IntegrationsModule
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

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

Summary

Fields
private IntegrationsPort client The client, mainly for mocking purposes.
private String username The Workday account's username
Public Constructors
IntegrationsModule()
Public Methods
ApproveBusinessProcessResponseType approveBusinessProcess(ApproveBusinessProcessRequestType businessProcess)
Approves a business process, if approvable, by the user
CancelBusinessProcessResponseType cancelBusinessProcess(CancelBusinessProcessRequestType request)
Cancels a business process, if cancelable, by the user
void connect(String integrationUser, String integrationPassword, String integrationEndpoint, String integrationWsdlLocation)
Connects to Workday
DenyBusinessProcessResponseType denyBusinessProcess(DenyBusinessProcessRequestType request)
Denies a business process, if deniable, by the user
void disconnect()
Disconnects
IntegrationsPort getClient()
String getConnectionIdentifier()
Connection identifier
GetEIBDefinitionsResponseType getEibDefinitions(GetEIBDefinitionsRequestType eibDefinitionsRequest)
Retrieves data related to an EIB definition.
GetEventDetailsResponseType getEventDetail(GetEventDetailsRequestType eventDetailRequest)
Retrieves data (e.g.
GetEventDocumentsResponseType getEventDocuments(GetEventDocumentsRequestType eventDocumentsRequest)
Retrieves data related to any Documents that may be available to an Integration Event.
GetIntegrationEventsResponseType getIntegrationEvents(GetIntegrationEventsRequestType integrationEventsRequest)
Retrieves data related to an execution of an Integration Event.
GetIntegrationSystemUsersResponseType getIntegrationSystemUsers(GetIntegrationSystemUsersRequestType integrationSystemUsersRequest)
Retrieves data related to Workday Accounts associated to an Integration System.
GetIntegrationSystemsResponseType getIntegrationSystems(GetIntegrationSystemsRequestType integrationSystemsRequest)
Retrieves data related to an Integration System.
GetReferencesResponseType getReferences(GetReferencesRequestType referencesRequest)
Provides a list of values for a business object in Workday given its "Reference ID Type".
GetSequenceGeneratorsResponseType getSequenceGenerators(GetSequenceGeneratorsRequestType sequenceGeneratorsRequest)
Retrieves data related to a Sequence Generator (e.g ID Definition).
GetSubscriptionsResponseType getSubscriptions(GetSubscriptionsRequestType subscriptionsRequest)
Retrieves data related to Subscriptions, both for an Integration System and for Transaction Log service configuration.
String getUsername()
IncrementSequenceGeneratorResponseType incrementSequenceGenerator(IncrementSequenceGeneratorRequestType sequenceGeneratorRequest)
Increments a Sequence Generator and persists the data within Workday.
LaunchEIBResponseType launchEib(LaunchEIBRequestType launchEibRequest)
Launchs an EIB Integration.
LaunchIntegrationEventResponseType launchIntegration(LaunchIntegrationEventRequestType LaunchIntegrationRequest)
Launchs an Integration.
PutIntegrationEventResponseType putIntegrationEvent(PutIntegrationEventRequestType integrationEvent)
Creates and/or update data related to an Integration Event.
PutIntegrationMessageResponseType putIntegrationMessage(PutIntegrationMessageRequestType integrationMessageRequest)
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.
PutIntegrationSystemResponseType putIntegrationSystem(PutIntegrationSystemRequestType integrationSystemRequest)
Creates and/or update data related to an Integration System.
PutIntegrationSystemUserResponseType putIntegrationSystemUser(PutIntegrationSystemUserRequestType integrationSystemUserRequest)
Creates and/or update data related to Workday Accounts associated to an Integration System.
PutReferenceResponseType putReference(PutReferenceRequestType referenceRequest)
Updates the Reference IDs on a business object for a Reference ID Type.
PutSequenceGeneratorResponseType putSequenceGenerator(PutSequenceGeneratorRequestType sequenceGeneratorRequest)
Creates and/or update data related to a Sequence Generator (e.g ID Definition).
PutSubscriptionResponseType putSubscription(PutSubscriptionRequestType subscriptionRequest)
Creates and/or update data related to Subscriptions, both for an Integration System and for Transaction Log service configuration.
RescindBusinessProcessResponseType rescindBusinessProcess(RescindBusinessProcessRequestType rescindBusinessProcessRequest)
Rescinds a business process, if rescindable by the user
void setClient(Object client)
void setClient(IntegrationsPort client)
void setUsername(String username)
boolean validateConnection()
Validate connection
[Expand]
Inherited Methods
From class org.mule.modules.workday.AbstractWorkdayModule
From class java.lang.Object

Fields

private IntegrationsPort client

The client, mainly for mocking purposes. *

private String username

The Workday account's username

Public Constructors

public IntegrationsModule ()

Public Methods

public ApproveBusinessProcessResponseType approveBusinessProcess (ApproveBusinessProcessRequestType businessProcess)

Approves a business process, if approvable, by the user

Parameters
businessProcess Request element for the Approve Business Process operation
Returns
  • Wrapper that contains all sub response elements.
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public CancelBusinessProcessResponseType cancelBusinessProcess (CancelBusinessProcessRequestType request)

Cancels a business process, if cancelable, by the user

Parameters
request Cancel Business Process Request
Returns
  • Cancel Business Process Response
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public void connect (String integrationUser, String integrationPassword, String integrationEndpoint, String integrationWsdlLocation)

Connects to Workday

Parameters
integrationUser Workday user
integrationPassword Workday password
integrationEndpoint Workday endpoint
integrationWsdlLocation Workday WSDL location
Throws
ConnectionException

public DenyBusinessProcessResponseType denyBusinessProcess (DenyBusinessProcessRequestType request)

Denies a business process, if deniable, by the user

Parameters
request Element for the Deny Business Process operation
Returns
  • Wrapper that contains all sub response elements.
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public void disconnect ()

Disconnects

public IntegrationsPort getClient ()

public String getConnectionIdentifier ()

Connection identifier

Returns
  • connection identifier

public GetEIBDefinitionsResponseType getEibDefinitions (GetEIBDefinitionsRequestType eibDefinitionsRequest)

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

Parameters
eibDefinitionsRequest Get EIB Definitions Request
Returns
  • Get EIB Definitions Response
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public GetEventDetailsResponseType getEventDetail (GetEventDetailsRequestType eventDetailRequest)

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

Parameters
eventDetailRequest Get_Event_Details request element
Returns
  • Get_Event_Details response element
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public GetEventDocumentsResponseType getEventDocuments (GetEventDocumentsRequestType eventDocumentsRequest)

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

Parameters
eventDocumentsRequest Get Event Documents Request element
Returns
  • Get Event Documents Response element
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public GetIntegrationEventsResponseType getIntegrationEvents (GetIntegrationEventsRequestType integrationEventsRequest)

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

Parameters
integrationEventsRequest Request element for the Get Integration Events operation
Returns
  • Get Integration Events Response
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public GetIntegrationSystemUsersResponseType getIntegrationSystemUsers (GetIntegrationSystemUsersRequestType integrationSystemUsersRequest)

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

Parameters
integrationSystemUsersRequest Get Integration System Users Request element
Returns
  • response element
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public GetIntegrationSystemsResponseType getIntegrationSystems (GetIntegrationSystemsRequestType integrationSystemsRequest)

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.

Parameters
integrationSystemsRequest Request element used to find and get Integration Systems and their associated data.
Returns
  • Response element containing instances of Integration System and each of its associated data.
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public GetReferencesResponseType getReferences (GetReferencesRequestType referencesRequest)

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

Parameters
referencesRequest Request element
Returns
  • response element
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public GetSequenceGeneratorsResponseType getSequenceGenerators (GetSequenceGeneratorsRequestType sequenceGeneratorsRequest)

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.

Parameters
sequenceGeneratorsRequest Sequence Generator request element.
Returns
  • Response element containing instances of Sequence Generator and each of its associated data.
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public GetSubscriptionsResponseType getSubscriptions (GetSubscriptionsRequestType subscriptionsRequest)

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.

Parameters
subscriptionsRequest Get Subscriptions Request
Returns
  • Get Subscriptions Response
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public String getUsername ()

public IncrementSequenceGeneratorResponseType incrementSequenceGenerator (IncrementSequenceGeneratorRequestType sequenceGeneratorRequest)

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

Parameters
sequenceGeneratorRequest Request element for Increment of Sequence Generator.
Returns
  • Response element for Increment of Sequence Generator.
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public LaunchEIBResponseType launchEib (LaunchEIBRequestType launchEibRequest)

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.

Parameters
launchEibRequest Launch EIB Request
Returns
  • Launch EIB Response
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public LaunchIntegrationEventResponseType launchIntegration (LaunchIntegrationEventRequestType LaunchIntegrationRequest)

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.

Parameters
LaunchIntegrationRequest Launch Integration Event Request
Returns
  • Launch Integration Event Response
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public PutIntegrationEventResponseType putIntegrationEvent (PutIntegrationEventRequestType integrationEvent)

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

Parameters
integrationEvent Integration event request element.
Returns
  • Integration Event response element
Throws
WorkdayException If an error during the operation occurs this exception is thrown.

public PutIntegrationMessageResponseType putIntegrationMessage (PutIntegrationMessageRequestType integrationMessageRequest)

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.

Parameters
integrationMessageRequest Integration Message request element.
Returns
  • Integration Message response element.
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public PutIntegrationSystemResponseType putIntegrationSystem (PutIntegrationSystemRequestType integrationSystemRequest)

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.

Parameters
integrationSystemRequest Integration System request element.
Returns
  • Integration System Response element
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public PutIntegrationSystemUserResponseType putIntegrationSystemUser (PutIntegrationSystemUserRequestType integrationSystemUserRequest)

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

Parameters
integrationSystemUserRequest Put Integration System User Request element
Returns
  • Put Integration System User Response element
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public PutReferenceResponseType putReference (PutReferenceRequestType referenceRequest)

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.

Parameters
referenceRequest Request element for Put Reference.
Returns
  • Response element for Put Reference.
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public PutSequenceGeneratorResponseType putSequenceGenerator (PutSequenceGeneratorRequestType sequenceGeneratorRequest)

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.

Parameters
sequenceGeneratorRequest Sequence Generator Request element
Returns
  • Sequence Generator Response element
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public PutSubscriptionResponseType putSubscription (PutSubscriptionRequestType subscriptionRequest)

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.

Parameters
subscriptionRequest Put Subscription Request
Returns
  • Put Subscription Response
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public RescindBusinessProcessResponseType rescindBusinessProcess (RescindBusinessProcessRequestType rescindBusinessProcessRequest)

Rescinds a business process, if rescindable by the user

Parameters
rescindBusinessProcessRequest Rescind Business Process Request
Returns
  • Rescind Business Process Response
Throws
WorkdayException If an error during the operation occurs this exception is thrown

public void setClient (Object client)

Parameters
client

public void setClient (IntegrationsPort client)

Parameters
client

public void setUsername (String username)

Parameters
username

public boolean validateConnection ()

Validate connection

Returns
  • true if the connector is connected