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 UDTs)</h1>
</div> |
Introduction to the Unified Namespace
The Unified Namespace is a powerful concept in industrial automation and data management systems that 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.
By understanding the fundamentals of the Unified Namespace, you will be able to design and implement more efficient and scalable systems, reducing the complexity and effort required to manage and maintain your data infrastructure.
On this page:
Table of Contents | ||||||
---|---|---|---|---|---|---|
|
Key Concepts
The purpose of the Unified Namespace is to provide a unified and organized data framework, enhancing data understanding by providing context and empowering users to navigate and understand the information they need easily. The key data modeling concepts to organize a Unified Namespace include:
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 by creating tags based on data templates (UDTs). Additionally, the Assets 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 are Local (created within the project) 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 different ways:
- The Devices module maps tag values to field equipment like PLC registers.
- The Datasets module links tags to SQL database tables and queries.
- The Scripts module performs analytics and calculations using tags.
- The Historian module creates a time-series archive of tag values.
- The Displays module enables Operator Displays independently show values corresponding to tags, regardless of their data source.
Data Templates (UDT)
Data templates are user-defined data structures known as UDTs (User Data Types). That data structure 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 with the properties ProcessValue, Setpoint, and ControlValue.
Enumerations
Enumerations define a series of potential values or ranges of values for a variable, mapping to messages and colors in each state. When connecting with a Tag, the value of the enumeration enhances data interpretation, providing context to the different states the variable can assume.
ExternalTags Sources
Theand Terms
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 DataTemplates that match sensor readings, physical equipment, setpoints, recipes, management data, and all the variables necessary to implement and operate an application.
DataTemplate (UDT)
A user-defined data structure that includes variables and references to other templates, creating a hierarchical data structure.
TagProvider Connection
Enables direct interaction with variables in remote systems without creating specific tags, enhancing data access within the Unified Namespace.
Enumeration
Defines potential values or ranges for a variable, mapping messages and colors to each state.
Runtime Database
An 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 that match 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 TagProvider Connection
It’s important to distinguish between these two concepts:
Tag | TagProvider 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 |
Understanding the Unified Namespace
Overview
This section elucidates the concepts and functionality of the Unified Namespace, organized into the following topics:
The Unified Namespace is a concept in industrial automation and data management systems, as it streamlines data management, improves system interoperability, and simplifies the development of applications that utilize data from multiple sources.
Runtime Database
The runtime database is an in-memory real-time database that stores and manages the Unified Namespace data during the execution of a project. It provides an event-driven data exchange of the values of tags and assets between various modules, like alarms and displays. The runtime database is implemented by the TServer.exe process, which ensures efficient and reliable data management.
Assets, Folders, and Tags
As pastas permitem representar diferentes níveis da arvore de ativos, em que cada nível na hierarquia de pastas representa algum aspecto do negócio. Assim, a Arvore de ativos de forma sistemática e h
The UNS consists of a systematic and hierarchical semantically oriented representation. It is possible thought by folders, which are used to create a hierarchical organization of your tags and assets in the Unified Namespace. This makes it easier for users to navigate and understand the data.
Folders, tags, and assets are the key components of the Unified Namespace that help organize and structure your data.
Folders: They are used to create a hierarchical organization of your tags and assets in the Unified Namespace. This makes it easier for users to navigate and understand the data.
Tags: Also known as real-time variables, tags represent real-time data in the Unified Namespace. They are accessible for read, write, and subscription by various modules such as Devices, Datasets, Scripts, and Historian.
Assets: Assets represent physical equipment in the production environment and are related to a group of tags that reflect the real-time state of that equipment. Assets are defined in the data model by creating tags based on templates, which provide a common definition for a set of variables.
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 Eg.: | 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 Eg.: |
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,
Configuring the Unified Namespace
Configuration Workflow
The e User Interface to build your models is in the Project Designer tools, under the section Tags - 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 Project, there already 2 folders pre-defined in the model.
- The "Root Tags" folder is where all new Tags are created by default.
- The "External Tags Source" folder is where all new External Tags Source 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 Tags Source features.
Typically many of the values of Tags will be read from physical Devices, like PLC's or field devices Asset Displays or used in Scripts and other modules, but that configuration is executed in those other modules, not in the data model.
One great advantage in working with Unified Namespace is exactly being agnostic on the various data sources that can be concurrently consuming or publishing values to your model.
Creating Tags and Folders
To create tags and folders in the Unified Namespace, follow these simple steps:
- Go to Unified Namespace → Tags.
(Note: This explanation covers creating tags and folders using the top toolbar within the Asset Tree page. For more detailed editing options using tables, refer to the Editing Tag Objects)
- To create a folder, select the root icon in the Asset tree, and click the 'New Folder' icon on the toolbar. (Don't worry about images for now.)
- To create tags, select the folder where you want the tag to be created and click 'Create New Tag.'
Note: If you don't specify a folder, the new tag will be placed in the 'Root Tags' section of the tree.
For more information on creating and using tags, visit the Editing Tag Objects.
Info |
---|
The maximum number of tags that can be included in a project, based on the Product Model of the license, follows the formula below: (ProductModel * 20) + 5000 = maximum number of tags allowed in the project |
Defining Templates and Enumerations
Templates and enumerations provide a way to create reusable data structures and define sets of possible values for variables. This subsection will cover the process of defining templates (User-Defined Types or UDTs) and enumerations, as well as how to implement them in your project.
To create and set up a new Data Template, navigate to Unified Namespace → Data Templates. Then, click 'New' on the Grid toolbar to open the 'Create New Tag Template' pop-up window. Enter the name of the Data Template and click 'Ok' to create a new tag template. Following this, add the properties of the template's members.
Templates are 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. To use a template in your project, simply create a new tag and select the appropriate template type, and the tag will inherit the defined attributes from the template. Go to Using Data Templates for more information on Defining Templates.solution, the Asset Tree includes a built-in “RootTags” folder for all root-level tags, improving visualization for large tag sets.
Typical configuration process:
- Creating DataTemplates: Define reusable tag data structures.
- Creating Tags and AssetFolders: Organizing your data.
- 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 or right-click menu from the Root or parent node.
- Create new Tags: Select a folder and use the New Tag toolbar button or right-click menu.
- Move Tags: Drag tags to the desired folder.
- Create TagProviders: Use the toolbar icon New TagProvider 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 icon.
→ Read more about Asset Tree.
Defining DataTemplates
DataTemplates 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 DataTemplates.
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.
Defining 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 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’.
- 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:
- Select or create an AssetFolder.
- 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.
Managing Tag Objects
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 Tag Objects within the Unified Namespace: 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: Editing Tag Objects.
Adding External Tags Sources
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. External Tags Sources facilitate the integration of data from external sources into the Unified Namespace.
To add and configure external tags sources to connect with external data sources, such as OPC UA servers or databases, as well as setting up connections, browsing external data sources, and linking external tags to the Unified Namespace, visit: External Tags Sources
Working with the Unified Namespace
ModuleRuntime Execution Execution
When you start the execution of your projectsolution execution starts, the Unified Namespace definition in is loaded into a an in-memory Real-Time Database. The .NET process in the computer implementing that is named TServer.exe
Executable Process, ports, Diagram, data flow
During the execution the Realtime Database, or just called Runtime, provides an real-time database, implemented by the TServer.exe process. This real-time database enables event-driven data exchange of the values of Tags and Assets tag and asset values between various modules, like Alarms and Displays.
The chapter Execute has detailed information on how to start and stop the execution of the project.
The chapter Runtime Environment has detailed information on all aspects and process in place when running the solution.
Monitoring your Data
You can monitor your data using the Monitor Page, Diagnostics Tools, and Tag Browsing on the Toolbar, in addition to the Displays.
(mention to Monitor Page, Diagnostics Tools, Tag Browsing on Toolbar). In addition of the Displays, of Course.
Custom Displays with the Assets Tree
Asset-based displays provide an efficient and organized way to visualize and interact with your data in the context of the Unified Namespace. By leveraging the hierarchical structure of Assets and the metadata associated with them, you can create more intuitive and informative displays for operators and engineers.
In the Asset Displays tutorial, you will learn how to create custom displays that take advantage of the Asset tree structure, allowing for seamless navigation and contextual data visualization. This tutorial will guide you through the process of designing and implementing Asset-based displays, incorporating data from various sources, and using built-in components to enhance the user experience.
A Tutorial on Asset Displays is available, which offers an explanation about Asset viewer.
Accessing Assets on Scripts and Expressions
Integration with Other Modules
such as alarms and displays.
Accessing Assets in Scripts and Expressions
Modules like Alarms and Displays can The various modules, like Alarms, Displays can easily access any variable from the Unified Namespace just but using its full name or path. For example, you can show the temperature of a machine1 in bar-graph or text output in an operator Display, just selecting Tag.Line.Machine1.Temperature
, or the name and path you assigned the that variable in when defining your data model.
The information on the Unified Namespace is also accessible to other application, using the built-in MQTT broker, or its native ability to act as OPC Server. For detailed information, please refer to the corresponding sections within the document and on the pages OPC Server and Client Tools and MQTT Tools.
Third-party applications can also access that data using Integration APIs.
RemoteAssets methods
to access a tag when creating an operator display, use “Tag” to access available tags. A property called “Temperature” from a template tag named “Machine1” would have the full path: Tag.Machine1.Temperature
.
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 | ||||
---|---|---|---|---|
|
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
Table of Contents | ||||||
---|---|---|---|---|---|---|
|
Troubleshooting and Common #Issues
Some common issues that may arisewhile working with the Unified Namespace include:
#Inconsistency or missing data from external systems:
Crash when using recursive data model
Make sure you're not using recursive Data Models - for example, a template which contains another template that contains another template etc. This may cause the system to overload and crash.
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
#Performance issues
<<Screens about target projects, talks about drivers, talk about displays >> but always pointing to other module when makes sense, and describing here in this chapter what you can correct in the configuration this section of the product only.
Optimize the organization of tags, assets, and templates to reduce unnecessary data overhead and improve system performance. << Need to evolve this >>
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, using folders and templates, to make it easier for users to find and understand the information they need.
- Plan your data structure carefully, considering the relationships between assets, tags, and templates.
- Leverage templates to create reusable data structures, reducing redundancy and streamlining data management.
- Organize tags and assets hierarchically, making it easier for users to navigate and understand the data.
- Use External Tags Sources to integrate external data sources, ensuring a seamless exchange of information between systems.
#Status Monitoring
Add your project, specific Displays and Scripts to regularly monitor and report the system performance, and connection status with the external data sources.
Implement Alarm conditions when critical connections are lost.
- and compatible data types.
In this section:
Unified Namespace Runtime Attributes
The Tag has attributes and methods that can be used in .NET scripts, and other system modules.
Info |
---|
For general information and concepts on objects namespaces and attributes, go to the section Objects and Attributes. |
This section describes only some commonly used properties.
Data Quality field, according OPC standards:
0: bad quality
64: undefined quality
192: good quality
Date and time of the last change on the tag value
Page Tree | ||||
---|---|---|---|---|
|