Rockwell Automation RSBizWare BatchCampaign User Manual

RSBizWare BatchCampaign
USER’S GUIDE
PUBLICATION BWCMP-UM009A-EN-P–August 2007
Supersedes Publication BWCMP-UM008A-EN-P
Contact Rockwell
Customer Support Telephone — 1.440.646.3434 Online Support — http://www.rockwellautomation.com/support/
Copyright Notice
Trademark Notices
Other Trademarks
Warranty
© 2007 Rockwell Automation Technologies, Inc. All rights reserved. Printed in USA. This document and any accompanying Rockwell Software products are copyrighted by Rockwell Automation
Technologies, Inc. Any reproduction and/or distribution without prior written consent from Rockwell Automation Technologies, Inc. is strictly prohibited. Please refer to the license agreement for details.
Allen-Bradley, ControlLogix, eProcedure, FactoryTalk, Rockwell Automation, Rockwell Software, RSLinx, RSView, and the Rockwell Software logo, are registered trademarks of Rockwell Automation, Inc.
The following logos and products are trademarks of Rockwell Automation, Inc.: RSBizWare, the RSBizWare logo, RSBizWare Batch, FactoryTalk Batch, RSBizWare BatchCampaign, RSBizWare
BatchHistorian, FactoryTalk Historian Classic for Batch, RSBizWare Historian, FactoryTalk Historian Classic, RSBizWare MaterialTrack, and RSLoop Optimizer.
Any Rockwell software or hardware not mentioned here are also trademarks, registered or otherwise, of Rockwell Automation Technologies, Inc.
ActiveX, Microsoft, Microsoft Access, SQL Server, Visual Basic, Visual C++, Visual SourceSafe, Windows, Windows ME, Windows NT, Windows 2000, Windows Server 2003, and Windows XP are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries.
Adobe, Acrobat, and Reader are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States and/or other countries.
ControlNet is a registered trademark of ControlNet International. DeviceNet is a trademark of the Open DeviceNet Vendor Association, Inc. (ODVA). Ethernet is a registered trademark of Digital Equipment Corporation, Intel, and Xerox Corporation. OLE for Process Control (OPC) is a registered trademark of the OPC Foundation. Oracle, SQL*Net, and SQL*Plus are registered trademarks of Oracle Corporation. All other trademarks are the property of their respective holders and are hereby acknowledged.
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 anytime without prior notice. It is your responsibility to obtain the most current information available from Rockwell when installing or using this product.
Version: 9.00.00 (CPR 9) Modified: September 19, 2007 4:58 pm
Contents
1 • Introducing RSBizWare BatchCampaign 1
What’s New? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Product Name Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Common User Assistance Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
RSBizWare BatchCampaign Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
System requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Configuration requirements for Windows Server 2003. . . . . . . . . . . . . . . . . . . . . . . . . 5
Tested Third-party Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
DEP settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Changing DEP settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Hardware DEP settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Where Can I Go For Help? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Reference the release notes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Reference the User’s Guide (this book) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Reference the Online Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Get Phone Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Get Web Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Contact us. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
2 • Installing RSBizWare BatchCampaign 11
Pre-Installation Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Install SQL Server 2005 (Optional) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Identify Batch Server Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Log On to Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Install FactoryTalk Activation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Install RSBizWare BatchCampaign. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Configure RSBizWare BatchCampaign. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Configure the Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Add a FactoryTalk Batch Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
3 • Implementing Security 23
Configuring FactoryTalk Security for RSBizWare BatchCampaign. . . . . . . . . . . . . . 24
Opening RSBizWare BatchCampaign . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Logging on to RSBizWare BatchCampaign. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Configuring RSBizWare BatchCampaign Commands Using FactoryTalk Security. . 26
Configuring Security for RSBizWare BatchCampaign Commands. . . . . . . . . . . 27
Enabling User Confirmation for RSBizWare BatchCampaign Commands. . . . . 28
Communicating with the FactoryTalk Batch Server . . . . . . . . . . . . . . . . . . . . . . . . . . 31
iii
RSBIZWARE BATCHCAMPAIGN USERS GUIDE
• • • • •
4 • Using RSBizWare BatchCampaign 33
Starting RSBizWare BatchCampaign . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
RSBizWare BatchCampaign User Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Menu Bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Server Communication Status Icons. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Status Bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Configuring the RSBizWare BatchCampaign Database . . . . . . . . . . . . . . . . . . . . . . . 37
Data Link Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Working with Servers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Setting up Triggers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Configuring Error Handling. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Working with an HMI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
5 • Working with Batches 47
Adding a Batch. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Filtering Recipes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Starting, Stopping, Aborting, and Deleting Batches . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Starting a Batch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Holding and Restarting a Batch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Stopping and Aborting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Deleting a Batch or a Campaign. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Buffered Batches and the Batch List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
6 • Working with Campaigns 55
Adding a Campaign . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Adding a Batch to an Existing Campaign . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Adding an Unrelated Batch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Starting, Stopping, Aborting, and Deleting Campaigns. . . . . . . . . . . . . . . . . . . . . . . . 60
Starting a Campaign . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Holding and Restarting a Campaign. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Stopping and Aborting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Deleting a Campaign . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Filtering Campaigns. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
A• RSBizWare BatchCampaign Database 63
How is the RSBizWare BatchCampaign Database Different from the
FactoryTalk Batch Recipe Database?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
BatchCampaign Database Schema. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Index v
iv
1
Introducing RSBizWare BatchCampaign
W elcome to RSBizWare™ BatchCampaign™, the application that makes batch campaign management fast and simple. BatchCampaign allows you to execute your production
schedules quickly and easily, thus increasing productivity and reducing errors.
®
BatchCampaign is a 32-bit Windows Automation, Inc. that creates and manages campaigns. A campaign is defined as a connected series of operations designed to bring about a particular result, such as meeting a production order request or fulfilling a customer order. A campaign may consist of one or more batches and is designed to manage and execute the batches according to your specified scheduling requirements.
BatchCampaign is tightly integrated with the FactoryTalk® Batch suite, providing complete control of batch-based production runs. Using a straightforward user interface, production requirements are entered, and BatchCampaign translates the information into either a single batch or complete campaign runs. BatchCampaign has a variety of triggers for batch execution, allowing you to choose the method that will best fit your production requirements.
This chapter includes:
What’s New?RSBizWare BatchCampaign FeaturesSystem requirements
-based software application from Rockwell
What’s New?
The following new features or enhancements have been added to BatchCampaign for this release:
Product Name Changes
Several product names have been changed. The products that directly affect BatchCampaign are:
RSBizWare Batch (also known as RSBatch) has changed to FactoryTalk BatchRSMACC has changed to FactoryTalk AssetCentreFactoryTalk Automation Platform has changed to FactoryTalk Services PlatformRSAssetSecurity has changed to FactoryTalk Security
1
RSBIZWARE BATCHCAMPAIGN USERS GUIDE
• • • • •
Common User Assistance Folder
Starting with version 9.0, all Rockwell applications will install their user assistance files (online help, user documentation PDF files, and release notes) in a common folder located at \Program Files\Common Files\Rockwell\Help. This gives you one central location to find information and allows interaction between different products’ user assistance files.
The BatchCampaign online help files will no longer be stored in the \Program Files\Rockwell Software\BatchCampaign\Help folder. The first Rockwell Automation, Inc. product installed on a computer creates the common folder. When a product is uninstalled, the user assistance associated with that application are also removed, but the \Help folder is not removed unless the product being uninstalled is the last Rockwell Automation product on the computer. The last Rockwell Automation product removed from the computer removes the common folder and all remaining user assistance files.
RSBizWare BatchCampaign Features
Flexible batch/campaign creation
Add individual batches – you can specify the size of each batch in the campaign.Create campaigns with multiple batches – you can automatically generate the
campaign of batches using the quantity/size or a value in between that is applied to all batches in the campaign.
Human interface Allows you to dynamically view the state of FactoryTalk Batch
Servers and their associated batches and campaigns. The user interface also allows you to start, stop, abort, hold, and restart an individual batch in the campaign.
Flexible batch execution Gives you complete flexibility in how you run your
process. Y ou can choose to execute campaigns automatically from BatchCampaign, or
®
have the FactoryTalk Batch View or ActiveX
controls as the primary interface for
executing and commanding batches. Using either of these methods, you can:
Start each batch individually.Start all the batches in the campaign simultaneously.
Automatic batch execution
Y ou can configure a start trigger , which starts a batch or campaign automatically at
a predetermined time.
You can configure batches to start immediately.You can configure start triggers, which automatically start the next batch in a
campaign upon completion of the currently executing batch.
2
1 Introducing RSBizWare BatchCampaign
Multi-server capability Allows BatchCampaign to work with multiple FactoryTalk
Batch Servers, and start batches/campaigns on one server based upon state (complete, started, etc.) of a batch/campaign on another server.
State transitions The batches can easily be started, stopped, held, restarted, and
aborted.
Batch list population Adds batches to the FactoryTalk Batch Server according to the
specified number of batches that operators should be able to see on the batch list at any time. As an example, if there were 15 batches in a given campaign, the Batch List Count is configured for 5, and there are already 5 or more completed, aborted, or stopped batches on the Server’s Batch list, then some of these batches must be removed from the batch list before new batches will be automatically moved from the campaign onto the FactoryTalk Batch View list.
Campaign and Batch ID configuration capability Gives you the ability to specify a
user algorithm for generating campaign and batch ID. A default algorithm is provided that generates a batch ID based upon current date and time.
Unit Binding Unit classes can be bound from the BatchCampaign Human Interface.Security You may choose to require a logon and password protection for access to the
BatchCampaign interface.
• • • • •
System requirements
This section presents the minimum and recommended system requirements to successfully install and run RSBizWare BatchCampaign.
These requirements assume that no other applications will be running on the
computer, unless listed in the “Tested Third-Party Software” section.
A CD-ROM drive is required for software installation.Ensure that all selected hardware is on the Microsoft® Windows™ Server 2003
Service Pack 1, Standard Edition, Windows Server 2003 RS2 Standard Edition (recommended) or Windows XP™ Professional Service Pack 2 compatibility list. Systems that do not meet the minimum requirements for the version of software being used are not covered under warranty.
The FactoryTalk Batch Server computer cannot be configured as a:
Domain ControllerDHCP ServerWINS ServerRAS ServerDNS ServerMaster Browser
3
RSBIZWARE BATCHCAMPAIGN USERS GUIDE
• • • • •
Replication cannot be enabled on the FactoryTalk Batch Server computer.Install FactoryTalk Batch software on an NTFS formatted hard drive, as Windows
Server 2003 security features are available only for drives formatted to use NTFS.
FactoryTalk Batch cannot be loaded and run on a PDC.
Version 9.0 of the FactoryTalk Batch clients must be installed on the same computer as BatchCampaign.
The following is a list of the hardware and software required to install RSBizWare BatchCampaign. The minimum requirements are listed as normal text and the recommended requirements are listed as Bold Italic text.
Server Client
Computer
Memory
Available Hard Disk Space
Hard Disk Format
Disk Drive(s)
Monitor
Mouse
Operating System
Network
Network Protocol
1.2 GHz Pentium processor or greater, including hyper-threading models
512 MB RAM
(1 GB RAM recommended)
4 GB (8 GB recommended)
NTFS
CD-ROM drive and a hard disk (SCSI or faster)
256-color VGA and 800x600 minimum resolution (SVGA TrueColor with 2 MB of video RAM and 1024x768 resolution recommended)
Microsoft Mouse, Microsoft IntelliMouse® or compatible pointing device
Windows Server 2003 R2 Stan dard
*
Edition
Internet Explorer 6.0, Service Pack 1 English (United States)
10 Megabit or faster Ethernet card, network cable
TCP/IP
1.2 GHz Pentium processor or greater
256 MB RAM
(512 MB RAM recommended)
2 GB (4 GB recommended)
Windows Server 2003 R2 Standard
*
or Windows XP Professional,
Edition Service Pack 2
*
4
Other Software
• • • • •
1 Introducing RSBizWare BatchCampaign
Server Client
RSBizWare BatchCampaign is not warranted to run with any other third-party software installed on the same PC, unless otherwise stated in writing by Rockwell Automation.
Backup
* Windows Server 2003 SP1 Standard Edition is also supported.
Removable media device such as a CD-RW drive, etc.
Configuration requirements for Windows Server 2003
RSBizW are BatchCampaign version 9.0 requires a specific configuration of the Microsoft Windows Server 2003 R2 Standard Edition operating system.
RSBizWare BatchCampaign version 9.0 is supported in U.S. English only. You must install the corresponding language version of Windows Server 2003 R2 Standard Edition or Windows XP Professional, Service Pack 2, to ensure proper operation of BatchCampaign. Modifying regional settings is not supported.
The only configurations that are tested, and therefore warranteed, by Rockwell Automation are as follows:
Component Version and Requirements
Servers
*
*
or Windows XP Professional,
Operating System
Microsoft Windows Server 2003 R2 Standard EditionInternet Explorer 6.0, Service Pack 1
• Install the operating system using the default selections
Clients
Microsoft Windows Server 20 03 R2 S tandard Edition
Service Pack 2
Internet Explorer 6.0, Service Pack 1Install the operating system using the default selections with the following exception:
• Select Personal Web Manager or select the Internet Information Server [IIS]
* Windows Server 2003 SP1 Standard Edition is also supported.
It is highly recommended that you use the default installation directories for all components. The application, test suite, and associated documentation assume default directories are used. Extensive unit and system testing by Rockwell Automation ensures that all components function as one solution after the application is configured.
5
RSBIZWARE BATCHCAMPAIGN USERS GUIDE
• • • • •
O
THER
FactoryTalk Batch and any associated requirements (sold separately)
3.5" floppy disk drive CD-ROM drive SCSI or EIDE hard disk Any Windows-compliant pointing device
Tested Third-Party Software
Microsoft
Internet Explorer 6.0, Service Pack 1Excel XP, Service Pack 2Word XP, Service Pack 2PowerPoint XP, Service Pack 2Access XP, Service Pac k 2 Visual Basic 6.0, Service Pack 6SQL Server 2005, Service Pack 2 (English version only)
Oracle
Oracle 9i
Adobe
Acrobat Reader 8.1
Rockwell Software
FactoryTalk Activation, 3.0FactoryTalk Services Platform, 2.10RSLinx Classic 2.52.00RSLinx Enterprise 5.00.00RSView32 7.20.00 FactoryTalk View SE 4.00.00 RSLogix 5000 v. 16
6
Anti-Virus sof tw are
All Rockwell Software products in this release have been tested using the latest anti-virus software. For more detailed information, refer to Rockwell Knowledgebase technical note ID 35330 (you may be required to log into the Knowledgebase before you can view the information)
DEP settings
Data Execution Prevention (DEP) is a security feature that is supported by both hardware and software and intended to prevent the execution of malicious code in the Microsoft Windows XP (Service Pack 2) and Microsoft Windows Server 2003 (Service Pack 1 and R2) operating systems.
The DEP settings determine which applications and components are covered by DEP protection. They apply to both hardware-supported and software DEP features. On computers with the necessary hardware capabilities, hardware-supported DEP features are enabled for the same set of applications and components as the software DEP features. The following table explains the possible DEP settings and if those settings are supported by Rockwell Software products.
• • • • •
1 Introducing RSBizWare BatchCampaign
Rockwell Software recommends that you use the default DEP settings unless you have a specific reason to change them.
DEP Setting Description
AlwaysOn Full DEP protection for the entire system (all applications
and components, no exceptions).
OptIn DEP-enabled only for Windows system components and
OptOut DEP-enabled for all processes except those that explicitly
AlwaysOff DEP protection is disabled for the entire system (all
* Rockwell Automation does not recommend using this setting since it will make your system more
vulnerable to malicious code.
for applications that explicitly “opt in”. This is the default setting for Microsoft Windows XP (Service Pack 2).
“opt out”. This is the default setting for Microsoft Windows Server 2003 (Service Pack 1 and R2).
applications and components, no exceptions).
*
Supported by Rockwell Software Products?
No
Yes
Yes
Yes
7
RSBIZWARE BATCHCAMPAIGN USERS GUIDE
• • • • •
Changing DEP settings
T o change the DEP settings, select Control Panel > System > Advanced > Performance Settings > Data Execution Prevention. The Turn on DEP for essential Windows programs and services only setting corresponds to the OptIn setting and the Turn on DEP for all programs and services except those I select setting corresponds to the OptOut setting.
You must be an administrator of your computer to change these settings.You must reboot the computer for the DEP setting changes to take effect.
Hardware DEP settings
Hardware DEP uses the processor to mark memory so that code cannot be executed from data regions. When code attempts to execute in these marked areas, the processor generates an exception. If you are using Microsoft Windows XP (Service Pack 2) or Microsoft Windows Server 2003 (Service Pack 1 and R2) operating systems, the offending program is terminated. Hardware DEP is also enabled as the factory default setting. This feature is turned on or off in the computer BIOS settings.
T o determine if your hardware supports DEP, refer to the hardware manual or contact your hardware manufacturer.
For additional information, see the Microsoft Knowledgebase article at: http:// support.microsoft.com/kb/875352.
Where Can I Go For Help?
Our commitment to your success starts with the suite of learning aids and assistance we provide with the RSBizWare BatchCampaign product. Consult the following resources for additional information:
Reference the release notes
The electronic release notes provide a list of the hardware and software that are necessary to use BatchCampaign effectively and a list of known issues, issue fixes, and new features that are available in the current release of the software. The release notes are available from the RSBizW are BatchCampaign software installation CD-ROM and from within the online help system in the BatchCampaign client.
Reference the User’s Guide (this book)
The BatchCampaign User’s Guide is designed to help you understand how to access and use BatchCampaign. The User’s Guide is focused on the end-user functions of the
8
1 Introducing RSBizWare BatchCampaign
application. A printed copy of the User’s Guide is distributed in the box with the product software and an electronic copy of the guide is available from the RSBizW are BatchCampaign software installation CD-ROM.
Reference the Online Help
The online help provides general overview information and step-by-step procedures for working with all of the features in BatchCampaign. To view online help from the BatchCampaign Client:
Select Contents from the Help menu.Click the Help button on the toolbar.Press F1.
Get Phone Support
Rockwell Automation, Inc.’s support team of outstanding professionals provides top­notch technical support—monitoring and tracking your experience with our products to pave the road to your success in understanding and improving your factory performance.
Rockwell Automation, Inc. provides full support for the entire FactoryTalk Batch suite of products, which include FactoryTalk Batch and BatchCampaign. Questions concerning installation and the use of the software are handled by the Rockwell Automation Customer Support Center, staffed Monday through Friday—except U.S. holidays—from 8 AM to 5 PM Eastern time zone for calls originating within the U.S. and Canada.
• • • • •
T o reach the Customer Support Center , call 440-646-3434 and follow the prompts. For calls originating outside the U.S./Canada, locate the number in your country by visiting
rockwellautomation.com/support/
and selecting the Phone/On-site link. A list will be
presented from which you can locate the number to call in your country.
W
HEN YOU CALL
When you call, you should be at your computer and prepared to give the following information:
the product serial number and version number, which can be found in the client
software by selecting Help > About
the type of hardware you are usingthe exact wording of any errors or messages that appeared on your screena description of what happened and what you were doing when the problem occurreda description of how you attempted to solve the problem
9
RSBIZWARE BATCHCAMPAIGN USERS GUIDE
• • • • •
Get Web Support
In addition to phone support, the Rockwell Automation Customer Support Center offers extensive online knowledgebases of tech notes and frequently asked questions for support of non-urgent issues. These databases are updated daily by our support specialists.
To receive regular e-mail messages with links to the latest tech notes, software updates, and firmware updates for the products that are of interest to you or to submit an online support request, visit rockwellautomation.com/support/
Contact us
We strive to help all of our customers become successful in their manufacturing improvement efforts. Toward this objective, we invite you to contact your local representative or Rockwell Automation, Inc. at any time that we may be of service to you.
and select the Online link.
10
3
Installing RSBizWare BatchCampaign
There are setup procedures that must be completed before and after you install RSBizWare™ BatchCampaign™. To define the installation process, the installation is divided into the following three categories:
Pre-Installation ProceduresInstall RSBizWare BatchCampaignConfigure RSBizWare BatchCampaign
Use the following checklist when installing RSBizWare BatchCampaign.
Pre-Installation Procedures
for BatchCampaign
Install FactoryTalk Batch 9.0 (client
components)
Install Microsoft SQL Server 2005
(Optional)
Identify Server Name
Log on to Windows Log on with Administrator privileges. 22
Install FactoryTalk Activation
Required for BatchCampaign (see the Batch Installation or Upgrade Guide for instructions if Batch is not already installed).
Install if recipes are stored in RDB format. 22
Identify the name of the computer where the FactoryTalk Batch Server is installed.
FactoryTalk Activation is used for licensing and must be installed prior to installing the FactoryTalk Batch client. Since the FactoryTalk Batch client components are required to run BatchCampaign, this step should already be complete.
Install BatchCampaign 9.0
Install BatchCampaign Install BatchCampaign. 22
Configure BatchCampaign
Configure the Database Configure the database used by BatchCampaign. 26
Add a Server Add from 1 to 10 FactoryTalk Batch Servers. 30
Page
22
22
Page
Page
21
RSBIZWARE BATCHCAMPAIGN USERS GUIDE
• • • • •
Pre-Installation Procedures
The following instructions assume that the FactoryTalk Batch client components have already been installed, and that at least one FactoryTalk Batch Server has been installed (not necessarily on the same computer). Y ou must have administrative privileges on the target computer to install BatchCampaign. Before installing BatchCampaign, complete the following:
Install SQL Server 2005 (Optional)
If you are planning on storing recipes in RDB format, install Microsoft SQL Server 2005, Service Pack 1. SQL Server 2005 services must be running during the installation process.
Restart the computer after the SQL Server installation is complete.
Identify Batch Server Name
The setup program prompts you for the domain level user account and password asks for the computer name where the FactoryTalk Batch Server is installed.
Log On to Windows
Log on to Windows® Server 2003 R2, Standard Edition or Windows XP Service Pack 2 with administrator privileges. Close any open applications.
22
Install FactoryTalk Activation
FactoryTalk Activation must be installed prior to installing the FactoryTalk Batch software. Therefore, the following section assumes that both FactoryTalk Activation and the FactoryTalk Batch Server are installed and that you have obtained an activation code for BatchCampaign.
The FactoryTalk Activation Server must be installed on the same network or on the same computer as the FactoryTalk Batch Server. Each Batch Server computer must have the FactoryTalk Activation Client installed for license validation to occur.
Refer to the Activate Rockwell Software Products brochure, located in your software package. RSBizWare BatchCampaign uses concurrent activation.
Install RSBizWare BatchCampaign
These instructions assume that you are installing RSBizWare BatchCampaign on a computer networked with other client computers and that you are installing BatchCampaign on the same computer as the Batch client components. You can exit
3 Installing RSBizWare BatchCampaign
installation at any time by clicking the Cancel button. Before you begin the installation, complete all the pre-installation procedures.
The following steps assume that FactoryTalk Activation was installed before the Batch Server. If you find that you do need to install FactoryTalk Activation, please refer to the Activate Rockwell Software Products brochure, located in your product package, for instructions.
1. Insert the installation CD into the CD-ROM drive. The CD has the Autorun feature
enabled so the installation process starts automatically. The RSBizWare Welcome dialog box opens.
2. Click Install RSBizWare BatchCampaign. The RSBizWare BatchCampaign Install Disk dialog box opens.
To start the installation process manually, click the Start button, and then select Run. In the Run dialog box, type d:\setup (where d is the drive letter for the CD-ROM drive), and then click OK.
• • • • •
If the installation program detects an existing FactoryTalk Batch installation, it may give you the option of modifying or repairing the current installation. Do not select Repair or Modify - these are not supported options. Y ou must remove the existing version of the sof tware before installing the upgrade.
23
RSBIZWARE BATCHCAMPAIGN USERS GUIDE
• • • • •
3. In the RSBizWare BatchCampaign Install Disk dialog box, click Install RSBizWar e BatchCampaign. The RSBizWare BatchCampaign - InstallShield Wizard opens. Click Next.
4. In the License Agreement dialog box, select I accept the terms in the license agreement.
5. Click Next. The FactoryTalk Directory Selection dialog box opens.
24
6. Select which FactoryTalk directory you want to use to control the BatchCampaign components: Local or Network (for more information about the FactoryTalk directories, click Help).
7. Click Next. The Customer Information dialog box opens.
8. Type your User Name and Organization. Click Next.
9. In the Custom Setup dialog box, accept the default BatchCampaign configuration. Verify that there is enough space on the selected install path, and then click Next. If
3 Installing RSBizWare BatchCampaign
you do not have enough space, perform step 7. If you do have enough space, skip to step 8.
The default installation directory is C:\Program Files\Rockwell Software\. To set a different directory, click the Change button, select the desired directory, and then click OK.
• • • • •
10. Click the Space button to see if there is enough disk space to install the selected options. The Disk Space Requirements dialog box opens. If there is not adequate space, the drive is highlighted. Click OK.
11. Click Next.
12. Click Install to begin the installation.
13. When prompted, click Finish.
25
RSBIZWARE BATCHCAMPAIGN USERS GUIDE
• • • • •
Configure RSBizWare BatchCampaign
The first time you run BatchCampaign, an Error! dialog box displays. This occurs because a server and database have not yet been configured for BatchCampaign.
1. Click the Start button, point to All Programs > Rockwell Software >FactoryTalk Batch Suite > BatchCampaign, and then select BatchCampaign.
2. Click OK to continue. BatchCampaign opens.
26
3. Click the Log In button, type a valid user name and password, and then click OK. (See “Logging on to RSBizWare BatchCampaign” for more information.)
Configure the Database
BatchCampaign stores configuration information and buffered batches in a Microsoft Access database (BatchCampaign.mdf) in its root folder. You do not need to install Microsoft SQL Server if you use this database. If SQL Server is part of your FactoryTalk Batch solution you can configure BatchCampaign to store its configuration information and buffered batches in a SQL database. You must specify the SQL Server and the name of the database prior to any other configuration or configure BatchCampaign to use the Access database.
3 Installing RSBizWare BatchCampaign
1. Click the Properties and Settings button on the BatchCampaign toolbar. The Properties dialog box displays:
2. Select the Configure button. Click OK to acknowledge that the changes you make will not take place until BatchCampaign is restarted.
• • • • •
3. The Data Link Properties dialog box displays. It contains four tabs: Provider, Connection, Advanced, and All. Select the Provider tab if it is not already selected.
27
RSBIZWARE BATCHCAMPAIGN USERS GUIDE
• • • • •
4. On the Provider tab, select the database type you want to connect with from the OLE DB providers list. The provider you select will affect the options listed on the Connection tab. The most popular providers are:
Microsoft OLE DB Provider (preferred) for SQL Server – used by RSBizWare
Batch 5.xx and higher (and FactoryTalk Batch 9.0 and higher) because it uses the SQL Server database for recipes. This provider is also the choice used for the BatchCampaign database, if SQL Server is installed. (See “Data Link Properties” for more information.)
Microsoft Jet 4.0 OLE DB Provider – used by the supplied Access database.
5. Select the applicable Microsoft OLE DB provider, and then click the Next button. The Connection tab opens.
If you chose the Microsoft OLE DB provider for SQL Server as your provider your Connection tab will look similar to this:
28
In this example, MasterRecipes is the selected database. This is the database used to store recipes if the “Store recipes as in a database” option is selected in the FactoryTalk Batch Equipment Editor. BatchCampaign will create the required tables in this database or any other database selected.
3 Installing RSBizWare BatchCampaign
The Connection tab will look similar to this for the Microsoft Jet 4.0 selection (Admin is the default user for the database):
6. Select the Advanced tab.
For most applications, the default values specified on this tab should be acceptable. If you would like to change anything on this tab, click the Help button for descriptions of the options found on this Microsoft-owned dialog box.
7. Select the All tab.
• • • • •
For most applications, the default values specified on this tab should be acceptable. If you would like to change anything on this tab, click the Help button for descriptions of the options found on this Microsoft-owned dialog box.
8. Click OK to close the Data Link Properties dialog box.
9. Click OK to close the Properties dialog box.
29
RSBIZWARE BATCHCAMPAIGN USERS GUIDE
• • • • •
Add a FactoryTalk Batch Server
When RSBizW are BatchCampaign is opened initially, no FactoryTalk Batch Servers are associated with the BatchCampaign application. You must configure the FactoryTalk Batch Server before it is added to the list. Once the server is added, you can add batches or campaigns.
1. Click the Properties and Settings button on the toolbar. The Properties dialog box displays.
2. Click the Servers tab.
30
3. Click the New button. The Add New Server dialog box displays.
3 Installing RSBizWare BatchCampaign
4. The Name box is used to identify the FactoryTalk Batch Server consistently within the BatchCampaign application. Enter a unique Name and Node Address to be associated with this server.
You can browse your network to locate the desired server by selecting the Browse button (shown at right) to the right of the Node Address box.
5. Enter a valid Scan Rate. The default scan rate is 500 milliseconds. The scan rate can range from 1 to 999,999 milliseconds.
6. The Time Out value is the time that BatchCampaign will wait before it determines that communication is lost with the FactoryTalk Batch Server. The default timeout for the communication with the FactoryTalk Batch Server is 10,000 milliseconds. The timeout can range from 1 to 999,999 milliseconds.
Enter a valid Time Out value.
7. Enter the desired Batch List Count. This is the number of batches within a campaign that can be running on a FactoryTalk Batch Server. The default configuration is 5 batches per campaign. The number of batches allowed per server or per campaign must be between 1 and 999,999.
8. When everything is complete, click OK twice and the server displays in the hierarchy pane (on the left of the BatchCampaign window).
• • • • •
BatchCampaign has now been installed, configured and is ready for use. (See “ Using RSBizWare BatchCampaign” for more information.)
31
RSBIZWARE BATCHCAMPAIGN USERS GUIDE
• • • • •
ADD M
ULTIPLE FACTORYTALK BATCH SERVERS
You can add up to ten FactoryTalk Batch Servers to your BatchCampaign configuration. This allows BatchCampaign to work with multiple FactoryTalk Batch Servers; you can schedule batches and campaigns on one server to start based upon the state (complete, started, etc.) of a batch or campaign on another server.
1. Click the Server button on the toolbar. The Servers dialog box opens.
2. Click the Add Server button. The Add New Server dialog box opens.
32
3. Configure the server as described in “Add a FactoryTalk Batch Server”, above.
4. Repeat for each additional FactoryTalk Batch Server.
2
Implementing Security
This chapter provides information on securing RSBizWare™ BatchCampaign™ using FactoryTalk® Security, and the communication between BatchCampaign and the FactoryTalk Batch Server.
The following topics are covered:
Configuring FactoryTalk Security for RSBizWare BatchCampaignOpening RSBizWare BatchCampaignConfiguring RSBizWare BatchCampaign Commands Using FactoryTalk SecurityCommunicating with the FactoryTalk Batch Server
The following information is specific to configuring FactoryTalk Security for RSBizWare BatchCampaign. (For information on securing your complete FactoryTalk Security system, see FactoryTalk Help).
To open FactoryTalk Help complete the following steps: click the Start button, point to
All Programs > Rockwell Software > FactoryTalk Tools, and then select FactoryTalk Help.
BatchCampaign product policies are created in the Local Directory and the Network Directory when the FactoryTalk Services Platform installs. These product polices are used to restrict access to the BatchCampaign secured resources which include commands and log ons.
Security settings in the Network Directory are completely separate from the security settings in the Local Directory. For example, changes made to the security settings in the Network Directory do not change security settings in the Local Directory.
There are BatchCampaign product policies in the Local Directory that do not exist in the Network Directory. These product policies are Configuration Options that determine whether BatchCampaign uses Local or Network security, and Single Sign-On capabilities.
These policy settings are in the following location: \\System\Policies\Product Policies\Batch\BatchCampaign\Configuration\Options.
The FactoryTalk® Services Platform installation process:
Creates a FactoryTalk Local Directory and a FactoryTalk Network Directory on
the computer.
and ready for use.
Allows any Windows Administrator user account to log on to either directory. The
installation process automatically adds the local Windows Administrators group to the FactoryTalk Administrators group in each FactoryTalk Directory.
When the install process finishes, both directories are fully configured
11
RSBIZWARE BATCHCAMPAIGN USERS GUIDE
• • • • •
Allows any authenticated Windows user to log on to th e FactoryT alk Local
Directory.
The installation process automatically adds all members of the local
Windows Authenticated Users group to the FactoryTalk Local Directory.
Allows all new user accounts full access permissions. The installation process
automatically sets system policies to allow all new user accounts added to either directory full access to that directory by default.
Configuring FactoryTalk Security for RSBizWare BatchCampaign
You can restrict access to the features of individual FactoryTalk products in your system to prevent inadvertent changes or tampering. Only users with the required level of access can use the product features you secure.
For example, when you set up product policies for RSBizWare BatchCampaign, you might restrict the ability to issue the prevent automated batch processes from going down during run time.
T o configure security for multiple features in FactoryTalk, use the Feature Security for Product Policies dialog box. (See FactoryTalk Help for more information.)
T o configure security for the BatchCampaign features, use the product policies defined to secure BatchCampaign. These product policies are located in the FactoryTalk Administration Console.
Abort Batch command to a small group of users, to
12
T o open the FactoryTalk Administration Console click the Start button, point to All Programs > Rockwell Software, and then select FactoryTalk Administration Console.
T o tighten security for RSBizWare BatchCampaign:
Delete the Windows Authenticated Users group from the Local Directory. Secure
the BatchCampaign Configuration Options product policies in the Local Directory to avoid tampering or unauthorized changes.
Create new FactoryTalk user accounts and groups in the FactoryTalk Directory.
Create user accounts and/or groups to secure BatchCampaign. (For more information see FactoryTalk Help.)
Add user accounts and groups created in Windows to the FactoryTalk Directory.
Windows accounts added to the FactoryTalk Directory are Windows-Linked user accounts and groups. (For more information see FactoryTalk Help.)
Windows Workgroup User Accounts are not supported in FactoryTalk. If you use Windows workgroups, you cannot administer user accounts centrally for RSBizWare BatchCampaign. FactoryTalk Directory does not allow multiple user accounts to have the same name and password.
Remove the All Users group from the BatchCampaign product policies. The
FactoryTalk Services Platform installation process adds the FactoryTalk product policies. To tighten security for BatchCampaign, remove or restrict the
All Users group for the BatchCampaign product policies. (See
“Configuring Security for RSBizWare BatchCampaign Commands” for more information.)
Add user accounts and groups to the BatchCamp aign product poli cies. To secure
BatchCampaign resources, add only the necessary user accounts and groups to the associated product policies. (See “Configuring Security for RSBizWare BatchCampaign Commands” for more information.)
Required User Confirmation: Use the FactoryT alk Administration Console to enable
the Confirm feature for specific BatchCampaign commands. (See “Enabling User Confirmation for RSBizWare BatchCampaign Commands” for more information.)
Opening RSBizWare BatchCamp aign
RSBizWare BatchCampaign uses FactoryTalk Security to determine which users have permissions to log on to BatchCampaign. One of the product policies created for BatchCampaign is setting created in the FactoryTalk Local Directory is used in conjunction with the FactoryTalk single sign-on feature which allows users to log on just once, per directory, on a given computer. Once a user is logged on to the FactoryTalk Directory, all participating FactoryTalk-enabled products running on the local computer and using that directory automatically use the security credentials of the FactoryTalk logged on user. (See
FactoryTalk Security Help for more information.)
Single-SignOn. The BatchCampaign Single-SignOn product policy
Use single sign-on system policy setting to enable/disable the FactoryTalk
• • • • •
2 Implementing Security
All Users group to all
Opening BatchCampaign when the BatchCampaign is ‘Enabled’ and the FactoryTalk
Use single sign-on system policy setting is ‘True’ the
Single-SignOn product policy setting
following scenarios are possible:
If a FactoryTalkSecurity user with RSBizWare BatchCampaign permissions opens
RSBizWare BatchCampaign while currently logged on to the FactoryTalk Directory, the security permissions are the same.
If a Windows-linked user with RSBizWare BatchCampaign permissions opens
RSBizWare BatchCampaign, the user will also be logged on to the FactoryTalk Directory.
The Log on to FactoryTalk dialog box opens when a FactoryTalk user is not found.
13
RSBIZWARE BATCHCAMPAIGN USERS GUIDE
• • • • •
If the FactoryTalk Use single sign-on system policy setting is ‘Disabled’ or the BatchCampaign FactoryTalk dialog box opens.
If BatchCampaign Single-SignOn product policy setting is disabled, users logged on to the FactoryTalk Directory are ignored when opening BatchCampaign.
Logging on to RSBizWare BatchCampaign
To log on to BatchCampaign you must be an authorized FactoryTalk Security user or a “Windows-linked” user.
User accounts created in FactoryTalk Directory are referred to as FactoryTalk Security users. A user account created in Windows and then added to FactoryTalk Directory is a Windows-linked user.
1. With the FactoryTalk Batch Server active, open BatchCampaign. The active user’s name or
2. If the Log on to FactoryT alk dialog box opens, type your user name in the Name box and your password in the Password box and then click OK to log on. The authenticated user name is displayed in the status bar.
Click Cancel to close the Log on to FactoryTalk dialog box.
<No authenticated user> is displayed on the status bar.
Single-SignOn product policy setting is ‘False’, then the Log on to
14
Click Change Password to change your password.
3. To open the Log on to FactoryTalk dialog box, click the Login button.
Configuring RSBizWare BatchCampaign Commands Using FactoryTalk Security
The FactoryTalk Administration Console is used to configure the product policies for the RSBizWare BatchCampaign commands. Assigning a user group to a security policy enables the corresponding BatchCampaign command for all users who are members of that user group. Alternately, removing a user account from a security policy disables the corresponding BatchCampaign command for all users who are members of that user group. (See “Configuring Security for RSBizWare BatchCampaign Commands” for more information.)
2 Implementing Security
For more information about FactoryTalk Security see FactoryTalk Help.
T o open FactoryTalk Help, click the Start button, point to All Programs > Rockwell Software > FactoryTalk Tools, and then select FactoryTalk Help.
The BatchCampaign security policies for commands are defined in the Local and Network FactoryTalk Directory at the following location: \\System\Policies\Product Policies\Batch\BatchCampaign\Commands.
You can configure FactoryTalk Security to require user confirmation for the BatchCampaign commands. A command that has the confirm feature enabled will not execute until the user account is validated in the Log on to Confirm User dialog box. (See “Enabling User Confirmation for RSBizWare BatchCampaign Commands” for more information.)
The following BatchCampaign commands can be configured to require user validation:
• • • • •
All Properties Add Batch Append Batch To Campaign Add New Campaign Move Batch Move Campaign Delete Batch Delete Campaign
Start Batch Start Campaign Pause Batch Pause Campaign Stop Batch Stop Campaign Hold Batch Hold Campaign
Config Servers Restart Batch Restart Campaign Abort Batch Abort Campaign Enable Triggers Disable Triggers
Additionally, you can restrict access to resources based on where a user is physically located, such as a computer used to perform actions. (For more information see
FactoryTalk Help.)
Configuring Security for RSBizW are Batch C ampaign Commands
T o allow only specified users to issue commands within RSBizWare BatchCampaign, add the necessary users and/or user groups to the and then remove or restrict the
To add a user and/or user group to a
All Users group.
Command policy setting complete the following
steps.
1. Open the FactoryTalk Administration Console and then log on to the FactoryTalk Directory.
Command policy setting you want to secure
T o open the FactoryTalk Administration Console click the Start button, point to All Programs > Rockwell Software and then select FactoryTalk Administration Console.
15
RSBIZWARE BATCHCAMPAIGN USERS GUIDE
• • • • •
2. Navigate to: System\Policies\Product Policies\Batch\ BatchCampaign\Commands to modify security policy settings for the BatchCampaign commands.
3. Right-click Commands and then select Properties. The Commands Properties dialog box opens.
4. Select the policy setting you want to configure and then click the corresponding browse button. The Configure Securable Action dialog box opens.
5. In the Configure Securable Action dialog box you can:
select a user or group and then click Remove. allow/deny a user or group access to the feature by selecting or clearing the
corresponding check box and then clicking OK.
Product policies do not inherit security settings. When specifying permissions for product policies, clearing both the Allow and Deny check boxes denies access to the product feature.
add a user account or user group by clicking Add. This option displays the Select
User and Computer dialog box.
6. In the Select User or Group dialog box you can:
select a user, user group, computer or computer group and then click OK.
16
click Create New to create and then add a new user, user group, computer or
computer group.
7. Click OK to close the View Pr o p er ties dialog box.
Restart BatchCampaign and FactoryTalk Batch components to pick up security changes made in the FactoryTalk Directory.
Enabling User Confirmation for RSBizWare BatchCampa ig n Commands
Y ou can configure FactoryTalk Security to require user confirmation for batch commands. A command that has the confirm feature enabled will not execute until the user account is validated in the Log on to Confirm User dialog box.
T o enable the Confirm feature, you must configure the BatchCampaign product policy for the command and then set the associated <Command> These policy settings are defined in FactoryTalk Directory for each command button within BatchCampaign.
Confirm policy setting to True.
2 Implementing Security
The <Command> Confirm policy settings are located in the FactoryTalk Directory at the following location:
Local | Network\ System\Policies\Product Policies\Batch\BatchCampaign\Commands.
M
ODIFYING
RSBIZW
ARE BATCHCAMPAIGN CONFIRM POLICY SETTINGS
If you assign specific users and/or groups to a BatchCampaign command and enable the corresponding Confirm policy setting, then only the specified users are allowed to issue the command. To configure
Command policy settings complete the following steps.
1. Open the FactoryTalk Administration Console and log on to the appropriate FactoryTalk Directory.
2. Navigate to: \System\Policies\Product Policies\Batch\BatchCampaign\Commands to modify security for control commands.
• • • • •
3. Right-click the Commands folder and select Properties. The Commands Properties dialog box opens.
17
RSBIZWARE BATCHCAMPAIGN USERS GUIDE
• • • • •
4. Scroll to the Confirmations policy settings. Select the confirm policy setting and then click the corresponding drop-down list box.
5. Select True to require a user log on each time the command button is clicked. Select False if confirmation is not required.
\
18
6. Click OK to return to the FactoryTalk Administration Console window.
Restart FactoryTalk Batch components to pick up security changes made in the FactoryTalk Directory.
Communicating with the FactoryTalk Batch Server
When RSBizWare BatchCampaign is communicating with a FactoryTalk Batch Server, a computer icon (as shown below) is present next to the name of the computer hosting the FactoryTalk Batch Server.
When the BatchCampaign application loses communication with a FactoryTalk Batch Server, a circle with a line through it (as shown below) appears over the computer icon next to the name of the computer hosting the FactoryTalk Batch Server.
• • • • •
2 Implementing Security
When communication to a server is lost, all of the campaign information associated with that server is no longer displayed. The detection of communication loss is dependent upon the “Scan Rate” and “Time Out” configured for that FactoryTalk Batch Server. If BatchCampaign does not receive information in the specified “Time Out” time on its scheduled scan period, then it indicates that communication has been lost.
When communication between the FactoryTalk Batch Server and BatchCampaign is restored, the user interface again indicates good communication status.
19
RSBIZWARE BATCHCAMPAIGN USERS GUIDE
• • • • •
20
4
Using RSBizWare BatchCampaign
This chapter provides you with information on using RSBizWare™ BatchCampaign™, including the use of commands, displays, and button functions.
The following topics are covered:
Starting RSBizWare BatchCampaignRSBizWare BatchCampaign User InterfaceConfiguring the RSBizWare BatchCampaign DatabaseWorking with ServersWorking with an HMI
Starting RSBizWare BatchCampaign
The following steps will guide you through the process of starting RSBizWare BatchCampaign.
1. Make sure the FactoryTalk Batch Server is running.
2. Click the Start button, point to All Programs > Rockwell Software > RSBizWare > BatchCampaign, and then select BatchCampaign.
3. The BatchCampaign main window opens. (See “RSBizWare BatchCampaign User Interface” for more information.)
If this is the first time BatchCampaign has been started, you may see an Error! dialog box. This occurred because BatchCampaign has not yet been configured. (See “Configure RSBizWare BatchCampaign” for more information.)
33
RSBIZWARE BATCHCAMPAIGN USERS GUIDE
• • • • •
RSBizWare BatchCampaign User Interface
When RSBizWare BatchCampaign starts up, it has a user interface similar to Windows Explorer. It displays servers and campaigns in a hierarchy structure on the left side (pane) of the window. As you add servers and campaigns to BatchCampaign, they display in the hierarchy pane on the left.
34
Selecting either a server or a campaign configured on a server in the hierarchy pane displays all of the batches included in the server or campaign in the right side (details pane) of the main window. If the Details button is selected, the following columns display:
Column Description Batch ID The batch identifier. Recipe The recipe that is chosen for the campaign. Description Descriptive field provided by FactoryTalk Batch for operator notes.
BatchCampaign utilizes this field to indicate whether a campaign/batch was created with BatchCampaign. Also used to store start trigger information.
Start Time When the batch started. Elapsed Time How long the batch has been running. State What state the batch is in: Running, Held, Abort, Stopped, Buffering, Idle,
complete, etc.
Mode This can be either manual, semi-automatic, or automatic mode.
To switch the mode go to the FactoryTalk Batch View application.
4 Using RSBizWare BatchCampaign
Menu Bar
The following describes the menu bar commands:
Item Definition
File Allows you to add batches, campaigns and enable or disable triggers.
• • • • •
Edit Allows you to delete, start, stop, restart, abort and hold batches/campaigns, and move
Login Allows you to log into or out of BatchCampaign (if security is enabled). View Allows you to control the view mode of the list view as well as view properties and
Help Provides you with online help, user documentation and release notes as well as
buffered batches to the batch list.
settings.
information regarding the software and system.
Toolbar
The toolbar contains a group of buttons used to perform commands in BatchCampaign. The buttons, from left to right, are:
Button Description Menu Command
(Green light means enabled, red light means disabled). Press to enable/disable triggers (indicates current state of triggering).
New Campaign File > New Campaign
New Batch File > New Batch
Delete a batch/campaign. Edit > Delete
Move buffered batch(es) to server’s batchlist. Edit > Move
File > Pause Trigger
Start a batch/campaign. Edit > Start
Restart a batch/campaign. Edit > Restart
35
RSBIZWARE BATCHCAMPAIGN USERS GUIDE
• • • • •
Button Description Menu Command
Hold a batch/campaign. Edit > Hold
Stop a batch/campaign. Edit > Stop
Abort a batch/campaign. Edit > Abort
Large Icons controls view mode of list view (right pane).
Small Icons controls view mode of list view (right pane).
List controls view mode of list view (right pane). View > List
Details controls view mode of list view (right pane).
Properties and Settings View > Properties
User Login Login (uses FactoryTalk Security)
Opens a user-defined HMI (Human-Machine Interface). Allows context information regarding the selected component to be passed to an OLE Automation Server.
View > Large Icons
View > Small Icons
View > Details
File > HMI Application
Server Communication Status Icons
The following icons indicate the communication status between BatchCampaign and the FactoryTalk Batch Server:
Icon Description
When the lightning bolt is flashing on your server icon in the hierarchy view, it means that BatchCampaign is communicating with that server.
36
When a question mark is displayed on your server in the hierarchy view, it means that BatchCampaign is trying to initialize communications with that server.
When a red circle with a line through it appears on your server icon in the hierarchy view, it means that the server has shut down or is not connected.
Status Bar
The selected process cell’s name appears in the lower right corner on the status bar, with the selected unit’s name to the left of the process cell name.
4 Using RSBizWare BatchCampaign
Configuring the RSBizWare BatchCampaign Database
This section details the methods and dialog boxes used when configuring the RSBizWare BatchCampaign database and servers. If you are configuring the database for the first time, refer to “Configure BatchCampaign” for information.
1. Click the Properties and Settings button on the toolbar. The Properties dialog box opens. The Properties dialog box is used to configure your BatchCampaign database, servers, triggering and error messaging. (See “RSBizWare BatchCampaign Database”.)
• • • • •
2. There are four tabs on the dialog box; each one will be described in order from left to right. The tabs are Database, Servers, Triggering, and Miscellaneous.
37
RSBIZWARE BATCHCAMPAIGN USERS GUIDE
• • • • •
Data Link Properties
1. To configure the BatchCampaign database, select the Configure button.
2. The Data Link Properties dialog box displays. It contains four tabs:
38
P
ROVIDER TAB
The Provider tab is used to select the type of database you want to connect to. The provider that is selected will affect the options listed for the Connection.
The Microsoft OLE DB provider for SQL Server is used by FactoryTalk Batch 5.0 and higher because it uses the SQL Server database for Recipes.
1. From the Select the data you want to connect to area, select the desired provider. The following examples and images use the Microsoft OLE DB Provider for SQL Server.
2. Click the Next button to select the Connection tab.
4 Using RSBizWare BatchCampaign
C
ONNECTION TAB
If you chose the Microsoft OLE DB provider for SQL Server as the provider, your Connection tab will look similar to this:
• • • • •
The following table describes all of the Microsoft OLE DB provider for SQL Server options for the Connection tab:
Option Description
Select or enter a server name
Use Windows NT Integrated Security
Use a specific user name and password
Blank Password Select this when there is no password required for access to the database. Allow saving
password Select the database
on the server
Select the server that you would like to use for your database.
If selected, the credentials of the workstation’s logged in user will be used to determine if access to the database is permitted.
Note: Typically used in a domain security environment. When selected, you must enter the user name and password for the particular
database you would like to use. Note: Typically used in a workgroup security environment.
When selected, BatchCampaign will store the specified password.
Use the scroll down list to find an existing database, or enter a new name and the BatchCampaign will automatically create this new database upon being restarted.
39
RSBIZWARE BATCHCAMPAIGN USERS GUIDE
• • • • •
Option Description
Attach a database file as a database name
Test Connection Click this button to test your database connection.
A
DVANCED TAB
For most applications, the default values specified on this tab should be acceptable. If you would like to change anything on this tab, click the Help button for descriptions.
ALL TAB
For most applications, the default values specified on this tab should be acceptable. If you would like to change anything on this tab, click the Help button for descriptions.
Working with Servers
Since RSBizW are BatchCampaign works with the batch list on a FactoryTalk Batch Server, you must first add a FactoryTalk Batch Server before you can begin adding batches or campaigns.
This option is not typically used for BatchCampaign installation. Click the Help button for additional details.
Note: If you enter a database name that is not on the scroll down list, it will only test successfully after you restart the application.
40
A
DDING A SERVER
1. Click the Servers tab. The Properties dialog box displays:
4 Using RSBizWare BatchCampaign
2. Next, click the New button. The Add New Server dialog box displays. Enter the Name, Node Address, Scan Rate, Timeout, Batch List Count and Recipe Database location associated with this server.
• • • • •
You can browse your network to locate the desired server by selecting the Browse button (shown at left) to the right of the Node Address edit box.
3. When everything is complete, click OK, then click Apply. The server will be displayed. Descriptions of the boxes are listed in the table below.
Box Description
Name Server name (must be unique). Node Address Unique network name assigned to the computer, or computer name. Scan Rate Determines how fast the display gets refreshed (the value is in milliseconds).
The smaller the number the more frequently the display gets refreshed. The default scan rate is 500 milliseconds. The scan rate can range from 1 to
999,999 milliseconds. Note: The faster the scan rate, the more network traffic there is. A safe span
would be between 500 and 5,000.
Time Out Determines how long BatchCampaign will wait before it notifies you that it
can no longer communicate. The default timeout for the communication with a FactoryTalk Batch Server is 10,000 milliseconds. The timeout range is 1 to 999,999 milliseconds.
The higher the value the more tolerant it is of network traffic (the value is in milliseconds).
41
RSBIZWARE BATCHCAMPAIGN USERS GUIDE
• • • • •
Box Description
Batch List Count The number of batches that will automatically be placed in the batch list (in
Provider This box automatically fills in with your provider name (the FactoryTalk
Source This box displays the database source. You can choose the database path by
To configure your FactoryTalk Batch Server recipe database, select the Configure button. For information on configuration, see “Data Link Properties” on page 38 and “RSBizWare BatchCampaign Database” on page 63.
the FactoryTalk Batch View) on the server being created. You can specify whether you want the batch list count to be a per server count or per campaign count. The default configuration for the batch list count is 5 batches per campaign. The number of batches allowed per server or per campaign must be between 1 and 999,999. (See “Buffered Batches and the Batch List” for more information.)
Note: If the number of batches already on the FactoryTalk Batch Server’s batch list is greater than or equal to this number, then new batches will not be transferred from the campaign buffer to the batch list until current batches on the batch list run to completion.
Batch Server Recipe Database provider) by clicking on the Configuration button. For details on provider configuration see the Provider tab on page38.
This box is for display only.
clicking on the Configuration button. For details on the configuration see the Connection tab on page 38.
This box is for display only.
42
This is necessary for BatchCampaign to be able to identify scalable deferred parameters.
M
ODIFYING A SERVER
The configuration information of a FactoryTalk Batch Server added to the RSBizWare BatchCampaign application can be modified using the Properties dialog box.
1. Click the Properties and Settings button on the toolbar. The Properties dialog box displays.
4 Using RSBizWare BatchCampaign
2. Click the Servers tab.
3. Click the Modify button. Make the desired changes and then click OK twice to save the changes and close the dialog box.
D
ELETING A SERVER
You can delete a FactoryTalk Batch Server from the list of servers associated with BatchCampaign. Removing a FactoryTalk Batch Server from BatchCampaign removes all references to the FactoryTalk Batch Server in the hierarchy and details pane.
• • • • •
1. Click the Properties and Settings button on the toolbar. The Properties dialog box opens.
2. Click the Servers tab.
3. Click the Delete button. The FactoryTalk Batch Server is removed from the list.
4. Click the Apply button on the Properties dialog box to save the deletion. Click OK to close the dialog box.
43
RSBIZWARE BATCHCAMPAIGN USERS GUIDE
• • • • •
Setting up Triggers
Triggers are used to determine when and in what order a batch or campaign is to be started. The master node is responsible for monitoring triggers and sending START commands when appropriate. An operator on any RSBizWare BatchCampaign client (configured to use the same configuration database) can enable or disable triggering. When triggering is disabled, the master node does not monitor trigger requirements and will not send START commands. The default setting for Triggering is ON.
1. Click the Properties and Settings button to open the Properties dialog box.
2. Select the Triggering tab.
3. Select a computer to act as the master node.
Note: Since this value can be changed from any computer running BatchCampaign, this provides a manual switchover / warm backup solution.
When BatchCampaign is installed on more than one node, the master node is the one on which BatchCampaign is running and is enabled to move or start batches. The master node is the only BatchCampaign node allowed to move batches from the Campaign batch buffer to the FactoryTalk Batch Servers’ batch lists and start batches whose trigger conditions have been met.
4. Click OK to close the dialog box.
44
5. You can control batch triggering from the main window. The Trigger button on the toolbar toggles between Triggering Enabled (green light) and Triggering Disabled (red light). When the traffic light is green, triggering is enabled on the master BatchCampaign node for all of the configured FactoryTalk Batch Servers. When the light is red, triggering is disabled.
Configuring Error Handling
You can enable or disable certain startup and timeout errors on the Miscellaneous tab of the Properties dialog box.
1. Click the Properties and Settings button to open the Properties dialog box.
2. Select the Miscellaneous tab.
3. Select a checkbox to enable (a check mark displays in the box) one or more of the following options:
Show “Recipe Database” connect errors on startup – Displays startup errors
resulting from attempts to connect to the recipe database.
Show “Buffering Database” connect errors on startup – Displays star tup errors
resulting from attempts to connect to the buffering database.
Allow Batch Stopping/Aborting – Enables the ability to Stop or Abort a batch.Ignore Timeout Errors when Ad ding/Moving Batc hes to the Batch Li st – When
checked, communication timeout errors will not be shown. Communication timeout errors can result from high network traffic, which may result in communication between the RSBizWare BatchCampaign and the FactoryTalk Batch Server taking more than the configured amount of time.
4. Click OK to save your changes and close the dialog box. Startup error handling will be in effect the next time you start BatchCampaign.
Working with an HMI
The Human-Machine Interface (HMI) is the process control software that allows the user to view the graphical representation of all the automated devices in the selected plant. The HMI displays each configured piece of equipment and enables the interaction with the plant environment. The HMI also offers the user the ability to manually control the devices displayed on the screens.
The HMI can be used in conjunction with BatchCampaign to control automated batch processing.
• • • • •
4 Using RSBizWare BatchCampaign
1. Click the Properties and Settings button to open the Properties dialog box.
2. Select the Miscellaneous tab.
3. In the HMI Application Path box, type the path and file name for the HMI application.
4. In the HMI Window Name box, type a name to be used in the title bar of the HMI window.
5. Click OK to save your changes and close the dialog box. The HMI button on the toolbar is enabled.
6. When you want to access the HMI application, click the HMI button (or sele ct HMI Application from the File menu).
45
RSBIZWARE BATCHCAMPAIGN USERS GUIDE
• • • • •
46
5
Working with Batches
This chapter provides you with information on adding, starting, stopping, aborting, holding, restarting, and deleting batches. It also discusses filtering batch recipes and moving buffered batches to the FactoryTalk® Batch Server’s batch list.
The following topics are covered:
Adding a BatchFiltering RecipesStarting, Stopping, Aborting, and Deleting BatchesBuffered Batches and the Batch List
Adding a Batch
Once RSBizWare™ BatchCampaign™ has been configured, you can create new batches on the FactoryTalk Batch Server. You can also add a new individual batch to an existing campaign. (See “Adding a Campaign” for more information.)
1. Start by clicking the New Batch button on the toolbar. The Recipe List dialog box displays:
47
RSBIZWARE BATCHCAMPAIGN USERS GUIDE
• • • • •
A list of recipes is displayed with the columns below:
Column Description
Identifier The recipe name. Procedure Description Description of the product or process at the procedure level. Product Code A short label that uniquely identifies the product. Recipe Type What type of recipe it is: Operation, Unit Procedure, Procedure,
Procedure Abstract A summary or outline of the procedure steps. Last Used Displays the date and time a recipe was last used.
2. Select the recipe to use, and then click Next. The Batch Creation dialog box opens:
or All Procedures.
48
The following table describes the options on this dialog box:
Box Description
Selected Recipe The recipe that you selected (view only).
If you click Back twice, you will be at the recipe list where you can select a different recipe.
Version The version of the recipe you are using (view only).
5 Working with Batches
Box Description
Batch ID If a batch ID was not automatically generated, you can change the batch ID to
whatever you want (using characters A-Z, 0-9); the default batch ID is Batch_ID.
Start Trigger Triggers automatically start the next batch in a campaign upon completion of
currently executing batch. Select the desired start trigger from the scroll down list:
(none) – no trigger.Time/Date – this allows you to enter the time and date you would like the
batch to start.
Batch State – allows you to set the batch to start depending on the state of
any other specified batch transitioning to Running or Complete.
Immediate Start – this will start the batch as soon as it is created.Sequential Start – each batch will automatically be started when the state
of the previous batch is Complete.
The start trigger for the first batch is not modified.
Scale Parameters (Only applies to
recipes that are marked as having scalable parameters)
(All scalable parameters are highlighted in blue.) This allows deferred recipe parameters to be scaled automatically according
to the batch size. When the box is unchecked, the ingredient value entered is sent to the FactoryTalk Batch Server and automatically scaled.
To see what it will be scaled to, check the Scale Parameters box and the scaled value will replace the original value.
When a value for the ingredient is entered and the Scale Parameters box is checked, the actual value that the FactoryTalk Batch Server will use is displayed, it will not be changed because it is already scaled.
For example, a batch with a default size of 4,000 liters is scaled to 5,000 liters, or 125% of the default batch size as defined in the recipe header. If 100 liters of the ingredient WATER is entered with the Scale Parameters box unchecked, FactoryTalk Batch Server will automatically scale the amount of the ingredient WATER to 125 liters.
When the Scale Parameters box is checked, it displays the value the FactoryTalk Batch Server used, which would be 125 liters. If
125 liters is
entered when the Scale Parameters box is checked, the FactoryTalk Batch Server uses the actual number you entered (in this case, 125 liters).
Formula Value
The name for a specific parameter in the recipe.
Name Minimum The minimum value for the recipe parameter. Value The desired value for the recipe parameter. Maximum The maximum value for the recipe parameter. Eng. Units Engineering units. Unit Alias Name given at a procedure level by the recipe author to reference the unit
class.
• • • • •
49
RSBIZWARE BATCHCAMPAIGN USERS GUIDE
• • • • •
Box Description
Filter You can filter what equipment is available for the individual units simply by
Bound Unit You can bind a unit to a unit alias simply by picking one from the dropdown
Batch Amount The total amount in the batch. Back Go back to the previous dialog box. Create Create the batch. Cancel Cancel batch creation.
3. When everything is set to your satisfaction, click the Create button and the batch is created.
typing in a filter string criteria. ? = Any single character. * = Zero or more characters. # = Any single digit (0-9)
list. If previously specified in the FactoryTalk Batch Recipe Editor, you will not
only have the units available for binding, but two more optio ns, <prompt> and <first available>. The prompt option will prompt you to choose a unit when the previous phase is complete. The first available option does not prompt you; it uses the first available unit when the previous phase is complete.
50
If FactoryTalk Batch has AutoBatchID enabled when you make a single batch with RSBizWare BatchCampaign, its batch ID will be what the AutoBatchID execute returns. You can edit the batch ID, if desired.
Filtering Recipes
Filtering allows you to specify the type of recipes to display. This is very helpful, especially in plants with large numbers of recipes. You select a recipe attribute, like Last Used or the Recipe ID (Identifier) and then select the type of filter to be used. You can also specify additional filter criteria and whether or not the filter should match the case of the filter criteria or not.
5 Working with Batches
1. The filter information is used when creating a campaign. Click the New Batch button on the RSBizWare BatchCampaign toolbar. The Recipe List dialog box displays:
2. Click the button labeled Filter Setup. The Recipe Filtering dialog box opens.
• • • • •
3. Select one of the following Recipe attributes:
(none)IdentifierProcedure DescriptionProduct CodeRecipe TypeProcedure AbstractLast Used
Selecting (none) from the Filter Criteria list removes the filter.
51
RSBIZWARE BATCHCAMPAIGN USERS GUIDE
• • • • •
4. Select one of the following types from the Filter Types list.
Filter type Data type
Starts WithContainsEnds With
Less ThanGreater ThanEqual ToLess Than or Equal
To
Greater Than or
Equal To
5. Enter the Filter Criteria (optional) and then enable or disable the Match Case checkbox to determine if the filter is to be case-sensitive (enabled) or case-insensitive (disabled).
. These filter types are basic string compares
For these choices, if the contents of both the recipe attributes and the filter criteria can be converted to numbers; the compare will be numeric, otherwise it will be a string compare.
For example, if you have the following recipe IDs:
Triple_Chocolate_A Triple_Chocolate_BTriple_Chocolate_C Triple_Chocolate_D
If you choose a filter type of Greater Than and a filter criteria of Triple_Chocolate_B, then only Triple_Chocolate_C and Triple_Chocolate_D will be listed.
52
6. Click OK. The Enable Filter checkbox is now enabled. Select the box (so that it has a check mark) to activate the filter you just created.
Starting, Stopping, Aborting, and Deleting Batches
Batches that are on a FactoryTalk Batch Server’s batch list can be started, held, restarted, and deleted from the main BatchCampaign window.
Starting a Batch
1. Click the desired Server or Campaign Entry/Item on the Main Window, in the hierarchy view on the left, to display the individual batches in the list view.
2. When the individual batches are shown in the table to the right of the hierarchy view, select the batch, and then click the Start button in the toolbar.
3. The batch state should change to RUNNING.
The batch mode must be either AUTOMATIC or SEMI-AUTOMATIC and the batch state must be Ready before you can start it.
To change the mode, go to the FactoryTalk Batch View application, select the batch, and then click the appropriate mode button.
Holding and Restarting a Batch
Putting a batch on hold and restarting a batch are very similar. You can only use these options if your batch is running. Click the Hold button in the toolbar to put the batch on hold. When the batch is on hold, the state of the batch should be HOLD or HELD. Once the batch is on hold you can use the Restart button on the toolbar to restart the batch. When you restart the batch, the state should return to RUNNING.
Stopping and Aborting
T o stop a batch, click the Stop button on the toolbar. T o abort a batch, you must click the Abort button on the toolbar. The batch will be
aborted; you cannot use it anymore in the campaign.
Deleting a Batch or a Campaign
Deleting a batch can only be done when the state of the batch is Buffered (IN_BUFFER), Ready, Aborted, or Completed and the mode is AUTO or SEMI-AUTO. To delete a batch, click on the batch, and then click the Delete button on the toolbar.
Buffered Batches and the Batch List
• • • • •
5 Working with Batches
The batch list is the set of batches currently on the FactoryTalk Batch Server. When adding a server, you have the option of entering the number of batches to be automatically allowed on the batch list.
For example, with a 10-batch limit on Server1 and a campaign that includes 50 batches, only 10 of the batches will be added to the batch list. In this example, the list will have 10 batches on it, leaving the remaining batches in BatchCampaign in the Buffered state. They will remain there until there are no longer enough batches in the buffer to maintain 10 batches on the list, and all the batches have finished executing.
It is possible to have the number of batches on the list be greater than the configured limit by clicking on a batch which is in the “In_Buffer” state and then clicking on the Move Buffered Batch(es) to the Batch List button on the toolbar. Also, batches whose start conditions have been met will get added and started, even if this will result in the number of batches on the batch list exceeding the BatchList Count.
53
RSBIZWARE BATCHCAMPAIGN USERS GUIDE
• • • • •
54
6
Working with Campaigns
This chapter provides you with information on adding, starting, stopping, aborting, holding, restarting, and deleting campaigns. It also discusses filtering your campaigns.
The following topics are covered:
Adding a CampaignAdding a Batch to an Existing CampaignAdding an Unrelated BatchStarting a CampaignHolding and Restarting a CampaignStopping and AbortingDeleting a CampaignFiltering Campaigns
Adding a Campaign
The following steps guide you through the process of adding a campaign.
1. Click the New Campaign button at the top of the main RSBizWare™ BatchCampaign™ window. The Recipe List dialog box opens with a list of recipes that have been released to production for this server.
55
RSBIZWARE BATCHCAMPAIGN USERS GUIDE
• • • • •
2. Select the recipe to be used in the campaign, and then select the Next button. (To filter the recipe choices, see “Filtering Recipes” on page 50). The Campaign Sizing dialog
box opens.
3. Enter the Campaign Amount and Batch Count (number of batches in the campaign)
4. When the Allow a single odd sized batch box is selected, an odd-sized batch may be created between the minimum and the maximum to fulfill the remaining campaign amount.
For example, A 13,000 liter campaign size is created with a batch size of 5,000 liters. With Allow Single Odd-Sized Batch selected, there will be two batches at 5,000 liters and a single (third) batch created with a batch size of 3,000 liters, thus fulfilling the campaign size specified (2*5,000) + 3,000 = 13,000 liters.
56
5. The # of batches to keep buffered is an option used if the process may potentially, but not always, have one or more bad batches.
For example, if a campaign size of 24,000 liters of fudge is created and the batch amount is set to 4,000 liters, the batch count will automatically be set to 6 batches. Potential exists for at least one bad batch in the campaign, but it cannot be known ahead of time if a given batch is going to be bad. If 1 is entered into the # of batches to keep buffered box and the batch count is increased by 1, the count becomes 7, thereby increasing the campaign amount to 28,000 liters. One extra batch of 4,000 liters is created that will not automatically go to the batch list. It will remain in buffer until an operator manually sends it to the list, though, only if all of the batches were successfully executed.
6. Configure the Batch Size area according to the options listed in the table below:
Option Description
Minimum The minimum batch size (taken from recipe header). Default The default recipe size (taken from recipe header). Maximum The maximum recipe size (taken from recipe header).
6 Working with Campaigns
Option Description
User Allows you to choose the batch size.
Must be between the minimum and maximum batch size.
Calculated Automatically calculates the optimal batch size and batch count for the
campaign amount you entered. The algorithm uses a batch size as close to the maximum value as possible.
7. When finished entering data, click Next. The Campaign Creation dialog box opens:
• • • • •
The table below describes the options on this dialog box:
Box Description
Selected Recipe The recipe that you selected (view only).
If you click Back twice, you will be at the recipe list where you will be
able to change the recipe. Version The version of the recipe you are using (view only). Campaign ID You can change the Campaign ID to whatever you want (using
characters A-Z, 0-9). The default ID is Batch_ID. The drop down list in
the box to the right of the ID allows you to bring up individual batches in
your campaign and change them in the table, or you can select <master>
which allows you to make changes that will apply to all of the batches in
that particular campaign.
57
RSBIZWARE BATCHCAMPAIGN USERS GUIDE
• • • • •
Box Description
Start Trigger There is a scroll down list allowing you to choose how you woul d like
Scale Parameters (Only applies to recipes
which are marked as having scalable parameters)
Formula Value Name A name for a recipe parameter. Minimum Minimum value for the recipe parameter. Value Desired value for the recipe parameter.
Maximum Maximum value for the recipe parameter. Eng. Units Engineering units. Unit Alias Name given at a procedure level by the recipe author to reference the
your campaign to be triggered. The list includes:
(none) – no trigg er.
Time/Date – this allows you to enter the time and date you would like
the campaign to start.
Batch State – allows you to set the batch to start depending on the
state of any other batch transitioning to Running or Complete.
Immediate Start – this will start the campaign as soon as it is created.
Sequential Start – each batch will automatically be started when the
state of the previous batch is “complete.”
Note: The start trigger for the first batc h is not mo dif ied .
(All scalable parameters are highlighted in light blue in the dialog box.)
This allows deferred recipe parameters to be scaled automatically
according to the batch size. When the box is unchecked, the ingredient
value entered is sent to the FactoryTalk Batch Server and automatically
scaled.
To see what it will be scaled to, check the Scale Parameters box and the
scaled value will replace the original value.
When a value for the ingredient is entered and the Scale Parameters
box is checked, the actual value that the FactoryTalk Batch Server will
use is displayed. It will not be changed because it is already scaled.
For example, a batch with a default size of 4,000 liters is scaled to 5,000
liters, or 125% of the default batch size as defined in the recipe header. If
100 liters of the ingredient WATER is entered with the Scale
Parameters box unchecked, FactoryTalk Batch Server will
automatically scale the amount of the ingredient WATER to 125 liters.
When the Scale Parameters box is checked, it displays the value the
FactoryTalk Batch Server used, which would be 125 liters. If
125 liters
is entered when the Scale Parameters box is checked, the FactoryTalk
Batch Server uses the actual number you entered (in this case, 125
liters).
You can adjust the values of an individual or the master batch,
depending on what you want. If you adjust the Batch Size parameter , the
campaign size will automatically be updated in the Campaign Amount
box at the bottom of the window.
unit class.
58
6 Working with Campaigns
Box Description
Filter Y ou can filter what equipment is available for the individual units simply
by typing in a filter string criteria.
? = Any single character
* = Zero or more characters
# = Any single digit (0-9) Bound Unit You can bind a unit to a unit alias simply by picking one from the
dropdown list.
If previously specified in the FactoryTalk Batch Recipe Editor, you will
not only have the units available for binding, but two more options,
<prompt> and <first available>. The prompt option will prompt you to
choose a unit when the previous phase is complete. The first available
option will not prompt you, but use the first available unit when the
previous phase is complete. Campaign Amount The total amount in the campaign (view only). Back Go back to the previous dialog box. Create Create the campaign. Cancel Cancel the campaign creation.
8. When you are satisfied with the campaign, click Create to complete campaign
creation.
• • • • •
If FactoryTalk Batch has AutoBatchID enabled when you create a campaign, BatchCampaign calls the AutoBatchID execute one time, and what is returned becomes the Campaign ID. Each batch in the campaign gets a batch ID of the Campaign ID with a suffix denoting the number the batch is within the campaign.
For example, if a campaign with 5 batches is created, and the AutoBatchID call returns BATCHID_040703, the campaign ID will be BATCHID_040703, and the batch IDs will be BATCHID_040703.01, BATCHID_040703.02, BATCHID_040703.03, BATCHID_040703.04 and BATCHID_040703.05.
These values can be edited, if desired.
Adding a Batch to an Existing Campaign
You may occasionally want to add a batch to an existing campaign. This can easily be accomplished with RSBizWare BatchCampaign. When a new batch is added to an existing campaign, the Campaign Amount is the default value already in the campaign and the Start Trigger is set to None.
1. To add a batch to an existing campaign, select the desired campaign in the hierarchy
pane.
Be sure that the actual campaign to which you want to add the batch is selected. Otherwise, the batch will be added to the batch list and will not be associated with the campaign.
59
RSBIZWARE BATCHCAMPAIGN USERS GUIDE
• • • • •
2. Click the New Batch button on the toolbar.
3. Follow the procedures in “Adding a Batch” on page 47. The new batch ID will be the Campaign ID followed by a period (“.”) and then the next number in the campaign’s sequence of batches.
4. Start the campaign.
Adding an Unrelated Batch
With RSBizWare BatchCampaign, you can also add batches that are not associated with a campaign. Both campaigns and unrelated batches can be managed from the BatchCampaign main window.
1. To add a batch to the batch list without associating it with a campaign, select the desired server in the hierarchy pane.
2. Right-click the Server to which you want to add the batch and select New Batch from the shortcut menu (or click the New Batch button on the toolbar).
Be sure that the actual server to which you want to add the batch is selected. Otherwise, the batch may be added to a campaign.
3. Follow the procedures in “Adding a Batch” on page 47. The newly created batch will be listed under the server name in the hierarchy pane.
60
Starting, Stopping, Aborting, and Deleting Campaigns
Campaigns (multiple batches) that are on a FactoryTalk Batch Server’s batch list can be started, held, restarted, and deleted from the main BatchCampaign window.
Starting a Campaign
1. Click the desired Server or Campaign Entry/Item on the Main Window, in the hierarchy pane on the left, to display the individual batches in the details pane on the right.
2. Click on the campaign entry you want to start, and then click the Start button.
Holding and Restarting a Campaign
Putting a campaign on hold and restarting it are very similar. You can only use these options if your campaign is running. Click the Hold button in the toolbar to put the campaign on hold. When the campaign is on hold, the state of the campaign should be HOLD or list HELD. Once the campaign is on hold you can use the Restart button on the toolbar to restart the campaign. When you restart the campaign, the state should return to RUNNING.
Stopping and Aborting
T o stop a campaign, click the Stop button on the toolbar. To abort a campaign, you must click the Abort button on the toolbar. The campaign will
be aborted; you cannot use it anymore in the campaign.
Deleting a Campaign
Deleting a campaign can only be done when the state of the campaign is Buffered (IN_BUFFER), Ready, Aborted, or Completed and the mode is AUTO or SEMI-AUTO. T o delete a campaign, select it, and then click the Delete button on the toolbar.
Filtering Campaigns
BatchCampaign version 9.0 and later gives you the ability to not only filter recipes, but to filter campaigns as well. Campaign filtering allows you to view a subset of all campaigns running on a FactoryTalk Batch Server.
1. In the Hierarchy pane, right-click on the server on which you want to filter campaigns.
2. From the shortcut menu, select Filter Campaigns. The Filter Campaigns dialog box opens.
• • • • •
6 Working with Campaigns
3. Select the desired Filter Criteria from the list. The following criteria can filtered:
Process Cell Product NameRecipe Name Product CodeCampaign Name Recipe Type
4. Enter a Filter Pattern to be used. Standard pattern matching characters are used:
? (question mark) Matches any single character * (asterisk) Matches zero or more characters # (number sign) Matches any single digit from 0 to 9
61
RSBIZWARE BATCHCAMPAIGN USERS GUIDE
• • • • •
You can specify multiple filter patterns by separating them with a comma. Each pattern is appended with an OR expression.
Example: PROC*,SERV#
5. Click OK to apply the campaign filter. The filter applies only to the selected server. When the campaigns for that server are filtered, the message “Campaign List Filtered” is appended to the server name.
You can remove a filter by right-clicking on the filtered campaign and selecting Remove Filter from the shortcut menu.
62
A
RSBizWare BatchCampaign Database
How is the RSBizWare BatchCampaign Database Different from the FactoryTalk Batch Recipe Database?
The RSBizWare™ BatchCampaign™ database is a database used by BatchCampaign to store the batches that are in buffer. BatchCampaign can use either the provided Access database or a SQL database. If a SQL data is used BatchCampaign will create the required tables in the database. Batches that are not on the Batch List need to be stored somewhere so that they are not lost when you shut down BatchCampaign. In contrast, the Batch Recipe Database stores the recipes created in the Recipe Editor in its database tables. This database can be used by BatchCampaign in place of binary or XML recipe storage, giving you options on what recipes to use when creating a campaign, and which deferred recipe parameters are scalable. BatchCampaign will work with any of these three recipe storage formats.
BatchCampaign Database Schema
63
RSBIZWARE BATCHCAMPAIGN USERS GUIDE
• • • • •
64
Index
A
abort
53
batches campaigns
add
batches campaign multiple servers
server advanced tab All tab allow batch stopping/aborting AutoBatchID
B
batch
abort
add
buffer
delete
hold
restart
start
stop batch amount batch ID batch limit batch list Batch Server
computer
identify names bound unit buffered batches buffering database buttons
C
calculated 57 campaign
abort
add
61
47
55
20, 40
19, 40
19, 40
50, 59
53
47
53 53
53
53
52
53
50
34, 49
42
53
3
50, 59
35
61
55
12
53
22
44
45
59
amount
61
delete
60
hold
60
restart
60
start
61
stop campaign ID communicating with FactoryTalk Batch Server
communication
to FactoryTalk Batch Server lost
with FactoryTalk Batch Server configuration requirements
for Windows Server 2003 configure
database
RSBizWare BatchCampaign
RSBizWare BatchCampaign security confirmation
enable for commands connection tab
57
31
31
31
5
16
16
26
28
18
D
database
configure
schema default
recipe size delete
batches
campaigns DEP settings
changing description
16
63
56
53
61
7
7
34
E
elapsed time 34 enable confirmation
for RSBizWare BatchCampaign commands
28
enable security
24
v
RSBIZWARE BATCHCAMPAIGN USERS GUIDE
• • • • •
eng. units 49, 58 error handling
configure
44
F
FactoryTalk Activation 12 FactoryTalk Administration Console FactoryTalk Batch Server
22
add FactoryTalk Help FactoryTalk Security
50, 59
filter
criteria
recipes
remove
52
type first available formula value name
23
24
52 50
62
50, 59
49, 58
H
HMI 45 hold
53
batches
campaigns human interface human-machine interface (HMI)
60
2
45
I
identify
Batch Server names ignore timeout install
RSBizWare BatchCampaign
SQL Server 2005 (optional)
45
12
12
12
L
language support 5 log in
to RSBizWare BatchCampaign
25, 26
M
master 57 master node maximum Microsoft compatibility list
44
49, 56, 58
3
24, 27
minimum miscellaneous mode
49, 56, 58
44
34
N
name 41 node address NTFS drives
41 4
O
odd-sized batch 56
P
pre-installation procedures
Batch Server
identify Batch Server names
FactoryTalk Batch Server
install SQL Server 2005 (optional)
50, 59
prompt provider provider tab
42
18, 38
12
R
recipe 34
attribute database filtering
size remove filters restart
batches
campaigns RSBizWare BatchCampaign
configure
installing
logging in RSBizWare BatchCampaign database
51
42, 44
50
56
62
53
60
16
12
25, 26
S
scale parameters 49, 58 scan rate security
selected recipe
41
configure
24
enable
26
57
12
63
vi
INDEX
• • • • •
servers
working with
42
source SQL Server 2005
install (optional)
start
batches campaigns RSBizWare BatchCampaign
34
time trigger (for batch) trigger (for campaign)
34
state stop
batches campaign
system requirements
40
12
52
60
49
53
61
3
T
timeout 41
35
toolbar
58
33
U
unit alias 49, 58 unit binding user user account
FactoryTalk Security
Windows
Windows-linked user interface
50, 59
57
26
34
V
value 49, 58 version
57
recipe View security
Single-SignOn
W
workgroup
configuring client
26
26
25
24
vii
Loading...