Overview

...

...

Installation Steps

Pre-Installation Preparation

System Verification

1. Check System Requirements
   • Verify hardware specifications meet minimums
   • Confirm OS version and updates
   • Validate .NET Framework installation
   • Check available disk space
2. Prepare Environment
   • Close all running applications
   • Disable antivirus temporarily (re-enable after)
   • Ensure administrator privileges
   • Back up existing solutions if upgrading
3. Download Installation Files
   • Get latest installer from support portal
   • Verify file integrity (MD5/SHA checksum)
   • Extract files if compressed
   • Review release notes

Windows Installation

Standard Installation

1. Launch Installer
   • Right-click setup.exe → Run as Administrator
   • Accept UAC prompt
   • Select installation language
2. Installation Wizard
   • Welcome Screen - Click Next
   • License Agreement - Read and accept terms
   • Installation Type:
     • Complete - All components (recommended)
     • Custom - Select specific components
     • Server Only - Runtime without Designer
3. Component Selection (Custom only)
   • Core Components:
     • FrameworX Runtime Engine
     • Solution Center
     • Designer Environment
   • Optional Components:
     • Web Server Components
     • Sample Solutions
     • Documentation
     • Development Tools
4. Installation Path
   • Default: C:\Program Files\FrameworX 10.1\
   • Custom path supported (avoid spaces)
   • Requires minimum 5 GB free space
5. Database Configuration
   • Embedded SQLite - Default, no configuration
   • External SQL Server:
     • Server name/IP
     • Authentication method
     • Database name
     • Test connection
6. Service Configuration
   • Service Account:
     • Local System (default)
     • Network Service
     • Custom domain account
   • Startup Type:
     • Automatic (recommended)
     • Manual
     • Disabled
7. Complete Installation
   • Review summary
   • Click Install
   • Progress bar shows status
   • Installation log created

Command Line Installation

Silent installation for automation:

cmd

setup.exe /S /V"/qn INSTALLDIR=\"C:\FrameworX\" ADDLOCAL=ALL"

Parameters:
/S              - Silent mode
/V              - Pass parameters to MSI
/qn             - No UI
INSTALLDIR      - Installation path
ADDLOCAL        - Features to install
DBTYPE          - Database type (SQLITE|SQLSERVER)
DBSERVER        - Database server name
SERVICETYPE     - Service account type

Linux Installation

Ubuntu/Debian Installation

bash

# Update package list
sudo apt-get update

# Install dependencies
sudo apt-get install -y wget apt-transport-https software-properties-common

# Add Microsoft package repository
wget https://packages.microsoft.com/config/ubuntu/20.04/packages-microsoft-prod.deb
sudo dpkg -i packages-microsoft-prod.deb

# Install .NET Runtime
sudo apt-get update
sudo apt-get install -y dotnet-runtime-6.0 aspnetcore-runtime-6.0

# Download FrameworX package
wget https://download.frameworkx.com/linux/frameworkx-10.1.deb

# Install FrameworX
sudo dpkg -i frameworkx-10.1.deb

# Configure service
sudo systemctl enable frameworkx
sudo systemctl start frameworkx

RHEL/CentOS Installation

bash

# Install dependencies
sudo yum install -y wget

# Add Microsoft repository
sudo rpm -Uvh https://packages.microsoft.com/config/rhel/8/packages-microsoft-prod.rpm

# Install .NET Runtime
sudo yum install -y dotnet-runtime-6.0 aspnetcore-runtime-6.0

# Download and install FrameworX
wget https://download.frameworkx.com/linux/frameworkx-10.1.rpm
sudo rpm -ivh frameworkx-10.1.rpm

# Start service
sudo systemctl enable frameworkx
sudo systemctl start frameworkx

Docker Installation

Docker Deployment

dockerfile

# Pull official image
docker pull frameworkx/runtime:10.1

# Run container
docker run -d \
  --name frameworkx \
  -p 9000:9000 \
  -p 80:80 \
  -v /data/solutions:/app/solutions \
  -v /data/licenses:/app/licenses \
  frameworkx/runtime:10.1

# With environment variables
docker run -d \
  --name frameworkx \
  -e LICENSE_KEY=XXXX-XXXX-XXXX-XXXX \
  -e DB_CONNECTION="Server=db;Database=fx" \
  -e ADMIN_PASSWORD="SecurePass123!" \
  frameworkx/runtime:10.1

Docker Compose

yaml

version: '3.8'
services:
  frameworkx:
    image: frameworkx/runtime:10.1
    ports:
      - "9000:9000"
      - "80:80"
    volumes:
      - solutions:/app/solutions
      - licenses:/app/licenses
    environment:
      - LICENSE_KEY=${LICENSE_KEY}
      - DB_TYPE=POSTGRES
      - DB_HOST=database
    depends_on:
      - database
      
  database:
    image: postgres:14
    environment:
      - POSTGRES_DB=frameworkx
      - POSTGRES_USER=fxuser
      - POSTGRES_PASSWORD=${DB_PASSWORD}
    volumes:
      - dbdata:/var/lib/postgresql/data

volumes:
  solutions:
  licenses:
  dbdata:

License Types

Development License

For solution development and testing:

• Features:
  • Full Designer access
  • Unlimited tag configuration
  • 2-hour runtime limit per session
  • All drivers and modules included
• Restrictions:
  • Not for production use
  • Runtime restarts required
  • Development watermark on displays
• Ideal for:
  • Solution development
  • Testing and validation
  • Training environments

Runtime License

For production deployment:

• Features:
  • Unlimited runtime operation
  • No Designer access
  • Production-ready performance
  • Full redundancy support
• Variations:
  • By tag count (1K, 5K, 25K, 100K, Unlimited)
  • By I/O points
  • By client connections
• Ideal for:
  • Production systems
  • Deployed solutions
  • OEM applications

Combined License

Development and runtime in one:

• Features:
  • Full Designer access
  • Unlimited runtime operation
  • All features enabled
  • No restrictions
• Benefits:
  • Single license management
  • Cost-effective for small teams
  • Simplified deployment
• Ideal for:
  • Small installations
  • Single-server deployments
  • Pilot projects

Trial License

Full-featured evaluation:

• Duration: 30 days standard (extensions available)
• Features: All features enabled
• Limitations: Time-limited only
• Conversion: Can upgrade to full license
• Purpose: Evaluation and proof-of-concept

Enterprise License

Organization-wide deployment:

• Features:
  • Unlimited servers
  • Unlimited tags
  • Unlimited clients
  • Priority support included
• Management:
  • Central license server
  • Floating licenses
  • Usage reporting
• Benefits:
  • Simplified administration
  • Cost predictability
  • Enterprise support

Activation Process

Online Activation

Automatic activation with internet connection:

1. Open License Manager
   • Start → FrameworX 10.1 → License Manager
   • Or from Solution Center → Help → License
2. Enter License Key
   • Input 25-character key (XXXXX-XXXXX-XXXXX-XXXXX-XXXXX)
   • Verify customer information
   • Click "Activate Online"
3. Activation Process
   • Connects to license server
   • Validates license key
   • Downloads certificate
   • Installs locally
4. Confirmation
   • Success message displayed
   • License details shown
   • Restart if required

Offline Activation

For systems without internet:

1. Generate Request File
   • Open License Manager
   • Click "Offline Activation"
   • Enter license key
   • Click "Generate Request"
   • Save .req file
2. Submit Request
   • Transfer .req file to internet-connected computer
   • Visit activation.frameworkx.com
   • Upload request file
   • Download response .lic file
3. Apply License
   • Transfer .lic file to target system
   • In License Manager, click "Import License"
   • Browse to .lic file
   • Click Apply
4. Verify Activation
   • Check license status
   • Confirm features enabled
   • Test functionality

Hardware Dongle

USB-based licensing:

1. Insert Dongle
   • Plug into USB port
   • Wait for driver installation
   • LED indicator shows status
2. Driver Installation
   • Automatic on Windows 10/11
   • Manual driver for older OS
   • Linux requires additional package
3. License Detection
   • FrameworX auto-detects dongle
   • No activation required
   • License tied to dongle
4. Dongle Management
   • Can move between systems
   • Update via license manager
   • Backup license recommended

License Server

Centralized license management:

1. Server Setup
   • Install license server software
   • Configure server settings
   • Import enterprise license
2. Client Configuration
   • Point to license server:

   xml

   <LicenseSettings>
     <ServerAddress>license.company.com</ServerAddress>
     <Port>27000</Port>
     <Timeout>30</Timeout>
   </LicenseSettings>

3. License Checkout
   • Automatic at startup
   • Floating license model
   • Released on shutdown

Troubleshooting Installation

...

...

...

License Issues

Post-Installation Issues

Verification Procedures

Installation Verification

1. Check Services

   cmd

   # Windows
   sc query "FrameworX Runtime"
   
   # Linux
   systemctl status frameworkx

2. Verify Files
   • Check installation directory
   • Confirm all components present
   • Review installation log
3. Test Basic Functions
   • Open Solution Center
   • Create test solution
   • Start runtime
   • Open Designer

License Verification

1. Check License Status
   • Open License Manager
   • View license details
   • Verify expiration date
   • Confirm feature list
2. Test Licensed Features
   • Create tags up to limit
   • Test driver connections
   • Verify client connections
   • Check module availability
3. Generate License Report
   • Export license details
   • Document for support
   • Keep for records

Upgrade Procedures

Upgrading from Previous Versions

1. Backup Current System
   • Export all solutions
   • Save license information
   • Document custom settings
   • Backup database
2. Check Compatibility
   • Review upgrade path
   • Verify solution compatibility
   • Check driver versions
   • Test in development first
3. Perform Upgrade
   • Install new version
   • Migrate solutions
   • Update licenses
   • Test functionality

Migration Checklist

• Backup all solutions
• Document current configuration
• Review breaking changes
• Test upgrade in development
• Plan maintenance window
• Prepare rollback plan
• Notify users
• Perform upgrade
• Verify functionality
• Update documentation

AI Assistant Data

<details> <summary>Structured Information for AI Tools</summary>

json

{
  "module": "Installation & Licensing",
  "category": "Reference Guide",
  "purpose": "Complete installation and licensing procedures",
  "installationTypes": {
    "windows": ["Standard", "Command Line", "Server Only"],
    "linux": ["Ubuntu/Debian", "RHEL/CentOS"],
    "container": ["Docker", "Kubernetes"]
  },
  "licenseTypes": {
    "development": "Design and test only",
    "runtime": "Production deployment",
    "combined": "Development and runtime",
    "trial": "30-day evaluation",
    "enterprise": "Organization-wide"
  },
  "activationMethods": [
    "Online activation",
    "Offline activation",
    "Hardware dongle",
    "License server"
  ],
  "commonTasks": [
    "Fresh installation",
    "Upgrade existing",
    "License activation",
    "Troubleshooting",
    "Verification"
  ],
  "supportFiles": {
    "logs": "Installation.log",
    "config": "FrameworX.config",
    "license": "License.lic"
  }
}

...