Unified Namespace and Tags

Purpose and 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 systematic and hierarchical representation semantically oriented 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

In the context of this platform, the term "tag" refer to real-time variables and their associated historical data. Tags are accessible for read, write and subscription by the various Modules. For example, the Devices Module can map the value of the Tag with field equipments , such as PLC registers; or the Datasets Module can connect tags with SQL databases tables and queries;  or the Scripts Module can perform calculation and analytics with the tags. The Historian Module allows you have a time-series archive of the Tag Values. The graphical Operator Displays shows values mapping to the Tags, independently of the data source for its value. The Tags can be created in the FactoryStudio project (Local Tags) or you can use remote tags, which definitions  are dynamically accessed using the LinkedTags Sources connectivity. Tag Attributes are are additional pieces of information or metadata automatically presenting when creating tags. Examples of attribute includes the Tag's last update time, quality status, and its description.

Data Templates (UDT)

Data templates are user defined data structures, also known as UDTs (User Data Types). That data structure can variables of any type, as well include reference to other templates, creating an hierarchical data structure. When creating Tags based on Templates, each variable is the template is referred as a Property. An example of 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.

LinkedTags Sources

The LinkedTag Sources enable direct interaction with variables in remote systems, bypassing the need to create specific tags in the project. It establishes connections with tags sources which can be set up in a table or directly in the assets, enhancing the versatility of data access and exploration in the Unified Namespace.

Understanding the Unified Namespace 

Overview

Real-time Database, Event-driven data exchange

FrameworX applications are organized around the real-time data Unified Namespace. The functional Modules, such as Alarms, Scripts, or Graphical Displays, runs independently using the centralized Data Model to exchange the real-time information, using event-driven data exchange.This architecture allows a modular configuration and scalability. 

This section elucidates the concepts and functionality of the Unified Namespace, organized into the following topics:

• Runtime Database
• Folders, Tags, Assets

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 in the FactoryStudio by the TServer.exe process, which ensures efficient and reliable data management.

Folders, Tags, Assets

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.

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 "Tag Providers" foder is where all new TagProvider 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 TagProvider features. 

Typically many of the values of Tags will be read from physical Devices, like PLC's or field devices Tutorial: Asset Displays<<Add link to modulus tutotial that shall be include in Devices module(esse link está correto?)>> , 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 Tags → Unified Namespace.

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

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

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.

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.

Go to Using Data Templates for more information on Defining Templates and Enumerations.

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 TagProviders

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 TagProviders facilitate the integration of data from external sources into the Unified Namespace.

To add and configure external TagProviders 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: Tag Providers

Working with the Unified Namespace Module 

Runtime Execution 

When you start the execution of your project, the Unified Namespace definition in loaded into a in memory Real-Time Database. The .NET process in the computer implementing that in FactoryStudio is named TServer.exe

Executable Process, ports, Diagram, data flow

During the execution the Realtime Database, or just called Runtime, provides an event-driven data exchange of the values of Tags and Assets 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, Diagostics 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 FactoryStudio's built-in components to enhance the user experience.

A Tutorial on Asset Displays is available, which offers an explanation about Asset viewer.

<< Add link to child page with expiation about Asset viewr

Accessing Assets on Scripts and Expressions

Integration with Other Modules

The various modules,  like Alarms, Displays can easily access any variable from the Unified Namespace just but its full name or path. 

For example, you can show the temperature of a machine1 in bargraph 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 FrameworX bulit-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.

Asset( ) methods

The ASSET() methods are used to access asset elements within the CodeBehind by navigating through the Tag Namespace. This provides a way to interact with the asset hierarchy and retrieve or manipulate data associated with the assets. Additionally, the elements within the Asset Display can be accessed using the syntax ASSET("? CompleteAssetName ?") in either a TextBox element or in the CodeBehind.

<<image>>

During runtime, the Asset Tree and its components will resemble the provided images, allowing users to visualize the structure and interact with the assets. The I/O element mapped using the ASSET(" CompleteAssetName ") syntax will be resolved in a similar manner to the TK. GetObjectValue function, displaying the current value of the specific tag it is mapped to. As users interact with the elements, the SelectedAsset and SelectedLevel tags will also be updated according to the currently selected element, providing additional context and functionality.

(Confirmar se o Asset( ) methods está correto).

Troubleshooting and Best Practices

Troubleshooting and Common #Issues

Some common issues that may arise while working with the Unified Namespace include:

#Inconsistency or missing data from external systems:

When using TagProviders, FactoryStudio ins dependent on the external application to provide and maintain that section of the Unified Namespace, including the variables names and its structure. Refer the TagProvider section of the manual on how to diagnose connections with external systems. 

When mapping Tags to Device Communication drivers, the Tag Definition is the FactoryProject, so the Tag name will always show property in the Unified Namespace, but its value in depending on the connection with the remote device. Rfer the Devices 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 that the import files (Excel, CSV, or any other supported format) are properly formatted and follow the guidelines mentioned in the documentation. Check if the required columns are present, and verify that the data types and values are compatible with the destination tables.

#Performance issues

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

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.

In this section...