Page History

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:

Tags

Tag is the basic building blocks of a Unified Namespace, representing individual data points or variables in your system.

Organizing Tags with Assets Templates

A Template allows the creation of reusable data structures and organizing your Tags into Assets, a hierarchical and logical representation of an equipment or information model.

Using TagProviders for External Data Definitions

A Tag Provider is a powerful tool for integrating data from external sources and systems, allowing you to incorporate their data into your Unified Namespace seamlessly.

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

Templates 

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. 

Assets 

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.

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.

Image Removed

Modular configuration and scalability

Key Concepts 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 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:

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,

Building a Unified Namespace

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 

Creating Data Templates for Assets

<add basic explanation and example and point to child>>

Creating links to TagProvider external data

<add basic explanation and example and point to child>>

Monitor your data

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

Typical configuration process:

1. Creating DataTemplates: Define reusable tag data structures.
2. Creating Tags and 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 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.

→ Read more about Tags.

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

1. Go to Unified Namespace / Enumeration.
2. Click ‘New’ on the grid toolbar.
3. Open the ‘Create New Enumeration’ pop-up window.
4. Enter the name of the enumeration and click ‘OK’.
5. 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.<add basic explanation on the monitor page, and on the Tag Browsing tools and data explorer tools>>

Working with the Unified Namespace

Runtime 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 in FactoryStudio is named TServer.exeDuring 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.

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

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

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.

Advanced Features and Options

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.

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

Best Practices and Troubleshooting

Best Practices and Recommendations

To get maximize the most out benefits of the Unified Namespace, follow these best practices:

Organization of the

Data Structure

• Organize tags into a clear hierarchy , using with folders and templates , to make it easier for users to find and understand the information they needfor easier navigation and understanding.
• Plan your data structure structures carefully, considering the relationships between assets, tags, and templates.
• Leverage Use templates to create for 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.
• .
• Seamlessly integrate external data sources using TagProviders.
• Use consistent naming conventions for tags to simplify navigation and troubleshootingUse TagProviders to integrate external data sources, ensuring a seamless exchange of information between systems.

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:

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 and compatible data types.

In this section:

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

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

Child Pages for the section:

Assets Templates:
Building Custom Data Types

Creating and editing Data Templates

1. Assets Templates: Asset Templates allow users to create reusable data structures and organize tags into hierarchical, logical representations of equipment or information models. These templates help streamline data management and improve system efficiency by reducing redundancy and simplifying the process of accessing tag attributes.

2. Building Custom Data Types: Custom data types, also known as User-Defined Types (UDTs), can be created to represent complex data structures in the Unified Namespace. UDTs can include multiple tag attributes, allowing users to model various properties of an asset, such as its current state, operational parameters, and historical data. Building custom data types helps ensure a more accurate and comprehensive representation of assets and their associated tag attributes.

3. Creating and Editing Data Templates: To create a new Data Template, navigate to the Project Designer tools and select the "Tags - Unified Namespace" section. From there, users can create, edit, or import Data Templates for use in their projects. When creating a template, it's essential to define the relevant tag attributes, such as data types, initial values, and any required metadata.

4. The tag will then inherit the defined attributes from the template, allowing users to access and manipulate these attributes as needed throughout the project.

5. Once a template is created, it can be edited to update tag attributes or modify the template structure as needed.

6. Using Data Templates in Projects: 
   Assets Templates:
   Building Custom Data Types

   Asset templates in [Software Name] enable users to build custom data types based on a specific data structure. These custom data types use existing built-in types or previously defined templates as the foundation, allowing users to create more complex and tailored data structures suited to their project's needs.

   Creating and Editing Data Templates
   Users can create, edit, or import Data Templates for use in their projects. When creating a template, it's essential to define the relevant tag attributes, such as data types, initial values, and any required metadata. Once a template is created, it can be edited to update tag attributes or modify the template structure as needed.

   Using Data Templates in Projects
   Once a custom data type is created, it can be used in projects for organizing and managing tags. To use data templates in projects, follow these steps:
   Step 1: On the Objects tab within the software, navigate to the "Type" column for the desired tag.

   Step 2: From the drop-down list, select the newly created custom data type. The software will automatically apply the data structure and attributes of the custom data type to the tag.

   Step 3: Continue using the custom data type for relevant tags throughout the project, ensuring consistency and efficient organization

Tag Providers:
Integrating External Data Sources

Introduction to Tag Providers

Types of Tag Providers

Tag Providers: Introduction
Tag providers in FrameworkX serve as intermediaries between the software and external data sources, facilitating the exchange of data and enabling the software to access, process, and display information from various sources. By configuring and connecting to tag providers, users can efficiently integrate and manage data from different devices, systems, or protocols within the software.

Types of Tag Providers
In [Software Name], there are several types of tag providers, each catering to specific data source requirements and communication protocols. Examples of tag providers include:

a. OPC UA: A popular and widely-used tag provider that supports the OPC Unified Architecture (UA) communication protocol for industrial automation systems.
b. Modbus: A tag provider that facilitates communication with devices using the Modbus protocol, commonly found in industrial control systems.
c. Custom Tag Providers: Proprietary or user-defined tag providers that cater to specific communication protocols, data sources, or project requirements.

Selecting the appropriate tag provider depends on the data source's communication protocol, system compatibility, and project requirements.

Connecting to External Data Sources
To connect to external data sources in [Software Name], follow the steps below:
Step 1: Identify the appropriate tag provider based on the communication protocol of the external data source (e.g., OPC UA, Modbus, Custom).

Step 2: In the software, navigate to the tag provider configuration section and create a new tag provider instance. Provide necessary information such as the provider's name, communication settings, and any required authentication credentials.

Step 3: Configure the tag provider's settings to ensure proper communication with the external data source. This may include specifying the IP address, port number, or other communication parameters specific to the data source or protocol.

Step 4: Test the connection between the tag provider and the external data source. If the connection is successful, the software will be able to access and process the data from the external source.

Step 5: Import the tag definitions from the external data source using the methods described in the previous document (e.g., copy-pasting from other projects or Excel, importing from CSV files, using the Import Tag Wizards, or utilizing the EngWrapper API).

Step 6: Organize and manage the imported tags within the software using features such as Asset Modeling or custom templates.