Running an XML Index DIP Process - XML Index Document Import Processor - English - Foundation 22.1 - OnBase - Essential - Premier - Standard - external - Essential - Standard - Premier

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

To run an XML Index DIP process, you must be a member of a user group that has sufficient rights.

CAUTION:

By default, the XML Import Index File is deleted after processing. To prevent the deletion of this file, flag it as Read-Only. In Windows Explorer, right-click the file, and then select Properties | Read-only. Depending on your system's configuration, you may be unable to flag the files as Read-Only. See your system administrator if you have questions.

  1. Log onto the Client module.
  2. From the Client module, select Processing | XML Index DIP . The XML Index Document Import Processor window is displayed. The left side of the XML Index Document Import Processor window displays the XML Index DIP Formats, Process Job, and status queues. The right side displays a list of whatever is selected in the left side (individual XML Index DIP formats, process jobs or batches).
    CAUTION:

    The Processing | Process Tuning menu option contains advanced installation settings that, if modified, could have unintended consequences on your XML Index DIP solution. For more information, contact your solution provider .

    • XML Index DIP Formats: Lists available XML Index DIP formats.

    • Process Job: Lists available process jobs. A Process Job is one or more processes (COLD, DIP, Check Processor, AutoFill Keyword Importer) set up to run sequentially.

    • Awaiting Commit: Lists batches that were processed into the database and are in an uncommitted state. Batches in this queue can be purged from the system. Documents in a batch that is in Awaiting Commit can be retrieved by users, provided they have the rights to do so.

    • Committed: Lists batches that have been verified and submitted to the system as valid documents.

    • Incomplete Process: Lists batches that have started processing, but have encountered errors during processing. These batches can be viewed and retrieved within the document retrieval window. After resolving the processing issue, the batch should be purged.

      CAUTION:

      If there is a disruption/errors in processing, the documents that were processed will go to the Incomplete Process queue. From this queue, the documents can be viewed and retrieved. If this XML Index DIP process has been set up to go to a Workflow during processing, the documents in the batch that were processed will go to the assigned Workflow, and are fully retrievable.

    • Incomplete Commit: Batches that have started the commit process, but have encountered errors during the process. After resolving the commit issue, the batch should be committed.

  3. From the left window, select XML Index DIP Formats. All available XML Index DIP formats display in the right window.
  4. Select an XML Index DIP format and right-click.
  5. Select XML Index Document Import Processor. The XML Index Document Import Processor dialog box is displayed.
  6. Select Store Document Indices to store Keyword Values for the imported documents.
  7. Select Store Document Data Files to copy the data files specified in the XML Import Index File into the corresponding Disk Group(s).
  8. You do not need to select Store Import File. The XML Import Index File is stored by default to the SYS Import Indexes Document Type. This setting remains for backwards compatibility.
  9. Select Create Auto Folder if the Document Type has been properly configured for foldering. This option will generate the folder structure for the Document Type if a structure does not currently exist.
  10. Select Test Only to test the process by running the file through memory. This option will not delete the source document, create documents in OnBase, or copy the data to the Disk Group. It will only create a Verification Report for the process.
  11. Select Default Keywords for the ability to assign Keyword Values to Keyword Types that are not configured to be obtained from the XML Import Index File. Default Keywords can be used in addition to Keyword Values obtained from the XML Import Index File.
    1. Click Default Keywords.
    2. Select the Keyword Type from the left side of the screen.
    3. Type the value in the Keyword entry field.
    4. Click Add.
      Note:

      Default Keywords can only be assigned to Keyword Types that are properly configured for the Document Type.

  12. Type a Default Document Date to set the Document Date for all Document Types that are not configured to obtain the date from the process format.
  13. After you have selected the desired options, click Process. The process starts and a status bar is displayed. Click Yes. The documents have been imported into OnBase.