Update from Brainware for Invoices or Brainware for Transcripts - 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
Note:

If pages are appended to documents, split from documents, or reordered within documents by Brainware for Invoices or Brainware for Transcripts, those changes will not be applied in OnBase.

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 for Invoices or Brainware for Transcripts:

  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 Brainware for Invoices or the Brainware for Transcripts option under Integration Type.
    4. Select the Document Types to be mapped from the drop-down list and click Add. The added Document Types are displayed under Document Types.

      The Integration for Brainware will attempt to reconcile the classifications assigned by your Brainware solution with the mapped OnBase Document Types.

    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.
    When you have finished configuring the options available on the Import Settings page, click Next.
  6. If you only added one Document Type on the Import Setting page, proceed to step 7. If you added more than one Document Type to the mapping on the Import Setting page, the Classification page is displayed.
    1. Enter the XML node path that identifies document types into the Document Type Node Path field. If the first three characters you type match the leading characters of any valid node paths in the uploaded XML file, a drop-down list containing those node paths is displayed below the Document Type Node Path field. You may continue typing, or select the node path from the drop-down list.
      Note:

      When adding a node path to an XML file for Brainware for Transcripts, ensure that the path is preceded by .//.

    2. Enter a node value that corresponds to a listed Document Type in the Node Value field.
    3. Select the corresponding Document Type row.
    4. Click the + button to map the node path and value to the Document Type.

      To remove a mapping, select the node value and click the - button.

    When you have finished configuring the options available on the Classification page, click Next.
  7. 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 uploaded XML file are listed under XML Nodes.

      Note:

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

    • The wizard will attempt to automatically match Keyword Types with XML nodes present in the XML file you loaded at the beginning of the wizard. 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 adding a node path to an XML file for Brainware for Transcripts, ensure that the path is preceded by .//.

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

      Note:

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

    • The wizard will attempt to automatically match Multi-Instance Keyword Type Groups with XML nodes present in the XML file you loaded at the beginning of the wizard. 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 select Add Node.
      Note:

      When adding a node path to an XML file for Brainware for Transcripts, ensure that the path is preceded by .//.

    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.
  9. If no mappings between Multi-Instance Keyword Type Groups and XML nodes exist, proceed to step 11. If at least one mapping between Multi-Instance Keyword Type Groups and XML nodes exists, 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.

      Note:

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

    • The wizard will attempt to automatically match Keyword Types with XML nodes present in the XML file you loaded at the beginning of the wizard. 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 adding a node path to an XML file for Brainware for Transcripts, ensure that the path is preceded by .//.

    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.
  10. Repeat step 9 for each Multi-Instance Keyword Type Group associated with the Document Type.
  11. Repeat steps 7 through 10 for each mapped Document Type. Click Next.
  12. The Options page is displayed.
    1. Enter the path to the node in which the Document ID is stored in the Document ID Node Path field.
      Note:

      When adding a node path to an XML file for Brainware for Transcripts, ensure that the path is preceded by .//.

      Note:

      If the first three characters you type match the leading characters of any valid node paths in an uploaded XML file, a drop-down list containing those node paths is displayed below the field. You may type the appropriate node path or select it from the drop-down list.

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

    3. To transition a document immediately after your Brainware solution has finished processing the document, select Transition Documents on Completion.
    4. To generate a verification report for the Brainware process, select Generate Verification Reports.
    5. 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.

    6. If you are configuring an integration for Brainware for Invoices, you can update the Document Date of each document to the Invoice Date assigned by Brainware for Invoices. To set the OnBase Document Date of each document to the Invoice Date assigned by Brainware for Invoices, select Set Document Date to Invoice Date. Enter the corresponding node path into the field below the corresponding option.
    Once you have finished configuring the settings on the Options page, click Next.
  13. The Summary screen 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.