Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

FrameworX Documentation

???  GET STARTED
?   ??? What is FrameworX?
?   ??? Quick Start Guide (5-minute tutorial)
?   ??? Installation & Setup
?   ?   ??? System Requirements
?   ?   ??? Installation Guide
?   ?   ??? Licensing
?   ?   ??? First Solution Walkthrough
?   ??? Learning Paths
?       ??? For Control Engineers
?       ??? For IT Professionals
?       ??? For System Integrators
?       ??? For Operators

???  PLATFORM ARCHITECTURE
?   ??? System Overview
?   ?   ??? Core Architecture (.NET 8)
?   ?   ??? Product Editions Comparison
?   ?   ??? Licensing Models
?   ?   ??? Performance & Scalability
?   ??? Core Components
?   ?   ??? Solution Center
?   ?   ??? Designer Workspace
?   ?   ??? Runtime Engine
?   ?   ??? Client Applications
?   ??? The Four Pillars Framework
?   ?   ??? 1. Unified Namespace (UNS)
?   ?   ?   ??? Tag System
?   ?   ?   ??? Asset Modeling
?   ?   ?   ??? Data Types
?   ?   ??? 2. Process Modules
?   ?   ?   ??? Devices & Communication
?   ?   ?   ??? Alarms & Events
?   ?   ?   ??? Historian
?   ?   ??? 3. Application Modules
?   ?   ?   ??? Datasets
?   ?   ?   ??? Scripts
?   ?   ?   ??? Reports
?   ?   ??? 4. User Interface
?   ?       ??? Displays
?   ?       ??? Dashboards
?   ?       ??? Client Types
?   ??? Deployment Architectures
?       ??? Standalone Systems
?       ??? Client-Server
?       ??? Distributed Systems
?       ??? Cloud & Hybrid
?       ??? Edge Computing
?       ??? Redundancy Options

??? TUTORIALS & GUIDES
?   ??? Basic Tutorials
?   ?   ??? Understanding Tags & UNS
?   ?   ??? Creating Your First HMI
?   ?   ??? Connecting to a PLC
?   ?   ??? Building Simple Dashboards
?   ?   ??? Basic Alarm Configuration
?   ??? Intermediate Guides
?   ?   ??? Database Integration
?   ?   ??? Historian Configuration
?   ?   ??? Report Generation
?   ?   ??? Multi-User Projects
?   ?   ??? Client Deployment
?   ??? Advanced Topics
?       ??? Redundancy Implementation
?       ??? Performance Optimization
?       ??? Custom Script Development
?       ??? Enterprise Integration
?       ??? Security Hardening

???  HOW-TO GUIDES
?   ??? Connect & Communicate
?   ?   ??? Connect to Modbus Devices
?   ?   ??? Setup OPC UA Server/Client
?   ?   ??? Configure MQTT/Sparkplug B
?   ?   ??? Connect to SQL Databases
?   ?   ??? Integrate with Historians
?   ?   ??? [70+ Protocol Guides...]
?   ??? Build & Configure
?   ?   ??? Design HMI Screens
?   ?   ??? Create Tags & Templates
?   ?   ??? Configure Alarms & Events
?   ?   ??? Setup Data Logging
?   ?   ??? Build Reports
?   ?   ??? Write Scripts
?   ?   ??? Implement Security
?   ??? Deploy & Maintain
?       ??? Deploy to Production
?       ??? Setup Redundancy
?       ??? Configure Clients
?       ??? Backup & Recovery
?       ??? Monitor Performance

??? SOLUTIONS BY INDUSTRY
?   ??? Manufacturing
?   ?   ??? Discrete Manufacturing Template
?   ?   ??? OEE Monitoring
?   ?   ??? Production Tracking
?   ?   ??? Quality Management
?   ??? Process Industries
?   ?   ??? Continuous Process Template
?   ?   ??? Batch Management
?   ?   ??? Recipe Management
?   ?   ??? Tank Farm Control
?   ??? Utilities
?   ?   ??? Water/Wastewater SCADA
?   ?   ??? Power Distribution
?   ?   ??? Pipeline Monitoring
?   ?   ??? Pump Station Control
?   ??? Energy & Sustainability
?       ??? Renewable Energy Management
?       ??? Building Automation
?       ??? Energy Analytics
?       ??? Carbon Tracking

??? STANDARDS & BEST PRACTICES
?   ??? Development Workflow
?   ?   ??? Project Organization
?   ?   ??? Naming Conventions
?   ?   ??? Version Control (Git)
?   ?   ??? Team Collaboration
?   ??? Industry Standards
?   ?   ??? ISA-101 HMI Design
?   ?   ??? ISA-95 Integration
?   ?   ??? High Performance HMI
?   ?   ??? ANSI/ISA-18.2 Alarms
?   ??? Regulatory Compliance
?   ?   ??? FDA 21 CFR Part 11
?   ?   ??? NERC CIP
?   ?   ??? ISO 27001/27002
?   ?   ??? GDPR Compliance
?   ??? Security & Hardening
?       ??? Security Architecture
?       ??? SBOM Documentation
?       ??? Network Security
?       ??? User Management

??? TECHNICAL REFERENCE
?   ??? Modules Reference
?   ?   ??? Tags & UNS Module
?   ?   ??? Devices Module
?   ?   ??? Alarms Module
?   ?   ??? Historian Module
?   ?   ??? Datasets Module
?   ?   ??? Scripts Module
?   ?   ??? Reports Module
?   ?   ??? Displays Module
?   ??? Programming Reference
?   ?   ??? C# API
?   ?   ??? VB.NET API
?   ?   ??? Python Integration
?   ?   ??? Expression Language
?   ?   ??? REST APIs
?   ?   ??? Extension Development
?   ??? Graphics Reference
?   ?   ??? Symbol Libraries
?   ?   ??? Animation System
?   ?   ??? Dashboard Components
?   ?   ??? Custom Controls
?   ?   ??? SVG Integration
?   ??? Troubleshooting
?       ??? Diagnostic Tools
?       ??? Common Issues
?       ??? Error Reference
?       ??? Performance Tuning

??? MIGRATION & INTEGRATION
?   ??? Migration Guides
?   ?   ??? From FactoryStudio
?   ?   ??? From Wonderware
?   ?   ??? From Ignition
?   ?   ??? From WinCC
?   ?   ??? From iFIX
?   ??? Integration Partners
?   ?   ??? Canary Historian
?   ?   ??? HiveMQ MQTT
?   ?   ??? Sorba.AI Analytics
?   ?   ??? Cisco Infrastructure
?   ??? Data Migration Tools

??? RESOURCES
?   ??? Downloads
?   ?   ??? Software & Updates
?   ?   ??? Example Projects
?   ?   ??? Templates
?   ?   ??? Documentation PDFs
?   ??? Support
?   ?   ??? Technical Support
?   ?   ??? Community Forum
?   ?   ??? Knowledge Base
?   ?   ??? Training & Certification
?   ??? Developer Resources
?       ??? API Documentation
?       ??? SDK Downloads
?       ??? Code Samples
?       ??? GitHub Repository

??? WHAT'S NEW
    ??? Current Release (v10.1)
    ??? Release Notes Archive
    ??? Roadmap
    ??? Known Issues & Fixes