SiteSync Docs

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Uploading JSON File for UDT Creation in Tag Provider ======

In Ignition, User-Defined Types (UDTs) are custom data types that allow you to group multiple tags into a single, reusable structure. You can create UDTs manually in the Ignition Designer, but you can also upload UDT definitions from JSON files through the SiteSync Module. This guide will walk you through the process of uploading a JSON file that meets the UDT JSON requirements and creates UDTs in a tag provider when a device checks in.

===== UDT JSON Requirements =====

The JSON file for UDT creation in Ignition must meet the following requirements:

- The "type" field should be set to "UdtType".
- The "name" field should specify the UDT name.
- The "tags" field should contain an array of tag objects, each defining the tag's properties.

Here is an example of a simple UDT JSON definition:

<code json>
{
    "name": "MyUDT",
    "tagType": "UdtType",
    "tags": [
        {
            "dataType": "String",
            "name": "ExampleTagFolder",
            "tagType": "AtomicTag",
            "valueSource": "memory"
        },
        {
            "name": "ExampleTagFolder",
            "tagType": "Folder",
            "tags": [
                {
                    "dataType": "String",
                    "name": "Temperature",
                    "tagType": "AtomicTag",
                    "valueSource": "memory"
                },
                {
                    "dataType": "String",
                    "name": "Battery",
                    "tagType": "AtomicTag",
                    "valueSource": "memory"
                }
            ]
        }
    ]
}
</code>

===== Conclusion =====

UDTs allow you to efficiently organize and manage your tags, making your SiteSync devices more organized and maintainable.