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

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

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 values:

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

AssetFolder (UnsAssetTree)

json

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

Devices Objects

Channel (DevicesChannels)

json

{
  "Data": [
    {
      "Name": "ModbusPLC1{
  "Data": [
    {
      "Name": "Temperature",
      "Type": 153,
      "Path": "\\Line1\\Tank1",
      "Description": "Tank temperature sensor",
      "ArrayProtocol": 0"Modbus",
      "StartValuePrimaryStation": "25.0192.168.1.10:502",
      "MinBackupStation": "0",
      "MaxTimeout": "100"3000,
      "UnitsRetries": "°C"3,
      "FormatEnabled": "N1"true,
      "DomainDescription": 0 "Main Modbus PLC",
      "Visibility": 2  "DateCreated": "2026-01-16T10:30:00Z",
      "RetentiveDateModified": 0"2026-01-16T10:30:00Z"
    }
  ]
}

PrimaryStation Formats by Protocol:

Node (DevicesNodes)

json

{
  "Data": [
    {
      "Name": "Line1PLC1",
      "PathChannel": "Channel.ModbusPLC1",
      "LinkedProviderPrimaryStation": "1",
      "AliasBackupStation": "",
      "Visibility": 2
    },
    {
      "Name": "Tank1",
      "Path": "\\Line1"Enabled": true,
      "LinkedProviderDescription": "Main PLC unit 1",
      "AliasDateCreated": "Primary Tank2026-01-16T10:30:00Z",
      "VisibilityDateModified": 2"2026-01-16T10:30:00Z"
    }
  ]
}

Devices Objects

Point (DevicesPoints)

json

{
  "Data": [
    {
      "NameNode": "ModbusPLC1Node.PLC1",
      "ProtocolTag": "ModbusTag.Line1.Tank1.Temperature",
      "PrimaryStationAddress": "192.168.1.10:502HR100",
      "BackupStationAccessType": "",
      "Timeout": 3000AccessType.Read",
      "RetriesEnabled": 3true,
      "EnabledDateCreated": true"2026-01-16T10:30:00Z",
      "DescriptionDateModified": "Main Modbus PLC2026-01-16T10:30:00Z"
    }
  ]
}

PrimaryStation Address Formats by Protocol:

Node (DevicesNodes)

json

Alarms Objects

AlarmItem (AlarmsItems)

json

{
  "Data": [
    {
      "Tag": "Tag.Line1.Tank1.Temperature",
      "Group": "Alarm.Group.Critical",
      "Area": "Alarm.Area.Plant1",{
  "Data": [
    {
      "NameCondition": "PLC1GreaterThan",
      "ChannelSetpoint": "Channel.ModbusPLC190",
      "PrimaryStationMessage": "1Tank temperature high: {0}°C",
      "BackupStationPriority": 800,
  ""    "Enabled": true,
      "EnabledDateCreated": true"2026-01-16T10:30:00Z",
      "DescriptionDateModified": "Main PLC unit 12026-01-16T10:30:00Z"
    }
  ]
}

  ]
}

Condition Values:

Historian Objects

HistorianTag (HistorianTags)

json

{
  "Data": [
    {
      "NodeTag": "Node.PLC1Tag.Line1.Tank1.Temperature",
      "TagHistorianTable": "TagHistorian.Line1Table.Tank1.TemperatureTable1",
      "AddressDeadband": "0.5",
      "HR100Enabled": true,
       "AccessType": "AccessType.Read"DateCreated": "2026-01-16T10:30:00Z",
      "EnabledDateModified": true"2026-01-16T10:30:00Z"
    }
  ]
}

Address Formats by Protocol:

Alarms Objects

Scripts Objects

ScriptTask (ScriptsTasks)

json

{
  "Data": [
    {
      "Name": "ServerStartup",
      "Code": "CSharp",
      {"Domain": "Server",
      "TagTrigger": "Tag.Line1.Tank1.Temperature",
      "GroupInitialState": "Alarm.Group.Critical"0,
      "AreaDescription": "Alarm.Area.Plant1",
      "ConditionNamespaceDeclarations": ">90",
      "MessageContents": "Tank temperature high: {0}°C// C# startup code\n@Info.Trace(\"Server started\");",
      "DateCreated": "Priority": 8002026-01-16T10:30:00Z",
      "EnabledDateModified": true"2026-01-16T10:30:00Z"
    }
  ]
}

Condition Syntax:

Historian Objects

HistorianTag (HistorianTags)

json

Field
Required
Type
Description
Name
Yes
string
Task name
Code
Yes
string
Language: "VB.NET", "CSharp", "Python"
Domain
No
string
"Server" or "Client"
Trigger
No
string
Trigger expression
InitialState
No
int
Initial state
Description
No
string
Documentation
NamespaceDeclarations
No
string
Additional namespaces
Contents
Yes
string
Script code
ScriptExpression (ScriptsExpressions)
json
{
  "Data": [
    {
      "Name": "TotalFlow",
      "Expression": "Tag.Flow1 + Tag.Flow2 + Tag.Flow3",
      "TargetTag": "Tag.TotalFlow",{
  "Data": [
    {
      "TagTriggerTag": "Tag.Line1.Tank1.TemperatureFlow1",
      "HistorianTableEnabled": "Historian.Table.Table1"true,
      "DeadbandDateCreated": "0.52026-01-16T10:30:00Z",
      "EnabledDateModified": true"2026-01-16T10:30:00Z"
    }
  ]
}

Field
Required
Type
Description
Name
Yes
string
Expression name
Expression
Tag
Yes
string
Tag to historizeHistorianTable
Calculation formula
TargetTag
Yes
string
Storage table referenceDeadband
Result destination tag
TriggerTag
No
string
Logging deadband
Tag that triggers recalculation
Enabled
No
bool
Active state
Scripts Objects
ScriptTask (ScriptsTasks)
json
{
  "Data": [
    {
      "Name": "ServerStartup",
      "Code": 2,
      "WhileRunning": false,
      "Execution": 1,
      "Contents": "// C# startup code\n@Info.Trace(\"Server started\");"
    }
  ]
}
Field
Required
Type
Description
Name
Yes
string
Task name
Code
Yes
int
Language: 0=VB.NET, 2=C#, 4=Python
WhileRunning
No
bool
Run in loop
Execution
No
int
0=Server, 1=Client
Contents
Yes
string
Script code
ScriptExpression (ScriptsExpressions)
json
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": "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": "TotalFlowPLC1",
      "ExpressionChannel": "Tag.Flow1 + Tag.Flow2 + Tag.Flow3Channel.ModbusCh1",
      "TargetTagPrimaryStation": "Tag.TotalFlow",
1" }] }
Step 4: Create Point
json
{ "Data": [{ "Name      "TriggerTag": "Tag.Flow1Point1",
      "Enabled": true
    }
  ]
}
Field
Required
Type
Description
Name
Yes
string
Expression name
Expression
Yes
string
Calculation formula
TargetTag
Yes
string
Result destination tag
TriggerTag
No
string
Tag that triggers recalculation
Enabled
No
bool
Active state
Common Patterns
Creating a Complete Device Communication Setup
Import order matters - create objects in dependency order:
Step 1: Create Tags
json
Node": "Node.PLC1", "Tag": "Tag.Process.TankLevel", "Address": "HR100" }] }
Bulk Tag Creation
json
{
  { "Data": [
    { "Name": "TankLevelMotor1_Speed", "Type": 153"Double", "Path": "\\ProcessMotors", "Units": "RPM" }] }
Step 2: Create Channel
json
,
    { "DataName": [{"Motor1_Current", "NameType": "ModbusCh1Double", "ProtocolPath": "Modbus\\Motors", "PrimaryStationUnits": "192.168.1.10:502A" }] }
Step 3: Create Node
json
{ "Data": [,
    { "Name": "PLC1Motor1_Running", "ChannelType": "Channel.ModbusCh1Digital", "PrimaryStationPath": "1\\Motors" }] }
Step 4: Create Point
json
{ "Data": [,
    { "NodeName": "Node.PLC1Motor2_Speed", "TagType": "Tag.Process.TankLevelDouble", "AddressPath": "HR100\\Motors" }] }
Bulk Tag Creation
json
{
  "Data": [, "Units": "RPM" },
    { "Name": "Motor1Motor2_SpeedCurrent", "Type": 153"Double", "Path": "\\Motors", "Units": "RPMA" },
    { "Name": "Motor1Motor2_CurrentRunning", "Type": 153"Digital", "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
Object
Required Fields
Tag
Name, Type
Channel
Name, Protocol, PrimaryStation
Node
Name, Channel, PrimaryStation
Point
Node, Tag, Address
AlarmItem
Tag, Group, Condition, Message
HistorianTag
Tag, HistorianTable
DatasetQuery
Name, DatasetDB, Contents
ScriptTask
Name, Code, Contents
See Also
→ Git Integration and Export Reference — Export configuration
→ Object Model Quick Reference — Object overview
→ UNS Tags Reference — Tag details
]
}
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
Object
Required Fields
Tag
Name, Type
Channel
Name, Protocol, PrimaryStation
Node
Name, Channel, PrimaryStation
Point
Node, Tag, Address
AlarmItem
Tag, Group, Condition, Setpoint, Message
HistorianTag
Tag, HistorianTable
DatasetQuery
Name, DatasetDB, Contents
ScriptTask
Name, Code, Contents

Summary of v1.1 Format Changes

Aspect
v1.0
v1.1
Sections
4 (ObjectIdentification, VersionInfo, ExportMetadata, Data)
3 (ObjectIdentification, ExportMetadata, Data)
ObjectIdentification
Module, TableType, TableGroup
TableType, SolutionName
VersionInfo
TableVersionID, SolutionVersionID, SolutionName
Removed
Folder structure
Hierarchical by module
Flat, single folder
File naming
Path-based
{TableType}.json or {TableType}-{Name}.json
Enum fields
Numeric IDs
String values
Data format
Array or single object
Always array
Type field
All objects
Only UnsTags and UserType tables
Filtered fields
None
ID, XRefInfo, LockState, ContentsRun, BuildMessages, etc.
DateCreated/DateModified
In Data objects
Kept in Data objects
→ Devices Module Reference — Device communication