Format Fields

Format Fields

Accessed from:

  • Setup > Tables > Payroll > Forms > Formats > export format > Setup > Format fields

Description

Format fields are user-definable fields that consolidate or populate the contents of an export format from various payroll-related data. For example, you may have a format field for a line of earnings in the Payroll register export format that you populate from an earning group.

Each format field record can be associated with a position filter, thereby differentiating between different jurisdictions or business entities that may use the same export format.

Format fields commonly define data or content fields (sometimes referred to as boxes) that appear on various types of statutory reports, such as the W-2 in the United States and the T4 in Canada.

Additional Tabs

Tab Tab Functions
Fast entry Duplicate any export format fields for any position filters currently set up in the company. Only export formats that have a blank position filter can be duplicated.

Fields

Field Description
Position filter Position filter code to identify that the export format field applies only to workers (or other payroll objects) with the specified position filter
Export format field User-definable name of export format field
Short code 5-character identifier. Defaults to the first five characters of the name
Description Long description of the format field
Field source type

Defines the type of the format field. One of:

  • Fixed: custom text (e.g., ABCCompany)
  • Accumulator: values from an accumulator
  • Calculation code: value from a calculation
  • Table: name of a database table
  • Expression: system function call (e.g., systemDateGet())
  • Benefit/Deduction: values from a benefit/deduction code
  • Boolean: Yes/No value
  • Enum: custom or system-enumerated value (e.g., currency types)
  • Earning: value from an earning code
  • Entitlement: value from an entitlement code
  • Communication type:
  • Earning group: value from an earning group
  • Benefit/deduction group: value from a benefit/deduction group
Field source enum name If Field source type is Enum, specify the enumerator type that determines the values of Field source
Field source Explicit value or location where the value of the export format field is obtained from (i.e., custom text, accumulator name, calculation, etc.)
Display in report? Yes to display the field in a report, if the export format is used to generate reporting data. No to hide the field.
Exclude if zero? Yes to hide the field from a report, if the value of the field is zero. No to display the field and the zero value.