FactoryTalk Batch View HMI Controls - Quick Start
FactoryTalk Batch View HMI Controls - Quick Start
FactoryTalk Batch View HMI Controls - Quick Start
Activities including installation, adjustments, putting into service, use, assembly, disassembly, and maintenance are required to be carried out by
suitably trained personnel in accordance with applicable code of practice. If this equipment is used in a manner not specified by the manufacturer,
the protection provided by the equipment may be impaired.
In no event will Rockwell Automation, Inc. be responsible or liable for indirect or consequential damages resulting from the use or application of this
equipment.
The examples and diagrams in this manual are included solely for illustrative purposes. Because of the many variables and requirements associated
with any particular installation, Rockwell Automation, Inc. cannot assume responsibility or liability for actual use based on the examples and
diagrams.
No patent liability is assumed by Rockwell Automation, Inc. with respect to use of information, circuits, equipment, or software described in this
manual.
Reproduction of the contents of this manual, in whole or in part, without written permission of Rockwell Automation, Inc., is prohibited.
Throughout this manual, when necessary, we use notes to make you aware of safety considerations.
WARNING: Identifies information about practices or circumstances that can cause an explosion in a hazardous environment, which may lead to
personal injury or death, property damage, or economic loss.
ATTENTION: Identifies information about practices or circumstances that can lead to personal injury or death, property damage, or economic
loss. Attentions help you identify a hazard, avoid a hazard, and recognize the consequence
Important: Identifies information that is critical for successful application and understanding of the product.
SHOCK HAZARD: Labels may be on or inside the equipment, for example, a drive or motor, to alert people that dangerous voltage may be
present.
BURN HAZARD: Labels may be on or inside the equipment, for example, a drive or motor, to alert people that surfaces may reach dangerous
temperatures.
ARC FLASH HAZARD: Labels may be on or inside the equipment, for example, a motor control center, to alert people to potential Arc Flash. Arc
Flash will cause severe injury or death. Wear proper Personal Protective Equipment (PPE). Follow ALL Regulatory requirements for safe work
practices and for Personal Protective Equipment (PPE).
Allen-Bradley, Rockwell Software, Rockwell Automation, and TechConnect are trademarks of Rockwell Automation, Inc.
Trademarks not belonging to Rockwell Automation are property of their respective companies.
Table of contents
Chapter 1
Chapter 4
BatchList Control Base Filter shortcuts for the BatchList Control .............................................. 19
Chapter 5
PromptSignatureList Control Base Filter shortcuts for the PromptSignatureList Control ......................... 21
Chapter 6
Full Control
Legal Notices ......................................................................................................... 24
The FactoryTalk® Batch View HMI Controls provide a means to monitor and
interact with the production process within a FactoryTalk View Site Edition (SE)
Display Client. The FactoryTalk Batch View HMI Controls consist of the
BatchList control, the PromptSignatureList control, and the Full control.
The BatchList control is used to create control recipes, view current control
recipes, and command a control recipe.
The Full Control is used to see the entire FactoryTalk Batch View site.
See also
Additional resources This document contains additional information concerning related Rockwell
Automation products.
Resource Description
FactoryTalk Batch View Quick Start Guide Use FactoryTalk Batch View to create, view, and
command control recipes. Also use FactoryTalk Batch
View to acknowledge prompts and signatures, view
equipment phases and diagnostic information, and view
profile information.
Access the Product Compatibility and Download Center (PCDC) to install the
FactoryTalk Batch View HMI Controls.
b. Select Next.
d. Select Install.
4. When the installation is complete, reboot the computer to start to use the
FactoryTalk Batch View HMI Controls.
See also
System requirements The FactoryTalk Batch View HMI Controls work within the system
requirements of all Rockwell Automation® software products.
Hardware requirements
The FactoryTalk Batch View HMI Controls do not have any specific hardware
requirements. It runs on any hardware platform that supports the required
software, either locally or on a virtual machine.
Ensure that all selected hardware is on the compatibility list of the operating
system that are listed in the Software requirements section.
Systems that do not meet the minimum requirements for the version of software
being used are not covered under warranty.
Software requirements
FactoryTalk Batch View HMI Controls requires the following software on the
host computer:
• Operating system
• Microsoft® Windows™ Server 2008 Service Pack 2 (32-bit)
Microsoft Windows Server 2008 R2 Service Pack 1 (64-bit)
• Microsoft Windows Server 2012
Microsoft Windows Server 2012 R2
• Windows 7 Service Pack 1 (64-bit)
Windows 8.1 (32-bit and 64-bit)
• Rockwell Software
• FactoryTalk Batch View version 1.00 or higher
• FactoryTalk View Studio version 8.10 or higher
• FactoryTalk View Site Edition (SE) version 8.10 or higher
• FactoryTalk Services Platform version 2.74.00 or higher
• FactoryTalk Activation Manager version 4.00.01 or higher
• Adobe
• Acrobat Reader XI (11)
• Anti-virus software
• All Rockwell Software products in this release have been tested using
the latest anti-virus software.
In FactoryTalk View Studio, configure the control properties using the Property
Page or the Property Panel, then configure the control to use VBA.
See also
Common control methods The BatchList Control, the PromptSignatureList Control, and the Full Control
use the Connect method during runtime.
Method Description
Connect Connects the FactoryTalk Batch View HMI Controls to the
FactoryTalk Batch server specified by the Node and Port
property settings.
Tip: If the Node and Port settings are changed in runtime, to ensure that there is a
connection to the new property settings, always reconnect.
See also
Common control property In a FactoryTalk View SE Display Client, configure these Property Page or
Property Panel properties for the BatchList Control, PromptSignatureList
settings Control, and the Full Control.
Node The computer on which the FactoryTalk Batch Read/Write Read/Write String
server and FactoryTalk Batch View are installed.
The Node property accepts valid string names
that are case insensitive or valid IP addresses of
the server machine.
The following rules apply for a string node
property value.
The value:
• Cannot begin with or contain http, https,
www or ftp anywhere in the value.
• Cannot be all numeric characters.
• Cannot contain the following characters:
backslash (\), forward slash (/), colon (:),
semi-colon (;).
For optimal performance, be sure to:
• Enter the FactoryTalk Batch View machine's
fully qualified domain name for the
FactoryTalk Batch View HMI Control's Node
property. For example, instead of setting the
Node property to <MachineName>, set it
to <MachineName.DomainName.com>.
• Follow the instructions in the HTTPS
certificates section in the FactoryTalk Batch
View Quick Start Guide, publication number
FTBVS-QS001, to accept the self-signed
certificate.
Port The value assigned to the FactoryTalk Batch Read/Write Read/Write Integer
View port during installation of FactoryTalk Default value: 443
Batch View. The default port value is 443. Other
valid port values are from 1024 through 32767.
ShowFilterBar Shows or hides the filter bar in runtime. This Read/Write Read/Write Boolean
setting does not impact the BaseFilter setting. • 0 - Hidden
• 1 - Shown (default)
Language Sets the ISO 639 language code in which the Read/Write Read/Write String
content is shown. The default value is EN. The Default value: EN
language name code is case insensitive.
See also
Configure the control To configure the BatchList Control, the PromptSignatureList Control, and
the Full Control to communicate with FactoryTalk Batch View, customize the
properties using the settings in the Property Page for the control.
Property Page
Before you begin:
• 0 - Full
• 1 - PromptSignatureList
• 2 - BatchList
4. In Port, enter the port through which the FactoryTalk Batch View server is
configured to receive communication.
5. (optional) Select the Show Filter Bar option to display the filter bar during
FactoryTalk View SE run-time.
• In the BatchList Control, this option enables the ability to create and
command batches during FactoryTalk View SE run-time.
• In the PromptSignatureList Control, this option enables the ability to
respond to prompts, such as to enter parameter values and to
acknowledge prompts, and also enables the ability to sign-off on
electronic signatures.
• In Full Control, this option enables these abilities for batches and
prompts.
See also
Configure the control To configure the BatchList Control, the PromptSignatureList Control, and
the Full Control to communicate with FactoryTalk Batch View, customize the
properties using the settings in the Property Panel for the control.
Property Panel
Before you begin:
• 0 - Full
• 1 - PromptSignatureList
• 2 - BatchList
5. In Port, enter the port through which the FactoryTalk Batch View server is
configured to receive communication.
6. (optional) Select True for the ShowFilterBar option to display the filter
bar during FactoryTalk View SE run-time.
See also
Configure the control to To configure the BatchList Control, the PromptSignatureList Control, and
the Full Control to use VBA, customize the ExposeToVBA setting in the
use VBA Property Panel.
5. Select Save.
See also
Apply a filter using the Use the BaseFilter property setting to display in the FactoryTalk Batch View
HMI Control only those items that match while in the run-time FactoryTalk
BaseFilter property setting View SE Display Client. The base filter icon is only shown in the FactoryTalk
View SE Display Client if a base filter is in use. If there is a syntax error in the filter
string, the base filter icon is yellow instead of white. If you click the base filter icon,
the syntax error is shown.
2. Open the Property Page or Property Panel for the user control.
a. To use the Property Page, double click the user control in the
FactoryTalk View SE display.
b. To use the Property Panel, right click the user control in the
FactoryTalk View SE display and select Property Panel.
Two or more keywords AND (all capital letters) vanilla AND speed returns a list of
items that include the strings vanilla and speed.
One of several keywords OR (all capital letters) vanilla OR speed returns a list of items
that include the strings vanilla or speed.
Exact keywords " " (quotation marks) "high limit" returns a list of items that
include the string high limit. Quotation marks indicate the
beginning and end of an exact phrase. The search only
returns matches when a phrase is identical to the phrase
within the quotation marks.
A filter statement:
See also
Diagnostic bar overview The diagnostic bar provides status information when viewing the BatchList
Control or the PromptSignatureList Control in a FactoryTalk View SE Display
Client.
Item Description
Return to the Home page to view the list of items.
View the item count notification for the control type in the
display window. If a base filter has been applied, the item count
is the number of items after the filter was applied. If there is a
syntax error in the base filter, the item count remains
unchanged from the unfiltered list.
View the configured base filter value. The base filter icon is only
shown if a base filter is in use.
The name of the control type in the display window.
See also
BatchList Control
The BatchList Control is used to create control recipes, view current control
recipes, and command a control recipe. Once a control recipe is created, it displays
in the BatchList until it is removed by the operator, or when the FactoryTalk
Batch server is restarted with a cold boot.
To access the BatchList Control, place the control into a FactoryTalk View
Studio Display Client.
See also
Base Filter shortcuts for the Use these shortcuts to filter the list of control recipes in the BatchList control
running in a FactoryTalk View SE Display Client.
BatchList Control
• Enter a keyword in BaseFilter. Filter text can contain alphanumeric
characters, symbols, full words, fragments of a word, or a single letter or
number.
• Combine operators and filters. For example: units:MIXER1 AND
recipe:vanilla.
Filters
Use one or more Control recipe filters for the Base Filter to narrow the results.
See also
PromptSignatureList Control
Signatures are requests for signoffs that require user permissions and optional
comments. When a signature is generated against a batch, acknowledge the
signature by completing the associated signoffs. A control recipe cannot complete
execution until the associated signoffs are completed.
See also
Base Filter shortcuts for the Use these shortcuts to filter the list of prompts and signatures in the
PromptsSignatureList control running in a FactoryTalk View SE Display Client.
PromptSignatureList
Control • Enter a keyword in Base Filter. Search text can contain alphanumeric
characters, symbols, and can be full words, fragments of a word, or a single
letter or number.
• Combine operators and filters. For example: description:deviation
AND recipe:vanilla.
Filters
Use one or more Control recipe filters for the Base Filter to narrow the results.
See also
Full Control
The Full control displays the entire FactoryTalk Batch View site, so an operator
can interact with the entire FactoryTalk Batch View site within a single HMI
control in a FactoryTalk View SE Display Client.
Use the Full control to create, view, and command control recipes, acknowledge
prompts and signatures, view equipment phases and diagnostic information, and
view profile information. The Full control has some differences from viewing the
BatchList Control or PromptSignatureList Control individually.
To use the Full control, place the control within a display in FactoryTalk View SE.
See also
You can view the Rockwell Automation End-User License Agreement ("EULA")
by opening the License.rtf file located in your product's install folder on your hard
drive.
Trademark Notices
Warranty
This product is warranted in accordance with the product license. The product’s
performance may be affected by system configuration, the application being
performed, operator control, maintenance, and other related factors. Rockwell
Automation is not responsible for these intervening factors. The instructions in
this document do not cover all the details or variations in the equipment,
procedure, or process described, nor do they provide directions for meeting every
possible contingency during installation, operation, or maintenance. This
product’s implementation may vary among users.
This document is current as of the time of release of the product; however, the
accompanying software may have changed since the release. Rockwell Automation,
Inc. reserves the right to change any information contained in this document or
the software at any time without prior notice. It is your responsibility to obtain the
most current information available from Rockwell when installing or using this
product.
Environmental compliance
In addition, we offer multiple support programs for installation, configuration, and troubleshooting. For more information, contact your local
distributor or Rockwell Automation representative, or visit http://www.rockwellautomation.com/services/online-phone.
Installation assistance
If you experience a problem within the first 24 hours of installation, review the information that is contained in this manual. You can contact
Customer Support for initial help in getting your product up and running.
United States Contact your distributor. You must provide a Customer Support case number (call the phone number above to obtain one) to
your distributor to complete the return process.
Outside United States Please contact your local Rockwell Automation representative for the return procedure.
Documentation feedback
Your comments will help us serve your documentation needs better. If you have any suggestions on how to improve this document, complete the
feedback form, publication RA-DU002.
Paulette M. Tiggs Copyright © 2016 Rockwell Automation, Inc. All rights reserved. Printed in the U.S.A.