AVEVA™ InTouch HMI 2023 R2 P01 Readme

Last revision: 6/14/2024

About this Readme

This Readme provides information about AVEVA InTouch HMI 2023 R2 P01. Readme files from previous releases of AVEVA InTouch HMI are posted on the support site.

In this Release

InTouch HMI 2023 R2 P01 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.

License requirement for InTouch WindowMaker

You can now run WindowMaker without license. For both Standalone and Managed InTouch applications, WindowMaker is allowed to run for any tag count and window count with full capability without any license check.

No tag and window count limitation in demo mode for InTouch WindowViewer

In both Standalone and Managed InTouch applications, if an application has less than or equal to 64 tags, then WindowViewer will launch in free mode (no restrictions).

Note: Free mode is not supported in Operations Control connected experience.

If application has greater than 64 tags and no valid license, then demo mode is offered. While running in demo mode, there is no tag count or window count limit, however, there is 2 hours of runtime limit. After two hours, WindowViewer will exit.

In free mode, if application is not an InTouchVew application and running in non-RDS(Remote Desktop Services) environment, then application will be always running with Read/Write capability regardless the setting of remote access configuration.

Chinese InTouch runs with either Chinese or English InTouch license

You can now run Chinese version of InTouch with English InTouch license as well.

Resolved Issues

InTouch 2023 R2 P01 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.

Resolved Issues for Web Client

Known Issues

This section describes known issues that remain in the release of InTouch HMI 2023 R2 P01.

AVEVA™ InTouch HMI 2023 R2 Readme

Last revision: 12/1/2023

About This Readme

This Readme provides information about InTouch HMI 2023 R2 (Version 23.1.000). Readme files from previous releases of InTouch HMI are posted on the Support website.

This release includes all the issues shipped in the InTouch HMI 2023 P01, InTouch HMI 2023 P02, and InTouch HMI 2023 P03 release and can be installed directly.

Important!

When installing System Platform 2023 R2, Gateway Communication Driver is installed as a hidden feature of InTouch HMI 2023 R2.

• If you previously installed FS Gateway, the System Platform 2023 R2 installation will remove FS Gateway, preserve your existing FS Gateway configuration, and port your configuration to a new instance of the Gateway Communication Driver, retaining the FS Gateway name. Existing FS Gateway configurations that use OPC access will not be impacted.
• Gateway Communication Driver will be installed as part of System Platform 2023 R2.
• If your system has an older version of Gateway Communication Driver installed, the System Platform 2023 R2 installation will upgrade Gateway Communication Driver as a first action. You will need to re-run the System Platform 2023 R2 installation to install other components.

For more information about the Gateway Communication Driver installation, upgrade, and uninstall, see the System Platform Installation Guide, "InTouch HMI Requirements and Prerequisites" section, "Installing OI Gateway and Modifying FS Gateway Installations" topic.

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

In this Release

InTouch HMI 2023 R2 (Version 23.1.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.

Alarm Latching and Alarm Dismiss

If the Alarm latching feature is enabled, an acknowledged alarm that has returned to a normal value will continue to be displayed in the LATCHED alarm state. LATCHED alarms can be displayed in the current alarms mode to show that the alarms did occur. Alarms go to the LATCHED state when:

• ACK an alarm from UNACK_RTN state.

  Or

• Return an alarm from ACK state.

To view the LATCHED state, enable the LATCHED state in the Alarms and events configuration screen of the IDE. You can dismiss the LATCHED alarms to remove the LATCHED alarms from the current mode of the Alarm Client Control grid. The dismissed LATCHED alarms would be visible in the recent mode of the Alarm Client Control.

Credential Manager

Use the Credential Manager utility to securely store and manage login credentials. You can retrieve the stored credentials (from AVEVA Application Manager for standalone applications, and from the Application Server for managed applications) for authenticating access to other components in WindowMaker, WindowViewer, and Alarm utilities.

By default, all named credentials are added to the Administrators group. In addition, we recommend you to add groups that the users running the application belong. This will allow the users to access the credentials even when running the application in a non-administrator mode, such as WindowViewer.

Changes to the Default TCP port for Communication with Historian Server

The default TCP port for communication with Historian server has been changed to 32565. This is configurable and is used for data replication and communication with remote IDAS version 2023 R2 and later. The Classic Historian TCP port - 32568, was used for data replication and remote IDAS communication with Historian versions 2023 and earlier, and remains for compatibility with previous versions.

OPC UA Enhancements

A new option External providers has now been added under Tag dictionary, that lists all the OPC UA server connections configured in the Gateway Communication Driver present on the same machine. Using this option, you can avoid several manual steps and create access names and InTouch tags for OPC UA item references easily. You can create the tags by just dragging and dropping from the External providers pane to the new Model – Tagname pane, that displays all the alarm groups and tags of the InTouch application.

Create Graphic Elements and Industrial Graphics using InTouch Tags

A Model – Tagname tab has been added in the Properties configuration pane of the Industrial Graphic Editor which displays all the tags available in the InTouch application. You can simply drag and drop the tags to the canvas to create graphic elements or Industrial Graphics. When creating multiple symbols at a time, the dot field property will be bounded automatically. This method simplifies the graphic development workflow and significantly reduces the application development time.

Embed an Industrial Graphic from the Toolbox Tab of Industrial Graphic Editor

You can embed an existing Industrial Graphic into current graphic using the Toolbox tab located in the Properties configuration pane of the Industrial Graphic Editor. The Toolbox tab displays all the Industrial Graphics available in the InTouch library. Once you have embedded the graphic, you can then edit it like any other component of the graphic.

Support for Import of SVG as an Industrial Graphic

The Industrial Graphic Editor supports import of Scalable Vector Graphics (SVG) as Industrial Graphics. You can perform the following:

• Import an SVG into the Industrial Graphic Editor. The graphic elements automatically get converted to an Industrial Graphic, which can include many primitives.
• Insert the SVG while using the Image icon from the Tools panel of the Industrial Graphic Editor.
• Use SVG for the UpImage and DownImage on a button.
• Use SVG for the Quality & Status display icons under Styles configuration.

Support for User Defined Types (UDTs) in InTouch

This feature supports the following:

• Manually create one or more UDTs, with nesting up to six levels.
• Manually create one or more UDT instances from a UDT.
• Bind individual UDT instance members to I/O.
• Reference individual UDT instance members in Industrial Graphics symbols.
• Import and export UDT to a JSON file.
• Edit UDT in bulk using external JSON editor.
• Edit and override UDT Properties except Name and Type.
• Changes in a data type are reflected immediately in the User Defined Type view.
• Configure the owning object of an embedded graphic and point to an UDT instance. During run time, the me. relative reference is replaced by the UDT instance. You can also update the owning object to a different UDT instance during run time.
• Intellisense for UDT instances lists all members and member data structures for the immediate level only. The Industrial Graphic Editor supports intellisense in scripting, animation, and custom properties. Native InTouch supports intellisense in scripting only.
• You can configure UDTs in Industrial Graphic animations and native InTouch animations.
• You can configure UDTs in an Industrial Graphic script and a native InTouch script.
• Update the alarm properties in the Properties grid. In the WindowViewer, you can view the members of an instance that are generating alarms and display them in an Alarm Client Control.
• The UDT members of an instance can log data to LGH files or the Historian, as with other InTouch tags.
• The UDT member of an instance behaves the same as other InTouch tags in the MapApp.
• The UDT member of an instance works the same as other InTouch tags in the Web Client.

Introducing the new Unified Identity

AVEVA Unified Identity enables Single Sign-On (SSO) for all Operations Control products on a given node with AVEVA Connect cloud capabilities. It supports common user authentication, authorization, and access entitlements across AVEVA Operations Control products. It includes:

• User Authentication via a single common user ID, configured and managed within AVEVA Connect.
• User Authorization via roles, groups, and rules (allow/deny).
• Single Sign-On: After you sign-on to a supported product, subsequent sign-ons to that product or other supported products on the node are automatic.

The connected experience requires access to the AVEVA Connect cloud repository from each node where you want to use it.

Option to secure InTouch application folder

To restrict access to the applications folder for Standalone applications, a new check box has been introduced in Application Manager under Tools > Security. When the security feature is enabled on a node, strict read and write permissions are applied to the InTouch View Application.

Update default local working directory for NAD and Managed InTouch application

An option Enable local working directory integrity check for Managed and NAD InTouch Applications has been added in the Application Manager, under Tools > Node properties > Security. If this option is enabled,when launching WindowViewer for a Managed InTouch application andr NAD application, a file time stamp and file content hash comparison is performed between the deployed application and the application in the local working directory. If the files do not match, WindowViewer will copy the deployed application to the local working directory and run the application.

System Requirements

This section describes the hardware and software requirements to support System Platform products, including InTouch HMI.

Hardware Requirements

System Sizing Guidelines

The following table provides guidelines for hardware configurations suitable for System Platform 2023 R2 software based on the size of the installation. These guidelines are subject to the limitations of your Windows operating system.

• The Intel Itanium 2 processor is not supported.
• We recommend 1280 x 1024 as the minimum display resolution for engineering tools such as the Integrated Development Environment (IDE).
• A Windows Server operating system is required for large installations with more than 50,000 I/O per node.
• SQL Server Express is not supported for installations with more than 25,000 I/O per node (small installations only).

Notes:

1 In redundant environments, increase CPU and RAM to maintain a maximum of 40% typical resource utilization.

2 Minimum amount of storage needed to provide sufficient capacity for 1 week @ max frequency.

Hardware Requirements Notes

Windows operating systems and SQL Server versions may impose hardware requirements that exceed the minimum requirements for InTouch HMI 2023 R2. Refer to the following Microsoft Web pages for Windows and SQL Server hardware requirements:

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

Auxiliary Hardware Requirements

This section describes any optional hardware requirements beyond the specific hardware requirements discussed earlier in this Readme.

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, .NET Framework, and Virtualization Requirements

This section describes additional details about the supporting software for an InTouch HMI system.

Software Requirement Notes

Windows Operating System Notes

• Windows versions 8.1, and 10 support touch screen gestures. In the Windows version 8.1,if the user swipes in from the right edge of a touch screen with a finger gesture, a set of Windows charms appears, which includes Search, Share, Start, Devices, and Settings. Moving the mouse cursor to the upper-right corner of a screen also shows the Windows charms for non-touch screens.

  Showing the set of charms is a standard feature of Windows versions 8.1 that cannot be disabled by software for a touch screen. As a result, operators can access these Windows charms and possibly unlock a dedicated touch screen view node.

• Newer operating system Service Packs (SPs) than those listed do not block the installation of products. A warning message may appear during the installation process.
• The Galaxy Repository (GR Node) can run on a client Windows operating system in a configuration in which System Platform products are installed on up to five nodes. For a system with more than five nodes, the Galaxy Repository must be installed on a computer running a Windows Server operating system.
• Development and application nodes are considered to be clients of the server GR node.
• When an operating system is upgraded on a computer, existing System Platform products must be uninstalled prior to the upgrade and then reinstalled after the upgrade. There are three exceptions. System Platform products do not need to be uninstalled when upgrading from:
  • Windows 8 to 8.1
  • Windows 8.1 to 10
  • Windows 2012 to Windows 2012 R2

.Net Notes

• Versions of .NET (other than 4.x versions) can coexist, but all .NET code, including QuickScript.net scripts, run under .NET 4.8.

  For more information about .NET Framework requirements and compatibility, see .NET Framework Requirements and Compatibility .

• .NET 3.5 is installed only because the supported SQL Server versions require it. No other dependencies must exist.

Operating System Notes Common to AVEVA Products

ActiveX Controls Behavior on Supported Windows Operating Systems

Due to the Data Execution Prevention (DEP) feature of Windows 7 and later operating systems, any ActiveX control built with ATL version 7.1 or earlier will fail to host or will have unpredictable behavior in InTouch 2017 UPDATE 1 either in WindowMaker or WindowViewer. For more information, refer to Tech Note 922: "Some ActiveX Controls NOT Supported in InTouch 2012 R2 (Version 10.6)" available from the Technical Support web site.

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

Using Alarm Manager on a Single Node Running Both InTouch HMI and Application Server Alarm Providers

Starting with Microsoft Windows Vista, the operating system imposes "Session 0 Isolation" as a security enhancement. All Windows services and associated programs are required to run in Session 0, and no GUI applications are allowed to run in Session 0.

Prior to Windows Vista, Application Server and InTouch HMI WindowViewer ran in the same Windows session. Session 0 Isolation requires that Application Server and WindowViewer run in separate Windows sessions. Alarms that are reported by the Galaxy are handled by the Session 0 instance of Alarm Manager (AlarmMgr), which is now different from the Console Session instance of AlarmMgr that handles InTouch alarms. A simple alarm query in an InTouch alarm display such as

\InTouch!$System \Galaxy!Area_001

is now serviced by two separate instances of AlarmMgr -- one running in the Console Session for InTouch, another running in Session 0 for the Galaxy.

This behavior, and related behaviors and error messages resulting from the Windows operating system Session 0 changes, along with procedures to configure the Distributed Alarm System to support alarms from both InTouch and Application Server on the same computer node running with Windows Vista and later operating systems, are described in detail in TechNote 988, "AlarmMgr Support for InTouch and AppServer on Windows Vista and Later". You can download this TechNote from the Global Customer Support (GCS) website.

Remote Desktop Services (Terminal Services) Behavior in Windows Server Operating Systems

Windows Server 2008 R2 and later Windows versions no longer support the /console switch as a means of starting the remote desktop (RDP) client, also known as Session 0 or Terminal Server Console session. In Windows Server 2008 or later, Session 0 is no longer an interactive session, and is reserved only for Windows services. From Windows Server 2008 and later, all remote connections are treated 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 Remote Desktop (Terminal Server Console) session.

In another aspect of Remote Desktop Services behavior, InTouch HMI functions such as TSEGetClientID() can return a null value with InTouch running in a remote desktop (RDP) client session. The cause of this behavior is that the relevant roles are not installed on the RDP client. You must install the "Remote Desktop Host" role in order for TSEGetClientId() and other related functions to work properly.

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.

Application Server and InTouch HMI detect when the application is running in the console. In Windows Server, it implies that the application was started by a user physically at the machine. However, this behavior may require you to disable the group policy that enables Fast User Switching.

The software detects when an application is running in the console. All remote connections are treated as a remote RDP session by Windows Server, regardless of /console or /admin switches in the mstsc connection.

To disable fast user switching through the Group Policy interface

1. Click Start and then Run. The Run dialog box appears.
2. Enter gpedit.msc and click OK. The Group Policy dialog box appears.
3. Go to the following location: Local Computer Policy > Administrative Templates > System > Logon.
4. Set Hide Entry Points for Fast User Switching to Enabled. Enabling this policy hides the Switch User option in the Logon interface, the Start menu, and the Task Manager.
5. On the File menu, click Exit to close the Group Policy dialog box.

By enabling the policy, Administrators hide the Switch User button in Windows logon, in the Start menu, and in the Task Manager.

InTouch HMI Operating System Notes

• Windows client (starting with Windows 7) do not support a dedicated single-node server configuration that runs one or more databases for an InTouch HMI system.
• The EnableDisableKeys() function writes to the Windows registry to enable or disable some keys on the host computer running an application in WindowViewer. For security purposes, Windows 7 and later versions of Windows prevent Standard or Power users from writing to the registry. Windows Administrators can write to the registry if not disabled by local domain security policies.

  You can configure local Windows security policies that work in conjunction with the EnableDisablekeys() script function to regulate the user's access to keys in a running InTouch application.

• As of System Platform 2014, a computer running Windows 7 or later operating systems can be configured as both an InTouch and an Application Server alarm provider. For more information, see Using Alarm Manager on a Single Node Running Both InTouch HMI and Application Server Alarm Providers on Windows Vista and Later Operating Systems.

  The following InTouch legacy script functions do not operate on 64-bit versions of Windows: WWPoke(), WWExecute(), WWRequest(), ActivateApp() and SendKeys().

• The InTouch Extensibility Toolkit might need to be started by right-clicking and selecting Run As Administrator on Windows 7 or later operating systems to function properly.
• The onscreen keyboard options have changed, beginning with Windows 7 and Windows Server 2008 R2 operating systems.
• Hovering to select from the Windows keyboard does not work in supported versions of Windows 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 R2 with InTouch HMI supports User Account Control-enabled operations on run-time nodes.

.NET Framework Requirements and Compatibility

IMPORTANT: System Platform 2023 R2 installs .NET 4.8 if the currently installed version of .NET is 4.7.2 or lower. If .NET 4.8 or later is installed, no change is made to the .NET Framework. Prior to upgrading your existing applications to System Platform 2023 R2, we strongly recommended that you:

• Back up your applications
• Familiarize yourself with the changes introduced by Microsoft in the .NET Framework
• Review your .NET scripts and .NET controls for any required changes

After upgrading to System Platform 2023 R2, you should perform application testing on application scripts and on script libraries used by the application to ensure they continue to function properly under .NET 4.8. We also recommend you test the upgrade in a staging system prior to upgrading your production system.

System Platform 2023 R2 leverages Microsoft .NET Framework 4. The System Platform installation program will install .NET 4.8 if your system uses version 4.7.2 or lower. No change is made if your system uses .NET 4.8 or higher. Multiple versions of the .NET Framework can coexist. On nodes where SQL Server is installed, .NET 3.5 is also installed by System Platform to support SQL Server. In this scenario, other applications you have on the same machine with dependencies on .NET 3.5 will access .NET 3.5. System Platform 2023 R2 will use .NET 4.7.1, 4.7.2, or later.

All user-supplied .NET code that runs in the context of InTouch HMI and Application Server requires .NET Framework 4.8 or higher. Although .NET Framework 4.5.1 (and later) is highly compatible with applications that are built with earlier .NET Framework versions, you may have to update your scripts, if your .NET scripts were created prior to System Platform 2014. These changes may also affect .NET controls developed with .NET 3.5.

In application scripting, some .Net codes could fail if not using proper text encoding, and could cause a script to exit without completion. The UTF8Encoder is the default BinaryStream decoder in .Net 4.5. To enable an application 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 the .NET Framework: http://msdn.microsoft.com/en-us/library/ms171868%28v=vs.110%29.aspx

What's obsolete in the .NET Framework Class Library: https://msdn.microsoft.com/en-us/library/ee461502%28v=vs.110%29.aspx

Migration Guide to the .NET Framework 4.6 and 4.5: https://msdn.microsoft.com/en-us/library/ff657133%28v=vs.110%29

.NET Framework 4 Migration Issues: http://msdn.microsoft.com/en-us/library/ee941656%28v=vs.100%29

Virtualization Host Support

See the Global Customer Support (GCS) Technology Matrix for supported virtualization environments.

SQL Server Requirements

SQL Server Requirements for All Components

See the GCS Technology Matrix for SQL Server requirements for System Platform 2023 R2 components, including InTouch HMI 2023 R2.

Note: Match SQL Server version to operating system version.

We recommend that you install and configure the supported SQL Server version before you begin the System Platform installation program, especially if you expect Information Server to coexist, either on initial or subsequent installations, with the InTouch HMI, Application Server, or the Historian Server.

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, and then resume the installation.

Considerations for SQL Server

• Alarm DB Logger To use the Alarm DB Logger, you must set the default SQL Server authentication mode from Windows-based to Mixed Mode.
• SQL Server Configuration Rights: While installing System Platform, configuration changes to SQL Server are required. If the installer does not have SQL Server administrative rights, the proper configuration of SQL Server may not be applied. A post-install aaConfig SQL utility enables you to verify if the SQL configuration has been performed.
• Maximum Server Memory: After installing SQL Server, Use SQL Server Management Studio to confirm that the Maximum Server Memory is configured to approximately 65% of the computer's total available RAM. By default SQL Server does not clamp this setting. The System Platform installation process will attempt to adjust it if it has the appropriate rights to configure SQL Server.
• Restoring a CAB: You cannot restore a Galaxy .cab file backed up in SQL Server 2012 or SQL Server 2008 to a node with an earlier version of SQL Server. For example, you cannot restore a Galaxy .cab file backed up in SQL Server 2012 to a node with SQL Server 2008. For example, you cannot restore a Galaxy .cab file backed up on SQL Server 2008 to a node with SQL Server 2005. SQL Server database backups from SQL Server 2005 forward are not backward-compatible. Attempting such a restore initializes, and the progress dialog box quickly displays 100% completion of restoring the database, but the Galaxy .cab restore operation does not actually complete, and no Galaxy Repository is created. When you start the IDE, the Galaxy is blank.
• Migrating SQL Server Versions: You can migrate a SQL Server database to a later version from any of two prior versions. For example, you can migrate to SQL Server 2012 from SQL Server versions 2008 or 2005. You can migrate to SQL Server 2008 from SQL Server versions 2005 or 2000. You cannot migrate directly from SQL Server 2000 to SQL Server 2012. Such a migration requires an intermediate version installation. For more information and helpful procedures, see the following Microsoft references:
  • Upgrade to SQL Server 2014
  • Migrate SQL Server 2000 to SQL Server 2012
  • Migrating to SQL Server 2008 R2
  • Migrating to SQL Server 2008
  • T-SQL scripts to migrate SQL server 2000 user databases to SQL server 2012
  • ALTER DATABASE Compatibility Level (Transact-SQL) SQL Server 2012
  • ALTER DATABASE Compatibility Level (Transact-SQL) SQL Server 2008 R2
• SQL Server Rights Requirements: SQL Server 2008 and later versions do not automatically create the BUILTIN\Administrators role delivered in SQL Server 2005. Because of this change to SQL Server, the Application Server 2014 installation process will create the necessary operating system user group (aaAdministrators) as well as the necessary SQL Server role. This automated process will provide the rights required to allow operations within the Galaxy Repository without the need for blanket BUILTIN\Administrator rights. The aaAdministrators group must be present and enabled. If you accidentally delete the aaAdministrators group from the Windows operating system, you can run either of two options to restore it:
  • Run the Change Network Utility from the Windows Start menu.
  • Run the aaConfig SQL Utility from the Windows Start menu.

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

Considerations for SQL Server Express

• SQL Server Express is supported for use on a Galaxy Repository node and recommended for use only with small systems.
• If you plan to modify an InTouch HMI installation which has SQL Server Express installed, then add Application Server with full SQL Server, you must install the full SQL Server prior to modifying the InTouch HMI installation or installing Application Server.
• If you plan to use SQL Server Express with Information Server and System Platform on the same node, the following limitations apply:
  • Install Information Server first with the SQL Server Express default instance name set to "SQLEXPRESS". Then, install InTouch HMI. This scenario will work without issues because each component uses a dedicated instance of SQL Server Express.
  • If you install InTouch HMI first, the System Platform installer silently installs and configures SQL Server Express. Installing Information Server will fail during configuration with an error message stating: "SQL Server client components not found."

    To work around this issue, configure Information Server to use an instance of SQL Server Express (or a non-Express edition) on a remote node.

  • The computing capacity of SQL Server Express is limited to the lesser of one CPU socket or four processor cores.
• For InTouch HMI installations, the System Platform installer installs SQL Server Express, if these conditions are met:
  • No other SQL Server elements are installed on the computer at the time of installation.
  • You select only the InTouch Development and Runtime System Platform installation option. When you select InTouch Development and Runtime, a Galaxy Repository will be installed.
  • The installation program includes an option to not install SQL Server on an InTouch development computer. When the option is selected, it prevents SQL Server from being installed. Clear this option to automatically install SQL Server on a development computer.

InTouch Access Anywhere Requirements

The following sections describe the requirements to run InTouch Access Anywhere Server and supported browsers. For detailed information, see the InTouch Access Anywhere documentation.

You can determine the version of InTouch Access Anywhere Server installed on a computer using Programs and Features from the Windows Control Panel.

Requirements

The InTouch Access Anywhere Server can be installed as a System Platform installation option. The InTouch Access Anywhere Secure Gateway is an optional component installed on a separate computer within a network DMZ.

The following requirements must be met before you install the InTouch Access Anywhere Server or a Secure Gateway.

• InTouch Access Anywhere server must be installed on a 64-bit version of Windows that is supported by InTouch HMI 2012 R2 (version 10.6) or later.
• InTouch Access Anywhere must be installed on the same RDP Server computer as InTouch HMI 2012 R2 (version 10.6) or later.
• Remote Desktop (RDP) must be enabled and properly configured on the host computer. For information and guidance, see Tech Note 782, "Installing Remote Desktop Services on Windows 2008 Server R2 for AVEVA Products". You also can refer to http://technet.microsoft.com/en-us/library/dd883253.aspx.
• You must have an InTouch 2012 R2 TSE (RDS) or newer license activated. When InTouch is launched by InTouch Access Anywhere, this RDS license will be consumed per browser session. It will be released when InTouch is closed by InTouch Access Anywhere.
• Per-Device licenses are not supported.

Supported InTouch Access Anywhere Browsers

InTouch Access Anywhere can run on smart phones, tablets, laptop computers, or any other device that supports an HTML5-compliant web browser. Browsers validated to support InTouch Access Anywhere include the following:

• Apple Safari
• Google Chrome
• Microsoft Edge
• Microsoft Internet Explorer
• Mozilla Firefox
• Opera

Functionally Compatible Browsers

Older versions of the listed browsers are functionally compatible with InTouch Access Anywhere. You may be able to use the following older versions of these browsers, but specific behaviors are unknown because no formal testing has been done with InTouch Access Anywhere.

• Apple Safari versions 5 and 6
• Google Chrome versions 11-27
• Microsoft Internet Explorer versions 7 and 8.
• Mozilla Firefox versions 4-21
• Opera versions 11-14

You are strongly encouraged to upgrade to one of the supported browser versions listed in Browsers Tested with WindowViewer. For a complete list of considerations to run an InTouch application with InTouch Access Anywhere on a portable device, see the InTouch Access Anywhere User Guide.

InTouch HMI 2023 R2 Product Compatibility

Product Compatibility refers to the ability of a product to work with various versions of other products running on different network nodes. Product Compatibility also refers to the ability of a product to work with various versions of the same product running on different nodes.

Coexistence refers to same-node installation of a product with other products that support the same hardware, operating system, and SQL Server versions. Other products not listed will be covered by System Compatibility Testing unless specifically noted.

In a single-node environment, if you want to install multiple components on a single computer, all components must be at the same versions.

In a node-to-node environment, components are compatible between the current licensed version and one licensed version back.

For more information about the list of products and their compatibility and coexistence with InTouch HMI 2023 R2, refer to the GCS Technology Matrix on the AVEVA Global Customer Support (GCS) website.

In some cases, InTouch HMI is supported in newer environments than a compatible product. InTouch HMI has been tested for compatibility with a listed product only in the environments that are supported by that particular product.

InTouch HMI Installation

For detailed English installation instructions, see the System Platform Installation Guide (SP_Install_Guide.pdf) or System Platform Installation Help (SP_Install_Guide.chm). Condensed English installation instructions are also provided in the printed InTouch HMI Getting Started Guide booklet that is included in the installation package. This booklet is provided for all supported languages.

Installing InTouch HMI

The major decision you must make when you install InTouch HMI is whether to install the InTouch development and run-time components, or the run-time components alone. The installation program guides you in selecting the features you want, verifying or modifying your selections, installing prerequisite software, and then installing InTouch HMI and the IDE if you chose to install development components.

What You Need to Install InTouch HMI

You must have the following materials ready to install InTouch HMI:

• Installation media.
• Computer that meets the hardware and software requirements listed in this Readme.

Important: Use the hardware and software requirements listed in the Application Server Readme if you are going to install the IDE.

Prerequisites

The installation program analyzes the software installed on your computer and lists any required software that is not installed.

Note: At the start of the installation, the prerequisites check is system-specific rather than product-specific.

The following prerequisites, if not already present on your system, will be installed by the System Platform installation program:

• Windows Installer 4.5
• .Microsoft .NET Framework 4.8
• SQL 2022 Express Core

  SQL 2022 Express Core is installed automatically if either of the following conditions are met:

  • No version of SQL Server is installed on the host computer.
  • You select only InTouch Development and Runtime during the System Platform installation. You must not select any Application Server components.

The installation program installs both system-specific and product-specific prerequisites. You do not have to exit from the installation program to install the prerequisite software. For more information about System Platform installation prerequisites, see the System Platform Installation Guide.

About the ArchestrA User Account

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

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

If the ArchestrA user account has not previously been configured, you will be prompted to configure it during the InTouch HMI installation. You must specify a user name, password, and domain.

If you choose to use an existing user account, it should meet the following requirements:

• User account with a permanent password that does not expire.
• User account with network privileges if InTouch HMI 2023 R2 will be installed on a multi-node system
• User account in which the password cannot be changed.
• User account that is a member of the local Administrators group.

After you install the InTouch HMI, you can use the Change Network Account utility to change or recreate the ArchestrA user account. This utility is accessible from the Start menu in the AVEVA Common folder after you install InTouch. You must have Administrator privileges on the computer to make changes with the Change Network Account utility. For more information, see the Change Network Account utility help.

Note: If you recreate the user account using the Change Network Account utility, the Microsoft Windows security component on the computer can take several minutes to update this information on the ArchestrA Galaxy node. Until that occurs, the ArchestrA component may not function properly. Restarting the Galaxy node updates this information immediately.

Performing the InTouch HMI Installation

Before you start installing InTouch HMI, you should have a clear idea whether you want to develop, deploy, and publish your own applications, or require only the InTouch run time, to run applications already created and deployed.

The following procedure will guide you through the installation, with information specific to the InTouch HMI.

To install the InTouch HMI

1. Locate the installer file (Setup.exe) in the installation media. Double-click the Setup.exe file or right-click Setup.exe and select Run as administrator.
2. Follow the prompts to start the installation and install system prerequisites, as necessary.

   The installation program prompts you to select an installation type: either product-based selection or installation by computer roles. As you are only installing InTouch HMI, click the product-based selection as your installation type.

3. Choose the components you want to install.
   1. If you choose InTouch Run Time Only, the following will be installed:
   • InTouch Run Time
   • InTouch documentation
   • Alarm DB Logger
   • OI Gateway (as a silent installation)
   • Application Server Bootstrap
   • InTouch Supplemental Components: InTouch Recipe Manager, InTouch SQL Access, and Symbol Factory

     Note: The 16 PenTrend supplementary component is not installed by default. You must select the Customize Installation option and select InTouch 16 PenTrend from the product list to install it as part of the InTouch HMI installation procedure.

   • AVEVA Enterprise Licensing Platform
   • InTouch Web Client
   • AVEVA System Monitor - Sentinel Agent
   • ASB Runtime Components
   1. If you choose InTouch Development and Run Time, the following will be installed:
   • All items listed under step a in these instructions.
   • InTouch Development
   • ASB Service Repository
   • InTouch demo applications
4. When the installation prompts you to verify your selection, select Customize Installation if you want to add or remove components of your InTouch installation.
5. After you verify and customize your selection, you are prompted to select the language you want to install. English is selected by default, but you can choose another supported language from the list.
6. Follow the subsequent installation steps to:
   1. Accept the End User License Agreement.
   2. Create a new ArchestrA user account, or specify an existing account.
   3. Install any prerequisite software components not yet installed on the computer.
   4. The installation proceeds to completion. You must restart the computer after completing the installation.

Activating Your InTouch License

InTouch uses the AVEVA Enterprise License Server to make licenses available. The AVEVA Enterprise License Manager manages one or more License Servers.

You use the AVEVA Enterprise License Manager interface to make licenses available to InTouch. First, import the entitlement XML file received upon purchase of the license. Then, select which licenses on the entitlement to activate on the License Server. After activation, the license becomes available to WindowMaker or WindowViewer upon start up. The license is released when InTouch is shut down.

InTouch will run in Demo Mode if it cannot consume a valid license at start up time.

To install AVEVA Enterprise licensing, see the AVEVA Enterprise Licensing Guide.

Antivirus Software Exclusions

Antivirus software should be implemented as part of a defense-in-depth strategy to secure your industrial control systems.

Visit https://softwaresupport.aveva.com/ to get the latest information on antivirus software recommendations.

Modifying, Repairing, or Removing the InTouch HMI

To modify, repair, or remove a product

1. Open the Modify, Repair or Remove Installation dialog box by doing either of the following:
   • Run Setup.exe from the installation media.
   • Access the Windows Control Panel and select the Programs and Features option. The list of software installed on your computer appears. Select the InTouch component
2. Click the Uninstall/Change button. The Modify, Repair or Remove Installation dialog box appears.
3. Follow the prompts to modify, repair, or remove InTouch. The name of the Uninstall/Change button varies depending on the version of Windows installed on your computer.

Note: Modern applications can no longer be created, edited, or run after Application Server is uninstalled from the same computer that also hosts InTouch run time and development components. Modern applications no longer work because the Galaxy Repository required for Modern applications is removed when Application Server is uninstalled.

Upgrading to the Latest Version from an Earlier Version of InTouch HMI

Upgrading refers to installation on a computer that already has a previous version. An upgrade removes the previous version of InTouch HMI and installs the latest version.

After the hardware and software requirements are met, you can upgrade directly to InTouch HMI 2023 R2 from InTouch HMI Version 11.1 SP1 or later, provided the prior version was installed on a 64-bit operating system.

You can only upgrade System Platform products that are already installed. You cannot install any new System Platform products by an upgrade process.

To upgrade from a previous version of the InTouch HMI

1. In the installation media, run setup.exe to start the set-up program. The upgrade feature dialog box appears.
2. Follow the prompts to complete the upgrade.

Upgrade Notes

• Important Note: If you plan to upgrade System Platform on a computer that has InTouch Access Anywhere Server installed, you must first uninstall the InTouch Access Anywhere Server. Then, upgrade System Platform and finally reinstall InTouch Access Anywhere Server.
  Back up any custom configuration of the installed instance of InTouch Access Anywhere before you uninstall it.
• InTouch Development (WindowMaker) is now installed with support for Industrial Graphics. This includes the Integrated Development Environment (IDE), Bootstrap, Galaxy Repository (GR), and FS Gateway.
• If Application Server is installed on the same node as InTouch HMI, both must be upgraded to System Platform Version 20.0.000. You must upgrade Application Server before upgrading InTouch HMI.
• If you are using managed InTouch applications with Industrial Graphics from Application Server 3.1 SP3 or earlier, run the Industrial Graphics Analysis and Repair Utility before installing Application Server to ensure that all issues reported by the utility are addressed.

Migrating Applications to InTouch HMI 2023 R2

Migration converts applications created with earlier versions of InTouch HMI to the current version. You can migrate applications to InTouch HMI 2023 R2 that were developed with InTouch HMI version 7.11 P07 or later.

Note: For InTouch Version 10.2 and newer, refer to the System Platform migration table. InTouch cannot be installed or upgraded as a single product since Version 10.2. Therefore all installed products on a node must be upgraded at the same time.

SPCPro was a Statistical Process Control (SPC) utility available with InTouch HMI prior to Version 11.0. SPCPro is no longer supported by InTouch HMI. We recommend that that you migrate your SPCPro databases to the latest version of QI Analyst if you still use SPCPro with InTouch. QI Analyst provides support for the latest versions of operating systems and databases.

QI Analyst also includes a utility to migrate your SPCPro database to a QI Analyst database, leaving the existing SPCPro database intact. Please contact your local sales representative for further information.

Important Note: We strongly recommend that you migrate your current SPCPro databases to QI Analyst before installing System Platform Version 20.0.000 with InTouch HMI. InTouch no longer includes SPCPro and will not open or migrate applications containing SPCPro components.

Resolved Issues

InTouch HMI 2023 R2 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.

Resolved Issues for Web Client

InTouch HMI 2023 R2 also includes issues resolved in InTouch HMI 2023 P01, InTouch HMI 2023 P02, and InTouch HMI 2023 P03. To see the list of resolved issues see the respective readme files available on the AVEVA Global Customer Support (GCS) website. The InTouch HMI 2023 P03 readme includes the readmes for InTouch HMI 2023 P01 and InTouch HMI 2023 P02.

Known Issues

This section describes known issues that remain in the release of InTouch HMI 2023 R2.

InTouch HMI Documentation

The InTouch library is offered in two different media:

• Portable Document File (PDF), which can be viewed with Adobe® Reader®. Each user guide is included on the InTouch installation media as a PDF file.
  The InTouch product library consists of a set of Portable Document Files (PDF) available in the following location of the System Platform installation media:

  \AVEVA System Platform\InstallFiles\CD-Intouch\UserDocs\English

  You need Adobe Reader installed on your computer to view InTouch documentation. You can download the latest version of Adobe Reader from the Adobe Corporation web site:

  http://www.adobe.com/products/acrobat/readstep2.html

  After installing Adobe Reader, double-click a PDF file with your pointing device to view the book with Adobe Reader. You can also open a book with the Adobe Reader Open command from the File menu. Context-sensitive documentation is also available with InTouch online help. Select Help for information about the current InTouch window that you have open on your computer.

• Online help, which can be accessed on your browser using the AVEVA Products Help Viewer. The Online Help can also be viewed while an InTouch HMI application is running. The help is context-sensitive and is also linked to all online InTouch information.

  To launch the Help Viewer, on the Windows Start menu, click AVEVA, and then click AVEVA Help.

  The AVEVA Help Viewer launches in your default browser.