Note: This is the basic upgrade process and you will need to perform these steps even if choose to use the Online Upgrade method.
Offline Upgrade to Citect SCADA 2018 comprises the following steps:
Perform a backup of your project and other relevant files. For the upgrade to complete smoothly without errors, you need to back up a number of files/folders from your system other than your project files. The number of files you need to back up depends on your system configuration. For more information about performing a backup, refer to the Backing Up a Project section in the online help of your current version.
The following files need to be backed up:
File |
Description |
---|---|
Project backup (.ctz file) |
This is the main file to back up. For information about backing up a project, refer to your current version's online help. You need to have the Save sub-directories and Save configuration files options selected in the Backup dialog. |
Citect.ini |
This file is located in the config folder. |
Data directory |
This file is found on the path [CtEdit]Data |
ALMSAV.DAT and ALMINDEXSAVE.DAT (For v7.20) OR Alarm Database (for v7.40 and v2015) |
These files contain alarm configuration data as well as runtime data. Their path is defined in the Citect.INI file. The default path is same as the data directory path.
The Alarm Database is located in the Data directory: [Data]\<Project Name>\<ClusterName.AlarmServerName>. For each alarm server you have in your system, a corresponding Alarm Database will exist. You need to backup all alarm databases. |
Trend files: *.HST and *.00X |
The path and names of these files are defined on the trend tag itself, and created in the Data directory defined in [CtEdit]Data. The files will be named after the trend name and number of files. For example, if the trend name is CPU, file names will be CPU.HST, CPU.001, CPU.002 and so on. |
Report Files |
These files contain the code that is executed on your reports, and are located in the [CtEdit]User\<Project Name> folder. |
Custom ActiveX Controls (.OCX) |
Citect SCADA includes a number of ActiveX controls, which will be available with the 2018 installation, but need to take a back up of your custom ActiveX controls. Check your ActiveX.dbf file in the [CtEdit]User\<Project Name> folder. This file contains a list of the ActiveX controls in your project and their GUID. Using the GUID, find the path of an ActiveX control using the Windows Registry key KEY_LOCAL_MACHINE\SOFTWARE\Classes\CLSID\"GUID"\InProcServer32\. The default value for this key is a path to the .DLL or .OCX file you need to back up. |
Process Analyst files | Backup the main <Project Folder>\Analyst Views and <Project Folder>\Dictionary folders. |
Device logs |
These files contain any logging (alarm logs, report logs) you have configured in your project. You will find their location in the Devices dialog. Refer to your online help for more information. |
Additional Files |
Check your Citect.ini file or use the Setup Editor | Paths section as it could contain runtime files used by custom code in the project. |
Driver Hotfixes |
If you are aware of any driver hotfix in your system, backup this driver DLL which is located in the Bin directory where Citect SCADA is installed. Note: The fixes contained in this hotfix may have been included in the drivers which ship with Citect SCADA 2018. |
In order to do this, you will either need to have a valid support agreement or you will need to purchase a license upgrade. Upgrade your key or soft license using our online license generator. You can also check the support status at the same URL.
If your license is out of support, contact your Schneider Electric account manager. If you are not sure who your account manager is, send an email to scada.orders@schneider-electric.com with your license and site ID details. For more information about licensing in Citect SCADA 2018, refer to Licensing.
If you need new hardware or need to upgrade to a new operating system to run Citect SCADA, this step is not required. Otherwise, uninstall the current version of Citect SCADA completely and install the next version specified in your upgrade path.
If your current version is v7.20 or higher, proceed to step 13.
Restore your project.
As a default, when you restore your project from a previous version, Citect SCADA will force an update, and you will get a warning message. Click Yes to proceed with project upgrade.
If this message is not displayed, you can force an update of all projects by setting the [CtEdit]Upgrade INI parameter to 1 and restarting Citect SCADA. Once you restart, you will get a warning message. After clicking Yes all projects will be upgraded.
The automatic project upgrade does not fully upgrade your projects, and needs to be followed by the Migration tool. The Migration tool is a separate application that run automatically after the project upgrade has been executed, and adds computers from the existing topology. You may need to run the Migration tool separately for other components. Refer to the online help for more information about running the Migration tool.
If you have defined the following parameters in your Citect.INI file, merge them into the new version's INI file.
Parameter |
Description |
---|---|
[General] TagStartDigit=1 |
Without this parameter, you will encounter the 'Tag not defined' compiler error. Setting this to 1 allows you to define tag names that begin with a number or a symbol. |
[General] CheckAddressBoundary=0 |
Without this parameter, you could encounter the 'Bad Raw Data' or other tag address related errors. Setting this to 0 allows defining variable tags of the same data type in odd or even addresses. When this parameter is set to 1 all variable tags from the same data type need to be defined on odd OR even addresses. |
[General] ClusterReplication=1 |
Without this parameter, compile will fail in a multi-cluster system. Setting this parameter to 1 will enable tag/tag reference replication in a multi-cluster system. |
[CtDraw.RSC] ListSystemPage=1 |
This allows you to open popup pages from Graphics Builder. |
[CtDraw.RSC] AllowEditSuperGeniePage=1 |
This allows you to edit super genie pages from Graphics Builder. |
[CtEdit] DbFiles=100 |
This allows you to set the maximum number of .DBF files that can be open simultaneously. Allowable values are between 50 to 32767 with the default set to 100. Increase the value of this parameter for larger projects. |
Merge any driver parameters from you old .INI file as they will most likely be necessary to interface with your I/O network. For a list of changes to .INI parameters, refer to Citect.INI Parameters in Version 2018.
After upgrading your project and running the Migration tool, compile your project to ascertain that runtime functionality works as expected. It is very likely that you may encounter errors when you compile your project. One of the most common sources of errors when upgrading is Cicode functions. This is because functions may have changed, deprecated or simply because the compiler code has been updated to prevent runtime errors. You can find a list of updates to Cicode functions here.
Refer to your online help for instructions on compiling your project.
Before running your project, run the Setup Wizard (known as Computer Setup Wizard in previous versions) to configure the Runtime Manager and other settings that are relevant to the runtime process. The Setup Wizard will automatically determine the role of your computer based on the network addresses defined in your project. After finishing the Setup Wizard, restore your historic data and other files, and run your project.
After compiling your project, place the files necessary for runtime in the correct directories. Refer to point 1 in this topic for the list of files you need to place in the corresponding directories as defined in your Citect.INI file and project configuration.
Restore the historical data files before running your upgraded projects.
Alarms (v7.20 and earlier)
Before you can upgrade to Citect SCADA2018, perform the following steps to convert your <Project Name>_<Cluster Name>_ALMSAV.DAT and <Project Name>_<Cluster Name>_ALMINDEXSAVE.DAT files to a format that can be ready by the new alarm server architecture introduced in v7.30:
Alarms (v7.40 and v2015)
Convert your Alarm Database in the Data directory with the following steps:
Trends
Follow these steps to convert the files:
Note: If you are changing the trend tag name, use the trend renaming tool available at the Support Site.
Run your project to check that the functionality works as intended:
After you have completed all the steps in your upgrade path, install Citect SCADA 2018. Refer to the Citect SCADA 2018 Installation Guide for more information.
See Also
Published June 2018