Configuring Document Type Settings - 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

Document Type Settings allow you to configure options for the Document Type.

To access the Document Type Settings dialog box, select Document | Document Types in the Configuration module, select a Document Type, and click Settings.

Click Save to save the Document Type settings. Click Clear to undo any changes or selections that were made.

Document Setting

Description

Document Type Group

Defines the Document Type group associated with the Document Type.

Default File Format

Defines the default file type characteristics for the Document Type (e.g., text format, image format, WAV audio file, MS Word).

Default Disk Group

Defines the storage location for the data files in the Document Type.

Show Text With Greenbar

When enabled, displays text documents of this Document Type with a greenbar background.

Note:

The color of the bar display can be changed in the Workstation Options in the Client module.

Show Thumbnails

When enabled, displays thumbnails vertically (to the right of the document) or horizontally (beneath the document).

Horizontal or Vertical display is determined by the User Options in the Client module.

Note:

Changes made to the Show Thumbnails option in Document Type Settings only affects the OnBase Client.

Allow File Caching

When enabled, allows documents of this Document Type to be placed into a cache during a workflow process Push Document into Cache action.

Force Thumbnail Caching

This option is used in conjunction with image file format documents. When selected, this option allows all pages to be cached. Thumbnail caching is useful when OnBase is using removable media (example: Jukebox) so requests for pages are received from the cache and not from the removable media, which speeds document retrieval.

Use Column Index

Enables column indexing to be performed during COLD processing for that Document Type, if the COLD Processor is properly configured.

Indexing Migrates File

If selected, documents of this type will be migrated to the Document Type's default Disk Group during indexing done in the scan queue (or during scanning if the Document Type is known via bar code or singular Document Type on the scan queue), when using Document Transfer to import documents into another database, during re-indexing in the OnBase Client, re-indexing in the Web Client, and executing the Re-Index Document and Set Document Type Workflow actions.

This ensures that documents adhere to Retention schedules when Document Retention is used.

Auto-Expand MIKG

When selected, Multi-Instance Keyword Type Groups will automatically expand in the following dialog boxes:

  • Add/Modify Keywords

  • Document Retrieval

From Document Retrieval, if you select more than one Document Type using the same Multi-Instance Keyword Type Group, this option will be respected.

Note:

By default, Multi-Instance Keyword Type Groups expand during indexing (e.g., while indexing a batch of documents in Document Imaging or Disconnected Scanning). For more information, see Multi-Instance Keyword Type Groups.

Check all Required Keywords in MIKG

When selected, required Keyword Types in a Multi-Instance Keyword Group (MIKG) will require values for each instance of the Keyword Group during indexing.

If this option is not selected, then required Keyword Types will require values in only one instance of the MIKG. If the MIKG has multiple required Keyword Types, the values for required Keyword Types can be split across multiple instances of the MIKG.

For example, a Document Type is assigned an MIKG where ID and NAME are required Keyword Types. If Check all Required Keywords in MIKG is selected for the Document Type, then a value must be provided for both ID and NAME in each instance of the MIKG. If Check all Required Keywords in MIKG is not selected for the Document Type, then ID or NAME can be left blank in one instance of the MIKG as long as the Keyword Type has a value in another instance.

Note:

When performing bar code processing in the Unity Client, required Keyword Types in a Multi-Instance Keyword Group (MIKG) will always require values for each instance of the Keyword Group during indexing, without respect to the Check all Required Keywords in MIKG option.

Use Form Feed to Determine Page Break

When selected, Core-based applications determine page breaks using document form feed information.

When not selected, Core-based applications determine page breaks using the View / Print Lines per page option.

Overlay First Page Only

When selected, an overlay displays on only the first page of a document if an overlay has been configured for this Document Type.

Compute Page Ref

Generates transparent reference markers throughout documents at intervals of approximately 100K of information.

These markers speed the "go to" function available from an open document in the Client module, allowing you to more quickly navigate to specific pages in long documents.

Page references do not affect the navigation speed when the page up and page down keys are used.

If the document being viewed has not yet been committed (exists in a pre-committed batch status such as Awaiting Commit, Awaiting Index, or Index In Progress), the page references must be generated each time the document is opened, slowing the time it takes to open a document. Once the document has been committed, page references are "set" and are not re-calculated when the document is opened.

Property-Based Indexing

Provides the ability to automatically map values from Structured Storage properties (e.g. the values displayed when you right-click an Excel document from your desktop and select Properties.)

Upon enabling Property-Based Indexing, the system makes the Property Mapping button available from the Keyword Type Assignment dialog box.

Keyword - Based XML

When enabled, the system automatically associates XML style sheets to XML documents, per user-defined keywords values.

If an XML document's Document Type is configured with the Keyword-Based XML setting, its appearance, determined by a style sheet, is based on a particular Keyword Value. If you change the Keyword Value that determines the style sheet used, the appearance of the document will be altered. This is true of Keyword Value changes made in the Re-index Document dialog box and the Add/Modify Keywords dialog box.

Note:

If more than one value exists for the particular Keyword Type used to determine the style sheet use for a document, the first value will be used to link the style sheet to the document.

Allow Redaction Bitmaps

This setting enables the right-click menu's Redaction Bitmap options for open image documents in the selected Document Type.

Redaction bitmaps must be imported into the SYS Redact Bitmaps Document Type.

In order to use redaction bitmaps, users must have User Group Modify privileges. They must also have User Group rights to the Sys Redact Bitmaps Document Type.

Respect Custom File Types

When importing a file into a Document Type configured to use a custom file format, the custom file format is not selected by default from the File Type drop-down list in the Import Document dialog box.

When the Respect Custom File Types option is selected, the custom file format is selected by default from the File Type drop-down list in the Import Document dialog box.

Enable Dynamic Document Content

Indicates whether or not a browser-based document can use scripting. Enable Dynamic Document Content is deselected by default.

Note:

Enable Dynamic Document Content does not apply to PDF documents. Changes to a PDF document via scripting must be made using an external PDF application and saved outside of OnBase.

Autodisplay Keyword Location

Defines the location for the display of Keyword Values at any of the four quadrants of the open document.

Note:

To view the Keyword Values in an autodisplay location, the Keyword Type Settings must be configured for autodisplay.

Retrieval List Sort Order

Defines the sort criteria for documents returned from a Document Search Results list. Sorting can be based on Document Date (oldest/newest), Document Handle (last/first stored), or None (random).

Tip:

Random sorting yields faster retrieval times because the documents do not have to be sorted in any specific order.

Document Date Label (Indexing Only)

Enter a label in Date Label (Indexing Only) field so that during Indexing, a Document Date indexing field displays by default. You may choose to custom label this date in order to provide more specific information for the indexer. For example, Document Date could be replaced by Invoice Date or Delivery Date.