Prevar - *PAYSLIP_COLLECT
Preceda Variable *PAYSLIP_COLLECT controls which Naming Convention option is being used, and whether or not a Manifest CSV file also needs to be generated.
If Position 1 is not populated with a valid value, the Pay slips - Collection Folder processing window is hidden, but if it contains any of the value listed below, the window will then be visible to Users with access to Activity ID M001592.
- The value in Position 1 is used when the Pay slips - Collection Folder process is run to determine which Naming Convention is to be applied to the ZIP and PDF files.
- The value in Position 2 is only referenced when Position 1 = Y and Position 4 = blank, or when Position 1 = S.
- The value in Position 3 is only referenced when Position 1 = Y, P, or S.
- The value populated in Position 4 is only referenced when Position 1 = Y.
| Position | 1 | 2 | 3 | 4 | |||||
|---|---|---|---|---|---|---|---|---|---|
| Description | Naming Convention | Employee ID | Manifest File | Global ID for Pay slip PDF | 10-59 / Manifest File Name | ||||
| Options | Blank |
The functionality is disabled. The Pay slips - Collection Folder will be hidden from the Navigator. |
|||||||
| Y |
Preceda Generic - Generate PDF files using the Generic Naming Convention (Standard). |
Blank | Employee ID includes leading zeroes (file name only) | Blank | No Manifest File | Blank | Leave blank to keep using Employee ID | ||
| Y | Employee ID leading zeroes removed (file name only) | W | A CSV Manifest File will be generated in the format for Workday. | 1 | To use Global ID 01 (N3GID#) as the value for first component of the name of a PDF pay slip instead of Employee ID if given. | ||||
| 2 | To use Global ID 02 (N3MIS2) as the value for first component of the name of a PDF pay slip instead of Employee ID if given. | ||||||||
| 3 | To use Global ID 03 (N3MIS3) as the value for first component of the name of a PDF pay slip instead of Employee ID if given. | ||||||||
| 4 | To use Global ID 04 (N3MIS4) as the value for first component of the name of a PDF pay slip instead of Employee ID if given. | ||||||||
| 5 | To use Single Sign-On ID (N3MIS1) as the value for first component of the name of a PDF pay slip instead of Employee ID if given. | ||||||||
| P | Payroll Exchange - Generate PDF files using the Payroll Exchange Naming Convention. | Blank | No Manifest File | ||||||
| P | A CSV Manifest File will be generated in the format for Payroll Exchange. | ||||||||
| S | SuccessFactors - Generate PDF files using the SuccessFactors Naming Convention. | Blank | Leading zeroes in Employee ID is retained (Employee ID in manifest file content) | Blank | No Manifest File | ||||
| Y | Leading zeroes in Employee ID is removed (Employee ID in manifest file content) | S | A CSV Manifest File will be generated in the format for SuccessFactors. | <Manifest File Name & Extension> | |||||
| G | EuHReka - Generate PDF files using the EuHReka Naming Convention. | See the File Naming Convention on this page for the details on the usage of Positions 2-23. | |||||||
Options for Position 1
When Position 1 is set to any of the valid options, the following naming conventions will be applied to the generated PDF file.
Y - Generic Naming Convention (Standard)The Standard Naming Convention is applied when Position 1 is set to 'Y'.
ZIP File
The naming convention for the ZIP file is: <Payrun Group Code>_<Payment Date>_<Process Run Date/Time>.zip
Example: MTH_20160315_201603141630.zip
PDF File
The PDF file names will be in the Standard format using the employee's Preceda ID number, Pay slip Number and Period End Date: <Employee ID>_<Payslip Number>_<Payment Date>.pdf
In the first six positions (Employee ID), when the Employee ID does not use all six, the remaining positions will be filed in with '0' (e.g. for '723' --> '000723').
Example: 001234_000000001_15032016.pdf
| Position | Position Description | Options/ Value |
|---|---|---|
| 1 - 6 | Employee ID |
PAYMST.AEMPNO |
| 7 | Filler | Fixed Underscore character - "_" |
| 8 - 16 | Pay slip Number | A running number for payslips in the ZIP file which increments per PDF included |
| 17 | Filler | Fixed Underscore character - "_" |
| 18 - 25 | Period End Date | Period End Date from the Payrun Header with the format: DDMMYYYY |
| 26 - 29 | File Extension | Set Value '.pdf' |
Manifest File
The Payslip ZIP file containing files with the Generic naming convention only includes a Manifest file when Position 3 of *PAYSLIP_COLLECT is set to W
The Manifest CSV file is saved as a separate file to the ZIP file - saved into the same IFS location.
The naming convention is: MANIFEST__<Process Run Date/Time>.csv
P - Payroll Exchange
The Payroll Exchange (PEX) Naming Convention is required for all Preceda databases which are configured for Integration with PEX.
This naming convention is applied when:
- Position 1 of Preceda Variable *PP_EXCHANGE is set to P; and
- Position 1 of *PAYSLIP_COLLECT is set to P in a PEX-enabled database. This will make the Pay slips - Collection Folder processing window visible.
This naming convention is a PEX Standard and must be met in relation to all Pay slip files sent to PEX. The setting of the Payslip Type field on the Payment Details window is not referenced under this Naming Convention. PDF Pay slip files will be generated for all Employees in the payrun.
ZIP FIle
The naming convention for the ZIP file is: PAYSLIP_<GCC>_<LCC>_<Payrun Group>_Y<Year>_P<Period>_R<Sequence>.zip
PDF Files
The PDF file format is: PAYSLIP_<GCC>_<LCC>_<Payrun Group>_Y<Year>_E<Employee ID>_P<Period>_R<Sequence>.pdf
| Position | Position Description | Options/ Value |
|---|---|---|
| 1 - 7 | Document Type |
Fixed value - 'PAYSLIP' |
| 8 | Filler | Fixed Underscore character - "_" |
| 9 - 11 | GCC* |
If Position 2 of *PP_EXCHANGE = Y then
Else:
|
| 12 | Filler | Fixed Underscore character - "_" |
| 13 - 17 | LCC* |
If Position 2 of *PP_EXCHANGE = Y then
Else
|
| 18 | Filler | Fixed Underscore character - "_" |
| 19 - 20 | Payrun Group | Payrun Group from Payrun Header (xxPAYTCW.GPAYGR) |
| 21 | Filler | Fixed Underscore character - "_" |
| 22 | Year | Fixed Value - 'Y' |
| 23 - 26 | Year ** | 1st to 4th characters of Period Number from Payroll Calendar (PE010.PEINUM) ** |
| 27 | Filler | Fixed Underscore character - "_" |
| 28 | Employee ID | Fixed Value - 'E' |
| 29 - 34 | Employee ID | PAYMST.AEMPNO |
| 35 | Filler | Fixed Underscore character - "_" |
| 36 | Period | Fixed Value - 'P' |
| 37 - 38 | Period** | 5th to 6th characters of Period Number from Payroll Calendar (PE010.PEINUM) ** |
| 39 | Filler | Fixed Underscore character - "_" |
| 40 | Sequence | Fixed Value - 'R' |
| 41 - 42 | Sequence*** | A running number for the payslips for an Employee in the Period |
| 43 - 46 | File Extension | Fixed Value - '.pdf' |
*GCC / LCC
Position 2 of the Preceda Variable *PP_EXCHANGE is used to control where the GCC / LCC is sourced from.
**Year / Period
Year and Period information for all file names are sourced from the Payroll Calendar, by using the Payrun Group and Period End Date from Payrun Header as a reference.
*** Preceda File H020
This is used to store a History of Payrun Group / Year / Period / Sequence information to ensure that the Sequence Number is incremented correctly when required.
Manifest File
The Payslip ZIP file containing files with the Payroll Exchange naming convention only includes a Manifest file when Position 3 of *PAYSLIP_COLLECT is set to P.
The Manifest file is saved within the ZIP file along with all of the PDF Payslip files.
The naming convention for PEX is: MANIFEST_<GCC>_<LCC>_<Payrun Group>_Y<Year>_P<Period>_R<Sequence>.csv
S - SuccessFactors
The Success Factors Naming Convention is required for Clients integrating with SuccessFactors.
This naming convention is applied when Position 1 of this Prevar is set to S.
The two main differences between this naming convention and the Preceda Generic one are that the Success Factors ZIP file name is fixed, and the PDF files use the Period End Date instead of the Payment Date.
The setting of the Pay slip Type field on the Payment Details window is not referenced under this Naming Convention. PDF Pay slip files will be generated for all Employees in the payrun.
ZIP FIle
Unlike the other Naming Conventions which include the Date/Time of when the file was generated, the Enhanced Generic Naming Convention applies a fixed constant name to the ZIP file: <Client ID>-<Payrun Group Code>-Preceda-PaySlipLoad.zip
Example: NELLER-MTH-Preceda-PaySlidLoad.zip
PDF FIles
The PDF file format is: <Employee ID>_<Payslip Number>_<Payment Date>.pdf
Example: 001234_000000001_31032016.pdf
| Position | Position Description | Options/ Value |
|---|---|---|
| 1 - 6 | Employee ID |
PAYMST.AEMPNO |
| 7 | Filler | Fixed Underscore character - "_" |
| 8 - 16 | Pay slip Number | A running number for payslips in the ZIP file which increments per PDF included |
| 17 | Filler | Fixed Underscore character - "_" |
| 18 - 25 | Period End Date | Period End Date from the Payrun Header with the format: DDMMYYYY |
| 26 - 29 | File Extension | Set Value '.pdf' |
Manifest File
The Payslip ZIP file containing files with the SuccessFactors naming convention only includes a Manifest file when Position 3 of *PAYSLIP_COLLECT is set to S.
The Manifest CSV file is saved within the ZIP file along with all of the PDF Payslip files.
The Manifest CSV File Name is sourced from Positions 10 to 59 of Preceda Variable *PAYSLIP_COLLECT.
G - EuHReka Naming Convention This naming convention is applied when Position 1 of Preceda Variable *PAYSLIP_COLLECT is set to G.
The ZIP file name is the same as that used by the Generic naming convention, but the PDF file names are strictly as required by EuHReka.
PDF Pay slip files under this naming convention will only be generated for Employees who have no value in the Payslip Type field on the Payment Details window. Employees with any value in this field will be excluded from the process.
ZIP File
The naming convention for the ZIP file is: <Payrun Group Code>_<Payment Date>_<Process Run Date/Time>.zip
Example: MTH_20160401_201604010930.zip
PDF File
| Position | Position Description | Options/ Value |
|---|---|---|
| 1 - 4 | Client Code |
Preceda Variable *PAYSLIP_COLLECT Positions 2 to 5 |
| 5 - 6 | ISO Country Code | Preceda Variable *PAYSLIP_COLLECT Positions 6 to 7 |
| 7 - 14 | Personnel Number |
This is to be sourced from the Global ID 01 field on the User Fields window - GLOBID.N3GID#
|
| 15 - 16 | Payroll Period |
This is in the form of numeric values for the month of the Payment Date entered on the Pay slips - Collection Folder processing window. Example:
January = '01' February = '02' December = '12' |
| 17 - 20 | Payroll Year | This is in the form of numeric values for the year of the Payment Date entered on the Pay slips - Collection Folder processing window. |
| 21 - 22 | Sequence Number (in current Month) |
This is in incremental number from 01 to 99 based on the number of pay slips produced for the employee for the Period/ Month. (File H009 checked for previous Period / File Numbers used) |
| 23 - 28 | Document Type | Preceda Variable *PAYSLIP_COLLECT Positions 8 to 13 |
| 29 - 37 | Application ID |
Preceda Variable *PAYSLIP_COLLECT Positions 14 to 23 If all positions are not populated, do not blank fill remaining positions in file name; Add file Extension after last character found in these positions. |
| 38 - 41 | File Extension | Set Value '.pdf' |
Manifest File
The EuHReka naming convention does not include a Manifest file.
2024