Purpose and Key Concepts

Solution

Solution refers to an application for real-time data built based on the software platform. It means the platform organizes its smart applications into solutions, providing several 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 refers to the output file of the application, with all engineering and business logic developed, tested, validated, and deployed according to the 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 opened and edited with the Solution design and engineering tools.

Modular architecture

Modular Architecture is the Solution Designer workspace foundation. Its core is based on compartmentalization, break 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 deal specifically with the internal processes and workflows that enable the system to function efficiently.

Application modules

The application modules are software components facilitating 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. Related to 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 Historian — to execute tasks, manage data, and perform automated operations based on predefined settings. The Runtime environment operates in a seamless manner, 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. You can log in or check the current user and its permissions. This page gathers navigation customizations, solution information, and local preferences for the Solution Designer user interface.

Furthermore, it shows a recent items list, that shows the last modification on each object. It does show all modifications made to each object, so if you first add an object and then modify, it'll only show the modification in the recent items.

The workspace homepage also provides quick tips guiding where do start with a link to go to the interfaces, it can be useful when you are starting a new solution.

Solution Explorer Navigation

The Solution Explorer Navigation enables users to choose the format that best suits their navigation preferences. It has two available configuration: the Filter shows a combo box allowing select a filter option and the Style shows radio buttons for users to switch the navigation style between 'Tree' or 'Accordion'.  For new users, you can filter out some of the software functionality, using the Navigation Filter options.

Solution Information

The Solution Information provides details about the solution. It specifies the "ProductName," which is determined based on the Product Family it belongs to, and the "TagQuantity," which varies according to the Product Series. It describes solution compatibility, informing which target-framework the solution is based. Additionally, it features a "Tags Counter" to distinguish between tags sourced locally from the user's computer and those obtained externally from tag providers.

Designer Local Settings

The Designer Local Settings allow users to customize their workspace by setting local preferences. 

Workspace Navigation

Navigation was designed to make workflows even more intuitive, simple and fast. The Navigation Menu is composed of Quick Access, Quick Navigation, Solution Explorer, Intra-module navigation shortcuts and Filter options, you can collapse or expand the navigation menu. When expanded it shows the Solution Explorer where you can search for a specific configuration or navigate for solution settings.

Solution Explorer

On the left side of the software, you'll find the complete navigation tree, divided by our modules. You can also use the shortcuts on 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 ant specific page. Out platform allows you alternate between Tree or Accordion view style, changing the appearance of the modules navigation sidebar.

Quick Navigation

The Quick Navigation bar includes "Home," which directs to the Solution Designer, "Tags" for accessing the Asset Tree in the Unified Namespace, and "Draw" for editing on Displays. "Runtime" starts platform processes. The bar also has navigation controls: "back" to return, "forward" to proceed, and "history" to see past navigation.

Switch Button

By clicking on the logo on the top left, it opens a menu where you can access Solution Management, documentation, forum, and video training related to design, development, and solution deployment on the software platform.

Solution Explorer and Intra-Module Navigation Shortcuts

The Solution Explorer allows users to navigate through the solution configuration interfaces. Each module in the Solution Explorer gathers configurations focused on a specific solution aspect. To navigate within the configuration interfaces of each module, users can either use the Solution Explorer by clicking to expand the modules menu and selecting the configuration interface or by using the Intra-Module Navigation shortcuts found in the upper right corner of the window, allowing internal navigation on the solution module. But if you are looking for a particular configuration, remember there's a search bar on the top of Solution Explorer.

Solution toolbar

On the top, you have buttons where users can 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 tags properties, and directly accessing documentation or providing feedback.

The table provides a concise reference for the commands and their associated functionalities.

Features Highlights

Tooltips and Validation

On the software platform, the 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 an example that can 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 or if the values are within the appropriate range and other factors. The exact rules depend on the specific item. The 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 the 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 the input fields that use tag names or object names, either in the datagrids or in the drawing tools, are enabled through Intellisense. The Intellisense fields have built-in tooltips and validation. Putting the mouse over a field will present the expected entries to that field. When you have an invalid input, the border of the field will become red and the tooltip will show the error.

Refactoring

Refactoring is the procedure 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 the references to that object will remain valid, using the new name with no actions required. For instance, to rename a tag that is already being used all across the solution, just go to Unified Namespace/Tags and rename it. The same applies to Edit-Alarms-Groups, members of templates, or any named object in the system.

In this section: