| 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 and Tags</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, improves system interoperability, and simplifies the development of applications that utilize data from multiple sources.
On this page:
| Table of Contents | ||||||
|---|---|---|---|---|---|---|
|
Key Concepts and Terms
| Info | ||||
|---|---|---|---|---|
| ||||
Asset Tree - A hierarchical representation of the physical equipment in the production environment. Tag - Represent real-time data variables that modules can read, write or subscribe to. |
| Panel | ||
|---|---|---|
| ||
Asset TreeThe 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 (UDT's). Additionally, the Asset Tree folders support categorizing and organizing tags and assets within the Unified Namespace, facilitating easier navigation and data comprehension. |
| Panel | ||
|---|---|---|
| ||
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. |
| Panel | ||
|---|---|---|
| ||
External TagProvidersExternal 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. |
| Panel | ||
|---|---|---|
| ||
TagsA 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:
|
| Panel | ||
|---|---|---|
| ||
EnumerationsEnumerations 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 | ||
|---|---|---|
| ||
Runtime DatabaseThe runtime database is an in-memory real-time database that stores and manages 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. |
Understanding the Unified Namespace
Module Highlights
Real-time Elements: The system has a built-in real- time, event driven, in-memory database, that manages the tags, assets and events in the application.
Real-time Tag Types: A typical HMI-SCADA system has only basic tag types, such as numeric and messages. As the system also targets IT and MES systems, it goes far beyond, supporting real- time entities that match all the SQL types and many .NET Framework entities, including Images and a complete DataTable in a single real-time tag.
Dynamic Arrays and References: The system offers built-in support for tri-dimensional dynamic arrays, lists and type-safe reference tags with dynamic assignments, creating reusable components on displays, symbols, reports, calculation and at any part of your solution.
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:
Creating Data Templates for Assets
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 discrete options or states. They can help improve 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 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' pop-up window. Enter the name of the Enumeration and click 'Ok' to create a new one. Following this, add the properties of the Enumeration set. You can add On and Off options, set the default value to each one, for example, '1' for 'On' and '0' for 'Off', and customize any enumeration properties, such as ActiveColor and InactiveColor, and several other available properties.
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:
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
- Create data templates for assets.
- Create and organize tags and folders. Optionally, use dynamic tag definitions from external data sources using the External TagProviders features.
- 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.
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. 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, 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 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.
Troubleshooting and Best Practices
Some common issues that may arise 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 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.
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:
| Page Tree | ||||
|---|---|---|---|---|
|