Page History

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

JSON Structure

Standard Format (v1.1)

Every JSON file follows this fourthree-section structure:

json

{
  "ObjectIdentification": {
    "Module": "Uns",
    "TableType": "UnsTags",
    "TableGroupSolutionName": "ObjectsMyProject"
  },
  "VersionInfoExportMetadata": {
    "TableVersionIDExportDate": 15"2026-01-16T10:30:00Z",
    "SolutionVersionIDExportUser": 245"john.doe",
    "SolutionNameExportProduct": "MyProjectFrameworX",
  },
  "ExportMetadataExportProductVersion": {
    "ExportDate": "2026-01-16T10:30:00Z",
    "ExportUser": "john.doe",
    "ExportProduct": "Designer",
    "ExportProductVersion": "10"10.1.1.1011",
    "ExportFormat": "1.01"
  },
  "Data": [
    { /* object 1 */ },
    { /* object 2 */ }
  ]
}

Section Details

Note: The Data section is always an array, even for single-object exports.

Minimal Import Format

For import operations, only the Data array is required:

json

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

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

Fields Filtered from Export

These fields are excluded from export files to reduce size:

Compiled/Binary Data:

Build Results:

Calculated Fields:

Conditional:

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 Types

UserType References

To reference a UserType in JSON, use the UserType name:

json

"Type": "LabelingMachine"

Enumeration Values Reference

Domain

Visibility

Retentive

Script Code Language

TableType Reference

Valid TableType valuesValid 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"Double",
      "Path": "\\Line1\\Tank1",
      "Description": "Tank temperature sensor",
      "Array": 0,
      "StartValue": "25.0",
      "Min": "0",
      "Max": "100",
      "Units": "°C",
      "Format": "N1",
      "Domain": 0"Server",
      "Visibility": "Public",
      "Retentive": "None",
      "DateCreated": 2"2026-01-16T10:30:00Z",
      "DateModified": "Retentive": 0"2026-01-16T10:30:00Z"
    }
  ]
}

AssetFolder (UnsAssetTree)

json

{
  "Data": [
    {
      "Name": "Line1",
      "Path": "",
      "LinkedProvider": "",
      "Alias": "",
      "Visibility": "Public",
      "DateCreated": "Alias": ""2026-01-16T10:30:00Z",
      "VisibilityDateModified": 2"2026-01-16T10:30:00Z"
    },
    {
      "Name": "Tank1",
      "Path": "\\Line1",
      "LinkedProvider": "",
      "Alias": "Primary Tank",
      "Visibility": "Public",
      "DateCreated": "2026-01-16T10:30:00Z",
        "Visibility": 2"DateModified": "2026-01-16T10:30:00Z"
    }
  ]
}

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",
      "DateCreated": "Enabled": true"2026-01-16T10:30:00Z",
      "DescriptionDateModified": "Main Modbus PLC2026-01-16T10:30:00Z"
    }
  ]
}

PrimaryStation Formats by Protocol:

Node (DevicesNodes)

json

{
  "Data": [
    {
      "Name": "PLC1",
      "Channel": "Channel.ModbusPLC1",
      "PrimaryStation": "1",
      "BackupStation": "",
      "Enabled": true,
      "Description": "Main PLC unit 1 1",
      "DateCreated": "2026-01-16T10:30:00Z",
      "DateModified": "2026-01-16T10:30:00Z"
    }
  ]
}

Point (DevicesPoints)

json

{
  "Data": [
    {
      "Node": "Node.PLC1",
      "Tag": "Tag.Line1.Tank1.Temperature",
      "Address": "HR100",
      "AccessType": "AccessType.Read",
      "Enabled": true,
      "DateCreated": "2026-01-16T10:30:00Z",
      "DateModified": "2026-01-16T10:30:00Z"
    }
  ]
}

Address Formats by Protocol:

Alarms Objects

AlarmItem (AlarmsItems)

json

{
  "Data": [
    {
      "Tag": "Tag.Line1.Tank1.Temperature",
      "Group": "Alarm.Group.Critical",
      "Area": "Alarm.GroupArea.CriticalPlant1",
      "AreaCondition": "Alarm.Area.Plant1GreaterThan",
      "ConditionSetpoint": ">9090",
      "Message": "Tank temperature high: {0}°C",
      "Priority": 800,
      "Enabled": true,
      "DateCreated": "2026-01-16T10:30:00Z",
      "DateModified": "2026-01-16T10:30:00Z"
    }
  ]
}

Condition SyntaxValues:

Historian Objects

HistorianTag (HistorianTags)

json

{
  "Data": [
    {
      "Tag": "Tag.Line1.Tank1.Temperature",
      "HistorianTable": "Historian.Table.Table1",
      "Deadband": "0.5",
      "Enabled": true,
      "DeadbandDateCreated": "0.52026-01-16T10:30:00Z",
      "EnabledDateModified": true"2026-01-16T10:30:00Z"
    }
  ]
}

Scripts Objects

ScriptTask (ScriptsTasks)

json

{
  "Data": [
    {
      "Name": "ServerStartup",
      "Code": "CSharp",
    {    "Domain": "Server",
      "NameTrigger": "ServerStartup",
      "CodeInitialState": 20,
      "WhileRunningDescription": false"",
      "ExecutionNamespaceDeclarations": 1"",
      "Contents": "// C# startup code\n@Info.Trace(\"Server started\"); started\");",
      "DateCreated": "2026-01-16T10:30:00Z",
      "DateModified": "2026-01-16T10:30:00Z"
    }
  ]
}

ScriptExpression (ScriptsExpressions)

json

{
  "Data": [
    {
      "Name": "TotalFlow",
      "Expression": "Tag.Flow1 + Tag.Flow2 + Tag.Flow3",
      "TargetTag": "Tag.TotalFlow",
      "TriggerTag": "Tag.Flow1",
      "Enabled": true,
      "DateCreated": "2026-01-16T10:30:00Z",
      "DateModified": "2026-01-16T10:30:00Z"
    }
  ]
}

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"Double", "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": [{ "Name": "Point1", "Node": "Node.PLC1", "Tag": "Tag.Process.TankLevel", "Address": "HR100" }] }

Bulk Tag Creation

json

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

Validation Rules

Name Validation

• Must be unique within object type
• Alphanumeric plus underscore
• Cannot contain dashes (reserved for expressions)
• Cannot start with number
• Max length: 256 characters
• Case-sensitive

Required Fields by Object

See Also