Last revision: 1/10/2025
This document contains important information about AVEVA Batch Management 2023 R2 (v13.1) release. Review this document for known issues and changes to the AVEVA Batch Management software and documentation included on this CD.
NOTE: Readme files from previous releases of Wonderware InBatch software are posted to the AVEVA Knowledge & Support Center.
AVEVA Batch Management 2023 R2 (v13.1) offers the following new features and enhancements:
Added support for Shared Components of System Platform 2023 R2 SP1.
Added support to retain Phase Formula Parameter extensions after the reimport of Batch Management objects.
Verified compatibility of Batch Management server and clients in both parent and child domains with trusted configurations.
Added support for Shared Components of System Platform 2023 R2 SP1.
Included the latest cybersecurity improvements, cumulative hotfixes, and technology updates.
Before installing AVEVA Batch Management, download and install the latest Microsoft updates to enhance security and ensure product compatibility. Allow the Windows update process to finish before you start installing AVEVA Batch Management. This recommendation applies to all Windows versions.
Note that when Windows updates run in the background, there is the possibility that different software processes can be adversely affected. Therefore, it is important to schedule the updates to run only during planned shutdown periods.
Configure automatic Windows updates
If Windows is configured to update automatically, these automatic updates, when running in the background, can disrupt AVEVA Batch Management components, including: Batch Management server, Batch Management Clients, Batch Historian, and run-time operations. These updates may cause the AVEVA Batch Management services to shutdown unexpectedly. Therefore, we recommend that you disable automatic Windows updates, or otherwise ensure the updates will be installed only when AVEVA Batch Management applications are not being actively used.
This section describes the hardware, software, and operating system required to install the AVEVA Batch Management software.
Hardware Requirements
Minimum Hardware Requirements
The following hardware is recommended to support AVEVA Batch Management:
Hardware Requirements
|
Client |
Server |
|||
---|---|---|---|---|---|
Small View Application |
Large View Application |
Small View Application |
Medium View Application |
Large View Application |
|
Processor |
1.8 gigahertz (GHz) |
1.8 gigahertz (GHz) |
2.8 gigahertz (GHz) |
2.8 gigahertz (GHz) |
2.8 gigahertz (GHz) |
Processor Cores |
2 (Minimum) 4 (Recommended) |
4 (Minimum) 8 (Recommended) |
2 (Minimum) 4 (Recommended) |
4 (Minimum) 8 (Recommended) |
8 (Minimum) 16 (Recommended) |
RAM |
1 GB (Minimum) 4 GB (Recommended) |
4 GB (Minimum) 16 GB (Recommended) |
4 GB (Minimum) 4 GB (Recommended) |
8 GB (Minimum) 12 GB (Recommended) |
16 GB (Minimum) 24 GB (Recommended) |
Hard Disk |
100 GB (Minimum) 200 GB (Recommended) |
200 GB (Minimum) 500 GB (Recommended) |
100 GB (Minimum) 200 GB (Recommended) |
200 GB (Minimum) 500 GB (Recommended) |
500 GB (Minimum) 1000 GB (Recommended) |
Video Adapter / Monitor Capability (Resolution) |
1024 x 768 (Minimum) 1920x1080 (Recommended) |
1024 x 768 (Minimum) 1920x1080 (Recommended) |
1024 x 768 (Minimum) 1920x1080 (Recommended) |
1024 x 768 (Minimum) 1920x1080 (Recommended) |
1024 x 768 (Minimum) 1920x1080 (Recommended) |
Network Speed |
100 Mbps (Minimum) 1 Gbps (Recommended) |
100 Mbps (Minimum) 1 Gbps (Recommended) |
100 Mbps (Minimum) 1 Gbps (Recommended) |
1 Gbps |
1 Gbps (Minimum) Dual 1 Gbps (Recommended) |
Input Devices |
|
Hardware Requirements - Operating System
See your specific Microsoft operating system hardware requirements for details.
Operating System Requirements
The following table lists the operating system, .NET Framework, and virtualization requirements for AVEVA Batch Management 2023 R2.
Operating System
|
Client Windows OS (64-bit) |
Server Windows OS |
.NET Framework
|
Virtualization |
|
|
|
|||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
10 (Semi-Annual Channel) Pro, Enterprise, and IoT Enterprise 22H2
|
10 (Long Term Servicing Channel) Enterprise, IoT Enterprise 2019 (1809), 2021 (21H2)
|
11 (Semi-Annual Channel) Pro, Enterprise, and IoT Enterprise 22H2, 23H2 |
2016 (Long Term Servicing Channel) Standard, Data Center, IoT |
2019 (Long Term Servicing Channel) Standard, Data Center, IoT, Essentials |
2022 (Long Term Servicing Channel) Standard, Data Center |
2025 (Long Term Servicing Channel) Standard, Data Center |
4.8 |
5.0 |
6.0 (LTSC) [ Nov 2024] |
7.0 |
8.0 (Nov 2026) |
Hyper-V shipped with supported version of Windows (Includes Gen1 and Gen2 VMs) |
VMWare VSphere 7.0.2 and newer (including HA/DR) |
VMWare Clients (including Horizon - App Virtualization) |
Cloud Virtualization - Azure |
VMWare Workstation 12.5.9 (Only) and 16.2.2 and newer |
Stratus HA/DR and FT based solutions (zTC Edge 110i) |
Nutanix (AHV version 20201105.2030, Nutanix AOS version - 5.20.8.1 LTS) |
VMWare vMotion v7 |
|
AVEVA Batch Management Server
|
Y |
Y |
Y |
Y |
Y |
Y |
Y
|
Y |
C |
Y |
C |
|
Y |
Y |
Y |
Y |
Y |
Y |
Y |
Y |
AVEVA Batch Management Clients
|
Y |
Y |
Y |
Y |
Y |
Y |
Y
|
Y |
C |
Y |
C |
|
Y |
Y |
Y |
Y |
Y |
Y |
Y |
Y |
AVEVA Batch Management History Server
|
Y |
Y |
Y |
Y |
Y |
Y |
Y
|
Y |
C |
Y |
C |
|
Y |
Y |
Y |
Y |
Y |
Y |
Y |
Y |
AVEVA Batch Management Reporting Content
|
Y |
Y |
Y |
Y |
Y |
Y |
Y
|
Y |
C |
C |
C |
|
Y |
Y |
Y |
Y |
Y |
Y |
Y |
Y |
Supported
|
Y |
Not Supported |
N |
Coexist. |
C |
Notes:
- For software requirements for the "AVEVA Batch Management Components for System Platform IDE" feature, see the software requirements for Application Server.
- For software requirements for the "AVEVA Batch Management Reporting Content" feature, see the software requirements for Microsoft SQL Server.
- If a supported version of the Microsoft .NET Framework is not installed, the AVEVA Batch Management installation automatically installs it.
Browser Requirements
Application Name |
Supported Version |
---|---|
Microsoft Edge |
Non-Chromium and Older Chromium 97.0.1072.76 and newer* |
Google Chrome |
Version 98.0.4758.80 and newer* |
Firefox |
Version 102.11 ESR and newer* |
Safari |
Version 15.2 and newer* (Mac and iOS only) (Not Windows) |
Opera |
Version 83.0.4254.16 and newer* |
* Unless later versions of browsers deprecate the user interfaces used by AVEVA Batch Management Reporting System.
Microsoft SQL Server Requirements
The following table lists the Microsoft SQL Server requirements.
Microsoft SQL Server Requirements |
SQL 2016 Express (SSME), Standard, Enterprise |
SQL 2017 Express Core/Express with Adv Tools), Standard, Enterprise (+All Cumulative Updates) |
SQL 2019 Express Core/Express with Adv Tools), Standard, Enterprise (+All Cumulative Updates) |
SQL 2022 Express Core/Express with Adv Tools), Standard, Enterprise (+All Cumulative Updates) |
---|---|---|---|---|
AVEVA Batch Management Server |
N/A |
N/A |
N/A |
N/A |
AVEVA Batch Management Clients |
N/A |
N/A |
N/A |
N/A |
AVEVA Batch Management History Server |
Y |
Y |
Y |
Y |
AVEVA Batch Management Reporting Content |
Y |
Y |
Y |
Y |
Supported
|
Y |
SQL Database is not required for AVEVA Batch Management Server and Clients |
N/A |
Note: The SQL Server Agent service is not available in the Express editions of SQL Server. As a result, operations such as Batch Management History Database Administration (Archive, Purge, Restore) and Reports Administration (Report Scheduling) are not supported in the SQL Express edition.
The SQL Server Agent functionality is exclusively available in the Enterprise or Standard editions of SQL Server.
In systems configured with SQL Server Express, the Batch Management Reports or History Administration page displays the following message:
“SQL Express edition detected on Batch Management Reporting Server. This operation is not supported as SQL Server Agent is unavailable or not installed.”
Additional Software Requirements
The following table lists the additional typical software requirements for each AVEVA Batch Management station type when the AVEVA Batch Management software is used with System Platform (SP):
Additional Software Requirements |
AVEVA Batch Management Station Type |
|||||
---|---|---|---|---|---|---|
Server |
Run-time Client |
Development Client |
History Server |
Reporting Content |
Redundant System |
|
Application Server bootstrap and IDE |
Yes* |
- |
Yes |
- |
- |
Yes* |
InTouch |
- |
Yes |
- |
- |
- |
- |
*Application Server IDE is required only during Development for GRAccess, and not during Runtime. IDE is required for Tag Linker Editor for browsing the Galaxy by creating an Access Name. Application Server Bootstrap is required only for AVEVA Batch Management Server and Redundant Server during Runtime.
AVEVA Batch Management Firewall Exceptions List
AVEVA Batch Management requires certain network ports to be opened in the Windows Firewall to establish communication with other components and services on the network. Usually, this is automatically done during the installation and configuration process of AVEVA Batch Management. However, if the Windows firewall is not enabled at the time of installation or if an alternative firewall is in use during installation, you need to open the appropriate network ports in the firewall manually for proper functioning of AVEVA Batch Management. The following is a list of ports that must be added to the Windows Firewall exceptions list for AVEVA Batch Management:
For important information about this product release, go to the AVEVA Global Customer Support (GCS) website. Information on the GCS website includes product requirements, compatibility, as well as downloads from previous releases. After you log in, you can filter search results by product name and the release/version.
AVEVA Batch Management enforces licensing through AVEVA Enterprise License Manager.
Licensing Information
Once installed, a link to the AVEVA Enterprise License Manager can be found in the \AVEVA folder on the Start menu.
It can also be accessed by pointing your browser to the following URL:
http://<nodename>/AELicenseManager
where <Nodename> is localhost or the name of the node where the AVEVA Enterprise License Manager is installed.
License Server
The AVEVA Enterprise License Server can be installed separately from the AVEVA Enterprise License Manager.
Note: Prior to upgrading, confirm that your Hist Queue and Error Queue are empty. Because of changes to the AVEVA Batch Management History database, any data left in the Hist Queue or Error Queue will not be accessible in the upgraded version. Also, ensure that all batches have ended and that all warm restart files have been deleted.
For installation and upgrade instructions, see the AVEVA Batch Management Installation Guide and the Installation Issues section of this document.
Upgrading the software from the versions listed below only requires running the Setup.exe:
The process will upgrade all components as required.
The following is a list of important points that you must note during the upgrade process.
Any new .CSV files are also added to the following folder: "C:\Program Files\Wonderware\InBatch\Messages\English".
Note: If you are using the InBatch GUI Controls and upgrading from 10.2 or earlier, you may need to adjust some of your InTouch application layouts. Some of the controls have been increased in size to better accommodate larger values. Also, a new "Formula" column was added to several list controls.
This section describes resolved issues listed by their Defect ID (CR or IMS number).
Defect ID |
Description |
---|---|
IMS 2605656 |
The Scheduler crashes if the formula file name contains special characters, such as "%," preventing batch initialization. |
IMS 2847434 |
In InTouch and AppServer, the tags IBSERV, LASTF, and FORNM are restricted to 16 characters for display, even though the database allows up to 128 characters. |
IMS 2988980 |
Issue with recipe validation caused by real-time changes to Material IDs in the Materials Editor. |
IMS 3045740 |
Documentation request for silent installation of AVEVA Batch Management 2023 R2. |
IMS 3480677
|
The myRecipe.GetOpLibrary() method throws an exception "The RPC server is unavailable" when fetching the Operation Library if more than one operation exists. |
IMS 3557672
|
Unable to migrate BatchHistory Database from BM2017 to BM 2023. A warning History Server ExecuteNonQuery failed for Database 'BatchHistory' appears. |
This section describes important known issues.
Installation Issues
2456284 |
AVEVA Batch Management application messages are not logged in SMC until the node is rebooted after installation. |
616969 |
Configuration of the History Server feature fails when you upgrade InBatch History Server to InBatch version 11.5.1 from versions prior to InBatch 11.0. Before proceeding with the upgrade, ensure that you delete all SQL Jobs related to Archive\Purge\Restore. Prior to InBatch 11.0 version, any SQL Agent jobs (Archive\Purge\Restore jobs) created in InBatch History Server may have been associated with BatchAdminUser, BatchReportAdmin, or BatchUser role. These user roles have been removed in 11.0 release. |
L00107356 |
Due to the large number of services running on Foxboro DCS platforms, the installation program should check the value of the SessionViewSize registry setting. It is likely that this registry value does not exist and will need to be created. If you ever notice that services unexpectedly fail to start, the value of this setting may be too small. Follow these steps:
|
L00127339 |
Machine names in redundant systems must be 12 characters or less. |
IMS 3609976 |
The I/O tag write failures may occur when AVEVA Batch Management 2023 R2 is installed on top of System Platform 2023 R2. Workaround: Apply the Hotfix 3609976. |
IMS 3647440 |
Users will be unable to log in to the System Platform IDE using the AVEVA Connect SSO configuration if Batch Management 2023 R2 is installed on top of System Platform 2023 R2. Workaround: Upgrade System Platform to 2023 R2 SP1. |
IMS 3647457 |
The InTouch web client does not display the deployed object's tag values at runtime when Batch Management 2023 R2 is installed on top of System Platform 2023 R2. Workaround: Upgrade System Platform to 2023 R2 SP1. |
IMS 3647498 |
Error "LicAPI.Loader.Core" and warning "vcp.services.onprem.frontdoo'" are logged in the SMC logger when deploying the AVEVA Batch Management 2023 R2 OMI Web View App on System Platform 2023 R2. Workaround: Upgrade System Platform to 2023 R2 SP1. |
IMS 3647528 |
Configuring "Microsoft Entra ID" as the Federated Identity Provider in the configurator will cause the System Platform IDE to crash when adding new roles, if Batch Management 2023 R2 is installed on top of System Platform 2023 R2. Workaround: Upgrade System Platform to 2023 R2 SP1. |
IMS 3648047 |
You may observe an exception in the Event Viewer when stopping Batch Management Services (IBServ). This issue occurs on Windows 2019, 2022, and 2025 but does not affect functionality. |
IMS 3650140 |
If AVEVA Batch Management 2023 R2 is uninstalled from a system that also has other AVEVA products installed, the "System Management Server" and "Federated Identity Provider" features might revert to an unconfigured state. Workaround: Reconfigure the "System Management Server" and "Federated Identity Provider" features. |
IMS 3678006 |
Uninstalling AVEVA Batch Management 2023 R2 also removes the LicAPI (x64) feature when AVEVA System Platform 2023 R2 SP1 is installed. Workaround: Reinstall the AVEVA Enterprise Licensing Platform feature. |
IMS 3692747 |
The startup time for the AVEVA Batch Management 2023 R2 (v13.1) IBMX service is longer with System Platform 2023 R2 SP1. Workaround: Apply the Hotfix 3692747. |
IMS 3696628 |
The startup time for the AVEVA Batch Management 2023 R2 (v13.1) IBMX service is longer with System Platform 2023 R2. Workaround: Apply the Hotfix 3696628. |
Other Issues
IMS 2353338 |
Unknown Opcode Internal Error dialog box is displayed in AVEVA InTouch 2023 when Batch Management ActiveX application switches to runtime. Workaround: Apply AVEVA System Platform 2023 P01 Patch.
|
|||||||||||||||||||||||||||||||||||
1055512 |
Batch Management web client Icons and images are distorted in Mozilla Firefox browsers. Workaround: Do the following settings in the Firefox browser:
|
|||||||||||||||||||||||||||||||||||
459424 |
Ensure that you adjust the InTouch application layouts to account for the new Formula column in the lists, if you are using GuiControl lists (ScheduleEdit.Schedule, BatchView.Batch, and BatchView.AllocationQueue). The width of other GUI Control lists may have also been increased to support better presentation of longer values. |
|||||||||||||||||||||||||||||||||||
614956 |
SSRS report execution (i.e. when you open the report and click "View Report") displays a blank page in the Chrome browser.
Workaround: To resolve this error, do the following:
|
|||||||||||||||||||||||||||||||||||
L00077400 |
Editors are not opening on the AVEVA Batch Management development client.
Workaround:
|
|||||||||||||||||||||||||||||||||||
L00081552 |
Running Wonderware InBatch with Foxboro DCS components in a redundant configuration does not fail over when FoxDCSDriver is shut down. The following table shows the redundancy status on master/backup nodes when IBMX, IBCli, and FoxDCSDriver are stopped from the Runtime Services dialog box or when you end the process from the Task Manager.
|
|||||||||||||||||||||||||||||||||||
L00082612 |
Custom-created reports that are populated to the batch report directory are not available for configuration and scheduling. Use the following steps to configure and schedule the custom reports. For example, suppose a report named "Custom Batch Detail" is populated in the list.
|
|||||||||||||||||||||||||||||||||||
L00098867 |
When using the IBCli application, some I/O Servers or DAServers (including FS Gateway) may report an error about an "Unknown Watchdog" tag. This error is only reported when IBCli starts. However, the Watchdog tag still functions as expected. If you get the following errors from IBCli:
|
|||||||||||||||||||||||||||||||||||
L00125348 |
If you use the Import Utility in the preview mode, warning messages are not shown. This is observed when the utility imports a Wonderware InBatch ModelDB, in which any of the following have duplicate names (case sensitive): processes, transfers, segments, units, connections, or phases. However, warning messages are shown when you perform an actual import. |
|||||||||||||||||||||||||||||||||||
L00128201 |
When you run the cvtmaster for a second time, conversion fails.
Workaround:
|
|||||||||||||||||||||||||||||||||||
L00139186 |
Error and warning messages related to ReportQueueReader are logged in the SMC logger after you enable the Enhanced security mode using "aaConfigSQL" tool.
Workaround: Ensure that the ServiceDB user (configured to run the InBatch ReportQueueReader service) has access to printers and has the privilege to print. |
|||||||||||||||||||||||||||||||||||
1010526
|
Compatibility issues with Vijeo Citect 2016
|
|||||||||||||||||||||||||||||||||||
1102209 |
The "History Admin" and the "Report Web" pages display the following error: Unable to contact Batch Host to determine if security is enabled. Check Batch Host and restart browser.
This error is observed when you:
Workaround:
|
|||||||||||||||||||||||||||||||||||
157908 |
When the BatchHistory database and Batch Management reports are in distributed nodes, Batch Management reports execution is failing with the error "An error has occurred during report processing. (rsProcessingAborted). Query execution failed for dataset 'BatchDetailData'. (rsErrorExecutingCommand). Login failed for user 'NT Authority\Anonymous Logon' ".
Workaround: To overcome this error, do the following.
|
|||||||||||||||||||||||||||||||||||
IMS 1700890 |
After upgrading Batch Management to the latest version and when you import the Batch model in IDE, the following error gets displayed: "Error in creating toolsets or templates Method not found".
Workaround: To overcome this error, do the following.
|
To view these Help files, download and install the viewer component from Microsoft at http://support.microsoft.com/kb/917607.
The AVEVA Batch Management online documentation is available on AVEVA Documentation.
The AVEVA Batch Management documentation set includes the following:
The AVEVA Batch Management product library consists of a set of Portable Document Files (PDF) located in the UserDocs folder of the AVEVA Batch Management installation CD. Install the Adobe Reader on your computer to view the AVEVA Batch Management documentation. You can download the latest version of the Adobe Reader from the Adobe Corporation web site:
www.adobe.com/products/acrobat/readstep2.htm
After installing the Adobe Reader, double-click a PDF file to view the book. Click the Open command on the File menu to open a book in the Adobe Reader.
The AVEVA Batch Management installation instructions are located in the root folder of the AVEVA Batch Management installation CD, as a .chm file. You can view these instructions by clicking the Help when you start the AVEVA Batch Management installation procedure.
The following messages are modified in the AVEVA Batch Management 2023 R2 release.
Resource Name |
Old Message |
New Message |
---|---|---|
IALink.csv |
||
rc57346 |
"I/A Series Linker Toolbar","I/A Series Linker Toolbar" |
"Foxboro DCS Linker (IALink) Toolbar","Foxboro DCS Linker (IALink) Toolbar" |
rc32772 |
"Generates automatic creation and linking of I/A Series tags to Model tags.\nGenerate","Generates automatic creation and linking of I/A Series tags to Model tags.\nGenerate" |
"Generates automatic creation and linking of Foxboro DCS tags to Model tags.\nGenerate","Generates automatic creation and linking of Foxboro DCS tags to Model tags.\nGenerate" |
msg11 |
"I/A Series tag","I/A Series tag" |
"Foxboro DCS tag","Foxboro DCS tag" |
msg180 |
"Error retrieving I/A Series tag information.","Error retrieving I/A Series tag information. |
"Error retrieving Foxboro DCS tag information.","Error retrieving Foxboro DCS tag information." |
msg209 |
"Invalid I/A Series tag","Invalid I/A Series tag" |
"Invalid Foxboro DCS tag","Invalid Foxboro DCS tag" |
msg384 |
"IA Linker configuration is valid.","IA Linker configuration is valid. |
"Foxboro DCS Linker (IALink) configuration is valid.","Foxboro DCS Linker (IALink) configuration is valid." |
rc129 |
"Generate I/A Series Tags","Generate I/A Series Tags" |
"Generate Foxboro DCS Tags","Generate Foxboro DCS Tags" |
menu&AboutIASeriesLinker… |
"&About I/A Series Linker...","&About I/A Series Linker..." |
"&About Foxboro DCS Linker (IALink)...","&About Foxboro DCS Linker (IALink)..." |
© 2015-2025 AVEVA Group Limited or its subsidiaries. All rights reserved. | Contact Us |