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

In just 5 minutes, create 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!

Step 1: Create Your Solution (1 minute)

Launch Solution Center

1. Start FrameworX
   • Windows: Start Menu → FrameworX 10.1 → Solution Center
   • Or desktop shortcut if created during installation
2. Create New Solution
   • Click New Solution button
   • Name: MyFirstSolution
   • Product Family: FrameworX Unlimited
   • Location: Keep default or browse
   • Click Create

? Checkpoint: Solution created and appears in the solution list

Step 2: Add Your First Tag (1 minute)

Open Designer

1. With your solution selected, click Edit
2. Designer opens with your solution loaded

Create a Tag

1. Navigate to Tags
   • In left tree: Unified Namespace → Tags
2. Add New Tag
   • Click in first empty row or press Insert
   • Configure:
     • Name: Temperature
     • Type: Float
     • Initial Value: 75.5
     • Description: Room Temperature
   • Press Enter to confirm
3. Add Control Tags
   • Add another tag:
     • Name: SetPoint
     • Type: Float
     • Initial Value: 72.0
   • Add boolean tag:
     • Name: SystemEnabled
     • Type: Boolean
     • Initial Value: True

? Checkpoint: Three tags visible in the tag grid

Step 3: Design Your Display (2 minutes)

Create Display

1. Navigate to Displays
   • In left tree: Displays → MainPage
   • Click Edit icon or double-click
2. Add Title
   • From toolbox, drag Text to canvas
   • Double-click and type: "My First FrameworX Solution"
   • Set font size: 24
   • Position at top of display
3. Add Temperature Display
   • From right panel, expand Tags tree
   • Find Temperature tag
   • Drag and drop onto display
   • Default TextBox appears showing value
4. Add SetPoint Control
   • Drag SetPoint tag to display
   • Right-click the TextBox → Replace With → Slider
   • Set slider range: Min=50, Max=100
5. Add Enable Switch
   • Drag SystemEnabled tag to display
   • Right-click → Replace With → CheckBox
   • Set label: "System Enabled"
6. Arrange Layout
   • Position elements nicely
   • Use alignment tools if needed
   • Save display (Ctrl+S)

? Checkpoint: Display shows title, temperature value, setpoint slider, and enable checkbox

Step 4: Run Your Solution (1 minute)

Start Runtime

1. Return to Solution Center
   • Close Designer (changes auto-save)
2. Start Runtime
   • Select your solution
   • Click Run button
   • Runtime starts and display opens automatically
3. Test Your Solution
   • Move the SetPoint slider - value changes
   • Toggle System Enabled checkbox
   • Watch Temperature value (static for now)
4. Make It Dynamic (Optional - 30 seconds)
   • Return to Designer
   • Add expression to Temperature tag:

     @Tag.SetPoint + (Random(-5, 5))

   • Restart Runtime
   • Temperature now fluctuates around SetPoint!

? Success! You've created your first FrameworX solution!

Solution Center Overview

Understanding the Interface

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

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

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

1. Runtime Information
   • Solution Center → Tools → Runtime Info
   • Shows module status, memory, connections
2. Property Watch
   • Monitor tag values in real-time
   • See quality and timestamps
3. 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

1. Device Communication
   • Configure your PLC brand
   • Test live data collection
   • Troubleshoot connections
2. Basic HMI Development
   • Create operator displays
   • Build equipment faceplates
   • Implement navigation
3. 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

Start Control Engineer Path →

For IT Professionals

Your Focus

IT/OT convergence, enterprise integration, databases, and cybersecurity.

Recommended Learning Path

Week 1: Foundation

1. Database Integration
   • Connect to SQL databases
   • Build queries
   • Real-time synchronization
2. Web Technologies
   • Deploy web clients
   • Configure HTTPS
   • Setup authentication
3. 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

Start IT Professional Path →

For System Integrators

Your Focus

Complete solution delivery from design through deployment and support.

Recommended Learning Path

Week 1: Foundation

1. Architecture Design
   • Platform architecture
   • Sizing and scaling
   • Network design
2. Solution Development
   • Four-pillar methodology
   • Template creation
   • Standards implementation
3. 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

1. Platform Architecture - Understand the complete system
2. Building Solutions - Master the four-pillar methodology
3. 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

Common Tasks

File Locations

Troubleshooting Quick Start

Common First-Time Issues

Getting Help

• Built-in Help - Press F1 anywhere
• Documentation - You're already here!
• Community Forum - Ask questions
• Support - Open ticket

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.