ClearSCADA 2010 R3.1 Upgrade Notes

[sbeadle1]

📖 Home  Back  
Please read the information below prior to upgrading to ClearSCADA 2010 R3.1 for important information on changes in this version.

Upgrading from ClearSCADA 2010 R3

Please refer to the File: Schema Comparison Output (See links below) for details about new changes to tables and fields in ClearSCADA 2010 R3.1. The table lists out the differences between ClearSCADA 2010 R3.1 and ClearSCADA 2010 R3.

Upgrading from ClearSCADA 2010 R2.x

Please refer to the File: Schema Comparison Output (See links below) for details about new changes to tables and fields in ClearSCADA 2010 R3. The table lists out the differences between ClearSCADA 2010 R3 and the latest build of the previous version (ClearSCADA 2010 R2.1).

• ClearSCADA 2010 R3.1 uses the SAP Crystal Reports runtime for .NET Framework 4:

• On 64-bit servers the 64 bit runtime must be installed (this is required by the Crystal Reports driver).

• On all computers the 32-bit runtime must be installed if using ViewX to display or edit reports.

• The Crystal Reports XI R2 and Crystal Reports 2008 runtimes are no longer required by ClearSCADA and can therefore be uninstalled following an upgrade to ClearSCADA 2010 R3.1, unless they are needed for other applications.

• When upgrading a 64 bit server to ClearSCADA 2010 R3.1 a new 64 bit ODBC DSN needs to be created to replace the existing 32 bit DSN as the ClearSCADA driver now uses the native 64 bit Crystal Reports runtime engine.

On 64 bit Windows 2008 Server and Windows Vista machines, the Setup button to configure a Data Source in the Server Configuration tool will be greyed out. On these platforms, the ODBC Data Source Administrator must be run from the Windows Control Panel.

• When exporting Crystal Reports to HTML a sub-folder called "Reports ####" is no longer appended to the end of the path.

• Users in the ClearSCADA database can now have more than 4 user groups and Areas of Interest (AOI) configured on each user profile. This change means that older clients connected to a ClearSCADA 2010 R3.1 server will not be able to configure a user's user groups or AOI since array database fields are not supported on properties forms on the older clients.

• All DDK drivers will need to be recompiled with the AssemblySupportLink assembly information added. This setting must exist and contain a valid link to a website where users of the system can get support (via the new Support option for each driver in the ServerStatus -> General -> Modules). Failure to have this new entry will cause a 'Bad Version Information' error to be shown for that driver when upgrades, however the DDK will compile successfully. AssemblyHelpLink and AssemblyUpdateInformation have also been added but are optional.

• AssemblyVersion and AssemblyCompany are also required fields and are also displayed on the new Modules dialogue.

• VB example: < assemblysupportlink="">

• To support a new historic import feature that allows importing data outside of the historic writable range, the historic synchronisation process now compares all historic data when calculating what to synchronise, where before it could optionally only check historic in the writable range. If for some reason the historic in the archive range differed between the main and standby, the first synchronisation after upgrade may take longer as the server brings the historic in the archive range up to date. Subsequent synchronisations will not be affected.

Upgrading from ClearSCADA 2010 R1.x

Please be aware of all the issues covered in the section "Upgrading from ClearSCADA 2010 R2.x" in addition to the following.

• As a part of the re-branding of ClearSCADA under Schneider Electric, the ODBC Driver for ClearSCADA has been renamed from Control Microsystems ClearSCADA Driver to ClearSCADA Driver.

As a result of this, users upgrading from versions older than ClearSCADA 2010 R2, will see two options available for the driver selection when configuring the ODBC DSN. The old driver name has been left in to ensure backwards compatibility.

• In ClearSCADA 2010 R3.1, the Core database module has been split into the Core and Kernel modules. This means that after upgrading from an older version, some Crystal Report objects may not work properly if relying on database tables that have moved since the split. These reports will have to be manually edited and then re-saved to access the correct table and module.

• The CPagerService table has been moved from DBObjCore to DBObjPager during the split of the Core database module into the Telemetry and Kernel modules. Because of this, when upgrading redundant servers from ClearSCADA 2010 R1/R1.x with no Pager driver installed, the main-standby synchronisation will fail. This is because the CPagerService will exist on the Main but not on the Standby.

To work around this

• either ensure that the Pager driver is installed on the Main and the standby before upgrading the machines.

• or shut down the Main and the Standby machines, upgrade them to ClearSCADA 2010 R3.1 and then let them synchronise.

• In ClearSCADA 2010 R3.1, the ViewX log file has been renamed to include the Session number for the connection. This was added to differentiate between log files of clients running on separate sessions. Before, the ViewX log file was common for clients running on separate sessions and this caused the log file to become interleaved. The new log file will contain the session number and will be in the format 'ViewX_SessionN_HeadN_NNN.log'.

• When upgrading a redundant configuration to ClearSCADA 2010 R3.1, please note that running a server with higher version or build number as Main is not supported. If configured this way, the server icon on the Standby machines will turn pink with the status saying 'Invalid Standby Configuration'. Clicking on the server icon will display the following dialog:

Invalid Partner.jpg

Due to limitations on the errors that can be returned to the Standby, the dialog will not display a list of the missing classes. This dialog has been added to prevent the problems that could occur as a result of running the system with this unsupported configuration.

• When upgrading from older versions to ClearSCADA 2010 R3.1, the Guest user settings will not be preserved due to the changes made to the file locations for rebranding under Schneider Electric. These settings will have to be re-configured after the upgrade.

You will need to make the following changes after the upgrade

• Copy the 'ViewX Global Settings.dat' and the files for the ViewX heads like 'ViewX Head 1 Settings.dat' located in

• For Windows Server 2003 and Windows XP - C:\Documents and Settings\\Local Settings\Application Data\Control Microsystems\ClearSCADA to C:\Documents and Settings\\Local Settings\Application Data\Schneider Electric\ClearSCADA

• For Windows 7 and Windows Server 2008 - C:\Users\\AppData\Local\Control Microsystems\ClearSCADA to C:\Users\\AppData\Local\Schneider Electric\ClearSCADA

• You will also need to copy the settings in the Registry key

HKEY_CURRENT_USER\Software\Serck Controls\SCX6
to
HKEY_CURRENT_USER\Software\Schneider Electric\ClearSCADA

• The 'Template Transactions' flag has been removed from the Server Configuration Tool. This has been replaced by the generic Configuration Transactions feature which executes all configuration transactions, such as Import, template transactions etc., incrementally at the server.

Upgrading from ClearSCADA 2009 R2.x

Please be aware of all the issues covered in the sections "Upgrading from ClearSCADA 2010 R1.x" and "Upgrading from ClearSCADA 2010 R2.x" in addition to the following.

• ClearSCADA 2010 R3.1 includes support for Crystal Reports 2008. When upgrading an existing Crystal Report installation to Crystal Reports 2008, please note the following:

• Grouped Boolean parameters are not supported in Crystal Reports 2008 and will be displayed in the parameters dialog as a number of normal Boolean checkboxes. A way to work around this issue is to use a numeric parameter with a discrete list of values which will be presented in the dialog as a combo box, and using conditional statements to reference the parameter in queries.

• The following export formats are no longer supported:

• Record Format

• ODBC export

• "Lotus Domino" is no longer supported as an export destination.

• ClearSCADA 2010 R3.1 utilises the Crystal Reports XI Release 2 Service Pack 6 runtime. To maximise compatibility we recommend upgrading all associated Crystal Reports installations to Crystal Reports XI Release 2 Service Pack 6.

• Following upgrade to ClearSCADA 2010 R3.1, all existing ODBC DSNs will lose their passwords. This potentially impacts report generation using Crystal Reports and external applications that use the ODBC driver. Hence, after upgrade, use the ODBC Data Source Administrator to reinstate ODBC DSN passwords. This applies to upgrade from all versions with the exception of ClearSCADA 2009 R2.2, ClearSCADA 2009 R1.3 and ClearSCADA 2007 R1.4.

Upgrading from ClearSCADA 2009 R1.x

Please be aware of all the issues covered in the sections "Upgrading from ClearSCADA 2009 R2.x", "Upgrading from ClearSCADA 2010 R1.x" and "Upgrading from ClearSCADA 2010 R2.x" in addition to the following.

• The "Deadband" and "Persistence" properties have been removed from the Driver Development Kit "PointSourceEntry" class as they are not relevant. This will cause existing DDK programs to fail to compile if they make use of these removed items. Hence before compiling any DDK programs, ensure that these properties are not used in the programs.

Upgrading from ClearSCADA 2007 R1.x

Please be aware of all the issues covered in the sections "Upgrading from ClearSCADA 2009 R1.x", "Upgrading from ClearSCADA 2009 R2.x", "Upgrading from ClearSCADA 2010 R1.x" and "Upgrading from ClearSCADA 2010 R2.x" in addition to the following.

• There is a known issue when instantiating particular types of objects within templates when running a mixed version redundant pair that could potentially result in an Integrity Check failure. It is recommended that minimal database changes be made during mixed version redundant pair operation and that servers are not run in this mode for extended periods of time.

• Upgrading from older versions of ClearSCADA to ClearSCADA 2010 R3.1 requires a new version 6 license to be issued. The older version 5 license will give an error if used on a machine running the ClearSCADA 2010 R3.1 version.

• Older versions of ClearSCADA contained a section in the Server Configuration tool called "User Contact Details" which allowed some of the fields associated with a user object such as E-Mail Address and Pager Id to be renamed. This section has been removed from the Server Configuration tool in ClearSCADA 2010.

Editing the names of database fields this way creates some entries in the "Metadata" key at the following location "HKEY_LOCAL_MACHINE\SOFTWARE\Serck Controls\SCX6\Metadata" in the Registry. The entries will look like one of the following depending on the field that has been renamed.

• Field_CDBUserContactConfig_EmailAddress

• Field_CDBUserContactConfig_EmailAddress2

• Field_CDBUserContactConfig_EmailAddress3

• Field_CDBUserContactConfig_EmailAddress4

• Field_CDBUserContactConfig_TextOnly

• Field_CDBUserContactConfig_TextOnly2

• Field_CDBUserContactConfig_TextOnly3

• Field_CDBUserContactConfig_TextOnly4

• Label_CDBUserContactConfig_EmailAddress

• Label_CDBUserContactConfig_EmailAddress2

• Label_CDBUserContactConfig_EmailAddress3

• Label_CDBUserContactConfig_EmailAddress4

• Field_CDBUserContactConfig_PagerId

• Field_CDBUserContactConfig_PagerId2

• Field_CDBUserContactConfig_PagerId3

• Field_CDBUserContactConfig_PagerId4

• Field_CDBUserContactConfig_PagerServiceId

• Field_CDBUserContactConfig_PagerServiceId2

• Field_CDBUserContactConfig_PagerServiceId3

• Field_CDBUserContactConfig_PagerServiceId4

• Label_CDBUserContactConfig_PagerId

• Label_CDBUserContactConfig_PagerId2

• Label_CDBUserContactConfig_PagerId3

• Label_CDBUserContactConfig_PagerId4

Before upgrading databases containing these renamed fields, these entries must be removed from the Metadata registry key. Otherwise, after the upgrade when the server is started, the Server Icon will go purple with "Invalid Metadata" error. By removing these registry values, the rename functionality will be disabled while maintaining the data associated with these points.

• In ClearSCADA 2010 R3.1, the Snapshot filename has been changed from "DB_Snapshot_" to "DBSnapshot_". To ensure that the appropriate number of Snapshot files are generated, please update the settings in the registry key HKEY_LOCAL_MACHINE\SOFTWARE\Serck Controls\SCX6\DBSnapshot.

• The older versions of ClearSCADA allowed Ethernet 1 or 2 to be selected as the DNP3 Master Port in the settings for DNP3 outstations even though the TCP/IP option was not enabled on the outstation. This is invalid configuration and has been fixed in ClearSCADA 2010. When upgrading to ClearSCADA 2010 from older versions, the outstations having this invalid configuration will have errors on them with an error message displayed saying "Invalid DNP Master Port 5".To correct this, enable TCP/IP and enter valid IP addresses for the Ethernet settings.

• In older versions of ClearSCADA, for a Channel with Connection Type set to "Network", an outstation could be configured with the "Network" field in the Network tab set to "None". This is invalid configuration and if a database containing this configuration is upgraded to ClearSCADA 2010, then configuration error is displayed on the outstation with the error message saying "Network Channel ... on set ... is not compatible with outstation.". To correct this error, a Network Type needs to be selected and the host address and port details need to be entered for the outstation.

• Dial-In Line Settings for PSTN outstations:

• In older versions of ClearSCADA, a PSTN Channel could be configured as "Dial In Only" or "Dial In and Dial Out" and there was no provision on the PSTN outstation form to specify the dial in channel settings. In ClearSCADA 2010, the PSTN tab for outstations has been modified so that the dial in line settings can be specified. Hence, when upgrading from older versions of ClearSCADA to ClearSCADA 2010, if the PSTN Channel is specified as "Dial In Only" or "Dial In and Dial Out", the status of the PSTN outstation will be "Available, Outgoing Only" unless the dial in channel details are specified in the "Dial In Line Settings" of the PSTN outstation. Then the status of the outstation becomes "Available".

• Changes in Port Configuration on E-Series Outstations:

• In ClearSCADA 2010, port configurations for E-Series outstations have been moved into a multi-choice aggregate.

• If you used automation interface code to configure port settings, then this code will no longer work in ClearSCADA 2010. Please use the example code below to modify your applications to use the new port structure.

ClearSCADA 2007 and earlier

Sub main()Dim objserver As ScxV6ServerDim obj As ScxV6ObjectDim sPort0DLRetries as StringSet objserver = New ScxV6Serverobjserver.Connect "MAIN", "", ""Set obj = objserver.FindObject("E-Series OS")'read the properties directlysPort0DLRetries = obj.Property("Port0DLRetries")End Sub

ClearSCADA 2009

Sub main()Dim objserver As ScxV6ServerDim obj As ScxV6ObjectDim aggOSType As ScxV6AggregateDim sPort0DLRetries as StringSet objserver = New ScxV6Serverobjserver.Connect "MAIN", "", ""Set obj = objserver.FindObject("E-Series OS")'Note that you need to find the board type aggregate before reading propertiesSet aggOSType = obj.Aggregate("BoardType")sPort0DLRetries = aggOSType.Property("Port0DLRetries")End Sub

Upgrading from an Older Version

Please be aware of all issues covered in the sections above.
Please also be aware of the Known Issues and Release Notes for each release since the version of ClearSCADA that is being upgraded.

Go: Home Back