AVEVA Batch Management 2023 Readme

Last revision: 5/11/2023

This document contains important information about AVEVA Batch Management 2023 (v13.0). 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.

In This Document

Release Summary

Minimum System Requirements

How to Find the Latest Product Requirements and Compatibility Information

Licensing

Installing AVEVA Batch Management 2023

Resolved Issues

Known Issues

Known Issues - Documentation

AVEVA Batch Management Documentation

Resource File

Release Summary

AVEVA Batch Management 2023 (v13.0) offers the following new features and enhancements:

Minimum System Requirements

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

  • CD-ROM or DVD-ROM drive for installation
  • Keyboard
  • Mouse or compatible pointing device

     

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.

Operating System

 

Client

Windows OS (64-bit)

Server

Windows OS

.NET Framework

 

Virtualization

 

 

 

10 (Semi-Annual Channel)

Pro, Enterprise, and IoT Enterprise

20H2, 21H1, 21H2

10 (Long Term Servicing Channel)

Enterprise, IoT Enterprise

2019 (1809), 2021 (21H2)

 

11 (Semi-Annual Channel)

Pro, Enterprise, and IoT Enterprise

21H2, 22H2

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

4.8

5.0

6.0

7.0
(Nov 2022)

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

C

C

C

Y

Y

Y

Y

Y

Y

Y

Y

AVEVA Batch Management Clients

 

Y

Y

Y

Y

Y

Y

 

Y

C

C

C

Y

Y

Y

Y

Y

Y

Y

Y

AVEVA Batch Management History Server

 

Y

Y

Y

Y

Y

Y

 

Y

C

C

C

Y

Y

Y

Y

Y

Y

Y

Y

AVEVA Batch Management Reporting Content

 

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.

 

SQL 2016

Express (SSME), Standard, Enterprise
(SP3, SP3 + All Cumulative Updates)

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

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

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:

How to Find the Latest Product Requirements and Compatibility Information

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.

Licensing

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.

Installing AVEVA Batch Management 2023

Special Notes

Installing or Upgrading

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.

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.

Resolved Issues

This section describes resolved issues listed by their Defect ID (CR or IMS number).

Defect ID

Description

IMS 1313762

The value of some process parameters having double datatype is displayed as "-1.#QNAN00" in exported Recipe XML file.

IMS 1425183

French OS installation has incoherent entries in the Batch History and generates Datetime errors in the errorq table.

IMS 1775869

The method GetRecipeApprovals() creates Scriptruntime error: masterrecipeCheck_001.CheckRecipes: Type mismatch. (Exception from HRESULT: 0x80020005 (DISP_E_TYPEMISMATCH)) in WWLogger.

IMS 1925607

After Migration, the Danish settings (delimiter ",") results in cryptic char in the Model Editor and values in RecipeEditor are empty.

IMS 1929642

Security Clearance Request Popup shows strange/empty characters on popup elements (Action, UserID, Password, eccc..) during runtime.

IMS 2177718

AVEVA InTouch OMI crashes when SFC App is displayed and logs the message "THREAD WARNING: SFC on different thread".

IMS 2220116

AVEVA InTouch OMI application crashes due to multi-node connection failure from AVEVA InTouch OMI to AVEVA Batch Management Server by using .Net GUI controls.

IMS 2264669

Engineering-Units are missing for phases parameters after importing Batch model into the galaxy.

IMS 2431786

When the Batch Journal report is printed as a PDF, the error message appears as "Error: sub-report could not be shown".

Known Issues

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 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:

  1. Open the Registry Editor.
  2. Navigate down to [HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\Memory Management].

    If a registry value named 'SessionViewSize' exists, ensure that it is at least 30 (hex) or 48 (decimal).

    If it does not exist, create a new DWORD value named 'SessionViewSize' and set it to 30 (hex) or 48 (decimal).

L00127339

Machine names in redundant systems must be 12 characters or less.

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:

  1. Open the Firefox browser.
  2. Navigate to Options > General.
  3. Under the Performance option, clear the Use recommended performance settings and Use hardware acceleration when available check boxes.
  4. Restart the 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:

  1. Browse to the Directory where reporting services is installed.

    For example: C:\Program Files\Microsoft SQL Server\MSRS11.MSSQLSERVER\Reporting Services\ReportServer.

  2. Open the file named reportserver.config.
  3. Insert the following line in the document:

    <Configuration >

    .......

    <HTMLViewerStyleSheet > SafariChromeFix </HTMLViewerStyleSheet>

    .......

    </Configuration >

  4. Save the file.
  5. Navigate to C:\Program Files\Microsoft SQL Server\MSRS11.MSSQLSERVER\Reporting Services\ReportServer\Styles directory.
  6. Make a copy of the file named SP_Full.css, and name the copy SafariChromeFix.css.
  7. Update the following lines to the top in the SafariChromeFix.css file:

    div { overflow: visible !important; }

  8. Save and close the file.

    All the existing reports on this instance of Reporting Services are displayed on all browsers including Chrome and Safari.

     

    Note: The reportserver.config may be overwritten with updates to reporting services. In such cases, add the <HTMLViewerStyleSheet > SafariChromeFix </HTMLViewerStyleSheet> tag into the config file every time.

     

L00077400

Editors are not opening on the AVEVA Batch Management development client.

 

Workaround:

  1. Open a Microsoft Windows Explorer page.
  2. Navigate to C:\Programs\Wonderware\Wonderware InBatch\cfg\Config_A.
  3. Right-click the file vista.taf, and then select Delete.

     

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.

 

 

IBMX

IBCli

IADriver

Action on the Master Node

Master Node Status

Backup Node Status

Master Node Status

Backup Node Status

Master Node Status

Backup Node Status

End process from Task Manager
(Correct Failover)

Master failed

Master with invalid backup

Master failed

Master with invalid backup

Master failed

Master with invalid backup

Stopped from Runtime Services
(Non-Failover)

Master with valid backup

Valid backup

Master with valid backup

Valid backup

Master with valid backup

Valid backup

 

 

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.

 

  1. Update the RptServicesConfig.xml file in the following location:

    <systemdrive>:\Inetpub\wwwroot\ReportWeb\ReportConfig

  2. Open the file RptServicesConfig.xml for editing.
  3. Add the following line under the <Reports> node:

    <Report Name="Custom Batch Detail" file="CustomBatchDetail.rdl" description="My Custom Report" />

  4. Save the file.

    Now the report named Custom Batch Detail is available for configuring and scheduling. Add a similar line for each custom report that is populated in the Execute Reports 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:

  • Too many ping timeouts (NOTE: only if you get this error repeatedly).
  • Failed to register 'Watchdog' ping tag - pinging is disabled.

    Do one of the following:

  • Try to upgrade to a newer I/O Server or DAServer version.
  • Create a tag called Watchdog in the I/O or DAServer. The tag can be of any data type.
  • Disable pinging using the IBCli Disable Ping option.

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:

  1. Create a new folder and name it (E.g. Test). Ensure that the folder name is not Config_A.
  2. Copy the contents of the Config_A folder to the new folder.
  3. Run cvtmaster, directing it to the new folder.
  4. Copy the database from the new folder to the Config_A folder.

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

 

  • In the Citect Design window, the application crashes when the 'InBatchGUIConfig' control is inserted prior to inserting the 'InBatchSFC' control on the same page.

    Workaround: The 'InBatchSFC' control must be inserted prior to the 'InBatchGUIConfig' control on the page/symbol.

  • Font size cannot be changed on any of the Batch ActiveX controls in Vijeo Citect.
  • An error message is displayed on the Control Area when you hold the InBatch Field ActiveX controls and drag them to a different location on page, during design time.
  • Tooltip does not get displayed on the Batch ActiveX controls at runtime.

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:

  1. Install and configure Batch Management Server on Node #1.
  2. Install and configure Batch Management History and Reports on Node #2.
  3. Launch Environment Display on Node #1.
  4. Launch History Admin page or Report Web page on Node #2.

 

Workaround:

  1. Launch Internet Explorer on Node #2.
  2. Under Tools, select Internet Options.

    The Internet Options dialog box appears.

  3. Click the Security tab and then select Trusted sites.
  4. Under Security level for this zone, click Custom level.

    The Security Settings – Local Intranet Zone dialog box appears.

  5. Under User Authentication > Logon, ensure that the Automatic logon with current user name and password option is selected.

     

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.

  1. On the node where the Batch Management reports are configured, navigate to the SSRS Reports page.
  1. Open the Batch Management Reports folder and then click the ibReports data source.

    The ibReports data source Configuration Settings page appears.

  2. Select the Credentials stored securely in the report server option for Connect using.
  3. Provide the credentials of the user who has access to the ‘BatchHistory’ database.
  4. Click Test Connection to check if the provided user details have access.
  5. Once the connection succeeds, click Apply to save configuration settings.
  6. Execute the Batch Management reports from the Reports node and any other remote node where the Reports feature is not configured.
  7. Ensure that reports are executed successfully without any issues.

     

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.

  1. Close IDE.
  2. Restart the' ArchestrA GalaxyRepository' service from the System Services window.
  3. Launch IDE and import the Batch Management Model.

     

Known Issues - Documentation

AVEVA Batch Management 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.

Resource File

The following messages are modified in the AVEVA Batch Management 2023 release.

Resource Name

Message

New/
Removed

SupervisorClient.csv

ErrAddUserToModel

Add user [{0}] to Batch Management security model and try again.

Removed

ErrAddUserToModelOpStation

Add the user to Batch Management security model with authorization for Operator Station [{0}] and try again.

New

 

© 2023 AVEVA Group Limited and its subsidiaries. All rights reserved.   |   Contact Us