Set Property Index Stage
The Set Property Index Stage is used to set a value on a document, or into the Pipeline Context for downstream consumption
by specifying a series of simple matching conditions.
These conditions match against whether a field exists, and simple substring matches on the field contents.
For more complex logic, use a JavaScript Index Stage.
|
|
When entering configuration values in the UI, use unescaped characters, such as \t for the tab character. When entering configuration values in the API, use escaped characters, such as \\t for the tab character.
|
A stage can conditionally set a value on a document or into the Pipeline Context for downstream consumption by having any one of the simple conditions return true. If you wish to have a more complex condition than the ones provided here, then use the Javascript Conditional option available on the stage.
skip - boolean
Set to true to skip this stage.
Default: false
label - string
A unique label for this stage.
<= 255 characters
condition - string
Define a conditional script that must result in true or false. This can be used to determine if the stage should process or not.
source - array[string]
The source fields and context keys to check conditions against. If only the source fields are set and nothing else, then only set the property if all fields are present and non-null on the document. May be a String Template.
ifEquals - string
Check whether a value equals another value. Valid entries for this are: another field/context key, the word 'null' or 'not null' (without the quotes) or a literal string (e.g. "match") in quotes (single or double). The value may be a String Template.
regularExpression - string
Apply the regular expression to the source fields and or context keys. If any of them match, than set the property. The implementation returns true if the regular expression matches anywhere in the string.
outputKey - string
The name of the key to insert into the output location (document or context). May be a String Template. See https://github.com/antlr/stringtemplate4/blob/master/doc/index.md
Default: setPropertyKey
outputValue - string
The value to set. May be a String Template. See https://github.com/antlr/stringtemplate4/blob/master/doc/index.md
Default: true
falseOutputValue - string
The value to set when nothing matches. If null/empty, then nothing will be output (same behavior as in Fusion 2.2). May be a String Template. See https://github.com/antlr/stringtemplate4/blob/master/doc/index.md
whatMatchedKey - string
The name of the context key to use to store a space separated list of what conditionals matched.
Default: whatMatched
outputType - stringrequired
Select whether the flag should be set on the document or in the Pipeline Context.
Default: context
Allowed values: documentcontext