Versions Compared

Key

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


HTML
<style>
.text-span-6 {
    background-image: linear-gradient(99deg, rgba(170, 163, 239, .5), rgba(125, 203, 207, .5));
    border-radius: 50px;
    padding-left: 15px;
    padding-right: 15px;
}

#title-text {
display: none;
}

.panelgradient {
    background-image: linear-gradient(180deg, #d5def0, whitesmoke);
    border-radius: 8px;
    flex-direction: column;
    justify-content: center;
    align-items: center;
    padding: 4rem;
    display: flex;
    position: relative;
}

</style>


<div class ="panelgradient">

<h1 style="text-align: center;">Unified Namespace <br> (Tags and UDT'sUDTs)</h1>

</div>



Introduction to the Unified Namespace

Image Added

The Unified Namespace provides a centralized data repository and a standardized method for organizing and accessing data from various sources. This concept streamlines data management, improves enhances system interoperability, and simplifies the development of applications that utilize data from multiple sources.

Image Added

On this page:

Table of Contents
maxLevel3
minLevel2
stylenone


Key Concepts and Terms

Tag

A process variable representing real-time and historical data, created locally or accessed remotely.

PanelbgColor#ffffff

Asset Tree

The Asset Tree is a

A hierarchical representation of the

physical equipment in the production environment. It leverages a group of tags that effectively capture and reflect the real-time state of the equipment. This organized structure enhances data modeling and provides context for tags by establishing a common definition for a set of variables through data templates (UDT's). Additionally, the Asset Tree folders support categorizing and organizing tags and assets within the Unified Namespace, facilitating easier navigation and data comprehension.

solution data, containing variables and data templates that match sensor readings, physical equipment, setpoints, recipes, management data, and all the variables necessary to implement and operate an application.

Data Template (UDT)

A user-defined data structure that includes variables

Panel
bgColor#ffffff

Data Templates (UDT)

Data templates, or UDT's (User Data Types), are user-defined data structures that can include variables of any type

and references to other templates, creating a hierarchical data structure

. When creating tags based on templates, each variable in the template is referred to as a property. An example of a data template is a simple PID information template with properties such as ProcessValue, Setpoint, and ControlValue.

.

TagProvider Connection

Enables

Panel
bgColor#ffffff

External TagProviders

External TagProviders enable

direct interaction with variables in remote systems

, bypassing the need to create specific tags in the solution. They establish connections with tag sources, which can be set up in a table or directly in the assets, enhancing the versatility of data access and exploration

without creating specific tags, enhancing data access within the Unified Namespace.

Panel
bgColor#ffffff

Tags

A tag represents real-time and historical data variables that modules can read, write, and subscribe to. Tags can be created locally within the solution or remotly accessed via ExternalTags Sources connectivity. Additional metadata, known as tag attributes (e.g., last update time, quality status, description), are automatically generated when creating a tag.  

Enumeration

Defines

  • Devices Module: Maps tag values to field equipment like PLC registers.
  • Datasets Module: Links tags to SQL database tables and queries.
  • Scripts Module: Performs analytics and calculations using tags.
  • Historian Module: Creates a time-series archive of tag values.
  • Displays Module: Enables operator displays to independently show values corresponding to tags, regardless of their data source.
Panel
bgColor#ffffff

Enumerations

Enumerations define a series of

potential values or ranges for a variable, mapping messages and colors to each state

. When connected to a tag, the enumeration value enhances data interpretation, providing context to the different states the variable can assume

.

Panel
bgColor#ffffff

Runtime Database

The runtime database is an

An in-memory real-time database

that stores and manages

for Unified Namespace data

during the execution of a solution. It provides an event-driven data exchange of the values of tags and assets between various modules, such as alarms and displays. The runtime database is implemented by the TServer.exe process

, ensuring efficient

and reliable

data management during solution execution.


Understanding the Unified Namespace 

Module

Highlights

Features

  • Real-time Elements: The system has The system includes a built-in, real-time, event-driven, in-memory database , that manages the tags, assets, and events in within the application. 

  • Real-time Tag Types: A Unlike typical HMI-SCADA system has only systems with basic tag types, such as numeric and messages. As the system also targets IT and MES systems, it goes far beyond, supporting this platform supports advanced real-time entities that match all the SQL types and many .NET Framework entities, including Images JSON objects and a complete DataTable DataTables in a single real-time tag.  

  • Dynamic Arrays and References: The system offers built-in support for supports tri-dimensional dynamic arrays, lists, and type-safe reference tags with dynamic assignments, creating reusable components on for displays, symbols, reports, calculation and at any part of your solution.  , calculations, and other solution parts.

Tags vs TagProvider Connection

It’s important to distinguish between these two concepts:


TagTagProvider Connection
Definition

Tags represent real-time and historical data variables that modules can read, write, and subscribe to.

TagProvider Connections enable direct interaction with variables in remote systems, bypassing the need to create specific tags within the solution.

Creation

Tags are created locally within the solution. If you want to map the value of the Tag with remote system, the Module Device handles that Configuration. 

Connection settings are defined in the solution, while the data, tag names, and structures are defined in the remote system, like OPC-UA Servers, MQTT Broker or Historian system.

Usage

Tags are central to the solution configuration and when used by various modules (Datasets, Scripts, Historian, Displays) and they be accessed either path its AssetPath and the Asset() methods, or directly by its TagName. 

Eg.:  Tag.Area1/LIne1/State  or Asset("Area1/LIne1/State")

TagProvider Connections are linked to folders within the Unified Namespace, which are dynamically populated according the contents of the remote System. The Modules access the values exclusively by its AssetPath and the Asset() method.  

Eg.: Asset("/Area1/Line1/State")


The decision to create Tags and the Devices Module to map its data, or to use TagProvider Connections, is discussed at the page Devices Module and TagProviders.

The key concept is that there are two very distinct ways to interface with external data, each with its own limitations and benefits. According to your requirements, one approach or the other will clearly be the best way to set up. For various solutions, it is likely that your Unified Namespace will have some data in local tags, mapped to devices, and some data dynamically driven by remote systems using the TagProvider Connection.

See more about TagProvider Connections


Configuring the Unified Namespace

Configuration Workflow

The Unified Namespace’s Asset Tree is where you build your data definitions. From this central

Configuring the Unified Namespace 

Configuration Workflow

The Solution Designer is interface where you can build your models.  This is found in the Unified Namespace.

From this centra point, you can create or import Tag definitiontags, organize the hierarchy, and monitor the current values of your variables. 

When you start a new Solution, two folders will be generated.

  • The "BaseTags" folder is where all new Tags are created by default.

  • The "ExternalTags" folder is where all new External TagProviders connections are added by default. 

The typical process on creating the model is:

  1. Creating Data Templates for Assets

  2. Creating and Organizing Tags and Folders. You can also use dynamic Tag definition from external data sources using the External TagProviders features. 

Values of Tags will be read from physical Devices, like PLC's or field devices, or used in Displays, Scripts and other modules. But those configurations are executed in each module and not in the data model.

Data Templates

Data Templates provide a way to create custom data structures that allow you to define reusable Tag configurations. They can be used to create hierarchical structures representing assets or information models.  They can also streamline data management and improve system efficiency. For example, a template could be created for a specific type of equipment, with tags for its operational parameters and status information. 

→ Read more about Data Templates.

Configuring the Asset Tree

  • Create a new folder: Folders allow you to organize, group and create hierarchies for your assets. Click the new Asset Folder icon to create one or right click the Asset Tree.
  • Create new Tags: After selecting a folder, use the New Tag toolbar button or right-click menu, to create a new tag inside that folder.
  • Move Tags to selected folders: Just drag tags from the BaseTags folder — or other location — to the desired placement level at the tree.
  • Insert Remote Assets: If there is a ExternalTags connection defined, you can insert specific assets from the external system in the asset tree.

→ Read more about Assets Tree.

*The maximum number of tags is different based on product license. To determine max tags, follow this formula --> 
(ProductModel * 20) + 5000 = maximum number of tags allowed in the solution.

Tags

Tag Objects represent real-time variables and their associated historical data within the Unified Namespace, managing and editing these objects ensures seamless integration with other modules and systems.

Managing Tags Allows You To:

solution, the Asset Tree includes a built-in “RootTags” folder for all root-level tags, improving visualization for large tag sets.

Typical configuration process:

  1. Creating Data Templates: Define reusable tag data structures.
  2. Creating Tags and AssetFolders: Organizing your data.
  3. Creating TagProviders: Add links to folders for external data.

Editing the AssetTree

  • Create a new folder: Organize and group assets using the new Asset Folder icon Image Added or right-click menu from the Root or parent node.
  • Create new Tags: Select a folder and use the New Tag toolbar Image Added button or right-click menu.
  • Move Tags: Drag tags to the desired folder.
  • Create TagProviders: Use the toolbar icon New TagProvider Image Added or the menu command File > New > TagProvider Connection.
  • Link Remote Data: Right-click a folder and use the context menu command  "Link Data from TagProvider", or use the toolbar iconImage Added.

Read more about Asset Tree.

Defining Data Templates

Data Templates allow you to create custom data structures for reusable tag configurations, streamlining data management and improving system efficiency by defining hierarchical structures that represent assets or information models.

Read more about Data Templates.

Defining Tags

The page Unified Namespace → Tags allows you to:

  • Create, modify, and delete tag objects.

  • Use built-in tools for search and filtering.

  • Bulk-edit.

  • Create, Modify and Delete Tag Objects. 
  • Import and Export Tag Objects
  • Use Built-In Tools for Search and Filtering
  • Bulk-Edit

→ Read more about Tags.

Defining Enumerations

Enumerations are sets of named integer values used to represent representing discrete options or states. By assigning meaningful names to integer values, you will improve , improving code readability and reduce reducing errors.   An example of this is a set of named states for a pump, such as "Off", "On", and "Fault", with corresponding integer values of For example, a pump’s states like “Off”, “On”, and “Fault” with values 0, 1, and 2.

To Create Enumerations

  1. Go
To 
  1. to Unified Namespace → Enumeration.
  2. Click
'New'
  1. ‘New’ on the
Grid Toolbar
  1. grid toolbar.
  2. Open the
'Create
  1. ‘Create New
Enumeration'
  1. Enumeration’ pop-up window.
  2. Enter the
Name
  1. name of the
Enumeration and Click 'Ok' to Create a New One
  1. enumeration and click ‘OK’.
  2. Add
the Properties of the Enumeration Set.
  • Add On and Off options
  • Set Default Value to Each
  • *for example, '1' for 'On' and '0' for 'Off', and customize any enumeration properties
    1. properties to the enumeration set, such as
    ActiveColor and InactiveColor, and several other available properties
    1. ‘On’ and ‘Off’ with default values.

    Read more about Enumerations.

    External TagProviders

    The External TagProviders is a tool that allows you to access Data Models definitions from external systems.  You can also access those variables and structures in any module directly, without having to create any local definition of Tags inside your solution.

    This feature is available for:

    Using TagProvider Connections

    To incorporate data from TagProviders into the Asset Tree:

    1. Select or create an AssetFolder.
    2. Right-click the folder and execute the command “Link Data from TagProvider”.

    The Unified Namespace → TagProvider Connections  page allows reviewing the list of defined TagProviders or browsing external data contents.

    → Read more about → Read more about External TagProviders.


    Working with the Unified Namespace

    Runtime Execution

    When the solution execution starts, the Unified Namespace definition is loaded into an in-memory real-time database, implemented by the TServer.exe process. During execution, the This real-time database provides enables event-driven data exchange of tag and asset values between various modules, like such as alarms and displays. → "Runtime (Startup)."

    Accessing Assets in Scripts and Expressions

    The platform's various modules, Modules like Alarms and Displays , can access any variable from the Unified Namespace using its full name or path. For example, to access a tag when creating an operator display, use "Tag" “Tag” to access available tags. A tag property called Temperature “Temperature” from a data template tag named Machine 1 “Machine1” would have the full path: Tag.Line.Machine1.Temperature 

    This information is also accessible to other applications using the built-in MQTT broker or its native ability to act as an OPC Server.

    RemoteAssets Methods

    RemoteAssets methods allow interaction with assets remotely. They provide functions to map and unmap entire assets.  They also refresh readings of the registered elements:

    RegisterElementToTag: Maps an entire RemoteAsset to a tag, requiring a template with the same structure as the asset.
    @Client.RegisterElementToTag(string assetName, string tagName, [bool readOnly=false])

    RefreshRemoteTags: Performs a new reading on the registered elements.
    @Client.RefreshRemoteTags()

    UnregisterElementToTag: Removes the RemoteAsset from the registered list.
    @Client.UnregisterElementToTag(string assetName)

    UnregisterAllAssets: Removes all RemoteAssets from the registered list.
    @Client.UnregisterAllAssets()

    Advanced Unified Namespace Topics

    Runtime Attributes

    The Tag has attributes and methods that can be used in .NET scripts, and other system modules. The Unified Namespace Runtime Attributes page lists all options available.

    .

    You can also access values using the Asset() method syntax. For example, if you place the tag defined in the previous example inside a folder called Line1, the path for that value would be:

    Asset("/Line1/Machine1.Temperature")


    Anchor
    BestPractices
    BestPractices
    Best Practices and Troubleshooting

    Best Practices and Recommendations

    To maximize the benefits of the Unified Namespace, follow these best practices:

    Organization of the Data Structure

    • Organize tags into a clear hierarchy with folders and templates for easier navigation and understanding.
    • Plan data structures carefully, considering the relationships between assets, tags, and templates.
    • Use templates for reusable data structures, reducing redundancy.
    • Seamlessly integrate external data sources using TagProviders.
    • Use consistent naming conventions for tags to simplify navigation and troubleshooting.

    Status Monitoring 

    • Add specific displays and scripts to regularly monitor system performance and connection status.
    • Implement alarm conditions for critical connection losses.

    Common Issues and Solutions

    Troubleshooting and Best Practices

    Some common issues while working with the Unified Namespace include:

    Inconsistency or

    missing data from external systems:

    Missing Data from External Systems:

    • Ensure that
    When using ExternalTags Sources, ensure
    • the external application
    provides and
    • maintains the Unified Namespace, including variable names and structure.
    • Refer to the UNS
    - External
    • TagProviders Connections section for diagnosing
    connections
    • connection issues.
    When mapping Tags to Device Communication
    • For device communication drivers, the
    Tag Definition is the Solution, so the Tag
    • tag name will always
    show property
    • display correctly in the Unified Namespace, but its value
    in depending
    • depends on the connection with the remote device.
    • Refer to the Devices (Field Communication) section
    on
    • in the documentation for
    information on
    • setup and
    diagnose connections with field devices. 
    • diagnostic information.
    • This
    concept
    • applies to any external data source
    being used by the system, like
    • , such as remote SQL
    database
    • databases or custom scripting using external APIs.

    Inconsistency or

    missing data after importing

    Missing Data After Importing:

    • Ensure that import files (Excel, CSV,
    or other formats
    • etc.) are properly formatted
    ,
    • with the required columns
    present,
    • and compatible data types
    and values
    • .

    In this section:

    Page Tree
    root@self
    spacesV10

    Performance issues

    Here are some key areas to review when improving performance: 

    • Target Solution: Structure and organize solutions efficiently to improve performance.
    • Driver Communication: Use the Monitor Page and Runtime - Diagnostics to monitor driver communication.
    • Displays: Avoid overloading displays with excessive information.
    • Optimization and Grouping: Use only necessary tags, group them logically, and reuse assets when possible.
    • Modular Templates: Design modular templates to reduce redundancy and streamline management.

    Best Practices

    To get the most out of the Unified Namespace, follow these best practices:

    Organization of the data structure

    • Organize tags into a clear hierarchy with folders and templates for easier navigation and understanding.
    • Plan data structures carefully, considering relationships between assets, tags, and templates.
    • Use templates for reusable data structures, reducing redundancy.
    • Integrate external data sources seamlessly using ExternalTags Sources.
    • Use consistent naming conventions for tags to simplify navigation and troubleshooting.

    Status Monitoring 

    • Add specific displays and scripts to monitor system performance and connection status regularly.
    • Implement alarm conditions for critical connection losses.

    What's Next?