Skip to main content
Share / Export

Configuring IM Template

IM Template is required before third-party data can be imported into Vista. It defines file format, record types, field locations, defaults, and cross-references. Form help: About the IM Template Form. Procedures: Create an Import Template, Set Import Template Detail, Set Record Types for Import Templates. There is no help slug configuring-im-template.

A standard template does not need IM Template setup. For custom work, create from scratch, copy and modify, or export/import. Copy a standard template and modify the copy is strongly recommended.

Before you start​

  • Confirm standard templates are not enough (see Standard Import Templates).
  • The Import Form must exist (F4). Import Routine, Upload Routine, and Viewpoint Routine default from that form.
  • Any non-default Import, Upload, Viewpoint, or User routine must already exist in the database (User Routine example: bsplIMUserRoutineSample). User routines run at the end of import.
  • Direct imports only: set Direct Import Type.
  • XML is for single-table uploads only (Multiple Table Upload unchecked / disabled). Attachments require Delimited.

Steps — create / modify (Info tab)​

  1. Open IM Template.
  2. Template: unique, max 10 characters (defaults to last active).
  3. Description: max 30 characters (ID only).
  4. Import Form → accept default routines, or pick existing custom ones.
  5. Direct Import Type if this is a direct import.
  6. Optional User Routine.
  7. Format: Delimited / Fixed Width / XML.
  8. Delimiter, or XML Row Tag (no <>).
  9. Multiple Table Upload if more than one table (not for XML), then Record Type Column (delimited) or Beginning/Ending Position (fixed width).
  10. Optional Starting Line Number (> 0 if entered; blank = auto import starts at line 1).
  11. Optional extra Record Types; optional extra Template Detail identifiers; optional Notifications.
  12. Save. Same steps to modify. Field help is F1.

Record Types​

  • RecordType (10) → Form (TableName displays) → Description (30) → optional Skip.
  • Standard templates use the destination table name as the record type (example: APHB / APLB). Extra types can be any value such as header/line.
  • Alphabetically first type is treated as the header (“Detail” would beat “Header” because D precedes H).

Template Detail​

One row set per record type (Record Type column appears and sorts when more than one type):

  • User Default Value (128) and/or Use Viewpoint Default, with Overwrite Import Value (some text says “Override Import Value”).
  • Cross Reference (30, IM Cross Reference name).
  • Location: Record Column (delimited), Beginning/Ending Position (fixed), or XML Tag (XML; brackets stripped on exit).
  • Optional Format Info; direct imports only: Update Column (Update Key is display-only).
  • Optional Prompt on Import (opens IM User Input Detail; that value can still be overridden by template defaults).
  • Nullable is read-only. Custom columns use Identifier > 999.
  • Incompatible data needs an extra identifier plus a cross-reference. Save.

Hard rules​

  • Delimiter must not appear inside fields; source program must use the same delimiter.
  • Remove Quotes strips surrounding double quotes only; inner quotes and apostrophes stay.
  • Enabled is Kofax only, delimited only. Identifiers 960 (file name) and 965 (type) are required on Template Detail; those columns may still be null. Separate attachment lines are errors.
  • Skip: skipped types are ignored if present and not required if missing. Unchecked and missing = error; check Skip, re-import, then uncheck.
  • Direct types: 0 Insert and Update, 1 Insert Only, 2 Update Only. Cannot attach new documents to existing records. Vendor updates (0 or 2) do not prompt to update PM Firms.
  • If both User Default and Use Viewpoint Default are set with overwrite, Viewpoint default wins.
  • Some fields always take the Viewpoint default when the file cannot contain them (Phase Group, PRGroup, InsCode).
  • AR invoices: Viewpoint default on JCCo blanks JCCo when Contract is blank.
  • MS tickets: Viewpoint default plus Use Metric UM converts UM, unit price, and units. Haul code defaults only if Hauler Type is H and not cash/credit. Hours calculated only if StartTime and StopTime both exist. Cash-sale unit price / material total overrides are ignored.
  • PR timecards: do not Viewpoint-default both DayNum and PostDate (circular).
  • Format methods include STRIP, STRIPL0, STRIPT0, STRIPB0, STRIPA0; date masks identify file layout; LEN2, 12; print masks #.## / #.###; combine with &.
  • Notify failure email is for automated imports only, not manual IM Import. Type V uses VA User Profile preferences.
  • Upload routines: IMUpload (one table), IMUploadHeaderDetail (header/detail), IMUploadDirect (no batch; APVM, ARCM, GLBD). Import routines: IMImportIMWE vs IMImportXML.

Notes​

  • Related: Standard Import Templates; Copy Import Templates; Export / Import an IM Template; About Import File Formats; Determining Import Defaults; Add Additional Import Identifiers; Template Detail Samples; Set Import Notifications; Import Types; Import Forms; IM Cross Reference; IM Template Copy; IM Import; IM Work Edit; IM User Input Detail.