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

Access Methods

Architecture

Core Components

Module Organization

The Designer organizes functionality into logical modules:

Key Features

IntelliSense

Automatic completion and validation for:

• Tag names
• Object references
• Script code
• Expression syntax

Refactoring

Automatic update of references when renaming:

• Tags
• Display names
• Script classes
• Any named object

Multi-User Support

Auto-Save Options

Solution Configuration

Configuration Storage

All settings stored in single .dbsln file:

Configuration Export

Navigation Methods

Quick Access

Search Features

Security Integration

User Permissions

*Default configuration - can be restricted

Protected Operations

Operations requiring authentication:

• Security configuration
• Runtime users
• License changes
• Critical settings

Performance

Resource Usage

Optimization Tips

• Close unused document tabs
• Use filtering in Solution Explorer
• Disable auto-save for large solutions
• Regular solution compacting

File Management

Working Files

Git Integration

Automatic export to Git folder structure:

Solution/
??? SolutionData/
?   ??? Git/
?       ??? Tags/
?       ??? Displays/
?       ??? Scripts/
?       ??? [Other modules]/

Troubleshooting

Common Issues

Log Files

Temporary Folders

When editing and designing a solution, temporary folders and data are automatically created to store information like user UI settings, code compiler output, trace logs, and other types of temporary data connected to a specific solution. They will be stored in a SolutionName-Designer folder, located on the same path as the solution in question. In general, the user doesn't need to be aware of these folders, and they can be deleted at any time, as they don't hold any solution configuration. However, in advanced scenarios, it may be useful to know about these folders and the type of data they contain.

Child Pages

Workspace Components:

• Designer Workspace (Reference) - UI elements and panels
• Solution Explorer (Reference) - Module navigation

Configuration Areas:

• Working with DataGrids - Table editing
• Find Results Panel - Cross-references
• Keyboard Shortcuts - Quick commands

See Also

• Solution Center (Reference) - Solution management
• Configuration Workflow (Reference) - Best practices
• Runtime (Reference) - Testing solutions

Now for the Designer Workspace (Reference) page:

Designer Workspace (Reference)

This reference provides detailed technical documentation for all Designer workspace elements, panels, and navigation features.

Parent Page: Designer (Reference)

Related Topics:

• Solution Explorer (Reference) - Module navigation
• Working with DataGrids - Table editing
• Keyboard Shortcuts - Quick commands

Solution Explorer

Module

Children Pages

Solution

Settings | Categories | Import Tags | Import Plugin | Export | History

Runtime

Startup | Execution Profiles | Build and Publish | Diagnostics

Unified Namespace

Asset Tree | Tags | Templates | Enumerations | TagProviders | Connections Monitor

Devices

Protocols | Channels | Nodes | Points | Access Types | Monitor

Alarms

Items | Groups | Areas | Global Settings | Monitor

Historian

Historian Tags | Historian Tables | Storage Location | Monitor 

Datasets

Databases | Queries | Query Editor | Tables | Files | Monitor

Reports

Forms | Forms Editor | WebData | WebData Editor | Monitor

Scripts

Tasks | Classes | Code Editor | Expressions | References | Monitor

Security

Users | Permissions | Policies | Runtime Users | Monitor

Displays

List | Draw | Layouts | Client Settings

Additional pages for Displays: Images, Symbols, Themes, Localization, and Units Conversion

Data Explorer

MQTT tools | OPC Tools | PLC Finder | SQL Query Builder 

Track Changes

Recent Changes | Version Control | Cross Reference | Use Count | Unused Objects

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 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.

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

An interface that displays pages or outputs rendered in real-time using HTML5. It allows users to preview or inspect HTML5-based web pages or applications during their runtime.

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.

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.

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 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

In this section: