Configuring Keyword Value Validation - 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

You can configure validation for some or all of the Keyword Values that are manually entered in a Data Set to ensure they meet the following requirements:

  • The Keyword Values meet the minimum and maximum length requirements for their associated Keyword Types.

  • Only data allowable for the Keyword Types can be assigned as Keyword Values (for example, only numerals can be entered for Keyword Values assigned to Numeric 9 or Numeric 20 Keyword Types).

To configure Keyword Value validation:

  1. Open the Front Office Scanning configuration file you created or edited for your solution.
    Tip:

    If you are editing the configuration file template generated by the Hyland Front Office Scanning installer, this file template is stored in C:\Program Files (x86)\Hyland\Front Office Scanning\Template\FOS by default.

  2. Locate one of the following elements:

    • For required Keyword Types for Data Sets, locate the Keywords element.

    • For optional Keyword Types for Data Sets, locate the DataSet element.

  3. Within the element you located, identify the Keyword child element associated with the Keyword Value to be validated. For example:
    Tip:

    For more information on the Keywords and DataSet elements and their child elements' settings, see The Keywords Element and The DataSet Element.

  4. To validate by the data type of the Keyword Value, add the type attribute to the Keyword child element and set it to one of the following values:

    Value

    Description

    numeric9

    Numeric Keyword Values up to 9 digits

    numeric20

    Numeric Keyword Values up to 20 digits

    date

    Date Keyword Values

    datetime

    Date & Time Keyword Values

    currency

    Currency Keyword Values

    Note:

    Currency values should respect the currency format assigned to the Keyword Type. The only allowable currency symbol is $.

    float

    Floating Point Keyword Values

    alpha

    Alphanumeric and Alphanumeric Single Table Keyword Values

    Note:

    If the alpha setting is used, the maxLength setting is also required.

    For example, to allow only currency Keyword Values, set type="currency".

  5. To validate by a minimum length, add the minLength attribute to the Keyword child element and set its value to the minimum number of characters you want to require for alphanumeric or numeric Keyword Values. For example, to require values to be five or more characters, set minLength="5".
  6. To validate by a maximum length, add the maxLength attribute to the Keyword child element and set its value to the maximum number of characters you want to allow for alphanumeric or numeric Keyword Values. For example, to require values to be nine or fewer characters, set maxLength="9".
    Note:

    The maxLength setting does not override the maximum length configured for the Keyword Type. Any Keyword Value that exceeds the maximum length configured for its Keyword Type is truncated in the Data Set, even if the maxLength setting's value is longer.

  7. Save the configuration file.
    Note:

    To apply your configuration changes to an open Front Office Scanning client, a user must close and reopen the client.