Eio0000002447 10
Eio0000002447 10
EIO0000002447_10
11/2022
www.se.com
Legal Information
The Schneider Electric brand and any trademarks of Schneider Electric SE and its
subsidiaries referred to in this guide are the property of Schneider Electric SE or its
subsidiaries. All other brands may be trademarks of their respective owners.
This guide and its content are protected under applicable copyright laws and
furnished for informational use only. No part of this guide may be reproduced or
transmitted in any form or by any means (electronic, mechanical, photocopying,
recording, or otherwise), for any purpose, without the prior written permission of
Schneider Electric.
Schneider Electric does not grant any right or license for commercial use of the guide
or its content, except for a non-exclusive and personal license to consult it on an "as
is" basis. Schneider Electric products and equipment should be installed, operated,
serviced, and maintained only by qualified personnel.
As standards, specifications, and designs change from time to time, information
contained in this guide may be subject to change without notice.
To the extent permitted by applicable law, no responsibility or liability is assumed by
Schneider Electric and its subsidiaries for any errors or omissions in the informational
content of this material or consequences arising out of or resulting from the use of the
information contained herein.
Secure the network using Windows firewall during running Database Gateway
features.
Safety Information
Important Information
Read these instructions carefully, and look at the equipment to become familiar
with the device before trying to install, operate, service, or maintain it. The
following special messages may appear throughout this documentation or on the
equipment to warn of potential hazards or to call attention to information that
clarifies or simplifies a procedure.
The addition of this symbol to a “Danger” or “Warning” safety label indicates that an
electrical hazard exists which will result in personal injury if the instructions are not
followed.
This is the safety alert symbol. It is used to alert you to potential personal injury
hazards. Obey all safety messages that follow this symbol to avoid possible injury or
death.
! DANGER
DANGER indicates a hazardous situation which, if not avoided, will result in death or serious
injury.
! WARNING
WARNING indicates a hazardous situation which, if not avoided, could result in death or
serious injury.
! CAUTION
CAUTION indicates a hazardous situation which, if not avoided, could result in minor or
moderate injury.
NOTICE
NOTICE is used to address practices not related to physical injury.
Please Note
Electrical equipment should be installed, operated, serviced, and maintained only
by qualified personnel. No responsibility is assumed by Schneider Electric for any
consequences arising out of the use of this material.
A qualified person is one who has skills and knowledge related to the construction
and operation of electrical equipment and its installation, and has received safety
training to recognize and avoid the hazards involved.
Contents
Contents
INTRODUCTION.................................................................................................... 4
Conventions used in this documentation............................................................................................................................... 5
About this software................................................................................................................................................................. 6
About the software components.............................................................................................................................................9
Differences between the runtime editions............................................................................................................................ 11
Install the full EcoStruxure Machine SCADA Expert 2020 software....................................................................................14
Execution modes.................................................................................................................................................................. 18
Page 2
Contents
Page 3
Introduction
Introduction
This Quick Start Guide is intended for persons who are using EcoStruxure Machine SCADA Expert 2020
for the first time, and it will help you to familiarize yourself with the basic functions of the software.
EcoStruxure Machine SCADA Expert 2020 is a powerful, integrated tool that exploits key features of
Microsoft operating systems and enables you to build full-featured SCADA (Supervisory Control and Data
Acquisition) or HMI (Human-Machine Interface) programs for your industrial automation business.
Page 4
Introduction
Text conventions
This documentation uses special text formatting to help you quickly identify certain items:
• Titles, labels, new terms, and messages are indicated using italic text (for example, Object Properties).
• File names, screen text, and text that you need to enter are indicated using monospace text (for
example, D:\Setup.exe ).
• Buttons, menu options, and keyboard keys are indicated using a bold typeface (for example, File menu).
In addition, this documentation segregates some text into Tip, Note, and Caution boxes:
• A Tip box provides information that helps you to save development time or improve run-time
performance.
• A Note box provides information that helps you to understand other nearby text, usually the text just
before the note.
• A Caution box provides information that helps you to avoid potentially hazardous situations, which, if
not avoided, can result in minor injury or equipment damage.
Windows conventions
This documentation uses the following Windows conventions:
• Dialogs are windows that allow you to configure settings and enter information.
• Text boxes are areas in dialogs where you can type text.
• Radio buttons are white circles in which a black dot appears or disappears when you click on the
button. Typically, the dot indicates the option is selected or enabled. No dot indicates the option is
cleared or disabled.
• Check boxes are white squares in which a check ( ) appears or disappears when you click on it
with the cursor. Typically, a check indicates the option is selected or enabled. No check indicates
the option is cleared or disabled.
• Buttons are icons in boxes appear "pressed" when you click on them.
• Lists are panes (white boxes) in windows or dialogs containing two or more selectable options.
• Combo boxes have arrows that, when clicked, show part or all of an otherwise concealed list.
• Dockable windows are windows that you can drag to an edge of the interface and merge with that
edge.
Page 5
Introduction
Product features
ActiveX and .NET
Use third-party controls to enhance your project. This software is a container for ActiveX
and .NET controls. Add functionality such as browsers, media players, charting, and other
tools that support the ActiveX and .NET interface standards.
Alarms
In addition to all of the alarm functions you would expect, this software also sends alarms
using multi-media formats like PDF. Use remote notification to have alarms sent right to
your email inbox, a printer, or a smartphone! Alarms are real-time and historical, log data in
binary format or to any database.
Animation
This software gives you great command over graphics. Paste images, and even rotate
them dynamically. Fill bar graphs with color, or adjust the scale of objects with easy-to-
use configuration. Other animations include "command" (for touch, keyboard and mouse
interaction), hyperlink, text data link, color, resize (independent height and width), position,
and rotation (with custom rotation point).
Database
Connect to SQL databases (MS SQL, MySQL, Sybase, Oracle), MS Access and Excel, and
ERP/MES systems (including SAP). Flexible enough to have a built-in interface without
the need to know SQL (for trends, alarms/events, grid and other objects), or use any SQL
statement you need anywhere you need it.
Drivers
This software includes over 240 built-in communication drivers for most PLCs, temperature
controllers, motion controllers, barcode/RFID readers, and other devices. Use these built-in
drivers without the need for OPC servers (but are an optional connection method).
Email
Send email via SMTP to any desktop or mobile device. Get real-time information on alarms,
process values, and other events. This software supports SSL encryption allowing the use of
third-party providers such as Gmail.
Events
This software offers traceability for operator initiated actions or internal system activity. Log
events such as security system changes (user logon/logoff), screen open/close, recipe/report
operations, tag value changes, custom messages, and other run-time issues.
FDA Traceability
Page 6
Introduction
Take advantage of built-in traceability and e-signature features to create projects that fully
comply with U.S. Food and Drug Administration regulations (Title 21 CFR Part 11). These
features are often used in food and pharmaceutical applications, but they can be used in
any application where traceability is required.
FTP
Automatically upload or download files during run time to/from remote storage locations
using FTP and flexible scripting functions. Configure FTP via scripting or the included
configuration interface.
Graphics and Design Tools
Create powerful screens to meet any application need using the improved tools in our
graphic interface. Combine built-in objects to create any functionality required. Store
graphics in the symbol library for future use. Easily make projects across a product line
share a consistent "look and feel".
Historical Performance
We have optimized the trend history module and designed it to load millions of values from
SQL relational databases with high performance, with built-in data decimation in the Trend
Control. Easy-to-use tools provide quick access to Statistical Process Control (SPC) values
without any need for programming.
Intellectual Property Protection
Screens, documents, scripts and even math worksheets can be individually password
protected. This helps to prevent unauthorized viewing or editing of your corporate custom
functionality.
Multi-Language
Develop your project in one of many development languages, including English, Portuguese,
German, and French.
OPC
As an alternative to the built-in drivers for direct communication with PLCs, you can also
use any of several different versions of OLE for Process Control (OPC) to manage your
devices. This software includes support for "classic" OPC DA (client or server), OPC UA
(client or server), OPC XML-DA (client only), and OPC HDA (server only).
PDF Export
Send Alarms, Reports, or any file (including .doc or .txt) to a production supervisor, quality
manager, or maintenance staff using the included PDF writer.
Recipes
Save time and maintain consistency by automating part parameters or productions
quantities with any triggering event.
Redundancy
This software supports web server, database and overall system redundancy to help ensure
data integrity.
Reports
Create clear, concise reports in text format, graphical RTF, XML, PDF, HTML, and CSV, or
integrate with Microsoft Office. Get the data you need, in the format you need it, to make
informed decisions, fast.
Scalable
Develop once and deploy anywhere, on any currently supported version of Microsoft
Windows.
Scheduler
Schedule custom tag changes on date/time, frequency, or any trigger. Use this for
simulation, to trigger reports or other functionality at a particular time of day, or even to
trigger driver worksheets to read/write at a scan rate you choose.
Page 7
Introduction
Scripting
Two powerful scripting languages are supported. Use built-in functions or use standard
VBScript to take advantage of widely available resources. Both can be used simultaneously
to give you the functionality you need.
Security
This software provides support for group and user accounts, e-signatures, and traceability,
as well as support for Lightweight Directory Access Protocol (LDAP). Integrate your project
with your Active Directory, including Active Directory Application Mode (ADAM).
SSL Support for Emails
Native support for Secure Socket Layer (SSL), which makes it easy and secure to send
emails from this software using third-party tools such as Gmail!
Standards
Take advantage of common industry standards to develop projects that are compatible with
any format. TCP/IP, ActiveX/.NET, OPC (client and server), COM/DCOM, OLE, XML, SOAP,
and HTML are all supported.
SNMP
Easily configure managed networked devices on IP networks (such as switches and routers)
using incorporated SNMP configuration commands and an easy-to-use configuration
interface.
Symbols
An extensive library of pre-made symbols features push buttons, pilot lights, tanks, sliders,
meters, motors, pipes, valves and other common objects. Use the included symbols in your
project, modify existing symbols to suit your needs, or create your own from scratch. Plus
support for third-party symbol libraries and graphic tools.
Tags Database
This software features an object-oriented tags database with boolean, integer, real, strings,
arrays, classes (structures), indirect tags, and included system tags.
Thin Clients
Remotely view project screens on several different types of thin clients. Use the standalone
Secure Viewer in order to increase security on plant-floor stations. Or use the HTML5-
enabled Mobile Access in order to access your project from almost any other browser or
mobile device.
Trends
Real-time and Historical trends are supported. Log data in binary format or to any database
locally and remotely. Color or fill trends with graphic elements to enhance clarity of data.
Date/Time based or numeric (X/Y plot) trends give you the flexibility to display information
that best suits your project.
Troubleshooting
Quickly debug and verify a project using local and remote tools for troubleshooting,
including status fields, Watch and LogWin. Capture screen open and close times, see
communications in real-time, and messages related to OPC, recipes/reports, security,
database activity, and even custom messages. Quickly get your project finished using these
powerful tools.
Page 8
Introduction
HMI Runtime Standalone runtime for Linux. Includes the Linux distributions:
following:
• Ubuntu
• Project runtime (limited tags and drivers)
• Raspberry Pi
• Remote agent, to allow remote management
• BeagleBone
• Mobile Access add-on for CGI-enabled web
• others (contact us)
server
Mobile Access Runtime Enables the project runtime to serve HTML5- Internet Information Services (IIS) for Windows, or
enhanced project screens to web browsers and any CGI-enabled web server (e.g., Apache)
mobile devices.
Secure Viewer Project viewer / thin client, installed as a
Windows
standalone program. (See below.)
Windows Server
Note: Although the term "Windows Embedded" appears in the communication driver manuals,
EcoStruxure Machine SCADA Expert 2020 is not supported on the Windows Embedded
operating system.
It helps to distinguish between the project development environment and the project runtime. You can
use the project development environment to design, develop, troubleshoot, deploy, and monitor projects.
In contrast, the project runtime actually runs your project, communicates with external databases and
devices, and serves screens to project viewers.
The full EcoStruxure Machine SCADA Expert 2020 software for Windows includes both the project
development environment (a.k.a. "Studio") and the project runtime (a.k.a. "SCADA"). Your software license
determines which parts of the software you can use on a specific computer. For more information, see
Execution modes on page 18.
Page 9
Introduction
HMI Runtime is a new, platform-agnostic runtime edition for other embedded devices. It has very low
system requirements and somewhat limited features.
In most cases, the first thing you need to do is install the full EcoStruxure Machine SCADA Expert 2020
software on your primary workstation, because it not only sets up the project development environment
for you, it also unpacks the rest of the components so that they can be installed on other computers and
devices.
We recommend that you use Mobile Access instead of our traditional Thin Client software whenever
possible. Thin Client depends on legacy, Windows-only technologies, while Mobile Access allows you to
use any HTML5-compatible browser running on any platform as a project viewer. Mobile Access does not
yet support all of the features that Thin Client does, but we are continuing to improve Mobile Access with
every new release.
Page 10
Introduction
Windows Supported
Not supported
For a complete list of system requirements for each runtime edition, see the installation instructions for
that edition.
The following table shows the main differences between the runtime editions in their support for project
features. (The majority of features are fully supported by all editions, so they are not listed.) If you develop
a project to include features that are not supported by your chosen edition, you might see unexpected
behavior and possibly even serious issues during run time. Some features will be automatically hidden in
the project development environment when you select your project's target platform, but you still need to
be aware of the differences. For more information, see About target platforms, product types, and target
systems.
Page 11
Introduction
1
Most functions are supported in all editions, but some specific functions are not supported in this edition.
For more information, see List of available functions.
2
Local mode only. Distributed and Domain modes are not supported.
3
VBScript is not supported.
4
Proprietary format is not supported. Alarm, Event, and Trend history can be saved in Database format only.
5
Some Database/ERP functions are supported. Database/ERP worksheets are not supported.
6
Most drivers are supported in all editions, but some specific drivers are not supported in this edition. For
more information, see the documentation for each driver.
Page 12
Introduction
For a comprehensive list of supported features and limitations in HMI Runtime, see Supported features in
HMI Runtime.
7
Pushbutton, ListBox, and Smart Message objects are not supported. Minor limitations in other objects.
8
A specific linked symbol is supported as long as all of its component objects and animations are also
supported.
9
Limited by runtime license, and by external and physical constraints (i.e., hardware and operating system).
Page 13
Introduction
Software Requirements
One of the following Windows operating systems:
• Windows:
• Windows 11
• Windows 10, version 1909 or later (including LTSC/LTSB versions)
• Windows 8.1
• Windows Server:
• Windows Server 2022
• Windows Server 2019
• Windows Server 2016
• Windows Server 2012 R2
Use the "Pro" or "Enterprise" editions of Windows because they include Internet Information Services
(IIS) as a pre-installed feature that can be turned on. Do not use the "Home" and "Education" editions of
Windows, because many features are hidden or disabled in these editions.
Update Windows before you install the software in order to have the latest security fixes and system
components.
.NET Framework
You need to have both .NET Framework 3.5 and .NET Framework 4.8 enabled in order to install and run
EcoStruxure Machine SCADA Expert 2020.
If Windows is fully updated on your computer, the latest versions of .NET Framework should be installed,
but they might not be enabled. Use either the Windows Features control panel in Windows or the Server
Manager console in Windows Server to confirm that both versions of .NET Framework are enabled.
In some cases, it might not be possible to update Windows through normal means. For example, if your
computer is on a private network without access to the Internet, it might not be able to contact the
Windows Update service. You can use another computer to download an offline installer for each .NET
Framework and then transfer it.
Optional Software
• Internet Information Services (IIS) installed and turned on. IIS is the default web server for Windows.
This item is optional because it is not required to develop a basic project and then run it on a
standalone device, but it is required in order to use more advanced features.
Page 14
Introduction
• In most cases, IIS is required in order to install and then use Mobile Access. You may choose not to
install the Mobile Access Runtime feature at this time. You can install it at a later time, for either
IIS or CGI. For more information, see the Mobile Access Runtime feature in the "Select Features"
installation step.
• IIS is required in order to run projects that include Industrial Graphics symbols.
• Either Microsoft Edge or Google Chrome, to be used for viewing project screens in Mobile Access.
This item is optional because you can always use the built-in Viewer program to view project screens.
System Sizing
The operating system, storage, and memory requirements will necessarily increase for larger projects; the
minimum requirements listed above are only for projects of up to 4,000 tags. The following table shows
the complete requirements:
Your computer needs to meet only the minimum requirements when you first install the software and
begin to develop your project, but the requirements will increase as your project grows. Every computer or
device that you plan to use as a runtime station is subject to the same requirements.
Industrial Graphics
If you are using Industrial Graphics screens, the project should be hosted on a dedicated Windows system
with IIS installed. The additional system recommendations for this dedicated system are:
• CPU PassMark® > 5200 pts
• 16 GB available RAM memory (Each client session requires ~200 MB of memory, depending upon
graphics complexity.)
These recommended requirements are suitable for a system with ten clients, browsing pages with
approximately 40 dashboard/charting components with ~250 I/O tags on the page. Pages may take a
longer time to display on the first visit. The display time depends on graphics and script complexity.
Additional clients can be supported by increasing the number of CPU’s, CPU speed, and Memory.
User Privileges
You need to have administrator privileges on your computer in order to install any software. If you are
not already signed on as a user with administrator privileges when you run the software installer, you
can choose to run the installer as an administrator. To do this, right-click the installer program file
(setup.exe), and then on the shortcut menu, click Run as administrator. You will be asked for the appropriate
user name and password.
Page 15
Introduction
6. On the Customer Information page, type your user name and company name, and then click Next.
7. On the Choose Destination Location page, select the folder in which you want to install the software, and
then click Next.
By default, the software will be installed at the following location:
8. On the Select Features page, select the specific features and components that you want to install, and
then click Next.
Feature Description
Program Files The main program files for the project development environment, the project runtime software for
Windows and Windows Server, and the thin client software for viewing project screens.
You cannot deselect this feature.
Custom Widget Framework Additional software that is required to develop HTML5-based widgets and then use them in project
screens.
You cannot deselect this feature.
AVEVA Historian Additional software that is required to save historical data from your project to an external database,
such as AVEVA Historian.
If you want to use this feature in your project, you must have .NET Framework 4.8 (or later) installed
and turned on.
BDE for PanelMate™ Import Wizard Borland Database Engine (BDE), which is required to import a PanelMate Plus or PanelMate Power
Pro program into a new project.
This feature is not selected by default, because it is used only in some cases.
Demo Projects Pre-made projects that demonstrate the capabilities of EcoStruxure Machine SCADA Expert 2020.
Industrial Graphics The Industrial Graphics editor and symbol library, which works as a companion to our native graphics
tools.
Mobile Access Runtime Add-on software for Internet Information Services (IIS) that lets you use HTML5-compatible browsers
to view your project screens. If you select this feature, the installer will try to confirm that IIS is
installed and turned on in Windows, and if it is, the add-on software will be installed.
Regardless of whether you select this feature for installation, a separate Mobile Access Runtime
software installer (MobileAccessSetup.exe) will be copied to your EcoStruxure
Machine SCADA Expert 2020 program folder. You can run that installer at a later time.
OPC Components Additional components that are required for communication with other OPC-compatible devices. This
includes OPC DA (a.k.a. OPC Classic), OPC XML-DA, and OPC UA.
PDF Printing Additional software that lets EcoStruxure Machine SCADA Expert 2020 projects save run-time
reports as PDF files.
Runtimes – Additional > HMI Runtime This is the platform-agnostic project runtime software for Linux and other operating systems.
Selecting this feature will not actually install HMI Runtime on your computer at this time. It will only
copy the installation files to your EcoStruxure Machine SCADA Expert 2020 program folder, so that
you can install HMI Runtime on another computer or device at a later time.
Security System Device Driver An additional keyboard driver that helps to enforce security during project run time.
Symbol Library A large library of pre-made but customizable screen objects such as pushbuttons, toggle switches,
gauges, dials, and indicator lights.
OPC Factory Server A standalone OPC server that your projects can use to communicate with the following Schneider
Electric PLCs:
• M340
• M580
• Quantum
• TSX Compact
• TSX Micro
• TSX Momentum
Page 16
Introduction
Feature Description
• TSX Series 7
• TSX S1000
• TSX/PCX Premium
• Unity Momentum
For more information, see the documentation that is installed with OPC Factory Server.
Note: You might receive the following message during installation: "Error 1628: Failed to
complete script based install." For more information about this issue and how to resolve it,
go to: https://flexeracommunity.force.com/customer/articles/en_US/ERRDOC/Error-1628-
Failed-To-Complete-Script-Based-Install
Note: If you try to install an earlier version of this software on a computer that already has a
later version installed, you might receive the following message during installation: "Version
x.x.x.x of CodeMeter Development Kit is already installed. Downgrading to Version x.x.x.x
is not possible, installation will be aborted." CodeMeter is supplemental software used by
EcoStruxure Machine SCADA Expert 2020 to manage hardkey licenses. To resolve this issue,
use Task Manager in Windows to stop CodeMeter Runtime Server (CodeMeter.exe) before
you install the earlier version of the software.
The software is installed, and then when the installation is finished, the last page of the wizard is
displayed.
10.Click Finish to close the installation wizard.
When you have finished the installation, you can find the software in your Windows Start menu at: Start >
EcoStruxure Machine SCADA Expert 2020
The software includes the following "apps" (applications):
EcoStruxure Machine SCADA Expert 2020 Help Manual
A complete technical reference and user guide for all of the EcoStruxure Machine SCADA
Expert 2020 software.
EcoStruxure Machine SCADA Expert 2020 Quick Start Guide
A brief guide to installing and using the project development environment, including a
tutorial for developing a simple project.
EcoStruxure Machine SCADA Expert 2020 Register
A utility program that manages your EcoStruxure Machine SCADA Expert 2020 software
license.
EcoStruxure Machine SCADA Expert 2020 Release Notes
A list of changes in the EcoStruxure Machine SCADA Expert 2020 software.
EcoStruxure Machine SCADA Expert 2020 Remote Agent
A utility program that allows other stations to remotely manage EcoStruxure Machine
SCADA Expert 2020 as a project runtime.
EcoStruxure Machine SCADA Expert 2020 SCADA
A shortcut that automatically starts the project runtime and then runs the most recent
project.
There will also be a shortcut icon on your desktop.
To run the software, do one of the following:
• Double-click the shortcut icon on your desktop; or
If the installation does not finish as expected, you can use System Restore to restore the computer to the
restore point that was created at the beginning of the installation. For more information about System
Restore, go to: https://support.microsoft.com/help/17127/windows-back-up-restore
Page 17
Introduction
Execution modes
Each software component supports the following execution modes:
Evaluation Mode
Enables all of the software's development and runtime features for a limited time.
The first time you install EcoStruxure Machine SCADA Expert 2020 on a computer, the
software runs for forty (40) hours in Evaluation Mode. This evaluation period includes any
time you run a product module (engineering or runtime). You can use this evaluation period
continuously or not; for example, 10 hours a day for 4 days, or 5 hours a day for 8 days, or
10 hours a day for 3 days plus 5 hours a day for 2 days, and so on.
After running for a total of 40 hours in the Evaluation Mode, the evaluation period ends
and the software automatically switches to Demo Mode until you apply a valid license. You
cannot reactivate Evaluation Mode, even if you reinstall the software on your computer.
Each major version of EcoStruxure Machine SCADA Expert 2020 has an evaluation period
that is independent of every other major version. For example, if an earlier version is
running in Demo Mode because its evaluation period has expired, and then you install the
latest version on the same computer, the latest version will begin its own 40-hour evaluation
period and the earlier version will continue to run in Demo Mode.
Demo Mode
Allows you to download projects to target stations and to run projects for testing or
demonstration purposes. You can start runtime tasks and use the remote debugging tools
(Watch, LogWin), but the project will stop automatically after two hours of continuous use.
After that period, you can run the project for another two hours. You can run the project as
many times as you want, but the fact that you will need to do so every two hours makes this
mode inappropriate for actual use.
You cannot create or modify project screens, worksheets, or settings while in Demo Mode.
Licensed for Engineering Only
Enables the project development features for an unlimited time.
This mode also allows you to run projects for testing purposes. You can start runtime tasks
and use the local debugging tools (Watch, Output), but the project will stop automatically
after 72 hours of continuous use. After that period, you can run the project again for
another 72 hours. You can run the project as many times as you want, but the fact that you
will need to do so every 72 hours makes this mode inappropriate for actual use.
Licensed for Runtime Only
Enables the runtime tasks and debugging tools (Watch, Output, LogWin) for an unlimited
time, but you cannot create or modify project screens, worksheets, or settings.
The menu options available in Runtime Only mode are the same as the options listed for
Demo Mode.
The Remote Management tool is always available, regardless of the mode, so that you can upload files
from or download files to target stations.
To see which mode you are currently in, go to the Help tab of the ribbon and then click About. The About
dialog box shows the execution mode, including the time remaining if you are in Evaluation Mode.
Page 18
The Development Environment
Page 19
The Development Environment
Title bar
The Title Bar located along the top of the project development environment displays the full name of the
Studio application (e.g., EcoStruxure Machine SCADA Expert 2020), followed by the name of the active
screen or worksheet (if any).
The Title Bar also provides the following buttons (from left to right):
• Minimize button: Click to minimize the development environment window to the Taskbar.
• Restore Down / Maximize: Click to toggle the development environment window between two sizes:
• Restore Down button reduces the window to its original (default) size.
• Maximize button enlarges the window to fill your computer screen.
• Close button: Click to save the database and then close the development environment. If you modified
any screens or worksheets, the application prompts you to save your work. This button's function is
similar to clicking Exit Application on the File menu.
Closing the project development environment does not close either the project runtime or the project
viewer, if they are running.
Page 20
The Development Environment
3. In the Choose commands from menu, select the appropriate Ribbon tab. The commands from that tab are
displayed in the Commands list.
Page 21
The Development Environment
4. In the Commands list, select the command that you want to add to the Quick Access Toolbar.
5. Click Add.
Only commands can be added to the Quick Access Toolbar. The contents of most lists, such as indent
and spacing values and individual styles, which also appear on the ribbon, cannot be added to the Quick
Access Toolbar.
Page 22
The Development Environment
Ribbon
The new ribbon combines the numerous menus and toolbars from the previous versions of this software
into a single, user-friendly interface. Almost all application commands are now on the ribbon, organized
into tabs and groups according to general usage.
File menu
When you click the File tab of the ribbon, it opens a menu of standard Windows application commands
like New, Open, Save, Print, and Close.
Home tab
The Home tab of the ribbon is used to manage your project within the development environment.
On the Home tab, the commands are organized into the following groups:
• Clipboard: Cut, copy, paste, and find items in project screens and task worksheets.
• Local Management: Run and stop the project on the local station (i.e., where the development application
is installed), as well as manage the execution tasks. You can also run a project in Debug mode, for
debugging VBScript.
• Remote Management: Connect to a remote station so that you can download the project to it, and then
run, stop, and troubleshoot the project on that station.
• Tools: Miscellaneous tools to verify the project, import tags from other projects, convert screen
resolutions, and register ActiveX and .NET controls.
• Tags: Manipulate tags and tag properties in the project database.
View tab
The View tab of the ribbon is used to customize the look of the development environment itself.
On the View tab, the commands are organized into the following groups:
• Show/Hide: Show and hide the different parts of the development environment, as well as restore the
default layout.
Page 23
The Development Environment
Insert tab
The Insert tab of the ribbon is used to insert new tags, screens, worksheets, and other components into
your project.
On the Insert tab, the commands are organized into the following groups:
• Global: Insert tags, classes, translations, and procedures into the Global tab of the Project Explorer.
• Graphics: Insert screens and screen groups into the Graphics tab of the Project Explorer.
• Task Worksheets: Insert task worksheets into the Tasks tab of the Project Explorer.
• Communication: Insert server configurations and communication worksheets into the Comm tab of the
Project Explorer.
Project tab
The Project tab of the ribbon is used to configure your project settings.
On the Project tab, the commands are organized into the following groups:
• Settings: Configure the general project settings or set the project to run as a Windows service.
• Security System: Enable and configure the project security system.
• Web: Configure the project to accept connections from a variety of thin clients.
Draw tab
The Draw tab of the ribbon is used to draw objects in project screens.
Page 24
The Development Environment
The Draw tab is available only when you have a project screen open for editing.
On the Draw tab, the commands are organized into the following groups:
• Screen: Configure settings for the project screen itself, such as its attributes, script, and background
color or image.
• Editing: Select and edit objects in the project screen.
• Shapes: Draw static lines and shapes.
• Active Objects: Draw active objects, like buttons and check boxes.
• Data Objects: Draw objects that display historical data, like alarms, events, and trends.
• Libraries: Select from libraries of premade objects, such as symbols, ActiveX and .NET controls , external
image files, and HTML5-based custom widgets.
• Animations: Apply animations to other screen objects.
Format tab
The Format tab of the ribbon is used to format and arrange objects in a project screen.
The Format tab is available only when you have selected one or more objects in a project screen.
On the Format tab, the commands are organized into the following groups:
• Arrange: Arrange objects in a project screen, including bring to front and send to back, group, align, and
rotate.
• Position: Precisely adjust the position of a screen object in a project screen.
• Size: Precisely adjust the size of a screen object.
• Style: Change the fill and line color of a screen object.
• Fonts: Change the caption font of a screen object.
Help tab
The Help tab of the ribbon provides additional help with using the software.
On the Help tab, the commands are organized into the following groups:
Page 25
The Development Environment
• Documentation: Access the documentation for the development application, including this help file /
technical reference and notes for the individual communication drivers.
• Information: Access other information about EcoStruxure Machine SCADA Expert 2020, including the
license agreement, product website, and release notes, as well as support details that make it easier for
us to assist you.
Page 26
The Development Environment
Project Explorer
The Project Explorer organizes all of the screens, worksheets, and other items that comprise your project
and presents them in an expandable tree-view.
To open a folder and view its contents, either click the Expand icon to the left of the folder or double-
click the folder itself.
To close a folder, click the Collapse icon to the left of the folder.
If you right-click any item in the Project Explorer, then a shortcut menu will appear with contextual
commands for that item.
There are four main sections, or tabs, in the Project Explorer: Global, Graphics, Tasks, and Comm.
Global tab
The Global tab of the Project Explorer contains the project tags database, as well as other features that
apply to the entire project such as the security system, VBScript procedures, and UI translation.
The folders on the Global tab are described in the following sections:
Project Tags
The project tags database contains all of the data tags that you create during project
development, such as screen tags (e.g., button1_state) or tags that read from / write to
connected devices.
Classes
Classes are compound tags that you can create to associate a set of values, rather than a
single value, with an object. For example, where you may normally create separate tags for a
tank's pressure, its temperature, and its fill level, you can instead create a "tank" class that
includes all three.
Shared Database
The shared database contains tags that were created in another program and then imported
into or integrated with your project.
System Tags
System tags are predefined values such as the date, the time, the name of the current user,
and so on. You can use these values to develop supervisory functions and housekeeping
routines.
All system tags are read-only, which means you cannot add, edit, or remove these tags from
the database.
Page 27
The Development Environment
Security
If you choose to enable it, you can use the project security system to control who may log on
to your project and what they may do during runtime.
Procedures
Procedures are VBScript functions and sub-routines that can be called by any other script
in your project.
Event Logger
The event logger saves run-time messages and task activity to an external database.
Translation
You can use the translation table to develop a multilingual user interface (MUI) for your
project.
Graphics tab
The Graphics tab of the Project Explorer contains all of the screens, screen groups, and symbols in your
project.
The folders on the Graphics tab are described in the following sections:
Screens
You create screens to provide a graphical interface for your project. Each screen can contain
many buttons, sliders, dials, indicators, graphs, and so on.
Screen Groups
You can combine individual screens into screen groups, so that they all open together at the
same time.
Thin Clients
You can deploy your project as a web application to be accessed by thin clients such as
desktop web browsers, tablets, and smartphones. You can even deploy different versions of
your project with different levels of functionality for each type of client.
Project Symbols
This folder contains all of the custom symbols that you create for your project. A symbol is
a group of interconnected screen objects that work together to perform a single function —
for example, lines, rectangles, and text fragments that have been arranged to make a slider
control.
Graphics Script
Page 28
The Development Environment
You can use this worksheet to define VBScript sub-routines that are called only when the
graphics module starts (i.e., when a client station connects to the server and displays the
graphical interface), while it is running, and when it ends.
Native Symbols
This folder is a library of the symbols that are created with the native graphics tools in
Studio. It contains not only the custom symbols that you create (see Project Symbols above),
but also a large selection of premade symbols that are installed with Studio.
Industrial Graphics Symbols
This folder is a library of the symbols that are created with the Industrial Graphics editor,
which works as a companion to the native graphics tools in Studio.
Layout
The layout editor displays all of the screens the are currently open for editing. You can use it
to visualize how the screens are arranged together and reuse screens in multiple layouts —
for example, to create a common navigation bar across your entire project.
Tasks tab
The Tasks tab of the Project Explorer organizes the worksheets that are processed as background tasks
(i.e., server-based maintenance tasks that are not directly related to screen operations or device I/O)
during project runtime.
The folders on the Tasks tab are described in the following sections:
Alarms
You can use Alarm worksheets to define when alarms are trigged, how they are handled, and
what messages they generate.
(You can then use the Alarm/Event Control screen object to display your alarms on screen,
but that is a separate procedure.)
Trend Logger
You can use Trend worksheets to select project tags to display as data trends and/or save as
historical data.
(You can then use the Trend Control screen object to actually display your trends on screen,
but that is a separate procedure.)
Recipes
Page 29
The Development Environment
You can use Recipe worksheets to select project tags that will load values from and/or save
values to an external file. These worksheets are typically used to execute process recipes,
but you can store any type of information such as passwords, operation logs, and so on.
(You can then call the Recipe function to actually run a configured Recipe worksheet, but
that is a separate procedure.)
Reports
You can use Report worksheets to design runtime reports that are either sent to a printer or
saved to disk.
(You can then call the Report function to actually run a configured Report worksheet, but
that is a separate procedure.)
Math
You can use Math worksheets to develop complex runtime logic using the built-in scripting
language.
Script
You can use Script worksheets to develop complex runtime logic using VBScript.
Scheduler
You can use Scheduler worksheets to run commands at specified times, dates, or trigger
events.
Database/ERP
You can use Database worksheets to set up connections and exchange data with external
databases using the standard ADO.NET interface.
Comm tab
The Comm tab of the Project Explorer organizes the worksheets that control communication with remote
devices, using either direct communication drivers or other common protocols.
The folders on the Comm tab are described in the following sections:
Drivers
You can use Driver worksheets to communicate with PLCs and other hardware, using any
of the hundreds of direct communication drivers that are installed with the development
application.
OPC DA 2.05
Page 30
The Development Environment
You can use OPC worksheets to communicate with OPC servers via the OPC Classic
protocol.
OPC UA
You can use OPC UA worksheets to communicate with OPC servers via the new OPC Unified
Architecture protocol.
OPC XML/DA
You can use OPC XML/DA worksheets to communicate with OPC servers via the new OPC
XML-DA protocol.
TCP/IP
You can use TCP/IP worksheets to configure communication between your own project and
other projects. The TCP/IP Client and TCP/IP Server modules enable two or more projects to
keep their databases synchronized using the TCP/IP protocol.
Page 31
The Development Environment
Screen/Worksheet Editor
Use the powerful, object-oriented screen editor to create and edit a variety of screens and worksheets for
your projects. You can input information using your mouse and keyboard, output control data to your
processes, and automatically update screens based on data input from your processes.
Screen/Worksheet Editor
Page 32
The Development Environment
Watch window
The Watch window is a debugging tool that lets you: watch and force values to project tags; execute and
test functions; and execute and test math expressions.
Page 33
The Development Environment
Output window
Use the Output window to view additional information about your project. By default, the window is
located in the bottom-right corner of the project development environment.
Output window
Page 34
The Development Environment
Status bar
The Status Bar located along the bottom of the development environment provides information about the
active screen (if any) and the state of the application.
The Status Bar fields (from left to right) are described in the following table:
Field Description
CAP Indicates whether the keyboard Caps Lock is on (black) or off (grey).
NUM Indicates whether the keyboard Num Lock is on (black) or off (grey).
SCRL Indicates whether the keyboard Scroll Lock is on (black) or off (grey).
Cursor Position The location of the cursor on the active screen or worksheet. If it's a screen,
then the position of the mouse cursor is given as X,Y coordinates, where X is
the number of pixels from the left edge of the screen and Y is the number of
pixels from the top edge of the screen. If it's a worksheet, then the position of
the text cursor is given as Line and Column.
Object Size The size (in pixels) of a selected screen object, where W is the width and H is
the height.
No DRAG Indicates whether dragging is disabled (No DRAG) or enabled (empty) in the
active screen.
Tag Count The total number of tags used so far in the project.
Page 35
About Tags and the Project Database
All tags are organized into one of the following categories, which are represented by folders on the Global
tab of the Project Explorer:
• Project Tags are tags that you create during project development. Places where project tags are used
include:
• Screen tags
• Tags that read from/write to field equipment
• Control tags
• Auxiliary tags used to perform mathematical calculations
• Shared Database tags are created in a PLC program and then imported into the tags database through
the Tag Integration feature.
For example you might create tags in CoDeSys and then import them into your project so that it can
directly read/write data on a CoDeSys device.
You cannot modify the properties of shared tags within your project. Instead, modify those tags in the
original PLC program and then re-import them into the tags database.
• System Tags are predefined tags with predetermined functions that are used for supervisory tasks
during project run time. For example,
• Date tags hold the current date in string format
• Time tags hold the current time in string format
Most system tags are read-only, which means you cannot add, edit, or remove these tags from the
database.
Page 36
About Tags and the Project Database
To see a list of the system tags, select the Global tab in the Project Explorer, open the System Tags folder,
and open the Tag List subfolder.
After creating a tag, you can use it anywhere within the project, and you can use the same tag for more
than one object or attribute.
Page 37
About Tags and the Project Database
Page 38
About Tags and the Project Database
Page 39
About Tags and the Project Database
Array tags
An array tag consists of a set of tags or elements that all have the same name but use array indexes to
differentiate between them. An array index can be a literal numeric value, another tag that contains the
value, or an expression that includes the arithmetic operator "+".
You can use array tags to simplify configurations, optimize memory usage, enable multiplexing, and save
time during project development.
For example, suppose you want to monitor the temperature of four tanks. The conventional configuration
method is:
• Temperature1 – high temperature on tank 1
• Temperature2 – high temperature on tank 2
• Temperature3 – high temperature on tank 3
• Temperature4 – high temperature on tank 4
You can use array tags to simplify this task as follows (where n represents the tank number):
• Temperature[n] – high temperature on tank n
The following table provides some additional examples of referencing an array tag:
Example Description
Simple arrays, where the array indexes (1, 2, 500) are literal numeric
Temperature[1]
values representing tank numbers.
Temperature[2]
Temperature[500]
Temperature[tk] A simple array, where the array index (tk) is a tag representing the tank
number.
Temperature[tk+1] A complex array, where the array index (tk+1) is an expression. For
example, the value of tk (tank number) plus 1.
When you create an array tag, you need to specify its size or maximum index. You can do this in either
the Project Tags datasheet or in the New Tag dialog box, depending on when and how you create the tag.
Enter the size in the Array Size box.
Keep in mind that each array tag has a position 0, so when you create an array tag of size n, it actually
has n+1 elements (i.e., from position 0 to position n).
The total number of tags in a project is limited by the Product Type (i.e., the runtime license) that you
select for the project. Each array element (including position 0) counts towards the total number of tags,
because each array element can have its own value. The maximum possible size of a single array tag is
either 16384 or the project's tag limit, whichever is lesser.
Notes
You cannot use spaces in an array tag or array index. When the software reads a tag name it begins with
the first character and then continues until it finds the next space or null character. Consequently, the
software does not recognize any characters following the space as part of the tag name. For example, if
you type a[second + 1], the software reads a[second as the tag name and considers it to be invalid
because it does not have a closing bracket. In contrast, if you type a[second+1], the software reads it
correctly and considers it to be valid.
If you use another tag as the index of an array, and if the value of that tag is outside the size of the array,
the following results are given:
• If the value of IndexTag is greater than the size of the array, then ArrayTag[IndexTag] will point to
the last position in the array; and
• If the value of IndexTag is less than 0, then ArrayTag[IndexTag] will point to the first position in the
array (i.e., position 0).
Page 40
About Tags and the Project Database
Indirect tags
An indirect tag references or "points to" another tag in the tags database.
Any tag of String type can be used as an indirect tag, as long as the value of that tag is the name of
another tag in the tags database. To indicate that a tag should be used as an indirect tag, simply prepend
an "at" character (@) to the tag name.
For example, consider the tag X of String type. If the value of X is "TEMP", then @X points to the tag TEMP.
Anywhere that you use @X in your project, you will actually use TEMP as if you referenced it directly. And if
the value of X changes to the name of yet another tag, then @X will point to that tag instead.
This eliminates the need to create duplicate logic for multiple tags. You can create the logic once, using
indirect tags to point to the actual tags, and then change the values of those indirect tags as needed.
If you are specifically creating a new tag to be used as an indirect tag, you do not need to create it of
String type. Instead, when you create the tag, you can enter the tag name with the @ already prepended
and then select the type of the other tag(s) to which it will point. For example, @Z of Integer type. This
makes it easier to filter the tags, because both regular and indirect tags of a specified type will be listed
together.
Page 41
Tutorial: Building a Simple Project
Page 42
Tutorial: Building a Simple Project
Page 43
Tutorial: Building a Simple Project
The Project Wizard dialog is closed, the project is created in the development environment, and the
Security System Configuration Wizard is displayed.
Page 44
Tutorial: Building a Simple Project
Page 45
Tutorial: Building a Simple Project
Creating tags
This part of the tutorial shows how to create new tags by adding them to the Project Tags datasheet.
A tag is any variable that holds a value. All tags created in a project are stored in the Project Tags folder,
on the Global tab of the Project Explorer.
Page 46
Tutorial: Building a Simple Project
Tip: You can sort the data in the Project Tags datasheet or insert/remove additional columns by
right-clicking on it and then choosing the applicable option from the pop-up menu.
Page 47
Tutorial: Building a Simple Project
Page 48
Tutorial: Building a Simple Project
Color picker
Page 49
Tutorial: Building a Simple Project
• Double-clicking on any screen object opens an Object Properties dialog containing the properties for
that object. The properties shown in the dialog change depending on the type of object.
• The Object Properties dialog also contains a pin button that controls whether this dialog remains
open. The button changes state (and function) each time you click on it, as follows:
• When the pin button is released, the focus is passed to the object on the screen as soon as it
is selected. It is recommended that this button is kept released when you want to manipulate
the objects (Copy, Paste, Cut, or Delete). Although the Object Properties dialog is on the top, the
keyboard commands (Ctrl+C, Ctrl+V, Ctrl+X, or Del) are sent directly to the objects.
• When the pin button is pressed, the focus is kept on the Object Properties dialog, even when you
click the objects on the screen. We recommend you keep this button pressed when you want
to modify the settings of the objects. You can click an object and type the new property value
directly in the Object Properties dialog (it is not necessary to click on the window to bring focus
to it). Also, when the pin button is pressed, the Object Properties dialog does not automatically
close when you click on the screen.
4. Click Fonts to open Font dialog, and then specify the font settings.
For this tutorial…
• Font is Arial
• Font style is Regular
• Size is 20
Page 50
Tutorial: Building a Simple Project
• Color is Blue
Page 51
Tutorial: Building a Simple Project
Page 52
Tutorial: Building a Simple Project
You can specify a screen that you have not yet created.
8. Close the Object Properties dialog.
Page 53
Tutorial: Building a Simple Project
Page 54
Tutorial: Building a Simple Project
During run time, the project replaces the ########## characters of the Text object with the value of
the system tag Date.
6. Close the Object Properties dialog.
7. On the Draw tab of the ribbon, in the Active Objects group, click Text.
8. Click on the screen, type Time: ##########, and then press Return.
9. Double-click the object to open its Object Properties dialog.
10.Click Text Data Link.
The Object Properties dialog changes to show the properties for the Text Data Link animation.
11.In the Tag/Expression box, type Time.
During run time, the project replaces the ########## characters of the Text object with the value of
the system tag Time.
12.Close the Object Properties dialog.
13.Go to File, and then select Save.
This figure shows what your screen will look like after you have created the date and time objects.
Page 55
Tutorial: Building a Simple Project
Page 56
Tutorial: Building a Simple Project
Shutdown is one of EcoStruxure Machine SCADA Expert 2020's built-in scripting functions, but it can
be used within VBScript by prefacing it with a dollar sign ($).
Page 57
Tutorial: Building a Simple Project
You may choose any tank symbol that you like; they all function basically the same.
Page 58
Tutorial: Building a Simple Project
A tank is an arrangement of different objects and animations (for example a rectangle, a bar graph,
etc.), all combined together as a Linked Symbol. You can modify the properties of this symbol by
editing the properties list. For this tutorial, you will modify the tag associated with the tank level.
9. For the property TagLevel, delete the existing value and then type Level[Index].
You do not need to reopen the Project Tags datasheet to create tags as you develop the project.
You have not previously created the tag Index in the Project Tags database, so an alert message asks
you if you would like to create it now.
10.Click Yes.
A New Tag dialog is displayed.
11.Configure the new tag with Array as 0, Type as Integer, and Scope as Local.
Page 59
Tutorial: Building a Simple Project
2. In the Symbols menu tree, open the System Symbols folder and then open the Sliders sub-folder.
Page 60
Tutorial: Building a Simple Project
This figure shows what your screen should look like after you have created the level slider object.
Page 61
Tutorial: Building a Simple Project
This figure shows what your screen should look like after you have created the tank selector object.
Page 62
Tutorial: Building a Simple Project
Page 63
Tutorial: Building a Simple Project
register_type:initial_offset
0X Coil Status
1X Input Status
3X Input Register
4X Holding Register
Page 64
Tutorial: Building a Simple Project
ID Slave ID Number
Page 65
Tutorial: Building a Simple Project
Page 66