| HTML |
|---|
<style>
.text-span-6 {
background-image: linear-gradient(99deg, rgba(170, 163, 239, .5), rgba(125, 203, 207, .5));
border-radius: 50px;
padding-left: 15px;
padding-right: 15px;
}
#title-text {
display: none;
}
.panelgradient {
background-image: linear-gradient(180deg, #d5def0, whitesmoke);
border-radius: 8px;
flex-direction: column;
justify-content: center;
align-items: center;
padding: 4rem;
display: flex;
position: relative;
}
</style>
<div class ="panelgradient">
<h1 style="text-align: center;">Designer <br>(IDE Overview)</h1>
</div> |
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 offers a single and integrated environment for the design, development, testing, simulation, validation, deployment, execution, and solution management, delivering high-end applications.
Image: Modules and Tools integrated on the Designer.
On this page:
| Table of Contents | ||||||
|---|---|---|---|---|---|---|
|
Key Concepts and Terms
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
Environment Navigation
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 mat also search for ant specific configuration section.
Welcome page
The Designer home page is the entry point when you design a solution using the software platform. It provides interface for the folioing actions:
- User Login: some configuration features my be protected according the the user
- Solution Information: Summary of key information about your solution
- Local Settings / User Preferences: Allow customization of the IDE, like themes and Help messages.
- Recent Items: Show Information about the last objects monied in the solution.
- Help Quick Links: On the Left side, some information for new users, on where to Start.
Go to Welcome Page Settings for more information
| Tip |
|---|
In order to back to the Welcome page, use the Home icon, at the Top-Left area. |
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.
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 | 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 pages for Displays: Images, Symbols, Themes, Localization, and Unit Conversion |
Data Explorer | MQTT tools | OPC Tools | PLC Finder | SQL Query Builder |
Track Changes | 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 bottoms, there are expander for 2 windows:
Find Results: Shows the Results for Cross-Reference requests.
Output: System messages concerning the Designer tool itself.
Error List. When in code Editor or Draw, the Error list shows errors form the last time the document as saved.
Quick Navigation Icons
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. |
Top Main 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. |
Configuring a Solution
The process to customize the configuration of Solution is essentially to navigate to the specific Module and setup the settings and objects as required by your application.
The page Configuration Workflow has some typical scenarios when editing a solution.
The page Working with DataGrids has detailed explanation on how to manage table-style pages, as many of the Solution configuration is thought tables.
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 | ||||
|---|---|---|---|---|
|