AVEVA System Platform 2020 Readme

Last revision: 4/7/2020

This document contains important information about AVEVA™ System Platform 2020, formerly Wonderware. This version of System Platform includes a number of security enhancements and new features for the component products of System Platform.

Important: Support for 32-bit operating systems and 32-bit SQL Server versions is discontinued in this release of System Platform. System Platform 2020 is only compatible with 64-bit operating systems and SQL Server versions. If you have a 32-bit version of SQL Server, you must uninstall it before installing System Platform. System Platform will check that an installed SQL version is compatible prior to installation, and will display an error message if the installed SQL Server version is not compatible for any reason (not only for 32-bit versions). For information about moving from 32-bit to 64-bit SQL Server, refer to Issue 1249251 under Install/Uninstall and Galaxy Migration Issues. For general information about SQL Server requirements, see SQL Server Notes.

• Supported Operating Systems at Time of Release
• Supported SQL Server Versions at Time of Release

Included in This Release

About This Release

Changelog: System Platform 2020

Supported System Platform Versions for Product Upgrade

You can upgrade directly to System Platform 2020 from the following versions:

• System Platform 2017 Update 3 SP1
• System Platform 2017 Update 3
• System Platform 2017 Update 2
• System Platform 2017 Update 1
• System Platform 2017
• System Platform 2014 R2 SP1 with Patch 01 and/or Patch 02
• System Platform 2014 R2 SP1

Note that all existing products must be upgraded to the same version.

Supported System Platform Versions for Migration

You can migrate user-created content (for example, .cab files, .aaPKG files, Historian databases, etc.,) to System Platform 2020, as long as the content was created in one of the following product versions:

• System Platform: Version 4.5 or newer
• Application Server: Version 2.5 or newer
• InTouch HMI: Version 7.11 P07 or newer
• Historian Server: Version 9.0 P02 or newer
• FS Gateway: Version 1.5 or newer

Server-based Licensing

System Platform 2020 continues to utilize the server-based licensing subsystem introduced in System Platform 2017. This new licensing subsystem provides centralized license management, and replaces the file-based licensing system that was used in prior releases. Licenses must be activated before use.

If you are upgrading from Windows Server 2014 R2 SP1 (with or without patches), you must first install and configure a license server node, and activate the licenses to ensure continuous plant operation. The license server is typically installed on the Galaxy Repository node, but you can use a dedicated license server. See the "License Installation and Activation" section of the System Platform Installation Guide (SP_Install_Guide.pdf), located at the root of the DVD.

Start Menu and Shortcut Changes

Some Start menu folders and some of the System Platform shortcuts they contain have been renamed. Commonly used applications, such as the Change Network Account utility, Configurator, and System Platform Management Console, are now located under the AVEVA Start menu folder. These were under the Wonderware Utilities folder in prior releases.

Readme Files for Other Products in this Release

To access individual product Readme files, insert the System Platform installation DVD and navigate to the applicable folder under the InstallFiles directory. Review the known and resolved issues contained in each Readme file for the component products updated for this release:

Important Information for Highly Secured Environments (TLS 1.2 Exclusively)

Affected Systems

This information is applicable to a small subset of highly secured environments, in which operating systems and supporting networks have been configured to enable TLS 1.2 and where TLS 1.0 and 1.1 have been purposefully disabled. In these rare instances, some additional configuration is required to ensure that System Platform will work as expected.

System Platform 2020 includes various measures to strengthen security, including the ability to leverage TLS (transport layer security) 1.2, provided that TLS 1.2 it has been enabled and configured in the host operating system.

In some cases, you may have to enable TLS 1.2 support by applying Microsoft updates and by making several manual edits to the system registry. The tasks of applying all Microsoft updates and editing the system registry must be completed before you install System Platform 2020. These instructions also apply to any other software products that support TLS 1.2. Follow the instructions listed below.

If you are required to enable TLS 1.2 and disable TLS 1.0 and TLS 1.1:

1. Before installing System Platform 2020, make sure that your computer is up to date by downloading and installing all applicable Microsoft updates.
2. If required by the updates, restart your computer.
3. Edit the system registry. The .REG file shown below sets registry keys to their safest values.
   For additional information about these registry changes, see Configuring security via the Windows Registry.

   Windows Registry Editor Version 5.00
   

   [HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Microsoft\.NETFramework\v4.0.30319]

   "SystemDefaultTlsVersions"=dword:00000001

   "SchUseStrongCrypto"=dword:00000001
   

   [HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\.NETFramework\v4.0.30319]

   "SystemDefaultTlsVersions"=dword:00000001

   "SchUseStrongCrypto"=dword:00000001

4. Restart your computer to ensure that all changes take effect.
5. Install System Platform 2020.

How to Find the Latest Product Requirements and Compatibility Information

For important information about this product release, go to the AVEVA Global Customer Support (GCS) website. Information on the GCS website includes product requirements, compatibility, as well as downloads from previous releases. After you log in, you can filter search results by product name and the release/version.

• The GCS Product Hub contains Readme files, videos, and product downloads from previous product releases.
• The GCS Technology Matrix is a searchable database that contains the latest product information. Enter the product name in the search bar, then select the current release to view:
  • Product Information: version name, number, release date, etc.
  • Product Notes: key release information, new features, and updates
  • OS Compatibility: list of compatible Windows and Windows Server versions
  • Database Compatibility: list of compatible SQL Server and other database product versions
  • Virtualization Compatibility: list of compatible virtualization software products and versions
  • Product Coexistence: list of products that can be installed on the same computer
  • Product Compatibility and Interoperability: list of products that can operate together and communicate with each other through a common message protocol

New Features in System Platform 2020

Two important new features, the requirement for 64-bit operating systems and SQL Server versions (where needed) and the Flex licensing option, apply across all System Platform 2020 products.

Additional new product-specific features are outlined below.

64-bit Operating System and SQL Server Now Required

With the release of System Platform 2020, a 64-bit operating system and SQL Server version are now required for all System Platform core products: Application Server, InTouch OMI, InTouch HMI, and the Historian. Running in a 64-bit environment provides a common environment for all products, and ensure that you get the best performance from your System Platform installation. For information about moving from 32-bit to 64-bit SQL Server, refer to Issue 1249251 under Install/Uninstall and Galaxy Migration Issues.

Flex Licensing Option

You can now choose between a perpetual license model and the new Flex-licensing subscription option for Application Server. Flex licensing lets you easily acquire and assign licenses to platforms, much more easily and affordably than what was possible with legacy perpetual licensing. Flex licenses are based on AppEngine assignments, rather than having to calculate I/O counts and other system parameters to determine final licensing costs. Other benefits include better cash flow management and a simplified business process.

New Features in Application Server and InTouch OMI 2020

Performance Improvements

A number of enhancements to improve performance have been implemented for this release of System Platform.

• Propagation times for changes to templates and creating instances have been shortened, especially in large systems.
• Deployment times for InTouchViewApp instances have been reduced.
• The startup time for the aaGR process has been improved.

Credential Management for InTouch OMI ViewApps

InTouch OMI ViewApps can use security credentials created in Application Server to gain access to third-party data where Windows OS credentials are not recognized, and/or to provide a method to automatically load a particular data set for specified users. Credential Management is described under "Security" in both the Application Server User Guide and the System Platform 2020 Help.

Support for Additional .NET Controls InTouch OMI ViewApps

InTouch OMI now lets you import, configure, and use .NET WinForm controls in a ViewApp (.NET WPF controls were already supported). See "Importing ArchestrA Apps" in the System Platform 2020 Help for more information.

Responsive Layouts for InTouch OMI ViewApps

The Layout Editor has a new option for creating responsive layouts. This allows the ViewApp to dynamically move and resize content in response to the screen size on which it is being viewed. See "About Responsive Layouts" in the System Platform 2020 Help for more information.

Script Support for InTouch OMI Layouts

Using the same foundation as scripting for Industrial Graphics (formerly ArchestrA Graphics), layout scripting lets you customize run time behaviors for layout content as well as the layout container by adding scripts. As part of layout support, graphic custom properties can be overridden within the layout. A new namespace, "MyContent," is available for addressing content within a single ViewApp, in addition to the MyViewApp global namespace. See "Layout Scripts" in the System Platform 2020 Help for more information.

Event Scripting for InTouch OMI Layouts

You can add event-based scripts to InTouch OMI layouts when the layout include apps that expose public properties, for example "MouseDown." See "Add an Event Handler Script" in the System Platform 2020 Help for more information.

HideContent() Scripting Function and API Call

The HideContent() scripting function and API call can be used in conjunction with ShowContent(), which was introduced in System Platform 2017 Update 2. ShowContent() lets you place symbols or layouts into specific panes within an InTouch OMI layout, either through scripting or programmatically, and now HideContent() provides the additional functionality for more complete control of the content you wish to make available to users at run time. See the Application Server Scripting Guide for more information.

InTouch OMI App Enhancements

The MapApp and Content Presenter App have been enhanced with new features and improved functionality. These apps are described in the System Platform 2020 Help.

• MapApp: Credential management has been improved, with a built-in menu for selecting a named credential.
• ContentPresenterApp: The ContentPresenter app shows graphics from one or more selected nodes of a ViewApp navigation model. The pane in which the ContentPresenter app has been placed shows a set of graphic thumbnails that match the ContentPresenter app filter criteria. Graphics shown by the ContentPresenter app can be filtered by content type, name, and location within the ViewApp navigation model.

Browse Application Server Run-Time Data with OPC UA Clients

AVEVA Application Server now includes OPC UA server functionality. This lets you browse the namespace in a deployed galaxy, and connect to, subscribe to, and retrieve galaxy data, without the need for a gateway or other protocol translation mechanism. See "Configuring and Using the OPC UA Server" in the Application Server User Guide for more information.

AVEVA Connect for Sharing Graphics

AVEVA Connect is a cloud-based resource that lets you easily create and share graphics between locations, galaxies, and applications. See "AVEVA Connect" in the Application Server User Guide for more information.

AVEVA Telemetry Server Enhancements

The Telemetry Server now supports handling data that arrives out-of-sequence via multiple channels. See "Telemetry Server Data References" in the Application Server User Guide for more information.

Visualize Externally-Detected Alarms

Alarm conditions that have been detected within a PLC can now be visualized in, for example, the Historical Trend App or the Alarm App. To accomplish this, the ability to configure a Boolean attribute within the Object Editor as an alarm input for a State Alarm has been added. This allows the trend tools to properly visualize alarms that have been detected externally. See "Using the State Alarm Feature" in the Application Server User Guide for more information.

New Features in InTouch HMI 2020

InTouch HMI 2020 includes a number of new features, hot fixes, and provides support for the latest versions of Microsoft products. Refer to the GCS Technology Matrix for the list of supported Microsoft products. The following section summarizes the major features introduced in this release.

64-bit Operating System and SQL Server Now Required

With the release of System Platform 2020, a 64-bit operating system and SQL Server version are now required for all System Platform core products: Application Server, InTouch OMI, InTouch HMI, and the Historian. Running in a 64-bit environment provides a common environment for all products, and ensure that you get the best performance from your System Platform installation.

Flex Licensing Option

You can now choose between a perpetual license model and new subscription option for InTouch HMI. Subscription (Flex) licensing lets you easily acquire licenses, much more easily and affordably than what was possible with legacy perpetual licensing. For more information, see the Application Management and Extension Guide.

New and Improved InTouch HMI Application Manager

The new InTouch HMI Application Manager presents with a modern user interface with simplified workflow tasks and easier access to features.

Integration with AVEVA Connect

You can upload, download and manage Industrial Graphics in AVEVA Connect via the Graphic Toolbox.

HTML5 Widget

In this release we have introduced the framework of using HTML5 widgets within InTouch HMI. The Carousel widget from the graphic toolbox will allow you to configure and view a HTML5 widget in WindowViewer and Web Client.

Standalone Applications with Support for Industrial Graphics

The new standalone application now supports Industrial Graphics.

• You can create application and frame windows, drag and drop graphics on the window and view them in WindowViewer.
• It does not have any dependency on a GR and can be used without the IDE installed.
• Standalone applications can be viewed on the Web Client. The application windows must be converted to Industrial Graphics before being viewed on the web client.

Other Major InTouch HMI Features

• ArchestrA symbols or ArchestrA graphics will now be referred to as Industrial Graphics.
• InTouch HMI tags can be configured to directly store tag information to AVEVA Historian via WindowMaker.
• The cross reference utility now displays tags used in Industrial Graphics present in the Graphic toolbox, but not placed on any window.
• InTouch tags will be displayed without having to type "InTouch:" for standalone InTouch applications in the Graphic Editor. The scripting engine will display the tags from the default namespace without requiring the user to type "<namespace>:".
• Enhanced security and performance improvements to various components of InTouch HMI.
• The ChangePassword() function has been enhanced to support longer passwords allowing better security.

Web Client

There are many improvements to the Web Client:

• Improvements to the security, availability and performance of the web server.
• Web Client now supports write operations. In this release, a new license that supports read/write operations has been introduced.
• You can now acknowledge alarms on the embedded alarm client from the Web Client
• Web Client now display Standalone applications with multiple symbols.
• Web client now supports Windows controls like checkbox, combobox, etc.
• New license that allows for unlimited sessions for reading and writing data from the web client.
• Web Client now supports user-specific InTouch System Tags on a per-user basis within a web browser session.

Web Client now available as a Mobile App

The Web Client interface is now available as a Mobile App. For more information see the Viewing Application Graphics in a Web Browser guide.

Using the Historical Trend Control for Viewing Historian Data

Using the Historical Trend Control from the Drawing toolbar you can configure the IndustrialSQL Server History Provider (Historian Server), to visualize historical trend data. This functionality requires the storage of database credentials in local files. To prevent unauthorized access to Historian and other SQL databases, we recommend using the ArchestrA Trend Client, with a Windows Integrated or Windows Account authentication mode.

New Features in Historian 2020

Multi-Tier Replication Support

The Historian supports multi-tier replication. Data originating at tier 1 can be replicated to tier 2, then again to tier 3, and so on. Replication from tier 1 to tier two can be simple or summary replication. Replication beyond tier 2 is simple replication.

Support for AVEVA Flex Licensing

Enhanced Excel add-in

Support for tag selection using search, tag metadata in headings, wide/narrow output formatting, flexible column selection, and native formats for numbers/dates.

AVEVA Historian Client Web (previously known as Historian Insight) supports white labeling for OEMs

New Features in Historian Client 2020

Trend automatically sets scale precision

Added auto precision option (enabled by default) to tag trend options. When enabled, the number of decimal places is set automatically based on the value range.

Trend XY plot "start/end" marker changes

Added options to show end markers only, show start markers only, not show any markers or time labels, and to change start/end marker sizes.

Dashboards can be accessed by URL, so they can be shared

Support for AVEVA Flex Licensing

Web Help Display and Video Playback

Web Help - Browser-based User Assistance

Web help components have been delivered in this release. Web help opens in the default browser on your local computer. Help displayed in a browser allows more dynamic and searchable user assistance including standard web browser navigation and tutorial videos.

Typically, help content is installed on your local machine as part of the documentation library, and displays in your browser without requiring an Internet connection. To open the help, use one of the following methods (depending on the editor/UI you are using):

• Press F1 from the ViewApp editor, Screen Profile editor, or Layout editor.
• From the System Platform IDE, select an object or symbol name and:
  • press Ctrl+F1, or
  • right-click, then select Help from the short-cut menu.
• Open web help from its installed location:

  C:\Program Files (x86)\ArchestrA\Framework\Docs\1033\NGX\index.htm

Browser Requirements and Recommendations

Internet Explorer is recommended. You can also view web help Firefox. If you use Firefox, you may need to install and use an IE rendering extension (for example, IE Tab) to ensure that video content is shown.

• Microsoft Edge will not load help content, unless you use the "Open with Internet Explorer" option in the Edge browser.
• Chrome and Chromium-based browsers, such as Vivaldi, will not load help content unless you install and use an IE-rendering extension (for example, IE Tab).

Browser Permissions for Displaying Web Help

Each browser and Windows operating system combination has its own security permissions. Using Internet Explorer (version 8, 10, or 11) as an example, you may see a dialog requesting you to "Allow blocked content" each time you invoke the web help. This dialog is triggered by the presence in the help system of JavaScript components that control internal navigation and topic display elements such as pop-up or in-place-expanding display blocks that contain text and graphical images. The text and image content is itself non-active.

You can accept each occurrence of this dialog, or you can set the following option in Internet Explorer, depending on your IT security requirements: In Internet Options, click the Advanced tab, then navigate to the Security section. Enable the "Allow active content to run in files on My Computer." Permissions and security settings will vary depending on your specific browser.

Playback of Tutorial Videos

The web help may contain a number of brief tutorial videos. To play these videos, you must have Microsoft Media Player installed on your local machine. In Windows Server operating systems, you must enable the "Desktop Experience" feature using Server Manager.

Internet Explorer (or IE-rendering in other browsers) may be required for viewing video content. If using a browser other than Internet Explorer without IE rendering enabled, videos may not be visible.

InTouch OMI SDK Web Help

When you install the Application Server IDE, the InTouch OMI SDK is automatically installed, and a link to the InTouch OMI SDK Web Help is added to the Windows start menu. The browser requirements and recommendations that apply to System Platform Web Help also apply to the SDK help.

• To open the SDK help from its installed location, go to:

  C:\Program Files (x86)\ArchestrA\Framework\Docs\1033\OMISDKHelp\index.html

• To open the SDK help from the start menu, go to:

  Start > AVEVA Documentation > InTouch OMI SDK Help

InTouch OMI SDK Web Help

When you install the Application Server IDE, the InTouch OMI SDK is automatically installed, and a link to the InTouch OMI SDK Web Help is added to the Windows start menu. The browser requirements and recommendations that apply to System Platform Web Help also apply to the SDK help.

• To open the SDK help from its installed location, go to:

  C:\Program Files (x86)\ArchestrA\Framework\Docs\1033\OMISDKHelp\index.html

• To open the SDK help from the start menu, go to:

  Start > AVEVA Documentation > InTouch OMI SDK Help

System Requirements and Guidelines

System Sizing Guidelines

The following table provides guidelines for hardware configurations suitable for System Platform 2020 software based on the size of the application. These guidelines are subject to the limitations of your Windows operating system, and if applicable, to the SQL Server edition (Express, Standard, or Enterprise). See the AVEVA GCS Technology Matrix for supported versions of Windows operating systems and SQL Server.

• The Intel Itanium 2 processor is not supported.
• We recommend 1280 x 1024 as the minimum display resolution for engineering tools such as the Integrated Development Environment (IDE).
• A Windows Server operating system is required for large installations with more than 50,000 I/O per node.
• SQL Server Express is not supported for installations with more than 25,000 I/O per node (small installations only).
• 32-bit operating systems are no longer supported. Installation is blocked on unsupported operating systems.
• 32-bit versions of SQL Server are no longer supported. Installation is blocked when an unsupported version of SQL Server is detected. The unsupported version must be deleted and then a supported version installed before installation can proceed.

Supported and Recommended Node Hardware Types

Hardware Requirements Notes

Windows operating systems and SQL Server versions may impose hardware requirements that exceed the minimum requirements for System Platform 2020. Refer to the following Microsoft Web sites for Windows and SQL Server hardware requirements.

Windows requirements

• Windows Server 2019 System Requirements
• Windows Server 2016 System Requirements
• Windows Server 2012 R2 System Requirements
• Windows Server 2012 System Requirements
• Windows 10 System Requirements
• Windows 8.1 System Requirements

  Note: System Platform 2020 is not supported on any 32-bit Windows operating system. Windows 10, Version 1809 (64-bit), is the earliest version of Windows 10 that supports System Platform 2020. For the complete list of supported Windows operating systems and SQL Server versions, see the AVEVA GCS Technology Matrix.

SQL Server requirements

• Hardware and Software Requirements for Installing SQL Server 2019
• Hardware and Software Requirements for Installing SQL Server 2017 and Prior
• Hardware and Software Requirements for Installing SQL Server 2014

AVEVA Historian Hardware Guidelines

• AVEVA Historian, formerly Wonderware, is not supported on cluster hardware.
• Do not use the Historian computer as a domain controller.
• If you are running the Historian on a virtual server, the Historian must have adequate CPU, network, memory, and disk I/O resources at all times. Overloading the virtual server leads to unpredictable behavior.

For system sizing examples, see the System Platform Installation Guide.

Alternative Authentication Using Smart Cards

• Smart Card: Raak Technologies C2-40 Mini Driver Smart Card
• Smart Card Reader: OK 3021 USB Smart Card Readers

Operating System, Firewall, .NET Framework, and Virtualization Notes

• Firewall Notes
• Operating System Notes: Common for AVEVA Products
• Operating System Notes: InTouch HMI 2020
• Operating System Notes: Application Server
• Operating System Notes: Historian Server
• Operating System Notes: Historian Client
• .NET Framework Requirements and Compatibility
• Virtual Environment Notes

Minimum Operating System and Browser Requirements for System Platform 2020

The latest product information for each System Platform product is listed in the AVEVA Global Customer Support GCS Technology Matrix. Each link includes:

• General information about the selected product, such as the version number and release date
• Operating system requirements
• Microsoft SQL Server requirements
• Virtualization software compatibility
• Information about interoperability (which AVEVA products a specific product works with)
• Information about coexistence (which AVEVA products can be installed on the same node)

Minimum Required Operating System Version

The following table shows the minimum operating system for each product. See the GCS Technology Matrix for a list of all supported operating systems.

Important: Regardless of which operating system you are using, we recommend that you download and install the latest Microsoft updates to enhance security and ensure product compatibility.

Note: Only Windows Server versions licensed under Microsoft's long term servicing channel (LTSC) are supported. Versions of Windows Server licensed under the Semi-Annual Channel (SAC) do not include Desktop Experience, and therefore, are not supported. For example SAC versions 1709, 1903, and 2003 are not supported.

Supported Operating Systems at Time of Release

64-bit only

SAC: Semi Annual Channel (subscription)

LTSC: Long Term Servicing Channel

LTSC is the newer name for LTSB (Long Term Servicing Branch)

Windows Server Notes:

• SAC releases of Windows Server do not include Desktop Experience and thus cannot be supported.
• Windows Server 2012: Data Center only (Standard is not supported).
• Windows Server 2012 R2: Embedded (full image ), Standard, and Data Center are supported.
• Windows Server 2016: IoT, Standard, and Data Center are supported.
• Windows Server 2019 (Desktop Experience): IoT, Standard, and Data Center are supported
• Windows Server 2019 (Core): NOT supported

System Platform 2020 Web Clients

The following web clients are included with System Platform 2020:

• InTouch Access Anywhere Client (HTML5 Browser)
• Historian InSight Client
• AVEVA Enterprise Licensing - Manager Client

The client programs listed above can be used with most common web browsers. Compatible browsers include:

• Microsoft Internet Explorer 11
• Microsoft Edge (version 40.15063 and newer)
• Firefox (version 60.9 ESR and newer)
• Safari for iOS and Mac only (version 11 and newer)
• Google Chrome (version 72.0.326 and newer)
• Opera (version 50 (2018) and newer)

Windows Operating System Notes

• Upgrading from one version of System Platform to this version is only allowed when system requirements for operating system version, SQL Server version, and .NET Framework version are met. Upgrading System Platform removes the prior version and installs the current version (System Platform 2020)
• Support for 32-bit versions of Windows and SQL Server has been discontinued. Only 64-bit versions are supported.
• Semiannual channel (SAC) releases of Windows Server only include Core, and not Desktop Experience. Therefore, SAC releases of Windows Server are not supported.
• Newer operating system Service Packs (SPs) than those listed do not block the installation of AVEVA products. A warning message may appear during the installation process.
• After System Platform installation, the only operating system upgrade that is supported is from Windows 8 to Windows 8.1. In all other cases, existing System Platform products must be uninstalled prior to the upgrade and then reinstalled after the upgrade.

.Net Notes

• Versions of .NET (other than 4.x versions) can coexist, but all .NET code, including QuickScript.net scripts, run under .NET 4.7.2 or higher. For more information about .NET Framework requirements and compatibility, see .NET Framework Requirements and Compatibility.

SQL Server Notes

Upgrading SQL Server with AVEVA products installed is supported. See the AVEVA Global Customer Support GCS Technology Matrix for the complete list of supported SQL Server versions.

Only 64-bit versions of SQL Server are supported in this System Platform release. See Supported SQL Server Versions at Time of Release for more information.

If an error message about an unsupported SQL Server version is displayed while installing or upgrading to System Platform 2020, check the following:

• Your installed version of SQL Server is no longer supported, for example, SQL Server 2008.
  • How to fix: Upgrade to a supported version. Refer to the following Microsoft resource for more information: Upgrade SQL Server
• Your installed version of SQL Server is supported but requires a service pack. For example, you have SQL Server 2014 SP2, which was supported on System Platform 2017 Update 3, but now upgrading to System Platform 2020 is blocked because System Platform 2020 requires SQL Server 2014 SP3 or newer.
  • How to Fix: Download and install the required service pack.
• You have a 32-bit version of SQL Server installed.
  • How to Fix: Refer to Issue 1249251 under Install/Uninstall and Galaxy Migration Issues.

Supported SQL Server Versions at Time of Release

64-bit only

Default database is SQL Server Express 2017 Core

For information about which version of SQL Server you are running, see How to determine the version, edition, and update level of SQL Server and its components

Virtual Environment Notes

The following virtualization software and cloud-based virtual environments are supported for System Platform 2020:

• Hyper-V 5 and newer (version is based on the operating system utilized)
  • Both Gen 1 and Gen 2 VMs are supported
  • Windows 10 and Windows Server 2016 support Versions 7 and 8
• VMWare VSphere 6.0 and 6.5, including HA/DR
• VMWare Clients, including Horizon - Application Virtualization
• Cloud Virtualization - Azure
• VMWare Workstation, Version 11 and higher

Firewall Notes

In order to establish communication with other components and services on the network, System Platform and ArchestrA Service Bus (ASB) services require certain network ports to be opened in the Windows Firewall. Typically, these ports are automatically opened for the Windows Firewall during installation. However, if the Windows Firewall service is disabled or not running at the time of installation, or if an alternative firewall is in use, you will need to manually open the appropriate network ports in the firewall. For more information about port configuration, see "Configuring ArchestrA Service TCP Ports" in the Application Server User Guide (filename: IDE.pdf).

Operating System Notes: Common for AVEVA Products

ActiveX Controls Behavior on Supported Windows Operating Systems

Due to the Data Execution Prevention (DEP) feature in Windows operating systems, any ActiveX control built with ATL version 7.1 or earlier will fail to host, or will behave unpredictably in InTouch, either in WindowMaker or WindowViewer.

The ActiveX controls and error message, along with solutions to resolve the behavior, are described in detail in TechNote 522, "Some ActiveX Controls NOT Supported in InTouch 2012 R2 (Version 10.6)". You can download this TechNote from the AVEVA Global Customer Support (GCS) website.

Configuring Remote Alarm Retrieval Queries

The process to configure remote alarm retrieval queries has changed for interactive applications such as InTouch HMI when running on currently-supported Windows and Windows Server operating systems.

When InTouch WindowViewer is started and generates alarms from an interactive Windows or Windows Server desktop session, an AlarmViewer control (running within InTouch HMI) on a remote node must be specially configured to query the alarms. The source alarms will not appear unless the AlarmViewer control's alarm query is configured.

This type of query only works for InTouch HMI as an alarm provider running in a Terminal Services session, not for InTouch HMI running in a console session.

To configure the AlarmViewer's alarm query

1. After starting InTouch WindowViewer (alarm provider), open the SMC Logger and look for the most recent string generated by AlarmMgr. For example: "Registering AlarmMgr with SLSSVC as AlarmMgr 253.127.148.120". The indicated IP address will be unique to your alarm-providing node. Note the IP address for use in Step 2.
2. In the Alarm Query tab of the AlarmViewer control on the remote computer, configure the alarm query as follows, substituting your nodename of the alarm providing InTouch HMI for "nodename" below and substituting your IP address noted in the previous step:

   \\nodename:ip_address\intouch!$system

   where nodename is the name of the node that is providing the InTouch alarm and ip_address is the IP address that you determined in step 1.

3. Test to validate that the alarms generated from the alarm-providing node are shown accurately in the AlarmViewer control.

Terminal Services Behavior in Windows Server Operating Systems

Windows Server no longer supports the /console switch as a means of starting the remote desktop (RDP) client, also known as Session 0 or Terminal Server Console session. Session 0 is no longer an interactive session, and is reserved only for Windows services. Windows Server treats all remote connections as remote RDP sessions regardless of /console, /admin, or any other switches used to make the connection.

This impacts InTouch HMI functionality such as Alarm Manager that depends on the Terminal Server Console session. The impact to Application Server is minimal as most Application Server processes run as services. One impact to Application Server is to carry forward the restriction introduced with the Windows Vista operating system which permits only one alarm provider. While both Application Server and InTouch HMI can be configured as alarm providers, only one alarm provider can be configured at any one time.

Refer to the InTouch HMI Readme for further information about InTouch HMI applications running in the Terminal Server Console.

If you are running WindowViewer within a Terminal Server session and want to access alarms from WindowViewer in a client session, you must use the syntax \\terminalservernode:<IP address>\InTouch!$System to access the alarms, with a colon (:) after the node name. The IP address is that of the client computer connected to the session.

Operating System Notes: InTouch HMI 2020

InTouch HMI with Supported Windows Operating Systems

• Windows client (8.1 and 10) operating systems do not support a dedicated single-node server configuration that runs one or more databases for an InTouch HMI system.
• InTouch HMI 2020 does not support the following legacy script functions on 64-bit systems: WWPoke(), WWExecute(), WWRequest(), ActivateApp() and SendKeys().
• If Recipe Manager is started using the path Start\Program\AVEVA\InTouch\Recipe, then select Run as Administrator.
• The InTouch Extensibility Toolkit might need to be started by right-clicking and selecting Run As Administrator to function properly.
• The onscreen keyboard options were changed as of Windows 7 and Windows Server 2008 R2. Although System Platform 2020 does not support these operating systems, these changes apply to the currently-supported operating systems.
• Hovering to select from the Windows keyboard does not work in currently-supported operating systems.

InTouch HMI View Applications and DDE Support

NetDDE is not supported for InTouchView applications.

By design, an InTouchView application does not serve data to any other source, including InTouch HMI itself. When WindowViewer starts, it verifies if the application is an InTouchView application. When WindowViewer detects an InTouchView application, it does not register to become a DDE server. ArchestrA Symbols make use of the client layer when accessing InTouch tags, and appear as a third-party client trying to access WindowViewer as a data server. As a result, ArchestrA Symbols cannot communicate with InTouch tags when used with an InTouchView license.

In ArchestrA Symbols, InTouch:<tagname> is still a valid method of referring to an InTouch tag on a local node.

InTouch HMI Support for Windows User Account Control

System Platform 2020 with InTouch HMI 2020 supports User Account Control-enabled operations on run-time nodes.

Operating System Notes: Application Server

• The Bootstrap, IDE, and Galaxy Repository are supported by the following language versions of Microsoft operating systems: English, Japanese, Simplified Chinese, German, and French. The Galaxy Repository is also supported by the English, Japanese, Simplified Chinese, German, and French versions of Microsoft SQL Server.
• Upon installation, the selected language and regional settings must match those of the intended operating locale and must use the collation of SQL Server that matches the operating system locale.

Using Application Server with Supported Windows Operating Systems

This section describes specific behaviors and restrictions when using the supported versions of Windows and Windows Server operating systems with Application Server.

• The DDESuiteLink Client connection to the local Operations Integration (OI) Server (DAServer) using Local DDE is supported ONLY when the OI Server is configured as "Not a Service" and activated from its executable file or launched from InTouch. On Windows and Windows Server operating systems, Local DDE is NOT supported when the OI Server is activated in the System Management Console (SMC).
• For toolkits such as the ArchestrA Object Toolkit, GRAccess Toolkit, and MXAccess Toolkit to function properly on Windows 8.1 and later operating systems, you may need to start the toolkit by right-clicking on the file and then clicking Run As Administrator.

Application Server and User Account Control Level

Application Server supports User Account Control-enabled operations. Starting the IDE requires elevated privileges.

Operating System Notes: Historian Server

Scenarios involving remote node communication fail if the Historian node is using the Windows 7, Windows 8, Windows Server 2008 R2, or Windows Server 2012 operating system.

For example:

1. When you log in as a local administrator on a computer and try to add a remote Historian node (a second node with the Historian installed) using the network account from the Management Console, the status of the remote Historian node is not reflected correctly.
2. Test the connection from a Historian node using the operating system to a remote tier-2 historian. The following error message is shown: "Test Connection to replication server () failed: cannot connect to Tier-1 replication service (error 0x80004005: Unspecified error)"
3. Replication to the remote tier-2 historian fails.
4. Although a remote IDAS service starts successfully, errors and warnings stating "Failed to get IDAS configuration version..." and "Unable to start data acquisition" are logged. This problem occurs if the ArchestrA user account is a local user. If the ArchestrA user account is a domain user, then this problem does not occur.

Workaround:

1. Open a command prompt and run the following command:

   cmd /c reg add HKLM\SOFTWARE\Microsoft\Windows\CurrentVersion\Policies\system /v LocalAccountTokenFilterPolicy /t REG_DWORD /d 1 /f

   This sets LocalAccountTokenFilterPolicy registry entry value to 1. In doing so, an elevated token for the user is generated.

2. Restart the system.

Operating System Notes: Historian Client

User Account Control can be enabled when the Historian Client application is running as non-administrator.

.NET Framework Requirements and Compatibility

IMPORTANT: System Platform 2020 leverages the Microsoft .NET Framework 4.7.2 (or higher) version. Multiple versions of the .NET Framework can coexist, if other applications on the same machine have dependencies on other .NET versions.

All user-supplied .NET code that runs in the context of InTouch HMI and Application Server requires .NET Framework 4.7.2 or higher. Although the .NET Framework 4.7.2 is highly compatible with applications that are built with earlier .NET Framework versions, you may have to update your scripts.

In ArchestrA scripting, some .Net codes could fail if not using proper text encoding, and could cause a script to exit without completion. The UTF8Encoder is the default BinaryStream decoder in .Net 4.5 and later. To enable an ArchestrA script to decode ASCII XML data, for example, insert the following snippet:

BinaryReader streamReader = new BinaryReader(ms, new ASCIIEncoding());

To learn more about changes introduced in different versions of the .NET Framework, refer to the following Microsoft resources:

• What's New in .NET Framework
• What's obsolete in the .NET Framework class library
• Migration Guide to the .NET Framework 4.8, 4.7, 4.6, and 4.5
• .NET Framework 4 migration issues

Considerations for SQL Server

SQL Server is required for Application Server, InTouch, and Historian Server. We recommend that you install and configure the supported SQL Server version before you begin the System Platform installation program. If you select SQL Server Express during System Platform installation, it will be installed automatically (applicable to small installations only).

The System Platform installer will install all prerequisites except the SQL Server requirement for installing the Historian Server. If you select the Historian Server for installation, and if the supported version of SQL Server is not already installed, you must exit the installation program, install the supported SQL Server version, then resume the installation.

Other considerations are:

• Alarm DB Logger: To use the Alarm DB Logger with SQL Server Express, you need to change the default authentication mode from Windows-based to Mixed Mode.
• SQL Server Configuration Rights: While installing InTouch HMI for System Platform, if the logged-on user performing the installation is not a SQL Server administrator, the Config SQL dialog box appears and requests SQL Server administrator credentials.
• Maximum Server Memory: After installing SQL Server, use SQL Server Management Studio to confirm that the Maximum Server Memory is configured to approximately 65% of the total available RAM. By default SQL Server does not clamp this setting. The System Platform installation process will attempt to adjust it if it has the appropriate rights to configure SQL Server.
• Restoring a CAB: You cannot restore a Galaxy .cab file backed up in SQL Server 2012 or SQL Server 2008 to a node with an earlier version of SQL Server. For example, you cannot restore a Galaxy .cab file backed up in SQL Server 2012 to a node with SQL Server 2008. Attempting such a restore results in an error message.
• The MSSQL Server user account is not supported for the SQL Server Service. Instead, configure SQL Server to run as the local system or Network Service account. Named instances are not supported.
• Migrating SQL Server Versions: System Platform now requires a 64-bit version of SQL Server. Beginning with SQL Server 2016 (13.x), SQL Server is only available as a 64-bit application. You can upgrade from 64-bit versions of SQL Server 2008 and later to a SQL Server version that supports System Platform 2020. Supported SQL Server versions at the time of release of System Platform 2020 include:
  • SQL Server 2012 SP4
  • SQL Server 2014 SP3
  • SQL Server 2017 with all cumulative updates
  • SQL Server 2019 with all cumulative updates

  Important! A 32-bit version of SQL Server cannot be upgraded to a 64-bit version through SQL Server Setup. However, you can back up or detach a database from a 32-bit instance of SQL Server, and then restore or attach the database to a 64-bit instance. For more information, see Supported Version and Edition Upgrades for SQL Server 2017.

• For more information and helpful procedures about migrating SQL Server, see the following Microsoft references:
  • Upgrade SQL Server
  • Upgrade to SQL Server 2014
  • Upgrade to SQL Server 2012
  • Migrate SQL Server 2000 to SQL Server 2012
  • ALTER DATABASE Compatibility Level (Transact-SQL) SQL Server 2012
• SQL Server Rights Requirements: SQL Server no longer automatically creates the BUILTIN\Administrators role delivered in earlier, unsupported versions SQL Server. The Application Server installation process will create the necessary operating system user group (aaAdministrators) and SQL Server role. This automated process will provide the rights required to allow operations within the Galaxy Repository without the need for blanket BUILTIN\Administrator rights. The aaAdministrators group must be present and enabled. If you accidentally delete the aaAdministrators group from the Windows operating system, you can run either of two options to restore it:
  • Run the Change Network Utility from the Windows Start menu.
  • Run the aaConfig SQL Utility from the Windows Start menu.

  If you accidentally delete the aaAdministrators group from the SQL Server security logins, you must run the aaConfig SQL Utility to restore it. Refer to the Application Server User's Guide, "About ArchestrA User Accounts", for further information and procedures about restoring the aaAdministrators group.

Considerations for SQL Server Express

• SQL Server Express is supported for use on an Application Server or Historian node, but is recommended for use only in small or development configurations. SQL Server 2017 Core is automatically installed when you select Application Server (with the Galaxy Repository selected) or the Historian, if, at time of installation, no other SQL Server elements are installed on the computer.
• The computing capacity of SQL Server Express is limited to the lesser of one CPU socket or four processor cores.
• For InTouch HMI-only installations, SQL Server is no longer a requirement since InTouch HMI 2020 has been reconfigured to work without a Galaxy Repository.

Additional SQL Server Notes for Application Server

• Only 64-bit versions of SQL Server are supported.
• If multiple versions of SQL Server are installed, the one used as the Galaxy Repository must be the default instance. Named instances are not supported.
• The Galaxy Repository locks the SQL Server maximum memory usage to 65% of the computer's physical memory.
• TCP/IP must be enabled on the computer hosting a SQL Server database. The TCP/IP protocol setting can be verified from the SQL Server Network Configuration under SQL Server Configuration Manager.
• To use the Alarm DB Logger with SQL Server Express, you need to change the default authentication mode from Windows-based to Mixed Mode.

Third-Party Application Prerequisites

For Historian Client:

• Microsoft Office is optional. If you install Office after installing Historian Client, the Historian Client add-ins do not appear in the list of Office add-ins. Run the Historian Client installation program and repair the installation to load the Office add-ins.
• When you perform a custom installation of Microsoft Office (32-bit), you must install Office Shared Features and Office Tools so that the Historian add-ins for Workbook or Report can be loaded. Note: Make sure that you are not using the Microsoft Office 64-bit version.

System Platform Installation

For detailed installation instructions in English, see the AVEVA System Platform Installation Guide (SP_Install_Guide.pdf) or AVEVA System Platform Installation Help (SP_Install_Guide.chm). The installation guide supersedes the separate installation guides for the individual products. The Installation Guide pdf file is located in the root directory of the System Platform installation DVD. The Installation Help chm file is located in the InstallFiles directory of the installation DVD.

The information provided in this Readme file and the InTouch Readme file supersedes the InTouch HMI Installation Help (Install-InTouch.chm) for the French, German, Japanese, and Simplified Chinese languages.

Before Installing System Platform

• Installing System Platform 2020 on a computer used as a domain controller is not supported. For more information, see the Microsoft Security Best Practices Checklist.
• Some AVEVA products released prior to System Platform 2020 must be installed BEFORE you install System Platform, if the product will be installed on the same node as System Platform. These are:
  • Alarm Adviser (2014 R2 SP1 and prior versions)
  • Intelligence (2014 R3 and prior versions)
  • Recipe Manager Plus (Update 1 and prior versions)
  • Skelta BPM 2017 R2 (Update 1 and prior versions)

About the ArchestrA User Account

The ArchestrA user account is a user name and password combination that enables inter-node communication between all computers in an ArchestrA environment. You must specify the same user account on every node when you install the System Platform components for the first time on computers that communicate with each other.

WARNING! The ArchestrA user account is a Windows operating system account located on the local computer or on a domain. Do not delete this account with operating system account management tools. If you do, ArchestrA-enabled software may stop functioning properly.

• If the ArchestrA user account has not previously been configured, you will be prompted to configure it during the System Platform installation. You must specify a user name, password, and domain.
• If you use an existing user account, it must have a permanent password that does not expire, and the password cannot be changed.

After you install a System Platform component, you can use the ArchestrA Change Network Account utility to change or re-create the ArchestrA user account. The Start menu contains a shortcut to the utility. It is under the AVEVA Utilities folder.

You must have Administrator privileges to use the Change Network Account utility. For more information, see the Change Network Account utility help

Note: If you re-create 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 node. Until that occurs, the ArchestrA component may not function properly. Restarting the Galaxy node updates this information immediately.

System Monitor Installation and Configuration

We highly recommend the following System Monitor installation and configuration sequence. For more information and details, please see “Configuring the System Monitor Agent" and "Configuring the System Monitor Manager” in the System Platform Installation Guide.

1. Install System Platform.
2. Start the Configurator:
   1. Configure AVEVA Enterprise Licensing Platform > AVEVA Enterprise License Server
   2. Configure Common Platform > System Management Server
   3. On all machines with System Platform products, configure the AVEVA System Monitor > System Manager
   4. On the System Monitor Manager machine, configure the AVEVA System Monitor > Alert Email Server
   5. Configure the remaining product plug-ins.
   6. Restart your system.

Re-Connecting to System Management Server after Hardware Replacement or VM Restoration

If you connect a machine to the System Management Server and then later replace the machine due to hardware failure, or restore the VM to a state prior to that connection without first disconnecting the machine from the System Management Server, you will not be able to reconnect that same machine to the System Management Server.

Cause:

To protect the security of the system, the System Management Server uniquely identifies each machine that connects to it. If an intruder attempts to pretend to be that machine (spoofing) and re-registers with that machine’s name, the System Management Server will detect the mismatched identity and reject the suspected intruder’s registration.

Solution:

• Before replacing a connected machine, and/or restoring the connected VM to a pre-connected state, run the Configurator on that machine and disconnect it from the System Management Server.
• If that is not possible (i.e., the machine is no longer available due to hardware failure), then you will need to remove the connection information on the System Management Server manually:

  After attempting to reconnect the machine, the logger will contain the warning:

  “ArchestrA.CertificateManager: Please un-register the device <device name> from management server. Use the (Remove-AsbDevice) script to remove the device registration”

  The PowerShell command will remove the machine’s connection information from the System Management Server. We recommend that you contact your support team, or AVEVA Global Customer Support (GCS), for assistance with executing this command.

System Platform Upgrade and Migration

IMPORTANT! You can only upgrade to System Platform 2020 if the prior version was installed on a 64-bit operating system.

You can upgrade directly to System Platform 2020 from System Platform 2014 R2 SP1 or later, provided the prior version was installed on a 64-bit operating system.

Upgrading is defined as installing a newer version of the software when a previous version of the software exists. An upgrade is possible when the system requirements (operating system, SQL Server, .NET Framework) are met. The upgrade process will properly remove or uninstall the previous software version and install the new version. For versions older than the current and previous licensed versions, only the latest service pack or patch versions are tested. For distributed systems, some products must be upgraded in a particular order. For more information, see upgrade information for each product in the System Platform Installation Guide.

The earliest versions of Windows that support System Platform 2020 are:

• Windows 8.1, Professional or Enterprise Editions
• Windows Server 2012 Datacenter Edition (Standard Edition is not supported)

See the GCS Technology Matrix for complete information about operating system that you can use with System Platform 2020 products.

IMPORTANT! Back up any relevant application configuration files or databases before you start an upgrade or migration.

Licensing Information

Once installed, a link to the AVEVA Enterprise License Manager can be found in the \AVEVA folder on the Start menu.

It can also be accessed by pointing your browser to the following URL:

http://<nodename>/AELicenseManager

where <Nodename> is localhost or the name of the node where the AVEVA Enterprise License Manager is installed.

License Server

The AVEVA Enterprise License Server can be installed separately from the AVEVA Enterprise License Manager.

Running both InTouch HMI and InTouch OMI in a Session on an RDS Server

In System Platform 2020, running both InTouch HMI and InTouch OMI in a session on an RDS Server will attempt to acquire two (2) Supervisory Client Server (unlimited) licenses instead of one (1).

If you have purchased a Supervisory Client Server license (unlimited RDP sessions on a single server) and then run both InTouch HMI and InTouch OMI simultaneously, there can be issues acquiring the server license due to differences in how the license is handled between the two. The order of startup will impact the results.

This behavior is seen in only a limited number of instances, only when you have purchased a Subscription license. If you do see this behavior, change the order of InTouch HMI and InTouch OMI startup.

If this behavior continues, contact AVEVA Software Global Customer Support (GCS), describe the behavior, and request a temporary license, typically valid for 60-days.

InTouch OMI and InTouch HMI ViewApp License Reservation Device Name for Client Devices, RDP Servers, and Users

License Reservation

Reserving a license for a specific device ensures a license will be available for that specific device whenever it is needed, regardless of the number of devices connected to the system. Keep in mind, each license can only be reserved to a single device, so if the device names are unknown ahead of time, it's better to not use reservations and instead allow the licenses to be acquired on a first-come, first-serve basis.

User-based License Reservation

In the AVEVA Enterprise License Manager license reservation page it is possible to mark a license to be reserved to a specific user. While the reservation page allows this particular configuration, it's important to know that neither InTouch OMI nor InTouch HMI ViewApps support user-based license reservations. The end-result will be the inability for the software to acquire the license reserved. Therefore, only use device-based reservations for Supervisory Client licenses.

Device-based License Reservation

When reserving a Supervisory Client license for a specific device, the Device Name needs to be the name of the computer running the InTouch HMI/OMI ViewApp. In the case where the ViewApp is running inside of a Remote Desktop Session, on an RDS (aka: Terminal Server), then the Device Name needs to follow this naming pattern:

<RDSHostName>-<RDPClientName>-<index>

where RDSHostName is the name of the Remote Desktop Server (aka: RDS or Terminal Server), and RDPClientName is the name of the PC running the RDP client software, and "index" is 1, unless there will be multiple RDP sessions from a single client machine, in which case the index should be incremented (starting at 1) for each reservation for that specific RDP client, up to the total number of RDP sessions from that specific RDP client.

Reservation Examples

Situation: A computer with a hostname of "ControlRoomA" runs InTouch OMI

Device Name: "ControlRoomA"

Situation: A computer with a hostname of "ControlRoomB" running a single Remote Desktop Client (RDP), connecting to the Remote Desktop Server (aka: Terminal Server) with a hostname of "PrimaryRDS"

Device Name: "PrimaryRDS-ControlRoomB-1"

Situation: Two computers with hostnames "SupervisorPC1" and "LineMgrA", respectively, each running a single Remote Desktop Client (RDP) connecting to the Remote Desktop Server (aka: Terminal Server) with a hostname of "PrimaryRDS"

Device Names:

• License Reservation 1: "PrimaryRDS-SupervisorPC1-1"
• License Reservation 2: "PrimaryRDS-LineMgrA-1"

Situation: A computer with a hostname of "ExecutiveDesktop" running four (4) Remote Desktop Clients (RDPs), connecting to the Remote Desktop Server (aka: Terminal Server) with a hostname of "PrimaryRDS"

Device Names:

• License Reservation 1: "PrimaryRDS-ExecutiveDesktop-1"
• License Reservation 2: "PrimaryRDS-ExecutiveDesktop-2"
• License Reservation 3: "PrimaryRDS-ExecutiveDesktop-3"
• License Reservation 4: "PrimaryRDS-ExecutiveDesktop-4"

AVEVA Enterprise Licensing Support for High Availability (HA) and Disaster Recovery (DR) in Virtual Environments

Virtual Environments: License Servers are supported in virtual environments. However, under certain circumstances, such as transferring a license from one virtual environment to another, the License Server may interpret the transfer as an improper move and therefore go into grace period.

High Availability: License Servers in a High Availability virtual environment are supported in specific topologies. Basic redundancy topologies are described in the AVEVA Enterprise Licensing online help.

Disaster Recovery: License Servers in a Disaster Recovery virtual environment will go into a grace period during DR activities. This is because DR activities are similar to an improper move of licenses and will trigger a grace period.

To avoid a grace period trigger in a DR virtual environment, we recommend that you run the License Server outside the virtualized DR environment and use a redundant License Server configuration through the functionality built into the License Server software. Another option is to purchase Disaster Recovery licenses at a discounted rate and establish a backup License Server with these additional licenses.

In all environments, we recommend you install and run the AVEVA System Monitor to monitor licensing functionality and view alerts on issues such as a License Server going into grace period or licenses expiring.

Hyper-V Virtual Environment

High Availability (HA) in a Hyper-V virtual environment does not activate licensing grace period during a failover as monitored environmental variables do not change.

Disaster Recovery (DR) in a Hyper-V virtual environment activates a licensing grace period as monitored environmental variables do change.

VMWare Virtual Environment

High Availability (HA) in a VMWare virtual environment does not activate licensing grace period during a failover as monitored environmental variables do not change.

Disaster Recovery (DR) in a VMWare virtual environment activates a licensing grace period as monitored environmental variables do change.

Antivirus Software

Antivirus Software should be implemented as part of a defense-in-depth strategy to secure your Industrial Control Systems. TechNote TN2865, available from the AVEVA Global Customer Support (GCS) web site, lists important information about antivirus software. Enter your GCS credentials to access the Tech Note.

https://softwaresupportsp.aveva.com/#/okmimarticle/docid/tn2865

Resolved Issues

See the product-specific Readme files for resolved issues.

Known Issues

The following important known issues are listed by their assigned CR or reference number in ascending order. Additional known issues are documented in the product-specific Readme files.

• Install/Uninstall and Galaxy Migration Issues
• ASB, PCS and MGC Issues
• InTouch OMI Issues
• Map App / Mobile Access Issues
• Application Server Issues
• InTouch HMI Issues
• InTouch Access Anywhere Issues
• Historian Issues
• Licensing Issues
• System Monitor Issues

ASB, PCS and MGC Issues

• ASB: ArchestrA Service Bus
• PCS: Platform Common Services
• MGC: Multi-Galaxy Communication

  1278013	In certain multi-galaxy environments (MGC) running different versions of System Platform and using OS User Security, Verified Writes from InTouch to an attribute on another Galaxy node do not succeed. This occurs where one node is running System Platform 2014 R2 SP1, and a Verified Write is attempted from an InTouch window to an attribute on another node that is running System Platform 2020. Both nodes have InTouch and the GR installed. The following error message is logged: "Write attempt failed for the following reason: 'Security error: 8018'." However, Verified Writes from Object Viewer are successful. Workaround: When performing a Verified Write from an InTouch window, enter the user name in the format ".\<UserName". Do not use the format "<LocalMachineName>\<UserName>".
  1263702	When upgrading from a node with Platform Common Services (PCS) 4.3.3 installed, such as the case when upgrading from System Platform 2107 Update 3 SP1 or installing on a node with RMP 2017 Update 2, errors are logged while deploying the OPCUA service. However, the service is deployed successfully. The errors are similar to the following: Application certificate does not have an application URI: CN=AZURE2019 Failed! UnifiedAutomation.UaBase.StatusException: Application certificate does not have an application URI: CN=AZURE2019 at UnifiedAutomation.UaBase.ApplicationInstanceBase.LoadApplicationCertificate(ApplicationDescription application, String hostName, Boolean silent) at UnifiedAutomation.UaBase.ApplicationInstanceBase.CheckConfiguration(Boolean silent) at UnifiedAutomation.UaBase.ApplicationInstance.Start(ServerBase server, WaitCallback callback, Object userData, Boolean silent) at PCS.Provider.OpcUa.UaServerHostedService.StartApplication() at PCS.Provider.OpcUa.UaServerHostedService.<ExecuteAsync>d__7.MoveNext() Workaround: Upgrade all nodes and install and configure PCS 4.4 on each. On the node that will function as the OPC UA Server, select the "No System Management Server configured" option and finish configuration. Start the Configurator again (reboot if necessary), and configure the System Management Server option as applicable for your system.
  1161407	With only run-time components of System Platform Update 3 or Update 3 SP1 already installed, the following error is encountered when installing InBatch 2014 R3SP1, Batch Management 2017, or RMP 2018 SP1: "Error 1603 A newer version of Archestra Service Bus Framework 4.2.2 is already installed." Workaround: Install InBatch/Batch Management/RMP first and then install System Platform 2017 Update3 or Update3 SP1. You will be prompted to upgrade ASB Framework and Licensing, Once this is complete, rerun System Platform installation to add products and components.
  	Alternate workaround: If you choose to install System Platform 2017 Update3 or 2017 Update3 SP1 first, then: Select and install GR components (not just run-time components), and then install InBatch/Batch Management/RMP.
  1111134 1121155	In some circumstances, when using the Configurator to configure the System Management Server, you may be prompted to enter your user credentials. This may happen if the logged-in user does not belong to the aaAdministrators or Administrators OS group. If you are a member of either of these groups, enter your user name as DomainName\UserName. The logged-in user should be a direct member of the aaAdministrators or Administrator group. Using the credentials for a user that belongs to nested groups is not supported. That is, you cannot use credentials that belong to a group that is part of aaAdministrators or Administrators. If you are not a member of aaAdministrators or Administrators on the local machine, you can obtain configuration privileges for another OS group by editing the file appsettings.json, and adding the name of the OS group to the file. The full path for this file is: C:\Program Files (x86)\AVEVA\Platform Common Services\Management Server\appsettings.json. To add an OS group to the file, add the new OS group after "aaAdministrators." "AppSettings": { "AllowGroups:: [ "aaAdministrators", "insert new group name here" ]
  1116282	In a very small set of multi-galaxy (MGC) environments, communications between some System Platform subscribers and a system service they subscribe to may not be secure. In these circumstances, communications still occur, but may not be secure. If all the following elements exist in an MGC topology, communications may occur over an insecure channel: Galaxies are installed across multiple domains. Multi-Galaxy Communication (MGC) is used. One of the following subscribers is on one domain and the MxDataProvider service to which it is subscribed is on another domain: WindowViewer Object Viewer An AppEngine that has input extensions on another galaxy Workaround: To ensure that communications are always secure, update the config files as follows. Locate aaEngine.exe.config and view.exec.config in the ArchestrA\Framework\Bin directory. Add the following to the <runtime> section of each file: <AppContextSwitchOverrides value="Switch.System.IdentityModel.DisableMultipleDNSEntriesInSANCertificate=false" /> Create the config file aaObjectViewer.exe.config in the ArchestrA\Framework\Bin directory. Add the following text to aaObjectViewer.exe.config: <configuration> <runtime> <AppContextSwitchOverrides value= "Switch.System.IdentityModel.DisableMultipleDNSEntriesInSANCertificate=false" /> </runtime> </configuration>
  L00141660	In a system with two GR nodes, attempting to connect from the IDE on one node to a Galaxy on the second GR node does not succeed, and the IDE shuts down. Workaround: Pair the GR nodes before trying to connect to the Galaxy on the other node. See "Working with Multiple Galaxies > Setting Up a Multi-Galaxy Environment" in the Application Server User Guide for information about configuring multi-Galaxy pairing.
  L00139918	Uninstalling Wonderware InBatch versions 10.2 or 11.0 installed on a System Platform 2014R2 SP1 system results in a failure to connect to ArchestrA Service Bus (ASB) services. If you uninstall either of these InBatch versions then cannot connect to ASB services, run a repair on System Platform 2014R2 SP1 using Windows' Add/Remove Programs utility.
  L00133534	Undeploying a galaxy with Object Viewer active will cause Object Viewer to shut down with an informational message that requires acknowledgement (click OK) to complete the shutdown. In a multi-galaxy configuration, with Object Viewer open, undeploying a paired Galaxy, then redeploying the galaxy without properly shutting down Object Viewer, can cause ASB services to fail to reconnect to the redeployed galaxy. To avoid this condition, click OK to shut down Object Viewer before redeploying the galaxy.
  L00123474	Writing from InTouch to a remote galaxy using indirect tags can fail for some of the remote references. Object Viewers on two different nodes may show different values for the same reference. You can avoid this issue by deactivating Advanced Communication Management in the IDE. Additionally, if you use the same indirect tag with scripting more than one time, you can modify your scripts to set the indirect tag's name property to an empty string after the loop completes. For example, in the following script snippet, you would add the line highlighted with bold text:   IF bRunScript  THEN     FOR tagval = 1 TO 3       indirect.Name = "Testtag" + Text(tagval, "0");              IF indirect.Value > 4  THEN                 indirect.Value  = 0;             ELSE                 indirect.Value  = indirect.Value  + 1;                 indirect.Value  = indirect.Value  + 1;             ENDIF;           NEXT;       indirect.Name = ""; ENDIF;
  L00123462	In a multi-galaxy environment, you can pair galaxies by IP address rather than using a node name (computer machine name). Unpairing galaxies identified by IP address fails when NetBIOS and DNS solutions are unavailable. Where your galaxies are identified by IP address, you must create a temporary host file to map the IP addresses as hostnames for purposes of unpairing. For example, Node1 and Node2 are identified by IP address and are paired. To unpair them, do the following: Navigate to the Hosts file on Node1. In Windows 7 and Windows 2008 R2 operating systems, the Hosts file typically can be found at C:\Windows\System32\Drivers\Etc\. Open the Hosts file in Notepad. In Windows 7 and Windows 2008 R2 systems, you should right click the Notepad executable, and click Run as Administrator, then open the Hosts file from inside Notepad. Alternatively, you can click Start, then click Run, then enter the following command in the text box: notepad c:\Windows\System32\Drivers\Etc\Hosts. Edit the Hosts file: Enter the IP address for Node2. On the same line as the IP address, provide a node (computer) name. Enter IP addresses and node (computer) names for each node identified by IP address to be unpaired. Save and close the Hosts file. You should now be able to unpair the galaxies.

Install/Uninstall and Galaxy Migration Issues

InTouch OMI Issues

Application Server Issues

Map App / Mobile Access Issues

InTouch HMI Issues

The following known issues are in addition to those documented in the InTouch HMI Readme.

InTouch Access Anywhere Issues

The following known issue is in addition to those documented in the InTouch Access Anywhere Readme.

Historian Issues

Licensing Issues

System Monitor Issues

The following known issues are in addition to those documented in the AVEVA System Monitor Readme.

ArchestrA Alarm Control Issues

If you create a filter for a history block query that results in no matches, "Not Connected" appears in the status bar and a warning is logged to the ArchestrA Logger. The status bar should show "Connected" even though no matches are returned.

Documentation

The System Platform documentation is available Adobe Acrobat .pdf files that are available from the following locations on the System Platform DVD:

InstallFiles\CD-ApplicationServer\UserDocs

InstallFiles\CD-Historian\UserDocs

InstallFiles\CD-HistorianClientUserDocs

InstallFiles\CD-Intouch\UserDocs

In addition, InTouch OMI Help is installed as web help when Application Server is installed. The web help is contained in a zip file in the InstallFiles\CD-ApplicationServer\UserDocs folder on the System Platform DVD. After Application Server installation, it can be launched from the following URL:

<System Drive>:\Program Files (x86)\ArchestrA\Framework\Docs\1033\NGX\index.htm

InTouch OMI Help can also be invoked from within the Application Server IDE by selecting an InTouch OMI object, such as a layout, screen profile, or InTouch OMI ViewApp, and pressing Ctrl + F1.

To view the PDF documentation, you must first download the latest version of Adobe Reader from the Adobe Corporation web site: http://www.adobe.com/products/acrobat/readstep2.html.

You can also access online Help systems from within the software.

• Common Components and Utilities User Documentation
• InTouch HMI Documentation
• Application Server Documentation
• Historian Server Documentation
• Historian Client Documentation

Common Components and Utilities User Documentation

• System Platform Installation Guide. This guide provides information on installing the System Platform, including hardware and software requirements and migration instructions.
• Log Viewer User's Guide. Explains how to use the Log Viewer utility to determine system diagnostics.
• Log Flag Editor Utility Guide. Explains how to turn on and off certain diagnostics logging messages.

InTouch HMI Documentation

• The InTouch HMI Application Management and Extension Guide. Describes how to create and manage InTouch applications locally and in a network environment.
• InTouch HMI Data Management Guide. Describes how to work with data items in the InTouch HMI and connect your application to the physical devices in your plant environment.
• InTouch HMI Visualization Guide. Describes how to develop the graphical operator interface of an InTouch application.
• InTouch HMI SmartSymbols Guide. Describes how to create reusable templates for graphic symbols that can save you a lot of engineering time and effort.
• InTouch HMI and ArchestrA Integration Guide. Describes how to integrate the InTouch HMI and ArchestrA technology to develop more robust applications that use richer graphics.
• InTouch HMI Alarms and Events Guide. Describes how to configure alarms for your data items, how to view and acknowledge alarms, and how to use the alarm clients and utilities supplied with the InTouch HMI.
• InTouch HMI Scripting and Logic Guide. Describes how to write scripts in the InTouch HMI to automate common tasks and processes. This guide includes a reference of the InTouch scripting language and functions.
• InTouch HMI Supplementary Components Guide. Describes software components that you can optionally install and use with the InTouch HMI.

Application Server Documentation

• AVEVA Application Server User Guide. Explains configuring and deploying Application Server applications.
• Creating and Managing Industrial Graphics User Guide. Explains how you create and manage graphical symbols using the Industrial Graphics Editor within the Integrated Development Environment (IDE).
• AVEVA Application Server Scripting Guide. Reference for the scripting language in Application Server.
• Object Viewer User Guide. Explains how to acquire run-time data using the Object Viewer.
• Guide to the ArchestrA Alarm Control. Explains how to configure the alarm control (client) to show current and historical alarms and events in a grid.
• Guide to the ArchestrA Trend Client. Explains how to configure a chart to trend real-time data values.
• Platform Manager User Guide. Explains how to start and stop system components.
• Galaxy Database Manager User Guide. Explains how to backup and restore the Galaxy database.
• InTouch HMI and ArchestrA Integration Guide. Explains how you can use the ArchestrA Integrated Development Environment (IDE) to manage InTouch HMI applications so that you can use symbols you create in the Industrial Graphics Editor.
• InTouch OMI Help. Explains how you can use the InTouch Operations Management Interface (OMI) to create visual applications (ViewApps) that incorporate the functionality needed by both operational and information technology teams in a production environment. Access to this help is available by pressing F1 when using the ViewApp, Layout, Screen Profile, or External Content editors. These editors are launched through the Application Server IDE.

Historian Server Documentation

• Historian Concepts Guide. Provides an overview of the entire Historian system and describes each of the subsystems in detail.
• Historian Administration Guide. Describes how to administer and maintain an installed Historian, such as, configuring data acquisition and storage, managing security, configuring replication, and monitoring the system.
• Historian Database Reference. Provides documentation for all of the Historian database entities, such as, tables, views, and stored procedures.
• Historian Glossary. Provides definitions for terms used throughout the documentation.

Historian Client Documentation

• Historian Client Software User's Guide. Describes how to use stand-alone applications, Microsoft Office add-ins, and ActiveX and .NET controls to retrieve and display data.

Documentation Issues

This section lists important System Platform documentation corrections. For documentation corrections for individual System Platform products, see the individual product Readme files.