Versions Compared

Key

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

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?

Benefits of the Four-Pillar Approach

BenefitDescriptionImpact
Structured DevelopmentClear sequence of implementationReduced errors and rework
ScalabilityFoundation supports growthEasy expansion without redesign
MaintainabilityOrganized architectureSimplified troubleshooting
ReusabilityTemplate-based approachFaster development
Best PracticesIndustry-proven patternsReliable solutions

Common Mistakes to Avoid

  • Starting with displays - Without proper data structure

  • Skipping UDTs - Leading to tag sprawl

  • Not leveraging UNS features - Local UNS Tags x Linked-Tags x Direct Mapping  

  • Ignoring naming conventions - Causing confusion later

  • Building monolithic solutions - Instead of modular architecture

solution



Solution Templates

Quick Start

Templates

 Templates, with guided explorer

Template

Description

Components

Time to DeployExplore

Basic HMISimple machine interface100 tags, 5 displaysDisplays. Modbus , TouchPanel UI10 min1 hour
SCADA StarterSmall SCADA system1000 tags, alarmsAlarms, trends4 hours15 min
MES InterfaceProduction trackingDatabase, reports, KPIs1 day20 min
IIoT Gateway& MQTTMQTT Edge IntegrationCloud connectivityMQTT , REST API, store-forward2 hours

Industry Templates

To Do: Priorize and Implement 

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

Broker, Client & Publisher & SQL15 min
Central Server
ProveIt!
Situational Awareness,
Corporation Level
Enterprise Unlimited, Local & Extended UNS, Direct Binding to MQTT20 min

Industry Templates

Discreet manufacturing

  • OEE calculations
  • Andon Dashboards

Utilities

  • GEO Asset Monitor 
  • Distributed Systems

Continuous  Process

  • Brewery Plant
  • High Performance HMI

Edge & IIoT

  • Edge PLC to SQL
  • Protocol Converter & OPC UA server
  • Regular backups
  • Performance monitoring
  • Security updates
  • User feedback
  • Continuous improvement



    Next Steps

    After Understanding the Methodology

    Deep Dive

    into

    Into Each Pillar

    Explore Examples
  • Solution Examples
  • Industry Templates
  • Architecture Patterns
  • Get Hands-

    On

    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

    Four Pillars at a Glance

    Pillar

    Purpose

    Key Components

    Order

    UNSData foundationTags, Assets, UDTsFirst
    ProcessField integrationDevices, Alarms, HistorianSecond
    ApplicationBusiness logicScripts, Datasets, ReportsThird
    InterfaceVisualizationDisplays, Dashboards, ClientsFourth

    Time Estimates

    Solution Size

    Tags

    Development Time

    Team Size

    Small<1,0001-2 weeks1 personMedium1,000-10,0004-8 weeks2-3 peopleLarge10,000-50,0003-6 months3-5 peopleEnterprise>50,0006-12 months5+ people

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

    Common Pitfalls and Solutions

    Pitfall

    Impact

    Solution

    No naming standardConfusion, errorsDefine and enforce standards early
    Skipping UDTsMaintenance nightmareCreate templates for all equipment
    Over-polling devicesPerformance issuesOptimize scan rates based on needs
    Complex displaysOperator confusionFollow ISA-101, simplify graphics
    No documentationSupport difficultiesDocument as you build
    Ignoring securityVulnerabilitiesImplement security from start


    Modules Key Concepts Review


    One Line Descriptions

    Data Flow Examples

    Key Concepts review

    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


    Development Time Estimates

    Solution

    Templates

    Size

    Quick Start Templates

    TemplateDescriptionComponentsTime to Deploy
    Basic HMISimple machine interface100 tags, 5 displays1 hour
    SCADA StarterSmall SCADA system1000 tags, alarms, trends4 hours
    MES InterfaceProduction trackingDatabase, reports, KPIs1 day
    IIoT GatewayCloud connectivityMQTT, REST API, store-forward2 hours

    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 →

    Tags

    Development Time

    Team Size

    Small<1,0001-2 weeks1 person
    Medium1,000-10,0004-8 weeks2-3 people
    Large10,000-50,0003-6 months3-5 people
    Enterprise>50,0006-12 months5+ people

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


    Shorten Dev time & Increase Reliability Checklist

    What to doReason
    Start with UNS, not DisplaysDisplays seems easier, but without proper data structure, the total development time increases, and reliability decreases.
    Leverage UNS featuresLocal UNS Tags x Linked-Tags x Direct Mapping establishes the foundation for the entire solution Life-cycle 
    Maintain Library of Classes, Symbols & Templates.Create a solution-specific reusable artifacts. Keeps consistency.
    Building Modular
    Scalable  solutions
    Modular architecture & solid design, prevent errors to happen, and provide core to future requirements not yet identified or raised by the end-users, avoid monolithic solution design.



    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

    How to Resolve

    Pitfall

    Impact

    Solution

    How to Resolve

    No naming standardConfusion, errorsDefine and enforce standards early
    Skipping UDTsMaintenance nightmareCreate templates for all equipment
    Over-polling devicesPerformance issuesOptimize scan rates based on needs
    Complex displaysOperator confusionFollow ISA-101, simplify graphics
    No documentationSupport difficultiesDocument as you build
    Ignoring securityVulnerabilitiesImplement security from start

    Next Steps

    After Understanding the Methodology

    Deep Dive into Each Pillar
  • Unified Namespace Details
  • Process Modules Guide
  • Application Modules Guide
  • User Interface Guide
  • Explore Examples
  • Get Hands-On
    • Build a sample solution
    • Follow a tutorial
    • Modify a template
  • Quick Reference

    Four Pillars at a Glance

    PillarPurposeKey ComponentsOrder
    UNSData foundationTags, Assets, UDTsFirst
    ProcessField integrationDevices, Alarms, HistorianSecond
    ApplicationBusiness logicScripts, Datasets, ReportsThird
    InterfaceVisualizationDisplays, Dashboards, ClientsFourth

    Time Estimates

    Solution SizeTagsDevelopment TimeTeam SizeSmall<1,0001-2 weeks1 personMedium1,000-10,0004-8 weeks2-3 peopleLarge10,000-50,0003-6 months3-5 peopleEnterprise>50,0006-12 months5+ people


    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

    Template

    Includes

    Best For

    Basic HMI

    Tags, Displays, Navigation

    Simple machine control

    SCADA System

    Devices, Alarms, Historian, Displays

    Process monitoring

    MES Integration

    Datasets, Scripts, Reports, Dashboards

    Production tracking

    IIoT Gateway

    MQTT, TagProviders, Cloud connectivity

    Edge computing

    Next Steps

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