Object type features

Extractor and validator are two features of Object type.

Content Analyzer patterns, keyPatterns, valuePatterns, and valueOnlyPatterns, are used to extract the keys and values from a document. The object type consists of valuePatterns and valueOnlyPatterns.

Object type features
  • Extractors. The valuePatterns and valueOnlyPatterns patterns are termed as extractors. An extractor is an Object type that is used to extract a word in a document. This word can represent the value in a key-value pair.
  • Validators. The Object type also holds validators, which are used to validate the extracted value in the key-value pair. A validator validates the extracted value in a key-value pair. The validator is part of the Object type.

The "Object type library" hosts the list of all the Object types in the ontology that is grouped by a "scope".

Using the features
  • You can define an <Object type> with zero or more extractors and zero or more <validators> in the Object type library.
  • While you create the keyClass, you can select the Object type to which the keyClass belongs to.
  • In the Ontology Management Tool, where you can create a Key Class, you can select one or more extractors from the selected Object type, or define one or more extractors.
  • You can select one or more validators from the selected Object type, or define one or more validators. By choosing the validators, you can select the logic AND or OR that needs to be applied to validate the value against the validators selected.
  • During processing, the selected extractors are applied on the value to identify the keyClass of the KVP.
  • The value, which is extracted by using the extractors, is validated by the validator.
  • On the document's JSON output:
    • If the extracted value passes the validator logic, the field, ValidatorResult, contains a value of Pass in the KVP entry, which is under the KVPTable field;
    • If the extracted value fails the validator logic, the field, ValidatorResult, contains a value of Fail in the KVP entry, which is under the KVPTable field;
    • If validators are not defined, or the KVP is obtained by using KeyAlias matching, then the ValidatorResult field does not exist.