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
Introduction to Data Templates
Data Templates can be used in projects to create tags with the defined attributes and organize them into hierarchical structures that represent assets or information models. By using Data Templates, users can easily access tag attributes and manage their data more efficiently. To use a Data Template in a project, simply create a new tag and select the appropriate template type. The tag will then inherit the defined attributes from the template, allowing users to access and manipulate these attributes as needed throughout the project.
On this page:
| Table of Contents | ||||||
|---|---|---|---|---|---|---|
|
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. |
| Info |
|---|
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:
| Page Tree | ||
|---|---|---|
|
Using Data Templates in FactoryStudio
Data Templates in FactoryStudio help users create tags with defined attributes and organize them into hierarchical structures representing assets or information models. By using Data Templates, data management becomes more efficient, and users can easily access tag attributes.
This document is organized into the following sections and subsections:
Introduction to Data Templates
Creating Templates
Assets Templates 3.1 Building Custom Data Types
Creating and Editing Data Templates
Using Data Templates in Projects
Introduction to Data Templates
Data Templates allow users to create reusable data structures and organize tags into hierarchical, logical representations of equipment or information models. These templates help streamline data management and improve system efficiency by reducing redundancy and simplifying the process of accessing tag attributes.
- Creating Templates
Templates enable users to create new tag types based on a data structure using existing built-in types and previously defined Templates. To create a tag template, follow the steps mentioned in the "Creating Templates" section.
- Assets Templates
Asset Templates help users create reusable data structures and organize tags into hierarchical representations of equipment or information models, enhancing data management and system efficiency.
3.1 Building Custom Data Types
Custom data types, also known as User-Defined Types (UDTs), can be created to represent complex data structures in the Unified Namespace. UDTs can include multiple tag attributes, allowing users to model various properties of an asset, such as its current state, operational parameters, and historical data. Building custom data types ensures a more accurate and comprehensive representation of assets and their associated tag attributes.
- Creating and Editing Data Templates
Users can create, edit, or import Data Templates for use in their projects. When creating a template, it's essential to define the relevant tag attributes, such as data types, initial values, and any required metadata. Once a template is created, it can be edited to update tag attributes or modify the template structure as needed.
- Using Data Templates in Projects
Data Templates can be used in projects to create tags with the defined attributes and organize them into hierarchical structures representing assets or information models. To use a Data Template in a project, follow the steps mentioned in the "Using Data Templates in Projects" section. The tag will inherit the defined attributes from the template, allowing users to access and manipulate these attributes as needed throughout the project.
Child Pages for the section:
Assets Templates:
Building Custom Data Types
Creating and editing Data Templates
Using Data Templates in Projects=================================
Assets Templates: Asset Templates allow users to create reusable data structures and organize tags into hierarchical, logical representations of equipment or information models. These templates help streamline data management and improve system efficiency by reducing redundancy and simplifying the process of accessing tag attributes.
Building Custom Data Types: Custom data types, also known as User-Defined Types (UDTs), can be created to represent complex data structures in the Unified Namespace. UDTs can include multiple tag attributes, allowing users to model various properties of an asset, such as its current state, operational parameters, and historical data. Building custom data types helps ensure a more accurate and comprehensive representation of assets and their associated tag attributes.
Creating and Editing Data Templates: To create a new Data Template, navigate to the Project Designer tools and select the "Tags - Unified Namespace" section. From there, users can create, edit, or import Data Templates for use in their projects. When creating a template, it's essential to define the relevant tag attributes, such as data types, initial values, and any required metadata. Once a template is created, it can be edited to update tag attributes or modify the template structure as needed.
Assets Templates:
Building Custom Data Types
Asset templates in [Software Name] enable users to build custom data types based on a specific data structure. These custom data types use existing built-in types or previously defined templates as the foundation, allowing users to create more complex and tailored data structures suited to their project's needs.
Creating and Editing Data Templates
Users can create, edit, or import Data Templates for use in their projects. When creating a template, it's essential to define the relevant tag attributes, such as data types, initial values, and any required metadata. Once a template is created, it can be edited to update tag attributes or modify the template structure as needed.
Using Data Templates in Projects
Once a custom data type is created, it can be used in projects for organizing and managing tags. To use data templates in projects, follow these steps:
Step 1: On the Objects tab within the software, navigate to the "Type" column for the desired tag.
Step 2: From the drop-down list, select the newly created custom data type. The software will automatically apply the data structure and attributes of the custom data type to the tag.
Step 3: Continue using the custom data type for relevant tags throughout the project, ensuring consistency and efficient organization
Creating Templates
Templates allow you to create new tag types based on a data structure using existing built-in types and previously defined Templates.
To create a tag template:
- Go to Tags → Templates.
- Click New.
- The "Create New Tag Template" dialog will open.
- In the "New Type Name" field, enter a name for the tag type. In the Description, enter a description of the tag. Click OK. The Templates tab displays with the name of the new template at the top of the tab.
- Click the insertion row to create a new attribute for this tag template.
Enter or select information, as needed. The properties are the same ones for Tags. See Creating and Editing Tags above.
- To delete a template, select it from the User Custom Type drop-down list, then click Del.
- On the Objects tab, you can now use this new template in the Type column.
In this section...
| Page Tree | ||||
|---|---|---|---|---|
|