vSite Admin Portal: KML Datasources

KML File Upload Process

To add a KML data source, go to the Datasources tab and click Add Source (Fig. 1).

Fig. 1

  1. Select 'KML' from the Type drop-down box.
  2. Press the Select KML file button.
  3. Choose the KML or KMZ package containing the file data source from the file browser.
  4. Press the Save button to continue.

You will receive a message at the bottom of your screen notifying you that your data source was created. You should now be able to locate this data source on the Data Sources page.

 

DSKML.png
Fig. 2

File Structure Requirements

  • KML file must be compressed into a .KMZ archive
  • Placemarks MUST be wrapped into folders
  • Folders MUST be wrapped into the <Document> node
  • Each folder MUST have a unique ID attribute
  • Placemarks MUST be assigned unique IDs
  • Nested folders are permitted. However, intermediate folders MUST NOT contain placemarks
  • Leaf folders SHOULD contain placemarks of same geometry type (except multigeometry)
  • Leaf folders SHOULD contain placemarks of same logic group (e.g. manholes, utility poles, etc.)
  • Polygons
    • The <coordinates> for polygons must be specified in counterclockwise order
    • At the moment, only the outer boundary of polygon is supported in KML
  • <kml> node should have a valid xmlns attribute

KML File Configuration Settings

The content below details all fields needed for this Datasource type and some common configuration settings to help you get started. To go back to the list of available Datasource types, click here.

Remember, to see the fields below, you will need to go to your Datasource and click the Synchronize Structure button.

Root Level

Layer Group

Select one of the predetermined layer groups (made at the team level). By default, all child notes inherit all settings from the parent node - if anything is set at the Root level, all models within the root will be set the same way.

Elevation Type

  • Default - Allows the system to recognize if the data set is z-enabled or not. If z-enabled, the base for the elevation calculations will refer to the sea level and its corresponding vertical datum. If not, it will count as Surface offset.
  • Surface offset - Refers to the selected digital surface as the base for the elevation calculations.
  • Ignore z-value - Ignores z-values within the data set.

Select Color

Select from preset colors or customize your own from the colour palette controls.

Vertical Datum & UoM (Unit of Measure)
 

Use the drop-down to select a preset datum that closely matches your project specifications. Skipping this step could result in your datasource layers being stacked on a flat surface when viewing in the app (if you don't see the vertical datum you need, open a ticket with vGIS Support to make your request).

Model Level/ Category Level

Disclaimer: Depending on the structure of the original dataset, the following fields can also be applied at the category level (note: any changes made at the model level will apply to all categories within).

Layer Group

Select one of the predetermined layer groups (made at the team level). By default, all child notes inherit all settings from the parent node - if anything is set at the model level, all categories within the model will be set similar way.

Header

This field, while editable, is generally preset with the header from the original dataset. The header can be seen when pointed at using the vGIS mobile app.

Select Color

Select from preset colors or customize your own from the colour palette controls.

Object Type

This field should remain untouched as it could lead to configuration issues. It can however be used to verify which object type has been uploaded (Point, Line, Area, 3D Model, or Unknown).

Sub-header

When applicable, use this dropdown to add more descriptive content to the selected layer (options; color, id, layer name, and type).

Object Configuration

These fields are normally preset from the original dataset but can be used to modify or configure fine details of a selected layer (Note: unit of measure will be asked for all measurements).

Line Objects

Object Subtypes; Pipe, Line

Fields: Default depth/ elevation. diameter, diameter field (Line subtypes also have adjustments for height and width).

Point Objects

Object Subtypes; various.

Fields: Default depth/elevation, height, width, underground connector depth

Area Objects

Fields: Default depth/elevation, height, width

Additional Details

Subtype Field

This field will only populate with the distinct values within the original dataset.

Label Type

This field will help identify elements with digital markers flags, or floating text (Note: as more labels become visible, the processing demands increase for the device used).

Elevation Type

At the layer folder level, there are four options:

  • Use Parent Node Setting - Takes configuration settings made at the Root level (see above).
  • Default - Allows the system to recognize if the data set is z-enabled or not. If z-enabled, the base for the elevation calculations will refer to the sea level and its corresponding vertical datum. If not, it will count as Surface offset.
  • Surface offset - Refers to the selected digital surface as the base for the elevation calculations.
  • Ignore z-value - Ignores z-values within the data set.

External ID field (Coming Soon!)
 

When complete, users will be able to hyperlink elements from an external database.

Infocard Image

An optional feature to include an external image that will be displayed when an asset has been selected in the AR application.

"Exclude from processing" Switch

When the same switch is toggled at the Root level (see above), enabling the switch at the model level will open a list with drop-down boxes. Admins can assign the predetermined floors to each layer folder.

A Note on Additional Details at the Category Level

When at the category level, only "label type" and Infocard Image fields will be available.

 

Have Questions? Feel free to Submit A Request to speak with a member of the vGIS Support Team.

Reviewed:  2025-03-06

Related articles