org.mule.modules

mule-module-workday

config

Namespacehttp://www.mulesoft.org/schema/mule/wd-identity
Schema Locationhttp://www.mulesoft.org/schema/mule/wd-identity/current/mule-wd-identity.xsd  (View Schema)
Schema Version2.0
Minimum Mule Version3.4

Module Overview

The Identity Management Web Service contains operations that relate to Workday Identity and Access Management.

Summary

Configuration
<wd-identity:config>
Configure an instance of this module
Message Processors
<wd-identity:get-unidentified-signons>
Gets all Unidentified Signon attempts for the specified criteria.
<wd-identity:get-workday-account-signons>
Gets all Signon or Signon attempts for the specified criteria when the provided User Name was associated with a valid Workday Account.

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-identity="http://www.mulesoft.org/schema/mule/wd-identity"
      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-identity
               http://www.mulesoft.org/schema/mule/wd-identity/current/mule-wd-identity.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-identity: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
NameDefault ValueDescriptionJava TypeMIME TypeEncoding
config-ref Optional. Specify which configuration to use.
identityUser Workday user String */* UTF-8
identityPassword Workday password String */* UTF-8
identityEndpoint Workday endpoint String */* UTF-8
identityWsdlLocation https://community.workday.com/custom/developer/API/Identity_Management/v20/Identity_Management.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:

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-identity:config>
         <reconnect count="5" frequency="1000"/>
    </wd-identity:config>
Reconnect Attributes
NameDefault ValueDescription
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-identity:get-unidentified-signons>

Gets all Unidentified Signon attempts for the specified criteria. An Unidentified Signon is an attempt to authenticate with a user name that is not associated with a valid Workday Account. The response includes specific information about the Unidentified Signon including the Signon DateTime and User Name. The time range specified in the request criteria must be less than 24 hours. The operation does not support criteria based requests with an As_Of_Entry_DateTime in the past, unless for paging consistency the As_Of_Entry_DateTime matches the page 1 request.

XML Sample
INCLUDE_ERROR

Attributes
NameDefault ValueDescriptionJava TypeMIME TypeEncoding
config-ref Optional. Specify which configuration to use.
unidentifiedSignonsRequest #[payload] Optional. Request element GetUnidentifiedSignonsRequestType */*
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.
identityUser Optional. Workday user String */* UTF-8
identityPassword Optional. Workday password String */* UTF-8
identityEndpoint Optional. Workday endpoint String */* UTF-8
identityWsdlLocation https://community.workday.com/custom/developer/API/Identity_Management/v20/Identity_Management.wsdl Optional. Workday WSDL location String */* UTF-8
Returns
Return Type Description
GetUnidentifiedSignonsResponseType response element
Exception Payloads
Payload ClassDescription
WorkdayException If an error during the operation occurs this exception is thrown

<wd-identity:get-workday-account-signons>

Gets all Signon or Signon attempts for the specified criteria when the provided User Name was associated with a valid Workday Account. Signon attempts where an unidentified (invalid) User Name was provided are not included. The response includes specific information about the Signon including the Signon DateTime, the Signon IP Address and the associated Workday Account. The time range specified in the request criteria must be less than 24 hours. The operation does not support criteria based requests with an As_Of_Entry_DateTime in the past, unless for paging consistency the As_Of_Entry_DateTime matches the page 1 request.

XML Sample
INCLUDE_ERROR

Attributes
NameDefault ValueDescriptionJava TypeMIME TypeEncoding
config-ref Optional. Specify which configuration to use.
workdayAccountSignonsRequest #[payload] Optional. Request element GetWorkdayAccountSignonsRequestType */*
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.
identityUser Optional. Workday user String */* UTF-8
identityPassword Optional. Workday password String */* UTF-8
identityEndpoint Optional. Workday endpoint String */* UTF-8
identityWsdlLocation https://community.workday.com/custom/developer/API/Identity_Management/v20/Identity_Management.wsdl Optional. Workday WSDL location String */* UTF-8
Returns
Return Type Description
GetWorkdayAccountSignonsResponseType response element
Exception Payloads
Payload ClassDescription
WorkdayException If an error during the operation occurs this exception is thrown

Message Sources

Transformers