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:

Prerequisites

Before starting, ensure you have:

Step 1: Create Your Solution (1 minute)

Launch Solution Center

  1. Start FrameworX
  2. Create New Solution

? 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
  2. Add New Tag
  3. Add Control Tags

? Checkpoint: Three tags visible in the tag grid

Step 3: Design Your Display (2 minutes)

Create Display

  1. Navigate to Displays
  2. Add Title
  3. Add Temperature Display
  4. Add SetPoint Control
  5. Add Enable Switch
  6. Arrange Layout

? 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
  2. Start Runtime
  3. Test Your Solution
  4. Make It Dynamic (Optional - 30 seconds)

? 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

Managing Solutions

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

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

Production Mode

Monitoring Runtime

  1. Runtime Information
  2. Property Watch
  3. Diagnostics

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

Hands-On Exercises

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

Hands-On Exercises

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

Hands-On Exercises

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

ProblemSolution
Can't create solutionRun Solution Center as Administrator
Designer won't openCheck for development license
Runtime won't startVerify no port conflicts on 9000
Display blankCheck if Runtime is actually running
Tags not updatingVerify Runtime started successfully

Getting Help

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

Opus 4.1