Metadata Filter

The Metadata Filter task allows specifying the Level (Group, Document and Datapage) on which to perform the action and under which condition. At least one level must have the condition set. The action will be performed sequentially beginning with the rule on the Group level, Document level and Data page level. The selection is performed on the node only.

For more information about Metadata see Metadata.

Input

Any data file with accompanying Metadata.

Processing

Any Metadata that does not correspond to the rules set forth by the filter are removed from the active Metadata. Note that the 'removed' Metadata is still present in the file, but is unselected: they are disabled and ignored on all tasks that use Metadata afterward (except the Metadata Sorter task).

Output

The original data file is output, along with the modified Metadata.

Task properties

General Tab

  • Filter levels: Rules for deselecting nodes at the Group, Document or Data page level. Note that currently unselected nodes are ignored.
    • Group: Select the Metadata Group nodes (the nodes only) based on the specified rule(s).
    • Document: Select the Metadata Document nodes (the nodes only) based on the specified rule(s).
    • Datapage: Select the Metadata Datapage nodes (the nodes only) based on the specified rule(s).
  • Rules: Define according to which criteria the action must to be performed. The condition must be TRUE to execute the action. All nodes on a specific level with false condition become unselected. The task effectively both selects and deselects nodes based on the condition. To set up conditions, the Rule Interface is displayed, allowing to edit the condition for the given action. See the Rule Interface page for more details.
  • Select all Metadata nodes: Check to reset the Selection status of all nodes before performing the filtering, effectively selecting all metadata nodes. This basically undoes the work of any previous Metadata Filter or Metadata Sequencer, so be careful when using this option.

On Error Tab

For a description of the options on the On Error tab see Using the On Error tab.

Miscellaneous Tab

The Miscellaneous tab is common to all tasks.

It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button and are displayed in The Task Comments Pane.

Check the option Use as step description to display the text next to the icon of the plugin in the Process area.

The tab also provides an option to highlight the task in The Process area with the default color, set in the Preferences (see Colors), or the color selected or defined under Highlight color on this tab.
To revert the selected highlight color to the default color, open this tab, turn the Highlight option off and close the dialog with the OK button; then turn highlighting back on.
Highlighting can also be turned on and off via the task's contextual menu and with the Highlight button on the View ribbon.

Special Considerations

  • The task CANNOT re-select unselected nodes if the condition is false for those nodes.
  • Filter rules cannot be based on the following metadata attributes: SelectedIndexInJob, SelectedIndexInGroup, SelectedIndexInDocument and SelectedIndex.