Filter Process Object

An Integrator Filter process object filters a data flow for certain rows. Rows that match a given criterion can either be allowed to pass through or filtered out, depending on the action attribute. A filter is used to select a subset of data, such as records from a given time period, region, etc. The filtering condition is an AND-OR method. For each column, an array of values is given. If multiple columns are filtered, then each column must have one of the listed data values. In other words, for a single column, it is an OR condition, while it is an AND condition among different columns.

Filter Attributes

Attribute	Type	Description
process_type (required)	String	Identifies the object as a Filter process object. The value of this string is "filter".
input (required)	String	Defines the object from which the data flow is arriving.
action	String	Determines whether data is kept or filtered out. Values allowed are "keep" (default) or "discard".
filters	Array of Sub-Objects	Defines the filtering conditions used to select data. At least one condition must be defined. See the table below (Filter Sub-Objects Attributes) for details.
case_sensitive	Boolean	Controls whether comparisons are case-sensitive or case-insensitive. If the attribute is not specified, comparisons will be case-insensitive. NOTE: This attribute is Case Sensitive in Visual Integrator.
trace_after	Sub-object	Traces data flows leaving the specified object, which makes debugging scripts easier. This is equivalent to adding a Trace process object immediately after the current object. See Embedded Trace Object for more on using trace sub-objects.
trace_before	Sub-object	Traces data flows entering the specified object. This is equivalent to adding a Trace process object immediately before the current object. See Embedded Trace Object for more on using trace sub-objects.

Filter Sub-Objects Attributes

Attribute	Type	Description
column	String	Defines the column that is being filtered.
values	Array of Strings	Defines a list of possible values for the column.
quickview	Boolean	Specifies whether the values should be interpreted as a QuickView parameter so that the value "All Values" matches any string. If this attribute is "true" and the values array contains the single string, "All Values", then all rows are matched for the column. This is useful in Tunnel scripts that are passed filter values from QuickViews.