Versions Compared

Key

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

Complete configuration options for Data Server services.

Technical Reference → UNS Reference → UNS Data Servers

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

Modules → Data Foundation → Data Services | Reference


Overview

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.

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 Contents
maxLevel2
minLevel2
indent10px
excludeOverview
stylenone

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

Configuration

Location: Unified Namespace → Data Servers → OPC UA Server [??]Navigate to Unified Namespace → TagProvider Services and click the OPC UA Server icon.

SettingDescriptionDefault
Port
Default:
TCP port for OPC UA connections4840
Security ModeNone, Sign, SignAndEncryptNone
User AuthenticationAnonymous, Username/Password, CertificateAnonymous


→ See OPC UA Server Reference for complete configurationprotocol details


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

Configuration

Location: Unified Namespace → Data Servers → MQTT Broker [??]Navigate to Unified Namespace → TagProvider Services and click the MQTT Broker icon.

SettingDescriptionDefault
TCP Port
Default:
Standard MQTT port1883
WebSocket Port
Default:
WebSocket transport port (0 = disabled)8083
AuthenticationAnonymous, Username/PasswordAnonymous
TLS
Optional encryption
Enable encrypted connectionsDisabled


→ See MQTT Broker Reference for complete configurationprotocol 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]

Configuration

Location: Scripts → Classes (custom tools)

SettingDescriptionDefault
HostListening addresslocalhost
PortMCP server port5000
TransportCommunication protocolstdio


Built-in Tools


ToolDescription
Get ValueRead current tag values from UNS
Get HistorianQuery historical data
Get AlarmsRetrieve alarm status and history

Custom Tools

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

Custom tools are defined in Script Classes using the [McpTool] attribute:

csharp

[McpTool("GetPanelPower", "Returns power output for specified solar panel")]
public double GetPanelPower(string panelId)
{
    return Tag.SolarPanels[panelId].Power.Value;
}

→ See AI MCP for Runtime Connector for setup details → See AI MCP for Runtime Tutorial for step-by-step guide


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

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

Configuration

Location: Unified Namespace → Data Servers → DataHub [??]

Configuration

SettingDescriptionListening PortDefault:
SettingDescriptionDefault
Listening PortTCP port for DataHub connections
30001
Access KeyAuthentication key for connections(none)
Access ModeRead, Write, or ReadWriteReadWrite


→ See Data Hub Communication Service for complete configuration

Enabling Services at Runtime

architecture details


Startup Options

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

ServiceStartup
OptionConfiguration Location
Checkbox
OPC UA Server?? OPCServer
TagProvider Services
MQTT Broker?? MQTTBroker
TagProvider Services
MCP for Runtime(Enabled via Scripts)
Scripts → Classes
DataHub Service?? Publish to DataHub


→ See Data Servers How-to for step-by-step enable procedures


Port Summary


ServiceDefault PortProtocol
OPC UA Server4840TCP
MQTT Broker (TCP)1883TCP
MQTT Broker (WebSocket)8083TCP/HTTP
MCP for Runtime5000stdio
DataHub Service30001
TagProvider Services
TCP

Partner APIs

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

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


Contact Tatsoft for partner API access and documentation.


See Also

  • Data Servers — Concept overview
  • Data Servers How-to — Enable and configure services
  • TagProvider Services — Connect to external systems (FrameworX as client)
  • 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