This guide
walks you throughcovers starting, monitoring, and managing
your solution'sruntime execution
. Learn to use, including execution profiles,
applyonline changes, and
troubleshoot runtime issuestroubleshooting.
Table of Contents maxLevel 2 minLevel 2 indent 10px exclude Overview style none
Startup Methods
Method | Steps | Use Case |
---|---|---|
Designer Test Mode | Press F5 or click Run Test | Development testing (2-hour limit) |
Designer Full Runtime | Runtime → Startup → Run Startup | Development with profile selection |
Solution Center | Select solution → Run in Profile | Production deployment |
Command Line | TStartup.exe /solution:"name" /profile:Production | Automation/service mode |
When you start a solution:
Quick Start (Test Mode):
Full Runtime Start:
batch
TStartup.exe /solution:"MySolution" /profile:Production
Parameters: /username:admin /redundancy:primary
Parameter | Description |
---|---|
/solution: |
Solution name or path | |
/profile: |
Development/Validation/Production | |
/username: |
Credentials if required | |
/redundancy: |
Primary/secondary/standalone |
Three standard profiles manage lifecycle:
Profile | Database | Storage | Security | Diagnostics |
---|---|---|---|---|
Development | SQLite local | Memory only | Minimal | Full trace |
Validation | Test SQL Server | Test storage | Test credentials | Performance metrics |
Production | Production SQL | Full storage | Full authentication | Errors only |
Profile | Purpose | Typical Settings | ||
Development | Testing and debugging | Local SQLite, test data, full diagnostics | ||
Validation | Pre-production testing | Test servers, limited data, validation rules | Production | Live operation | Production servers, full security, optimized
Development Profile:
Database: SQLite (local)
Historian: Memory only
Alarms: Local file
Trace: Full diagnostics
Production Profile:
Database: SQL Server
Historian: Full storage
Alarms: Central database
Trace: Errors only
View real-time information:
Check individual modules:
Module | Status Indicators |
---|---|
TServer | Main process health |
Devices | Communication status |
Alarms | Active alarm count |
Historian | Storage status |
Scripts | Execution state |
Access runtime information programmatically:
csharp
Property | Location | Information |
---|---|---|
Solution Status | Runtime → Status | Running/stopped, uptime, profile |
Module Status | Module Information | Individual module health |
Resource Usage | Diagnostics | CPU, memory, threads |
Communication | Devices status | Channel and node status |
// Check runtime status
// Check if runningbool isRunning = @Info.Module.IsRunning;
// Get solution namestring solution = @Info.Solution.Name;
// Check test modebool testMode = @Info.TestMode; // Write
totrace
tracemessage @Info.Trace("Runtime started successfully"); // Check license int tagCount = @Info.License.TagCount;
Changes that apply immediately:
Apply Without Restart | Requires Restart |
---|---|
- Tag values and |
limits - Display modifications - Script logic updates - Alarm |
conditions - User permissions |
Changes requiring restart:
- Device channels - Database connections - Port assignments - Module enable/disable - License changes |
Cannot change online:
Enable web access:
Client Type | Setup | Access Method |
---|---|---|
Web Client | No installation | http |
://server/solution |
Smart Client |
Rich Client:
Smart Client:
Configure for tablets/phones:
Auto-download | Click-once deployment | |
Rich Client | Full installation | Desktop application |
Mobile | Responsive design | Browser on device |
Create read-only version:
Tool | Purpose | Access |
---|---|---|
Property Watch | Monitor |
/modify tag values |
Runtime → Diagnostics |
→ Property Watch |
Trace Window | View system messages |
Runtime → Diagnostics → Trace Window |
Module Information | Module performance metrics | Runtime → Diagnostics → Module Info |
Method | Steps | Notes |
---|---|---|
Designer | Runtime → Startup → Stop Runtime | Graceful shutdown |
Solution Center | Select solution → Stop | Remote shutdown |
Command line | TStartup.exe /solution:"name" /stop | Scripted shutdown |
Emergency | Task Manager → End TServer.exe | Force stop |
Issue | Check | Solution |
---|
Detailed module status:
From Designer:
From Solution Center:
Force immediate stop:
batch
TStartup.exe /solution:"MySolution" /stop /force
Or use Task Manager:
Runtime won't start |
Modules fail to load:
High CPU usage:
Memory growth:
Clients cannot connect:
Database connection fails:
? Use appropriate profiles for each environment ? Test in Development before Production ? Document profile settings ? Backup before changes
License, ports, database | Check event log, verify connections | |
High CPU usage | Scripts, scan rates | Optimize scripts, reduce scan frequency |
Memory growth | Historian, scripts | Check retention, dispose objects |
Client can't connect | Firewall, services | Open ports, verify server running |
Database fails | Connection string, network | Test connectivity, check credentials |
This guide covered starting and managing runtime execution, from initial startup through monitoring and diagnostics, providing essential knowledge for reliable solution operation.
Claude can make mistakes.
Please double-check responses.
Research
Opus 4.1
Excerpt Include | ||||||
---|---|---|---|---|---|---|
|
Page Tree | ||
---|---|---|
|
→ 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.
When developing a software solution, maintaining stability and preventing interference between various stages and components is crucial. To ensure the configuration and development aspects do not negatively impact the solution's runtime environment, use "Configuration and Runtime Process Isolation."
The Configuration Process involves setting up parameters, profiles, and other settings that define how the solution should operate.
Isolating these processes allows developers to modify configurations and test new features without disrupting the running solution, defining how the solution should opportunity depending on the Execution Profile you are running.
The Runtime Startup section allows you to Start and Stop the execution of the Solution, specify the Execution Profile you want to use, and customize all settings connected within that execution.
The settings defined here are also applied when the Startup is executed by the StartSolution command line, or starting the solution as a Windows Server. This section focuses on the various settings you have available and starting and stopping manually.
→ Read more about Runtime Startup Settings.
Execution Profiles enable distinct configurations for a single project, facilitating a seamless and swift transition between devices and databases.
Development, Validation, and Production are the scenarios in which the solution must operate over its lifecycle. Occasionally, these scenarios may overlap, posing risks to the entire operational environment. In this version, we introduce an intuitive method to separate these stages, enhancing both security and reliability.
→ Read more about Runtime Execution Profiles.
The software platform offers support to manage solution versions, allowing the creation of a read-only version and a published version. The Build feature compiles the solution's displays and scripts for final verification before deployment in production. It ensures complete verification of an application's scripts in preparation for production. The Publish command generates a read-only protected version of a solution ready for field deployment. This command produces a new Solution file (".dbsln") with the chosen version number. The Published Solutions (".dbrun") mirror the current solution but are accessible only in read-only mode, offering a secure backup of published applications.
→ Read more about Build and Publish.
This page provides a comprehensive guide on how to use diagnostic tools for project applications. These tools include the Property Watch, Trace Window, and Module Information, which offer insights into the status and operation of different modules within your application.
Property Watch is a tool designed to access and modify the system's tags and internal properties. With an Intellisense feature, it also provides a list of available objects related to a specific object type.
→ Read more about Runtime Diagnostics.
There are a few runtime objects that provide information about running the solution.
The Info namespace is the main location for the runtime status. The main objects on the namespace are:
Info.Solution: information about the solution that is running
Info.License: information about the license
Info.Module: information and start/stop command to Modules
Info.Trace(): displays a message on the TraceWindow
Info.TestMode: shows if the solution is running in Test Mode
The Server namespace has information about the server computer. The Client namespace has information about each client compute that runs a graphical interface. See Namespaces for the complete programming reference on runtime objects.
Starting and Stopping the Solution Execution
To start the solution execution, you need to launch the application or server, depending on the solution type. It is essential to monitor the system for any errors or issues during startup, as they may prevent the application from running correctly.
To stop the solution execution, you can use the appropriate command or interface provided by the runtime environment or the application itself. Make sure to shut down the application to avoid data loss or corruption.
To start the solution in production mode:
Configuration changes can be applied to the runtime environment to modify the behavior of the application. These changes can include modifying settings, adding or removing modules, or adjusting resource allocation. To apply configuration changes, follow these steps:
Restart the application or reload the configuration to apply the changes, depending on the capabilities of the runtime environment.