Configuring a Template Cross-Reference - System Administration - On-Premises - English - Foundation 22.1 - OnBase - Essential - Premier - Standard - external - Standard - Essential - Premier

On-Premises System Administration

Platform
OnBase
Product
System Administration - On-Premises
Release
Foundation 22.1
License
Standard
Essential
Premier

Template cross-references compare text values in a source document (which must have a Text file format) to Keyword Values stored for the cross-referenced Document Type. The text values used for comparison are offset from the text string a user clicks to initiate the cross-reference. Template cross-references are useful when users might not know which text values are used as Keyword Values on retrieved documents.

In OnBase, the text string a user double-clicks from a source document is called the Identification String. The text values used to match Keyword Values on retrieved documents are called Keyword Strings. Because Keyword Strings must always be in the same place relative to the Identification String, Template cross-references are ideal for documents that follow a standard template (e.g., a text-based report).

The following document lends itself to a Template cross-reference:

For example, the Identification String could be “First Federal” because this text appears in the same column on every document. A Keyword String could be the account number, since this value always has the same number of characters and appears in the same place relative to the Identification String. With this configuration, a user would double-click “First Federal” to retrieve documents indexed with the displayed account number.

To configure a Template cross-reference:

  1. In the Configuration module, select Document | Document Types.
  2. At the Document Types dialog box, select the Document Type that will represent the source document (i.e., the document used to initiate the cross-reference). Click Cross-References.
  3. In the Cross-Reference Assignment dialog box, add one or more Document Types to be cross-referenced.
  4. Click Template.

    The Cross-Reference Template Configuration dialog box displays.

  5. Configure the Identification String, using the following table as a guide:

    Field

    Description

    Line

    This value provides a reference line from which the system begins searching for Keywords Strings. The first line is 1.

    Col

    Type the number of the column in which the Identification String begins (referenced from the left side of the document). The first column is 1.

    String

    Defines the text string as it appears to the user. The user selects this string to retrieve referenced documents.

  6. Configure the Keywords, using the following table as a guide:

    Field

    Description

    Line

    Type the line number on which the Keyword String occurs relative to the Identification String line number.

    For example, if the Keyword String is on the same line as the Identification String, this value is 1. If the Keyword String is on the line immediately below the Identification String, this value is 2. If the Keyword String is on the line immediately above the Identification String, this value is 0. If the Keyword String is two lines above the Identification String, this value is -1.

    Note:

    The Line field is the only field in the Cross-Reference Template Configuration dialog box that can accommodate negative values.

    Col

    Type the number of the column in which the Keyword String begins (referenced from the left side of the document). The first column is 1.

    Width

    Type the number of characters in the Keyword String.

    Keyword Type

    Select the Keyword Type associated with the Keyword String.

    For each Keyword String, enter the appropriate information and click Add.

    Note:

    Documents retrieved by the cross-reference must have Keyword Values that match all the configured Keyword Strings.

    If a Keyword Type has a Date data type, select the Keyword Type from the Keywords list and click Date Format. The Date Format dialog box displays. For information on configuring the Date Format, see Date Formatting.

    To remove a Keyword Type, select it from the Keywords list and click Remove.

  7. If you have configured any additional cross-references for the source Document Type, determine the setting of the Do not check for additional cross-references check box.
    • If this check box is selected, the user receives only reference documents retrieved using the Template cross-reference. The results display in the Document Search Results list.

    • If this check box is not selected, two sets of cross-reference results are returned in the OnBase Client: one for the Template cross-reference and one for the additional cross-reference(s).

      • Results returned by the Template cross-reference display in the Document Search Results list.

      • Results returned by additional cross-reference(s) display in the Cross-Reference For list. Excluding results for the Template cross-reference, the Cross-Reference For list displays results for all Document Types configured for cross-referencing from the source document, regardless of the type of cross-reference (image, text, keyword) configured for each Document Type.

  8. Click Save.