Upgrading Builds

From SysCAD Documentation
Jump to navigation Jump to search

Navigation: User Guide -> Upgrading Builds

Related Links: Upgrading Projects, Upgrade to SysCAD 9.3


This topic describes steps for upgrading Builds within a version. For example, Build 136 to Build 137 for SysCAD version 9.3. For major version upgrades, see Upgrading Projects.

Refer to What's New for Build release notes and to Revision History for Build update notes.

Installing the new SysCAD Build

It is strongly recommended that you install the new Build rather than simply unzip the Update. A new Build will have updated example projects as well as updated utilities and referenced files such as those contained in Basefiles folder.

SysCAD Installation Instructions:

You can install a new Build over the existing Build, as it is not necessary to install to a new location. When installing to the same location it is strongly recommended that you first:

  1. Delete, backup or rename the tutorial and example projects folders before installing the new build. (If you do not do this, you will get a mixture of old and new files in the tutorial and example projects.)
  2. Delete, backup or rename the BaseFiles folder before installing the new build.
  3. You can retain a version of the previous Build by renaming the bin folder before installing (optional).
    • For example, if you are upgrading to Build 137 and your current Build is 136.20721 you can rename the Bin folder "Bin136_20721", or simply "Bin136", to retain the older version.

When installing a new Build to a new location, some of your preferences which are stored in ...\BaseFilesUser folder are not seen. For example, the license location is "forgotten" and you may need to browse for the license folder again. To avoid this, after installing the new Build, copy the files from the old build BaseFilesUser folder to the new installation location.

Recommended Project Upgrade Procedure

Generally projects upgrade smoothly between Builds with little or no user action required. New Builds primarily have new features, new options and improved usability all of which are enhancements that rarely effect existing models and the upgrade process. However, a general rigorous procedure is described below.

For some errors reported at project load or solver startup, it can sometimes be possible to make changes or fixes in the original project. It can be beneficial to change the original project, solve and save and repeat the necessary parts of the upgrade steps.

Step 1 - Backup

Create a backup of your entire project folder, including the CfgFiles folder. This is important, as you may wish to return to the previous Build to compare results and configuration with the upgraded project.

Step 2 - Edit Configuration File

This step may not be required with every new Build.

Start SysCAD and go to Edit Project Configuration and edit the project configuration file. Ensure that the models list and species list are as required.

IMPORTANT: This step is REQUIRED when upgrading from SysCAD 9.3 Build 136 to Build 137, user needs to select the Solve mode for the project in the configuration file. Steady state and dynamic projects NO LONGER share the same configuration file.

Before opening any dynamic projects, user must first edit the configuration file to select the dynamic solve mode, alternatively, user can select to edit the configuration from the Project solve mode mismatch dialog box (as a result of solve mode mismatch).

Step 3 - Resolve Database Issues

This step may not be required with every new Build.

Resolve all species database issues, if there are any, by editing the species database:

  • The user may click on the Species DB button on the bottom of the 'Project Configuration' dialogue box, or
  • Go to menu item Species - Edit Project Database and then browse for the required species database.

Tip: The upgrade will usually be smoother if you make as many of the required changes in the original build prior to upgrading. This may mean doing a test upgrade to identify the issues, then going back to the original project in the original build to make the changes, and then doing the upgrade proper.

Step 4 - Open Project (Part a - do not save)

Open the project. Do not save the project.

BEFORE saving the projects you will want to resolve any errors related to loading referenced pgm and mp files, as well as other load errors in referenced files.

There may be many messages related to the upgrade, so you may need to scroll past these to look for errors and warnings related to PGM and MP for the project load.

The first important error to look out for is any PGM or MP files that fail to load. The errors in the PGM code that prevent a PGM load must be resolved first. If the project is saved without correcting these then the state (values) of the pgm or mp variables are lost. The best approach is to resolve PGM an MP load errors (by editing the text files), exit SysCAD without saving the project, then reload the project.

There may be other errors loading reaction (RCT) files or the species database that can be resolved at this time.

During this step you are fixing any errors in external files. You are not changing or fixing anything in the project itself so you do not need to save the project. Close the project and reload as often as may be required.

Step 4 - Open Project (Part b - Save As)

Open the project again and then carry out a Save Project As command and select a new project name.

Continue reviewing warnings and errors, making the required corrections. Save and reload the project as often as may be required. Many of the potential issues are described in the release notes for the specific Builds. The aim of this step is to resolve as many errors as possible before attempting to solve the project.

Step 5 - Solve the Project (Part a - Solver Startup)

Once previous steps are complete, that is:

  1. the configuration file, species database & project have been upgraded;
  2. the project saved to a new name; and
  3. all important load errors and warnings have been resolved and/or reviewed.

Then you are ready to resolve any potential errors that may occur when you solve the upgraded project.

There may be warnings and error messages when solving a newly upgraded project. These may be related to tag name changes, discontinued tags, rearranged options or other changes in the new Build. These may be described in the release notes for the specific Builds.

Rather than solve the project, select the menu option Actions|Idle as this performs the solver startup tests before solving any iterations. Then you can resolve any solver startup issues before looking at any issues that occur while solving. If there are errors, stop the solver then make corrections, select Idle again and repeat.

Save the project. Exit the project and reload, checking the messages as you proceed.

Step 5 - Solve the Project (Part b - Solve)

Having resolved errors at solver startup, you are now ready to solve the project. During this step you are reviewing the errors as they occur during the solver iterations.

Once any issues have been resolved, the project results can be compared to previous results to determine if there are any significant differences that need investigation. With some new Builds, small differences in results may occur because of improvements see release notes for the specific Builds.

Remember to also check the Excel inputs and reports to check that these still work as expected and don't have any messages about invalid tags.

Step 6 - Other Projects

For all other projects which use the same species database and configuration file, repeat step 4 and 5 only. The configuration file and related species database only needs to be upgraded once for all the projects that reference this.

Tag Changes

  1. Some tags may have been renamed either to achieve consistency across different models or to provide a better description of the tag.
    • When an old tag is referenced, e.g. in a PID, general controller, Excel report, trend page, QuickView, graphics annotation, historian, etc, in most cases SysCAD will generate a message that the tag has changed and use the new tag.
    • The messages will continue to be generated until the user changes the reference to the new tag. For the historian, it is a good idea to delete the historian (Push the Delete button on the Historian page for Project Settings).
  2. A few tags that were rarely used may have been removed.
  3. Some conversion types have been changed or discontinued. If an old conversion type has been used in a PGM for a variable declaration then this will need to be manually changed to the equivalent type.

Changes that may affect results

If there are any changes that may effect results, these will be described in the release notes for the Build.