Migrate an Existing Configuration from an Earlier Version

When you install a new version of Plant SCADA Access Anywhere, the existing Secure Gateway configuration file is no longer available. If you want to migrate your existing settings to the new version, you need to manually merge some information into the newly installed configuration files.

To migrate an existing Secure Gateway configuration:

1. Make a backup of the configuration files.

   For the Secure Gateway, this will include the following files:

   • \Program Files (x86)\AVEVA Plant SCADA Access Anywhere\Plant SCADA Access Anywhere Authentication Server\EricomAuthenticationServer.exe.config

   • \Program Files (x86)\AVEVA Plant SCADA Access Anywhere\Plant SCADA Access Anywhere Authentication Server\EricomAuthenticationServer_Tenants.xml

   • \Program Files (x86)\AVEVA Plant SCADA Access Anywhere\Plant SCADA Access Anywhere Secure Gateway\WebServer\PlantAccessAnywhere\config.js

   • \Program Files (x86)\AVEVA Plant SCADA Access Anywhere\Plant SCADA Access Anywhere Secure Gateway\EricomSecureGateway.exe.config

     If you also want to migrate an existing Plant SCADA Access Anywhere Server, you should also back up the following files before performing an upgrade:

   • \Program Files (x86)\AVEVA Plant SCADA Access Anywhere\Launcher\SE.Scada.AnywhereLauncher.exe.config

   • \Program Files (x86)\AVEVA Plant SCADA Access Anywhere\Server\WebServer\PlantAccessAnywhere\config.js

     Note: If you have used a custom certificate for the Plant SCADA Access Anywhere Server, you will need to export a backup of the server configuration settings as a registry file as certificate information is not included in the configuration files listed above. You can view the current SSL certificate details on the Security tab of the Access Anywhere Server Configuration console. You can also export the configuration settings as a registry file (.reg) using the console's Advanced tab.

     The process for migrating the Plant SCADA Access Anywhere Server is explained in the Plant SCADA Access Anywhere Installation and Configuration Guide.

2. Install the new version of the software, then return to step 3.

3. Manually merge the settings from the files listed below into the new version of each file.

4. Restart the affected services.

   Note: With the release of Plant SCADA Access Anywhere 2020 R2, the default installation location changed to '\Program Files (x86)\AVEVA Plant SCADA Access Anywhere'.

• EricomAuthenticationServer.exe.config

  Merge the following sections into the new configuration file, if applicable.

  • <appSettings /> - except the key 'CertificateThumbrpint' if a self-signed certificate is used.

  • <logSettings />

  • <translatorSettings />

• EricomAuthenticationServer_Tenants.xml

  Merge every section across to the new xml file, if applicable.

• PlantAccessAnywhere\config.js

  Merge every section across to the new xml file, if applicable.

• EricomSecureGateway.exe.config

  For the EricomSecureGateway.exe.config file, the file format has been changed. The relevant sections have been moved to a file called EricomSecureGateway.config (without the '.exe' extension).

  To migrate applicable settings, merge the following sections to the new EricomSecureGateway.config file based on the mappings in the table below. For example, if you had specified a Session Inactivity Timeout of 15 minutes in the Secure Gateway Administration settings, it will appear in the version 1.1 "EricomSecureGateway.exe.config" file as follows:

  <configuration>
  …
  <sessionsSettings>
  <Admin>
  <add key="InactivityTimeoutMinutes" value="15" />
  …
  </Admin>
  …
  </configuration>

  To migrate the setting, copy the value of the "InactivityTimeoutMinutes" key to the following section in the new "EricomSecureGateway.Config" file:

  <PropertySet name="ESG Configuration Parameters" version="1.0">
  <Section name="">
  …
  <Section name="Admin">
  <Property name="InactivityTimeoutMinutes" type="int" value="15" />
  …
  </Section>
  …
  </Section>
  </PropertySet>

  V 1.1 EricomSecureGateway.exe.config	V2.0 EricomSecureGateway.config
  configuration.externalServersSettings. AuthenticationServer	PropertySet["ESG Configuration Parameters"].Section[""].Section["AuthenticationServer"]
  configuration.externalServersSettings. WebConnectServer	PropertySet["ESG Configuration Parameters"].Section[""].Section["WebConnectServer"]
  configuration.externalServersSettings. VMwareViewServer	PropertySet["ESG Configuration Parameters"].Section[""].Section["VMwareViewServer"]
  configuration.sessionsSettings.Visitor	PropertySet["ESG Configuration Parameters"].Section[""].Section["Visitor"]
  configuration.sessionsSettings.WebServer	PropertySet["ESG Configuration Parameters"].Section[""].Section["Sessions"].Section["InternalWebServer"]
  configuration.sessionsSettings.Admin	PropertySet["ESG Configuration Parameters"].Section[""].Section["Admin"]
  configuration.sessionsSettings.Gateway	PropertySet["ESG Configuration Parameters"].Section[""].Section["Sessions"].Section["Gateway"]
  configuration.internalWebServerSettings. General	PropertySet["ESG Configuration Parameters"].Section[""].Section["InternalWebServer"]
  configuration.internalWebServerSettings. Folders	PropertySet["ESG Configuration Parameters"].Section[""].Section["InternalWebServer"].Property["FolderList"]
  configuration.mailAlertsSettings. SmtpServer	PropertySet["ESG Configuration Parameters"].Section[""].Section["MailAlert"].Section["SmtpServer"]
  configuration.mailAlertsSettings.Mail	PropertySet["ESG Configuration Parameters"].Section[""].Section["MailAlert"].Section["Mail"]
  configuration.mailAlertsSettings.Alerts	PropertySet["ESG Configuration Parameters"].Section[""].Section["MailAlert"].Section["Alerts"]
  configuration.logSettings.Roles	PropertySet["ESG Configuration Parameters"].Section[""].Section["Log"].Section["Level"].Section["Role"]
  configuration.logSettings.HttpDataWatch	PropertySet["ESG Configuration Parameters"].Section[""].Section["Log"].Section["Level"].Section["HttpDataWatch"]
  configuration.logSettings.SessionRecording	PropertySet["ESG Configuration Parameters"].Section[""].Section["SessionRecording"]
  configuration.advancedSettings	PropertySet["ESG Configuration Parameters"].Section[""].Section["Advanced"]
  configuration.appSettings	PropertySet["ESG Configuration Parameters"].Section[""].Section["Network"]