Enabling Renditions for a Document Type - 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

Renditions are versions of the same document in different file formats. For example, OCR can be used to create a text rendition of an image document.

To configure a Document Type to allow renditions:

  1. From the OnBase Configuration module, select Document | Document Types. The Document Types dialog box is displayed.
  2. Select the Document Type that is to be configured to allow renditions.
  3. Click Rendition/Revision. The Rendition/Revisions Control Settings dialog box is displayed.
  4. Configure the appropriate settings for the Document Type to enable the use of renditions for the documents associated with the selected Document Type.
    Note:

    Revision Settings are only available if your database is licensed for EDM Services. For more information, see the EDM Services module reference guide.

    Rendition/Revision Control Setting

    Description

    Read-Only

    Select this option to allow users to apply Read-Only attributes to the documents configured for this Document Type.

    Display Message When Document Is Locked

    Select this option to display a message when a user attempts to open a document locked by another user:

    This document is already checked out by another user. Checked out by <User Name>.

    Allow Multiple Renditions

    Select this option to allow users to create multiple renditions of documents belonging to this Document Type.

    Note:

    When this setting is selected, it is considered a best practice to enable UNQ for Keyword Types whose values determine whether documents are related. Any Keyword Types that may include a large number of values should not have UNQ enabled. For more information, see Configuring Document Type Keywords.

    Unlike revisions, an EDM Services license is not required to create renditions.

    Note:

    If your OnBase solution is licensed for EDM Services and a Document Type is configured to allow multiple revisions, the latest revision of the document is always used when creating a rendition of that document.

    Use Text Display Format For External Text Search Results

    Select this option to automatically display the text rendition of a document when an external text search is performed to retrieve a document that has multiple renditions.

    If this option is not selected, a non-text rendition of the document retrieved via an External Text Search could be displayed. If a non-text rendition is displayed, the text search string will not be highlighted in the displayed document.

    If a non-text rendition does not have the same number of pages as the text rendition, the external text search may not direct your users to the correct page number. Contact your first line of support if you have questions about this behavior.

    Note:

    The rendition of a document that is automatically displayed when the document is retrieved is controlled by the Rendition Display Behavior Global Client Setting.

  5. When finished, click Save.
    Note:

    If the Document Type of a document in the Trash Can is configured to use the Allow Multiple Renditions option, you can view the document's rendition history from the Trash Can.