Overview
DataTemplates enable users to extend the platform’s predefined data types by defining custom types with properties tailored to their business needs. This feature offers flexibility for modeling solution-specific data structures that standard types can’t represent, such as machine data, equipment status, and other asset attributes within an industrial plant.
On this page:
Defining DataTemplates
To define a tag template:
Go to Unified Namespace → DataTemplates.
Click New.
The "Create New DataTemplate" dialog will open.
In the "New Name" field, enter a name for the tag type. In the Description, enter a description of the template. Click OK. The Templates tab displays with the name of the new template at the top of the tab.
To create a new attribute for this DataTemplate, type into the first row of the table next to it and press enter after adding all the information. The properties here are the same ones for Tags. See Creating and Editing Tags for more information.
To delete a template, select it from the User Custom Type drop-down list, then click Delete Item.
Using DataTemplates for custom Tag Types
DataTemplates streamline the creation of tags by supplying predetermined attributes. By employing these templates, users can efficiently manage data by upholding a logical and hierarchical structure representing assets or informational models.
To implement a DataTemplate in your project:
Navigate to the 'Tags' tab and click on 'New Item' to create a new tag.
In the 'Type' dropdown row, you can select the desired template. If a tag has already been created, select the desired template from the 'Type' column.
The tag will inherit the attributes from the chosen template.
DataTemplate Members Columns
DataTemplate Properties | |
|---|---|
ID | Identifies the unique identifier for the DataTemplate. |
VersionID | Shows the specific version number of the DataTemplate. |
Name | Names the DataTemplate for identification and reference. |
Type | Defines the member's data type, which could be one of the base types listed below. The base data types include Digital, Integer, Long, Double, Decimal, and Text. |
Array | Indicates whether the DataTemplate is an array and defines its size and structure. |
Parameters | Specifies additional parameters that define the behavior or attributes of the DataTemplate. |
Min | Sets the minimum allowable value. |
Max | Sets the maximum allowable value. |
ScaleMin | Defines the minimum scale value for display or calculation purposes. |
ScaleMax | Defines the maximum scale value for display or calculation purposes. |
Units | Specifies the unit of measure for the DataTemplate. |
Format | Determines the format in which the data is displayed. |
Enumeration | Lists possible enumeration values for the DataTemplate. |
StartValue | Sets the initial value for the DataTemplate when it is first created. |
Retentive | Indicates whether the DataTemplate retains its value after a system restart. |
Domain | Defines the domain or category to which the DataTemplate belongs. |
Visibility | Controls whether the DataTemplate is visible in certain contexts. |
Disable | Indicates whether the DataTemplate is disabled and non-operational. |
DisplayText | Specifies the text to be displayed for the DataTemplate in the user interface. |
RelativeAddress | Sets the relative address or reference path for the DataTemplate within the system. |
EditSecurity | Specifies the security level required to edit the DataTemplate. |
ReadSecurity | Specifies the security level required to read the DataTemplate. |
WriteSecurity | Specifies the security level required to write to the DataTemplate. |
LockState | Indicates whether the DataTemplate is locked and cannot be modified. |
LockOwner | Identifies the owner or entity responsible for locking the DataTemplate. |
DateCreated | Records the date and time when the DataTemplate was created. |
DateModified | Records the date and time when the DataTemplate was last modified. |
Description | Summarizes the purpose and details of the DataTemplate. |
When setting properties for an array element or a DataTemplate member (like StartValue, Min, or Max), these values won’t show up in the DataTable inside the Designer. Instead, you can find them in the Dialog TagProperties or during Runtime.
Also, keep in mind that changing a property for one element won’t update the rest. Each item in the Template or Array works independently, so modifications won’t apply across all instances automatically.
In this section: