Filters

Allow or deny DataItems by Category, Type, ID, or an Expression, and reduce data with Period and Delta filters.
MTConnect Server Docs Menu

By default, every DataItem of a Profile's Devices is stored and published. A Profile's Filter tab selects the DataItems to include, and reduces how often their values are sent. Each Profile has its own Filter, so the same Device can store everything in a database while only publishing its alarms to MQTT.

Allow and Deny

  • When the Allow list is empty, all DataItems are allowed. Otherwise, only the DataItems matching an Allow pattern are included.
  • DataItems matching a Deny pattern are always left out.

Patterns are added with the picker, which lists the DataItems of the Profile's Devices:

ModeSelects
By CategorySAMPLE, EVENT, or CONDITION DataItems
By TypeA Type (ex. EXECUTION), or a Type and SubType (ex. POSITION ↳ ACTUAL)
By IDA single DataItem, by its ID
ExpressionA pattern typed in (below). Click an example to use it

Expressions

ExpressionMatches
*All DataItems
category=CONDITIONAll Conditions
type=EXECUTIONExecution DataItems
type=POSITION&subtype=ACTUALActual Positions (conditions are joined with &)
id=availThe DataItem with the ID avail
representation=TIME_SERIESTime Series DataItems
/*DataItems of the Device itself (not in a Component)
type=Controller/**All DataItems below Controllers
type=Linear/type=POSITIONPositions of Linear Axes

DataItems can be matched by id, name, type, subtype, category, representation, units, native_units, and coordinate_system. A / separates Components (matched by id, name, or type), * matches any one Component, and ** matches any number of levels.

Match Preview

The Filter previews which DataItems it matches (ex. Matches 42 of 120 DataItems on 2 Devices), using each Device's Probe from its Agent, or the stored Device model when the Agent can't be reached. The picker shows how many of each Category and Type are matched.

A Profile's Filter tab, with the picker By Type and the Match Preview
A Profile's Filter tab, with the picker By Type and the Match Preview

Presets

Presets are ready made changes to the Filter. Applying one writes ordinary settings into the Filter, which can then be seen, edited, and removed like any others.

PresetWhat It Sets
Exclude constantly changing valuesDenies the Types that change all the time a machine runs: POSITION, PATH_POSITION, ANGLE, ROTARY_VELOCITY, AXIS_FEEDRATE, PATH_FEEDRATE, LOAD, TORQUE, ACCUMULATED_TIME, CLOCK_TIME, LINE_NUMBER, LINE, and BLOCK.
Faults onlyKeeps Conditions at the FAULT level, and what ends each one. Warnings and other levels are left out.

Condition Levels

Condition Levels keep only some levels of Conditions: Fault, Warning, Normal, and Unavailable. A level that's left out is still kept when it ends a kept one, such as the NORMAL that clears a kept FAULT, so the stored alarms always have an end.

Period and Delta Filters

FilterDescription
Period FilterSkips values that change more often than the minimum period (milliseconds). Use it to reduce fast changing values, such as positions.
Delta FilterSkips numeric values that change by less than the minimum delta. Use it to ignore small changes, such as noise on a temperature.
Filters don't apply to MTConnect Assets. A Tables Profile stores every Asset of its Devices when Store Assets is on.