Engineering Module - Design file upload: File requirements

Vitruvi Accepts KML, SHP and Excel filetypes - be sure to follow the instructions below.

This reference article describes the file type requirements for uploading Design files into Vitruvi. It also describes project prerequisites - i.e., the data that must be set up in a Vitruvi project prior to uploading Design files.

File type requirements

Vitruvi will accept Design files created in any Engineering Design program, provided they meet the requirements for one of the two file types below:

KML requirements

  • Must be type .KML
  • Must have coordinate reference system (CRS) with the following:
    • WGS: 84
    • EPSG: 4326
  • Must have some kind of Unique Identifier (UID) metadata - either a specific UID column containing unique values for each potential Design Element, or several columns which can combine to create unique values
  • Should have some other Design metadata, ideally including Design Element name, element type, and attributes

SHP requirements

  • Must be a ZIP file containing the following Mandatory file types:
    • .shp — shape format; the feature geometry itself
    • .shx — shape index format; a positional index of the feature geometry to allow seeking forwards and backwards quickly
    • .dbf — attribute format; columnar attributes for each shape, in dBase IV format

      Optional additional file types in the same ZIP file;
      • .prj — projection description, using a well-known text representation of coordinate reference systems
      • .sbn and .sbx — a spatial index of the features
      • .fbn and .fbx — a spatial index of the features that are read-only
      • .ain and .aih — an attribute index of the active fields in a table
      • .ixs — a geocoding index for read-write datasets
      • .mxs — a geocoding index for read-write datasets (ODB format)
      • .atx — an attribute index for the .dbf file in the form of shapefile.columnname.atx (ArcGIS 8 and later)
      • .shp.xml — geospatial metadata in XML format, such as ISO 19115 or other XML schema
      • .cpg — used to specify the code page (only for .dbf) for identifying the character encoding to be used
      • .qix — an alternative quadtree spatial index used by MapServer and GDAL/OGR software
  • Must have coordinate reference system (CRS) that can translate to EPSG: 4326.
  • Must have some kind of Unique Identifier (UID) metadata - either a specific UID column containing unique values for each potential Design Element, or several columns which can combine to create unique values
  • Should have some other Design metadata, ideally including Design Element name, element type, and attributes

Excel requirements

  • Must be type .XLSX or .XLSM
  • Must have headings (do not have to be in row 1)
  • If the document has multiple sheets, the document must be saved with the desired sheet open for Vitruvi to read it
  • Must have some kind of Unique Identifier (UID) metadata - either a specific UID column containing unique values for each potential Design Element, or several columns which can combine to create unique values
  • Must have either latitude/longitude data or address data for each Design Element (note: either type must be separated into multiple columns - one column for latitude/one longitude, or one column for street number, one column for street name, one column for city, etc.).
    • Note for Address data: "Country" values have a 2-character limit (eg. use CA for Canada, US for United States of America)
    • Note for latitude/longitude data: the two lat/long columns MUST NOT be the first two columns in the sheet
  • Should have some other Design metadata, ideally including Design Element name, element type, and attributes

Project set-up requirements

Before you upload a Design file, please ensure your project is set up with the following:

  1. All Administrative data, including:
    1. General Admin: Labor Items, Material Quantity Descriptions, Payable Item Categories, Work Order Categories, Work Item Categories, Materials, Equipment, Roles, People, Crews, Contractors, and Network Symbology.
  2. Network Operator Admin: Network Operator set-up, Program, program segment, region; program standards including: Material Categories, Materials, Payable Item Categories, Work Order Categories, and Design Element Types.
  3. The appropriate regional breakdown for the regions covered by your Design (Note: this is added in the Vitruvi api Admin).
  4. The appropriate Design Element Attribute fields added in the api Admin. 
  5. The appropriate Work Packages for your project generated in Vitruvi's Work Management module. 
  6. Design files which meet the file type requirements listed above.