The Options Tab - XML Index Document Import Processor - English - Foundation 22.1 - OnBase - Essential - Premier - Standard - external - Standard - Essential - Premier

XML Index Document Import Processor

Platform
OnBase
Product
XML Index Document Import Processor
Release
Foundation 22.1
License
Standard
Essential
Premier

The Options tab contains options that specifically affect the documents that are imported as part of the batch.

The following options are displayed on the Options tab:

Option

Description

Run Process

This check box is used to enable the process to store the documents identified from the index file in OnBase. It is selected by default.

The Run Process check box must be selected in order for the process to actually import documents into OnBase. The ability to deselect this option is provided to allow you to test formats without saving documents to OnBase.

If the Run Process check box is not selected, the XML Index DIP process does not import files into OnBase.

The Download and Preprocess functions are performed regardless of whether Process is selected. If the processor encounters an error within the index file, it is moved from its current folder to the ERROR_FILES sub-folder.

Note:

If an error occurs, the index file is moved to the ERROR_FILES folder even if it is marked as read-only.

Tip:

If multiple import index files are processed into a single batch and successfully processed import index files are configured to not be deleted, import index files that have been correctly processed may be moved to the ERROR_FILES folder if one or more import index files that compose the batch are not processed correctly. XML Index DIP cannot distinguish between the import index files in the batch that have been processed correctly and the import index files with errors that remain in the Default Directory location. To prevent correctly-processed import index files from ending up in the ERROR_FILES folder, configure each import index file to be processed as an individual batch or allow the import index files to be deleted after processing (the default behavior), but configure the import index file to be backed up during the Process Settings configuration for the XML Index DIP process format. All correctly-imported import index files are deleted after processing, the incorrectly-processed import index files are moved to the ERROR_FILES folder and all processed import index files are backed up to the configured location.

Add Documents to Workflow

Note:

To use this option you must be properly licensed for Workflow.

Place processed documents into a Workflow life cycle associated with the Document Type of the imported documents.

Note:

Documents can only be added to Unity life cycles from the Core-based OnBase Client interface.

When this option is selected, the following options are available:

  • On Commit: Bring documents into a Workflow life cycle when a batch is committed.

    When using the Core-based OnBase Client interface, if one or more documents are not successfully added to a Workflow life cycle, the batch is added to the Committed queue.

    Tip:

    When using the Core-based OnBase Client interface, it is recommended that you always select On Commit.

    When using the classic OnBase Client interface, if one or more documents are not successfully added to a Workflow life cycle, the batch is added to the Incomplete Commit queue.

  • During Processing: Add the documents to a Workflow life cycle as they are processed.

    If errors are encountered while documents are processed, the successful part of the batch is moved to a Workflow life cycle and the unsuccessful part of the batch is moved to the Incomplete Process queue.

    CAUTION:

    Documents in the Incomplete Process queue can be viewed and retrieved by anyone with access to the queue, even if those users do not normally have rights sufficient to view and retrieve those documents in OnBase.

  • Add Revisions to Workflow: Resend the documents to a Workflow life cycle as a revision is processed.

  • Perform System Work: Execute the configured system work for a Workflow life cycle as soon as the documents are added to a Workflow life cycle. This option is deselected by default for new processes.

Note:

If Verification Reports are configured to enter a Workflow life cycle, they will enter that Workflow life cycle regardless of the Add Documents to Workflow option setting.

Use Disk Group from Document Type

Select this option to store documents in the batch in the default Disk Group associated with their Document Type instead of the Disk Group associated with the process format.

If this option is selected, both the Disk Group assigned to the process format and the Disk Group assigned to the Document Type(s) are checked to ensure they have sufficient disk space available before the documents are placed. If there is not enough available space in the Disk Group, the batch is routed to the Incomplete Process queue, an error message is displayed and the index file is sent to the Error_Files directory.

If <none> is selected in the Disk Group drop-down menu when this option is selected, a check for space will not be performed on a Disk Group.

Auto-Folder Documents

Provides the ability to Auto-Folder documents upon import.

Note:

Selecting this check box sets the default behavior for Auto-Foldering documents upon import. However, if a user has the ability to initiate processing from within the OnBase Client, they can de-select this feature when initiating the process by deselecting the Create Auto Folder option.

Tip:

Ensure you have Auto-Foldering properly configured before selecting the Auto-Folder Documents upon Processing check box.

One Batch per File

Creates a separate batch for each index file when a single XML Index DIP process encompasses multiple index files. This option helps to better track and manage individual index files after they were imported into the system.

Note:

The Maximum Uncommitted Batches option is not respected when the One Batch per File option is selected.

Create Image Thumbnails On Commit

Select this option to create a small thumbnail image of the first page of all image documents in a batch and archive them as a rendition to the original. When such a document is displayed in the thumbnail hitlist, OnBase will first attempt to load the small thumbnail image instead of the full size image. If there is no thumbnail image available, the original image will display.

Accumulate Processing Information

Provides the ability to combine several Verification Reports into a single, cumulative daily report.

After process is run, OnBase produces and displays a Verification Report for the process. If your solution uses several different processors or process formats, you can combine each of these Verification Reports into a single, daily report for ease of viewing by selecting the Accumulate Processing Information check box.

The Verification Report is stored as a text document in the System Documents Document Type Group, SYS Verification Reports Document Type.

Extract Index Information

Directs the XML Index DIP Processor to store all Keyword Values extracted from the XML Index DIP file during processing into a text file. You must also select an index extraction format from the Index Extraction Format drop-down list.

If there are multiple Keyword Values for one Keyword Type, only the first value listed will be extracted.

To configure an Index Extraction Format, see Configuring Index Extraction for more information.

Store AutoFill Keyword Set Data

This option is used to store values from the import index file into the associated AutoFill Keyword Set, as long as there is no AutoFill Keyword Set instance that already contains the Primary Keyword Value from the import index file. When an instance is imported with the same Primary Keyword Value as an existing instance, but with different secondary values, an additional instance is added.