Offline Upgrade

Before you proceed with an offline upgrade, review the topic Prepare your System for Upgrade to check if a computer is ready to install a new version of Plant SCADA.

You should also check that a computer supports the hardware and software required to run the version of Plant SCADA you are installing. The requirements for each type of computer in a Plant SCADA system are in the relevant section of the Installation Guide. For example, the requirements for a development workstation are described in the topic Development Workstation Installation Requirements.

Note: The new version you are installing may have updates available. An update could include a fix for the automated project migration process and may need to be installed before restoring your projects. You can check for available product updates on the Products page of the AVEVA™ Knowledge & Support Center (https://softwaresupport.aveva.com).

1. Install Plant SCADA

Run the Plant SCADA Installer and select the components required for the computer you are upgrading. See Install Plant SCADA.

2. Setup Configurator

When a Plant SCADA installation is complete, a dialog will appear asking if you would like to launch Configurator. When upgrading a computer, you should use Configurator to confirm the following settings.

• System Management Server

  If your Plant SCADA system uses encryption, you first need to check the settings on Configurator’s Common Platform | System Management Server page.

  • If the computer is a System Management Server, confirm it is correctly configured. For more information, see Configure a System Management Server.

  • If it is not, make sure the computer is connected to a System Management Server. See Connect a Computer to a System Management Server.

• Enable Encryption

  You can then go to the Plant SCADA | Encryption page and confirm that encryption is enabled. See Enable Encryption in the Plant SCADA documentation.

• Configure the Server Password

  A server process requires a password that allows it to create trust with other servers. Check the Server Password setting on Configurator's Plant SCADA | Computer Setup page. If the Password and Confirm Password fields already contain an entry, it means a server password has already been configured on the local computer. For more information, see Use Configurator to Set Up a Runtime Server.

Note: The installation experience is not complete until after you exit Configurator. A restart request is likely to appear at this point. To avoid permission issues, you should close Configurator and confirm if a reboot is required before you run Plant SCADA.

3. Restore your projects

Use the *.ctz backup files you created prior to installation to restore your projects. This is achieved via the Projects activity in Plant SCADA Studio. For further instructions, refer to the topic Restore a Project in the Plant SCADA documentation.

4. Upgrade your projects

By default, when you restore a project from a previous version, Plant SCADA will force a project upgrade. Click Yes on the notification that appears to proceed with project upgrade.

You can also force an upgrade for all projects by setting the [CtEdit]Upgrade INI parameter to 1. When you restart Plant SCADA Studio, you will be notified that all projects will be upgraded. Click Yes to proceed.

5. Migrate your projects

The automatic project upgrade does not fully prepare your projects for operation on a new version of Plant SCADA. You also need to run the Project Migration Tool, a separate application that enables changes in project functionality. It also adds computers from the existing topology. You may need to run the Migration Tool separately for other components.

6. Merge your INI file

If you had any project-specific parameters defined in your existing Citect.ini file, you will need to merge them into the new version of the INI file that has been installed on the computer. Remember to merge any driver parameters from your old INI file as they will most likely be necessary to interface with your I/O network.

If the deployment system is used to distribute compiled projects, you should also check any Profile.ini files you have created for distribution.

For a list of any changes to INI parameters in the new version, refer to the topic on Citect.ini parameters in the What’s New section.

7. Compile your project

After upgrading your project and running the Migration Tool, compile your project to ascertain that runtime functionality will work as expected. It is likely that you may encounter errors when you compile your project.

One of the common sources of errors when upgrading is Cicode functions. This is because functions may have changed, become deprecated or simply because the compiler code has been updated to prevent runtime errors. You can find a list of updates to Cicode functions in the What's New section.

Note: If you are upgrading from version 2018 R2, the compiler warning message W1041 will be generated if the Address field for your network address is an IP address. If this occurs and you want to use encryption, you need to set the DNS Name field in the Topology|Computers view for the matching network address to the DNS Name of the computer.

8. Run the Setup Wizard

Before running your project, run the Setup Wizard 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.

9. Restore runtime files

After compiling your project, place the files necessary for runtime in the correct directories. Refer to the list of configuration files in the topic Prepare your System for Upgrade and place them in the corresponding directories.

10. Restore historical data files

A project upgrade may require your existing trend and alarm data to be updated to ensure compatibility with new product features. This means you should restore your historical data files before running your upgraded projects.

Note: Once the data files have been upgraded, they may not be compatible with the previous version. It is recommended that you maintain a copy of your original backup. Apply the upgrade to a duplicate copy of the data.

Alarms

Convert your alarm database in the Data directory with the following steps:

1. Check that you have placed your backed-up alarm database in the directory defined by the [CtEdit]Data parameter.

2. Delete any legacy database files.

   Prior to version 7.30, Citect SCADA used the following alarm database files:

   • <project>_<cluster>_ALMSAVE.DAT

   • <project>_<cluster>_ALMINDEXSAVE.DAT

     Or:

   • ALMSAVE.DAT

   • ALMINDEXSAVE.DAT.

     If you are upgrading from a version prior to 7.30, these legacy files are converted to a new alarm database format when the alarm server is launched. Once this occurs, these files are no longer required.

     If you are upgrading from a version later than 7.30 (2015 or later), you should delete these files prior to starting the alarm server. Confirm that the directory specified by the [Alarm]SavePrimary parameter does not contain the legacy alarm database files listed above.

Note: If you do not delete these files, in some circumstances the legacy data from these files may replace or merge into your current alarm database when you launch the alarm server.

Trends

Follow these steps to convert the files:

3. Create the same file hierarchy on the new system.

4. Place the files in the same folders.

   It is not recommended to change the directory path of the trend data files during the project upgrade as this may affect the trend operation. The default data directory may be changed between product versions and may need to be considered in the context of the install and upgrade with regards to the trend file location.

   If you want to change the folder location or you cannot replicate the same file hierarchy, edit the trend tag definitions to match the new file paths.

11. Run your project

Run your project to check that the functionality works as intended.

• Check any Cicode that you had to modify in order to compile your project.

• Test communications to your I/O devices, alarm triggering and trend capture.

Note: After the upgrade and configuration changes to the project are complete, it is recommended to perform system testing of the new project version prior to applying it to the production environment.

See Also

Troubleshooting an Offline Upgrade