Last revision: 2/25/2022
This document contains important information about AVEVA Batch Management 2020 SP1 (v.12.5.1). 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 2020 SP1 (v.12.5.1) offers the following new features and enhancements:
Support has been added to update Phase Parameter Extension values at runtime.
Batch Objects now uses Float data type instead of Double data type.
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 Requirement
|
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) |
2 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 2020 SP1.
Operating System
|
Client Windows OS |
Server Windows OS |
.NET Framework |
Virtualization |
|||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
8.1 Professional, Enterprise (64-bit) |
10 Pro, Enterprise, and IoT Enterprise 1909, 2004 Pro, 20H2 Pro, 21H1 (64-bit) Semi-Annual Channel (SAC) |
10 Enterprise 2016 and IoT Enterprise 2016 LTSB Enterprise 2019 and IoT Enterprise 2019 LTSC Long-Term Servicing Channel (LTSC) |
11 Pro, Enterprise |
2012 Data Center |
2012 R2 Standard, Data Center, Embedded (Full image) (64-bit) |
2016 Standard, Data Center (64-bit) Long Term Servicing Channel (LTSC) |
2019 Standard, Data Center (Desktop Experience) (64-bit) Long Term Servicing Channel (LTSC) |
IoT 2016 LTSB |
IoT 2019 LTSC |
2022 Standard, Data Center (64-bit) |
3.5 SP1 |
4.7.2 |
4.8 |
Hyper-V shipped with supported version of Windows (Includes Gen1 and Gen2 VMs) |
VMWare VSphere 6.5 and newer (including HA/DR) |
VMWare Clients (including Horizon - App Virtualization) |
Cloud Virtualization - Azure |
VMWare Workstation 12.5.9 (Only) and 14.1.3 and newer |
|
AVEVA Batch Management Server
|
Y |
Y |
Y |
Y |
Y |
Y |
Y |
Y |
Y |
Y |
Y |
C |
Y |
Y |
Y |
Y |
Y |
Y |
Y |
AVEVA Batch Management Clients
|
Y |
Y |
Y |
Y |
Y |
Y |
Y |
Y |
Y |
Y |
Y |
C |
Y |
Y |
Y |
Y |
Y |
Y |
Y |
AVEVA Batch Management History Server
|
Y |
Y |
Y |
Y |
Y |
Y |
Y |
Y |
Y |
Y |
Y |
C |
Y |
Y |
Y |
Y |
Y |
Y |
Y |
Batch Management Reporting Content
|
Y |
Y |
Y |
Y |
Y |
Y |
Y |
Y |
Y |
Y |
Y |
C |
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 ArchestrA IDE" feature, see the software requirements for Application Server.
- For software requirements for the "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 |
Version 40.15063 and newer |
Google Chrome |
Version 72.0.3626 and newer* |
Firefox |
Version version 60.9 ESR and newer* |
Safari |
Version 11 and newer (Mac and iOS only) (Not Windows) |
* 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.
|
2012 Standard, Enterprise |
2014 Standard, Enterprise SP3 (32/64-bit) |
2016 Standard, Enterprise |
SQL 2017 Standard, Enterprise (+All Cumulative Updates) |
SQL 2019 Standard, Enterprise (+All Cumulative Updates) |
---|---|---|---|---|---|
AVEVA Batch Management Server |
N/A |
N/A |
N/A |
N/A |
N/A |
AVEVA Batch Management Clients |
N/A |
N/A |
N/A |
N/A |
N/A |
AVEVA Batch Management History Server |
Y |
Y |
Y |
Y |
Y |
AVEVA Batch Management Reporting Content |
Y |
Y |
Y |
Y |
Y |
Supported
|
Y |
SQL Database is not required for Batch Management Server and Clients |
N/A |
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.
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.
Otherwise, you might encounter the following issues:
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 |
CR - L00143794 |
When the product is upgraded from version 8.1 to version 11.5, the recipes become invalid in the later version because the Process instances are not available after the upgrade. |
CR - L00158955 |
The user is allowed to print a report with unsaved recipe in the Recipe Editor which may lead to security vulnerabilities. |
CR - L00159158 |
The Header is missing in each subsequent page of Procedure Reports generated from the Recipe Editor. |
CR - L00159209 |
When the product is upgraded from version 10.1 to version 12.1, and the Batch History database is moved to another server, the user cannot configure the Batch History server when restoring the Batch History database (version 10.1) on the same node, where SQL Server is Named Instance. |
CR - L00159650 |
After migration when the user re-issues a Batch Journal report on a Batch that took place before the migration, the information like User CheckBy, DoneBy in the Batch sequence does not appear. |
CR - L00159657 |
Cannot configure the Reporting content when a SQL Named Instance is configured for the Batch History server. |
CR - L00159972 |
When the product is upgraded from 10.1 to 12.1 some expressions do not evaluate. Transition gets triggered before assignment completes. |
CR - L00159976 |
The electronic signatures (e-sigs) are missing while performing Batch operations when the user enables security for those batch operations. |
IMS - 574128 |
Cannot add more than 7 digits after decimal for Input and Process Variables where decimal value range between >=-1 and <=1. |
IMS - 944232 |
Batch Management .NET controls in InTouch OMI application are not working from Batch Management client node. |
IMS - 946984 |
The Batch Manager stops or crashes. Also, the scheduled batch in Ready state starts unexpectedly without being set to Run state. |
IMS - 1202153 |
The system crashes due to memory issues with BatchMngr.exe (v12.5). |
IMS - 1398532 |
InBatch failover procedures are stuck with "hanging" clients because clients try to reconnect during the exit and shutdown requests. |
IMS - 1465025 |
The Date field is missing in the Material Input Report. |
IMS - 1407279 |
When upgrading the product from InBatch 2014 R2 to Batch Management 2020, switching the window in InTouch causes the view to crash due to Batch ocx while acquiring client license. |
This section describes important known issues.
Installation Issues
1213460 |
When you install Batch Management on a computer where System Platform 2017 is already installed, ArchestrA IDE is not able to connect to the pre-existing Galaxy or create a new Galaxy. Workaround: Do the following: In the Registry Editor, under the "HKEY_LOCAL_MACHINE\SYSTEM\ControlSet001\Services\aaGR\" location, delete the Key "DependOnService" which has the value "ArchestrADataStore32". Also, delete the Key "DependOnService" from the HKEY_LOCAL_MACHINE\SYSTEM\ControlSet002\Services\aaGR and HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\aaGR locations. Restart the machine. |
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 IA Series 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. |
Other Issues
1055512 |
Batch Management web client Icons and images are distorted in Mozilla Firefox browsers. Workaround: Do the following settings in the Firefox browser:
|
|||||||||||||||||||||||||||||||||||
455938 |
When you access the InBatch Reports using Internet Explorer 11, the user interface fields of the Reports header are not displayed correctly. Note: This issue is reported only on a system with SQL Server 2012. Workaround: To resolve this issue, add the target site to Compatibility View Settings in Internet Explorer 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 Wonderware InBatch development client.
Workaround:
|
|||||||||||||||||||||||||||||||||||
L00081552 |
Running Wonderware InBatch with IA components in a redundant configuration does not fail over when IADriver is shut down. The following table shows the redundancy status on master/backup nodes when IBMX, IBCli, and IADriver 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:
|
|||||||||||||||||||||||||||||||||||
1105212 |
Under the Usage Details tab in the Schneider Electric License Manager web page, the Device Name is displayed as:
|
|||||||||||||||||||||||||||||||||||
1105211 |
License refresh failed, and a valid client license could not be acquired from the license server. A warning message is logged in the SMC logger.
Workaround: Apply the License Server Hot Fix CR L00150512.
|
|||||||||||||||||||||||||||||||||||
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 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 2020 SP1 release.
Resource Name |
Message |
New/ |
Notes |
BatchDspl.csv |
|||
menu&Legal |
&Legal |
New |
|
BatchSched.csv |
|||
menu&Legal |
&Legal |
New |
|
BatchView.csv |
|||
menu&Legal |
&Legal |
New |
|
EnvDspl.csv |
|||
menu&Legal |
&Legal |
New |
|
EnvEdit.csv |
|||
menu&Legal |
&Legal |
New |
|
IALink.csv |
|||
menu&Legal |
&Legal |
New |
|
ImportExportUtil.csv |
|||
menu&Legal |
&Legal |
New |
|
LogEdit.csv |
|||
menu&Legal |
&Legal |
New |
|
MaterialEdit.csv |
|||
menu&Legal |
&Legal |
New |
|
ModelEdit.csv |
|||
menu&Legal |
&Legal |
New |
|
RecipeCompare.csv |
|||
menu&Legal |
&Legal |
New |
|
RecipeEdit.csv |
|||
menu&Legal |
&Legal |
New |
|
SecEdit.csv |
|||
menu&Legal |
&Legal |
New |
|
TagLinker.csv |
|||
menu&Legal |
&Legal |
New |
|
TrainEdit.csv |
|||
menu&Legal |
&Legal |
New |
|
BatchMngr.csv |
|||
msg418 |
Cannot update the Phase parameter as it has only Read access. |
New |
|
msg419 |
The value entered is invalid Enum value. |
New |
|
AdminWeb.csv |
|||
HtmlTitle |
AVEVA™ Batch Management History Server Administration |
Modified |
Old Value: AVEVA Batch Management History Server Administration |
HtmlHANavHeader |
AVEVA<span>™</span> Batch Management History Administration |
Modified |
Old Value: AVEVA Batch Management History Administration |
HtmlIBHisServerAdminError |
AVEVA<span>™</span> Batch Management History Server Administration Error |
Modified |
Old Value: AVEVA Batch Management History Server Administration Error |
HtmlCannotDisplayIBHisSerAdminPage |
The AVEVA<span>™</span> Batch Management History Server Administration web page cannot be displayed |
Modified |
Old Value: The AVEVA Batch Management History Server Administration web page cannot be displayed |
HtmlIBHisSerAdminErrMsg |
AVEVA<span>™</span> Batch Management History Server Administration - Error Message |
Modified |
Old Value: AVEVA Batch Management History Server Administration - Error Message |
HtmlIBHisSerAdminLogin |
AVEVA<span>™</span> Batch Management History Server Administration Login |
Modified |
Old Value: AVEVA Batch Management History Server Administration Login |
HtmlAppTitle |
AVEVA<span>™</span> Batch Management History Database Administration |
Modified |
Old Value: AVEVA Batch Management History Database Administration |
ReportWeb.csv |
|||
HtmlTitle |
AVEVA™ Batch Management Reports Administration |
Modified |
Old Value: AVEVA Batch Management Reports Administration |
HtmlInBatchReportsTitle |
AVEVA™ Batch Management Reports |
Modified |
Old Value: AVEVA Batch Management Reports |
HtmlReportWebLogin |
AVEVA<span>™</span> Batch Management Reports Administration Login |
Modified |
Old Value: AVEVA Batch Management Reports Administration Login |
HtmlAppTitle |
AVEVA<span>™</span> Batch Management Reports Administration |
Modified |
Old Value: AVEVA Batch Management Reports Administration |
HtmlInBatchReportsAppTitle |
AVEVA<span>™</span> Batch Management Reports |
Modified |
Old Value: AVEVA Batch Management Reports |
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. | Contact Us |