Unified Namespace and Tags

Purpose and Key Concepts

The main objective of a Unified Namespace is to consolidate relevant data into a single, coherent structure, promoting greater interoperability and data clarity. By streamlining data access, it accelerates the implementation of analytics applications, monitoring systems, and other solutions, ultimately leading to reduced maintenance efforts and improved overall performance. Additionally, the Unified Namespace enhances data context and comprehension, empowering users to easily navigate and understand the information they need.

The key data modeling concepts to organize an Unified Namespace include:

Assets Tree

(Visual Representation the Unified Namespace

Assets refer to the physical equipment in the production environment, which is related to a group of Tags representing the real-time state of that equipment.

The definition of Assets in data model is easily accomplish by creating tags based on the Templates, so they share the that common definition for a set a variables.

You can also Folders to further organize the Tags and Assets in the Unified Namespace in an hierarchical representation of your process.

Visual reprentation of the Unified Namespace

Templates, UDT

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.

Typically, the equipments on the field will have various variables for realtime monitoring. Instead of creating one Tag to each variable, it is possible to create a Template with those variables, then create one Tag with that Template type.  

When creating Tags based on Templates, each variable is the template is referred as a Property. Example of Template is a simple PID information, with the properties ProcessValue, Setpoint and ControlValue.   Template Members, 

Enumerations

(Define a series of potential values, or ranges of values for a variable, mapping to messages and colors in each states. When connecting with a Tag, the value of ....

Tag Objects

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 project FactoryStudio project (Local Tags) or you can use remote tags, which definitions  are dynamically accessed using the TagProvider 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.

TagProviders

4.5.3.Understanding the Unified Namespace 

The Unified Namespace is a crucial 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. This section will help you better understand the Unified Namespace and its components.

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.

TagProvider Links

TagProviders are connections to external data sources, such as PLCs, remote SQL databases, or custom scripting using external APIs. They are essential for integrating external data sources with the Unified Namespace, ensuring a seamless exchange of information between systems. TagProvider links allow you to dynamically access remote tag definitions and manage their connectivity.

By understanding the Unified Namespace components and their interactions, you can design and implement more efficient and scalable projects within FactoryStudio, reducing the complexity and effort required to manage and maintain your data infrastructure.

Configuring the Unified Namespace 

How the Unified Namespace Operates

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. 

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 <<Add link to modulus tutotial that shall be include in Devices module>> , 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

<< add simple way to create a tag and folder using the Top toolbar, and point for the child page for more, something like that:

Go To Tags → Unified Namespace, 

(Aqui so explicamos como criar via Toolbar n pag de Asset Tree, mas faz referencia para a paina filha com Tags Objects para edição via tabela.

In order to create folders, Select the root icon the Asset tree, and click the New Folder Icon the toolbar (nao se preocupe com images por hora)

In oder to create Tags, select the folder where you want the Tag to be created and click Crete Tag

Note: If you don't specific a folder, the new Tag will be placed on the Root Tags section of the tree.

For further information on how to create and use Tags, refer to the child page xxxxxx

Defining Templates and Enumerations

<add basic explanation and example and point to child>>. parecido com exemplo anterior
• Child page: Using Data Templates

Using Data Templates - v10 - Tatsoft LLC

Managing Tag Objects

• Child page: Editing Tag Objects

Adding External TagProviders

<add basic explanation and example and point to child>>
• Child page: TagProviders Configuration

Tag Providers - v10 - Tatsoft LLC

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

(mention to Monitor Page, Diagostics Tools, Tag Browsing on Toolbar). In addition of the Displays, of Course

Custom Displays with the Assets Tree

• Child page: Tutorial on Asset Displays

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

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

Third-party applications can also access that data using Integration APIs.

((Explain the ASset( ) methods))

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

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.

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

In this section...