Configuring Keywords - Host Enabler - Foundation 23.1 - Foundation 23.1 - Ready - OnBase - external - OnBase/Host-Enabler/Foundation-23.1/Host-Enabler/Configuration/Configuration-Overview/Configuring-Keywords - 2023-09-11

Host Enabler

Platform
OnBase
Product
Host Enabler
Release
Foundation 23.1
License

In Terminal Cross-Referencing keywords are used to determine which document or folder of the selected document/folder type will be retrieved from OnBase when you double-click on an action field on the Terminal Emulation screen.

In Terminal Screen Scraping keywords tell OnBase which characters must be picked up as index keywords during screen scraping. Keyword data entry areas are defined by blocking off the possible number of characters that will comprise each keyword value when typed into the Terminal Emulation screen data entry form.

To configure keywords:

  1. Select the first keyword value on the Terminal Emulation screen then click Configure Keywords from the Terminal Emulation screen tools box to open the Keywords dialog box. If the keyword has been selected, the X and Y positions, length and height edit fields will be automatically filled in on the Keywords dialog box.
  2. The Document/Folder Type section indicates which document/folder these keywords will further define.
  3. If the keyword value has not been selected in the Terminal Emulation screen, you can manually fill in the following edit fields:

    Edit Field

    Description

    X Position

    Horizontal page position of the first character of the keyword. This number can be determined by counting columns across the width of the page (left to right) up to and including the first character of the keyword.

    Y Position

    Vertical page position of the first character of the keyword. This number can be determined by counting rows down the length of the page (top to bottom) up to and including the first character of the keyword.

    String

    Number of characters that comprise the longest potential keyword (if there is the possibility of multiple keywords).

    Height

    Number of characters that comprise the height of the keyword. If there are multiple keywords - enter a number that will comprise many lines of text and select Get Keywords Clicked by User.

  4. You can select a keyword type that will be used to determine which document or folder will be retrieved from the Keyword Type drop-down list.
  5. Only use the Get Keywords Clicked by User check box for Terminal Cross-Referencing. You can select the check box to have OnBase ignore any keywords that were previously configured for the selected action field. Instead OnBase will look at the X Position and the character length and height of the configured keyword. OnBase then picks up the specified number of characters starting at the X position in the line that you have double-clicked. These characters are now used for the keyword value.
  6. When you have finished configuring the keywords, click Save.