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. This field-proven approach has been refined across hundreds of deployments to minimize rework and maximize reliability.

On this page:

HTML
results:
??????????????????????????????????????????????????????????????????????????????
?                          FRAMEWORKX SOLUTION                               ?
??????????????????????????????????????????????????????????????????????????????
?                                                                            ?
?  1. UNIFIED NAMESPACE     2. PROCESS MODULES      3. APPLICATION MODULES  ?
?     (Foundation)           (Connect & Collect)      (Store & Process)     ?
?                                                                            ?
?    ????????????            ????????????            ????????????         ?
?    ?   Tags   ? ???????    ? Devices  ? ???????    ? Scripts  ?         ?
?    ?  Assets  ?            ?  Alarms  ?            ? Datasets ?         ?
?    ?   UDTs   ?            ?Historian ?            ? Reports  ?         ?
?    ????????????            ????????????            ????????????         ?
?          ?                        ?                        ?              ?
?          ???????????????????????????????????????????????????              ?
?                                   ?                                       ?
?                         4. USER INTERFACE                                 ?
?                        (Analyze & Visualize)                              ?
?                         ????????????????                                  ?
?                         ?   Displays    ?                                 ?
?                         ?  Dashboards   ?                                 ?
?                         ?    Mobile     ?                                 ?
?                         ????????????????                                  ?
??????????????????????????????????????????????????????????????????????????????


??????????????????????????????????????????????????????????????????????????????
?                          FRAMEWORKX SOLUTION                               ?
??????????????????????????????????????????????????????????????????????????????
?                                                                            ?
?  1. UNIFIED NAMESPACE     2. PROCESS MODULES      3. APPLICATION MODULES  ?
?     (Foundation)           (Connect & Collect)      (Store & Process)     ?
?                                                                            ?
?    ????????????            ????????????            ????????????         ?
?    ?   Tags   ? ???????    ? Devices  ? ???????    ? Scripts  ?         ?
?    ?  Assets  ?            ?  Alarms  ?            ? Datasets ?         ?
?    ?   UDTs   ?            ?Historian ?            ? Reports  ?         ?
?    ????????????            ????????????            ????????????         ?
?          ?                        ?                        ?              ?
?          ???????????????????????????????????????????????????              ?
?                                   ?                                       ?
?                         4. USER INTERFACE                                 ?
?                        (Analyze & Visualize)                              ?
?                         ????????????????                                  ?
?                         ?   Displays    ?                                 ?
?                         ?  Dashboards   ?                                 ?
?                         ?    Mobile     ?                                 ?
?                         ????????????????                                  ?
??????????????????????????????????????????????????????????????????????????????
                          FrameworX Solution                                
_____________________________________________________________________________
?                                                                           ?
?  1. UNIFIED NAMESPACE     2. PROCESS MODULES      3. APPLICATION MODULES  ?
?     (Foundation)      (Industrial Integration)       (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

  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 →

Table of Contents
maxLevel2
minLevel2
indent10px
excludeSteps
stylenone



The Four Pillars Overview

Image Added


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
  • Mirror physical/logical structure -
  • Organize by area/process/equipment -
  • Create navigable hierarchy -
  • Enable asset-based navigation
  • Create equipment templates
  • Define standard objects
  • Build reusable components
  • Ensure consistency

[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

Device CommunicationsImage Added

Alarm ManagementImage Added

HistorianImage Added

  • Configure channels and protocols 
  • Setup nodes and devices
  • Map points to tags
  • Optimize scan rates
  • - Define alarm areas and groups
  • - Configure conditions and limits
  • - Setup notifications -
  • Implement ISA-18.2 standards
  • Configure data storage
  • Set collection rates
  • Define retention policies 
  • Plan for growth

[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

ScriptsImage Added

DatasetsImage Added

ReportsImage Added

  • Write calculation logic
  • Implement workflows
  • Create data validation
  • Automate processes
  • Connect to SQL databases 
  • Create queries and views
  • Setup synchronization
  • Manage transactions
  • Design report templates
  • Configure schedules
  • Setup distribution
  • Export formats (PDF//XML/JSON)

[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

Operational DisplaysImage Added

DashboardsImage Added

Operator UI ClientsImage Added

  • Process graphics
  • Control panels
  • Navigation structure
  • Alarm summaries
  • KPI visualization
  • Analytics views
  • Mobile layouts
  • Executive summaries
  • Rich & Smart clients (.NET)
  • Web access (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 architecture



Solution Templates

Quick Start Templates

TemplateDescriptionComponentsTime to Explore
Basic HMISimple machine interfaceDisplays, Modbus, TouchPanel UI10 min
SCADA StarterSmall SCADA systemAlarms, trends, reports15 min
MES InterfaceProduction trackingDatabase, reports, KPIs20 min
IIoT & MQTTEdge IntegrationMQTT Broker, 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 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

(*) 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

Pillar 2: Process Modules (Industrial Integration)

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

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

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

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

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

Connection Architecture

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

Best Practices

The Four-Pillar Methodology

Building a FrameworX solution follows a logical progression through four integrated pillars. Each pillar builds upon the previous, creating a complete industrial application.

Panel
borderStylesolid
titleSolution Development Workflow

FoundationIntegrationLogicVisualization

Start with data modeling, connect to field devices, add business logic, then create user interfaces.

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.

Key Components

Component

Description

Common Uses

Tags

Real-time data variables

Process values, setpoints, calculations

Asset Tree

Hierarchical data organization

Plant structure, equipment groups

User Data Types

Reusable data templates

Motor, valve, PID loop templates

TagProviders

External data connections

OPC servers, databases, cloud services

Best Practices

  • Design your tag structure before connecting devices
  • Use consistent naming conventions
  • Create UDTs for repeated equipment types
  • Organize assets to match your process

Pillar 2: Process Modules (Connect & Collect)

Purpose

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

Core Modules

Module

Function

Typical Configuration

Devices

Field communication

Channels → Nodes → Points mapping

Alarms

Event management

Areas → Groups → Items → Notifications

Historian

Time-series storage

Storage locations → Tables → Tag mapping

Integration Flow

  1. Configure communication channels
  2. Define device nodes
  3. Map points to UNS tags
  4. Set up alarm conditions
  5. Configure historian collection

Pillar 3: Application Modules (Store & Process)

Purpose

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

Module Capabilities

Module

Primary Use

Key Features

Scripts

Custom logic and automation

Tasks, classes, expressions, multi-language

Datasets

Database integration

SQL queries, stored procedures, real-time sync

Reports

Data exchange and documentation

PDF generation, Excel export, scheduled delivery

Common Implementations

  • Production calculations and KPIs
  • Database logging and retrieval
  • Shift reports and batch records
  • Integration with ERP/MES systems

Pillar 4: User Interface (Analyze & Visualize)

Purpose

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

Visualization Options

Type

Target Users

Deployment

Displays

Operators, Engineers

Control rooms, plant floor

Dashboards

Managers, Analysts

Offices, meeting rooms

Mobile Apps

Field technicians, Supervisors

Tablets, smartphones

Client Technologies

  • Rich Clients - Full-featured .NET applications
  • Web Clients - HTML5 browser-based access
  • Mobile Clients - iOS and Android apps

Module Dependencies and Interactions

Panel
borderStylesolid

Understanding module relationships helps build robust solutions:

  • Tags are used by all other modules
  • Devices populate tag values
  • Alarms monitor tag conditions
  • Historians record tag changes
  • Scripts manipulate tag values
  • Displays visualize tag data

Solution Building Checklist

Foundation Phase

% Define tag naming standards
% Create Asset Tree structure
% Build User Data Types
% Configure TagProviders

Integration Phase

% Set up device communications
% Map device points to tags
% Configure alarm areas and groups
% Set up historian storage

Logic Phase

% Create calculation scripts
% Configure database connections
% Build report templates
% Test data flows

Visualization Phase

% Design operator displays
% Create management dashboards
% Configure navigation
% Deploy clients

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