Data Section

A Data Section allows the content of a document to be subdivided into sections for further processing.

Remarks

Sections can be used for a variety of purposes, including but not limited to the following:

Inherits from: Data Element

Properties

The following 22 properties are defined.

Property Name Description
General
Extract Method Type: Section Extract Method

Specifies how section instances will be identified and extracted.

Scope Type: CaptureScope, Default: MultiInstance

Defines the cardinality of the section, and determines how multiple extraction results will be handled. Can be one of the following values:

  • MultiInstance - Defines a multi-instance section. Each extractor result will produce one section instance.
  • SingleInstance - Only the first matching section instance will be returned.
  • CombineColumns - Combines all matching instances in column read order, and returns a single section instance. Use this setting to re-order content flow when working with multi-column data.
  • MultiInstanceLegacy - Extracts multi-instance sections in a manner compatible with Grooper versions prior to 2.72. Each extractor result will produce one section instance.

Separator String Type: String

The separator to be used between each combined instance when CombineColumns is in use.

Miss Disposition Type: MissDispositionEnum, Default: NoInstance

Defines what will happen if section extraction fails. Can be one of the following values:

  • NoInstance - If the Main Extractor produces no results, then no section instances will be created.
  • DefaultToParent - If the Main Extractor produces no results, a section instance will be created from the source content.
  • BlankInstance - If the Main Extractor produces no results, a blank section instance will be created.
  • UseDefaultZone - If the Main Extractor produces no results, a section instance will be created using the Default Zone.

Default Zone Type: Rectangle, Default: (0,0):(0,0)

The default zone to be used when section extraction fails.

OCR Profile Type: OCR Profile

If an OCR Profile is specified here, once the boundaries of the section have been determined, this zone will be re-OCR'd using this profile.

Resynthesize Type: Boolean, Default: False

If enabled, the contents of each section instance will be resynthesized. When this option is enabled, section instances may not span multiple columns or pages.

Description Type: String

Specifies a description for the item.

Appearance
Collapsible Type: Boolean, Default: False

Indicates whether the section can be collapsed and expanded in the Index Panel.

Hide Border Type: Boolean, Default: False

If set to true, no border will be displayed around the section in user interfaces.

Background Color Type: Color, Default: Control

The background color for this item.

Foreground Color Type: Color, Default: ControlText

The foreground color for this item.

Visible Type: Boolean, Default: True

Controls whether this item is visible in the user interface.

Label Position Type: LabelPositionEnum, Default: Left

Controls how the label for this item is displayed. Can be one of the following values:

  • Left - The label is displayed to the left of the item.
  • Above - The label is displayed above the item.
  • Below - The label is displayed below the item.
  • None - The label will not be displayed.

Label Alignment Type: ContentAlignment, Default: MiddleLeft

The text alignment to be used for the data element's label. Can be one of the following values:

  • TopLeft - Content is vertically aligned at the top, and horizontally aligned on the left.
  • TopCenter - Content is vertically aligned at the top, and horizontally aligned at the center.
  • TopRight - Content is vertically aligned at the top, and horizontally aligned on the right.
  • MiddleLeft - Content is vertically aligned in the middle, and horizontally aligned on the left.
  • MiddleCenter - Content is vertically aligned in the middle, and horizontally aligned at the center.
  • MiddleRight - Content is vertically aligned in the middle, and horizontally aligned on the right.
  • BottomLeft - Content is vertically aligned at the bottom, and horizontally aligned on the left.
  • BottomCenter - Content is vertically aligned at the bottom, and horizontally aligned at the center.
  • BottomRight - Content is vertically aligned at the bottom, and horizontally aligned on the right.

Child Element Options
Child Label Width Type: Int32, Default: 100, Range: 60 - 300

The width to be used for child field labels. Only applicable when the child item's Label Position property is set to Left.

Show Fields In Grid Type: Boolean, Default: False

If enabled, child field will be displayed in a grid in the Index Panel, rather than as individual controls.

Field Label Background Color Type: Color, Default: Control

The background color to be used for field labels when 'Show Fields in Grid' is enabled.

Field Label Foreground Color Type: Color, Default: ControlText

The foreground color to be used for field labels when 'Show Fields in Grid' is enabled.

Behavior
Lookups Type: List of Lookup Specification

A list of lookup operations to be performed on child elements of this container. Each Lookup Specification defines a lookup operation, where the value of one or more Grooper fields will be used to query an external data source, such as a database. The results of the query can be used to validate existing field values or populate additional field values.

Lookup Specifications are executed at the following times:

  • Immediately after Extract runs, all lookup specifications in the Data Model will be executed.
  • When the value of a field is changed by a user, all lookup specifications referencing that field will be executed.
  • When a user manually triggers a lookup in the Index Panel to resolve a case where duplicate results were returned.

Preserve Character Data Type: Boolean, Default: False

Indicates whether character-level position and confidence data should be saved. If true, character-level detail will be saved with the data element. If false, only the raw text of the element's value will be saved. As storing this information increases storage requirements and reduces performance, this feature should only be enabled for individual data elements in cases where it is needed.

Character-level data can be useful in custom activities or custom export sceanrios, and is also used in certain built-in Grooper activities.

Rubberband OCR Profile Type: OCR Profile

The OCR Profile to use for rubberband OCR.

Commands

Command Name Shortcut Keys Description
Add Multiple Items Creates multiple items as children of the selected object.
Clear Children Deletes all children of the selected object(s).
Export to Zip Archive Exports a set of Grooper nodes to a ZIP archive.
Publish to Grooper Repository Publishes one or more Nodes to one or more Target Grooper Repositories.
Unpublish Unpublishes a set of Grooper Nodes to a Target Grooper Repository.

Tabs

Tab Name Description
Data Element - GeneralProvides a user interface displaying the properties of a Data Element as well as an interface for testing the Data Element on test Batch documents.
Grooper Node - ScriptingProvides script viewing, compilation, management, and basic editing features.
Grooper Node - ContentsProvides a user interface for viewing and managing the children of a Grooper Node.
Grooper Node - AdvancedDisplays detailed information about Grooper Node objects, and provides administrative functions for managing them.

See Also

Lookup Specification, OCR Profile, Rectangle, Section Extract Method

Used By

Data Connection - Create Table, Export Mapping, Train Lexicon