Understanding the HxC Export Package - Hyland Experience Capture Import Processor - Foundation 24.1 - Foundation 24.1 - Ready - OnBase - external

Hyland Experience Capture Import Processor
Platform
OnBase
Product
Hyland Experience Capture Import Processor
Release
Foundation 24.1
License

The HxC export package is a collection of documents and .xml files used for the importing and indexing of documents into OnBase. The export package is generated as a hxcpkg.zip file from the Hyland Experience Capture application.

In a typical HxC export package, the .zip file consists of the following:

  • A batch.xml file- The batch.xml file contains the Batch ID number that is used to assign to each document imported into OnBase from the HxC export package. For more information on mapping the Batch ID number to an OnBase Keyword Type, see Assigning the HxC Batch ID to a Keyword Type.

  • A documents folder- The documents folder contains the .xml files for each exported document in the HxC export package. These .xml files are used to configure OnBase Keywords Types by pointing the HxC Import Processor to particular XML tags and attributes. For more information on mapping XML information to OnBase Keyword Types, see Configuring Additional Keyword Type Mappings.

  • An exportedFiles folder- The exportedFiles folder contains the PDF versions of each exported document in the HxC export package.

Upon processing, the HxC Import Processor automatically unzips the hxcpkg.zip file to begin processing the data in the export package. Once processing is complete, the unzipped files are deleted. One of the following occurs with the original hxcpkg.zip export package:

  • If no errors occur during processing, the original export package is left in its original directory, to be handled according to the package post-processing options configured under the HxC Import Settings. For more information on package post-processing options, see Configuring Import Processor Settings.

  • If errors are detected upon importing (for example, incorrect >>File Name mappings or missing files), the original hxcpkg.zip export package is moved to the ERROR_FILES folder.

  • If an error occurs that prevents the package from being fully imported (for example, if the import process is interrupted before it can be completed), the original hxcpkg.zip export package remains in the original directory.