Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

Data Templates play a crucial role in FactoryStudio projects by facilitating the creation of tags with predefined attributes and organizing them into hierarchical structures that represent assets or information models. Utilizing Data Templates enables users to access tag attributes effortlessly and manage their data with increased efficiency. To employ a Data Template in a project, users need to 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 required throughout the project.

This document serves as a comprehensive guide for understanding, configuring, and working with Data Templates in FactoryStudio projects. It aims to streamline data management, enhance system efficiency, and simplify the process of accessing tag attributes. The document will cover the following key topics: Overview, Understanding Using Data Templates, Data Templates Configuration, and Working Using Data TemplatesDataTemplates 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:

Table of Contents
maxLevel3
minLevel2
stylenone


Defining DataTemplates

To define

Understanding Using Data Templates

Data Templates are essential for creating tags with defined attributes and organizing them into hierarchical structures representing assets or information models in FactoryStudio projects. Utilizing Data Templates allows users to access tag attributes and manage their data more efficiently. This section will provide an in-depth understanding of the importance and benefits of using Data Templates in your projects.

Data Templates Configuration

Templates are the foundation for creating new tag types based on data structures, utilizing existing built-in types and previously defined templates. The process of creating a tag template is straightforward and detailed in the "Creating Templates" section.

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 Unified Namespace →

    Data Templates

    DataTemplates.

  • Click New.

  • The "Create New

    Tag Template

    DataTemplate" dialog will open.

  • In the "New Name" field, enter a name for the tag type. In the Description, enter a description of the

    tag

    template. Click OK. The Templates tab displays with the name of the new template at the top of the tab.

    Click the insertion row to

Image Added

To create a new attribute for this

tag template.Enter or select information, as needed

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

above

for more information. 

Image Added

To delete a template, select it from the User Custom Type drop-down list, then click Delete Item.

  • On the Objects tab, you can now use this new template in the Type column.
  • Assets Templates



    Using DataTemplates for custom Tag Types

    DataTemplates

    Asset Templates are a vital aspect of FactoryStudio, allowing users to create reusable data structures and logically organize tags into hierarchical representations of equipment or information models. This organization helps to enhance data management and improve overall system efficiency.

    Building Custom Data Types

    Custom Data Types, or User-Defined Types (UDTs), can be created to represent complex data structures in the Unified Namespace. These 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.

    Working Using Data Templates

    Creating and Editing Data Templates

    FactoryStudio gives users the ability to create, edit, or import Data Templates. In creating a template, it is imperative to define the relevant tag attributes such as data types, initial values, and any necessary metadata. These attributes form the foundation of your tags and shape their behavior in the system. The steps to create a Data Template are:

    1. Navigate to Unified Namespace → Data Templates.
    2. Click on 'New'. This will open the 'Create New Tag Template' dialog box.
    3. In the 'New Name' field, input a name for your tag type. Provide a concise and descriptive tag in the 'Description' field.
    4. After clicking 'OK', your new template will appear at the top of the 'Data Templates' tab.
    5. You can now add attributes to your tag template by clicking on the insertion row.

    To edit a template, select the template you wish to modify from the User Custom Type dropdown list. You can then adjust the tag attributes as required.

    Using Data Templates in Projects

    Data templates 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 Data Template DataTemplate in your project:

    1. Navigate to the 'Tags' tab and click on 'New Item' to create a new tag.

    2. 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.

    3. The tag will inherit the attributes from the chosen template.

    Image Added


    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:

    In this section...

    Page Tree
    root@parent
    spacesV10