Running a Directory Import Processor Process - Directory Import Processor - English - Foundation 22.1 - OnBase - Essential - Premier - Standard - external - Standard - Essential - Premier

Directory Import Processor

Directory Import Processor
Foundation 22.1

To run a Directory Import Processor process, you must be a member of a user group that has sufficient rights.


Files over 2 GB are not supported for import into OnBase. Files over this size cannot be properly displayed in OnBase.

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

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

    • Directory Import Processor Formats - Lists available Directory Import Processor 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.


      If there is a disruption/error during 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 Directory Import Processor 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 Directory Import Processor Formats. All available Directory Import Processor Formats display in the right window.
  4. Select a Directory Import Processor Format and right-click.
  5. Select Directory Import Processor. The Directory 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 into the corresponding Disk Group(s).

    The Store Import File option is not supported for use with the Directory Import Processor.

  8. 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.
  9. Select Test Only to test the process by running the file through memory. This option will not delete the source documents, create documents in OnBase, or copy the data to the Disk Group. It will only create a Verification Report for the process.
  10. Select Default Keywords for the ability to assign Keyword Values to Keyword Types that are not configured to be obtained from the data files. Default Keywords can be used in addition to Keyword Values obtained from the imported files.
    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.

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

  11. 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.
  12. After you have selected the desired options, click Process. The process starts and a status bar is displayed.