The Filter element allows you to filter the Document Type buttons displayed in the Scan/Create Document window based on a specified Keyword Value in the selected Data Set.
<Filter> <Keyword name="Smoker/Nonsmoker" value="Smoker" default="false"> <DocType>1</DocType> </Keyword> <Keyword name="Smoker/Nonsmoker" value="Nonsmoker" default="true"> <DocType>2</DocType> </Keyword> </Filter>
Filters can be "stacked" (i.e., multiple Keyword Value conditions must be met for a Document Type button to be displayed) so that they are even more restrictive. See Configuring a Document Type Button Filter for more information.
The Filter element is composed of one or more Keyword sub-elements. Each Keyword sub-element represents one Keyword Value that is used to filter the displayed Document Type buttons.
Typically, Keyword sub-elements are created in pairs or other multiples to represent multiple potential values of the same Keyword Type (e.g., Status=Smoker/Nonsmoker, Gender=Male/Female, Age=Under 18/18-29/30-39/40-49, etc.).
Each Keyword sub-element contains the following settings:
Keyword Sub-Element Settings |
Description |
---|---|
name |
This setting is used to specify the Keyword Type that is used to filter the available Document Type buttons. Set the name setting to the name of the Keyword Type. |
value |
This setting is used to specify the Keyword Value of the specified Keyword Type used to filter the Document Type buttons. Data Sets with this Keyword Value will satisfy the parameters of the filter. Set the value setting to the desired Keyword Value of the Keyword Type. Note:
If a Data Set contains a Keyword Value for the specified Keyword Type that does not have a corresponding value setting, then the Document Type buttons are not filtered (i.e., all Document Type buttons are displayed). |
default |
This setting is used to specify whether the Keyword Value specified in the value setting is to be used as the default value for the filter Keyword Type.
|
<DocType></DocType> |
The DocType sub-element specifies one or more Document Type button identifier(s) to associate with the Keyword sub-element. This allows the Document Type buttons to be filtered based on Keyword Values in the selected Data Set. Enter the filterid from the DocType element that corresponds to the Document Type button you would like to associate the filter with. ID for the specified Keyword Type/Keyword Value pairing. This filter ID is also assigned to one or more DocType elements. Enter a numeric value for the filter ID. Tip:
It is recommended that the first Keyword sub-element have a filter ID of 1, the second Keyword sub-element have a filter ID of 2, etc. If the parameters of the filter are met (i.e., if the selected Data Set contains a Keyword Value that matches the value setting in the Keyword sub-element):
Tip:
This setting can also be written as: <DocType filterid="" />. |
In order to use the functionality offered by these settings, additional configuration is required. For more information, see Configuring a Document Type Button Filter.