Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AVEVA™ Batch Management

Upgrade Previous Versions

  • Last UpdatedOct 25, 2024
  • 7 minute read

Before you begin an upgrade, it is important that you do the following:

  • Confirm that the History Error Queue is empty. Because of changes to the InBatch History database, any data left in the Error Queue will not be accessible in the upgraded version. Refer to the "System Administration" section of the AVEVA Batch Management User Guide for detailed information.

  • Ensure that all batches have ended and that all warm restart files have been deleted.

  • Uninstall the PCS-Service Repository (PCS-SR) from all nodes except the GR node (IBMX), if present. The PCS-SR feature will not be installed with Batch Management 'Server Components' or 'Components of ArchestrA IDE' during the upgrade. Ensure PCS-SR is removed from all other nodes where it was previously configured.

The upgrading process varies depending on the version from which you are upgrading.

For information on upgrading from InBatch 9.0 or greater, see the "Upgrading from InBatch 9.0 or Later" section. For information on upgrading from a pre-InBatch 9.0 version, refer to "Upgrading from pre-9.0 InBatch Product".

The x_internal_ia and x_internal_ib folders are for internal use only. You should only use the dflt_cfg folder.

Upgrading from InBatch 9.0 or Later

When you install the latest version of Batch Management on a system that already has InBatch 9.0 or a later version, the installation procedure automatically detects the earlier version of InBatch and upgrades it to the version you are installing.

NOTE: When you upgrade from previous versions (11.0 or earlier) of InBatch to the latest version of Batch Management, all the InBatch links from Information Server database are removed. You can verify the NavNode, NavRole, and NavPanelNode tables where all InBatch related rows must be removed. The .rdl template files are also removed from ArchestrA\InBatch Reports folder and are now deployed in the new path "AVEVA Batch Management Reports" folder in the Reporting service URL. If you upgrade to the latest version of Batch Management from any previous versions, the Reports folder name is displayed as "InBatch Reports".

When you upgrade from the earlier versions of the product to Batch Management 2020 SP1 version, the installed path is C:\Program Files\Wonderware\Batch Management. For a fresh installation, the path is C:\Program Files\AVEVA\Batch Management.

To upgrade from InBatch 9.0 or greater

  1. Insert the AVEVA Batch Management CD into the CD-ROM drive and run setup.exe. The Installation Wizard starts.

    The Installation Wizard detects the earlier version of the InBatch product and starts the upgrade procedure.

    The License Agreement dialog box appears.

  2. Read the license agreement, and then click I accept the license agreement.

  3. Click Next. The AVEVA Batch Management Installation dialog box appears. The features that are installed in the previous version of InBatch are automatically selected for upgrade.

    You cannot change the feature selection during the upgrade.

  4. Click Next. If your computer does not meet the prerequisites for the InBatch features to be upgraded, the Prerequisites dialog box appears.

  5. Click Install Prerequisites. When all the prerequisites are installed, click Next. The Ready to Upgrade dialog box appears.

  6. Click Upgrade. The Backup dialog box appears. The installation wizard takes a backup of the existing InBatch data and then the progress bar appears.

    The files from the previous versions of InBatch are uninstalled and new files are copied. The Restore dialog box appears briefly.

  7. After the upgrade process is complete, the complete installation dialog box appears.

  8. If the upgraded features require configuration, click Configure. For more information on configuring InBatch, see AVEVA Batch Management Configuration.

    If your History or Archive database needs to be upgraded, the upgrade will take place automatically during the configuration process.

    NOTE: After upgrade, you can access the reports from the standard Reporting Services URL or the shortcut menu available in the AVEVA Batch Management folder. The reports will not be available from the Information Server. Also, the History Administration and Report Administration web pages now have their own shortcut menus available in the AVEVA Batch Management folder.

    IMPORTANT: When you upgrade the AVEVA Batch Management Server feature, the AVEVA Batch Management share exists with 'Everyone' as 'Full control' permissions. Make sure you remove the share and reconfigure the AVEVA Batch Management Server feature in order to add the current logged user with 'Full control' permissions on the AVEVA Batch Management folder share.

Upgrading from pre-9.0 InBatch Product

When you install the latest version of Batch Management on a system that has an older version of InBatch (such as 8.0, 8.1, or 8.1 SP1), the prerequisites program detects the older version of InBatch and stops the upgrade procedure. You will have to manually uninstall the existing version of InBatch and install the latest version as described below.

If you are using a version of InBatch earlier than 8.1, upgrade to InBatch 8.1. This process updates the databases and other files to a format that is compatible with the AVEVA Batch Management 2023 R2 installation procedures.

To upgrade your pre-9.0 InBatch product to AVEVA Batch Management 2023 R2

  1. Back up your pre-9.0 InBatch configuration and database files.

  2. Uninstall the pre-9.0 InBatch product using Programs and Features on the Control Panel. This removes the InBatch product and configuration files, but leaves the databases.

    If you are upgrading from InBatch 8.1 SP1 and your History or Archive database needs to be upgraded, the upgrade will take place automatically during the configuration process.

  3. If you are uninstalling 8.1 SP1 on a system that has a WAS bootstrap or a DAS server installed, do the following before uninstalling 8.1 SP1:

    1. Undeploy all platforms deployed to system and stop all DAS Servers.

    2. Find and back up the file c:\windows\system32\msstkprp.dll.

    3. Uninstall the InBatch product as described in Step 2. Do not reboot when done.

    4. Restore the file msstkprp.dll to the c:\windows\system32 directory.

    5. From a command prompt, change the directory to c:\windows\system32.

    6. Register the control by typing regsvr32 msstkprp.dll.

    7. Reboot and continue with steps below.

  4. Insert the AVEVA Batch Management installation media. The auto-run capability of Windows starts the setup program. If it does not, from the Start menu, select Run and enter E:\setup.exe (where E: is your installation media drive). The AVEVA Batch Management Installation Wizard starts and the main AVEVA Batch Management Setup dialog box appears.

  5. Follow the procedures in the Installation Wizard.

    Upgrading from pre-11.0 InBatch Product

    When you install the latest version of Batch Management on a system that has versions of InBatch earlier than InBatch 11.0, there may be "Tag Write" errors at runtime (from BatchMngr).

    There are new "Formula specific" system tags. You should perform a "Model Edit / Model Validation" to generate these new System tags on your existing equipment. Initially these new tags will be memory tags. If using Batch Objects, you can re-export the model and re-deploy the Batch Objects.

    Converting the Configuration Files

    Whether you are upgrading from a pre-9.0 version or 9.0 or higher version of InBatch, you must convert your configuration files for use with the latest version of Batch Management.

    To convert the configuration files to AVEVA Batch Management 2023 R2

    1. If you are upgrading from InBatch 9.0 or greater, skip to Step 2. If you are upgrading from a pre-9.0 version of InBatch, restore your configuration files by copying your backed up Config_A directory contents to the C:\Program Files\AVEVA\Batch Management\cfg\Config_A directory.

      NOTE: This replaces the directory that the install created.

    2. On the InBatch server node, from the Start menu, select Environment Display. The Environment Display dialog box appears.

    3. From the File menu, select Exit and Shutdown.

    4. Close the WWLogger.

    5. From the Start menu, select Run, and then enter C:\Program Files\AVEVA\Batch Management\bin\ CvtMaster.exe. A dialog box asks you to make sure that you have backed up your configuration files and that your InBatch History Server is connected to the history database.

    6. Click OK. The Batch Database Conversion Utility dialog box appears.

    7. Click Convert.

      The conversion utility converts the databases in the specified directory. When the conversions are complete, the utility displays information about the databases that were:

      • Converted

      • Failed or skipped

      • Already upgraded to the latest version of Batch Management

      The utility logs information about the conversion operations in the DbCvt.txt file, located in the configuration folder.

    8. Shutdown the CvtMaster utility and start EnvDspl.

    9. Run ModelEdit and perform a Validate. This will create any new System tags that have been added.

      NOTE: You will need to do an Update Runtime if new system tags are created.

      Upgrading Platforms that Use the InBatch Stateless API

      If you are upgrading from InBatch 9.5, the following InBatch Stateless API methods have been modified to include DoneBy and CheckBy (DoneBy, DoneByPswd, CheckBy, CheckByPswd) arguments:

      • AddScheduleEntry

      • DeleteScheduleEntry

      • InitializeScheduleEntry

      The AddScheduleEntry, DeleteScheduleEntry, and InitializeScheduleEntry methods use the security set for Access Schedule method. Use the security authentication set required for Access Schedule method of the Batch Client application.

      NOTE: If you are upgrading from 9.5 and are using any of the above-mentioned methods, you will need to modify your code or script.

      To upgrade platforms that use the InBatch Stateless API

      The following are the upgrade instructions:

      1. Run the AVEVA Batch Management upgrade on all InBatch Runtime Client and Batch Server systems. This includes any Application Server platforms that have InBatch API scripting deployed and running.

      2. Before running the AVEVA Batch Management upgrade, it is best to undeploy all Application Server platforms that are deployed to a Batch Runtime Client or Batch Server.

      3. Install the AVEVA Batch Management upgrade and re-import the InBatch API DLLs into the Galaxy. For more information on importing DLLs, see the Batch Management Stateless API Guide.

      4. Redeploy all platforms, engines, and objects as needed.

        In This Topic
        TitleResults for “How to create a CRG?”Also Available in