ClearSCADA

In some scenarios, it can be useful to run the installer such that a specific set of options are installed without running the risk of installing the wrong thing, or to automate the installation of ClearSCADA on a large scale.

As of ClearSCADA 2010 R1, the installation process is managed by setup.exe which handles the installation of a variety of prerequisite as well as the installation of ClearSCADA itself. Setup.exe can be run either interactively or with a set of command line switches to customise the install process.

Setup.exe supports the following command line options:

Setup.exe [/log fullname] [/appendlog] [/silent] [/settings filename] [/noinstall] [/installlevel=n] [/productinstallerargs=args] [/suppressreboot]

/log filename - log installer actions to the specified file
/appendlog - append log to the end of the specified file.
/silent - suppress all dialogs during installation.
/noinstall - perform all actions except the actual installation of components. Useful for gauging the effects of an installation without making any changes.
/installlevel=n - the installer level passed to the main product installer.
/productinstallerargs=args - specify extra arguments to pass to the main installer.
/suppressreboot - suppress reboots, where possible.

ClearSCADA Feature Table

This table lists the component features of ClearSCADA in their hierarchy and the install level at which they are installed.
Note that -> in the feature column of the table indicates that the feature is part of the feature listed above it in the hierarchy. For example, MODBUS is part one of the SERVER components. The MODBUS component is dependant on the SERVER component be installed so installation of the MODBUS component will also install the SERVER component.

Feature
    Title Description Install Level
CLIENT     Clients Client components of ClearSCADA 1
-> VIEWX   ViewX Client Full client components of ClearSCADA 10
-> -> VIEWXCRYSTALREPORTS Crystal Reports Business Objects Crystal Reports Driver User Interface 15
-> VIEWXCTRL   WebX Client WebX client components of ClearSCADA 1
DATAACCESS     Data Access Data Access Components for ClearSCADA 5
SERVER     Server Server components of ClearSCADA 15
-> ADVANCEDMODBUS   Advanced Modbus Advanced Modbus driver
15
-> ADVANCEDOPC   Advanced OPC Advanced OPC Driver 15
-> ADVANCEDEWS   Advanced EWS Advanced EcoStruxure Web Services Driver 15
-> CFX   CFX Flow-Cal CFX Export Driver 20
-> CRYSTALREPORTS   Crystal Reports Business Objects Crystal Reports Driver 15
-> DDE   DDE Client DDE Client Driver 20
-> DEMO   Demonstration Projects Demonstration project database import files 15
-> DF1   Allen-Bradley DF1 Allen-Bradley DF1 Driver 15
-> DNP3   DNP3 DNP3 Driver 15
-> -> ENET SCADAPack E-Series DNP3 SCADAPack E-Series Extension Driver 15
-> HILSCHER   Hilscher Hilscher I/O Card Driver 20
-> ICMP   ICMP ICMP Driver 20
-> IEC60870   IEC 60870-5 IEC 60870-5-101 and IEC 60870-5-104 Driver 20
-> -> IEC60870PHOENIX Phoenix PSTN Phoenix Contact IEC60870-5-101 PSTN Extension Driver 20
-> KINGFISHER   Kingfisher Kingfisher Series II Driver 15
-> MITSUBISHI   Mitsubishi Mitsubishi Driver 20
-> MITSUBISHISLAVE   Mitsubishi Slave Mitsubishi Slave Driver 20
-> MODBUS   Modbus RTU Modbus RTU Driver 15
-> MODBUSSLAVE   Modbus RTU Slave Modbus RTU Slave Driver 15
-> NTP   NTP Monitor Network Time Protocol Monitor Driver 15
-> ODBC   ODBC Client ODBC Client Driver 15
-> OPC   OPC Client OPC Client Driver 15
-> OPCXMLDA   OPC XML-DA Client OPC XML-DA Client Driver 15
-> PAGER   Pager Pager Driver 15
-> PLC   PLC PLC Driver 15
-> SCADAPACKMODBUS   SCADAPackModbus CMI SCADAPack Modbus Driver 15
-> -> SCADAPACKREALFLO RealFLO CMI SCADAPack Modbus RealFLO Extension Driver 20
-> SDI12   SDI-12 SDI-12 Driver 20
-> SIMATICS7   Simatic S7 Siemens Simatic S7 Driver 20
-> SNMPMANAGER   SNMP Manager SNMP Manager Driver 15
-> SQLEXPORT   SQL Export SQL Export Driver 15
-> TMX   TMX Kuipers Electronic Engineering TMX Driver 20
-> TRIODIAGNOSTICS   Trio Diagnostics Trio Radio Diagnostics Driver 15
SERVERTOOLSFEATURE     Server Management Utilities Server management utilities 15
UTILS     Utilities Utilities for ClearSCADA 20
-> AEPRINTER   Alarm & Event Printer Alarm && Event Printer 50
-> PORTSERVER   Port Server Remote Port Server 20

Setting the Install Level

Using the "/installlevel=n" command line switch in conjunction with "/silent", setup.exe can be instructed to automatically install a selected set of predefined features. There are a number of defined base installation levels available when installing ClearSCADA as summarized in the table below.

Install Level Description
1 WebX Client only
5 WebX Client + Data Access
10 Full client install
15 Demo installation
20 Conformance installation
50 Full Installation

The following command would perform a full client install (including ViewX, WebX and Data Access components) silently, without requiring any user input.

setup.exe /silent /installlevel=10
For details on which features are installed at each install level, see the Feature Table above.

Adding Features to the Base Install Level

Once you have selected the base install level, you can then modify the installer to add additional features to that installation. The list of available features is shown in the ClearSCADA Feature Table above.
To install additional features you can set the ADDLOCAL installer argument with the selected features that are required.

The following example would silently perform a WebX Client only installation and additionally install the ViewX client with Crystal Reports XI R2 feature set.

setup.exe /silent /installlevel=1 "/productinstallerargs=ADDLOCAL=CLIENT,VIEWX,VIEWXCRYSTALREPORTS115"

Repair/Upgrade

Repair and Upgrade can be achieved by running the installer in silent mode.

setup.exe /silent

Note that in this case all optional third party pre-requisites will be installed.

Logging

An install may be logged using the log argument.

setup.exe /log d:\temp\install.log

Restart

The suppressreboot argument can be used to, where possible, suppress a Windows restart.

setup.exe /suppressreboot

Versions Prior to ClearSCADA 2010 R1

In some scenarios, it can be useful to setup the installer such that a specific set of options are installed without running the risk of installing the wrong thing. The ClearSCADA installer run with msiexec allows this automation to occur through the use of install levels and features.

Install Levels

There are a number of defined base installation levels available when installing ClearSCADA as summarized in the table below.

Install Level Description
1 Minimum install (browser only)
5 Data_access_install + Browser
10 Full_client_install
18 Demo_installation
20 Conformance_installation
50 Full_Installation

So in the simplest case, the installer can be run with a specified install level to install the combination of features shown above.

The INSTALLLEVEL property is the initial level at which features are selected "ON" for installation by default.

Adding Features to the Base Install Level

Once you have selected the base install level, you can then modify the installer to add additional features to that installation. The list of available features is shown in the table below. Note that -> in the feature column of the table indicates that the feature is part of the feature listed above it in the hierarchy. For example, installing the feature ClearSCADA also includes the CLIENT feature.

Once you have determined the feature set to install, you can then use the ADDLOCAL option to add specific features from the table below. See the examples in the next section.

Feature Feature Description Comments
CLIENT     Client components
-> VIEWX   Full client components
-> -> VIEWXBMS Serck Controls BMS Driver User Interface
-> -> VIEWXDNP3 DNP3 Driver User Interface for SCADAPackES (eNET) Components
-> -> VIEWXLOGIC Logic (IEC 6-1131) Driver User Interface
-> -> VIEWXCRYSTALREPORTS Seagate Software Crystal Reports 8.5 Driver User Interface
Only on versions of ClearSCADA containing Crystal Reports version 8.5
-> -> VIEWXCRYSTALREPORTS10 Crystal Decisions Crystal Reports 10.0 Driver User Interface
Only on versions of ClearSCADA containing Crystal Reports version 10
-> -> VIEWXCRYSTALREPORTS11 Business Objects Crystal Reports XI Driver User Interface
Only on versions of ClearSCADA containing Crystal Reports version 11
-> -> VIEWXCRYSTALREPORTS115 Business Objects Crystal Reports XI R2 Driver User Interface
Only on versions of ClearSCADA containing Crystal Reports version 11 Release 2
-> -> VIEWXCRYSTALREPORTS2008 Business Objects Crystal Reports 2008 Driver User Interface
-> -> VIEWXEMS Serck Controls EMS User Interface
-> VIEWXCTRL   Web client components
SERVER     Server components
-> DF1   Allen-Bradley DF1 Driver
-> RSLINX   Allen-Bradley RSLinx Driver
-> CRYSTALREPORTS   Seagate Software Crystal Reports 8.5 Driver
-> CRYSTALREPORTS10   Crystal Decisions Crystal Reports 10.0 Driver
-> CRYSTALREPORTS11   Business Objects Crystal Reports XI Driver
-> CRYSTALREPORTS115   Business Objects Crystal Reports XI R2 Driver
-> DDE   DDE Client Driver
-> DNP3   Serck Controls DNP3 Driver
-> -> ENET DNP3 SCADAPackES (eNET) Extension Driver
-> HILSCHER   Hilscher I/O Card Driver
-> ICMP   ICMP Driver
-> IEC60870   IEC 60870-5-101 and IEC 60870-5-104 Driver
-> KINGFISHER   Kingfisher Series II Driver
-> SERVERLOGIC   Logic (IEC 6-1131) Driver
-> MGX   Serck Controls MGX Driver
-> MITSUBISHI   Mitsubishi Driver
-> MITSUBISHISLAVE   Mitsubishi Slave Driver
-> MODBUS   Modbus RTU Driver
-> MODBUSSLAVE   Modbus RTU Slave Driver
-> ODBC   ODBC Client Driver
-> OPC   OPC Client Driver
-> OPCXMLDA   OPC XML-DA Client Driver
-> NTMON   Windows Performance Monitor Driver
-> NTP   Network Time Protocol Monitor Driver
-> PAGER   Pager Driver
-> RANDOM   Random Number Generator Driver
-> SCADAPACKMODBUS   CMI SCADAPack Modbus Driver
-> -> SCADAPACKREALFLO CMI SCADAPack Modbus RealFLO Extension Driver
-> SDI12   SDI-12 Driver
-> SIMATICS7   Siemens Simatic S7 Driver
-> SNMPMANAGER   SNMP Manager Driver
-> TMX   Kuipers Electronic Engineering TMX Driver
-> DEMO   Demonstration project database import files
DATAACCESS     Data Access Components for ClearSCADA
DEVKIT     Development sample files for ClearSCADA
-> DDESAMPLE   Sample VB SDK plugin to provide support for DDE sources
-> MODBUSSAMPLE   Sample C++ SDK plugin to provide support for Modbus sources
-> SDKDOCS   Guide for creating a driver using the Development Kit
PORTSERVER     Remote Port Server
SERVERCONFIG     Server management utilities
AEPRINTER     Alarm && Event Printer

Running the Installer

The installer must be run using msiexec with a number of parameters passed to the exe to determine how it will operate. A number of examples have been provided below.

Full details of msiexec switches can be found by running msiexec /? from the command line. In these examples, I will use /qb to provide information on install progress to the user without the option to modify the installed options.

It is recommended that you first uninstall the existing package and then do the appropriate reinstall. The uninstall can be performed by running:

msiexec /x c:\67.2975\ClearSCADA.msi /qb

To run the installer to install web client only:

msiexec /i c:\67.2975\ClearSCADA.msi /qb INSTALLLEVEL=1

To run the installer to install all data access components:

msiexec /i c:\67.2975\ClearSCADA.msi /qb INSTALLLEVEL=5

To install the full client components:

msiexec /i c:\67.2975\ClearSCADA.msi /qb INSTALLLEVEL=10

To install only a subset of the full client components (in this case ViewX and the DNP3 client components):

msiexec /i c:\67.2975\ClearSCADA.msi /qb INSTALLLEVEL=5 ADDLOCAL=VIEWX,VIEWXDNP3

Each additional option to add should simply be added in the comma separated string for ADDLOCAL.

Note that if the installer filename contains spaces you should enclose the filename within double quotes. For example:

msiexec /i "c:\67.2975\ClearSCADA With Crystal 11.msi" /qb INSTALLLEVEL=5 ADDLOCAL=VIEWX,VIEWXDNP3

Further References

MSDN provides a lot of information about using msiexec, INSTALLLEVEL and ADDLOCAL options.

INSTALLLEVEL

ADDLOCAL property

  1. Sep 10

    Dennis Tanzania says:

    Configuring Superuser credentials on silent install is also possible. Parameter...

    Configuring Superuser credentials on silent install is also possible.

    Parameters need to be set:

    SUPERUSERNAME
    SUPERUSERPASS
    CHANGESUPERUSER

    For example

    setup.exe /silent /productinstallerargs="SUPERUSERNAME=s SUPERUSERPASS=1q2w3e4r5t6y CHANGESUPERUSER=1"

    Be aware that you have to pass /productinstallerargs as the last switch to setup.exe. Also be warned you still have to have 12 characters as a minimum for the password to be accepted but you won't get any warning on a silent install if you fail to do so unless you also enable logging.