› Capture › Extraction groups › Fields › Properties of a field in a document type › General properties of a document type field › Configure the formatter settings for a document field

Configure the formatter settings for a document field

Configure formatting rules for a document field using predefined formatters or inline formatting rules.

Use predefined formatters

Predefined formatters are reusable formatting rules that can be applied to multiple fields. Choose from existing formatters such as Date, Percentage, Amount, or Business rule.

Procedure
  1. In the Formatter field, select a predefined formatter from the dropdown list.

    For more information about available formatters, see Field formatters.

  2. Select Save in the field properties.

    The formatter is applied to the field.

Create an inline formatting rule

Create a formatting rule specific to a field without creating a separate formatter. Inline formatting rules can be simple or conditional.

Procedure
  1. In the Formatter field, select to create an inline formatting rule.
  2. Select one of the Formatting options:

    • Simple (Default): Use simple formatting when the formatting logic is straightforward and does not depend on conditions.

      1. Configure the following settings:
      Property Description
      Format expression

      Enter the expression to format the field value. The toolbar provides operators. To use fields or functions, right-click on the rule editor to select the item.
      Failure

      • Error message: Display an error message when formatting fails.

      • Error code: Display an error code when formatting fails. The dropdown displays the error codes configured in the error codes page.

    • Conditional: You can define multiple conditional formatting rules, each with its own condition and format expression.

      1. Select .

      2. Configure the following settings:

        Property Description
        Name

        A descriptive name for the conditional rule.
        Condition

        Enter the condition that determines when this format expression applies. The toolbar provides operators. To use fields or functions, right-click on the rule editor to select the item.
        Format

        Enter the format expression to apply when the condition is true. The toolbar provides operators. To use fields or functions, right-click on the rule editor to select the item.
        Failure

        • Error message: Display an error message when formatting fails.

        • Error code: Display an error code when formatting fails. The dropdown displays the error codes configured in the error codes page.
        Save Saves the conditional formatting.

      3. Select Save to save the conditional formatting.
      4. Optional. To add multiple conditional rules, select Add and configure each rule.

      Conditional formatting rules are evaluated in the order they are displayed. The first matching condition is applied, and the remaining rules are skipped. If no conditions match, the field value remains unchanged and the field is set to valid.

  3. Optional. To test the formatting rule, select either option:

    • Validate: Checks the syntax of the format expression and condition (for conditional formatting) at design time.

    • Test: Tests the formatting rule with sample data to verify the output.

    To delete an inline formatting rule, select . The configured rule is removed and the rule editor panel is closed.

  4. Select Save.

    The formatter is applied to the field.