AVEVA™ System Platform Version 2023 Patch 02 Readme

Last revision: 6/8/2023

Included in this Patch --- 2023 Patch 02

This document contains important information about AVEVA™ System Platform 2023 Patch 02, which includes the products listed below. The Readme for System Platform 2023 follows the patch information.

Review the individual product Readme files for details regarding product-specific known and resolved issues. When you extract the patch installation files, the product Readme files are extracted to individual folders. The Readme files are also posted on the AVEVA Global Customer Support (GCS) website. Readme files from previous releases of System Platform and its component products are also posted on the AVEVA Global Customer Support (GCS) website, along with additional technical information about System Platform. For the latest updates related to supported operating systems and databases, see the GCS Technology Matrix.

About This Patch Release - 2023 Patch 02

Changelog: System Platform 2023 Patch 02

Supported System Platform Versions for Product Upgrade

This patch can be applied to System Platform 2023 or System Platform 2023 Patch 01 only. When you install this patch on a System Platform 2023 installation, it installs all patches and other updates contained in both Patch 01 and Patch 02.

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

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.

Web Server Redundancy Support in Web Client

The Web Client now supports web server redundancy. That is, in case of a fail-over of a web server, the requests are sent to another redundant web server.

A reverse proxy is a server that is positioned in front of one or more web servers, intercepting requests from clients. If any of these web servers are down or in case of the fail-over of one of these web servers, then the reverse proxy will send the requests from clients to the other web server. There are many providers of reverse proxy solutions. Refer to the relevant reverse proxy solution documentation for the information on redundancy support and instructions on setting up the reverse proxy solution in your infrastructure.

Resolved issues 2023 Patch 02

See the product-specific Readme files (in the ReadMe directory, as described above) for issues resolved in this patch release. The table below shows issues resolved in components that are shared between two or more products.

InTouch HMI Resolved Issues

InTouch 2023 P02 includes corrections for the issues listed in the following table. These issues are listed by their Defect ID (IMS number), any assigned Service Request (SR) or Case Number with a brief description of the defect.

Known Issues 2023 Patch 02

See the product-specific Readme files (in the Readme directory, as described above) for possible known issues in this patch release. Also, see the Patch01 Readme, below, for previously existing known issues.

Known Issues in Application Server and System Platform Documentation

The following known issues have been identified. Additional known issues are documented in the product-specific Readme files.

InTouch HMI Documentation Corrections

This section lists important InTouch HMI documentation corrections.

--- End of Patch 02 Readme ---

AVEVA™ System Platform Version 2023 Patch 01 Readme

Last revision: 6/8/2023

Included in This Patch - 2023 Patch 01

This document contains important information about AVEVA™ System Platform 2023 Patch 01, which includes the products listed below. The Readme for System Platform 2023 follows the patch information.

Review the individual product Readme files for details regarding product-specific known and resolved issues. When you extract the patch installation files, the product Readme files are extracted to individual folders. The Readme files are also posted on the AVEVA Global Customer Support (GCS) website. Readme files from previous releases of System Platform and its component products are also posted on the AVEVA Global Customer Support (GCS) website, along with additional technical information about System Platform. For the latest updates related to supported operating systems and databases, see the GCS Technology Matrix.

About This Patch Release

Changelog: System Platform 2023 Patch 01

The SVG graphic support, described in Support for Import of SVG as an Industrial Graphic, applies to graphics used in InTouch HMI applications only. In this patch release, you cannot use SVG graphics in an OMI ViewApp.

Supported System Platform Versions for Product Upgrade

This patch can be applied to System Platform 2023 only.

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

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.

Support for Import of SVG as an Industrial Graphic

With this release, Industrial Graphic Editor supports import of Scalable Vector Graphics (SVG) as Industrial Graphics. You can import an SVG into the Graphic Editor and the graphic elements automatically get converted to an Industrial Graphic, which can include many primitives. A list of supported SVG elements can be found at SVG Github.

To import an SVG and insert as an Industrial Graphic:

1. In the Industrial Graphic Editor, on the Graphic menu, click Import SVG.
2. Browse for the required SVG and click Open.

   Note: You can import multiple SVG files at once.

3. Click anywhere on the canvas to insert the SVG file as Industrial Graphics.

OR

• Drag and drop the SVG to the canvas.

  You can drag and drop multiple SVG files at once.

CAUTION: You can drag and drop SVG files only if User Account Control (UAC) is turned off. Before turning off UAC, be sure to check your organization's security policy, as turning it off could cause a security issue.  If you try to drag and drop an SVG file to the canvas with UAC turned on, a forbidden icon is displayed.

Note:
- If there are any unsupported characters in the name of the SVG or primitive, it will be converted to “_”.
- The SVG element name is used to name the corresponding primitive. If a SVG element does not have a name, then Industrial Graphic primitive type is used to name the primitive. For example, if the SVG group name is "Header", the primitive name in Graphic Editor after import will also be Header. If the SVG group has no name, the same will be named as <primitive type>_<number>, that is group_01.
- Only three colors are supported in gradients. If the SVG file has more than three colors for primitive, the first, last, and middle colors are considered. The middle color is calculated by the formula middle color = (int)((colors.Length) / 2). That is, if there are four colors, then it will consider the second color as middle color.

Limitations of SVG Support at the time of this release

The following features are not supported at the time of this release:

• SVG animations are not yet supported, and any animation configured on a SVG element will not be imported.
• SVG Marker and Clip elements
• Inserting the SVG using the Image icon from the Tools panel of the Graphic Editor.

Known Issues - 2023 Patch 02

The following known issues have been identified. Additional known issues are documented in the product-specific Readme files.

Known Documentation Issue

The following known issues have been identified. Additional known issues are documented in the product-specific Readme files.

--- End of Patch 01 ReadMe ---

AVEVA™ System Platform 2023 Readme

Last revision: 6/15/2022

This document contains important information about AVEVA System Platform 2023 and AVEVA System Platform Enterprise 2023.

AVEVA System Platform Enterprise builds upon the core technology of AVEVA System Platform to bring enhanced user accessibility and exclusive visualization extensions, specifically for enterprise users in assembling an AVEVA Unified Operations Center solution. This includes the AVEVA Operations Management Interface (OMI) Web Client, allowing applications to be viewed in a standard web browser. AVEVA System Platform Enterprise is an AVEVA Flex subscription activated product.

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 Installation, Upgrade and Galaxy Migration Issues. For general information about SQL Server requirements, see SQL Server Notes.

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

Included in This Release

New in System Platform 2023

System Platform 2023 includes the following features, as well as miscellaneous bug and security fixes.

Refreshed user interface

The design environments for Application Server, AVEVA OMI, and InTouch HMI now have a new look and improved user interface. Menus and icons have been redesigned for a better user experience. Some of the key highlights include new backstages and menu organization. This updated interface provides more efficient workflows and a common look and feel across AVEVA’s operations control software.

Integrated Web Help System

System Platform 2023 now includes an integrated Web Help system that uses your default browser to display both general and contextual help.

System Platform Enterprise 2023

System Platform Enterprise is intended for customers who subscribe to AVEVA Operations Control Enterprise. It features capabilities that are specific to the implementation of Unified Operation Centers (UOC). Exclusive features of System Platform Enterprise include:

• A web client for Operations Management Interface (OMI)
• Additional web widgets
  • ScatterChart widget
  • Breadcrumb widget
  • NavigationTree widget
  • Hamburger widget
  • TitleBar widget
  • Graphic Repeater widget
  • MapApp widget
• Additional OMI Apps
  • Power BI OMI app
  • PI Vision app
  • Sankey app
• UOC documentation

System Platform Enterprise does NOT include:

• InTouch HMI (WindowMaker and WindowViewer)
• InTouch web client
• InTouch Workspaces

New in Application Server and AVEVA OMI 2023

Application Server 2023 includes a number of new features, hot fixes, and provides support for the latest versions of Microsoft products. Refer to the GCS Technology Matrix for the list of supported Microsoft products.

New look for Application Server

The System Platform IDE, the design environment for Application Server, now has a new look and improved user interface. Menus and icons have been redesigned for a better user experience. Some of the key highlights of the System Platform IDE user interface include a new backstage, menu items, and groups. All special operations that you need to access frequently are now in the backstage, on the Galaxy menu. Other commands have been regrouped in different menu items based on their functionality and ease of accessibility.

User authentication and single sign-on via Azure Active Directory

Azure Active Directory (AD) can be used for identity authentication and single sign-on. After setting Galaxy security to use an external identity provider, Azure AD can be used to authenticate users. System Platform users can then use their Microsoft-managed identities to log in to the System Platform IDE, Operations Control Management Console, AVEVA OMI ViewApps, and to perform secured and verified writes.

Integrated web help system

Help for Application Server is now available as web help, and can be viewed and searched in your default browser. Help for other System Platform products has also been migrated to web help, allowing you to more easily view and search across all System Platform products.

Alarm translation enhancements

You can now localize alarm and event message, and alarm groups.

Preview a ViewApp

System Platform includes the capability for developers to preview an OMI ViewApp from the ViewApp editor without deploying any associated assets. After selecting the Preview Web button, the ViewApp appears in the Web Client.

Object wizard performance

The time needed to propagate changes has been significantly improved, thus greatly increasing performance during development.

Symbol wizard integration

Symbol Wizard support has been improved in web graphics that appear in OMI web ViewApps. In the case of SAL symbols, Wizard Options are supported to provide different configurations of the same symbol.

Display a web ViewApp on a mobile device

The AVEVA Mobile Operations application has been updated to show OMI web ViewApps on a mobile device.

Enhanced management of cloud graphics

AVEVA Connect users are prevented from accessing or overwriting any cloud graphics that were created with a higher version of the Graphic Editor than their local editor. Since multiple AVEVA products use the Industrial Graphic Editor, this allows organizations to use these different products, which may incorporate different versions of the editor, while avoiding any issues that may result from attempting to edit a graphic with new extensions that do not exist in their local version of the editor.

Embed web widgets within OMI Industrial Graphics

Place one or more web widgets directly in an Industrial Graphic for use in the OMI desktop as well as the OMI web client.

GRAccess as an API

The GRAccess Toolkit is now delivered as an API with System Platform to allow users to programmatically interact with Application Server.

Security identity event logging

Log-on and log-off events, both successful and unsuccessful, are tracked for security and audit purposes.

Updates for historical playback capability

Source non-historized values during historical playback to avoid missing information. These values can optionally be flagged to make the viewer aware of the alternative data source.

New BigString data type

The BigString data type supports a virtually unlimited string size to allow users to store and transmit huge strings.

Dynamic images in Industrial graphics

A new property, ImageURI, has been added to Industrial Graphics. This allows the user to modify the property at runtime to dynamically change the image.

AVEVA Flex subscription enhancements

Multiple Flex single engine licenses can now by assigned to a single platform.

Workspace feature for the AVEVA Operations Management Interface Web Client

Use the Workspace feature to create customizable dashboards for casual users across the enterprise. Workspace displays all graphics available in the Workspaces toolset of Graphic Toolbox in the selected application. This allows viewing an Industrial Graphic with operations data by binding attributes from AVEVA System Platform Enterprise. You can create, modify, and save your dashboards, and even share them with others.

To access Workspace, you must:

• have a license for the AVEVA Operations Control, Enterprise package
• enable workspaces from the AVEVA Application Manager

Note:
- The AVEVA Historian search and elastic search features are installed to support the Workspace feature for the OMI Web Client. Workspace is available if you are using Flex licensing. Therefore, after installation, you may see AVEVA Historian listed as a Windows program, even if you did not install the Historian. Do not uninstall Historian. You can use the Modify workflow to restore the Historian search and elastic search features if you inadvertently uninstalled Historian.
- In this initial release of Workspace, searching for Application Server attributes is not supported when using Workspace on a remote node. Searching for Application Server attributes is only supported on the GR or Galaxy Repository node. This feature will be supported in future releases.

For more information, see Widgets, Apps, and Controls in the AVEVA Help.

Cybersecurity enhancements

Application Server and AVEVA OMI incorporate ongoing cybersecurity enhancements and hardening.

Extensions

• New Grid View Widget
• Content Presenter OMI App Update
• Map App Update

New in InTouch HMI 2023

InTouch HMI 2023 (Version 23.0.000) includes a number of new features, hot fixes, and provides support for the latest versions of Microsoft products. Refer to the GCS Technology Matrix for the list of supported Microsoft products.

New Look of InTouch HMI

InTouch HMI 2023 now has a new look. The product and icons have been redesigned for a simpler and enhanced user experience. The new user interface complies with the fluid design and adheres with the AVEVA Design System. Some of the key highlights of the new InTouch HMI 2023 user interface are:

• New backstage, menu items, and groups – All the configurations and special operations that you need to access frequently are now in the backstage, on the File menu. All other InTouch commands have been regrouped in different menu items based on their functionality and ease of accessibility.
• Customize the Application Theme – You can control the color scheme of InTouch HMI application by switching between the light and dark theme, on the View menu.

Longer tag names and item names

The tagname length has been extended from 32 to 128 characters. Item name length has been extended from 79 to 254 characters.

Unlimited Tag Count Support

The InTouch license now supports unlimited tag count. This means that the run-time database can theoretically store unlimited tagcount license, which includes both local tags and tags that reference a remote tag source. However, we have tested up to 300,000 tag handles (300K) only. For more information, see the section Licensing in InTouch HMI in the InTouch HMI Help.

Cloud Graphic Versioning Support

The AVEVA Drive graphics supports Industrial Graphics, Client Controls, and Widgets in the Cloud, published from different products with different versions of the graphic subsystems. For more information, see the section Working with Industrial Graphics in AVEVA Connect in the InTouch HMI Help.

Map App Web Widget

You can use the Map App Web Widget to incorporate a zoomable map into InTouch HMI applications and display selected graphics in a geographical context. It supports a number of popular map providers, and is perfect for geographically distributed applications. You can integrate Supertags with MapApp widget to display it in WindowViewer or Web Client. For more information, see the section Using MapApp Widget with Supertags in the InTouch HMI Help.

Supertags

Supertags is now more easily accessible from the Windows panel. It also has an improved workflow, making it easier to manage members, instances, and attributes.

Improved Search in WindowMaker

The improved search functionality in WindowMaker allows you to search with a keyword simultaneously within the windows, scripts, tags, and symbols.

Bit State Animations

Bit State animations allow you to add conditions to an animation based on bit values. You can add multiple conditions and for each condition you can select individual bits in any pattern up to 32 bits.

Extended Truth Table Animations

The Blink, Disable, Value Display and Visibility animations have now been extended with the ability to configure animations with truth table conditions.

New Graphic Element - Multi Pens Trend

Introducing a new graphic element – Multi Pens Trend. A Multi Pens Trend is like a trend pen and displays a succession of process values but with multiple trend lines.

Ramp option with the Pushbutton Animation

Within the Pushbutton animation you can choose to apply a percentage ramp to the Increment, Decrement, Multiply and Divide actions.

Support for Momentary Touch

The Momentary Contact action is now available for the Pushbutton Boolean animation, allowing you to configure a time-period to hold the set value.

Option to Reset Industrial Graphic Option Cached Values

You can now choose to reset the Industrial Graphic cached values and windows properties when the window is closed and reopened.

Improved Association of Tag Reference with Graphic Element text

There is an improved association of the the tag reference with the text displayed for the Graphic Element.

• If the tag reference is 'Bad Quality No Data', the text of the Graphic Element displays the special Characters configured in Styles Configuration section of the IDE.
• If the tag reference is 'Quality is initializing', there is no text displayed for the Graphic Elements.

Enhanced Language Switching at Runtime

The InTouch HMI application and the Alarm Client Control supports runtime language switching of alarm group names, and event and status bar messages.

Secure SuiteLink Configuration

As of System Platform 2023, the SuiteLink connection is by default set to secure with TLS encryption. If you want to enable the fallback mode to accept the unsecure connection, you have to make the configuration changes in the System Management Server. You can verify the mode of the SuiteLink connection, whether secure or unsecure, by checking the WWSLS component in the Log Viewer.

If unsecure fall back mode is not enabled and secure connection requirements are not met, then SuiteLink connection will fail. For more information, see Configuring Secure Suitelink as a Standard User in the AVEVA InTouch HMI Help.

Workspace Feature for the AVEVA InTouch HMI Web Client

Use the Workspace feature from the InTouch HMI Web Client for operators to create customizable dashboards dynamically. Workspace displays all graphics available in the Workspaces toolset of Graphic Toolbox in the selected application. This allows viewing an Industrial Graphic with runtime data by binding custom properties to tags from InTouch HMI. You can create, modify, and save your dashboards, and even share them with others on the team.

To access Workspace, you must:

• have a Flex license for InTouch HMI Web Client
• enable Workspaces from the AVEVA Application Manager

Note:
- The AVEVA Historian search and elastic search features are installed to support the Workspace feature for the InTouch HMI Web Client. Workspace is available if you are using Flex licensing. Therefore, after installation, you may see AVEVA Historian listed as a Windows program, even if you did not install the Historian. Do not uninstall Historian. You can use the Modify workflow to restore the Historian search and elastic search features if you inadvertently uninstalled Historian.
- In this initial release of Workspace, searching for Application Server attributes is not supported when using Workspace on a remote node. Searching for Application Server attributes is only supported on the GR or Galaxy Repository node. This feature will be supported in future releases.

For more information, see Workspace in the AVEVA InTouch HMI Help, ITWebBrowser.pdf, and Widgets, Apps, and Controls Help.

Cybersecurity Enhancement

This version of InTouch HMI incorporates several cybersecurity enhancements.

X-Frame-Options Authentication Settings for Web Client

The Web Client now supports the X-Frame-Options HTTP response header. This can be used to indicate whether or not a browser should be allowed to render a page in a <frame>, <iframe>, <embed> or <object>. An XFrameOptions property has been added to the appsettings.json files under InTouchWeb\Server and InTouchWeb\Content.

The value of XFrameOptions in the appsettings.json file is blank by default. To ensure that the Web Client page can only be displayed in a frame on the same origin as the page itself, you must set the values of XFrameOptions as ‘SAMEORIGIN’. The value is not case sensitive. A shared Web Client may not load if the value of XFrameOptions is set to SAMEORIGIN.

If you specify the value of XFrameOptions as blank, the X-Frame-Options response header will not be added.

New in Historian 2023

The AVEVA Historian 2023 release includes these features:

Ad hoc expressions in Historian Client Web and SQL queries

Replication to AVEVA PI and AVEVA Data Hub

Secure web access (HTTPS) that is easy to configure and use

Enhanced Excel add-in

• Streamlined workflow for creating reports
• New "Detailed Values" option
• "Last" (cyclic) option added to "Periodic Values"

Easily backfill to any replication server up to 10x faster (not just auto-summary)

Remote IDAS

• Now firewall-friendly, no longer requiring open inbound TCP ports
• Configuration via "pull" mechanism

Operations Control Management Console (formerly "System Management Console" or "SMC")

• Easy management of storage location indexes
• Supports Windows Integrated Login rather than specific credentials

Modernized Interface

• New Operations Control Management Console icons
• Optional Historian Client Web "new experience" adapted from AVEVA Insight

Hosted Help Integration

• Compiled help files (CHM) replaced with web-based help

Miscellaneous

• More consistent pen colors with default color based on the associated engineering unit dimension (Web and Desktop)
• "Daily" summary statistics adjust for daylight savings time in SQL queries
• InTouch alarm groups are now included in alarm history, and can be used as filters in the Historian Client Web alarm grid

New in Historian Client 2023

The AVEVA Historian Client 2023 release includes these features:

Modernized Interface

• Ribbon bar for Trend and Query
• Updated interface for embedded Trend and Query controls
• New application icons

Option for auto-scale to always automatically update in Trend

Configurable color for cursor difference color in Trend

Simplified queries and improved alarm queries in Query

Enterprise license support

Hosted Help Integration

• Compiled help files (CHM) replaced with web-based help

Miscellaneous

• More consistent pen colors with default color based on the associated engineering unit dimension
• "Daily" summary statistics adjust for daylight savings time in SQL queries

New in Communication Drivers

Revised Standard User Privileges and Options

A Standard User will now have only read rights. However, the Standard User will have an option to get the additional user privileges for a specific time interval by providing the OI Administrator user credentials. For more information on standard user privileges and getting Administrator Privileges, refer to "Accessing OCMC as a Standard User" in the Communication Drivers Pack Help.

Microsoft Edge for Auto-Build

Auto-Build now requires the Microsoft Edge browser.

MQTT

• Publisher: You can now publish payloads encoded in Sparkplug format using the MQTT publisher.
• Dedicated Publishing Hierarchy.
• Import/Export MQTT Publisher configuration.
• Performance improvement in displaying large galaxy configuration.
• MQTT Subscriber now provides hierarchical display of Sparkplug device attributes.

Buffered Data

Communication Drivers Pack supports buffered data up to 10K values/tag.

SuiteLink Fallback

Starting with this release, the fallback mode is set to secure (V3) by default, and the fallback mode to accept unsecure (V2) connections is disabled.

OPC UA Reverse Connect

The OPC UA Reverse Connect feature enables the OPC UA server to initiate a connection with the Gateway Communication Driver. In a secure environment, inbound connections to the OPC UA server are restricted as the server operates behind a firewall. By using Reverse Connect, the firewall restriction is alleviated as the connection is being made from the OPC UA server to the client.

New Security Policy Options

OPC UA now supports two new security policies: Aes128_Sha256_RsaOaep and Aes256_Sha256_RsaPss. Basic125Rsa15 and Basic256 are deprecated and supported only for compatibility reasons. For more information, refer to the Gateway Communication Driver Help.

Improved Server Browsing

You can now browse and select available endpoints of the OPC UA server and its supported security policy.

OpenSSL 1.1.1n Support

Gateway Communication Driver now uses OpenSSL 1.1.1n for MQTT, SuiteLink, and OPCUA for secure communication.

System Platform and System Platform Enterprise Comparison

The following tables list the System Platform and System Platform Enterprise components available for installation. Most components are common to both, while some widgets, apps, and other components are available for installation to only one.

About This Release

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

Application Object Toolkit

Start Menu and Shortcut Changes

Name Changes to Graphics and Graphic Toolsets

Readme Files for Other Products in this Release

Supported System Platform Versions for Product Upgrade

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

You can upgrade directly to System Platform Enterprise 2023 only from System Platform 2020 R2 SP1.

Limitations

All existing, installed products on a node must be upgraded to the same version. 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.

You cannot mix System Platform and System Platform Enterprise nodes; all nodes must be either System Platform or System Platform Enterprise.

System Platform Enterprise requires FLEX licenses.

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

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.

Operating System Compatibility

The earliest versions of Windows that support System Platform 2023 and System Platform Enterprise 2023 are:

• Windows 10 1809 (Long Term Service Channel license), Professional, Enterprise, or Enterprise IoT Edition
• Windows 10 20H2 (Semi Annual Channel license), Enterprise or Enterprise IoT Edition
• Windows Server 2016 (Long Term Service Channel license) Standard or Datacenter Edition

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

Supported System Platform Versions for Migration

You can migrate user-created content (for example, .cab files, .aaPKG files, Historian databases, etc.,) to System Platform 2023, 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.

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

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.

Application Object Toolkit

Microsoft .NET Framework 4.8 is required for System Platform 2023. 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 2023 release, but if you use AOT to build objects for Application Server, check that you have installed and configured the developer pack for .NET Framework 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 Operations Control Management Console, are now located under the AVEVA Start menu folder. These were under the Wonderware Utilities folder prior to System Platform 2020.

Name Changes to Graphics and Graphic Toolsets

For System Platform 2023, the System Platform IDE changes the names of some of the toolsets and graphics included in the Graphics Toolbox. The affected toolsets and graphics are in the path
_Default Content > 3. Graphics > Icon Library

• The "SE_" prefix is removed from all graphic names in the SE_Branding toolset, and the toolset name is changed to "Branding." The full path to the renamed toolset and graphics is:
  _Default Content > 3. Graphics > Icon Library > Branding

  The SE_Branding toolset is now simply Branding, SE_Domain_Pictograms is now Domain_Pictograms, and so on.

• The "WW_" prefix is removed from the WW_Icons toolset, and the WW_Logo and WW_Logo_Tbit graphics are removed. The toolset name is changed to "Icons." The full path to the renamed toolset and graphics is:
  _Default Content > 3. Graphics > Icon Library > Icons

  The new Icons toolset contains only one graphic named AVEVA_Logo. This graphic is new for System Platform 2023.

Existing galaxies that were created before System Platform 2023 will continue to contain the previous toolset and graphic names; you do not need to change any existing graphics or layouts that use any of these graphics under the SE_* or WW_* name.

New galaxies created after an upgrade to System Platform 2023 will contain only the new graphics.

Except for replacing the old WW_Logo graphics with AVEVA_Logo, this is a name change only. The graphics themselves have not changed.

Readme Files for Other Products in this Release

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

Important 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 2023 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 2023. 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 2023, 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 2023.

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

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 OMI 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 System Platform 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. You can also open the OMI SDK Help via AVEVA Help, accessible from the Windows Start Menu, under AVEVA.

• The default installed location of the SDK is:

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

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 2023

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

Supported and Recommended Node Hardware Types

Hardware Requirements Notes

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

Windows requirements

• Windows Server 2022 System Requirements
• Windows Server 2019 System Requirements
• Windows Server 2016 System Requirements
• Windows 11 System Requirements
• Windows 10 System Requirements

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

SQL Server requirements

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

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

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

Minimum Operating System and Browser Requirements for System Platform 2023

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

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

Minimum Required Operating System Version

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

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

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

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

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 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 2023 on a computer used as a domain controller is not supported.
For more information, see the Microsoft Security Best Practices Checklist.

System Platform 2023 Web Clients

The following web clients are included with System Platform 2023:

• 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 2023).
• 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.
• Upgrading the operating system while System Platform is installed is not supported.

.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 System Platform, check the following:

• Your installed version of SQL Server is no longer supported, for example, SQL Server 2012.
  • 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 2016 SP2, which was supported on System Platform 2020 R2 SP1, but now upgrading to System Platform 2023 is blocked because this release requires SQL Server 2016 SP3 or newer.
  • How to Fix: Download and install the required service pack.
• You have a 32-bit version of SQL Server installed.
  • How to Fix: Refer to Issue 1249251 under Installation, Upgrade and Galaxy Migration Issues.

Supported SQL Server Versions at Time of Release

64-bit only

The default database is SQL Server 2019 Express Core

For information about which version of SQL Server you are running, see 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 2023:

• 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 Operations Control Management 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 2023

InTouch HMI with Supported Windows Operating Systems

• InTouch HMI 2023 does not support the following legacy script functions: 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 2023 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 2023 with InTouch HMI 2023 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 Operations Control Management Console.
• 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 2023 leverages Microsoft .NET Framework 4.8. 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. Although .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 proper text encoding is not used. This may cause a script to exit without completion. The UTF8Encoder is the default BinaryStream decoder in .NET Framework 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:

• What's New in .NET Framework
  https://docs.microsoft.com/en-us/dotnet/framework/whats-new/
• What's obsolete in the .NET Framework class library
  https://docs.microsoft.com/en-us/dotnet/framework/whats-new/whats-obsolete
• Migration Guide to the .NET Framework 4.8, 4.7, 4.6, and 4.5
  https://docs.microsoft.com/en-us/dotnet/framework/migration-guide/
• .NET Framework 4 migration issues
  https://docs.microsoft.com/en-us/previous-versions/dotnet/netframework-4.0/ee941656(v=vs.100)

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. If SQL Server is not installed, SQL Server 2019 Express Core is installed automatically. If you wish to install a full version of SQL Server, exit the installation program, install a 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

• 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. Supported SQL Server versions at the time of release of System Platform 2023 include:
  • SQL Server 2016 SP3 or SP3 with all cumulative updates
  • SQL Server 2017 with all cumulative updates
  • SQL Server 2019 with all cumulative updates
  • SQL Server 2022 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:
  • Upgrade SQL Server
  • ALTER DATABASE (Transact-SQL) Compatibility Level
• 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 AVEVA folder in the Windows Start menu.
  • Run the SQL Access Configurator from the AVEVA folder in the Windows Start menu.

  If you accidentally delete the aaAdministrators group from the SQL Server security logins, you must run the SQL Access Configurator to restore it. Refer to the "About the System Platform Network Account" in the Application Server User Guide for additional information.

Considerations for SQL Server Express

• SQL Server Express is supported for use on an Application Server or Historian node, but is recommended for use only in small or development configurations. SQL Server 2019 Express 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 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 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 2023 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 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 should have a permanent password that does not expire, and the password should not 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, some System Platform components 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 the Common Platform, including the System Management Server (SMS) and license type, on all nodes. Only one SMS node should be configured per System Platform installation; configure all other System Platform nodes to point to the SMS node.
   2. Configure the AVEVA System Monitor on all nodes. Only one System Monitor node should be configured per System Platform installation; configure all other System Platform nodes to point to the System Monitor node.
   3. Configure the Alert Email Server on the System Monitor Manager node.
   4. Configure the remaining product plug-ins.
   5. 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.

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 2023, 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

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.

• PCS and MGC Issues
• Communication Driver Pack Issues
• Installation, Upgrade and Galaxy Migration Issues
• AVEVA OMI Issues
• Application Server Issues
• InTouch HMI Issues
• InTouch Access Anywhere Issues
• Historian Issues
• Licensing Issues
• System Monitor Issues
• AVEVA Alarm Control Issues
• AVEVA Edge Co-Existence Issues

PCS and MGC Issues

PCS: Platform Common Services

MGC: Multi-Galaxy Communication

Communication Driver Pack Issues

Installation, Upgrade and Galaxy Migration Issues

AVEVA OMI Issues

Application Server Issues

InTouch HMI Issues

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

InTouch Access Anywhere Issues

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

Historian Issues

Licensing Issues

System Monitor Issues

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

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.

Documentation

Most System Platform help documents are provided as PDF and web help documents.

• The System Platform Installation Guide is located in the root folder of the installation DVD.
• Use the Start Menu to access Application Server, InTouch HMI, Historian, and other System Platform PDF documents in the AVEVA Documents folder.
• Online help can be viewed in your browser using the AVEVA Products Help Viewer.
  • To launch the Help Viewer from the Windows Start menu, click AVEVA, and then click AVEVA Help.
  • The Online Help can also be accessed directly from the various System Platform applications, including Application Server (System Platform IDE), InTouch HMI (WindowMaker), and Historian.

InTouch HMI Documentation Corrections

This section lists important InTouch HMI documentation corrections.

--- End of Patch 02 Readme ---