Page History

Key Concepts and Terms

Asset Tree

The Asset Tree is 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 (UDTs). Additionally, the Asset Tree folders support categorizing and organizing tags and assets within the Unified Namespace, facilitating easier navigation and data comprehension.

Tags

A tag represents real-time and historical data variables that modules can read, write, and subscribe to. Tags can be local (created within the solution) or remote (dynamically accessed via ExternalTags Sources connectivity). Additional metadata, known as tag attributes (e.g., last update time, quality status, description), are automatically generated upon tag creation. Modules utilize tags in various ways:

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

Data Templates (UDT)

Tag

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

Asset Tree

A hierarchical representation of the 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 Data templates, or UDTs (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.

Enumerations

TagProvider Connection

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

Enumeration

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

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 within the Unified Namespace.

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

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:

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

→ Read more about Tags.

Defining

Configuring the Unified Namespace 

Configuration Workflow

The User Interface to build your models can be found Solution Designer tools, under the section Unified Namespace.

From that centralized interface, you can create or import Tag definition, organize the hierarchy and monitor the current values of your variables. 

When you start a new Solution, there already two folders pre-defined in the model.

• 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. Optionally you can use dynamic Tag definition from external data sources using the External TagProviders features. 

Typically the 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.

Defining 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, streamlining data management and improving system efficiency. For example, a template could be created for a specific type of equipment, with tags for its operational parameters and status information. 

Go to Data Templates for more information.

Asset Tree

The typical action when configuration the asset tree are:

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

For more information on the Asset Tree, visit Assets Tree.

The maximum number of tags that can be included in a solution, based on the Product Model of the license, follows the formula below: (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.

To learn more about aspects of managing Tags within the Unified Namespace, including Creating Tag Objects, Modifying Tag Objects, Deleting Tag Objects, Importing/Exporting Tag Objects, and using built-in tools for searching, filtering, and bulk-editing to optimize the management process, visit: Tags.

Enumerations

Enumerations are sets of named integer values used to represent representing discrete options or states. They can help improve , improving code readability and reduce errors by assigning meaningful names to integer values. An example of an enumeration could be a set of named states for a pump, such as "Off", "On", and "Fault", with corresponding integer values of reducing errors. For example, a pump’s states like “Off”, “On”, and “Fault” with values 0, 1, and 2.

To create and set up a new Enumeration, navigate to Unified Namespace → Enumeration. Then, click 'New' on the Grid toolbar to open the 'Create New Enumeration' Create Enumerations

1. Go to Unified Namespace / Enumeration.
2. Click ‘New’ on the grid toolbar.
3. Open the ‘Create New Enumeration’ pop-up window.
4. Enter the name of the

1. enumeration and click

Visit Enumerations for more information.

External TagProviders

The External TagProviders is a tool that allows you to access Data Models definitions from external systems, using 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:

• InfluxDB

• MQTT SparkPlugB

• AB Rockwell - ControlLogix/CompactLogix Devices

• OPC UA 

• CanaryLabs

• Server to Server communication

• GE Proficy Historian

• SQLDatabase

For more information, visit External TagProviders.

Working with the Unified Namespace

The user interface for building models can be found in the Solution Designer tools under the Unified Namespace section. From this centralized interface, you can create or import tag definitions, organize the hierarchy, and monitor current variable values. When starting a new solution, two folders are predefined:

• BaseTags Folder: Where all new tags are created by default.
• ExternalTags Folder: Where all new External TagProviders connections are added by default.

Typical Process for Creating the Model

1. Create data templates for assets.
2. Create and organize tags and folders. Optionally, use dynamic tag definitions from external data sources using the External TagProviders features.
3. Typically, tag values are read from physical devices, like PLCs or field devices, or used in displays, scripts, and other modules. These configurations are executed in each module, not in the data model.

1. ‘OK’.
2. Add properties to the enumeration set, such as ‘On’ and ‘Off’ with default values.

→ Read more about Enumerations.

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

Working with the Unified Namespace

Runtime Execution

When

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. Detailed information on all aspects and processes during runtime can be found in the chapter "Runtime Environment."

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 and 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

Some common issues

Troubleshooting and Best Practices

Troubleshooting and Common #Issues

while working with the Unified Namespace include:

Inconsistency or

Missing Data from External Systems:

• Ensure that

• the external application

• maintains the Unified Namespace, including variable names and structure.
• Refer to the

• UNS TagProviders Connections section for diagnosing

• connection issues.

• For device communication drivers, the

• tag name will always

• display correctly in the Unified Namespace, but its value

• depends on the connection with the remote device.
• Refer to the Devices

• (Field Communication) section

• in the documentation for

• setup and

• diagnostic information.
• This

• applies to any external data source

• , such as remote SQL

• databases or custom scripting using external APIs.

Inconsistency or Missing Data After Importing:

• Ensure that import files (Excel, CSV,

• etc.) are properly formatted

• with the required columns

• and compatible data types

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

In this section: