Basic Instructions for the IMIMPORT Command/Script Driven Importer

Overview

vMedia has the capability to programmatically import images that are in the Hanna format. IMIMPORT takes a single parameter, which is a pointer to a text file that contains the setup and control parameters for the import function. A corresponding log file with the same name as the passed parameter file is created (with an extension of LOG) in the same folder in which the parameter file is located.

NOTE: Each time IMIMPORT is run with the same parameter file, any existing LOG file is overwritten.

Basic Usage Instructions for the IMIMPORT Command/Script Driven Importer

Prerequisites: The image files to be imported must already be formatted and structured according to the Hanna/TIFF import specification.

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. (ex. Given F:\vMedia\IMPORT\ as the base path, the documents would need to 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.)

Usage: From a command prompt, shell, or ShellExec, execute the following command:
IMIMPORT {name of parameter file to interpret}

Parameter File Contents:

All parameters have the format of Variable=value.
Variable names are not case sensitive.
Any variable(s) omitted will have the default value as indicated.
Variables can appear in any order.

Variable Contents:

SourceFolder Full path ending in \ pointing to the start of the Hanna import tree structure
(default)= C:\IMPORT\

DestFolder Full path ending in \ pointing to the start of the vMedia folder where the converted documents for this import run
should be stored.
(default)= {Base path as defined in the vMedia Database}\YYYYMMDD\

ImportAll 1=Import All Documents (default) or 0=Only Import New Documents (Requires index on first processing rule to match.)

Database The vMedia database six-character name prefix, either with or without the path
(default)= {vMedia Folder}\CLS000

FN-Expr The folder name processing expression to match on the folder names in the import tree.
(default)= fileno WITH l_fwfileno

DD-Expr The document description processing expression which handles the import file name.
(default)= cmt WITH l_cmt

ShowUI 1=Show User Interface (default) or 0=Run process completely silently.
The user interface displays the parameter file being used, the log file created, and the number of documents
while they are being converted. The user interface automatically terminates when the processing has completed.

NOTE: Any line that does not have the format of variable=value will be ignored and can be used to comment the file.

See the sample ControlFile.txt for a practical example of the usage of all of the parameters.

Basic Instructions for the IMIMPORT Command/Script Driven Importer

Overview

Basic Usage Instructions for the IMIMPORT Command/Script Driven Importer

Related Topics