Routing Documents to the Integration for Brainware - Integration for Brainware Deployment Guide - Foundation 23.1 - Foundation 23.1 - Ready - OnBase - Essential - Premier - Standard - external - Essential - Standard - Premier

Integration for Brainware Deployment Guide

Platform
OnBase
Product
Integration for Brainware Deployment Guide
Release
Foundation 23.1
License
Essential
Standard
Premier

In order for documents to be processed by your Brainware solution, the scan queue used to bring in documents must be configured to route those documents to the status queue or status step for the Integration for Brainware. Depending on your configuration, this status queue or status step may be named Awaiting Custom Process, Brainware Integration, or it may have a name customized for your solution.

Note:

The Awaiting Custom Process batch status queue is not unique to the Integration for Brainware. Any batches brought in by a scan queue that is configured for custom processing will pass into the Awaiting Custom Process batch status queue. For more information on custom processing, see the Document Imaging module reference guide.

If the scan queue is configured to export documents and import data using a custom process, the Awaiting Custom Process batch status queue is routinely polled by the OnBase Client running as a service. When the service encounters documents in the corresponding status queue, it automatically routes the documents to your Brainware solution with no user intervention.

If the scan queue is configured to export documents and import data using the Brainware Integration status step, the Application Server sends the documents to your Brainware solution. After Brainware processing is complete, the Data Capture Server imports the resulting data back into OnBase.

Note the following:

  • When using the Integration for Brainware with the Data Capture Server, ensure that the Enabled option of the XMLImportSetting sub-element in the Data Capture Server configuration file is set to true.
  • When the initial, pre-indexed Document Type is changed during classification, any supplied common Keywords are applied to the document. This includes both standalone Keywords and Keywords belonging to a Single-Instance (SIKG) or Multi-Instance (MIKG) Keyword Group.
  • When the initial, pre-indexed Document Type is not changed during classification, pre-indexed Keyword Values of all types are applied to the document.
    Note: The integration does not support SIKGs. However, any SIKG Keyword Value in a pre-indexed state is added to the document.
  • In cases where the target Document Type is configured with a Default Keyword Value, the following occurs:
    Scenario Result
    In the case of Standalone Keywords (not belonging to a SIKG or MIKG) and when the Document Type does not change during classification If Brainware does not extract a value (that is, the value is blank or does not exist in the XML files generated), the Default Keyword Value is applied. This occurs regardless of whether the value is configured in the Brainware Integration Indexing mappings.
    In the case of all Keyword types and when the Document Type is changed during classification The Default Keyword Values of the target Document Type are applied to the document if these items are NOT configured in the Brainware Integration Indexing mappings. This case is valid if these particular keywords were not common to the initial document type.
  • If the scan queue is configured to export documents and import data using the Brainware Integration status step, the documents that are exported to Brainware will be locked in OnBase until Brainware processing is complete.

After the documents are processed, they are routed to the next configured status queue or status step.

Note:

Depending on your configuration, documents may remain in the status queue or status step for the Integration for Brainware if your Brainware solution did not populate one or more required Keyword Types.

The method used to configure a scan queue to route documents to your Brainware solution depends on whether the scan queue uses a custom process or the Brainware Integration status step.