org.mule.modules

mule-module-workday

2.2
Namespacehttp://www.mulesoft.org/schema/mule/wd-payroll
Schema Locationhttp://www.mulesoft.org/schema/mule/wd-payroll/2.0/mule-wd-payroll.xsd
Version2.0
Minimum Mule Version3.2

Module Overview

The Workday Payroll Module contains operations that expose Workday Payroll data for integration with third parties (such as time and attendance).

Summary

Configuration
<wd-payroll:config>
Configure an instance of this module
Message Processors
<wd-payroll:put-payroll-federal-w4-tax-election>
Put worker federal W-4 tax election data.

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-payroll="http://www.mulesoft.org/schema/mule/wd-payroll"
      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-payroll
               http://www.mulesoft.org/schema/mule/wd-payroll/2.0/mule-wd-payroll.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
TypeNameDefault ValueDescription
xs:string name Optional. Give a name to this configuration so it can be later referenced.
xs:string endpoint The payroll endpoint.
xs:string password The Workday account's password
xs:string username The Workday account's username

Message Processors

<wd-payroll:put-payroll-federal-w4-tax-election>

Put worker federal W-4 tax election data.

XML Sample
INCLUDE_ERROR

Attributes
NameDefault ValueDescription
config-ref Optional. Specify which configuration to use.
lockInLetter false Lock in Letter Indicator on the W-4
noWageNoTax false No Wage/No Tax Indicator on the W-4
nonresidentAlien false Nonresident Alien Indicator on the W-4
exempt false Exempt Indicator on the W-4
additionalAmount Optional. Additional Amount on the W-4
numberOfAllowances Optional. The Number of Allowances on the W-4
effectiveAsOf Optional. The Effective date of the W-4
Child Elements
<wd-payroll:workerReference>
Optional. Worker the W-4 is for
<wd-payroll:companyReference>
Optional. The Company the W-4 is for
<wd-payroll:maritalStatusReference>
Optional. The Marital Status of the Worker that the W-4 is for
Return Payload
  • a response with The Payroll Payee W-4 instance that is created and the data that should be displayed for the instance of the W-4
Exception Payload
Exception if the operation fails
if operation fails