payroll advice adapter - amazon web servicesec2-54-235-97-194.compute-1.amazonaws.com/... · the...

Payroll Advice Adapter


ContentsPayroll Advice Adapter 2

Commercial In Confidence 3

Payroll Advice Adapter 4

Overview 4

Process 4

OAGIS Message 4

Foreign Keys 5

Concurrent Updates 5

Methods 5

Process 5

Process Message Mapping - ProcessPayrollAdviceHeader 5

Notes 5

Process Message Mapping - ProcessPayrollAdviceEmployee 6

Notes 8

Cancel 9

Cancel Message Mapping 9

Notes 9

Message Examples 9

Process 9

Cancel 14

Commercial In ConfidenceCopyright 2016 ABB

All Rights Reserved

Confidential and Proprietary

Legal Disclaimer

The product described in this documentation may be connected to, and/or communicate information and data via, a networkinterface, which should be connected to a secure network. It is your sole responsibility to ensure a secure connection to thenetwork and to establish and maintain appropriate measures (such as but not limited to the installation of firewalls, applicationof authentication measures, encryption of data, installation of antivirus programs, etc.) to protect the product, the network,your systems, and the interface against any kind of security breach, unauthorised access, interference, intrusion, leakage,damage, or corruption or theft of data. We are not liable for damages or losses related to any such security breach,unauthorised access, interference, intrusion, leakage, damage, or corruption or theft of data.


OverviewThe Payroll Advice adapter is used to provide the output from payroll processing by a 3rd party payroll application for eachemployee. For the Payroll Advice adapter, the Ellipse business elements outlined below can be updated:

• PayAdviceHeader (MSF8P1)

• PayAdviceEmployee (MSF8P4)

• PayAdviceEmpEarning (MSF8P9)

• PayAdviceEmpDeduction (MSF8PA)

• PayAdviceEmpBanking (MSF8PB)

• PayAdviceLeave (MSF8PD)

• PayAdviceMessage (MSF8PC)

• PayAdviceEmpPTDEarning (MSF8P5)

• PayAdviceEmpPTDDeduction (MSF8P6)

• PayAdviceEmpYTDTax (MSF8P7)

• PayAdviceEmpTax (MSF8P8)

ProcessThe Payroll Advice adapter has been developed to operate within an end-to-end integration solution with an external Payrollsystem. This assumes that relevant Ellipse data (Employees, Master Data, Employee Leave and Payroll Transactions) has beenpassed to the external Payroll system for processing. This data can be passed via relevant EIP adapters, Personnel, PersonnelLeave, Payroll Transaction and Payroll Master. The Payroll Advice adapter allows for the update of the Pay Advice Employeerelated tables with the details for an employee in Ellipse from a payroll run performed in an external Payroll system. A ProcessPayroll Advice Header message for a payroll run must firstly be sent from the external Payroll system and received in Ellipse.This will indicate that the payroll run processing was successfully completed and cater for Employee Self Service (ESS)processing in Ellipse. Ellipse will provide an acknowledgement message for the Payroll Advice Header process message, whichwill contain the unique payroll run id (created in Ellipse) for this payroll run. The related Process Pay Advice Employeemessages for each employee processed in that payroll run can then be sent in any order. The Process Pay Advice Employeemessages for each employee MUST include the unique payroll run id created in Ellipse, this is to allow Ellipse to associate theProcesss Pay Advice Employee messages for each employee with the correct payroll run.

It is assumed that with this solution, any manual Payroll runs will ONLY be processed in the external Payroll system. It is furtherassumed that manual Payroll runs will ONLY be processed in the external Payroll system AFTER the update payroll run has beenprocessed in the external Payroll system AND the details of that have been returned to Ellipse. Where a manual Payroll run isprocessed the external Payroll system, the details can be returned to Ellipse and will be consolidated with the last updatepayroll run details. NB. Any manual Payroll run will always be consilidated into the last update payroll run for the nominatedPay Group.

Where an update Payroll run is processed in the external Payroll system and is then incorrectly passed to Ellipse, there exists aCancelPayrollAdviceHeader message that can be passed to the Payroll Advice Adapter to delete this information in Ellipse.

NoteNote that Ellipse only holds one Payroll run per period, if a subsequent Payroll run is attempted to be updated into thecurrent Ellipse period an error will be returned.

OAGIS MessageThe Payroll Advice adapter will accept 2 messages, a ProcessPayrollAdviceHeader message and aProcessPayrollAdviceEmployee message.

PayrollAdviceHeader noun

The OAGIS standard does not contain a noun called PayAdviceRun, so an Ellipse PayAdviceRun noun has been created. Onlysome of the Ellipse attributes held for a PayAdviceRun record can be mapped to OAGIS attributes. Where Ellipse attributescannot be mapped to OAGIS attributes, then our own attribute names have been devised.

PayAdviceEmployee noun

The OAGIS standard does not contain a noun called PayAdviceEmployee, so an Ellipse PayAdviceEmployee noun has beencreated. Only some of the Ellipse attributes held for a PayAdviceEmployee record can be mapped to OAGIS attributes. WhereEllipse attributes cannot be mapped to OAGIS attributes, then our own attribute names have been devised.

The OAGIS verb Process (and Acknowledge) will also be supported for both nouns. In addition the OAGIS verb Cancel will alsobe supported for PayrollAdviceHeader.

Foreign KeysN/A

Concurrent UpdatesN/A

Methods

ProcessThe Process method for the Payroll Advice adapter will update Ellipse with payroll run details from an external Payroll system.The adapter will handle messages relating to the payroll run itself (ProcessPayrollAdviceHeader) and for each Employee(ProcessPayrollAdviceEmployee).

The Process method for a ProcessPayrollAdviceHeader message will call the following Ellipse service to process the datapassed:

• PayAdviceHeaderThe Process method for a ProcessPayrollAdviceEmployee message will call the following Ellipse services to process the datapassed:

• PayAdviceEmployee

• PayAdviceEmpEarning

• PayAdviceEmpDeduction

• PayAdviceEmpBanking

• PayAdviceLeave

• PayAdviceMessage

• PayAdviceEmpPTDEarning

• PayAdviceEmpPTDDeduction

• PayAdviceEmpYTDTax

• PayAdviceEmpTaxThe process of processing payroll advice messages into Ellipse will potentially involve large numbers of messages beingprocessed. To manage this without impacting processing of other messages, separate queues have been implemented tochannel the payroll advice messages. The payroll advice messages will be processed over the MIB.PAYROLL.ACK queue. TheAcknowledgePayrollAdviceHeader and AcknowledgePayrollAdviceEmployee messages with the response for the payroll adviceupdates into Ellipse will be output to the MIB.COMMON.REPLY queue.

Multiple Payroll Advice Entries

Multiple Payroll Advice process requests in a single ProcessPayrollAdviceHeader or ProcessPayrollAdviceEmployee message willNOT be supported.

Process Message Mapping - ProcessPayrollAdviceHeaderMapping of ABB ProcessPayrollAdviceHeader message attributes to Ellipse web services:

Field Description Service Attribute<PayAdviceHeader> PayAdviceHeader <WageGroupCode>string Pay Group ID paygroup <Extension> <ExternalPayrollName>string Name of Payroll system. externalPayrollName <PayRunID>string Pay Run Number. payRunNo <PayRunType>string Pay Run Type. payRunType </Extension></PayAdviceHeader>

NotesRequired Attributes

As a minimum the following attributes MUST be passed to Ellipse:

• PayGroup

• PayRunTypePayGroup

The PayGroup value passed to Ellipse from the external Payroll system must correspond with a Pay Group ID passed fromEllipse as part of the Payroll adapter messages.

PayRunType

The PayRunType values that can be passed to Ellipse are as follows:

• M: Manual

• U: UpdateWhere a PayRunType is not passed to Ellipse the value will be defaulted to 'U'.

PayRunID

The PayRunID caters for a number from 0-999. Value treated as information only, Ellipse will determine the actual Pay Run Nofor the Pay Group.

ExternalPayrollName

The ExternalPayrollName caters for a string up to 40 characters. An ExternalPayrollName is additional information to identifythe external Payroll system.

Process Message Mapping - ProcessPayrollAdviceEmployeeMapping of ABB ProcessPayrollAdviceEmployee message attributes to Ellipse web services:

Field Description Service Attribute<PayAdviceEmployee> <Employee> PayAdviceEmployee <ID>string Employee Id value. employee </Employee> <WageGroupCode>string Ellipse pay group code. paygroup <Extension> <Banking> PayAdviceEmpBanking <Account> <Code>string Bank account number. bankAccountNo <Name>string Bank account name. bankAccountName <Type>string Bank account type. bankAccountType <Description>string Bank account description. bankAccountDesc </Account <Amount>decimal Disbursement amount. bankDisbursementAmount <BankDescription>string Bank description. bankDesc <BankingType>string Banking type. bankingType <Branch> <Code>string BSB code. branchCode <Name>string Branch name. branchName </Branch <EnvelopeType>string Envelope type value. envelopeType </Banking> <Deduction> PayAdviceEmpDeduction <Amount>decimal Transaction amount. deductionAmount <Code>string Deduction code. deductionCode <DefaultSupplierInd>string Default supplier indicator. defaultSupplierInd <EnvelopeType>string Envelope type value. envelopeType <Quantity>decimal Transaction time units. tranUnits <Reference1>string Reference 1. reference <Reference1>string Reference 2. referenceB <SupplierID>string Supplier number. supplierNo <WorkTimePeriod> <StartDateTime>date Transaction Date. tranDate </WorkTimePeriod> </Deduction> <Earnings> PayAdviceEmpEarning <Amount>decimal Transaction amount. tranAmount <AnnualRateAmount>decimal Annual Rate applicable to transaction. annualRate <Code>string Earnings code. earningsCode <DailyRateAmount>decimal Daily Rate applicable to transaction. dailyRate <EnvelopeType>string Envelope type value. envelopeType <ExtendedQuantity>decimal Transaction units times factor. equivalentUnits <HigherDuties> <RateAmount>decimal HD rate amount applicable to transaction. hdRateRefRate <RateTypeCode>string HD rate reference code value. hdRateRefCode </HigherDuties> <HourlyRateAmount>decimal Hourly Rate applicable to transaction. hourlyRate <Quantity>decimal Transaction time units tranUnits <RateAmount>decimal Rate amount applicable to transaction. tranRate <RateTypeCode>string Rate reference code value. rateRefCode

<WeeklyRateAmount>decimal Weekly Rate applicable to transaction. weeklyRate <WorkTimePeriod> <StartDateTime>date Transaction Date. tranDate </WorkTimePeriod> </Earnings> <Leave> PayAdviceLeave <Accrued>decimal Leave accrued. leaveAccrued <Amount>decimal Leave amount. leaveAmount <Balance>decimal Leave balance. leaveBalance <DueDate>date Due date. dueDate <Entitlement>decimal Leave entitlement. leaveEntitlement <ExpiryDate>date Expiry date. expiryDate <PayoutInd>string Leave Payout indicator (E/A). leavePayoutInd <Type>string Leave type. leaveType <UnitType>string Leave Unit of Measure. unitType </Leave> <Message> PayAdviceMessage <MessageText>string Message text. payslipMessage <Type>string Message type. messageType </Message> <PayRunType>string Ellipse pay run type (U-Update,M-Manual,P-Preview). payRunType <PayRunNumber>string Ellipse pay run number. payRunNo <PayRunUUID>string Unique Ellipse identifier for a Pay Run. payAdvHdrUuid <PTDDeduction> PayAdviceEmpPTDDeduction <CalendarYearToDate> <Amount>decimal Calendar YTD amount. calendarYearToDateAmount <Quantity>decimal Calendar YTD units. calendarYearToDateUnits </CalendarToDate> <Code>string Deduction code. deductionCode <DeductionGoal> <LimitAmount>decimal Reducing balance for deduction. reducingBalance </DeductionGoal> <FiscalYearToDate> <Amount>decimal Fiscal YTD amount. fiscalYearToDateAmount <Quantity>decimal Fiscal YTD units. fiscalYearToDateUnits </FiscalYearToDate> <MonthToDate> <Amount>decimal Month to date amount. monthToDateAmount <Quantity>decimal Month to date units. monthToDateUnits </MonthToDate> <QuarterToDate> <Amount>decimal Quarter to date amount. quarterToDateAmount <Quantity>decimal Quarter to date units. quarterToDateUnits </QuarterToDate> <TaxYearToDate> <Amount>decimal Tax YTD amount. taxYearToDateAmount <Quantity>decimal Tax YTD units. taxYearToDateUnits </TaxYearToDate> </PTDDeduction> <PTDEarnings> PayAdviceEmpPTDEarning <CalendarYearToDate> <Amount>decimal Calendar YTD amount. calendarYearToDateAmount <Quantity>decimal Calendar YTD units. calendarYearToDateUnits </CalendarToDate> <Code>string Earnings code. earningsCode <FiscalYearToDate> <Amount>decimal Fiscal YTD amount. fiscalYearToDateAmount <Quantity>decimal Fiscal YTD units. fiscalYearToDateUnits </FiscalYearToDate> <MonthToDate> <Amount>decimal Month to date amount. monthToDateAmount <Quantity>decimal Month to date units. monthToDateUnits </MonthToDate> <QuarterToDate> <Amount>decimal Quarter to date amount. quarterToDateAmount <Quantity>decimal Quarter to date units. quarterToDateUnits </QuarterToDate> <TaxYearToDate> <Amount>decimal Tax YTD amount. taxYearToDateAmount <Quantity>decimal Tax YTD units. taxYearToDateUnits </TaxYearToDate> </PTDEarnings> <Tax> PayAdviceEmpTax <AuthorityCode>string Tax authority code. taxAuthCode <AuthorityLevel>string Tax authority level. taxAuthLevel <Benefits>decimal Non-taxable benefits amount. nonTaxableBenefitsAmount <EEERIndicator>string Employee/Employer indicator. taxEmployeeEmployerInd <FederalID>string Federal Id. federalId

<Gross>decimal Taxable Gross amount. taxableGross <NetAmount>decimal Net amount. netAmount <TaxAmount>decimal Tax amount. taxAmount <TotalGross>decimal Total Gross amount. totalGross <USType>string US tax type. usTaxType </Tax> <YTDTax> PayAdviceEmpYTDTax <AuthorityCode>string Tax authority code. taxAuthCode <AuthorityLevel>string Tax authority level. taxAuthLevel <Benefits>decimal YTD Non-taxable benefits. ytdNonTaxableBenefits <EEERIndicator>string Employee/Employer indicator. taxEmployeeEmployerInd <FederalID>string Federal Id. federalId <Gross>decimal YTD Taxable Gross amount. ytdTaxableGross <NetAmount>decimal YTD Net amount. ytdNet <TaxAmount>decimal YTD Tax amount. ytdTax <TotalGross>decimal YTD Total Gross amount. ytdTotalGross <USType>string US tax type. usTaxType </YTDTax> </Extension>



• EmployeeID

• PayRunUUID (returned in acknowledgement response message for process PayAdviceHeader request message).Minimum attributes reqd for each web service request (in addition to above):

Banking

Branch Code - branchCode

Bank Account Number - bankAccountNo

Bank Account Name - bankAccountName

Amount - bankDisbursementAmount

EnvelopeType - envelopeType - for allowable values refer PENV table, if not passed default to space.

bankingType enumeration:

A - Bank

B - Bank

C - Cash

L - Bank and Deduction

Q - Cheque

Deduction

Amount - deductionAmount

Code - deductionCode

Date - tranDate

EnvelopeType - envelopeType - for allowable values refer PENV table, if not passed default to space.

Quantity - tranUnits, if not passed default to 1.

Earnings

Amount - tranAmount

Code - earningsCode

Date - tranDate

EnvelopeType - envelopeType allowable values A, T, etc refer PENV table, if not passed default to space.

Quantity - tranUnits, if not passed default to 1.

RateAmount - tranRate

Leave

Leave type - leaveType

Leave Unit of Measure - unitType

Message

Message text - payslipMessage

Message type - messageType

PTDDeduction

Deduction code - deductionCode

PTDEarnings

Earnings code - earningsCode

Tax (US only)

Federal Id - federalId

Tax Authority Code - taxAuthCode

US Tax Type - usTaxType

TaxYTD (US only)

Federal Id - federalId

Tax Authority Code - taxAuthCode

US Tax Type - usTaxType

CancelThe Cancel method for the Payroll Advice adapter will remove from Ellipse payroll run details from an external Payroll system.The adapter will remove data relating to the payroll run itself and for all Employees.

The Cancel method for a CancelPayrollAdviceHeader message will call the following Ellipse service to process the data passed:

• PayAdviceHeaderFor consistency with processing of payroll advice messages, CancelPayrollAdviceHeader messages will be processed over theMIB.PAYROLL.ACK queue. ConfirmBOD messages with the response for the payroll advice updates into Ellipse will be output tothe MIB.COMMON.REPLY queue.

Multiple Payroll Advice Entries

Multiple Payroll Advice Header cancel requests in a single CancelPayrollAdviceHeader message will NOT be supported.

Cancel Message MappingMapping of ABB CancelPayrollAdviceHeader message attributes to Ellipse web services:

Field Description Service Attribute<PayAdviceHeader> PayAdviceHeader <WageGroupCode>string Pay Group ID paygroup <Extension> <PayRunUUID>string Pay Run UUID value. payAdvHdrUuid </Extension></PayAdviceHeader>



• PayGroup

• PayRunUUIDPayGroup

The PayGroup value passed to Ellipse from the external Payroll system must correspond with a Pay Group ID passed fromEllipse as part of the Payroll adapter messages.

PayRunUUID

The PayRunUUID value passed to Ellipse from the external Payroll system must correspond with the PayRunUUID returned inthe AcknowledgeayrollAdviceHeader returned from Ellipse for the relavent ProcessPayrollAdviceHeader passed to Ellipse.

Message Examples

ProcessProcess a Payroll Advice Header.

<?xml version="1.0" encoding="UTF-8"?><ProcessPayrollAdviceHeader xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ip="http://www.ventyx.com/IP/1" xsi:noNamespaceSchemaLocation="file:///C:/git-clones/mib/mib-common/schema/IP/1_0_0/BODs/ProcessPayrollAdviceHeader.xsd"> <ApplicationArea> <ip:Sender> <ip:LogicalID>PayrollAdviceHeader</ip:LogicalID> <ip:TaskID>ProcessPayrollAdviceHeader</ip:TaskID> <ip:ReferenceID>Process Test</ip:ReferenceID> </ip:Sender> <ip:Receiver/> <ip:CreationDateTime>2014-06-04T11:17:03</ip:CreationDateTime> <ip:BODID>JUnit Test</ip:BODID> <ip:Extension> <ip:AnyExtension> <ip:ServiceContext> <ip:ServiceName>ProcessPayrollAdviceHeader</ip:ServiceName> <ip:ServiceVersion>1.0</ip:ServiceVersion> <ip:MessageType>PayrollAdviceHeader</ip:MessageType> <ip:DocumentName>PayrollAdvice</ip:DocumentName> </ip:ServiceContext> <ip:AuthorizationContext> <ip:Proxy> <ip:UserID>INTEGRAT</ip:UserID> <ip:OrgID>R100</ip:OrgID> <ip:Role>INTEGRAT</ip:Role> </ip:Proxy> </ip:AuthorizationContext> </ip:AnyExtension> </ip:Extension> </ApplicationArea> <DataArea> <Process/> <PayrollAdviceHeader> <WageGroupCode>PW1</WageGroupCode> <Extension> <PayRunID>032</PayRunID> <PayRunType>U</PayRunType> </Extension> </PayrollAdviceHeader> </DataArea></ProcessPayrollAdviceHeader>

Acknowledge Payroll Advice Header message returned:<?xml version="1.0" encoding="UTF-8"?><AcknowledgePayrollAdviceHeader xmlns:ip="http://www.ventyx.com/IP/1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:oa="http://www.openapplications.org/oagis/10" xsi:noNamespaceSchemaLocation="file:///C:/git-clones/mib/mib-common/schema/IP/1_0_0/BODs/AcknowledgePayrollAdviceHeader.xsd"> <ApplicationArea> <ip:Sender> <ip:LogicalID>Ellipse</ip:LogicalID> <ip:ComponentID>PayrollAdviceHeader</ip:ComponentID> <ip:TaskID>AcknowledgePayrollAdviceHeader</ip:TaskID> <ip:ReferenceID>RequestID</ip:ReferenceID> </ip:Sender> <ip:Receiver> <ip:LogicalID/> </ip:Receiver> <ip:CreationDateTime>2014-10-13T08:39:37</ip:CreationDateTime> <ip:BODID>b147ebea-8b4e-4b86-8aaa-157ace9b0eda</ip:BODID> <ip:Extension> <ip:AnyExtension> <ip:ServiceContext> <ip:ServiceName>AcknowledgePayrollAdviceHeader</ip:ServiceName> <ip:ServiceVersion>1.0</ip:ServiceVersion> <ip:MessageType>PayrollAdviceHeader</ip:MessageType> </ip:ServiceContext> <ip:AuthorizationContext/> </ip:AnyExtension> </ip:Extension> </ApplicationArea> <DataArea> <Acknowledge> <oa:ResponseCriteria xmlns:oa="http://www.openapplications.org/oagis/10"> <oa:ResponseExpression expressionLanguage="XPath" actionCode="Accepted">[*]</oa:ResponseExpression> <oa:ChangeStatus> <oa:Code>OK</oa:Code> <oa:Description>Process header for pay group PW1.</oa:Description> <oa:ReasonCode>processPayrollAdviceHeader</oa:ReasonCode>

<oa:Reason/> </oa:ChangeStatus> </oa:ResponseCriteria>

</Acknowledge> <PayrollAdviceHeader> <WageGroupCode>PW1</WageGroupCode> <Extension> <PayRunType>U</PayRunType> <PayRunID>002</PayRunID> <PayRunUUID>2A2F21241788452698496990B8BA2022</PayRunUUID> </Extension> </PayrollAdviceHeader> </DataArea></AcknowledgePayrollAdviceHeader>

Process a Payroll Advice Employee.<?xml version="1.0" encoding="UTF-8"?><ProcessPayrollAdviceEmployee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ip="http://www.ventyx.com/IP/1" xsi:noNamespaceSchemaLocation="file:///C:/git-clones/mib/mib-common/schema/IP/1_0_0/BODs/ProcessPayrollAdviceEmployee.xsd"> <ApplicationArea> <ip:Sender> <ip:LogicalID>PayrollAdviceEmployee</ip:LogicalID> <ip:TaskID>ProcessPayrollAdviceEmployee</ip:TaskID> <ip:ReferenceID>Process Test</ip:ReferenceID> </ip:Sender> <ip:Receiver/> <ip:CreationDateTime>2014-06-04T11:17:03</ip:CreationDateTime> <ip:BODID>JUnit Test</ip:BODID> <ip:Extension> <ip:AnyExtension> <ip:ServiceContext> <ip:ServiceName>ProcessPayrollAdviceEmployee</ip:ServiceName> <ip:ServiceVersion>1.0</ip:ServiceVersion> <ip:MessageType>PayrollAdviceEmployee</ip:MessageType> <ip:DocumentName>PayrollAdvice</ip:DocumentName> </ip:ServiceContext> <ip:AuthorizationContext> <ip:Proxy> <ip:UserID>INTEGRAT</ip:UserID> <ip:OrgID>R100</ip:OrgID> <ip:Role>INTEGRAT</ip:Role> </ip:Proxy> </ip:AuthorizationContext> </ip:AnyExtension> </ip:Extension> </ApplicationArea> <DataArea> <Process/> <PayrollAdviceEmployee> <Employee> <ID>A0000014</ID> </Employee> <WageGroupCode>WK1</WageGroupCode> <Extension> <Banking> <Account> <Code>1234AA</Code> <Name>BLOGGS</Name> <Type>S</Type> <Description>CRD</Description> </Account> <Amount>128.75</Amount> <BankDescription>NAB</BankDescription> <BankingType>B</BankingType> <Branch> <Code>7722</Code> <Name>National</Name> </Branch> <EnvelopeType>A</EnvelopeType> </Banking> <Banking> <Account> <Code>1234BA</Code> <Name>BLOGGS</Name> <Type>S</Type> <Description>SAV</Description> </Account> <Amount>128.75</Amount> <BankDescription>COM</BankDescription>

<BankingType>C</BankingType> <Branch> <Code>8822</Code> <Name>Commonwealth</Name>

</Branch> <EnvelopeType>A</EnvelopeType> </Banking> <Deduction> <Amount>234.55</Amount> <Code>082</Code> <DefaultSupplierInd>S</DefaultSupplierInd> <EnvelopeType>A</EnvelopeType> <Quantity>12.5</Quantity> <Reference1>R1</Reference1> <Reference2>R2</Reference2> <SupplierID>ACME1</SupplierID> <WorkTimePeriod> <StartDateTime>2009-06-22</StartDateTime> </WorkTimePeriod> </Deduction> <Earnings> <Amount>734.25</Amount> <AnnualRateAmount>122.75</AnnualRateAmount> <Code>001</Code> <DailyRateAmount>88.85</DailyRateAmount> <EnvelopeType>A</EnvelopeType> <ExtendedQuantity>142.55</ExtendedQuantity> <HigherDuties> <RateAmount>322.75</RateAmount> <RateTypeCode>HD</RateTypeCode> </HigherDuties> <HourlyRateAmount>66.75</HourlyRateAmount> <Quantity>12.5</Quantity> <RateAmount>344.75</RateAmount> <RateTypeCode>RT</RateTypeCode> <WeeklyRateAmount>945.95</WeeklyRateAmount> <WorkTimePeriod> <StartDateTime>2009-08-24</StartDateTime> </WorkTimePeriod> </Earnings> <Earnings> <Amount>754.25</Amount> <AnnualRateAmount>152.75</AnnualRateAmount> <Code>002</Code> <DailyRateAmount>85.85</DailyRateAmount> <EnvelopeType>A</EnvelopeType> <ExtendedQuantity>152.55</ExtendedQuantity> <HigherDuties> <RateAmount>352.75</RateAmount> <RateTypeCode>HD</RateTypeCode> </HigherDuties> <HourlyRateAmount>65.75</HourlyRateAmount> <Quantity>15.5</Quantity> <RateAmount>354.75</RateAmount> <RateTypeCode>RT</RateTypeCode> <WeeklyRateAmount>955.95</WeeklyRateAmount> <WorkTimePeriod> <StartDateTime>2009-08-25</StartDateTime> </WorkTimePeriod> </Earnings> <ExternalPayrollName>SAP01</ExternalPayrollName> <Leave> <Type>A</Type> <Amount>2</Amount> <UnitType>D</UnitType> <Entitlement>20</Entitlement> <Accrued>24</Accrued> <Balance>22</Balance> <PayoutInd>N</PayoutInd> <DueDate>2014-04-30</DueDate> <ExpiryDate>2014-12-30</ExpiryDate> </Leave> <Message> <Text>Well done to you on your pay Ted.</Text> <Type>X</Type> </Message> <PayRunUUID>F1D06CFA80294375BA2A02926C26E1C4</PayRunUUID> <PTDDeduction> <CalendarYearToDate> <Amount>1224.75</Amount> <Quantity>111.15</Quantity> </CalendarYearToDate>

</Tax> <Tax> <AuthorityCode>00000001</AuthorityCode> <AuthorityLevel>6</AuthorityLevel> <Benefits>252.75</Benefits> <EEERIndicator>E</EEERIndicator> <FederalID>987654321</FederalID> <Gross>3522.15</Gross> <NetAmount>2522.15</NetAmount> <TaxAmount>452.65</TaxAmount> <TotalGross>5522.15</TotalGross> <USType>01</USType> </Tax> <YTDTax> <AuthorityCode>00000000</AuthorityCode> <AuthorityLevel>5</AuthorityLevel> <Benefits>252.75</Benefits> <EEERIndicator>E</EEERIndicator> <FederalID>987654321</FederalID> <Gross>3522.15</Gross> <NetAmount>2522.15</NetAmount> <TaxAmount>452.65</TaxAmount> <TotalGross>5522.15</TotalGross> <USType>01</USType> </YTDTax> <YTDTax> <AuthorityCode>00000001</AuthorityCode> <AuthorityLevel>6</AuthorityLevel> <Benefits>262.75</Benefits> <EEERIndicator>E</EEERIndicator> <FederalID>987654321</FederalID> <Gross>3622.15</Gross> <NetAmount>2622.15</NetAmount> <TaxAmount>462.65</TaxAmount> <TotalGross>5622.15</TotalGross> <USType>01</USType> </YTDTax> </Extension> </PayrollAdviceEmployee> </DataArea></ProcessPayrollAdviceEmployee>

Acknowledge Payroll Advice Employee message returned.<?xml version="1.0" encoding="UTF-8"?><AcknowledgePayrollAdviceEmployee xmlns:ip="http://www.ventyx.com/IP/1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="file:///C:/git-clones/mib/mib-common/schema/IP/1_0_0/BODs/AcknowledgePayrollAdviceEmployee.xsd"> <ApplicationArea> <ip:Sender> <ip:LogicalID>Ellipse</ip:LogicalID> <ip:ComponentID>PayrollAdviceEmployee</ip:ComponentID> <ip:TaskID>AcknowledgePayrollAdviceEmployee</ip:TaskID> <ip:ReferenceID>Payroll Advice</ip:ReferenceID> </ip:Sender> <ip:Receiver> <ip:LogicalID/> </ip:Receiver> <ip:CreationDateTime>2014-10-14T11:37:17</ip:CreationDateTime> <ip:BODID>8d3e0fb6-e9ad-4cd3-9675-8a894f4a66dd</ip:BODID> <ip:Extension> <ip:AnyExtension> <ip:ServiceContext> <ip:ServiceName>AcknowledgePayrollAdviceEmployee</ip:ServiceName> <ip:ServiceVersion>1.0</ip:ServiceVersion> <ip:MessageType>PayrollAdviceEmployee</ip:MessageType> </ip:ServiceContext> <ip:AuthorizationContext/> </ip:AnyExtension> </ip:Extension> </ApplicationArea> <DataArea> <Acknowledge> <oa:ResponseCriteria xmlns:oa="http://www.openapplications.org/oagis/10"> <oa:ResponseExpression expressionLanguage="XPath" actionCode="Accepted">[*]</oa:ResponseExpression> <oa:ChangeStatus> <oa:Code>OK</oa:Code> <oa:Description>Process detail for employee A0000010.</oa:Description> <oa:ReasonCode>processPayrollAdviceEmployee</oa:ReasonCode> <oa:Reason/> </oa:ChangeStatus> </oa:ResponseCriteria> </Acknowledge> <PayrollAdviceEmployee> <Employee> <ID>A0000014</ID> </Employee> <WageGroupCode>WK1</WageGroupCode> <Extension> <PayRunID/> <PayRunType/> <PayRunUUID>F1D06CFA80294375BA2A02926C26E1C4</PayRunUUID> </Extension> </PayrollAdviceEmployee> </DataArea></AcknowledgePayrollAdviceEmployee>

CancelCancel Payroll Advice run details.<?xml version="1.0" encoding="UTF-8"?><CancelPayrollAdviceHeader xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ip="http://www.ventyx.com/IP/1" xsi:noNamespaceSchemaLocation="file:///C:/git-clones/mib/mib-common/schema/IP/1_0_0/BODs/CancelPayrollAdviceHeader.xsd"> <ApplicationArea> <ip:Sender>

<ip:LogicalID>PayrollAdviceHeader</ip:LogicalID> <ip:TaskID>CancelPayrollAdviceHeader</ip:TaskID> <ip:ReferenceID>Cancel Test</ip:ReferenceID> </ip:Sender> <ip:Receiver/> <ip:CreationDateTime>2014-06-04T11:17:03</ip:CreationDateTime> <ip:BODID>JUnit Test</ip:BODID> <ip:Extension> <ip:AnyExtension> <ip:ServiceContext> <ip:ServiceName>CancelPayrollAdviceHeader</ip:ServiceName> <ip:ServiceVersion>1.0</ip:ServiceVersion> <ip:MessageType>PayrollAdviceHeader</ip:MessageType> <ip:DocumentName>PayrollAdvice</ip:DocumentName> </ip:ServiceContext> <ip:AuthorizationContext> <ip:Proxy> <ip:UserID>INTEGRAT</ip:UserID> <ip:OrgID>R100</ip:OrgID> <ip:Role>INTEGRAT</ip:Role> </ip:Proxy> </ip:AuthorizationContext> </ip:AnyExtension> </ip:Extension> </ApplicationArea> <DataArea> <Cancel/> <PayrollAdviceHeader> <WageGroupCode>PF1</WageGroupCode> <Extension> <PayRunUUID>11E6526F9B514306907B80DF2943E42D</PayRunUUID> </Extension> </PayrollAdviceHeader> </DataArea></CancelPayrollAdviceHeader>

Confirm BOD message returned:<?xml version="1.0" encoding="UTF-8"?><ConfirmBOD releaseID="10" xmlns="http://www.openapplications.org/oagis/10" xmlns:oa="http://www.openapplications.org/oagis/10" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <ApplicationArea> <Sender> <LogicalID>Ellipse</LogicalID> <TaskID>ConfirmBOD</TaskID> <ReferenceID></ReferenceID> <AuthorizationID></AuthorizationID> </Sender> <CreationDateTime>2014-10-13T11:44:39</CreationDateTime> <BODID>f21a3c8f-942f-4d50-abeb-5c08148538fb</BODID> <Extension> <AnyExtension> <ip1:ServiceContext xmlns:ip1="http://www.ventyx.com/IP/1"> <ip1:ServiceName>CancelPayrollAdviceHeader</ip1:ServiceName> <ip1:ServiceVersion>1.0</ip1:ServiceVersion> <ip1:MessageType>PayrollAdviceHeader</ip1:MessageType> </ip1:ServiceContext> <ip1:AuthorizationContext xmlns:ip1="http://www.ventyx.com/IP/1"> </ip1:AuthorizationContext> </AnyExtension> </Extension> </ApplicationArea> <DataArea> <Confirm> <oa:ResponseCriteria xmlns:oa="http://www.openapplications.org/oagis/10"> <oa:ResponseExpression expressionLanguage="XPath" actionCode="Accepted">[*]</oa:ResponseExpression> <oa:ChangeStatus> <oa:Code>OK</oa:Code> <oa:Description>Cancel header for pay group PF1.</oa:Description> <oa:ReasonCode>cancelPayrollAdviceHeader</oa:ReasonCode> <oa:Reason></oa:Reason> </oa:ChangeStatus> </oa:ResponseCriteria> </Confirm> <BOD></BOD> </DataArea></ConfirmBOD>

payroll advice adapter - amazon web servicesec2-54-235-97-194.compute-1.amazonaws.com/... · the...

Documents