Key-Value Pair (Collation Provider)
Key-Value Pair is a Collation Provider for Data Type extractors. It uses the layout relationship between a key and a value on a document to return a result.
Key-Value Pair collation is one of the most commonly used collation providers. It provides an excellent way to extract data when a value exists next to a label on a document, whether next to it horizontally, vertically, or even in a text flow.
About
How are these two boxes related to each other?
They're next to each other. You could draw a horizontal line connecting the two boxes.
How are these two boxes related?
They're also next to each other, just vertically instead of horizontally.
How is the green box different from the orange boxes?
It's horizontally aligned with the blue box!
This is how Key-Value Pair collation works. Key-Value Pair collation uses the relationship between two extractors, a "Key" extractor and a "Value" extractor, to return the value aligned with the key.
The beauty of Key-Value Pair collation is even if the Value extractor returns multiple hits on the page, only the one next to the specified Key will be returned.
Key-Value Pair collation is set using the "Collation" property of a Data Type.
The Key-Value Pair provider collates the results of two child extractors, a "Key" extractor and a "Value" extractor.
The Key extractor locates a word, phrase or piece of data that relates to the value you wish to extract. The Key is the context you as a human use to find a value on a page. This is typically a label for the value, such as the word "Date" labeling a particular date.
The Value extractor matches the value you wish to return. The beauty of Key-Value Pair collation is the Value extractor can match multiple results besides the specific one you want to return. Only the result laid out next to the key will be returned (This layout