[IM] IM Template Form Field Definitions

Created by Crystal Millington, Modified on Fri, 26 Dec at 4:04 PM by Crystal Millington

Template – Enter a unique name or number (up to 10 characters) for the template. Defaults to the last active template.

Description – Add a description (up to 30 characters) for identification purposes.

Import Form – Select the destination form for the import. Press F4 to view available forms.

Import Routine – Select the routine that imports data into Vista tables:

  • bspIMImportIMWE – Standard routine for delimited or fixed-width files.

  • bspIMImportXML – For XML files only.

Upload Routine – Select the routine that uploads data to tables:

  • bspIMUpload – Single table imports.

  • bspIMUploadHeaderDetail – Multi-table (header/detail) imports.

  • bspIMUploadDirect – Direct imports that update tables without batches.

Direct Import Type – For direct imports, choose:

  • 0 – Insert and Update – Add new records and update existing ones.

  • 1 – Insert Only – Add new records only.

  • 2 – Update Only – Update existing records only.

Viewpoint Routine – Applies default Vista values when data is missing in the import file. Enable via Use Viewpoint Default on Template Detail.

User Routine – Optional custom routine for special processing. Executed at the end of import.

Data Format – Select the file format:

  • Delimited – Fields separated by characters (comma, tab, etc.).

  • Fixed Width – Field positions defined by character lengths.

  • XML – For single-table XML files with tags identifying fields.

XML Row Tag – For XML files, enter the tag that identifies each row.

Delimiter – For delimited files, select the character separating fields (Tab, Comma, Pipe, etc.). Use Other to specify a custom delimiter.

Multiple Table Upload – Check if the import updates more than one table. Requires additional record types.

Record Type Column / Beginning-Ending Position – Specify where the record type is located in delimited or fixed-width files.

Starting Line Number – Enter the line number where import should start. Useful to skip headers or bad data.

Remove Quotes – Check to remove surrounding quotes in imported fields.

Enabled – For Kofax users, include inline attachment information.

Record Type (Record Types tab) – Name the record type (e.g., Header, Item). Alphabetically first record is treated as header.

Form / TableName / Description – Assign the import form, view the default table, and add a description for the record type.

Skip – Check to ignore missing or unwanted record types in the import file.

Identifier / Column Name / User Default Value / Use Viewpoint Default / Overwrite Import Value – Configure the columns:

  • Identifier – Unique number for each column.

  • Column Name – Name of the column.

  • User Default Value – Enter a value to insert or replace data.

  • Use Viewpoint Default – Apply Vista default values if the file is blank.

  • Overwrite Import Value – Force the system to use the default value even if data exists in the file.

Cross Reference – Link imported values to Vista values using cross-reference tables.

Record Column / Beginning-Ending Position / XML Tag – Specify where fields are located depending on the file type (Delimited, Fixed Width, XML).

Format Info – Reformat data using methods like:

  • Character Stripping – Remove spaces or specific characters.

  • Date Format – Specify the date format used in the file.

  • Length Format – Select specific characters from a field.

  • Print Mask – Set numeric formatting for decimals.

Update Column / Update Key – For direct imports, select fields to update and keys to match existing records.

Prompt on Import – Ask the user for a value during import for fields that change per import.

Nullable – Indicates whether a field can be blank.

Notification Fields (Seq, Type, Destination Name, Notify on Success/Failure, Attach Log File) – Configure notifications for automatic imports.

Export/Import Template Directory – Specify a network folder for saving and sharing templates.

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article