Update from Brainware Intelligent Capture - Integration for Brainware Deployment Guide - English - Foundation 22.1 - OnBase - Essential - Premier - Standard - external - Standard - Essential - Premier

Integration for Brainware Deployment Guide

Platform
OnBase
Product
Integration for Brainware Deployment Guide
Release
Foundation 22.1
License
Standard
Essential
Premier
Note:

If a scan queue uses the Brainware Integration status step to update documents from Brainware Intelligent Capture, and pages were added to, split from, or reordered within any documents during Brainware processing, new documents will be created in OnBase that incorporate the updates made by Brainware Intelligent Capture. If a Verification Report is generated, details regarding the newly created documents will be included in the Verification Report.

After configuring a custom capture process to send documents to Brainware using the Brainware Integration status step, you must configure the process to update from Brainware. If you have not yet configured the custom capture process to send documents to Brainware, see Send to Brainware.

To configure a custom capture process to update documents from Brainware Intelligent Capture:

  1. In OnBase Studio, select the Capture Process tab in the Repositories pane. This tab lists the scan queues enabled for custom capture processes.
  2. Within the Capture Process tab, open the scan queue and capture process to be used for the Integration for Brainware. The capture process is displayed in the design view pane.
  3. Select the Brainware Integration status step.
  4. The Brainware Integration status step is displayed in the design view pane. The focus is set to the Brainware Integration status step, and the sub-options for Brainware Integration are displayed on the General tab in the Properties pane.
  5. Click Add Mapping. The Import Settings page of the Brainware Integration wizard is displayed.
    1. Enter a name for the mapping in the Mapping Name field.
    2. Enter a shared UNC path into the Polling Location field, or click Browse to navigate to the directory. This is the directory to which your Brainware solution will export XML data files.
      Note: When using multiple mappings for Brainware Integration status steps in a custom capture process, the Data Capture Server processes the XML files returned from Brainware in the order of the lowest-to-highest ID numbers for the Brainware Integration status steps. If the same UNC path is configured for multiple mappings, this can result in the incorrect mapping being applied to the XML file. To avoid the unintended application of multiple mappings, it is recommended that you configure a separate UNC path for each Brainware Integration status step.
    3. Select the Generic option under Integration Type.
      Note:

      When you select Generic, the Classification option is automatically selected as well.

    4. To update OnBase documents with extraction results from your Brainware solution, select the Extraction option.
    5. Click Load XML File and navigate to the location of an example XML file associated with your Brainware solution. Select the file and click Open. Then, click Next on the Import Settings page.
    When you have finished configuring the options available on the Import Settings page, click Next.
  6. The Generic Classification page is displayed.

    Note the following:

    • Each Document Type assigned to the scan queue is listed under Document Types.

    • Nodes from the example XML file are listed under XML Nodes.

    • The wizard will attempt to automatically map Document Types with XML nodes present in the example XML file you loaded at the beginning of the wizard. Any Document Types and XML nodes that were automatically mapped are displayed under Mappings.

    • A green check mark is displayed next to any Document Types and XML Nodes that have already been mapped.

    Manually map any unmapped Document Types to an XML node. To map a Document Type to an XML node:

    1. From the Document Types list, select the Document Type to be mapped.
    2. From the XML Nodes list, select the XML node to which the Document Type will be mapped. You may also enter a new node path and select Add Node.
      Note:

      When you hover over an XML node, the full path of the XML node is displayed.

    3. Click Link to add the mapping to the Mappings list.
    4. If you want to remove a mapping between a Document Type and an XML node, select the mapping and click Remove Mapping.
    5. If you want to remove all mappings between Document Types and XML nodes, click Clear Mappings. The Clear Mappings dialog box is displayed.
      • Click Yes to remove all mappings between Document Types and XML nodes.

      • Click No to preserve the existing mappings and return to the wizard.

    When you have finished configuring the options available on the Generic Classification page, click Next.
  7. If you did not select the Extraction option on the Import Settings page, proceed to step 12. If you selected the Extraction option on the Import Settings page, the Extraction Mappings page is displayed.

    Each Document Type that has been mapped to an XML node is displayed. For each Document Type, the total number of associated Keyword Types and Brainware XML fields are displayed, and the total number of mapped Keyword Types and Brainware XML fields are displayed in bold.

    CAUTION:

    You will not be able to return to the Generic Classification page or the Import Settings page after your double-click a Document Type Row on the Extraction Mappings page. Ensure that all settings and options on those pages have been configured correctly before you double-click a Document Type row.

    Note:

    When the Extraction Mappings page is first displayed, each Document Type will be listed as having 0 OnBase Keywords, 0 Brainware Fields, 0 Linked Fields, and 0 Linked Groups. These values will be updated as you proceed though the wizard.

    Example XML result files can be loaded into the wizard on this page. If XML result files are loaded into the wizard, the wizard will attempt to automatically map Keyword Types and Multi-Instance Keyword Type Groups to Brainware XML nodes based on the results in the XML file.

    Note:

    Single-Instance Keyword Type Groups cannot be mapped to XML nodes using the Brainware Integration status step.

    To load XML result files into the wizard:

    1. Click Load Example File(s).
    2. Navigate to the location of the example file.
    3. Select the file and click Open.
    When you have finished uploading an XML result file, double-click a Document Type row to review the Keyword Type and Multi-Instance Keyword Type Group mappings associated with the Document Type.
  8. The Index page is displayed.

    Note the following:

    • The corresponding Document Type is displayed at the top of the page.

    • Each Keyword Type assigned to the Document Type is listed under Keyword Types.

    • Nodes from the example XML file are listed under XML Nodes.

    • The wizard will attempt to automatically match Keyword Types with XML nodes present in an XML file loaded on the Extraction Mappings page. Any Keyword Types and XML nodes that were automatically mapped are displayed under Mappings.

    • A green check mark is displayed next to any Keyword Types and XML Nodes that have already been mapped.

    Manually map any unmapped Keyword Types to XML nodes. To add a mapping between a Keyword Type and an XML node:

    1. From the Keyword Types list, select the Keyword Type to be mapped.
    2. From the XML Nodes list, select the XML node to which the Keyword Type will be mapped. You may also enter a new node path and select Add Node.
      Note:

      When you hover over an XML node, the full path of the XML node is displayed.

    3. Click Link to add the mapping to the Mappings list.
    4. If you want to remove a mapping between a Keyword Type and an XML node, select the mapping and click Remove Mapping.
    5. If you want to remove all mappings between Keyword Types and XML nodes, click Clear Mappings. The Clear Mappings dialog box is displayed.
      • Click Yes to remove all mappings between Keyword Types and XML nodes.

      • Click No to preserve the existing mappings and return to the wizard.

    When you have finished configuring the options available on the Index page, click Next Mapping and proceed to step 9. If Next Mapping is unavailable, click Next Document Type and repeat steps 8 through 10. If Next Mapping and Next Document Type are unavailable, click Extraction Mappings and proceed to step 11.
  9. The Groups page is displayed.

    Note the following:

    • The corresponding Document Type is displayed at the top of the page.

    • Multi-Instance Keyword Type Groups assigned to the Document Type are listed under Keyword Type Groups.

      Note:

      Single-Instance Keyword Type Groups are not listed and cannot be mapped to XML nodes using the Brainware Integration status step.

    • Nodes from the example XML are listed under XML Nodes.

    • The wizard will attempt to automatically match Multi-Instance Keyword Type Groups with XML nodes present in the XML file loaded on the Extraction Mappings page. Any Multi-Instance Keyword Type Groups and XML nodes that were automatically mapped are displayed under Mappings.

    • A green check mark is displayed next to any Keyword Type Groups and XML Nodes that have already been mapped.

    Manually map any unmapped Multi-Instance Keyword Type Groups to XML nodes. To add a mapping between a Multi-Instance Keyword Type Group and an XML node:

    1. From the Keyword Type Groups list, select the Multi-Instance Keyword Type Group to be mapped.
    2. From the XML Nodes list, select the XML node to which the Multi-Instance Keyword Type Group will be mapped. You may also enter a new node path and click Add Node.
      Note:

      When you hover over an XML node, the full path of the XML node is displayed.

    3. Click Link to add the mapping to the Mappings list.
    4. If you want to remove a mapping between a Multi-Instance Keyword Type Group and an XML node, select the mapping and click Remove Mapping.
    5. If you want to remove all mappings between Multi-Instance Keyword Type Groups and XML nodes, click Clear Mappings. The Clear Mappings dialog box is displayed.
      • Click Yes to remove all mappings between Multi-Instance Keyword Type Groups and XML nodes.

      • Click No to preserve the existing mappings and return to the wizard.

    When you have finished configuring the options available on the Groups page, click Next Mapping and proceed to step 10. If Next Mapping is unavailable, click Next Document Type and repeat steps 8 through 10. If Next Mapping and Next Document Type are unavailable, click Extraction Mappings and proceed to step 11.
  10. The Group Index page is displayed.

    Note the following:

    • The corresponding Document Type and the corresponding Multi-Instance Keyword Type Group are displayed at the top of the page.

    • Keyword Types assigned to the Multi-Instance Keyword Type Group are listed under Keyword Types.

    • Nodes from the example XML are listed under XML Nodes.

    • The wizard will attempt to automatically match Keyword Types with XML nodes present in the XML file loaded on the Extraction Mappings page. Any Keyword Types and XML nodes that were automatically mapped are displayed under Mappings.

    • A green check mark is displayed next to any Keyword Types and XML Nodes that have already been mapped.

    Manually map unmapped Keyword Types to XML nodes. To add a mapping between a Keyword Type and an XML node:

    1. From the Keyword Types list, select the Keyword Type to be mapped.
    2. From the XML Nodes list, select the XML node to which the Keyword Type will be mapped. You may also enter a new node path and select Add Node.
      Note:

      When you hover over an XML node, the full path of the XML node is displayed.

    3. Click Link to add the mapping to the Mappings list.
    4. If you want to remove a mapping between a Keyword Type and an XML node, select the mapping and click Remove Mapping.
    5. If you want to remove all mappings between Keyword Types and XML nodes, click Clear Mappings. The Clear Mappings dialog box is displayed.
      • Click Yes to remove all mappings between Keyword Types and XML nodes.

      • Click No to preserve the existing mappings and return to the wizard.

    When you have finished configuring the options available on the Group Index page, click Next Mapping and repeat step 10. If Next Mapping is unavailable, click Next Document Type and repeat steps 8 through 10. If Next Mapping and Next Document Type are unavailable, click Extraction Mappings and proceed to step 11.
  11. The Extraction Mappings page is displayed. If you want to modify any mappings between Keyword Types, Multi-Instance Keyword Type Groups, and Brainware XML nodes, double-click the corresponding Document Type row and repeat steps 8 through 10. Once you have finished configuring the options available on the Extraction Mappings page, click Next.
  12. The Options screen is displayed.
    1. To include a rendition of the XML file with the processed image, select Add XML Rendition. The XML will be included as a rendition of the corresponding Document Type in the document set.
      Note:

      In order for a Brainware XML file to be imported into OnBase as a rendition, the corresponding Document Type must be renditionable and configured to allow multiple renditions. For more information on importing renditions, see the System Administration module reference guide.

    2. To transition a document immediately after Brainware Intelligent Capture processing has been completed on that document, select Transition Documents on Completion.
    3. To generate a verification report for the Brainware Intelligent Capture process, select Generate Verification Reports.
    4. Determine whether XML results will be saved after Brainware processing is complete.
      • To delete the XML results after Brainware processing is complete, select Delete Results under XML Results.

      • To store the XML results in a specific directory after Brainware processing is complete, select Move Results under XML Results. Then, enter the shared UNC path to the directory in the Path field.

    Once you have finished configuring the options available on the Options page, click Next.
  13. The Summary page is displayed.

    A brief summary of your configuration settings is listed. Once you are finished reviewing the summary, do one of the following:

    • To save your configuration settings and close the wizard, click Finish.

    • To change your configuration settings, click Previous. Use the Previous and Next buttons to navigate between pages. Update the configuration settings as required.

    • To discard your configuration changes and close the wizard, click Cancel.

  14. Use the Evaluator connectors to integrate the Brainware Integration status step into the capture process.
  15. Complete the rest of the capture process by adding and configuring any other status steps and evaluators as needed for your solution.

When you are finished configuring the capture process, save the changes and publish the capture process.