Release Notes

( 9358-Bx ) Provides efficient, predictable batch processing, consistency between batches, and generation of event info. FTB
Version 15.00.00 (released 5/2022)

Catalog Number FactoryTalk Batch 

These release notes describe version information for FactoryTalk Batch, version 15.00.00 (released 5/2022).

Requirements

This release has the following requirements.

Supported operating systems

Supported database applications

(for storing recipes, materials, reports, and journal archives)

Web browsers

(for FactoryTalk Batch View only)

Logix Designer Application requirements

(for FactoryTalk Batch only)

FactoryTalk View SE requirements

(for integration of FactoryTalk Batch View HMI Controls)

FactoryTalk Services requirements

Rockwell Automation Test Environment

Rockwell Automation tests software products under a standard configuration of operating systems and antivirus software. For additional information see the Knowledgebase Document ID: PN24 - Rockwell Software Products and Antivirus Software.

  

(for FactoryTalk Batch only)



  

Features

This release includes the following system features.


Product lifecycle status

The FactoryTalk eProcedure Client, legacy FactoryTalk Batch View Client, and the FactoryTalk Batch ActiveX Controls have been deprecated and are not included in nor supported by FactoryTalk Batch 15.00. If your production system has dependencies on these products, transition to the modern FactoryTalk Batch View and FactoryTalk Batch View HMI Controls before upgrading to FactoryTalk Batch 15.00.


Corrected Anomalies in This Release

This release corrects the following anomalies.


FactoryTalk Batch

BatchIDCreation project update needed for Batch Server [914495]

Custom BatchIDCreation project in .Net format is needed. Current version is out of date with modern development tools.
In FactoryTalk Batch 15.00 a new BatchIDCreate project is provided.

Corrected Anomaly with FactoryTalk Batch 15.00
Known Anomaly First Identified in FactoryTalk Batch 14.00


Recipe Editor allows the use of reserved words in expressions [914545]

In FactoryTalk Batch 15.00 the Recipe Editor will provide Recipe Verification Warnings for step collisions where the name of a Parameter or Report collides with a step attribute (such as ERROR, MODE, FAILURE, OWNER, and so on).  The Transition Expression Editor Dialog will display an error message if name collision warnings are detected.

Corrected Anomaly with FactoryTalk Batch 15.00
Known Anomaly First Identified in FactoryTalk Batch 14.00


Master Recipe List slow to populate [914551]

In FactoryTalk Batch 15.00 the Recipe Object Model processing was improved to provide a faster load time.

Corrected Anomaly with FactoryTalk Batch 15.00
Known Anomaly First Identified in FactoryTalk Batch 13.02


Recipe Editor terminates when saving formulation to SQL database [982003, 1369929]

When using the SQL storage format attempting to save or validate a recipe that contains one or more formulations, the Recipe Editor crashes and the changes to the recipe are lost. In FactoryTalk Batch 15.00 the recipes are saved and validated without issue.

Corrected Anomaly with FactoryTalk Batch 15.00
Known Anomaly First Identified in FactoryTalk Batch 14.00


Batch View Server Product Policies missing on remote FactoryTalk Directory [1063952]

In FactoryTalk Batch 15.00 the Batch View Server Product Policies are installed as part of FactoryTalk Services Platform 6.30.

Corrected Anomaly with FactoryTalk Batch 15.00
Known Anomaly First Identified in FactoryTalk Batch 14.00


FactoryTalk Batch View Server fails to provide eProcedure instructions for multiple recipes [1064202]

When FactoryTalk Batch View does a getInstruction or getState call to the eProcedure Server it provides the set of createIDs for the Batches that correspond the the eProcedure instructions. If the client requests multiple createIDs and one of them is wrong the eProcedure server returns an error saying: "Unable to retrieve recipe step information for the specified procedure" and none of the instructions are provided. In FactoryTalk Batch 15.00 each createID is evaluated individually and the relevant instructions are provided.

Corrected Anomaly with FactoryTalk Batch 15.00
Known Anomaly First Identified in FactoryTalk Batch View 1.02


FactoryTalk Event Archiver Installation failure when using SQL Server on a named instance [1105890]

In FactoryTalk Batch 15.00 the installation program has been updated to use a different method of determining if SQL Server is installed.

Corrected Anomaly with FactoryTalk Batch 15.00
Known Anomaly First Identified in FactoryTalk Batch 14.00


Recipe Editor is slow to open when first started 1144064]

When using RDB recipe format, with approval workflows enabled, the Recipe Editor may take a long time to open and may appear to be stuck. It may also take longer than expected to launch and display the Open Recipe dialog.  These performance issues are especially noticeable when using a large number of recipes. FactoryTalk Batch 15.00 improves the performance of the Recipe Editor when using RDB recipe format with approval workflow enabled.

Corrected Anomaly with FactoryTalk Batch 15.00
Known Anomaly First Identified in FactoryTalk Batch 14.00


Recipe Editor open file dialog delayed response [1146906]

When using SQL recipe storage format, the Open File dialog would take a long time to to open. FactoryTalk Batch 15.00 improves the performance of the Open Dialog when using SQL storage format.

Corrected Anomaly with FactoryTalk Batch 15.00
Known Anomaly First Identified in FactoryTalk Batch 14.00


Batch Server service unexpectedly terminates when logging error information [1172391]

The Batch Server service terminates when handling a small number of uncommon errors. In FactoryTalk Batch 15.00 the error handling was updated so that the Batch Server responds appropriately.

Corrected Anomaly with FactoryTalk Batch 15.00
Known Anomaly First Identified in FactoryTalk Batch 14.00


Batch Server service terminates when a batch created from a UPC recipe is remove from the Batch List [1176902]

In FactoryTalk Batch 14.00 the removal of a unit procedure from the batchlist could randomly cause the Batch Server service to unexpectedly terminate. In FactoryTalk Batch 15.00 the removal logic was revised to allow removing of the batch. 

Corrected Anomaly with FactoryTalk Batch 15.00
Known Anomaly First Identified in FactoryTalk Batch 14.00


Batch Server Memory growth when using formulations [1194413]

When reading formulation data, the BatchSvr.exe memory usage grows. This memory growth may lead to performance issues with the FactoryTalk Batch system and may lead to termination of the Batch Server service. This can occur when using any the FactoryTalk Batch Client applications, or by using the INFO_TRIMMED, FOMULATION_DATA, and FORMULATIONS_INFO API calls directly. The memory growth is especially fast when using large recipes with a large number of formulation sets. In FactoryTalk Batch 15.00 the system correctly handles allocation and deallocation of memory for the API calls.

Corrected Anomaly with FactoryTalk Batch 15.00
Known Anomaly First Identified in FactoryTalk Batch 14.00


eProcedure Step Verification Signature does not include the full user name [1302092]

In FactoryTalk Batch 15.00 a new way to configure the step verification signature was implemented. This method made changes to the following:

Corrected Anomaly with FactoryTalk Batch 15.00
Known Anomaly First Identified in FactoryTalk Batch 13.00.02


No indication when the Batch server has issues writing entries to the Batch event journal [1325957]

In FactoryTalk Batch 13.00.02 there is no indication if the Batch server has issues writing entries to the Batch event journal. In FactoryTalk Batch 15.00, if the Batch server has issues writing entries to an event journal, it will attempt to log a message to the FactoryTalk Diagnostics log, and when possible, will include the details of the errant journal event in that message.

Corrected Anomaly with FactoryTalk Batch 15.00
Known Anomaly First Identified in FactoryTalk Batch 13.00.02


FactoryTalk Batch installation does not set the correct service account for eProcedure Server [914598]

When adding FactoryTalk eProcedure and Material Manager Editor to an existing FactoryTalk Batch install, the installer will incorrectly set the service account used to run the eProcedure Server. It also does not configure the computer name of the Material Manager Server. The installer for FactoryTalk Batch 15.00 now prompts the user for the required information.

Corrected Anomaly with FactoryTalk Batch 15.00
Known Anomaly First Identified in FactoryTalk Batch 14.00

Unsupported integer datatypes result in error [914582] 

Tags with USINT, SINT, UINT, INT, and UDINT datatypes in the controller are not supported by FactoryTalk Batch. Attempting to read or write to these tag types may result in a phase failure. 

Corrected Anomaly with FactoryTalk Batch 15.00
Known Anomaly First Identified in FactoryTalk Batch 14.00

Upgrade failure when installing FactoryTalk Batch with FactoryTalk Event Archiver [914577] 

Upgrade may fail unexpectedly when installing FactoryTalk Batch with FactoryTalk Event Archiver. In this situation, the install does not complete and system becomes unresponsive. This situation occurs because previous versions of the FactoryTalk Batch uninstall program do not always successfully remove the existing ODBC DSN entry for the Batch Event Archiver data source. The FactoryTalk Batch 15.00 installer checks for an existing "FactoryTalk Batch Events" DSN during the install process. If there is, it will remove the existing DSN and create a new one.

Corrected Anomaly with FactoryTalk Batch 15.00
Known Anomaly First Identified in FactoryTalk Batch 14.00

Area model updates: When deploying runtime area model updates the system does not check for activations [00369234]

The system only checks for licenses when the Batch Server is started. If the area model modifications require more activations than are available, a restart of the Batch Server will fail during the license check.

Corrected Anomaly with FactoryTalk Batch 15.00
Known Anomaly First Identified in FactoryTalk Batch 14.00

FactoryTalk Batch View

FactoryTalk Batch 14.00 included FactoryTalk Batch View 2.00. FactoryTalk Batch 15.00 includes FactoryTalk Batch View 2.01. Anomalies corrected in patches released subsequent to the release of FactoryTalk Batch 14.00 are included in the list of anomalies corrected in this release.

Using "textarea" tag in eProcedure html file causes a command error in Batch View [990743]

If an eProcedure html instruction file uses a "textarea" tag for a phase report parameter it will prevent the instruction from completing, when you select the OK button after filling in the text box you get the error "Control Step was already responded to by another client". In <FTBV 2.01 the FactoryTalk Batch View client and server were updated to properly handle textarea tags

Corrected Anomaly with FactoryTalk Batch View 2.01
Known Anomaly First Identified in FactoryTalk Batch View 2.00

Batch Reports not working in FactoryTalk Batch View HMI Control [1277219]

Selecting the Reports control in the FactoryTalk Batch View HMI User Controls results in a white display. In FactoryTalk Batch View 2.01 the HMI User Controls open the Reports view as expected.

Corrected Anomaly with FactoryTalk Batch View 2.01
Known Anomaly First Identified in FactoryTalk Batch View 2.00

Signature cancellation causes issues with future steps [1430586]

Completing a sign-off of a manual instruction signature request generated after a cancellation of a manual instruction signature causes FactoryTalk Batch View to become unresponsive.

Corrected Anomaly with FactoryTalk Batch View 2.00.11
Known Anomaly First Identified in FactoryTalk Batch View 2.00

Modern FactoryTalk Batch View client only allows scaling up to 1000% [1327777]

The legacy FactoryTalk Batch View client had a limit of 3.4028238 on the Batch Scale setting. The modern FactoryTalk Batch View client was designed to place an upper limit of 1000% on the Batch Scale setting. Patch 2.00.10 replaces this limit with the previous limit of 3.4028238 returning the Batch View functionality to parity with the legacy client.

Corrected Anomaly with FactoryTalk Batch View 2.00.10
Known Anomaly First Identified in FactoryTalk Batch View 2.09

User ID is blank in FactoryTalk Batch journal when eProcedure instructions are completed using FactoryTalk Batch View [1302090]

Event Signatures from the eProcedure server did not include the User ID (also referred to as user login name and user name), making it difficult to validate the signatures. This release updates the FactoryTalk Batch View Server to provide the option to store the User ID of the user that completes the eProcedure instruction in the event journal.

Corrected Anomaly with FactoryTalk Batch View 2.00.09 and FactoryTalk Batch 14.00.00.309
Known Anomaly First Identified in FactoryTalk Batch 2.00.08 and FactoryTalk Batch 14.00

FactoryTalk eProcedure instructions result in unresponsive client [1072655]

When requesting FactoryTalk eProcedure instruction information for multiple recipes, the request will fail for all recipes if there is an issue with any of the recipes in the request. This can lead to performance issues with FactoryTalk eProcedure instructions, and a potentially unresponsive client.

With FactoryTalk Batch View 2.00.08, FactoryTalk eProcedure Instruction information requests for recipes that do not have errors will be processed, regardless of whether other recipes have errors or not.

Corrected Anomaly with FactoryTalk Batch View 2.00.08
Known Anomaly First Identified in FactoryTalk Batch 2.00.07


FactoryTalk Batch View resubmitting completed instructions [1064081]

FactoryTalk Batch View submits the completion of an instruction multiple times, which can result in the next instance of an eProcedure phase being skipped.

Corrected Anomaly with FactoryTalk Batch View 2.00.07
Known Anomaly First Identified in FactoryTalk Batch 1.02.66

Batch View Server stops responding after FactoryTalk Batch View error [1064112]

FactoryTalk Batch View encounters an error while processing an expression, which may cause the Batch View Server to stop responding.

Corrected Anomaly with FactoryTalk Batch View 2.00.07
Known Anomaly First Identified in FactoryTalk Batch View1.02.60


UserID is blank in FactoryTalk Batch journal when eProcedure instructions are completed using FactoryTalk Batch View [1064092]

In FactoryTalk Batch View 2.00.07 the UserID of the user that completes the eProcedure instruction is passed to the Batch Server and included in the event journal.

Corrected Anomaly with FactoryTalk Batch View 2.00.07
Known Anomaly First Identified in FactoryTalk Batch View 1.02.66


FactoryTalk users have read-only access when using FactoryTalk Batch View  [CLM 5101]

Product policies for FactoryTalk Batch View were not installed. Product policies now install correctly.

Corrected Anomaly with FactoryTalk Batch View 2.00.05
Known Anomaly First Identified in FactoryTalk Batch View 1.01


Batch View Security: The Batch View 1.02 policies and 2.00 policies do not coexist in a FactoryTalk directory [899076]

Security granularity has changed from FactoryTalk Batch View 1.02 to 2.0. New security policies were added for FactoryTalk Batch View and FactoryTalk Batch View HMI controls. In the initial release of FactoryTalk Batch View version 2.00 the policies that were used by FactoryTalk Batch View 1.02 and FactoryTalk Batch View HMI Controls 1.02 were no longer available.

In FactoryTalk Batch View version 2.00.05 the FactoryTalk Batch View 1.02 security policies were restored and disambiguated from the FactoryTalk Batch View version 2.00 security policies so that they could coexist in the FactoryTalk Directory and both clients can be supported.

Corrected Anomaly with FactoryTalk Batch View 2.00.05
Known Anomaly First Identified in FactoryTalk Batch View 1.01


FactoryTalk Batch Material Manager

Material Server not able to access the material database remotely [925005]

The installation program for the Material Server was not setting the RemoteAccessEnabled key for remote access to the material database.

Corrected Anomaly with FactoryTalk Batch 15.00
Known Anomaly First Identified in FactoryTalk Batch 14.00


  

Known Anomalies in This Release

This release has the following known anomalies.


FactoryTalk eProcedure

Videos are not displayed correctly in manual instruction content served from Batch View Server [1503087]

In FactoryTalk Batch version 15.00 a new folder named customercontent was added the Batch View Server. During installation, you can choose to have your custom images, videos, and scripts migrated to this folder to support existing instructions. Absolute paths in the scripts files and manual instructions to the customer content are updated correctly to point to the new content location. However, if you are using relative paths the content paths in the scripts files and manual instructions are not correctly updated by the installation. Video and script files must include eProcedure/ at the beginning of the relative path.

The src attributes for the instructions need to be updated as follows:

After updating the attributes, the videos should display as expected.

FactoryTalk Batch View

Port conflict when using HTTPS [1536376]

FactoryTalk View SE, FactoryTalk Services Platform and FactoryTalk Batch View support secure communication using HTTPS and use the default HTTPS port 443. There are two situations in which this port conflict could impact FactoryTalk Batch View.

  1. FactoryTalk Batch View is installed before FactoryTalk View SE

    The FactoryTalk View SE installation processes does not check for port conflicts when installing with the option Secure communication with TLS and does not provide the option to select a different port. If FactoryTalk Batch View is installed first and assigns port 443 to its secure communication and then FactoryTalk View SE is installed and the option Secure communication with TLS is selected the installation will fail with communications errors due to the port being unavailable. The FactoryTalk Batch View installation process does detect the port conflict and provides the option to select a different secure communications port. First identified in FactoryTalk Batch View 2.01.

    To work around this issue, install FactoryTalk Batch View after FactoryTalk View SE.

  2. Installing new FactoryTalk-enabled software that uses HTTPS communication after installing FactoryTalk Batch View

    Because the other FactoryTalk software do not check communication during install a port conflict (port 443) will be created. As a result, FactoryTalk Batch View client and HMI user controls cannot communicate with the FactoryTalk Batch View server. First identified in FactoryTalk Services Platform version 6.30.00.

    Use one of these workarounds to resolve this issue:

    • If you installed FactoryTalk Reverse Proxy:
      1. On the computer hosting a FactoryTalk-enabled software server, open FactoryTalk Administration Console.
      2. In the Explorer pane, go to localhost > System > Policies > System Policies > Security Policy.
      3. Change Reverse Proxy Port to other available ports instead of 443.
      4. If Reverse Proxy Port is changed, the system will make changes to Site Bindings in Internet Information Services (IIS) Default Web Site.
      5. You may need to remove port 443 in IIS to ensure that the software works appropriately.
      6. You may also need to configure Product Policies for the FactoryTalk-enabled software to ensure that its HTTPS port in use is the same as Reverse Proxy Port.
      7. Select Apply, and then select OK.

    • If you did not install FactoryTalk Reverse Proxy:

      1. On the computer hosting a FactoryTalk-enabled software server, open FactoryTalk Administration Console.
      2. Go to localhost > System > Policies > Product Policies > FactoryTalk-enabled software> HTTPS Protocol.
      3. Change the port to other available ports instead of 443.
      4. Select Apply, and then select OK.
      5. Open Internet Information Services (IIS) Manager.
      6. In the Connections pane, select the server and site for the FactoryTalk-enabled software.
      7. In the Actions pane, click Bindings.
      8. In the Site Bindings dialog box, select the HTTPS site binding, and then click Edit.
      9. Change the port number to the one you configured in Step 3.
      10. Click OK.

FactoryTalk Event Archiver

Installing FactoryTalk Batch version 14.00 and later updates FactoryTalk Services Platform to version 6.20 [00369202]

There is a known anomaly in FactoryTalk Services Platform 6.11 and 6.20 that impacts FactoryTalk Event Archiver components. When FactoryTalk Diagnostics version 6.11 or 6.20 and Microsoft SQL Server Reporting Services 2017 or 2019 are installed on the same computer, Microsoft SQL Server Reporting Services fails to work. This anomaly was first identified in FactoryTalk Services Platform version 6.11.00.

To avoid this problem, change the default port used by Microsoft SQL Server Reporting Services from 8082 to another port.
For steps to address the issue after installation is complete, see Knowledgebase Document ID: BF25929 - SQL Server Reporting Services stops working after installing FactoryTalk Diagnostics.

FactoryTalk Batch Material Manager

Material Editor cannot access the material database after upgrading FactoryTalk Batch [929120]

The MTUser account is not in the correct database. Anomaly first identified in FactoryTalk Batch 14.00.

To work around this issue use these steps:

  1. Open the SQL Server Management Console.
  1. Navigate to the database Logins and delete the MachineName\MTUser login.
  2. Navigate to the material database and open the list of users: delete the user account MTUser.
  3. Run the script MaterialTrack_DBSecurity.sql on the material database. This will recreate the MTUser user account under the database.
    The script is located in the C:\Program Files(x86)\Rockwell Software\Batch\Scripts folder.
    Access to the material database should now be restored.

FactoryTalk eProcedure

Cannot create HMI Server on a computer with FactoryTalk eProcedure and FactoryTalk View SE [00369237]

After adding eProcedure to a FactoryTalk Batch and FactoryTalk View SE install, an HMI Server cannot be created.

To work around this issue, restart the computer after installing eProcedure, then create the HMI Server. 

 FactoryTalk Batch View 2.00

Pop-up notifications are persistent [519919, 519912]

For example: When an invalid login is used, a pop-up notification is displayed, indicating that the login is invalid. The notification is not cleared even after a successful login is completed.

Anomaly first identified in FactoryTalk Batch View 2.00.

To work around this issue, the user must close the notification.

Unintended actions from Arbitration Summary page [98187]

On the Arbitration Summary page, when the More menu graphic is open and a user selects Enter, the first item in the More menu is executed, resulting in possible unintended actions.

Anomaly first identified in FactoryTalk Batch View 2.00.

To avoid this issue, in FactoryTalk Security, enable confirmation messages, which prompt to confirm before actions are performed in FactoryTalk Batch View.

Spurious "No master recipes are released to production" message [263925]

When adding a batch to the batch list, the client may display a "No master recipes are released to production" message while the system is gathering the control recipe data.

Anomaly first identified in FactoryTalk Batch View 2.00.

To work around this issue, wait for the recipes to load. The message disappears after the recipes are loaded.

Spurious client reports of control recipe removal [471548]

During the runtime area model update, the control recipe may be inaccessible to the client, causing the client to report that the control recipe has been removed.

Anomaly first identified in FactoryTalk Batch View 2.00.

The control recipe is not actually removed, so you can ignore this message

Filters not functioning on Arbitration Summary page [760902]

On the Arbitration Summary page, when performing a warm restart or applying a run-time area model update, applied filters may not function as expected.

Anomaly first identified in FactoryTalk Batch View 2.00.

To work around this issue, reapply filters.

Filter values are not cleared automatically [98193]

When a user sets filter values on a phase while on the Equipment page and then restarts the FactoryTalk Batch View Server, the filter values are not cleared automatically.

Anomaly first identified in FactoryTalk Batch View 2.00.

To work around this issue, after restarting the FactoryTalk Batch View Server, manually clear the filter values.

FactoryTalk Batch View HMI Controls 1.00

FactoryTalk View SE Client process lock [360350]

When a Display Client is closed while running a FactoryTalk View SE display that contains the FactoryTalk Batch HMI Controls, the Display Client process keeps running as a background process. This may prevent the ability to launch subsequent instances of the Display Client.

Anomaly first identified in FactoryTalk Batch View HMI Controls 1.00

To work around this issue, reboot the machine on which the FactoryTalk View SE Display Client is executing.

FactoryTalk View Batch server authorization changes only reflected in FactoryTalk View SE user interface only after login [362225]

If a change is made to the FactoryTalk Batch View authorization policies when a FactoryTalk View SE display containing an HMI Control is in runtime, the change is not reflected in the user interface.

The user is required to log out and then login with valid credentials for the new authorization policy changes to be reflected in the user interface.

Removed BaseFilter batch remains on batch list [CLM 4578]

If a BaseFilter batch state is applied (such as State:Running) and the state changes for a currently visible batch on the Batch List, the batch is visibly removed from the list and the message: Control Recipe <name> has been removed appears.

Even though the applied BaseFilter removes visibility to the batch, the batch is actually still on the batch list and can be viewed from other clients or HMI Controls that do not filter based on the batch state.



  

Known Anomalies from Previous Releases

These anomalies are from previous releases but are still known in this release.

Known Anomalies in FactoryTalk Batch Components version 14.00

Functional Changes

This release has the following functional changes from the previous release.

Change in operating system support

Beginning in this release, the product installer prevents installation on all 32-bit versions of Windows operating systems (for example, Windows 10, 32-bit) and any Windows 7 operating system (for example, Windows 7 Professional, 64-bit).

Installation
eProcedure




  

Application Notes

This release has the following application notes.

Mitigation for Microsoft DCOM Hardening patch

In response to Microsoft Distributed Component Object Model (DCOM) Hardening patch (MS KB5004442), the minimum DCOM authentication level used by Rockwell Automation products was raised to Packet Integrity.

IMPORTANT
Installing this product’s latest version with earlier unpatched versions of other FactoryTalk products or products using Classic OPC DA connections may cause a loss of connectivity due to the difference in DCOM authentication level used. For additional information, see the Knowledgebase Document ID: IN39461 - Microsoft DCOM Hardening Information TOC.

Microsoft releases the DCOM Hardening patch in response to CVE-2021-26414. This patch elevates the minimum DCOM authentication level that is required to establish a DCOM connection. DCOM is used by many Rockwell Automation products and may be affected by the change that is made by the Microsoft patch. For additional information about the affected Rockwell Automation products, see the Knowledgebase Document ID: PN1581 - Product Notification 2022-01-001 - Rockwell Automation products unable to establish proper DCOM connection after installing Microsoft DCOM Hardening patch (MS KB5004442).


Upgrade

FactoryTalk Batch

Command-line parameters

Use command-line parameters to perform an unattended or silent installation of the software.

The following table identifies the installation command-line parameters. Command-line parameters are case-insensitive. However, if a specified value includes a space, be sure to enclose the value in quotation marks (for example, "value with spaces").

Common Rockwell Automation parameters

These parameters are applicable for all Rockwell Automation software that are available in the installation package.

Parameter
Description
/?
Displays the usage options for installation parameters.
/Q
 Silent Install, install runs in a quiet mode without any user interface.
This parameter is recommended if you are deploying the software installation using an IT tool or script, and don’t expect to see any error or restart messages. When using this parameter, your IT tool or script should check the error codes,
and respond as needed. For example, if the installation returns error code 1641, then the IT tool or script should restart the computer and relaunch the installation after restart.
This parameter is required if /QS is not specified.
/QS
 Unattended Install, install runs in a quiet simple mode and shows progress through the UI, it does not accept any input but still shows error or restart messages.
When using this parameter, you will not have to check the error codes, and the installation will stop and display a prompt if there are error or restart messages. For example, if an immediate restart is required to complete the install, a restart message will be displayed for you to confirm the restart. Installation resumes automatically from the point of interruption after restart.
This parameter is required if /Q is not specified.
/IAcceptAllLicenseTerms
 Acknowledges acceptance of the license terms.
This parameter is required for /Q or /QS parameters.
/AutoRestart
 Automatically restarts the computer after the installation is complete. Used when a restart is required to complete the installation.
This parameter is optional. If this parameter is not used silent install (/Q) will return either error code 1641 or 3010 if a restart is required, and unattended install (/QS) will result in a confirmation prompt that must be agreed to before the installation is completed.
/SetupLanguage="value"
 Specifies which language will be displayed during install process.
The value must be the one of the following:
  • ENU
  • CHS
  • DEU
  • ESP
  • FRA
  • ITA
  • JPN
  • KOR
  • PTB
This parameter is optional. If this parameter is not used, the default language is the current user or operating system user interface language.
/Record
 Records the installation options chosen to a recording file.
This parameter is optional.
/Playback
 Plays back a recording file to specify the installation options.
This parameter is optional.
/Product="value"
 Specifies which sub-products will be installed.
Only required if sub-products are included with the install package.
If the software does not include sub-products this parameter is not available.
/ProductLanguage="value"
 Specifies the language version of the software being installed.
The value must be the one of the following:
  • ENU
  • CHS
  • DEU
  • ESP
  • FRA
  • ITA
  • JPN
  • KOR
  • PTB
This parameter is optional. If this parameter is not used, the default language is the same as the setup language.
If the software does not support multiple languages this parameter is not available.
/InstallLocation="value"
Or
/InstallDrive="value"
 Specifies the install location or install drive respectively.
This parameter is optional. If this parameter is not used, the default install location is "C:\Program Files (x86)\Rockwell Software".
Some software restricts the installer to only change the drive the software is installed on. Use /? to determine which parameter is supported.
/SerialNumber="value"
 Specifies the serial number of the software being installed. This is used to activate the software during installation.
This parameter is optional. If it is not specified the software must be activated manually after installation if activation is required.
Some software does not require activation. If activation is not required this parameter is not available.
/ProductKey="value"
 Specifies the product key used to get activation keys during installation.
This parameter is optional. If it is not specified the software must be activated manually after installation if activation is required.
Some software does not require activation. If activation is not required this parameter is not available.
/Version="value"
 Specifies the version of the software to activate which corresponds to the product version associated with the SerialNumber and ProductKey.
This parameter is optional. If it is not specified the installer will use the most recent product version available.
Some software does not require activation. If activation is not required this parameter is not available.


FactoryTalk Batch-specific command line parameters

The command-line install of FactoryTalk Batch performs a full install of FactoryTalk Batch. To install FactoryTalk Batch, FactoryTalk <EA>, FactoryTalk Batch Material Manager, or FactoryTalk Batch View HMI Controls separately use the installation wizard instead of the command-line.

These options are specific to installing FactoryTalk Batch software:

Parameter
Description
BatchServerName
Required for Batch. Machine name where the Batch server is installed.
eProcedureServerName
Required for eProcedure. Machine name where the eProcedure Server is installed.
MaterialManagerServerName
Required for Material Manager. Machine name where Material Manager Server  is installed.
FirstInSystem
 Optional. Set to "No" to add a Batch or Material Manager install to an existing system.
If omitted, the default is "Yes"
DomainWorkgroup
 Optional. Set to "WORKGROUP" to indicate for a Batch, eProcedure, or Material Manager install that the machine is not connected to a domain.
If omitted, the default is "DOMAIN"
BatchDomain
 Required for Batch, eProcedure, and Material Manager.
Specifies the domain name of the machine where the product is being installed. Value should be set to the local machine name when installing in a workgroup.
BatchUserName
Required for Batch, eProcedure, and Material Manager.
BatchPassword
Required for Batch, eProcedure, and Material Manager.
RecipesInSQL
 Optional. Set to "Yes" to indicate for a Batch or Material Manager install that recipes should be stored in SQL.
If omitted, the default is "No"
FTDirectory
 Optional. Set to "Local" to indicate for a Batch or eProcedure install that FTSP should use the Local directory.
If omitted, the default is "Network"
MaterialJournaling
 Optional. Set to "Yes" for a Material Manager install to record activity to the MaterialBasedRecipe_MAJ database.
If omitted, the default is "No"
ArchiverSqlAuth
 Optional. Set to "Yes" to indicate for an Event Archiver Database install to use SQL authentication with the user and password values passed in /ArchiverSqlUser and/ArchiverSqlPass.
If omitted, the default is "No"
ArchiverSqlUser
Optional for Event Archiver Database Feature.
ArchiverSqlPass
Optional for Event Archiver Database Feature.
ArchiverDbAction
 Required for Event Archiver Database Feature.
"Migrate" updates pre-Batch 12 DB schema to current format
"Upgrade" updates only stored procedures and reports
"Create" generates a new DB, overwriting an existing one
ArchiverServerName
Required for Event Archiver Database Feature.
ArchiverInstanceName
Optional for Event Archiver Database Feature.
ArchiverDataSourceName
Required for Event Archiver Database Feature.
ArchiverWithReports
 Optional. For an Event Archiver Database install, set to:
"Yes" to use a BatchHistoryEx database with reporting
"No" to use a BatchHistory database without reporting
If omitted, the default is "Yes"
HTTPS_PORT_USER
 Optional for BatchView Server.
If omitted, the default value is 443.
To define a custom port, specify the value of the desired port (port value must follow the validation rules for port number assignment).
CopyCustomerContentSelected
 Optional for BatchView Server.
If omitted, the default is "No".

Example

The following example installs FactoryTalk Batch using command-line parameters.


Error codes

The following table identifies the error codes that can be returned by an installation.

Error Code
Value
Description
ERROR_SUCCESS
0
The installation completed successfully.
ERROR_INVALID_PARAMETER
87
One of the parameters was invalid.
ERROR_INSTALL_USEREXIT
1602
The installation was cancelled by the user.
ERROR_INSTALL_FAILURE
1603
A fatal error occurred during installation.
ERROR_BAD_CONFIGURATION
1610
The configuration data for this product is corrupt. Contact your support personnel.
ERROR_SUCCESS_REBOOT_INITIATED
1641
The installer has initiated a restart. After restart installation will continue.
ERROR_SUCCESS_REBOOT_REQUIRED
3010
A restart is required to complete the installation. After restart the product is successfully installed.
ERROR_SUCCESS_RELAUNCH_REQUIRED
3011
Restart of setup needed before installation can continue.


FactoryTalk Batch Material Manager

  • The installation program requires TLS 1.0 be enabled so that the SQL server scripts can create and update the Material Manager database. TLS 1.0 is not used by the application and can be disabled after installation is complete.
  • Material Editor is a COM+ application. If another service starts or logs in using the same identity before the Material Server is started, stopping that service logs off the user account. If the Material Editor is connected before the other service is stopped, it will still have access to the Material Server, but if it disconnects from the Material Server it will not be able to reconnect until the server is rebooted or the previous service is restarted. For more information and potential workarounds, see the information about COM+ applications on the Microsoft web site.

FactoryTalk Batch Enterprise Integration Server

  • Install the FactoryTalk Batch Enterprise Integration Server after completing the FactoryTalk Batch installation to add support for developing enterprise integration features using the provided API.

    The FactoryTalk Batch EI Server.msi file is in the EIServer folder of your FactoryTalk Batch 15.00 installation media.

Rockwell Automation recognizes that some of the terms that are currently used in our industry and in this publication are not in alignment with the movement toward inclusive language in technology. We are proactively collaborating with industry peers to find alternatives to such terms and making changes to our products and content. Please excuse the use of such terms in our content while we implement these changes.

Copyright © 2023 Rockwell Automation, Inc. All rights reserved.
Rockwell Automation, Allen-Bradley, and FactoryTalk are trademarks of Rockwell Automation, Inc.
To view a complete list of Rockwell Automation trademarks please click here.
Trademarks not belonging to Rockwell Automation are property of their respective companies.