Segment item parameters
Note
If the segment item where the parameter is declared is flagged as obsolete, the segment item parameter is also flagged as obsolete.
Maintain a segment item parameter
Segment item parameters are declared on the Calculations tab of segment items but you can maintain them in the Parameter window.
- In the Navigation pane, highlight the Payroll/Human Resources > Setup > Segment Items > Parameters folder.
- In the HD view, locate and double-click the parameter you need to maintain. The Parameter window opens with the parameter record loaded.
- The Parameter field shows the current name of the parameter. If the parameter is not currently used in any calculation expressions, you can change it. If you change the name of a parameter that is used in a calculation expression and attempt to save the change, ActivityHD warns you that the proposed change is invalid.
- In the Description field, enter a description of the parameter.
- From the Data Type drop-down list, select the type of data the parameter can accept. Your options are:
- Date
- Number
- String (text)
- True/False
- If you selected "Number" in the Data Type field, the Scale field is enabled. Enter the number of decimal places (0-4) to allow in parameter values.
- From the Date Source drop-down list, select the type of date to compare the effective date for parameter values to. Your options are:
- Check
- Work
Pay parameters such as salary or pay rate are typically compared to the work date. Most tax parameters such as social security rate are compared to the check date. Deductions can be either one.
- To enter a new value for the parameter:
- Add a blank row to the Values table.
- In the new row in the Effective Date column, enter the date that the new value for the parameter takes effect.
- In the Value column, enter the new value for the parameter.
- In the Description column, enter a description of the value.
- When you finish, save your changes.
Perform only the steps necessary to update the parameter record.
Delete a segment item parameter
A segment item parameter cannot be deleted if it is used in a calculation expression.
To delete a segment item parameter that is not used in a calculation expression, highlight the parameter record in the HD view and click , or open the segment item parameter and select
> Edit > Delete. In either case, ActivityHD prompts you to confirm your action. Click Delete to delete the parameter.
Flag a segment item parameter as obsolete
You can flag individual parameters, even built-in parameters, as obsolete. When a parameter is marked obsolete, its values also become obsolete. Since numerous built-in parameters are available, marking those you do not use as obsolete effectively "hides" them from your view while leaving them accessible in case you need them in the future.
Like other obsolete items in Payroll, obsolete parameters and their values are still used for payroll processing and reporting.
To flag a segment item parameter as obsolete:
- In the Navigation pane, highlight the Payroll/Human Resources > Setup > Segment Items > Parameters folder.
-
In the HD view, locate and double-click the segment item parameter you need to flag as obsolete. The Parameter window opens.
- Mark the Obsolete checkbox.
- Save your changes.
Purpose
The Segment Item Parameters Listing provides a list of segment item parameters defined in Payroll.
Content
For each segment item parameter included on the report, the listing shows:
- description
- data type
- scale
- date source
- whether the parameter is obsolete.
In addition, you can include:
- parameter values (segment item, effective date, value).
The following total appears on the report:
- record count.
Print the report
- In the Navigation pane, highlight the Payroll/Human Resources > Setup > Segment Items > Parameters folder.
- Start the report set-up wizard.
- To report on all or a filtered subset of segment item parameters:
- Right-click the Parameters folder and select Select and Report > Segment Item Parameters Listing from the shortcut menu.
- On the Selection tab, define any filters to apply to the data.
- To report on specifically selected segment item parameters:
- In the HD view, select the segment item parameters to include on the report. You can use Ctrl and/or Shift selection to select multiple records.
- Click
.
- To report on a particular segment item parameter from the Parameter window:
- In the HD view, locate and double-click the segment item parameter to report on. The Parameter window opens with the segment item parameter loaded.
- Click
.
- To report on all or a filtered subset of segment item parameters:
- Select the Options tab.
- In the Effective Date field, enter the date to compare with the parameter value effective dates to determine which parameters to include on the report.
- To include values for the parameters on the report, mark the Include Parameter Values checkbox.
- Select the Output tab.
- In the Design field, look up and select the report design to use.
- In the toolbar, click the icon for the type of output you want:
- Provides access to two preview options.
- Preview - Click the icon or click the drop-down arrow and select Preview from the drop-down menu to view the report in the Crystal Reports viewer.
- Preview to PDF - Click the drop-down arrow next to the icon and select Preview to PDF to view the report in the PDF reader.
- Opens the Print dialog so that you can select and configure a printer and then print a paper copy of the report.
- Opens the Report Email dialog so that you can address and compose an email that the report will be attached to. For best results, ensure your email client is running before you attempt to send a report via email.
- Opens the Export Report dialog so that you can save the report to a file. File types include Crystal Reports (.rpt), PDF (.pdf), Microsoft Excel (.xls), Microsoft Word (.doc), rich text (.rtf), and XML (.xml).
Data extensions
The following data extensions are available for the report:
- Segment item parameters
- Segment item parameter values
Parameter Record ID
Displays the segment item on which the parameter is defined.
Press F3 to look up the value.
If a value is already selected, you can press F4 to open the record in its native editor.
- Date
- Number
- String
- True/False
- Check
- Work
Pay parameters such as salary or pay rate typically compare the work date to the effective date. Most tax parameters such as social security rate compare the check date to the effective date. Deductions can use either one.
Parameter tab
Segment Item Values tab
The Segment Item Parameter Values pane shows the Segment Items > Parameter Values HD view filtered to show all parameter values for the selected segment item.
Double-click a row in the pane to drill down to its record in the Segment Item Parameter Value window.
Employee Values tab
The Employee Parameter Values pane shows the Employees > Parameter Values HD view filtered to show all values for the parameter that are assigned on an employee record.
Double-click a row in the pane to drill down to its record in the Employee Parameter Value window.
Parameter | Description | Data Type | Scale | Data Source | Comments |
---|---|---|---|---|---|
Tax:SUTA:Percent | State unemployment percent | Number | 4 | Check | |
Tax:USA:SuppMethodAggregate | "True" means use the aggregate supplemental method. Not found or "False" means use the fixed rate method to calculate tax on supplemental pay. | True/False | N/A | Check | |
Type:Pay:HrRate | Hourly rate | Number | 4 | Work | These parameters support the annual salary calculation needed for some StateW4.Withholding calculations (Delaware, Georgia, Hawaii, Rhode Island, Wisconsin). For example:
|
Type:Pay:YrSalary | Annual salary amount | Number | 2 | Work | |
Type:Tax:CASDIExempt | Employee is exempt from SDI (California only) | True/False | N/A | Check | |
Type:Tax:CASDIMax | Maximum wages for SDI (California only) | Number | 2 | Check | |
Type:Tax:CASDIPercent | SDI percent (California only) | Number | 2 | Check | |
Type:Tax:COFAMLIEmployeeShare | Colorado FAMLI Employee Share Percent | Number | 2 | Check | |
Type:Tax:COFAMLIPercent | Colorado FAMLI Total Percent | Number | 2 | Check | |
Type:Tax:CPP2MaxContr | Canada CPP 2 Maximum Contribution | Number | 2 | Check | |
Type:Tax:CPP2MaxEarn | Canada CPP 2 Maximum Earnings | Number | 2 | Check | |
Type:Tax:CPP2Percent | Canada CPP 2 Percent | Number | 2 | Check | |
Type:Tax:CPPExempt | Canada CPP Employee is Exempt | True/False | N/A | Check | |
Type:Tax:CPPExemptAmt | Canada CPP Annual Exemption | Number | 2 | Check | |
Type:Tax:CPPMaxContr | Canada CPP Maximum Contribution | Number | 2 | Check | |
Type:Tax:CPPMaxEarn | Canada CPP Maximum Earnings | Number | 2 | Check | |
Type:Tax:CPPPercent | Canada CPP Percent | Number | 2 | Check | |
Type:Tax:EIMaxEarn | Canada EI Maximum Earnings | Number | 2 | Check | |
Type:Tax:EIMaxPrem | Canada EI Maximum Premium | Number | 2 | Check | |
Type:Tax:EIPercent | Canada EI Percent | Number | 2 | Check | |
Type:Tax:HDF1 | Canada Annual Deductions | Number | 2 | Check | |
Type:Tax:K3 | Canada Other Tax Credits | Number | 2 | Check | |
Type:Tax:LCF | Canada LCF Shares | Number | 2 | Check | |
Type:Tax:MedEEAddPercent | Medicare employee additional percent | Number | 2 | Check | |
Type:Tax:MedEEPercent | Medicare employee percent | Number | 2 | Check | |
Type:Tax:MedEEThreshold | Medicare employee wages threshold | Number | 2 | Check | |
Type:Tax:MedERPercent | Medicare employer percent | Number | 2 | Check | |
Type:Tax:MedExempt | "True" means employee is exempt from Medicare deduction | True/False | N/A | Check | |
Type:Tax:SocSecEEPercent | Social security employee percent | Number | 2 | Check | |
Type:Tax:SocSecERPercent | Social security employer percent | Number | 2 | Check | |
Type:Tax:SocSecExempt | Social Employee is Exempt | True/False | N/A | Check | |
Type:Tax:SocSecMax | Social security maximum wages | Number | 2 | Check | |
Type:Tax:TC | Canada Total Claim Amount | Number | 2 | Check |
![]() |
Extras\Payroll\Import Segment Item Parameters.xls; PRBuiltInStateData.sql |
Segment item parameters security
Common accesses available on segment item parameters
Segment item parameters filters
The following built-in filters are available for segment item parameters:
Report Email dialog
- Windows user default account. Sends email using the user's Windows default email account. For most users, this is the account configured in Outlook or another email client application.
- Server personal. Sends email using the email configuration for the system or company server and the email address on the current user's authorized user record. The authorized user record must have a confirmed email address.
- Server generic. Sends email using the email configuration and "from" address for the system or company server. This option requires "Send generic" access to the Server Email resource.
5225 S Loop 289, #207 Lubbock, TX 79424 806.687.8500 | 800.354.7152 |
© 2025 AccountingWare, LLC All rights reserved. |