ContextFilter

Filter context keys by applying one of the various available manipulations and storing in a new context key. Please notice that the resulting context key will not be available automatically as an option but you can still specify it.

javascript · Common Scripts

Details

ID	`ContextFilter`
Language	javascript
From Version	5.0.0
Tags	Utility

README

Filters context keys by applying one of the various available manipulations and stores a new context key. The resulting context key will not be available automatically but you can still specify it as an option.

Script Data

Name	Description
Script Type	javascript
Tags	Utility

Inputs

Argument Name	Description
data	The data to apply the filter on.
filterType	The type of filter to apply. Can be, “upper”, “lower”, “join”, “split”, “index”, “substr”, “trim”, “regex”, or “replace”.
filter	The data for the filter. Can be, “join” - the join string between elements (this is optional. The default is ‘,’), “split” - the string on which to split (This is optional. The default is ‘,’), “index” - the index of the array to return (This is optional. The default 0), “substr” - the from (inclusive) and length (This is optional. The default is to end of string), “regex” - the regular expression to match, “replace” - a regular expression to replace and with what.
out	The name of the context output parameter that should be written to.
additional	The additional arguments to add to filter. For example, flags for regex. Flags, replace string for replace. Length for substr.

Outputs

There are no outputs for this script.

Source

ContextFilter.js ContextFilter.yml

Download History Raw

commonfields:
  id: ContextFilter
  version: -1
name: ContextFilter
script: ''
type: javascript
tags:
- Utility
comment: Filter context keys by applying one of the various available manipulations
  and storing in a new context key. Please notice that the resulting context key will
  not be available automatically as an option but you can still specify it.
system: true
enabled: true
args:
- name: data
  required: true
  default: true
  description: The data to apply the filter on
  isArray: true
- name: filterType
  required: true
  description: The type of filter to apply. Available filters are upper, lower, join,
    split, index, substr, trim, regex, replace
- name: filter
  description: The data for the filter. join - the join string between elements (optional,
    default is ','). split - the string on which to split (optional, default is ',').
    index - the index of the array to return (optional, default 0). substr - the from
    (inclusive) and length (optional, default is to end of string). regex - the regular
    expression to match. replace - a regular expression to replace and with what.
- name: out
  required: true
  description: The name of the context output parameter we should write to
- name: additional
  description: Additional arguments to add to filter. flags for regex. flags, replace
    string for replace. length for substr.
scripttarget: 0
dependson: {}
timeout: 0s
fromversion: 5.0.0
tests:
- No tests