Table of Contents

Field Formats

The Field Formats functionality in the Document Reporting module provides precise control over how data is presented in your reports. This powerful feature allows you to define standardized formatting rules that can be applied consistently across your reporting system.

Understanding Field Formats

Field Formats define how different types of data should be displayed in reports. They control aspects such as:

  • Number of decimal places for numeric values
  • Rounding methods for numeric values
  • Date formats (day, month, year order and separators)
  • Time formats (12/24 hour, display of seconds)
  • Consistent presentation across multiple reports

Using standardized Field Formats ensures that your business data is presented consistently, improving readability and professional appearance of your reports.

Key Components of Field Formats

Each Field Format definition includes:

  • Code: A unique identifier for the format
  • Description: A descriptive name for the format
  • Rounding Method Code: The rounding method to apply to numeric values
  • Decimal Places: Controls how decimal values are displayed
  • Decimal Format: Specifies additional decimal formatting options
  • Date Format: Controls how date values are displayed
  • Time Format: Controls how time values are displayed

Setting Up Field Formats

To create a new Field Format:

  1. Choose the Lightbulb that opens the Tell Me feature icon, enter Report Field Formats, and then choose the related link.
  2. On the Report Field Format List page, choose the New action.
  3. Fill in the following fields:
    • Code: Enter a unique code for this field format.
    • Description: Enter a descriptive name for the format.
    • Rounding Method Code: Select a rounding method if applicable.
    • Decimal Places: Specify how decimal values should be displayed (e.g., "2" or "2:2").
    • Date Format: Select the preferred date format.
    • Time Format: Select the preferred time format.

Decimal Places Configuration

The Decimal Places field supports two configuration formats:

  1. Single Number Format: Entering a single number (e.g., "2") sets both the minimum and maximum decimal places to that value.
  2. Range Format: Entering two numbers separated by a colon (e.g., "1:3") sets the minimum and maximum decimal places.

Examples:

  • "2" - All numeric values will show exactly 2 decimal places
  • "0:2" - Values will show 0 to 2 decimal places, as needed (no trailing zeros)
  • "2:2" - Values will show exactly 2 decimal places (same as just "2")
  • "2:5" - Values will show at least 2 and at most 5 decimal places

Using Field Formats in Reports

Field Formats can be applied to various reporting components:

1. In Event/Milestone Format Templates:

  1. Open an Event Milestone Format Template Line.
  2. In the Field Format Code field, select the field format to apply.
  3. The system will use this format when displaying date/time values in the event.

2. In Report Definitions:

Field formats can be managed through the function set of a report data item to control how data is displayed:

  1. Open a Report Definition.
  2. Navigate to the data item's function set.
  3. For fields or operations that produce numeric, date, or time output, specify the field format code.
  4. The system will apply this format when displaying the data or operation results.

Best Practices for Field Formats

  • Create a library of standard formats for common data types in your organization
  • Use consistent naming conventions for format codes
  • Consider regional requirements when setting date and number formats
  • Apply formats consistently across related reports
  • Review formats periodically to ensure they continue to meet business needs

Common Field Format Examples

Code Description Decimal Places Use Case
CURR-STD Standard Currency 2:2 General financial values
CURR-PREC Precise Currency 4:4 High-precision financial calculations
PERC-STD Standard Percentage 1:1 General percentage values
PERC-PREC Precise Percentage 2:2 Detailed percentage analysis
QTY-STD Standard Quantity 0:0 Whole number quantities
QTY-FRAC Fractional Quantity 2:2 Quantities with decimal parts
DATE-DMY Date (Day/Month/Year) n/a European date format
DATE-MDY Date (Month/Day/Year) n/a US date format
TIME-24 24-hour Time n/a Standard time format
TIME-12 12-hour Time n/a AM/PM time format
DATETIME Date and Time n/a Combined date and time values

Integration with Other Features

Field Formats work seamlessly with other Document Reporting features:

  1. Event Milestone Formatting: Apply consistent date/time formats to event data
  2. Report Definitions: Ensure consistent data presentation across report elements
  3. Data Grouping: Apply formatting to grouped data for better readability

This integration ensures a consistent look and feel across your entire reporting system.

For more information about event and milestone formatting, see Event and Milestone Formatting.

Edit this page