The Designer is the integrated development environment (IDE) for configuring industrial automation solutions. It provides a unified workspace for all configuration tasks, from tag definition to display creation.
Related Topics:
- Designer (Concept) - Understanding the IDE
- Configuring Solutions (How-to) - Step-by-step procedures
- Solution Center (Reference) - Solution management
Access Methods
| Method | Entry Point | Result |
|---|---|---|
| Solution Center | Edit button | Full editing mode |
| Solution Center | View button | Read-only mode |
| Direct Launch | Designer.exe | Opens last solution |
| Web Browser | ClickOnce | Remote editing |
Architecture
Core Components
| Component | Purpose | Location |
|---|---|---|
| Solution Explorer | Module navigation | Left panel |
| Design Canvas | Active configuration | Center area |
| Properties Panel | Object settings | Right panel |
| Output Windows | System messages | Bottom panel |
Module Organization
The Designer organizes functionality into logical modules:
| Category | Modules | Purpose |
|---|---|---|
| Foundation | Solution, Runtime | Core settings |
| Data Model | Unified Namespace | Tags and assets |
| Application | Devices, Alarms, Historian | Real-time processing |
| Process | Datasets, Reports, Scripts | Data handling |
| Interface | Displays, Security | User interaction |
| Tools | Data Explorer, Track Changes | Utilities |
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
| 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 |
Solution Configuration
Configuration Storage
All settings stored in single .dbsln file:
| Content | Storage Method | Encryption |
|---|---|---|
| Tags | Embedded SQL | Yes |
| Displays | Embedded SQL | Yes |
| Scripts | Embedded SQL | Yes |
| Images | Binary storage | Yes |
| All configs | Single file | AES-256 |
Configuration Export
| Format | Extension | Purpose |
|---|---|---|
| CSV | .csv | Spreadsheet editing |
| JSON | .json | Version control |
| XML | .xml | External tools |
Navigation Methods
Quick Access
| Shortcut | Target | Icon |
|---|---|---|
| Home | Welcome page | |
| Tags | Unified Namespace | |
| Draw | Display editor | |
| Runtime | Execution control |
Search Features
| Type | Scope | Access |
|---|---|---|
| Module Search | Configuration sections | Top of explorer |
| Object Search | All objects | Ctrl+F |
| Cross-Reference | Usage locations | Find Results |
Security Integration
User Permissions
| Level | Can Access | Cannot Access |
|---|---|---|
| Guest | View all* | Protected items |
| Operator | Runtime only | Configuration |
| Engineer | All modules | Security settings |
| Administrator | Everything | Nothing |
*Default configuration - can be restricted
Protected Operations
Operations requiring authentication:
- Security configuration
- Runtime users
- License changes
- Critical settings
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
File Management
Working Files
| Type | Location | Purpose |
|---|---|---|
| Solution | User-defined | Main .dbsln |
| Temp | %TEMP%\Designer | Working files |
| Backup | Solution folder | Auto-backups |
| Export | Git subfolder | Version control |
Git Integration
Automatic export to Git folder structure:
Solution/
??? SolutionData/
? ??? Git/
? ??? Tags/
? ??? Displays/
? ??? Scripts/
? ??? [Other modules]/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 |
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.
Solutions-Designer Folders | |
|---|---|
Folder | Usage |
Git | Store exports of the Solution configuration, when the 'Automatically Export Changes" is set on Designer Home Page. |
NetCompiler | Use by the .NET code compiler to store intermediated compiler file and debug information. |
Settings | Used to store users preference, and states for the Grids, when using the Designer. |
TagsUsage | When Runtime / Build and Publish option is setup to Debug, text files are created in this folder with information of all tags used on Scripts-Tasks and Displays. |
TraceLogs | Used to store specific solution logs, when enabled at Runtime / Startup and Runtime / Build And Publish. |
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
Quick Navigation Icons
The Quick Navigation bar includes the following shortcuts:
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. |
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. |
Modular Architecture
The modular architecture of the software platform enables a flexible workflow for the creation, management, deployment, and maintenance of solutions.
As explained in the Modules and Tools section, the platform has a modular architecture, meaning the Solution Configuration does not need to follow a specific sequence. Any module can be modified at any time independently.
You can start by configuring any solution module. For example, you can begin by defining or importing tags, setting up external tag sources, mapping devices, structuring data templates, reviewing asset trees, drawing displays, adjusting alarms, customizing security definitions, or configuring datasets and historians.
Basic Workflows
Data Definitions (Unified Namespace and Data Explorer)
Use the Unified Namespace module for asset modeling. Define your asset model to represent your asset structure, their relationships, and metadata. Interact with this model using the Asset Tree to navigate the asset structure. Use data templates and enumerations to model your data and define custom data types. Leverage the Data Explorer tools for browsing and discovering relevant data points from devices.
Process Modules (Devices, Alarms, Historian)
Use the Devices module to connect to field devices and configure communication protocols to enable data flow. Define the rules to trigger alarms and events, and log them alongside changes and user actions for analysis and troubleshooting. Integrate the time-series historian by configuring data collection and aggregation.
Application Modules (Datasets, Scripts, Reports, Displays)
Use the Datasets module to establish connections to external SQL databases for additional data storage and integration. Use the Scripts module to customize through scripting, allowing for complex data transformations and calculations. Use graphical tools to build dashboards, visualizations, and reports, turning raw data into actionable insights.
Runtime and Management (Runtime, Security, Track Changes)
Put your solution into the live production environment and begin continuous data collection and analysis. Use the Security module to implement user authentication and role-based access control to protect data integrity. Use the Track Changes module to log all configuration changes, providing traceability and aiding in troubleshooting.
Typical Solution Procedures
When starting a new solution, the most common initial procedure is associated with tag definitions. While developing a solution, it is crucial to clearly understand the architecture you are working with, including the data sources and devices involved. Therefore, one of the first steps in solution development is generally related to defining or importing tags.
There are different ways to define or import tags into your solution. You can create them from scratch or import tag definitions from an import file using the available Import Wizards. With the Import Tags Wizard, you can access all of the data from your devices with just a few clicks. After that, you can start using them in your solution. To learn more about the available import wizards, see the Import Tags.
These are the typical procedures to follow:
Typical Configuration Procedures | ||
|---|---|---|
Action | Where | Description |
Create Tags | Unified Namespace → Tags | The easiest way to create tags is by copying and pasting them from a spreadsheet. However, you can also define them one by one by clicking on New Tag in the toolbar or on the Asset Tree toolbar. |
Import Tags | Solution → Import Tags | Importing Tags from external sources. |
Connect TagProviders | Unified Namespace → TagProvider Connections | TagProviders can be used for dynamic data monitoring or as Historian Database targets. |
Create Tag Templates | Unified Namespace → Data Templates | A well-defined data model greatly simplifies solution development. It creates templates not only to represent your assets but also for data structures intended to implement internal solution logic. |
Review Assets tree | Unified Namespace → Asset Tree | With the Templates and TagProviders defined, perform a final organization of the Assets. |
Create Displays | Displays → Draw | Create display pages, popups and dialogs. |
Configure Devices | Devices | Set up the communication channels with the field devices and map tags as needed. The import procedure may have already defined this step. |
Define Alarms | Alarms | Configure your alarm groups, areas, and tags events generating alarms. |
Configure Historian | Historian | Configuration of the Historian module is accomplished through the following sections: Target Database, Historian Table, and Historian Tag. |
Configure Datasets | Datasets | Set up connections to required SQL databases, and define the tables and queries that will be used. |
Customize Security | Security | The Security module ensures the safety and integrity of your solutions by managing user access, roles, and permissions. It allows administrators to control who can access, view, and modify solution components, as well as manage runtime user interactions with displays and actions. |
Modify Scripts | Scripts | Create function libraries at Scripts → Classes and server side solution logic using Scripts → Tasks. |
Configure Reports | Reports | Create Text and PDF reports. You can also generate WebData definitions to manipulate JSON, HTML, Text and XML data. |
Additional Configuration Tools
The Additional Configuration Tools section of the Solution Designer provides a number of features that can be used to customize and manage solutions. These features include the ability to:
Customize Solutions Settings
Define Categories on large applications
Import Plugins
Manage Solution Plugins
Export the Solution Configuration
Access the Solution History
In addition to these features, the Additional Configuration Tools section also provides a number of procedures that can be used to test, deploy, and troubleshoot solutions. These procedures include:
Additional Configuration Procedures | ||
|---|---|---|
Action | Where | Description |
Setup Family and Model | Solution → Settings | Correct definitions of the Product Family and Model are essential, as the Solution Designer will present or limit configuration options based on those settings. |
Create Categories | Solution → Categories | For large solutions, it is recommended to use categories to better organize the configuration objects. This also allows you to select the default symbols used to represent the tags in the graphical displays. |
Import Plugins | Solution → Import Plugins | Importing Plugins (encapsulated solution components). |
Symbols Customization | Displays → Symbol | Check the Symbol Library and expand it as necessary to include the symbols required by your solution. Create symbols mapped to your TagTemplates and categories. Draw a diagram and provide information about the solution on the MainPage, which is the page displayed in the Solution Selector list. |
Review Layouts | Displays → Layouts | The layout refers to the organization of your windows and displays. Toolbars and sidebars are commonly used for navigation, while the remaining area is used for the working displays. |
Test the Solution | Runtime → Startup | Execute the solution in Test Mode to check its functionality. If there is a formal validation procedure, use the Development and Validation profiles available in the Sandbox settings. |
Deploy the Application | Runtime → Startup | Run the solution in Production Mode and execute the deployment procedure to the field computer. |
In this section: