Configuring a Security Mask - Encrypted Alpha Keywords - Foundation 23.1 - Foundation 23.1 - Ready - OnBase - Essential - Premier - Standard - external - Standard - Essential - Premier

Encrypted Alpha Keywords

Encrypted Alpha Keywords
Foundation 23.1

When a security mask is configured, a portion of the encrypted Keyword Type, or the entire encrypted Keyword Type, is hidden by the configured mask. For example, a social security number Keyword Type is configured so all but the last four digits of each social security number are masked by the * character. In this example, a user viewing a social security number in OnBase would see *******6789 instead of the actual Keyword Value stored in OnBase, 123-45-6789.


A security mask can only be configured when a Keyword Type has already had encryption enabled. A security mask can be configured for Keyword Types that already have format masks applied.


A security mask is not required to encrypt a Keyword Type. Encrypted Alpha Keywords behave differently when a security mask is configured. Ensure that you understand the Access Security Masked Keywords User Group privilege before configuring a security mask. For more information, see Required User Group Privilege.


In Core Services applications, security mask characters cannot be stored as part of the Keyword Value. For example, if the character * is configured as a Mask Symbol for the Security Masking of a Keyword Type, a Keyword Value of 12*34 will not be saved.

  1. In the Keyword Type Configuration dialog box, select a Keyword Type that has been enabled for encryption.
  2. Click Masking.
  3. The Masking Configuration dialog box is displayed:

    In addition to configuring security masking, the Masking Configuration dialog box is also used to configure format masking. For more information on format masking, see the System Administration module reference guide. When an encrypted Keyword Type is configured with a format mask and a security mask, the Full Field Entry Required check box is automatically selected.

  4. In the Security Masking section, type a character such as * or # in the Mask Symbol field. This character will be used to mask the characters in the Keyword Value.

    You cannot use numeric or alphabetic characters in the Mask Symbol field.

  5. In the Security Mask field, use the following characters to designate how security masking should be applied:




    The character will not be security masked.


    The character will be security masked with the character in the Mask Symbol field.

    For example, to security mask all but the last four digits of a Social Security Number Keyword Type, type the following in the Security Mask field: MMMMMMMAAAA


    The Security Mask field is limited to 50 characters. The security mask symbol is automatically applied to every character after the fiftieth character.

  6. To test the Security Mask configuration, click Test Masking.
  7. The Test Masking dialog box is displayed.
  8. Type a Keyword Value into the Test field. The way in which this Keyword Value will be displayed to users is displayed below the Test field.
  9. Click Close to close the Test Masking dialog box.
  10. Click Save to save the configured security mask.

    If you configured a format mask and a security mask for this Keyword Type, you are prompted to update the Keyword Type's format mask after clicking Save. This is because configuring both masks for a Keyword Type automatically selects the Full Field Entry Required check box. If the new format mask is not compatible with existing Keyword Values in OnBase, you will experience issues displaying and working with these Keyword Values. The Old Mask and New Mask are presented so that you can determine if these two masks are compatible. Refer to the System Administration documentation for information on changing format masks. If the two masks are compatible, click Update Keyword Mask to update the Keyword Type's format mask. If the two masks are not compatible, click Cancel and contact your first line of support to assist with modifying existing Keyword Values so that they are compatible with the new format mask.

  11. If the security mask is being configured for a new Keyword Type, you have completed security mask configuration.
    If the security mask is being configured for a Keyword Type already being used on documents in OnBase, proceed to step 12.
  12. The following prompt is displayed:
  13. Click Show Details to display the Document Type(s) that contain this Keyword Type:
  14. After clicking OK, you are prompted that the OnBase Configuration module must be restarted before renaming any Document Types:
  15. Click OK. See Applying Security Masking to Auto-Name Strings.