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 → Integration → Logic → Visualization

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

esults:

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

Implementation Steps

Step 1: Plan Your Namespace
??? Define naming standards (Area_Equipment_Signal)
??? Document tag requirements
??? Plan for 20% growth

Step 2: Create Base Tags
??? System tags (heartbeat, status)
??? Communication tags
??? Calculation tags

Step 3: Build UDTs
??? Motor (Running, Speed, Current, Hours)
??? Valve (Open, Close, Position, Fault)
??? Tank (Level, Temperature, Pressure)
??? PID (SP, PV, CV, Mode)

Step 4: Organize Assets
??? Plant
   ??? Area1
      ??? Line1
      ??? Line2
          ??? Area2

Best Practices

• Naming Convention Example: WTP_PUMP01_RUNNING
  • WTP = Water Treatment Plant
  • PUMP01 = Equipment ID
  • RUNNING = Signal name
• Use consistent abbreviations
• Plan for expansion (reserve number ranges)
• Document everything

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

Implementation Steps

Step 1: Setup Devices
??? Create Channel (Protocol, Port, Timeout)
??? Add Nodes (IP, Device ID)
??? Map Points to Tags

Step 2: Configure Alarms
??? Create Areas (Plant sections)
??? Define Groups (Equipment types)
??? Set Conditions (Limits, Deviation)
??? Configure Notifications

Step 3: Enable Historian
??? Select Storage Location
??? Create Tables
??? Configure Tag Collection
??? Set Compression

Connection Architecture

Field Level        Communication        UNS & Operation
???????????         ???????????          ???????????
?  PLCs   ?         ? Drivers ?          ?  Tags   ?
???????????         ???????????          ???????????
?  RTUs   ? ??????? ?Protocols? ???????  ? Alarms  ?
???????????         ???????????          ???????????
? Sensors ?         ?Providers?          ?Historian?
???????????         ???????????          ???????????

Best Practices

• Start with slow poll rates, optimize later
• Group similar devices on same channel
• Use event-driven updates when available
• Test each connection thoroughly
• Document IP addresses and settings

Detailed Process Modules Guide →

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

Implementation Steps

Step 1: Database Setup
??? Configure Connections
??? Create Tables/Views
??? Build Queries
??? Test Transactions

Step 2: Script Development
??? Calculation Tasks
??? Control Logic
??? Data Processing
??? Error Handling

Step 3: Report Creation
??? Design Templates
??? Configure Data Sources
??? Set Schedules
??? Test Distribution

Data Flow

Raw Data → Scripts → Calculations → Database → Reports
   ↓          ↓           ↓            ↓          ↓
  Tags     Process    Transform      Store    Distribute

Common Implementations

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 apps

Implementation Steps

Step 1: Display Architecture
??? Create Navigation Structure
??? Design Template Displays
??? Build Process Graphics
??? Implement Standards

Step 2: Display Development
??? Overview Displays
??? Detail Displays
??? Control Faceplates
??? Alarm Displays

Step 3: Dashboard Creation
??? KPI Dashboards
??? Analytics Views
??? Mobile Layouts
??? Executive Reports

Step 1: Display Architecture
??? Create Navigation Structure
??? Design Template Displays
??? Build Process Graphics
??? Implement Standards

Step 2: Display Development
??? Overview Displays
??? Detail Displays
??? Control Faceplates
??? Alarm Displays

Step 3: Dashboard Creation
??? KPI Dashboards
??? Analytics Views
??? Mobile Layouts
??? Executive Reports

Display Hierarchy

Plant Overview
    ↓
Area Overview
    ↓
Process Display
    ↓
Equipment Detail
    ↓
Faceplate Popup

Design Principles

• Follow ISA-101 HMI standards
• Use consistent color philosophy
• Implement situational awareness
• Minimize animation
• Optimize for target resolution

Detailed User Interface Guide →

Solution Building Workflow

Complete Development Process

PLAN                          BUILD                         DEPLOY
?????????????????            ?????????????????            ?????????????????
1. Requirements     ????     5. Implementation    ????    9. Installation
2. Architecture              6. Integration                10. Commissioning
3. Standards                 7. Testing                    11. Training
4. Design                    8. Validation                 12. Support

Phase 1: Planning (Week 1)

Requirements Gathering

• Define project scope
• Identify data sources
• List user requirements
• Document interfaces
• Establish success criteria

Architecture Design

• Size system (tags, users, data)
• Design network topology
• Plan redundancy
• Define security zones
• Select hardware

Phase 2: Development

Step 1: Foundation (UNS)

• Create Local Tags structure
• Build UDTs 
• Setup asset tree
• External Governance: Extend UNS with Dynamic Binding.

Step 2: Integration

• Configure devices
• Setup alarms
• Enable historian
• Test communications

Step 3: Logic

• Develop scripts
• Create queries
• Build reports
• Test calculations

Step 4: Visualization

• Design displays
• Create navigation
• Build dashboards
• Test clients

Step 5: Integration Testing

• End-to-end testing
• Performance testing
• Security testing
• User acceptance

Phase 3: Deployment

Go-Live Preparation

• Production installation
• Data migration
• User training
• Documentation
• Support handover

Module Dependencies and Interactions

Understanding Module Relationships

Tags (UNS)

          → Devices (Read/write values)
          → Alarms (Monitor conditions, notify and request ack, as needed)
          → Historian (store and recover time-series data)
          → Scripts (process data, implement workflows)
          → Dataset (sync with SQL databases, or recipe files)
          → Reports (pub PDF or CSV data, exchange JSON/XML data
          → Displays (Visualize)

Security Module
          → Restrict access to configuration modules and artifacts.
          → Provides Identification & Authorization for Displays client users.

Data Flow Examples

Example 1: PLC to Display

PLC → Driver  (Device Point) → Tag → Display

Example 2: PLC to Display, using Direct Binding.

PLC address → Dynamic TagProvider  → Display

Example 3: Calculation to Database

Tags → Script (Calculation) → Result Tag → Dataset  (SQL)

Example 4: User Command

Display → Button Click → Tag Write  (UNS) → Device → PLC

                                                                      & → Audit Log (when enabled)

Solution Templates

Quick Start Templates

Industry Templates

Manufacturing Template

• Production tracking
• OEE calculations
• Downtime analysis
• Quality management
• Inventory tracking

Utilities Template

• SCADA infrastructure
• Telemetry systems
• Regulatory reporting
• Load management
• Outage management

Building Automation

• HVAC control
• Lighting management
• Energy monitoring
• Access control
• Tenant billing

Explore All Templates →

Best Practices Checklist

Design Phase

• Define clear naming conventions
• Create reusable UDTs
• Plan for 20-30% growth
• Document all decisions
• Review with stakeholders

Development Phase

• Follow the four-pillar sequence
• Test each component thoroughly
• Use version control
• Regular backups
• Code reviews for scripts

Deployment Phase

• Complete testing before production
• Train all users
• Document operational procedures
• Establish support processes
• Monitor performance

Maintenance Phase

• Regular backups
• Performance monitoring
• Security updates
• User feedback
• Continuous improvement

Common Pitfalls and Solutions

Next Steps

After Understanding the Methodology

1. Deep Dive into Each Pillar
   • Unified Namespace Details
   • Process Modules Guide
   • Application Modules Guide
   • User Interface Guide
2. Explore Examples
   • Solution Examples
   • Industry Templates
   • Architecture Patterns
3. Get Hands-On
   • Build a sample solution
   • Follow a tutorial
   • Modify a template

Quick Reference

Four Pillars at a Glance

Time Estimates

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

AI Assistant Data

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

json

{
  "page": "Building Solutions",
  "type": "Methodology Guide",
  "purpose": "Explain the four-pillar solution building approach",
  "pillars": [
    {
      "name": "Unified Namespace",
      "order": 1,
      "purpose": "Data foundation",
      "components": ["Tags", "Assets", "UDTs"]
    },
    {
      "name": "Process Modules",
      "order": 2,
      "purpose": "Field integration",
      "components": ["Devices", "Alarms", "Historian"]
    },
    {
      "name": "Application Modules",
      "order": 3,
      "purpose": "Business logic",
      "components": ["Scripts", "Datasets", "Reports"]
    },
    {
      "name": "User Interface",
      "order": 4,
      "purpose": "Visualization",
      "components": ["Displays", "Dashboards", "Clients"]
    }
  ],
  "workflow": {
    "phases": ["Planning", "Development", "Deployment"],
    "duration": "1-12 months depending on size",
    "approach": "Sequential pillar implementation"
  },
  "bestPractices": [
    "Follow pillar sequence",
    "Create reusable components",
    "Document everything",
    "Test thoroughly",
    "Plan for growth"
  ]
}

</details>

Claude can make mistakes.
Please double-check responses.

Quick Start Templates

Next Steps

• Unified Namespace - Start with data modeling
• Process Modules - Connect to field devices
• Application Modules - Add business logic
• User Interface - Create visualizations