Page History
...
For architecture context and sizing, see Platform Architecture Reference and Deployment Scenarios.
Other deployment modes (Linux, Docker/Kubernetes, edge devices, mobile clients) are supported but outside the scope of this runbook. See the links in section 10 below.
...
- Runtime placement — dedicated server (recommended) or shared application server. The runtime is a single executable plus supporting services.
- Service account — a domain service account (preferred) or Local System. Domain accounts allow auditing and controlled access to network resources, databases, and file shares.
- Historian database — built-in SQLite (small deployments), external SQL Server / PostgreSQL / Oracle (typical), or time-series databases (InfluxDB, TimescaleDB).
- Ports and firewall — see the Network Ports section below. Open only what you need, inbound only where required.
- License model — per-server licensing with online or offline activation. See Licensing Procedures Reference.
- High availability — optional runtime redundancy (primary/secondary). See Redundancy Reference.
2. Install
Prerequisites
- Windows Server 2019 or later (Windows 10 / 11 for small deployments)
- .NET Framework 4.8 (included in Windows 10+)
- .NET 8 runtime (required for cross-platform runtime, AI integration, and DataHub)
- Visual C++ 2015-2022 Redistributable (bundled with the installer)
- Administrator rights on the target machine
...
Run the signed installer and follow the wizard. Default install location is C:\Program Files\Tatsoft\FrameworX\. Full step-by-step reference: Installation and Licensing Reference.
Silent / unattended install
...
The .NET 8 runtime can also be deployed by copying the installation folder. Useful for portable deployments, custom update pipelines, and locked-down environments where MSI-style installs are blocked. See Runtime Installation Reference.
3. Configure
Install folders
...
Location | Purpose |
|---|---|
| Executables and supporting libraries (read-only after install) |
| User-facing content: solutions, exchange folder, screenshots |
| Machine-scoped operational data: service state, cache (new installs) |
Full layout reference: Installation Folders and Utilities Reference.
Run the runtime as a Windows Service
...
- Designer UI — Solution Center has a button to install the runtime as a service
- Command-line — scripted install with elevated PowerShell (see Runtime Startup Reference)
Run the service under a dedicated domain account where possible. The account needs:
...
Web client, REST endpoints, and runtime HTTP services are hosted by the built-in web server. Configure ports, TLS certificates, and optional reverse-proxy routing as described in Web Server Configuration Reference.
Licensing
Online activation is used for internet-connected servers. Offline activation (license file transfer) is supported for air-gapped networks. See Licensing Procedures Reference.
Network ports
Typical enterprise deployment ports:
...
Default runtime and web ports are configurable. Exact values depend on solution configuration — see Runtime Startup Reference and Server Configuration Reference.
4. Monitor
Log locations
The runtime writes trace logs by default to C:\Users\Public\Documents\FrameworX\TraceLogs\. New installs can use C:\ProgramData\Tatsoft\FrameworX\Logs\ instead — recommended for enterprise deployments because it matches Windows conventions for operational data and is automatically scanned by most log-collection agents (Splunk forwarder, Datadog agent, Azure Monitor, ELK).
...
The built-in System Monitor exposes live metrics on tags, modules, memory, and client sessions. See Runtime System Monitor Reference and Runtime Diagnostics Reference.
5. Update & Rollback
Updates within the same major version (e.g. 10.1.5 to 10.1.6) can be applied by running the newer installer over an existing installation. The installer supports side-by-side versioning with rotation, so a minor update can be rolled back by re-running the previous installer. Full semantics: Managing Updates and Multiple Versions Reference.
Before updating a production server:
...
Production deployments should follow the hardening checklist. Topics include TLS configuration, authentication (local users, Windows authentication, Active Directory), role-based access control, secrets storage, audit logging, and network segmentation.
- Security Hardening Reference — detailed procedures
- Security Hardening Compliance How-to — step-by-step hardening guide
- IEC 62443 Compliance How-to — industrial cybersecurity standard
- NERC-CIP Compliance How-to — critical infrastructure
- FDA 21 CFR 11 Compliance How-to — regulated industries
8. Automate
...
Symptom | First place to look |
|---|---|
Service won't start | Windows Event Log (Application) for service source, then TraceLogs folder |
Port conflict |
|
License error | Event Log source |
Client can't connect to runtime | Firewall rule on runtime port, |
Web client blank / auth error | TLS certificate validity, browser console, Web Server Configuration Reference |
Database connection fails | Service account permissions, connection string, firewall rule to DB server |
Deep reference: Runtime Troubleshooting Reference.
When opening a support ticket, collect: Event Log entries (Application log, source FrameworX), the most recent TraceLog file, the install log, the output of Get-Service for the runtime service, and the solution build number.
...
This runbook focuses on typical enterprise Windows Server deployments. Other modes are supported — see the dedicated references:
- Container Deployment Reference — Docker and Kubernetes
- Linux Deployment Reference — .NET 8 on Linux servers and edge devices
- Redundancy Reference — primary/secondary runtime pairs
- SecureGateway Services Reference — multi-site communication routing
- Mobile App — mobile client deployment