You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Import tags and device points from GIS data files — GeoJSON, Shapefile, and KML/KMZ.

ReferenceSolutionDesignerSettings and ToolsImport Tags → GIS File


The GIS File Tag Importer creates FrameworX tags, channels, nodes, and device points from geographic feature data. Each feature in the source file becomes one tag bound to one device point, with channels and nodes shared across features according to your naming patterns.

Typical use: a plant engineer receives a GeoJSON export of solar panels, a KML file of water-treatment assets, or a Shapefile of pipeline segments, and wants FrameworX tags and Modbus/OPC addresses created automatically for each feature.

Access: Solution → Import Tags → GIS File


Supported File Formats

FormatExtensionsLibraryNotes

GeoJSON

.geojson, .json

RFC 7946 compliant

FeatureCollection or single Feature. Streaming parse supports 100K+ features.

Shapefile

.shp (with .dbf, .shx, .prj) or .zip bundle

Esri standard

ZIP bundles are auto-extracted. .dbf columns become feature attributes.

KML / KMZ

.kml, .kmz

OGC KML 2.2

KMZ auto-extracted. Folder hierarchy becomes the layer structure.

Geometry handling

Point features use their coordinates directly. LineString, Polygon, and multi-part geometries are centroid-reduced to a single point — each non-Point feature is represented by the centroid of its vertices.

All coordinates are treated as WGS84 (lat/lon). If a Shapefile carries a .prj file with a different coordinate system, the file is read but coordinates are not reprojected — use a WGS84 export for now.


Import Wizard

Step 1 — File Select

Browse for a GIS file. The wizard auto-detects the format and displays a quick summary: feature count, list of layers, list of attribute names, coordinate system (when available).

Step 2 — Protocol

Select the communication protocol (Modbus TCP/IP, OPC UA, Ethernet/IP, etc.) and configure channel and node naming patterns.

Step 3 — Mapping

Define how feature attributes become tag properties:

FieldPurposeDefault

Tag Name Pattern

Template for the tag name

{Name}

Tag Type

Analog, Digital, Integer, Text

Analog

Description Attribute

Feature attribute to use as the tag description

(none)

Address Pattern

Template for the device-point address

{Attr:Address}

Access Type

Read / Write / ReadWrite

ReadWrite

Update Existing

Re-import updates matching tags in place

Checked

Step 4 — Preview

The first 50 resolved features are shown with their computed tag name, channel, node, and address. Any duplicate matches against existing tags are flagged at the top.

Step 5 — Generate

Progress bar with live counters. For large files (100K+ features), expect a few minutes — the pipeline uses bulk-mode DataTable operations optimized for high-volume imports.


Pattern Tokens

All pattern fields support these tokens:

TokenReplaced WithExample

{Name}

Feature name (GeoJSON id/name, KML Placemark name, Shapefile attribute)

INV-001

{Layer}

Shapefile base name, or KML Folder name

Intake

{Id}

Source-assigned ID (FID, OBJECTID, etc.)

1

{Index}

0-based index within the file

42

{Lat} / {Lon}

Latitude / longitude, 6 decimal places

41.123456

{Attr:xxx}

Value of feature attribute xxx, empty if missing

{Attr:device_id}INV-001

Hierarchical tag names

Use a slash in the Tag Name Pattern to create asset-tree folder hierarchy:

  • {Layer}/{Name} on a multi-layer KML produces tags nested under one folder per KML Folder.
  • {Attr:area}/{Attr:device_id} produces tags nested by the area attribute.

Example — Solar Plant Inverters (GeoJSON)

A typical photovoltaic plant export: one Point feature per inverter with Modbus address and combiner-box grouping as attributes.

solar_plant_inverters.geojson
{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "id": "1",
      "geometry": { "type": "Point", "coordinates": [-43.172, -22.906] },
      "properties": {
        "device_id": "INV-001",
        "device_type": "SMA_SunnyHighpower_150",
        "modbus_address": "1",
        "combiner_box": "CB-A1",
        "area": "Block_A"
      }
    },
    {
      "type": "Feature",
      "id": "2",
      "geometry": { "type": "Point", "coordinates": [-43.173, -22.907] },
      "properties": {
        "device_id": "INV-002",
        "modbus_address": "2",
        "combiner_box": "CB-A1",
        "area": "Block_A"
      }
    }
  ]
}

Suggested mapping

Protocol

ModbusTCPIP

Tag Name Pattern

{Attr:device_id} produces INV-001, INV-002

Channel Name Pattern

{Attr:area}_Channel — one channel per plant block

Node Name Pattern

{Attr:combiner_box} — one node per combiner box

Address Pattern

{Attr:modbus_address}

Description Attribute

device_type


Notes and Limitations

  • Coordinate reprojection is not implemented. All inputs are assumed WGS84. Shapefiles with non-WGS84 .prj files are read but coordinates are not transformed.
  • Line and polygon geometries are centroid-reduced. The original geometry is not preserved.
  • Multi-geometry features (MultiPoint, MultiLineString, MultiPolygon) use the centroid of the combined geometry.
  • KMZ with multiple .kml files uses the first file alphabetically.
  • Re-import with Update Existing checked updates matching tags in place.

See Also


In this section…

The root page @parent could not be found in space FrameworX 10.1.

  • No labels