Overview
FrameworX serves diverse professionals across the industrial automation spectrum. This guide provides tailored learning paths for Control Engineers, IT Professionals, and System Integrators, helping you focus on the most relevant features and capabilities for your role. Each path includes specific tutorials, exercises, and real-world scenarios designed to accelerate your proficiency.
Select Your Professional Profile
Quick Assessment - Which Path Is Right for You?
Answer these questions to identify your optimal learning path:
Question | Control Engineer | IT Professional | System Integrator |
---|---|---|---|
Primary Background | PLC/DCS/SCADA | Databases/Networks/Security | Project Delivery/Architecture |
Main Focus | Field devices & HMI | Enterprise integration | Complete solutions |
Typical Tools | Ladder logic, HMI software | SQL, Active Directory, APIs | Multiple platforms |
Key Concerns | Reliability, real-time control | Security, data integrity | Scalability, standards |
Path 1: For Control Engineers
Your Profile
Traditional automation professionals with experience in PLCs, HMIs, and SCADA systems. You focus on reliable control, operator interfaces, and field device integration.
Learning
...
By completing this path, you will:
- ? Connect and configure industrial devices
- ? Design effective operator interfaces
- ? Implement alarm management strategies
- ? Create control logic and calculations
- ? Build trending and historical displays
Week 1: Foundation for Control Engineers
Day 1-2: Device Communication Mastery
Morning: Understanding FrameworX Drivers
Exercise 1: Driver Selection
1. Open Designer → Devices
2. Review available drivers:
- Allen-Bradley (EtherNet/IP)
- Siemens (S7)
- Modbus (TCP/RTU)
- OPC UA
3. Document which drivers match your PLCs
Afternoon: Configure Your First PLC
Lab: Connect to Allen-Bradley ControlLogix
??? Step 1: Create Channel
? - Protocol: Allen-Bradley ControlLogix
? - Connection: Ethernet
? - Timeout: 3000ms
??? Step 2: Add Node
? - IP Address: [Your PLC IP]
? - Slot Number: 0
??? Step 3: Import Tags
? - Use automatic tag import
? - Map to UNS namespace
??? Step 4: Verify Communication
- Check status indicators
- Monitor update rates
Day 3-4: HMI Design Fundamentals
Creating Operator Displays
Standard Display Components:
???????????????????????????????????????
? Header (Title, Time, Alarms) ?
???????????????????????????????????????
? ?
? Main Process Graphic ?
? (P&ID representation) ?
? ?
???????????????????????????????????????
? Navigation Bar ?
???????????????????????????????????????
Exercise: Build Motor Control Faceplate
- Create new symbol "MotorControl"
- Add elements:
- Status indicator (Running/Stopped)
- Start/Stop buttons
- Speed display (if VFD)
- Fault indicator
- Local/Remote mode
- Link to Motor UDT
- Test in runtime
Day 5: Alarm Configuration
Alarm Philosophy Implementation
Priority | Color | Response Time | Example |
---|---|---|---|
Critical (1-200) | Red | Immediate | Safety shutdown |
High (201-400) | Orange | 10 minutes | Process upset |
Medium (401-600) | Yellow | 30 minutes | Efficiency loss |
Low (601-999) | Blue | Next shift | Maintenance required |
Lab: Configure Process Alarms
Tank Level Alarms:
??? HiHi Alarm (95%) - Priority 250
??? Hi Alarm (85%) - Priority 400
??? Lo Alarm (15%) - Priority 400
??? LoLo Alarm (5%) - Priority 250
Settings per alarm:
- Deadband: 2%
- Delay On: 5 seconds
- Delay Off: 3 seconds
- Auto Acknowledge: No
Week 2: Advanced Control Topics
Day 1-2: Control Logic Implementation
Script Development for Control Engineers
csharp
// Example: Pump Control Logic
public void PumpControl()
{
// Read process values
float tankLevel = @Tag.Tank01.Level;
float setpoint = @Tag.Tank01.Setpoint;
bool pumpAvailable = @Tag.Pump01.Available;
// Control logic
if (pumpAvailable)
{
if (tankLevel < (setpoint - 5))
{
@Tag.Pump01.StartCmd = true;
@Tag.Pump01.Speed = CalculateSpeed(tankLevel, setpoint);
}
else if (tankLevel > (setpoint + 2))
{
@Tag.Pump01.StartCmd = false;
}
}
// Alarm generation
if (!pumpAvailable && tankLevel < 10)
{
@Tag.Alarms.LowLevelNoPump = true;
}
}
private float CalculateSpeed(float level, float sp)
{
// PID calculation or curve
float error = sp - level;
return Math.Max(30, Math.Min(100, error * 5));
}
Day 3-4: Trending and Historical Analysis
Creating Effective Trends
Trend Configuration:
??? Time Axis
? ??? Real-time (last hour)
? ??? Historical (date range)
? ??? Resolution (1 sec - 1 day)
??? Y-Axes
? ??? Primary (0-100%)
? ??? Secondary (0-150°F)
? ??? Auto-scale option
??? Pens
??? Pen 1: Flow (Blue, Primary)
??? Pen 2: Pressure (Green, Primary)
??? Pen 3: Temperature (Red, Secondary)
Exercise: Build Trending Display
- Create new display "ProcessTrends"
- Add trend object
- Configure 4 pens for related process values
- Add time navigation controls
- Include data export button
Day 5: Performance Optimization
Optimizing for Control Applications
Area | Best Practice | Impact |
---|---|---|
Scan Rates | Match process dynamics | Reduce network load |
Display Updates | Limit animations | Improve client performance |
Alarm Deadbands | Prevent chattering | Reduce alarm floods |
Script Efficiency | Avoid loops in expressions | Lower CPU usage |
Control Engineer Toolkit
Essential Components Library
Standard Objects to Create:
??? Motors
? ??? Motor_Simple (On/Off)
? ??? Motor_VFD (Variable Speed)
? ??? Motor_Reversing (Forward/Reverse)
??? Valves
? ??? Valve_OnOff
? ??? Valve_Control (Analog)
? ??? Valve_3Way
??? Process Equipment
? ??? Pump_Centrifugal
? ??? Tank_Level
? ??? Heat_Exchanger
??? Instruments
??? Transmitter_Analog
??? Switch_Digital
??? Controller_PID
Communication Quick Reference
PLC Brand | Recommended Driver | Typical Settings |
---|---|---|
Allen-Bradley | EtherNet/IP | Slot 0, RPI 100ms |
Siemens | S7 TCP | Rack 0, Slot 2 |
Modbus Devices | Modbus TCP | Port 502, Unit ID 1 |
Schneider | Modbus TCP | Port 502, Holdings |
Omron | FINS | Port 9600, Node 1 |
Troubleshooting Guide for Control Engineers
Problem | Check | Solution |
---|---|---|
PLC won't connect | IP address, subnet | Verify network settings |
Tags not updating | Point mapping | Check addresses match PLC |
Alarms flooding | Deadband, delays | Adjust alarm settings |
HMI slow | Graphics complexity | Simplify animations |
Trends gaps | Historian settings | Check storage configuration |
Path
...
Your Profile
IT professionals managing industrial systems integration, cybersecurity, databases, and enterprise connectivity. You bridge the IT/OT gap.
Learning Objectives
By completing this path, you will:
- ? Implement secure authentication systems
- ? Integrate with enterprise databases
- ? Deploy web-based solutions
- ? Configure REST APIs and web services
- ? Establish cybersecurity best practices
Week 1: Foundation for IT Professionals
Day 1-2: Database Integration
SQL Database Connectivity
sql
-- Example: Production Database Schema
CREATE TABLE ProductionData (
ID INT IDENTITY(1,1) PRIMARY KEY,
Timestamp DATETIME NOT NULL,
ProductCode VARCHAR(50),
Quantity INT,
Quality FLOAT,
LineID INT,
OperatorID VARCHAR(50)
);
CREATE TABLE BatchRecords (
BatchID VARCHAR(50) PRIMARY KEY,
StartTime DATETIME,
EndTime DATETIME,
Recipe VARCHAR(100),
Status VARCHAR(20)
);
Exercise: Configure Database Connection
- Navigate to Datasets → Connections
- Add SQL Server connection:
Server: SQLServer01 Database: Production Authentication: Windows Pool Size: 10
- Create real-time query:
sql
SELECT TOP 100 * FROM ProductionData WHERE Timestamp > DATEADD(hour, -1, GETDATE()) ORDER BY Timestamp DESC
Day 3-4: Web Deployment
Setting Up Web Clients
Web Server Configuration:
??? IIS Setup
? ??? Install IIS with WebSocket support
? ??? Configure application pool
? ??? Set up SSL certificate
??? FrameworX Web Config
? ??? Enable web server
? ??? Set ports (HTTP/HTTPS)
? ??? Configure authentication
??? Client Access
??? URL: https://server/frameworkx
??? Test on multiple browsers
??? Verify responsive design
Lab: Deploy Secure Web Access
- Generate SSL certificate
- Configure HTTPS binding
- Enable Windows authentication
- Test from remote browser
- Monitor performance
Day 5: Security Implementation
Security Architecture Setup
Security Layers:
???????????????????????????????????
? Network Security ?
? • Firewall rules ?
? • VLAN segmentation ?
???????????????????????????????????
?
???????????????????????????????????
? Application Security ?
? • Authentication (AD/LDAP) ?
? • Role-based access ?
? • Audit logging ?
???????????????????????????????????
?
???????????????????????????????????
? Data Security ?
? • Encryption at rest ?
? • TLS in transit ?
? • Backup encryption ?
???????????????????????????????????
Week 2: Advanced IT Topics
Day 1-2: Enterprise Integration
REST API Implementation
javascript
// Example: REST API Client Configuration
const apiConfig = {
baseURL: 'https://frameworkx-server/api',
endpoints: {
tags: '/tags',
alarms: '/alarms',
historical: '/historian'
},
authentication: {
type: 'Bearer',
token: 'your-api-token'
}
};
// GET current tag values
async function getTagValues(tagNames) {
const response = await fetch(`${apiConfig.baseURL}/tags`, {
method: 'POST',
headers: {
'Authorization': `Bearer ${apiConfig.authentication.token}`,
'Content-Type': 'application/json'
},
body: JSON.stringify({ tags: tagNames })
});
return response.json();
}
Exercise: Create ERP Integration
- Design data exchange schema
- Configure REST endpoints
- Implement authentication
- Schedule data sync
- Add error handling
Day 3-4: Cloud Deployment
Azure/AWS Integration
yaml
...
-
...
Day 5: Performance & Monitoring
System
...
Integrators
Target Audience
...
powershell
# PowerShell Monitoring Script
$server = "FrameworX-Server"
$metrics = @{
CPU = (Get-Counter "\Processor(_Total)\% Processor Time").CounterSamples.CookedValue
Memory = (Get-Counter "\Memory\Available MBytes").CounterSamples.CookedValue
Disk = (Get-Counter "\PhysicalDisk(_Total)\% Disk Time").CounterSamples.CookedValue
Network = (Get-Counter "\Network Interface(*)\Bytes Total/sec").CounterSamples.CookedValue
}
# Send to monitoring system
Send-MetricsToSplunk -Server $server -Metrics $metrics
IT Professional Toolkit
Security Checklist
- Network segmentation implemented
- Firewalls configured
- SSL certificates installed
- Active Directory integrated
- Role-based access configured
- Audit logging enabled
- Backup strategy implemented
- Disaster recovery tested
- Penetration testing completed
- Security policies documented
Database Optimization Guide
Task | Query | Purpose |
---|---|---|
Index Analysis | sp_helpindex 'TableName' | Identify missing indexes |
Query Performance | SET STATISTICS TIME ON | Measure execution time |
Maintenance | DBCC CHECKDB | Database integrity |
Backup | BACKUP DATABASE TO DISK | Regular backups |
Integration Patterns
Pattern 1: ERP Integration
ERP → REST API → FrameworX → Production
Pattern 2: Cloud Analytics
FrameworX → MQTT → IoT Hub → Analytics
Pattern 3: Reporting
FrameworX → SQL → Power BI → Dashboards
Path 3: For System Integrators
...
System integrators delivering complete solutions from design through deployment
...
, managing projects,
...
implementing standards, and
...
ensuring successful delivery.
Learning Objectives
...
...
- Design scalable architectures
...
- Implement industry standards
...
- Manage multi-site deployments
...
- Create reusable templates
...
- Deliver complete solutions
Learning Paths by Role
Your Role | Primary Focus | Essential Pages | Advanced Topics | |
---|---|---|---|---|
System Integrator | Full platform | Platform Overview | Solution Lifecycle | Security & Operations |
Week 1: Foundation
...
Day 1-2: Architecture Planning
...
System Sizing Calculator
...
Exercise: Design Multi-Site Architecture
- Define site requirements:
- Number of sites
- Tag count per site
- Communication between sites
- Redundancy requirements
- Plan network topology:
- WAN connectivity
- Bandwidth requirements
- Latency constraints
- Specify hardware per site
- Design redundancy strategy
- Document architecture diagram
Day 3-4: Template Development
Creating Reusable Solutions
...
Standard Project Structure
Code Block |
---|
ProjectTemplate/ ??? Standards/ ? ??? NamingConvention.docx ? ??? ColorStandards.xml ? ??? AlarmPhilosophy.docx ??? UDTs/ ? ??? Motors.xml ? ??? Valves.xml ? ??? Instruments.xml ??? Graphics/ ? ??? Symbols.library ? ??? Templates.displays ? ??? Navigation.menu ??? Scripts/ ? ??? Calculations.cs ? ??? Reports.sql ??? Documentation/ ??? UserManual.docx ??? QuickStart.pdf |
Lab: Create Reusable Template
- Create base project structure
- Define naming conventions:
- Tags:
Area_Equipment_Parameter
- Displays:
Area_Function_Type
- UDTs:
Equipment_Vendor_Model
- Tags:
- Build standard UDTs for common equipment
- Create symbol library
- Document standards
Day 5: Project Delivery Methods
Implementation
...
Project Phases:
??????????????????????????????????
? Phase 1: Discovery (1 week) ?
? • Requirements gathering ?
? • Site survey ?
? • Risk assessment ?
??????????????????????????????????
? Phase 2: Design (2 weeks) ?
? • Architecture design ?
? • Standards development ?
? • Review & approval ?
??????????????????????????????????
? Phase 3: Development (4 weeks) ?
? • Configuration ?
? • Programming ?
? • Testing ?
??????????????????????????????????
? Phase 4: Deployment (1 week) ?
? • Installation ?
? • Commissioning ?
? • Training ?
??????????????????????????????????
...
Phases
Phase | Duration | Deliverables |
---|---|---|
Discovery | 1 week | Requirements document, Site survey, Risk assessment |
Design | 2 weeks | Architecture design, Standards document, Design review |
Development | 4 weeks | Configuration, Programming, Unit testing |
Deployment | 1 week | Installation, Commissioning, Training |
Week 2: Advanced Topics
Day 1-2: Standards Implementation
ISA Standards Compliance
Standard |
---|
Focus Area | Implementation | |
---|---|---|
ISA-88 | Batch Control | Recipe management, |
phase logic | ||
ISA-95 | MES Integration | Level models, B2MML interfaces |
ISA-18.2 | Alarm Management | Philosophy document, rationalization |
ISA-101 | HMI Design | Display hierarchy, |
color standards | ||
ISA-99/IEC-62443 | Cybersecurity | Zones, conduits, security levels |
Exercise: Implement ISA-101 Display Hierarchy
- Level 1 - Overview displays (plant-wide)
- Level 2 - Area displays (unit operations)
- Level 3 - Detail displays (equipment)
- Level 4 - Support displays (diagnostics)
- Create navigation structure
- Apply consistent color scheme
- Document display standards
Day 3-4: Performance Optimization
Large System Optimization
...
Strategies
Area | Technique | Implementation |
---|---|---|
Database | Partitioning by date | Monthly partitions for historical data |
Database | Index optimization | Clustered index on timestamp |
Communication | Protocol efficiency | Use bulk reads, minimize polling |
Communication | Compression | Enable data compression |
Processing | Distributed computing | Split processing across servers |
Processing | Edge processing | Local data aggregation |
Client | Lazy loading | Load displays on demand |
Client | View optimization | Limit points per display |
Lab: Optimize Large System
- Analyze system performance baseline
- Identify bottlenecks:
- Database queries
- Network traffic
- CPU utilization
- Implement optimizations
- Measure improvement
- Document settings
Day 5: Solution Validation
...
Test Categories and Procedures
Test |
---|
...
Type | Focus | Method |
---|---|---|
Functional | I/O |
...
verification, Control logic, Alarms | Point-to-point testing | |
Performance | Load testing, Stress testing, Endurance | Simulate maximum load |
Security | Access control, Audit trails | Penetration testing |
Acceptance | User requirements, Performance criteria | Witness testing |
Project Estimation Guidelines
...
System Integrator Toolkit
Project Management Templates
- Statement of Work (SOW)
- Functional Specification
- Design Specification
- Test Procedures
- Training Materials
- Handover Documentation
Estimation Guidelines
Task | Hours per Unit | Notes |
---|
Tag Configuration | 0.1 hour/tag | Including alarming |
Display Development | 4-8 hours/display | Depends on complexity |
Device Integration | 2-4 hours/device | Including testing |
Alarm Configuration | 0.2 hour/alarm | Including documentation |
Testing | 20% of development | All test categories |
Documentation | 15% of development | User and technical docs |
Training | 16 hours minimum | 2 days |
on-site |
Quality Assurance Checklist
- Requirements traced to implementation
- All I/O points verified
- Alarms tested and documented
- Performance requirements met
- Security measures implemented
- Backup/recovery tested
- Documentation complete
- Training delivered
- Support handover complete
...
Project Management Templates
Required Documentation
Document | Purpose | When |
---|---|---|
Statement of Work | Define scope and deliverables | Pre-project |
Functional Specification | Detail requirements | Discovery phase |
Design Specification | Technical design | Design phase |
Test Procedures | Validation methods | Development phase |
Training Materials | User education | Deployment phase |
Handover Documentation | Support transition | Project close |
Multi-Site Deployment Strategy
Approach | Pros | Cons | Best For |
---|---|---|---|
Centralized | Single point of management | WAN dependency | < 5 sites |
Distributed | Local autonomy | Complex management | > 10 sites |
Hybrid | Balance of both | Higher complexity | 5-10 sites |
Troubleshooting Guide
Issue | Investigation | Resolution |
---|---|---|
Performance degradation | System metrics analysis | Apply optimization strategies |
Communication failures | Network diagnostics | Verify routing, firewall rules |
Synchronization issues | Time server configuration | Configure NTP properly |
Template conflicts | Version comparison | Implement version control |
Deployment failures | Installation logs | Verify prerequisites |
Certification Path
FrameworX Solution Architect
- Prerequisites: FrameworX Certified Developer + project experience
- Focus Areas: Architecture design, standards implementation, project delivery
- Format: Online exam + architecture review project
- Duration: 6 hours
Additional Resources
- Architecture Design Guide
- ISA Standards Implementation
- Project Template Library
- Multi-Site Deployment Guide
- Community Forum - Architecture Section
Certification Paths
Available Certifications
Certification | Target Audience | Prerequisites | Exam Topics |
---|---|---|---|
FrameworX Certified Developer | All paths | Basic training | Configuration, displays, basic scripting |
FrameworX Control Specialist | Control Engineers | FCD + experience | Advanced control, PLC integration |
FrameworX IT Specialist | IT Professionals | FCD + IT background | Security, databases, web deployment |
FrameworX Solution Architect | System Integrators | FCD + project experience | Architecture, standards, deployment |
Next Steps for All Paths
Continue Learning
- Hands-On Practice - Build sample projects
- Community Forum - Join discussions
- Advanced Training - Specialized courses
- Certification - Validate your skills
- Real Projects - Apply knowledge
Resources by Path
Resource | Control Engineers | IT Professionals | System Integrators |
---|---|---|---|
Priority Docs | Device configs, HMI design | Security, APIs | Architecture, standards |
Key Examples | PLC integration, faceplates | Database, web apps | Templates, multi-site |
Forum Sections | Devices, displays | Integration, security | Architecture, deployment |
Advanced Topics | Custom drivers, scripting | Cloud, enterprise | Standards, optimization |
AI Assistant Data
<details> <summary>Structured Information for AI Tools</summary>
json
{
"page": "Choose Your Path",
"type": "Role-Based Learning Paths",
"purpose": "Provide tailored learning experiences for different professionals",
"paths": [
{
"role": "Control Engineers",
"focus": "PLCs, HMI, SCADA, field devices",
"duration": "2 weeks",
"skills": ["Device integration", "HMI design", "Alarm management", "Control logic"]
},
{
"role": "IT Professionals",
"focus": "Databases, security, web, integration",
"duration": "2 weeks",
"skills": ["Database integration", "Web deployment", "Security", "APIs"]
},
{
"role": "System Integrators",
"focus": "Architecture, standards, deployment",
"duration": "2 weeks",
"skills": ["System design", "Templates", "Standards", "Project delivery"]
}
],
"commonElements": [
"Foundation week",
"Advanced week",
"Hands-on exercises",
"Real-world scenarios",
"Toolkit resources"
],
"certification": {
"base": "FrameworX Certified Developer",
"specialized": ["Control Specialist", "IT Specialist", "Solution Architect"]
}
}
...