This page (revision-79) was last changed on 20-Sep-2023 14:24 by Lilia Urtan

This page was created on 26-Nov-2021 10:22 by JEscott

Only authorized users are allowed to rename pages.

Only authorized users are allowed to delete pages.

Page revision history

Version Date Modified Size Author Changes ... Change note
79 20-Sep-2023 14:24 81 KB Lilia Urtan to previous
78 05-May-2023 13:45 81 KB Lilia Urtan to previous | to last
77 21-Mar-2023 10:08 80 KB Kevin Higgs to previous | to last
76 26-Nov-2021 10:22 80 KB kparrott to previous | to last
75 26-Nov-2021 10:22 80 KB khiggs to previous | to last
74 26-Nov-2021 10:22 80 KB khiggs to previous | to last
73 26-Nov-2021 10:22 79 KB khiggs to previous | to last
72 26-Nov-2021 10:22 79 KB khiggs to previous | to last
71 26-Nov-2021 10:22 79 KB khiggs to previous | to last
70 26-Nov-2021 10:22 79 KB rmorrell to previous | to last
69 26-Nov-2021 10:22 79 KB rforbes to previous | to last
68 26-Nov-2021 10:22 78 KB jmyers to previous | to last
67 26-Nov-2021 10:22 78 KB jmyers to previous | to last
66 26-Nov-2021 10:22 78 KB jmyers to previous | to last
65 26-Nov-2021 10:22 78 KB jmyers to previous | to last
64 26-Nov-2021 10:22 78 KB jmyers to previous | to last
63 26-Nov-2021 10:22 78 KB jmyers to previous | to last
62 26-Nov-2021 10:22 78 KB jmyers to previous | to last
61 26-Nov-2021 10:22 79 KB jmyers to previous | to last

Page References

Incoming links Outgoing links
UEEF
UEEF

Version management

Difference between version and

At line 5 changed 3 lines
!!Required Set Up
!Step 1 - Define Lexicons in [IMLN]
!!Setup Step 1 - Define Lexicons in [IMLN]
At line 8 added one line
At line 571 added 4 lines
!Setup Step 2 - Define Interface Format in [IDIF]
!Fixed File Format
The following set up instructions for a Fixed File format using the interface [HL$BE-ELIGTOTAL].\\
The interface does not need to be manually entered in IDIF, it is loaded through seed data during an install or upgrade.
At line 576 added one line
You should use (Copy Definition) to copy into a different Interface code and then enter your own company data.
At line 578 added 2 lines
- The starter script SEED_IDIF_HL$BE_ELIG_TOTAL.sql is provided to load in example of a fixed format interface file
- the user should use [Copy Definition] to copy into a different Interface Code and then enter their own company data
At line 583 added one line
IDIF field descriptions:
At line 585 added 2 lines
The maximum length of a file size is 10000 bytes.
The maximum length of a file size with Sort Sequence is 4000 bytes.
At line 589 added 9 lines
Code: - user defined Interface Code
- if IDIF layout is supplied by High Line, Interface Code begins with HL$
Interface Type: - must be 35 – EEM/EAS Interface
File Format: - specifies one of the File Formats from look up list
Form Type: - please select ‘Not Specified’ from look up list, Form Type is not used for UEEF
Description: - user defined description
File Name: - specifies the default file name, otherwise file name is entered on UEEF parameter
File Creation Number: - not used
Taxation Level: - please select ‘Not Specified’ from look up list, Taxation Level is not used for UEEF
At line 599 added 2 lines
Record Number - user assigned Record Number
- each Record Number generates a new line in the interface file
At line 602 added one line
The followings are suggested Record Numbers, user can set up their own numbers.
At line 583 changed 3 lines
!Step 2 - Define Interface Format in [IDIF]
Fixed File Format
The following set up instructions for a Fixed File format using the interface [HL$BE-ELIGTOTAL]
Record Number Interface File Records generated
0 Qualify Records
1 – 29 Header Records
30 – 69 Detail Records
70 – 99 Trailer Records or Update Records
At line 587 changed one line
The interface does not need to be manually entered in IDIF it is loaded through seed data during an install or upgrade.
Field Number - user assigned number
At line 589 changed one line
You should use (Copy Definition) to copy into a different Interface code and then enter your own company data.
Name - user assigned field name
At line 591 changed one line
XML File Format
XML Tag - optional, used for XML File Format only
- if XML Tag is not specified for XML File, then the Name field is used as XML Tag
Beginning Position - if File Format = ‘Fixed Format’, the user must specify the Beginning position
Ending Position - if File Format = ‘Fixed Format’, the user must specify the Ending position
- these positions must be continuous without gap, otherwise an error situation will occur
- Beginning/Ending positions are not needed for xml and other file format
- the maximum length of a file size is 10000 bytes, therefore the Ending Position must not exceed 10000
- if Sort Sequence is used, the Ending Position must not exceed 4000
Field Type - can be ‘Char’, ‘Number’ or ‘Date’
Variable Name - select from lexicon X_INF_VARIABLE_NAME 35nnnn, refer to lexicon list above
Sort Sequence - specifies the Sort Sequence for this Record #, Field #
- used for Record # with Record Type = ‘Detail Record’ only
- for Record # with Record Type = ‘Detail Level 1’ to ‘Detail Level 5’, it uses the same Sort from Record Type = ‘Detail Record’ so that the Detail Level n records are followed after the ‘Detail Record’
e.g. if Interface File need to sort by: Department, Employee First Name, Last Name
- then for the Fld# entry that specify ‘Department’, enter sort sequence: 100
- for the Fld# that specify ‘Employee First Name’, enter sort sequence: 150
- for the Fld# that specify ‘Employee Last Name’, enter sort sequence: 200
- all Sort sequences must be entered on entries with the same Record Number
- Sort Sequence is not supported for XML file format because xml file may specify many different Record # to generate xml begin and end tags and the xml tags are not able to sort along with the data
- Sort Sequence is not supported if the IDIF format contains ‘Employee Header’ or ‘Employee Summary because the Sorting of the Detail Record cannot carry it’s associated Employee Header/Summary Record
Format Mask - applicable to Numeric and Date field
Record Type - must be used for this Interface Type, lexicon X_RECORD_TYPE values are:
00 – Not Specified - not applicable for this Interface type
01 – Header Record - generate Header records at begin of file
10 – Employer Header - not used for UEEF
11 – Employer Summary - not used for UEEF
12 – Employer Header2 - not used for UEEF
13 – Employer Summary2 - not used for UEEF
14 – Employee Header - generate Employee Header at the
beginning of an employee (EEM) after the Qualify record
15 – Employee Summary - generate Employee Summary at the
end of an employee (EEM)
16 – Pay Header Begin - not used for UEEF
17 – Pay Header Summary - not used for UEEF
20 – Detail Record - generate Employee Detail record
21 – Detail Level 1 - Detail Level 1 to 5 hangs beneath
22 – Detail Level 2 the Employee Detail record and loops
23 – Detail Level 3 through BE plans or Contacts etc
24 – Detail Level 4 depending on UEEF parameter
25 – Detail Level 5 Interface Level selection criteria
30 – Detail Summary - wraps up for Employee Detail record
- mostly used for XML file xml end tag
80 – Total Record - not used
90 – Trailer Record - generate Trailer records at end of file
- may contain File totals, record counts etc
91 – Qualify Record - should be used for Record Number 0
- the Qualify records are performed at the beginning of every Detail record to qualify employees
- user can use derivation expression to BYPASS certain criteria
92 – Update Record - should be defined at the end of the IDIF definition
- in non-Trial mode, the UDF can be Inserted or Updated as defined in the Variable Name and Constant Value field
- user can use derivation expression to BYPASS certain criteria for Update
Record Identifier - not used for this Interface Type
Constant Value - if Variable Name = ‘Constant Value’, this field specifies the Constant Value to be used
- if Variable Name = ‘User Calc’, this field specifies the User Calc Name
- if Variable Name = ‘UDF (xxx)’, this field specifies the User Defined Field Name
- if Variable Name = ‘Statistics Amt’, this field specifies the Statistics Code
- if Variable Name = ‘Element’, this field specifies the Element Code
- if Variable Name = ‘Total Value’, this field specifies the Rec# and Field # of the Detail Records to be totaled
e.g. Record # 50 Field 70 is to be totaled and Total option = ‘Calculate Total’, then the Trailer record can report the ‘Total Value’, Constant value should be 5070
Print Zero Rule - applicable to Numeric field only, use for Record Type = ‘Detail Record’
- if amount is zero, this field indicates to include this amount in the interface file or not
- e.g. if the field is from ‘Statistics Amount’ and the amount is zero, the user may not want to report this amount
- if all numeric amounts are zero within one Record# and the Print Zero Rule are set to ‘Do not Print zeros’ for each field, then this entry will not be reported on interface file
- lexicon X_PRINT_ZERO_RULE
00 – Not Specified
01 – Print Zero Amounts
02 – Don’t Print Zeros
XML Tag option - applicable to XML file, if Variable Name = ‘XML begin Tag’or ‘XML end Tag’, this field option indicates if the XML Tag should be written
- lexicon X_XML_TAG_OPTION
00 – Not Specified
01 – Optional, omit tag if null
02 – Mandatory, always write
Accum Option - applicable to Numeric field only, use for Record Type = ‘Detail Record’
- indicate if this Record #, Field # amount should be accumulated or not
- e.g. if the field is a ‘Pay Number’ or ‘Check Number’, then do not accumulate
- if field is ‘Element Value’ or ‘PC Amount’, then you may want to accumulate to avoid writing too much detail per element or per pay component
Total Option - applicable to Numeric field only, use for Record Type = Detail Record, Detail Leveln
- indicate if this Record #, Field # amount should be totaled for Header or Trailer record
- e.g. if the field is a ‘FTE’ or ‘Rate of Pay’, then do not totaled
- if field is ‘Statistics Amount’ or ‘User Calc Amount’, then you may want to calculate the total for Trailer record
- lexicon X_TOTAL_OPTION
00 – Not Specified
01 – Calculate Total
Derivation Expression - specifies the derivation expression for the Variable name
- this derivation expression will apply to the result of the Variable name before format mask
- the user may use RTRIM(~) to remove trailing blanks before comparing the entire string because the data may contain blanks that are not visible at the end
- please refer to following Derivation Expression processing
!XML File Format
This page (revision-79) was last changed on 20-Sep-2023 14:24 by Lilia UrtanTop