ClearSCADA 2015 Installation Guide
ClearSCADA 2015 Installation Guide
Printed in Canada.
2
Contents
Welcome to SCADA Expert ClearSCADA . . . . . . . . . . . . . 4
Security Guidelines . . . . . . . . . . . . . . . . . . . . . . . . 6
Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
System Requirements . . . . . . . . . . . . . . . . . . . . . . . 8
Recommended PC Configurations . . . . . . . . . . . . . . . . . 9
ClearSCADA Demonstration Version . . . . . . . . . . . . . . . 11
Installing ClearSCADA . . . . . . . . . . . . . . . . . . . . . . 12
Running ClearSCADA . . . . . . . . . . . . . . . . . . . . . . . 20
ClearSCADA Tools for New Users . . . . . . . . . . . . . . . . . 22
Guide for configuring and accessing new WebX . . . . . . . . . 23
Appendix A – Troubleshoot ClearSCADA Installation . . . . . . . 24
Appendix B – Adding a licence to your system . . . . . . . . . . 25
Appendix C – Starting and Stopping ClearSCADA . . . . . . . . 29
Appendix D – Support for Internet Explorer 10 . . . . . . . . . . 30
Appendix E – ClearSCADA Uninstall Procedure . . . . . . . . . 32
Appendix F – Folder Locations Table . . . . . . . . . . . . . . . 33
3
Welcome to SCADA Expert ClearSCADA
Welcome to Schneider Electric’s SCADA Expert ClearSCADA™ host
system software (hereafter referred to as ‘ClearSCADA’).
ClearSCADA is a powerful client-server SCADA system with:
4
Technical Support:
Americas, Europe, Africa, Middle East, Asia
Available: Monday to Friday 8:30am - 5:30pm
Eastern Standard Time
Toll free within North America: 1-888-226-6876
Direct Worldwide: +1 (613) 591-1943
Email: [email protected]
Technical Support:
Australia
Schneider Electric Australia
Direct: 1300 369 233
Email: [email protected]
5
Security Guidelines
The following are intended as recommendations when securing your
ClearSCADA system:
■■ User Accounts & Database Privileges
■■ The Super User account created upon installation should be
used to configure Administration User account(s) as required,
and then disabled.
■■ Always associate Users with User Groups, and assign privileges
only to User Groups (not individual User Accounts).
■■ Ensure security permissions for users on the root level of the
Database are set correctly and securely.
■■ Do not provide ‘Everyone’ or ‘Guest’ user access to the root level
of the Database.
■■ The Guest user should be used only to provide access to
customized ‘Log On’ and ‘Log Off’ mimics, if required.
■■ Use appropriate Windows User Accounts for Server operations
including System Calls, Printing, File Upload, and Performance
Monitoring.
■■ Password Policy
■■ Ensure good strong names are used for users.
■■ Ensure strong passwords are enforced for all users.
■■ Web Access
■■ Purchase and install a Web Server Certificate.
■■ Disable “Allow logon and database writes over non-secure
HTTP”.
■■ Use a proxy server or proxy firewall for communications with
Original WebX clients.
■■ Use a secure VPN if WebX is to be deployed across public
networks.
For more information please search for “Recommended Security
Settings” within the ClearSCADA Online Help Documentation.
6
Getting Started
After inserting the DVD, the following screen is displayed.
7
System Requirements
ClearSCADA can be installed on server or desktop hardware using
32-bit or 64-bit computers.
Server Hardware
Systems running on server hardware need to use server operating
systems such as Windows Server® 2008 R2 or Windows Server 2012.
Server operating systems are designed for servicing entire systems
rather than individual computers or small networks, and are therefore
better suited for larger ClearSCADA systems with more than two
clients.
■■ Windows Server 2012 R2 (Standard and Datacenter editions).
64-bit Only.
■■ Windows Server 2008 Release 2 (Standard and Enterprise editions)
- initial release and Service Pack 1. 64-bit Only.
Desktop Hardware
Desktop class hardware is only suitable for small, stand-alone client-
server systems.
■■ Windows 10 (Professional and Enterprise Editions) - initial release.
32-bit or 64-bit.
■■ Windows 8 (Professional edition) - initial release and 8.1. 32-bit
or 64-bit.
■■ Windows 7 (Professional and Ultimate editions) - initial release and
Service Pack 1. 32-bit or 64-bit.
NOTE: Desktop class operating systems such as Windows 7 should
not be used for servers with more than two clients. This is because
the TCP/IP security measures in these operating systems can cause
significant delays.
ClearSCADA requires Internet Explorer® 10 or 11 for web access to
ClearSCADA graphics pages, although ClearSCADA 2015 R2
includes a web server to provide access to browsers that support
HTML5 including Google Chrome™, Firefox®, and Safari®. HTML5
browsers can access the new web server for a richer web experience
including access to ClearSCADA trends & lists, queries, events
& alarms, point controls, database browsing and alarm banner
functionality via WebX.
8
Recommended PC Configurations
The table on page 10 lists the recommended PC configurations for a
variety of client and server scenarios.
In the table, the term ‘object’ refers to a database item whereas ‘point’
refers to a specific type of database item that stores I/O (a database
point). Historic points are database points that have the Historic
feature enabled.
9
Application Server Requirement
Small stand-alone Quad core processor, 8GB RAM, 50GB free disk space.
client-server with up to Desktop class hardware and operating system.
10,000 objects and 1-2
remote clients
Server with 10,000 objects, Quad core server class processor, 8GB RAM, 25GB free
5,000 historic points stored space on high performance disks for configuration, log files
for 2 years on-line, 3 or etc. A separate 250GB high performance disk system for
more clients historic data. Server class hardware and 64-bit operating
system.
Server with 50,000 objects, Quad core server class processor, 8GB RAM, 25GB free
25,000 historic points space on high performance disks for configuration, log files
stored for 2 years on-line, etc. A separate 500GB high performance disk system for
multiple clients historic data. Server class hardware and 64-bit operating
system.
Server with 100,000 Quad core server class processor, 16GB RAM, 50GB free
objects, 75,000 historic space on high performance disks for configuration, log files
points stored for 2 years etc. A separate 1TB high performance disk system for historic
on-line, multiple clients data. Server class hardware and 64-bit operating system.
Server with 175,000 Quad core server class processor, 16GB RAM, 50GB free
objects, 100,000 historic space on high performance disks for configuration, log files
points stored for 2 years etc. A separate 2TB high performance disk system for historic
on-line, multiple clients data. Server class hardware and 64-bit operating system.
Server with 250,000 2 x Quad core server class processor, 32GB RAM, 100GB
objects, 150,000 historic free space on high performance disks for configuration, log
points stored for 2 years files etc. A separate 4TB high performance disk system for
on-line, multiple clients historic data. Server class hardware and 64-bit operating
system.
Server with 450,000 2 x Quad core server class processor, 48GB RAM, 100GB
objects, 250,000 historic free space high performance disks for operating system,
points stored for 2 years installed applications, database configuration, and so on. A
on-line, multiple clients separate 50GB high performance disk system for log files.
A separate 4TB high performance disk system for Historic
data. A separate 4TB high performance disk system for Event
Journal data. A separate 8TB redundant array of disks for
historic data. Server class hardware and 64-bit operating
system.
Server with 1,000,000 2 x octa-core server class processor, 96GB RAM, 100GB
objects, 500,000 historic free space on high performance disks for operating system,
points stored for 2 years installed applications, database configuration, and so on.
on-line, multiple clients A separate 50GB high performance disk for log files. A
separate 8TB high performance disk system for Historic data.
A separate 8TB high performance disk system for Event
Journal data. Server class hardware and 64-bit operating
system.
10
ClearSCADA Demonstration Version
When installing ClearSCADA for the first time, it is recommended that
you install the Full (Recommended) Version. The Full (Recommended)
Version installs a subset of common drivers and core functionality of
the ClearSCADA software and ViewX client as well as the following:
■■ Overview Tutorial
■■ Sample Projects
■■ Symbol Library
The Demonstration version of ClearSCADA does contain some
limitations as compared to the fully licensed version of ClearSCADA.
These include:
■■ The ClearSCADA Server will run for 2 hours at a time then
automatically shut down.
■■ he ClearSCADA Server is limited to 1000 points. Once you exceed
T
this number you will be unable to create additional points in the
database.
■■ he ClearSCADA Server will allow you to connect 2 ViewX clients, 1
T
OPC client, 1 Data access client and 2 Web clients. If you purchase
a license for ClearSCADA, it will define the number of clients that
can attach to your server.
■■ You will not be able to configure 2 or more ClearSCADA Servers in
a redundant configuration in Demonstration Mode. If you wish to
evaluate ClearSCADA in a redundant configuration then we suggest
that you discuss this with your ClearSCADA distributor.
See Appendix B for details on requesting and installing a ClearSCADA
license.
11
Installing ClearSCADA
Before beginning the installation, please ensure the following:
■■ You are logged onto your computer with administrator privileges
■■ All firewalls are turned off (i.e. Norton™, ZoneAlarm™, BlackICE,
etc.)
■■ All other applications are closed.
12
We suggest that you only install the components that you need for
your system. For example, you only need to install:
13
3. Review the Licence Agreement and, if you agree, select
“I accept the terms in the Licence Agreement”. Click Next.
14
5. Select the Full (Recommended) option.
15
6. ClearSCADA will prompt you to create a username and password
for the Super User account. The Super User has security
privileges above and beyond all other users on the system. It is
recommended that a Super User account is used only to create a
privileged Administrator user account in the database, and then
the Super User account should be removed using the Server
Configuration tool. Enter a username and password. Click Next.
16
8. Select Finish.
17
9. Review the Licence Agreement and select “I accept the terms in
the Licence Agreement”. Click Next.
10. The installation will prompt you to configure the HTTP and SSL
hosting services. Usually the default values will be suitable, so
no changes are required.
18
11. Select whether to disable the IIS Default Web Site to allow
port 80 to be used with ClearSCADA. The default setting is
recommended. Click Next.
19
Running ClearSCADA
Three new shortcuts have been added to your desktop, which are
used to interact with the ClearSCADA server and client applications.
20
2. Launch the ClearSCADA Server Icon to access the status of the
ClearSCADA Server. The Server Icon can also be used to access
server configuration and status features, as well as server logging
and license details, accessible by right-clicking on the icon.
The ClearSCADA Server should appear as a blue icon in the
system tray (lower right corner of the screen). If this icon is not
present, or is another color, the ClearSCADA Server is not running
properly. If the server is not running properly please refer to
“Appendix A - Troubleshoot ClearSCADA Installation” on page 24.
3. Use the ViewX icon to launch the ViewX client application.
You will need to first login to ClearSCADA using the Super User
account defined in Step 6 of the installation process, above.
Remember to remove the Super User account once a privileged
Administrator account has been created in the database.
Please note that the Example Projects in the Configuration
Samples will trigger system alarms resulting in an audible alarm
bell. To silence the alarm, right click on the large red button in the
lower left corner of the screen and select
Disable Bell.
21
ClearSCADA Tools for New Users
A number of tools are available to help new users get started with
ClearSCADA:
■■ Videos – from the ClearSCADA Setup utility, select Getting Started.
From this page three videos are available;
■■ Introduction to ClearSCADA – this provides a general
introduction to the concepts used in ClearSCADA. This video
will take you through creating points, mimics, alarms, trends
and object menus.
22
Guide for configuring and accessing new WebX
The following are some tips and recommendations to help you get
started with the new WebX User Interface:
■■ As a reminder, the default port assignments for both the original and
new WebX are listed below. The unique default port assignments
allow both original and new WebX servers to be operational on the
same server concurrently, when enabled and licensed appropriately.
Original WebX New WebX
HTTP 80 85
HTTPS / SSL 443 453
23
Appendix A - Troubleshoot ClearSCADA Installation
The installation may take a few minutes, and is completed
automatically unless:
■■ here is insufficient disk space. If you have this problem, you need
T
to make more disk space available by deleting files or installing
additional disk space.
■■ The source files cannot be found. If this occurs, you need to
ensure that ClearSCADA can access the installation files on the
ClearSCADA DVD.
■■ here has been an error in the installation procedure. If this occurs,
T
you should contact Technical Support.
■■ our Microsoft Windows user account does not have the
Y
administrator level privileges. Refer to your Microsoft Windows
documentation for more information.
■■ You have a software firewall running during the installation that
interferes with the installation. While the installer should work with
firewalls, if you have problems, try running the installer with the
firewall disabled.
24
Appendix B – Adding a licence to your system
Once installed, when the ClearSCADA Server is started, it will run
in demo mode for a period of 2 hours. Once the 2 hour period has
expired, the Server will shut down. Changes to the database and
historic (logged) data will not be lost when this happens. A user
simply needs to restart the server to re-establish a connection to the
database.
Licensing ClearSCADA can be performed in one of the following two
ways:
■■ Hardware License (USB dongle)
■■ Software License (.lic file)
Hardware License
The USB key hardware license has the advantage of not being PC
specific. The key can be used on any PC running ClearSCADA
which means a user may, in effect, “take” their license with them. The
downside to the USB key hardware license is that once removed,
ClearSCADA reverts back to demo mode which means the USB key
must be inserted at all times in order for the license to be seen as
‘valid’ by the ClearSCADA Server.
Hardware licenses are typically shipped with the ClearSCADA DVD at
the time of order.
To obtain a USB key hardware license, email your inquiry to:
[email protected]
Within one business day, you will receive a response to your email
complete with instructions of delivery.
25
Software License
The software license has the advantage of being permanently installed
on the PC, thereby ensuring that ClearSCADA will always be licensed
on that machine. The downside to the software license is that it is hard
coded to the PC’s machine ID. Should a hardware configuration be
made to the PC (i.e. adding a new network card) that changes the
PC’s machine ID, the software license may become invalid and a new
license will need to be installed.
A software license cannot be transferred from one PC to another. It is
PC specific.
To obtain a software license:
1. S
tart the ClearSCADA Server and right click on the “ClearSCADA
Server icon” in the system tray (lower right corner of screen).
Select “License Details” from the menu. Note the “Machine ID”
number. To avoid transcription errors, we suggest that you copy
and paste this number into an email (see step 2).
2. Email the following information to
[email protected]:
■■ Machine ID (this should be copied and pasted from Step 1)
Within one business day, you will receive a response to your email
complete with the required license file and instructions to activate your
license.
To activate your software license for the server
1. Save the attached license file to your computer (remember the
location where you place the file)
2. Right click on the server icon (in the system tray)
3. Select License Details
4. Browse to the license file
5. Select file and click Open
26
To activate your license for the local (embedded) client:
1. F
rom the Start menu, select All Programs -> Schneider Electric
-> StruxureWare SCADA Expert -> ClearSCADA –> Configure
Connections. The ClearSCADA Client dialog will appear
2. Click on the Licenses... button. The Client Licensing dialog will
appear
3. Click on the browse button located to the right of the License File
field
Note: If odd characters exist in the License File field, delete them
as they prevent the file browser from being displayed.
4. Browse to the license file located on the hard drive and click
Open
5. In the Client Licensing dialog, click on Apply
6. Click on the OK button
7. Close the ClearSCADA Client dialog
8. (Re)start ViewX.
Note: the above steps are also used to activate the ViewX license on a
remote client.
27
Upgrading your License
Both the hardware and software licenses may be upgraded after they
are installed.
4. Once the email is received, our customer support group will reply
with a new unlocking code. Paste this code into the field below the
“Get Locking Code” field in the Field Exchange Utility.
28
Appendix C - Starting and Stopping ClearSCADA
The ClearSCADA Server icon is a separate application and is not part
of the Server Service. The Server icon may be launched separately
from the Server which means that the Server may be running but the
icon may not be visible.
If the ClearSCADA Server is set to start automatically as a service on
PC startup, the Server icon will appear as normal in the system tray. If
the icon is not visible, you can launch the Server icon by clicking on
Start Menu -> All Programs -> Schneider Electric -> StruxureWare
SCADA Expert -> ClearSCADA –> Server Icon
If the ClearSCADA Server is stopped, the Server icon will appear
grayed out like this:
If the ClearSCADA Server is running, the Server icon will appear blue
like this:
You can start the server by right clicking on the Server icon and
selecting Start Server.
Similarly, if the server is currently running, right click on the icon and
select the Shutdown Server option. You may be required to log on if
security is enabled on your database.
29
Appendix D - Support for Internet Explorer 10
There is a known issue with Cross-Site Scripting (XSS) Filter in Internet
Explorer 10. The issue can cause Internet Explorer 10 to ‘hang’. This
only applies when:
■■ Using Internet Explorer 10 to connect to Classic WebX over the
Internet.
■■ Using IP addresses in the URL for the ClearSCADA server.
■■ he default security settings for the Local Intranet zone have been
T
modified.
Please read the section below for more information about this issue
and instructions on how to prevent or correct this issue.
30
To add a WebX to ClearSCADA server connection to your Trusted Sites:
1. Using a WebX client, log on to the ClearSCADA server you
want to access. You will need to use a Username and Password
that is valid for a ViewX User account (and that User account has
to have the appropriate permissions to access the server).
2. Once you have logged on to the server, select Tools>Internet
Options to display the IE Internet Options dialog box.
3. Select the Security tab.
4. Select the Trusted Sites icon.
5. Select the Sites button to display the Trusted Sites dialog box.
The URL of the WebX connection to the server should be shown in
the Add this website to the zone field.
6. Add the URL to the list of Trusted Sites:
• If you use secure URLs (https:), select the Add button. The
connection to the ClearSCADA server is added to your list of
Trusted Sites and is unaffected by the XSS filter issue.
• If you use non-secure URLs. (http:), you should clear the
Require server verification (https:) for all sites in this
zone check box. This allows you to add non-secure sites to
the Trusted Zone. Use the Add button to add the connection
to the ClearSCADA server to your list of Trusted Sites.
7. On the Security tab, select the Trusted Sites icon and then
select the Custom Level button. This displays the Security
Settings dialog box.
8. Scroll down to the Enable XSS Filter setting.
9. Select Disable for the Enable XSS Filter setting.
10. Select the OK button.
11. On the Internet Options dialog box, select the Close button.
12. Repeat this process on each WebX client.
Alternatively, you could access the Custom Level settings for the
Internet zone and disable the Enable XSS Filter setting. However,
this would apply to all connections over the Internet, not just those to a
ClearSCADA server. For this reason, we recommend that you use the
Trusted Sites work around as described above.
31
Appendix E – ClearSCADA Uninstall Procedure
Prior to uninstalling ClearSCADA, you should make a backup of required
parts of the ClearSCADA database.
1. You can either
■■ Export what you want to keep from ViewX by right-clicking on the
appropriate group and selecting “Export”
■■ Backup the entire database folder. The location of the database
folder can be found under “System Configuration - Location” in
the server configuration dialog.
1. Start the Server Configuration application by rightclicking on
the Server Icon in the system tray and selecting Configuration.
2. Browse to System Configuration->Location
Note that you should shut down the server before backing up
the database in this manner.
2. If you have been issued a ClearSCADA soft license file for your
computer, locate it and save it somewhere safe. It will be a .lic file.
To uninstall ClearSCADA:
1. Stop the ClearSCADA server and close ViewX.
2. Remove any system DSN using the “Schneider Electric
ClearSCADA Driver”. Check in Control Panel | Administrative
Tools | Data Sources (ODBC) on the System DSN tab.
3. Un-install Schneider Electric ClearSCADA from Windows
using Control Panel | Add/Remove Programs. Remove any
ClearSCADA version installed.
4. Delete the ClearSCADA install and database directories as well
as the settings folder. Refer to the “Appendix F - Folder Locations
Table” on page 34 for more details.
Note that it may be difficult to locate the settings folder if you don’t have
the Show Hidden Files option turned on. Open a Windows Explorer
dialog and, from the top menu, select Tools | Folder Options. Select the
View tab and ensure the Show Hidden Files and Folders option is
checked.
32
Appendix F - Folder Locations Table
C:\Program Files\
ControlMicrosystems\
ClearSCADA
ClearSCADA 2010 C:\Program Files (x86)\ C:\Documents and Set- C:\Documents and
R2.X and R3.X Schneider Electric\ tings\All Users\Applica- Settings\<User>\
ClearSCADA tion Data\SchneiderElec- Local Settings\Application
ClearSCADA 2013 C:\Program Files\ tric\ClearSCADA Data\Schneider Electric\
R1.X and R2.X Schneider Electric\ ClearSCADA
ClearSCADA
ClearSCADA 2014 R1.X
Windows 8, ClearSCADA 2009 C:\Program Files (x86)\ C:\ProgramData\ C:\Users\<User>\
Windows 7, R2.X ControlMicrosystems\ ControlMicrosystems\ App-Data\Local\
Windows Vista, ClearSCADA ClearSCADA ControlMicrosystems\
Windows Server 2012 ClearSCADA
(64-bit) ClearSCADA 2010 C:\Program Files\
Windows Server R1.X ControlMicrosystems\
2008 (64-bit) ClearSCADA
Windows Server
2008 R2 (64-bit).
ClearSCADA 2010 C:\Program Files (x86)\ C:\ProgramData\ C:\Users\<User>\
R2.X and R3.X Schneider Electric\ Schneider Electric\ App-Data\Local\
ClearSCADA ClearSCADA Schneider Electric\
ClearSCADA 2013 ClearSCADA
R1.X and R2.X C:\Program Files\
Schneider Electric\
ClearSCADA 2014 R1.X ClearSCADA
and later versions
33
Schneider Electric
Telemetry & Remote SCADA Solutions