Configuring Colors for Auto-Name Strings - 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

Text within the Auto-Name string for a document can be configured to display in a specified color as well as bold, italic, strikeout, or underline format. To tag the string characteristic with a certain color or format, enclose it with the following codes:

  • Where COLOR represents a supported color: <COLOR></COLOR>

  • Where BOLD represents a bold format: <BOLD></BOLD> or <O></O>

  • Where ITALIC represents an italic format: <ITALIC></ITALIC> or <I></I>

  • Where STRIKEOUT represents a strikeout format: <STRIKE></STRIKE> or <K></K>

  • Where UNDER represents an underline format: <UNDER></UNDER> or <U></U>

  • Where CASH displays the enclosed numeric or currency value in red if it is negative:

    <CASH></CASH> or <S></S> . Values are considered negative if the first character is a hyphen or a left parenthesis. This tag is not supported in the Web Client.

For example, in the following string, the Keyword Value identified by %K001102.1 is displayed in a red font. PO Number<RED>%K001102.1</RED>

The following colors are supported. Color tags can use either the color's name or the color's abbreviation. Abbreviations can help keep Auto-Name strings at an acceptable length. For example, instead of entering <RED></RED>, you can enter <R></R>.

  • red (Abbreviation: R)

  • green (Abbreviation: G)

  • blue (Abbreviation: B)

  • yellow (Abbreviation: Y)

  • cyan (Abbreviation: C)

  • magenta (Abbreviation: M)

  • black (Abbreviation: S)

  • gray (Abbreviation: A)

  • white (Abbreviation: W)

Within the Client module, the colors and formats are displayed almost everywhere the Auto-Name String is displayed. This includes the Classic Interface Workflow windows, document hit lists, and lists of processed documents. Colors and formats are not displayed when the Auto-Name is found within the details of a description (e.g., in Document History and Transaction Logs). In the Core-based Workflow user interface, color tags for the Auto-Name string are respected in the Inbox and Work Folder; all other tags are not respected.

In Core Services applications, such as the Web Client, the colors and formats are only displayed in the Workflow windows and Document Search Results lists. The Web Client also displays formatted document names in Custom Query Results lists and formatted folder names in the Folders pane, with the exception of the Folder Tree. In the Unity Client, the colors and formats are only displayed in the Document Search Results lists, Custom Query Results lists, and the InBox and Related Items panes in the Workflow interface.

Note:

Placing color tags within color tags (also known as "nesting" tags) is not supported and will cause Auto-Name strings to display incorrectly. For example, you have configured the following Auto-Name string: <A>Application Summary for <R>%K00164.1</R> - %K00114.1</A> . In this example, everything after the <R></R> tag ( - %K00114.1 ) would not be color formatted.