Directory structure and file locations created by FrameworX installation.
Parent Page: Installation & Licensing (Reference)
Overview
This page explains how to install and manage the software, including system requirements, installation steps, version handling, and uninstallation 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.
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. |
Product Installation Folders (Reference)
Directory structure and file locations created by FrameworX installation.
Parent Page: Installation & Licensing (Reference)
Executables Installation
Default location: C:
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.
.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.
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
The installer creates a folder under\Program Files (x86)\
Tatsoft\
FrameworX\
Custom paths can be selected during
theinstallation.
ProductUser Document Folders
Created on
User DocumentsThe 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.
first execution under <User>\Documents\FrameworX\
:
Folder | Purpose |
---|---|
Demos | Demo solutions from installer |
Product Folders under <User>\Documents
Folder name
Usage
Demos
Solutions | Default location |
for new solutions |
ThirdParty |
Third-party extension libraries for server |
execution |
ToolsSettings |
Product tool configurations |
Utilities |
Command-line |
Utilities
utilities |
Public Document Folders
Created under C:\Users\Public\Documents\FrameworX\
:
Folder | Contents |
---|---|
MachineSettings | Settings for all users on machine |
SystemSolutions | Library.dbsln (Symbol Library), Monitor.dbsln (Monitoring tools) |
Templates | Solution templates - add .dbsln files for custom templates |
TraceLogs | Diagnostic logs and exception reports |
Transfers | Import/Export/Upload/Download operations |
Installed Utilities
Located in Utilities
folder:
Utility | Function |
---|
Installed Command-line Utilities
Name
AutoStartClient.exe |
Auto-start web pages or thin clients based on server status |
CertificateConverter.exe |
Convert .pem to .pfx |
Read more at Certificate Converter section.
certificates for MQTT drivers | |
DisableTaskSwitchProtection.bat | Allow task switching (Rich Clients) |
EnableTaskSwitchProtection.bat | Prevent task switching (Rich Clients) |
RemoveAllServices.bat |
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.
Remove all installed services (TWebServices, Hardkey |
, TStartup) |
StartRichClient.bat |
Launch Rich Client locally |
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
Product Folders under / Users / Public / Public Documents (Common Documents)
Folder name
Usage
MachineSettings
Settings that apply to all users on that machine.
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.
Start solution execution locally | |
StartWebServices.bat | Start TWebServices in user mode |
Solution Creator.exe | Solution creation utility |
TDatabaseBuilder.exe | SQLite database administration |
Custom Installation Paths
For Linux/Docker deployments, create custompaths.txt
in installation folder:
MyDocuments=<folder>
CommonDocuments=<folder>
CommonApplicationData=<folder>
Typically points to memory areas outside Docker image for read/write access
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 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>
.
In this section:
Page Tree | ||||
---|---|---|---|---|
|