JSON Import Export Specification

Complete field reference for JSON-based configuration import and export.
Reference → Solution → DevOps → Git Integration | JSON Specification

JSON Structure

Standard Format

Every JSON file follows this four-section structure:

json

{
  "ObjectIdentification": {
    "Module": "Uns",
    "TableType": "UnsTags",
    "TableGroup": "Objects"
  },
  "VersionInfo": {
    "TableVersionID": 15,
    "SolutionVersionID": 245,
    "SolutionName": "MyProject"
  },
  "ExportMetadata": {
    "ExportDate": "2026-01-16T10:30:00Z",
    "ExportUser": "john.doe",
    "ExportProduct": "Designer",
    "ExportProductVersion": "10.1.1.1011",
    "ExportFormat": "1.0"
  },
  "Data": [
    { /* object 1 */ },
    { /* object 2 */ }
  ]
}

Section Details

Minimal Import Format

For import operations, only the Data array is required:

json

{
  "Data": [
    { "Name": "Tag1", "Type": 153 }
  ]
}

Import Behavior

Fields Ignored on Import

These fields are auto-generated and ignored during import:

Import Rules

Pre-defined Objects (Cannot Import)

These system objects cannot be created or modified via import:

Import Order Dependencies

When importing related objects, order matters:

1. Independent objects first: Tags, Channels, AlarmGroups, StorageLocations, DatasetDBs
2. Dependent objects after: Nodes→Channels, Points→Nodes+Tags, AlarmItems→Tags+Groups, HistorianTags→Tags+Tables

Tag Types Reference

Built-in Type IDs

UserType IDs

UserType references use IDs starting at 201:

• First UserType created: ID 201
• Second UserType: ID 202
• And so on...

To reference a UserType in JSON: "Type": 201

TableType Reference

Valid TableType values for the ObjectIdentification section:

UNS Module

Devices Module

Alarms Module

Historian Module

Datasets Module

Scripts Module

Reports Module

Security Module

Displays Module

Object Reference Formats

When JSON fields reference other objects, use these formats:

UNS Objects

Tag (UnsTags)

json

{
  "Data": [
    {
      "Name": "Temperature",
      "Type": 153,
      "Path": "\\Line1\\Tank1",
      "Description": "Tank temperature sensor",
      "Array": 0,
      "StartValue": "25.0",
      "Min": "0",
      "Max": "100",
      "Units": "°C",
      "Format": "N1",
      "Domain": 0,
      "Visibility": 2,
      "Retentive": 0
    }
  ]
}

AssetFolder (UnsAssetTree)

json

{
  "Data": [
    {
      "Name": "Line1",
      "Path": "",
      "LinkedProvider": "",
      "Alias": "",
      "Visibility": 2
    },
    {
      "Name": "Tank1",
      "Path": "\\Line1",
      "LinkedProvider": "",
      "Alias": "Primary Tank",
      "Visibility": 2
    }
  ]
}

Devices Objects

Channel (DevicesChannels)

json

{
  "Data": [
    {
      "Name": "ModbusPLC1",
      "Protocol": "Modbus",
      "PrimaryStation": "192.168.1.10:502",
      "BackupStation": "",
      "Timeout": 3000,
      "Retries": 3,
      "Enabled": true,
      "Description": "Main Modbus PLC"
    }
  ]
}

PrimaryStation Formats by Protocol:

Node (DevicesNodes)

json

{
  "Data": [
    {
      "Name": "PLC1",
      "Channel": "Channel.ModbusPLC1",
      "PrimaryStation": "1",
      "BackupStation": "",
      "Enabled": true,
      "Description": "Main PLC unit 1"
    }
  ]
}

Point (DevicesPoints)

json

{
  "Data": [
    {
      "Node": "Node.PLC1",
      "Tag": "Tag.Line1.Tank1.Temperature",
      "Address": "HR100",
      "AccessType": "AccessType.Read",
      "Enabled": true
    }
  ]
}

Address Formats by Protocol:

Alarms Objects

AlarmItem (AlarmsItems)

json

{
  "Data": [
    {
      "Tag": "Tag.Line1.Tank1.Temperature",
      "Group": "Alarm.Group.Critical",
      "Area": "Alarm.Area.Plant1",
      "Condition": ">90",
      "Message": "Tank temperature high: {0}°C",
      "Priority": 800,
      "Enabled": true
    }
  ]
}

Condition Syntax:

Historian Objects

HistorianTag (HistorianTags)

json

{
  "Data": [
    {
      "Tag": "Tag.Line1.Tank1.Temperature",
      "HistorianTable": "Historian.Table.Table1",
      "Deadband": "0.5",
      "Enabled": true
    }
  ]
}

Scripts Objects

ScriptTask (ScriptsTasks)

json

{
  "Data": [
    {
      "Name": "ServerStartup",
      "Code": 2,
      "WhileRunning": false,
      "Execution": 1,
      "Contents": "// C# startup code\n@Info.Trace(\"Server started\");"
    }
  ]
}

ScriptExpression (ScriptsExpressions)

json

{
  "Data": [
    {
      "Name": "TotalFlow",
      "Expression": "Tag.Flow1 + Tag.Flow2 + Tag.Flow3",
      "TargetTag": "Tag.TotalFlow",
      "TriggerTag": "Tag.Flow1",
      "Enabled": true
    }
  ]
}

Common Patterns

Creating a Complete Device Communication Setup

Import order matters - create objects in dependency order:

Step 1: Create Tags

json

{ "Data": [{ "Name": "TankLevel", "Type": 153, "Path": "\\Process" }] }

Step 2: Create Channel

json

{ "Data": [{ "Name": "ModbusCh1", "Protocol": "Modbus", "PrimaryStation": "192.168.1.10:502" }] }

Step 3: Create Node

json

{ "Data": [{ "Name": "PLC1", "Channel": "Channel.ModbusCh1", "PrimaryStation": "1" }] }

Step 4: Create Point

json

{ "Data": [{ "Node": "Node.PLC1", "Tag": "Tag.Process.TankLevel", "Address": "HR100" }] }

Bulk Tag Creation

json

{
  "Data": [
    { "Name": "Motor1_Speed", "Type": 153, "Path": "\\Motors", "Units": "RPM" },
    { "Name": "Motor1_Current", "Type": 153, "Path": "\\Motors", "Units": "A" },
    { "Name": "Motor1_Running", "Type": 151, "Path": "\\Motors" },
    { "Name": "Motor2_Speed", "Type": 153, "Path": "\\Motors", "Units": "RPM" },
    { "Name": "Motor2_Current", "Type": 153, "Path": "\\Motors", "Units": "A" },
    { "Name": "Motor2_Running", "Type": 151, "Path": "\\Motors" }
  ]
}

Validation Rules

Name Validation

• Must be unique within object type
• Alphanumeric plus underscore
• Cannot start with number
• Max length: 256 characters
• Case-sensitive

Required Fields by Object

See Also

• → Git Integration and Export Reference — Export configuration
• → Object Model Quick Reference — Object overview
• → UNS Tags Reference — Tag details
• → Devices Module Reference — Device communication