│ Grooper Help - Version 25.0
25.0.0017 2,127
  • Overview
  • Help Status

Key-Value List

Ordered Array Grooper.Extract

Matches cases where a key and a list of 1 or more values occur on the document in a specific layout.

Remarks

The KeyValueList collation provider extracts structures where a single key is associated with a list of one or more values, based on their layout within the document.

How it works:

  • Requires exactly two child extractors on the Data Type: one for keys and one for values.
  • For each key instance found by the first extractor, the provider locates all qualifying value instances from the second extractor that are associated with that key, according to document layout and sequence.
  • Each key-value association is output as a separate result, with the key stored as context for each value.

Requirements:

  • The Data Type must have exactly two extractors (pattern, referenced extractors, or child extractors).
  • If this requirement is not met, validation will fail.

Use cases:

  • Extracting lists of values that are labeled by a single key, such as "Allergies: ...list of allergies..." or "Items: [Item1, Item2, Item3]".
  • Capturing repeated key-value list structures in forms, tables, or semi-structured documents.

Related behaviors:

  • The provider disables properties such as 'CombineMethod', 'ResultSeparator', and 'ReturnChildValues', as they are not relevant to this collation mode.
  • The output structure is determined by the spatial and sequential relationship between key and value extractors.

Properties

NameTypeDescription
General
Layout
Combine Options

See Also

HorizontalVerticalFlow

Used By

Data Type

Notification