Runtime Environment

Purpose and Key Concepts

The purpose of the Runtime and Solution Execution is to actively operate the configured Solutions, execute real-time data-acquisition, scripts, alarms, and all Solution configured items from all Modules. It is an essential and final phase of the Solution development, effectively delivering its functionality.

Runtime

The term Runtime, or Runtime environment, refer to the execution environment operates. It is used to do a differentiation from the Configuration (or Engineering, or Development) phase. The term Runtime is also use to refer the software components and computer processes in execution.

Execution Profile

An execution profile is a set of configurable settings that allows customization during runtime of Database Connections, Device Network addresses,  facilitating the management of different environment. It allows to setup the connections used during the Development, Validation and Production phases, to their settings, still having only solution configuration file.

Online Configuration

This feature enables real-time modifications to be made to a running solution without stopping its execution. It allows users to adapt the solution to changing requirements, improving flexibility and responsiveness.

Hot Updates

Hot updates are a subset of online configuration, permitting the application of offline solution changes without disrupting the runtime environment. They are essential for maintaining solution stability and avoiding downtime while ensuring the solution stays up-to-date with the latest changes.

Build and Publish

The build and publish process involves compiling solution code and creating a read-only version of the solution, which can be distributed to end-users. This step is critical in ensuring the solution is ready for deployment and accessible to the intended audience.

Understanding the solution Execution

Real-time in-memory Database

When the solution is in execution, the realtime-variables for the application, i.e. Tags, Templates, Assets, are loaded into memory, and it acts as central point of reference, to other functional modules can request values from those variables, or publish values, as they perform its function. 

The computer process and executable responsible to hold the Real-time database is the TServer.Exe.That application can as a Windows Service, or it can be deployed to Linux and other  supported operating systems.

Startup Steps

The are various ways to start the execution of a Solution. You can start it manually by going to the Runtime→Startup page. The various other ways to setup its execution are detailed in the chapter Deploying the Application.

When you click on the Start button on the Designer interface, the follow steps are executed:

1. The TStartup.exe application is launched

This utility is a solution loader, it will read the Solution Configuration for Startup, accordingly the Execution Profile selected, parse \ command line parameters, and active the main process TServer.exe

2. Starting the Real-Time DatabaseThe TServer.EXE starts

The TServer.EXE starts, loading  solution objects, tags, templates, assets, into memory, and a communication service is stablished allowing other modules to start and connect for that. 

3. Modules Startup

The other modules defined to start, like Historian, Alarms, Devices, Scripts, Datasets and Reports, start their execution, reading the solution configuration and establish connection with the main process. 

4. Execution Profiles are applied

When the modules are starts they will behave according the definitions on the Execution Profiles. For instance, you can estou that in Development mode, you use a temporary local SQLite database for your alarm records, and on the Production mode, the Alarm Database is automatically mapped to a SQL server. 

5. Solution Designer Automatic Connection

The Solution designer automatically connects to the running solution, allowing users to monitor progress, make adjustments, and troubleshoot issues as needed using the Monitor and Diagnostics pages. 

6. Opening Client-Side Displays

The Operations display, using HTML5 from any type of Browser, or high performance WPF graphics pages can be opened from any remote computer connected with the server. 

7. 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 enables users to adapt the solution to changing requirements and maintain high system availability.

Configuration and Runtime Process Isolation

In a software development solution, it is essential to maintain stability and prevent interference between various stages and components of the solution. Configuration and runtime process isolation is a technique used to achieve this goal, ensuring that the configuration and development aspects of the solution do not negatively impact the solution's runtime environment.

The configuration process involves setting up parameters, profiles, and other solution settings, which define how the solution should operate. On the other hand, the runtime process focuses on executing the solution and maintaining optimal performance. By isolating these processes, developers can modify configurations and test new features without disrupting the running solution.

This isolation is achieved through several means:

1. Separate Environments: By using separate environments for development, testing, and production, it is possible to work on solution configurations and features without affecting the runtime environment. Any changes made during development are not reflected in the runtime environment until they are thoroughly tested and deployed.

2. Containerization: Containerization technologies, such as Docker, allow developers to create isolated containers for different parts of the solution. This approach ensures that modifications made in one container do not impact the runtime environment or other containers.

3. Version Control: Implementing version control helps manage solution configurations and code changes. This method allows developers to experiment with configurations, roll back to previous versions, and track changes without affecting the runtime environment.

4. Access Control: By implementing access control mechanisms, it is possible to restrict modifications to the runtime environment and configuration settings. This approach ensures that only authorized personnel can make changes, reducing the risk of accidental disruptions or unauthorized access.

By employing configuration and runtime process isolation, solutions can maintain stability, enhance security, and minimize disruptions during the development and execution phases. This practice allows for continuous improvements, troubleshooting, and adjustments without compromising the solution's overall performance.

Runtime Execution Configuration

The Runtime Section in the Solution Designer allows to the define the settings to start the execution the application, perform solution verification and backup, and diagnostic the execution. 

The User interface for Runtime configuration,  is composed by four sub-section that will be covered in this chapter. They are:

• Startup 
• Execution Profiles
• Diagnostics
• Build And Publish

Startup Parameters

Those parameters define which Profile the solution will use, Communication Ports and other settings. It allows to control the starting and stopping of the execution, as well the Online Configuration.

Execution Profiles

Development and testing profiles are used to manage different environments within a solution. These profiles enable developers to work on new features, bug fixes, or improvements while keeping the production environment stable. By configuring separate profiles for development and testing, teams can maintain code quality and avoid deploying untested changes to the live environment. This separation also facilitates the debugging process and helps to identify issues that may arise during development. You can learn more about each of the profiles at Execution Profiles.

Diagnostics

Diagnostics on runtime execution are essential for monitoring a solution's performance, identifying potential issues, and ensuring overall stability. By implementing logging, performance metrics, and error reporting, developers can gain valuable insights into the execution process. These insights can be used to troubleshoot problems, optimize performance, and maintain system health. Effective diagnostic tools are crucial for maintaining a reliable and high-performing solution. For more information on Diagnostics, see Diagnostics Tools.

Build and Publish

Publishing read-only versions of a solution is crucial for maintaining a stable production environment while allowing developers to work on new features and bug fixes. The process involves preparing the solution for publication, creating a snapshot or branch, building and testing the solution, packaging the build, marking it as read-only, and deploying it to the production environment. 

This approach reduces the risk of unintentional changes, simplifies rollback processes, and separates development and production environments. Adhering to best practices like regular release scheduling, using version control, thorough testing, documentation, and clear communication ensures a smooth and efficient publishing process for read-only versions. To learn more, visit Build and Publish.

Working with the Runtime

Working with the runtime is a key aspect of software development, as it involves managing the execution of a program while it's running. This includes starting and stopping the execution, switching execution profiles, and applying configuration changes. This comprehensive guide provides an overview of best practices and techniques for efficiently 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's 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 gracefully shut down the application to avoid data loss or corruption.

To start the solution is production mode,

• Go to Runtime → Startup
• Click the Run Startup button

There are a few customizations you can do on how the solution shall be executed, such as if the solution will run in your local computer or start in a remote Server computer, which modules will be loaded, and some other settings described in this section.

Startup Computer

On Run → Modules, you should see two options regarding the displays affected by this setting:

• If Displays is selected - A RichClient is opened on the solution server when the solution is started
• If LocalDisplays is selected - A RichClient is opened on local PC when the solution is started

There are a few ways to stop the running Solution. All those options assume the current user has Security Authorization to shutdown the solution. For information on Security, refer to Security, Users and Roles.

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.
• Restart the application or reload the configuration to apply the changes, depending on the capabilities of the runtime environment.

Common Issues and Solutions

• Performance bottlenecks: Slow solution execution can be caused by a variety of factors, such as inefficient code or inadequate hardware resources. To resolve this issue, optimize your code, allocate more resources, or employ parallel processing techniques.
• Configuration errors: Incorrect settings in the solution configuration can lead to unexpected behavior or failure. Review your configuration files, verify the parameters, and ensure they adhere to the documentation.
• Runtime environment mismatch: Incompatibilities between development and production environments may cause issues during runtime. To address this, ensure that all dependencies are consistent across environments and use containers or virtual machines for environment isolation.
• Module conflicts: Conflicts between modules can lead to unexpected behavior or crashes. To resolve this, check for duplicate or outdated modules and ensure that your modules are compatible with each other.
• Database connectivity issues: Problems connecting to the real-time database can be caused by network issues, incorrect credentials, or misconfigured database settings. Verify the database connection settings, ensure the database server is accessible, and check the credentials.
• Client-side display errors: Issues with client-side displays can stem from incompatible browser versions, outdated JavaScript libraries, or improperly configured display settings. To fix this, ensure your solution supports the target browser versions, update your libraries, and double-check display settings.
• Hot updates not applied: If hot updates are not being applied correctly, confirm that your solution is configured to accept online changes and verify the update mechanism is functioning as expected.
• Build and publish failures: Errors during build and publish processes may be due to incorrect settings, code issues, or dependency problems. Review the build and publish configuration, fix any code issues, and ensure all dependencies are resolved.

Troubleshooting and Best Practices

Runtime issues can occur during the execution of the application, such as crashes, performance problems, or unexpected behavior. To troubleshoot these issues, follow these steps:

• Review the application logs for any error messages or warnings.
• Use debugging tools to inspect the state of the application at runtime.
• Monitor system resources, such as CPU, memory, and disk usage, to identify potential bottlenecks or resource constraints.
• Consult the documentation or support resources for known issues and solutions.
• Make sure you're using appropriate execution profiles for different stages of the development lifecycle.
• Apply configuration changes carefully, always testing before deploying to production.
• Document any custom configurations or modifications for future reference.
• Keep the runtime environment up to date with security patches and software updates.

Info, 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 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.

In this section: