TN - 1031 Tips for Installing AVEVA System Platform
The stability of your system is often tied to the initial configuration and installation. If you are new to installing AVEVA products the following guide provides suggestions for ensuring a successful installation and avoiding common pitfalls.
- Author: Mario Meza
- Published: 9/18/2017
- Applies to: System Platform Installations
|1. Use a Virtual Machine||
While you may be tempted to jump right in and install the software on a personal or work machine, you will most likely encounter installation issues due to 3rd party software conflicts and artifacts left by previously installed programs. If you are fortunate enough to get the product installed, OS updates and permissions are typically handled by your organization. These are often regularly updated, this will almost certainly 'break' a working system. It is strongly suggested to set up a virtual machine as there are a number of benefits.
A free solution called Virtual Box can be used to create a Virtual Machine in just a few minutes so you can test the waters. (If you ever have a need to move a vm created on VIrtual Box to another platform like Hyper-V you can use a utility like StarWind V2V Image creator to make the conversion). Many guides exist covering setting up a VM, such as the one at the following link. If you don't have an OS you can obtain a 90 day trial to Windows 10 LTSC. The following article discusses how to obtain an evaluation version along with some benefits with the LTSC version of Windows 10. Before installing make sure to finish reading this guide and remember to UNBLOCK your downloads as covered in this InSource article. Failing to do this as soon as the download completes will prevent the downloaded software from operating correctly. For more information see the 'System Platform Virtual Implementation Guide' in the product documentation.
|2. Confirm Windows Compatibility||Few things are as frustrating as getting a system setup only to find out that it is not compatible with your version of the product. To avoid this check the Technology Matrix on the AVEVA site when planing your installation. With the release of Windows 10 the Technology Matrix has been updated to also reflect the supported 'Build' of Windows 10.|
|3. Windows Automatic Updates||
Once the VM has been created, it is highly recommended to disable Automatic Updates until the product is installed and stabilized. Once the product is licensed and configured you can then install updates according to the list of supported updates as outlined in Security Central on the AVEVA site. If Automatic Updates are left on, they should not be set to
To quickly obtain a list of the installed updates on you system
From a command prompt run the following command :
wmic qfe list brief /format:htable > "%USERPROFILE%\hotfix.html"
This will generate an html table with the installed windows updates at the following path:
From there you can do a ctrl + f to validate the currently installed updates against an Export from Security Central. If an update is not on the list it means it has not been tested and may cause problems with AVEVA software products.
|4. Setup Administrator Account||You should make sure that you are installing and configuring all AVEVA software from a valid administrator account. This ensures that the software is able to make the necessary changes to your system and that it will have all permissions needed to complete installation tasks. If installing with a domain account make sure it has local administrative rights.|
|5. Verify Computer Name||Make sure that the domain, workgroup, and/or computer name are set properly. Having correct network identification is critical when developing applications and setting up any server or node for external connections/communications. Changing the computer name or moving the computer to a new domain after AVEVA software is installed will cause certain components to break.|
|6. Disable Firewall/Local Internet Port
|Verify that firewalls are turned off (at least until the product is installed and licensed). This can cause issues with ports and security settings required by AVEVA software. If you must use a firewall, it must be configured. Most new AVEVA software will automatically add exceptions to the Windows firewall to allow application communication. To perform this manually, run the utility “osconfiguration.exe”, provided with your AVEVA software. Note that this only applies to Windows firewall. For other firewall software, you must add exceptions yourself. For information on the necessary ports consult the Readme Firewall Notes section. If using 2017 a list of the necessary ports can be obtained from the following link.|
|7. Create a Network Services Account||For one AVEVA application to execute software on another computer, it must have permission to do so. To grant that permission “under the hood”, AVEVA uses a special account called the 'Network Services Account', 'Change Network Account' or simply the “aaAdmin” account. This account is used to start/stop services on remote machines, and also grants permission to local services, such as allowing Operation Integration Servers to run. This account must be a local administrator level account, and the password policy should be set to not expire. Username/Password should be the same on all machines. You will be prompted for this account during installation of the software. You may need to run the Change Network Account utility periodically to resolve various issues. For additional information on the Change Network Account see this InSource Article.|
|8. Add Exceptions to Real-Time Virus Scanning Software for AVEVA Folders||
The following folders should be excluded by the antivirus software:
32-bit Operating System
64-bit Operating System
Other File Directory Exclusions
Note: If you choose different drives/folders for the program files and data files, be sure that you configure the Antivirus software accordingly. For additional information see the following tech note on the AVEVA site:
TN470 : Wonderware System Platform FAQs for IT Professionals
|9. Use Tech Note 'X' for SQL Server Installation||
Starting with System Platform 2012 the installation media includes SQL Server Express.The installer will automatically install
TN1024: Installing Microsoft SQL Server 2016 for Wonderware Products
|10. Install Microsoft Office||
Check the Technology Matrix to validate version compatability, Microsoft Office is an optional prerequisite. If you install Office after installing Historian Client, then the Historian Client add-ins do not appear in the list of available add-ins in Office. Run the Historian Client installation program and repair the installation to get the add-ins loaded.
Note for Microsoft Office support:
The 64 bit version is not supported.
This applies to all versions of MS Office (2010 and >, including Office 365 when installed locally)
You may see a note listed in the Technology Matrix for 2017 discussing the x64 Add-in. This is in reference to the brand-new "InSight Add-in"” (aka “Wonderware Historian On-Premises Connector”) for use with Excel. This is NOT a direct replacement of the classic "HistClient Workbook".
|11. Map Network Drives / Shared Resources||
In your environment you may have shared resources such as mapped drives that you would want available from your installation(s). Setting this configuration now will persist when cloning images for future use and eliminate the need for this step when setting up new systems.
|12. Take a snapshot / clone the OS||
If you've followed the suggestions outlined in this article you have a virtual machine prepped and ready to install various AVEVA product versions compatible with the chosen OS. At this point you can take a snap shot and clone this VM so you can quickly install Wonderare components. When working with a cloned VM BEFORE installing Wonderware components remember to;
1. Update the hostname
2. Update SQL server name
To update the SQL sever name execute the following query (filling in the bold items):
Once executed stop and start the SQL SErver (MSSQL SERVER) service to update the change and validate the new server name in SQL using the following query.
*** Do not CLONE a vm with 2017 licenses installed. Doing so will trigger a grace period.
|13. Install Configure and License Wonderware Products||
Final check, make sure if downloading a new installer direct to the VM to validate it's unblocked. Once validated run the installation "Run as administrator" (By default, apps on Windows 10 run without administrator permissions, to prevent unauthorized changes to your system). Once the installation completes the configurator will automatically launch. While you have the option to configure every feature available, a solid approach is to simply start by configuring licensing components. Exit the configurator (you can always configure additional features later). Validate license activation is successful and the product launches using the appropriate license. This approach will aid in targeting the root of any licensing related issues. Once the system is licensed and stable, take a snapshot and proceeded with configuring any additional components.
*** If installing any version of 2017 not using license manager 3.5.1 it is strongly recommended to upgrade before activating a license. You can download the 3.5.1 standalone installer from the following link.
The stability of the system is often dictated by the quality of the installation / configuration. It is important to note that this document is not to be taken as complete and comprehensive coverage when installing AVEVA software products. This document is a collection of pragmatic tips based on cases with clients in the field installing AVEVA products. For comprehensive coverage of installation refer to the official AVEVA installation guides. The various product install guides can be found on the root of the Installation Media for each component at the following path: