payroll transaction data adapterec2-54-235-97-194.compute-1.amazonaws.com/documentation/... ·...

15
Payroll Transaction Data Adapter

Upload: others

Post on 18-Jun-2020

0 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: Payroll Transaction Data Adapterec2-54-235-97-194.compute-1.amazonaws.com/documentation/... · 2016-11-16 · Payroll Transaction Data Adapter Overview The Payroll Transaction adapter

Payroll Transaction Data Adapter

Page 2: Payroll Transaction Data Adapterec2-54-235-97-194.compute-1.amazonaws.com/documentation/... · 2016-11-16 · Payroll Transaction Data Adapter Overview The Payroll Transaction adapter

Payroll Transaction Data Adapter

ContentsPayroll Transaction Data Adapter 2

Commercial In Confidence 3

Payroll Transaction Data Adapter 4

Overview 4

Valued Transactions 4

Process 4

Publication 4

Events 5

Timer 5

OAGIS Message 5

Foreign Keys 5

Concurrent Updates 5

Methods 5

Notify 5

Notify Message Mapping 6

Post Message Mapping 6

Acknowledge 7

Ack Message Mapping 7

Notes 7

Message Examples 8

Notify 8

Post 8

Acknowledge 12

Page 3: Payroll Transaction Data Adapterec2-54-235-97-194.compute-1.amazonaws.com/documentation/... · 2016-11-16 · Payroll Transaction Data Adapter Overview The Payroll Transaction adapter

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.

Page 4: Payroll Transaction Data Adapterec2-54-235-97-194.compute-1.amazonaws.com/documentation/... · 2016-11-16 · Payroll Transaction Data Adapter Overview The Payroll Transaction adapter

Payroll Transaction Data Adapter

OverviewThe Payroll Transaction adapter is used to provide the input to payroll processing by a 3rd party payroll application. The payrollprocessing will determine the salary to be paid to an employee for a period of time worked. The Work Time details are passedas valued entries. Ellipse supports processing of non-valued and valued entries, for external payroll processing valued entriesare passed. This ensures that the valued data is available if required. For the Payroll Transaction adapter, the Ellipse businesselements outlined below can be accessed:

• PayrollHistoryThe information includes a Employee details, payroll factors, worked periods, absence periods, costing allocations and worklocations.

Valued TransactionsFor valued transactions the adapter relies on the Ellipse Payroll Transaction History (MSF835) being generated prior toprocessing. This includes transactions generated by the Roster Generate (MSB890), Timeekeeping (MSE891), Leave Request(MSE888) and Payroll Transactions entry applications (MSO832, MSO89F, MSO83M). All these processes will create the date tobe processed in this interface. The Employee Payroll Transactions History table (MSF835) contains raw payroll transaction data(Time and Units) generated by the above processes utilising the employee details, configuration and award interpretationprocess. The external Payroll system will receive a complete set of work time transactions for an Ellipse Employee. The externalPayroll system will be required to acknowledge the work time transaction group as either having been successfully processedor not. The status of the work time transaction group in Ellipse will be updated to reflect the processing in the external Payrollsystem for ease of reconciliation.

ProcessThe Payroll Transaction adapter has been developed to operate within an end-to-end integration solution with an externalPayroll system.

An overview of the expected end-to-end process is as follows:

• Work Time Transactions are created via the roster generation, timekeeping, award interpretation and manual time entryprocesses.

• These transactions are marked with a status of 'PEND' (Pending Processing), which indicates that they are ready toexport.

• The Payroll Transaction adapter pushes ready to export work time transaction data to the external Payroll system .

• These transactions are then marked with a status of 'SENT', indicating that they have been sent to external Payrollsystem.

• The external Payroll system is expected to acknowledge the transactions it has received from Ellipse as either processedsuccessfully or unsuccessfully.

• The Payroll Transaction adapter then updates the status of the work time transaction data on the Employee PayrollTransactions History table (MSF835) as either 'PROC' (Processed) or 'REJE' (Rejected).

PublicationThere are 2 supported mechanisms provided for the publication of Payroll Transaction data from Ellipse:

1. Events - where a change is made to the Pay Group Control table (MSF801_PG_801), an event message will be generated.This will initiate the extraction of Payroll Transaction data for the relevant Pay Group by the Payroll Transaction adapter.

2. Timer - the extraction of Payroll Transaction data for Pay Groups can be initiated via time based process. At the specifiedtime the extraction of Payroll Transaction data will be processed by the Payroll Transaction adapter.

The details of these 2 options are outlined below.

NoteIt is recommended that one or the other method is chosen, as implementing both methods at the same time may causeunexpected results.

Page 5: Payroll Transaction Data Adapterec2-54-235-97-194.compute-1.amazonaws.com/documentation/... · 2016-11-16 · Payroll Transaction Data Adapter Overview The Payroll Transaction adapter

EventsWhere the property mib.payrollcontrol.eventsenabled=true is set to true (mib-core.properties), event processing will behandled for Payroll Transaction data. The event processing will be triggered by a change to the Pay Group Control table(MSF801_PG_801). The specific change will be where the Pay Group Control table has column update_ind_pg = 'N' (update notin progress) and column payroll_type_pg <> 'F' (not full payroll). These columns will be set this way on completion of the batchPayroll process in Ellipse for a specfified Pay Group. An event message for the Pay Group Control table will be generated andpassed to EIP. EIP maintains the named subscription PayGroupControl1 under the EllipseServices topic to process these eventmessages. This will result in NotifyEmployeeWorkTime messages being generated and processed for the specified Pay Group,with PostEmployeeWorkTime messages then being output to the queue MIB.PAYROLL.REPLY, for consumption by an externalPayroll system.

TimerTo enable the extract of Payroll Transactions via a timer, 2 properties must be set:

mib.payroll.transactionExtract=truemib.payroll.transactionTimer=0 */60 * * * ?

The timing of this will be configurable via the property mib.payroll.transactionTimer. The property value set must be a validcron expression. It is recommended that the cron expression defines a time to begin adapter extract execution after the Ellipsebatch Payroll Update suite of processes (initiated by MSB8UP) has run. In addition the property mib.payroll.transactionExtractmust be set to true.

Where the extract of Payroll transactions is not required the properties should be set as follows:

mib.payroll.transactionExtract=falsemib.payroll.transactionTimer=59 23 31 12 0 ?

A new Notify Employee Work Time message is then placed on the MIB.PAYROLL.GW queue. The adapter is initiated (by theEmployee Work Time message on the MIB.PAYROLL.GW queue) and the notify method retrieves a transactions from the PayrollTransactions History table (MSF835). The adapter creates a Post Employee Work Time message and outputs this message tothe MIB.PAYROLL.REPLY queue.

N.B. Where the Payroll Transaction adapter is initiated via the Timer process, it will extract details for All Pay Groups.

OAGIS MessageEmployee Work Time noun

The OAGIS standard contains a noun called EmployeeWorkTime, this has been used to represent an Ellipse Employee PayrollTransaction record. Only some of the Ellipse attributes held for a Employee Payroll Transaction record can be mapped toattributes under the EmployeeWorkTime noun. Where Ellipse attributes cannot be mapped to attributes under theEmployeeWorkTime noun, this has been extended through the use of the Extensions/AnyExtensions group.

The OAGIS verbs Notify (and Post) and Acknowledge will also be supported (as ABB BODs).

Foreign KeysN/A

Concurrent UpdatesN/A

Methods

NotifyThe notify method calls the following Ellipse services to process the data passed:

• PayrollHistoryThe process of posting employee work time transactions to a 3rd party payroll application will potentially involve large numbersof messages being processed. To manage this without impacting processing of other messages, separate queues have beenimplemented to channel the employee work time transaction messages. The trigger messages to initiate the extraction ofemployee work time transactions will be processed over the MIB.PAYROLL.GW queue. The PostEmployeeWorkTime messagewith the details for an Employee will be output to the MIB.PAYROLL.REPLY queue.

NoteThe adapter will pass both valued and unvalued employee work time transactions as part of the post processing. Where the3rd party payroll application only requires one or the other (valued or unvalued), processing will need to be implemented to

Page 6: Payroll Transaction Data Adapterec2-54-235-97-194.compute-1.amazonaws.com/documentation/... · 2016-11-16 · Payroll Transaction Data Adapter Overview The Payroll Transaction adapter

filter the transactions passed. The filtering of the transactions will need to be done as part of the processing by the 3rdparty payroll application.

Notify Message MappingMapping of ABB PostEmployeeWorkTime message attributes to Ellipse web service:

Field Description Notes Service Attribute<EmployeeWorkTime> <Employee> <ID>string Employee Id value PayrollHisory employee </Employee> <WageGroupCode>string Work pay group code paygroup<EmployeeWorkTime>

Post Message MappingMapping of ABB PostEmployeeWorkTime message attributes to Ellipse web service:

Field Description Notes Service Attribute<EmployeeWorkTime> <Employee> <ID>string Employee Id value. PayrollHisory employee <PersonName> <FormattedName>string Employee formatted name. employeeName </PersonName> </Employee> <AbsenceTypeCode>string Leave reason code value. leaveReason <WageGroupCode>string Work pay group code. paygroup <WorkShiftID>string Work shift id value. rosterId <WorkTimePeriod> <StartDateTime>date Transaction Date. tranDate </WorkTimePeriod> <Extension> <Amount>decimal Transaction amount. amount <Classification>string Transaction classification. tranClass <Code>string Transaction code. tranCode <Indicator>string Transaction indicator. tranInd <Name>string Transaction code description. tranCodeDesc <Number>decimal Multiplier applicable to rate amount. tranFactor <Quantity>decimal Transaction time units tranUnits <RateAmount>decimal Rate amount applicable to transaction. rateAmountPayment <AnyExtension> <ActualTimePeriod> <StartTime>decimal Start time. fromTime <EndTime>decimal End time. endTime </ActualTimePeriod> <AnnualRateAmount>decimal Annual Rate applicable to transaction. baseSalary <Award> <Code>string Award code. awardCode <Description>string Award code description. awardCodeDesc </Award> <Envelope> <Code>string Envelope type value. envelopeType <Description>string Envelope type description value. envelopeTypeDesc </Envelope> <HigherDuties> <AdditPercentCategory>string Additional percentage category. addPercCat <Amount>decimal HD amount applicable to transaction. hdAmount <AnnualRateAmount>decimal HD Annual Rate applicable to transaction. hdSalary <Code>string HD earnings code. hdaEarnCode <FrequencyType>string Frequency type value. freqType <FrequencyRate>decimal Frequency rate value. freqRate <Percentage>decimal HD percentage. hdPercent <RateAmount>decimal HD rate amount applicable to transaction. hdRateAmount <RateOverrideInd>string Frequency rate override indicator. rateOverrideInd <RateTypeCode>string HD rate reference code value. hdRateRef </HigherDuties> <OverrideUnits>decimal Override units. overrideUnits <PayRunNumber>string Ellipse pay run number. payRunNo <PayRunType>string Ellipse pay run type. payRunType <PeriodEndDate>date Ellipse period end date. periodEndDate <RateTypeCode>string Rate reference code value. rateRefCode <ShiftType>string Shift type code value. shiftType <TransactionIndDesc>string Transaction indicator description. tranIndDesc

Page 7: Payroll Transaction Data Adapterec2-54-235-97-194.compute-1.amazonaws.com/documentation/... · 2016-11-16 · Payroll Transaction Data Adapter Overview The Payroll Transaction adapter

<TransactionUUID>string Unique Ellipse identifier for a record. tranUuid <WageGroupCode> <Name>string Work pay group code description. paygroupDesc </WageGroupCode> </AnyExtension> </Extension></EmployeeWorkTime>

AcknowledgeThe acknowledge method calls the following Ellipse services to process the data passed:

• PayrollHistoryFor each Employee Work Time transaction passed to the Payroll system, the result of that processing status the Payroll systemwill be required to be recorded in Ellipse. The transaction status value will be updated on the Employee Payroll History table(MSF835). The status value will marked as 'Accepted' (PROC) or 'Rejected' (REJE) in Ellipse by the Payroll system. The statusupdate to Ellipse can be performed on a group of Payroll transaction records or a specific Payroll transaction record.

Where the update is to be performed on a group of Payroll transaction records, the following details must be passed:

• Employee ID

• Pay Group

• Pay Run Number

• Pay Run Type

• Period End DateWhere the update is to be performed on a specific Payroll transaction record, the following details must be passed:

• Employee ID

• Transaction UUIDThe process of acknowledging employee work time transactions back to Ellipse will potentially involve large numbers ofmessages being processed. To manage this without impacting processing of other messages, separate queues have beenimplemented to channel the employee work time acknowledge messages. The acknowledge messages to update the status ofemployee work time transactions will be processed over the MIB.PAYROLL.ACK queue.

Ack Message MappingMapping of ABB AcknowledgeEmployeeWorkTime message attributes to Ellipse web service:

Field Description Validation Service Attribute <EmployeeWorkTime><EmployeeWorkTime> <Employee> <ID>string Employee Id value. PayrollHistory employeeID </Employee> <Extension> <AnyExtension> <PayRunNumber>string Ellipse pay run number. payRunNo <PayRunType>string Ellipse pay run type. payRunType <PeriodEndDate>date Ellipse period end date. periodEndDate <TransactionUUID>string Unique Transaction UUID value. tranUuid </AnyExtension> </Extension></EmployeeWorkTime>

NotesResponse Criteria

In addition to the passing of the Employee Work Time Group Key value in the message sent to Ellipse, the status of the updateof this in the ERP is required. The status of the update passed back in the acknowledgement must be either 'Accepted' or'Rejected'. This is required to be supplied as followed in the Acknowledge message under the DataArea element as follows:

Accepted:

<Acknowledge> <ResponseCriteria> <ResponseExpression actionCode="Accepted">ID=A0000018</ResponseExpression> <ChangeStatus> <Reason>{ "Request ID": 8775959, "Status": "Ok" }</Reason> </ChangeStatus> </ResponseCriteria></Acknowledge>

Rejected:

Page 8: Payroll Transaction Data Adapterec2-54-235-97-194.compute-1.amazonaws.com/documentation/... · 2016-11-16 · Payroll Transaction Data Adapter Overview The Payroll Transaction adapter

<Acknowledge> <ResponseCriteria> <ResponseExpression actionCode="Rejected">ID=A0000018</ResponseExpression> <ChangeStatus> <Reason>{ "Request ID": 8775959, "Status": "Ok" }</Reason> </ChangeStatus> </ResponseCriteria></Acknowledge>

Message Examples

NotifyInitiate extraction a specific Payroll Transaction data.<?xml version="1.0" encoding="UTF-8"?><NotifyEmployeeWorkTime 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/NotifyEmployeeWorkTime.xsd"> <ApplicationArea> <ip:Sender> <ip:LogicalID>MIB</ip:LogicalID> <ip:ComponentID>PayrollTransaction</ip:ComponentID> <ip:TaskID>NotifyEmployeeWorkTime</ip:TaskID> <ip:ReferenceID>RequestID</ip:ReferenceID> </ip:Sender> <ip:Receiver> <ip:LogicalID/> </ip:Receiver> <ip:CreationDateTime>2014-06-09T10:51:46</ip:CreationDateTime> <ip:BODID>1c78979d-6abd-4322-9ec7-1af39e061a17</ip:BODID> <ip:Extension> <ip:AnyExtension> <ip:ServiceContext> <ip:ServiceName>PostEmployeeWorkTime</ip:ServiceName> <ip:ServiceVersion>1.0</ip:ServiceVersion> <ip:MessageType>EmployeeWorkTime</ip:MessageType> </ip:ServiceContext> <ip:AuthorizationContext/> </ip:AnyExtension> </ip:Extension> </ApplicationArea> <DataArea> <Notify/> <EmployeeWorkTime> <WageGroupCode>PW1</WageGroupCode> </EmployeeWorkTime> </DataArea></NotifyEmployeeWorkTime>

PostPost a Transaction Group.<?xml version="1.0" encoding="UTF-8"?><PostEmployeeWorkTime 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/PostEmployeeWorkTime.xsd"> <ApplicationArea> <ip:Sender> <ip:LogicalID>MIB</ip:LogicalID> <ip:ComponentID>PayrollTransaction</ip:ComponentID> <ip:TaskID>PostEmployeeWorkTime</ip:TaskID> <ip:ReferenceID>RequestID</ip:ReferenceID> </ip:Sender> <ip:Receiver> <ip:LogicalID/> </ip:Receiver> <ip:CreationDateTime>2014-06-09T10:51:46</ip:CreationDateTime> <ip:BODID>1c78979d-6abd-4322-9ec7-1af39e061a17</ip:BODID> <ip:Extension> <ip:AnyExtension> <ip:ServiceContext> <ip:ServiceName>PostEmployeeWorkTime</ip:ServiceName> <ip:ServiceVersion>1.0</ip:ServiceVersion> <ip:MessageType>EmployeeWorkTime</ip:MessageType> </ip:ServiceContext> <ip:AuthorizationContext/> </ip:AnyExtension>

</ip:Extension> </ApplicationArea> <DataArea> <Post/> <EmployeeWorkTime> <Employee> <ID>A0000018</ID> <PersonName> <FormattedName>MOODY,OWEN Richard</FormattedName> </PersonName> </Employee>

Page 9: Payroll Transaction Data Adapterec2-54-235-97-194.compute-1.amazonaws.com/documentation/... · 2016-11-16 · Payroll Transaction Data Adapter Overview The Payroll Transaction adapter

<AbsenceTypeCode/> <WageGroupCode>PW1</WageGroupCode> <WorkShiftID>R004</WorkShiftID> <WorkTimePeriod> <StartDateTime>2009-07-07</StartDateTime> </WorkTimePeriod> <Extension> <Amount>149.5</Amount> <Classification>O</Classification> <Code>001</Code> <Indicator>1</Indicator> <Name>ORDINARY EARNINGS</Name> <Number>1</Number> <Quantity>11.5</Quantity> <RateAmount>13</RateAmount> <AnyExtension> <ActualTimePeriod> <StartTime>18</StartTime> <EndTime>6</EndTime> </ActualTimePeriod> <AnnualRateAmount>41600</AnnualRateAmount> <Award> <Code>W40</Code> <Description>Weekly 40 hrs per week</Description> </Award> <HigherDuties> <Amount>0</Amount> <AnnualRateAmount>0</AnnualRateAmount> <FrequencyRate>0</FrequencyRate> <Percentage>0</Percentage> <RateAmount>0</RateAmount> </HigherDuties> <OverrideUnits>0</OverrideUnits> <PayRunNumber>002</PayRunNumber> <PayRunType>U</PayRunType> <PeriodEndDate>2009-07-11</PeriodEndDate> <RateTypeCode>FIT01</RateTypeCode> <ShiftType>N</ShiftType> <TransactionIndDesc>EARNINGS</TransactionIndDesc> <WageGroupCode> <Name>Weekly Pay Group 1</Name> </WageGroupCode> </AnyExtension> </Extension> </EmployeeWorkTime> <EmployeeWorkTime> <Employee> <ID>A0000018</ID> <PersonName> <FormattedName>MOODY,OWEN Richard</FormattedName> </PersonName> </Employee> <AbsenceTypeCode/> <WageGroupCode>PW1</WageGroupCode> <WorkShiftID>R004</WorkShiftID> <WorkTimePeriod> <StartDateTime>2009-07-08</StartDateTime> </WorkTimePeriod> <Extension> <Amount>149.5</Amount> <Classification>O</Classification> <Code>001</Code> <Indicator>1</Indicator> <Name>ORDINARY EARNINGS</Name> <Number>1</Number> <Quantity>11.5</Quantity> <RateAmount>13</RateAmount> <AnyExtension> <ActualTimePeriod> <StartTime>18</StartTime> <EndTime>6</EndTime> </ActualTimePeriod> <AnnualRateAmount>41600</AnnualRateAmount> <Award> <Code>W40</Code> <Description>Weekly 40 hrs per week</Description> </Award> <HigherDuties>

Page 10: Payroll Transaction Data Adapterec2-54-235-97-194.compute-1.amazonaws.com/documentation/... · 2016-11-16 · Payroll Transaction Data Adapter Overview The Payroll Transaction adapter

<Amount>0</Amount> <AnnualRateAmount>0</AnnualRateAmount> <FrequencyRate>0</FrequencyRate> <Percentage>0</Percentage> <RateAmount>0</RateAmount> </HigherDuties> <OverrideUnits>0</OverrideUnits> <PayRunNumber>002</PayRunNumber> <PayRunType>U</PayRunType> <PeriodEndDate>2009-07-11</PeriodEndDate> <RateTypeCode>FIT01</RateTypeCode> <ShiftType>N</ShiftType> <TransactionIndDesc>EARNINGS</TransactionIndDesc> <WageGroupCode> <Name>Weekly Pay Group 1</Name> </WageGroupCode> </AnyExtension> </Extension> </EmployeeWorkTime> <EmployeeWorkTime> <Employee> <ID>A0000018</ID> <PersonName> <FormattedName>MOODY,OWEN Richard</FormattedName> </PersonName> </Employee> <AbsenceTypeCode/> <WageGroupCode>PW1</WageGroupCode> <WorkShiftID>R004</WorkShiftID> <WorkTimePeriod> <StartDateTime>2009-07-09</StartDateTime> </WorkTimePeriod> <Extension> <Amount>149.5</Amount> <Classification>O</Classification> <Code>001</Code> <Indicator>1</Indicator> <Name>ORDINARY EARNINGS</Name> <Number>1</Number> <Quantity>11.5</Quantity> <RateAmount>13</RateAmount> <AnyExtension> <ActualTimePeriod> <StartTime>18</StartTime> <EndTime>6</EndTime> </ActualTimePeriod> <AnnualRateAmount>41600</AnnualRateAmount> <Award> <Code>W40</Code> <Description>Weekly 40 hrs per week</Description> </Award> <HigherDuties> <Amount>0</Amount> <AnnualRateAmount>0</AnnualRateAmount> <FrequencyRate>0</FrequencyRate> <Percentage>0</Percentage> <RateAmount>0</RateAmount> </HigherDuties> <OverrideUnits>0</OverrideUnits> <PayRunNumber>002</PayRunNumber> <PayRunType>U</PayRunType> <PeriodEndDate>2009-07-11</PeriodEndDate> <RateTypeCode>FIT01</RateTypeCode> <ShiftType>N</ShiftType> <TransactionIndDesc>EARNINGS</TransactionIndDesc> <WageGroupCode> <Name>Weekly Pay Group 1</Name> </WageGroupCode> </AnyExtension> </Extension> </EmployeeWorkTime> <EmployeeWorkTime> <Employee> <ID>A0000018</ID> <PersonName> <FormattedName>MOODY,OWEN Richard</FormattedName> </PersonName> </Employee>

Page 11: Payroll Transaction Data Adapterec2-54-235-97-194.compute-1.amazonaws.com/documentation/... · 2016-11-16 · Payroll Transaction Data Adapter Overview The Payroll Transaction adapter

<AbsenceTypeCode/> <WageGroupCode>PW1</WageGroupCode> <WorkShiftID>R004</WorkShiftID> <WorkTimePeriod> <StartDateTime>2009-07-10</StartDateTime> </WorkTimePeriod> <Extension> <Amount>149.5</Amount> <Classification>O</Classification> <Code>001</Code> <Indicator>1</Indicator> <Name>ORDINARY EARNINGS</Name> <Number>1</Number> <Quantity>11.5</Quantity> <RateAmount>13</RateAmount> <AnyExtension> <ActualTimePeriod> <StartTime>18</StartTime> <EndTime>6</EndTime> </ActualTimePeriod> <AnnualRateAmount>41600</AnnualRateAmount> <Award> <Code>W40</Code> <Description>Weekly 40 hrs per week</Description> </Award> <HigherDuties> <Amount>0</Amount> <AnnualRateAmount>0</AnnualRateAmount> <FrequencyRate>0</FrequencyRate> <Percentage>0</Percentage> <RateAmount>0</RateAmount> </HigherDuties> <OverrideUnits>0</OverrideUnits> <PayRunNumber>002</PayRunNumber> <PayRunType>U</PayRunType> <PeriodEndDate>2009-07-11</PeriodEndDate> <RateTypeCode>FIT01</RateTypeCode> <ShiftType>N</ShiftType> <TransactionIndDesc>EARNINGS</TransactionIndDesc> <WageGroupCode> <Name>Weekly Pay Group 1</Name> </WageGroupCode> </AnyExtension> </Extension> </EmployeeWorkTime> <EmployeeWorkTime> <Employee> <ID>A0000018</ID> <PersonName> <FormattedName>MOODY,OWEN Richard</FormattedName> </PersonName> </Employee> <AbsenceTypeCode/> <WageGroupCode>PW1</WageGroupCode> <WorkShiftID>R004</WorkShiftID> <WorkTimePeriod> <StartDateTime>2009-07-11</StartDateTime> </WorkTimePeriod> <Extension> <Amount>149.5</Amount> <Classification>O</Classification> <Code>001</Code> <Indicator>1</Indicator> <Name>ORDINARY EARNINGS</Name> <Number>1</Number> <Quantity>11.5</Quantity> <RateAmount>13</RateAmount> <AnyExtension> <ActualTimePeriod> <StartTime>18</StartTime> <EndTime>6</EndTime> </ActualTimePeriod> <AnnualRateAmount>41600</AnnualRateAmount> <Award> <Code>W40</Code> <Description>Weekly 40 hrs per week</Description> </Award> <HigherDuties>

Page 12: Payroll Transaction Data Adapterec2-54-235-97-194.compute-1.amazonaws.com/documentation/... · 2016-11-16 · Payroll Transaction Data Adapter Overview The Payroll Transaction adapter

<Amount>30</Amount> <AnnualRateAmount>62400</AnnualRateAmount> <Code>601</Code> <FrequencyRate>0</FrequencyRate> <Percentage>100</Percentage> <RateAmount>30</RateAmount> <RateTypeCode>W40</RateTypeCode> </HigherDuties> <OverrideUnits>0</OverrideUnits> <PayRunNumber>002</PayRunNumber> <PayRunType>U</PayRunType> <PeriodEndDate>2009-07-11</PeriodEndDate> <RateTypeCode>FIT01</RateTypeCode> <ShiftType>N</ShiftType> <TransactionIndDesc>EARNINGS</TransactionIndDesc> <WageGroupCode> <Name>Weekly Pay Group 1</Name> </WageGroupCode> </AnyExtension> </Extension> </EmployeeWorkTime> <EmployeeWorkTime> <Employee> <ID>A0000018</ID> <PersonName> <FormattedName>MOODY,OWEN Richard</FormattedName> </PersonName> </Employee> <AbsenceTypeCode/> <WageGroupCode>PW1</WageGroupCode> <WorkShiftID/> <WorkTimePeriod> <StartDateTime>2009-07-11</StartDateTime> </WorkTimePeriod> <Extension> <Amount>150</Amount> <Classification/> <Code>001</Code> <Indicator>3</Indicator> <Name/> <Number>0</Number> <Quantity>1</Quantity> <RateAmount>150</RateAmount> <AnyExtension> <ActualTimePeriod> <StartTime>0</StartTime> <EndTime>0</EndTime> </ActualTimePeriod> <AnnualRateAmount>41600</AnnualRateAmount> <Award> <Code>W40</Code> <Description>Weekly 40 hrs per week</Description> </Award> <HigherDuties> <Amount>0</Amount> <AnnualRateAmount>0</AnnualRateAmount> <FrequencyRate>0</FrequencyRate> <Percentage>0</Percentage> <RateAmount>0</RateAmount> </HigherDuties> <OverrideUnits>0</OverrideUnits> <PayRunNumber>002</PayRunNumber> <PayRunType>U</PayRunType> <PeriodEndDate>2009-07-11</PeriodEndDate> <TransactionIndDesc>TAX</TransactionIndDesc> <WageGroupCode> <Name>Weekly Pay Group 1</Name> </WageGroupCode> </AnyExtension> </Extension> </EmployeeWorkTime> </DataArea></PostEmployeeWorkTime>

AcknowledgeAcknowledge an Employee Work Time Transaction Group as being processed.

Page 13: Payroll Transaction Data Adapterec2-54-235-97-194.compute-1.amazonaws.com/documentation/... · 2016-11-16 · Payroll Transaction Data Adapter Overview The Payroll Transaction adapter

<?xml version="1.0" encoding="UTF-8"?><AcknowledgeEmployeeWorkTime 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/AcknowledgeEmployeeWorkTime.xsd"> <ApplicationArea> <ip:Sender> <ip:LogicalID>Payroll</ip:LogicalID> <ip:ComponentID>PayrollTransaction</ip:ComponentID> <ip:TaskID>AcknowledgePayrollTransaction</ip:TaskID> <ip:ReferenceID>ReferenceID</ip:ReferenceID> </ip:Sender> <ip:CreationDateTime>2014-06-10T11:11:11</ip:CreationDateTime> <ip:BODID>JUnit Test</ip:BODID> <ip:Extension> <ip:AnyExtension> <ip:ServiceContext> <ip:ServiceName>AcknowledgeEmployeeWorkTime</ip:ServiceName> <ip:ServiceVersion>1.0</ip:ServiceVersion> <ip:MessageType>EmployeeWorkTime</ip:MessageType> <ip:DocumentName>EmployeeWorkTime</ip:DocumentName> </ip:ServiceContext> <ip:AuthorizationContext> <ip:Proxy> <ip:UserID>INTEGRAT</ip:UserID> <ip:OrgID>CONS</ip:OrgID> <ip:Role>INTEGRAT</ip:Role> </ip:Proxy> </ip:AuthorizationContext> </ip:AnyExtension> </ip:Extension> </ApplicationArea> <DataArea> <Acknowledge> <ResponseCriteria> <ResponseExpression actionCode="Accepted">ID=A0000018</ResponseExpression> <ChangeStatus> <Reason>{ "Request ID": 8775959, "Status": "Ok" }</Reason> </ChangeStatus> </ResponseCriteria> </Acknowledge> <EmployeeWorkTime> <Employee> <ID>A0000018</ID> </Employee> <WageGroupCode>PW1</WageGroupCode> <Extension> <AnyExtension> <PayRunNumber>002</PayRunNumber> <PayRunType>U</PayRunType> <PeriodEndDate>2009-07-11</PeriodEndDate> </AnyExtension> </Extension> </EmployeeWorkTime> </DataArea></AcknowledgeEmployeeWorkTime>

Acknowledge an Employee Work Time Transaction Group as being rejected.<?xml version="1.0" encoding="UTF-8"?><AcknowledgeEmployeeWorkTime 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/AcknowledgeEmployeeWorkTime.xsd"> <ApplicationArea> <ip:Sender> <ip:LogicalID>Payroll</ip:LogicalID> <ip:ComponentID>PayrollTransaction</ip:ComponentID> <ip:TaskID>AcknowledgePayrollTransaction</ip:TaskID> <ip:ReferenceID>ReferenceID</ip:ReferenceID> </ip:Sender> <ip:CreationDateTime>2014-06-10T11:11:11</ip:CreationDateTime> <ip:BODID>JUnit Test</ip:BODID> <ip:Extension> <ip:AnyExtension> <ip:ServiceContext> <ip:ServiceName>AcknowledgeEmployeeWorkTime</ip:ServiceName> <ip:ServiceVersion>1.0</ip:ServiceVersion> <ip:MessageType>EmployeeWorkTime</ip:MessageType> <ip:DocumentName>EmployeeWorkTime</ip:DocumentName> </ip:ServiceContext> <ip:AuthorizationContext> <ip:Proxy> <ip:UserID>INTEGRAT</ip:UserID>

Page 14: Payroll Transaction Data Adapterec2-54-235-97-194.compute-1.amazonaws.com/documentation/... · 2016-11-16 · Payroll Transaction Data Adapter Overview The Payroll Transaction adapter

<ip:OrgID>CONS</ip:OrgID> <ip:Role>INTEGRAT</ip:Role> </ip:Proxy> </ip:AuthorizationContext> </ip:AnyExtension> </ip:Extension> </ApplicationArea> <DataArea> <Acknowledge> <Acknowledge> <ResponseCriteria> <ResponseExpression actionCode="Rejected">ID=A0000018</ResponseExpression> <ChangeStatus> <Reason>{ "Request ID": 8775959, "Status": "Ok" }</Reason> </ChangeStatus> </ResponseCriteria> </Acknowledge> <EmployeeWorkTime> <Employee> <ID>A0000018</ID> </Employee> <WageGroupCode>PW1</WageGroupCode> <Extension> <AnyExtension> <PayRunNumber>002</PayRunNumber> <PayRunType>U</PayRunType> <PeriodEndDate>20090711</PeriodEndDate> </AnyExtension> </Extension> </EmployeeWorkTime> </DataArea></AcknowledgeEmployeeWorkTime>

Acknowledge a specific Employee Work Time Transaction Record as being processed.<?xml version="1.0" encoding="UTF-8"?><AcknowledgeEmployeeWorkTime 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/AcknowledgeEmployeeWorkTime.xsd"> <ApplicationArea> <ip:Sender> <ip:LogicalID>Payroll</ip:LogicalID> <ip:ComponentID>PayrollTransaction</ip:ComponentID> <ip:TaskID>AcknowledgePayrollTransaction</ip:TaskID> <ip:ReferenceID>ReferenceID</ip:ReferenceID> </ip:Sender> <ip:CreationDateTime>2014-06-10T11:11:11</ip:CreationDateTime> <ip:BODID>JUnit Test</ip:BODID> <ip:Extension> <ip:AnyExtension> <ip:ServiceContext> <ip:ServiceName>AcknowledgeEmployeeWorkTime</ip:ServiceName> <ip:ServiceVersion>1.0</ip:ServiceVersion> <ip:MessageType>EmployeeWorkTime</ip:MessageType> <ip:DocumentName>EmployeeWorkTime</ip:DocumentName> </ip:ServiceContext> <ip:AuthorizationContext> <ip:Proxy> <ip:UserID>INTEGRAT</ip:UserID> <ip:OrgID>CONS</ip:OrgID> <ip:Role>INTEGRAT</ip:Role> </ip:Proxy> </ip:AuthorizationContext> </ip:AnyExtension> </ip:Extension> </ApplicationArea> <DataArea> <Acknowledge> <ResponseCriteria> <ResponseExpression actionCode="Accepted">ID=A0000018</ResponseExpression> <ChangeStatus> <Reason>{ "Request ID": 8775959, "Status": "Ok" }</Reason> </ChangeStatus> </ResponseCriteria> </Acknowledge> <EmployeeWorkTime> <Employee>

<ID>A0000018</ID> </Employee> <Extension>

Page 15: Payroll Transaction Data Adapterec2-54-235-97-194.compute-1.amazonaws.com/documentation/... · 2016-11-16 · Payroll Transaction Data Adapter Overview The Payroll Transaction adapter

<AnyExtension> <TransactionUUID>123456789012345678901234567890AA</TransactionUUID> </AnyExtension> </Extension> </EmployeeWorkTime> </DataArea></AcknowledgeEmployeeWorkTime>

Acknowledge a specific Employee Work Time Transaction Record as being rejected.<?xml version="1.0" encoding="UTF-8"?><AcknowledgeEmployeeWorkTime 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/AcknowledgeEmployeeWorkTime.xsd"> <ApplicationArea> <ip:Sender> <ip:LogicalID>Payroll</ip:LogicalID> <ip:ComponentID>PayrollTransaction</ip:ComponentID> <ip:TaskID>AcknowledgePayrollTransaction</ip:TaskID> <ip:ReferenceID>ReferenceID</ip:ReferenceID> </ip:Sender> <ip:CreationDateTime>2014-06-10T11:11:11</ip:CreationDateTime> <ip:BODID>JUnit Test</ip:BODID> <ip:Extension> <ip:AnyExtension> <ip:ServiceContext> <ip:ServiceName>AcknowledgeEmployeeWorkTime</ip:ServiceName> <ip:ServiceVersion>1.0</ip:ServiceVersion> <ip:MessageType>EmployeeWorkTime</ip:MessageType> <ip:DocumentName>EmployeeWorkTime</ip:DocumentName> </ip:ServiceContext> <ip:AuthorizationContext> <ip:Proxy> <ip:UserID>INTEGRAT</ip:UserID> <ip:OrgID>CONS</ip:OrgID> <ip:Role>INTEGRAT</ip:Role> </ip:Proxy> </ip:AuthorizationContext> </ip:AnyExtension> </ip:Extension> </ApplicationArea> <DataArea> <Acknowledge> <ResponseCriteria> <ResponseExpression actionCode="Rejected">ID=A0000018</ResponseExpression> <ChangeStatus> <Reason>{ "Request ID": 8775959, "Status": "Ok" }</Reason> </ChangeStatus> </ResponseCriteria> </Acknowledge> <EmployeeWorkTime> <Employee> <ID>A0000018</ID> </Employee> <Extension> <AnyExtension> <TransactionUUID>123456789012345678901234567890AB</TransactionUUID> </AnyExtension> </Extension> </EmployeeWorkTime> </DataArea></AcknowledgeEmployeeWorkTime>