Configuring the Settings of a Filter - Front Office Scanning - Foundation 23.1 - Foundation 23.1 - Ready - OnBase - Premier - external - Standard - Essential - Premier - Standard - Essential

Front Office Scanning

Platform
OnBase
Product
Front Office Scanning
Release
Foundation 23.1
License
Premier
Standard
Essential

Document Type button filters are configured in the Front Office Scanning configuration file. All Document Type button filter information is contained in the Filter element; the configuration information for each individual filter is contained in a Keyword sub-element of the Filter element.

The Document Type button filters are based on Keyword Values; for each specified filter Keyword Value, you assign a Filter ID. When the specified filter Keyword Value is present in the selected Data Set, only the Document Type buttons that have been assigned a matching corresponding Filter ID are displayed.

For example:

Gender is specified as a filter Keyword Type with two potential Keyword Values, Male and Female,. In the Front Office Scanning configuration file, the Male Keyword Value is assigned a Filter ID of 1 and the Female Keyword Value is assigned a Filter ID of 2.

  • If the selected Data Set contains the Male Keyword Value, then only Document Type buttons that have been assigned a Filter ID of 1 in their corresponding DocType sub-element are displayed.

  • If the selected Data Set contains the Female Keyword Value, then only Document Type buttons that have been assigned a Filter ID of 2 in their corresponding DocType sub-element are displayed.

  • If the selected Data Set contains no Keyword Value or another Keyword Value for the Gender Keyword (e.g., Unknown, Unspecified, etc.), then all Document Type buttons are displayed.

Multiple Filter ID values can be assigned to each Document Type button, making the Document Type button filters more restrictive. If the selected Data Set contains no Keyword Value that satisfies one of the filters, then that filter is discarded but any other filters may be applied.

For example:

Gender is specified as a filter Keyword Type with two potential Keyword Values, Male and Female. In the Front Office Scanning configuration file, Male Keyword Value is assigned a Filter ID of 1 and the Female Keyword Value is assigned a Filter ID of 2.

Additionally, Insurance Status is specified filter Keyword Type with two potential Keyword Values, Insured and Uninsured. In the Front Office Scanning configuration file, the Insured Keyword Value is assigned a Filter ID of 3 and the Uninsured Keyword Value is assigned a Filter ID of 4.

  • If the selected Data Set contains the Male and Insured Keyword Values, then only the Document Type buttons that have been assigned 1 and 3 as their Filter ID values are displayed.

  • If the selected Data Set contains the Female and Insured Keyword Values, then only the Document Type buttons that have been assigned 2 and 3 as their Filter ID values are displayed.

  • If the selected Data Set contains the Male and Uninsured Keyword Values, then only the Document Type buttons that have been assigned 1 and 4 as their Filter ID values are displayed.

  • If the selected Data Set contains the Female and Uninsured Keyword Values, then only the Document Type buttons that have been assigned 2 and 4 as their Filter ID values are displayed.

  • If the selected Data Set contains no value for the Gender Keyword Value and the Insured Keyword Value, then only Document Type buttons that been assigned a Filter ID of 3 are displayed (the Gender filter Keyword is ignored because no matching Keyword Value was found, but the filter for the Insurance Status Keyword Type was still applied).

To configure a filter Keyword:

  1. In the Front Office Scanning configuration file, locate the Filter element. If this element is not present, add it to the configuration file.
  2. Add a Keyword sub-element to the Filter element. Each Keyword sub-element specifies the one filter Keyword Value and its associated Filter ID.
    Note:

    Multiple Keyword sub-elements are needed for each filter Keyword Type (i.e., one Keyword sub-element is needed for each potential Keyword Value for a filter Keyword Type). For example, if Gender is your Keyword Type then you would need two Keyword sub-elements: one for Male and the other for Female.

  3. Add the Name setting to the Keyword sub-element and set it to the name of the filter Keyword Type being configured.
    For example: <Keyword name="Gender">
  4. Add the Value setting to the Keyword sub-element and set it to the filter Keyword Value being configured.

    For example: <Keyword name="Gender" value="Male">

    Note:

    If the selected Data Set contains a Keyword Value for a filter Keyword Type that is not specified in the configuration file (e.g., Gender=Unknown, Unspecified, etc.), or if the selected Data Set does not contain a Keyword Value for the filter Keyword Type, then Document Type buttons are not filtered based on this filter Keyword.

  5. If you wish to set the Keyword Value specified in the Value setting as the default, add the Default setting to the Keyword sub-element and set it to true.

    For example: <Keyword name="Gender" value="Male" default="true">

    This ensures that the Keyword Value specified in the Value setting is displayed by default for the filter Keyword Type, even if the selected Data Set does not contain a Keyword Value for the filter Keyword Type.

    Note:

    If the Default setting is set to false, or if it is not present, no Keyword Value is set as the default.

  6. Add the DocType sub-element to the Keyword element and set it to the Filter ID for the filter Keyword Value being configured. For example:
    <Keyword name="Gender" value="Male">
       <DocType>1</DocType>
    Note:

    The Filter ID can be specified in either of the following ways: <DocType>1</DocType> or <DocType> filterid="1"/>

    Tip:

    It is recommended that the first DocType sub-element have a value of 1, the second DocType sub-element have a value of 2, etc.

    Note:

    The Filter ID value is also assigned to one or more Document Type buttons as the FilterID value; for more information, see Assigning a Filter ID to a Document Type Button.

  7. Once the filter has been configured, ensure that you add the end tag (i.e., </Keyword>) to close the Keyword sub-element.
  8. Repeat Steps 2-6 to create a Keyword sub-element for each filter Keyword Value for this filter Keyword Type.
  9. Repeat Steps 2-7 to create Document Type button filters for each filter Keyword Type you would like to configure for your Front Office Scanning solution.
    Tip:

    For more information on the Front Office Scanning configuration file's Filter element, its Keyword sub-element, and its settings, see The Filter Element.

  10. Save and close the configuration file.