Hanna UI Based Importer

Overview

vMedia has the capability to programmatically import images that are in the Hanna format in addition to the option of dropping them in a folder and then running the import module manually in vMedia. The importer walks a directory tree and imports multi-page TIFF or PDF files.

Indexing expressions are provided for the first-level folder name and TIFF or PDF file name. Optionally, you can specify a processing expression for the folder name and the file name elements. A processing expression is a function that is executed for the specified elements in the imported document. It is typically used to map fields within the vMedia database to data coming from an outside source. A processing expression can perform very sophisticated data transformation and formatting.

Specifications

  • Required file format: Multi-page/frame TIFF-encoded raster image or multi-page/frame PDF-encoded raster image.
  • Naming: Can be named with index information. The file name, along with the file folder(s) containing the image files can be used for indexing.
  • Structure: Image files must be placed in at least one container folder that is a child of the base import path.
    • Example - given F:\vMedia\IMPORT\ as the base path, the documents must be placed in sub-folders under that path. In the case where the sub-folders will not participate in indexing, the sub-folder can be named anything.

Configuring the Processing Expressions

To replace a vMedia database field with a data value derived from the source document, use this format:

Fieldname WITH field value where fieldname is the name of the vMedia database field as specified in the data base configuration, and field value is the expression that will be evaluated when the document is saved.

Within the field value, the following variables have special meaning:

l_Filename is the file name without an extension.

l_Folder is the folder that the file is located in.

l_Dir is the full source path, not including the folder being processed.

Legacy variables:

l_fwfileno is the internal variable that contains the folder name from the import source that contains the document being imported.

l_cmt is the internal variable that contains the file name of the document being imported.

STREXTRACT() Function for String Extractions

NOTE: l_FileName will include the .PDF extension from the file name. To ignore the .PDF extension you can use the following command: strextract(l_filename,"",".")

vMedia has a useful function to perform string extractions when the sub-strings are bound by specific delimiters. That function is called STREXTRACT() and it takes the following parameters (separated by commas):

  1. Name of the string to extract

  2. Starting delimiter character(s)

  3. Ending delimiter character(s), or empty to end at the end of the string

  4. Occurrence of the starting delimiter to begin string extraction

There are some optional flags to modify function behavior: 1=Case blind delimiter search (for when the delimiter is an alpha string), 2=Ending delimiter may or may not be present, 4=Include delimiters in the returned sub-string

Example:

filename - "ABC1125_1234555567890000_My Document.PDF"

STREXTRACT(pFileName,"","_",1) will return ABC1125

STREXTRACT(pFileName,"_","_",1) will return 1234555567890000

STREXTRACT(pFileName,"_","",2) will return My Document.PDF

 NOTE: This function can only be used in vMedia wherever an expression is allowed.

"pFileName" is a variable for the Spectrum and Media Importers that corresponds to the name of the file being imported, including the extension. A similar variable for the Hanna Importer is "l_Filename", which is the file name without the extension.

Procedure

  1. From the Master Control screen, click on the [Import/Export Module] button.
  2. Highlight your desired vMedia database from the list and click [Select].

  1. From the Bulk Document Import list, click [Frederick Hanna].

NOTE: Once  a profile is selected, the desired profile will load. Focus remains with the profile selector after the load.

  1. Enter a profile in the Select Profile field at the top of the interface.
Selection Options
  • Click on the drop-down button to display a list of profiles and select your desired profile.
    • Type leading characters to select desired item.
  • Use [Alt-Down Arrow] to display the drop-down list of profiles.
    • Cycle through the profile options with the the up or down arrow keys.
  • Use any combination of the previous selection options.
  1. Edit the Location and Destination fields and/or Indexing Control Expressions or accept the default settings.
  2. [Save Profile] is optional. Click this button if you want to save the current settings for future use.

NOTE: Duplicate Document Detection is disabled by default. If you choose to uncheck this option, (as shown in the preceding graphic) the Duplicate Document Detection feature works with a specific field and index configuration only. Documents are considered duplicates if the Primary Key fieldname and the mandatory Secondary Key cmt both match an existing document.

The requirements for the Duplicate Document Detection option are:

  • File Number Processing (Primary Key) must be in the format of "fieldname WITH value-expression."
  • Fast Find Feature must be enabled in the database for fieldname specified above.
  • Document Description Processing (Secondary Key) must be in the format of "cmt WITH value-expression"
  • A field named cmt must exist in the database and have the fast find feature enabled for it.
  1. Click [Import Images].