Wonderware InBatch 2012 (9.6)
Wonderware InBatch 2012 (Version 9.6) Readme
Last revision: 9/6/2012
About This Readme
This document contains important information about Wonderware® InBatch 2012 (version 9.6). Review this document for known issues and changes to the InBatch software and documentation included on this CD.
Important! Before upgrading your system, review the Installing Wonderware InBatch 9.6 section. |
Use the following links to the various sections of this Readme.
- Release Summary
- System Requirements
- Product Compatibility
- Licensing
- Installing Wonderware InBatch 9.6
- Resolved Issues
- Known Issues
- Known Issues – InBatch Documentation
- Updated Wonderware InBatch Documentation
NOTE: Readme files from previous releases of Wonderware InBatch software are posted to the Wonderware Developer Network at http://wdn.wonderware.com/Downloads.
Release Summary
Wonderware InBatch 9.6 offers the following new features and enhancements:
- Maintenance of Line product improvements by addressing issues reported by customers
- Support for VMware VSphere 5.0 advanced features High Availability (HA) and Disaster Recovery
- Includes previously released hot fixes
System Requirements
This section describes the hardware, software, and operating system required to install the Wonderware InBatch version 9.6 software.
- Hardware Requirements
- Software Requirements
- Database Requirements
- Operating System Requirements
- I/A Series Operating System Requirements
- I/A Series Additional Software Requirements
- Additional Software Requirements
- Wonderware InBatch Firewall Exceptions List
Hardware Requirements
Minimum Hardware Requirements
The following hardware is recommended to support Wonderware InBatch 9.6:
- Processor: 3.0 gigahertz (GHz) or faster processor
- RAM: 2 gigabyte (GB) of memory
- Hard disk: At least 4 GB of available disk space
- Video adapter and monitor with super VGA (1024 × 768) resolution or higher
- CD-ROM or DVD drive for installation
- Keyboard
- Mouse or compatible pointing device
See your specific Microsoft operating system hardware requirements for details.
| Operating Systems | Link to Microsoft Operating System Requirements |
| Windows Server 2003 R2 SP2 | http://technet.microsoft.com/en-us/library/cc756124(WS.10).aspx |
| Windows Server 2008 R2 SP1 | http://www.microsoft.com/windowsserver2008/en/us/system-requirements.aspx |
| Windows Server 2008 SP2 | http://technet.microsoft.com/en-us/library/dd540766(WS.10).aspx |
| Windows Vista SP2 | http://technet.microsoft.com/en-us/library/dd335032(WS.10).aspx |
| Windows XP Professional SP3 | http://windows.microsoft.com/en-us/windows/help/learn-how-to-install-windows-xp-service-pack-3-sp3 |
| Windows 7 SP1 | http://windows.microsoft.com/en-US/windows7/whats-included-in-windows-7-service-pack-1-sp1 |
Software Requirements
You must install Microsoft .NET Framework 3.5 SP1 before installing Wonderware InBatch 9.6. If this version of the .NET Framework is not installed on the computer, the Wonderware InBatch installation automatically installs it.
I/A Series, InFusion and Foxboro Control Software configurations are supported only on certain operating systems and platforms.
Restriction
- InBatch 9.6 is not supported on a single node running on Windows XP SP3. Windows XP SP3 32-bit does not support IIS 6.0, so the InBatch History Server feature cannot be installed.
Database Requirements
Microsoft SQL Server
| Version | Type |
Service Pack Level |
| Microsoft SQL Server 2005 | Standard or Enterprise Edition |
SP3 |
| Microsoft SQL Server 2008 | Standard or Enterprise Edition (32-bit only) |
SP1, SP3* |
| Microsoft SQL Server 2008 R2 | Standard or Enterprise Edition (32-bit only) |
- |
*Note: Check if other products that use the same Operating System as InBatch 9.6 are compatible with Microsoft SQL Server 2008 SP3.
Operating System Requirements
The following table lists the operating systems that are supported and can be installed on computers that run Wonderware InBatch:
Operating Systems |
Service Pack Level |
Wonderware InBatch Features |
||||||
Server |
Run-time Client |
Development Client |
History Server |
Reporting Content |
Redundant System |
|||
| Windows Server 2003 R2 Standard | 32-bit only | SP2 |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
| Windows Server 2003 R2 Enterprise | 32-bit only | SP2 |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
| Windows Server 2008 Standard | 32-bit & 64-bit | SP2 |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
| Windows Server 2008 Enterprise | 32-bit & 64-bit | SP2 |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
| Windows Server 2008 R2 Standard | 64-bit only | SP1* |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
| Windows Server 2008 R2 Enterprise | 64-bit only | SP1* |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
| Windows Vista Business | 32-bit & 64-bit | SP2 |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
| Windows Vista Enterprise | 32-bit & 64-bit | SP2 |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
| Windows Vista Ultimate | 32-bit & 64-bit | SP2 |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
| Windows XP Professional | 32-bit only | SP3 |
Yes |
Yes |
Yes |
No |
No |
Yes |
| Windows 7 Professional | 32-bit & 64-bit | SP1* |
No |
Yes |
Yes |
No |
Yes |
Clients only |
| Windows 7 Enterprise | 32-bit & 64-bit | SP1* |
No |
Yes |
Yes |
No |
Yes |
Clients only |
* - Supported with and without Service Pack
Notes:
I/A Series Operating System Requirements
The following table lists the I/A Series operating systems requirements for each station type:
Operating Systems |
Service Pack Level |
I/A Series and Foxboro Control Software Batch Station Type |
||||||
Server |
Run-time Client |
Development Client |
History Server |
Reporting Content |
Redundant System |
|||
| P90/P91 Windows Server 2003 R2 | 32-bit only | SP2 |
Yes |
Yes |
Yes |
Yes |
- |
Yes |
| P92 Windows XP | 32-bit only | SP3 |
Yes |
Yes |
Yes |
- |
- |
Yes |
Notes:
I/A Series Additional Software Requirements
The following table lists the additional software requirements of each station type for I/A Series:
Additional Software Requirements |
I/A Series and Foxboro Control Software Batch Station Type |
|||||
Server |
Run-time Client |
Development Client |
History Server |
Reporting Content |
Redundant System |
|
| Foxboro Control Software 3.1 |
Yes |
- |
- |
- |
- |
Yes |
| I/A Series Software 8.7 | Yes |
- |
- |
- |
- |
Yes |
| Foxboro Control Software 3.1 InFusion View | - |
Yes |
- |
- |
- |
- |
| Foxboro Control Software 3.1 IEE | - |
- |
Yes |
- |
- |
- |
| Internet Information Services (IIS) 6.0 or 7.0 | - |
- |
- |
Yes |
- |
- |
| Wonderware Information Server with ArchestrA Reports feature | - |
- |
- |
- |
Yes |
- |
If InBatch software is used without Foxboro Control Software, then AIMAT 3.4 is required.
Additional Software Requirements
The following table lists the additional typical software requirements for each InBatch station type:
Additional Software Requirements |
Wonderware InBatch Station Type |
|||||
Server |
Run-time Client |
Development Client |
History Server |
Reporting Content |
Redundant System |
|
| Wonderware Application Server bootstrap and IDE (only when integrating with System Platform and InFusion) |
Yes |
- |
Yes |
- |
- |
Yes |
| Wonderware InTouch 10.1 or higher | - |
Yes |
- |
- |
- |
- |
| Internet Information Services (IIS) 6.0 or 7.0 | - |
- |
- |
Yes |
- |
- |
| Wonderware Information Server with ArchestrA Reports feature | - |
- |
- |
- |
Yes |
- |
Wonderware InBatch Firewall Exceptions List
The following table lists the application names and their ports, that must be added in the Windows Firewall exceptions list for Wonderware InBatch:
Application Name |
Port Number |
BatchMngr | 9008 |
| EnvMngr | 9002 |
| InfoMngr | 9012 |
| HistQMngrvista | 9015 |
| HisQReader | 9016 |
| InBatch Middleware Access | 8199 |
| OLE Recipe Automation | 5001 |
| OLE Recipe Automation | 5002 |
| OLE Recipe Automation | 5003 |
| OLE Recipe Automation | 5004 |
| OLE Recipe Automation | 5005 |
| RedMngr | 9006 |
| RedMngrX | 9013 |
| RedMngrX2 | 9014 |
| SecMngr | 9004 |
| UnilinkMngr | 9007 |
| aaLogger.exe | - |
| RecipeEdit.exe | - |
| TagLinker.exe | - |
| MaterialSrv.exe | - |
Product Compatibility
Wonderware InBatch 9.6 is compatible and can co-exist with the following components. Compatibility means that the products can communicate with each other over the network. Co-existence means that the products can be installed on the same computer.
| Component | Version | Compatibility | Co-existence |
| ArchestrA® System Platform | 2012 | Y | Y |
| ArchestrA® Workflow | 1.1 and later | N/A | Y |
| Wonderware® Manufacturing Execution System (MES) | 4.0 SP2 and later | N/A | Y |
| Wonderware® InControl™ | 7.11 SP2 P01 | N/A | Y |
| Wonderware® QI Analyst™ | 8.0 SP2 | N/A | Y |
| Wonderware® Intelligence | 1.1 and later | N/A | Y |
| Foxboro® Control Software (using ArchestrA System Platform 2012) | 3.1 | Y | Y |
| I/A Series Software | 8.7 | Y | Y |
Licensing
Wonderware Component Licensing
Please contact your local Invensys Distributor or Sales representative for details about the licensing requirements for Wonderware components.
Microsoft Office Fluent UI Licensing
The 2007 Microsoft Office Fluent User Interface is subject to protection under U.S. and international intellectual property laws. The interface is used by Wonderware MES under the license from Microsoft.
Installing Wonderware InBatch 9.6
For installation and upgrade instructions, see the InBatch Installation Guide.
Upgrading to Wonderware InBatch 9.6 from the following versions is automatic:
- Wonderware InBatch 9.0
- Wonderware InBatch 9.5
- Wonderware InBatch 9.5 with SP1
The upgrade supports Wonderware InBatch with I/A components and without I/A components.
To upgrade from a version older than Wonderware InBatch 9.0, first uninstall the previous version and then install Wonderware InBatch 9.6.
After you upgrade Batch Reporting Content (from a pre-InBatch 9.0 SP2 version), a new report template called BatchJournal_EOB is available. The BatchJournal_EOB template is for an optimized Batch Journal report that is meant to be used with End of Batch report triggers. To schedule this report in Wonderware Information Server, you must manually redeploy the Batch Reports by using the Wonderware Information Server Report Deployment tool.
Note: If InBatch Server fails to start after being installed on the Windows XP SP3 operating system, you must restart the InBatch Server node.
If you are using InBatch IBMX with Wonderware Application Server 2012, you must install the following to solve tag write issues:
- Wonderware Application Server 3.5 Patch 01
- Wonderware Application Server Hotfix L00120158
- Wonderware Application Server Hotfix L00122616 (must be installed after L00120158)
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:
1. AddScheduleEntry
2. DeleteScheduleEntry
3. 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.
To upgrade platforms that use the InBatch Stateless API
Any code or scripting that is using the AddScheduleEntry, DeleteScheduleEntry,and InitializeScheduleEntry methods will need to be modified. The following are the upgrade instructions:
- The InBatch upgrade needs to be run on all InBatch Runtime Client and Batch Server systems. This includes any WAS platforms that have InBatch API scripting deployed and running.
- Before running the InBatch upgrade, it is best to undeploy all WAS platforms that are deployed to a Batch Runtime Client or Batch Server.
- Install the InBatch upgrade and re-import the InBatch API DLL's into the Galaxy (see InBatch API Help file for details of importing DLL's).
- The upgrade may break existing scripts functionality. Verify future Known Issues in the InBatch 9.6 Documentation section for changes in scripting that may be required for the scripts to work.
- Redeploy all platforms, engines, and objects as needed.
Resolved Issues
This section describes important resolved issues.
| L00119348: | (HotFix L00119899) SR 24910022: The BatchHook interface equipment functions are not receiving correct values for wwAllocate and wwRelease. |
||
| L00119613: | (HotFix L00119899) SR 24910023: Batch Manager should have the ability to disable the refresh of warm restart tags. |
||
| L00119733: | SR 24910024: The InBatch Env Display stops responding when application level security is enabled. |
||
| L00119754: | (HotFix L00119899) SR 24910029: Equipment status is considered as available even if unit status tag has bad quality. |
||
| L00119786: | (HotFix L00119899) SR 24910031: IBMX must handle transient bad quality when making a request. |
||
| L00119830: | (HotFix L00119899) SR 24910031: Add an option to BatchMngr to put all parameter tags on advise at the beginning of a phase. |
||
| L00119834: | (HotFix L00119899) SR 24910032: InBatch can advise/unadvise tags too quickly for OPC Servers (and possibly others) to finish the request and get into a good state. This can cause the OPC Server cache to be in an unexpected state the next time a point is activated. |
||
| L00119836: | (HotFix L00119899) SR 24910030: IBMX currently ignores Initializing quality (0x20). If a status tag gets stuck in Initializing during BatchMngr startup on a Status tag read request, it can cause the read to wait indefinitely and BatchMngr does not start. |
||
| L00120621: | (HotFix L00120888) SR 24910044: BatchMngr stops responding while evaluating manually selected equipment. |
||
| L00120682: | (HotFix L00120888) SR 24910037: The InBatch Manual Equipment Selection list behavior for Units added and removed is sometimes incorrect. For example, after changes to unit status. |
||
| L00121009: | (HotFix L00121003) SR 19911872: the Status property in the BOBatch object is not being updated by the Batch Hooks API. |
||
| L00121133: | If a control button is used and set at the same time a phase is completing, BatchMngr stops responding. |
||
| L00121761: | (HotFix L00121499) SR 24910048: HistQReader logs duplicate "Executing SQL" trace instead of "Deleting from ErrorQ". |
||
| L00121762: | (HotFix L00119923) SR 24910034: HistQReader goes into an infinite loop. Although HistQReader is running, HistQDB reaches the size limit and InBatch is shut down. |
Known Issues
This section describes important known issues.
Known Issues – Documentation
The following table lists the known issues in the product documentation:
Item |
Location of Change |
Existing Documentation |
Change |
InBatch Stateless API Reference Guide | Under InBatch.API Namespace / Classes / Schedule / Methods, see the following 3 API calls: 1. AddScheduleEntry |
Missing |
The following InBatch Stateless API methods have been modified to include DoneBy and CheckBy (DoneBy, DoneByPswd, CheckBy, CheckByPswd) arguments: 1. AddScheduleEntry These methods use the security set for Access Schedule method. Use the security authentication set required for Access Schedule method of the Batch Client application. The following description provides an overview of the methods: This method adds a new entry to the schedule, following the previous entry, for the given CLB (Campaign, Lot, Batch). If there is no entry in the schedule, the new entry is added to the beginning of the schedule. It may require DoneBy and CheckBy parameters, if security is enabled for the AddScheduleEntry functionality. Syntax: InBatch.API.Schedule.AddScheduleEntry (previousCampaign, previousLot, previousBatch, campaign, lot, batch, recipe, train, size, mode, doneById, doneByPassword, checkById, checkByPassword); This method deletes the schedule entry with Open, Done, or Aborted status for the given CLB. It may require DoneBy and CheckBy parameters, if security is enabled for the DeleteScheduleEntry functionality. Syntax: InBatch.API.Schedule.DeleteScheduleEntry (campaign, lot, batch, doneById, doneByPassword, checkById, checkByPassword); This method initializes schedule entry for the given CLB. It may require DoneBy and CheckBy parameters, if security is enabled for the InitializeScheduleEntry functionality. Syntax: InBatch.API.Schedule.InitializeScheduleEntry (campaign, lot, batch, doneById, doneByPassword, checkById, checkByPassword); For upgrading instructions, see Installing Wonderware InBatch 9.6. |
InBatch User's Guide | Missing |
The Batch Display, Batch Schedule, and Batch View methods can take two host names for the -A command line parameter, separated by a semicolon (;). For example: |
|
InBatch Installation Guide | "Uninstalling InBatch" chapter, introductory paragraph | Missing |
Back up the ConfigA folder before uninstalling the InBatch software. |
InBatch User's Guide | "Application Parameter Descriptions" section | Missing |
All options must be manually entered in the EnvEdit parameter editor using the New button. IBMX b = Quality Timeout. The number of seconds to wait for good quality when an initial bad quality is received. After a request has received good quality, any change to bad quality will be reported. This parameter requires a value. Default is 10 seconds. w = Lazy Unadvise. The number of seconds to wait before unadvising a tag when it no longer needs to be advised. This is not needed if you are using the AdviseAll option. This parameter requires a value. Default is disabled. u = Startup UnAdvise Delay. The number of seconds (plus Response Timeout seconds) after IBMX starts where Status tags will remain advised. BatchMngr needs to be started and running within this time period; otherwise, startup can be considerably slower. This parameter requires a value. Default is 120 seconds. t = Response Timeout. The number of seconds to wait for an ACK or NAK from Wonderware Application Server before reporting an error to the InBatch software. This parameter requires a value. Default is 20 seconds. BatchMngr z = AdviseParams. Causes BatchMngr to advise parameter tags while a phase is running, so that when it reads the parameters at the end of the phase, the values in the caches will be fresh. This option does not require a value. t = No System Tag Write. Causes BatchMngr to not write system tags from a warm restart at startup. This option does not require a value. |
Wonderware InBatch Documentation
The Wonderware InBatch documentation set includes the following:
- Wonderware InBatch Installation Guide - Provides information about upgrading from the previous InBatch versions to InBatch 9.6.
- Wonderware InBatch User Guide - Provides information about the new features and enhancements.
- Wonderware InBatch COM Technical Reference Guide - This guide describes using the InBatch COM technology and provides practical examples of its use.
- Wonderware InBatch Stateless API Online Reference - Provides information about the new stateless API supported by the Batch Server.
- ReadMe (This document) - Provides information about software and hardware requirements, known issues, licensing, and documentation updates.
The Wonderware InBatch product
library consists of a set of Portable Document Files (PDF) located in the
Docs folder of the Wonderware InBatch installation CD. Install the Adobe Reader on your computer to view the Wonderware InBatch 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 Wonderware InBatch installation
instructions are located in the root folder of the
Wonderware InBatch installation CD, as a .chm file. You can
view these instructions by clicking the Help when you start the Wonderware InBatch installation procedure.
© 2012 Invensys Systems, Inc. All Rights Reserved.
