Introduction to Designer Workspace
The Solution 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 offers a single and integrated environment for the design, development, testing, simulation, validation, deployment, execution, and solution management, delivering high-end applications.
On this page:
| Table of Contents | ||||
|---|---|---|---|---|
|
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. The default security configurations, such as the guest and the administrator users, are customizable through the Security Module configuration interfaces. Refer to the Security Module documentation for overall reference. Refer to the Security Users for detailed information on the default users configured for the Designer workspace. Refer to Security Permissions for more information on user permission groups.
The home page gathers navigation customizations, solution information, and local preferences for the Solution Designer user interface. The Designer workspace home page lists recent items, showing only the last modifications made to each object. To see the complete list of modified configuration items, navigate to Track Changes/Recent Changes in the Solution Explorer. For more information, refer to the Track Changes documentation page.
The workspace homepage also provides quick tips for where to start with a link to the interfaces. It is useful when you are starting to develop your solutions on the software platform. The "Where do I start?" guides users in discovering the Solution Designer features, including DataExplorer, Unified Namespace, Devices, Application and Draw, and Runtime. It helps users explore data sources, organize data models, map tags for data protocols, set up application modules, and verify connections.
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.
Solution Information | |
|---|---|
Target | ProductName (ProductFamily based). TagQuantity (Product Series based) |
Tags counter | Local: from local computer and External: from external TagProviders sources |
Designer User Preferences
The Designer Users Preferences allow users to customize their workspace by setting local preferences.
Designer Local Settings Options | |
|---|---|
Theme | Changes the platform color scheme to Sky, Dark, Navy and more. |
Switch at | Enables switching from a light to a dark theme based on the configured schedule. The following time options are available to select on the drop-down menu:
The "Switch at" option in the Designer workspace automatically switches to the dark version of the selected theme when opening a solution after the specified time. For example:
If you enable this checkbox already using a night version theme (e.g., Dark, Navy, Graphite), it will only activate at the defined time. To use a dark theme as default, this checkbox must be unchecked. |
Show Quick Help | Setup if the Quick Help Expander, in all configurations, is open by default. |
Collapse Menu on Draw | When enabled, it collapses the Solution Explorer automatically when accessing the Draw environment. |
Auto-save | Enables or disables auto-save feature. Also, the drop-down list contains options about how auto-save frequency (When Closing Documents, or Every 5, 10 or 15 minutes). |
Automatically Export Changes | Setup to export all configuration changes to CSV or JSON files at the GIT sub-folder. |
Solution Explorer Preferences
The Solution Explorer Preferences 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.
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.
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.Show navigation historyPresents 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 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.
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 could 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. 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's a way 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. A resource for users to get 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 certain features or functionalities. Training videos are visual aids that help users understand and utilize the product or service better. |
| Note | ||
|---|---|---|
| ||
In some scenarios, when a Dialog is open, and you navigate to another application and back to the dialog, the TextBoxes (text input) from the Dialog will not accept focus. To overcome that issue, you need to click on main Designer window, which allows after it full access to the children dialogs. Alternatively you can also press the Cancel or OK in the Dialog that as left open. |
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 Explorer | Intra-Module Navigation shortcuts |
Solution | Settings | Categories | Import Tags | Import Plugin | Export | History |
Runtime | Startup | Execution Profiles | Build and Publish | Diagnostics |
Unified Namespace | Asset Tree | Tags | Templates | Enumerations | Connections Monitor |
Devices | Protocols | Channels | Nodes | Points | Access Types | Monitor |
Alarms | Items | Groups | Areas | Global | Settings | Monitor |
Historian | Historian Tags | Historian Tables | Archive 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 configurations for Displays, such as the related ones to Images, Themes, Localization, and Unit Conversion, are available only on Solution Explorer. |
Data Explorer | MQTT tools | OPC Tools | PLC Finder | SQL Query Builder |
Track Changes | Recent Changes | Version Control | Cross Reference | Use Count | Unused Objects |
| Note |
|---|
Each module's monitors are available only at the solution runtime. This means that their target data tables will be displayed only when the solution is running. |
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.
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. |
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:
| Page Tree | ||||
|---|---|---|---|---|
|