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 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.

Overview

The four-pillar methodology (UNS, Process Modules, Application Modules, UI) provides a unique organizational principle that differentiates Tatsoft from competitors. This architectural approach to documentation surpasses the typical product-centric organization seen in platforms like FactoryTalk or WinCC, potentially offering superior conceptual clarity for system designers.

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 Field Proven Methodology

Foundation → Integration → Logic → Visualization

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

??????????????????????????????????????????????????????????????????????????????
?                          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    ?                                   ?
?                         ????????????????                                   ?
??????????????????????????????????????????????????????????????????????????????

Why Follow This Methodology?

Benefits of the Four-Pillar Approach

Common Mistakes to Avoid

? Starting with displays - Without proper data structure ? Skipping UDTs - Leading to tag sprawl ? Direct device-to-display binding - Creating maintenance nightmares ? Ignoring naming conventions - Causing confusion later ? Building monolithic solutions - Instead of modular architecture

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

1. Tag Structure
   • Define naming conventions
   • Create tag hierarchy
   • Set data types and ranges
   • Configure engineering units
2. Asset Tree
   • Mirror physical/logical structure
   • Organize by area/process/equipment
   • Create navigable hierarchy
3. User Data Types (UDTs)
   • Create equipment templates
   • Define standard objects
   • Build reusable components

→ Solution Dev - Use Case Example

Detailed UNS Guide →

Pillar 2: Process Modules (Industrial Operations)

Purpose

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

What to Build

1. Device Communications
   • Configure channels and protocols
   • Setup nodes and devices,
   • Map points to tags, or use direct binding
2. Alarm Management
   • Define alarm areas and groups
   • Configure conditions and limits
   • Setup notifications
3. Historian (Time-series Data Collection)
   • Configure historian storage
   • Set collection rates
   • Define retention policies

Pillar 3: Application Modules (Store & Process)

Purpose

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

What to Build

1. Database Integration
   • Connect to SQL databases
   • Create queries and views
   • Setup synchronization
2. Business Logic
   • Write calculation scripts
   • Implement control logic
   • Create data validation
3. Reporting
   • Design report templates
   • Configure schedules
   • Setup distribution

Detailed Application Modules Guide →

Pillar 4: User Interface (Analyze & Visualize)

Purpose

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

What to Build

1. Operational Displays
   • Process graphics
   • Control panels
   • Navigation structure
2. Dashboards
   • KPI visualization
   • Analytics
   • Mobile views
3. Client Deployment
   • Rich clients
   • Web access
   • Mobile UI

Detailed User Interface Guide →

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