Import & Export

Source maps can be bulk imported or exported using CSV files. This is useful for standing up a new equipment template, sharing a map between projects, or performing bulk edits to a point list.

Unlike other entities, a source map CSV describes a single map: the first data row is the map itself, and each following row is one of its points.

CSV Format

Source maps can be exported and imported from projects as CSV and MS Excel documents, with the first data row containing the source metadata and the following rows detailing the point list.

The addr, unit, enum, formula, schedule, mode, limit, and modifier columns are left blank for the source row, while vendor and model are left blank for point rows.

The source row id names the map being updated (i.e.: sm.1), and is left blank to create a new one. Point row ids are the point number - 1, 2, 3 - unique within the map.

name	id	type	addr	unit	formula	desc	vendor	model
Kaiterra SE200		bacnet				Smart Air Quality Monitor	Kaiterra	SE200
Temperature	1	air_temp_sensor	ai.1	°C
Humidity	2	air_humidity_sensor	ai.2	%
CO2	3	co2_sensor	ai.2	ppm
PM2.5	4		ai.4	μg/m³		Airborne particles ≤ 2.5µm
PM10	5		ai.5	μg/m³		Airborne particles ≤ 10µm
TVOC	6		ai.6	ppb
Temp °F	7		calc.1	°F	$1 * 9 / 5 + 32

The schedule, mode, limit, and modifier columns are omitted above for brevity - see Point Properties below.

Field to CSV Column Name Mapping

The following table shows each field and its respective column name in CSV, listed in the order the export produces them:

Field	CSV Column Name	Applies To
Name	`name`	Source and points
ID	`id`	Source and points
Type	`type`	Source and points
Address	`addr`	Points
Unit	`unit`	Points
Enum	`enum`	Points
Formula	`formula`	Points
Description	`desc`	Source and points
Schedule	`schedule`	Points
Mode	`mode`	Points
Limit	`limit`	Points
Modifier	`modifier`	Points
Vendor	`vendor`	Source
Model	`model`	Source

Column order does not matter on import - columns are matched by header name, and any column may be omitted.

Point Properties

The schedule, mode, limit, and modifier columns are optional and each accepts a fixed set of values - see Point Properties. A value outside the accepted set fails the import.

name,                 id, type,              addr, unit, schedule,   mode
Zone Temp Sp (Occ),   1,  zone_air_temp_sp,  av.1, °F,   occupied,   heating
Zone Temp Sp (Unocc), 2,  zone_air_temp_sp,  av.2, °F,   unoccupied, heating

Import Behavior

Merge — If the source row provides an id, the row’s fields are merged into that existing map. A point row whose id already exists in the map is updated; fields not listed remain unchanged.
Add Source Map — If the source row id is blank, a new map is created. A point row with an id not already in the map is added.
Validation — Every point row requires an id, name, addr, and type. If import validation fails, no data will be added or updated. All errors are reported so they can be corrected and the import retried.

Export

Export produces a CSV for a single source map in the format above - the map row followed by every point, ordered by point id.

The export includes every field that import accepts, so a map round-trips without loss: export it, edit it, and import it back to get exactly the changes you made and nothing else. Clearing the source row id turns the same file into the starting point for a new map.

Novant