How to obtain log information for SCADAConnect


  Applies To     
  Product(s): WaterGEMS  
  Version(s): 08.11.XX.XX and higher  
  Original Author: Akshaya Niraula, Bentley Technical Support Group  

 

Problem

How can I enable SCADAConnect logging to obtain SCADA log information?

Solution - 08.11.06.58 and higher

In version 08.11.06.58 and higher (including CONNECT Edition, 2023, 2024, etc) the SCADAConnect log file is available from the Configure Ribbon:

Note: starting with Patch01 of version 10.02.01.06, the log file is located here: C:\Users\<User Name>\AppData\Local\Bentley\SCADAConnect\10*\SCADAConnect.log

*Product version (10, 24, 26...)

Verbose Logging

In version 10.03.XX.XX and higher, you can enable more verbose (detailed) logging by adding the following highlighted option to your watergems.exe.config file via text editor. This file is located in the root of the OpenFlows Water installation folder (for version 24.00.01.05 and higher) or in the "x64" subfolder of your WaterGEMS installation folder, for older versions.

Depending on your version, you may already have a section for "appSettings" in the watergems.exe.config file. In the text editor, check if you already have section that looks like the following highlighted in yellow below. If so, you will need to add the syntax highlighted in green.

<startup useLegacyV2RuntimeActivationPolicy="true">
    <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.8" />
  </startup>
  <appSettings>
    <add key="Ribbon_Theme" value="light" />
    <add key="Ribbon_ExternalTools_AddIn" value="false" />
    <add key="SCADA_EnableVerboseLogging" value="true"/>
  </appSettings>
  <runtime>

If there is not already a section for "appSettings" in the config file, you will need to add the syntax highlighted in yellow below.

<?xml version="1.0" encoding="utf-8"?>
<configuration>
<startup useLegacyV2RuntimeActivationPolicy="true">
 <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.6.1"/>
</startup>
<runtime>
 <assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
  <probing privatePath="SharedAssemblies" />
  <dependentAssembly>
   <assemblyIdentity name="Bentley.License.Library.NET" publicKeyToken="4bf6c96a266e58d4" />
   <bindingRedirect oldVersion="1.0.0.0" newVersion="9.0.0.39" />
  </dependentAssembly>
 </assemblyBinding>
</runtime>
<appSettings>
 <add key="SCADA_EnableVerboseLogging" value="true"/>
</appSettings>
</configuration>

Note: If you make the changes above and WaterGEMS will not open (you will see the splash screen and then nothing will open), make sure that you do not have see two "appSettings" sections in the config file. You cannot have two sections for "appSettings," which is the cause of the issue.

Solution - V8i SS5 (08.11.05.61)

In V8i SELECTseries 5, the SCADAConnect log file is available from the main toolbar:



Solution - V8i SS4 (08.11.04.58) and below

In V8i SELECTseries 4, to obtain a log please first make sure that saving log option is toggled. From the Tools menu of SCADAConnect, go to Options and Advanced tab. Please make sure "Enable Advanced Logging" is checked.

Generally the default location where the log file is saved, is at the following location:

Windows XP: C:\Documents and Settings\<User>\local Settings\Application Data\Bentley\WaterGEMS\8\SCADAConnect.log

Vista or higher: C:\Users\<User>\AppData\Local\Bentley\WaterGEMS\8\SCADAConnect.log

 

See Also

Using SCADAConnect Simulator (V8i SS6 and CONNECT Edition)

Using SCADAConnect Simulator (older versions)

SCADAConnect - SewerGEMS