Masked Keywords - Web Client - Foundation 24.1 - Foundation 24.1 - Ready - OnBase - Essential - Premier - Standard - external - Standard - Premier - Essential

Web Client

Platform
OnBase
Product
Web Client
Release
Foundation 24.1
License
Standard
Premier
Essential

Masked Keyword Types must have values entered in a specific format, called a mask format. Fields for masked Keyword Types prohibit you from typing values that do not satisfy the mask format.

For example, a masked Keyword Type for Social Security Numbers may contain dashes as static characters and allow users to enter only nine numeric characters. The dashes are entered automatically as the subsequent characters are typed.

Depending on your system's configuration, a mask may also be applied to certain Keyword Values upon retrieval.

In the Keyword Panels for retrieving, importing, indexing, and re-indexing documents, the mask format is displayed below the Keyword Type field, as shown in the following example:

The example Keyword displayed is Social Security Number. The mask format displayed below the keyword is 000-00-0000.

Mask formats are composed of characters that represent the types of characters accepted in a valid Keyword Value. Use the following table to determine what types of characters you must enter to satisfy a mask format for a masked Keyword Type.

Mask Format Character

Description

A

Accepts alphabetic characters only. Special characters such as é or ñ are allowed.

X

Accepts any printable, alphanumeric character (except control codes).

0

Accepts numeric characters only.

9

Accepts numeric characters and the following symbols: +, -, ., *.

Any other character

Accepts only the character displayed in the mask format. For example, if the mask format is 000-00-0000, then a dash must be entered for the fourth and seventh characters; all other characters must be numeric.

Blank spaces may also be used. For example, if the mask format is 0 000, then the second character must be a space.

The Web Client automatically enters these static characters for you as you type subsequent characters, so you do not need to type them manually. If a static character is at the end of a mask format, the Web Client enters it automatically when you type the second-to-last character.