2023.1:Footer Rows and Footer Modes (Data Table Functionality): Difference between revisions

From Grooper Wiki
Line 48: Line 48:
* ''Disabled'' - This will disable footer calculation for a '''Data Column'''
* ''Disabled'' - This will disable footer calculation for a '''Data Column'''
* ''Calculate'' - This will enable footer calculation for a '''Data Column'''
* ''Calculate'' - This will enable footer calculation for a '''Data Column'''
'''''Generate Footer Row''''' can create footer rows regardless of whether or not a footer row appears on the document.  In the case of the image below:
* "Table A" has a footer row present on the document totaling the "Salary" column.
* "Table B" has no such row on the document.
[[File:2023.1 FooterRowsandFooterModes 02 GenerateFooterRow 01.png|center]]
In either case, the '''''Generate Footer Row''''' property can generate the footer row and calculate the totaled value for the column, as seen in the image below.


=== Enable Generate Footer Row ===
=== Enable Generate Footer Row ===

Revision as of 13:49, 10 January 2024

This article is about an older version of Grooper.

Information may be out of date and UI elements may have changed.

20252023.1

A "footer row" (also called a "total row") provides Grooper users a quick way to validate numerical data in a Data Column. The Data Column's "Footer Mode" property controls if and how a total is determined for numerical values in a Data Column

About

We will begin by addressing some simple questions you may have.

What is a footer?

A "footer", in terms of table extraction, is a line that indicates you've reached the last row of a table.

What is a footer row?

A "footer row" is a special row that displays totals for some or all numerical columns in the table.

How do I display a footer row in Grooper?

There are two ways depending on what Data Table extract method you're using.
  • For all table extract methods, you can enable the Data Table's "Generate Footer Row" property to generate a blank footer row.
    • This option is useful for situations where you want Grooper to simply calculate the sum total of Data Columns.
    • When enabled, a footer row will always be present in the table Grooper extracts, whether a footer row is present on the document itself or not.
    • To generate a computed sum of the Data Column's values, the Data Column's Footer Mode must be set to Calculate.
  • For the Tabular Layout method only, you can collect a footer row from the document itself by enabling the Capture Footer Row property.
    • This will extract a row from the document using either the Footer Detection extractor's result or a Footer label (if collected in the Document Type's Label Set) for the Data Table
    • Creating a footer row in this way has additional Footer Mode options. You can simply populate the footer row with values collected from the document. You can validate the value collected totals up according to values collected for a column. There are also modes that allow you to calculate a footer value if not present on the document (or otherwise not extracted from the document).
    • Enabling this property will override the Generate Footer Row property, if configured.

What is a "Footer Mode"?

This property determines how footer values are extracted or calculated for each Data Column. This property is located on each individual Data Column's property panel. This property and its configuration options will be discussed in more detail in the following "how to" sections of this article:

Footer values will ONLY be collected/calculated for Data Types with numerical Value Types (Decimal, Double, Int16, Int32, Int64).

  • Furthermore, the Footer Mode property will only appear for Data Columns with numerical Value Types.
  • You will not see this property if the Data Column is using the default "String" Value Type.

How to use Generate Footer Row

A footer row can be created for any Data Table by enabling the Generate Footer Row property.

While there are multiple Footer Mode options, only two apply for footer rows generated by the Generate Footer Row property:

  • Disabled - This will disable footer calculation for a Data Column
  • Calculate - This will enable footer calculation for a Data Column

Generate Footer Row can create footer rows regardless of whether or not a footer row appears on the document. In the case of the image below:

  • "Table A" has a footer row present on the document totaling the "Salary" column.
  • "Table B" has no such row on the document.

In either case, the Generate Footer Row property can generate the footer row and calculate the totaled value for the column, as seen in the image below.

Enable Generate Footer Row

Enable Footer Calculation for Data Columns

Disable Footer Calculation for Data Columns

How to use Capture Footer Row