Metadata Filter
The 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.
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 metadata is still "present", but is disabled and ignored on all tasks that uses metadata afterwards.
Output
The original data file is output, along with the modified metadata.
Task Properties
General Tab
- Filter levels: Rules for unselecting 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 unselects 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 please be careful when using this option.
On Error Tab
By default, any action task, branch, splitter or condition that generates an error will simply be ignored, and the task just under it (not within a branch) will be given control of the job file without any modification. Any initial input task that generates an error will stop the process from running as a whole, and output tasks will not generate output. The On Error tab can be used to overwrite the default behaviors.
- Send to Process: Check this option to send the job file to an error management process.
- Error Process drop-down: Enabled only when the Send to Process option is checked. Lists any process of which the initial input task is the Input Error Bin task.
- Action Group: This group is disabled in the initial input tasks and defaults to Stop Process. In all other tasks where the On Error tab is present, the following options are available:
- Ignore: The task is ignored as if it did not exist, and the job file is passed on to the next task in the process.
- Stop Branch: If the task is in a branch of the process, the branch is stopped and the job file is returned to the process after the branch. The branch will not produce any output.
- Stop Process: The process is stopped and no more processing is done. No further output is produced.
- Log Message: Check this option to enable logging a custom error message in the PlanetPress Suite Workflow Tools' log file.
- Message: Enabled only when the Log Message option is checked. Enter a message that will be logged in the PlanetPress Suite Workflow Tools' log file. You can use any variables available in PlanetPress Workflow to customize the message.
- Store the message in variable: Select in which jobinfo, local or global variable you want to store the message content.
- ID: Enter an error ID. This ID will be visible in the Windows Event Viewer. However, the ID is not visible in the PlanetPress Suite Workflow Tools' log file.
- Store the ID in variable: Select in which jobinfo, local or global variable you want to store the error ID.
- Reset to defaults: Resets all options in this tab to their default values.
If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten.
Common Errors
Though some error messages are specific to a task in particular, others may apply to any and all tasks because they are related more to the system than to PlanetPress itself. Some examples would be W3813, W3830, W3991, W4005. These correspond to issues such as not having any space to write files, permission errors on folders or files, etc.
Comments Tab
The Comments tab, added in PlanetPress Suite 7.5, is common to all tasks. It contains a single 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.
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.