Overview
The Runtime Startup section
of the Designer Interfaceallows you to start and stop
thesolution execution
of the solution, specify
theexecution
profile you want to useprofiles, and customize
allconnection settings
for that execution.The settings defined here are also applied when the startup is executed via the Start Solution command line or when starting the solution as a Windows service. This section focuses on the various settings when using the Designer configuration tool. For advanced information to run solutions in production environments, refer to the page Solution Deployment.
On this page:
Table of Contents | ||||
---|---|---|---|---|
|
Runtime Startup Settings
. Settings defined here apply to all runtime scenarios including command line and Windows service startup.
Access: Runtime → Startup
Parent Page: Runtime Designer UI (Reference)
Main Commands
Execution Controls
Command | Function | Status Indicators |
---|---|---|
Run Startup | Starts the application | Button changes to Stop |
Stop | Stops the application | Button changes to Run |
Online Configuration | Apply changes in real-time | Must be connected to runtime |
Note:
Runtime Startup Page when All Features are enabled
Runtime Startup Page, when Basic Modules Filter is Selected
Note | ||
---|---|---|
| ||
Some specific configurations, including Windows Authentication and Windows Service, are exclusively available when Windows is selected as the Target Platform for the solution. This option unlocks the specific functionalities and security feature that are inherent and exclusive to Windows operational systems. |
Settings on this page define which profile the solution will use, communication ports, and other configurations. They allow control over starting and stopping the execution, as well as managing the online configuration.
Main Commands and Options
Run Startup
This command button starts the application.
Stop
This command button stops the application.
Online configuration
All changes must be saved before they
can appear on a screen.This is a setting you check to make changes apply immediately. You need to be connected to the running app for it to workappear in runtime when online configuration is enabled.
Execution Profiles
Execution Profiles allow for the dynamic replacement of database connections or device nodes during solution runtime, enabling smooth transitions between development, validation, and production environments.
The solution uses its main configuration in the Production profile without additional overrides. When you change from the Production Profile to any other profile in Runtime → Startup, this change will be reflected in the Startup Command line.
Execution Profiles
Development
Provides an environment with debugging and development tools enabled. Developers use this profile during the development and testing phases to test and troubleshoot the solution.
Production
Optimizes performance and stability for running in a production environment. Based on the selected profile, it automatically applies different database connections and device configurations.
The User can enable Validation and Custom profiles on Runtime / Execution Profiles. For detailed information, refer to the Runtime Execution Profiles.
Startup Port Settings
The startup port settings allow you to define the network ports used by the application, both for internal communication and external access via the web. You can activate automatic port allocation and configure authentication via Windows.
Startup Port Settings
The ports must be enabled and available on the server.
Main Port
Sets the port that each execution profile uses to access. By default, the Development profile uses the 3301 port, the Validation execution profile uses the 3201 port and the Production execution profile uses the 3101 port. These ports must be enabled and available on the server.
Auto Ports
Ensures that the software runs even when the specified main ports are unavailable. When enabled, and if the port defined as the Main Port is unavailable, the software will automatically search for and select an available port to use.
WA Port
Defines the port used by software platform for access with Windows Authentication.
Windows Authentication
Checks if the system can only accept Windows Authentication.
SSL Port
Enables the web port in the solution. By default, the port is set to 3111.
AutoStartup / Windows Service
Configures the solution to auto-start.
For Windows solutions, it will setup the solution to run as a Windows Service when the computers starts, without requiring users login on the sever. If the Solution is MultiPlatform, but you using it in a Windows Computer, it will also run as a Windows Service.
For MultiPlatform solutions on remote .NET 8 devices, it will setup the TWebServicesRunPrograms.json to start the solution when the TWebServices starts. Typically on Docker and Linux platforms the TWebServices.exe is set to run when the device is on, so you can manage it remotely. For more information on that configuration file, go to the TWebServices documentation.
Execution Environment
The execution environment allows you to choose between running the application locally or on a solution server. This section also includes settings for the MQTT broker, facilitating communication between IoT devices.
Execution Path Settings
Direct File Access
The Solution is launched accessing directly the Solution file, located on the local computer on ir a network file path.
When opening the solution using Direct Access, other instances of Designer will open in read-only mode.
Solution Server
Displays the IP address or the name of the computer where the solution is, based on the configuration of Solution Server in Solutions Manager > Server Information.
It can be the local or a remote computer, the Designer is connected with the TWebServices communication service, and multiple users can access the same solution configuration.
Path/Use Solution Path
Overrides the default execution path, which is the solution file location.
Used by the system to allow one station to automatically update the solution in the redundant pair when doing online solution changes and HotStart commands.
DataHub Service
Publish to a DataHub Service
When is checked, activate and share objects with a remote DataHub Service.
It requires a TagProvider Connection configured using the Data Hub Server Communication.
Select the environment-specific configuration:
Profile | Purpose | Default Port |
---|---|---|
Development | Debugging enabled, dev tools active | 3301 |
Validation | Testing environment | 3201 |
Production | Optimized for production | 3101 |
Custom | User-defined settings | User-defined |
The Production profile uses main configuration without overrides. Other profiles apply configured replacements at startup.
Startup Port Settings
Configure network ports for application access:
Setting | Description | Default |
---|---|---|
Main Port | Primary access port per profile | Profile-dependent |
Auto Ports | Auto-select if main unavailable | Disabled |
WA Port | Windows Authentication port | As configured |
Windows Authentication | Require Windows auth only | Unchecked |
SSL Port | HTTPS web access | 3111 |
AutoStartup/Windows Service | Run at system startup | Disabled |
AutoStartup Behavior
Windows Platform:
- Configures as Windows Service
- Starts without user login
- Runs under system account
Multiplatform on Remote Devices:
- Configures in TWebServicesRunPrograms.json
- Starts with TWebServices
- Enables remote management
Execution Environment
Execution Path Settings
Option | Description | Use Case |
---|---|---|
Direct File Access | Local file access | Single-user development |
Solution Server | TWebServices connection | Multi-user collaboration |
Path/Use Solution Path | Override default path | Redundancy configuration |
DataHub Service
Enable solution data sharing:
Setting | Function |
---|---|
Publish to DataHub | Share objects with remote DataHub |
DataHub Settings | Configure connection parameters |
DataHub Settings Dialog:
- Alias: Solution identifier
- Primary/Secondary Host: Server addresses
- Port: TCP communication (default: 30001)
- AccessKey: Authentication
Built-in Broker Settings
MQTT broker configuration:
Setting | Function |
---|---|
Publish to MQTT Broker | Make UNS visible to MQTT clients |
TMQTT Broker Settings | Configure security and options |
Startup Modules
Select modules to activate at startup:
Module | Function | Impact |
---|---|---|
Devices | Enable device communication | Required for field data |
Alarms | Enable alarm processing | Required for notifications |
Historian | Enable data logging | Required for trending |
Datasets | Enable database access | Required for queries |
Reports | Enable report generation | Required for documents |
Scripts | Enable script execution | Required for logic |
Displays | Launch WPF client locally | Opens TRichClient |
OpenBrowser | Launch web client | Opens default browser |
OPC Server | Enable OPC DA/UA server | External access |
Redundancy Settings
Configure high-availability environment:
Setting | Description | Format |
---|---|---|
Primary Server IP/Port | Main server address | IP:Port |
Secondary Server IP/Port | Backup server address | IP:Port |
Timeout | Switchover delay | Seconds |
On Primary Startup | Recovery behavior | Switch/Keep |
Replication | Data to replicate | Alarm/Tag Historian |
Recovery Options
- Switch back to primary: Auto-return when available
- Keep secondary active: Manual switchback required
Command Lines and URLs
Startup Command Line
TStartup.exe /solution:"path\solution.dbsln" /profile:1 /OnlineConfig:true /port1:3301
Parameters:
/solution:
- Solution file path/profile:
- 1=Dev, 2=Val, 3=Custom/OnlineConfig:
- Enable online changes/wa
- Windows Authentication/port1:
- Override port
Client Access
Client | Command/URL | Options |
---|---|---|
Rich Client | TRichClient.exe /port1:3101 | NoSplash, ViewOnly |
Smart Client | http://IP:Port/smartclient | SSL available |
HTML5 Client | http://IP:Port/html5 | SSL available |
Client Options
Option | Function |
---|---|
NoSplash | Skip splash screen |
WA | Windows Authentication |
SSL | Secure connection |
ViewOnly | Read-only mode |
Network Access
Accessing HTML5 from Other Devices
- Identify server IP (not 127.0.0.1)
- Ensure port accessibility
- Use URL:
http://ServerIP:Port/html5
- For SSL:
https://ServerIP:Port/html5
Example:
DataHub Services SettingsWhen the user clicks on this icon, it opens the DataHubService Settings dialog. This dialog allows configuring the connection between the solution and the DataHub Service, enabling data exchange between distributed solutions. The following configuration items are available in this dialog:
The Alias field identifies the Solution within the DataHub.
The Primary Host defines the main server handling the communication, while the optional Secondary Host provides redundancy.
The Port sets the TCP communication channel, defaulting to 30001.
The AccessKey field allows authentication control, ensuring only authorized runtimes can publish data.
Expand | ||
---|---|---|
| ||
For detailed information on the TagProvider Connection configuration check Data Hub Server Communication.
Built-in Broker Settings
Publish to Built-in MQTT Broker
When is checked, the UnifiedNamespace is made visible to the built-in TMQTTBroker.
The execution is very efficient, as all the Unified Namespace is made visible to Broker clients for subscriptions, but only when there is a client subscribing the data is published.
This icon opens the TMQTT broker settings, where you can customize security and other execution options.
As these settings are not applied dynamically, they will be used only in the next time the broker is started.
For more information on the built-in broker configuration go to Built-in MQTT Broker page.
Startup Modules
Startup Modules allow you to define which application components will be active at startup, ensuring that only the necessary modules are loaded, thus optimizing resources and performance.
Startup Modules
Select which modules will be started up when running the solution.
Devices
Enables Devices module.
Alarms
Enables Alarms module.
Historian
Enables Historian module.
Datasets
Enables Datasets module.
Reports
Enables Reports module.
Scripts
Enables Scripts module.
Displays
Enables Displays module. When starting it the local computer, open the TRichClient application show the solution displays, in Windows WPF.
OpenBrowser
When starting it the local computer, open the web browser pouting to the solution displays.
OPC Server
Enables the OPC Server.
Redundancy Enabled
Redundancy configurations allow you to define a high-availability environment, where a secondary server can take over operations in the event of a primary server failure.
Redundancy Enabled
Primary Server IP/Port
Enter the IP address and port of the primary server.
Secondary Server IP/Port
Enter the IP address and port of the secondary server.
Timeout
Connection timeout time in seconds. If reached, this will cause the system to switch to the secondary server.
On Primary Startup
Switch back to primary: When the primary instance becomes available again after a failure, the system will automatically switch back to using the primary instance.
Keep secondary active: Even after the primary instance is restored, the system continues to use the secondary instance until manually switched back.
Replication
AlarmHistorian: Replicates alarm history data to ensure that alarm events are preserved and accessible even if the primary instance fails.
TagHistorian: Replicates tag history data, which includes historical values of tags, ensuring data continuity and availability.
Command Lines and URLs
The command lines and launch URLs provide the commands and shortcuts necessary to launch the application and access different clients, such as RichClient, SmartClient, and HTML5 Client, ensuring flexibility in accessing the application.
Tip | ||
---|---|---|
| ||
Click the button to start the Client. |
Command Lines and URLs
Startup Command line
TStartup.exe: It's the executable file responsible for initiating the startup process.
/solution: Specifies the path to the solution file that will be run.
/profile: Defines the Execution Profile to be used. Refer to Execution Profiles for more details.
/profile:1 refers to the Development Execution Profile;
/profile:2 refers to the Validation Execution Profile;
/profile:3 refers to the Custom Execution Profile.
/OnlineConfig:true: Indicates whether the online configuration is enabled or not.
/wa: Enables the Windows Authenticator.
/port1: Specifies the port number used during the startup.
Rich Client command
TRichClient.exe: It's the executable file used to start the Rich Client.
/port1: Specifies the port number to be used by the Rich Client.
Smart Client URL
This URL is used to access the Smart Client interface via a web browser, allowing for interaction with the industrial solution using advanced, intelligent features. The IP address and port number define the network location of the service.
HTML5 Client URL
This URL provides access to the HTML5 Client interface. This allows users to interact with the solution using web technologies and ensures compatibility with modern web browsers.
NoSplash
When checked, suppresses the display of the splash screen during the startup of the application, potentially reducing the startup time.
WA
When checked, enables the Windows Authenticator for added security during the startup and operation of the solution on Windows operating systems.
SSL
When checked, enables Secure Sockets Layer (SSL) for encrypted and secure communication between the client and the server, protecting data integrity and confidentiality.
ViewOnly
When checked, sets the client to a read-only mode, where the user can view but cannot modify the configurations and data.
Accessing HTML5 Clients on Devices Connected to the Same Network
To access HTML5 clients from other devices on the same network, follow these instruction:
Understanding the Localhost Address
The address 127.0.0.1 is the loopback address or "localhost". It refers to the device where the application runs, such as the engineering workstation or the controller computer.
Network Configuration
Assume you have an engineering workstation where your solution runs. This workstation has a specific IP address on the local network, different from 127.0.0.1.
Accessing from Other Devices
Open any browser on the target device (notebook, smartphone).
Enter the IP address of the engineering workstation followed by the port used by the application. The URL format will be http://
<Workstation-IP>:<Port>/html5
.
Practical Example
Identifying the Workstation's IP Address:
Assume the engineering workstation's IP address is 192.168.0.8 and the application uses port 3201.
Accessing the Application:
In the browser on the target device (notebook, smartphone), type the following- Server IP: 192.168.0.8
- Port: 3201
If SSL is enabled, use https://192.168.0.8:3201/HTML5.
This process will allow you to access the HTML5 application running on the engineering workstation from any device connected to the same local network.
The software platform allow you monitor the users connected at runtime. For detailed information, refer to the Security RuntimeUsers.
title | Adjusting Monitor Scale or Resolution in HTML5 Client |
---|
Monitor Access
Direct browser access to runtime monitor:
http://ServerIP:Port/html5/?Monitor=Runtime
Startup Procedure
Step 1: Launching TStartup.exe
- Loads the Solution
- Reads Solution Configuration
- Parses Command Line Parameters
- Activates Main Process TServer.exe
Step 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.
Step 3: Modules Startup
Other modules (Historian, Alarms, Devices, Scripts, Datasets, Reports) start execution by reading solution configuration and establishing connection with the main process.
Step 4: Applying Execution Profiles
Modules behave according to Execution Profile definitions. Example:
- Development: Temporary local SQLite database
- Production: SQL server for production data
Step 5: Solution Designer Automatic Connection
Designer automatically connects to running solution for monitoring and diagnostics.
Step 6: Opening Client-Side Displays
Operations displays (HTML5 or WPF) can be opened from any remote computer.
Step 7: Applying Online Changes and Hot Updates
System applies configuration changes without disrupting runtime.
Platform-Specific Features
Features exclusive to Windows Target Platform:
- Windows Authentication
- Windows Service configuration
- OPC Classic support
- Specific security features
See Also
- Runtime Designer UI (Reference) - Parent section
- Runtime Execution Profiles (Reference) - Profile configuration
- Runtime Build and Publish (Reference) - Solution deployment
- Solution Deployment (Guide) - Production setup
Runtime Startup Page when All Features are enabled
Runtime Startup Page, when Basic Modules Filter is Selected
In this section:
Page Tree | ||||
---|---|---|---|---|
|