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
Benefit | Description | Impact |
---|---|---|
Structured Development | Clear sequence of implementation | Reduced errors and rework |
Scalability | Foundation supports growth | Easy expansion without redesign |
Maintainability | Organized architecture | Simplified troubleshooting |
Reusability | Template-based approach | Faster development |
Best Practices | Industry-proven patterns | Reliable 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
Solution Templates
Quick Start Templates
Template | Description | Components | Time to Deploy |
---|---|---|---|
Basic HMI | Simple machine interface | 100 tags, 5 displays | 1 hour |
SCADA Starter | Small SCADA system | 1000 tags, alarms, trends | 4 hours |
MES Interface | Production tracking | Database, reports, KPIs | 1 day |
IIoT Gateway | Cloud connectivity | MQTT, REST API, store-forward | 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
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
Pitfall | Impact | Solution |
---|---|---|
No naming standard | Confusion, errors | Define and enforce standards early |
Skipping UDTs | Maintenance nightmare | Create templates for all equipment |
Over-polling devices | Performance issues | Optimize scan rates based on needs |
Complex displays | Operator confusion | Follow ISA-101, simplify graphics |
No documentation | Support difficulties | Document as you build |
Ignoring security | Vulnerabilities | Implement security from start |
Next Steps
After Understanding the Methodology
- Deep Dive into Each Pillar
- Explore Examples
- Get Hands-On
- Build a sample solution
- Follow a tutorial
- Modify a template
Quick Reference
Four Pillars at a Glance
Pillar | Purpose | Key Components | Order |
---|---|---|---|
UNS | Data foundation | Tags, Assets, UDTs | First |
Process | Field integration | Devices, Alarms, Historian | Second |
Application | Business logic | Scripts, Datasets, Reports | Third |
Interface | Visualization | Displays, Dashboards, Clients | Fourth |
Time Estimates
Solution Size | Tags | Development Time | Team Size |
---|---|---|---|
Small | <1,000 | 1-2 weeks | 1 person |
Medium | 1,000-10,000 | 4-8 weeks | 2-3 people |
Large | 10,000-50,000 | 3-6 months | 3-5 people |
Enterprise | >50,000 | 6-12 months | 5+ people |
Note: Those are order of magnitude references. Specific requirements & workflow & user review process need to be accounted for.
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
Solution Templates
Quick Start Templates
Template | Description | Components | Time to Deploy |
---|---|---|---|
Basic HMI | Simple machine interface | 100 tags, 5 displays | 1 hour |
SCADA Starter | Small SCADA system | 1000 tags, alarms, trends | 4 hours |
MES Interface | Production tracking | Database, reports, KPIs | 1 day |
IIoT Gateway | Cloud connectivity | MQTT, REST API, store-forward | 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
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
Pitfall | Impact | Solution |
---|---|---|
No naming standard | Confusion, errors | Define and enforce standards early |
Skipping UDTs | Maintenance nightmare | Create templates for all equipment |
Over-polling devices | Performance issues | Optimize scan rates based on needs |
Complex displays | Operator confusion | Follow ISA-101, simplify graphics |
No documentation | Support difficulties | Document as you build |
Ignoring security | Vulnerabilities | Implement security from start |
Next Steps
After Understanding the Methodology
- Deep Dive into Each Pillar
- Explore Examples
- Get Hands-On
- Build a sample solution
- Follow a tutorial
- Modify a template
Quick Reference
Four Pillars at a Glance
Pillar | Purpose | Key Components | Order |
---|---|---|---|
UNS | Data foundation | Tags, Assets, UDTs | First |
Process | Field integration | Devices, Alarms, Historian | Second |
Application | Business logic | Scripts, Datasets, Reports | Third |
Interface | Visualization | Displays, Dashboards, Clients | Fourth |
Time Estimates
Solution Size | Tags | Development Time | Team Size |
---|---|---|---|
Small | <1,000 | 1-2 weeks | 1 person |
Medium | 1,000-10,000 | 4-8 weeks | 2-3 people |
Large | 10,000-50,000 | 3-6 months | 3-5 people |
Enterprise | >50,000 | 6-12 months | 5+ 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>
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