Set Property Index Stage

Configuration

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.

Configuration

Tip	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.

When using Fusion's REST API, the type for this stage is: index-set-property.

Property Description, Type

falseOutputValue

False Output Value

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

type: string

ifEquals

If Value Equals

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.

type: string

outputKey

Output Key

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

type: string

default value: 'setPropertyKey'

outputType

Output Type

required

Select whether the flag should be set on the document or in the Pipeline Context.

type: string

default value: 'context'

enum: { document context }

outputValue

Output Value

The value to set. May be a String Template. See https://github.com/antlr/stringtemplate4/blob/master/doc/index.md

type: string

default value: 'true'

regularExpression

Regular Expression Match

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.

type: string

source

Source

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.

type: array of string

whatMatchedKey

What Matched Key

The name of the context key to use to store a space separated list of what conditionals matched.

type: string

default value: 'whatMatched'