pay advice | abb

—

Pay Advice Functional Overview

Ellipse EAM® 8.5

© Copyright 2014 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 network interface, which should be connected to a secure network. It is your sole responsibility to

ensure a secure connection to the network and to establish and maintain appropriate measures (such as but

not limited to the installation of firewalls, application of 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.

Functional Overview Pay Advice

© Copyright 2014 ABB of 33

Contents Definitions, Acronyms and Abbreviations ............................................................................................. 4

Introduction .................................................................................................................................................. 5

Purpose .......................................................................................................................................................... 5 Executive Summary ..................................................................................................................................... 5 Scope .............................................................................................................................................................. 6

Baselines ................................................................................................................................................. 6 Functional Scope................................................................................................................................... 6 Ellipse Changes ..................................................................................................................................... 8

Scope Exclusions .......................................................................................................................................... 9 Business Benefits ......................................................................................................................................... 9

Functional Enhancements ........................................................................................................................ 11

Pay Advice Header Service ....................................................................................................................... 12 Pay Advice Earnings Service .................................................................................................................... 12 Pay Advice Deduction Service ................................................................................................................. 13 Pay Advice Employee Service .................................................................................................................. 13 Pay Advice Employee Period to Date Service ...................................................................................... 13 Pay Advice Employee Period to Date Service ...................................................................................... 14 Pay Advice Employee Year to Date Taxation Service ......................................................................... 15 Pay Advice Employee Current Period Taxation Service .................................................................... 15 Pay Advice Employee Current Period Earnings Service .................................................................... 16 Pay Advice Employee Current Period Earnings Service .................................................................... 16 Pay Advice Employee Banking Details Service .................................................................................... 17 Pay Advice Messages Service .................................................................................................................. 18 Pay Advice Leave Information Service .................................................................................................. 18 Pay Advice Other Information Service .................................................................................................. 19 Pay Advice History Update (java batch) ............................................................................................... 19 Pay Advice (Jasper – MSJ8PA) ................................................................................................................. 19

Batch Pay Advice Processing ........................................................................................................... 19 ESS Pay Advice Processing .............................................................................................................. 20

Employee Personnel Workbench ............................................................................................................ 25 Pay group .....................................................................................................................................................26 Notional Earnings ...................................................................................................................................... 27

How to Configure ...................................................................................................................................... 28

Modules ........................................................................................................................................................28 System Control File ...................................................................................................................................28 District Control File ...................................................................................................................................28 Table Codes .................................................................................................................................................28

FRPM – Form Reports ........................................................................................................................29 FPMP – Form Parameter Mappings ................................................................................................29 PSDM – Payslip Distribution Method ............................................................................................. 31

Data Conversion ......................................................................................................................................... 31 Security ......................................................................................................................................................... 31 Core Menu Changes................................................................................................................................... 32 Other Configuration .................................................................................................................................. 32

Business Process ........................................................................................................................................ 32

Functional Overview .................................................................................................................................. 33



Definitions, Acronyms and Abbreviations Definition Description

Global Payroll Adaptor

Solution

A generic payroll integration solution using the Ventyx Integration

Platform (VIP). Available from Ellipse 8.5. Supports both the Unvalued

Timekeeping Transaction model and the Valued Transaction Model.

MSE81S Ellipse program for the Personnel Workbench. An employee self-service

application and also used by HR users.

MSE82S Ellipse program for the Payroll Workbench. An employee self-service

application.

MSO808 Ellipse program used for creating and maintaining pay group

information

ESS Employee Self Service. Within Ellipse this is a set of applications and

components that provide an employee with access to employee related

information and enables the employee to update relevant information

for themselves. Employee Self Service also provides an employee with

full access to timekeeping, labour costing, training and leave, and review

access to payroll information including history and payslips.

MSS Manager Self Service.



Introduction Purpose The purpose of this document is to explain the business intent of the ‘Pay Advice’ enhancement,

including how to configure and use the new functionality.

Executive Summary This development item enables the core pay advice files (MSF8P* series tables) to be populated and

reported upon by Ellipse ‘Full Payroll‘ customers and by those customers using the Global Payroll

Adaptor solution (‘Timekeeping‘ and ‘Gross‘ payroll customers).

The development consists of 8 key enhancements:

Database changes to the existing core pay advice tables (introduced in Ellipse 8.2) to

accommodate additional pay advice and reporting information, including new Ellipse fields

introduced since Ellipse 8.2. The 14 MSF8P* tables have now been incorporated for use in the

core solution.

The creation of 14 java services (one for each of the MSF8P* tables) to manage the MSF8P* Pay

Advice tables. These services are used by both the java batch job (MSB8PA) and the Pay

Advice Adapter.

The development of a java batch job (MSB8PS – Pay Advice History Update) to orchestrate the

population of the pay advice tales for Ellipse Full Payroll customers and the deprecation of

obsolete COBOL components (MSB82U, MSB82Z, MST82Z, MSB82Y and MSB82X).

The creation of a Pay Advice Adapter as an extension of the Global Payroll Adapter solution to

enable customers to import pay advice history information into Ellipse for pay advice and

business reporting (production and analytical).

The addition of a Payslip Distribution Preference setting on MSE81S – Personnel Workbench to

store an individual’s preference for pay advice delivery information (ESS, Work Email, Home

Email and so on).

A core Jasper report (MSJ8PA – Pay Advice) for generating bulk pay advice information for

emailing or printing. This includes the ability to bulk email (burst) pay advices to employees.

A core Jasper report (MSJ8PA – Pay Advice) for generating individual employee pay advices in

Ellipse and available via Employee Self Service.

Modification of the MSE82S – Payroll Workbench and MSE83G – Employee Payment Details to

enable the user to launch MSJ8PA without entering parameters or submitting for batch

processing (the user clicks on the request and the report (pay advice) displays on screen).

The key benefits are:

Accurate and reproducible pay advices. This overcomes some existing limitations in Ellipse

whereby year to date, leave balance and payslip message information was only available on

the most current payslip. Regenerated historical payslips did not contain this point in time

information. It also overcomes the limitation that when a description of a code was modified;

only the latest description displays on pay advices rerun for prior periods.

Faster pay advice generation. Bulk and individual pay advices are substantially quicker and

simpler to generate using java and Jasper reporting functionality.

Lower implementation costs. The core Jasper report has been highly parameterised and

properties are easily modified. The goal would be for most customers to use the core report

rather than develop a custom pay advice.

The ability to bulk email employee pay advices via Jasper reporting. This can generate

significant savings for customers while providing pay advice information to employees faster.



Bulk emailing can be used in conjunction with ESS functionality rather than physical printing

and distribution of pay advices.

A consistent storage mechanism (single point of truth) for pay advice information which can

be easily used for production and analytical reporting. For example, information contained in

the MSF8P* files would enable easy reporting on overtime information such as days of week,

dates, units and value by employee, position, employee class, work group, crew, physical

location, work location, primary reporting code and so on, for further cost saving analysis.

Providing ESS users with the ability to nominate how they want to receive their pay advice

such as view online only, use work email, use home email, distribute to employee physical

location, distribute to employee work location, post to residential address or post to postal

address.

Pay advice that adheres to industry best practice.

Scope The scope of the ‘Pay Advice‘ enhancement is detailed below:

Baselines Ellipse 8.5 onwards. This item is not suitable for back fit to prior versions of Ellipse 8.

Functional Scope The functional scope of the development item encompasses:

1. Enhancements to pay advice history tables to ensure sufficient information is stored for

global payroll, payslip reporting and payroll analytics.

2. Services created for the individual pay advice history tables used by the new batch pay advice

update program as well as the pay advice adapter.

3. New java batch program (MSB8PS) developed to populate the pay advice history tables as part

of the payroll calculate process. This batch program is run as part of the payroll preview and

update processes and populates the pay advice history tables for use by the online review of

pay advice history within the payroll workbench (MSE82S), and for use by the jasper pay advice

program.

4. Payroll Advice adapter created to support the import of pay advice details into Ellipse from a

3rd party application. This provides users the ability to review and print pay advices from

Ellipse even though the payroll was processed on another system.

5. New Jasper pay advice (MSJ8PA). New pay advice utilizes the core pay advice history tables

and is reproducible, quick to generate, cheap to create and distribute, meets legislative

requirements, is easy to understand, highly parameter driven and accurate for employer and

employee obligations.

6. Employee service and personnel workbench modified to support payslip distribution method.

This change provides users with the ability to create and update the preferred payslip

distribution method, so that the payslip is distributed per the preferred method. Distribution

preferences include:

a. Online

b. home email

c. home address

d. work email

e. work address

7. Pay group configuration modified to accommodate additional attributes for payslip print

process. Enhancements are:



a. Pay Slip Box to exclude – enables selection of a pay slip box to be excluded from

printing on pay slips. A value entered in this field will cause any earnings or deductions

with the same pay slip box value to be excluded from the pay slip.

b. Earnings Summary Only – indicates that the payslip earnings are to be in a summary

format (one line per code) or detail format (one line per transaction)

c. Increased length of logo path

8. Button added to Payroll Workbench (MSE82S) to initiate Jasper Pay Advice report (MSJ8PA)

for the most recent payroll update run. Clicking the button will initiate the pay advice report in

ESS mode and display the pay advice on a new tab within the browser. The existing custom

payslip button has been removed as the new button supports the core payslip and can be

modified to initiate a custom payslip.

9. Pay advice history tab on the Payroll Workbench has been modified to utilize the pay advice

history tables to populate the grid for those pay runs that have pay advice history tables

generated. For pay runs that do not have pay advice history associated with them, the grid will

be populated using the existing program logic.

10. New application MSE83S - Review Employee Pay Advice Details has been developed to display

the information on the pay advice history tables for a selected pay run. This replaces the

existing MSE83G application for those pay runs that have pay advice history details (for pay

runs that do not have pay advice history entries, the existing MSE83G application will continue

to be used to display the pay advice details). The MSE83S application includes a button to

initiate the Jasper Pay Advice report (MSJ8PA) for the payroll run being displayed. Clicking this

button will initiate the pay advice in ESS mode and display the pay advice on a new tab within

the browser.

11. Notional Earnings are now being displayed on the MSM823A - Review Employee Select Period

to Date Amounts and the MSM82EA - Review Employee Payroll Totals In Common Currency

screens. Notional Earnings are also being taken into account when calculating the Totals

Earnings on the Pay Advice History tab and associated details applications on the MSE82S -

Update Payroll Workbench.



Ellipse Changes The following components were created, modified or deprecated as a result of this development item:

Modules:

3001 – General Module

3801 – Payroll Configuration

3820 – Payroll Management

Components:

MSO808 – Pay Group Details (modified)

MSM808B – Pay Group General Details (modified)

MSE81S – Personnel Workbench (modified)

MSB8PS – Pay Advice History Update (new)

MSJ8PA – Pay Advice (new)

MSE82S – Payroll Workbench (modified)

MSE83G – Employee Payment Details (modified)

MSE83S – Employee Pay Advice Details (new)

MSGUPDPD.INS – Pay Update Request Gen (modified)

MSGPRVPD.INS – Pay Preview Request Gen (modified)

MSGUPDWS.INS – Pay Update Request Gen (modified)

MSGPRVWS.INS – Pay Preview Request Gen (modified)

MSB8UP – Payroll Update (Modified)

MSB839 – Payslip Messages (modified)

MSO823 – Review Employee Select Period to Date Amounts (modified)

MSO82E – Review Employee Payroll Totals in Common Currency (modified)

MSM823A – Review Employee Select Period to Date Amounts (modified)

MSM82EA – Review Employee Payroll Totals in Common Currency (modified)

MSB82Z – Generic Payslip Extract (obsolete)

MSB82U – Generic Payslip Extract USA (obsolete)

MSB82Y – Generic Payslip Print (obsolete)

MST82Z – Generic Payslip Extract (obsolete)

MST82U – Generic Payslip Extract USA (obsolete)

Services:

PayAdviceHeader (new)

PayAdviceEarnings (new)

PayAdviceDeductions (new)

PayAdviceEmployeePaySlip (new)



PayAdviceEmployeePeriodToDateEarnings (new)

PayAdviceEmployeePeriodToDateDeductions (new)

PayAdviceEmployeeCurrentPeriodEarnings (new)

PayAdviceEmployeeCurrentPeriodDeductions (new)

PayAdviceEmployeeBanking (new)

PayAdviceMessages (new)

PayAdviceOtherInformation (new)

PayAdviceEmlpoyeeYearToDateTaxation (new)

PayAdviceEmployeeCurrentPeriodTaxation (new)

PayAdviceLeaveInformation (new)

Employee – MSK810 (modified)

Employee Payment History – MSK83G (modified)

MSF010 Tables:

PAYR – Payroll Report Program (modified)

PRVR – Payroll Preview Update Requests (modified)

UPDR – Payroll Calculate Update Requests (modified)

PSDM – Pay Slip Distribution Method (new)

FRPM – Form Reports

FPMP – Form Parameter Mappings

Database Tables:

Pay Advice History (modified)

Pay Group (modified)

Employee (modified)

Adapters:

PayrollAdvice (new)

Scope Exclusions Not applicable.

Business Benefits The key business benefits of this development item include:

Accurate and reproducible pay advices. This overcomes some existing limitations in Ellipse

whereby year to date, leave balance and payslip message information was only available on

the most current payslip. Regenerated historical payslips did not contain this point in time

information. It also overcomes the limitation that when a description of a code was modified;

only the latest description displays on pay advices rerun for prior periods.



Core pay advice developed in Jasper has been made available as part of this enhancement.

This pay advice utilizes the pay advice history tables to ensure that a pay advice can be

accurately reproduced at any point in time. The same Jasper pay advice that is run in batch

mode for producing pay advices for all or selected employees is also used in ESS mode within

the online pay advice history application.

Full history of pay advices with point in time review of any historical pay advice. The online

application details basic information for each pay advice as it was when originally generated.

A detailed pay advice in pdf format is available for each item by clicking a button on the detail

page. When the Pay Advice button is clicked, a pay advice in pdf format is generated by

initiating a Jasper report that displays in a new tab. This pay advice uses the same information

generated when the payroll was originally processed so will be a true point in time report.

Faster pay advice generation. Bulk and individual pay advices are substantially quicker and

simpler to generate using java and Jasper reporting functionality.

Lower implementation costs. The core Jasper report has been highly parameterised and

properties are easily modified. The goal would be for most customers to use the core report

rather than develop a custom pay advice.

The ability to bulk email employee pay advices via Jasper reporting. This can generate

significant savings for customers while providing pay advice information to employees faster.

Bulk emailing can be used in conjunction with ESS functionality rather than physical printing

and distributing pay advices.

A consistent storage mechanism (single point of truth) for pay advice information which can

be easily used for production and analytical reporting. For example, information contained in

the MSF8P* files would enable easy reporting on overtime information (days of week, dates,

units and value by employee, position, employee class, work group, crew, physical location,

work location, primary reporting code and so on) for further cost saving analysis.

Providing ESS users with the ability to nominate how they want to receive their pay advice

such as view online only, use work email, use home email, distribute to employee physical

location, distribute to employee work location, post to residential address, post to postal

address.

Single point of entry and review for ESS regardless of where the actual payroll calculations and

disbursements occur.

Pay advice which adheres to industry best practice.



Functional Enhancements This section details the individual enhancements made with this development item and the

associated design decisions:

1. Services created for the individual pay advice history tables. These services are used by the

new batch pay advice update program as well as the pay advice adapter.

2. New java batch program (MSB8PS) developed to populate the pay advice history tables as part

of the payroll calculate process. This batch program is run as part of the payroll preview and

update processes and populates the pay advice history tables for use by the online review of

pay advice history within the payroll workbench (MSE82S) and for use by the jasper pay advice

program.

3. Payroll Advice adapter created to support the import of pay advice details into Ellipse from a

3rd party application. This provides users the ability to review and print pay advices from with

ellipse even though the payroll was processed on another system.

4. New Jasper pay advice (MSJ8PA). New pay advice utilizes the core pay advice history tables

and is reproducible, quick to generate, cheap to create and distribute, meets legislative

requirements, is easy to understand, highly parameter driven and accurate for employer and

employee obligations.

5. Employee service and personnel workbench modified to support payslip distribution method.

This change provides users with the ability to create and update the preferred payslip

distribution method, so that the payslip is distributed per the preferred channel. Distribution


a. Online

b. home email

c. home address

d. work email

e. work address

6. Pay group configuration modified to accommodate additional attributes for payslip print

process. Enhancements are

a. Pay Slip Box to exclude – enables selection of a pay slip box to be excluded from

printing on pay slips. A value entered in this field will cause any earnings or deductions

with the same pay slip box value to be excluded from the pay slip.

b. Earnings Summary Only – indicates that the payslip earnings are to be in a summary

format (one line per code) or detail format (one line per transaction)

c. Increased length of logo path

7. Button added to Payroll Workbench (MSE82S) to initiate Jasper Pay Advice report (MSJ8PA)

for the most recent payroll update run. Clicking the button will initiate the pay advice report in

ESS mode and display the pay advice on a new tab within the browser. The existing custom

payslip button has been removed as the new button supports the core payslip and can be

modified to initiate a custom payslip.

8. Pay advice history tab on the Payroll Workbench has been modified to utilize the pay advice

history tables to populate the grid for those pay runs that have pay advice history tables

generated. For pay runs that do not have pay advice history associated with them, the grid will

be populated using the existing program logic.

9. New application MSE83S - Review Employee Pay Advice Details has been developed to display

the information on the pay advice history tables for a selected pay run. This replaces the

existing MSE83G application for those pay runs that have pay advice history details (for pay

runs that do not have pay advice history entries, the existing MSE83G application will continue

to be used to display the pay advice details). The MSE83S application includes a button to



initiate the Jasper Pay Advice report (MSJ8PA) for the payroll run being displayed. Clicking this

button will initiate the pay advice in ESS mode and display the pay advice on a new tab within

the browser.

10. Notional Earnings are now being displayed on the MSM823A - Review Employee Select Period

to Date Amounts and the MSM82EA - Review Employee Payroll Totals In Common Currency

screens. Notional Earnings are also being taken into account when calculating the Totals

Earnings on the Pay Advice History tab and associated details applications on the MSE82S -

Update Payroll Workbench.

Pay Advice Header Service The purpose of this service is to support the read, search and creation of MSF8P1 - Pay Advice Header

records.

The service supports the following methods:

Read - This method is used to read a single Pay Advice Header (MSF8P1) record.

Search - This method is used to search for Pay Advice Header records. It allows for searching

by Paygroup, PeriodEndDate, PayRunType and PayRunNo in any combination.

Create - This method is used to create a record on the Pay Advice Header table.

DeletePayRun - This method is used to delete all records from all Pay Advice tables that belong

to a specified pay run.

1. The standard Update method has not been provided as there is no functional requirement to be

able to update Pay Advice Header records. The Pay Advice Header record for a pay run contains static

data that will not change.

2. The standard Delete method has not been provided as a Pay Advice Header record should never be

deleted without also deleting all related records from other Pay Advice tables.

3. When creating Pay Advice Header records, mandatory inputs are Pay Group and Pay Run Type. If the

Pay Run Type is not Update, then the Pay Run No is also mandatory. The remaining fields on MSF8P1

are populated from existing database fields based on the Pay Group.

Pay Advice Earnings Service The purpose of this service is to support the read, search and creation of MSF8P2 - Pay Advice

Earnings records.


Read - This method is used to read a single Pay Advice Earnings (MSF8P2) record.

Search - This method is used to search for Pay Advice Earnings records. It allows for searching

by Pay Advice Header primary key and/or Earnings Code. It also supports being passed the

Paygroup, PeriodEndDate, PayRunType and PayRunNo used to derive the Pay Advice Header

primary key.

Create - This method is used to create a record on the Pay Advice Earnings table.


able to update Pay Advice Earnings records. The Pay Advice Earnings records for a pay run contain

static data that will not change.

2. The standard Delete method has not been provided as a Pay Advice Earnings record should never be


3. When creating Pay Advice Earnings records, the only mandatory input is Earnings Code. The related

Pay Advice Header record primary key must also be input unless Paygroup, PeriodEndDate,

PayRunType and/or PayRunNo is input, in which case these attributes are used to derive the Pay



Advice Header primary key. The remaining fields on MSF8P2 are populated from existing database

fields based on the Earnings Code.

Pay Advice Deduction Service The purpose of this service is to support the read, search and creation of MSF8P3 -Pay

Advice Deductions records.


Read - This method is used to read a single Pay Advice Deduction (MSF8P3) record.

Search - This method is used to search for Pay Advice Deduction records. It allows for

searching by Pay Advice Header primary key and/or Deduction Code. It also supports being

passed the Paygroup, PeriodEndDate, PayRunType and PayRunNo used to derive the Pay

Advice Header primary key.

Create - This method is used to create a record on the Pay Advice Deductions table.


able to update Pay Advice Deduction records. The Pay Advice Deduction records for a pay run contain


2. The standard Delete method has not been provided as a Pay Advice Deduction record should never

be deleted without also deleting all related records from other Pay Advice tables.

3. When creating Pay Advice Deduction records, the only mandatory input is Deduction Code. The

related Pay Advice Header record primary key must also be input unless Paygroup, PeriodEndDate,


Advice Header primary key. The remaining fields on MSF8P3 are populated from existing database

fields based on the Deduction Code.

Pay Advice Employee Service The purpose of this service is to support the read, search and creation of MSF8P4 - Pay Advice

Employee records.


Read - This method is used to read a single Pay Advice Employee (MSF8P4) record.

Search - This method is used to search for Pay Advice Employee records. It allows for

searching by Pay Advice Header primary key and/or Employee and/or Envelope Type. It also

supports being passed the Paygroup, PeriodEndDate, PayRunType and PayRunNo used to

derive the Pay Advice Header primary key.

Create - This method is used to create a record on the Pay Advice Employee table.

1. Update method is not required as records on MSF8P4 are a snapshot of an historical event and are

not updated.

2. Delete method is not required as individual pay advice related records will never be deleted. Pay

Advice records will only ever be deleted for an entire pay run.

3. Mandatory input fields are Pay Advice Header UUID and Employee Id and Envelope Type. These will

be validated against the MSF8P1, MSF810 and PENV table respectively.

Pay Advice Employee Period to Date Service The purpose of this service is to support the read, search and creation of MSF8P5 - Pay Advice

Employee PTD Earnings records.




Read - This method is used to read a single Pay Advice Employee PTD Earnings (MSF8P5)

record.

Search - This method is used to search for Pay Advice Employee PTD Earnings records. It

allows for searching by Pay Advice Header primary key and/or Pay Advice Employee primary

key and/or Earnings Code. It also supports being passed the Paygroup, PeriodEndDate,

PayRunType and PayRunNo used to derive the Pay Advice Header primary key and the

Employee Id and Envelope Type used to derive the Pay Advice Employee primary key.

Create - This method is used to create a record on the Pay Advice Employee

PTD Earnings table.


able to update Pay Advice Employee PTD Earnings records. The Pay Advice Employee

PTD Earnings records for a pay run contain static data that will not change.

2. The standard Delete method has not been provided as a Pay Advice Employee PTD Earnings record

should never be deleted without also deleting all related records from other Pay Advice tables.

3. When creating Pay Advice Employee PTD Earnings records, the only mandatory input is Earnings

Code. The related Pay Advice Header record primary key must also be input unless either the Pay

Advice Employee primary key or the Paygroup, PeriodEndDate, PayRunType and/or PayRunNo is input,

in which case these attributes are used to derive the Pay Advice Header primary key. The related Pay

Advice Employee primary key must be input unless the Employee and Envelope Type are input, in

which case these attributes will be used to derive the Pay Advice Employee primary key.

Pay Advice Employee Period to Date Service The purpose of this service is to support the read, search and creation of MSF8P6 - Pay Advice

Employee PTD Deduction records.


Read - This method is used to read a single Pay Advice Employee PTD Deduction (MSF8P6)

record.

Search - This method is used to search for Pay Advice Employee PTD Deduction records. It


key and/or Deduction Code. It also supports being passed the Paygroup, PeriodEndDate,

PayRunType and PayRunNo used to derive the Pay Advice Header primary key and being

passed the Employee Id and Envelope Type used to derive the Pay Advice Employee primary

key.

Create - This method is used to create a record on the Pay Advice Employee

PTD Deduction table.


able to update Pay Advice Employee PTD Deduction records. The Pay Advice Employee

PTD Deduction records for a pay run contain static data that will not change.

2. The standard Delete method has not been provided as a Pay Advice Employee

PTD Deduction record should never be deleted without also deleting all related records from other Pay

Advice tables.

3. When creating Pay Advice Employee PTD Deduction records, the only mandatory input

is Deduction Code. The related Pay Advice Header record primary key must also be input unless either

the Pay Advice Employee primary key or the Paygroup, PeriodEndDate, PayRunType and/or PayRunNo

is input, in which case these attributes are used to derive the Pay Advice Header primary key. The

related Pay Advice Employee primary key must be input unless the Employee and Envelope Type are

input, in which case these attributes will be used to derive the Pay Advice Employee primary key.



Pay Advice Employee Year to Date Taxation

Service The purpose of this service is to support the read, search and creation of MSF8P7 -Pay Advice

Employee YTD Taxation records.


Read - This method is used to read a single Pay Advice Employee YTD Taxation (MSF8P7)

record.

Search - This method is used to search for Pay Advice Employee YTD Taxation records. It


key and/or Federal Id and/or Tax Authority Code and/or US Tax Type. It also supports being

passed the Paygroup, PeriodEndDate, PayRunType and PayRunNo used to derive the Pay

Advice Header primary key and being passed the Employee Id and Envelope Type used to

derive the Pay Advice Employee primary key.

Create - This method is used to create a record on the Pay Advice

Employee YTD Taxation table.

Design Decisions:


able to update Pay Advice Employee YTD Taxation records. The Pay Advice Employee YTD Taxation

records for a pay run contain static data that will not change.

2. The standard Delete method has not been provided as a Pay Advice Employee YTD Taxation record


3. When creating Pay Advice Employee YTD Taxation records, mandatory inputs are Federal Id, Tax

Authority Code and US Taxation Type. The related Pay Advice Header record primary key must also be

input unless either the Pay Advice Employee primary key or the Paygroup, PeriodEndDate, PayRunType

and/or PayRunNo is input, in which case these attributes are used to derive the Pay Advice Header

primary key. The related Pay Advice Employee primary key must be input unless the Employee and

Envelope Type are input, in which case these attributes will be used to derive the Pay Advice Employee

primary key.

Pay Advice Employee Current Period Taxation

Service The purpose of this service is to support the read, search and creation of MSF8P8 Pay Advice

Employee Current Period Taxation records.


Read - This method is used to read a single Pay Advice Employee Current Period Taxation

(MSF8P8) record.

Search - This method is used to search for Pay Advice Employee Current Period

Taxation records. It allows for searching by Pay Advice Header primary key and/or Pay Advice

Employee primary key and/or Federal Id and/or Tax Authority Code and/or US Tax Type. It

also supports being passed the Paygroup, PeriodEndDate, PayRunType and PayRunNo used to

derive the Pay Advice Header primary key and being passed the Employee Id and Envelope

Type used to derive the Pay Advice Employee primary key.

Create - This method is used to create a record on the Pay Advice Employee Current Period

Taxation table.




able to update Pay Advice Employee Current Period Taxation records. The Pay Advice Employee

Current Period Taxation records for a pay run contain static data that will not change.

2. The standard Delete method has not been provided as a Pay Advice Employee Current

Period Taxation record should never be deleted without also deleting all related records from other

Pay Advice tables.

3. When creating Pay Advice Employee Current Period Taxation records, mandatory inputs are Federal

Id, Tax Authority Code and US Taxation Type. The related Pay Advice Header record primary key must

also be input unless either the Pay Advice Employee primary key or the Paygroup, PeriodEndDate,


Advice Header primary key. The related Pay Advice Employee primary key must be input unless the

Employee and Envelope Type are input, in which case these attributes will be used to derive the Pay

Advice Employee primary key.

Pay Advice Employee Current Period Earnings

Service The purpose of this service is to support the read, search and creation of MSF8P9 -Pay Advice

Employee Current Period Earnings records.


Read - This method is used to read a single Pay Advice Employee Current Period Earnings

(MSF8P9) record.

Search - This method is used to search for Pay Advice Employee Current Period Earnings

records. It allows for searching by Pay Advice Header primary key and/or Pay Advice Employee

primary key and/or Earnings Code and/or Transaction Date. It also supports being passed the

Paygroup, PeriodEndDate, PayRunType and PayRunNo used to derive the Pay Advice Header

primary key and being passed the Employee Id and Envelope Type used to derive the Pay


Create - This method is used to create a record on the Pay Advice Employee Current

Period Earnings table.


able to update Pay Advice Employee Current Period Earnings records. The Pay Advice

Employee Current Period Earnings records for a pay run contain static data that will not change.


Period Earnings record should never be deleted without also deleting all related records from other

Pay Advice tables.

3. When creating Pay Advice Employee Current Period Earnings records, mandatory inputs are

Earnings Code and Transaction Date. The related Pay Advice Header record primary key must also be

input unless either the Pay Advice Employee primary key or the Paygroup, PeriodEndDate, PayRunType

and/or PayRunNo is input, in which case these attributes are used to derive the Pay Advice Header

primary key. The related Pay Advice Employee primary key must be input unless the Employee and

Envelope Type are input, in which case these attributes will be used to derive the Pay Advice Employee

primary key.

Pay Advice Employee Current Period Earnings

Service The purpose of this service is to support the read, search and creation of MSF8PA -Pay Advice

Employee Current Period Deduction records.




Read - This method is used to read a single Pay Advice Employee Current

Period Deduction (MSF8PA) record.

Search - This method is used to search for Pay Advice Employee Current

Period Deduction records. It allows for searching by Pay Advice Header primary key and/or Pay

Advice Employee primary key and/or Deduction Code and/or Transaction Date. It also

supports being passed the Paygroup, PeriodEndDate, PayRunType and PayRunNo used to



Create - This method is used to create a record on the Pay Advice Employee Current

Period Deduction table.


able to update Pay Advice Employee Current Period Deduction records. The Pay Advice

Employee Current Period Deduction records for a pay run contain static data that will not change.


Period Deduction record should never be deleted without also deleting all related records from other

Pay Advice tables.

3. When creating Pay Advice Employee Current Period Deduction records, mandatory inputs

are Deduction Code and Transaction Date. The related Pay Advice Header record primary key must

also be input unless either the Pay Advice Employee primary key or the Paygroup, PeriodEndDate,


Advice Header primary key. The related Pay Advice Employee primary key must be input unless the

Employee and Envelope Type are input, in which case these attributes will be used to derive the Pay


Pay Advice Employee Banking Details Service The purpose of this service is to support the read, search and creation of MSF8PB -Pay Advice

Employee Banking records.


Read - This method is used to read a single Pay Advice Employee Banking (MSF8PB) record.

Search - This method is used to search for Pay Advice Employee Banking records. It allows for

searching by Pay Advice Header primary key and/or Pay Advice Employee primary key

and/or Branch Code and/or Bank Account No. It also supports being passed the Paygroup,

PeriodEndDate, PayRunType and PayRunNo used to derive the Pay Advice Header primary key

and being passed the Employee Id and Envelope Type used to derive the Pay Advice Employee

primary key.

Create - This method is used to create a record on the Pay Advice Employee Banking table.


able to update Pay Advice Employee Banking records. The Pay Advice EmployeeBanking records for a

pay run contain static data that will not change.

2. The standard Delete method has not been provided as a Pay Advice Employee Banking record


3. When creating Pay Advice Employee Banking records, mandatory inputs are Branch Code and Bank

Account No. The related Pay Advice Header record primary key must also be input unless either the

Pay Advice Employee primary key or the Paygroup, PeriodEndDate, PayRunType and/or PayRunNo is

input, in which case these attributes are used to derive the Pay Advice Header primary key. The related

Pay Advice Employee primary key must be input unless the Employee and Envelope Type are input, in




Pay Advice Messages Service The purpose of this service is to support the read, search and creation of MSF8PC -Pay Advice

Message records.


Read - This method is used to read a single Pay Advice Message (MSF8PC) record.

Search - This method is used to search for Pay Advice Message records. It allows for searching

by Pay Advice Header primary key and/or Pay Advice Employee primary key. It also supports

being passed the Paygroup, PeriodEndDate, PayRunType and PayRunNo used to derive the Pay

Advice Header primary key and being passed the Employee Id and Envelope Type used to

derive the Pay Advice Employee primary key.

Create - This method is used to create a record on the Pay Advice Message table.


able to update Pay Advice Message records. The Pay Advice Message records for a pay run contain


2. The standard Delete method has not been provided as a Pay Advice Message record should never be


3. When creating Pay Advice Message records, mandatory inputs are Message Type and Payslip

Message. The related Pay Advice Header record primary key must also be input unless either the Pay





Pay Advice Leave Information Service The purpose of this service is to support the read, search and creation of MSF8PD -Pay Advice Leave

records.


Read - This method is used to read a single Pay Advice Leave (MSF8PD) record.

Search - This method is used to search for Pay Advice Leave records. It allows for searching by

Pay Advice Header primary key and/or Pay Advice Employee primary key and/or Leave Type. It

also supports being passed the Paygroup, PeriodEndDate, PayRunType and PayRunNo used to



Create - This method is used to create a record on the Pay Advice Leave table.


able to update Pay Advice Leave records. The Pay Advice Leave records for a pay run contain static

data that will not change.

2. The standard Delete method has not been provided as a Pay Advice Leave record should never be


3. When creating Pay Advice Leave records, the only mandatory input is Leave Type. The related Pay

Advice Header record primary key must also be input unless either the Pay Advice Employee primary

key or the Paygroup, PeriodEndDate, PayRunType and/or PayRunNo is input, in which case these

attributes are used to derive the Pay Advice Header primary key. The related Pay Advice Employee

primary key must be input unless the Employee and Envelope Type are input, in which case these

attributes will be used to derive the Pay Advice Employee primary key.



Pay Advice Other Information Service The purpose of this service is to support the read, search and creation of MSF8PE -Pay Advice Other

Information records.


Read - This method is used to read a single Pay Advice Other Information (MSF8PE) record.

Search - This method is used to search for Pay Advice Other Information records. It allows for

searching by Pay Advice Header primary key and/or Pay Advice Employee primary key

and/or Other Information Type. It also supports being passed the Paygroup, PeriodEndDate,

PayRunType and PayRunNo used to derive the Pay Advice Header primary key and being

passed the Employee Id and Envelope Type used to derive the Pay Advice Employee primary

key.

Create - This method is used to create a record on the Pay Advice Employee Banking table.


able to update Pay Advice Other Information records. The Pay Advice Other Information records for a

pay run contain static data that will not change.

2. The standard Delete method has not been provided as a Pay Advice Other Information record


3. When creating Pay Advice Other Information records, the only mandatory input is Other Information

Type. The related Pay Advice Header record primary key must also be input unless either the Pay





Pay Advice History Update (java batch) Java batch program (MSB8PS) written to populate Pay Advice (MSF8P*) files with data generated

from pay previews and pay updates so the MSF8P* files can be used for MSE82S, pay advices and

other reporting. The MSB8PS program will run automatically as part of the pay preview and pay

update streams. As a result of the automated population of the MSF8P* files, the MSB82U, MSB82Y

and MSB82Z batch jobs and associated MSTs have been made obsolete.

Pay Advice (Jasper – MSJ8PA) New Jasper pay advice (MSJ8PA). The new pay advice utilizes the core pay advice history tables and is

reproducible, quick to generate, cheap to create and distribute, meets legislative requirements, is

easy to understand, highly parameter driven and accurate for employer and employee obligations.

The pay advice is heavily parameterized in order to meet the majority of pay advice requirements

without any code changes. If an alternative format, or different details are required, this pay advice

can be used as a template or starting point for a custom solution.

The pay advice can be run in batch mode for an entire pay process (or for selections within the pay

process), or can be initiated by clicking a button on the payroll workbench.

Batch Pay Advice Processing Batch processing of pay advices enables the printing and/or emailing of pay advices for all or selected

employees in a pay process. There are several request parameters that determine the pay run to print,

selected employees, display options, filtering, print sequence, etc. For example, you can select pay

advices for a pay group, a pay type and a pay location for a specified pay period. You can also run a

pay advice for a single employee ID for a selected pay period.



Batch Request Information

Pay Group The pay group for which the pay advices will be processed for.

Run Type The run type to process, must be one of the following:

M - Manual. You will need to also enter a Run Number for this option.

P - Preview. You will need to also enter a Run Number for this option.

U - Update

Run Number Run number for Manual or Preview run types.

Period End Date Pay period ending date for which the pay advices will be processed for.

Sort Order Sort sequence for printing of pay advices. If left blank will default to

Employee Id sort sequence.

Code or Desc This controls the display of earnings and deduction codes, will default to

BOTH if left blank

CODE - displays the code only

DESC - displays the description of the code only

BOTH - displays the code and the description

Employee ID Enter employee ID to print a pay advice for a single employee.

Pay Location Enter a pay location to print pay advices for a single pay location. Leave

blank to print for all pay locations.

Override Distribution

Preference

Indicates that the employee distribution preferences will be overridden and

all pay advices will be printed. Enter Y to override employee's pay advice

distribution method and print all pay advices.

Alternate Coloured

Rows

Option to display alternate shaded rows to help track rows on long pay

advices. Enter Y to display with shading.

Pay Advice Header

UUID

This field enables selection by the UUID key to the Pay Advice Header

record and is not required when running in batch.

Pay Advice Employee

UUID

This field enables selection by the UUID key to the Pay Advice Employee

record and is not required when running in batch.

Preference Filter Enter a payroll distribution method code to select only pay advices for

employees configured with the requested distribution method.

Pay Distribution

Graph

Provides the ability to produce a pie chart of how an employee's gross pay

is distributed between deductions, tax and bank deposits. Enter Y if a

distribution graph is required.

ESS Pay Advice Processing Pay advices for an employee can be initiated and displayed from within the Payroll Workbench by

clicking the Pay Advice (MSJ8PA) button on the main page of the payroll workbench to produce the

last pay period pay advice, or on the details page of Pay Advice History to produce the pay advice for

the selected pay run.



Last Pay Run Pay Advice

To access the Pay Advice for the most recent pay run click the Pay Advice button on the payroll

workbench.

A pay advice in PDF format displays in a new browser tab.

Historical Pay Run Pay Advice

To access the pay advice for a selected payroll process.

Click the Pay Advice (MSJ8PA) button

to initiate the pay advice for the last

pay period.



The Pay Advice History grid displays

Pay Advice Details will be displayed, including a button for displaying the pay advice

Select Pay Advice History tab.

Select any pay process from the

grid.



A pay advice in PDF format for the selected pay process displays in a new browser tab.


to initiate the pay advice for the pay

process displayed.



Preview Pay Run Pay Advice

Depending upon configuration and security access, pay previews may be available for access in the

Pay Advice History. If a pay preview is displayed, the pay advice for the preview process can be

displayed using the same process as described above.

Pay advice details for the preview will be displayed

A pay advice in PDF format displays in a new browser tab (including a watermark indicating that is a

preview).

Select pay preview process from the

grid.


to initiate the pay advice for the pay

preview currently displayed.



Employee Personnel Workbench The Employee Personnel Workbench has been modified to support a payslip distribution method on

the Contacts tab. This change provides users with the ability to create and update the preferred

payslip distribution method so that the payslip is distributed per the preferred channel. Distribution


a. Online

b. home email

c. home address

d. work email

e. work address



Pay group Pay group configuration is modified to accommodate additional attributes for payslip print process.

Enhancements are:

Pay Slip Box to exclude – enables selection of a pay slip box to be excluded from printing on

pay slips. A value entered in this field will cause any earnings or deductions with the same pay

slip box value to be excluded from the pay slip.

Earnings Summary Only – indicates that the payslip earnings are to be in a summary format

(one line per code) or detail format (one line per transaction)

Increased length of logo path



Notional Earnings Notional Earnings are now being displayed on the MSM823A - Review Employee Select Period to Date

Amounts and the MSM82EA - Review Employee Payroll Totals In Common Currency screens. Notional

Earnings are also being taken into account when calculating the Totals Earnings on the Pay Advice

History tab on the MSE82S - Update Payroll Workbench and associated details applications



How to Configure Modules

Module

No

Module Name Required Notes

3001 General Module Mandatory Required for all payroll types.

3760 Personnel Administration Mandatory* Required to use all payroll types except ‘No

Payroll ‘.

3785 Salary Administration Optional Required for the payroll types of Gross and Full

Payroll.

3801 Payroll Configuration Mandatory* Required to configure the payroll types of

Rostered, Timekeeping, Gross and Full Payroll.

3820 Payroll Management Mandatory* Required to administer the payroll types of

Timekeeping, Gross and Full Payroll.

3840 Higher Duties Optional Optional for all payroll types.

3870 Position Management Mandatory Required for all payroll types

3880 Absence Management Optional* Optional to administer the payroll types of


Not applicable for the payroll type of No Payroll.

3890 Time Management Mandatory* Required to administer the payroll types of


Not applicable for the payroll type of No Payroll.

3895 Retrospective Payments Optional Optional method to administer retrospective

payments for payroll types of Gross and Full

Payroll. Not applicable to the payroll types of No

Payroll, Rostered and Timekeeping.

System Control File Screen Attribute Required Notes

Not applicable n/a No new system control file attributes

were created.

.

District Control File Screen Attribute Required Notes

Not applicable n/a No new district control file attributes

were created.

Table Codes 010 Table Description Required Notes

PSDM Payslip Distribution Method Yes Ventyx supplied table used to validate

employee payslip distribution method.

If any distribution methods are not

supported the Active indicator for the

individual table code must be set to

‘N’.



010 Table Description Required Notes

FRPM Form Reports Yes New entries added to support the

addition of a button for MSJ8PA (Pay

Advice) to MSE82S and MSE83S.

FPMP Form Parameter Mappings Yes New entries added to support the

addition of a button for MSJ8PA (Pay

Advice) to MSE82S and MSE83S

PAYR Payroll Report Program Yes

PRVR Payroll Preview Update Requests Yes

UPDR Payroll Calculation Update requests Yes

FRPM – Form Reports New entries have been added to the MSF010:FRPM table for table codes ‘MSE82S 01‘ and ‘MSE83S 01‘

for the report MSJ8PA (Jasper Pay Advice). The entry of these codes indicates that a button to initiate

the pay advice will be rendered on the applications MSE82S and MSE83S. The table codes have been

configured to not show default prompts as the intent is to initiate the pay advice without any

interaction by the user once the button has been selected.

FPMP – Form Parameter Mappings New entries have been added to the MSF010:FPMP table to control the parameters used when

processing the pay advice from within MSE82S and MSE83S.

These table entries are used to map and populate the request parameter information required by the

pay advice and by modifying these entries,or adding entries for additional parameters, it is possible

to change how the ESS pay advice displays.

MSE82S FPMP Entries

The Ventyx supplied entries for MSE82S are:

The Table Code indicates which online application the form is on (MSE82S), which report (MSJ8PA00)

and the parameter number from the request configuration.

The Description is either a constant value or the content of a field from the application.

The Associated Values indicate whether the Description field is a constant value or an application field

value.



Using the request information above and the FPMP configuration, the Ventyx supplied entries are

populating the following request parameters when initiating the pay advice:

10 Alternate Coloured Rows Y (indicates that alternate rows will be shaded)

11 Pay Advice Header UUID Pay Advice Header UUID for record being displayed

12 Pay Advice Employee UUID Pay Advice Employee UUID for record being displayed

14 Pay Distribution Graph Y (indicates that the distribution graph will be displayed)

It is possible to add another parameter to tailor the pay advice if required, for example:

MSE82S MSJ8PA0006 DESC V

This indicates that the pay advice would be run with Code or Desc request parameter set to DESC.

MSE83S FPMP Entries

The Ventyx supplied entries for MSE82S are:

The Table Code indicates which online application the form is on (MSE83S), which report (MSJ8PA00)

and the parameter number from the request configuration.

The Description is either a constant value or the content of a field from the application.

The Associated Values indicate whether the Description field is a constant value or an application field

value.



Using the request information above and the FPMP configuration, the Ventyx supplied entries are

populating the following request parameters when initiating the pay advice:

10 Alternate Coloured Rows Y (indicates that alternate rows will be shaded)

11 Pay Advice Header UUID Pay Advice Header UUID for record being displayed

12 Pay Advice Employee UUID Pay Advice Employee UUID for record being displayed

14 Pay Distribution Graph Y (indicates that the distribution graph will be displayed)

It is possible to add another parameter to tailor the pay advice if required, for example

MSE83S MSJ8PA0006 DESC V

This indicates that the pay advice would be run with Code or Desc request parameter set to DESC.

PSDM – Payslip Distribution Method Ventyx supplied distribution methods, the active indicator on MSF010 controls which methods are

available.

Data Conversion MSF810 (Core Employee) conversion modified to accommodate pay slip distribution method.

MSF801_PG_801 (Pay Group) conversion modified to accommodate additional attributes on pay

group record.

Security Not applicable



Core Menu Changes No core menu changes have been made as a result of this development item.

Other Configuration This functional overview does not detail the pre-existing configuration requirements for employees

and payroll.

Business Process This development item enables the core pay advice files (MSF8P* series tables) to be populated and

reported upon by Ellipse ‘Full Payroll‘ customers and by those customers using the Global Payroll

Adaptor solution (‘Timekeeping‘ and ‘Gross‘ payroll customers).

The process for ‘Full Payroll‘

Pay Group configured with pay advice specific controls

Employee configured with pay slip distribution method (optional)

Payroll preview and update processes populate the pay advice history tables

Pay advice batch report run and pay advices printed or emailed to employees

Employee review of pay advice via ESS

The process for ‘External Payroll‘

Pay Group configured with pay advice specific controls

Employee configured with pay slip distribution method (optional)

Payroll process generates transactions for posting to 3rd party payroll

3rd party payroll sends results to Ellipse in order to populate the pay advice history tables

Pay advice batch report run and pay advices printed or emailed to employees

Employee review of pay advice via ESS



Functional Overview The following activities can be performed as a result of this development item:

Configure pay advice requirements at pay group level.

Assign a Payslip Distribution Preference setting on MSE81S – Personnel Workbench to store an

individual’s preference for pay advice delivery information such as ESS, Work Email, Home

Email and so on.

Produce a core pay advice for emailing or printing. This includes the ability to bulk email

(burst) pay advices to employees.

Individual employee pay advices in Ellipse and available via Employee Self Service.

pay advice | abb

Documents