Wonderware InBatch 2014 R3 (11.5)
Wonderware InBatch 2014 R3 (v.11.5) Readme
Last revision:04/27/2016
About This Readme
This document contains important information about Wonderware® InBatch™ 2014 R3 (v.11.5). Review this document for known issues and changes to the Wonderware InBatch software and documentation included on this CD.
Important! Before upgrading your system, review the Installing Wonderware InBatch 2014 R3 section. |
- Release Summary
- Minimum System Requirements
- Product Compatibility
- Licensing
- Installing Wonderware InBatch 2014 R3
- Resolved Issues
- Known Issues
- Known Issues – Documentation
- Wonderware InBatch Documentation
- Resource File
- Use of Material Design Lite
NOTE: Readme files from previous releases of Wonderware InBatch software are posted to the Wonderware Knowledge & Support Center at https://softwaresupportsp.invensys.com/Pages/ProductHub.aspx.
Release Summary
Wonderware InBatch 2014 R3 (v.11.5) offers the following new features and enhancements:
- InBatch Reports are now independent of Wonderware Information Server.
- InBatch Reports are made available through Microsoft SQL Server Reporting Services (SSRS).
- Provides support for SQL Named Instances on supported SQL versions.
- Provides support for SQL Express Edition on supported SQL versions (For application development only).
- Provides support for Phase tagname delimiter that allows the Alarm report to work with A2ALMDB and WWALMDB.
- New and enhanced look and feel for the InBatch Reporting content.
- Fixes to several issues reported by customers.
Minimum System Requirements
This section describes the hardware, software, and operating system required to install Wonderware InBatch 2014 R3 software.
- Hardware Requirements
- Operating System Requirements
- Browser Requirements
- Microsoft SQL Server Requirements
- Additional Software Requirements
- Wonderware InBatch Firewall Exceptions List
Hardware Requirements
The following hardware is recommended to support Wonderware InBatch 2014 R3 Client and Server installations:
| Requirement | Client | Server |
| Processor | 1.8 gigahertz (GHz) | 2.8 gigahertz (GHz) |
| Processor Cores | 2 | 4 |
| RAM | 2 gigabytes (GB) | 8 gigabytes (GB) |
| Hard Disk | 30 GB available | 500 GB available |
| Video Adapter / Monitor Capability | 1280 x 1024 resolution | 1024 x 768 resolution |
| Network Speed (MBps) | 1000 | 1000 |
| 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 Wonderware InBatch 2014 R3.
| Client Windows OS |
Server Windows OS |
.NET Framework |
Virtualization | ||||||||||
| 7 SP1 Professional, Enterprise, Ultimate (32/64-bit) |
8 Professional, Enterprise (32/64-bit) |
8.1 Professional, Enterprise (32/64-bit) |
10 Professional and Enterprise Standard, Enterprise (64-bit) |
2008 R2 SP1 Standard, Enterprise (64-bit) |
2012 Standard, Data Center (64-bit) |
2012 R2 Standard, Data Center (64-bit) |
3.5 SP1 | 4.5.2 | Hyper-V (Based on Supported OS version) |
VMWare 6.0 Update 1 (including HA/DR*) |
VMWare Workstation 7.x, 8.x |
||
| Wonderware InBatch Server | N | N | N | N | Y | Y | Y | C | Y | Y | Y | Y | |
| Wonderware InBatch Clients | Y | Y | Y | Y | Y | Y | Y | C | Y | Y | Y | Y | |
| Wonderware InBatch History Server | N | N | N | N | Y | Y | Y | C | Y | Y | Y | Y | |
| Wonderware InBatch Reporting Content | Y | Y | Y | Y | Y | Y | Y | C | Y | Y | Y | Y | |
| Supported | Y |
| Not Supported | N |
| Coexist | C |
Notes:
- For software requirements for the "Wonderware InBatch Components for ArchestrA IDE/IEE" feature, see the software requirements for Wonderware Application Server.
- For software requirements for the "Wonderware InBatch Reporting Content" feature, see the software requirements for Microsoft SQL Server.
- If a supported version of the Microsoft .NET Framework is not installed, the Wonderware InBatch installation automatically installs it.
Browser Requirements
| Browser | Version |
| Internet Explorer | Version 10 or later on the Windows operating system* |
| Microsoft Edge | Version 20 |
| Chrome | Version 47 or later on the Windows operating system* |
| Firefox | Version 44 or later on the Windows operating system* |
* Unless later versions of browsers deprecate the user interfaces used by InBatch Reporting system.
Microsoft SQL Server Requirements
The following table lists the SQL Server requirements:
| 2008 R2 SP1 (32/64 bit) | 2008 R2 SP2 Standard, Enterprise (32/64 bit) | 2012 Standard, Enterprise (32/64 bit) | 2012 SP2 Express-SSMSE (32/64 bit) | 2012 SP1 Standard, Enterprise (32/64 bit) | 2012 SP2 Standard, Enterprise (32/64 bit) | 2014 Standard, Enterprise (32/64 bit) | 2014 SP1 Express-SSME (32/64 bit) | |
| Wonderware InBatch Server | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A |
| Wonderware InBatch Clients | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A |
| Wonderware InBatch History Server | Y | Y | Y | Y* | Y | Y | Y | Y* |
| Wonderware InBatch Reporting Content | Y | Y | Y | Y* | Y | Y | Y | Y* |
| Supported | Y |
| Not Supported | N |
* History Archive, Purge, and Restore will not work with SQL Express. Reporting only works with Express with Advanced Services and Reporting Scheduling Capabilities will not be available.
Additional Software Requirements
The following table lists the additional typical software requirements for each Wonderware InBatch station type when the Wonderware InBatch software is used with Wonderware System Platform:
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 |
Yes |
- |
Yes |
- |
- |
Yes |
| Wonderware InTouch | - |
Yes |
- |
- |
- |
- |
Wonderware InBatch Firewall Exceptions List
The following table lists the application names and 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 |
| Wonderware 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 |
Product Compatibility
Wonderware InBatch 2014 R3 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 |
| Wonderware® System Platform* | |||
| 2014 R2 SP1 | Y | Y | |
| 2014 R2 P01 | Y | Y | |
| 2014 R2 | Y | Y | |
| ArchestrA® System Platform | |||
| 2012 R2 | N | N | |
| 2012 | N | N | |
| Wonderware® ASB Framework | |||
| 4.0.0.13000 | Y | Y | |
| Wonderware® InTouch® CE | 10.1 | N | N |
| Wonderware® Manufacturing Execution System | |||
| 2014 SP1 (v5.0.1) | N/A | Y | |
| 2014 (v5.0) | N/A | Y | |
| 2012 p01 (4.5 P01) | N/A | Y | |
| 4.0 SP2 | N/A | Y | |
| 4.0 SP1 | N/A | N | |
| Wonderware® Manufacturing Execution Module | 1.0 | N/A | N |
| Wonderware® QI Analyst™ | |||
| 8.0 SP3 | N/A | Y | |
| 8.0 SP2 | N/A | Y | |
| 8.0 SP1 P01 | N/A | N | |
| Wonderware® Intelligence™ | |||
| 2014 R2 P1 (v2.0 P1) | Y | Y | |
| 2012 (v1.5.100) | Y | Y | |
| 1.5 | N | N | |
| ArchestrA® Workflow™ | 2012 R2 SP1 | N/A | Y |
| Wonderware® Skelta BPM™ | |||
| 2014 R2 SP2 (v4.3) | N/A | Y | |
| 2014 R2 (v4.1) | N/A | Y | |
| 2014 (v4.0) | N/A | Y | |
| Wonderware® Production Execution Module | 2.1 SP1 | N/A | Y |
| Foxboro® Evo | 2014 | Y | Y |
| Foxboro® Control System | |||
| 6.0 (and all Quick Fixes) | N | N | |
| 5.0 (and all Quick Fixes) | N | N | |
| 4.0 (and all Quick Fixes) | N | N | |
| Foxboro® Evo Control Core Services | |||
| 9.2 | Y | Y | 9.1 | Y | Y |
| 9.0 | Y | Y | |
| Foxboro® I/A Series Software | |||
| 8.8 | Y | Y | |
| 8.7 (Windows XP, Windows 2003) | Y | Y |
| Supported | Y |
| Not Supported | N |
| Products do not share data directly, but can coexist. | N/A |
* Previously called ArchestrA System Platform
In some cases, the Wonderware InBatch software is supported in newer environments than a compatible product. Wonderware InBatch software has been tested for compatibility with a listed product only in the environments that are supported by that particular product.
For compatibility information regarding Wonderware InBatch 2014 R3 and Foxboro Control Software 6.0, contact your Schneider Electric sales representative.
Licensing
Wonderware Component Licensing
Please contact your local Schneider Electric Distributor or Sales representative for details about the licensing requirements for Wonderware components.
Wonderware InBatch 2014 R3 supports Archestra.lic license files. Archestra.lic format licenses work with Wonderware InBatch 2012 R2 and later.
Installing Wonderware InBatch 2014 R3
Special Notes
- Before upgrading, please take note of the known issues in the Installation Issues section of this document.
Before installing InBatch 2014 R3 (v 11.5) on a node with WSP 2014 R2 SP1, you must install WSP 2014 R2 SP1 GRAccess HotFix CR L00140512.
Otherwise, you might encounter the following issues:
- Error while Galaxy browsing from TagLinker
- ArchestrA security will not work if enabled in Security editor.
- Note: Prior to upgrading, confirm that your Hist Queue and Error Queue are empty. Because of changes to the Wonderware InBatch 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.
- Starting with 11.5, InBatch History Server and Reporting Content no longer integrate with Wonderware Information Server. These features are now available through Start Menu shortcuts. See the install and user guides for more details.
- Follow this installation order if you are installing System Platform 2012 or later on the Batch Server node with a custom Wonderware Application Server installation location:
- Install Application Server
- Install Wonderware InBatch
Installing or Upgrading
For installation and upgrade instructions, see the Wonderware InBatch Installation Guide and the Installation Issues section of this document.
Upgrading the software from the versions listed below only requires running the Setup.exe:
- Wonderware InBatch 9.0
- Wonderware InBatch 9.0 with SP1, and SP2
- Wonderware InBatch 9.5
- Wonderware InBatch 9.5 with SP1
- Wonderware InBatch 9.6
- Wonderware InBatch 2012 R2 (10.0)
- Wonderware InBatch 2014 (10.1)
- Wonderware InBatch 2014 R2 (10.2)
- Wonderware InBatch 2014 R2 SP1 (11)
The process will upgrade all components as required.
The following is a list of important points that you must note during the upgrade process.
-
Once the upgrade process is completed, you have to run the CVTMaster.exe utility to upgrade the application databases.
-
When you upgrade from previous versions of InBatch to InBatch 2014 R3 , all the InBatch links from Wonderware Information Server database are removed. You can verify the NavNode, NavRole, NavPanelNode tables from where all InBatch related rows must be removed. The .rdl template files are also removed from the ArchestrA\InBatch Reports folder and are now deployed in the InBatch Reports folder in the Reporting service URL.
-
Users can access the reports from the standard Reporting Services URL or the shortcut menu available in the InBatch folder. The reports will not be available from the Wonderware Information Server. Also, the History Database Administration and Reports Administration web pages now have their own shortcut menu and is available in the InBatch folder.
-
If you have created custom reports and want to convert them to InBatch v11.5, no longer rely on Wonderware Information Server. For more information, see the Wonderware InBatch Custom Report Update Guide (InBatchCustRepGuide.pdf).
-
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 2014 R3.
-
When you upgrade InBatch from an earlier version to InBatch v11.5, the .CSV message files available at "C:\Program Files\Wonderware\InBatch\Messages" are backed up and are placed at the same location: "C:\Program Files\Wonderware\InBatch\Messages".
Any new .CSV files are also added to the following folder: "C:\Program Files\Wonderware\InBatch\Messages\English".
- You need to manually update or copy the resources files to be able to get the correct messages after upgrade from InBatch 11.0. If you have not manually updated the resource files in InBatch v11.0, then you should copy all the resource files. For more information on the list of updated messages in the resource files, refer to the Resource File section.
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 important resolved issues.
| L00137252: | Random BatchMngr issues are encountered and the BatchMngr is crashing. To prevent BatchMngr from crashing, the system now catches the exception and display a message in the SMC logger. |
| L00137542: | (HotFix L00140389): When you migrated from InBatch Premier 8.1 to InBatch 10.2 (2014 R2), expressions used for Group defined in Process Logger Group editor are not converted correctly. The expressions still have dash(-) in place of dot(.). The issue is resolved. |
| L00137575: | IADriver needs extended logging added to so that customer can see the Tag read writes in the SMC like IBCLI and IBMX for debugging when the phase control bit get out of sync with InBatch. To view the Tag updates trace messages, click to select the Trace log flag option available in SMC Logger for IADriver by navigating Action -> LogFlags -> IADriver -> Trace . |
| L00137581: | Error encountered while configuring the InBatch History Server. |
| L00138508: | When user uses Czech Republic region and language settings while working with the the Archive, Purge and Restore jobs in Windows server 2012R2. Date validation logic fails and an error message is displayed. The default date display space after the date separator. This issue is resolved. |
| L00138620: | InBatch GUI .Net List Controls crashes if keyboard arrows is used to move up/down in the list. |
| L00138628: | Issue related to Tooltips in the InBatch GUI .Net Controls is resolved. |
| L00138854: | Sync Validate and Phase sync button in Recipe Editor over writing values and displays UOM error. The issue is resolved. |
| L00138966: | Opening multiple Batch views from Batch Scheduler crashes the Batch View after you reach a limit. |
| L00138979: | Working with the Recipe Compare feature when using the Recipe Compare API throws errors when executed. |
| L00139154: | Recipe with long names are not displayed correctly in the Recipe Editor. |
| L00139745, L00138604: | Editing parameters values in Phase Parameters tab of Recipe Editor sometime affects the non-edited Phase Parameters after saving the changes. This issue is resolved. |
| L00139858: | When the batch is running and if the parameter target value is manually edited, then this change will be logged in the BatchHistory database even if the old target and the new target values are the same. |
| L00140007: | Valid administrative account on domain fails in Configurator while working access the InBatch Reporting Content - Service DB Access Account. This issue is resolved now. |
| L00140021: | (HotFix L00140222): BatchNativeSec is not working if UAC is enabled in Registry. |
| L00140139: | (HotFix L00139985): UnilinkMngr crashes when you start/stop quickly and also not all the data response/update does not come into unilinkMngr (from IBMX, IBCli, etc.). This issue is resloved now. |
| L00140153: | InBatch User ID Timeout option for retaining ID in security prompt does not work in Operating System and ArchestrA security modes. |
| L00140379: | Issue is resolved for Recipe Editor crash when trying to save a recipe with the following error: BatchNativeSec "Native Get User Name failed. The RPC server is unavailable. [1722]. |
| L00140386: | InBatch StatelessAPI, InBatchCommon.BatchRuntimeStatusTypes. AllRuntimeServicesExceptInBatchTag Enumeration is working without any issues. A new sample example is added in the Stateless API help file. |
| L00140387: | RecipeEditor crashes while launching it from Environment Display. |
| L00140674: | Working with the OcxBatch.ScheduleSchedGetItem & BatchSchedGetItem and AllocQueueGetItem methods caused errors when processing the data. This issue is resolved now. |
| L00140690: | Recipe validate not working when the parameter value is updated to 0. |
Known Issues
This section describes important known issues.
Known Issues – Documentation
Wonderware InBatch Documentation
The Wonderware InBatch documentation set includes the following:
- ReadMe (This document) - Provides information about software and hardware requirements, known issues, licensing, and documentation updates.
- Wonderware InBatch Installation Guide - Provides information about installation and upgrading from the previous Wonderware InBatch versions.
- Wonderware InBatch Getting Started Guide - Describes the basic components of the Wonderware InBatch software and provides a tutorial to help you get started using the product.
- Wonderware InBatch Demo Guide - Describes a demo application that shows you how to use some of the new features in the Wonderware InBatch 2014 release.
- Wonderware InBatch User's Guide - Describes the components of the Wonderware InBatch software and how to use them to create applications.
- Wonderware InBatch Stateless API Online Reference - Provides information about the stateless API supported by the Batch Server.
- Wonderware InBatch COM Technical Reference Guide - Describes using the Wonderware InBatch COM technology and provides practical examples of its use.
- Wonderware InBatch Application Object Editor Help - Provides information about the Wonderware InBatchUnit, Wonderware InBatchConnection, Wonderware InBatchPhase, and Wonderware InBatchSegment objects.
- Wonderware InBatch Custom Report Guide - Provides information about how to convert old (pre 11.5) custom reports to work without WIS and to have UTC support in Wonderware InBatch.
The Wonderware InBatch product
library consists of a set of Portable Document Files (PDF) located in the
UserDocs 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.
Resource File
The following list of messages are modified in the Wonderware InBatch v11.5:
| Resource Name | Message | New/Modified | Notes |
| AdminWeb.csv | |||
| JsBadUserIDPwd | Unknown user name and/or password. | Modified | old value: Unknown userid and/or password.","Unknown userid and/or password. |
| HtmlEnterUserIDPassword | Please enter user name and password | Modified | old value: Enter User ID & Password","Enter User ID & Password |
| HtmlUserID | User name | Modified | old value: User ID |
| ErrLoginBadUIDPwd | Login Error - Unknown user name and/or password. | Modified | old value: Login Error - Unknown userid and/or password.","Login Error - Unknown userid and/or password. |
| HtmlAppTitle | Wonderware InBatch History Database Administration | New | |
| HtmlSQLExpressEdition | SQL Express edition detected on InBatch History Server. This operation is not supported as SQL Server Agent is unavailable/not installed. | New | |
| ErrSQLDoesNotExistIncorrectPwd | Specified SQL server UserID does not exists or incorrect Password. | New | |
| ErrFailedToConnectHS | Failed connecting to History Server. | New | |
| ReportWeb.csv | |||
| HtmlTitle | InBatch Reports Administration | Modified | old value: InBatch Reporting |
| HtmlInBatchReportsTitle | InBatch Reports | New | |
| HtmlViewReports | View Reports | New | |
| HtmlExecuteReports | Execute Reports | New | |
| ErrLoginBadUIDPwd | Login Error - Unknown user name and/or password. | Modified | old value: Login Error - Unknown userid and/or password. |
| HtmlReportWebLogin | InBatch Reports Administration Login | Modified | old value: InBatch Reporting Login |
| HtmlEnterUserIDPassword | Please enter user name and password | Modified | old value: Enter User ID & Password |
| HtmlUserID | User name | Modified | old value: User ID |
| JsBadUserIDPwd | Unknown user name and/or password. | Modified | old value: Unknown userid and/or password. |
| HtmlAppTitle | Wonderware InBatch Reports Administration | New | |
| HtmlInBatchReportsAppTitle | Wonderware InBatch Reports | New | |
| HtmlExportedReportsDetails | Details of exported report: | New | |
| HtmlSQLExpressEdition | SQL Express edition detected on InBatch Reporting Server. This operation is not supported as SQL Server Agent is unavailable/not installed. | New | |
| HtmlAbout | About | New | |
| HtmlVersion | Version | New | |
| dkerrors.csv | |||
| msg16 | Redundancy Manager not registered in services file! Re-configure Batch Server feature to register the Redundancy Manager in services file. | Modified | old value: Redundancy Manager not registered in services file! |
| msg19 | Cannot connect to master Redundancy Manager! Check if runtime services are running on the Master node. | Modified | old value: Cannot connect to master Redundancy Manager! |
| msg48 | Redundancy configuration file is invalid! Delete the existing redcfg file present under Config_A folder and re-configure Batch Server feature to get a valid redcfg file. | Modified | old value: Redundancy configuration file is invalid! |
| dklib.csv | |||
| msg84 | Warning: Lost connection to master %%s! Check if runtime services are running on the Master node. | Modified | old value: Warning: Lost connection to master %%s! |
| msg87 | System backup is no longer valid! Check if runtime services are running correctly on the Master node. | Modified | old value: System backup is no longer valid! |
Use of Material Design Lite
The product uses Google's Material Design Lite library for portions of the user interface: Copyright 2015 Google Inc
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
All code in any directories or sub-directories that end with *.html or *.css is licensed under the Creative Commons Attribution International 4.0 License, which full text can be found here: https://creativecommons.org/licenses/by/4.0/legalcode.
As an exception to this license, all html or css that is generated by the software at the direction of the user is copyright the user. The user has full ownership and control over such content, including whether and how they wish to license it.
© 2016 Schneider Electric Software, LLC. All rights reserved.
