Overview
The software platform provides simple, optimized, and flexible workflows. Any configuration procedure can be completed with just a few clicks. This page contains detailed information about the typical and additional procedures related to solution configuration workflows. Basic workflows include creating and importing tags, setting up devices and alarms, and using templates for asset models.
On this page:
| Table of Contents | ||||
|---|---|---|---|---|
|
Modular Architecture
The modular architecture of the software platform enables a flexible workflow for the creation, management, deployment, and maintenance of solutions.
Modular Architecture
As explained in the Platform Overview Modules and Tools section, the platform has a modular architecture, therefore meaning the Project Solution Configuration does not need to follow one 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 onNew 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 | |
Typical Project Configuration Steps
<<<<. Essa tabla esta muito complexa. Tem que quebrar um workflow mais simples, e depois colocar mais opacos na section suite Additional Configuration Tools
Verify the Target Platform and custoize setts
- Customize Settings, if needed
- Define Categories on large applications
- Import Tag Definitions , when applicable
- Manage Project Plugins, when applicable
- Export the Project Configuration
- Access the Project History
There is a typical procedure to follow.
Typical Project Configuration Steps
Action
Where
Description
Setup Family and Model
Project → Settings
Product Family and Model correct definitions are essential, as the Project Designer will present or limit configuration options based on those settings.
Create Categories
Project → Categories
For large size projects, it is recommend to use categories to better organize the configuration objects. It also allows to select the default Symbols used to represent the tags in the graphical displays.
Create Tag Templates
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 |
Add Tag Providers
Tags → Assets or
Tags → Tag Providers
Tags Provider can be used for dynamic data monitoring or Historian Database targets.
Create or Import Tags
Tags → Assets or
Tags → Objects or
Project → Import Tags
solution logic. |
Review |
Assets tree |
Unified Namespace → |
Asset Tree | With the Templates and |
TagProviders defined, |
perform a final organization of the Assets. |
Historian configuration
Historian
Security definition
Security
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. |
Create the Displays
Display Drawing
Create display pages, popups and dialogs.
Create Reports
Reports
It is possible to save Displays as PDF or JPEG and use them as reports. Also, use the Reports module to created additional reports.
Test the Solution | Runtime → Startup | Execute the solution |
Test the Project
Execute → Startup
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. |
Additional Configuration Tools
In this section
...:
| Page Tree | ||||
|---|---|---|---|---|
|