| 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 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:
| Table of Contents | ||||||
|---|---|---|---|---|---|---|
|
Key Concepts and Terms
| Panel | ||
|---|---|---|
| ||
Asset TreeA 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. |
| Panel | ||
|---|---|---|
| ||
Data Template (UDT)User-defined data structure that includes variables and references to other templates, creating a hierarchical data structure. |
| Panel | ||
|---|---|---|
| ||
External TagProviderEnable direct interaction with variables in remote systems without creating specific tags, enhancing data access within the Unified Namespace. |
| Panel | ||
|---|---|---|
| ||
TagProcess variable representing real-time and historical data, created locally or accessed remotely. |
| Panel | ||
|---|---|---|
| ||
EnumerationDefine potential values or ranges for a variable, mapping messages and colors to each state. |
| Panel | ||
|---|---|---|
| ||
Runtime DatabaseIn-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:
| Tag | External 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’s 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 includes a built-in “Base Tags” folder for all root-level tags, improving visualization for large tag sets.
Typical configuration process:
- Creating Data Templates: Define reusable tag data structures.
- Creating Tags and AssetFolders: Organizing your data.
- Creating TagProviders: Add links to folders for external data.
Editing the Assets Tree
- Create a new folder: Organize and group assets using the new Asset Folder icon or right-click menu.
- 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, right-click menu, or File > New > TagProvider Connection.
- Link Remote Data: Right-click a folder and use Add Link to TagProvider to include external data.
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 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.
Defining Enumerations
Enumerations are sets of named integer values representing discrete options or states, improving code readability and reducing errors. For example, a pump’s states like “Off”, “On”, and “Fault” with values 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’.
- Add properties to the enumeration set, such as ‘On’ and ‘Off’ with default values.
→ Read more about Enumerations.
Using External TagProviders
To incorporate data from TagProviders into the Asset Tree:
- Select or create an AssetFolder.
- Right-click the folder and execute the command “Insert Link to TagProvider”.
The Unified Namespace → External TagProviders page allows reviewing the list of defined TagProviders or browsing external data contents.
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 (Solution Execution)."
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 from “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)
You can also access values using the Asset() method syntax. For, example 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"UnregisterAllAssets: Removes all RemoteAssets from the registered list.
@Client.UnregisterAllAssets()
| Anchor | ||||
|---|---|---|---|---|
|
Best Practices and Recommendations
To get maximize the most out benefits of the Unified Namespace, follow these best practices:
Organization of the
data structureData 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 Seamlessly integrate external data sources seamlessly using ExternalTags SourcesExternal 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 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:Missing Data from External Systems:
Ensure the external application maintains the Unified Namespace, including variable names and structure.
Refer to the UNS External TagProviders section for diagnosing connections.
For device communication drivers, the tag name will always show properly 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 diagnosis information.
This applies to any external data source, like remote SQL databases or custom scripting using external APIs.
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:
| Page Tree | ||||
|---|---|---|---|---|
|