WSP Install Guide
WSP Install Guide
Installation Guide
© 2017 Schneider Electric Software, LLC.
No part of this documentation shall be reproduced, stored in a retrieval system, or transmitted
by any means, electronic, mechanical, photocopying, recording, or otherwise, without the
prior written permission of Schneider Electric Software, LLC. No liability is assumed with
respect to the use of the information contained herein.
Although precaution has been taken in the preparation of this documentation, Schneider
Electric Software, LLC assumes no responsibility for errors or omissions. The information in
this documentation is subject to change without notice and does not represent a commitment
on the part of Schneider Electric Software, LLC. The software described in this
documentation is furnished under a license agreement. This software may be used or copied
only in accordance with the terms of such license agreement.
ArchestrA, Avantis, DYNSIM, eDNA, EYESIM, Foxboro, Foxboro Evo, I/A Series, InBatch,
InduSoft, InStep, IntelaTrac, InTouch, PIPEPHASE, PRiSM, PRO/II, PROVISION, ROMeo,
Schneider Electric, SIM4ME, SimCentral, SimSci, Skelta, SmartGlance, Spiral Software,
VISUAL FLARE, WindowMaker, WindowViewer, and Wonderware are trademarks of
Schneider Electric SE, its subsidiaries, and affiliated companies. An extensive listing of
Schneider Electric Software, LLC trademarks can be found at: http://software.schneider-
electric.com/legal/trademarks/. All other brands may be trademarks of their respective
owners.
Schneider Electric Software, LLC
26561 Rancho Parkway South
Lake Forest, CA 92630 U.S.A.
(949) 727-3200
http://software.schneider-electric.com/
Publication date: 11/9/2017
Contact Us
Contact Schneider Electric Software Technical Support
Avantis Technical Support
Listing of regional and local country contacts: http://software.schneider-
electric.com/support/avantis/
Technical support: http://softwaresupport.schneider-electric.com/
For Avantis.PRO, Avantis Approvals, Avantis.DSS, and Condition Manager:
Email: [email protected]
Phone (8:30 a.m. to 5:00 p.m. Monday to Friday, Eastern Time):
o Toll-Free U.S. and Canada: 1-888-262-7111
o Toll-Free EMEA: 1-800-4670-6466
o Direct dial: 1-905-632-0635
For Avantis.XA:
Email: [email protected]
Phone (8:30 a.m. to 5:00 p.m. Monday to Friday, Eastern Time):
o Toll-Free U.S. and Canada: 1-800-991-8000
o Toll-Free EMEA: 1-800-4670-6466
o Direct dial: 1-905-632-4122
SimSci Technical Support
Listing of regional and local country contacts: http://software.schneider-
electric.com/support/simsci/
Technical support: http://softwaresupport.schneider-electric.com/
Email U.S. and Canada: [email protected]
Phone (USA 8:00 a.m. to 5:00 p.m. Central Time)
o Toll-Free U.S. and Canada: 1-800-746-7241
Skelta Technical Support
Email: [email protected]
Phone:
o U.S.: 1-678-306-4110 Option 3
o India: 91-80-4060-2600 Option 3
Wonderware Technical Support
Listing of regional and local country contacts: https://www.wonderware.com/contact/contact-
support/
Technical support: http://softwaresupport.schneider-electric.com/
Priority email for Customer FIRST Members: [email protected]
Email for customers without a support agreement: [email protected]
Phone
o Toll-Free North America and Latin America: 1-800-966-3371
o Direct dial: 1-949-639-8500
InStep Technical Support
Contact page: http://www.instepsoftware.com/contact-us
Technical support: https://support.instepsoftware.com/
Email: [email protected]
Phone (USA 8:00 a.m. to 5:00 p.m. Central Time)
o 1-312-894-7870
Schneider Electric – Smart Water Software Technical Support
Help desk email: [email protected]
Help desk telephone hotline: +45 88 30 20 77 (09:00 to 16:00 Monday to Thursday,
Friday 09:00 to 15:00, Central European Time)
Contact Schneider Electric Software Learning Services
Contact Software Learning Services for assistance regarding classes, schedule, offerings,
frequently asked questions, tuition, policies, and more.
Email: [email protected]
Toll-Free U.S. and Canada: 1-866-998-7246
Direct: 1-949-639-8508
Fax: 1-949-639-1847
Wonderware System Platform Installation Guide
Contents
Chapter 1 Wonderware System Platform Installation ....................................................... 9
Preparing for Wonderware System Platform Installation ............................................................... 9
License Installation and Activation ........................................................................................ 9
Operating System Minimum Requirements ......................................................................... 11
System Sizing Guidelines .................................................................................................. 12
Supported and Recommended Node Hardware Types ........................................................ 13
Required Installation Order of Additional Wonderware Products ........................................... 14
Common Components ....................................................................................................... 14
Windows Network Configuration......................................................................................... 15
Wonderware System Platform Prerequisites ....................................................................... 15
About SQL Server Requirements.................................................................................. 18
Selecting a Type of Installation........................................................................................... 18
About Product-Based Installation .................................................................................. 18
About Role-B ased Installation ...................................................................................... 20
ArchestrA User Account..................................................................................................... 23
About ArchestrA Us er Account Privileges ...................................................................... 24
Installing the Wonderware System Platform .............................................................................. 24
Configuring Wonderware System Platform Components ............................................................ 34
Configuring the Schneider Electric License Server Location ................................................. 34
Configuring Databases and Dat a File Locations .................................................................. 35
System Restart after Configuration ..................................................................................... 41
Modifying an Installation .......................................................................................................... 41
Repairing an Installation .......................................................................................................... 43
Uninstalling Wonderware System Platform ............................................................................... 43
Uninstalling Wonderware System Platform Uninstall a Wonderware System Platform
Component ...................................................................................................................... 43
Uninstall All Components ................................................................................................... 44
Upgrading Wonderware System Platform ................................................................................. 45
5
Wonderware System Platform Installation Guide Contents
SQL Server not found on node: medium and larger configurations ........................................ 55
Compatible version of SQL Server already installed ............................................................ 55
New version of SQL Server already installed ....................................................................... 55
Incompatible version of SQL Server already installed .......................................................... 55
Using a Non-Default Port for SQL Server.................................................................................. 56
Setting a Windows Firewall Exception for the SQL Server Port ............................................. 57
6
Contents Wonderware System Platform Installation Guide
7
Wonderware System Platform Installation Guide Contents
8
Wonderware System Platform Installation Guide
C HAPTER 1
Wonderware System Platform Installation
You can use the Wonderware® System Platform installation program to install the entire suite
of products or any of the components.
In This Chapter
Preparing for Wonderware System Platform Installation .................................................................... 9
Installing the Wonderware System Platform .................................................................................... 24
Configuring Wonderware System Platform Components .................................................................. 34
Modifying an Installation ................................................................................................................ 41
Repairing an Installation ................................................................................................................ 43
Uninstalling Wonderware System Platform ..................................................................................... 43
Upgrading Wonderware System Platform ....................................................................................... 45
9
Wonderware System Platform Installation Guide Wonderware System Platform Installation
The Schneider Electric License Manager node, under the Schneider Electric start
directory (after installation is complete).
Schneider Electric Licensing
The Schneider Electric License Server acquires, stores, and serves licenses for all installed
Schneider Electric software, including all Wonderware System Platform products. The
Schneider Electric License Server and Manager work together to provide centralized
management of all your product licenses.
For products and roles that do not install the License Server on the same node, you will have
to provide the location (node name) of the License Server.
The basic product installation and license activation workflow is:
1. Install Wonderware System Products, along with the Schneider Electric License Server
and License Manager. See Installing the Wonderware System Platform on page 24.
2. Configure the Schneider Electric License Server (and Historian, if installed). See
Configuring the Schneider Electric License Server Location (see "Configuring the
Schneider Electric License Server Location" on page 34).
3. Start the Schneider Electric License Manager. The License Manager is browser-based,
and is located in the Schneider Electric folder (Start > Schneider Electric > Schneider
Electric License Manager). The License Manager uses the following URL:
http://localhost/SELicenseManager
Note: If you are running the License Manager from a remote node (not the License
Server/Galaxy Repository node), substitute the node name for localhost.
10
Wonderware System Platform Installation Wonderware System Platform Installation Guide
4. If a License Server is displayed, you can simply click on it to select it. If there are no
License Servers displayed, click the Add Server button, and then enter the computer
name of the License Server, or select the computer name from the drop down.
5. Select and activate your product license(s) from your license file before starting the
application(s). See the Schneider Electric License Manager Guide for detailed
information.
11
Wonderware System Platform Installation Guide Wonderware System Platform Installation
Wonderware Historian
Schneider Electric Licensing
Wonderware InTouch Access Server OS is required
Anywhere
Note: Windows 10 versions prior to version 1607 (Anniversary Update; OS build 14393) do
not support Wonderware System Platform 2017.
RDP clients, ITAA Minimum 1 512 MB N/A 800 x 600 100 Mbps
browsers, mobile
devices Recommended 2 2 GB N/A 1280 x 1024 100 Mbps
Client Node
12
Wonderware System Platform Installation Wonderware System Platform Installation Guide
Basic RDS -
RDS, ITAA Server 8 12 GB 500 GB 1920 x 1080 1 Gbps
Recommended
Supports up to five
remote sessions Large RDS - Minimum 8 16 GB 500 GB 1024 x 768 1 Gbps
Large RDS -
16 24 GB 1000 GB 1920 x 1080 Dual 1 Gbps
Recommended
All-In-One Node
Server node type applies to Historian Server, Galaxy Repository node, and nodes hosting AppEngines.
In redundant environments, increase CPU and RAM to maintain a maximum of 40% typical resource utilization.
Window Maker (with Managed Apps) Preferred Supported Supported RDP Supported
InTouch Access Anywhere Client (HTML5 Browser Browser Browser Browser Browser
Browser)
InTouch Access Anywhere Secure Gateway Supported No No No No
13
Wonderware System Platform Installation Guide Wonderware System Platform Installation
Historian
Support Components
Common Components
Wonderware System Platform 2017 includes several shared modules that are needed for the
products to operate. You will see the following common components listed under Programs
and Features in the Windows Control Panel after installation is complete:
ArchestrA Data Store 2.1.1
ArchestrA Service Bus Framework V5
ArchestrA Service Bus Framework 4.1.0
Schneider Electric Licensing
Schneider Electric Licensing (x86)
Schneider Electric License Server
Wonderware Operations Integration – Core G-2.1
Wonderware Operations Integration – Supervisory Gateway (G-2.1 Series)
14
Wonderware System Platform Installation Wonderware System Platform Installation Guide
15
Wonderware System Platform Installation Guide Wonderware System Platform Installation
Microsoft .NET® Framework 4.5.2: In addition to .NET 3.5 SP1, .NET 4.5.2 is also
required. .NET 4.5.2 is automatically installed if a version of .NET equal to, or higher than,
4.5.2 is not found.
SQL Server: SQL Server is required for products or roles that you select for installation
that include GR node or Historian Server. If SQL Server is not present, you are given the
option to install SQL Server 2014 SP2 Express with Tools as part of the Wonderware
System Platform installation. However, SQL Server Express supports only small
installations with less than 25,000 I/O per node.
For medium and large installations, a copy of SQL Server 2016 SP1 Standard Edition is
supplied with Wonderware System Platform. You must install it or another supported
version of SQL Server separately, before you install Wonderware System Platform. See
the Schneider Electric Global Support (GCS) Technology Matrix for a list of supported
SQL Server versions.
If you do not want to install SQL Server, and you have product or role selections that
include the GR node by default, you can select the Customize Installation checkbox and
deselect the Galaxy_Repository. However, this will limit any database-related product
functionality, such as the Application Server IDE, that uses the Galaxy Repository.
See SQL Server Requirements on page 53 for more information about the limitations of
using SQL Server Express instead of a standard or enterprise edition.
The following tables summarize which Wonderware System Platform products and roles
require SQL Server.
SQL
Wonderware System Platform Product Selections Required
16
Wonderware System Platform Installation Wonderware System Platform Installation Guide
SQL
Wonderware System Platform Product Selections Required
Historian Yes
Historian Client No
Licensing No
SQL
Wonderware System Platform Role Selections Required
Runtime Client No
All-In-One-Node Yes
Without GR node and Historian Server (custom installation) No
Note: Wonderware System Platform allows you to install an InTouch development system
without a GR node. However, InTouch Modern Applications will not work without the GR
node.
17
Wonderware System Platform Installation Guide Wonderware System Platform Installation
While installing Wonderware System Platform, if the logged-on user (the installer) is not a
SQL Server administrator, the aaConfig SQL dialog box appears and requests SQL Server
administrator credentials. Enter valid SQL Server administrator credentials when requested.
For more information about setting user privileges with the aaConfig SQL utility, see Setting
the SQL Server Security Mode on page 50. For more information about SQL Server
installation, see About SQL Server Requirements on page 18.
The Wonderware System Platform installation installs both system-specific and product-
specific prerequisites. It also checks for incompatible software that will prevent installation
from proceeding, (for example, if InTouch Access Anywhere was previously installed). You do
not have to exit from the Wonderware System Platform installation procedure to install the
prerequisite software, with the exception of standard or enterprise versions of SQL Server.
You will need to exit and perform any uninstall operations that are indicated before continuing
with installation.
For information on prerequisites and software requirements for the specific products, see the
Wonderware System Platform Readme, the Readme files of the specific products located in
your documentation directory, or the specific product information chapter in this installation
guide.
18
Wonderware System Platform Installation Wonderware System Platform Installation Guide
If you are familiar with Wonderware products and their associated components, you can opt
for a product-based installation, and then choose the components that you need.
For example if you need to install InTouch® with the default options, then select a product-
based installation. The following product selection options are available:
Important: Product-Based installation includes an option to install the InTouch Access
Anywhere Secure Gateway. This option can only be installed on a computer running a
supported version of the Windows Server operating system (minimum: Windows Server
2012). No other System Platform components can be installed with it.
19
Wonderware System Platform Installation Guide Wonderware System Platform Installation
20
Wonderware System Platform Installation Wonderware System Platform Installation Guide
InTouch Access Anywhere Secure Gateway Node: Install the components to access
Wonderware InTouch applications hosted on Terminal Servers by using HTML5
compatible web browsers. This component cannot be installed on a computer that has
other System Platform components installed.
Role Component
21
Wonderware System Platform Installation Guide Wonderware System Platform Installation
Role Component
22
Wonderware System Platform Installation Wonderware System Platform Installation Guide
Role Component
23
Wonderware System Platform Installation Guide Wonderware System Platform Installation
24
Wonderware System Platform Installation Wonderware System Platform Installation Guide
2. After some automatic configuration occurs, the select installation mode dialog box
appears.
3. Select whether you want a product-based or a computer role-based installation, and then
click Next. The select options dialog box appears. Its appearance will vary, depending on
whether you chose product-based or role-based installation.
For information about product-based installation, see About Product-Based Installation
on page 18.
For information about role-based installation, see About Role-Based Installation on
page 20.
25
Wonderware System Platform Installation Guide Wonderware System Platform Installation
If you select the Product Based Selection option, then the product based installation
dialog box appears..
If you select the Wonderware System Platform Computer Roles option, the role based
installation dialog box appears.
You can select multiple products or roles. All the selected components will be installed
together. If you are installing InTouch Access Anywhere Secure Gateway, it must be
installed by itself, without any other System Platform components.
26
Wonderware System Platform Installation Wonderware System Platform Installation Guide
4. Select the check boxes to indicate which products or roles you want to install, and then
click Next. The verify selection dialog box appears.
5. To proceed with your selections without making any changes, click Next. To change your
configuration, select the Customize Installation check box before clicking Next.
Important: You must select the Customize Installation option to install the InTouch 16-
Pen Trend Wizard supplementary component.
6. Complete the following installation steps to install InTouch HMI supplementary
components and make other changes:
a. Select Customize Installation.
27
Wonderware System Platform Installation Guide Wonderware System Platform Installation
c. Scroll through the list of Wonderware System Platform products to be installed to the
InTouch Supplementary Components section.
d. Select InTouch 16 PenTrend from the list.
– You can make other product and component selections.
– You can click Browse on the customize installation dialog box to change the
program installation destination folder.
e. Click Next to continue the remainder of the installation procedure.
28
Wonderware System Platform Installation Wonderware System Platform Installation Guide
7. If you have selected an InTouch HMI features, the language selection dialog box
appears. Select the language for your InTouch HMI installation. The InTouch language
versions are supported only for the matching operating system language. For example,
the German version of the InTouch HMI is only supported on the German operating
system.
8. Click Next. The End User License Agreement dialog box appears.
29
Wonderware System Platform Installation Guide Wonderware System Platform Installation
9. Review the license(s). Click I have read and accept the terms of the license
agreement(s), and then click Agree.
10. If the products or roles you selected require it, the ArchestrA User Account dialog box
appears.
Note: If an Archestra User Account is NOT required (for example, if you are only installing
Historian Client), you will be prompted to click Install. If this is the case, skip to step 12.
11. Specify an ArchestrA User Account. You can specify an existing user account, or create a
new ArchestrA User Account if no other ArchestrA-enabled software is installed on the
computer.
To select an existing user account:
a. Clear the Create Local Account check box. When you clear the check box, the
Domain/Local Machine text box displays the default domain name. Specify a
different domain/local machine name if necessary.
b. Type the user name and password for the existing account. The account must meet
the following requirements:
– The account must have a permanent password that does not expire.
– The account must have a password that cannot be changed.
– The account must be a member of the local Administrators group.
c. Click Next to complete the User Account setup.
30
Wonderware System Platform Installation Wonderware System Platform Installation Guide
Caution: If you select SQL Server Express, Wonderware System Platform will
automatically grant you (the logged in user) SQL sysadmin privileges. This level of access
is required to proceed with SQL Server Express installation. You will retain sysadmin
privileges even after installation. If you need to remove sysadmin privileges from the
logged in account, be sure to create a sysadmin account first.
Click Yes to use SQL Server Express. SQL Server Express is adequate for systems
with less than 25000 IO. It will be installed automatically along with the other
prerequisites and the selected Wonderware System Platform components.
Click No to skip SQL Server Express installation. Then, click Exit and manually install
SQL Server. Wonderware System Platform for medium and large installations
includes a separate DVD with a full version of SQL Server 2016 SP1 Standard.
However, you can install any supported version of SQL Server. See the Schneider
Electric Global Support (GCS) Technology Matrix for a list of supported SQL Server
versions.
When you have finished SQL Server installation, restart Wonderware System Platform
installation.
31
Wonderware System Platform Installation Guide Wonderware System Platform Installation
13. A list of missing prerequisite components (if any) and the Wonderware System Platform
products to be installed are displayed.
Note: Any prerequisites required for the products selected for installation will be listed
above the list of products and components. The prerequisites will be installed first, and
the product and components will be installed immediately after installation of the
prerequisites has finished. If you elected to install SQL Server Express, it will be installed
along with any other prerequisites.
32
Wonderware System Platform Installation Wonderware System Platform Installation Guide
15. After the installation is over, the complete installation dialog box appears.
Select View Readme for important information about Wonderware System Platform
2017 UPDATE 1, including hardware and software requirements, new features, and
known and resolved issues.
Select Configure to continue. See Configuration (see "Configuring Wonderware
System Platform Components" on page 34) for the final steps to complete installation .
33
Wonderware System Platform Installation Guide Wonderware System Platform Installation
The status of each item in the Configurator is displayed when the Configuration opens and
as items are configured. The status indicators are:
o Error - Indicates that an error occurred during configuration.
o Not Configured - Indicates that the feature is installed, but not configured.
o Warning - Indicates that configuration is complete, but with warnings.
o Configured - Indicates that configuration completed successfully.
o Not Installed - Indicates that the feature is not installed.
34
Wonderware System Platform Installation Wonderware System Platform Installation Guide
Backup: If you have configured a backup server (secondary server), select the
checkbox to enable backup. Then, enter the secondary server name.
35
Wonderware System Platform Installation Guide Wonderware System Platform Installation
2. In the left pane, click Server. Then configure the databases as follows.
a. Under Database Information, specify the SQL Instances and database path.
– SQL Instance
Name the SQL Instance associated with this historian.
– Database Path
Unless you have specific requirements, keep the default SQL Server database
path. This is the path where the configuration database is deployed. Click the
ellipsis button to specify a different directory in which to install the historian
database files.
b. Under Existing Database Conflict, read any notices.
If the database is created for the first time, then this option is not available. When
reconfiguration is done, then the Drop and Create New Database option is available.
If you select this check box, then the existing database is dropped and a new
database is created. If this check box is cleared, then the database is not dropped, but
configured for changes, if any.
c. Under Alarms & Events Storage, configure how you want to store alarm and events.
36
Wonderware System Platform Installation Wonderware System Platform Installation Guide
Important: If you want to change this setting later after the Historian is running, you
must first shut down and disable the historian using the Management Console. Then,
after making the change, you can restart and enable the historian.
– High-speed (default/recommended)
The high speed setting for storing alarms and events in history blocks provides
several advantages. You can manage the data using simple operations such as
moving, copying, or deleting folders, instead of using database management
software.With this storage method, you no longer need to purge to sustain
storage.This method offers significantly higher storage rates. Also, the capacity for
alarm and event storage is only limited by disk space, not by insertion rate.
If you select this option, you will not be able to query alarm and event history from
SQL queries, but alarm and event data stored in history blocks can be retrieved
via the Open Data Protocol (OData), the ArchestrA AlarmClient control 2014 R2 or
later, or the Historian SDK 2014 R2 or later.
For more information on retrieving alarm and event history via OData, see the
Wonderware Historian Retrieval Guide.
– Traditional
The traditional setting stores alarms and events in the A2ALMDB SQL Server
database. This works well for smaller applications. Alarm and event data stored in
the A2ALMDB database can be retrieved using SQL queries. You can also use
SQL Server tools, such as Reporting Services, to query alarm and event history.
d. Under Network, accept the default ports or change these settings. The ports you
specify are added to the exclusions list of Windows Firewall.
– Historian TCP port is used for replication data.
If you are configuring a tiered historian server, specify the port number for tag
replication between the tier-1 and tier-2 servers. You must use the same port for
all the tier-1 and tier-2 systems working together in the tiered configuration.
– InSight/REST TCP port is used for data queries via InSight or the Historian REST
API to the Historian Server.
Type the number for the port used by InSight and REST interface queries.
– Search port is used for data searches. This field is for reference only.
e. Under Security, Check the box if you want to allow remote access of this server's
System Management Console (SMC).
37
Wonderware System Platform Installation Guide Wonderware System Platform Installation
3. In the left pane, click Security. Configure the security options as follows.
a. Under Historian Users, review the existing users and roles for this server. Make
adjustments to the list as needed:
– To create a new user account, click Create Users and then specify account
details.
– To add existing user accounts to this list, click Add Users and then select the
account criteria to use.
– If you don't need this account anymore, mark the Delete Account check box.
b. Under SQL Logins, do one of the following to ensure your SQL Server logins are
secure:
– If you want to keep using a default account listed, type a new password.
– If you don't need this account, mark the Delete Account check box.
38
Wonderware System Platform Installation Wonderware System Platform Installation Guide
When you migrate from an older version of Wonderware Historian Server, this area is
populated with all preexisting SQL Server accounts and gives you the option to
change account password and to delete unused accounts to ensure strong security for
your system.
4. In the left pane, click Search. Then configure the search options as follows.
39
Wonderware System Platform Installation Guide Wonderware System Platform Installation
o Mark the Reindex Search Documents check box to create a new index of all existing
tags.
5. In the left pane, click Reporting. Then mark the appropriate check boxes to configure
OData extensions for SQL Reporting Studio or Visual Studio Report Designer on your
system.
40
Wonderware System Platform Installation Wonderware System Platform Installation Guide
Note: The installed programs may not function properly until you restart the system.
After the system restarts, and before you start using Wonderware System Platform, make
sure that you have activated your product licenses. See License Installation and Activation
(see "License Installation and Activation" on page 9).
Modifying an Installation
You can change the Wonderware System Platform components installed on your computer.
You can add new components or remove the existing ones. You can modify any component
of Wonderware System Platform.
You must have the installation DVD inserted in the DVD-ROM drive before you can modify a
program.
To modify an installation
1. Select the Modify option from the Wonderware System Platform Modify, Repair or
Remove Installation dialog box. You can open the dialog by doing either of the following:
Run Setup.exe from the Wonderware System Platform installation DVD.
Navigate to Uninstall or Change a Program in the Windows Control Panel. Then,
select any Wonderware System Platform component and then click the
Uninstall/Change button.
41
Wonderware System Platform Installation Guide Wonderware System Platform Installation
Note: The name of the Uninstall/Change option may vary depending on which
Windows operating system is installed on your computer.
2. Click the Modify option, and then click Next. The list of Wonderware System Platform
components appears.
3. Select or clear the components that you want to add or remove, and then click Next. The
verify change dialog box appears.
42
Wonderware System Platform Installation Wonderware System Platform Installation Guide
4. Click Modify. The selected components are added or removed and the complete
modification dialog box appears.
5. Click Finish.
Note: The system may not prompt you to restart the system after Modify is successful.
However, if you have added a new product or feature, a system restart is recommended.
Repairing an Installation
You can repair the installation of any component of the Wonderware System Platform. You
can repair missing or corrupt files, registry keys or shortcuts. You can also reset the registry
key to the default value.
Note: You must insert the installer DVD in the DVD-ROM drive before you can repair a
program.
To repair an installation
1. Click the Uninstall or Change a Program option in Windows Control Panel. The list of
software installed on your computer appears.
2. Select the Wonderware System Platform component that you want to repair, and then
click the Uninstall/Change button. The Modify Repair or Remove Installation dialog
box appears.
Note: The name of the Uninstall/Change button varies depending on the Windows
operating system installed on your computer.
3. Click the Repair option, and then click Next. The Confirm Repair dialog box appears.
4. Click Repair. The complete repair dialog box appears.
5. Click Finish.
43
Wonderware System Platform Installation Guide Wonderware System Platform Installation
2. Select the Wonderware System Platform component that you want to uninstall, and then
click the Uninstall/Change button. The Modify, Repair or Remove Installation dialog
box appears.
3. Click the Remove option, and then click Next. The confirmation dialog box appears.
4. Click Uninstall. The component is uninstalled and the complete uninstallation dialog box
appears.
5. Click Finish.
44
Wonderware System Platform Installation Wonderware System Platform Installation Guide
Products that will be upgraded are listed in the startup screen. Schneider Electric
licensing will be displayed for upgrade if any of the following products are installed:
o Alarm Adviser
o Intelligence
o Recipe Manager Plus
Note: You can only upgrade the products that are already installed, and you will not be
able to install additional products during the upgrade process.
2. Click OK and wait as configuration completes. If there are any recommended steps that
should be performed before continuing, they will be displayed.
45
Wonderware System Platform Installation Guide Wonderware System Platform Installation
3. Follow the instructions given and click Next. A list of all Wonderware System Platform
components appears. The installed components that need to be upgraded are selected
and disabled. You cannot clear these check boxes or select more components during the
upgrade.
If you are upgrading from a prior version of Wonderware Application Server, and a galaxy is
deployed, the Galaxy Patcher will start as soon as you connect to the galaxy from the
Application Server IDE. Undeployed galaxies are not patched until you connect to them.
Important: Galaxy patching may take several minutes. Do not shut down the node while the
patching operation is in progress.
If you have upgraded from Wonderware System Platform 2014R2 SP1, a new icon for the
Wonderware Application Manager is installed on the desktop, Use the Application Manager to
select and run deployed InTouch OMI ViewApps.
47
Wonderware System Platform Installation Guide
C HAPTER 2
Security and Permissions
In This Chapter
Modifying an ArchestrA User Account ............................................................................................ 49
SQL Server Rights Requirements .................................................................................................. 49
Setting the SQL Server Security Mode ........................................................................................... 50
Restoring Required SQL Server Accounts ...................................................................................... 52
Setting the FIPS Security Policy Option .......................................................................................... 52
Note: If you recreate the user account using the Change Network Account utility, the
Microsoft Windows security component on the computer can take several minutes to update
this information on the ArchestrA Galaxy Repository node. Until that occurs, the ArchestrA
component may not function properly. Restarting the Galaxy Repository node updates this
information immediately.
49
Wonderware System Platform Installation Guide Security and Permissions
The ArchestrA User Account is an operating system administrator and, as a member of the
aaAdministrators group, has the SQL sysadmin fixed server role. This account must be
defined for Galaxy operations. See ArchestrA User Account on page 23 for additional
information.
Caution: aaGalaxyOwner and ASBService are reserved OS user names. aaAdministrators
and ASBSolution are reserved OS group names. Do not create users or groups with these
names.
The automated process that creates the aaAdministrators group, ArchestrA User Account,
and aaGalaxyOwner user account also provides the rights required for operations within the
GR. The aaAdministrators group, ArchestrA User Account, and aaGalaxyOwner user account
must all be present and enabled for Galaxy operations.
Note: The aaGalaxyOwner account is the owner (dbo) of all Galaxy databases in your
system. It does not have a system login, and does not have the OS admin privileges that the
ArchestrA User Account has.
If you accidentally delete the aaAdministrators group or the ArchestrA User Account from
the Windows operating system, you can run either the Change Network Account utility
or the aaConfig SQL utility to restore it.
Both of these programs are located in the Wonderware folder, under All Programs.
If you accidentally delete the aaGalaxyOwner account from the Windows operating
system, you must run the aaConfig SQL utility to restore it.
If you accidentally delete the aaAdministrators group, ArchestrA User Account, or
aaGalaxyOwner from the SQL Server security logons, you must run the aaConfig SQL
utility to restore it.
50
Security and Permissions Wonderware System Platform Installation Guide
If you select Enhanced Security Mode, you may be prompted to provide SQL sysadmin
user credentials when restoring a Galaxy that was created with an older version of
Application Server. You do not need sysadmin credentials to restore Galaxies created
with the current version of Application Server.
Enhanced Security Mode removes the SQL sysadmin privilege from various ArchestrA
users and groups, including:
o NTAUTHORITY\SYSTEM
o aaAdminstrators (local security group that contains the ArchestrA Network User)
o <NodeName>\ASBService (used for cross-Galaxy communications, and for browsing
ArchestrA components)
51
Wonderware System Platform Installation Guide Security and Permissions
52
Wonderware System Platform Installation Guide
C HAPTER 3
Configuring SQL Server
In This Chapter
SQL Server Requirements............................................................................................................. 53
Working with SQL Server Versions ................................................................................................ 54
Using a Non-Default Port for SQL Server ....................................................................................... 56
53
Wonderware System Platform Installation Guide Configuring SQL Server
54
Configuring SQL Server Wonderware System Platform Installation Guide
Note: Nodes are defined as follows: Small = up to 25,000 I/O per node; Medium = 25,000 to
50,000 I/O per node; Large = 50,000 to 400,000 I/O per node.
55
Wonderware System Platform Installation Guide Configuring SQL Server
6. Change the TCP Port number from 1433 to the desired number.
7. Click OK or Apply to commit the changes.
8. Reboot the GR node.
56
Configuring SQL Server Wonderware System Platform Installation Guide
57
Wonderware System Platform Installation Guide
C HAPTER 4
Application Server Upgrade
Direct upgrade to Wonderware System Platform 2017 UPDATE 1 is supported from:
Wonderware System Platform 2014 R2 SP1 (with or without Patch 01 or Patch 02
applied).
Wonderware System Platform 2017.
In This Chapter
About Upgrading Application Server............................................................................................... 59
Basic Upgrade S equence .............................................................................................................. 61
Upgrading a Galaxy Repository Node ............................................................................................ 62
Upgrading an IDE-only Node ......................................................................................................... 62
Migrating the Galaxy Database ...................................................................................................... 63
Upgrading Run-Time Nodes .......................................................................................................... 63
Upgrading Redundant Pairs .......................................................................................................... 64
Upgrade Considerations for Multi-Galaxy Communication ............................................................... 68
Issues with Legacy Common Components ..................................................................................... 69
59
Wonderware System Platform Installation Guide Application Server Upgrade
To upgrade SQL Server after Application Server is installed, we recommend that you
undeploy any galaxies deployed on the relevant computer, and that you undeploy all
ArchestrA Service Bus (ASB) services. For more information, see the Wonderware
Application Server User Guide.
You can upgrade the following Application Server components:
Bootstrap
You will see a warning message if you attempt to upgrade a computer with a deployed
WinPlatform. You have the choice to continue with the upgrade or to cancel. If you
continue with the Bootstrap upgrade, the deployed WinPlatform object is removed from
run time and upgraded to version 2017 UPDATE 1.
If an InTouchViewApp instance is deployed for a managed InTouch application, the folder
is undeployed and deleted. You are prompted to stop InTouch WindowViewer from
running the managed application.
IDE and Bootstrap
You will see a warning message if you attempt to upgrade a computer with a deployed
WinPlatform. You have the choice to continue with the upgrade or to cancel. If you
continue with the upgrade, the current IDE and Bootstrap are removed and the new
versions are installed.
If an installed InTouchViewApp instance is deployed for a managed InTouch application,
the folder is undeployed and deleted. You are prompted to stop InTouch WindowViewer
from running the managed application.
Galaxy Repository (GR) and Bootstrap
You will see a warning message if you attempt to upgrade a computer with a deployed
WinPlatform or a client application is connected to the GR node. You can choose to
continue with the upgrade or to cancel. If you continue, the components are removed and
upgraded to version 2017 UPDATE 1.
Upgraded IDE/Client nodes cannot connect to a non-upgraded GR node. The GR node is
undeployed before it is upgraded to Application Server 2017 UPDATE 1.
IDE, GR, and Bootstrap
A warning message is displayed if you attempt to upgrade a computer with a deployed
WinPlatform or if a client application is connected to the GR node. You can choose to
continue with the upgrade or to cancel. If you continue, all components are removed and
upgraded to version 2017 UPDATE 1.
Run-time node
Upgrading the Bootstrap on any computer removes the running WinPlatform and
AppEngine. Both of these system objects are marked as undeployed if they are running
on any Galaxy node.
Note: No system objects are removed on non-GR nodes when migrating from earlier versions
of Application Server.
If a remote node is disconnected from the GR node, or if you upgrade the remote node before
you upgrade the GR node, the remote Platform is not marked as undeployed. You must
undeploy and redeploy the Platform.
60
Application Server Upgrade Wonderware System Platform Installation Guide
The run-time functionality of Application Server continues throughout the upgrade process,
except during a run-time node upgrade. Configuration, however, must be done using
components that are at the same version level. For example, you cannot use the Galaxy
Browser in the InTouch HMI on a non-upgraded node to view or select attributes from an
upgraded Galaxy. You can, though, view or modify run-time data using an InTouch window or
the Object Viewer.
Special considerations apply if you are upgrading both the Application Server and the
Wonderware Historian. For more information, see Upgrading from a Previous Version on
page 107.
61
Wonderware System Platform Installation Guide Application Server Upgrade
Important: After you have upgraded the GR node to Application Server 2017 UPDATE 1,
you will not be able to deploy or undeploy from the GR node to non-upgraded remote nodes.
Also, an IDE node that has been upgraded to 2017 UPDATE 1 will not be able to connect to a
GR node that has not been upgraded.
Note: As long as the operating system and SQL requirements are met, upgrade is supported.
During software installation, operating system upgrade is not supported.
62
Application Server Upgrade Wonderware System Platform Installation Guide
4. Click Upgrade. The node will be upgraded to Wonderware System Platform 2017
UPDATE 1, then click Finish.
5. When prompted, click Restart Now to complete the upgrade.
63
Wonderware System Platform Installation Guide Application Server Upgrade
Upgrading to Application Server 2017 UPDATE 1 on a run-time node will remove any
deployed Platforms on that node.
After you upgrade and then deploy a run-time node, it continues to function with other run-
time nodes as long as the other nodes are the current version or from the previous version.
The run-time node does not function while you are upgrading it. You cannot roll back the
upgrade.
After you upgrade the run-time node and all hosted objects, you need to redeploy the
WinPlatform and all hosted objects to the node.
The GR node migration fails if the GR node is used as a run-time node for another GR.
To upgrade a run-time node
1. On the run-time node, run Setup.exe from the DVD. An information box appears that lists
the products installed on the node.
2. Click OK. The Select Features dialog box appears. Any previously-installed features
appear dimmed.
3. Click Next. The Ready to Upgrade dialog box appears.
4. Click Upgrade. The node will be upgraded to Wonderware System Platform 2017
UPDATE 1, then click Finish.
5. When prompted, click Restart Now to complete the upgrade.
64
Application Server Upgrade Wonderware System Platform Installation Guide
3 Reboot Software is
when now at v2
prompted and P0
engines are
running off-
scan.
5 Optional: InTouch
Open and ViewApps
migrate now at v2.
InTouch
ViewApps
65
Wonderware System Platform Installation Guide Application Server Upgrade
66
Application Server Upgrade Wonderware System Platform Installation Guide
11 Reboot E1 is
when patched to
prompted v2 and is
running off-
scan.
12 Cascade E1 is No down-
deploy P1 deployed as time for
part of P1 objects on
deployment. E1b as E1b
continues to
E1 starts as
run as
standby and
active.
fully syncs
with active
engine.
After you have upgraded to Wonderware System Platform 2017 UPDATE 1, you can enable
CPU load balancing to improve the performance of redundant AppEngines during failover.
See the Wonderware Application Server User’Guide, Working with Redundancy, for
additional information.
The following table describes the behaviors associated with specific upgrade actions and
states.
Cascade deploy a Platform If the upgraded plat form hosts a backup redundant engine with
after upgrade a part ner in the SUP state, then during the deploy operation, it
will extract the hosted objects from the partner and deploy them
along with the backup redundant engine.
67
Wonderware System Platform Installation Guide Application Server Upgrade
Do the following to rename a Galaxy for use in a multi-Galaxy environment. For more
information about creating and backing up galaxies, see "Getting Started with the IDE," and
"Managing Galaxies," in the Wonderware Application Server User Guide.
1. Select a Galaxy with a duplicate name, undeploy it and back it up to create a .cab file.
2. Use the .cab file as a "template" by placing it in \Program
Files\ArchestrA\Framework\Bin\BackupGalaxies.
3. Create a new Galaxy with a new name, based on the backup .cab file. The name must be
unique, not in use anywhere else in the multi-Galaxy environment.
4. Repeat the preceding steps for each Galaxy to be renamed with a unique name.
5. Redeploy each newly created Galaxy.
6. Delete the original Galaxy from the GR node.
7. Upgrade to Wonderware Application Server 2017 UPDATE 1.
Your Galaxy can now be configured for use in a multi-Galaxy environment.
69
Wonderware System Platform Installation Guide
C HAPTER 5
InTouch HMI Requirements and
Prerequisites
You need to meet the requirements and prerequisites for Wonderware products.
In This Chapter
Installing OI Gateway and Upgrading from FS Gateway ................................................................. 71
71
Wonderware System Platform Installation Guide InTouch HMI Requirements and Prerequisites
72
InTouch HMI Requirements and Prerequisites Wonderware System Platform Installation Guide
If you are upgrading from InTouch 2014 R2 SP1, FS Gateway will appear in the SMC
(System Management Console) under DAManager.
After upgrading to InTouch 2017 UPDATE 1 from InTouch 2014 R2 SP1, two new
Gateway servers are installed. The first OI Gateway is installed under Operations
Integration Supervisory Servers as OI.GATEWAY.n. A second instance replaces the
existing FS Gateway instance, but preserves the existing configuration and name, even
though FS Gateway has been deleted and the new OI Gateway has been installed in its
place. Since the new gateway instance is in a deactivated state, you must activate it
(select the instance, right-click, and select "Activate Server").
73
Wonderware System Platform Installation Guide InTouch HMI Requirements and Prerequisites
Note that the component names are changed from "FSGateway" to "Gateway." This does
not affect references or change the behavior of the gateway.
74
Wonderware System Platform Installation Guide
C HAPTER 6
Historian Server Requirements and
Recommendations
For your Wonderware Historian to achieve maximum performance, make sure your hardware
and software meets the following requirements. Because the Wonderware Historian is a high-
performance relational database, it is also important to size your system to handle the level of
data that you expect to store.
The Wonderware Historian is tightly integrated with Microsoft products, and a working
knowledge of both Microsoft SQL Server and Microsoft Windows operating systems is
required. For more information on Microsoft SQL Server or Windows operating systems, see
your Microsoft documentation.
In This Chapter
Server Requirements .................................................................................................................... 75
Requirements for Historian Management Tools .............................................................................. 78
Remote IDAS Requirements.......................................................................................................... 78
Disk Sizing and Data Storage ........................................................................................................ 79
Performance Considerations ......................................................................................................... 85
Networking Rec ommendations ...................................................................................................... 88
Client Access ............................................................................................................................... 89
Support for Non-English Operating Systems................................................................................... 90
Integration with Other Wonderware Products .................................................................................. 90
System Sizing Examples ............................................................................................................... 90
Server Requirements
The minimum hardware and software requirements for the Wonderware Historian are based
on the tag count and the anticipated data throughput rate. These requirements are divided
into four levels, which are outlined in this section.
The recommended memory configuration for SQL Server (32-bit) is to clamp memory
consumption to 50 percent of the amount of physical memory installed on the server or 512
MB, whichever is larger. For SQL Server Standard and Enterprise editions (32-bit), the
recommended physical memory configuration is 1 GB. The recommended Windows virtual
memory setting is twice the amount of physical RAM installed on the server. For installation
requirements for SQL Server versions, see the Microsoft documentation.
75
Wonderware System Platform Installation Guide Historian Server Requirements and Recommendations
You need to ensure that the memory that SQL Server reserves for the Wonderware Historian
is adequate for the expected load. Based on your particular environment, you may need to
adjust the SQL Server MemToLeave allocation. For more information on MemToLeave, see
the Microsoft documentation.
You can install the Wonderware Historian on operating systems that have the User Account
Control (UAC) turned on.
If you are running the Wonderware Historian on a virtual server, the historian must have an
adequate CPU, adequate network memory, and disk I/O resources at all times. Overloading
the virtual server leads to unpredictable behavior. See System Sizing Guidelines (see
"System Sizing Guidelines" on page 12) for general hardware requirements.
Operating Systems
Any supported operating system. See the Schneider Electric Global Customer Support (GCS)
Technology Matrix.
Microsoft SQL Server
For supported Microsoft SQL Server versions, see the Schneider Electric Global Customer
Support (GCS) Technology Matrix.
Disk Space
300 MB of free disk space to install the Wonderware Historian
Appropriate space for history block storage. For more information, see Disk Sizing and
Data Storage on page 79.
Level 1 Server - Hardware
A Level 1 server can handle a load of about 5,000 tags. For example, 2,600 analogs, 2,200
discretes, 300 strings, and 20 non-I/O Server (manual) tags.
When replicating to Wonderware Online, each Level 1 server can support up to 15,000 tags
and 5,000 values per second.
The requirements are:
Processor:
o Minimum: P4 3.2 GHz CPU
o Recommended: dual-core CPU
RAM:
o Minimum: 2 GB
o Recommended: 4 GB
100 Mbps network interface card (NIC)
Level 2 Server - Hardware
A Level 2 server can handle a load of about 100,000 tags, with 50% analog, 45% discrete,
and 5% string tags. The requirements are:
Processor:
o Minimum: P4 3.0 GHz dual CPU
o Recommended: quad-core CPU
76
Historian Server Requirements and Recommendations Wonderware System Platform Installation Guide
RAM:
o Minimum: 4 GB
o Recommended: 8 GB
1 Gbps network interface card (NIC)
Level 3 Server - Hardware
A Level 3 server can handle a load of 150,000 tags, with 50% analog, 45% discrete, and 5%
string tags. The requirements are:
Processor:
o Minimum: P4 2.7 GHz Xeon quad CPU
o Recommended: dual processor, quad-core CPUs
RAM:
o Minimum: 6 GB
o Recommended: 12 GB
1 Gbps network interface card
Level 4 Server - Hardware
A Level 4 server can handle a load of 2,000,000 tags, with 50% analog, 45% discrete, and
5% string tags. The requirements are:
Processor:
o Recommended: two quad-core CPUs
RAM:
o Minimum: 24 GB
o Recommended: 48GB
1 Gbps network interface card
A performance report for different historian systems is provided in System Sizing Examples
on page 90.
77
Wonderware System Platform Installation Guide Historian Server Requirements and Recommendations
78
Historian Server Requirements and Recommendations Wonderware System Platform Installation Guide
When you install the historian, you must specify an administrative user account under which
all of the historian services run. Make sure that this same user account is added to the
Administrators security group on the remote IDAS computer. The existence of the same
administrative user account on both the computers, allows the historian to access the remote
IDAS, and vice versa.
Note: A remote IDAS only requires the same administrative account to exist on the local
computer and the historian. It is not required for you to log on to the remote IDAS computer
using the administrator account.
If you change the Windows login using the System Management Console, after installing the
historian, make sure that the user account change is reflected on the remote IDAS computer.
If you are running the historian in a domain environment (recommended), you can create the
administrative user account on the domain controller and add the account to the
Administrators group on the historian computer and the remote IDAS computer. Do not create
a local user on any computer with the same name and/or password as the administrative user
account.
If you are running a remote IDAS in a workgroup environment, there is no centralized
management and authentication of user accounts (no domain controller). Create the same
administrative user account on each individual computer running a historian component. For
example, if you have a computer running the historian and plan to install remote IDASs on
two other computers, create the user account (that is, matching user names and passwords)
on all three computers.
For information on workgroups, domains, creating user accounts, and adding accounts to the
Administrators security group, see your Microsoft operating system documentation.
79
Wonderware System Platform Installation Guide Historian Server Requirements and Recommendations
A performance report for different historian systems is provided in System Sizing Examples
on page 90.
80
Historian Server Requirements and Recommendations Wonderware System Platform Installation Guide
The Holding database temporarily stores tag definitions being imported from InTouch®
HMI software. The information in the Holding database is stored to a database file named
HoldingDat_116_<server_name>.mdf. Its associated log file is
HoldingLog_116_<server_name>.ldf.
The A2ALMDB database stores alarm and event data. The information in the A2ALMDB
database is stored to a database file named A2LMDat_115_<server_name>.mdf. Its
associated log file is A2ALMDB_LOG.ldf.
The Runtime and Holding databases are set to automatically expand at a 10% rate (the
default).
You cannot change these defaults during the installation. The databases can be resized later
using Microsoft SQL Server utilities. For more information on sizing databases, see your
Microsoft SQL Server documentation for guidelines.
Note: If you are upgrading a previous version of the Wonderware Historian, the installation
program needs space to save a copy of the old Runtime database while it creates the new
one. To upgrade, the database space required is twice the size of the old database, plus the
database size for the new install.
Analog - Integer 8 34
81
Wonderware System Platform Installation Guide Historian Server Requirements and Recommendations
Analog - Double 12 38
Discrete 5 31
Analog Summary 37 63
The storage size is used for estimating the space required for storage.
The network transmission size is used for calculating the network bandwidth required
between HCAL and the historian.
If you enable compression on the AppEngine from which events are originating, then the
network size is reduced by approximately 80%.
For alarms and events, the network transmission size assumes that the average name length
for each of the alarm properties is 20 characters.
The following table provides some sizing examples.
82
Historian Server Requirements and Recommendations Wonderware System Platform Installation Guide
Note: Current space calculations are different than the calculations used by the classic
storage system.
83
Wonderware System Platform Installation Guide Historian Server Requirements and Recommendations
Discrete Tags 5
State Summary for String (10 states and 32 byte string) (1 + 32) * 10 = 330
84
Historian Server Requirements and Recomm endations Wonderware System Platform Installation Guide
For this example, if all are stored in the local storage engine and forwarded later, the number
of bytes required for every second is as follows:
1. 798 * 8 = 6384 Bytes
2. 815 * 5 = 4075 Bytes
3. 187 * 25 = 4675 Bytes
4. 800 * 37 / 60 = 493 Bytes
5. 800 * 37 / 3600 = 8 Bytes
6. 800 * 280 / 60 = 3733 Bytes
7. 800 * 280 / 3600 = 62 Bytes
BandwidthForwa rding = 1.04 * 8 * (6384 + 4075 + 4675 + 493 + 8 + 3733 + 62) = 162 Kbps
BandwidthRecommendedFor wardin g = 1.3 * 162 Kbps = 211 Kbps
Performance Considerations
For a complete Wonderware Historian system, the following components put a demand on
memory.
85
Wonderware System Platform Installation Guide Historian Server Requirements and Recommendations
Internal historian subsystems, such as the Configuration Manager, data acquisition, and
data storage
The associated Microsoft SQL Server
The operating system
Client access (data retrieval), which includes caching
When determining the amount of memory to purchase, remember that adding more memory
is the cheapest and easiest thing that you can do to improve performance. Increasing the
amount of memory reduces the amount the server has to use virtual memory, thus lowering
the load on the storage subsystem. Even if you have a large amount of memory, additional
memory is used as additional disk cache, speeding up disk access and therefore file service.
Also, processes needed by the server become faster because they are memory-resident.
A major factor in system performance is the amount of plant data you anticipate storing in the
system, including considerations about how often that data is stored and retrieved. In general,
the more you store, the more often you store it, and the more you retrieve it, the slower the
system. The major storage factors affecting the performance of the system are:
Effective analog flow rate (analog updates per second).
Period of online data storage required.
Effective discrete variable flow rate.
Number of concurrent end users required.
Complexity of end user queries.
Number and size of string tags, as well as the effective flow rate of string values.
Number and duration of string tag retrieval queries, as well as the frequency at which
these queries are executed.
A performance report for different historian systems is provided in System Sizing Examples
on page 90.
Server Loading
When a user connects to the Wonderware Historian with a client, configuration information is
immediately requested from the historian. This information includes the tags that the server
stores, their descriptions, engineering units, and other tag data. SQL Server reads this
information from the database (stored on disk) and places it in memory.
As the user selects time periods to trend, the historian reads data from files located on the
disk and prepares the results of the client's data request to be transmitted back to the client.
The ability of the server to quickly handle subsequent requests for data from the same client
and others is dependent on the server's ability to keep as much information in memory
without having to again access data from the disk.
As a higher load is placed for memory, a higher load is placed on the disk I/O system as the
server has to use disk caching and read from the data files.
The following table summarizes the loading for various systems.
86
Historian Server Requirements and Recommendations Wonderware System Platform Installation Guide
Acquisition and Base load of the historian. This load exists as long as the system is running.
storage However, this load is not affected by client activity.
Retrieval Variable loading caused by data ret rieval from client applications. When the
client initially connects, the data requested is configuration data, which is
stored in SQL Server. The historian requests data from SQL Server,
causing its loading to increase. As the client requests historical data, the
disk time increases as information from the data files is transferred to
memory. This continues as the client requests additional data. If the client
application requests data that has already been transferred to memory,
there is no associated disk activity and trans fer of data to memory.
The server must be able to adequately handle the variation on loading caused by the client
applications. To accomplish this, make sure that your hardware is sized so that it can handle
the base load created by the acquisition and storage systems and that there are adequate
resources still available for the retrieval system.
IDAS Performance
An IDAS can acquire an unlimited number of real-time data values, from an unlimited number
of I/O Servers, each with an unlimited number of topics. However, IDASs are subject to the
following limitations.
The maximum sustained data throughput for any single IDAS is 30,000 items per second
for real-time data. For late or old data, the maximum throughput is 9,000 items per
second. The total combined throughput (real-time data plus late or old data) cannot
exceed 30,000 items per second. For higher-volume applications, you can set up multiple
IDASs to serve a single storage subsystem.
The size of any data value is limited to 64,000 bytes.
The maximum number of tags supported by any single IDAS is 30,000.
Tiered Historians
If you are installing a tiered historian, tier-1 nodes use the same basic configuration for the
number and types of tags and data collection rates.
The tier 1 configuration should be "delta" data collected and stored:
12,000 analog tags every 2 seconds
2,900 discrete tags every 2 seconds
100 32-character string tags every 30 seconds
For the analog and discrete tags, the averages and value state aggregates are:
6000 tags with an hourly calculation performed at the top of each hour
6000 tags with 1-minute calculations performed at the top of each minute
plus
1500 tags replicated (not aggregated) in tier 2
1500 tags stored only in tier 1 (no aggregates or replication)
87
Wonderware System Platform Installation Guide Historian Server Requirements and Recommendations
Networking Recommendations
The Wonderware Historian is a highly configurable package that can be set up in many
different ways depending on your needs.
The historian can use any protocol currently supported by Microsoft SQL Server 2012. You
can use the default Microsoft SQL Server 2012 protocol (named pipes) with TCP/IP. TCP/IP
is required if SuiteLink™ is used.
Do not use the historian computer as a domain controller.
It is highly recommended that you run the historian on a dedicated computer. For example,
running the historian on a mail server or an Internet server may impact performance.
88
Historian Server Requirements and Recommendations Wonderware System Platform Installation Guide
Generally, it is recommended that you split the process and IS networks to ensure that the
process network does not become overloaded. The following illustration shows one possible
network architecture where the historian is the link between the process network and the
business LAN/WAN
For this architecture, install two network cards on a server computer and configure them to
segment the IS network from the process network.
Note: All tags to be stored in historian are on "advise" all the time. This may cause heavy
load conditions on the process network. Before you install the historian, investigate the
possible load impact of installing the historian on your network.
Client Access
All clients should connect to the Wonderware Historian using the default Microsoft SQL
Server connection. Usually, this means using the name of the computer on which the
historian is running as the server name when logging on.
To change the default network protocol used by Microsoft SQL Server to something other
than named pipes, configure the client network access using the SQL Server Client Network
Utility. For more information, see your Microsoft SQL Server documentation.
89
Wonderware System Platform Installation Guide Historian Server Requirements and Recommendations
90
Historian Server Requirements and Recommendations Wonderware System Platform Installation Guide
91
Wonderware System Platform Installation Guide Historian Server Requirements and Recommendations
Query Load
For the following seven queries, each are occurring at different times in the hour:
1 query (trend):
o live mode - 1 second update
o 1-hour duration
o 10 tags (7 analogs, 3 discretes)
1 query: 1-hour range / hour (1 tag)
4 queries: 15-minute range / hour (1 tag)
1 query: 24-hour report every 24 hours (25 to 30 tags)
Performance Results
Category Value
92
Historian Server Requirements and Recommendations Wonderware System Platform Installation Guide
Event Information
3 snapshot events, each having:
o 1 analog snapshot
o 1 discrete snapshot
o 1 string snapshot
2 summary events, each having:
o 1 AVG calculation (1 tag every 8 hours)
o 1 MAX calculation (1 tag every 8 hours)
o 1 MIN calculation (1 tag every 8 hours)
o 1 SUM calculation (1 tag every 8 hours)
1 SQL insert every 4 hours
2 SQL multi-point updates every hour
Query Load
For the following seven queries, each are occurring at different times in the hour:
1 query (trend):
o live mode - 1 second update
o 1- hour duration
o 10 tags (7 analogs, 3 discretes)
1 query: 1-hour range / hour (1 tag)
4 queries: 15-minute range / hour (1 tag)
1 query: 24-hour report every 24 hours (25 to 30 tags)
Performance Results
Category Value
93
Wonderware System Platform Installation Guide Historian Server Requirements and Recommendations
Category Value
94
Historian Server Requirements and Recommendations Wonderware System Platform Installation Guide
Event Information
3 snapshot events, each having:
o 1 analog snapshot
o 1 discrete snapshot
o 1 string snapshot
2 summary events, each having:
o 1 AVG calculation (1 tag every 8 hours)
o 1 MAX calculation (1 tag every 8 hours)
o 1 MIN calculation (1 tag every 8 hours)
o 1 SUM calculation (1 tag every 8 hours)
1 SQL insert every 4 hours
2 SQL multi-point updates:
o 1 every 15 minutes
o 1 every 30 minutes
Query Load
For the following seven queries, each are occurring at different times in the hour:
1 query (trend):
o live mode - 1 second update
o 15-minute duration
o 15 tags (10 analogs, 5 discretes)
1 query: 1-hour range / hour (1 tag)
4 queries: 15-minute range / hour (1 tag)
1 query: 24-hour report every 24 hours (25 to 30 tags)
Performance Results
Category Value
95
Wonderware System Platform Installation Guide Historian Server Requirements and Recommendations
96
Historian Server Requirements and Recommendations Wonderware System Platform Installation Guide
The 400 Kbps data transfer limit reflects a typical data transfer speed between remote
locations over the Internet. The data transfer from each tier-1 historian to a tier-2 historian is
assumed to be through a dedicated 400 Kbps connection; multiple tier-1 historians do not
share the same 400 Kbps connection. It is assumed that the 400 Kbps is a bandwidth that
can be fully used.
Tier 2 Historian Specifications
DELL PowerEdge 6800 with four dual-core Intel Xeon 3.4 GHz CPUs
16 GB RAM with enabled PAE or 4 GB RAM
Disk I/O subsystem of a 100MB/s throughput, 6 ms access time.
100/1000 Base-T network card
400 Kbps network connection (actual usable bandwidth)
Tier 1 Historian Specifications
DELL Precision WorkStation T5400 with dual processor quad-core Intel Xeon 2.7 GHz
CPUs
4 GB RAM
Disk I/O subsystem of a 60MB/s throughput, 16 ms access time.
97
Wonderware System Platform Installation Guide Historian Server Requirements and Recommendations
Latency Results
Category Value
Latency is the difference in time between when the value is received by the tier-1 historian
and when it is received by the tier-2 historian.
98
Historian Server Requirements and Recommendations Wonderware System Platform Installation Guide
100-Base T
Tier-1 Historians
(standard configurations)
Latency Results
Category Value
Latency is the difference in time between when the value is received by the tier-1 historian
and when it is received by the tier-2 historian.
100
Historian Server Requirements and Recommendations Wonderware System Platform Installation Guide
101
Wonderware System Platform Installation Guide Historian Server Requirements and Recommendations
Loading Information
In the tier-1 historian modem configuration, the tier-1 historian receives 3,000 tags from I/O
Servers of the following types with average update rate 300 items per second:
1,500 4-byte analog delta tags (1,400 always fitting the real-time window and 100 falling
outside of the real-time window being 50 minutes late)
1,350 1-byte discrete delta tags
150 variable-length string delta tags of 32 bytes each
Performance Results for the Tier-2 Historian
Category Value
Latency Results
Category Value
Latency is the difference in time between when the value is received by the tier-1 historian
and when it is received by the tier-2 historian.
102
Wonderware System Platform Installation Guide
C HAPTER 7
Historian Server Installation and
Configuration
In This Chapter
Preparing for the Wonderware Historian Installation ...................................................................... 103
Microsoft SQL Server Installation ................................................................................................. 104
Wonderware Historian Installation Features .................................................................................. 105
About the Wonderware Historian Installation ................................................................................. 105
Testing the Installation ................................................................................................................ 106
Antivirus Software....................................................................................................................... 106
Wonderware Historian Menu Shortcuts ........................................................................................ 107
Repairing the Wonderware Historian ............................................................................................ 107
Modifying the Wonderware Historian Installation ........................................................................... 107
Uninstalling the Wonderware Historian ......................................................................................... 107
Upgrading from a Previous Version.............................................................................................. 107
103
Wonderware System Platform Installation Guide Historian Server Installation and Configuration
You must have administrative rights on the local computer to install the historian. The account
with which you log on to the computer must also be a sysadmin for the SQL Server or you
must be able to provide a sysadmin account for the SQL Server when prompted for it during
the installation. For SQL Server 2008, computer administrators are not automatically added
as SQL Server sysadmins by default.
The installation program detects any previous versions of the historian and notifies you of
your migration options.
104
Historian Server Installation and Configuration Wonderware System Platform Installation Guide
Feature Description
Wonderware This option installs or re-installs the historian, configuration tools and
Historian selected subcomponents.
IDAS An IDAS, which can be used remotely. The IDAS is always installed if you
select to install a complete historian.
Configuration Tools The server management tools include Wonderware Historian Configuration
Editor and Wonderware Historian Management Console. Both of these
applications are MMC snap-ins that are contained in the System
Management Console. These tools are always installed on the same
computer as the historian and can also be installed on a different computer
on the network. The Wonderware Historian Database Export/Import Utility
is also an installed configuration tool.
ActiveE vent ActiveE vent is an ActiveX cont rol that allows you to notify the historian
classic event system when an event has occurred in another application,
such as InTouch HMI software.
InSight Client Wonderware Historian InSight is a browser client included with
Wonderware Historian. It is the on-premises version of Wonderware Online
InSight, and provides instant access to production and performance dat a.
Historian This option installs historian extensions for OData and SQL Server
Extensions Reporting Services (SSRS ).
Antivirus Software
After installing the Wonderware Historian, configure your antivirus software to prevent archive
files from being scanned. Also, antivirus software should not scan files in certain folders. For
a list of folder exclusions, see the Wonderware System Platform Readme file.
106
Historian Server Installation and Configuration Wonderware System Platform Installation Guide
107
Wonderware System Platform Installation Guide Historian Server Installation and Configuration
You should upgrade the Historian Server before upgrading Wonderware Historian remote
IDAS nodes. Remote IDAS nodes that are not upgraded to 2017 will remain fully functional.
However, it is strongly recommended that you upgrade them to 2017 to incorporate minor
improvements and simplify further upgrades and maintenance.
If you have been using replication, when upgrading historian nodes, upgrade the tier-2
historian node first and then the tier-1 historian node.
108
Historian Server Installation and Configuration Wonderware System Platform Installation Guide
5. If you re-create the database, existing Runtime database will not be re-named but will be
overwritten with a new Runtime database. If you do not re-create the database, the
existing database will remain intact.
6. Finish the installation of Wonderware Historian.
7. Restart the computer.
8. Start the Historian. The Historian will start acquiring and storing the store-and-forward
data from the existing remote IDASs.
9. After the Historian Server node is upgraded, you can upgrade any remote IDAS nodes.
109
Wonderware System Platform Installation Guide
C HAPTER 8
Historian Client Requirements
In This Chapter
About Wonderware Historian Client.............................................................................................. 111
Wonderware Historian Client Components ................................................................................... 111
Requirements and Recommendations .......................................................................................... 112
Support for Operating System Language Versions ........................................................................ 112
Desktop Applications
The Wonderware Historian Client software includes the following stand-alone applications:
Wonderware Historian Client Trend
Allows plotting of historical and recent data over time
Allows you to compare data over different time periods
Wonderware Historian Client Query
Allows you to query the Wonderware Historian database
Provides complex, built-in queries
Eliminates the need to be familiar with the database structure or SQL
111
Wonderware System Platform Installation Guide Historian Client Requirements
112
Wonderware System Platform Installation Guide
C HAPTER 9
Historian Client Installation and
Configuration
The Wonderware System Platform installation program allows you to install the Wonderware
Historian Client software. The Wonderware System Platform installation program copies the
files from the setup DVD to the target computer.
For more information on the components installed, see Wonderware Historian Client
Components on page 111.
In This Chapter
About the Wonderware Historian Client Installation ....................................................................... 113
Using Wonderware Historian Client Soft ware with Roaming P rofiles .............................................. 114
Repairing the Wonderware Historian Client Installation .................................................................. 114
Uninstalling Wonderware Historian Client ..................................................................................... 114
Upgrading from a Previous Version.............................................................................................. 114
113
Wonderware System Platform Installation Guide Historian Client Installation and Configuration
After the Wonderware Historian Client software is installed on the computer, you must install
the Language Packs manually.
114
Historian Client Installation and Configuration Wonderware System Platform Installation Guide
3. Locate SQL scripts that you'll need for intermediate migration in this folder:
C:\ProgramData\ArchestrA\Historian\Install\Scripts
4. From SQL Server Management Studio:
a. Drop the Runtime database.
b. Restore a backup of the Runtime from your previous version of Historian.
5. Disable any triggers or constraints that would prevent schema changes. This prepares
your database for changes.
6. Run the scripts you need to update Historian 2017.
If you are upgrading from a much older version, you may have to run scripts to
incrementally upgrade versions.Run the scripts in the order they appear (when sorted
alphanumerically).
7. Restore any changes (triggers and other constraints) that you made to settings in step #5.
8. Shut down the old server's remote IDAS.
9. From the new server, force an update to the remote IDAS configuration.
115
Wonderware System Platform Installation Guide
A PPENDIX A
Using Silent Installation
Wonderware System Platform supports silent (command line) installation. This feature
enables you to install Wonderware System Platform products without user interaction.
Important: If prerequisite software is required for the Wonderware System Platform
products you are installing, all prerequisites must be installed before starting silent
installation.
Prerequisite software includes .NET Framework and SQL Server. Details about prerequisite
software is provided in Wonderware System Platform Prerequisites on page 15. See SQL
Server Requirements on page 53 for additional information about supported versions of SQL
Server.
Setup.exe is run from the command line and accepts as an argument the name and path of a
response file containing pre-scripted responses to Wonderware System Platform installation
prompts.
Important: Use silent installation only to install a new system or upgrade an existing one.
Modifying a previously installed system, that is, adding or removing components at the same
release level, is not supported through silent installation. However, you can add components
as part of an upgrade to a higher release level. Removing components during an upgrade is
NOT supported.
In This Appendix
Starting Silent Installation ............................................................................................................ 117
Using Response Files ................................................................................................................. 118
Response File Samples .............................................................................................................. 119
Configuring the License Server .................................................................................................... 122
117
Wonderware System Platform Installation Guide Using Silent Installation
The /silent switch completely disables the graphical user interface of Setup.exe. There is no
input from or feedback to the end user. However, the installation will output progress to a log
file. The log is usually found here:
C:\Program Files (x86)\Common Files\ArchestrA\Install\
{<FolderName>}\ILog<timestamp>.log
Silent installation with minimal GUI syntax:
D:\setup.exe /MINGUI <path\response-file-name>
Running setup with the /MINGUI switch will cause setup to install without any input from the
end user, but it will display the progress of the installation on screen.
Silent installation command-line help:
D:\setup.exe /?
Running setup with the /? switch will display the silent installation command-line help.
118
Using Silent Installation Wonderware System Platform Installation Guide
Historian Client Node.txt Installs the components required to connect to an existing Historian
Server, analyze the dat a, and provide ArchestrA object server run-
time components. Components include:
Bootstrap
Historian Client
Historian Server Node.txt Installs the components required to host a Historian server, analyze
the data with a Historian Client, and provide ArchestrA object
server run-time components. Components include:
Bootstrap
Historian Server with IDAS, configuration tools and extensions
Historian InSight
InTouch Alarm DB Logger
119
Wonderware System Platform Installation Guide Using Silent Installation
120
Using Silent Installation Wonderware System Platform Installation Guide
121
Wonderware System Platform Installation Guide Using Silent Installation
122
Wonderware System Platform Installation Guide
A PPENDIX B
Single Product Installation
You can create an alternative installation media source if you are installing only Historian,
Historian Client, or the Application Server runtime, and you want to reduce network usage.
This alternative installation source will be much smaller than the full set of installation files,
and thus will be easier to send to remote locations. This is of particular value if your network
connection to the remote site is slow or unreliable, and any of the following, or similar
circumstances, apply:
You have multiple nodes at a remote site on which you want to install only Historian,
Historian Client, or the Application Server runtime.
A firewall at the remote site restricts most off-site access, and having a local copy of the
installation files is easier to manage than having to modify the firewall.
Installing from a WAN-based share is impossible due to the speed or reliability of the
network connection.
With this procedure, you will:
1. Create a new installation source that contains a subset of the installation files contained
on the Wonderware System Platform installation DVD.
2. Install Historian, Historian Client, or the Application Server runtime from this subset of
files.
Copying the files, rather than installing from a remote location, eliminates the possibility of a
time-out during installation.
In This Appendix
Guidelines for Creating a Compact Installation Source .................................................................. 123
Preparation for Installing a Single Product .................................................................................... 124
Creating the Installation Source and Installing the Selected Component ......................................... 126
123
Wonderware System Platform Installation Guide Single Product Installation
When you run the installation program, components that were deleted will show as disabled
(grayed-out) and unavailable for selection.
InTouch
InstallFiles Folder Folder Size Hi storian Application (Run time only
(Component) (approx) Hi storian Client Server or run time and
development)
CD-ADS 6 MB
CD-ApplicationServer 1.5 GB
CD-ASBFramework 61 MB
CD-Gateway 50 MB
CD-Historian 491 MB
CD-HistorianClient 53 MB
124
Single Product Installation Wonderware System Platform Installation Guide
InTouch
InstallFiles Folder Folder Size Hi storian Application (Run time only
(Component) (approx) Hi storian Client Server or run time and
development)
language]
CD-LicAPI 56 MB
CD-Licensing 62 MB
CD-NGVisualization 171 MB
CD-OIEngine 62 MB
CD-OIGA TEWAY 16 MB
CD-Server 47 MB
External 3 MB
Redist 1.2 GB
The Redist folder contains SQL Server Express in subfolder SQL2014EXPRSP2. If you are installing Historian Client or the
Application Server runtime, or if you installing Historian and the target system already has a supported version of SQL
Server, you can remove the SQL Server Express subfolder. See SQL Server Requirements on page 53 for information about
supported versions of SQL Server.
Note: If .NET version 4.5.1 or higher is already installed on the target system, you can remove the DOTNET folder from
Redist.
MDAC 5 MB
MSI4.5 6 MB
PreReqInstaller 0 MB
Safenet 8 MB
VC10SP 1 18 MB
125
Wonderware System Platform Installation Guide Single Product Installation
InTouch
InstallFiles Folder Folder Size Hi storian Application (Run time only
(Component) (approx) Hi storian Client Server or run time and
development)
VC90SP 1 4 MB
VC2012U4 13 MB
VC2013U4 13 MB
ResponseFiles 0 MB
Support 0.2 MB
UpgradeSupport 38 MB
Note: The Redist folder contains SQL Server Express in folder SQL2014EXPRSP2. If you
the products you are installing do not need SQL Server, or if the target system already has a
supported version of SQL Server, you can remove the SQL Server Express subfolder. See
SQL Server Requirements on page 53 for information about supported versions of SQL
Server.
126
Single Product Installation Wonderware System Platform Installation Guide
Now you are ready to install or upgrade the product(s) using either of the methods
described below.
To install or upgrade a single product
Direct installation from the copy location (install locally or on a different network node):
1. Remove the original Wonderware installation DVD from the drive.
Important: When you run setup.exe, it checks for the Wonderware DVD. If the
Wonderware DVD is available, it will be used instead of the copy location.
2. Navigate to the copy location.
3. Make sure you have deleted the folders you do not need.
4. Run setup.exe. Components that were deleted will be grayed-out and unavailable for
installation.
5. If this is a new installation (not an upgrade), select the target location when you are
prompted.
Installation from a CD or DVD:
1. Create a CD or DVD from the copy location after deleting the folders you do not need.
2. Run setup.exe from the CD/DVD on each node. Components that were deleted will be
grayed-out and unavailable for installation.
127
Wonderware System Platform Installation Guide
Index
configuring products • 32
1
16 Pen Trend • 23 D
database
A configuring • 33
A2ALMDB database • 75 disk space requirements • 75
aaAdministrators group • 47 disk sizing • 74
aaConfigSQL • 48 disk space
aaGalaxyOwner user account • 47 history blocks • 76
acquistion planning • 75
loading • 81
ActiveEvent • 98
ActiveX and .NET Controls • 104
E
Enhanced Security Mode • 48
aaHistClientQuery • 104
event data
aaHistClientTrend • 104
migrating from older versions • 102
Antivirus Software • 100
Application Server
hardware requirements • 56 F
fault-tolerant servers • 73
user account requirements • 22
ArchestrA user account
requirements for use with Application G
Server • 22 Galaxy database, migrating • 58
ASBService • 51 Galaxy Repository
ASBSolution • 51 upgrading • 57
upgrading with the Bootstrap • 55
B upgrading with the Bootstrap and IDE •
Bootstrap 55
upgrading • 55
building block controls H
aaHistClientTagPicker • 104 hardware recommendations
aaHistClientTimeRangePicker • 104 storage • 75
Historian Client • 103
C Historian Database Export/Import Utility
Change Network Account utlity • 47 requirements • 73
common components • 64, 99 history blocks
configuration utility • 33 disk space requirements • 76
129
Wonderware System Platform Installation Guide Index
130
Index Wonderware System Platform Installation Guide
Workbook • 103
Wonderware System Platform • 23
132