System Platform 2020 R2 SP1 Patch 01 Released

About This Patch Release

Changelog: System Platform 2020 R2 SP1 Patch 01

Change Description

Miscellaneous bug fixes

Incorporate HotFixes – all products

Fix for DCOM hardening issue. Additional information is listed below.

SuiteLink uses OpenSSL 1.1.1q for secure communication.

Supported System Platform Versions for Product Upgrade

This patch can be applied to System Platform 2020 R2 SP1 only.

Important! System Platform does not support mixed Windows workgroup/domain environments. As stated in the System Platform Installation Guide, while workgroups are supported, domain-based networking is recommended. However, you cannot use workgroup nodes within a domain environment.

Future Upgrade (after applying Patch 01)

If you upgrade a node to System Platform 2023 after this patch is applied, you may need to apply a HotFix or patch after the upgrade to ensure that all fixes in this patch are preserved. This is because System Platform 2020 R2 SP1 Patch 1 is being released after System Platform 2023, and as result, there may be HotFixes included in this patch that were not included in System Platform 2023. If needed, a compatible HotFix or patch for System Platform 2023 will be issued. Please contact AVEVA Customer Support if you have any questions.

DCOM Hardening

Prior to this patch release for System Platform 2020 R2 SP1, DCOM hardening in Microsoft Windows caused a minor issue for the OPCClient object in the System Platform IDE during design time, which prevented the OPCClient object from browsing for remote OPC servers or remote OPC references during design-time. There was no impact on run-time functionality.

The issue is resolved for Application Server in this patch release. Other components, however, may require a HotFix. Should you encounter issues, contact AVEVA Customer Support.

Insight Publisher

To ensure that you have the latest security enhancements, we recommend that you download and install the latest version of Insight Publisher after you finish installing this patch. Go to https://online.wonderware.com/downloads and click the DOWNLOAD button for Insight Publisher.

ReadMe Files for Other Products in this Release

The extracted patch files include a ReadMe directory with the ReadMe files for each individual component product. To access the product ReadMe files, navigate to the applicable folder under the ReadMe directory. Review the known and resolved issues contained in each file as applicable.

Known Issues

The following known issues have been found in System Platform 2020 R2 S1 P01. See the product-specific ReadMe files for any additional issues.

Issue Number

Description

IMS 2109000

When patch 01 is applied to a node that is running both System Platform 2020 R2 SP1 and AVEVA Mobile Operator 2020 R1, the AIM Token Host Service is unable to start.

Cause: Mobile Operator only works in Enterprise mode. This requires removal of the Custom User Store, and that the application be configured to use an Active Directory domain.

Workaround: Remove the Custom User Store and configure Mobile Operator in Enterprise mode.

  1. Launch the PowerShell as Administrator and run the following command:

    Remove-PcsCustomUserStore

  2. Start the AIM Token Host Service.
  3. Launch the command prompt as Administrator and run the following command:

    wmic group where name=<Domain Admins> get name,sid,domain

    Replace the Domain Admins group name in the “where” clause with the AD group
    name that will be used for Mobile Operator users.

  4. Copy the `SID` value from the result, the paste it into the SQL script “Associate existing Group with an AD/Azure AD Group” at the point in the script that sets the
    ExternalID (SET @ExternalId = N’SIDvalue‘).
  5. In the SQL script, pass in the user ID at the line, “SET @UserLoginName = N'< login id >.”
  6. Copy and run the SQL script (below) to associate an existing Mobile Operator group with the AD group.
  7. After the script has executed successfully, relaunch or refresh the Mobile Operator web application. This changes the Authentication Mode to enterprise.

    Note: If the user is not part of the Tenant group, you will need to run an additional SQL script to
    add the user prior to opening the Launch Management Center, as described below.

  8. Open the Launch Management Center and enter your Windows credentials in the username
    and password fields in the Login dialog. For subsequent launches, you can select the checkbox
    to use “Windows login” in the Login dialog.

/****************Associate existing Group with an AD/Azure AD Group**********************/

DECLARE @ExternalId nvarchar(500), @ADDomainName nvarchar(64), @GroupName
nvarchar(250), @DepartmentId UNIQUEIDENTIFIER, @ExistingGroupName nvarchar(250)

SET @ExternalId = N'<Provide ExternalId (SIDvalue) here>’

/* The SID of the AD or Azure AD Group you want to associate */

SET @GroupName = N'<Provide the Group/Department name that needs ExternalId to
be mapped>’

SET @ADDomainName = N'<Provide AD/Azure AD Domain Name here>’

SET @ExternalId = LTRIM(RTRIM(@ExternalId));

SET @GroupName = LTRIM(RTRIM(@GroupName));

SET @ADDomainName = LTRIM(RTRIM(@ADDomainName));

— Check for empty ExternalId

IF @ExternalId = ” OR @ExternalId = N'<Provide ExternalId here>’

BEGIN

PRINT ‘ExternalId is required.’

RETURN

END

— Check for empty Group Name

IF @GroupName = ” OR @GroupName = N'<Provide the Group/Department name that needs
ExternalId to be mapped>’

BEGIN

PRINT ‘Group Name is required.’

RETURN

END

— Check for empty Domain name

IF @ADDomainName = ” OR @ADDomainName = N'<Add AD Domain Name here>’

begin

PRINT ‘Domain Name is required.’

RETURN

END

— Check if the Group name exists in the database

SELECT @DepartmentId = DEPARTMENT_PK FROM ISMGT_DEPARTMENT WHERE NAME = @GroupName

IF (@DepartmentId IS NULL)

BEGIN

PRINT ‘Group does not exists in ISMGT_DEPARTMENT table’

RETURN

END

— Check if the External Id is mapped to different Group

SELECT @ExistingGroupName = NAME FROM ISMGT_DEPARTMENT WHERE ExternalID =
@ExternalId AND DEPARTMENT_PK <> @DepartmentId

IF (@ExistingGroupName IS NOT NULL)

BEGIN

PRINT ‘External Id is already mapped to different Group –
‘+@ExistingGroupName+”

RETURN

END

BEGIN

UPDATE ISMGT_DEPARTMENT

SET

ExternalID = @ExternalId,

ADDomainName = @ADDomainName

WHERE

DEPARTMENT_PK = @DepartmentId

END

/***********************End of SQL Script***************************************/

If the user is not part of the Tenant group, run the following SQL script to add the user.

/***********************Add user as Tenant Admin***************************************/

DECLARE @UserLoginName nvarchar(25)

SET @UserLoginName = N'< login id >’

DECLARE @adminId uniqueidentifier, @departmentPK uniqueidentifier, @userFk
uniqueidentifier

SELECT @adminId = UserPK FROM ISMGT_USER where LOGIN_ID = @UserLoginName

IF (@adminId is null)

BEGIN

Print ‘User not found – unable to add’ + @UserLoginName + ‘ as Tenant Admin.’

END

ELSE

BEGIN

select @userFk = USER_FK from ISMGT_USER_DEPARTMENT_LINK where USER_FK =
@adminId AND
DEPARTMENT_FK = ’73B9685A-765D-47A8-ADE9-EB5AFC3B3B62′

IF (@userFk is null)

BEGIN

insert into ISMGT_USER_DEPARTMENT_LINK VALUES (@adminId,
’73B9685A-765D-47A8-ADE9-EB5AFC3B3B62′, GETDATE(), NEWID(), NULL)

Print @UserLoginName + ‘ added as Tenant Admin.’

END

END

/***********************End of SQL Script***************************************/

IMS 2127222

Installation of Vision AI Assistant OMI App did not complete due to an inability to install Microsoft .NET Core Runtime 5.0.10, which is a prerequisite component.

Workaround:

  1. Save all installation files for Vision AI locally.
  2. Navigate to the Prerequisites.ini file for the Vision AI installer, located in the path shown below.

    <Local Vision AI Installation Files>\SignedInstaller\InstallFiles\Prerequisites.ini

  3. Find the existing sections of the .ini file shown below, and replace the sections with the new text (also shown below).
  4. Save the ini file and re-run Vision AI installation.

Existing Text:

[NET48.Registry]

Hive=HKLM

Key=SOFTWARE\Microsoft\NET Framework Setup\NDP\V4\Full

Item=Version

Minver=4.8

Name=Microsoft.Net Framework 4.8 Setup

Comment=Product installation requires Microsoft.NET Framework 4.8

InstallCmd=\Redist\DOTNET\v4\ndp48.exe /q /norestart

RebootStatus=AfterInstall

[DOTNET512.Registry]

Hive=HKLM

Key=SOFTWARE\dotnet\Setup\InstalledVersions\x64\sharedhost

Item=Version

Minver=5.0.10

Name=Microsoft.Net Core Runtime 5.0.10

Comment=Product installation requires Microsoft.Net Hosting Bundle (x64)

InstallCmd=\Redist\DOTNET\v5\dotnet-hosting-5.0.5-win.exe /q /norestart

RebootStatus=AfterInstall

===========================================

Replace With:

[DOTNET.RegValue]

Hive=HKLM

Key=SOFTWARE\Microsoft\NET Framework Setup\NDP\V4\Full

Item=Release

MinVal=528040

Name=Microsoft .NET Framework 4.8

Comment=Product installation requires Microsoft.Net Framework 4.8

InstallCmd=\Redist\DOTNET\4.8\NDP48-x86-x64-ALLOS-ENU.exe /q /norestart

InstallFailureMsg=An error occurred while attempting to install the prerequisite
Microsoft .NET Framework 4.8.\n\nYou can try installing it manually from
here:\n<Media>\InstallFiles\Redist\DOTNET\4.8\ndp48-x86-x64-allos-enu.exe.
\n\nIf you continue to encounter installation problems we recommend you refer to
the following Microsoft technical note on how to update Windows to prepare it for
Microsoft .NET Framework 4.8:\n\nhttps://support.microsoft.com/en-in/help/4486153

RebootStatus=immediate

[DOTNET512.Check]

Name=Microsoft .NET 5.0.10 – Windows Server Hosting

Comment=Required Component

Architecture=x64

Prereq1=DOTNET512.Alternate.RegValue

[DOTNET512.Alternate.RegValue]

Hive=HKLM

Key=SOFTWARE\WOW6432Node\dotnet\Setup\InstalledVersions\x64\hostfxr

Item=Version

MinVer=5.0.10

Name=Microsoft .NET 5.0.10 – Windows Server Hosting

Comment=Product installation requires Microsoft.Net Hosting Bundle (x64)

InstallCmd=\Redist\DOTNET\v5\dotnet-hosting-5.0.5-win.exe /q /norestart

RebootStatus=AfterInstall

IMS 2145207

In some circumstances which can occur during System Platform restart after patch installation, error messages stating that AlarmMgr is not running are logged multiple times while the system is shutting down. These messages are related to Insight Publisher and repeat until the publisher processor shuts down, and are similar to the following:

Error aahAlarmPublisher WNALGetStatistics AlarmMgr not running

Error aahAlarmPublisher WNALEndPaint AlarmMgr not running

Error aahAlarmPublisher WNALBeginPaint AlarmMgr not running

These messages do not have any impact on system functionality or impede the patch process. You can safely ignore these messages. When the system restarts, patch installation is complete and Insight Publisher will function normally.

— End of Patch 01 ReadMe —

AVEVA™ System Platform 2020 R2 SP1 Readme

Last revision: 10/29/2021

This document contains important information about AVEVA System Platform 2020 R2 SP1.

Important: 32-bit operating systems and 32-bit SQL Server versions are no longer supported. This version of System Platform 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.

Related Topics

AVEVA™ System Platform 2020 R2 SP1 Patch 01 ReadMe

Included in This Release

About This Patch Release

Included in This Release

Program Name

Version

AVEVA Application Server 2020 R2 SP1 including AVEVA OMI

20.1.100

AVEVA Communication Drivers Pack 2020 R2 SP1

7.2.200

AVEVA Enterprise License Manager

3.7.002

AVEVA Enterprise License Server

3.7.002

AVEVA Enterprise Licensing Platform

3.7.002

AVEVA Historian, formerly Wonderware 2020 R2 SP1

20.1.100

AVEVA Historian Client 2020 R2 SP1

20.1.100

AVEVA InTouch HMI, formerly Wonderware 2020 R2 SP1

20.1.100

AVEVA InTouch Access Anywhere Server 2020 R2

20.1.000

AVEVA InTouch Access Anywhere Secure Gateway 2020 R2

20.1.000

AVEVA Platform Common Services 4.6.2

4.6.21267.2

Insight Publisher

4.4.000

System Monitor Agent Install Manager 1.4

1.4.0

System Monitor Manager 1.4

1.4.0

About This Release

Changelog: System Platform 2020 R2 SP1

Change Description

Where to Find Additional Information

Warm Failover for redundant AppEngines

Application Server User Guide, Working with Redundancy

Security enhancements, including the removal of end-of-life third-party redistributable assemblies

System Platform Installation Guide, Installing System Platform

This Readme, “Security Changes Related to End-of-Life Third-Party Components”

Miscellaneous bug fixes and hot fixes

Application Server, InTouch, Historian, and Historian Client Readmes

Operating System compatibility check

System Platform Installation Guide, Installing System Platform

Related Topics

Supported System Platform Versions for Product Upgrade

Supported System Platform Versions for Migration

Security Changes Related to End-of-Life Third-Party Components

Compatibility with AVEVA Recipe Management and AVEVA Manufacturing Execution System

Server-based Licensing

Application Object Toolkit

Start Menu and Shortcut Changes

Readme Files for Other Products in this Release

Supported System Platform Versions for Product Upgrade

You can upgrade directly to AVEVA System Platform 2020 R2 SP1 from Wonderware System Platform 2014 R2 SP1 or newer.

All existing, installed products on a node must be upgraded to the same version. Therefore, when you upgrade a node to System Platform 2020 R2 SP1, all products on the node must be upgraded to version 2020 R2 SP1.

Important! System Platform does not support mixed Windows workgroup/domain environments. Although workgroups are supported, domain-based networking is recommended. However, you cannot use workgroup nodes within a domain environment.

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 R2 SP1, 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

Security Changes Related to End-of-Life Third-Party Components

Security changes in this release include the removal of certain assemblies from Microsoft and other third-parties that have reached their end-of-life and are now out of support, and may therefore pose a security risk. Some assemblies have been removed completely as they are no longer needed to support System Platform installation. Other assemblies and executables, listed in the following table, are still included with the installation media. You are given the option to install them on an as-needed basis. Note that installation of the following components is NOT recommended. Instead, we recommend that you rebuild any custom objects and applications using currently-supported software versions.

Redistributable Description

Folder/Assembly Name

Microsoft SQL Server 2012 Management Objects SP2 (11.2.5058.0)

SQL2012SP2FeaturePack/SharedManagementObjects.msi
(x64 and x86 versions)

Microsoft System CLR Types for SQL Server 2012 SP2 (11.2.5058.0)

SQL2012SP2FeaturePack/SQLSysClrTypes.msi
(x64 and x86 versions)

Microsoft Visual C++ 2008 Redistributable

VC90SP1/vcredist_x86.exe

Microsoft Visual C++ 2010 Redistributable

VC10SP1/vcredist_x64.exe

VC10SP1/vcredist_x86.exe

You may need to install the out-of-support assemblies if you are using or migrating any of the following objects:

  • Objects that were custom-built using the Application Object Toolkit
  • Remote Response Objects
  • $FieldReference object
  • $Switch object

Both the $FieldReference and $Switch templates are discontinued ApplicationObjects, and no longer included with System Platform.

Note: If you do not install the out-of-support assemblies and import objects that have dependencies on them, you may see errors from the aaPim and WWPackageServer components while importing the objects.

The installation process requires that you acknowledge this change in behavior before you can successfully install System Platform 2020 R2 SP1. This applies to both GUI-based and command-line (silent) installation. See the following sections of the System Platform Installation Guide (SP_Install_Guide.pdf), located at the root of the DVD for additional information:

Installation Method

Installation Guide Section

GUI-based installation

Installing System Platform

Silent installation

Using Silent Installation

The end-of-life assemblies are included on the installation DVD under the InstallFiles\OutOfSupportRedist folder. If you select the option to install them now, they will be automatically installed during the installation process.

Important! Installation of out-of-support assemblies is NOT recommended.

Compatibility with AVEVA Recipe Management and AVEVA Manufacturing Execution System

There are specific requirements for installing or upgrading System Platform 2020 R2 SP1 with AVEVA™ Recipe Management and/or AVEVA™ Manufacturing Execution System (MES).

Patches must be applied to Recipe Management and MES. The patches are located on the System Platform Installation media. For instructions on applying the patches and the workflows that must be followed to successfully use System Platform on the same node with Recipe Management and MES, see “AVEVA™ System Platform 2020 R2 SP1: Compatibility with AVEVA™ Recipe Management and AVEVA™ Manufacturing Execution System” (CompatibilityReadme.htm) on the installation media.

Patch and compatibility readme location: [Install path]\Install Files\CoexistenceUpdates

Server-based Licensing

AVEVA System Platform 2020 R2 SP1 utilizes the server-based licensing subsystem introduced in System Platform 2017. This 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 Wonderware System Platform 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.

Application Object Toolkit

Microsoft .NET Framework 4.8 is required for System Platform 2020 R2 SP1. When the System Platform installation process begins, it automatically checks the .NET version and installs the correct version if needed.

The Application Object Toolkit (AOT) is not included in the System Platform 2020 R2 SP1 release, but if you use AOT to build objects for Application Server, check that you have installed and configured the developer pack for .NET 4.8 when you create your AOT solution in Visual Studio.

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 prior to System Platform 2020.

Old Name (SP 2017 Update 3 SP1 or earlier)

New Name

Type

Wonderware Utilities

AVEVA

Folder

Wonderware Documentation

AVEVA Documentation

Folder

Wonderware Historian

AVEVA Historian

Folder

Wonderware InTouch

AVEVA InTouch HMI

Folder

Wonderware System Platform

AVEVA System Platform

Folder

Sentinel System Monitor

AVEVA System Monitor

Folder

ArchestrA Service Bus Portal

Common Services Portal

Shortcut

AVEVA Enterprise License Manager

Enterprise License Manager

Shortcut

Sentinel Application

System Monitor Application

Shortcut

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:

Product

Location on Installation DVD

Application Server 2020 R2 SP1

InstallFiles/CD-ApplicationServer/Readme.html

InTouch HMI 2020 R2 SP1

InstallFiles/CD-Intouch/Readme.html

Historian Server 2020 R2 SP1

InstallFiles/CD-Historian/Readme.html

Historian Client 2020 R2 SP1

InstallFiles/CD-HistorianClient/Readme.html

InTouch Access Anywhere 2020 R2

InstallFiles/CD-Server/Readme.html

Important Notice: Windows Updates

Before installing System Platform, download and install the latest Microsoft updates to enhance security and ensure product compatibility. Allow the Windows update process to finish before you start installing System Platform. This recommendation applies to all Windows versions.

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 R2 SP1 includes various measures to strengthen security, including the ability to leverage TLS (Transport Layer Security) 1.2, provided that TLS 1.2 is 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 R2 SP1. 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 R2 SP1, 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 (requires administrator permissions). For additional information about these registry changes, see the Microsoft document, Configuring security via the Windows Registry.

    The .REG file shown below sets registry keys to their safest values.

    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 R2 SP1.

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 and 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 in System Platform 2020 R2 SP1

System Platform 2020 R2 SP1 includes the following features, as well as miscellaneous bug fixes.

New in Application Server and AVEVA OMI 2020 R2 SP1

Warm Failover

Redundant AppEngines can be configured for warm failover. This greatly reduces the time and number of scan cycles needed before the backup AppEngine becomes functional, and thus greatly reduces any data lost during failover. See the Redundancy section of the Application Server User Guide for details.

Alarm Message Translation

Alarm comment language switching (message translation) is now supported in the AVEVA OMI AlarmApp. See the Languages section of the AVEVA OMI Help.

New in InTouch HMI 2020 R2 SP1

InTouch HMI 2020 R2 SP1 (Version 20.1.100) includes a number of 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.

Cybersecurity Enhancements

This version of InTouch HMI incorporates the following cybersecurity enhancements:

  • Removal of end-of-life third-party redistributable assemblies
  • Removal of shared DLLs from GAC for Graphic Editor

New in Historian 2020 R2 SP1

This release of Historian includes the following new feature:

Licensing Enhancement

Additional product features, such as replication, can now be enabled with an incremental license without regenerating your original license.

New in Historian Client 2020 R2 SP1

This release of Historian Client incorporates miscellaneous bug fixes and hot fixes.

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. When you install the Application Server IDE, a link to the AVEVA OMI Web Help is added to the Windows start menu. 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 a Layout, ViewApp, Screen Profile, AVEVA OMI app, or External Content object and:
    • press Ctrl+F1, or
    • right-click, then select Help from the short-cut menu.
  • To open AVEVA OMI help from its installed location:

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

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

    Start > AVEVA Documentation > AVEVA OMI Help

Browser Requirements and Recommendations

Internet Explorer is recommended.

  • 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 as an example, you may see a dialog requesting that you “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.

AVEVA OMI SDK

The AVEVA OMI Software Developer Kit (SDK) provides programmatic access to component APIs and namespaces. Using the methods and properties that these provide, you can build your own custom AVEVA OM applications. Users can then add these custom apps to their ViewApps, the same way that they can add the AVEVA OMI apps that are included with Application Server.

When you install the Application Server IDE, the AVEVA OMI SDK is automatically installed, including samples and libraries. A link to the AVEVA OMI SDK Web Help is added to the Windows start menu.

  • The default installed location of the SDK is:

    C:\Program Files (x86)\ArchestrA\Framework\AcfSdk

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

    Start > AVEVA Documentation > AVEVA OMI SDK Help

System Requirements and Guidelines

Hardware Requirements

Hardware Requirements Notes

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

Software Requirements

Windows Operating System Notes

Supported Operating Systems at Time of Release

.NET Framework Requirements and Compatibility

.Net Notes

SQL Server Notes

Virtual Environment Notes

Firewall Notes

Third-Party Application Prerequisites

Operating System Notes

Operating System Notes: Common for AVEVA Products

Operating System Notes: InTouch HMI 2020 R2 SP1

Operating System Notes: Application Server

Operating System Notes: Historian Client

SQL Server Considerations

Considerations for SQL Server

Considerations for SQL Server Express

System Sizing Guidelines

The following table provides guidelines for hardware configurations suitable for System Platform 2020 R2 SP1 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.

  • We recommend an HD 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.

The following guidelines are provided for reference only. The system configuration required for your application will depend on multiple factors, including but not limited to the size and complexity of the application, and the features and components used.

Application

Level

Logical Processors 1

RAM 3

Free Disk Space 2, 3

Network Speed

Application Server Nodes 5

Small Application
(1 – 25,000 I/O per Node)

Minimum

4

2 GB

100 GB

100 Mbps

Recommended

8

4 GB

200 GB

1 Gbps

Medium Application
(25,000 – 50,000 I/O per Node)

Minimum

8

8 GB

200 GB

1 Gbps

Recommended

16

12 GB

500 GB

1 Gbps

Large Application
(> 50,000 I/O per Node)

Minimum

16

16 GB

500 GB

1 Gbps

Recommended

32

24 GB

1 TB

Dual 1 Gbps

Galaxy Repository Nodes

Small Galaxy
(1 – 50,000 I/O per Node)

Minimum

4

2 GB

100 GB

100 Mbps

Recommended

8

4 GB

200 GB

1 Gbps

Medium Galaxy
(50,000 – 200,000 I/O per Node)

Minimum

8

8 GB

200 GB

1 Gbps

Recommended

16

12 GB

500 GB

1 Gbps

Large Galaxy
(> 200,000 I/O per Node)

Minimum

16

16 GB

500 GB

1 Gbps

Recommended

32

24 GB

1 TB

Dual 1 Gbps

Historian Server Nodes

Small Historian
(1 – 50,000 Historized Tags per Node)

Minimum

4

2 GB

100 GB

100 Mbps

Recommended

8

4 GB

200 GB

1 Gbps

Medium Historian
(50,000 – 200,000 Historized Tags per Node)

Minimum

8

8 GB

200 GB

1 Gbps

Recommended

16

12 GB

500 GB

1 Gbps

Large Historian
(> 200,000 Historized Tags per Node)

Minimum

16

16 GB

500 GB

1 Gbps

Recommended

32

24 GB

1 TB

Dual 1 Gbps

Thin Client Nodes

RDP clients, InTouch Access Anywhere, mobile devices

Minimum

2

512 MB

N/A

100 Mbps

Recommended

4

2 GB

N/A

100 Mbps

Client Nodes

WindowViewer, OMI ViewApp, Historian Client, Remote IDE

Minimum

4

1 GB

100 GB

100 Mbps

Recommended

8

4 GB

200 GB

1 Gbps

Remote-Desktop Server Nodes

Basic RDS, InTouch Access Anywhere Server
Supports up to 15 concurrent remote sessions

Minimum

8

8 GB

200 GB

1 Gbps

Recommended

16

12 GB

500 GB

1 Gbps

Large RDS, InTouch Access Anywhere Server
Supports up to 30 concurrent remote sessions

Minimum

16

16 GB

500 GB

1 Gbps

Recommended

32

24 GB

1 TB

Dual 1 Gbps

All-In-One Nodes 4

Small Application – All products on one node: 1,000 I/O max

Minimum

8

8 GB

200 GB

100 Mbps

Recommended

12

12 GB

500 GB

1 Gbps

Medium Application – All products on one node: 20,000 I/O max

Minimum

12

16 GB

500 GB

1 Gbps

Recommended

16

32 GB

1 TB

1 Gbps

Large Application 6 – All products on one node: 100,000 I/O max

Minimum

20

32 GB

2 TB

1 Gbps

Recommended

24

64 GB

4 TB

1 Gbps

1) To calculate the number of logical processors: multiply the number of physical cores by the number of threads each core can run. A four core CPU that runs two threads per core provides eight logical processors. The terms “Hyper-Threading and “simultaneous multithreading” (SMT) are also used to describe logical processors.
2) SSD drives are highly recommended.
3) In redundant environments, increase CPU and RAM to maintain a maximum of 40% typical resource utilization.
4) For optimal performance of all-in-one nodes, a high clock speed (>2.8 GHz) is recommended.
5) For Application Server platform nodes, it is recommended that you deploy no more than two AppEngines per logical processor (typically one primary AppEngine and one backup).
6) For large applications on all-in-one nodes, dual XEON processors are recommended.

Supported and Recommended Node Hardware Types

Product

Server Node

Thin Client- Server Node

Client Node

Thin Client

All-In-One

Application Server

Galaxy Repository

Preferred

Supported

Supported

No

Supported

Application Engine

Preferred

Supported

Supported

No

Supported

IDE

Preferred

Supported

Supported

RDP

Supported

OMI ViewApp Runtime

Supported

Supported

Preferred

ITAA/RDP

Supported

InTouch Standalone

WindowMaker (No Modern Apps)

Supported

Supported

Preferred

RDP

Supported

WindowMaker (with Modern Apps)

Preferred

Supported

Supported

RDP

Supported

WindowViewer / InTouch ViewApp (runtime only)

Supported

Supported

Preferred

ITAA/RDP

Supported

InTouch for System Platform

WindowMaker (with Managed Apps)

Preferred

Supported

Supported

RDP

Supported

WindowViewer / InTouch ViewApp (runtime only)

Supported

Supported

Preferred

ITAA/RDP

Supported

InTouch Access Anywhere

InTouch Access Anywhere Server

Supported

Preferred

No

No

Supported

InTouch Access Anywhere Client (HTML5 Browser)

Browser

Browser

Browser

Browser

Browser

InTouch Access Anywhere Secure Gateway

Supported

No

No

No

No

Historian

Historian Server

Preferred

Supported

Supported

No

Supported

AVEVA Insight (Historian Client)

Browser

Browser

Browser

Browser

Browser

Historian Client

Supported

Supported

Preferred

RDP

Supported

Support Components

OI Gateway

Preferred

Supported

Supported

No

Supported

AVEVA Enterprise Licensing – Server

Preferred

Supported

Supported

No

Supported

AVEVA Enterprise Licensing – Manager

Preferred

Supported

Supported

No

Supported

AVEVA Enterprise Licensing – Manager Client

Browser

Browser

Browser

Browser

Browser

Hardware Requirements Notes

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

Windows requirements

SQL Server requirements

AVEVA Historian Hardware Guidelines
  • AVEVA Historian 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 (SP_Install_Guide.pdf).

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

Supported Operating Systems at Time of Release

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)

    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.

64-bit only

System Platform Product / Component

Windows 8.1 Pro/ Enterprise

SAC Windows 10
Pro/Enterprise/IoT Enterprise

LTSC Windows 10
Enterprise/IoT Enterprise

LTSC Windows Server
See Windows Server Notes

Application Server 2020 R2 SP1

  • Galaxy Repository
  • AppEngine / Platform / Bootstrap
  • IDE (including remote)
  • AVEVA OMI ViewApp (run time)

Supported

1909 (Enterprise and IoT Enterprise only, Professional not supported)

2004

20H1

20H2

1507 (with extended support)

1607

1809

2012 Data Center

2012 R2 Standard, Data Center, and Embedded with full image

2016 Standard and Data Center

2019 Data Center, Essentials, and Standard

InTouch HMI 2020 R2 SP1

  • WindowMaker (no Modern apps)
  • WindowMaker (Modern apps)
  • WindowViewer (run time) / InTouchViewApp
  • InTouch Web Client (run time)

InTouch for System Platform 2020 R2 SP1

  • WindowMaker (Managed Apps)
  • WindowViewer (run time) / InTouchViewApp

2012 Data Center

2012 R2 Standard and Data Center

2016 Standard and Data Center

2019 Data Center, Essentials, and Standard

Historian Server 2020 R2 SP1

2012 Data Center

2012 R2 Standard, Data Center, and Embedded with full image

2016 Standard and Data Center

2019 Data Center, Essentials, and Standard

InTouch Access Anywhere Server 2020 R2

  • ITAA Client (HTML5 browser)

    InTouch Access Anywhere Secure Gateway 2020 R2

Other System Platform 2020 R2 SP1 components / products

  • Historian Client 2020 R2 SP1
  • OI Gateway
  • System Management Server
  • AVEVA Licensing
  • System Monitor Agent / Manager

Note: While Windows Server 2012 is supported (Data Center version only), Windows 8 is not supported. The minimum Windows client version is Windows 8.1.

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

Important! Installing System Platform 2020 R2 SP1 on a computer used as a domain controller is not supported.
For more information, see the Microsoft Security Best Practices Checklist.

System Platform 2020 R2 SP1 Web Clients

The following web clients are included with System Platform 2020 R2 SP1:

  • 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 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.3626 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 R2 SP1)
  • Support for 32-bit versions of Windows and SQL Server has been discontinued. Only 64-bit versions are supported.
  • Semi-Annual 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.

.NET Notes

Versions of .NET Framework (other than 4.x versions) can coexist, but all .NET code, including QuickScript.NET scripts, run under .NET Framework 4.8 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 R2, 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 R2 is blocked because System Platform 2020 R2 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.

Supported SQL Server Versions at Time of Release

64-bit only

System Platform Product / Component

SQL Server Express SSMSE

SQL Server

Application Server 2020 R2 SP1

  • Galaxy Repository
  • AppEngine / Platform / Bootstrap
  • IDE (including remote)
  • AVEVA OMI ViewApp (run time)

2012 SP4

v11.0.7001.0 or higher

2014 SP3

v12.0.6024.0 or higher

2016 SP2

v13.0.5026.0 or higher

2017 Core

v14.0.1000.169 or higher

2019 Core

v15.0.2000.5 or higher

2012 Standard/Enterprise SP4

v11.0.7001.0 or higher

2014 Standard/Enterprise SP3

v12.0.6024.0 or higher

2016 Standard/Enterprise SP2

v13.0.5026.0 or higher

2017 Standard/Enterprise

v14.0.1000.169 or higher

2019 Standard/Enterprise

v15.0.2000.5 or higher

InTouch HMI 2020 R2 SP1

  • WindowMaker (no Modern apps)
  • WindowMaker (Modern apps)
  • WindowViewer (run time) / InTouchViewApp
  • InTouch Web Client (run time)

InTouch for System Platform 2020 R2 SP1

  • WindowMaker (Managed Apps)
  • WindowViewer (run time) / InTouchViewApp

Historian Server 2020 R2 SP1

System Monitor Manager

The 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 R2 SP1:

  • 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.5 and newer, including HA/DR
  • VMWare Clients, including Horizon – Application Virtualization
  • Cloud Virtualization – Azure
  • VMWare Workstation, Version 12.5.9 (only) and Versions 14.1.3 and newer
  • Stratus HA/DR and FT based solutions (zTC Edge 110i)
  • Nutanix (AHV version 20170830.337, Nutanix AOS version – 5.10.8.1 LTS)

Firewall Notes

In order to establish communication with other components and services on the network, System Platform and Platform Common Services (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 Service TCP Ports” in the Application Server User Guide (filename: IDE.pdf).

Note: The ArchestrA Service Bus (ASB) is superseded by Platform Common Services (PCS). However, some ASB references remain in System Platform.

Operating System Notes: Common for AVEVA Products

Before installing System Platform, download and install the latest Microsoft updates to enhance security and ensure product compatibility. Allow the Windows update process to finish before you start installing System Platform. This recommendation applies to all Windows versions.

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 R2 SP1

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 R2 SP1 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 R2 SP1 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. Industrial Graphics 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, Industrial Graphics cannot communicate with InTouch tags when used with an InTouchView license.

In Industrial Graphics, 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 R2 SP1 with InTouch HMI 2020 R2 SP1 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 Communication Driver (also called the OI Server or DAServer) using Local DDE is supported ONLY when the Communication Driver is configured as “Desktop Mode (Must Start from Command line)” and activated from its executable file or launched from InTouch HMI. On Windows and Windows Server operating systems, Local DDE is NOT supported when the Communication Driver is activated in the System Platform Management Console (SMC)
  • For toolkits such as the Application Object Toolkit, GRAccess Toolkit, and MXAccess Toolkit to function properly, you may need to start the toolkit by right-clicking on the file and then clicking Run As Administrator.

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 R2 SP1 leverages the Microsoft .NET Framework 4.8 (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.8 or higher. Although the .NET Framework 4.8 is highly compatible with applications that are built with earlier .NET Framework versions, you may have to update your scripts.

In scripts for Industrial Graphics and/or Application Server objects, 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 a 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:

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: The System Platform installation process will attempt to adjust Maximum Server Memory if it has the appropriate rights to configure SQL Server. After installing SQL Server, you can download SQL Server Management Studio and use it 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. If you do not have SQL Server Management Studio installed, you can download it from:

    https://docs.microsoft.com/en-us/sql/ssms/download-sql-server-management-studio-ssms?view=sql-server-ver15

  • 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 R2 SP1. Supported SQL Server versions at the time of release of System Platform 2020 R2 SP1 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 upgrading/migrating SQL Server, see the following Microsoft references:
  • 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 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 Express 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 64-bit version of Microsoft Office.

System Platform Installation

For detailed installation instructions in English, see the AVEVA System Platform Installation Guide (SP_Install_Guide.pdf). The Installation Guide pdf file is located in the root directory of the System Platform installation DVD.

Before Installing System Platform

Important! Installing System Platform 2020 R2 SP1 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 R2 SP1 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 (2017 SP1 and prior versions)
  • Recipe Manager Plus (2017 Update 1 and prior versions)
  • Skelta BPM (2017 R2 Update 1 and prior versions)

About the Network User Account

The Network User Account, previously called the ArchestrA User or AdminUser Account, is a user name and password combination that enables inter-node communication between computers in a System Platform (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 Network 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, System Platform software that uses the account may stop functioning properly.

  • If the Network 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 Change Network Account utility to change or re-create the Network User Account. The AVEVA Start menu contains a shortcut to the utility.

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

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 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 (SP_Install_Guide.pdf).

  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 R2 SP1 if the version you are upgrading from was installed on a 64-bit operating system.

You can upgrade directly to System Platform 2020 R2 SP1 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 R2 SP1 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 R2 SP1 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 AVEVA OMI in a Session on an RDS Server

In System Platform 2020 R2 SP1, running both InTouch HMI and AVEVA 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 AVEVA 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 AVEVA 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.

AVEVA 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 AVEVA 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/AVEVA 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 AVEVA 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 (HA) in VMWare and Hyper-V virtual environments does not activate licensing grace period during a failover as monitored environmental variables do not change.
  • Disaster Recovery (DR) in VMWare and Hyper-V virtual environments activates a licensing grace period as monitored environmental variables do change.

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.

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 TechNote.

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

Resolved Issues

Issues that were previously listed as known issues in the System Platform Readme that are now resolved are listed in this table. For additional resolved issues that apply to a specific product, see the Readme file for that product.

Issue Number

Description

TFS 1195009

Users experienced a 5 to 10 second delay if any option from the Configure New Asset dialog box was selected, or if the dialog box was closed.

TFS 1233570

The aaGR service generated errors and warnings when a Galaxy was migrated from System Platform 2014 R2 SP1 to System Platform 2020. This issue was most noticeable on nodes with eight or more cores, although it could also occur on nodes with six or fewer cores.

Note: This issue was resolved in the prior release (System Platform 2020 R2) but was not documented.

TFS 1249822

If the aaGR process was restarted while importing a Galaxy, the import process did not complete.

Note: This issue was resolved in the prior release (System Platform 2020 R2) but was not documented.

TFS 1258604

The System Platform IDE became non-responsive after attempting to edit a ViewApp associated with a layout that contained more than 32 panes.

Note: This issue was resolved in the prior release (System Platform 2020 R2) but not documented.

TFS 1279394

In Application Server 2020, the MxDataprovider service may have had a memory leak of about 2MB per day (based on 5000 updates/sec or about 360 million changes/day).

Note: This issue was resolved in the prior release (System Platform 2020 R2) but was not documented.

TFS 1283400

An aaPKG file that contained a large number of objects or symbols could take longer to export or import in System Platform 2020 as compared to System Platform 2017 Update 3.

Note: This issue was resolved in the prior release (System Platform 2020 R2) but was not documented.

TFS 1287606

At run time, an overview symbol showed the LocalSymbolSetting override, even though the override setting visibility was changed to false in the Object Wizard settings.

Note: This issue was resolved in the prior release (System Platform 2020 R2) but was not documented.

TFS 1287616

After an attribute, script, or symbol was added to a template with about 2500 child instances, checking in the template took more than a minute.

TFS 1289649

Certain characters could not be entered when the Layout Script Editor was set to the International US keyboard. Instead of the typed character, the keyboard produced a space.

TFS 1290949

Changes to an Object Wizard containing a symbol during run time or while in preview mode do not hide the symbols associated with the Wizard.

TFS 1291740

After a parent template with child template and instance objects across multiple hierarchy levels was edited, checking in the template took longer than expected.

TFS 1292344

While the System Platform IDE was running and an ipconfig /release command was followed by an ipconfig/renew command on a remote client machine, the IDE remained responsive but objects could not be edited.

Note: This issue was resolved in the prior release (System Platform 2020 R2) but was not documented.

TFS 1295525

A ViewApp did not always provide a WYSYWYG preview.

TFS 1295718

After an expression in a template was changed from locked to unlocked and an invalid expression was added to a script, a derived instance when into a warning state when the template was checked in.

Note: This issue was resolved in the prior release (System Platform 2020 R2) but not documented.

TFS 1297211

When an instance object with a Boolean attribute was configured with read/write I/O (and options for invert, buffer, reflect input and output, and output every scan were enabled), the instance was overwritten by its parent template at run time, if the attribute in the parent object was configured as an Integer.

Note: This issue was resolved in the prior release (System Platform 2020 R2) but was not documented.

TFS 1303484

The FLEX licensing configuration was lost if “Unlimited Engine” FLEX licensing was configured for an Application Server platform, and the System Platform IDE was closed and then reopened.

Note: This issue was resolved in the prior release (System Platform 2020 R2) but was not documented.

TFS 1342283

An error message that warned of an incompatibility was displayed if a computer was upgraded to System Platform 2020 R2 from System Platform 2020, and AVEVA Edge 2020 was installed on the same computer.

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.

ASB, PCS and MGC Issues

ASB: ArchestrA Service Bus

PCS: Platform Common Services

MGC: Multi-Galaxy Communication

Issue Number

Description

IMS 1586624

The logger will repeatedly display error/exception messages from the “view” component if a multi-galaxy pairing is broken for any reason, and then an InTouch HMI Managed ViewApp is launched that contains cross-references to tags in another galaxy.

Workaround: Since the exceptions are caused by the broken galaxy pairing, simply pair the galaxies again. The exceptions will no longer be logged.

TFS 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>”.

TFS 1263702

When upgrading from a node with Platform Common Services (PCS) 4.3.3 installed, such as the case when upgrading from System Platform 2017 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:

  1. Upgrade all nodes and install and configure PCS 4.4 on each.
  2. On the node that will function as the OPC UA Server, select the “No System Management Server configured” option and finish configuration.
  3. Start the Configurator again (reboot if necessary), and configure the System Management Server option as applicable for your system.

Communication Driver Pack Issues

Issue Number

Description

IMS 1578426

When attempting to establish a secure, encrypted SuiteLink connection, an error may be generated and the connection is terminated (by either the Client or Server). This condition will occur if the standard user has not been added as a member of the ‘ArchestrAWebHosting’ user group.

Workaround: For a secure, encrypted communications over SuiteLink, add the standard user to the ‘ArchestrAWebHosting’ user group on the server side. For details, see the AVEVA Communication Drivers Pack Help, “Secure SuiteLink Connection,” available after installation in the AVEVA Help application.

IMS 1435622

TFS-1355437

If the Gateway Communication Driver (v4.0-v6.0) is installed on a machine and you try to upgrade to System Platform 2020 R2 SP1, then the Gateway Communication Driver gets uninstalled.

Workaround: Use Modify install option in System Platform 2020 R2 SP1 and select Standards – Gateway to install on the machine.

Note: If you install the Gateway Communication Driver using System Platform 2020, System Platform 2020 R2, or Wonderware System Platform 2017 U3 SP1 (along with InTouch and Application Server), then there is no issue in upgrading the Gateway Communication Driver using System Platform 2020 R2 SP1.

Install/Uninstall and Galaxy Migration Issues

Issue Number

Description

TFS 1354470

If Intelligence 2017 Update 1 (or prior version) is installed on a machine that has System Platform 2020 R2 installed, the Configurator cannot open after the system restarts.

Workaround: Install Intelligence 2017 Update 1 (or prior version), then install System Platform 2020 R2.

  1. Install Intelligence 2017 Update 1 and configure it.
  2. Install System Platform 2020 R2. System Platform will upgrade shared components such as Licensing during the installation process.
  3. Run the Configurator for System Platform 2020 R2 and restart the system.
  4. Run the Intelligence 2017 Update 1 Repair module (setup.exe). This will upgrade the Intelligence Configurator.
  5. Configure Intelligence using the upgraded Configurator.

TFS 1249251

Upgrading to System Platform 2020 from a prior version does not succeed if the prior version used a 32-bit version of SQL Server. Support for 32-bit SQL Server has been discontinued for the System Platform 2020 release.

Workarounds: Two methods for upgrading System Platform and migrating galaxies are listed below. Use the first method if you will use SQL Server Express, included with System Platform. Use the second method if you will be installing a 64-bit full version of SQL Server in place of a 32-bit version.

Method 1 (install SQL Server Express as part of System Platform installation):

  1. Detach the galaxy databases through SQL Server Management Studio.
  2. Back up the database files by copying the Galaxy folder in the path:
    C:\Program Files (x86)\ArchestrA\Framework\FileRepository\
  3. Uninstall the 32-bit version of SQL Server Express.
  4. Launch the System Platform 2020 installation program (setup.exe), and allow it to install SQL Server Express 2017 (64-bit).
  5. Restore the Galaxy folder to the path:
    C:\Program Files (x86)\ArchestrA\Framework\FileRepository\
  6. Attach the previously detached Galaxy database files.
  7. Restart the aaGR and Watchdog services.
  8. Launch the IDE, then connect to the galaxy and migrate it.

    Galaxy migration should succeed without any issues.

Method 2 (install full version of SQL Server):

  1. Detach the galaxy databases through SQL Server Management Studio and make a backup (see Considerations for SQL Server for information about SQL Server Management Studio).
  2. Uninstall the existing 32-bit version of SQL Server.
  3. Install a supported 64-bit version SQL Server.
  4. Attach the previously detached Galaxy database files.
  5. Launch the System Platform 2020 installation program (setup.exe) and allow it to upgrade your products.
  6. After upgrade is complete, launch the IDE, then connect to the galaxy and migrate it.

    Galaxy migration should succeed without any issues.

TFS 1224058

When a galaxy with an ITMEViewApp object is migrated to System Platform 2020, an “ArchestrAObjectSupport” error message is logged.

Note: This issue has been corrected in AVEVA™ Edge 2020.

Workaround: You can avoid this issue by contacting AVEVA Customer Support for a patch compatible with your System Platform release. Before migrating your galaxy to System Platform 2020, import the ITMEViewApp Object patch.

If you have already migrated your galaxy to SP 2020 and are seeing an error message, import the ITMEViewApp Object included in the AVEVA™ Edge 2020 release.

TFS 1135229 TFS 1157116

If InBatch 2014 R3 or InBatch 2014 R3 SP1 is installed on the same node as System Platform 2017 or 2017 Update 1, upgrading to System Platform Update 3 SP1 may result in a compatibility issue that stops the IDE from working.

Workaround: Upgrade InBatch to version 2017 or later before upgrading to System Platform 2017 Update 3 SP1. InBatch 2017 and later versions are compatible with System Platform 2017 Update 3 SP1.

AVEVA OMI Issues

Issue Number

Description

IMS 1212168

On Windows 10 operating systems, layouts created in System Platform 2020 with non-English OS/regional settings show a warning and do not open when migrated to System Platform 2020 R2 or 2020 R2 SP1.

Workaround: Before migrating the galaxy, make sure the operating system locale is set appropriately by following these steps:

  1. Open the Windows Control Panel and select Region.
  2. Select the Administration tab when the Region popup opens. The Administration tab contains two buttons:
    • Copy settings
    • Change system locale
  3. Select Copy settings and then mark the checkboxes to copy current settings to “Welcome screen and system accounts,” and “New user accounts.”
  4. Select Change system locale and then choose the applicable locale from the dropdown list.

TFS 1369154

Under certain circumstances, an instance derived from a template with an invalid reference will not show a warning during design time. This can occur if the following occurs:

  1. A symbol is added to the Graphic Toolbox with an undefined relative reference, for example, “Me.Attribute001,” where Attribute001 has not been created yet.
  2. The symbol is then added to a layout.
  3. The layout is linked to a UDO (User Defined Object) template. When the template is saved, no warning is displayed.
  4. When an asset is derived from the template, no warning is displayed for the instance either.

    Result: Although no warnings are issued during design time, when you create and then deploy a ViewApp with the linked layout, and show the linked layout in any screen, an error message will be displayed at run time (or in Preview Mode) that will allow you to troubleshoot and correct the error. The message will be similar to:

    Element ‘TEXT1’ in Symbol ‘UDO_001.S1’ has Configuration error: Invalid reference ‘Galaxy1:Me.Attribute001’ with owning object ‘UDO_001’ does not exist.

TFS 1160616

If an admin user logs in, launches a ViewApp, and then logs off the system while leaving the ViewApp running, registry keys are unloaded in the profile of the user account. This results in continuous errors from CheckPointFileServer in the logger similar to: “”INVALID HRESULT LINE765 File CheckPointFile.cpp hResult 80003fa after logging off and logging on as different users (non-admin).”

Cause: This is a known Microsoft issue. This problem typically occurs after an administrator uses a service account to log in to the server for an interactive session, and then logs off. For example, an administrator may log in to a Web Front End (WFE) server by using the farm account, and then log off. This activity forces the registry keys to be unloaded in the profile of that account, and makes the keys unavailable for future use. Microsoft recommends using either of the following workarounds to resolve this issue. For more information, see:

“800703fa Illegal operation attempted on a registry key” error

A COM+ application may stop working on Windows Server 2008 when the identity user logs off

Workaround 1: Do not log in to the server for interactive sessions by using a service account.

Workaround 2: Disable the related Windows User Profile Service feature as follows:

  1. Open the Group Policy editor (Gpedit.msc) on the affected server.
  2. Open the User Profiles folder in the following path:

    Computer Configuration > Administrative Templates > System > User Profiles

  3. Locate the “Do not forcefully unload the user registry at user logoff” setting.
  4. Change the setting to Enabled.

CR L00150114

SR59513303: TheGetCPTimeStamp() scripting method, when used in an AVEVA OMI action or named script within a symbol, does not return the timestamp at run time. Instead, it returns characters for the timestamp format, such as “mm/dd/yyyy hh:mm:ss.” No errors or warnings will appear in the logger. This is similar to issue 777504, listed below.

Workaround: Use the GetCPTimeStamp() method in an object script instead of a symbol script.

TFS 1100582

Switching languages during run time while using multi-content panes that use locale-specific scripting calls can sometimes result in errors in the logger.

Workaround: Restart the ViewApp after switching the run-time language. This action fully resolves the issue with no loss of functionality.

Missing NavTree

After upgrading or migrating an AVEVA OMI ViewApp from 2017, a warning message states that the NavTree entity could not be found. In 2017 Update 1, this navigation object has changed and is now called “NavTreeControl.”

Workaround 1: To replace the NavTree object in a ViewApp or Layout when upgrading from System Platform 2017:

  1. Open the ViewApp or Layout that shows the warning.
  2. In the ViewApp or Layout editor, look in the Actions list for all references to “NavTree.” An icon showing “Content not available” will be displayed for these references.
  3. To see the entire action list for a ViewApp, toggle the Actions for Primary switch to show Actions for Home (does not apply to the Layout editor).
  4. Replace the NavTree object with the new NavTreeControl.
    1. Search for NavTreeControl under the Toolbox tab.
    2. Drag the NavTreeControl onto the pane to replace the NavTree.
  5. Confirm that you want to replace the content, then save the ViewApp or Layout and close the editor.
  6. Verify Layouts and ViewApps no longer show any warnings related to the NavTree.
  7. Deploy the ViewApp.

Workaround 2: To replace references to NavTree when importing packages from System Platform 2017:

  1. Launch the IDE and open the “Find” dialog.
  2. Search for “NavTree” using the default search settings.

    If the package file contains the obsolete NavTree object, it will be listed in the search results.

  3. Double-click the NavTree search result, which will select the NavTree object in the Graphic Toolbox.
  4. Delete the NavTree object from the Graphic Toolbox.
  5. Use Workaround 1 to replace the NavTree object with the new NavTreeControl object.

TFS 774717

When an AVEVA OMI application (View.exe) that uses one of the following web controls is run in 4K mode or on multiple 1080p monitors, under certain circumstances the application may stop responding:

  • InSightApp
  • MapApp
  • WWWebAppControls

Workaround: When running a ViewApp that uses a web control on a 4K monitor, set the monitor resolution to 2560 x1440 or less. When running the ViewApp on 1080p monitors, do not attempt to span multiple monitors.

TFS 777504

The GetCPQuality() scripting method is not supported in AVEVA OMI. If used in a ViewApp, it always returns quality = 0 (bad quality). This is similar to issue L00150114, listed above.

TFS 781006

If an invalid custom property is added to a symbol, no warning is logged in the System Management Console, even though no value is displayed for the custom property.

TFS 781620

The Height and Width properties of a group with text elements do not change in accordance with changes made to the label font size, and are not rendered correctly.

TFS 784470

Tooltip animations that contain multiple lines of text with line breaks may not display properly in deployed ViewApp.

TFS 784474

A tooltip may partially cover the element with which it is associated in the deployed ViewApp.

TFS 787192

When OSGroup security mode is used, the VerifiedWrite dialog is not displayed when you modify the value of a VerifiedWrite attribute from a combobox, if you first attempted to perform the VerifiedWrite without having the correct security credentials.

TFS 789958

On some high resolution tablet devices, such as the Surface Pro 4, object names in the System Platform IDE may have insufficient line spacing between items, which can make it harder to read object names.

TFS 794383

When a custom property is changed from public to private, the change does not have any affect, and the value of the private custom property is shown at run time (private values should not be shown). Similar situations occur when:

  • An override values for a custom property that is later made private. The override is also shown at run time.
  • An override is applied to a custom property, and later the custom property is locked (can no longer be overridden). When the ViewApp is redeployed, the override value is still shown.

Workaround: Manually validate the outermost symbol and then deploy the ViewApp.

Application Server Issues

Issue Number

Description

IMS 1592456

If a non-admin user logs into a remote IDE node and the User Access Control (UAC) setting in Windows is disabled, the user cannot launch AVEVA OMI editors from the IDE. AVEVA OMI editors are the Layout, Screen Profile, External Content, and ViewApp editors.

Workaround: Turn on (enable) UAC on the remote IDE client node.

TFS 1352630

When IP addresses are used for galaxy pairing, pairing is successful. However an error dialog is displayed and an error message is logged. The error message is similar to: “Failed to get the Discovery Service information for the target Galaxy Repository ‘x.x.x.x’. Please see the logger for more details.”

Workaround: We recommended that you use the hostname of the node for galaxy pairing.

If you use the IP address instead, make sure the reverse DNS lookup zone is configured properly on the DNS server. If the reverse DNS lookup zone is not set up while pairing the galaxy with the IP address, galaxy pairing may be successful. However you may see the message described above. You may safely ignore the error message.

CR L00138837

AppEngine can crash due to calls made to API dlls even when using try/catch. This issue is specific to Nullable data types. The recommendation is to use wrapped API DLLs in Application Server scripting.

TFS 1296015

In a client-server System Platform implementation where the client node is running a remote GR and run time features, the asb.Watchdog service may stop. As a result, MXData and Authentication warning messages appear in the logger.

Workaround: Insert the System Platform installation DVD and run setup.exe, then select the Repair option. For more information, see “Repairing an Installation” in the System Platform Installation Guide (SP_Install_Guide.pdf).

TFS 1291740

After editing a parent template with child template and instance objects across multiple hierarchy levels, checking in the template takes longer than expected.

TFS 1290449

A legacy object with field attributes goes into an error state after importing a package file having field attributes and converting them using the Galaxy menu option, Convert Legacy UserDefined Object, even after the object has been validated.

InTouch HMI Issues

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

Issue Number

Description

IMS-1488851

Post-upgrade from InTouch HMI 2017 U3 SP1 to InTouch HMI 2020 R2 SP1, the following warning message is logged in the LogViewer:

“Unable to start the aaServiceHost Could not load file or assembly ‘PCS.Client.Discovery, Version=1.3.1.0, Culture=neutral, PublicKeyToken=23106a86e706d0ae’ or one of its dependencies. The system cannot find the file specified.”

This has no functional impact. However, restarting the system will resolve the message.

IMS-1576516

On Windows Server 2012 R2, when the TeamWork widget is opened as ShowSymbol animation, the InTouch HMI WindowViewer stops working.

Workaround: Use Windows Server 2016 or Windows 10.

InTouch Access Anywhere Issues

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

Issue Number

Description

TFS 1280717

InTouch Access Anywhere cannot be removed through the Modify workflow. An error message is displayed that states, “To install this product, please run Setup.exe. The setup will now exit.”

Workaround: Select the Remove workflow, instead of Modify, from the Maintenance dialog. This successfully deletes InTouch Access Anywhere and its components.

Historian Issues

Issue Number

Description

.NET Apps

When importing AVEVA .NET Apps that use AVEVA Historian Client controls, some of the required files are not imported correctly.

Workaround:

  1. Import the App using the System Platform IDE by selecting Import from the Galaxy menu.
  2. Select AVEVA App.
  3. Select the folder containing the App to be imported.
  4. The App is imported and all the dependent files are copied to a new folder, C:\Program Files (x86)\ArchestrA\Framework\FileRepository\<GalaxyName>\ObjectFileStorage2\xxx, where xxx is a 3-digit number.

    Tip: Sorting the ObjectFileStorage2 folder by date modified can make it easier to locate the correct numbered folder.

  5. Some of the required files for AVEVA Historian Client controls may not be copied. For each of the controls your imported App uses, locate the corresponding folder(s) from the following list, and copy all the files from those folders into the folder from step 4:
    • Query control: C:\Program Files (x86)\ArchestrA\Framework\Bin\AVEVA_Software__LLC__aaHistClientQueryControl.dll
    • Tag Picker: C:\Program Files (x86)\ArchestrA\Framework\Bin\AVEVA_Software__LLC__aaHistClientTagPicker.dll
    • Time Range Picker: C:\Program Files (x86)\ArchestrA\Framework\Bin\AVEVA_Software__LLC__aaHistClientTimeRangePicker.dll
    • Trend control: C:\Program Files (x86)\ArchestrA\Framework\Bin\AVEVA_Software__LLC__aaHistClientTrendControl.dll

TFS 1345774

Logger errors from during the galaxy migration can occur if the Historian Client Control was renamed.

Workaround: If a Historian Client Control in the galaxy was renamed, and if there are errors during migration related to the Historian Trend Client (aaTrendControl), resolve this error as follows:

  1. After migration, delete the renamed Historian Client Control. Note the name of this control as you will need it to rename the new control with the same name.
  2. Import the latest Historian Client Control aaPKG file from the following folder:
    C:\Program Files (x86)\ArchestrA\Framework\Bin
    File name: aaHistClientTrendControl.aaPKG
  3. Rename the imported client control with its original name (from step 1).

Note: If you have multiple Historian Client Controls in the galaxy and errors are being logged, and you want to retain only the original Historian Client Control, you can do this as follows:

  1. Delete the Historian Client Control with its original name (aaTrendControl).
  2. Rename one of the other Historian Client Controls to the original name (aaTrendControl).
  3. Delete the control you renamed in step 2. Note: This rename/delete process is required to maintain references that use the control.
  4. Repeat as many times as necessary until you have deleted the controls.
  5. Import the latest Historian Client Control aaPKG file from the following folder:
    C:\Program Files (x86)\ArchestrA\Framework\Bin
    File name: aaHistClientTrendControl.aaPKG

TFS 931966

When using silent install to upgrade Historian from System Platform 2017 or earlier that sets a default password for SQL Server users, warning messages are logged that alert you to set new passwords for various system users after the Configurator runs. Your system will continue to operate normally without resetting the passwords, but changing the passwords will increase system security.

TFS 924302

When installing Historian along with any other component, and the other component requests a system restart, if you restart immediately after closing out the Configurator, a number of warnings may appear in the logger from the Historian services. This is caused by a timing issue.

The warning messages can be safely ignored because they do not affect the configuration of the Historian, and do not have any effect on the system during or after the system restart.

Licensing Issues

Issue Number

Description

TFS 1300491

Activating OI Gateway consumes a license even though OI Gateway does not require a license unless the MQTT component has been configured and is in use.

Workaround: Reserve a license for each Communication Driver (OI Server) that requires a license. No licenses will then be available because they are reserved to other Communication Drivers. When OI Gateway is activated but not using MQTT, no license will be consumed by OI Gateway. OI Gateway will run without interruption.

TFS 1241116

MES 2017/2017 R2 may not acquire a trial license when installed with System Platform 2020. This is due to a file path name change for the TrialLicensePool that is part of the System Platform 2020 release. This issue only occurs if you are using a trial license.

For both MES 2017 and MES 2017 R2, the file path for the TrialLicensePool folder is:
C:\ProgramData\Schneider Electric\Licensing\TrialLicensePool

For System Platform 2020, the file path for the TrialLicensePool folder is:
C:\ProgramData\AVEVA\Licensing\TrialLicensePool

Workarounds: Use one of the following workarounds.

  • If only the file path “C:\ProgramData\Schneider Electric\Licensing\TrialLicensePool” is on your system, change the name of the “Schneider Electric” folder in the file path to “AVEVA.” No other change is needed.
  • If both file paths exist on your system, copy the trial license from “C:\ProgramData\Schneider Electric\Licensing\TrialLicensePool” to “C:\ProgramData\AVEVA\Licensing\TrialLicensePool.” No other change is needed

    If the AVEVA License Manager is open while you are moving the license file or renaming the file path, you may see a series of error messages. However, these will clear once the trial license is acquired. You can avoid this by closing the License Manager prior to renaming or moving the file.

TFS 793643

If you have not set a default browser, and you install System Platform with AVEVA Enterprise licensing selected, clicking the AVEVA Enterprise License Manager shortcut does not open the License Manager in the browser as it should. Instead, the shortcut opens in Windows Explorer. From Windows Explorer, you cannot open License Manager (the OK button is inactive).

Workaround: Follow the instructions for your operating system to set the default browser, and then open the AVEVA Enterprise License Manager from the shortcut, or:

Open your browser and copy the shortcut link, http://localhost/AELicenseManager, directly into the browser’s address bar.

TFS 779958

When the same license is acquired on both a local node and in an RDP session that originates from the same node, the License Manager may not show all the licenses that have been acquired. This occurs even though the licenses are counted properly on the license server. The license count that you see applies only to the node you are viewing. Thus, once you reach your maximum number of licenses, you will not be able to acquire additional licenses, even though the license manager may indicate that more licenses are available.

System Monitor Issues

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

Issue Number

Description

201646

On a fresh install, the Rule Overview page shows a Current Manifest Version value other than 1. The Manifest version listed on the Rules grid should show the value 1 because the out-of-the-box manifest is immediately published. However, the UI shows that the manifest has already been published more than once.

201649

Machines are added to the Monitored Machines list with an inaccurate date/time value under the Discovered Date column.

202853

Users can create multiple rules with the same name.

202854

Manually specifying a proxy server in the Local Area Network (LAN) Settings configuration dialog results in inability to access the Sentinel Manager login screen.

Workaround: Use an automatic configuration script (provided by your IT department) to configure a proxy server.

202877

On creating a rule to monitor a file or folder with a path longer than 100 characters, the rule is partially stored in the database and not published in the agent manifest.

202878

On undeploying a platform that is being monitored, the Runtime Provider is stopped. On redeploy of the platform, the Runtime Provider does not resume until the Galaxy is rediscovered.

Workaround: Following redeploy of a platform, manually rediscover the Galaxy (in the Galaxy Diagram area). Alternatively, stop and restart the Sentinel Agent Service.

202898

I’m Alive Emails are not sent consistently until 24 hours after enabling the notification.

202906

On Reports with date parameters, the data returned is not inclusive of the end-date.

608555

Distorted UI when downsizing browser window or viewing UI in a resolution less than 1440×900.

623127

Start Menu with the option to open AVEVA System Monitor Manager is installed on non-Manager nodes.

623129

On uninstall, System Monitor start menu options are not removed.

1436554

It may take up to five minutes for the Galaxy Diagram to reflect Alert changes to the Galaxy shape in Sentinel Manager.

Workaround: Refresh the page for the updated galaxy diagram after 5 minutes of change in the galaxy shape.

1436013

Email alerts cannot be sent through secured SMTP.

1511692

Post Install -> Reboot, ASM has an alert that Bootstrap is not running that does not update to show Bootstrap IS running.

Workaround: Resolve the Bootstrap alert. It will not shows the incorrect status again.

AVEVA 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 in the Logger. The status bar should show “Connected” even though no matches are returned.

AVEVA Edge Co-Existence Issues

AVEVA Edge is not a component product of System Platform, but is sometimes installed with it.

Issue Number

Description

TFS 1342283

If you attempt to upgrade a computer to System Platform 2020 R2 from System Platform 2020, and AVEVA Edge 2020 is installed on the same computer, an error message may be displayed that warns of an incompatibility. This will occur during the upgrade if certain registry values are incorrect, and the upgrade installation will be blocked.

Workaround: Use regedit to enter the correct registry values.

Location: HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\ArchestrA\Framework

  1. Change the value of InstallPath to “C:\Program Files (x86)\ArchestrA\Framework\” (add the final backslash character)
  2. Change the value of TargetInstallPath to “C:\Program Files (x86)\ArchestrA\” (add “ArchestrA\”)

Citect SCADA Co-Existence Issues

We do not recommend installing System Platform 2020 R2 on the same the node where Citect SCADA is installed. To avoid issues, we recommend that you install System Platform and Citect SCADA on separate nodes.

Issue Number

Description

TFS 1377931

If System Platform 2020 R2 is installed on a machine that already has Citect SCADA 2018 R2 installed, you cannot browse Citect SCADA 2018 R2 tags from the System Platform IDE.

Workaround: Install Citect SCADA 2018 R2 and System Platform 2020 R2 on separate nodes.

Leave a Reply

Your email address will not be published. Required fields are marked *

× 1 = 4