The Options Tab - XML Tag Import Processor - Foundation 23.1 - Foundation 23.1 - Ready - OnBase - Essential - Premier - Standard - external - Standard - Essential - Premier

XML Tag Import Processor

XML Tag Import Processor
Foundation 23.1

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

Options Tab Option


Run Process

The Run Process check box is selected by default. It must be selected in order to actually process documents. The ability to deselect this option is provided to allow installers or administrators to test formats without saving documents to OnBase.

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


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

Add Documents to Workflow


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.


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.


    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.


    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.

  • 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.


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.

Auto-Folder Documents

Provides the ability to Auto-Folder documents upon processing.


Selecting this check box sets the default for the Auto-Folder documents upon processing function. However, if a user has the ability to initiate the processor from the Client (Product Right in User Groups & Rights) s/he has the ability to de-select this function when initiating the process. In the Client, the option is called Create Auto Folder.


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

Accumulate Processing Information

After a TIP process is run, the system displays a Verification Report for the process. If you would like to view the combined Verification Reports for several processes, select the Accumulate Processing Information check box. This causes the Verification Report information to be stored in the database and used to generate a cumulative report.

View the cumulative report in the Client module by selecting Processing | View Daily Reports.


The View Daily Reports option appears on the Processing menu only when a COLD, DIP, or TIP process uses the Accumulate Processing Information option.

The Verification Report is stored as a text document in the System Documents document type group, SYS Verification Reports document type.

Store AutoFill Keyword Set Data

If the Document Type of the document being imported is assigned to an AutoFill Keyword Set, the TIP process will populate the AutoFill Keyword Set with values from the import index file.

When a record is imported with the same Primary Keyword Value as an existing AutoFill Keyword Set, but has other Keyword Values that differ from the existing Keyword Set, an additional AutoFill Keyword Set is added. This allows the creation of multiple records with the same primary Keyword Value.