<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 UDTs)</h1>

</div>



Introduction to the Unified Namespace

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, enhances system interoperability, and simplifies the development of applications that utilize data from multiple sources.

On this page:



Key Concepts and Terms


Asset Tree

A hierarchical representation of the solution data, containing variables and data templates matching sensor reading physical equipments, setpoints, recipes, management data, and all the variables necessary to implement and operate an application.


Data Template (UDT)

User-defined data structure that includes variables and references to other templates, creating a hierarchical data structure.


External TagProvider

Enable direct interaction with variables in remote systems without creating specific tags, enhancing data access within the Unified Namespace.


Tag

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


Enumeration

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


Runtime Database

In-memory real-time database for Unified Namespace data, ensuring efficient data management during solution execution.




Understanding the Unified Namespace 

Module Features

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

  • Real-time Tag Types: Unlike typical HMI-SCADA systems with basic tag types, this platform supports advanced real-time entities matching all SQL types and many .NET Framework entities, including JSON objects and complete DataTables in a single real-time tag.

  • Dynamic Arrays and References: The system supports tri-dimensional dynamic arrays, lists, and type-safe reference tags with dynamic assignments, creating reusable components for displays, symbols, reports, calculations, and other solution parts.

Tags vs External TagProviders

It’s important to distinguish between these two concepts:


TagExternal TagProvider
Definition

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

External TagProviders 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.

Connection settings are defined in the solution, while the data, tag names, and structures are defined in the remote system.

Usage

Tags are central to the solution configuration and are used by various modules (Devices, Datasets, Scripts, Historian, Displays).

External TagProviders facilitate the use of remote data directly within the solution, supporting protocols like OPC UA, MQTT, and various historian systems.




Configuring the Unified Namespace Configuration Workflow

The Unified Namespace → Asset Tree is where you build your data definition. From this central point, you can create or import tags, organize the hierarchy, and monitor the current values of your variables.

When you start a new Solution, the Asset Tree has a built-in folder "Base Tags" to keep all tags from the Root level (tags not associated with an AssetFolder), That allows a better visualization of your Asset Tree when there is large number of tags.

Typical configuration process:

  1. Creating Data Templates: Define reusable tag data structures.
  2. Creating Tags and AssetFolders, organizing your data.
  3. Creating TagProviders and adding links in the folders to its data.
Editing the Assets 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.
  • Create TagProviders: If using that feature, create TagProvides with toolbar icon (. ), or right click or with the menu option File / New / TagProvider Connection.
  • Insert Remote Assets: select any folder, right-click and use the context menu Add Link to TagProvider, so you can insert specific data from the external system.

→ Read more about Assets Tree.

Defining Data Templates

Data Templates allow you to create custom data structures for reusable tag configurations. They streamline data management and improve system efficiency by defining hierarchical structures representing 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

→ Read more about Tags.

Defining Enumerations

Enumerations are sets of named integer values used to represent discrete options or states. By assigning meaningful names to integer values, you will improve code readability and reduce 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 0, 1, and 2.

To Create Enumerations

  • Go To Unified Namespace → Enumeration.
  • Click 'New' on the Grid Toolbar
  • Open the 'Create New Enumeration' pop-up window.
  • Enter the Name of the Enumeration and Click 'Ok' to Create a New One.
  • 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, such as ActiveColor and InactiveColor, and several other available properties.

→ Read more about Enumerations.

Using External TagProviders 

The creation of Tag Providers, as presented, can happens with the menu File/New command or Asset Tree toolbar. 

Ir oder to incorporate data from TagProviders into the Asset Tree, just select any AssetFolder in the Tree (or create a new one if necessary), and right-click on the folder to execute the command Insert Link to TagProvider.

The page Unified Namespace → External TagProviders allows to review the list of defined TagProviders, or to browse the contents of the external data, 

→ 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 real-time database provides event-driven data exchange of tag and asset values between various modules, like alarms and displays. 

→ "Runtime (Solution Execution)."

Accessing Assets in Scripts and Expressions

The platform's various 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" to access available tags. A tag called Temperature from a data template named Machine 1 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()



Best Practices and Troubleshooting

Best Practices and Recommendations

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.


Common Issues and Solutions

Some common issues while working with the Unified Namespace include:

Inconsistency or missing data from external systems:

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 section for diagnosing connections.

When mapping Tags to Device Communication drivers, the Tag Definition is the Solution, so the Tag name will always show property in the Unified Namespace, but its value in depending on the connection with the remote device.

Refer the Devices (Field Communication) section on the documentation for information on setup and diagnose connections with field devices. 

This concept applies to any external data source being used by the system, like remote SQL database or custom scripting using external APIs.

Inconsistency or missing data after importing:

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

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.


In this section: