This guide walks you through using the Designer interface to configure your solution. Learn to navigate between modules, use productivity features, and understand the workspace layout for efficient solution development.
Prerequisites:
First time opening:
??????????????????????????????????????????????????????????? ? 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 ? ? ? ??????????????????????????????????????????????????????????? ? Output Window [Build][Errors][Search Results] ? ??????????????????????????????????????????????????????????? |
Top toolbar shortcuts:
The tree organizes modules by the Four Pillars:
1. Define Your Data
2. Connect & Collect
3. Monitor & Act
4. Visualize & Share
Method 1: Double-click
Method 2: Right-click menu
Method 3: Drag and drop
All module editors share:
Feature | Function | Shortcut |
---|---|---|
Save | Save current changes | Ctrl+S |
Undo/Redo | Reverse actions | Ctrl+Z/Y |
Find | Search in editor | Ctrl+F |
IntelliSense | Auto-completion | Type "." |
Validation | Red border on errors | Automatic |
Most configurations use tables:
Adding rows:
Editing cells:
Selecting multiple:
Right panel shows properties:
Auto-completion everywhere:
Works for:
Find where objects are used:
Real-time error checking:
Rename with automatic updates:
Bottom panel with tabs:
Tab | Shows | Use For |
---|---|---|
Build | Compilation results | After save/build |
Errors | Validation issues | Finding problems |
Search | Find results | Cross-references |
Output | System messages | General info |
Test without deploying:
Available during test:
Not available:
Save current item:
Save all:
Auto-save:
Quick build:
Full build:
Docking panels:
Auto-hide:
Reset layout:
Configure in Tools → Options:
Between items:
For bulk operations:
Action | Shortcut | Context |
---|---|---|
Save | Ctrl+S | Any editor |
Find | Ctrl+F | Any editor |
Replace | Ctrl+H | Text editors |
Undo | Ctrl+Z | Anywhere |
Redo | Ctrl+Y | Anywhere |
Build | F6 | Anywhere |
Test | F5 | Anywhere |
Help | F1 | Context help |
Action | Shortcut |
---|---|
Next tab | Ctrl+Tab |
Previous tab | Ctrl+Shift+Tab |
Close tab | Ctrl+F4 |
Go to line | Ctrl+G |
IntelliSense not working
Cannot save changes
Validation errors persist
Panels disappeared
This guide covered navigating and using the Designer workspace, from basic layout understanding to productivity features, providing the foundation for efficient solution configuration.
The Designer provides a unified configuration workspace for all FrameworX solution development. It delivers an integrated environment for design, development, testing, validation, and deployment across all functional modules, organized through the Four Pillars architecture that structures data flow from field connectivity to user visualization.
Configuration Workflow | |
---|---|
(1) Define Your Data | (2) Setup Industrial Process Modules |
|
|
|
|
|
|
(3) Setup Application Modules | (4) User Interface Design |
|
|
|
|
|
|
Step | Action | Description |
---|---|---|
1. Foundation Layer | Configure UNS | Define tags, templates, enumerations, asset tree |
2. Industrial Integration | Setup Process Modules | Configure Devices, Alarms, Historians |
3. Business Logic | Add Application Modules | Create Scripts, Datasets, Reports |
4. Visualization | Design User Interface | Build Displays, dashboards, client settings |
5. Security | Define Access Control | Setup users, permissions, runtime security |
6. Test & Deploy | Validate Solution | Test mode execution, build, and publish |
Pillar 1: Unified Namespace (Foundation)
Pillar 2: Process Modules (Industrial Integration)
Pillar 3: Application Modules (Business Logic)
Pillar 4: User Interface (Visualization)
Component | Function | Features |
---|---|---|
Navigation Tree | Module access | Quick shortcuts, search, hierarchical browsing |
Design Canvas | Context-sensitive editing | IntelliSense, validation, real-time preview |
Properties Panel | Object configuration | Dynamic property grid, tooltips, examples |
Output Window | System feedback | Build results, errors, search results |
Top Toolbar | Common operations | Undo/redo, cut/copy/paste, find, export |
All configured objects inherit from .NET classes, providing:
The Designer is the configuration workspace for your solution—where you define tags, devices, datasets, alarms, scripts, displays, and security. It supports offline and online editing in a unified, cross-platform UI. See the workspace layoutsketch on page 1 for the main regions (Navigation Tree, Canvas, Properties, Output).
Configure UNS/Tags, Devices, Datasets/SQL, Alarms, Scripts, Displays, and Security from a single workspace.
Use Test Mode to validate behavior without leaving Designer.
Navigate fast via Solution Explorer and quick shortcuts (Home, Tags/UNS, Draw, Runtime).
Inspect cross-references, errors, and build output in the bottom panels.
Benefit from tooltips, validation, IntelliSense, and refactoring across editors.
Use this model to avoid a long flat list and give users a mental map. (Each item links to its module reference.)
Define Your Data
UNS & Tags, Datasets/Queries, Data Explorer tools.
Connect & Collect
Devices (protocol drivers, OPC UA/DA, MQTT Sparkplug B), Connections/Monitors.
Monitor & Act
Alarms (Items/Groups/Areas, Notifications), Historian (SQL/Canary, store-and-forward), Security (users, groups, AD/LDAP).
Visualize & Share
Displays (desktop & web), Reports/Forms/WebData.
Tip: In the Solution Explorer table (Reference), keep these pillar groupings by section so users can scan: Solution, Runtime, UNS, Devices, Alarms, Historian, Datasets, Reports, Scripts, Security, Displays, Data Explorer, Track Changes. (See page 3 for the full child-page matrix.)
Solution (.dbsln): encrypted SQL file storing all configuration.
Modular architecture: changes in one module won’t break others.
Unified Namespace (UNS): central semantic model for tags and assets.
Designer produces the configuration your Runtime executes; clients (desktop & web) visualize and interact with the running system. Designer’s Test Mode lets you validate behavior before publishing to Runtime. (See “Runtime execution” and “Display/HMI clients” callouts on page 1.)
Navigation Tree (modules by pillar) • Design Canvas • Properties Panel • Output/Errors/Cross-Ref. Diagram on page 1.
Quick navigation: Home, UNS/Tags, Draw (Displays), Runtime; plus Switch menu to Solution Management, docs, forum, and training.
Open a solution in Designer.
Work pillar-by-pillar: Define data → Connect devices → Monitor/Act → Visualize/Share.
Run/Test from Designer; then publish to Runtime.
Solution Center (Concept): launchpad for create/open/license/run.
Runtime & Clients (Concept): execution and client connections.
Designer Environment (Reference): UI details, toolbars, shortcuts, child pages.
This keeps Overview short and moves value into What you can do—the same pattern we used for Solution Center.
The pillar mapping mirrors the Process/Application modules split and the Define/Setup/Runtime tiles shown in the Designer reference intro image (page 1), making the concept page consistent with the reference UI.
Want me to generate the matching Modules (Reference) index grouped by the four pillars (with one-line summaries for each module)?
The Designer is where you configure your solution: tags, devices, datasets, alarms, scripts, displays, and security. It supports offline and online configuration and a unified, cross-platform UI.
On this page
What you configure here
Offline vs. online editing
Saving & deploying changes (high level)
???????????????????????????????????????????????????????????
? 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] ?
???????????????????????????????????????????????????????????
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 |
Build real-time data models, like Tags and Templates. Connect seamlessly to external systems using Dynamic ExternalTags for on-demand data connectivity. Asset modeling allows for the creation of a hierarchical view of the data.
Easily store and access time-series data. Our platform includes an SQL historian engine, Canary Historian, at no extra cost. It seamlessly integrates with other historian tools like OSIsoft PI and InfluxDB. Plus, it offers out-of-the-box store-and-forward functionality.
Control access to project configuration and user security effortlessly. Enable FDA compliance applications, integrate with Active Directory, LDAP, and more for user security. Define access to displays and objects based on user profiles and security groups with ease.
Access over 60 native communication protocol drivers for PLCs, transmitters, and field devices effortlessly. Our platform fully supports OPC UA and DA for both server and client execution, along with emerging standards like MQTT SparkPlug B.
Easily organize Tags into Groups and Areas for setting Alarm conditions, Audit-Trail, and notifications via email, SMS, or voice. Visualize alarms online and in the historian. Store data agnostically on any selected Database provider.
Effortlessly handle multiple connections with SQL databases, customize processes with queries, and tailor tables for real-time tag values. Manage recipes and data files in ASCII, UNICODE, or XML formats with ease.
Enable powerful server-side and client-side scripting with high performance. Use languages like C#, VB .NET, Python, and JavaScript. Easily develop multi-threading applications with parallel execution and add references to externally developed classes.
Generate Text (Plain, XML or JSON), PDF, or HTML5 reports directly without relying on external tools. Additionally, utilize web services to interact with external applications or systems. Access, manipulate, and share data using standardized communication protocols like HTTP and RESTful APIs. This facilitates integration with various software systems such as ERP, BI tools, and custom applications, enhancing data sharing and collaboration.
Effortlessly design User Interface Displays using our advanced drawing tool, featuring a wide range of customizable Symbols and Graphical components. Whether you need a Responsive Dashboard, a traditional Process Diagram, or high-performance SCADA Graphics, we've got you covered. Deploy your displays seamlessly in HTML5 or secure .NET SmartClient to desktop, mobile, or web clients. Enhance user experience with features like Language Localization, dynamic Engineering Units conversion, and dynamic theme color schemes.
Perform data mining and monitoring from various data sources, including MQTT Brokers, OPC-UA, PLCs and SQL databases.
Automatically maintain a log of Solution configuration changes, cross-reference tables, and Version Control Information.
In most systems, you usually have to go through the hassle of creating Tags or Variables and writing code to display information about what's happening in your application, like how much CPU is being used by the latest task.
Using our platform, things are way simpler. All those things you need to keep track of, like Tags, AlarmGroups, and ScriptTasks, are actually classes that extend from .NET classes. This means that when you configure your project, you get to use all the properties and methods created by our platform, as well as those already built into the .NET classes.
Take the Tag DateTime, for example. In other systems, you'd need to write code and methods to convert strings to DateTime formats or figure out what day of the week a specific date falls on. But with our platform, the DateTime Tag is just an instance of the .NET class DateTime. That means your project can easily tap into all the properties and methods that come with it, right out of the box.
Finding the weekday of date time event: simply access the property Tag.DateTimeExample.Value.DayOfWeek
,
Finding the amount of CPU used the last time a calculation was executed: simply access the property Script.Task.Example1.LastCPUTime
All the Modules, tools and objects used in a project are organized in accessible namespaces. Some of main namespaces are:
Tags: Group of variables of the real-time database
Alarms: Provides access to all information about the management of Alarms.
Devices: Includes information on all field devices and its communication status.