Access Methods

Architecture

Core Components

Module Organization

Category	Modules	Purpose
Foundation	Solution, Runtime	Core settings
Data Model	Unified Namespace	Tags and assets

Application

Process

Devices, Alarms, Historian

Real-time processing

Process

Application	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

reference updates when renaming:

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

Multi-User Support

Auto-Save Options

Quick Navigation

Main Toolbar

Solution Configuration

Configuration Storage

Content	Storage Method	Encryption
Tags	Embedded SQL

Yes

AES-256
Displays	Embedded SQL

Yes

AES-256
Scripts	Embedded SQL

Yes

AES-256
Images	Binary storage

YesAll configsSingle file

AES-256

Configuration

Export Formats

Navigation Methods

Quick Access

Temporary Folders

Solution-specific temporary data stored in SolutionName-Designer folder:

Basic Workflows

Data Definitions

1. Define tags in Unified Namespace
2. Create data templates
3. Build asset tree
4. Connect tag providers

Process Configuration

1. Setup device connections
2. Configure alarms
3. Enable historian
4. Map communication points

Application Development

1. Create datasets
2. Build reports
3. Write scripts
4. Design displays

Deployment

1. Configure security
2. Test in development mode
3. Validate functionality
4. Deploy to production

Typical Procedures

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:

In this section...

Quick Navigation Icons

The Quick Navigation bar includes the following shortcuts:

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.

Modular Architecture

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

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: