WSP Install Guide v2014
WSP Install Guide v2014
WSP Install Guide v2014
Wonderware System
Platform Installation
Guide
12/3/14
All rights reserved. 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 Invensys Systems, Inc. No copyright or patent liability is assumed with respect
to the use of the information contained herein. Although every precaution has been taken in the
preparation of this documentation, the publisher and the author assume no responsibility for errors or
omissions. Neither is any liability assumed for damages resulting from the use of the information
contained herein.
The information in this documentation is subject to change without notice and does not represent a
commitment on the part of Invensys Systems, Inc. The software described in this documentation is
furnished under a license or nondisclosure agreement. This software may be used or copied only in
accordance with the terms of these agreements.
Contents
Chapter 1
Chapter 2
Contents
Chapter 3
Chapter 4
Chapter 5
39
40
41
41
42
43
47
49
51
52
55
58
60
61
61
62
63
63
63
64
65
66
67
68
69
70
70
Contents5
Chapter 6
71
72
73
73
74
74
76
76
78
79
79
80
81
82
82
83
84
84
84
86
88
90
91
91
94
96
100
101
102
103
107
108
108
108
Contents
Chapter 7
Chapter 8
114
114
114
115
115
115
Chapter 9
109
109
109
110
110
111
117
118
118
119
119
122
123
123
124
125
125
125
125
126
126
127
Contents7
Chapter 10
130
130
131
133
136
136
138
140
141
141
142
143
143
143
144
144
146
148
150
151
152
154
155
155
158
159
160
160
160
161
161
Contents
Appendix A
Appendix B
165
166
167
168
169
169
172
172
172
175
175
Index..................................................... 177
Chapter 1
Wonderware System Platform
Installation
Missing prerequisites are listed with the status "not met" and
highlighted in yellow. Pre-existing software that is incompatible with
components being installed is listed with the status "incompatible" and
highlighted in red.
Start setup.exe.
If you select the Product Based Selection option, then the product
based installation dialog box appears.
Select the check boxes to indicate which products or roles you want
to install, and then click Next. The verify selection dialog box
appears.
If you select InTouch features, you need to select a language for the
InTouch installation. The localized InTouch versions are supported
only in the paired operating system. 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.
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.
Type the user name and password for the existing account. The
account must meet the following requirements:
Configuring Products
Some products require post-installation configuration for initial setup.
You need to configure your products using the Configurator dialog box
after you have installed them. The Configurator dialog box lists all
product components that you have installed. You can configure the
locations for the product database and the data files.
You must have sysadmin permissions to configure products using the
Configurator.
Note: You need to configure the products only if you have installed
Wonderware Historian Server or Wonderware Information Server.
To configure products
1
On the left pane, select the component and configure the details on
the right pane.
Note: The installed programs may not function properly until you
restart the system.
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.
Note: When you apply a patch, the product version number
increments in Windows Add or Remove Programs (Uninstall or
Change a Program in Windows 7 and Windows 2008). If you install a
new feature from the original media, the product version will revert to
the original installation version. You must re-apply the patch each time
you install a new feature.
To modify an installation
1
Modifying an Installation27
Click the Modify option, and then click Next. The list of
Wonderware System Platform components appears.
Select or clear the components that you want to add or remove, and
then click Next. The verify change dialog box appears.
Click Finish.
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 Repair option, and then click Next. The Confirm Repair
dialog box appears.
Click Finish.
Click the Remove option, and then click Next. The confirmation
dialog box appears.
Click Finish.
Insert the DVD into your DVD-ROM drive. Run setup.exe to start
the set-up program. The upgrade feature dialog box appears.
Note: You can only upgrade the products that are already installed
and you will not be able to install new products that have an upgrade
process. The installed components that need to be upgraded are
selected and disabled. You can neither clear these check boxes nor
select more components during the upgrade.
2
Click Finish.
31
Chapter 2
Application Server
Requirements and
Prerequisites
In the results pane, verify that, under the State column, Running
appears next to the name of each service.
If Stopped appears, right-click the name of the service, and click
Start.
In the results pane, verify that, under the Status column, Enabled
appears next to the name of the TCP/IP protocol.
If Disabled appears, right-click TCP/IP, and then click Enable.
In the results pane, verify that, under the Status column, Enabled
appears next to the name of the TCP/IP protocol.
If Disabled appears, right-click TCP/IP, and then click Enable.
37
Chapter 3
Application Server Upgrade
For specific versions of the Application Server that you can upgrade to
version 2014 R2, see the Wonderware System Platform Readme file.
Important: Ensure that you have installed the latest patch for your
existing version, wherever possible, before upgrading to the latest
version. Also, only systems that meet the minimum system
requirements, including operating system and SQL Server version, can
be upgraded.
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 WinPlatform object is removed and
upgraded to version 2014 R2.
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.
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.
Run Setup.exe from the DVD. The Welcome dialog box appears.
Click Next. Review the recommended steps before you upgrade and
take appropriate action, if needed.
Click Next. Review the status of objects deployed in the system and
take appropriate action, if needed.
Click Next. The Prerequisites dialog box appears. You can select
the Show All check box to view all prerequisites.
Click the prerequisite whose status is "Not Met", and then click
Install Prerequisites. The general system prerequisites are
installed.
On the IDE node, run Setup.exe from the DVD. The Welcome
dialog box appears.
Click Next. The Prerequisites dialog box appears. You can select
the Show All check box to view all prerequisites.
Click the prerequisite whose status is Not Met, and then click
Install Prerequisites. The general system prerequisites are
installed.
The IDE you use to migrate the database must be the current
version.
Run Setup.exe from the DVD. The Welcome dialog box appears.
Click Next. Review the status of objects deployed in the system and
take appropriate action, if needed.
Deploy the platform and all hosted objects to the run-time node.
Step
Action
Resulting
State
(Initial
state)
Deployed.
Upload
run-time
changes
Changes
made at
run-time
now stored
in the
database.
Node B
Primary AppEngine (E1)
Platform 1 (P1)
Action
Resulting
State
E1
Deployed
Active.
Node C
Backup AppEngine (E1b)
Platform 2 (P2)
Action
Resulting
State
E1b
Deployed
Standby.
Node A
GR
Platform 0 (P0)
Step
Action
Resulting
State
Upgrade
(with
AppServer
deployed
but shut
down)
All objects
on P0
become
undeployed.
Reboot
(when
prompted)
Software is
now at v2.
Open IDE
and
migrate
database
Galaxy
database
now at v2.
Node B
Primary AppEngine (E1)
Platform 1 (P1)
Action
Resulting
State
Node C
Backup AppEngine (E1b)
Platform 2 (P2)
Action
Resulting
State
Upgrade
(with
AppServer
deployed
but shut
down)
P2 and its
hosted
engines and
objects
become
undeployed.
IDE shows
P1 and P2
in SUP
state.
5
Optional:
Open and
migrate
InTouch
ViewApps
InTouch
ViewApps
now at v2.
Cascade
deploy P0
All objects
on P0 are
deployed.
Node A
GR
Platform 0 (P0)
Step
Action
Resulting
State
Node B
Primary AppEngine (E1)
Platform 1 (P1)
Action
Resulting
State
Node C
Backup AppEngine (E1b)
Platform 2 (P2)
Action
Cascade
Deploy P2
E1 becomes
undeployed.
E1 shows as
undeployed,
but objects
under E1
show as
deployed.
Upgrade
(with
AppServer
deployed
but shut
down)
P1 becomes
undeployed.
10
Cascade
Deploy P1
E1 is
deployed as
part of P1
deployment.
E1 starts as
standby and
fully syncs
with active
engine.
(Final
state)
Deployed.
E1
Deployed
Standby.
Note:
This action
results in a
brief
downtime
for objects
on E1 and
E1b as E1
becomes
undeployed
(a few
seconds to a
few
minutes,
depending
on number
of objects).
Resulting
State
E1b
becomes
active,
hosted
objects are
now
running
under v2.
Note: E1b
does NOT
start from
the checkpointed state
of nonupgraded E1
No downtime for
objects on
E1b as E1b
continues to
run as
active.
E1b
Deployed
Active.
Behavior
Cascade deploy a
Platform after upgrade
Deploy a redundant
engine with a partner
in the SUP state.
Multi-selection for a
cascade deployment
includes a redundant
engine with a partner
in SUP state
Select a backup
redundant partner
engine for deployment
Action or State
Behavior
Partner engine is
deployed but not
reachable or not ready
to synch.
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.
49
Chapter 4
InTouch HMI Requirements
and Prerequisites
A clean system
I want to...
Install Wonderware
System Platform 2014 R2
with InTouch 11.1 and
FS Gateway 3.0 SP1
FS Gateway is
FS Gateway is
preconfigured with a
predefined OPC access
Name.
preconfigured with a
predefined OPC access
Name.
FS Gateway appears in
Add/Remove Programs.
FS Gateway 2.0.0 or
previous installed
(Stand-alone)
Existing FS Gateway
Configuration is retained.
a hidden feature.
InTouch appears in
Add/Remove Programs.
Existing FS Gateway
Configuration is retained.
FS Gateway is upgraded.
InTouch is installed.
FS Gateway appears in
FS Gateway is installed as
Add/Remove Programs.
a hidden feature.
FS Gateway is upgraded.
FS Gateway appears in
Add/Remove Programs.
InTouch appears in
Add/Remove Programs.
InTouch 10.0.0 or
previous installed
FS Gateway is
preconfigured with a
predefined OPC access
Name.
FS Gateway is
preconfigured with a
predefined OPC access
Name.
a hidden feature.
FS Gateway appears in
InTouch is upgraded.
Add/Remove Programs.
InTouch appears in
Add/Remove Programs.
InTouch appears in
Add/Remove Programs.
I have...
FS Gateway 2.0.0
(Stand-alone) or previous
and InTouch 10.0.0 or
previous
I want to...
Install Wonderware
System Platform 2014 R2
with InTouch 11.1 and
FS Gateway 3.0 SP1
Existing FS Gateway
Existing FS Gateway
Configuration is retained.
Configuration is retained.
FS Gateway is upgraded.
FS Gateway is upgraded.
FS Gateway appears in
InTouch is upgraded.
Add/Remove Programs.
InTouch appears in
Add/Remove Programs.
FS Gateway appears in
Add/Remove Programs.
InTouch appears in
Add/Remove Programs.
FS Gateway 2.0.1
Stand-alone
Existing FS Gateway
Existing FS Gateway
Configuration is retained.
Configuration is retained.
FS Gateway is upgraded.
FS Gateway is installed as
FS Gateway appears in
Add/Remove Programs.
a hidden feature.
InTouch is installed.
FS Gateway appears in
Add/Remove Programs.
InTouch appears in
Add/Remove Programs.
Wonderware System
Platform 2012 with
InTouch 10.5 and
FS Gateway 2.0.1
Existing FS Gateway
Configuration is retained.
FS Gateway is installed as
a hidden feature.
InTouch is upgraded.
InTouch appears in
Add/Remove Programs.
I have...
FS Gateway 3.0.0
Stand-alone
I want to...
Install Wonderware
System Platform 2014 R2
with InTouch 11.1 and
FS Gateway 3.0 SP1
FS Gateway is
Existing FS Gateway
preconfigured with a
predefined OPC access
Name.
Configuration is retained.
InTouch is installed.
a hidden feature.
FS Gateway appears in
Add/Remove Programs.
InTouch appears in
Add/Remove Programs.
Wonderware System
Platform 2012 R2 with
InTouch 10.6 and
FS Gateway 3.0.0
Existing FS Gateway
Configuration is retained.
Existing FS Gateway
Configuration is retained.
FS Gateway appears in
Add/Remove Programs.
InTouch appears in
Add/Remove Programs.
FS Gateway is installed as
a hidden feature.
FS Gateway appears in
Add/Remove Programs.
InTouch appears in
Add/Remove Programs.
I want to...
Uninstall
Stand-alone
FS Gateway
FS Gateway 3.0.0
Stand-alone installed
Uninstall WSP
2014 InTouch
Uninstall Both
FS Gateway is
removed.
FS Gateway
does not appear
in Add/Remove
Programs.
N/A
N/A
FS Gateway is
Wonderware System
Platform 2012 R2 with
InTouch 10.6 and
FS Gateway 3.0.0 installed
removed
InTouch is
N/A
removed
InTouch does
N/A
not appear in
Add/Remove
Programs.
I have...
I want to...
Uninstall
Stand-alone
FS Gateway
Uninstall WSP
2014 InTouch
Uninstall Both
FS Gateway
InTouch is
FS Gateway is
removed
InTouch is
removed
FS Gateway
does not appear
in Add/Remove
Programs.
InTouch does
not appear in
Add/Remove
Programs.
Both Wonderware System
Platform 2014 with
InTouch 11 and
FSGateway 3.0 SP1
installed
FS Gateway is
removed
InTouch is
N/A
removed
InTouch does
not appear in
Add/Remove
Programs.
N/A
57
Chapter 5
Historian Server
Requirements and
Recommendations
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.
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.
Operating Systems
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. The requirements are:
Processor:
Minimum: P4 3.2 GHz CPU
Server Requirements59
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:
Minimum: P4 3.0 GHz dual CPU
Recommended: quad-core CPU
RAM:
Minimum: 4 GB
Recommended: 8 GB
1 Gbps network interface card (NIC)
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:
Minimum: P4 2.7 GHz Xeon quad CPU
Recommended: dual processor, quad-core CPUs
RAM:
Minimum: 6 GB
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:
Recommended: two quad-core CPUs
RAM:
Minimum: 24 GB
Recommended: 48GB
1 Gbps network interface card
A performance report for different historian systems is provided in
"System Sizing Examples" on page 88.
Tag Type
Analog - Integer
34
34
Analog - Double
12
38
Discrete
31
String
5+AvgStringLength
(5+AvgStringLength)+26
Analog Summary
37
63
40
66
28*NumberOfStates
(28*NumberOfStates)+26
(28+AvgStringLength)*
NumberOfStates
((28+AvgStringLength)*
NumberOfStates)+26
Alarm
325
6061
Acknowledgement
325
6066
Event
300
5048
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.
Tag Type
5+32 = 37
(5+32)+26 = 63
28*10 = 280
71*10 = 710
Tag Type
20*2 = 40
68*2 = 136
(1+32)*10 = 330
(69+32)*10 = 1010
Rate * Transmission
Simple Replication - 187 string tags (20 bytes string) every second.
The average number of bytes transmitted every second for each of the
above replication types is as follows. For a table of transmission sizes,
see "Storage and Network Transmission Sizes for Tags" on page 68.
1
Discrete Tags
37
37
28 * 10 = 280
20 * 2 = 40
(1 + 32) * 10 = 330
Performance Considerations71
Performance Considerations
For a complete Wonderware Historian system, the following
components put a demand on memory.
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.
System
Load Description
Acquisition
and storage
Retrieval
Performance Considerations73
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.
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:
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.
Networking Recommendations75
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.
Licensing
Use the Invensys License Manager to manage licenses and associated
feature lines.
The historian allows functionality based on the presence of a valid
license file and/or feature lines. The historian checks that:
Licensing77
Licensing79
If this feature line is locked to a hardware key and you have removed
the key from the historian computer, the Historian_TagCount license
is automatically released. If you reattach the hardware key, the
historian reacquires the license and automatically tries to reacquire
the Historian_TagCount feature line. This effectively means that data
collection continues uninterrupted all the time. However, retrieval is
limited by the last week until the Historian_Tagcount feature line is
acquired again and retrieval is limited to 32 tags and seven days. This
behavior applies not just to hardware key removal, but for all cases
when the Historian_Tagcount feature line has been initially acquired
successfully, but then suddenly was lost (for example, expired).
The historian will not acquire data for tags belonging to the IDAS that
is not licensed.
The remote IDAS count is adjusted at run time, without requiring a
historian restart.
If the remote IDAS count license changes (typically, if you substitute a
different license file), you must manually refresh the license
information using the System Management Console. If the remote
IDAS count increases, the historian starts acquiring and storing data
for the additional remote IDAS(s), if they exist in the database, with
their associated I/O servers, topics, and tags.
If the remote IDAS count decreases during reconfiguration or startup,
the historian stops acquiring and storing data for all tags assigned to
remote IDAS n+1 and higher, where n denotes the remote IDAS count,
and removes the corresponding IDAS, I/O servers and topics from
displays in the System Management Console, and so on.
If, after successful acquisition, the license has been lost during run
time (for example because of a hardware key removal or license
expiration), the data collection remains unaffected.
All IDASes may be configured for failover, including the local IDAS.
This means that IDAS potentially has to be physically installed on
more computers than there are actual entries for IDASes in the
configuration database. The remote IDAS licensing behavior remains
as follows in terms of the IDAS failover:
The local IDAS is counted only one time, even if it has a failover
node configured. At run time, the failover IDAS (which by
definition has to be on a remote node), will not run unless a valid
license for at least one remote IDAS is present.
If the feature line is present, all CSV file import operations, as well
as SQL inserts and updates, are permitted.
Licensing81
German
French
Japanese
Simplified Chinese
DELL OptiPlex 755 with 2.4 GHz single processor quad-core CPU
4 GB RAM
512 MB Virtual Memory
1 Gbps NIC
Microsoft SQL Server 2008 SP3 Standard Edition
SQL memory clamped @ 512 MB
12-hour history block duration
Tag Information
None.
Event Information
For the following seven queries, each are occurring at different times
in the hour:
1 query (trend):
live mode - 1 second update
1-hour duration
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
1.896
714
18
1002
4 GB RAM
3072 MB Virtual Memory
1 Gbps NIC
Microsoft SQL Server 2008 SP3 Standard Edition
SQL memory clamped @ 1024 MB
4-hour history block duration
Tag Information
Remote IDAS
P4 1.7 GHz
1 GB RAM
34,000 tags via the remote IDAS and the rest via the local IDAS
Note: Because this configuration was used for performance and stress
testing, the remote IDAS tag count is more than the recommended
30,000 maximum.
Event Information
For the following seven queries, each are occurring at different times
in the hour:
1 query (trend):
live mode - 1 second update
1- hour duration
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
5.38
1174
20
4.12
DELL PowerEdge 6800 with four dual-core Intel Xeon 3.4 GHz
CPUs
16 GB RAM
4096 MB Virtual Memory
1 Gbps NIC
Microsoft SQL Server 2008 SP3 Standard Edition
SQL memory clamped @ 3967 MB
2-hour history block duration
Tag Information
Remote IDAS
For the following seven queries, each are occurring at different times
in the hour:
1 query (trend):
live mode - 1 second update
15-minute duration
15 tags (10 analogs, 5 discretes)
1 query: 1-hour range / hour (1 tag)
Value
10
360
10
1.81
48 GB RAM
48 GB Virtual Memory
1 Gbps NIC
Windows Server 2012 Data Center Edition
Microsoft SQL Server 2012 SP1 Standard and Enterprise
SQL memory clamped @ 4096 MB
1-hour history block duration
Tag Information
1 query (trend):
live mode - 1 second update
Wonderware System Platform Installation Guide
15-minute duration
500 tags (250 analogs, 225 discretes, 25 strings)
Performance Results
Category
Value
26.444
11,124
246
10.00
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
4 GB RAM
Disk I/O subsystem of a 60MB/s throughput, 16 ms access time.
100/1000 Base-T network card
Loading Information
Assume that the total tag count on the tier-1 historian is 15,000.
The tier-1 historian receives 15,000 tags from I/O Servers of the
following types and data rates:
Value
1%
3.05 GB
312
888 MB
Latency Results
Category
Value
10.33 hours
Simple replication
4 seconds
Summary replication
4.6 seconds
Tier-2 Historian
Tier-2 Historian
100-Base T
Tier-1 Historians
(standard configurations)
DELL PowerEdge 6800 with four dual-core Intel Xeon 3.4 GHz
CPUs
4 GB RAM
Disk I/O subsystem of a 60MB/s throughput, 16 ms access time.
100/1000Base-T network card
Loading Information
Assume that the total tag count on the tier-1 historian is 15,000.
The tier-1 historian receives 15,000 tags from I/O Servers of the
following types and data rates:
Value
1.55%
3.3 GB
312
888 MB
Latency Results
Category
Value
9.92 hours
Simple replication
1.65 seconds
Summary replication
1.51 seconds
Tier-2 Historian
56 Kbps
Tier-1 Historian
(modem configuration)
4 GB RAM
Disk I/O subsystem of a 60MB/s throughput, 16 ms access time.
100/1000Base-T network card
56K modem
Tier 1 Historian Specifications
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)
Value
1%
1.86 GB
30
43 MB
Latency Results
Category
Value
n/a
Simple replication
5 seconds
Summary replication
n/a
99
Chapter 6
Historian Server Installation
and Configuration
As you select the path to the data files, you must consider that the
historian Runtime database will grow, especially if you are going to
use the event subsystem (including summaries) or storing data in
the ManualAnalog, ManualDiscrete, or ManualString tables.
For obvious security reasons, you should not use a blank password
for Microsoft SQL Server.
Description
Wonderware
Historian
IDAS
Configuration
Tools
ActiveEvent
Checks for required disk space based on the features that you
select.
The Legend box shows the status indicators. The status indicators
are:
Error
Not Configured
not configured.
Warning
warnings.
Configured
successfully.
Not Installed
Data Path
If the database is created for the first time, then this option is not
available. When re-configuration 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 would not
be dropped, but will be configured for changes, if any.
4
In the Alarms & Events Storage area, configure how you want to
store alarm and events.
Important: If you want to later change this setting after the Historian
is running, you must first shut down and disable the historian using the
Management Console. After making the change, you can then restart
and enable the historian.
Traditional
If you have larger storage needs for alarms and events, you can
select this option to store alarm and event data to the history
blocks. Storing alarms and events in history blocks provides the
following advantages:
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 using 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 using OData, see the
Wonderware Historian Concepts Guide.
5
In the SQL Login Information area, you can log on to the SQL
Server if you have the "sysadmin" privileges enabled. You can click
Windows Authentication to use the interactive users account or
click SQL Server Authentication and provide the credentials as
required. This connection information is not stored and is used
only for completing the configuration.
When you click Connect, the connection to the SQL Server is
tested.
10 After the system finishes running the SQL scripts, the Historian
node and Historian Server node are shown with a green status
indicator if the database is successfully configured.
11 Click All Messages to see all the configuration messages.
12 Click Close to exit the Configurator.
Start the storage system and check that the system is receiving
data from the system tags.
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.
Data Import
Database Configuration Export and Import
Historian Books Online
Migrate A2ALMDB
Wonderware Historian
In addition, the shortcut to the System Management Console appears
in the Start\All Programs\Wonderware folder.
Note: If you performed a complete historian installation, the System
Management Console is configured so that the local SQL Server is
already registered. However, if you only installed the client tools, the
console is empty.
If you are upgrading from Wonderware System Platform 2014 and are
using the Wonderware Historian for alarm and events (instead of
Alarm DB Logger), then you should also upgrade the Historian server
first. Otherwise, the alarm and event history for an AppEngine
upgraded to 2014 R2 will be collected as store-and-forward data until
you upgrade the Historian server. Note that there are no such
limitations for process history when upgrading from ArchestrA System
Platform 2012 R2 or Wonderware System Platform 2014.
If you have been using replication, when upgrading historian nodes,
upgrade the tier-2 historian node first and then the tier-1 historian
node. A tier-1 node running Wonderware Historian 2014 R2 cannot
replicate to a tier-2 node running Wonderware Historian 2014 or
earlier.
Start the Historian. The Historian will start acquiring and storing
the store-and-forward data from the existing remote IDASs.
After the Historian Server node is upgraded, you can upgrade any
remote IDAS nodes.
113
Chapter 7
Historian Client
Requirements
Desktop Applications
The Wonderware Historian Client software includes the following
stand-alone applications:
Wonderware Historian Client Trend
English
French
German
Japanese
Simplified Chinese
Note: The SQL Server locale language must be the same as the
operating system locale language.
117
Chapter 8
Historian Client Installation
and Configuration
121
Chapter 9
Information Server
Requirements and
Recommendations
Software Requirements
You must install the following software on the web server computer
before installing Wonderware Information Server. For details
regarding the specific versions of required and supported software
prerequisites, see the Readme file.
Check the Microsoft web site for updates and patches that you may
need to install.
Check the Microsoft web site for updates and patches that you may
need to install.
Exclude TCP Port 1433 and Port 80 from the Windows firewall on
the remote SQL Server computer.
Wonderware Information Server can be used with a case-sensitive or
case-insensitive SQL Server database.
If you want to use the ArchestrA Reporting Services feature of
Wonderware Information Server, you must install SQL Server
Reporting Services on the Wonderware Information Server portal
computer. It is best to select Reporting Services as part of the original
SQL Server installation, rather than to try to add it later.
Insert the SQL Server installation CD into the DVD drive. The
SQL Server Installation Center window appears.
In the right pane, click to start the new SQL Server stand-alone
installation wizard.
10 Continue with the default settings in the Collation tab. The default
appears.
requirements.
16 After the installation completes, verify that the SQL Server is
.NET Extensibility
ASP
ISAPI Filters
Default Document
Directory Browsing
HTTP Errors
HTTP Redirection
Static Content
WebDAV Publishing
ISAPI Extensions
ASP.NET
HTTP Logging
Request Monitor
Request Filtering
Windows Authentication
11 After you enable the required features, start the World Wide
In the left pane of Server Manager, select the node that represents
the server you are currently working on.
In the right pane, expand Roles Summary and click Add Roles.
The Add Roles Wizard appears.
Click Next. The wizard moves to the Select Server Roles step.
Select the Web Server (IIS) check box and click Next. The next
wizard step that appears is information that guides you in the
installation.
Click Next. The wizard moves to the Role Services step. A list of
available role services is displayed. If you click the name of a role,
a short description of the role is displayed.
In Server Manager, under the Roles node, select the Web Server
(IIS) role.
In the Role Services section, click Add Role Services. The Add
Role Services wizard appears.
In the System Service section, make sure that the World Wide
Web Publishing Service is running.
If the service is not running, start it.
Under the Manage menu, select Add Roles and Features. The Add
Roles and Features Wizard appears.
Select the server on which you want to install these roles and
features and then click Next.
Select the Web Server (IIS) check box and expand the IIS role to
view the underlying role services.
Default Document
Directory Browsing
HTTP Errors
HTTP Redirection
Static Content
WebDAV Publishing
check boxes:
HTTP Logging
Request Monitor
Request Filtering
Windows Authentication
13 After you enable the required features, start the World Wide
In the Services section, make sure that the World Wide Web
Publishing Service is running. If the service is not running, start
it.
In the Server Name box, enter the name of the local report
server node.
Make sure that the following components are configured with the
defaults and no errors occur:
Service Account
Web Service URL
Database
Report Manager URL
Click Exit.
139
Chapter 10
Information Server
Installation and
Configuration
Installable Features
You can select from the following features during the Wonderware
Information Server install:
Installation Pre-Requisites141
Installation Pre-Requisites
The installation program checks for the following basic system
pre-requisites:
If you are using a remote SQL Server, you must enable File and
Printer Sharing in the Windows firewall configuration to permit
If you are using a remote SQL Server, Port 1433 and port 80 must
be open in the Windows firewall on the remote node to access the
Reporting Service web pages.
Enables WebDAV.
In the Virtual Folder Name box, type the virtual folder name. The
virtual folder name is the address you enter in Internet Explorer to
access Wonderware Information Server. The virtual folder name is
not case-sensitive, can be any characters other than /,*,?, and \.
The maximum length is 240 characters. For example, if you
specified MyInfoServer, run-time users would type
http:\\<computername>\MyInfoServer to access Wonderware
Information Server.
In the Server box, type the name of the SQL Server host.
If you are using a non-default instance of SQL Express, specify
the name in the following format:
<SQLServerName>\<InstanceName>
In the Virtual Folder Name box, type the report web site name.
On the Windows Start menu, click Run. The Run dialog box
appears.
Type the appropriate command for the operating system you are
using:
Select Identity.
In the Query Timeout box, type the time, in seconds, that the
Wonderware Information Server should wait for the results of
a database query to the Historian to be returned, before
returning an error message.
In the Provider box, type the provider name for SQL Server. For
SQL Server 2008, type SQLNCLI10. For SQL Server 2012, type
SQLNCLI11.
Click OK.
Creates the ArchestrA Reports folder under the root of the SQL
Server Reporting Services web site.
Select the Deploy Sample Reports to use the sample reports with
a historian or alarm data source. If you do not select his check box,
you can use ArchestrA Reporting for products that do not use a
historian or alarm data source, such as the InBatch software.
In the Historian Data Source for Sample Reports area, specify the
name of the data source for the report data. You can either select
an existing data source from the list or click Define New Historian
Data Source to define a new one. For more information, see
"Defining a New Historian Data Source" on page 150.
In the Alarm Data Source for Sample Reports area, specify the
name of the InTouch alarm database to use as the source of alarm
data. You can either select an existing data source from the list or
click Define New Alarm Data Source to define a new one. For more
information, see "Defining a New Alarm Data Source" on page 152.
In the Data Source Name list, type name of the alarm data
source as you would like it to appear for Wonderware
Information Server users.
In the Query Timeout box, type the time, in seconds, that the
Wonderware Information Server should wait for the results of
an alarm query to be returned, before returning an error
message.
In the Provider box, type the provider name for SQL Server. For
SQL Server 2008, type SQLNCLI10. For SQL Server 2012, type
SQLNCLI11.
Click OK.
Click Configure. A green check appears in the left pane when the
sample content is successfully configured.
Before you can use the Information Model, the configuration for the
model must be defined in the Model schema tables in the SuiteVoyager
database. An application developer must create the model. For more
information, see the Wonderware Information Model Configuration
Guide.
You can also populate the model tables by importing sample content.
The Information Model uses the ArchestrA Data Adapter service to get
data from the following sources:
Wonderware Historian
Microsoft SQL Server
Oracle
OSI PI OLE DB
Text (CSV) files
An instance of a data adapter can be created for each external data
repository. A data adapter is a component that can communicate with
the particular type of data repository. When you configure a data
source, you must provide a user account that has security privileges to
access the data source.
If you want to connect to an OSIsoft PI Server (OLE DB), Oracle, or a
text file data repository, you must install connectivity software on the
Information Server portal node so that the ArchestrA Data Adapter
service can communicate with the data source. For the required
versions of the connectivity software, see the Wonderware System
Platform Readme file.
Data Source
Connectivity Software
Oracle
Text (CSV)
Click Configure. A green check appears in the left pane when the
sample content is successfully configured.
1 MES Model.sql
3 Historian Model.sql
The data sources that are listed in the Data Sources window will
depend on what is defined in the model.
If no data sources are available, be sure that you have imported a
model and that the model includes data sources.
2
Click Close.
165
Appendix A
Using Silent Installation
Note that the full filespec of the response file (filename plus location of
file) must be included. For example:
D:\setup.exe /silent C:\docs\myresponsefile.txt
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:
C:\<path>\setup.exe /?
Running setup with the /? switch will display the silent installation
command-line help.
Ensure that the user running the install has administrator rights.
A good approach for testing is to first run the setup.exe in GUI mode
on a typical computer and confirm that no incompatibities exist that
would stop the installation, then cancel and run by command line.
Note: If the GUI-based installation requires a system reboot after the
installation is complete, installing by command line will also require a
system reboot.
Save the file to a directory on your local computer. Note the path
and full name of the file.
From the command line, type the install command and provide the
path and filename of the response file you want to use.
Example: E:\setup.exe /silent c:\Documents\DevNode.txt.
In this example, the setup.exe file is in the root directory of the
DVD, and the development node response file is on the local C:
drive in the specified directory.
Description
Development
Workstation.txt
Historian Client
Node.txt
Historian Server
Node.txt
Information Portal.txt
Runtime Client.txt
System Platform
Development
Server.txt
Description
All.txt
Application Server
Development.txt
Application Server
Galaxy Repository.txt
Application Server
Runtime.txt
Historian.txt
Historian Client.txt
Wonderware
Application Server.txt
Wonderware
Information Server.txt
Wonderware
InTouch.txt
171
Appendix B
Single Product Installation
All the files in the root directory (24 MB), except the Wonderware
System Platform Virtual Implementation Guide (18.6 MB). This
leaves a total of 5.4 MB required for installation.
InstallFiles
Folder
(Component)
Folder
Size
Historian
CD-Application
Server
670 MB
Bulk Import
11 MB
Historian
Client
Application
Server
Runtime
Utility
External
0.2 MB
Framework
379 MB
Redist
53 MB
UserDocs
32 MB
CD-Gateway
37 MB
CD-Historian
91 MB
CD-Historian
Clients
223 MB
CD-Intouch
263 MB
CD-IntouchFrench
276 MB
CD-IntouchGerman
276 MB
CD-Intouch
Japanese
276 MB
CD-Intouch
SChinese
276 MB
CD-Language
Assistant
103 MB
CD-Licensing
18 MB
CD-Server
30 MB
CD-WIS
585 MB
Optional
InstallFiles
Folder
(Component)
Folder
Size
External
1 MB
1414 MB
DOTNET (see
298 MB
Historian
Historian
Client
Optional
Optional
Application
Server
Runtime
Optional
important note)
MDAC
5 MB
MSI4.5
6 MB
PreReqInstaller
<0.01
MB
Safenet
8 MB
SQLK12SSMSE
995 MB
VC10SP1
0.02 MB
VC2012U4
13 MB
ResponseFiles
1 MB
Support
1 MB
UpgradeSupport
38 MB
4510 MB
1853 MB
700 MB
726 MB
N/A
297 MB
402 MB
428 MB
Optional
Important: You must copy the entire DVD. The root directory from
the DVD and all files in it must be in place and completely intact.
2
Navigate to the location where you copied the DVD. Delete the
files, components and language folders that you do not need.
Now you are ready to install or upgrade the product(s) using either
of the methods described below.
Make sure you have deleted the folders you do not need.
177
Index
Numerics
16 Pen Trend 18
A
A2ALMDB database
disk space 65
acquisition
loading 72
ActiveEvent
installing 101
ActiveFactory reporting, configuring 148
ActiveX and .NET Controls
aaHistClientQuery 115
aaHistClientTrend 115
alarm data source
defining 154
antivirus software 108
Application Server
ArchestrA user account requirements 12
hardware requirements 39
ArchestrA Bootstrap 123
ArchestrA Change Network Account
utility 13, 26
B
Bootstrap
upgrading 38
upgrading with Galaxy Repository 38
upgrading with IDE 38
upgrading with IDE and Galaxy
Repository 38
building block controls
aaHistClientTagPicker 115
aaHistClientTimeRangePicker 115
C
common components 35, 102
Configuration Utility 103
Configurator
starting 144
configuring
178 Index
D
database
configuring 103
database files
disk space requirements 64
demo mode 50
disk sizing 63
disk space
history blocks 65
planning 63
domain controller 124, 125
security 124
using with Wonderware Information
Server 124, 125
E
event data
migrating from older versions 111
F
fault-tolerant servers 60
feature lines 76
features 140
firewall exceptions 143
G
Galaxy database
migrating 41
Galaxy Repository
upgrading 40
upgrading with the Bootstrap 38
upgrading with the Bootstrap and IDE 38
H
hardware recommendations
storage 63
hardware requirements 39
disk space 63, 64
IDASs 61
System Management Console 61
Wonderware Historian 58
Historian Client 83
historian data source
defining 151
Historian Database Export/Import Utility
requirements 61
history blocks
disk space requirements 65
licensing 81
history data
licensing 80
migrating from older versions 111
Holding database
disk space 64
I
IDASs
installing 101
performance 73
requirements 61
security 62
IDE
upgrading 41
upgrading with the Bootstrap 38
upgrading with the Bootstrap and Galaxy
Repository 38
IIS 125, 130
installing 130
InBatch 83
installation
about 99
components 99
modifying 26
repairing 28
silent 165
Wonderware Historian 99
installation pre-requisites 141
installing
IIS and ASP.NET 130
product license 163
SQL Server 126, 127
Windows Server 2003 125
Windows Server 2008 125, 126
Wonderware Historian Client 117
Wonderware Information Server 139, 141
Wonderware System Platform 9
Internet Information Services 126
InTouch 121, 125, 141
Index179
supplementary components 18
InTouch windows
running within browser 121
InTouch WindowViewer 83
Invensys License Manager 30, 163
L
LAN 75
language packs 138, 161
legacy software 35
License Viewer 102
licensing 49
about 76
feature lines
data modification 80
history duration 81
operating system 79
remote IDAS 79
replication server 82
tag count 78
loading
Wonderware Historian 72
M
Management Console 101
Manufacturing Execution Module 83
memory
requirements 58, 71
Microsoft Client Utilities 100
Microsoft SQL
Intelligence data adapters 156
Microsoft SQL Server
installation 100
Microsoft Windows Server 2003 125
Microsoft Windows Server 2008 125
Microsoft Windows Server 2008 R2 126
modify
installation 26
modifying Wonderware Information
Server 160
multilingual systems 138
N
named pipes 100
navigation tree 122
network cards 75
network protocol 76
networking 74
O
operating system requirements 123
operating system, upgrading 39
operating systems
licensing 79
non-English 82
Oracle
Intelligence data adapters 156
OSI PI
Intelligence data adapters 156
P
performance 71
examples 84
IDASs 73
physical memory 58
process graphics 121
process network 75
product license 30, 163
installing 163
products
configuring 24
protocols 76
recommendations 74
R
RAID 63
repair
installation 28
repairing 118
Wonderware Historian 108
repairing Wonderware Information
Server 161
requirements 115
Historian Database Export/Import
Utility 61
response files 166
retrieval
loading 72
roaming profiles 118
Runtime database
disk space 64
migration 110
S
SCSI 63
180 Index
security
domain controller 124
remote IDASs 62
silent installation 165
software
requirements 39
software requirements 123
IDASs 61
System Management Console 61
Wonderware Historian 58
SPCPro 18, 83
SQL Server 115
installing 126, 127
upgrading 39
SQL Server Reporting Services 122, 136
SQL Server Versions 33
SQL Server, incompatible version installed 34
SQL Server, not found 33
SQL Server, untested version installed 34
SQL statements
licensing 80
storage
disk sizing 63
hardware recommendations 63
loading 72
SuiteLink 74
summary data
migrating from older versions 111
system
sizing 84
System Management Console
installing 101
requirements 61
T
TCP/IP 74, 100
text files
Intelligence data adapters 156
tiered historian
sizing 91
U
uninstall
Wonderware System Platform
Component 29
uninstalling 119
uninstalling Wonderware Information
Server 161
upgrade
basic steps 39
Galaxy Repository 40
Galaxy Repository node 40
IDE 41
operating system 39
redundant pairs 43
run-time nodes 42
SQL Server 39
upgrading 110
previous version 162
Wonderware Information Server 3.1 163
Wonderware Information Server 4.0 163
Wonderware Information Server 4.0 with
SP1 163
V
virtual memory 58
W
WAN 75
web server
requirements 122
Windows 7 125
Installing 125
windows authentication 143
Windows Server 2003 125, 126
installing 125
Windows Server 2008 130, 131, 133
installing 125, 126
Windows Server 2008 R2 126
Windows Vista 58
Wonderware Application Server 125
Wonderware Historian
components 101
installation 102
installing 99
loading 72
memory requirements 71
repairing 108
requirements 58
upgrading 109, 110
Wonderware Historian Client
Components 114
Query 114
Report 114
Trend 114
Workbook 114
Index181
182 Index