The Runtime Environment is the active stage where a Solution starts and operates, executing real-time data acquisition, scripts, alarms, and all configured modules to deliver the application's functionality.

Parent Page: Solution Lifecycle (Reference)



Overview

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, 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 lifecycle (Development, Validation, Production).

Key Concepts

TermDefinition
RuntimeThe execution environment when the solution is running, distinguishing it from the Configuration phase. Also denotes the software components and processes in execution
Execution ProfileSettings allowing customization of database connections and device network addresses for different environments
Online ConfigurationReal-time modifications to a running solution without stopping execution
Hot Updates/Hot ReloadSubset of online configurations allowing offline solution changes without disrupting runtime
Build and PublishCompilation of solution code and creation of read-only versions for regulated deployment

Runtime Architecture

Real-Time In-Memory Database

When the solution executes, variables like Tags, Templates, and Assets are loaded into memory, acting as a central reference point for all functional modules.

???????????????????????????????????????????????
?            TServer.exe Process              ?
???????????????????????????????????????????????
?         Real-Time Database                  ?
?    • Tags, Templates, Assets                ?
?    • Current Values & Quality               ?
?    • Microsecond Updates                    ?
???????????????????????????????????????????????
?         Module Connections                  ?
?    • Devices → Tag Updates                  ?
?    • Scripts → Processing                   ?
?    • Clients → Data Access                  ?
???????????????????????????????????????????????

The computer process TServer.exe maintains the real-time database and can run as a Windows Service or be deployed to Linux and other supported operating systems.

Startup Procedure

1. Launching TStartup.exe

  • Loads the Solution
  • Reads Solution Configuration
  • Parses Command Line Parameters
  • Activates Main Process TServer.exe

2. Starting the Real-Time Database

TServer.exe starts by loading solution objects, tags, templates, and assets into memory. A communication service is established, allowing other modules to start and connect.

3. Modules Startup

Other modules (Historian, Alarms, Devices, Scripts, Datasets, Reports) start execution by reading solution configuration and establishing connection with the main process.

4. Applying Execution Profiles

Modules behave according to Execution Profile definitions. For example:

  • Development: Temporary local SQLite database for alarm records
  • Production: Alarm Database automatically mapped to SQL server

5. Solution Designer Automatic Connection

Designer automatically connects to running solution, enabling monitoring, adjustments, and troubleshooting via Monitor and Diagnostics pages.

6. Opening Client-Side Displays

Operations displays (HTML5 or WPF) can be opened from any remote computer connected to the server.

7. Applying Online Changes and Hot Updates

System can apply configuration changes and updates without disrupting runtime, maintaining high availability.

Runtime Namespaces

Info Namespace

Main location for runtime status:

Info.Solution    - Information about running solution
Info.License     - License information
Info.Module      - Module information and start/stop commands
Info.Trace()     - Display message on TraceWindow
Info.TestMode    - Shows if solution running in Test Mode

Server Namespace

Information about the server computer running the solution.

Client Namespace

Information about each client computer running a graphical interface.

Configuration Components

ComponentPurposeDocumentation
Runtime StartupStart/stop execution, profile selectionRuntime Startup (Reference)
Execution ProfilesEnvironment-specific configurationsRuntime Execution Profiles (Reference)
Build and PublishCompilation and deploymentRuntime Build and Publish (Reference)
Runtime DiagnosticsProperty Watch, Trace Window, Module InfoRuntime Diagnostics (Reference)
System MonitorRuntime status and metricsRuntime System Monitor (Reference)

Process Isolation

Configuration and Runtime Process Isolation ensures development doesn't impact production:

ProcessActivitiesIsolation Method
ConfigurationSetting parameters, profilesSeparate environment
RuntimeActive executionProtected instance
DevelopmentTesting featuresDifferent profile

Working with Runtime

Starting Solution Execution

  1. Go to Runtime → Startup
  2. Select appropriate Execution Profile
  3. Click Run Startup button
  4. Monitor for errors during startup

Stopping Solution Execution

Use appropriate shutdown method to avoid data loss:

  • Designer: Click Stop button
  • Service: Stop Windows service
  • Command line: Use shutdown command

Applying Configuration Changes

  1. Identify configuration file or settings
  2. Modify settings as needed
  3. Either:
    • Restart application (offline changes)
    • Use Online Configuration (hot updates)

Child Pages

Configuration Interface:

Architecture:

Support:

See Also




In this section: