Page History

Key Concepts

The purpose of the Unified Namespace is to provide a unified and organized data framework.

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 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 different ways:

1. The Devices module maps tag values to field equipment like PLC registers.

2. The Datasets module links tags to SQL database tables and queries.

3. The Scripts module performs analytics and calculations using tags.

4. The Historian module creates a time-series archive of tag values.

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

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

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,

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

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 Source" folder is where all new ExternalTags Source connections are added by default. 

solution, the Asset Tree includes a built-in “RootTags” folder for all root-level tags, improving visualization for large tag sets.

Typical configuration processThe typical process on creating the model is:

1. Creating Data Templates for Assets: Define reusable tag data structures.
2. Creating Tags and Organizing Tags and Folders. Optionally you can use dynamic Tag definition from external data sources using the ExternalTags Source features. 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 TreeTypically 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 allow you 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 modelsfor reusable tag configurations, 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 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. Once you've done so, your template will be available as a type when creating new tags and the tag will inherit the defined attributes from the template. 

Image Removed

Go to Data Templates for more information.

Working with the Asset Tree

To create tags and folders in the Unified Namespace, follow these simple steps:

• Go to Unified Namespace → Asset Tree.

Image Removed

• Add New Asset Folders

Image Removed

• Add New Tags

Image Removed

If you don't specify a folder, the new tag will be placed in the 'Base Tags' section of the tree.

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

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

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

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

1. Go to Unified Namespace

1. / Enumeration.

2. Click ‘New’ on the

1. grid toolbar.
2. Open the ‘Create New Enumeration’ pop-up window.
3. Enter the name of the

1. enumeration and click

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.

Visit Enumerations for more information.

Adding External Tags Sources

The ExternalTags feature (previously called TagProvider) 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 Tags Sources

Working with the Unified Namespace

Runtime Execution Execution

When you start the execution of your solutionsolution 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 Runtime Environment has detailed information on all aspects and process in place when running the solution.

such as alarms and displays.

Accessing Assets in Scripts and Expressions

Modules

The various modules of the platform, like Alarms and Displays , can easily access any variable from the Unified Namespace by using its full name or path.   For example, to access a tag when creating a an operator Displaydisplay, use "Tag." “Tag” to access the 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.

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

RemoteAssets methods provide means to interact with assets remotely. They allow you to map and unmap entire assets, and refresh readings of the registered elements. 

RegisterElementToTag: This method allows you to map an entire RemoteAsset to a Tag. It requires that you create a Template with the same structure as your 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() 

Troubleshooting and Best Practices

Troubleshooting and Common #Issues

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

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

#Performance issues

Here are some key areas to review when improving performance: 

#Target Solution

Analyze the structure and organization of your solutions. A well-organized solution with efficiently structured hierarchies can significantly improve system performance. 

#Driver Communication

Use the Monitor Page and Runtime Diagnostics to monitor the communication between the drivers and your solution.  

#Displays

Busy and information overloaded displays can hinder system performance and make the solution more difficult to navigate for the user. Ensure that your screens have only the information they need to operate. 

#Optimization and Grouping

Only use tags that are necessary for your application. Excessive and unnecessary tags can create additional overhead that can hamper performance. Group tags logically based on functionality or the device they are associated with. This not only improves readability but also enhances system efficiency. 

#Reuse Assets

Try to reuse assets where possible. If two components use the same type of asset, consider using one asset and replicating it where needed. 

#Modular Templates

Design your templates to be modular. A modular template can be used in various parts of your solution, reducing the number of unique templates you need to create and manage. 

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. Create standard templates for common tasks. This not only saves time but also ensures consistency across your solution. 

• Use ExternalTags Sources to integrate external data sources, ensuring a seamless exchange of information between systems.

• Use a consistent naming convention for your tags. It can make your solution easier to navigate and troubleshoot. 

#Status Monitoring 

• Add to your solution specific Displays and Scripts to regularly monitor and report the system performance, as well as the connection status with the external data sources. 

• Implement alarm conditions when critical connections are lost.

Unified Namespace Runtime Attributes

The Tag has attributes and methods that can be used in .NET scripts, and other system modules. 

This section describes only some commonly used properties.

Commonly used Tag Properties

Property

Type

Description

Value

Tag Type

Last Value of the Tag

Quality

Integer

Data Quality field, according OPC standards:

0: bad quality
64: undefined quality
192: good quality

Timestamp

DateTimeOffset

• and compatible data types.

In this section: