The Four Pillars Overview

Pillar 1: Unified Namespace (Foundation)

Purpose

The Unified Namespace (UNS) is your solution's data foundation - a single source of truth for all real-time and configuration data.

What to Build

[Detailed UNS Guide →]

Pillar 2: Process Modules (Industrial Operations)

Purpose

Process modules connect your solution to the physical world, collecting data from field devices and managing industrial operations.

What to Build

[Detailed Process Modules Guide →]

Pillar 3: Application Modules (Business Logic)

Purpose

Application modules add business logic, data processing, and integration capabilities to transform raw data into actionable information.

What to Build

[Detailed Application Modules Guide →]

Pillar 4: User Interface (Visualization)

Purpose

The UI layer presents information to operators, managers, and stakeholders through interactive displays and dashboards.

What to Build

[Detailed Operator UI Guide →]

Solution Ready to Run (Secure & Deploy)

Purpose

Solution ready to Run, validate, apply security, and deploy.

What to Do

[Detailed Solution Runtime Guide →]

Overview

Building successful FrameworX solutions follows a proven four-pillar methodology that ensures scalability, maintainability, and performance. This structured approach guides you from initial data modeling through to final deployment, with each pillar building upon the previous to create a complete industrial application.

The Four-Pillar Architecture / Methodology 

Platform Components

Solution Developer Journey: Create → Design → Deploy/Run

1. Core Components — servers, services, modules; how they fit together. 

2. Workspaces — Solution Center Overview and Designer Workspace (can be siblings or a combined page). 

3. Runtime & Clients — SmartClient/Web, roles, where logic runs.

Platform UI Tools  Interaction

Our platform relies on the three components described below. It supports distributed architectures, which means that each one of these software components may be running on one computer, exchanging data with the modules on other computers.

(EDITORS NOTE: Text to review and consolidate to the table)

Solutions Manager (Solution Management)

Our platform enables you to create industrial applications for any platform - you can run it on Windows, Linux, Mac, Routers and Universal Robots. This is the first interface you'll see when running the software and it showcases all the solution files you have. You can create, edit, manage and run solutions from here.

Designer (Solution Configuration)

The Designer Workspace allows you to edit solutions’ displays and tags, as well as modules such as Devices, Alarms, Scripts, Datasets and Historian.

Runtime (Solution Execution)

When you run your solution, the first UI you'll be presented with is the TStartup, which is responsible for loading everything the solution needs. This includes the TServer, which enables communications with databases, and the modules that will act behind the scenes to display the information the user sees. It will also open the User Interface, which can be either Windows or Web Clients.

The Four Pillars

Every FrameworX solution is built on four foundational pillars that work together to create a complete industrial application:
Solution Building Blocks

Every FrameworX solution is built on four foundational pillars that work together to create a complete industrial application:

Key Architectural Benefits

System Network Architecture

System Architecture

Three-Tier Architecture

• Presentation Tier
  • Rich Client (.NET)
  • Web Client (WebAssembly)
  • Mobile Client (WebAssembly)

• Application Tier
  • FrameworX Runtime (TServer)
  • UNS (Tag & UDT)  | Field Devices | Alarms
  • Historian | Reports | Dataset SQL | Scrips

• Data Tier
  • Solution DB (configuration), Historian DB (Time-Series) and Alarms DB
  • External SQL, Objects DB,  or Cloud Storage, or custom connectors. 
  • Drivers (70+ field protocols), UPC-UA, MQTT + third-party extensions.

Platform Components

The platform operates through three essential workspaces:

• [Platform Architecture (Concept)] - Technical foundation and component integration
• [Solution Center (Concept)] - Solution management and launch point
• [Designer Workspace (Concept)] - Configuration environment for all modules
• [Runtime Environment (Concept)] - Execution environment for deployed solutions
• [Network Topologies (Concept)] - Deployment architectures from standalone to distributed

Key Architectural Benefits

The Four-Pillar Methodology

Foundation → Industrial Operation → Logic & Data → Visualization

Each pillar represents a critical layer of your solution, implemented in sequence for optimal results:

Pillar 1- Foundation - Unified Namespace:  Tag, AssetTree, User Data Types
Pillar 2 - Industrial Operations - Process Modules: Devices, Alarms, Historian
Pillar 3 - Logic & Data Enrichment - Application Modules: Scripts, Datasets (SQL), Reports (PDF/JSON/XML(
Pillar 4 - User Interface Modules: Displays, Dashboards, Layouts. Desktop, Web and Mobile clients.

Why Follow This Methodology?

Field Proven

→ Catalog

Benefits of the Four-Pillar Approach

Solution Templates

Quick Start  Templates, with guided explorer

Next Steps

After Understanding the Methodology

Deep Dive Into Each Pillar

• Unified Namespace Details
• Process Modules Guide
• Application Modules Guide
• User Interface Guide

Get Hands-ON

• Get Aware of the Quick Links Tables
• Follow a  Tutorial
• Build a sample solution
• Follow a tutorial
• Modify a template

Quick Reference Tables

• → Four Pillars At a Glance
• → Modules Key Concepts Review 
• → Development Time Estimates 
• → Shorten Dev time & Increase Reliability Checklist
• → Best Practices Checklist
• → Common Pitfalls and Solutions

Four Pillars at a Glance

Note: Those are order of magnitude references. Specific requirements & workflow & user review process need to be accounted for.

Building successful FraeworX solutions follows a proven four-pill methodolog that ensures scalability, maintainability, and performance. This sapproach guides you from initial data modelig through to inal deplyment, with each pilla building upon the previous to create a coplete industrial application.

Found→ Integration → Logic → Visualization

Each pillar represents a critical layer of your solution, implemented in sequence optimal results:

Why Follow This Methodology?

Benefits of the Four-Pillar Approach

Comm Mistakes to Avoid

? Starting with displays-Without proer dat structure ? Skippin UDTs - Ladingto tag sprawl ? Direct device-to-display binding - Creating maintenance nightmares ? Ignoring naming conventions - Causing confusion later ? monolithic solutions - Instead of modular architecture

Pillar 1: Unified Namespace (Foundation)

Purpose

The Unified Namespace (UN) is your s'datafoundation - a single source of truth for all real-time and configuration data.

What to Build

1. Tag Structure
   • Define naming conventions
   • Create tag hierarchy
   • Set data s andranges
   • Configure engineering units
2. Asset Tree
   • irror physical/logical structur
   • Organize by area/process/equipmen
   • Create navigable ierarchy
3. User Data Types (UDTs)
   • Create equipment templates
   • Define standard bjects
   • Buil reusable components

→ Sutin Dev - Use Case Example

Detailed UNS→

Pillar2: Process Modules (Industrial Oerations)

P

Process modules connect your solutionto the hysica world, connecting & collecting dta from feld devices admanaging indusrial operations.

Wat to Build

1. DevicCommunications
   • Conigure channels and protocls
   • Setp nodes and devices,
   • Map points to tags, o use direct binding
2. Alarm Management
   • Define alarm areas and groups
   • Configure conditions and limits
   • Setup notifications
3. Historian (Timeseries Data Collection)
   • Configure historian storage
   • Set collection rates
   • Define retention olicies

P3: Application Module (Stre & Process)

Purpose

Appication modles add business logic, data processing, and integracapailities to transform raw data into actionable information.

What to B

1. Database Integrato
   • Connect to SQL databases
   • Create queries and views
   • Setup synchronization
2. Business Loic
   • Writeclculation scrits
   • Imlement contl logic
   • Crete data validation
3. Reporting
   • Design report templates
   • Configure sedules
   • Setupdistribution

DetailedAplication Modules Guide →

P 4UserInterface(Analyze& Visualize)

Purpose

The UI layer presents information to operators, managers, and stakeholders through interactive displays anddashboards.

WhattoBuild

1. OperationalDisplays
   • Processgraphics
   • Controlpanels
   • Navigationstructure
2. Dashboards
   • KPI visualization
   • Alytics
   • Mobile views
3. Client Deploynt
   • Richclients
   • Web access
   • Mobile I

Detailed User Iterface Gude →

Consolidate 

Dev to Production Worklow

Overvw

FrameworX 10.1 follows a moular,scalable rchitecture designed for industrial applications fro small single-machine interfac to enterrise-wide systems. Understnding the platform arhitcturehelpsyoudesignrobustsolutions,ptimize peformance, and plan for growth. This gui exploesthe core componentsdataflow,anddeploymentpatterns that makeFrameworX a owerfl industial aplicatin platform.

FrameworX i  morthn jus softwre tool,

It's the enablingield-prven architectre a methodology to deploy applics managing critical assetsfromlargedistributedsystemstostandalone edge apps. It unloks the sphistication, perforance and oenness f latest techologis, yet keepig a simple configuraion, and a clear cot with advantageous Total Cost of Ownership.

Reference Link 
   Solutions Guidebook (examples of solution rchitecture in production)

Solution Development Workflow

Specification to Solution Flow 

SolutionDeployment Workflow

Development toProduction Flow

Tools  Interaction

Complete Solution Lifecycle

== > Link to Development to Production Best Practices and Industry Standard pages. 

Stage 1: Iitite (Planning)

Project Definition - Scope Developnt

Define clear boundaries and objectives

• ProjectScope Document
  • Business Objectives
    • ROI Targets
    • Efficiency Goals
    • Compliance Requirements
  • Technical Requirements
    • I/O Count
    • User Count
    • Integration oints
    • Pefrmance Targets
  • Constrains
    • Budget
    • Timeline
    • Resources
    • Technology
  • SucCriteria
    • Acceptance Tests
    • Performance etrics
    • Deliverables

Stakehler Analysis

RquirementsGathering

unctonal Rquirements Checkist

• Process control requirements
• Data acquisition nees
• Alarmmanagement requrements
• Reporting specifications
• User interface requirements
• I requirements
• Security requirements
• Performance requirements

Stage 2: sgn (Arhitcture)

Sytem ArchitectureDesign

rchitecture Decision Matrix

Network Architecture

Data Architecture

Tag Naming Convention

Standard: [Area_[Equipment]_[Component]_[Signal]

Examples:
WTP_PUMP01_MOTOR_RUNNING
WTP_PUMP01_MOTOR_SPEED_SP
WTP_TANK01_LEVEL_PV
BLDG_HVAC_AHU01_TEMP_SP
UNS Structure

UDT Design - UNS Data Template 
UDT: MOTOR_VF0

Disay Archteture

NavigHierarchy

Stage 3ld (Developmet)

Dvelopment Workflow

Sprint Planning (Example of a 2-Week Sprint)

ConfigurationManagement

VersionControlStrategy

TstingStrategy

TestLevels

TestDocumentation-TestCaseTemlate

Stage 4: Deploy (Producton)

Deployment Plnning

Pre-Deploymen Checklst

• All tests passed
• Dcumetationcomplete
• Backupcreated
• Licensesverified
• Trainingcompleted
• Supportplanready
• Rollbak plan prepared
• Maintenance windw scheduled

Deployent Sequence

Delymet Sequence

Cmmissioning Process

System Commissioning Steps

System Comissoning Step

Commssioning Documation

Stage 5Support(Maintenance)

SupportStructure

SupportTiers

SupportTies

Maintenance Activities

Preventive Maintenance Schedule

Continous Impovement

Performnce Moniorng

KPI Dashboard Example

Tools and Temlats

Project Maagement Tools

FrameworX Native Tools

Tird-party recommend tools

Standard Templates

Avaable Temptes

• PojectCharter
• Requreents Secification
• Design Document
• Test Pan
• Dploy Guide
• Training Merals
• Support Prcedures
• ChageRequestForm

QualityGates

GateReviews

Gate Review

BestPractices

Do'sandDon'ts

DO:

• ?naming conventons consistently
• ? Document a decisions and chnges
• ? Test thooughly at eachtag
• ? Incld operators i dsignreviews
• ?Planfor 20-30%growth
• ? Use version control
• ?

DON'T:

• ? Skip testing to save time
• ? Ignore user feedback
• ?Hardcodevalues
• ?Forgetsecurity considerations
• ? eply without bakups
• ? Ass requiremeswon't chang
• ? Neglct documentation

Risk Management

Workflow Optimization

Automation Opportunities

Collabatin Tips

??????????????????????????????????????????????????????????????????????????????
?                          FRAMEWORKX SOLUTION                               ?
??????????????????????????????????????????????????????????????????????????????
?                                                                            ?
?  1. UNIFIED NAMESPACE     2. PROCESS MODULES      3. APPLICATION MODULES   ?
?     (Foundation)         (Industrial Operation)      (Business Logic)      ?

?                                                                            ?

?    ????????????            ????????????            ????????????            ??    ?   Tags   ? ???????    ? Devices  ? ???????    ? Scripts  ?            ?
?    ?  Assets  ?            ?  Alarms  ?            ? Datasets ?            ?
?    ?   UDTs   ?            ?Historian ?            ? Reports  ?            ?
?    ????????????            ????????????            ????????????            ?
?          ?                        ?                        ?               ?
?          ???????????????????????????????????????????????????               ?
?                                   ?                                        ?
?                         4. USER INTERFACE                                  ?
?                        (Analyze & Visualize)                               ?
?                         ????????????????                                   ?
?                         ?   Displays   ?                                   ?
?                         ?  Dashboards  ?                                   ?
?                         ?    Mobile    ?                                   ?
?                         ????????????????                                   ?
??????????????????????????????????????????????????????????????????????????????

Next Steps

After Understanding Workfl

1. Download Templaes
   • Project Templates
   • DocumentationStandards
2. ReviewExamples
   • Solution Examples
   • Case Stuies
3. G Trning
   • Project Management
   • Best Practice

Consolidate 

Dev to Production Workflow

Overview

FrameworX 10.1 follows a modular, scalable architecture designed for industrial applications from small single-machine interfaces to enterprise-wide systems. Understanding the platform architecture helps you design robust solutions, optimize performance, and plan for growth. This guide explores the core components, data flow, and deployment patterns that make FrameworX a powerful industrial application platform.

FrameworX is  more than just software tool,

It's the enabling field-proven architecture and methodology to deploy applications managing critical assets, from large distributed systems to standalone edge apps. It unlocks the sophistication, performance and openness of latest technologies, yet keeping a simple configuration, and a clear cost with advantageous Total Cost of Ownership.

Reference Link: 
    Solutions Guidebook (examples of solution architecture in production)

Solution Development Workflow

Specification to Solution Flow 

Solution Deployment Workflow

Development to Production Flow

Tools  Interaction

Complete Solution Lifecycle

== > Link to Development to Production Best Practices and Industry Standard pages. 

Stage 1: Initiate (Planning)

Project Definition - Scope Development

Define clear boundaries and objectives:

• Project Scope Document
  • Business Objectives
    • ROI Targets
    • Efficiency Goals
    • Compliance Requirements
  • Technical Requirements
    • I/O Count
    • User Count
    • Integration Points
    • Performance Targets
  • Constrains
    • Budget
    • Timeline
    • Resources
    • Technology
  • Success Criteria
    • Acceptance Tests
    • Performance Metrics
    • Deliverables

Stakeholder Analysis

Requirements Gathering

Functional Requirements Checklist

• Process control requirements
• Data acquisition needs
• Alarm management requirements
• Reporting specifications
• User interface requirements
• Integration requirements
• Security requirements
• Performance requirements

Data Collection Worksheet Example

Stage 2: Design (Architecture)

System Architecture Design

Architecture Decision Matrix

Network Architecture

Data Architecture

Tag Naming Convention

Standard: [Area]_[Equipment]_[Component]_[Signal]

Examples:
WTP_PUMP01_MOTOR_RUNNING
WTP_PUMP01_MOTOR_SPEED_SP
WTP_TANK01_LEVEL_PV
BLDG_HVAC_AHU01_TEMP_SP
UNS Structure

UDT Design - UNS Data Template 
UDT: MOTOR_VF0

Display Architecture

Navigation Hierarchy

Stage 3: Build (Development)

Development Workflow

Sprint Planning (Example of a 2-Week Sprints)

Configuration Management

Version Control Strategy

Change Management Process

Testing Strategy

Test Levels

Test Documentation - Test Case Template

Stage 4: Deploy (Production)

Deployment Planning

Pre-Deployment Checklist

• All tests passed
• Documentation complete
• Backup created
• Licenses verified
• Training completed
• Support plan ready
• Rollback plan prepared
• Maintenance window scheduled

Deployment Sequence

Deployment Sequence

Commissioning Process

System Commissioning Steps

System Comissoning Step

Commissioning Documentation

Stage 5: Support (Maintenance)

Support Structure

Support Tiers

Support Ties

Maintenance Activities

Preventive Maintenance Schedule

Continuous Improvement

Performance Monitoring

KPI Dashboard Example

Tools and Templates

Project Management Tools

FrameworX Native Tools

Third-party recommend tools

Standard Templates

Available Templates

• Project Charter
• Requirements Specification
• Design Document
• Test Plan
• Deployment Guide
• Training Materials
• Support Procedures
• Change Request Form

Quality Gates

Gate Reviews

Gate Review

Best Practices

Do's and Don'ts

DO:

• ? Follow naming conventions consistently
• ? Document all decisions and changes
• ? Test thoroughly at each stage
• ? Include operators in design reviews
• ? Plan for 20-30% growth
• ? Use version control
• ? Create reusable components

DON'T:

• ? Skip testing to save time
• ? Ignore user feedback
• ? Hardcode values
• ? Forget security considerations
• ? Deploy without backups
• ? Assume requirements won't change
• ? Neglect documentation

Risk Management

Workflow Optimization

Automation Opportunities

Manual Tasks → Automated Solutions
?????????????????????????????????
Tag Creation → Excel Import
Alarm Config → Template Application
Report Gen → Scheduled Tasks
Testing → Automated Scripts
Deployment → Scripted Installation
Backup → Automated Schedule

Collaboration Tips

Next Steps

After Understanding Workflow

1. Download Templates
   • Project Templates
   • Documentation Standards
2. Review Examples
   • Solution Examples
   • Case Studies
3. Get Training
   • Project Management
   • Best Practices