Versions Compared

Old Version 4

changes.mady.by.user admin

Saved on

compared with

New Version Current

changes.mady.by.user admin

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Image Modified P1:Unified Namespace (

UNS) Module OverviewThe Unified Namespace Module

Concept) is the first pillar on the Four Pillars methodology, it provides a centralized real-time data repository with hierarchical organization for all solution data.

It

As the first pillar in the Four-Pillar methodology, it creates a standardized method for accessing and managing tags, assets, and external data sources

through a single, cohesive framework that serves as the foundation for all other modules

.

Image Modified

On this

Page

page:

Table of Contents
maxLevel2
minLevel2
indent10px
exclude

Steps
stylenone



Unified Namespace → Tutorial | Concept | How-to Guide |  ISA-95 | Reference
Overview


Key Concepts

Tag:
ConceptDescriptionExample
TagProcess variable representing real-time and historical data
, created locally or accessed remotely
Tank01.Level, Pump01.Status
Asset Tree
:
Hierarchical representation of solution data
containing variables and DataTemplatesDataTemplate
/Plant/Area1/Line1/Equipment
UserType (UDT)
: User-defined
Reusable data structure
including
with variables and references
to other templatesTagProvider Service:
Motor template with Speed, Current, Status
TagProvider ServicesDirect interaction with variables in remote systemsOPC UA server, MQTT broker connections
Enumeration
:
Named integer values
representing discrete options or states
with
associated
messages and colors0=Stopped, 1=Running, 2=Fault
Runtime Database
:
In-memory real-time database managing UNS dataTServer.exe process


What the UNS Does

The Unified Namespace

data during solution execution

serves as your solution's data backbone:

Data OrganizationSystem Integration
  • Creates

What It Does

Creates and manages
  • real-time data models with tags
,
  • and templates
, and enumerations
  • Organizes data in hierarchical Asset Tree structure
with folders and templates
  • Maintains relationships between equipment and data
  • Provides intuitive navigation through process hierarchy
  • Enables dynamic connectivity to external systems
through TagProvider connections
  • Supports advanced data types including SQL
types, .NET entities, and complete DataTables
  • datasets and JSON objects
  • Provides type-safe references and up to  tri-dimensional arrays
Provides tri-dimensional dynamic arrays and type-safe reference tags
  • Maintains event-driven, in-memory database
for real-time data exchangeConfiguration Workflow
Unified Namespace



Configuration Workflow

StepAction
DescriptionDefine DataTemplates
Tool (Designer UI)Tools
1. Define UserTypesCreate reusable structures
Design custom data structures for assets
UNS → UserTypesTemplate Editor
2. Build Asset TreeOrganize hierarchy
Create folders and organize data structure
UNS → Asset TreeAsset Browser
3. Create TagsDefine variables
Add tags based on templates or basic types
UNS → TagsTag Editor, DataExplorer
4. Configure EnumerationsSet discrete values
Define state options with messages and colors
UNS → EnumerationsEnumeration Editor
5. Add TagProvider Services
Add TagProviders
Connect external dataUNS → TagProvider ServicesTagProvider Services
6. Map Remote DataLink to
OPC-UA, MQTT, databases, or historiansMap Remote DataLink to Asset foldersConnect TagProvider data to namespace locations
Asset foldersUNS → Asset TreeAsset Mapping


Info
titleDataExplorer: Accelerating UNS Development

The DataExplorer tool streamlines UNS creation by enabling:

  • Discovery - Browse MQTT brokers, OPC servers, PLCs, and SQL databases
  • Import - Create tags and templates directly from discovered structures
  • Validate - Test connections before adding to production

Image Added

This tool reduces manual configuration time by 50-70% when building your tag structure during the Foundation phase.

→ Learn more in the DataExplorer How-to Guide


Runtime Behavior

Data Loading and Management

When solution execution starts, the Unified Namespace definition loads into the in-memory real-time database (TServer.exe process). This database enables event-driven data exchange between all solution modules with millisecond precision.

Data Access Methods

Modules access Unified Namespace variables through two primary methods:

Direct Tag Access (Local Tags)Asset Method Access: Using the Asset() function

Using tag names

and paths

  • Example: Tag.Machine1.Temperature
  • Supports both local tags and nested
template properties
  • UserType properties

When connecting the tag with the field device

  • Use the Devices Module to map the Tag to a DevicePoint
  • If the protocol has TagDiscovery, you can use the DataLink field
    • In this case only the TagProvider services must be enabled
Asset Method Access: Using the Asset() function
  • Example: Asset("/Line1/Machine1.Temperature")
  • Required for TagProvider connections and dynamic references

    • Tag vs TagProvider Connections

    AspectTagsTagProvider Connections
    DefinitionLocal real-time variables within solutionDirect link to external system variables
    CreationCreated and configured locallyDefined in remote system, linked dynamically
    Data MappingDevices Module handles remote mappingNo local mapping required
    Access MethodTagName or AssetPathAssetPath only via Asset() method
    Use CaseCore solution data requiring local controlDynamic external data without local overhead
    • Local Tags can be also use this syntax

    TagProvider TagDiscovery Service

    • If the protocol supports TagDiscovery (OPC UA, MQTT, ..)
      • Dynamic Tags can created in runtime as a Asset("path") is used. 
      • see  more at ->


    Features Highlights

    Advanced Data Types

    • SQL-compatible types
    :
    • - Full
    support for
    • database data
    types
    • type support
    • .NET
    Framework
    • entities
    :
    • - Images, JSON
    objects
    • , DataTables in single tags
    • Dynamic structures
    :
    • - Tri-dimensional arrays, lists,
    and
    • collections
    • Type-safe references
    :
    • - Dynamic tag assignments with
    type
    • validation

    Hierarchical Organization

    • Asset folders
    :
    • - Logical grouping matching
    physical
    • equipment
    • Nested templates
    :
    • - Composition and inheritance support
    • Reusable components
    :
    • - Template-based design
    for displays, reports, calculations
    • patterns
    • Clear data paths
    :
    • - Intuitive navigation through
    process
    • hierarchy

    External System Integration

    • Protocol support
    :
    • - ControlLogix, OPC-UA, MQTT SparkPlugB
    • Database connectivity
    :
    • - SQL
    databases
    • , CanaryLabs, InfluxDB, OSIsoft PI
    • Remote applications
    :
    • - Other FrameworX solutions
    • Dynamic browsing
    :
    • - Real-time discovery of
    external
    • data structures

    Real-time Performance

    • Event-driven updates
    :
    • - Millisecond timestamp precision
    • In-memory database
    :
    • - High-performance data access
    • Publish-subscribe model
    :
    • - Efficient module communication
    • Store-and-forward
    :
    • - Reliable
    data
    • handling during disconnections


    Common Implementation Patterns

    ISA-95 Model Implementation


    evelAsset StructureTypical Tags
    Enterprise/CompanyKPIs, Financial metrics
    Site/Company/Site1Production totals, Energy usage
    Area/Company/Site1/Area1Area production, Quality metrics
    Line/Company/Site1/Area1/Line1Line speed, Product counts
    Cell/Company/Site1/Area1/Line1/Cell1Equipment status, Process values

    Naming Convention Best Practices


    Code Block
    titleNaming Individual Tag Names
    Standard Format: [Area]_[Equipment]_[Component]_[Signal]

Examples:
WTP_PUMP01_MOTOR_RUNNING
WTP_PUMP01_MOTOR_SPEED_SP
WTP_TANK01_LEVEL_PV
BLDG_HVAC_AHU01_TEMP_SP

if using UDT SP is BLDG_HVAC_AHU01_TEMP.SP


    Code Block
    titleNaming using Asset Folders and UDTs
    Standard Format: [Area]/[Equipment]/[Component][Signal].[Attribute]

Examples:
WTP/PUMP01/MOTOR/RUNNING
WTP/PUMP01/MOTOR/SPEED.SP
WTP/TANK01/LEVEL.PV
BLDG/HVAC/AHU01/TEMP.SP

    Code Block
    titleNaming adding a DataTemplate for Components( MOTOR, TANK)
    Standard Format: [Area]/[Equipment]/[ComponentUDT].[Signal]

Examples:
WTP/PUMP01/MOTOR.RUNNING
WTP/PUMP01/MOTOR.SPEED.SP
WTP/TANK01/LEVEL.PV
BLDG/HVAC/AHU01.TEMP.SP

    Development Efficiency Tools

    • Bulk operations
    :
    • - Import/export via Excel, CSV
    • Search and filter
    tools:
    • - Quick tag location and editing
    • Template
    reusability: Reduce redundancy in configurationsUnified editor: Single interface for all namespace components
    • library - Reusable component repository
    • Cross-reference - Find tag usage across modules
    • Version tracking - Built-in change management


    Info
    • Rename any Tag , anytime - Without losing configuration integrity and runtime online updates. 
    • Cross-reference Tag usage - on-the-fly update, information is always instantly available


    Next Steps

    • [UNS (How-to Guide)] - Step-by-step configuration
    • [UNS (Reference)] - Complete technical documentation
    • [P2: Process Modules] - Connect to field devices
     
    In this section...

    Page Tree
    root@parent
    spaces93DRAF