AVEVA™ System Platform 2017 Update 3 SP 1 Patch 01 Installation Guide

Last revision: 6/12/2020

This document provides important information about applying Patch 01 to AVEVA™ System Platform 2017 Update 3 SP 1, using either the Patch Manager utility or Silent Installation.

Read This Before Installing Patch 01

This section contains essential information about applying Patch 01. It is important to understand the patch process and how to prepare your system for patch installation before running the Patch Manager utility or installing silently.

Also in This Section

Patch Information

Important

• Before Patching Application Server or InTouch
• Before Patching the Historian
• Before You Launch the Patch Installer

Patch Information

Apply this patch to System Platform 2017 Update 3 SP 1 to update the installed component products. The following table shows products included in the patch and version numbers. Two version numbers for each product are shown. The first version shown (pre-patch) is the product version included in System Platform 2017 Update 3 SP1. The second version (post-patch) is the version number that will be installed with this patch.

* Upgrade from PCS 4.3.3 (v4.3.19141.2) and 4.3.4 (v4.3.20048.1) is supported. PCS 4.3.5 (v4.3.20141.1) is installed with this patch.

You can verify product version numbers in the Windows Control Panel, under Programs and Features. Once you install the patch, the version numbers of the patched products are updated by incrementing the last digit of the version number from "0" to "1" (for example, to 17.3.101, or to 6.1.001). "P01" is appended to the program name. The Platform Common Services version, listed under Program Name, increments from 4.3.3 to 4.3.4.

This patch can only be applied to System Platform 2017 Update 3 SP1.

Important

You Must Have Reboot Privileges: In a server operating system, inadequate privileges can prevent a user from rebooting the computer. After patch installation, the patch installer might be unable to force the required computer reboot. In this case, you will need to manually reboot the computer to properly complete the software patch process.

Allow Adequate Time: Improvements in the libraries provided with the Galaxies will increase the time required to run the Galaxy Patcher when compared to past installations. The time to patch an individual Galaxy can vary from a few minutes to an hour or more, based on the complexity of the Galaxy. The Galaxy Patcher will only run on the deployed Galaxy. For an undeployed Galaxy, the Galaxy Patcher will launch automatically and patch the Galaxy the first time you connect to it in the IDE.

Multiple Galaxies: In most previous patch releases, all installed Galaxies were patched immediately after the Patch Manager finished patching the node. For this patch release, only the deployed Galaxy is patched immediately after the patch installation process finishes. Undeployed Galaxies are patched the first time you connect them to the IDE.

InTouch: InTouch Modern Applications will be patched the first time you connect to them. Patching will require approximately ten minutes per Modern Application. Times may vary, based on the number of symbol templates in your galaxy.

Before Patching Application Server or InTouch

• Ensure you have created known good backups of all installed Galaxies. To create a backup of your Galaxy, access the Galaxy Database Manager in the System Platform Management (SMC) console. Expand the Galaxy Database Manager and select the Galaxy. On the Action menu, click Backup. Follow the prompts to complete the backup operation for each Galaxy.
• Undeploy the platform or stop the platform from Platform Manager from the SMC. Exit all applications including the System Platform IDE, SMC, InTouch OMI ViewApps, InTouch HMI WindowMaker, and InTouch HMI WindowViewer, if installed and running.
• Make sure that any active remote IDE sessions are disconnected from the GR node. Patch 01 requires that you shut down System Platform-related processes. A reboot may be required. For systems where the IDE is on one node and connects to a remote node with the Galaxy Repository: both the IDE and GR nodes must be at the same version. Ensure the versions are the same by patching both nodes.

  Note: As a general workflow, patch the GR node first, then patch run-time nodes.

• Close any anti-virus programs running on the computer before applying this patch to Application Server.
• If you use a custom branding image file, back it up so you can restore it later. The IDE watermark image file is overwritten during the installation of AVEVA System Platform 2017 Update 3 SP 1 Patch 01. The image file, typically a .png file such as "IDEWatermark.png," is located under:
  64-bit OS: C:\Program Files (x86)\Common Files\ArchestrA\ApplicationServer\4.1.06000\Branding
  32-bit OS: C:\Program Files\Common Files\ArchestrA\ApplicationServer\4.1.06000\Branding

Before Patching the Historian

Before installing the patch, shut down the Historian and back up the Runtime DB. To shut down the Historian:

1. Open the SMC and select Historian.
2. Select the Historian node name.
3. Select Management Console, then right-click to open the context menu.
4. Select All Tasks from the context menu, then select Shutdown (and disable) Historian.
5. Enter your credentials to shut down the Historian.

Before You Launch the Patch Installer

Prior to running the patch installer, undeploy the platform from the IDE, and check that any active remote IDE sessions are disconnected from the GR. Alternatively, you can shutdown the platform from the System Platform Management Console (see below). After undeploying the platform, exit all running System Platform applications including the System Platform IDE. Make sure the following System Platform and Microsoft applications are closed:

Note: If any processes or services are blocking patch installation, the patch install utility will prompt you to close them.

• InTouch WindowViewer
• InTouch WindowMaker
• ArchestrA IDE (System Platform IDE)
• Alarm Printer
• Any applications hosting Alarm Manager (Platform/WindowViewer)
• Alarm DB Purge/Archive utility
• Alarm DB Restore utility
• Alarm Hot Backup Manager utility
• Alarm DB Logger Manager utility (stop and close)
• Historical Data Manager utility
• Recipe Manager utility
• InTouch Application Manager
• All instances of InTouch OMI ViewApps
• AVEVA Application Manager/Wonderware Application Manager
• Configurator utility
• Microsoft Excel
• Microsoft Word
• LogFlagEditor utility

Use the System Platform Management Console (SMC) to shut down and/or stop the Historian, OI Servers, DA Servers (as applicable to your system):

• To shut down the Platform: SMC > Platform > Manager > Platform > Shutdown
• To shut down and disable the Historian: SMC > Historian > Management Console > All Tasks > Shutdown (and Disable)
• To stop the OI Gateway: SMC > Operation Integration Server Manager > Deactivate OI Gateway
• To stop the ABCIP OI Server: SMC > Operation Integration Server Manager > Deactivate ABCIP OI Server
• To stop the ABTCP OI Server: SMC > Operation Integration Server Manager > Deactivate ABTCP OI Server
• To stop the SIDIRECT OI Server: SMC > Operation Integration Server Manager > Deactivate SIDIRECT OI Server
• To stop the GESRTP OI Server: SMC > Operation Integration Server Manager > Deactivate GESRTP OI Server
• To stop the MBTCP OI Server: SMC > Operation Integration Server Manager > Deactivate MBTCP OI Server
• To stop the ITME OI Server: SMC > Operation Integration Server Manager > Deactivate ITME OI Server
• To stop the KOYO OI Server: SMC > Operation Integration Server Manager > Deactivate KOYO OI Server
• To stop the SOMAC OI Server: SMC > Operation Integration Server Manager > Deactivate SOMAC OI Server
• To stop the MELSEC OI Server: SMC > Operation Integration Server Manager > Deactivate MELSEC OI Server
• To stop the OMRONFINS OI Server: SMC > Operation Integration Server Manager > Deactivate OMRONFINS OI Server
• To stop the TI500 OI Server: SMC > Operation Integration Server Manager > Deactivate TI500 OI Server
• To stop the SNMP OI Server: SMC > Operation Integration Server Manager > Deactivate SNMP OI Server
• To stop the BACLITE OI Server: SMC > Operation Integration Server Manager > Deactivate BACLITE OI Server
• To stop the CODESYS OI Server: SMC > Operation Integration Server Manager > Deactivate CODESYS OI Server
• To stop the ADPRO OI Server: SMC > Operation Integration Server Manager > Deactivate ADPRO OI Server
• To stop the TWINCAT OI Server: SMC > Operation Integration Server Manager > Deactivate TWINCAT OI Server
• To stop the OPTOMMP OI Server: SMC > Operation Integration Server Manager > Deactivate OPTOMMP OI Server
• To stop the ABCIP DA Server: SMC > Operation Integration Server Manager > Deactivate ABCIP DAServer
• To stop the ABTCP DA Server: SMC > Operation Integration Server Manager > Deactivate ABTCP DAServer
• To stop the SIDIRECT DA Server: SMC-> Operation Integration Server Manager > Deactivate SIDIRECT DAServer
• To stop the Siemens DA Server: SMC > Operation Integration Server Manager > Deactivate Siemens DAServer
• To stop the ITME DA Server: SMC > Operation Integration Server Manager > Deactivate ITME DAServer
• To stop the GESRTP DA Server: SMC > Operation Integration Server Manager > Deactivate GESRTP DAServer
• To stop the MBTCP DA Server: SMC > Operation Integration Server Manager > Deactivate MBTCP DAServer
• To stop the MBSerial DA Server: SMC > Operation Integration Server Manager > Deactivate MBSerial DAServer
• To stop the FS Gateway: SMC > Operation Integration Server Manager > Deactivate FS Gateway
• To stop the DASSim DA Server: SMC > Operation Integration Server Manager > Deactivate DASSim DAServer
• To stop the SIM OI Server: SMC > Operation Integration Server Manager > Deactivate SIM OI Server

Close the SMC after you have shut down the all the above processes.

Use the Windows Control Panel > Administrative Tools > Services to Stop any of the following services that are running:

• ArchestrA Bootstrap

  Note: Disable the Bootstrap service first, then Stop it.

• ArchestrA Watchdog Service
• ArchestrA GlobalDataCacheMonitorServer
• Wonderware Historian Client Access Point

  Note: Disable the Historian Client Access Point service first, then Stop it.

• ArchestrA UserValidator
• Wonderware Historian Insight
• InTouch Web
• InTouch IData Service
• ArchestrA AutoBuild Service
• Sentinel Install Manager Service
• Sentinel Agent Service

Close the Control Panel and Services window after you have stopped all the above services.

Installing the Patch

Also in This Section

Modifying an Installation: PCS Errors

Download and Run the Patch

1. Download SP2017U3SP1_Patch01.exe to a folder on the computer where AVEVA System Platform 2017 Update 3 SP1 is installed.
2. Double-click SP2017U3SP1_Patch01.exe to extract the patch files. The End User License Agreement (EULA) appears.

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

3. Accept the License Agreement. The Patch Manager window appears.
   1. The Patch Manager displays a list of available patches, the associated product names, and patch status for each product. By default, all installed products are selected for patching. We recommend that you install all patches.
   2. Click a product name to view the Readme file for that product. The System Platform Readme appears at the top of the list of installable items and associated Readme files.
   3. Click the Install button. The patch Progress Window appears.

      Note: If any blocking programs or services are still running, a list of the still-running items appears and the Next button will be deactivated. Follow the instructions for closing the items, as listed above and on-screen. Once you close and/or stop the blocking items, select the Try Again button. When all the blocking items are closed/stopped, select the Next button to proceed.

4. A Status Window displays a list of installed patches.
   1. Click the link provided to view the log file.
   2. Click the Finish button.
5. The Galaxy Patcher patches the deployed Galaxy.

   Note: Galaxy patching may take several minutes. Do not shut down the node while this operation is in progress. Undeployed Galaxies remain unpatched until you connect to the Galaxy from the IDE.

6. When installation completes, the Configurator opens. Some items, such as the Historian and/or Sentinel, may require reconfiguration.
7. When configuration is complete, follow the prompts to reboot the machine.

Modifying an Installation: PCS Errors

This section describes a workaround/fix that can be applied if you see the following error message during a Modify installation of System Platform 2017 Update 3 SP1, after installing System Platform 2017 Update 3 SP1 P01.

Error: A newer version of Platform Common Services 4.3.3 is already installed.

Workaround

1. Open the Control Panel, go to Programs and Features, then select Platform Common Services 4.3.5.
2. Select the Change option.
3. Select the ASB Service Repository feature. Use the “Entire feature will be installed on the local hard drive” option from the dropdown.
4. Complete the "Modify" installation of the PCS Framework

Once you complete the workaround steps, you can add the new System Platform component/feature without encountering an error. Run setup.exe from the System Platform 2017 Update 3 SP1 installation media to perform the "Modify" installation.

Installing the Patch Silently

While you'll use the Patch Manager installation steps to do most installations, you can use a "silent" installation if you are applying the patch to several computers at once.

The workflow to install the patch silently is:

1. Generate a response file.
2. Run silent install from the command line.

   Note: Silent-mode installation of the Configurator is not supported in this patch. After installing the patch, the Configurator launches automatically, but you must perform the required configuration manually.

Generating the Response File for Silent Installation

1. Run cmd.exe as an Administrator.
2. Change the working directory to the folder that contains SP2017U3SP1_Patch01.exe.
3. Run this command line: SP2017U3SP1_Patch01.exe /list /filename:c:\PatchCreation\response.txt.
4. The response.txt file will appear in the c:\PatchCreation folder.
5. Using a text editor, modify the response.txt file to keep only the patches you want to install.

Running Silent Install from the Command Line

1. Run cmd.exe as an Administrator.
2. Change the working directory to the folder where you downloaded SP2017U3SP1_Patch01.exe.
3. Run the appropriate command line:
   1. To automatically restart the node when silent installation completes, run the following command line:
      SP2017U3SP1_Patch01.exe /Silent "c:\PatchCreation\response.txt".
   2. If you do not want to automatically restart your computer after silent installation completes, use the /Silentnoreboot option. However, changes do not take effect until the node is restarted:
      SP2017U3SP1_Patch01.exe /Silentnoreboot "c:\PatchCreation\response.txt"

   Note: Only the deployed Galaxy is patched. Undeployed Galaxies remain unpatched until they are deployed.

Applying the Patch to Application Server 2017 Update 3 SP 1 Redundant Platforms

You can reduce plant down time by patching the two partner nodes in an Application Server redundant pair, one at a time.

Platforms hosting redundant pairs may be deployed even when a partner platform is not patched and the Galaxy Repository (GR) platform is either patched or in the Software Upgrade Pending (SUP) state.

When applying the patch to a redundant pair, we recommend patching the standby partner first. This way, only one failover of the redundant engines is needed, thus minimizing the period of time in which process data is not collected. After patching the first node, patch the second as soon as possible. When only one node is patched, backup and failover are not available. Both nodes must be patched to enable redundancy.

The procedure for patching redundant pairs is similar to the procedure for upgrading redundant pairs (see the Wonderware System Platform Installation Guide for the upgrade procedure). However, there are some differences between patching and upgrading. Follow the actions listed in the table below to patch a GR node and redundant pair. Using this procedure will reduce down time. These instructions assume an initial state where the primary engine (E1) is active. At the conclusion of this procedure, all three nodes are patched and the backup engine (E1b) is active.

The following table illustrates the workflow for patching a Galaxy Repository and one redundant pair, consisting of different nodes, from unpatched (v1) to patched (v2). Action items are shaded. In this example, Node B and Node C comprise the redundant pair, and a redundant Application Engine is hosted by the platform on each node. Use the Platform Manager to determine which platform (P1 or P2) is hosting the active Application Engine. See the Platform Manager User's Guide for additional information.