This page (revision-52) was last changed on 26-Nov-2021 10:22 by mmcfarland

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

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
52 26-Nov-2021 10:22 23 KB mmcfarland to previous
51 26-Nov-2021 10:22 23 KB mmcfarland to previous | to last
50 26-Nov-2021 10:22 23 KB mmcfarland to previous | to last
49 26-Nov-2021 10:22 23 KB mmcfarland to previous | to last
48 26-Nov-2021 10:22 23 KB mmcfarland to previous | to last
47 26-Nov-2021 10:22 23 KB mmcfarland to previous | to last
46 26-Nov-2021 10:22 24 KB jescott to previous | to last
45 26-Nov-2021 10:22 24 KB jescott to previous | to last
44 26-Nov-2021 10:22 23 KB jmyers to previous | to last US TAX SERIES ==> US TAX SERIES(System_Preference)
43 26-Nov-2021 10:22 23 KB jmyers to previous | to last US TAX PORT NUM ==> US TAX PORT NUM(System_Preference)
42 26-Nov-2021 10:22 23 KB jmyers to previous | to last US TAX HOST NAME ==> US TAX HOST NAME(System_Preference)
41 26-Nov-2021 10:22 23 KB jmyers to previous | to last US STE LOG LEVEL ==> US STE LOG LEVEL(System_Preference)

Page References

Incoming links Outgoing links

Version management

Difference between version and

At line 1 changed one line
[{TableOfContents }]
[{TableOfContents }]
At line 3 added 2 lines
!!Overview
At line 7 changed one line
The [UDGNIS] process loads in the "US Geographic Names Information System" (GNIS) information from the Symmetry Tax Server into Personality. The process loads in all Counties, Cities, Schools, Municipalities and Zip Codes for each State selected in the parameters. Please refer to the [PR_US_Load_GNIS|US Load GNIS Locations] page for more detailed information on how the UDGNIS function works.
UDGNIS process loads in the ‘US Geographic Names Information System (GNIS)’ information from the Symmetry Tax Server into the ePersonality system. The process will load in all Counties, Cities, Schools, Municipalities, and Zip Codes for each state selected in the parameters. Please refer to the document ‘PR_US_Load_GNIS.doc’ for more detailed information as to how the UDGNIS function works.
At line 11 changed 6 lines
!IDCO - Define Countries
*ISO Alpha 2 and ISO Alpha 3 can be defined for each Country
*These fields contain the 2 or 3 character ISO Country code
*Some government reporting requires to report a two character ISO Country code while some government reporting requires to report a three character ISO Country code
*For Annual Wage W-2 or Quarterly reporting, if an organization has employees with Foreign Country Addresses, then the ISO Country codes must be set up.
*The website to obtain 2 Alpha or 3 Alpha ISO Country Codes is [http://www.unc.edu/~rowlett/units/codes/country.htm]
!IDCO – Define Countries
At line 18 changed 4 lines
!IDSP - Define States and Provinces
*State Code "00" is used for Federal Level Taxation
*The [FIPS] code is stored at the State level. This field contains the FIPS Numeric code for each State
*The UDGNIS process will load in the States and the FIPS codes, if they do not already exist
INSERT IMAGE 2.1
*ISO Alpha 2 and ISO Alpha 3 may be defined for each Country
*These fields contain the 2 or 3 character ISO Country Code
*Some Government Reporting requires to report a 2 character ISO Country Code while some Government Reporting requires to report a 3 character ISO Country Code
*For Annual Wage W-2 or Quarterly reporting, if an Employer deals with Foreign Country Addresses, then the ISO Country Codes need to be set up
*Website for 2 Alpha or 3 Alpha ISO Country Code : http://www.unc.edu/~rowlett/units/codes/country.htm
!IDSP – Define States and Provinces
INSERT IMAGE 2.2
*State Code ‘00’ is used for Federal Level Taxation
*[FIPS] code is stored at State level, this field contains the FIPS Numeric Code for each State
*UDGNIS process will load in the States and FIPS codes if these do not already exist
At line 23 changed 5 lines
!IDCN - Define Counties
*The Symmetry County code format is: 99-999
*The Vertex County code format: 99-999-0000
*During the UDGNIS Vertex conversion, if the Vertex County Code has been defined in the system, the Vertex County Code will be stored as an Alternate County code for reference with format: 99-999-0000. If the Vertex County Code has not been defined, this County code will be removed.
*The UDGNIS process will load in all Counties for each State. Users do not need to manually enter information on this form.
!IDCN – Define Counties
At line 29 changed 6 lines
!IDCI - Define Cities
*City code format: Variable length, 4 digits to 7 digits
*For each County from [IDCN], the UDGNIS process retrieves all City codes for this County
*This helps users to enter the correct combination of City, with the related County, for tax calculations
*At the City Level, the entire combination of State-County-City codes will form a valid GNIS code for Symmetry Taxation, such as 06-001-1655980 is for Dublin, Alameda, California
*The UDGNIS process will load in all cities for each State. Users do not need to manually enter information on this form.
INSERT IMAGE 2.3
*Symmetry County Code Format is: 99-999
*Vertex County Code Format: 99-999-0000
*During UDGNIS Vertex conversion, if the Vertex County Code has been used in the system, the Vertex County Code will be stored as Alternate County Code for reference with format: 99-999-0000, if the Vertex County Code has not been used, this County Code will be removed
*UDGNIS process will load in all Counties for each State, users do not need to enter manually on this screen
At line 36 changed one line
!IDSD - Define School Districts
!IDCI – Define Cities
INSERT IMAGE 2.4
*City Code Format: Variable length, 4 digits to 7 digits
*For each County from [IDCN], UDGNIS retrieves all City Codes that are for this County
*This helps the user to enter the correct combination of City with the related County for tax calculations
*At the City Level, the entire combination of ‘State-County-City’ codes will form a valid GNIS code for Symmetry Taxation, e.g. 06-001-1655980 is for Dublin, Alameda, California
*UDGNIS process will load in all Cities for each State, users do not need to enter manually on this screen
!IDSD – Define School Districts
INSERT IMAGE 2.5
At line 38 changed 6 lines
*For each County from IDCN, the UDGNIS process retrieves all School District Codes for this County
*This helps users to enter the correct combination of School, with the related County, for tax calculations
*During UDGNIS Vertex conversion:
**If a Vertex School code __has not__ been defined in the system, this Vertex School code will be removed
**If a Vertex School code has been used in the system, the UDGNIS process will look for a match for the School District, and the Vertex School code will be stored in an Alternate School Code for reference purposes
*The UDGNIS process loads in all schools for Ohio and Pennsylvania only. Users do not need to manually enter information on this form. However, users __must__ associate the School District Code to the appropriate Tax Jurisdiction in [IDTX].
*For each County from IDCN, UDGNIS retrieves all School District Codes that are for this County
*This helps the user to enter the correct combination of School with the related County for tax calculations
*During UDGNIS Vertex conversion, if a Vertex School Code has not been used in the system, this Vertex School Code will be removed
*During UDGNIS Vertex conversion, if a Vertex School Code has been used in the system, UDGNIS will look for a match for the School District and the Vertex School Code will be stored in Alternate School Code for reference purposes
*UDGNIS process will load in all Schools for Ohio and Pennsylvania only, users do not need to enter manually on this screen
At line 45 changed 6 lines
!IDMN - Define Municipalities
*Municipality code format: 7 digits
*For each County from IDCN, the UDGNIS process retrieves all Municipality codes for this County
*This helps users to enter the correct combination of Municipality, with the related County, for tax calculations
*The State of Pennsylvania requires a Municipality Code to calculate City taxes. Other States do not require Municipality Codes
*The UDGNIS process loads in all Municipalities for Pennsylvania only. Users do not need to manually enter information on this form. However, users __must__ associate the Municipality to the appropriate Tax Jurisdiction in [IDTX].
!IDMN – Define Municipalities
At line 52 changed 2 lines
!IDZR - Maintain ZIP Ranges
__COUNTY_ZIP RANGES Tab - Used by Symmetry Taxation__
INSERT IMAGE 2.6
*Municipality Code Format: 7 digits
*For each County from IDCN, UDGNIS retrieves all Municipality Codes that are for this County
*This helps the user to enter the correct combination of Municipality with the related County for tax calculations
*State of Pennsylvania requires Municipality Code to calculate City taxes, other States do not require Municipality Codes
*UDGNIS process will load in all Municipalities for Pennsylvania only, users do not need to enter manually on this screen
At line 55 changed one line
*For Symmetry Taxation, the 'County Zip Ranges' tab is used
!IDZR – Maintain ZIP Ranges
__IDZR - COUNTY_ZIP RANGES Tab – Used by Symmetry Taxation__
INSERT IMAGE 2.7.1
*For Symmetry Taxation, the ‘COUNTY ZIP RANGES’ tab is used
At line 57 changed 6 lines
*For each County from IDCN, the UDGNIS process retrieves all ZIP Codes for this County and Cities
*The UDGNIS loads in all ZIP codes for each State. Users do not need to manually enter information on this form
*Users can drag the applicable column to the first column to sort the data\\Example:
**Drag the Zip Code to the first column to show all Cities with the same Zip Code
**Drag the City to the first column to show all Zip Codes for the same City
\\
*For each County from IDCN, UDGNIS retrieves all ZIP Codes that are for this County and Cities
*UDGNIS loads in all ZIP codes for each State, users do not need to enter manually on this screen
*The user can drag the applicable column to the first column to sort the data\\Example:
**Drag Zip Code to the first column to show all Cities for the same Zip Code
**Drag City to the first column to show all Zip Codes for the same City
At line 64 changed 4 lines
__IDZR - JURISDICTION ZIP RANGES Tab - Used by Vertex Taxation Only__
*For Vertex Taxation, use the 'Jurisdiction Zip Ranges' tab
*To view the list of ZIP codes by Vertex GEO codes, click the GEO Code entries with the GEO Type = City
*During the UDGNIS Vertex conversion, the unused Vertex ZIP ranges are removed, and the new ZIP ranges are loaded by County and City. Therefore after conversion, there may be no ZIP entries on the Jurisdiction Zip Ranges tab. Users should only use the County Zip Ranges tab after the conversion
__IDZR - JURISDICTION ZIP RANGES Tab – Used by Vertex Taxation Only__
At line 88 added 6 lines
INSERT IMAGE 2.7.2
*For Vertex Taxation, please use ‘JURISDICTION ZIP RANGES’ Tab
*To view the list of ZIP codes by Vertex GEO Codes, please click GEO Code entries with GEO Type = ‘City’
*During UDGNIS Vertex conversion, the unused Vertex ZIP ranges are removed, the new ZIP ranges are loaded by County and City, therefore after conversion, there may be no ZIP entries on ‘JURISDICTION ZIP RANGES’ Tab, user should use the ‘COUNTY ZIP RANGES’ Tab after conversion
At line 71 changed one line
!IDTX - Tax Jurisdiction Concepts
!IDTX – Tax Jurisdiction Concepts
At line 73 changed 2 lines
*UDGNIS is the process that loads in all the "US Geographic Names Information System" (GNIS) Location codes into Personality
*Before entering Tax Jurisdictions on the IDTX form, users must run UDGNIS to load in all the [IDCO], [IDSP], [IDCN], [IDCI], [IDMN], [IDSD], [IDZR] entries so that the [IDTX] form can be defined using the GNIS information.
*UDGNIS is the process which loads in all ‘US Geographic Names Information System (GNIS)’ Location codes into the system
At line 76 changed one line
*The UDGNIS process can also be run to create Tax Jurisdictions in IDTX, for the State selected in the report parameters.
*Before entering Tax Jurisdictions on IDTX screen, user must run UDGNIS to load in all the IDCO, IDSP, IDCN, IDCI, IDMN, IDSD, IDZR entries so that IDTX can be defined using the GNIS information.
At line 78 changed one line
*A GNIS code is also known as a GEO code in Personality
*UDGNIS may also be run to Create tax jurisdictions in IDTX for the state selected in the report parameters.
At line 80 changed one line
*The GNIS Code Format is: SS-CCC-FFFFFFF, where:
*GNIS code is also known as GEO code in ePersonality System
*GNIS Code (i.e. GEO Code) Format is: SS-CCC-FFFFFFF, where:
At line 85 changed one line
*The IDTX form stores a unique combination of State, County, City, Municipality and School Districts that will be used in the system.
*IDTX screen stores a unique combination of State, County, City, Municipality and School Districts that will be used in the system
At line 87 changed one line
*Each combination of State, County, City, Municipality and School Districts will form a tax jurisdiction that is eligible for tax calculations when an employee is being paid under this tax jurisdiction.
*Each combination of State, County, City, Municipality and School Districts will form a TAX JURISDICTION that is eligible for tax calculation when an employee is being paid under this Tax Jurisdiction
At line 89 changed one line
*After a tax jurisdiction has been paid in a pay for an employee, this tax jurisdiction becomes the pay jurisdiction of this pay.
*After a TAX JURISDICTION is being paid in a Pay for an employee, then this TAX JURISDICTION becomes the PAY JURISDICTION of this Pay
At line 91 changed 2 lines
*Users can view the pay jurisdiction information of a pay on the [IPPH] and [IPVT] forms, with its associated tax amounts.
\\
*Users can view the PAY JURISDICTION information of a Pay on the IPPH and IPVT screens with its associated tax amounts
At line 94 changed 7 lines
!IDTX - Tax Jurisdiction Form Layout
*The GNIS Code 00-000-0000 is used for the Federal Level Taxation. The UDGNIS process automatically loads this entry
*Each IDTX entry is for a unique combination of State, County, City, Municipality and School District
*If the same GNIS Code displays multiple entries, please note that these are not duplicate entries. Entries must be defined for different Municipalities or School Districts. Review the State, County, City, Municipality and School details to identify each unique entry.
*In order for the School District tax to calculate for Ohio and Pennsylvania, the School District __must__ be defined on IDTX for the appropriate Tax Jurisdictions.
*For the [IDLN], [IEPI], [IEAS], [IPTR], [IPPH] forms that require a Jurisdiction code, these forms will pop into 'Tax Jurisdiction Editor Utility' with the GNIS Code icon [US_Tax_Screens_geocode_icon.JPG] to enter the Jurisdiction information.
*There are 2 options to create new Tax Jurisdictions in IDTX:
!IDTX – Tax Jurisdiction Screen Layout
At line 102 changed 3 lines
1. Users can manually enter the Tax Jurisdiction combination on the IDTX form\\Example: enter each State, County, City, Municipality, School code
2. Users can click the GNIS Code icon [US_Tax_Screens_geocode_icon.JPG] to pop into the 'Tax Jurisdiction Editor Utility' dialog box
* To manually convert an existing Vertex GEO Code to a Symmetry GNIS code, please read the 'Manually Converting Tax Jurisdictions' section in the following pages. \\ \\
INSERT IMAGE 3.2.1
*GEO Code ’00-000-0000’ is used for Federal Level Taxation, UDGNIS automatically loads in this entry
At line 106 changed 2 lines
__Option (1)__ \\
To manually create NEW tax jurisdictions:
*Each IDTX entry is for a unique combination of State, County, City, Municipality, School
*There are 2 options to enter Tax Jurisdiction on IDTX screen
*#user can manually enter the Tax Jurisdiction combination on the right side of the IDTX screen
*#*i.e. enter each State, County, City, Municipality, School code
*#user can click the GEO Code icon to pop into the ‘Tax Jurisdiction Editor Utility’ dialog Box
*If the same GEO Code displays multiple entries on the left side, please note that these are not duplicate entries, these entries must be defined for different Municipalities or Schools, please refer to the right side to show the detail of this screen
*For IDLN, IEPI, IEAS, IPTR, IPPH screens that need the Jurisdiction Code, these screens will pop into ‘Tax Jurisdiction Editor Utility’ with GEO Code icon to enter Jurisdiction Information
At line 109 changed 3 lines
* Manually enter the tax jurisdiction on the IDTX form. Example: The State will default in, select a County, City, Municipality and School Code
* The new GNIS Code will be automatically built with the selected State-County-City Code
* If a user is unsure of the County the City belongs to, select the City and the system will default in the associated County.
__Option (1)__
*Enter manually on the right side of the IDTX screen
**i.e. State will default in, select a County, City, Municipality, School Code
*The new GEO Code will be automatically built with the selected State-County-City Code
*If the user is unsure of the County the City belongs to, they may select the City and the system will default the associated County.
At line 139 added 2 lines
INSERT IMAGE 3.2.2
At line 114 removed 2 lines
* Click on the GNIS Code [US_Tax_Screens_geocode_icon.JPG] icon to pop into the 'Tax Jurisdiction Editor Utility' dialog box
* On IDTX, select a State, then click the Add [US_Tax_Screens_add_icon.JPG] icon , then click the GNIS Code [US_Tax_Screens_geocode_icon.JPG] icon to pop into the Tax Jurisdiction Editor Utility dialog box.\\ \\
At line 143 added 2 lines
*Click GEO Code icon to pop into the ‘Tax Jurisdiction Editor Utility’ dialog Box
*On IDTX, select a State, then click the Add icon , then click the GEO Code icon to pop into the ‘Tax Jurisdiction Editor Utility’ dialog box.
At line 118 changed one line
__Manually Converting Tax Jurisdictions__\\
INSERT IMAGE 3.2.3
At line 120 changed one line
There may be times where the UDGNIS process could not convert a tax jurisdiction. This could be a result of a spelling error, or the jurisdiction is not classified as a city by the US Postal Service. Therefore the UDGNIS process will not find the correct GNIS code to use.
__Manually Converting Tax Jurisdictions__
At line 150 added 2 lines
There may be cases where the UDGNIS could not convert a tax jurisdiction. This could be a result of a spelling error or the jurisdiction is not classified as a real city by the US Postal Service and therefore the UDGNIS could not find the correct GNIS code to use.
At line 123 changed 2 lines
#Copy the GEO CODE into the Alternate Geo Code field. This is required so that when the [UPCALC] process is run using Vertex, UPCALC knows which Vertex GEO Code to use.
#Select the correct County and City. This creates the appropriate GNIS Geo Code. The name defined in the Jurisdiction field will be replaced with the City name.
#Copy the GEO CODE into the Alt Geo Code field. This is needed so that when UPCALC is run using Vertex, UPCALC knows which Vertex GEO Code to use.
#Using the fields on the right hand side, select the correct County and City. This will create the appropriate GNIS Geo Code. The name defined in the Jurisdiction field will be replaced with the City name.
At line 128 changed one line
!IDTX - Tax Jurisdiction Dialog Box
!IDTX – Tax Jurisdiction Dialog Box
At line 130 changed one line
When the IDTX, IDLN, IEPI, IEAS, IPTR or IPPH form requires a Jurisdiction code, users can click the [US_Tax_Screens_geocode_icon.JPG] icon beside the GNIS Code field, which will pop up the 'Tax Jurisdiction Editor Utility' dialog box. \\ \\
When IDTX, IDLN, IEPI, IEAS, IPTR, IPPH screen requires a Jurisdiction code, the user can click the icon beside the GEO Code field which will pop up the ‘Tax Jurisdiction Editor Utility’ dialog Box.
At line 132 changed one line
In the Tax Jurisdiction Editor Dialog there are two sections to enter information. Users can enter information in either one:\\ \\
INSERT IMAGE 4.1
In the ‘Tax Jurisdiction Editor Dialog there are 2 sections to enter information, the user can enter information in either one:\\ \\
At line 134 changed 3 lines
__GEO Code:__
*Users can click the GNIS Code lookup icon and select from the list of existing GNIS Codes
*After a GNIS Code entry is selected, the valid State, County, City, Municipality, School is displayed \\ \\
;GEO Code:
*the user may click the GEO Code lookup icon and select from the list of existing GEO Codes
*after a GEO Code entry is selected from lookup the valid State, County, City, Municipality, School will be displayed
;ZIP Code:
*the user may click the lookup of the ZIP Code and select from the list
*or user may manually enter a ZIP code
*if a ZIP Code is selected from lookup, the valid State, County, City, Municipality, School will be displayed, e.g. ZIP 17815 for PA
*if a ZIP Code is manually entered and if this ZIP code is unique, then the valid combination will be displayed
;Location:
*the user may click the lookup for Location Code and select from the list
*after a Location Code is selected from lookup, this Location Code is used to go into IDLN to retrieve the Jurisdiction if it exists and display the State, County, City, Municipality, School of the IDLN Jurisdiction
At line 138 changed 5 lines
__ZIP Code:__
*Users can click on the magnifying glass icon (LOV) of the ZIP Code and select from the displayed list
*Alternately, users can manually enter a ZIP code
*If a ZIP Code is selected from the LOV, the valid State, County, City, Municipality, School is displayed, such as ZIP 17815 for PA
*If a ZIP Code is manually entered, and the ZIP code is unique, then the valid combination is displayed \\ \\
After the selection of GEO Code, ZIP Code or Location Code is specified, the user can modify the Jurisdiction Details if these combinations are not correct or click OK.\\ \\
__2) Jurisdiction Details__
;State:
*the state will default in, however the user may select a different state from the list
;County:
*the user may click the lookup for County Code and select from the list.
;City:
*the user may click the lookup for City Code and select from the list.
*if the user does not know the County the City belongs to, the user may not provide the County information and just select a City, the County will default in according to the selected City
;Municipality:
*the user may click the lookup for Municipality Code and select from the list.
*only the State of Pennsylvania will display Municipalities
;School:
*the user may click the lookup for School and select from the list
*only Ohio and Pennsylvania States will display Schools to select from
At line 144 changed 3 lines
__Location:__
*Users can click on the magnifying glass icon (LOV) of the Location Code and select from the displayed list
*After a Location code is selected from the LOV, the system uses the Location code to retrieve the Jurisdiction from the IDLN form, if it exists, and displays the State, County, City, Municipality and School District of the IDLN Jurisdiction
When doing lookup for County, City, Municipality or School, if the user does not know the code of the County or City, the user may use ‘%’ to lookup the column, e.g. %Ph will display the list that contains ‘Ph’
At line 148 changed one line
After the selection of the GNIS Code, ZIP Code or Location Code is defined, users can modify the Jurisdiction Details if these combinations are not correct, or click OK.\\ \\
The Message Box will display the DTX_00001 to DTX_00007 messages, depending on the selections made above.
At line 150 changed 11 lines
__2. Enter the Jurisdiction Details__
__State:__ The State will default in, however users can select a different State from the list \\ \\
__County:__ Users can click on the magnifying glass icon (LOV) for the County Code and select from the list. \\ \\
__City:__ Users can click on the magnifying glass icon (LOV) for the City Code and select from the list. \\ \\
*If a user does not know the County the City belongs to, users __cannot__ enter the County information and just select a City. The County will default in according to the selected City. \\ \\
__Municipality:__
*Users can click on the magnifying glass icon (LOV) for the Municipality Code and select from the displayed list.
*Only the State of Pennsylvania will display Municipalities to select from \\ \\
__School:__
*Users can click on the magnifying glass icon (LOV) for the School and select from the displayed list
*Only Ohio and Pennsylvania States will display Schools to select from
The Return GEO Code will display the generated GEO Code/GNIS Code based on the selections made above.
!List of Screens that use Tax Jurisdiction Dialog Box
At line 162 changed one line
%%information When using the magnifying glass icon (LOV) to look up a County, City, Municipality or School, if a user does not know the code of the County or City, they can use the '%' character to look up the column. Example: "%Ph" will display a list that contains 'Ph'%%
The following is a list of screens that contain the tax jurisdiction:
At line 164 changed one line
The Message Box will display the DTX_00001 to DTX_00007 messages, depending on the selections made above.
*IDLN - Define Locations
*IDTX – Define Tax Jurisdictions
*IEPI – Maintain Personal Information
*IEAS – Maintain Assignments
*IEHR – Establish Personnel Profiles
*IEQH – Quick Hire Employees
*IPTR – Maintain Pay Transactions
*IPPH – Maintain Employee Pays
At line 166 changed one line
The Return GNIS Code will display the generated GNIS Code based on the selections made above.
!!Definition Screens
!IDGV – Maintain Government Registrations
INSERT IMAGE 5.1
*IDGV Government Registrations must be set up by ‘Registration Type’ for Federal, State, Local Level
*The user may also define IDGV Government Registration by County or City if necessary
*The Year End document describes the reporting requirement of the Government Registration
*Any Government Rates defined in IDGV for a specific Government Registration will override those defined in IPUTR.
At line 168 removed one line
!List of Forms that use the Tax Jurisdiction Dialog Box
At line 170 changed one line
The following is a list of forms that contain the tax jurisdiction:
!IPUTR – Maintain US Tax Rates
At line 172 removed 8 lines
*IDLN - Define Locations
*IDTX - Define Tax Jurisdictions
*IEPI - Maintain Personal Information
*IEAS - Maintain Assignments
*IEHR - Establish Personnel Profiles
*IEQH - Quick Hire Employees
*IPTR - Maintain Pay Transactions
*IPPH - Maintain Employee Pays
At line 181 changed one line
!!Definition Forms
At line 183 removed 5 lines
!IDGV - Maintain Government Registrations
*Government Registrations must be set up by "Registration Type" for Federal, State and Local Levels
*Users can also define the Government Registration by County or City, if necessary
*The Year End document describes the reporting requirements of the Government Registration
*Any Government Rates defined on IDGV for a specific Government Registration will override those defined on IPUTR.
At line 189 changed 9 lines
!IPUTR - Maintain US Tax Rates
*Users MUST run [UPUTR] to load the US Tax Rates, by Effective Date, into the [IPUTR] form
*Please read the [US Load Tax Rates and State Parameters] documentation for details
*Users can click the applicable State to view the Tax Rates
*The 'Tax Rate Seq' field is in format of XXnnnn, where XX is the State code and nnnn is a consecutive 4 digit number
*The State Code for the Federal Level is 00
*The Tax Identifier is retrieved from Symmetry. The format is pre-defined by Symmetry and contains the Tax Type
*The Tax Rate and Wage Base information are provided by Symmetry, or may contain zero to indicate this Tax Type will be calculated
*To sort by Effective Date, users can drag the Effective Date column to the left side of the State Column
• The user MUST run UPUTR to load in US Tax Rates by Effective Date
At line 199 changed one line
!IPUTR - Override Tax Rates
• Please read the documentation PR_US_Load_Tax_Rates.doc for detail
• The user may click the applicable State to view the Tax Rates
• Tax Rate Seq is in Format of ‘XXnnnn’ where XX is the State code and nnnn is a consecutive 4 digit number
• The State Code for Federal Level is 00
• Tax Identifier is retrieved from Symmetry, the format is pre-defined by Symmetry and contains the Tax Type
• The Tax Rate, Wage Base information are provided by Symmetry or may contain zero to indicate this Tax Type will be calculated
• To sort by Effective Date, user may drag the Effective Date column to the left side of the State Column
At line 201 removed 2 lines
*To calculate ER FUTA/SUTA, Symmetry requires organizations to define an override tax rate for both FUTA and SUTA, as these are typically different for each organization.
*Users have 2 options to set up ER FUTA/SUTA override rates:
At line 204 changed one line
1. For FUTA, on IDGV define the Reg Type 'US FUTA Regist n' with 'US FUTA Rate' for every IDGV registration. \\For SUTA, for the appropriate State/Registration, define the Govt Rate Type as 'US SUI ER'.
!IPUTR – Override Tax Rates
At line 206 removed 2 lines
2. On IPUTR, enter the appropriate tax rate in the 'Override Tax Rate' field for the appropriate Tax Identifier. Example: 00-000-0000-ER_FUTA-000 under Federal.
*The IDGV Rate will be used if one exists, otherwise the IPUTR Rate will be used. \\ \\
At line 209 changed 2 lines
!IPUTP - Maintain US Tax Parameters
*Users MUST run UPUTR to load in the US Miscellaneous Tax Parameters for Federal and State taxation.
At line 212 changed one line
*Please read the [US Load Tax Rates and State Parameters] documentation for details on how to run UPUTR
• To calculate ER FUTA / SUTA, Symmetry requires clients to define an override tax rate for both FUTA and SUTA as these are typically different for each client.
At line 214 changed one line
*Users can select the applicable State from the find block to view the State Miscellaneous Parameters by Misc. Tax Parm.
• The users have 2 options to set up ER FUTA / SUTA override rates:
At line 216 changed one line
*Miscellaneous Identifiers are retrieved from Symmetry during the UPUTR process. These are passed to the Symmetry Tax Server for tax calculations in UPCALC. Example: FILINGSTATUS
(1) On IDGV for FUTA set up Reg Type ‘US FUTA Regist n’ with ‘US FUTA Rate’ for every IDGV registration . For SUTA for the appropriate state/registration set up Govt Rate Type ‘US SUI ER’.
At line 218 changed one line
*The [IPUTP] form information is used by the IPRLU 'Miscellaneous' tab for each employee to enter their filing information by State.
(2) On IPUTR, enter the appropriate tax rate in the Override Tax Rate field for the necessary Tax Identifier, e.g. 00-000-0000-ER_FUTA-000 under Federal.
At line 220 changed one line
*The Reference Text field contains the editing information for the Miscellaneous Identifier
• The IDGV Rate will be used if one exists, otherwise the IPUTR Rate will be used
At line 222 removed one line
*‘Federal’ taxation level means the Miscellaneous Identifier will be generated with State Name = 'Federal' and will be used at the Federal Level taxation. Certain Federal Identifiers are applicable to all States of the same pay.
At line 224 changed one line
*‘State’ taxation level means the Miscellaneous Identifier will be generated with State Name = 'UPUTR' selected list of States, and will be used at the State Level taxation. These State Identifiers are specific to the defined State only.
At line 226 changed 4 lines
*The Miscellaneous Identifiers are given a usage to define where the Identifier is used within the application, and who provided the Identifier.\\There are three types of Identifier usages:
**01 - Employee Level (STE)
**02 - Employee Level
**03 - Legislative Level
!IPUTP – Maintain US Tax Parameters
At line 231 removed one line
*The Identifiers with a usage of ‘Employee Level (STE)’ are provided by the Symmetry Tax Engine and are available in the IPRLU / IPRLUS forms for employees to provide their tax filing information. These parameters will be passed directly to the Symmetry Tax Engine for calculation.
At line 233 removed one line
*The Identifiers with a usage of ‘Employee Level’ are system provided and are interpreted by the UPCALC process, prior to being passed to the Symmetry Tax Engine. These Identifiers are available on the IPRLU / IPRLUS forms to select.
At line 235 changed one line
*The Identifiers with a usage of ‘Legislative Level’ are system provided and are interpreted by the UPCALC process, prior to being passed to the Symmetry Tax Engine. These Identifiers are Government Legislative type requirements allowing employers to provide/override tax requirements. These identifiers are not available to the employee in the IPRLU/IPRLUS forms. \\ \\
At line 237 removed one line
The following table provides examples of the different usages and whether they allow an override on the IPRLU / IPRLUS forms.
At line 239 changed 10 lines
||Tax Level||Miscellaneous Identifier||Identifier Usage||Allow IPRLU Override
|Federal|IRS_MAXIMUM_EXEMPTIONS|Employee Level|Yes
|Federal|IRS_LOCK_IN_FILING_STATUS|Employee Level|Yes
|Federal|APPLY_BENEFIT_WAGE_LIMIT|Legislative|No
|State|FILINGSTATUS|Employee Level (STE)|Yes
|State|STATE_ROUNDING|Legislative Level|No
|State|STATE_NEXUS|Legislative Level|No
|State|SUP_PAID_WITH_REG|Employee Level|Yes
|State|SUP_PAID_WITHOUT_REG|Employee Level|Yes
\\
• The user MUST run UPUTR to load in US Miscellaneous Tax Parameters for Federal and State taxation
At line 250 changed one line
!IPCU - Define Pay Component Usages
• Please read the document PR_US_Load_Tax_Rates.doc for specific detail on how to run UPUTR
At line 252 changed one line
*All US PC Usages are delivered and loaded into the system during every US Taxation release
• The user may select the applicable State from the find block to view the State Miscellaneous Parameters by Misc. Tax Parm.
At line 254 changed one line
*Users should go to the IPPC form and set up the Pay Components for the PC Usage Codes that will be used by the UPCALC process
• Miscellaneous Identifiers are retrieved from Symmetry during the UPUTR process. These will be passed to the Symmetry Tax Server with this exact name for tax calculations in UPCALC, e.g. FILINGSTATUS
At line 256 changed one line
*For a list of US PC Usages, please read the PR_US_PC_Usages document
• The Reference Text field contains the editing information for the Miscellaneous Identifier
At line 258 changed one line
*The Associated Pay Components section displays a list of Pay Components that are defined for the PC Usage Code\\Example: IPPC PC 6962 NY-MCTMT Commuter Tax is set up with Usage 7452
• The IPUTP screen information will be used by the IPRLU Miscellaneous tab for each employee to enter their filing information by State
At line 260 removed 2 lines
*UPCALC will store the Tax Result for New York Metropolitan Commuter Transportation Mobility Tax in PC Usage 7452. Example: store in PC 6962
\\
At line 263 changed 2 lines
!IPPC - Define Pay Components
*Users should go to the IPPC form and set up the Pay Components for the PC Usage Codes that will be used by the UPCALC process
Internal Miscellaneous Identifiers
• Internal Miscellaneous Identifiers are automatically loaded in via the UPUTR process, these are used to provide Default Methods
At line 266 changed one line
!!Employee Forms
Level Miscellaneous Identifier Provided By Allow IPRLU Override
At line 268 changed 2 lines
!IPRLU - Miscellaneous tab
*IPRLU is the original Tax Filing form where employees must define their Tax Filing information. The IPRLU form contains all of the original fields used by Vertex. There is a also tab for the Misc Tax Parameters needed for Symmetry.
Federal 401K_CATCHUP Internal Yes
State STATE_ROUNDING Legislative No
State SUP_PAID_WITH_REG Internal Yes
State SUP_PAID_WITHOUT_REG Internal Yes
At line 271 removed one line
*All employees MUST be set up on IPRLU 'Miscellaneous' Tab prior to running UPCALC to calculate US Taxation by Symmetry
At line 273 changed one line
*The IPRLU form can be set up without a State code. This entry will be used for multiple States. If the specific State IPRLU entry is defined, this will override the generic State IPRLU entry
• ‘Federal’ level means the Miscellaneous Identifier will be generated with State Name = ‘Federal’ and will be used at the Federal Level taxation, certain Federal Identifiers are applicable to all States of the same pay
e.g. 401K_CATCHUP is used for Federal and State Level 401K calculation
At line 275 changed one line
*When IPRLU is set up without a State, the 'Misc. Tax Seq' column can be defined for many States. The Reference Text will help users to enter the correct information in the Field Variable column
• ‘State’ level means the Miscellaneous Identifier will be generated with State Name = UPUTR selected list of States and will be used at the State Level taxation, these State Identifiers are specific to the defined State only
At line 277 changed one line
*If the 'Misc. Tax Seq' field type is Char, and the 'Reference Text' defines a list of values, the Field Variable column will be edited with the list of values. Example: 000001 FILINGSTATUS only allows S or M or MH or NRA
• These Internal Miscellaneous Identifiers are used internally by UPCALC and will not be passed to the Symmetry Tax Engine
At line 279 changed one line
*When IPRLU is set up with a State, the 'Misc. Tax Seq' must be defined for that specific State only. The IPRLU entry contains information to be used for this State only \\
• Certain Identifiers are defined according to Government Legislative Requirement which allows the Employer to override on IPUTP but however do not allow the employee to override at the employee level, these Identifiers are defined with ‘Provided By’ = ‘Legislative’, e.g. STATE_ROUNDING
At line 281 changed 2 lines
!IPRLUS - Tax Filing Form
*IPRLUS is a trimmed down version of the IPRLU form, used for Symmetry taxation.
• For the ‘Internal’ Identifiers, the employee may optionally add this Identifier on IPRLLU MISC Tab to override the default value of IPUTP, e.g. SUP_PAID_WITH_REG
At line 284 changed 2 lines
*The 'Misc Tax Parameters' are on the 'State' tab.
\\
• For State Supplemental Tax calculation, please read PR_US_IPRLU_Sup_Pay_v1.0.doc for detail for the usage of SUP_PAID_WITH_REG and SUP_PAID_WITHOUT_REG
At line 287 removed one line
!IPPH - Pay Jurisdiction Tab
At line 289 changed one line
*If the Pay Stage is prior to Calculated/Paid, the Work Jurisdiction and Home Jurisdiction area can be used to enter the Home Tax Jurisdiction and Work Tax Jurisdiction. Note: These can also be entered on the PAY HEADER Tab
!IPCU – Define Pay Component Usages
At line 291 changed one line
*Users can click on the Jurisdiction Name icon to look up, or to pop into the Tax Jurisdiction Editor dialog box, to enter the State, County, City, Municipality and School
At line 293 removed one line
*The Tax Jurisdiction is returned by the lookup or the Tax Jurisdiction Editor dialog box and becomes the Pay Jurisdiction of this pay
At line 295 changed one line
*On the Pay Lines tab, each Pay Line Jurisdiction can define the Work Jurisdiction for the line, so that the Hours and Earnings are allocated to the defined Work Jurisdiction of the line
• All US PC Usages are delivered and loaded into the system during each release of US Taxation
At line 297 changed 2 lines
*After this Pay is calculated by Trial Calc or UPCALC, the Tax Audit Information will be displayed for the list of Jurisdictions, and the summary of all Pay Components are displayed on the 'Pay Amounts' tab.
\\
• The user should go into IPPC screen to set up Pay Components for the PC Usage Codes that are to be used by UPCALC
At line 300 changed 2 lines
!IPVT - View Employee Pay Totals
*After the UPCLOZ process is complete, the Pay Header's Work Jurisdictions and Home Jurisdiction will be updated on IPVT YTD / QTD
• For a list of US PC Usages, please read the document PR_US_PC_Usages.doc
At line 330 added one line
• The ‘Associated Pay Components’ section shows a list of Pay Components that are defined for the PC Usage Code
At line 304 changed one line
!IPGH - Manage Government Report Details
e.g. IPPC PC 6962 NY-MCTMT Commuter Tax is set up with Usage 7452
At line 306 changed 2 lines
*The RPYEU process will generate the IPGH information by Jurisdictions
*Users can view the Jurisdiction information on IPGH 'Pay Jurisdiction' tab
- UPCALC will store the Tax Result for ‘New York Metropolitan Commuter Transportation Mobility Tax’ in PC Usage 7452, i.e. store in PC 6962
At line 309 changed one line
!!Site Preference - US Taxation
!IPPC – Define Pay Components
At line 311 changed one line
!IMST - Site Preference
At line 313 removed one line
*For each database server, the IMST Site Preferences below should be set up during the installation of the US Symmetry taxation
At line 315 changed one line
__US TAX PREFERENCES__
• The user should go into the IPPC screen to set up Pay Components for the PC Usage Codes that will be used in UPCALC
At line 317 changed 6 lines
|[US TAX SERIES|US TAX SERIES(System_Preference)]|Defines the US Tax Series to be used in UPCALC; field size: char(1)
| |0, N - N/A: Defines that the organization is not using US Taxation. UPCALC is used for BE/AT purposes only
| |1 - Main US tax module: the Symmetry Tax Engine (STE) is used
| |L - Legacy Series: the Vertex COBOL version tax module is used
|[US TAX HOST NAME|US TAX HOST NAME(System_Preference)]|Defines the Database Host Name of the Symmetry Tax Server that is installed
|[US TAX PORT NUM|US TAX PORT NUM(System_Preference)]|Defines the Port Number of the Symmetry Tax Server that will be listening for incoming Tax Server requests. This must be the same as serverConfig.txt PORT_NUMBER \\ \\
!!Employee Screens
At line 324 changed 10 lines
__SYMMETRY PREFERENCES__
|[US STE LOG DIR|US STE LOG DIR(System_Preference)]|Required. Defines the Output Directory for Symmetry Log File
| |*This directory should be the same Output Directory that is used to generate Interface Files for the Application Server, such as Tantus\output. If the full location is not defined (example: C:\Output), the directory will be relative to the server where the Symmetry Tax Engine is defined.
| |IMPORTANT: Please define a valid Directory Name with the Path Name. The Database Object for Output Files MUST NOT be used. Example: OUTPUT object cannot be used
|[US STE LOG LEVEL|US STE LOG LEVEL(System_Preference)]|Required. Defines the Symmetry Logging Level that will be passed in STE_LOGGING_LEVEL
| |*Users can define one of the following LOG LEVELS: DEBUG, INFO, WARN, ERROR, FATAL, OFF
| |*This should be set to DEBUG as the default. When Trail Calc or UPCALC is run in Utility Trace, this Log Level will be used
| |*When the STE_LOGGING_LEVEL is passed to Symmetry, Symmetry will display the information pertaining to the Level defined. Example: If WARN, it will show only WARN information
| |*Set to DEBUG to see all information when running in Trace
|[US STE LOG FILE|US STE LOG FILE(System_Preference)]|Future functionality. Optional. Users can define an overridden Symmetry Log File name.
!IPRLU – Miscellaneous Tab
At line 347 added 105 lines
• IPRLU is the original Tax Filing screen where employees must have defined their Tax Filing information. The IPRLU contains all of the original fields used by Vertex. A new tab has been added for the Misc Tax Parameters needed for Symmetry.
• All employees MUST be set up on IPRLU MISCELLANEOUS Tab prior to running UPCALC to calculate US Taxation by Symmetry
• IPRLU can be set up without a State code, this entry will be used for multiple States, then if the specific State IPRLU entry is set up, this overrides the generic State IPRLU entry
• When IPRLU is set up without a State, the Misc. Tax Seq can be entered for many States, the Reference Text will help the user to enter the correct information in the Field Variable
• If the Misc. Tax Seq Field Type is ‘Char’ and the Reference Text specifies a list of values, the Field Variable will be edited with this list of values, e.g. 000001 FILINGSTATUS only allows S or M or MH or NRA
• When IPRLU is set up with a State, the Misc. Tax Seq must be entered for that specific State only, this IPRLU entry contains pertaining information to be used for this State only
!IPRLUS – New Tax Filing Screen
• IPRLUS is a new trimmed down version of the IPRLU used for Symmetry taxation. The fields that were solely used by Vertex have been removed from this new screen, therefore this screen should only be used for Symmetry.
• The Misc Tax Parameters have been added to the State tab as there is now more room in the tab to house this information.
• The functionality of the screen remains the same as the original IPRLU as noted in the previous section.
!IPPH – Pay Jurisdiction Tab
• If the Pay Stage is prior to ‘Calculated / Paid’, the Work Jurisdiction and Home Jurisdiction Area can be used to enter the Home Tax Jurisdiction and Work Tax Jurisdiction, note that these can also be entered on the PAY HEADER Tab
• The user can click the Jurisdiction Name to lookup or to pop into the ‘Tax Jurisdiction Editor Dialog’ Box to enter State, County, City, Municipality and School
• The Tax Jurisdiction is returned by Lookup or the ‘Tax Jurisdiction Editor Dialog’ Box and becomes the ‘Pay Jurisdiction’ of this pay
• On the ‘PAY LINES’ Tab, each Pay Line Jurisdiction may specify the Work Jurisdiction of this line so that the Hours and Earnings are allocated to the specified Work Jurisdiction of this line
• After this Pay is calculated by Trial Calc or UPCALC, the Tax Audit Information will be displayed for the list of Jurisdictions, and the summary of all Pay Components are displayed on ‘PAY AMOUNTS’ Tab
!IPVT – View Employee Pay Totals
• After UPCLOZ the Pay Header’s Work Jurisdictions and Home Jurisdiction will be updated into IPVT YTD / QTD
!IPGH – Manage Government Report Details
• RPYEU will generate IPGH information by Jurisdictions
• IPGH ‘PAY JURISDICTION’ Tab allows the user to view the Jurisdiction information
!!Site Preference – US Taxation
!IMST – Site Preference
• For each Database Server, the above IMST Site Preferences should be set up during the installation of US Symmetry taxation
US TAX PREFERENCES
US TAX SERIES - specifies the US Tax Series to be used in UPCALC; field size: char(1)
0, N – N/A, client is not using US Taxation, UPCALC is used for BE/AT purposes only
1 – Main US tax module, the Symmetry Tax Engine (STE) is used
L – Legacy Series, the Vertex COBOL version tax module is used
Q – Quantum Q Series Tax Calculation, not supported, will remove later
US TAX HOST NAME - specifies the Database Host Name of the SymmetryTaxServer that is installed
US TAX PORT NUM - specifies the Port Number of the SymmetryTaxServer that will be listening for incoming Tax Server requests, this must be the same as serverConfig.txt PORT_NUMBER
SYMMETRY PREFERENCES
US STE LOG DIR - optional, specifies the Output Directory for Symmetry Log File
- this directory should be the same Output Directory that is used to generate Interface Files for the Application Server, e.g. \\Tantus\output
- IMPORTANT: please specify a valid Directory Name with Path Name,
the Database Object for Output Files MUST NOT be used e.g. OUTPUT object cannot be used
US STE LOG LEVEL - optional, specifies the Symmetry Logging Level that will be passed in STE_LOGGING_LEVEL
- user may specify one of the following LOG LEVEL:
- “DEBUG”, “INFO”, “WARN”, “ERROR”, “FATAL”, “OFF”, NULL
- this should be set to ‘DEBUG’ as default, when Trail Calc or UPCALC is run in Utility Trace, this Log Level will be used
- when STE_LOGGING_LEVEL is passed to Symmetry, Symmetry will display information pertaining to the Level specified, e.g. if WARN, it will show only WARN info
- please set to ‘DEBUG’ to see all information when running in Trace
US STE LOG FILE - optional, may specify an overridden Symmetry Log File name (future, not used yet)