The KEYWORD Sub-Element - Express Scanning - Foundation 23.1 - Foundation 23.1 - Ready - OnBase - Essential - Premier - Standard - external - Premier - Essential - Standard

Express Scanning

Platform
OnBase
Product
Express Scanning
Release
Foundation 23.1
License
Premier
Essential
Standard

The KEYWORD sub-element allows you to assign default Keyword Values or to require a user to enter values for one or more Keyword Types associated with each document that is imported into OnBase via this button in the Express Scanning client.

Tip:

Manually-entered Keyword Values (and other features that require user interaction) should not be configured for Document Type buttons that are configured to be selected automatically via the autoselect setting in the BUTTON element.

For example, when scanning invoice documents, you might want to have users enter the unique Invoice # Keyword Value for each invoice that is scanned.

Or, you might want to automatically assign a value of Received to the Status Keyword upon scanning the invoices. You can configure the button to automatically assign this value to the Status Keyword Type when a user clicks it to scan or sweep an invoice into OnBase.

Each KEYWORD sub-element is specific to its parent BUTTON element only. To configure default or user-entered Keyword Values for more than one button, a KEYTYPE sub-element must be configured for each BUTTON element. For information on configuring a BUTTON element, see The BUTTONS Element.

Note:

The Keyword Types represented in the KEYWORD sub-element must be assigned to the Document Type in order for Keyword Values to be assigned to the document. For information on assigning Keyword Types to a Document Type, see the System Administration documentation.

In the example above, note the KEYWORD sub-elements are parts of the BUTTON element.

Tag

Description

keytype

This setting identifies the OnBase Keyword Type that is being configured by the settings in this KEYWORD sub-element.

The keytype setting must be set to the OnBase Keyword Type's name. For example, if you are configuring values for the Status Keyword Type in this KEYWORD sub-element, you would set the keytype attribute to Status (i.e., keytype="STATUS").

prompt

Note:

This setting is only used if the Keyword Value is to be entered by the user.

This setting controls the text displayed in the Keyword Value Input dialog box.

For example, if you would like the Keyword Value Input dialog box to display, Please enter the Invoice # below, then you would set the prompt attribute to Please enter the Invoice # below (i.e., prompt="Please enter the Invoice # below").

title

Note:

This setting is only used if the Keyword Value is to be entered by the user.

This setting controls the text displayed in the title bar of the Keyword Value Input dialog box.

For example, if you would like the title bar of the Keyword Value Input dialog box to display, Enter the Invoice #, then you would set the title attribute to Enter the Invoice # (i.e., title="Enter the Invoice #").

hidetext

Note:

This setting is only used if the Keyword Value is to be entered by the user.

This optional setting allows you to disguise the characters that are being entered in the Keyword Value Input dialog box.

Tip:

This option is useful if the user is entering sensitive or private information, such as a Social Security Number.

To disguise the text being entered, set the hidetext setting to true (i.e., hidetext="true").

By default, the hidetext setting is set to false.

numeric

Note:

This setting is only used if the Keyword Value is to be entered by the user.

This optional setting allows you to require the Keyword Value being entered to be a numeric value. If a user attempt to enter a non-numeric character, a message is displayed and the character is not added to the field.

Tip:

This option can help to ensure that the values being entered are accurate by limiting the types of characters that can be entered.

To limit the Keyword Value to a numeric value, set the numeric setting to true (i.e., numeric="true").

By default, the numeric setting is set to false.

allowblank

Note:

This setting is only used if the Keyword Value is to be entered by the user.

This optional setting allows users to enter a blank value in the Keyword Value Input dialog box.

To allow users to enter a blank value in the Keyword Value Input dialog box, set the allowblank setting to true (i.e., allowblank="true").

By default, the allowblank setting is set to false and users cannot enter blank values into the Keyword Value Input dialog box.

dataset

Note:

This setting is only used if the Keyword Value is to be entered by the user.

This optional setting creates a drop-down list of pre-configured values for a Keyword.

To create a dataset for a Keyword, set the value of the dataset attribute to the specified Keyword Values that can be selected for this Keyword. Separate the Keyword Values by semicolons:

dataset="value one; value two; value three"

If the allowblank attribute is set to true, the user is not required to select a value.

If the value attribute is configured, the specified value is pre-selected from the drop-down list. The user can change this value by selecting a different value from the drop-down list.

You may also use variables, such as %username%, %date%, and %location%, as values for the dataset. For example, entering %username% as a dataset value would display the user name of the logged-in user in the drop-down list for the Keyword.

maxchars

Note:

This setting is only used if the Keyword Value is to be entered by the user.

This optional setting specifies the maximum length of the value that a user can enter in the Keyword Value Input dialog box.

To set the maximum length of a user-entered Keyword Value, set the maxchars setting to the maximum number of characters you would like to allow a user to enter for the Keyword Value. For example, to limit a user-entered Keyword Value to 10 characters, set the maxchars setting to 10 (i.e., maxchars="10").

By default, there is no maximum character restriction for user-entered Keyword Values.

Tip:

It is considered a best practice to configure a maxchars value for each alphanumeric Keyword Value that users are expected to enter. This value should be set to the maximum number of characters allowed for the Keyword Type or fewer.

CAUTION:

If a Keyword Value is entered that exceeds that maximum length specified for that Keyword Type, then that Keyword Value will be truncated to the maximum length allowable for the Keyword Type.

dateformat

Note:

This setting is only used if the Keyword Value is to be entered by the user.

This optional setting allows you to require a Date Keyword Value to be in a valid format. If a user attempts to enter a date value that is not in a valid format, a message is displayed and the value is not accepted.

To restrict date values to valid formats, set the dateformat setting to true (that is, dateformat="true").

By default, date values are not restricted to valid formats.

datetimeformat

Note:

The datetimeformat setting is only used if the Keyword Value is to be entered by the user.

The optional datetimeformat setting allows you to require a Date & Time Keyword Value to be in a valid format. If a user attempts to enter a date & time value that is not in a valid format, a message is displayed and the value is not accepted.

To restrict date & time values to valid formats, set the datetimeformat setting to true (that is, datetimeformat="true").

By default, date & time values are not restricted to valid formats.

value

Note:

This setting can be used if a default Keyword Value is to be assigned to the Keyword Type without user interaction. If the value setting is used in a situation where the Keyword Value is to be entered by the user, a default Keyword Value is supplied in the Keyword Value Input dialog box that the user can choose to accept or overwrite.

This setting specifies the default Keyword Value assigned to the Keyword Type identified by the keytype setting.

For example, to set a Keyword Value to received, your value attribute must be set to received (that is, value="received").

You may also use variables, such as %username%, %date%, and %location%, as values for default Keyword Types. For example, value=%username% would set the Keyword Value to the user name of the user who scanned the document.

Other variables can be defined at the workstation level. For more information, contact your solution provider.