Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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
maxLevel2
minLevel2
indent10px
excludeSteps
stylenone


Create Your Solution (1 minute)

Launch Solution Center

  1. Start FrameworX
    • Windows: Start Menu → FrameworX

...

    • → Solution Center
    • Or use desktop shortcut

...

Create New Solution

  1. Click

...

  1. New Solution

...

  1. button
  2. Configure:
    • Name:

...

    • MyFirstSolution
    • Product Family: FrameworX

...

    • Location: Keep default or browse
  1. Click

...

  1. Create

...

(tick) Checkpoint: Solution created and appears in the solution list

...


Add Your First

...

Tags (1 minute)

Open Designer

...

  1. Select your solution

...

  1. Click Edit - Designer opens

...

Create

...

Tags

  1. Navigate to

...

  1. Unified Namespace

...

...

  1. Tags
  2. Add

...

  1. Temperature tag:
    • Name:

...

    • Temperature
    • Type:

...

    • Double
    • Initial Value:

...

    • 75.5
    • Description:

...

    • Room Temperature

...

  1. Add

...

  1. SetPoint tag:
    • Name:

...

    • SetPoint
    • Type:

...

    • Double
    • Initial Value:

...

    • 72.0
  1. Add

...

  1. SystemEnabled tag:
    • Name:

...

    • SystemEnabled
    • Type:

...

    • Digital
    • Initial Value:

...

    • 1

...

(tick) Checkpoint: Three tags visible in the tag grid

...


Design Your Display (2 minutes)

Create Display

  1. Navigate to Displays
  • In left tree: Displays  MainPage
  • Click Edit icon or double-click
  1. → Draw → List
  2. Double-click MainPage to open editor

Build Interface

  1. Add title:
    • Drag TextBlock from toolbox
    • Enter

...

    • : "My First FrameworX Solution"
    • Set font size: 24

...

  1. Add Temperature

...

  1. display:
    • From

...

    • Assets tree, drag Temperature tag to canvas
    • TextBox appears showing value
  1. Add SetPoint

...

  1. control:
    • Drag

...

    • SetPoint

...

    • tag to display
    • Right-click

...

    • Dynamics → use Slider
    • Set

...

    • range: Min=50, Max=100
  1. Add Enable

...

  1. switch:
    • Drag

...

    • SystemEnabled

...

    • tag to display
    • Right-click →

...

    • Dynamics → use CheckBox
    • Set label: "System Enabled"

...

  1. Save display (Ctrl+S)

...

(tick) Checkpoint: Display shows title, temperature value, setpoint slider, and enable checkbox

...


Run Your Solution (1 minute

...

Start Runtime

...

)

Start Runtime

...

  1. Click

...

  1. Run

...

  1. button in Designer toolbar
    • Or press F5
  2. Runtime starts and display opens

...

Test Your Solution

  • Move

...

  • SetPoint slider - value

...

  • updates
  • Toggle System Enabled checkbox

...

  • Observe Temperature value

...

Make It Dynamic

...

(Optional

...

)

  1. Return to Designer
  2. Select Temperature tag
  3. Add expression

...

  1. in Value column:
   @Tag.SetPoint + 

...

Rand(-5, 5)

...

  1. Restart Runtime

...

  1. - Temperature

...

  1. fluctuates around SetPoint

...

...

(tick) Success!

...

You've created your first FrameworX solution

...

Solution Center Overview

Understanding the Interface

PanelPurposeKey Actions
Solution ListShows all solutionsSelect, search, organize
Solution ActionsOperations toolbarNew, Open, Edit, Run, Stop
Properties PanelSolution detailsView version, size, status
License StatusCurrent license infoCheck 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

FeatureLocationPurpose
Tag EditorUNS → TagsCreate and configure tags
Display DesignerDisplays → PagesBuild HMI screens
Device ConfigurationDevices → ChannelsSetup communications
Script EditorScripts → TasksWrite custom logic
Test ModeToolbar → Run TestTest 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

ComponentFunctionAccess
TServerCore execution engineRuns as service
Tag DatabaseReal-time data storageIn-memory
Module EnginesExecute specific functionsAuto-started
Client ServerServes displays to clientsTCP 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

  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
  2. Basic HMI Development
  3. Alarm Configuration

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
  2. Web Technologies
  3. Security Implementation

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
  2. Solution Development
  3. Deployment 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

Join the Community

Quick Reference Card

Essential Shortcuts

ActionShortcutContext
SaveCtrl+SDesigner
Test ModeF5Designer
Build SolutionF7Designer
FindCtrl+FAll
HelpF1All

Common Tasks

TaskWhereHow
Add TagDesigner → UNS → TagsInsert key or click +
Create DisplayDesigner → DisplaysRight-click → New
Add DeviceDesigner → DevicesNew Channel → New Node
Write ScriptDesigner → ScriptsNew Task
View LogsSolution Center → ToolsLog Viewer

File Locations

TypeDefault Path
SolutionsC:\ProgramData\FrameworX\Solutions\
LogsC:\ProgramData\FrameworX\Logs\
LicensesC:\ProgramData\FrameworX\Licenses\
BackupsC:\ProgramData\FrameworX\Backups\

Troubleshooting Quick Start

Common First-Time Issues


Next Steps

TopicDescriptionLink
Understand the PlatformLearn architecture and concepts[Platform Overview]
Build Real SolutionsMaster the four-pillar methodology[The Four Pillars]
Connect to DevicesAdd real data sources[Connect to Devices]

Troubleshooting

Issue

...

Solution
Can't create solutionRun Solution Center as Administrator
Designer won't openCheck

...

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 updatingVerify

...

expression syntax

Getting Help

...

...



In this section...

Page Tree
root@parent
spaces93DRAF

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

...