Atrieve Payroll

Earnings Statement Parameter Profile

The Earnings Statement Parameters Profile module allows you to define the layout of your earnings statement.

In order to utilize the User Defined Earnings Statement, you must first layout the earnings statement on paper. The profile allows you build an earnings statement as you go. You must enter the variable earnings statement program name in the User's Specific Parameters Profile, field 2 (e.g. SRB$OPSEXE:PRPY0S).

When entering the parameters for the earnings statements the line number in the profile should be the line you want the output on (e.g., needs output on line 9, use line 9 in the profile).Your print masks do not need to account for the minus (-) sign. The minus sign floats on the left side of each amount where required.

Print masks and line numbers operate differently between the Cheque and Earnings statement programs.


Need

Use for Cheque

Use for Earn STMT

Print Mask

9 characters

9

8

Line Number

Line 9

8

9

Line #

  • Enter the line number to be created or changed.

Line Segment

  • Enter the segment of the line to be created or changed according to the following options detailed.

M

This is the most common segment for a line. It indicates a main section. Unless the line segment falls under one of the types below, this will be your line segment type. The L and T detailed below are only if you require static information before or after the repeating information on the same line as the repeating line information.

L

This is a leading segment. It is printed before a main segment. The purpose of this type is for printing a repeating line with static data before it. This line segment will be printed exactly on the line specified. This segment will default to a line type of N regardless of the line type of the main segment.

T

This is a trailing segment. It is printed after a main segment. The purpose of this type is for printing a repeating line with static data after it. This line segment will be printed exactly on the line specified. This segment will default to a line type of N regardless of the line type of the main segment.

If you are making changes to a line, the system will bring up the line information. The next prompt will be the column prompt.

S

A Line SEGMENT of 'S' allows the definition of the field names applicable for including an employee's timesheet details on the earning statement. Lines defined for printing of timesheet detail may not contain any other information.

C

A Line SEGMENT of 'C' allows the definition of the maximum line on which timesheet detail may be printed. All remaining timesheet details will be summarized and printed on this line. The definition of a compression line will ensure the timesheet details do not extend the size of the earnings statement beyond the specified line.

'S' & 'C' line types are for reporting timesheet details on the earning statement.  Details and examples are included below.

If you are making changes to a line, the system will bring up the line information. The next prompt will be the column prompt.

Type

  • Enter the type of line to be created according to the following options:

N

This is a non-repeating line which will print at the line number specified. You must take care if this type of line is to follow a series of repeating lines. It must be placed so that it is below the lowest possible line of the repeating line.

F

This is a following line. Its intended use is for information which is to be printed directly following a repeating line and whose position will vary with the number of repeating lines elements. A following line may be made up of elements which will repeat.

R

This is a repeating line. It will print elements such as a list of pay codes until that list ends. Only pay code, deduction code, bank code and message text are available for use with this line type. the specific field names are detailed below.

This field will be filled automatically if you are editing an existing line or if the line segment is either 'T' or 'L'. If the line segment is either 'T' or 'L', then the line type will be 'N' and may not be changed. NOTE: To have a blank line between 'F' type lines, you must enter an 'F' type line containing a 'LIT' field which contains a space.

NOTE: The repeating message line must be defined as a Main section and must be the only repeating field on the line. 

NOTE: The benefit repeating codes cannot be defined on the same line as the deduction repeating codes. The benefit repeating codes are a separate list of deductions only containing those deductions that have a share or benefit amount.

Col #

  • Enter the column number where the field is to be placed. The column number prompt will allow you to enter a column number up to a maximum of 210. Most printers have a maximum of 132 characters wide.  

Items defined to be printed after the 80th column will not display on the screen. Items defined to be printed after the 99th column will not display on the Earnings Statement Parameter report.

Field

This is the prompt for the field name you wish printed at this column position. The field names are verified against a master list and must be on the list.  Use look-up for a list of valid field names.

  • Enter 'LIT' to enter a user defined phase.

SIZE

This prompt is only accessed on fields with variable lengths. Enter the length you wish the field to be. This is checked to verify that you have not gone over the maximum length. If you do go over the maximum, you will be re-prompted for the length.

A line with a Line SEGMENT of 'S' allows the definition of the field names applicable for including an employee's timesheet details on the earning statement. Lines defined for printing of timesheet detail may not contain any other information. This special line segment type includes three field names:

TMTLE     allows definition of a header, if applicable.

TMSHT    defines the column where the timesheet information is to be printed. The timesheet detail printed is static and includes the date, pay code description and number of hours/days worked. The timesheet detail is sorted by date and will leave a blank line between weeks. 

TMTOT allows the definition of a total description and indicates the total hours/days are to be printed. The total line will be printed one blank line after the timesheet details has been completed.

These special field names are the only fields that may be defined on a line with the line segment of 'S'. The field name TMSHT is mandatory, the header (TMTLE) and total (TMTOT) are optional.

NOTE: The User Specific Parameters Profile field Timesheet Details on Earning Statement allows for specific pay codes to be selected for inclusion on the earnings statement. When this User Specific Parameter Profile field is empty, all pay codes will be printed; when pay codes are defined in this field, only those pay codes are printed.

The following is an example of the definition of the timesheet details fields:

Line Segment 'S'

Line   SEG   Type  COL  Field  SIZE  Literal

052     S          F      020   TMTLE    24     DETAILS for Days Paid         

052     S          F      022   TMSHT   60

052     S          F      041   TMTOT   15     TOTAL Days Paid

Line Segment 'C' 

A line with a Line Segment of 'C' allows the definition of the maximum line on which timesheet detail may be printed. All remaining timesheet details will be summarized and printed on this line. The definition of a compression line will ensure the timesheet details do not extend the size of the earnings statement beyond the specified line. The compression line will only accept the definition of a Literal Field. The literal description defined on this line will indicate the description to be used for the compressed items.

The following is an example of the definition of a Timesheet Compression Line:

060    C          F      022     LIT       22     Other Time - No Detail

Valid Field NAMES

Field Name

Field Type

Field LENGTH

Field MASK

Calculations

Field Description

Name

CHAR

50



Employee's Name

ADD1

CHAR

30



Address Line 1

ADD2

CHAR

30



Address Line 2

ADD3

CHAR

40



City, Prov Code

City

CHAR

28



City line

PROV

CHAR

10



Prov Code or value in province field

PROV2

CHAR

30



Long form of province

ADD4

CHAR

50



City, Province Long form

ADD5

CHAR

50



City, Province Code Postal Code

ADD6

CHAR

50



City, Province Long Form Postal Code

POST

CHAR

10



Postal Code

EMP#

CHAR

10



Employee Number

Email

CHAR

99



Employee's Email Address – attached client domain when applicable

PASSW

CHAR

10



Employee PDF Statement password

YPP

Fixed

  6

YYYYPP


Pay Period

LOCAT

CHAR

  4



Employee's Location Code

SIN

CHAR

10



Social Insurance Number

FEXP

NUMERIC

16



Federal Exemption

PEXP

NUMERIC

16



Provincial Exemption

IDATL

Fixed

11

DD-MMM-YYYY


Employee's Increment Date – Pay screen

SDATL

Fixed

11

DD-MMM-YYYY


Employee's Seniority Date – Pay screen

VDATL

Fixed

11

DD-MMM-YYYY


Employee's Vacation Date – Pay screen

HDATL

Fixed

11

DD-MMM-YYYY


Employee's Current Hire Date – Pay screen

ODATL

Fixed

11



Employee's Original Hire Date – Pay screen

atrieveHR##

CHAR

80 maximum



atrieveHR User Defined Field 01 -> 40 see below

CDATE

Fixed

  8

YYYYMMDD


Statement Date

PDATE

Fixed

  8

YYYYMMDD


Pay Period End Date

CDATL

Fixed

11

DD-MMM-YYYY


Cheque Date

PDATL

Fixed

11

DD-MMM-YYYY


Pay Period End Date

CDATS

Fixed

 8

YY/MM/DD


Cheque Date

PDATS

Fixed

 8

YY/MM/DD


Pay Period End Date

LIT

CHAR

70



Literals

PCODE

Fixed

 2

##


Pay Codes  (repeating)

PDESC

CHAR

30



Pay Code Description  (repeating)

PHour

NUMERIC

16



Pay Code Hours  (repeating)

PRate

NUMERIC

16



Pay Code Rate  (repeating)

PAMT

NUMERIC

16



Pay Code Amount  (repeating)

DCODE

Fixed

 2



Deduction Code  (repeating)

DDESC

CHAR

30



Deduction Description  (repeating)

VDESC

CHAR

30



Deduction/Table Description (note below)  (repeating)

DAMT

NUMERIC

16



Deduction Amount  (repeating)

PYTD

NUMERIC

16



Pay Code  Amount Year to Date  (repeating)

DYTD

NUMERIC

16



Deduction Year to Date  (repeating)

Gross

NUMERIC

16



Gross Earnings

NET

NUMERIC

16



Net Pay

CHEK

CHAR

10



Cheque Number

CAMT

NUMERIC

10

**#,###.##**


Cheque Amount







DTOT

NUMERIC

16



Deduction Total

PYTDH

NUMERIC

16



Pay Year to Date Hours  (repeating)

ACC#

CHAR

20



Account Number

DSHR

NUMERIC

16



Deduction Share  (repeating)

GYTD

NUMERIC

16



Gross Year to Date

DEDTD

NUMERIC

16



Deduction to Date

Trans

CHAR

10



Transit Number

SHYTD

NUMERIC

16



Share Year to Date  (repeating)

EIYTD

NUMERIC

16



Share Year to Date EI Rebate specific (repeat)

SHTOT

NUMERIC

16



Share Total

SHTD

NUMERIC

16



Share to Date Total

EITD

NUMERIC

16



Share to Date EI Rebate specific

SCODE

Fixed

2

##


Benefit deduction  (repeating) Benefit repeating fields are compressed for deductions with share amounts only.

SDESC

CHAR

30



Benefit deduction description (repeating)

CSHR

NUMERIC

16



Benefit amount (repeating)

CYTD

NUMERIC

16



Benefit Year To Date (repeating)

CTOT

NUMERIC

16



Benefit Total (use with CSHR)

CTD

NUMERIC

16



Benefit to Date Total (use with CYTD)

BCODE

Fixed

 2

##


Bank Code  (repeating)

BDESC

CHAR

30



Bank Description  (repeating)

TDESC

CHAR

30



Bank Table Description  (repeating)

BHour

NUMERIC

16


Y

Bank Hours  (repeating)

BAMT

NUMERIC

16


Y

Bank Amount  (repeating)

BVAL

NUMERIC

16



Storage Bank Hours or Bank Amount  (repeat)

BUsed

NUMERIC

16



Current Storage Bank Withdrawals – prints as '(Used ###,###.##)' (repeat)

HTOT

NUMERIC

16



Total Hours

YHTOT

NUMERIC

16



Total YTD Hours

YNET

NUMERIC

16



Net Total to Date

OCCU

Fixed

 4

####


Occupation Code

Shift

Fixed

 1

#


Shift Code

CATER

CHAR

 4



Employee Type (Code)

PAYTY

Fixed

 1



Pay Type

MESSG

CHAR

99



Message (Must be line segment MAIN) (repeat)

PTYPD

CHAR

30



Pay Type

CATED

CHAR

30



Employee Type (Code)-Description

TRAND

CHAR

30



Transit description

LOCAD

CHAR

30



Location Description

COSTD

CHAR

30



Cost Center Description

OCCUD

CHAR

30



Occupation Description

SHIFD

char 

30



Shift Code Description

FRate

NUMERIC

16



Pay Code Rate from Master Function

FHour

NUMERIC

16



Pay Code Hours from Master Function

RANNL

NUMERIC

16



Annualized Salary Grid Rate from Master

%ANNL

NUMERIC

16



Annualized Grid Rate prorated by FTE

BNAMT

NUMERIC

16



Taxable Benefit Amount  (repeating) with DED

BNTD

NUMERIC

16



Total YTD Taxable Benefits

BNYTD

NUMERIC

16



YTD Taxable Benefits  (repeating) with DED

BNTOT

NUMERIC

16



Total Taxable Benefits


CHAR

30



Taxable Benefit Description (repeating) with SHR

CNAMT

NUMERIC

16



Taxable Benefit Amount (repeating) with SHR

CNYTD

NUMERIC

16



YTD Taxable Benefit (repeating) with SHR

SGRID

Fixed

  6



Salary Grid from Master Function line

GDESC

CHAR

30



Salary Grid description

SEQNO

NUMERIC

  6

######


Sequence or Page number

perC

Fixed

  7

###.##%


% Employed For First Active Function Line

perS

Fixed

7

###.##%


% Employed For All Active Function Lines

FTE

Fixed

6

#.####


% Employed for First Active Function Line

FTES

Fixed

6

#.####


% Employed For All Active Function Lines













WFDAY

NUMERIC

8

###.##


Working Days from Payroll Calendar

WPDAY

NUMERIC

8

###.##


Working Days from Payroll Calendar prorated by Employee's FTE for all active function lines

*PRM##   Enter PRM followed by the applicable PRM user defined field number to have the employee's user defined field value printed on the earning statement.  PRM01 up to PRM40 relates to the employee's PRM User Defined Demographic screen field value. 

*perC and perS, FTE and FTES These fields only apply when field #39= Percentage Employed is active on the User Specific Parameter Profile. Function lines with a pay type of Hourly, Part-time or Lump sum are not applicable and will display as a blank.

*SEQNO This field prints an incrementing number starting at 1 that can be used to represent page numbers. This can be used to identify which pages of the Earnings Statement you want to reprint in the event the printer jams part way through a print job. Refer to Print Earnings Statements for details on restarting a print of the Earnings Statements.

*BVAL Will print either the storage bank hours or bank amount depending on the first character entered on the transaction field on the storage bank table. If the transactions are defined as EH or E then earnings will be printed.

When the transactions are defined as HE or H then the bank hours will be printed. Note that changing a storage bank table value requires that the Earnings Summary and Payroll Processing phases must both be rerun.

*BUsed     Will print '(Used ###,###.##)' where the value is the employee's total current withdrawals (WD) and Withdrawal Adjustments (WJ) of hours or earnings. The withdrawal adjustments included are since the last pay statement. If the transactions are defined as EH or E then earnings will be printed. When the transactions are defined as HE or H then the bank hours will be printed.  A field on the Storage Bank table controls which bank tables will print the Used. Nothing will print when no withdrawals were made for the pay period.

*VDESC    use this code word instead of 'DDESC' to print the deduction code descriptions. When VDESC is used the deduction table description used instead of the deduction code description when a vendor number has been defined on the deduction table database.

*MESSG    this field Must be set to a line segment of MAIN and type 'repeating'. 

*EIYTD   is a replacement for SHYTD and EITD is a replacement for SHTD. These EI Rebate specific codes allow for reporting of the EI Rebate under the employer share when the EI Rebate is paid out each pay period. The employer portion of the EI Rebate is cleared each time the EI Rebate is paid out making reporting ineffective. These special codes will add the employee's year to date EI Rebate amount (multiplied by 1 as the value is negative) to the employer portion for reporting of the full EI Rebate per year.

The following field names Only apply when multiple bank accounts are being used. Refer to the employee's Pay screen under Employee Additions for more information.

Field Name

Field Type

Field LENGTH

Field MASK

Calculations

Field Description

NET2

NUMERIC

16



Second Net Pay

NETT

NUMERIC

16



Total Net Pay

CAMT2

NUMERIC

10

**#,###.##


Second Net Pay

CAMTT

NUMERIC

10

**#,###.##


Total Net Pay

ACC#2

CHAR

20



Second Bank Account

TRAN2

CHAR

10



Second Transit number

TRND2

CHAR

30



Second Transit description