Versions Compared

Key

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

Introduction to the Runtime

Image Modified

...

Runtime Module Overview

The Runtime

...

Environment is where your configured solution

...

comes to life. It transforms static configuration into an active system

...

by loading tags into memory,

...

processing real-time data,

...

executing scripts and alarms, and

...

serving information to clients

...

.

...

Runtime

...

is the

...

Executing a Solution, or starting the Runtime, involves:

  • Loading all functional modules for execution
  • Acquiring and processing data and updating visual displays
  • Performing all tasks based on the Solution's configuration

When the Runtime Environment loads the module's configuration. Some settings, such as network addresses and database connections, can be applied according to the execution profile. Profiles enable the same solution configuration to interface with various databases and devices, accommodating different phases of the solution life cycle, such as Development, Validation, or Production.

operational heart of your FrameworX solution.

Core Functions:

  • Execute configured solutions
  • Maintain real-time database in memory
  • Process data from field devices
  • Serve displays to clients
  • Monitor system performance


Panel
borderWidth1
borderStylesolid
title

...

On this Page:
  • Runtime Module Overview
  • Key Concepts
  • What It Does
  • Configuration Workflow
  • Runtime Behavior
  • Feature Highlights

Key Concepts

  • TServer.exe: The core process that runs your solution
  • Execution Profile: Different settings for Development vs Production
  • Real-Time Database: Tags and data held in memory for fast access
  • Online Changes: Modify the running solution without stopping
  • Test Mode: Run and debug from within Designer
  • Build & Publish: Create validated versions for deployment

What It Does

  • Starts and stops solution execution
  • Loads tags and templates into memory
  • Runs all configured modules (Devices, Alarms, Scripts, etc.)
  • Manages connections to databases and field devices
  • Serves data to displays and clients
  • Monitors performance and system health

Key Concepts and Terms

The purpose of the Runtime Environment is to actively operate configured solutions, executing real-time data acquisition, scripts, alarms, and all items from all modules. It represents the essential final phase of solution development, delivering the application's functionality. 

Runtime

The term "Runtime" or "Runtime Environment" refers to the execution environment when the solution is running, distinguishing it from the Configuration (or Engineering, or Development) phase. "Runtime" also denotes the software components and computer processes that are in execution when the solution is started. 

Execution Profile

An Execution Profile consists of settings that allow customization of database connections and device network addresses. This enables the management of different environments.

Online Configuration

This feature allows real-time modifications to a running solution without stopping its execution. Users can adapt the solution to changing requirements, enhancing flexibility and responsiveness.

Hot Updates / Hot Reload

Hot Updates are a subset of online configurations that allow the application of offline solution changes without disrupting the runtime environment. They maintain solution stability and prevent downtime, ensuring the solution remains up-to-date with the latest changes.

Build and Publish

The Build process involves compiling the solution code. The Publish process creates a read-only version of the solution for distribution in regulated sites.

Understanding the Runtime Environment

Real-Time In-Memory Database

When the solution is in execution, variables like Tags, Templates, and Assets are loaded into the memory. These variables act as a central point of reference, allowing other functional modules to request or publish values as they perform their functions. The computer process and executable responsible for maintaining the real-time database is TServer.exe. This application can run as a Windows Service or be deployed to Linux and other supported operating systems.

Image Removed

Runtime Fundamentals

Startup Procedure

→ For details on the startup procedure review the Runtime Startup Settings page.

→ For details on setting up the execution review the Solution Deployment (Reference) page.

Runtime in the Four Pillars (Concept)

Runtime Execution Overview

During Runtime, the Four Pillars transform from static configuration into an active system. Each pillar operates as an independent yet interconnected layer, with data flowing from field devices through the foundation layer, processed by business logic, and presented to users through visualization interfaces.

On this Page:

  • Runtime Execution Overview
  • Key Concepts
  • What Happens at Runtime
  • Pillar Interactions
  • Execution Profiles
  • Performance Characteristics

Key Concepts

  • Pillar Activation: Each pillar becomes an active process or service during execution
  • Data Flow Direction: Information moves upward through pillars, commands flow downward
  • Module Independence: Each pillar's modules run as separate processes
  • Memory-Based Operation: UNS maintains all real-time data in RAM
  • Event-Driven Architecture: Changes propagate through publish-subscribe patterns
  • Profile-Based Behavior: Same configuration runs differently in Dev vs Production

What Happens at Runtime

When a solution starts, each pillar activates in sequence:

  1. Foundation loads - Tags and templates enter memory
  2. Process modules connect - Field devices start communicating
  3. Application logic initiates - Scripts and datasets begin processing
  4. Interface serves - Displays become available to clients

Pillar Interactions

Data Flow Pattern

...

Table of Contents
maxLevel2
minLevel2
excludeSteps





Image Added


Key Concepts


ConceptDescriptionDetails
TServer.exeCore execution engineProcess that maintains real-time database
Execution ProfileRuntime environment settingsDevelopment, Validation, or Production modes
Real-Time DatabaseIn-memory tag storageFast access to all solution data
Online ConfigurationModify running solutionChanges without stopping execution
Hot ReloadApply updates instantlyNo downtime for changes
Test ModeDesigner-based executionDebug without full deployment



What Runtime Does

Execution ControlData ProcessingClient Services
  • Start/stop solutions
  • Load configurations
  • Initialize memory
  • Manage profiles
  • Control services
  • Monitor status
  • Maintain tag database
  • Execute scripts
  • Process alarms
  • Store historian data
  • Calculate values
  • Handle events
  • Serve displays
  • Manage connections
  • Update real-time data
  • Handle commands
  • Authenticate users
  • Distribute changes



How Runtime Works

Startup Sequence

When you start the Runtime, the following sequence occurs:

No Format
1. Solution Load (< 5 seconds)
   ??? Read .dbsln configuration
   ??? Validate settings

2. Memory Initialization (5-10 seconds)
   ??? Load tags and templates
   ??? Create data structures
   ??? Initialize TServer.exe

3. Module Activation (10-30 seconds)
   ??? Start Device communications
   ??? Enable Alarm processing
   ??? Begin Historian collection
   ??? Initialize Scripts

4. Steady State (< 60 seconds)
   ??? All modules operational
   ??? Data flow active
   ??? Ready for clients


Real-Time Database Architecture

Image Added

Info

When the solution runs, all tags, templates, and assets load into memory. This in-memory database acts as the central hub where modules publish and request values. The TServer.exe process maintains this database, running as a Windows Service or on Linux/Docker platforms.



The Four Pillars at Runtime

During execution, each pillar transforms into active processes:

Data Flow Through Pillars

No Format
[Field Devices] ? [P2: Process] ? [P1: UNS] ? [P3: Application] ? [P4: UI]
                        ?              ?              ?                

...

?
                    [Alarms]     [Historian]    [Datasets]       [Clients]

...

Communication Methods

From Pillar

To Pillar

Method

Process → FoundationTag writesDirect memory update
Foundation → ApplicationTag changesEvent notifications
Application → FoundationCalculated valuesTag writes
Foundation → InterfaceValue updatesSubscription/publish
Interface → FoundationOperator commandsTag writes


PillarRuntime RoleKey Processes
P1: UNSData foundationTag database, events
P2: ProcessField connectivityDevice drivers, alarm engine
P3: ApplicationBusiness logicScript execution, queries
P4: Operator UIVisualizationDisplay server, client handler



Execution Profiles

Different runtime behaviors for the same configuration:

AspectDevelopment

...

Validation

...

Production

...

  • Enterprise SQL databases
  • Optimized logging
  • Configuration locked
  • Live data sources
  • Performance optimized

Runtime & Clients — Overview

The Runtime executes your solution (real-time tags, UNS, modules, utilities). Clients (desktop & web) visualize and interact with the running system. This page explains how execution works and how clients connect.

On this page

  • Execution model (Runtime, services, UNS)

  • Client types (desktop, web)

  • Basic diagnostics you’ll use first

Runtime Components

ComponentFunctionAccess
TServerCore execution engineRuns as service
Tag DatabaseReal-time data storageIn-memory
Module EnginesExecute specific functionsAuto-started
Client ServerServes displays to clientsTCP port 9000

Component Relationships

  • TServer hosts the tag database
  • Modules connect to TServer for data exchange
  • Client Server retrieves data from TServer
  • All components share the solution configuration

Execution Modes

Development Mode

  • Full diagnostics enabled
  • Detailed error messages
  • Performance monitoring
  • Online configuration changes

Production Mode

  • Optimized performance
  • Minimal logging
  • Security enforced
  • Stable operation

The same solution behaves differently based on the execution mode, controlled by the Execution Profile selected at startup.

PurposeTesting & debuggingSystem verificationLive operation
DatabaseLocal SQLiteTest SQL ServerEnterprise SQL
DiagnosticsFull loggingPerformance metricsMinimal overhead
ChangesOnline edits allowedLimited changesProtected/locked
Data SourcesSimulators/devicesTest devicesLive equipment



Client Connections

...

Runtime supports multiple client types simultaneously:

Desktop Rich ClientDesktop

...

Smart Client Web ClientMobile Client

.NET WPF application

High-performance

...

Local installation

...

Direct connection

Full functionality

.NET WPF application

High-performance

Click-one activation

Direct

...

connection

...

Full functionality

HTML5 browser

...

WebAssembly

No installation

...

Responsive design

Cross-platform

Adaptive layout

WebAssembly

...

Mobile Client

...

No installation

Touch-optimized

...

Basic Diagnostics

Three essential tools for monitoring Runtime:

1. Runtime Information

...

Shared content



Monitoring Runtime

Diagnostic Tools (Desktop)

ToolAccessPurposeKey Information
Runtime InfoSolution Center → ToolsSystem health
Module status, memory

...

,

...

2. Property Watch

  • Function: Monitor tag values in real-time
  • Details: See quality indicators and timestamps
  • Usage: Debug data flow and values

3. Diagnostics Window

  • Content: View logs and traces
  • Analysis: Performance metrics
  • Troubleshooting: Error identification

Monitoring Runtime

  1. Runtime Information
    • Solution Center → Tools → Runtime Info
    • Shows module status, memory, connections
  2. Property Watch
    • Monitor tag values in real-time
    • See quality and timestamps
  3. Diagnostics
    • View logs and traces
    • Analyze performance

Runtime (Concept)

Runtime Module Overview

The Runtime Module executes your configured solution, transforming the static configuration into an active system. It loads tags into memory, processes real-time data, executes scripts and alarms, and serves information to clients - making your solution come alive.

On this Page:

  • Runtime Module Overview
  • Key Concepts
  • What It Does
  • Configuration Workflow
  • Runtime Behavior
  • Feature Highlights

Key Concepts

  • TServer.exe: The core process that runs your solution
  • Execution Profile: Different settings for Development vs Production
  • Real-Time Database: Tags and data held in memory for fast access
  • Online Changes: Modify the running solution without stopping
  • Test Mode: Run and debug from within Designer
  • Build & Publish: Create validated versions for deployment

What It Does

  • Starts and stops solution execution
  • Loads tags and templates into memory
  • Runs all configured modules (Devices, Alarms, Scripts, etc.)
  • Manages connections to databases and field devices
  • Serves data to displays and clients
  • Monitors performance and system health

Runtime Behavior

How Runtime Works

When you start the Runtime:

  1. Solution loads - Configuration is read from the .dbsln file
  2. Memory initialization - Tags and templates load into RAM
  3. Modules start - Devices, Alarms, Historians begin operation
  4. Data flows - Real-time values update across the system
  5. Clients connect - Displays can now show live data

Development vs Production

Aspect

Development

Production

PurposeTesting and debuggingLive operation
DatabaseLocal SQLiteSQL Server
DiagnosticsFull loggingMinimal overhead
ChangesOnline edits allowedProtected operation
PerformanceDebug informationOptimized speed

Simple Monitoring

Access runtime information through:

  • Solution Center - Start/stop and status
  • Designer - Connect to running solution
  • Property Watch - See tag values in real-time
  • Diagnostics - View logs and performance

Feature Highlights

Easy Execution

  • One-click start: Run button in Solution Center or Designer
  • Windows Service: Auto-start with Windows
  • Multiple profiles: Same solution, different environments
  • Remote start: Launch from web interface

Real-Time Operation

  • Fast data updates: Millisecond response times
  • Event-driven: Changes trigger immediate actions
  • Reliable communication: Store-and-forward for network issues
  • Scalable performance: From embedded to enterprise

Development Features

  • Test Mode: Run without leaving Designer
  • Online changes: Modify tags while running
  • Hot reload: Update displays instantly
  • Property Watch: Monitor any value live

Production Ready

...

CPU
PropertyWatchDesigner → PropertyWatchTag monitoringValues, quality, timestamp
TraceWindowDesigner → TraceWindowTroubleshootingLogs, traces, errors
ModuleInfoDesigner → ModuleInfoModule detailsStatus, performance

Heath & Monitoring Tools (Desktop & Web & Mobile)

ToolAccessPurposeKey Information
Runtime MonitorSolution Center → ManageSystem healthModule status, memory, CPU
Alarms MonitorSolution Center → ManageAlarms statusmodule state, active alarms
Historian MonitorSolution Center → ManageHistorian statusmodule state, trend charts



Performance Characteristics

Processing Distribution

  • Parallel execution - Modules run independently
  • Priority management - Critical operations first
  • Event-driven - Changes trigger immediate updates
  • Optimized memory - Efficient data structures

Typical Performance Metrics

  • Tag updates: < 10ms response
  • Alarm evaluation: < 50ms detection
  • Display refresh: 100-500ms
  • Script execution: Varies by complexity
  • Client connections: 100+ concurrent

Feature Highlights

Development Features

  • Test Mode - Run from Designer
  • Online changes - Modify without stopping
  • Hot reload - Instant display updates
  • Debug tools - Comprehensive diagnostics

Production Features

  • Auto-start - Windows Service mode
  • Redundancy - Hot-standby support
  • Store-and-forward - Network resilience
  • Cross-platform -

...

  • Windows, Linux, Docker

Built-in

...

  • Module status: See what's running
  • Performance metrics: CPU, memory usage
  • Trace messages: Debug information
  • Error logging: Automatic issue tracking

Performance Characteristics

Memory Usage by Pillar

Pillar

Primary Memory Use

Typical Range

Foundation (UNS)Tag values, templates100MB - 2GB
Process ModulesCommunication buffers50MB - 500MB
Application ModulesScript execution100MB - 1GB
User InterfaceDisplay cache50MB - 200MB per client

Processing Distribution

Parallel Execution: Each pillar's modules run independently

  • Device communications don't block displays
  • Script calculations don't affect alarm processing
  • Database operations isolated from real-time updates

Priority Management: Critical operations get precedence

  • Alarm evaluation: Highest priority
  • Control commands: High priority
  • Historical archiving: Normal priority
  • Report generation: Low priority

Startup Sequence

  1. TServer.exe starts (< 5 seconds)

    • Loads tag database
    • Initializes memory structures
  2. Module activation (5-30 seconds)

    • Process modules connect to devices
    • Application modules initialize
    • Interface prepares client services
  3. Steady state (< 60 seconds)

    • All communications established
    • Full data flow active
    • Clients can connect

untime Behavior

Solution Management Process

The Solution Center maintains a real-time view of all available solutions through file system monitoring and server connections. Solution files (.dbsln) contain complete configurations as encrypted embedded SQL databases, enabling portability and backup.

Access Methods

Solution Center supports three primary access modes:

Local Access: Direct file system access to solutions on the local computer

  • Immediate file operations
  • Single-user exclusive mode available
  • No network requirements

Server Connection: Remote access via TWebServices

  • Multi-user collaboration support
  • Centralized solution management
  • Requires port 10108 open

Web UI Access: Browser-based interface

  • URL format: http://<server>:10108/solutions
  • No local installation required
  • Click-Once Designer deployment

Solution Execution States

...

Reliability

  • Watchdog timers - Auto-recovery
  • Module isolation - Fault containment
  • Data persistence - Survives restarts
  • Error handling - Graceful degradation

How It Fits in the Solution Lifecycle


Info
titleRuntime

Runtime is the execution environment in the Solution Lifecycle:

  1. Solution Center - Create and manage solutions
  2. Designer - Configure all modules
  3. Runtime ← You are here (Execute and monitor)

Runtime brings your configuration to life, executing all the logic and serving data to clients. It's where your solution delivers value to operations.


Next Steps

Essential Reading

  • [Execution Profiles →] - Configure for different environments
  • [Client Types →] - Understand display options
  • [Diagnostics Guide →] - Monitor and troubleshoot

Practical Guides

  • [Starting Runtime] - Step-by-step startup
  • [Performance Tuning] - Optimization techniques
  • [Deployment Guide] - Production readiness



This page introduces Runtime as the execution heart of your FrameworX solution. Understanding how Runtime transforms configuration into operation helps you design better solutions and troubleshoot effectively.


In this section...

Page Tree
root@parent
spaces93DRAF

...