Versions Compared

Key

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

Expose the Unified Namespace to external clients, AI systems, and other FrameworX solutions.

Modules → Data Foundation → Data Services (Concept) | How-to | Reference

Overview


Overview

FrameworX includes built-in services that expose your Unified Namespace (UNS) to external systems. FrameworX as Server: These services allow external clients to connect TO your solution — the opposite of TagProvider Services, where FrameworX connects to external systems as a client.

DirectionComponentFrameworX RoleExternal → UNSTagProvider ServicesClient (

run alongside your solution and provide standardized access to live data without additional infrastructure.

Table of Contents
maxLevel2
minLevel2
indent10px
excludeOverview
stylenone

FrameworX as Client or Server


ConnectionModuleFrameworX Role
UNS → External TagProvider ServicesFrameworX UNS connects to PLCs, brokers, third-party servers
)
External → UNS
→ External
Data Servers
Server (clients connect
External Client connects to FrameworX
)FrameworX includes built-in services that expose your Unified Namespace (UNS) to external systems. These services run alongside your solution and provide standardized access to live data without additional infrastructure.
Data Servers


TagProvider Services:
You connect TO external systems

Data Servers: External systems connect TO you

→ See TagProvider Services for connecting to external data sources


Available Services


ServiceProtocolPurpose
OPC UA ServerOPC UAExpose UNS to enterprise systems and other SCADA platforms
MQTT BrokerMQTTPublish/subscribe access for IoT devices and cloud platforms
MCP for RuntimeMCPEnable AI/LLM models to query live solution data
DataHub ServiceTCPSynchronize data between multiple FrameworX solutions
Table of ContentsmaxLevel2minLevel2indent10pxexcludeOverviewstylenone



OPC UA Server

Expose your UNS to external OPC UA clients using industry-standard protocols.

Capabilities:

  • Browse and subscribe to any tag in the UNS
  • Read/write access with configurable security
  • Historical data access (if Historian configured)
  • Alarm and event subscriptions

Configuration

Navigate to Unified Namespace → TagProvider Services and click the OPC UA Server icon.

SettingDescription
PortDefault: 4840
Security ModeNone, Sign, SignAndEncrypt
User AuthenticationAnonymous, Username/Password, Certificate

→ See UNS Data Servers Reference for configuration details→ See OPC UA Server Reference for complete configuration


MQTT Broker

Built-in MQTT broker for publish/subscribe messaging without external infrastructure.

Capabilities:

  • Full MQTT 3.1.1 and MQTT 5.0 support
  • Sparkplug B compatibility
  • Topic-to-tag mapping
  • QoS 0, 1, and 2 support
  • WebSocket transport option

Configuration

Navigate to Unified Namespace → TagProvider Services and click the MQTT Broker icon.

SettingDescriptionTCP PortDefault: 1883WebSocket PortDefault: 8083AuthenticationAnonymous, Username/PasswordTLSOptional encryption

→ See MQTT Broker UNS Data Servers Reference for complete configuration details


MCP for Runtime

Enable AI language models to query live solution data through Model Context Protocol.

Capabilities:

  • Query tag values from the UNS
  • Retrieve alarm status and history
  • Access historian data for trend analysis
  • Extend with custom tools via Script Classes

How It Works

AI Model (Claude) ←→ MCP Protocol ←→ TMCPServerStdio.exe ←→ TServer.exe

[Live UNS Data Access]

Built-in Tools

ToolDescription
Get ValueRead current tag values
Get HistorianQuery historical data
Get AlarmsRetrieve alarm status

Custom Tools

Create solution-specific tools using Script Classes. AI models can invoke any method you expose.

→ See AI MCP for Runtime Connector for setup → See AI MCP for Runtime Tutorial for step-by-step guideand configuration

DataHub Service

Distributed data aggregation for multi-solution architectures. Enables multiple FrameworX solutions to share and access tag, device, server, and alarm namespaces.

Capabilities:

  • Multi-solution data synchronization
  • Centralized UI solution consuming data from multiple edge solutions
  • Shared alarm management across solutions
  • Scalable distributed architecture

Architecture Pattern:

No Format
+-------------+     +-------------+     +-------------+
|   EDGE 1    |     |   EDGE 2    |     |   EDGE 3    |
|  (Publish)  |     |  (Publish)  |     |  (Publish)  |
+-------------+     +-------------+     +-------------+
        |
     ?               ?               ?
     ?????????????????????????????????
          |        
        +--------------------------------------+             	
?
              ???????????????
        |
            ? |UI  Solution ?
  +------------------+
  |      UI Solution    |
 ? | (DataHub) Service |?
  |   Port 30001)    |   
  +------------------+

Configuration

SettingDescription
Listening PortDefault: 30001
Access KeyAuthentication for connections
Access ModeRead, Write, or ReadWrite
  ???????????????

→ See Data Hub Communication Service for

complete

configuration

details


Configuration Location

Designer: Unified Namespace → Data Servers

Each service has its own configuration dialog accessible via the edit icon.


Explanation - to understand concepts
→ You are here

How-to Guides - to accomplish specific tasks
→ How to Enable Data Servers

Reference - technical details
→ UNS Data Servers Reference — All settings and configuration options
→ AI MCP for Runtime Connector — MCP setup and tutorial
→ Data Hub Communication Service — Multi-solution architecture details


See Also

  • TagProvider Services — Connect to external systems (FrameworX as client)
  • Data Foundation — UNS overview
  • AI Integration — AI capabilities overview

Enabling Services at Runtime

Built-in services are enabled on the Runtime → Startup page:

ServiceStartup OptionConfiguration Location
OPC UA Server?? OPCServerTagProvider Services
MQTT Broker?? MQTTBrokerTagProvider Services
MCP for RuntimeEnabled via ScriptsScripts → Classes
DataHub Service?? Publish to DataHubTagProvider Services

Partner APIs

For development partners requiring direct programmatic access, additional APIs are available:

APIDescription.NET APINative .NET library for direct solution integrationREST APIHTTP-based access for web and cloud applications

Contact Tatsoft for partner API access and documentation.


See Also

  • TagProvider Services — Configure built-in services
  • AI MCP for Runtime Connector — AI integration details
  • Data Hub Communication Service — Multi-solution architecture
  • Data Foundation — UNS overview