Overview
This page
provides information on installingexplains how to install and manage the software
platform,
encompassing theincluding system requirements, installation steps,
management of multiple product versionsversion handling, and
guidelines for uninstalling. It also includes detailed instructions for managing the installation using .EXE and .MSIX files. These files facilitate the installation process, allowing users to choose the best method that suits their needs, whether a traditional .exe setup or the modern .msix package for Windows applicationsuninstallation procedures. It provides clear guidance to ensure a smooth setup process using the standard Setup.EXE installer.
On this page:
| Table of Contents | ||||
|---|---|---|---|---|
|
Systems Requirements
Runtime Solutions
Specification (miniumum) | Multiplatform Solution | Windows Solution |
|---|---|---|
.NET Framework | .NET 8 | .NET 4.8 and .NET 8 (for Web Displays) |
RAM | 512 MB | 2 GB |
Disk space | 100 MB | 1 GB |
.NET Framework | .NET 8 | .NET 4.8 and .NET 8 (for Web Displays) |
Designer, Configuration Tools
The table below shows the system requirements for properly installing the software platform.
Specification | Minimum | Recommended |
|---|---|---|
CPU | Intel Core 2 Duo | Intel Core i7 |
RAM | 4 Gb | 16 Gb |
Disk space | 2 Gb | 256 Gb |
Display Resolution | 1024 x 768 | 1280 x 1024 or higher |
Platform | Windows 10 | Windows 10 or newer |
.NET Framework | .Net Framework 4.8 | .NET Framework 4.8 and .NET 8 |
The .NET 8 Desktop Runtime must be installed for solutions that include web-based displays or when deploying to Linux.
Check out the requirements for the .NET Framework.
FrameworX-Install.MSIX vs FrameworX-Setup.Exe
We support two Microsoft technologies for installation: MSIX and .EXE.
This section presents the benefits and constrains of each method, so you can select the one more suitable to your environment.
MSIX Installation Benefits
- It follows the newer Microsoft standards and is likely to receive ongoing improvements.
- The installation is significantly faster than the legacy Setup.EXE, with typical installation times ranging from 8 to 90 seconds, depending on the computer and the applications running.
- Updates and removal of the application are also faster.
- It is designed with security in mind, so the installation folder is standardized (\Program Files\WindowsApps) and is installed only for the Windows user logged in during the installation.
MSIX Installation Constraints
- It requires Windows 10 version 1709 or newer, or Windows Server 2022 or later.
| Info |
|---|
If the specifications of MSIX meet your environment's needs, this is our recommended installation process. |
EXE Installation Benefits
- Suitable for environments that do not support the new MSIX standard.
- Ideal for production environments such as factory-floor servers or data centers, where more control over the installation process is needed.
- Allows customization of the installation folder.
- Installs the application for all users on the computer, making it more convenient in multi-user environments.
EXE Installation Constraints
- Slower installation times compared to MSIX.
- Updates and removal processes may take longer.
- Does not offer the same enhanced security as the MSIX method, as it does not restrict installation to a specific user or folder.
Installing with MSIX file
When you install FrameworX for the first time, just click Install. It takes around a minute, or much less in some computers. You'll need to manually authorize firewall ports during installation.
| Warning | ||
|---|---|---|
| ||
Before installing the new version, remove the previous installation to prevent conflicts. The update of Security Certificates for code signing may cause the system to treat it as a different product. Removing the prior installation also speeds up the setup process by avoiding incremental updates that takes longer as it verifies all files. |
User Preferences configuration
Upon first opening a solution, you will set up the User Preferences.
Installing Using Setup.EXE file
This type of installation can take a few minutes but is significantly faster than the 9.2 version. You'll need to manually authorize firewall ports during installation.
Managing multiple versions installations
The versions 9.2 and Version 10 use completely independent folders, and they can be added, removed, or updated independently.
When installation an update version 10, in top of an existing one, it is recommended to first install the previous v10 installation.
.NET 8 Installation
.NET 8 is required to create solutions to other operating platforms like Linux, and to edit displays to show on web browsers.
If you receive a warning that .NET 8 is not available on your computer, you still will be able to work with Windows-only solutions and displays.
To install the .NET 8, follow the link in the installer message, or you can find the .NET 8 Desktop Runtime installer from Microsoft here: https://dotnet.microsoft.com/en-us/download/dotnet/8.0. Be sure to pick the version that matches your CPU architecture, which is likely x64. (And don't pick the "SDK" or ".NET Runtime" or other versions - just the ".NET 8 Desktop Runtime")
Uninstalling
Windows provides multiple ways to uninstall applications, ranging from the classic Control Panel to modern Settings.
Uninstalling
Windows provides multiple ways to uninstall applications, ranging from the classic Control Panel to modern Settings. The ideal method depends on whether the application is managed by the Microsoft Store (.msix) or the traditional Windows installer system (.exe).
Applications (.msix)
Start Menu
- Right-click on the application icon.
- Select "Uninstall".
- Confirm the action in the pop-up dialog.
Settings
- Open the Start menu and go to "Settings > Apps > Apps & features".
- Find the desired application and click on it.
- Click "Uninstall" and confirm the action.
Applications (.exe)
Control Panel
- Open the Control Panel and go to "Programs and Features".
- Select the desired application and click on "Uninstall".
- Follow the on-screen instructions to complete the uninstallation.
Start Menu
- Right-click on the application icon.
- Select "More" > "Uninstall".
- Confirm the action in the pop-up dialog.
Only that version's specific subfolder is uninstalled when you uninstall a version.
The main folder (FrameworX) remains untouched, you can continue running the Welcome page and open Solutions in another version.
The main folder (FrameworX) will always have the last (newest) version installed. This is why the solution window continues with 9.1 even if you uninstall fs-9.1.
There is no way to roll back the Welcome/Solution Manager because the files are overwritten.
Instalation Folders
Executables Installation Folder
Using the Microsoft App standard, the MSIX The installer creates a folder under \Program Files (x86)\WindowsApps\ for the product. This folder should not be accessed directly by users. Installation or removal of the product should be done using the Windows Add/Remove Apps utility.When using the Setup.Exe the installation for is \<Company>\Product\ or at the custom path selected during the installation.
Product Folders Created on User Documents
The first time the product is executed in the computer, it automatically creates various Folders under the Documents special folder, using the product name as the initial node.
Product Folders under <User>\Documents | |
|---|---|
Folder name | Usage |
Demos | Default location for Demo solutions included in the installer |
Solutions | Default location when creating new solutions. |
ThirdParty | Default folder to add third-party extension libraries for server side execution. |
ToolsSettings | Contains configuration files for the product tools |
Utilities | Folder with command-line product utilities. |
Utilities
Installed Command-line Utilities | |
|---|---|
Name | Usage |
AutoStartClient.exe | Service to automatically start WebPages or ThinClients in stations according its server status. Read more on Remote Clients Setup. |
CertificateConverter.exe | Converts Security Certificates with extension .pem to .pfx, in order to be used on the MQTT communication drivers. The syntax to execute is: CertificateConverter.exe /certificate:<.pem CertificateFilePath> /key:<.pem CertificateKeyFilePath> /password:<Password for .pfx certificate> Read more at Certificate Converter section. |
DisableTaskSwitchProtection.bat | RichClients only, disables the operator to force Windows to switch the Displays module to other applications. |
EnableTaskSwitchProtection.bat | RichClients only, enables the operator to force Windows to switch the Displays module to other applications. |
RemoveAllServices | Remove all installed services (TWebServices, Hardkey and TStartup) |
StartRichClient.bat | Starts the RichClient in the local computer. The bat file is expected to receive the arguments as configured in Runtime Startup page. |
StartRuntime.bat | Starts the execution a solution in the local computer. The bat file is expected to receive the arguments as configured in Runtime Startup page. |
StartWebServices | Starts the TWebServices service in user mode. When in Windows, this application is typically setup to run as a windows service. |
Solution Creator | Starts the Solution Creator utility. |
TDatabaseBuilder | Starts the Database Admin for SQLite database. |
Product Folders Created on Public Documents
Contains the templates available to use when creating new solutions. Users can add their own solutions (.dbsln) to use as. template.
Product Folders under / Users / Public / Public Documents (Common Documents) | |
|---|---|
Folder name | Usage |
MachineSettings | Settings that apply to all users on that machine. |
Templates
SystemSolutions |
The file Library.dbsln, in that folder, holds the Symbol Library, displays and scripts templates, and it is where the documents are saved using the "Export do Library" command in the Designer. |
The file Monitor.dbsln is where you can customize the SystemMonitor, AlarmMonitor, and TrendMonitor monitoring tools. | |
Templates | Contains the templates available to use when creating new solutions. Users can add their own solutions (.dbsln) to use as a template. If you add your solutions files to this folder, they will be presented an option for template, when creating new solutions. |
TraceLogs | Folder used by product diagnostics to report exceptions and configured traces. |
Transfers | Folder used in Download, Upload, export and Import operations. |
Custom Installation Paths
In some scenarios, like Linux or Docker deployment, it may be necessary to change the system defaults.
That can be accomplished creating the a CustomPaths configuration file: custompaths.txt, at the main installation folder where the binaries are located.
Each line of the file, a customization folder is setup:
- MyDocuments=<folder>
- CommonDocuments=<folder>
- CommonApplicationData=<folder>CustomLogTransfers=<folder>
Typically those paths are setup to point to a memory area, outside the docker image, where you can read and write data.
In this section:
| Page Tree | ||||
|---|---|---|---|---|
|