Designer Workspace (Reference):
Detailed technical documentation for all Designer workspace elements, panels, and navigation features.
Related Topics:
- Solution Explorer (Reference) - Module navigation
- Working with DataGrids - Table editing
- Keyboard Shortcuts - Quick commands
Introduction to Designer Workspace
The Designer is a configuration workspace for industrial solutions, designed to make solution configuration procedures even more accessible and intuitive, offering engineering features, functionalities, and configuration tools.
It provides a single, integrated environment for design, development, testing, simulation, validation, deployment, execution, and solution management, delivering high-end applications.
Table of Contents maxLevel
2 minLevel 2 indent 10px exclude Steps style none
Key Concepts and Terms
Solution
A Solution refers to an application for real-time data built on the software platform. The platform organizes its smart applications into solutions, providing various tools and features to design and manage the end-to-end Solution Development Life Cycle. Every solution developed on the software platform generates a file (.dbsln). This file is the output of the application, containing all the engineering and business logic developed, tested, validated, and deployed according to operational requirements and ready to run. The solution files store all of an application's configuration information. All configuration items are saved in a single embedded SQL database. The file is encrypted for security and can be opened and edited with the Solution Designer and engineering tools.
Modular Architecture
Modular architecture is the foundation of the Solution Designer workspace. Its core is based on compartmentalization, breaking down complex system functionalities into distinct and standalone modules. The modular architecture provides flexibility in design and configuration while ensuring that changes or adjustments to one module won't inadvertently disrupt or compromise another.
Unified Namespace
The Unified Namespace (UNS) centralizes data in complex systems like smart manufacturing, offering semantic data structuring. It aggregates, normalizes, and provides data access, streamlining communication and integration among disparate systems. As a middleware layer, the UNS translates raw data into actionable information, ensuring device interaction within a hub-and-spoke architecture, minimizing direct communications, and maximizing flexibility.
Process Modules
Process modules refer to the software components that manage and execute a system's internal logic and data transformations. They encompass Scripts, Reports, and Datasets. They are called "process modules" because these components specifically deal with the internal processes and workflows that enable the system to function efficiently.
Application Modules
Application modules are software components that facilitate interactions between a system and its external environment or various system parts. The application modules encompass Alarms, Devices, and Historians. They are called "Application Modules" because they are applied to specific tasks or applications within the system. These modules continuously monitor, collect, and process information, ensuring that the system remains in its desired state.
Runtime
Runtime refers specifically to the phase where a solution is in active execution. This phase involves running tests, carrying out validations, and handling other critical tasks associated with deploying a solution. During this phase, the software effectively utilizes all configured modules — such as Devices, Alarms, and Historians — to execute tasks, manage data, and perform automated operations based on predefined settings. The Runtime Environment operates seamlessly, integrating with the Solution Designer workspace and the Unified Namespace to ensure real-time data exchange and process control.
Understanding the User Interface
Welcome page
The Designer home page is the entry point when you design a solution using the software platform. It provides an interface for the following actions:
- User Login: Some configuration features may be protected according to the user.
- Solution Information: A summary of key information about your solution.
- Local Settings / User Preferences: Allows customization of the IDE, such as themes and help messages.
- Recent Items: Shows information about the last objects modified in the solution.
- Help Quick Links: On the left side, information for new users on where to start.
Go to Welcome Page Settings for more information
| Tip |
|---|
To return to the Welcome page, use the Home icon located in the top-left area. |
Workspace Layout
Main Window Structure
| Designer UI | |
|---|---|
Menu Bar (File, Open, ...) | |
Main Toolbar | |
Navigation Bar | |
Solution | Design Canvas (Active Document) |
Output Panels: [Find Results] [Output] [Error List] | |
Main UI areas
| Area | Purpose | Location |
|---|---|---|
| Solution Explorer | Module navigation | Left panel |
| Main Workspace Area | Active configuration | Center area |
| Find Results Panel | Object settings | Right panel |
| Output Panels | System messages | Bottom panel |
Solution Explorer
Module Organization
| Category | Modules | Purpose |
|---|---|---|
| Foundation | Solution, Runtime | Core settings |
| Data Model | Unified Namespace | Tags and assets |
| Process | Devices, Alarms, Historian | Real-time processing |
| Application | Datasets, Reports, Scripts | Data handling |
| Interface | Displays, Security | User interaction |
| Tools | Data Explorer, Track Changes | Utilities |
Welcome Page
Sections
| Section | Content | Location |
|---|---|---|
| User Login | Current user, login button | Top left |
| Solution Info | Name, version, license | Center top |
| User Preferences | Theme, auto-save, settings | Center |
| Recent Changes | Last modified objects | Bottom |
| Quick Help | Getting started links | Right side |
Solution Information Display
| Field | Description | Example |
|---|---|---|
| Target | Product and framework | FactoryStudio (.NET 8) |
| Tag Count | Local vs external | Local: 1,234 / External: 567 |
| Version | Solution version | 1.2.0 |
| Modified | Last save | 2024-12-15 14:30 |
Main Toolbar
Standard Commands
| Button | Function | Shortcut | Availability |
|---|---|---|---|
| Undo | Revert last action | Ctrl+Z | Until save |
| Redo | Restore undone action | Ctrl+Y | Until save |
| Cut | Cut selection | Ctrl+X | With selection |
| Copy | Copy selection | Ctrl+C | With selection |
| Paste | Insert clipboard | Ctrl+V | After copy/cut |
| Delete | Remove selection | Del | With selection |
| Print current view | Ctrl+P | Always |
Advanced Commands
| Button | Function | Use Case |
|---|---|---|
| Export Document | Save to Git folder | Version control |
| Find Elements | Cross-reference search | Find usage |
| Next Reference | Navigate to next use | After search |
| Previous Reference | Navigate to previous | After search |
| New Tag | Quick tag creation | Any context |
| Tag Properties | Edit tag settings | Tag selected |
| Object Selection | Browse objects | Any context |
Quick Navigation Bar
| Icon | Name | Target | Shortcut |
|---|---|---|---|
| Home | Welcome page | Solution home | Alt+H |
| Tags | UNS Asset Tree | Tag management | Alt+T |
| Draw | Display editor | Graphical design | Alt+D |
| Runtime | Startup control | Execution | Alt+R |
| Back | Previous location | Navigation | Alt+Left |
| Forward | Next location | Navigation | Alt+Right |
| History | Navigation history | Recent pages | Alt+Down |
Solution Explorer Panel
Explorer Modes
| Mode | Description | Use Case |
|---|---|---|
| Accordion | Auto-collapse sections | Focus on current |
| Tree | All sections visible | Overview mode |
Filter Options
| Filter | Shows | Hides |
|---|---|---|
| All Modules | Everything | Nothing |
| Basic Features | Common modules | Advanced |
| Unified Namespace | Data model | Applications |
| Process Modules | Devices, Alarms, Historian | Others |
| Application Modules | Datasets, Reports, Scripts | Others |
Design Canvas Area
Document Types
| Type | Extension | Editor |
|---|---|---|
| DataGrid | Configuration tables | Grid editor |
| Display | .display | Draw environment |
| Script | .cs | Code editor |
| Report | .report | Report designer |
| Query | .sql | Query builder |
Tab Management
| Action | Method | Result |
|---|---|---|
| Open | Double-click | New tab |
| Close | X button | Save prompt |
| Close All | Right-click menu | Save all prompt |
| Float | Drag tab | Separate window |
| Dock | Drag to center | Return to tabs |
Properties Panel
Property Categories
| Category | Content | When Shown |
|---|---|---|
| General | Name, description | Always |
| Data | Bindings, sources | With data objects |
| Appearance | Visual settings | Display objects |
| Behavior | Actions, triggers | Interactive objects |
| Security | Permissions | Protected items |
Property Editors
| Type | Editor | Example |
|---|---|---|
| Text | Text box | Names, descriptions |
| Number | Numeric spinner | Sizes, counts |
| Boolean | Checkbox | Enable/disable |
| Selection | Dropdown | Enumerations |
| Complex | Dialog button | Expressions, colors |
Output Panels
Find Results
| Column | Description | Action |
|---|---|---|
| Location | Module and item | Double-click to go |
| Property | Where used | Shows context |
| Value | Current setting | Reference info |
Output Window
| Tab | Content | Use |
|---|---|---|
| General | System messages | Status info |
| Build | Compilation results | Solution validation |
| Debug | Debug output | Development |
Error List
| Type | Icon | Description |
|---|---|---|
| Error | ? | Must fix |
| Warning | ? | Should review |
| Info | ? | Informational |
User Preferences
Theme Settings
| Theme | Mode | Switch Time |
|---|---|---|
| Sky | Light | → Navy at night |
| Steel | Light | → Graphite at night |
| Light | Light | → Dark at night |
| Pearl | Light | → Indigo at night |
| Gold | Light | → Coffee at night |
Auto-Save Settings
| Option | When Saves | Best For |
|---|---|---|
| Disabled | Manual only | Critical edits |
| On Close | Document close | Default |
| Every 5 min | Timer | Active development |
| Every 10 min | Timer | Normal editing |
| Every 15 min | Timer | Review mode |
Display Options
| Setting | Effect | Default |
|---|---|---|
| Show Quick Help | Help panel visible | On |
| Collapse Menu on Draw | Hide explorer in Draw | Off |
| Auto Export Changes | Git export on save | Off |
Window Management
Docking Zones
| Zone | Location | Content |
|---|---|---|
| Left | Solution Explorer | Navigation |
| Center | Document area | Active work |
| Right | Properties/Help | Context info |
| Bottom | Output panels | Results |
Window States
| State | Description | Toggle |
|---|---|---|
| Docked | Fixed in zone | Drag to zone |
| Floating | Separate window | Drag out |
| Auto-hide | Slide out panel | Pin button |
| Hidden | Not visible | View menu |
Context Menus
DataGrid Context Menu
| Command | Function | Shortcut |
|---|---|---|
| Edit Combined Rows | Multi-edit dialog | Select multiple |
| Copy Selected Rows | Copy with headers | Ctrl+C |
| Paste Rows | Smart paste | Ctrl+V |
| Delete Rows | Remove selected | Del |
| Export to CSV | Save to file | Right-click |
Document Tab Context Menu
| Command | Function | When Available |
|---|---|---|
| Save | Save document | Modified |
| Close | Close tab | Always |
| Close All But This | Close others | Multiple tabs |
| Float | Undock tab | Always |
| New Window | Duplicate view | Always |
Performance Indicators
Status Bar
| Indicator | Shows | Alert Level |
|---|---|---|
| Memory | RAM usage | > 2GB |
| CPU | Processor usage | > 80% |
| Save Status | Last save time | > 10 min |
| User | Current login | Guest |
See Also
Parent Page:
- Designer (Reference) - Main Designer documentation
Related Pages:
- Welcome Page Settings - Preferences detail
In this section...
| Page Tree | ||||
|---|---|---|---|---|
|
Environment Navigation
On the left side of the software, you'll find the complete navigation tree, divided by modules. You can also use the shortcuts at the top of the tree to quickly jump to the Workspace homepage, the UNS module (where you'll manage your tags), the Draw Environment, and the Runtime environment. You may also search for any specific configuration section.
Solution Explorer
Module
Children Pages
Settings | Categories | Import Tags | Import Plugin | Export | History
Startup | Execution Profiles | Build and Publish | Diagnostics
Asset Tree | Tags | Templates | Enumerations | TagProviders | Connections Monitor
Protocols | Channels | Nodes | Points | Access Types | Monitor
Items | Groups | Areas | Global Settings | Monitor
Historian Tags | Historian Tables | Storage Location | Monitor
Databases | Queries | Query Editor | Tables | Files | Monitor
Forms | Forms Editor | WebData | WebData Editor | Monitor
Tasks | Classes | Code Editor | Expressions | References | Monitor
Users | Permissions | Policies | Runtime Users | Monitor
List | Draw | Layouts | Client Settings
Additional pages for Displays: Images, Symbols, Themes, Localization, and Units Conversion
Recent Changes | Version Control | Cross Reference | Use Count | Unused Objects
| Tip | ||
|---|---|---|
| ||
In addition to the Solution Explorer, the top-right side has those shortcuts always available for direct navigation. |
Find Results and Output Window
At the bottom of the window, there are expander for different windows:
Quick Navigation Icons
The Quick Navigation bar includes the following shortcuts:
Switch to allows users to quickly switch between different interfaces, applications, or modes. Designed for quick navigation and enhancing user experience by saving time.
Go to Solutions Management
Directs users to a section or interface where they can manage solutions. This may include adding, editing, deleting, or viewing details of various solutions, depending on the context of the application.
Runtime .NET Displays
Refers to an interface or functionality that showcases the real-time or "runtime" displays or outputs generated using the .NET framework. This is useful for developers or users working with .NET-based applications to monitor or debug their work.
Runtime HTML5 Pages
Shortcut | Description | |
| Home | Redirects users to the Solution Designer home page. |
| Tags | Takes the user to the Asset Tree within the Unified Namespace. It is where your assets can be viewed and managed. |
| Draw | Navigates users to the Draw section on Displays. It is where users can create, edit, or visualize graphical representations or designs. |
| Runtime | Directs the user to the Startup section of the Runtime. It is where users can initiate, run, or monitor processes or applications. |
| Navigation back | Allows users to go back to the previous page or section they were on. |
| Navigation forward | Lets users navigate forward if they've previously used the back button. |
| Navigation history | Presents users with a list of their recent navigation actions, allowing them to quickly jump to a specific page or section they visited earlier |
Switch Button
By clicking on the logo in the top left of the Designer, a menu opens where you can access Solution Management, documentation, the forum, and video training related to design, development, and solution deployment on the software platform.
. |
Discover allows users to explore or find new features, content, or functionalities. Can also be a search or recommendation tool, helping users find relevant information or tools.
Documentation Site
Directs users to a website or portal where they can find detailed documentation about the product, software, or service. It serves as a resource for users to access information, guidelines, and tutorials.
Users Forum
A platform or section where users can interact with each other, ask questions, share insights, and provide solutions. Forums are community-driven and allow users to discuss various topics related to the product or service.
Training Videos
Leads to a library or collection of video content designed to train or educate users about specific features or functionalities. Training videos are visual aids that help users understand and utilize the product or service more effectively.
| Note | ||
|---|---|---|
| ||
In some scenarios, when a dialog is open and you navigate to another application and then return to the dialog, the TextBoxes (text input) in the dialog may not accept focus. To overcome this issue, you need to click on the main Designer window, which will then allow full access to the child dialogs. Alternatively, you can press Cancel or OK in the dialog that was left open. |
Top Main Toolbar
At the top of the page, you have buttons that allow users to undo or redo actions, manipulate rows or objects with cut, copy, paste, and delete functions, and interact with Git for document synchronization. There are also functionalities for searching and navigating references, handling database tags, editing tag properties, and directly accessing documentation or providing feedback.
The table provides a concise reference for the commands and their associated functionalities.
Action | Description | |
| Undo | Undoes an operation/change. This button is available until you save changes. |
| Redo | Redoes a previously undone operation/change. This button is available until you save changes. |
| Cut | Cuts a selected row (DataGrid) or objects (Drawing). This command will delete any select row or object in order to paste it somewhere else. |
| Copy | Copies a selected row (DataGrid) or objects (Drawing). |
| Paste | Pastes a row (DataGrid) or objects (Drawing) that was copied or cut previously. |
| Delete | Deletes selected row (DataGrid) or objects (Drawing). |
| Prints current table (DataGrid) or display (Drawing). | |
| Export Document | It saves the selected object to the Git folder located at the following path: Path: C:\Users\User\Documents\Framework\Solutions\Solution\SolutionData\Git\<Module>\<Configuration interface>\ |
| Find Elements | The Find Elements button on the toolbar accesses the object cross-reference, which lets you find where objects are used in the Project and go directly to each location. |
| Next Reference | Navigates to the subsequent reference or item in a given list or sequence. |
| Previous Reference | Navigates to the preceding reference or item in a given list or sequence. |
| New Tag | Allows the creation of a new tag in the real-time database. |
| Tag Properties | Shows the properties of the tag selected in the text box. |
| Object Selection | Enables the user to choose a specific item from a set of objects or elements within the interface. |
| Open a New Window to the Selected Document | Opens the document or file currently selected in a new window, allowing for parallel viewing or editing alongside the current content. |
| Feedback | Give your opinion in the feedback tab of the Tatsoft website. |
| Documentation | Access the documentation on the website. |
Configuring a Solution
The process to customize the configuration of a solution essentially involves navigating to the specific module and setting up the settings and objects as required by your application.
The Configuration Workflow (Reference) page outlines some typical scenarios when editing a solution.
The Working with DataGrids page provides a detailed explanation on how to manage table-style pages, as much of the solution configuration is done through tables.
Features Highlights
Tooltips and Validation
On the software platform, fields and buttons have tooltips that contain information about the field or button. Tooltips appear when you move your cursor over the related field or button. Some tooltips also include examples to help you. The system validates whatever you enter into most fields, especially tables. Validation rules may check if the input is in the correct format, if the values are within the appropriate range, or other factors. The exact rules depend on the specific item. An entry is invalid if you see a red outline around the table cell.
IntelliSense
The IntelliSense feature presents a list of valid objects according to the characters you type into a specific input field and a list of valid entries for that field. You can insert a selected item from that list by pressing Enter, Space, the dot key, or another symbol key. All input fields that use tag names or object names, whether in data grids or drawing tools, are enabled with IntelliSense. The IntelliSense fields have built-in tooltips and validation. Hovering the mouse over a field will present the expected entries for that field. When you have an invalid input, the border of the field will turn red, and the tooltip will display the error.
Refactoring
Refactoring is the process of changing the definition of tag names or object names (such as alarm groups, device nodes, etc.) after the symbolic name is already in use in the application. The centralized SQL configuration allows you to rename any object by simply typing the new name in the configuration table where that object is defined. All references to that object will remain valid, using the new name with no further actions required. For instance, to rename a tag already in use across the solution, simply go to Unified Namespace → Tags and rename it. The same applies to editing alarm groups, members of templates, or any named object in the system.
ey Features
IntelliSense
Automatic completion and validation for:
- Tag names
- Object references
- Script code
- Expression syntax
Refactoring
Automatic reference updates when renaming:
- Tags
- Display names
- Script classes
- Any named object
Multi-User Support
| Feature | Description | License Required |
|---|---|---|
| Concurrent Edit | Multiple users, same solution | Engineering users > 1 |
| Auto-merge | Automatic conflict resolution | Included |
| Change Tracking | Who changed what | Included |
Auto-Save Options
| Mode | Frequency | Use Case |
|---|---|---|
| On Close | Document close | Default |
| Every 5 min | Automatic | Active development |
| Every 10 min | Automatic | Standard editing |
| Every 15 min | Automatic | Review mode |
| Manual | User triggered | Critical changes |
Quick Navigation
| Icon | Target | Description |
|---|---|---|
| Home | Welcome page | Solution home page |
| Tags | Unified Namespace | Asset tree management |
| Draw | Display editor | Graphical design |
| Runtime | Execution control | Process monitoring |
Main Toolbar
| Action | Function | Shortcut |
|---|---|---|
| Undo/Redo | Revert/restore changes | Ctrl+Z/Y |
| Cut/Copy/Paste | Standard editing | Ctrl+X/C/V |
| Delete | Remove selected | Delete |
| Find Elements | Cross-reference search | Ctrl+F |
| New Tag | Create tag | Ctrl+T |
| Export Document | Save to Git folder | - |
Solution Configuration
Configuration Storage
| Content | Storage Method | Encryption |
|---|---|---|
| Tags | Embedded SQL | AES-256 |
| Displays | Embedded SQL | AES-256 |
| Scripts | Embedded SQL | AES-256 |
| Images | Binary storage | AES-256 |
Export Formats
| Format | Extension | Purpose |
|---|---|---|
| CSV | .csv | Spreadsheet editing |
| JSON | .json | Version control |
| XML | .xml | External tools |
Temporary Folders
Solution-specific temporary data stored in SolutionName-Designer folder:
| Folder | Usage |
|---|---|
| Git | Configuration exports when auto-export enabled |
| NetCompiler | Intermediate compiler files and debug info |
| Settings | User preferences and grid states |
| TagsUsage | Debug mode tag usage reports |
| TraceLogs | Solution-specific logs when enabled |
Basic Workflows
Data Definitions
- Define tags in Unified Namespace
- Create data templates
- Build asset tree
- Connect tag providers
Process Configuration
- Setup device connections
- Configure alarms
- Enable historian
- Map communication points
Application Development
- Create datasets
- Build reports
- Write scripts
- Design displays
Deployment
- Configure security
- Test in development mode
- Validate functionality
- Deploy to production
Typical Procedures
| Action | Location | Description |
|---|---|---|
| Create Tags | Unified Namespace → Tags | Define or paste from spreadsheet |
| Import Tags | Solution → Import Tags | Import from external sources |
| Connect Providers | Unified Namespace → TagProviders | Dynamic data sources |
| Create Templates | Unified Namespace → Data Templates | Asset modeling |
| Design Displays | Displays → Draw | Create HMI screens |
| Configure Devices | Devices | Setup communications |
| Define Alarms | Alarms | Configure alarm conditions |
| Setup Historian | Historian | Time-series data |
| Configure Security | Security | User access control |
Performance
Resource Usage
| Component | Typical RAM | CPU Impact |
|---|---|---|
| Base IDE | 200-500 MB | Low |
| Large solution | 500-2000 MB | Medium |
| Draw environment | +200 MB | Medium |
| Code editor | +100 MB | Low |
Optimization Tips
- Close unused document tabs
- Use filtering in Solution Explorer
- Disable auto-save for large solutions
- Regular solution compacting
Troubleshooting
Common Issues
| Problem | Cause | Solution |
|---|---|---|
| Slow loading | Large solution | Compact database |
| Can't edit | Read-only mode | Check permissions |
| Changes lost | No auto-save | Enable auto-save |
| IntelliSense missing | Cache issue | Restart Designer |
Log Files
| Log Type | Location | Content |
|---|---|---|
| Designer | Logs\Designer\ | IDE errors |
| Configuration | Logs\Config\ | Save errors |
| User Actions | Logs\Audit\ | Change log |
In this section...
| Page Tree | ||
|---|---|---|
|
In this section:
| Page Tree | ||||
|---|---|---|---|---|
|