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 →

Integration

Industrial Operations Business 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

. This field-proven approach has been refined across hundreds of deployments to minimize rework and maximize reliability.

On this page:

Table of Contents
maxLevel2
minLevel2
indent10px
excludeSteps
stylenone



The Four Pillars Overview

Image Added

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

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

Tag Structure Image Added

Asset TreeImage Added

User Data TypesImage Added

  • Define naming conventions
  • Create tag hierarchy
  • Set data types and ranges
  • Configure engineering units
Asset Tree
  • Mirror physical/logical structure -
  • Organize by area/process/equipment -
  • Create navigable hierarchy
User Data Types (UDTs)
  • -
  • Enable asset-based navigation
  • 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

  • Ensure consistency

[

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

Device CommunicationsImage Added

Alarm ManagementImage Added

HistorianImage Added

  • Configure channels and
protocols
  • protocols 
  • Setup nodes and devices
,
  • Map points to tags
, or use direct binding
  • Optimize scan rates
  • -
Alarm Management
  • Define alarm areas and groups
  • - Configure conditions and limits
  • - Setup notifications -
Historian (Time-series Data Collection)
  • Implement ISA-18.2 standards
  • Configure data
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?
???????????         ???????????          ???????????
  • policies 
  • Plan for growth

[

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

Business Logic)

Purpose

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

What to Build

Database Integration

ScriptsImage Added

DatasetsImage Added

ReportsImage Added

  • Write calculation logic
  • Implement workflows
  • Create data validation
  • Automate processes
  • Connect to SQL
databasesReporting
  • databases 
  • Create queries and views
  • Setup synchronization
  • Business Logic
    • Write calculation scripts
    • Implement control logic
    • Create data validation
    • Manage transactions
    • 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

    Use CaseImplementation
    KPI CalculationsScripts calculate OEE, efficiency, yield
    Batch RecordsDatabase stores recipe and production data
    IntegrationREST APIs connect to ERP/MES
    ReportsAutomated shift, daily, monthly reports
    • Export formats (PDF//XML/JSON)

    [Detailed Application Modules Guide →]


    Pillar 4: User Interface (

    Analyze & Visualize

    Visualization)

    Purpose

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

    What to Build

    Operational DisplaysImage Added

    DashboardsImage Added

    Operator UI ClientsImage Added

    • Process graphics
    • Control panels
    • Navigation structure
    Dashboards
    • Alarm summaries
    • KPI visualization
    • Analytics views
    • Mobile
    views
    • layouts
    Client Deployment
    • Executive summaries
    • Rich & Smart clients (.NET)
    • 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
    • (WebAssembly)
    • Mobile UI (Responsive)
    • Multi-monitor setup


    [Detailed Operator UI Guide →]

    Solution Ready to Run (Secure & Deploy)

    Purpose

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

    What to Do

    RuntimeImage Added

    SecurityImage Added

    DeploymentImage Added

    • Test with Execution Profiles
    • Development Environment (Lab)
    • Validation Environment (FAT)
    • Production Environment (SAT)
    • Protect Configuration
    • Secure Scripts and IP
    • Defile Users & Roles
    • Apply on Operator UI
    • Single file deployment
    • Publish to FDA & regulated area
    • Container for Edge & Cisco Routers
    • Setup Version Control & Maintenance 

    [Detailed Solution Runtime Guide →]


    Why This Methodology Works

    Benefits of the Four-Pillar Approach

    BenefitDescriptionImpact
    Structured DevelopmentClear sequence of implementation50-70% reduction in rework
    ScalabilityFoundation supports growthEasy expansion without redesign
    MaintainabilityOrganized architectureSimplified troubleshooting
    ReusabilityTemplate-based approach40% faster development
    Best PracticesIndustry-proven patternsReliable solutions

    Common Mistakes to Avoid

    (error) Starting with displays - Without proper data structure

    (error) Skipping UDTs - Leading to tag sprawl

    (error) Direct device-to-display binding - Creating maintenance nightmares

    (error) Ignoring naming conventions - Causing confusion later

    (error) Building monolithic solutions - Instead of modular architectureDetailed User Interface Guide →



    Solution Templates

    Quick Start Templates

    Deploy1 hour1000 tags alarms trends4 hours1 day GatewayCloud connectivity REST API, store-forward
    TemplateDescriptionComponentsTime to
    Explore
    Basic HMISimple machine interface
    100 tags, 5 displays
    Displays, Modbus, TouchPanel UI10 min
    SCADA StarterSmall SCADA system
    Alarms,
    trends,
    reports
    15 min
    MES InterfaceProduction trackingDatabase, reports, KPIs
    20 min
    IIoT
    & MQTTEdge IntegrationMQTT Broker,
    2 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 →

    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

    PitfallImpactSolution
    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
    Client, SQL15 min
    Enterprise ProveIt!Corporate LevelEnterprise Unlimited, Extended UNS20 min



    Development Workflow

    Image Added

    Solution Development Stages

    InitiateDesignBuildDeploySupport
    • Requirements
    • Scope
    • Resources
    • Architecture
    • UNS design
    • Standards
    • Configuration
    • Testing
    • Integration
    • Installation
    • Commissioning
    • Training
    • Maintenance
    • Optimization
    • Updates

    Platform UI Components

    Three Essential Workspaces


    Image Added


    UI EnvironmentPurposeKey Functions
    Solution CenterSolution Management
    • Create/open solutions
    • License management
    • Server configuration
    • Launch Designer and Runtime
    DesignerSolution Configuration
    • UNS Configuration
    • Process Modules Design
    • Application Modules Design
    • Operator UI Design
    Runtime

    Solution Execution

    • Real-time data processing
    • Client connections
    • Module execution
    • Performance monitoring



    Quick Reference Tables

    Development

    Next Steps

    After Understanding the Methodology

    1. Deep Dive into Each Pillar
    2. Explore Examples
    3. 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 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.

    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

    (*) About the Development Time estimates

    Best Practices Checklist

    DO:DON'T:

    ?(tick) Start with UNS design

    ?(tick) Use naming conventions

    ?(tick) Create UDTs first

    ?(tick) Test each pillar

    ?(tick) Document decisions

    ?(tick) Use version control

    ?(error) Start with displays

    ?(error) Skip testing phases

    ?(error) Hardcode values

    ?(error) Ignore standards

    ?(error) Build without UDTs

    ?(error) Deploy without backup



    Next Steps

    • Get Started: Download [Solution Templates]
    • Deep Dive: Explore each pillar's detailed guide
    • Learn More: Review [Best Practices] documentation
    • Get Help: Access [Training Resources]



    In this section...

    Page Tree
    root@parent
    spaces93DRAF

    Next Steps

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