Configuring Auto-Name Strings - Image Statements - English - Foundation 22.1 - OnBase - external

Image Statements

Image Statements
Foundation 22.1

The Auto-Name Configuration dialog box allows you to configure an Auto-Name string for documents using variables containing data about each document and/or static text. The Auto-Name strings configured in this dialog box are used to identify each document inside the Client module and in distributed statements.


Auto-Name strings are limited to 150 characters.


If the Auto-Name is used as the file name for documents saved or e-mailed outside of OnBase, the following characters are replaced with underscores: *|/\<>:?

To configure an Auto-Name string for a document:

  1. Open the appropriate dialog box for configuring the Auto-Name string. The areas in the software that use the Auto-Name strings are listed in the Overview of this Appendix.
  2. The Auto-Name field at the top holds the name string that is used to generate each document's name. The Auto-Name string is determined by static text and symbols, representing specific information about each document. The symbols can be distinguished from static text by the % before the each symbol.
  3. The Symbols Used section displays the available variables. Click inside the field and type the symbol or click the symbol's button to add it to the Auto-Name field.

    The following variables are available for use in Auto-Name strings:


    Symbol Name



    Document Date

    Displays the user-defined Document Date.


    Document Type

    Displays the Document Type of the document.


    Date Stored

    Displays the date the document was stored in OnBase. This date cannot be modified by the user.


    Document Handle

    Displays the unique internal number associated with the document within OnBase.


    Time Stored

    Displays the time the document was stored in OnBase.

    %K'<Keyword Number>'.<Repeats>

    Keyword Type

    Displays a Keyword Type Value stored for the document. May be repeated to show more than one Keyword Type Value stored for the document.

    %S'<First Character>'.<Minimum Length>

    Keyword Type Substring

    Displays a substring of a Keyword Type Value stored for the document. Must be configured to start a prescribed number of characters into the string and to extend for a prescribed number of characters.


    This symbol must immediately follow the Keyword Type tag, without any separating spaces.


    User Name

    Displays the user name of the user that created the document.


    Real User Name

    Displays the real name of the user that created the document as entered in the User Settings dialog box of the User Names & Passwords Configuration menu.


    If a value for the real name of the user has not been entered in the User Names and Passwords menu of the OnBase Configuration module, the User Name of the user who created the document is displayed.



    Select the Newline symbol when the header you have configured should span multiple lines when printed out. Each line will break at the Newline symbol.

  4. To add a keyword value to the Auto-Name string, select a Keyword Type from the Keyword Type drop-down or enter the symbol manually. For more information on configuring keyword values to display in an Auto-Name string, see the System Administration Help or Module Reference Guide.
  5. Partial keyword values, called substrings, may be configured to be displayed in the Auto-Name string. For more information on configuring substrings, see Keyword Value Substrings.
  6. Click Save.