Overview
This guide covers starting, monitoring, and managing runtime execution, including execution profiles, online changes, and troubleshooting.
Prerequisites
- Solution configured in Designer
- Appropriate runtime license
- Understanding of execution profiles
Table of Contents maxLevel 2 minLevel 2 indent 10px exclude Overview style none
Starting the Runtime
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 |
Startup Sequence
- TStartup.exe loads solution and parses parameters
- TServer.exe starts real-time database
- Modules initialize (Historian, Alarms, Devices, Scripts)
- Execution profile applies settings
- Client connections become available
Command Line Parameters
TStartup.exe /solution:"MySolution" /profile:Production /username:admin /redundancy:primary| Parameter | Description |
|---|---|
| /solution: | Solution name or path |
| /profile: | Development/Validation/Production |
| /username: | Credentials if required |
| /redundancy: | Primary/secondary/standalone |
Execution Profiles
Profile Configuration
| 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 |
Configuring Profiles
- Go to Runtime → Execution Profiles
- Select profile to configure
- Set database connections
- Configure historian storage
- Define alarm database
- Adjust communication ports
Monitoring Runtime Status
Status Information
| 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 |
Using Info Namespace
// Check runtime status
bool isRunning = @Info.Module.IsRunning;
string solution = @Info.Solution.Name;
bool testMode = @Info.TestMode;
// Write trace message
@Info.Trace("Runtime started successfully");
// Check license
int tagCount = @Info.License.TagCount;Online Configuration Changes
Hot Reload Capabilities
| Apply Without Restart | Requires Restart |
|---|---|
| - Tag values and limits - Display modifications - Script logic updates - Alarm conditions - User permissions | - Device channels - Database connections - Port assignments - Module enable/disable - License changes |
Applying Online Changes
- Make changes in Designer
- Save modified items (Ctrl+S)
- Click Apply Online Changes
- Select modules to update
- Confirm application
Client Connections
Connection Types
| Client Type | Setup | Access Method |
|---|---|---|
| Web Client | No installation | http://server/solution |
| Smart Client | Auto-download | Click-once deployment |
| Rich Client | Full installation | Desktop application |
| Mobile | Responsive design | Browser on device |
Build and Publish
Build Process
- Go to Runtime → Build
- Select build options: • Compile scripts • Validate displays • Check references
- Click Build
- Review output for errors
Publish Process
- Go to Runtime → Publish
- Set version number
- Choose publish options: • Read-only (.dbrun) • Encrypted • Include resources
- Click Publish
- Deploy .dbrun file
Runtime Diagnostics
Diagnostic Tools
| 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 |
Trace Levels
- Error - Critical issues only
- Warning - Warnings and errors
- Info - General information
- Debug - Detailed diagnostics
Stopping Runtime
Shutdown Methods
| 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 |
Troubleshooting
Common Issues
| Issue | Check | Solution |
|---|---|---|
| Runtime won't start | 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 |
Best Practices Checklist
Startup
- Use appropriate profile for environment
- Test in Development before Production
- Document profile settings
- Backup before changes
Monitoring
- Set up critical error alerts
- Monitor resource usage trends
- Archive trace logs periodically
- Check module health daily
Online Changes
- Test changes in Development first
- Apply during low-activity periods
- Have rollback plan ready
- Document all changes
| Excerpt Include | ||||||
|---|---|---|---|---|---|---|
|
In this section...
| Page Tree | ||
|---|---|---|
|
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.
- Launching TStartup.exe
- Loads the Solutions
- Reads the Solution Configuration
- Parses Command Line Parameters
- Activates the Main Process TServer.exe.
- Starting the Real-Time Database
- TServer.exe starts by loading solution objects, tags, templates, and assets into the memory. A communication service is established, allowing other modules to start and connect.
- Modules Startup
- The other modules, such as Historian, Alarms, Devices, Scripts, Datasets, and Reports, then start their execution by reading the solution configuration and establishing a connection with the main process.
- Applying Execution Profiles
- As the modules start, they behave according to the definitions in the Execution Profiles. For instance, in Development mode, a temporary local SQLite database might be used for alarm records, while in Production mode, the Alarm Database is automatically mapped to a SQL server.
- Solution Designer Automatic Connection
- The Solution Designer automatically connects to the running solution, enabling users to monitor progress, make adjustments, and troubleshoot issues as needed using the Monitor and Diagnostics pages.
- Opening Client-Side Displays
- Operations displays, using HTML5 from any browser or high-performance WPF graphics pages, can be opened from any remote computer connected to the server.
- Applying Online Changes and Hot Updates
- During execution, the system can apply online configuration changes and hot updates without disrupting the runtime environment. This capability allows users to adapt the solution to changing requirements while maintaining high system availability.
Configuring the Runtime Environment
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.
Runtime Configurations
Runtime Startup
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
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.
Build and Publish
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.
Runtime Diagnostics
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.
Server And Client Namespaces
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 ModeThe 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.
Working with the Runtime
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:
- Go to Runtime / Startup.
- Click the Run Startup button
Applying Configuration Changes
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:
- Identify the configuration file or settings for your application.
- Modify the configuration settings as needed.
...