Quick Start
Overview
Get started with FrameworX 10.1 in minutes, not hours. This Quick Start guide provides hands-on tutorials and learning paths tailored to your role. Whether you're building your first solution or exploring FrameworX capabilities, you'll find the fastest path to productivity here.
Your First Solution - 5 Minutes to Success
What You'll Build
...
First Solution (5 min) creates a working solution with:
- Real-time data tags
- Interactive display with controls
- Live value updates
- Running application
Prerequisites
...
Before starting, ensure you have:
- FrameworX 10.1 installed - Installation Guide
- Valid license - Trial, Development, or Combined
- Administrator access - For first-time setup
- 5 minutes - That's really all you need!
...
On this page:
Table of Contents maxLevel 2 minLevel 2 indent 10px exclude Steps style none
Create Your Solution (1 minute)
Launch Solution Center
- Start FrameworX
- Windows: Start Menu → FrameworX
...
- → Solution Center
- Or use desktop shortcut
...
Create New Solution
- Click
...
- New Solution
...
- button
- Configure:
- Name:
...
-
MyFirstSolution
- Product Family:
FrameworX
-
...
- Location: Keep default or browse
- Click
...
- Create
...
Checkpoint: Solution created and appears in the solution list
...
Add Your First
...
Tags (1 minute)
Open Designer
...
- Select your solution
...
- Click Edit - Designer opens
...
Create
...
Tags
- Navigate to
...
- Unified Namespace
...
- →
...
- Tags
- Add
...
- Temperature tag:
- Name:
...
-
Temperature
- Type:
-
...
-
Double
- Initial Value:
-
...
-
75.5
- Description:
-
...
Room Temperature
...
- Add
...
- SetPoint tag:
- Name:
...
-
SetPoint
- Type:
-
...
-
Double
- Initial Value:
-
...
-
72.0
-
- Add
...
- SystemEnabled tag:
- Name:
...
-
SystemEnabled
- Type:
-
...
-
Digital
- Initial Value:
-
...
-
1
-
...
Checkpoint: Three tags visible in the tag grid
...
Design Your Display (2 minutes)
Create Display
- Navigate to Displays
- In left tree: Displays → MainPage
- Click Edit icon or double-click
- → Draw → List
- Double-click MainPage to open editor
Build Interface
- Add title:
- Drag TextBlock from toolbox
- Enter
...
- : "My First FrameworX Solution"
- Set font size: 24
...
- Add Temperature
...
- display:
- From
...
- Assets tree, drag
Temperature
tag to canvas
- Assets tree, drag
- TextBox appears showing value
- Add SetPoint
...
- control:
- Drag
...
SetPoint
...
- tag to display
- Right-click
...
- → Dynamics → use Slider
- Set
...
- range: Min=50, Max=100
- Add Enable
...
- switch:
- Drag
...
SystemEnabled
...
- tag to display
- Right-click →
...
- Dynamics → use CheckBox
- Set label: "System Enabled"
...
- Save display (Ctrl+S)
...
Checkpoint: Display shows title, temperature value, setpoint slider, and enable checkbox
...
Run Your Solution (1 minute
...
Start Runtime
...
)
Start Runtime
...
- Click
...
- Run
...
- button in Designer toolbar
- Or press F5
- Runtime starts and display opens
...
Test Your Solution
- Move
...
- SetPoint slider - value
...
- updates
- Toggle System Enabled checkbox
...
- Observe Temperature value
...
Make It Dynamic
...
(Optional
...
)
- Return to Designer
- Select Temperature tag
- Add expression
...
- in Value column:
@Tag.SetPoint +
...
Rand(-5, 5)
...
- Restart Runtime
...
- - Temperature
...
- fluctuates around SetPoint
...
...
Success!
...
You've created your first FrameworX solution
...
Solution Center Overview
Understanding the Interface
Panel | Purpose | Key Actions |
---|---|---|
Solution List | Shows all solutions | Select, search, organize |
Solution Actions | Operations toolbar | New, Open, Edit, Run, Stop |
Properties Panel | Solution details | View version, size, status |
License Status | Current license info | Check expiration, features |
Essential Operations
Creating Solutions
- New - Start from scratch
- New from Template - Use industry templates
- Import - Load exported solution
- Clone - Copy existing solution
Managing Solutions
- Backup - Create safety copy
- Export - Package for deployment
- Delete - Remove solution
- Properties - View/edit settings
Designer Basics
Workspace Layout
???????????????????????????????????????????????????????????
? Menu Bar [File][Edit][View][Tools][Help] ?
???????????????????????????????????????????????????????????
? ? ? ?
? Navigation ? Design Canvas ? Properties ?
? Tree ? ? Panel ?
? ? (Context-Sensitive) ? ?
? ? Solution ? ? Tag: Temp ?
? ? UNS ? ? Type: Float ?
? • Tags ? ? Value: 75.5 ?
? ? Devices ? ? ?
? ? Displays ? ? ?
???????????????????????????????????????????????????????????
? Output Window [Build][Errors][Search Results] ?
???????????????????????????????????????????????????????????
Key Designer Features
Feature | Location | Purpose |
---|---|---|
Tag Editor | UNS → Tags | Create and configure tags |
Display Designer | Displays → Pages | Build HMI screens |
Device Configuration | Devices → Channels | Setup communications |
Script Editor | Scripts → Tasks | Write custom logic |
Test Mode | Toolbar → Run Test | Test without leaving Designer |
Navigation Tips
- Double-click items to edit
- Right-click for context menus
- Drag-drop between panels
- Ctrl+S saves current item
- F5 starts test mode
Runtime Fundamentals
Runtime Components
Component | Function | Access |
---|---|---|
TServer | Core execution engine | Runs as service |
Tag Database | Real-time data storage | In-memory |
Module Engines | Execute specific functions | Auto-started |
Client Server | Serves displays to clients | TCP port 9000 |
Execution Modes
Development Mode
- Full diagnostics enabled
- Detailed error messages
- Performance monitoring
- Online configuration changes
Production Mode
- Optimized performance
- Minimal logging
- Security enforced
- Stable operation
Monitoring Runtime
- Runtime Information
- Solution Center → Tools → Runtime Info
- Shows module status, memory, connections
- Property Watch
- Monitor tag values in real-time
- See quality and timestamps
- Diagnostics
- View logs and traces
- Analyze performance
Choose Your Path
Select Your Learning Journey
Based on your role and experience, choose the path that best fits your needs:
For Control Engineers
Your Focus
Traditional automation professionals working with PLCs, HMIs, and SCADA systems.
Recommended Learning Path
Week 1: Foundation
- Device Communication
- Configure your PLC brand
- Test live data collection
- Troubleshoot connections
- Basic HMI Development
- Create operator displays
- Build equipment faceplates
- Implement navigation
- Alarm Configuration
- Setup alarm conditions
- Configure notifications
- Test acknowledgments
Week 2: Advanced Topics
- Complex Graphics - Animations and symbols
- Control Logic - Scripts for automation
- Trending - Historical data visualization
- Reports - Shift and production reports
Hands-On Exercises
- Connect to Allen-Bradley PLC
- Build motor control faceplate
- Create tank level display
- Implement alarm banner
For IT Professionals
Your Focus
IT/OT convergence, enterprise integration, databases, and cybersecurity.
Recommended Learning Path
Week 1: Foundation
- Database Integration
- Connect to SQL databases
- Build queries
- Real-time synchronization
- Web Technologies
- Deploy web clients
- Configure HTTPS
- Setup authentication
- Security Implementation
- User management
- Role-based access
- Audit trails
Week 2: Advanced Topics
- Enterprise Integration - ERP/MES connections
- Cloud Deployment - AWS/Azure setup
- API Development - REST/GraphQL
- Performance Tuning - Database optimization
Hands-On Exercises
- Connect to SQL Server
- Deploy web dashboard
- Implement Active Directory
- Create REST API endpoint
For System Integrators
Your Focus
Complete solution delivery from design through deployment and support.
Recommended Learning Path
Week 1: Foundation
- Architecture Design
- Platform architecture
- Sizing and scaling
- Network design
- Solution Development
- Four-pillar methodology
- Template creation
- Standards implementation
- Deployment Strategies
- Installation procedures
- Redundancy setup
- Backup strategies
Week 2: Advanced Topics
- Project Delivery - Methodologies and tools
- Performance Optimization - Large-scale systems
- Custom Development - Advanced scripting
- Training Delivery - End-user education
Hands-On Exercises
- Design multi-site architecture
- Build reusable templates
- Implement redundancy
- Create training materials
Start System Integrator Path →
Next Steps
After Quick Start
Expand Your Knowledge
- Platform Architecture - Understand the complete system
- Building Solutions - Master the four-pillar methodology
- Solution Examples - Explore industry templates
Get Certified
- FrameworX Certified Developer
- Online courses and exams
- Industry recognition
Join the Community
- Community Forum - Ask questions, share solutions
- User Groups - Local meetups
- Annual Conference - Training and networking
Quick Reference Card
Essential Shortcuts
Action | Shortcut | Context |
---|---|---|
Save | Ctrl+S | Designer |
Test Mode | F5 | Designer |
Build Solution | F7 | Designer |
Find | Ctrl+F | All |
Help | F1 | All |
Common Tasks
Task | Where | How |
---|---|---|
Add Tag | Designer → UNS → Tags | Insert key or click + |
Create Display | Designer → Displays | Right-click → New |
Add Device | Designer → Devices | New Channel → New Node |
Write Script | Designer → Scripts | New Task |
View Logs | Solution Center → Tools | Log Viewer |
File Locations
Type | Default Path |
---|---|
Solutions | C:\ProgramData\FrameworX\Solutions\ |
Logs | C:\ProgramData\FrameworX\Logs\ |
Licenses | C:\ProgramData\FrameworX\Licenses\ |
Backups | C:\ProgramData\FrameworX\Backups\ |
Troubleshooting Quick Start
Common First-Time Issues
Next Steps
Topic | Description | Link |
---|---|---|
Understand the Platform | Learn architecture and concepts | [Platform Overview] |
Build Real Solutions | Master the four-pillar methodology | [The Four Pillars] |
Connect to Devices | Add real data sources | [Connect to Devices] |
Troubleshooting
Issue |
---|
...
Solution | |
---|---|
Can't create solution | Run Solution Center as Administrator |
Designer won't open | Check |
...
Windows version (10 or newer required) |
Runtime won't start |
...
Check Windows Firewall settings |
Display blank |
...
Ensure Runtime is |
...
running (green icon in system tray) | |
Tags not updating | Verify |
...
expression syntax |
Getting Help
...
...
In this section...
Page Tree | ||||
---|---|---|---|---|
|
AI Assistant Data
<details> <summary>Structured Information for AI Tools</summary>
json
{
"page": "Quick Start",
"type": "Tutorial and Learning Paths",
"purpose": "Rapid onboarding for new FrameworX users",
"sections": {
"fiveMinuteTutorial": {
"steps": 4,
"duration": "5 minutes",
"outcome": "Working solution with tags and display"
},
"overviews": [
"Solution Center",
"Designer Basics",
"Runtime Fundamentals"
],
"learningPaths": [
{
"role": "Control Engineers",
"focus": "PLC, HMI, SCADA",
"duration": "2 weeks"
},
{
"role": "IT Professionals",
"focus": "Integration, Security, Web",
"duration": "2 weeks"
},
{
"role": "System Integrators",
"focus": "Architecture, Deployment, Delivery",
"duration": "2 weeks"
}
]
},
"prerequisites": [
"FrameworX installed",
"Valid license",
"Administrator access"
],
"outcomes": [
"Create first solution",
"Understand basic concepts",
"Choose learning path",
"Know where to get help"
]
}
</details>
Claude can make mistakes. Please double-check responses.
Research
...