FactoryTalk eProcedure User Guide - Literature Library

FactoryTalk eProcedure User Guide - Literature Library
User Guide
FactoryTalk eProcedure
User Guide
FactoryTalk® eProcedure Client
Important User Information
Solid-state equipment has operational characteristics differing from those of electromechanical equipment. Safety Guidelines for the Application,
Installation, and Maintenance of Solid State Controls (publication SGI-1.1 available from your local Rockwell Automation sales office or online at
http://www.rockwellautomation.com/literature/) describes some important differences between solid-state equipment and hard-wired
electromechanical devices. Because of this difference, and also because of the wide variety of uses for solid-state equipment, all persons responsible for
applying this equipment must satisfy themselves that each intended application of this equipment is acceptable.
In no event will Rockwell Automation, Inc. be responsible or liable for indirect or consequential damages resulting from the use or application of this
equipment.
The examples and diagrams in this manual are included solely for illustrative purposes. Because of the many variables and requirements associated
with any particular installation, Rockwell Automation, Inc. cannot assume responsibility or liability for actual use based on the examples and
diagrams.
No patent liability is assumed by Rockwell Automation, Inc. with respect to use of information, circuits, equipment, or software described in this
manual.
Reproduction of the contents of this manual, in whole or in part, without written permission of Rockwell Automation, Inc., is prohibited.
Throughout this manual, when necessary, we use notes to make you aware of safety considerations.
WARNING: Identifies information about practices or circumstances that can cause an explosion in
a hazardous environment, which may lead to personal injury or death, property damage, or
economic loss.
ATTENTION: Identifies information about practices or circumstances that can lead to personal
injury or death, property damage, or economic loss. Attentions help you identify a hazard, avoid a
hazard, and recognize the consequence
SHOCK HAZARD: Labels may be on or inside the equipment, for example, a drive or motor, to
alert people that dangerous voltage may be present.
BURN HAZARD: Labels may be on or inside the equipment, for example, a drive or motor, to alert
people that surfaces may reach dangerous temperatures.
Important:
Identifies information that is critical for successful application and understanding of the product.
Allen-Bradley, Rockwell Software, and Rockwell Automation ControlLogix, eProcedure, FactoryTalk, RSBizWare, RSBizWare BatchHistorian, RSBizWare Historian, RSBizWare MaterialTrack, and RSLinx are
trademarks of Rockwell Automation, Inc.
Trademarks not belonging to Rockwell Automation are property of their respective companies.
Table of contents
Chapter 1
Document organization .......................................................................................................7
Introducing the eProcedure client .....................................................................................7
Client interface ......................................................................................................................8
Log in button..................................................................................................................8
Information area ............................................................................................................8
Filter area.........................................................................................................................9
View selection area ........................................................................................................9
Help button ....................................................................................................................9
User-defined area...........................................................................................................9
Command area............................................................................................................ 10
Open the eProcedure Client ............................................................................................ 12
eProcedure Client views.................................................................................................... 12
Select the filter view ........................................................................................................... 13
Run on Internet Explorer version 7.x and higher ........................................................ 14
Introduction
Chapter 2
Use the Batch List
view
Information in the Batch List view................................................................................. 18
Navigate in the Batch List view ....................................................................................... 18
Batch List view command buttons ......................................................................... 18
Command a batch in the Batch List view ............................................................. 19
Add a batch to the batch list .................................................................................... 20
Start a batch ................................................................................................................. 23
Hold a batch ................................................................................................................ 23
Restart a batch ............................................................................................................. 23
Abort a batch............................................................................................................... 24
Stop a batch ................................................................................................................. 24
Place a batch in manual mode .................................................................................. 25
Place a batch in automatic mode ............................................................................. 25
Remove a batch from the batch list ........................................................................ 26
Perform semi-auto processing .................................................................................. 26
Chapter 3
Use the Equipment
List view
Information in the Equipment view............................................................................... 30
Navigate in the Equipment view ..................................................................................... 30
Equipment view command buttons ....................................................................... 31
Command a batch in the Equipment view ................................................................... 31
Start a batch ................................................................................................................. 31
Use the hyperlinks ...................................................................................................... 32
Rockwell Automation Publication eProcedure Client User Guide - February 2017
3
Table of contents
Command phases ............................................................................................................... 32
Acquire a phase ........................................................................................................... 32
Start a phase ................................................................................................................. 33
Start a material-based phase ..................................................................................... 33
Reset a phase ................................................................................................................ 34
Release a phase ............................................................................................................ 34
Run an individual phase in auto mode ................................................................... 34
Perform semi-auto phase processing....................................................................... 35
Disconnect an equipment module .......................................................................... 36
Chapter 4
Use the Procedure
view
4
Information in the Procedure view................................................................................. 37
SFC view ...................................................................................................................... 38
Table view .................................................................................................................... 39
Navigate in the Procedure view ....................................................................................... 39
Procedure view command buttons ......................................................................... 39
Command a batch in the Procedure view ..................................................................... 40
Start a batch ................................................................................................................. 40
View the batch properties ......................................................................................... 40
View parameters.................................................................................................. 40
Edit parameter values......................................................................................... 40
View the report parameters .............................................................................. 41
View expression values....................................................................................... 41
View the recipe header information ............................................................... 43
View material data.............................................................................................................. 43
Run material-based recipes without the Material Server.................................... 44
Work with phases............................................................................................................... 45
Manual phase binding ............................................................................................... 45
Prompted binding ...................................................................................................... 46
Binding to a material-enabled phase step .............................................................. 47
Off-line material binding .......................................................................................... 48
Manual phase control binding ................................................................................. 49
Work with timer steps....................................................................................................... 49
Reset a timer step ........................................................................................................ 50
Force a timer step to complete ................................................................................. 50
Change the setpoint of a timer step ........................................................................ 51
Make active step changes .................................................................................................. 52
Rockwell Automation Publication eProcedure Client User Guide - February 2017
Table of contents
Chapter 5
Use the Instructions
view
Information in the Instructions view ............................................................................. 54
Instructions view command buttons...................................................................... 54
Execute control steps ......................................................................................................... 55
Locate the control step .............................................................................................. 56
Enter report values ..................................................................................................... 56
Confirm report values ............................................................................................... 57
Verify report values ............................................................................................................ 57
Cancel a signature request ........................................................................................ 58
Use instruction-based equipment modules................................................................... 59
Reactivate a control step ................................................................................................... 60
Step reactivation with a signature request ............................................................. 62
Chapter 6
Use the Signature
List view
Electronic signature types ................................................................................................. 63
How electronic signatures work ...................................................................................... 63
View the signature list ....................................................................................................... 65
Resize columns ............................................................................................................ 65
Sort the signature list ................................................................................................. 66
Acknowledging a signature request ................................................................................ 66
Use report verifications ..................................................................................................... 67
Complete a report verification ................................................................................ 68
Configuration of a report verification policy........................................................ 69
Configure eProcedure step verification policies........................................................... 70
Legal Notices
Legal Notices ....................................................................................................................... 71
Index
Index ..................................................................................................................................... 73
Rockwell Automation Publication eProcedure Client User Guide - February 2017
5
Chapter 1
Introduction
This document provides information and procedural instructions required to
create and command batches using the FactoryTalk® eProcedure® Client, and can
be used as a reference guide by the operator.
Document
organization
Introducing the
eProcedure client
The following subjects are presented in this document:
•
Introduction to the Client
•
Using the Client Views
•
Commanding a Batch
The eProcedure Client is a web-based application that uses instruction files to step
through the process of creating and commanding a batch. You can view
equipment or procedures for batches running within the plant.
The eProcedure Client’s security is an extension of the security implemented for
the FactoryTalk Batch View and uses the defined FactoryTalk Security policy
settings for commands. The eProcedure Client uses those settings to determine
which users have permissions to log into the Client. FactoryTalk Batch security
policies are located in the FactoryTalk Directory. (See the FactoryTalk Batch
Administrator Guide for more information on security.)
One of the security policies created is Single-SignOn. Single sign-on capability
allows users to log on just once, per directory, on a given computer. Once a user is
logged onto FactoryTalk, all participating FactoryTalk-enabled products that run
in that directory on that computer automatically use the security credentials of the
logged on user. This allows users to work with multiple Rockwell products
simultaneously, without having to log on to each product separately. (See the
FactoryTalk Security Help for more information.)
The system administrator must configure FactoryTalk Security prior to using the
eProcedure Client. Instructions for configuring security can be found in the
Administrator Guide. While in the eProcedure Client, any FactoryTalk Security
user with the appropriate permissions can log in or out.
Tip:
The eProcedure client installation modifies Internet Explorer
security settings. See the FactoryTalk Batch Components Upgrade
and Installation Guide for more information.)
Rockwell Automation Publication eProcedure Client User Guide - February 2017
7
Chapter 1
Introduction
Client interface
The eProcedure Client provides a graphical representation of a running batch and
its associated data.
Important:
If the eProcedure Client does not display when you open Internet
Explorer, you must set the eProcedure Client as your home page.
In Internet Explorer, select Internet Options from the Tools menu,
enter http://[computer name]/eProcedure (where [computer
name] is the name of the computer where the Client is installed) in
the Home page box, and then click OK. Do the same for any other
user accounts that also use the eProcedure Client on the
computer.
The display is divided into five areas: Information area, Filter area, View
Selection area, User-Defined area, and Command area.
Log in button
The eProcedure Client displays the user name of the currently logged in user. The
Log In button is used to log out the current user and log in a new FactoryTalk
Security or Windows-linked user. (See the FactoryTalk eProcedure Administrator
Guide for more information on FactoryTalk Security.)
Information area
The Information area displays information regarding the plant’s equipment and
the current batches. When one of the buttons is clicked in the View Selection
area, the information displayed within the Information area changes accordingly.
For example, clicking the Procedure button displays the Procedure view. In
addition, when the button in the Filter area is clicked, the Information area
displays the Filter Selection view.
8
Rockwell Automation Publication eProcedure Client User Guide - February 2017
Chapter 1
Introduction
You can filter by either equipment or procedure. The Filter area displays
information regarding the current filter.
Filter area
The following examples show text that you might see as the filter changes:
Area Filter
(Equipment)
Unit Filter
(Equipment)
Procedure Filter
(Procedure)
Operation Filter
(Procedure)
View selection area
The View Selection area contains four buttons. Each button activates a different
view within the information area. The Equipment button activates the
Equipment view. The Instructions button activates the Instructions view. The
Batches button activates the Batch List view. The Procedure button activates the
Procedure view. The Signatures button displays the Signature List. The Help
button opens a Help file for the eProcedure Client or the eProcedure ActiveX
Controls.
The Help button accesses user assistance for the eProcedure Client and the
eProcedure ActiveX Controls, depending on the current Client focus, as
described below:
Help button
eProcedure Help: Select the Help button in the View Selection area to open the
user assistance file for the eProcedure Client.
ActiveX Help: Press the F1 key while an ActiveX control has focus to open the
user assistance file for the eProcedure ActiveX Controls.
Tip:
User-defined area
If selecting Help from the Microsoft Internet Explorer menu bar or
pressing F1 when an ActiveX control does not have focus, the user
assistance for Internet Explorer opens.
You can add custom content, such as your company logo linked to your Web site,
to the User-Defined area. The default content is the Rockwell logo. (See
Customizing eProcedure in the eProcedure Administrator Guide for information
on adding custom content.)
Rockwell Automation Publication eProcedure Client User Guide - February 2017
9
Chapter 1
Introduction
Command area
The Command area contains buttons used to command batches. As the view in
the Information area changes, the command buttons also change. Only buttons
that represent valid commands for the current filter are enabled.
Command Area Buttons
Equipment View
Instructions View
Batch List View
Procedure View
The following are descriptions of each command button:
Start/Restart: This is a toggle button. Starts or restarts a batch that is currently
on the Batch List, based upon its current state.
Hold: Holds a batch that is currently running.
Stop: Performs an orderly termination of a currently running batch.
Abort: Performs an emergency termination of a currently running batch.
Resume: Continues processing on a batch that is paused in Semi-Auto mode.
Manual/Auto: This is a toggle button. If the batch is in the Auto mode, the
button displays.
Manual: If the batch is in the Manual mode, the button displays Auto. Manual
mode allows you to control the execution of the remaining steps in the current
batch. Auto mode gives control of the running batch to the FactoryTalk Batch
Server.
10
Rockwell Automation Publication eProcedure Client User Guide - February 2017
Chapter 1
Introduction
Semi-Auto/Manual: This is a toggle button. If the batch is in the Semi-Auto
mode, the button is labeled Manual. If the batch is in the Manual mode, the
button is labeled Semi-Auto. Manual mode allows you to control the execution of
the remaining steps in the current batch. Semi-Auto mode allows you to control
the execution of all filter steps in the current batch.
Add: Adds a batch to the Batch List.
Remove: Removes a batch from the Batch List.
Comment: Allows you to add a comment to the electronic batch record for the
current batch.
Clear Failures: Clears all failures.
Disconnect: Allows you to disconnect an unusable equipment module from the
Batch Server.
Acquire/Release: Allows you to take or release ownership of the selected
resource.
Reset: Resets the selected resource to the Idle state.
Zoom In: Increases the zoom percentage, increasing the size of the objects in the
Information area.
Zoom Out: Decreases the zoom percentage, decreasing the size of the objects in
the Information area.
Refresh: Refreshes the display in the Instruction view.
Show Past/Hide Past: This is a toggle button. Show Past displays all of the
control steps completed for the current batch. Hide Past hides the past steps.
Show Future/Hide Future: This is a toggle button. Show Future displays all of
the control steps to be executed for the current batch. Hide Future hides the
future steps.
Reactivate Step: Used with the Show Past button to reactivate any past control
step that has not been reactivated, is in a phase that is currently in the RUNNING
state, and does not have a pending reactivated step.
Bind: Binds a unit procedure or operation to a particular unit.
Step Change: Allows you to change the current active step, enabling you to re-run
a previous step, or if appropriate, skip a step.
Details: Opens a dialog box allowing you to review the batch header data, modify
parameter data, and enter report data.
Rockwell Automation Publication eProcedure Client User Guide - February 2017
11
Chapter 1
Introduction
Timer Complete: Forces a Timer step to complete.
Timer Reset: Resets the ELAPSED_TIME in a Timer step to 0 (if the Timer step
is configured as a COUNT_DOWN timer the REMAINING_TIME will be
reset to the setpoint value).
Table/SFC: This is a toggle button. Table displays the current batch in table
form. SFC displays the current batch in Sequential Function Chart (SFC) form.
Open the
eProcedure Client
The eProcedure Client runs in Internet Explorer. The FactoryTalk Batch Server
and eProcedure services should be running prior to opening the Client. If
configured properly, Internet Explorer can use the eProcedure Client as the home
page so that when you open Internet Explorer the eProcedure Client opens. (See
the FactoryTalk Batch Components Upgrade and Installation Guide for more
information.)
Tip:
eProcedure Client
views
12
By default, the FactoryTalk Batch Server starts automatically when the
computer is started. The FactoryTalk Batch Server and eProcedure Server
must be running before opening the eProcedure Client.
The eProcedure Client provides information regarding current batches and the
facility’s equipment in five unique views. Each view displays different information.
The information displayed is based on the current filter, except for the Batch List
and Signature List views, which present information unfiltered. Each view also
allows for the issuing of commands to the batch.
•
Batch list view
Enables the operator to create and command a batch. A batch remains on
the Batch List until the operator removes it, or the FactoryTalk Batch
Server is restarted with a cold boot. See Use the Batch list view for more
information.
•
Equipment view
Provides a graphical view of your facility’s equipment. The Equipment view
displays run-time information that is relevant to the type of equipment
displayed. You can use the predefined hyperlinks to access custom Web
pages, documents, or applications. See Use the Equipment view for more
information.
•
Procedure view
Provides an SFC view and a Table view of the selected batch, unit procedure
or operation. The Procedure view allows you to command any portion of
the batch, from the procedure level down to the phase level. See Use the
Procedure view for more information.
Rockwell Automation Publication eProcedure Client User Guide - February 2017
Chapter 1
Introduction
•
Instructions view
Provides the ordered list of control steps for the selected filter. You can view
Current, Past, and Future control steps. See Use the instruction view for
more information.
•
Signature List view
Displays a list of pending signatures and their related commands, report
parameters, etc., which are maintained on the FactoryTalk Batch Server. See
Use the Signature list view for more information.
See also
Use the Batch List view on page 17
Use the Equipment view on page 29
Use the Procedure view on page 37
Use the Instructions view on page 53
Use the Signature List view on page 63
Select the filter view
The information displayed in the eProcedure Client view is based upon the
current filter, with the exception of the Batch List view, which displays all current
batches.
To access the Filter view, click the Select Filter button in the Filter area of the
eProcedure Client page. The Filter view has two distinct areas: Equipment and
Procedures.
Rockwell Automation Publication eProcedure Client User Guide - February 2017
13
Chapter 1
Introduction
The Equipment area contains the area, process cells, and units defined in your area
model. Clicking one of the equipment resources returns you to the current view
where the information is filtered based upon the selected resource.
The Procedure area displays all batches currently on the Batch List, including their
subordinate unit procedures and operations. Phases are not listed here, as they are
displayed when an operation is selected. Clicking one of the procedures returns
you to the current view, where the information is filtered based on the selected
procedure.
If you do not want to change the filter, click Cancel to return to the current view.
Run on Internet
Explorer version 7.x
and higher
Since version 7.0, Microsoft Internet Explorer allows multiple web pages to be
open in the same browser window. These individual web pages are represented by
tabs on the browser window.
This new functionality allows you to open more than one instance of the
eProcedure Client, either by opening it on a new tab or in a new browser window.
This enables you to select the various eProcedure views just by clicking a tab.
From a security aspect, the user who is currently logged on will be the logged on
user on all tabs or browser windows running the eProcedure Client. For example,
if a user named James is logged on to the eProcedure Client in the Equipment
view, he can right-click the Batches button and select Open Link in New Tab
from the pop-up menu.
14
Rockwell Automation Publication eProcedure Client User Guide - February 2017
Chapter 1
Introduction
This opens the Batch view on a new tab, as shown below. The user James is logged
on to both views.
If another user logs on to the Batch view, that new user is also logged on to other
views on all tabs or other browser windows. Following the example shown above,
if Mary logs onto the Batch view, she is also logged on to the Equipment view.
Rockwell Automation Publication eProcedure Client User Guide - February 2017
15
Chapter 2
Use the Batch List view
The Batch List view provides an overview of the batches that are running, ready to
run, or complete. The Batch List view is used to create and command batches. A
batch remains on the Batch List until you remove it or until the FactoryTalk
Batch Server is restarted with a cold boot.
Batches are specific instances of the master recipes developed for your facility.
When you create a batch you may be prompted to select or input parameter values,
and/or to select specific units in which the batch will run.
Tip:
If you are running Internet Explorer version 7.0 or higher, it is possible to
have multiple instances of the eProcedure Client running in the same
browser window. The current user will be logged on to all instances.
(See Run on Internet Explorer version 7.x for more information.)
See also
Run on Internet Explorer version 7.x on page 14
Rockwell Automation Publication eProcedure Client User Guide - February 2017
17
Chapter 2
Use the Batch List view
Information in the
Batch List view
The Batch List view includes information regarding each batch that is on the
Batch List. You can use the horizontal scroll bar to scroll right and left to view all
of the columns of data. A vertical scroll bar is included if there are more batches
on the Batch List than can display in the allotted area.
The following data is included in the Batch List view:
Item
Description
Batch ID
User-entered or automatically generated identification of the
batch. Each Batch ID must be unique.
Recipe
Name of the recipe from which the batch was created.
Description
Description of the recipe.
Start Time
Time the batch was started.
Elapsed Time
Elapsed time measured from the start time, updated after
completion
of a phase.
State
Current state of the batch.
Mode
Current mode of the batch.
Failure
Failure information for the batch.
Process Cell
Name of the process cell in which the batch is running.
Units in Use
Units currently in use by the batch.
Phases In Use
Phases the batch is currently running.
CreateID
Unique ID assigned by the FactoryTalk Batch Server to the
batch when it is created.
Batches are listed in the Batch List view in alphanumeric order by Batch ID. You
can toggle the order from ascending to descending by clicking on the Batch ID
column heading. You also can sort batches on any other column heading by
clicking on the desired column. When you exit eProcedure, the sort order reverts
to the default alphanumeric order by Batch ID.
Navigate in the
Batch List view
You can change the filter to a specific batch and move to the Procedure view by
double-clicking the batch in the Batch List.
Batch List view
command buttons
You can use the Batch List view to add a batch to and command batches on the
Batch List. The Command area includes the command buttons that pertain to
each Batch List view. If you wish to command a batch, you must first select the
batch. The appropriate command buttons are then enabled, based on the state and
mode of the selected batch. (See Command area for more information.)
See also
Command area on page 10
18
Rockwell Automation Publication eProcedure Client User Guide - February 2017
Chapter 2
Use the Batch List view
Command a batch in
the Batch List view
You can issue Batch commands by using the command buttons in the Batch List
view, Equipment view and the Procedure view. Only buttons representing valid
commands are enabled. Some of the command buttons are toggles, meaning that
the button label will change, depending on the state of the batch. For example, if a
batch’s state is READY, the label on the Start/Restart button is Start. However,
if the batch’s state is HELD, the button’s label is Restart.
Possible Batch States and Color Indicators
READY
Black
COMPLETE
Dark Gray
IDLE
Black
RUNNING
Dark Green
RESTARTING
Green
STARTING
Green
CONNECTING
Green
DOWNLOADING
Green
UPLOADING
Dark Green
UPLOAD_HELD
Dark Yellow
HOLDING
Yellow
HELD
Dark Yellow
STOPPING
Blue
STOPPED
Dark Blue
ABORTING
Magenta
ABORTED
Dark Magenta
Possible Modes in the Mode Column
O_AUTO
The batch is running normally and is under FactoryTalk Batch Server
control. Operator intervention is not required to complete the batch.
MANUAL
The batch is running manually and is under operator control. When a
batch is placed in Manual, the current step is completed and the
batch waits for the operator to perform an active step change and/or
return the batch to the Auto mode to continue.
S_AUTO
The batch is running normally and is under operator control. When a
recipe level is placed in Semi-Auto, the current step is completed and
pauses at the next transition as it becomes TRUE. The operator is
required to issue the Resume command or return the batch to the
Auto mode.
Rockwell Automation Publication eProcedure Client User Guide - February 2017
19
Chapter 2
Use the Batch List view
Add a batch to the
batch list
When adding a batch, a list of the master recipes is presented that have been
defined and released to production for the facility. It may be necessary to enter
parameter values and unit binding information when adding the batch to the
Batch List.
1. Select the Add button. The Master Recipe List dialog box opens,
displaying the list of master recipes.
2. To filter the list of recipes, select an option from the Filtering Column list,
and then select Refresh.
Tip:
If the recipe list is empty, select Cancel to close the Master Recipe List
dialog box. Select the Add button again. If the recipe list is still empty,
please refer to the Administrator Guide for instructions on configuring
Server Options to point to the recipe directory.
3. Select the appropriate master recipe and select OK.
4. If the recipe contains a material class-based phase, the Material Value
Selection dialog box opens. If not, skip to step 6.
20
Rockwell Automation Publication eProcedure Client User Guide - February 2017
Chapter 2
Use the Batch List view
5. From the Material list, select the material to use in this particular batch,
and then select Create. The Batch Creation dialog box opens.
If creating a batch of a material-based recipe and the FactoryTalk
Batch Server has lost communication with the Material Server and is
Warning set to continue processing in MANUAL mode, the following warning
shows:
"WARNING: MATERIAL SERVER NOT IN USE." You can continue to
create and run the batch, but automatic binding will not occur. You are
prompted to select the container/equipment module pair that can
supply the correct material to continue processing the batch. Use
extreme caution when operating without the Material Server. The
container/equipment module list is not filtered by the Material Server
when it is unavailable. Failure to select the correct
container/equipment module pair could result in a hazardous situation,
depending on the material. (See Running material-based recipes
without the Material Server for more information.)
6. If a Batch ID is not automatically generated, type a unique Batch ID. The
Batch ID can be comprised of any character except the following: The
defined list separator, spaces, single or double quotes, brackets, parentheses,
the percent sign (%), the tab character ( \t ), the carriage return character (
\r ), or the new line character ( \n ). The maximum length of the Batch ID is
255 characters.
Tip:
A Batch ID box that appears dimmed cannot be change it. The option to
make the Batch ID editable is set by the system administrator in the
System Configuration and Defaults dialog box on the General tab.
7. If the batch is to be run at a percentage other than 100%, in the Scale box,
type a percentage by which to scale the recipe.
All phase parameters that were marked as scalable in the FactoryTalk Batch
Equipment Editor and all operation or unit parameters that were marked as
scalable in the FactoryTalk Batch Recipe Editor are adjusted proportionally
by the entered percentage. Any phase, unit, or operation parameters that are
not marked as scalable are not adjusted; their values remain the same as the
original value specified no matter how the batch is scaled.
Rockwell Automation Publication eProcedure Client User Guide - February 2017
21
Chapter 2
Use the Batch List view
8. If there are formula values that need to be assigned or modified, select the
Value cell in the Formula Values area and enter a new value.
If this is a class-based recipe, and the recipe has a unit allocation method of
At Batch Creation or Operator Choice, specify the unit allocation
requirements. If the unit allocation method is At Batch Creation, choose a
specific unit from a list of the available units. If the unit allocation method
is Operator Choice, then choose from a list of available units, or select the
Prompt or First Available unit allocation methods.
9. Select the Bound Unit cell in the Unit Binding area to activate the Bound
Unit list. Make an appropriate selection.
Tip:
If the recipe does not require that any formula values be assigned, the
Formula Values area contains a single blank row. Likewise, if the recipe
does not require any unit binding, the Unit Binding area contains a single
blank row.
10. Select Create to add the batch to the Batch List window. The Start
command button is enabled.
Important:
22
If control strategies are enabled for a recipe, changing the selected
control strategy after the recipe is added to the batch list could
corrupt that recipe.
Rockwell Automation Publication eProcedure Client User Guide - February 2017
Chapter 2
Use the Batch List view
Tip:
When a recipe is set to Release Recipe to Production, but makes
reference to one or more sub-recipes or embedded procedures
that are not set to Release Recipe as Step, that recipe cannot be
used to create a batch. Ensure that all steps in the recipe are set to
Release Recipe as Step.
See also
Run Material-Based Recipes Without the Material Server on page 44
The Start command starts a batch when it is in the READY state. You can start a
batch from the Batch List, Equipment or Procedure views.
Start a batch
1. Open the appropriate eProcedure Client view.
2. Use the Filter area to select the batch to start.
3. Click the Start button. The batch transitions to the RUNNING state.
The Hold command temporarily stops the execution of the batch at a step. A
HELD batch may be RESTARTED, STOPPED, or ABORTED. A batch may be
started from the Batch List, Equipment or Procedure views.
Hold a batch
1. Open the appropriate eProcedure Client view.
2. Use the Filter area to select the procedure to be held.
3. Click the Hold button. The batch transitions to the HELD state.
Restart a batch
Restarting a batch begins the execution of the batch that is in the HELD state.
Unless there has been an active step change, the batch will restart with the step
that was active at the time the batch was HELD. You should not restart a batch if
there are associated phases that are failed or in external control. You can restart a
batch from the following eProcedure Client views: Batch List, Equipment and
Procedure.
1. Open the appropriate eProcedure Client view.
2. Use the Filter view to select the procedure to be restarted.
3. Click the Restart command button. The batch transitions to the
RUNNING state.
Rockwell Automation Publication eProcedure Client User Guide - February 2017
23
Chapter 2
Use the Batch List view
Abort a batch
The ABORT command is used to permanently stop the execution of a batch at
the current step, generally in emergency situations. You can abort a batch only
when it is in one of the following states: RUNNING, STOPPING, HOLDING,
HELD, or RESTARTING. A batch may be aborted from the Batch List,
Equipment or Procedure views. You must be authorized to Stop or Abort batches.
Important:
ABORTED batches cannot be restarted.
1. Open the appropriate eProcedure Client view.
2. Use the Filter view to select the procedure to be aborted.
3. Click the Abort command button.
4. Enter your User Name and Password (if security is enabled) and click OK.
The batch transitions to the ABORTED state.
Tip:
Stop a batch
If a batch contains a phase that is in the UPLOAD_HELD state, the
ABORT command may not abort that phase (it does abort all other
phases, however). If the phase is uploading data to the FactoryTalk Batch
Server, it will not abort unless the phase has transitioned to a different
state. This ensures that all report values have been captured. If you want
to abort a phase that is in UPLOAD_HELD, you must first disconnect the
phase and then you can abort it.
The STOP command is used to permanently stop the execution of a batch at the
current step, generally in non-emergency situations. You can stop a batch only
when it is in one of the following states: RUNNING, HOLDING, HELD, or
RESTARTING. You cannot restart a STOPPED batch. A batch can be stopped
from the Batch List, Equipment or Procedure views. You must be authorized to
Stop or Abort batches.
Important:
STOPPED batches cannot be restarted.
1. Open the appropriate eProcedure Client view.
2. Use the Filter view to select the procedure to be stopped.
3. Click the Stop command button.
4. Enter your User Name and Password (if security is enabled) and click OK.
The batch transitions to the STOPPED state.
24
Rockwell Automation Publication eProcedure Client User Guide - February 2017
Chapter 2
Use the Batch List view
Place a batch in
manual mode
A batch or step can be placed in MANUAL mode to allow the operator to
perform an active step change. The batch must be active to place any part of the
batch in MANUAL. When you place one level of a recipe in MANUAL mode,
MANUAL propagates upward. A batch or step placed in MANUAL mode will
allow the active step(s) to complete, but will not automatically transition to the
next step. For example, assume you have a recipe with two unit procedures in
succession. The first unit procedure consists of three operations, the first two
operations run in parallel and the third follows the two parallel operations. Once
you start the batch, you place the first unit procedure within this recipe in
MANUAL, which places the procedure in MANUAL. The two parallel
operations execute normally, and execution halts prior to starting the next
operation. You must now either perform an active step change, or return the unit
procedure to AUTO. After returning the unit procedure to AUTO, it will
continue to execute normally, but execution will halt prior to starting the next
unit procedure. In order to start execution of the next unit procedure you must
place the procedure in AUTO. A batch or step may be placed in the manual mode
from the Batch List, Equipment or Procedure views.
1. Open the appropriate eProcedure Client view.
2. Use the Filter view to select the procedure to be placed in the manual mode.
You should select the lowest appropriate batch level and place it in
MANUAL mode (for example, unit procedure or procedure).
3. Click the Manual command button. The batch completes the active step
and the step transitions to the COMPLETE state. The batch must be
placed in AUTO mode to resume automatic execution.
Place a batch in
automatic mode
A batch or step that is in MANUAL mode must be placed in AUTOMATIC
mode to continue normal execution. A batch or step may be placed in
AUTOMATIC mode from the following eProcedure Client views: Batch List,
Equipment and Procedure.
1. Open the appropriate eProcedure Client view.
2. Use the Filter view to select the batch that is to be placed in
AUTOMATIC mode. To place the entire batch in AUTO mode, you
should select the highest recipe level and place it in AUTOMATIC mode
(i.e., unit procedure or procedure).
3. Click the Auto command button. The batch will continue to sequence
automatically.
4. All higher level steps are left in MANUAL mode and all lower level steps are
placed in AUTO mode.
Rockwell Automation Publication eProcedure Client User Guide - February 2017
25
Chapter 2
Use the Batch List view
Remove a batch from
the batch list
To remove a batch from the Batch List it must be in one of the following states:
•
STOPPED
•
COMPLETE
•
ABORTED
•
READY
•
IDLE
In the Batch List view, select the batch to be removed and click the Remove
command button. The batch is permanently removed from the Batch List.
Perform semi-auto
processing
SEMI-AUTO processing allows the operator to control the execution of steps in a
specific recipe level. SEMI-AUTO mode can be helpful when attempting to
troubleshoot a recipe. A recipe level can be placed in SEMI-AUTO mode when
the batch is in MANUAL or AUTO mode. When a batch or step is placed in
SEMI-AUTO mode, all higher-level steps are placed in MANUAL mode, and all
lower-level steps are placed in AUTO mode. You should select the lowest
appropriate level of the recipe and then place it in SEMI-AUTO mode. The step
that is active at the time that recipe level is placed in SEMI-AUTO mode is
completed, including its subordinate steps. The batch execution then pauses at the
next transition as the conditional expression becomes TRUE. The operator will
have to issue the RESUME command to initiate the next step of the selected
recipe level.
For example, assume you have a recipe with two unit procedures in succession.
The first unit procedure consists of three operations; the first two operations run
in parallel and the third follows the two parallel operations. Once you start the
batch, you place the first unit procedure within this recipe in SEMI-AUTO,
which places the procedure in MANUAL. The two parallel operations execute
normally, and execution pauses prior to starting the next operation. You then issue
the Resume command to continue the execution of the batch. However,
execution of the batch will halt prior to the third unit procedure. In order to
continue execution of the next unit procedure you must place the procedure in
AUTO. The batch will then continue to execute normally.
A batch or step may be placed in SEMI-AUTO mode when it is in MANUAL or
AUTO mode. A batch may be placed in SEMI-AUTO mode from the following
eProcedure Client views: Batch List, Equipment and Procedure.
Placing a Batch or Step in SEMI-AUTO Mode
1. Open the appropriate eProcedure Client view.
2. Use the Filter view to select the procedure to be placed in SEMI-AUTO
mode. If the batch is the active filter, the procedure level is placed in SEMIAUTO mode.
26
Rockwell Automation Publication eProcedure Client User Guide - February 2017
Chapter 2
Use the Batch List view
3. Click the Semi-Auto button. All higher level steps are placed in
MANUAL, all lower level steps are placed in P_AUTO and the selected
step is placed in S_AUTO. The active step will complete its processing and
execution will pause at the next transition as it becomes TRUE.
4. At this point you can perform an active step change or troubleshoot your
recipe.
5. When you are ready to continue execution, select the step that is to be
resumed.
6. Click the Resume button. The step transitions to the RUNNING state.
7. Repeat steps 4 - 6 to run each of the subordinate steps.
8. Place the batch in AUTO mode and continue normal execution, perform
an active step change, or perform semi-auto processing at another recipe
level.
Rockwell Automation Publication eProcedure Client User Guide - February 2017
27
Chapter 3
Use the Equipment List view
The Equipment view provides an equipment-centric view of the current batches.
The equipment displayed in the Equipment view is defined in the equipment
database in the Equipment Editor. There are three levels of equipment which can
be viewed within the Equipment view: Area, Process Cell, and Unit. Each level
includes run-time data for each equipment resource and up to five custom
hyperlinks for each resource. The Area and Process Cell levels also provide a direct
link to the Instructions view, which will display all of the instructions for the
selected batch. The Unit level provides additional run-time data with respect to
the state of the equipment modules.
Tip:
If running Internet Explorer version 7.0 or higher, it is possible
to have multiple instances of the eProcedure Client running in
the same browser window. The current user will be logged on
to all instances. (See Run on Internet Explorer version 7.x
and higher for more information.)
See also
Run on Internet Explorer version 7.x on page 14
Rockwell Automation Publication eProcedure Client User Guide - February 2017
29
Chapter 3
Use the Equipment List view
Information in the
Equipment view
The Equipment view presents a set of data based on the selected level. Additional
Phase Logic Interface (PLI) information is displayed as a tool tip when your
cursor passes over an equipment module. The following is an overview of the data
displayed within each level:
Information
Description
Area
Process
Cell
Unit
Phase
Batch ID
The Batch ID of the selected batch. In the Area display
mode, there is a drop-down list containing the Batch IDs of
all the batches on the Batch List in order by Create ID.
X
X
X
X
State-SI
The state of the phase along with the step index; only
included in the Unit display mode.
State
The state of the selected batch. For example, RUNNING,
HELD, etc.
X
X
X
X
Mode
For the Area and Process Cell displays, this is the mode of
the selected batch. For example, O_AUTO, MANUAL, or
S_AUTO. In the Unit display mode, this indicates
ownership of the phase. For example, PROGRAM if the
phase is under a batch's control, OPERATOR if the phase
has been acquired1 by the operator and EXTERNAL if the
external bit has been set.
X
X
X
X
Instructions
A link to the Instructions view. The instructions for the
current batches within the area or process cell are included
in the Instructions view.
X
X
Link1 - Link5
These customizable hyperlinks can be defined for each
equipment resource in the equipment database. The labels
(Link 1, Link 2, etc.) are also customizable for each
specific equipment resource type.
X
X
Request
A description of the unresolved request on the phase, if
any.
Phase
The name of the phase.
X
Step Index
The step index of the phase.
X
Failure
Failure message, when appropriate.
X
Unit
Name of the unit in which the phase resides.
X
Navigate in the
Equipment view
X
X
X
X
The Equipment view includes three equipment resource levels: Area, Process Cell,
and Unit. The Area level includes icons for each of the defined process cells. The
process cell level includes icons for each of the defined units. The unit level
includes icons for each of the defined equipment modules.
acquire. To gain ownership of a resource. Resources can be acquired automatically when
a batch runs. Resources can also be acquired manually in the Arbitration and Phase
Control processes.
1
30
Rockwell Automation Publication eProcedure Client User Guide - February 2017
Chapter 3
Use the Equipment List view
Double-clicking a resource displays the next lower level. For example, doubleclicking a process cell displays all of the units that are included in the selected
process cell. You can display the next higher level by double-clicking the
background in the Information Area. For example, double-clicking the
background while in the unit level displays the process cell in which the unit
belongs. If more than one batch is on the Batch List, the process cell level will
include a drop-down list of the current batch IDs, listed in order by Create ID. As
you navigate down the levels, the information displayed is reflective of the actual
state of the equipment, regardless of the batch ID selected in the drop-down list.
Equipment view
command buttons
Use the Equipment view to command equipment resources and batches that are
currently on the Batch List. The Command Area includes the command buttons
available for the Equipment view. The appropriate command buttons are enabled,
based on the state (and mode, for batches) of the selected resource or batch. (See
Command area for more information.)
See also
Command area on page 10
Command a batch
in the Equipment
view
Batch commands may be issued by using the command buttons in the Batch List
view, Equipment view and the Procedure view. Only those buttons representing
valid commands are enabled. Some of the command buttons are toggles, meaning
that depending on the state of the batch, the button label will change. For
example, if a batch’s state is READY, the label on the Start/Restart button is
Start. However, if the batch’s state is HELD, the button’s label is Restart.
Start a batch
A batch can only be started when it is in the READY state. A batch can be started
from the Batch List, Equipment and Procedure Client views.
1. Open the Equipment view.
2. Use the Level view to select the batch to be started.
3. Click the Start button. The batch transitions to the RUNNING state.
Rockwell Automation Publication eProcedure Client User Guide - February 2017
31
Chapter 3
Use the Equipment List view
Use the hyperlinks
The Equipment view can include up to five hyperlinks for each equipment
resource displayed. The hyperlinks must be defined within the Equipment Editor.
The process includes defining the hyperlink labels for each resource type, and then
assigning specific URLs to each of the defined equipment instances. For example,
you may want to provide the following hyperlinks for each unit: Detail Display,
Maintenance, and Safety. The labels are the same for each unit instance. However,
you can assign a different URL to MIXER1’s Detail Display than you do to
MIXER2’s Detail Display. (See the eProcedure Administrator Guide for
information on setting up hyperlinks.)
Command phases
In order to manipulate a phase (equipment module), the operator must first
acquire2 the phase. A phase can only be acquired when it is not currently owned.
Phases can be run from within the Equipment view. You must release the phase
when it is no longer needed so the phase is available to other batches.
1. Open the Equipment view.
Acquire a phase
2. Select the phase by clicking the phase’s icon.
3. Click the Acquire button. The Owner for the selected phase changes to
OPERATOR (see following example) and the mode changes to
PH_AUTO.
Tip:
Move the mouse pointer over the phase icon to view the phase specific
information display (PSID), as shown in the following example.
Phase-Specific Information Display (PSID)
acquire. To gain ownership of a resource. Resources can be acquired automatically when
a batch runs. Resources can also be acquired manually in the Arbitration and Phase
Control processes.
2
32
Rockwell Automation Publication eProcedure Client User Guide - February 2017
Chapter 3
Use the Equipment List view
1. Acquire the appropriate phase.
Start a phase
2. Click the Start button to initiate the phase. The Batch ID dialog box
opens.
3. Type a unique Batch ID for the manual phase control batch, unless you are
generating Batch IDs automatically. (See "Customizing Batch IDs" in the
FactoryTalk Batch Administrator Guide for more information.)
4. If control strategies are enabled for the phase, select the appropriate control
strategy from the Control Strategy list and click OK. The State changes to
RUNNING.
Tip:
Start a material-based
phase
If an error occurs while running a manual control phase, the error
message displays in the PSID and on the FactoryTalk Batch View.
1. Acquire the appropriate phase.
2. Click the Start button to initiate the phase. The Phase Control Feed Type
and Material Selection dialog box opens.
Rockwell Automation Publication eProcedure Client User Guide - February 2017
33
Chapter 3
Use the Equipment List view
3. Select the Feed Type (if available), and Material, and then click OK. The
Phase Control dialog box opens.
4. Type a unique Batch ID for the manual phase control batch in the Enter
Batch ID box, unless you are generating Batch IDs automatically. (See
Batch identification in the FactoryTalk Batch Administrator Guide for
more information.)
5. Select the appropriate container from the Make a selection to bind
equipment module box and click OK. The State changes to RUNNING.
Tip:
Reset a phase
The first container on the list is the default container.
Once the phase runs, it must be reset prior to being released.
1. Select the phase icon for the phase you are resetting.
2. Click the Reset button.
Release a phase
1. Select the phase icon for the phase you are e releasing.
2. Click the Release button. The Owner for the selected phase is now blank,
indicating that the operator no longer owns the phase.
Run an individual
phase in auto mode
You may run a phase using AUTO mode in the Equipment view. When a phase is
in AUTO mode, P_AUTO displays as the Mode next to the phase icon. While
the phase is running, RUNNING is displayed next to the phase icon in dark green
text. The information is also displayed in the Phase Specific Information Display
area.
1. Open the Equipment view.
2. Navigate to the Unit in which the desired phase resides. Phases that are not
running are in IDLE status.
34
Rockwell Automation Publication eProcedure Client User Guide - February 2017
Chapter 3
Use the Equipment List view
3. Select the phase, and then click the Acquire button.
4. Click the Start button to initiate the phase. The Batch ID dialog box
opens.
5. Enter the appropriate Batch ID, and then click OK.
6. The text next to the phase icon lists the current active state and the step
index, both in the appropriate color (i.e., RUNNING_1, where
RUNNING is the State and 1 is the step index). The mode is displayed as
PH_AUTO for operator-controlled Auto mode. The phase transitions to
the RUNNING state and then to the COMPLETE state after all steps are
executed.
7. Respond to any prompts in the Instructions view.
8. Once the phase is complete it must be reset. Click the appropriate Phase
icon, and then click the Reset button.
9. Click the Release button. The Owner is set back to blank, indicating that
there is no current owner of the phase.
Perform semi-auto
phase processing
You can manually step through a phase using SEMI-AUTO mode in the
Equipment view, as long as the phase logic was programmed with break points.
Semi-Auto processing allows you to test the functionality of the phase logic prior
to releasing the phase for general use. When a phase is in SEMI-AUTO mode, S
displays next to the step index on the phase button. PAUSED is displayed on the
phase button in dark blue text, on the line between the phase’s name and its
current state.
Tip:
The phase logic must set the Paused bit where appropriate. These
programmed break points are where the phase pauses while in Semi-Auto
processing.
1. Open the Equipment view.
2. Navigate to the unit in which the desired phase resides. Phases that are not
running are in the IDLE state.
3. Select the desired phase icon, and then click the Acquire button.
4. Click outside of the phase icon. This enables the Semi-Auto and Auto
options in the Mode area.
5. Select the Semi-Auto option to initiate semi-auto processing. The phase is
automatically put into the PAUSED state, allowing the operator to
manually process the phase using the Resume command button.
Rockwell Automation Publication eProcedure Client User Guide - February 2017
35
Chapter 3
Use the Equipment List view
6. Click the Start button to initiate the phase. The Batch ID dialog box
opens.
7. Type a unique Batch ID and then click OK to continue. Respond to any
prompts on the Instructions view.
8. The phase pauses at each pre-programmed break point. Click the Resume
command button to restart execution of the phase. The phase transitions to
the RUNNING state and then returns to the PAUSED state when it
reaches the next pre-programmed break point. The phase transitions to the
COMPLETE state after all steps have been executed.
9. With the acquired phase icon selected, click the Reset command button.
The phase transitions to the IDLE state.
10. Click the Release command button. The Owner box is set back to blank,
indicating that there is no current owner of the phase.
Disconnect an
equipment module
When an equipment module becomes unusable (due to errors in equipment logic,
communication problems, command handshake timeouts, etc.), the
DISCONNECT command can be used to disconnect the FactoryTalk Batch
Server from the unusable equipment module. This allows the operator to advance
the batch past the problem point or remove the batch from the system. The
DISCONNECT command can be executed on any step in O_AUTO or
S_AUTO mode that is connected to an equipment module and that is in any state
other than NOT_CONNECTED (READY). This applies to an equipment
module that is under EXTERNAL control, has a failure, is PAUSED, or HELD.
The Disconnect button is available in the Procedure view (in either Table or SFC
mode) and the Equipment view. When disconnecting from an equipment module,
the affected batch remains on the Batch List.
1. In the Equipment view or Procedure view, select the phase associated with
the equipment module that is to be disconnected.
2. Click the Disconnect button, and then confirm the disconnection.
Important:
36
The equipment module must to be reset to an IDLE state before it
can be used again by the FactoryTalk Batch Server.
Rockwell Automation Publication eProcedure Client User Guide - February 2017
Chapter 4
Use the Procedure view
You can use the Procedure view to watch the steps and transitions of a batch
execute, or to command a batch. Within the Procedure view there are three levels:
Procedure, Unit Procedure and Operation. Each level includes run-time data for
each step and transition.
Information in the
Procedure view
The Procedure view includes two separate views of a batch: the Sequential
Function Chart (SFC) view and the Table view. The SFC/Table command
button toggles between the two views. The steps in both views are color-coded,
allowing easily recognition of the state of a specific step.
Tip:
If running Internet Explorer version 7.0 or higher, it is possible to have
multiple instances of the eProcedure Client running in the same browser
window. The current user will be logged on to all instances. (See Run on
Internet Explorer version 7.x for more information.)
See also
Run on Internet Explorer version 7.x on page 14
Rockwell Automation Publication eProcedure Client User Guide - February 2017
37
Chapter 4
SFC view
Use the Procedure view
The SFC view displays the step’s name on the first line, regardless of the level
being viewed. Steps that represent unit procedures or operations display their
binding information on the second line. If the step is bound, the name of the unit
to which it is bound is displayed. If the step is not bound, the alias name is
displayed. The step’s current state is displayed in the lower left corner of the step,
and the current mode is displayed in the lower right corner of the step. Step or
recipe comments generated in the FactoryTalk Batch Recipe Editor also display in
the eProcedure SFC view.
When a transition is paused, PAUSED displays to the left of the transition. When
a step is acquiring resources, ACQUIRING1 displays to the left of the transition.
All transition expressions display to the right of the transition. The results of the
transition expression evaluation can be viewed by double-clicking the transition.
The Transition Expression dialog box opens, displaying the current expression
evaluation, or a message stating that the transition expression is not being
evaluated.
A transition in the process of ACQUIRING a phase
38
Rockwell Automation Publication eProcedure Client User Guide - February 2017
Chapter 4
Use the Procedure view
The Table view provides a list-based representation of a batch. Steps are executed
in order starting with the top row, and proceeding downward through the table.
Each row consists of an individual step and its associated information.
Table view
The following data can be displayed:
Tip:
Navigate in the
Procedure view
Description
Name
The name of the recipe step.
State
The current state of the recipe step.
Mode
The current mode of the recipe step.
Failure
The failure information associated with the recipe step.
Unit
The name of the unit in which the recipe step is running.
Owner
The current owner of the recipe step.
Step Index
The current step index of the recipe step.
Message
The message for the recipe step.
Request
The pending request for the recipe step.
Parameter(s)
The value of any parameters given for the recipe step.
Parameter values are right-justified so you may need to scroll to the right
to view them (or click the Details button).
Navigation is the same in both the SFC view and Table view. Double-clicking a
step displays the next lower level within the batch. For example, double-clicking a
procedure displays the unit procedures for the selected procedure. Double-clicking
the initial step displays the next higher level within the batch. Double-clicking the
initial step of a unit procedure displays the procedure step. If more than one batch
is on the Batch List, you are prompted to select a batch before the Procedure view
is opened.
Tip:
Procedure view
command buttons
Item
The initial step is not displayed in the Table view. To display it, double-click
outside of the table.
You can use the Procedure view to command batches that are currently on the
Batch List. The Command area includes the command buttons available for the
Procedure view. The appropriate command buttons are enabled based on the state
and mode of the selected batch. (See the Command area topic for more
information.)
See also
Command area on page 10
Rockwell Automation Publication eProcedure Client User Guide - February 2017
39
Chapter 4
Use the Procedure view
Command a batch
in the Procedure
view
Batch commands are issued by using the command buttons in the Batch List view,
Equipment view and the Procedure view. Only those buttons representing valid
commands are enabled. Some of the command buttons are toggles, meaning that
depending on the state of the batch, the button label will change. For example, if a
batch’s state is READY, the label on the Start/Restart button is Start. However,
if the batch’s state is HELD, the button’s label is Restart.
Start a batch
A batch must be started when it is in the READY state. Batches are started from
the Batch List, Equipment, and Procedure Client views.
1. Use the Filter view to select the batch, unit procedure or operation to be
started.
2. Click the Start button. The batch transitions to the RUNNING state.
View the batch
properties
The Details button opens the Properties dialog box, which displays the
properties associated with the currently selected step or procedure. The dialog box
contains three tabs: Parameter, Report, and Recipe.
View parameters
The Parameter tab contains a list of all of the parameters associated with the
selected step or procedure. If the selected recipe step is a phase, the phase
parameters are displayed. If the selected step is an operation or unit procedure, the
procedure’s parameters are displayed. If no recipe step is selected, the current
procedures parameters are displayed.
Edit parameter values
1. Select a step of the batch.
2. Click the Details command button. The Properties dialog box opens.
3. Double-click a parameter. The Change Parameter Value dialog box
displays the minimum, maximum, and default values of the parameter.
40
Rockwell Automation Publication eProcedure Client User Guide - February 2017
Chapter 4
Use the Procedure view
Minimum and Maximum are blank if the parameter data type is
enumeration.
4. Type a new value in the Value box and click OK.
5. Click OK to exit the Properties dialog box. The selected step now displays
the new value, as shown below:
Tip:
View the report parameters
View expression values
The Value must be configured as the Display Parameter in the Recipe
Editor (on the Formula Value Entry dialog box).
The Report tab contains a list of all report parameters associated with the selected
phase. If the selected recipe step is not a phase, the Report tab will not contain any
information. Displayed report parameters are view-only and cannot be edited.
The Binding tab displays the unit requirements for the step that is selected in the
Procedure view. The information on the Binding tab includes: Unit Requirements
for the batch procedure or the unit requirement associated with the step that is
selected in the Procedure view, Binding Requirements associated with the step
selected in the SFC or Table view, and Binding Preferences associated with the step
selected in the SFC or Table view. At the unit procedure or unit operation level,
there is only one unit requirement.
Rockwell Automation Publication eProcedure Client User Guide - February 2017
41
Chapter 4
Use the Procedure view
Double-clicking a binding requirement or preference expression opens the
Binding Requirement (or Preference) Expression Values view. It lists the units
that are potential legal binding candidates, a value indicating whether those
candidates currently meet the selected binding requirement or preference, and
shows a list of the inputs used to evaluate the expression.
If viewing an expression for a binding requirement, the content of the Expression is
Boolean; it evaluates to Yes or No. This is the only expression allowed for a
binding requirement. The values dynamically update as the inputs to the
expression change.
42
Rockwell Automation Publication eProcedure Client User Guide - February 2017
Chapter 4
Use the Procedure view
If viewing an expression for a binding preference, the content of the Expression
depends on the Type of expression selected:
View the recipe header
information
View material data
Bind Preference Types
Expression
Boolean Expression
Expression that must evaluate True
Minimize Expression
Expression to be minimized
Maximize Expression
Expression to be maximized
The Recipe tab contains the recipe header information (entered by the recipe
author when the master recipe was created). This information is relevant to the
procedural level currently displayed and is view-only.
If you are running a material-based recipe (MBR), you can view the materials used
in each step of the recipe by selecting a step and clicking the Details command
button.
Rockwell Automation Publication eProcedure Client User Guide - February 2017
43
Chapter 4
Use the Procedure view
The following material information is listed on the Parameter tab of the
Properties dialog box:
•
Name
•
Low (Minimum)
•
Value (Default Value)
•
High (Maximum)
•
Engineering Units
Once the phase is COMPLETE, you can view the actual amount of material used
by selecting a parameter and then clicking the Details button. Select the Report
tab to view actual amounts used as shown below:
Run material-based
recipes without the
Material Server
If communication is lost with the Material Server, material-based control recipes
can continue to process. A highly visible warning message displays when
communication is lost with the Material Server. When adding a material-based
control recipe to the batch list without access to the Material Server, you must
select the materials and containers for binding. For control recipes run without the
Material Server, you must update the inventory manually in the Material Editor
using the addition and distribution information presented in the Event Journal.
Loss of the Material Server causes the FactoryTalk Batch Server to
switch to prompt binding and presents an unfiltered list of
container/equipment module pairs from which to select binding
candidates. The operator must select the container/equipment module
pair to supply the correct material to continue processing the batch.
Failure to select the correct container/equipment module pair could
result in a hazardous situation depending on the material. Exercise
extreme caution when operating without the Material Server.
(See the FactoryTalk Batch Material Manager Administrator Guide for more
information about running recipes without the Material Server. See the Material
Editor User Guide for more information about updating inventory.)
44
Rockwell Automation Publication eProcedure Client User Guide - February 2017
Chapter 4
Use the Procedure view
Work with phases
You can command various phases in the batch from the Procedure view. The
following commands can be applied to phases from either the SFC or Table view:
Start, Hold, Restart, Abort, Stop, Reset, Pause, Resume, Comment, Manual,
Semi-Auto, Auto, Clear Failures, Bind, Release, and Disconnect. These
commands only affect the selected phase.
Manual phase binding
Manual phase binding is the process of binding a unit (equipment phase), or
rebinding a previously bound unit, to a step within a control recipe without being
prompted to do so. Manual binding must be performed from within the
Procedure view (Table or SFC mode).
The following criteria must be met in order to perform manual phase binding:
•
The step is associated with a unit class in the recipe’s equipment
requirements.
•
The step represents the highest recipe level wholly contained within the
unit. (For example, one step in the recipe represents a unit procedure that is
associated with the pre-mixer unit class, while another step that is associated
with the same pre-mixer unit class is an operation. As long as the balance of
the manual binding requirements are met you can manually bind the unit
procedure, but not the operation, since the unit procedure is the highest
recipe level associated with the unit.)
•
The step is inactive or has a binding status of BINDING.
•
More than one legal binding choice exists for the unit that is associated with
the step.
Tip:
All other steps within the recipe that are associated with the
same unit alias are bound to the same unit. (See Create a
procedure in the FactoryTalk Batch Recipe Editor User Guide
for information about unit alias.)
1. In the Batch List view, double-click the batch that requires binding. The
Procedure view opens.
2. To bind a unit to a step, you must select the unit procedure in either the
SFC or Table. If the control recipe was created from an operation or unit
procedure, then select the parent level. If the manual binding criteria was
met, the Bind command button is enabled.
Rockwell Automation Publication eProcedure Client User Guide - February 2017
45
Chapter 4
Use the Procedure view
3. Click the Bind command button. The Bind dialog box opens with a list of
legal binding options.
4. Select the appropriate binding type:
•
Operator Prompt – When the batch is started and the bound unit is
encountered, a message to "Bind Unit Alias" is displayed in the
Instruction view. Select the appropriate item from the list, and then
click the OK (or Submit) button.
•
First Available – When more than one unit fits the recipe criteria,
eProcedure will select the first available unit.
•
Specific Unit – When more than one unit fits the recipe criteria, you
can select which unit to use for the batch.
5. If you selected Specific Unit, select the specific unit to bind and click OK.
You are returned to the Procedure view. If you selected Operator Prompt,
see the Prompted binding topic for more information.
See also
Prompted binding on page 46
Prompted binding
Prompted binding is the process of binding a unit to a step after a bind prompt is
generated. Only unit class aliases that are defined as having the Prompt binding
method generate a prompt. This includes those that are defined with Prompt
binding during batch creation. The execution of the batch pauses when the
transition above the unbound step becomes True. The "Bind to Alias" prompt
displays in the Instructions view.
Tip:
All other steps within the procedure that are associated with the same
alias are bound to the same unit.
1. In the Batch List window, start the batch that contains the bound unit (if it
is not already running).
46
Rockwell Automation Publication eProcedure Client User Guide - February 2017
Chapter 4
Use the Procedure view
2. Select the Instructions view. The Prompt to Bind Unit Alias instruction
form opens.
3. Select the unit to which the step is to be bound, and then click OK. The
prompt is removed from the Instructions view when the acknowledgment
successfully completes.
Binding to a materialenabled phase step
Material binding is the process of binding activated material phase steps to
material-enabled equipment modules, or rebinding a previously bound material to
a step within a control recipe without being prompted to do so. Material binding
must be performed from within the Procedure view. The following criteria must
be met to perform manual binding:
•
The step is associated with a material in the recipe.
•
The step is inactive or has a binding status of BINDING.
If you bind a material-based phase, you will have the opportunity to select the type
of binding and/or the binding container.
1. In the Batch List view, double-click the batch that requires binding.
2. In the Procedure view, select the material-based phase to bind, and then
click the Bind command button. The Prompt to Bind a Material Phase
Step opens with a list of legal binding options.
3. Select the binding Lot or Storage Container for the material, and then click
OK. If there is only one option, just click OK.
Rockwell Automation Publication eProcedure Client User Guide - February 2017
47
Chapter 4
Use the Procedure view
4. Navigate back to the top of the unit procedure, and then click the Start
command button; or switch to the Batch List view and start the batch.
5. If you selected a specific material or Automatic, you do not need to do
anything. If you selected Prompt, a Prompt to Bind a Material Phase Step
instruction displays in the Instructions view when it is time to select a
material.
6. Switch to the Instructions view, and then select the desired Lot or Storage
Container from the list.
7. Click OK.
Off-line material
binding
If the Material Server is unavailable to provide material data, you can continue to
run material-based recipes in eProcedure. The area model and the recipe provide
most of the information, which leaves only the information about actual materials
and lots unknown.
When the Material Server is unavailable (off-line), you are prompted to select a
unit, even when the binding type is First Available. Notice in the following
illustration that the Capacity column contains a 0 value, while the EU, Lot, and
Label columns are blank.
48
Rockwell Automation Publication eProcedure Client User Guide - February 2017
Chapter 4
Use the Procedure view
Manual phase control
binding
Each manual phase control session begins when you select an equipment module
from within a unit. The materials that can be manipulated are a function of the
container associations on that equipment module.
The dialog box prompting you to enter the Batch ID now includes the selection of
a material - container - use.
When you select a line in this dialog box, you are selecting the material to be used,
the storage container to bind the equipment module with and whether a material
addition or distribution is to be made. This enables the AMOUNT parameter to
be prompted and its range checked to see that the value entered suits an addition
or distribution phase.
Work with timer
steps
If the recipe on the batch list contains one or more Timer steps, you can reset the
Timer step or force it to complete. The batch must be in MANUAL mode, which
places the Timer step into O-AUTO mode.
Tip:
The Timer step must be in the RUNNING state for Timer Complete and
the RUNNING or HELD states for Timer Reset.
Rockwell Automation Publication eProcedure Client User Guide - February 2017
49
Chapter 4
Use the Procedure view
Reset a timer step
1. In the Batch List view, double-click the batch that contains a Timer step.
The batch opens in the Procedure view.
2. When the Timer step becomes active, place the batch in MANUAL mode.
3. Select the Timer step in the SFC or Table view, and then click the Timer
Reset button.
When a Timer step in the RUNNING or HELD state receives the Timer
Reset command the ELAPSED_TIME report will be reset to 0. If the
Timer step is configured as a COUNT_DOWN timer the
REMAINING_TIME report will be reset to the setpoint value. If the
Timer Reset command is issued and the command is no longer valid, due to
a change of state for example, the command is ignored.
Tip:
Force a timer step to
complete
If the logged in user does not have permission to send the Timer
Complete or Timer Reset commands then the commands will not
be enabled even if the Timer step is in the proper mode and state.
1. In the Batch List view, double-click the batch that contains a Timer step.
The batch opens in the Procedure view.
2. When the Timer step becomes active, place the batch in MANUAL mode.
3. Select the Timer step in the SFC or Table view, and then click the Timer
Complete button.
When a Timer step is in the RUNNING state and receives a Timer
Complete command the Timer step will transition to the COMPLETE
state. If a Timer Complete command is issued and the command is no
longer valid, due to a change of state for example, the command is ignored.
Tip:
50
If the logged in user does not have permission to send the Timer
Complete or Timer Reset commands, the commands will not be
enabled even if the Timer step is in the proper mode and state.
Rockwell Automation Publication eProcedure Client User Guide - February 2017
Chapter 4
Use the Procedure view
Change the setpoint of
a timer step
You can change the setpoint of a Timer step whether or not it is currently active
and regardless of its state.
1. In the Batch List view, double-click the batch that contains a Timer step.
The batch opens in the Procedure view.
2. Select the Timer step in the SFC or Table view, and then click the Details
button. The Properties dialog box opens.
3. Select the Parameters tab to view the Hold Behavior, Setpoint
(COUNT_DOWN timers only), and Timer Type for the selected Timer
step.
4. Double-click anywhere in the SETPOINT row. The Change Parameter
Value dialog box opens.
5. Type a new setpoint value in the Value box, and then click OK.
The value entered must be within the displayed minimum and maximum
values for the parameter. If the value is between the minimum and
maximum values when you click OK the new value is sent to the Timer
step. If the value is not between the minimum and maximum values, an
error message requests "Please enter a value between the configured
Minimum [Minimum Value] and Maximum [Maximum Value] values".
Click OK to enter a new value.
6. Click OK to close the Properties dialog box and apply the change.
Rockwell Automation Publication eProcedure Client User Guide - February 2017
51
Chapter 4
Use the Procedure view
Make active step
changes
You can change the active step in a batch (at the step level only) as long as the
recipe level that requires the active step change is in MANUAL mode. Steps that
are in the HELD state cannot be removed as the active step. Although an active
step change can be performed in the Procedure view (in either SFC or Table
mode), it is recommended that you use the SFC mode.
1. In the Batch List view, double-click the batch that requires an active step
change. The batch opens in the Procedure view.
2. Navigate to the level that contains the active step you want to change. Click
the Manual command button to place this level in Manual mode.
3. Click the Step Change command button. The active step changes to a
yellow striped background. In addition, two new command buttons display:
Commit and Cancel.
Tip:
The cursor changes to a hand shape. Use the cursor to toggle steps
between activated and deactivated status.
4. Position the hand cursor over the step(s) to deactivate and click. The yellow
striped background changes to dark blue stripes.
5. Using the hand cursor, click the new step(s) you wish to activate. The
background changes to green stripes.
6. Click the Commit command button to accept the active step change. The
new active step(s) displays a READY state.
7. In the Procedure view, select the new active step, which is now in the
READY state and the O_AUTO mode. Any subsequent steps in the recipe
that have completed are reset. This provides the option to place the batch in
Automatic mode and process the balance of the batch normally.
8. Click the Start command button to start the new active step. The step runs
and returns to a completed state when it is finished. If the batch was placed
in Automatic mode, the balance of the batch processes normally.
52
Rockwell Automation Publication eProcedure Client User Guide - February 2017
Chapter 5
Use the Instructions view
The Instructions view displays an ordered list of control steps based on the
selected filter. You can enter parameter data, respond to prompts, and enter step
verification information from the Instructions view. The Instructions view
provides a list of control steps as they relate to a particular location in your facility,
such as the entire area, process cell or unit (See the eProcedure Instruction File
Design Guide for more information on creating control steps or instructions.) You
can also change the filter to show only those control steps in a particular batch.
The Instructions view displays three types of control steps: current, future and
past.
Tip:
The correct path to the instruction files must be configured (in the
Server Options dialog box of the Equipment Editor) or eProcedure
will not find any instructions to display for selected batches. (See the
FactoryTalk eProcedure Getting Results Guide for procedures on
configuring the path to the instruction files.)
Rockwell Automation Publication eProcedure Client User Guide - February 2017
53
Chapter 5
Use the Instructions view
Information in the
Instructions view
The Instructions view provides a list of HTML-based control steps appropriate
for the selected filter. Control steps include processing instructions, and can
include recipe parameter values and text boxes for entering report values. All
control steps must include a submit button (the submit button may be labeled OK
or Done). Control steps can include any valid HTML components. Each control
step also includes run-time data. The Batch ID, the unit and phase from which the
control step originated, and the step index are all included within a box to the left
of the control step text.
Since the Instructions view can include past, present and future control steps, the
steps are uniquely identified, based on type, to allow you to quickly determine the
status of a particular control step. Current control steps have a white background
in the box containing the Batch ID and an OK (submit) button on the far right.
Past control steps have a gray background in the Batch ID box and a box with a
check mark in it on the right side (instead of a submit button). Future control
steps have a gray background in the Batch ID box and no button on the right side.
The following presents an overview of the possible components of a control step
and how they appear in each step status.
Control Step Components
Step Status
Past
Present
Future
Instructions
Displayed
Displayed
Displayed
Parameter Values
Displayed
Displayed
Displayed
Report Entry Fields
Report Data
Displayed
Report Field
Enabled
Report Field
Disabled
Submit Buttons
Checked box
Displayed
Not Displayed
Run-Time Data
Displayed
Displayed
Displayed
Valid HTML Components
Displayed
Displayed
Displayed
Instructions view
command buttons
The Instructions view allows you to view and respond to control steps related to
the current filter. The Instructions view command buttons allow you to view or
hide past and future control steps for the selected filter. You can also reactivate
and correct a past control step. (See the Command area topic for more
information.)
See also
Command area on page 10
54
Rockwell Automation Publication eProcedure Client User Guide - February 2017
Chapter 5
Use the Instructions view
Execute control
steps
Control steps represent the individual steps of a phase. As a batch executes, the
current control step for each active step is displayed. Control steps are executed in
the order specified within the master recipe. Recipes that include an OR branch
assume the leftmost path to be the default path. If more than one step is active on
a parallel branch, you can choose the order in which the current control steps are
processed.
When executing a control step, you complete the steps defined in the written
instructions, fill in any required report data, and then submit the control step data.
All present control steps will include a submit button, which is used to inform the
eProcedure Server that you have completed the step.
Report fields can be configured to limit the range of possible values, to require
users to verify the data, and to allow comments to be entered with verifications. If
a report value falls outside of the user-defined range, you are prompted to correct
it. If a report field requires verification, a pre-defined user or member of a user
group is required to enter a valid user name and password to verify that the correct
report values were entered. The verification step can also allow you to enter
comments.
Important:
Control steps that were active during a Warm Boot of the
eProcedure Server are active when the server starts again, but the
control step is restarted with a new reactivation number. All
signatures and previously-entered values associated with the
control step due to parameter deviation or cancelled step
verification signatures are removed. A Past control step is added,
which states "Control Step Terminated by eProcedure Server
shutting down".
Report fields can be configured to require from one to three sign-offs if the values
are outside a pre-defined set of limits. (See the Use the Signature List view topic
for more information.)
Tip:
To achieve faster report parameter uploads, use reports with sequential
report IDs in the control step. See Parameters and reports with
FactoryTalk Batch in the FactoryTalk Batch Equipment Editor User
Guide.
See also
Use the Signature List view on page 63
Rockwell Automation Publication eProcedure Client User Guide - February 2017
55
Chapter 5
Use the Instructions view
Locate the control step
1. From the Instructions view, use the Filter view to select a filter that will
display the control steps to be executed.
2. Locate the first control step to execute; present control steps have an OK
button (or other submit button) on the right-hand side of the step. Any
present control step can be executed in any order.
3. Execute the instruction(s) provided in the control step.
Enter report values
Earlier versions of eProcedure required that the report values be entered in ALL
CAPS. This is no longer the case — eProcedure can read the entered value in
either upper- or lower-case.
Tip:
It is recommended that you include no more than two reports in a
single instruction form.
1. Enter any required report values. Report values can be entered in a text box
(field), or you can choose from a list of possible values.
Important:
Tip:
Do not use the following words or phrases as phase parameter
names or report parameter names: "all", "length", recipepath",
"outerhtml", "finalinstructions", "stepindex", "submitstring",
or "submit". Using these phrases as parameter names can cause
errors during manual phase control.
If there are multiple report values required, be sure to enter all values
before clicking the submit button. Once the submit button is clicked the
report values are stored in the electronic batch record, and cannot be
modified, and the control step is displayed as a past control step.
2. Click the submit button. (The submit button label can be user-defined; the
text could be OK, Submit or Done, but there should be only one submit
button per control step.)
56
Rockwell Automation Publication eProcedure Client User Guide - February 2017
Chapter 5
Use the Instructions view
Confirm report values
Report parameters can be defined to include range checking. The report
parameter can require confirmation for values outside a specified range. Report
parameters can also be defined to require the report value to be within a specified
range, forcing the operator to correct an entry that is outside the range. The
Confirm Value dialog box is generated from the HTML code.
•
If the report value is valid, you can enter an optional comment and then
click OK.
•
If the report value is incorrect, click the Cancel button to cancel the
submit process and return to the current control step where the value is
selected. You can then enter the correct report value and re-submit the
report data.
(See the eProcedure Instruction File Design Guide for information on including
Confirm and Comment instructions in control steps.)
Verify report values
If the report verification policy was configured to generate a signature request, the
Signature Request opens in the current control step in the Instructions view.
Rockwell Automation Publication eProcedure Client User Guide - February 2017
57
Chapter 5
Use the Instructions view
1. Enter a valid User ID and Password. The user must be listed in the Security
Permissions area of the Signature Request (or be a member of an authorized
group).
2. Enter a Comment, if required and click the Sign button.
Cancel a signature
request
You can cancel a signature request using the following procedure.
Important:
Be advised that canceling a Signature Request also cancels the
action3 that generated the request.
1. Click the Cancel Signature button. A message displays to notify you that
canceling the signature request also cancels the action that generated the
request.
2. Click Yes to cancel the Signature Request or No to return to the active
control step.
3. If you clicked Yes, a signature cancelation request is sent to the eProcedure
Server. The eProcedure Server returns an error message, if necessary, and the
data on the current state of the step. The step is then refreshed and the
cancelation is noted on the Signature Request, as shown below.
Action. An organized activity performed on a resource in order to accomplish an
objective. Actions are grouped into categories, with some actions common to multiple
products.
3
58
Rockwell Automation Publication eProcedure Client User Guide - February 2017
Chapter 5
Use the Instructions view
Use instructionbased equipment
modules
Equipment modules that derive from a material-based recipe (MBR) phase can be
instruction-based or automation-based. When you are working with an
instruction-based equipment module, the phase parameters show up as part of the
instructions, and phase reports consist of data from the instructions. The MBR
generates a prompt, which is formatted into instructions by the eProcedure Server.
\t\t\tSample of an MBR-generated prompt
Tip:
If there is more than one parameter prompt for any given control step,
each prompt is displayed in a separate instruction step row.
The MBR function uses a number of parameters and reports. The table below
describes how they are used within the eProcedure instruction files:
Name
Parameter/ Report
Used in an Instruction...
AMOUNT
Parameter
As data to be viewed by the operator
MATERIAL
Parameter
As data to be viewed by the operator
LOT
Parameter (optional)
As data to be viewed by the operator (might be
necessary for the operator to locate the specific quantity)
LABEL
Parameter (optional)
As data to be viewed by the operator (might be
necessary for the operator to locate the specific quantity)
CONTAINER
Parameter (optional)
As data to be viewed by the operator (might be
necessary for the operator to locate the specific quantity)
ACTUAL_AMOUNT*
Report
Entered by the operator
FEED_COMPLETE*
Report
Defaults to TRUE to indicate that the feed and phase
completed successfully.
If the prompt in question has a pending signature request, the submit button is
replaced with the words "Prompt Pending Signature".
Rockwell Automation Publication eProcedure Client User Guide - February 2017
59
Chapter 5
Use the Instructions view
You can acknowledge the signature by clicking the Signatures button in the View
Selection area to open the Signature List view. Double-click the appropriate
signature to display the Signature Request for the prompt. Complete the
Signature dialog box, click Sign, and then click Close, and return to the
Instructions view to continue. (See the Use the Signature List view topic for
more information.)
See also
Use the Signature List view on page 63
Reactivate a control
step
You can reactivate any past control step that has not already been reactivated, is in
a phase that is currently in the RUNNING state, and does not have any pending
reactivated steps.
Important:
Control steps that were reactivated when the eProcedure Server
does a warm boot are not active when the eProcedure Server
restarts. When the eProcedure Server warm boots, any reactivated
control steps are stopped and the control step that was active
before the reactivation occurred becomes active once again. A
Past control step is added, which states "Reactivated Control Step
Terminated by eProcedure Server shutting down." (See "Effects of
Warm Boot on Control Steps" in the eProcedure Getting Results
Guide for more information.)
1. To reactivate and correct a control step, click the Show Past button to view
all past instructions.
Tip:
60
If you are running Internet Explorer version 7.0 or higher, it is
possible to have multiple instances of the eProcedure Client running
in the same browser window. The current user will be logged on to
all instances. (See the Run on Internet Explorer version 7.x topic
for more information.)
Rockwell Automation Publication eProcedure Client User Guide - February 2017
Chapter 5
Use the Instructions view
As you move the cursor over past steps, a black box will frame those steps
that are valid for reactivation. When you select a valid past step, the
Reactivate Step button is enabled, as shown:
2. Select a valid past control step, and then click the Reactivate Step button. If
you have proper security privileges the step is reactivated and can be
corrected. The step information includes "Reactivated".
Rockwell Automation Publication eProcedure Client User Guide - February 2017
61
Chapter 5
Use the Instructions view
3. Correct any values that were entered incorrectly. All signature requirements
are the same as they were the first time the control step ran. Click OK. If
the phase was still in the RUNNING mode, the correction is accepted and
the step is complete. If the phase containing the control step is no longer
active, the following message displays:
See also
Run on Internet Explorer version 7.x on page 14
Step reactivation with
a signature request
If the ReactiveStep command was configured with a signature template (in the
Equipment Editor), the Signature Request displays in the instruction step being
reactivated, as shown here.
The past step above it displays "Reactivation Pending Signature" on the right, in
place of the OK (or other submit) button.
1. Enter the required User ID and password, and a comment, if required, and
click the Sign button.
2. Correct any values that were entered incorrectly the first time. All signature
requirements are the same as they were the first time the control step ran.
Click OK.
62
Rockwell Automation Publication eProcedure Client User Guide - February 2017
Chapter 6
Use the Signature List view
eProcedure’s Signatures List view allows viewing of all incomplete signatures
associated with currently running batches. Double-clicking a signature opens a
dialog box containing pertinent signoff information about the selected signature.
Tip:
If you are running Internet Explorer version 7.0 or higher, it is possible to have
multiple instances of the eProcedure Client running in the same browser
window. The current user will be logged on to all instances. (See the Run on
Internet Explorer version 7.x topic for more information.)
See also
Run on Internet Explorer version 7.x on page 14
Electronic signature
types
The types of signatures may include report parameter verification for automated
and manual phases, recipe parameter change verification, eProcedure step
verification and step reactivation, batch and phase command verification, and a
general usage signature that allows a phase to request a signature when needed.
How electronic
signatures work
There are several steps involved in configuring and executing electronic signatures.
These steps span the FactoryTalk Batch product suite.
First, the FactoryTalk Batch system administrator sets up electronic signature and
signoff security. (See the FactoryTalk Batch Administrator Guide for more
information on setting up security for electronic signatures.)
In the FactoryTalk Batch Equipment Editor, the control engineer selects the
Archiver event filters for the signature events that will be used in FactoryTalk
Historian Classic for Batch reports or other reports. (See the FactoryTalk Event
Archiver User Guide for more information on configuring the Archiver event
filters for electronic signatures.)
Rockwell Automation Publication eProcedure Client User Guide - February 2017
63
Chapter 6
Use the Signature List view
Then, the signature templates for the area model4 are created. In order to obtain
electronic signatures for recipe parameters and report parameters of specific
phases, configure the verification method and signature template to be used when
the phase is created or edited. To require signature verification for the execution of
specific commands, set up command verification policies in the Equipment Editor,
using the signature templates created earlier. (See the FactoryTalk Batch
Equipment Editor User Guide for more information.)
When the master recipe is built, the recipe parameter limits that trigger the
verification policy are defaulted from the parameter limits specified on the
equipment phase. These values can be changed at the recipe level in the Recipe
Editor. If a phase is configured to obtain a signature for deviation of report limits,
those limits must be specified on the report for the phase in the Recipe Editor.
(See the FactoryTalk Batch Recipe Editor User Guide for more information.)
When a batch is run and parameter or report deviations requiring signature
verification occur, or the operator issues commands requiring signature
verification, the signature list is displayed in the FactoryTalk Batch View, the
Electronic Signature ActiveX control, or the eProcedure client, prompting the
appropriate users to enter signatures. (See the FactoryTalk Batch View User Guide,
ActiveX Controls User Guide, or the eProcedure Client User Guide for more
information.)
All signatures entered are recorded as Signature events and can then be viewed in
the Event Journal viewer in the FactoryTalk Batch View. (See the FactoryTalk
Batch Administrator Guide for more information on the electronic signature event
types. See the FactoryTalk Batch View User Guide for more information on
viewing signature events in the FactoryTalk Batch Event Journal viewer.)
After signature event data is generated you can create FactoryTalk Historian for
Batch reports or other reports that capture electronic signature data.
Important:
During a Warm Boot all signatures are removed. You will no
longer see parameter deviation signatures that may have been
entered or generated prior to the eProcedure Server rebooting.
area model. The physical component of a batch facility. A database that consists of all
equipment in the facility and all of the tasks that it is capable of performing.
4
64
Rockwell Automation Publication eProcedure Client User Guide - February 2017
Chapter 6
Use the Signature List view
View the signature
list
The eProcedure Signatures List displays a list of pending signatures and their
related commands, report parameters, and other data. The list of pending
signatures is maintained on the FactoryTalk Batch Server.
Tip:
Step Verification signature requests and Reactivate Step signature
requests only display in the Instructions view; batch and phase
command verification signature requests display in the Signature List
and the appropriate Signature dialog box opens in the Instructions
view.
Click the Signatures button to display the Signatures List page, shown below.
Each row in the list represents one signature. The Signature List automatically
updates as new signatures are generated and the states of existing signatures
change.
Tip:
Signatures are not filtered; therefore the Filter area and the Select
Filter button are not available on the Signature List page.
Tip:
If you do not have sufficient rights to view the Signature List, you
are prompted "The current user does not have permission to view
the Signature List." See the eProcedure Administrator Guide for
information on configuring signature and signoff security.
The following columns display on the Signatures List view:
Resize columns
Column Name
Default Header
Default Width
Time
Time
120
Batch ID
Batch ID
100
Signoff Meaning
Signoff Meaning
230
Signoff Security
Signoff Security
120
Signature Context
Signature Context
250
Columns can be resized by clicking and dragging the column header dividers, or
you can double-click the column header divider to automatically resize the column
to the left of the divider to fit the data contained in the column.
Rockwell Automation Publication eProcedure Client User Guide - February 2017
65
Chapter 6
Use the Signature List view
Sort the signature list
When the Signature List is first loaded, the signatures are sorted by the Time
column in descending order. Clicking a different column header sorts the
signatures by the data in that column. Clicking the column header toggles the sort
order of the data to ascending (A – Z or 1,2,3,...) or descending order (Z – A or
...3,2,1).
Acknowledging a
signature request
Double-clicking a signature on the Signature List opens the appropriate Signature
dialog box, from which the required signoff(s) are made or canceled. From this
dialog box you can view the time and date the signature was generated, the ID of
the batch, and the procedure ID and specific command that caused the signature
to be generated. The dialog box shown here is a Command Signature dialog box
generated by a HOLD command.
You have the option of enabling (in the FactoryTalk Batch Equipment Editor) a
signature request on up to eleven general commands and one eProcedure-specific
command.
66
Rockwell Automation Publication eProcedure Client User Guide - February 2017
Chapter 6
Use the Signature List view
Use report
verifications
Some control steps may require report verification with one or more signatures.
Report verification policies are configured and associated with phases in the
FactoryTalk Batch Equipment Editor by the control engineer. When eProcedure
encounters a phase that has an associated verification policy, the report
Verification Signature instructions are displayed in the Instructions view, similar
to the one shown here:
This example shows the execution of a dual signature for an eProcedure report
verification before either signoff is completed. The execution of a signature for an
eProcedure step verification looks very similar. The red (1) visually ties the
signature to the report to which it corresponds.
Tip:
Step Verification signature requests and Reactivate Step signature
requests will display in the Instructions view; all others display in the
Signature List view and the appropriate Signature dialog box opens in the
Instructions view.
Report Verifications contain the following fields:
•
The reason (meaning) for the required signature, i.e. "Report Limit
Violated".
•
The report name
•
Limit type
•
Limit value
•
Value entered
•
Signature 1 area, which contains the signature meaning (confirmed over
limit, etc.), user name, password, comment, plus OK and Cancel buttons
•
Signature 2 area, if required (contains the same information as the Signature
1 area)
Rockwell Automation Publication eProcedure Client User Guide - February 2017
67
Chapter 6
Use the Signature List view
Complete a report
verification
Single signature required
When a report verification is pending, the current eProcedure instruction notifies
you, as shown here:
1. From the eProcedure Instructions view, click the User Name box in the
Report Verification instruction, and type the appropriate user name.
2. In the Password box, type a valid password.
Tip:
If verification fails because the operator is not in the required security
group or used an incorrect password, an error message displays and
"Incorrect Signature" is logged.
3. If a comment is required, type it in the Comment box.
If a comment was required but not entered, eProcedure will prompt you to
enter a comment when you click OK.
4. Click OK to complete the sign-off. The data (full name, signature meaning,
time, date, and comment) is saved in the event log and the completed
signature displays in the eProcedure step.
Tip:
If the signature you are trying to signoff on was already completed on a
different workstation, an error message is displayed, the attempt is
logged, and the completed signature is displayed for the step.
Canceling a Signature
If you cancel the signature, eProcedure marks the signature as canceled, but leaves
the signature information to indicate that the signature was requested. The
cancelation is journaled and the data entry area is reactivated. The previously
entered value displays, with a red line through it, next to the data entry field.
68
Rockwell Automation Publication eProcedure Client User Guide - February 2017
Chapter 6
Use the Signature List view
If the signature was accessed from a different workstation, the completed signature
and any cancelations are displayed. The step looks exactly the same on both
workstations.
Dual signatures required
Report verifications requiring two signatures are completed in much the same way
as those requiring only one signature. The exception being when a user tries to
complete signature two before signature one is complete. When that occurs,
eProcedure prevents signature two data from being entered.
Tip:
Signature 1 and Signature 2 can be completed from different eProcedure
Clients (workstations). The sign-offs work the same as they would from
one workstation. The completed signature and any cancelations are
displayed and the step looks exactly the same on both workstations.
The following example shows a report verification requiring two signatures with
Signature 1 being complete.
Configuration of a
report verification
policy
You configure a report verification policy in the Equipment Editor. Use the
Reports tab of the Edit Phase dialog for the specific phase class.
Rockwell Automation Publication eProcedure Client User Guide - February 2017
69
Chapter 6
Use the Signature List view
Configure
eProcedure step
verification policies
To configure a verification policy for an eProcedure step, add a tag that defines the
signature template to that step’s HTML code in the instruction file.
Tip:
Step Verification signature requests only display in the Instructions
view, not in the Signature List view.
For example, to use a signature template named "StepVerificationTemplate", you
would type: <SOP>VerificationSig=StepVerificationTemplate</SOP>.
This is illustrated in the screen shot below.
See the eProcedureInstruction File Design Guide for information on including
Confirm and Comment instructions in control steps.
70
Rockwell Automation Publication eProcedure Client User Guide - February 2017
Legal Notices
Legal Notices
Copyright notice
© 2017 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.
End User License Agreement (EULA)
You can view the Rockwell Automation End-User License Agreement ("EULA")
by opening the License.rtf file located in your product's install folder on your hard
drive.
Trademark Notices
Allen-Bradley, CompactLogix, ControlLogix, Connected Components
Workbench, eProcedure, FactoryTalk, GuardLogix, GuardPLC, Micro800,
MicroLogix, MobileView, MobileView Guard, PanelBuilder, PanelView,
PhaseManager, PlantLink, PlantPAx, PLC-2, PLC-3, PLC-5, PowerMonitor,
RSBizWare, RSBizWare BatchHistorian, RSBizWare Historian, RSBizWare
MaterialTrack, RSLinx, Rockwell Automation, Rockwell Software, SLC,
SoftLogix, Studio 5000, and XMare trademarks of Rockwell Automation, Inc.
Any Rockwell Automation software or hardware not mentioned here is also a
trademark, registered or otherwise, of Rockwell Automation, Inc.
For a complete list of products and their respective trademarks, go to:
http://www.rockwellautomation.com/rockwellautomation/legalnotices/overview.page?#tab4
Rockwell Automation Publication eProcedure Client User Guide - February 2017
71
Legal Notices
Warranty
This product is warranted in accordance with the product license. The product’s
performance may be affected by system configuration, the application being
performed, operator control, maintenance, and other related factors. Rockwell
Automation is not responsible for these intervening factors. The instructions in
this document do not cover all the details or variations in the equipment,
procedure, or process described, nor do they provide directions for meeting every
possible contingency during installation, operation, or maintenance. This
product’s implementation may vary among users.
This document is current as of the time of release of the product; however, the
accompanying software may have changed since the release. Rockwell Automation,
Inc. reserves the right to change any information contained in this document or
the software at any time without prior notice. It is your responsibility to obtain the
most current information available from Rockwell when installing or using this
product.
Environmental compliance
Rockwell Automation maintains current product environmental information on
its website at http://www.rockwellautomation.com/rockwellautomation/aboutus/sustainability-ethics/product-environmental-compliance.page
Contact Rockwell Automation
Customer Support Telephone — 1.440.646.3434
Online Support — http://www.rockwellautomation.com/support/
72
Rockwell Automation Publication eProcedure Client User Guide - February 2017
Index
A
abort a batch 24
Abort Batch command button 10
acquire a phase 32
Acquire command button 10
add a batch 19
Add Batch command button 10
Auto Mode command button 10
automatic mode 25
automatic phase processing 34
B
batch
abort 24
adding 19
hold 23
restart 23
start 23
stop 24
Batch ID 18
batch list
remove a batch 26
Batch List view
adding a batch 19
batch states 19
command buttons 18
commanding a batch 19
information contained in 18
modes 19
navigating 18
using 17
batch modes 19
batch scale 19
Batch Server 44
Bind command button 10
binding
material-based phase 47
preferences 40
requirements 40
binding type 45
first available 45
operator prompt 45
specific unit 45
C
cells 18
Clear Failures command button 10
command
area 10
buttons 10
commanding phases 32
Comment command button 10
complete
force Timer step 50
control steps 55
confirming report values 58
entering report values 57
locating 55
CreateID 18
creating instruction files 53
D
description of recipe 18
Details command button 10
Disconnect command button 10, 36
E
elapsed time 18
electronic signatures
removed by warm boot 65
eProcedure Client
command area 10
information area 8
level area 9
opening 12
opening as home page 12
set as home page 8
user-defined area 9
view selection area 9
views 12
equipment module
disconnect 36
instruction-based 60
Equipment View
acquire a phase 32
command a batch 31
command buttons 31
Rockwell Automation Publication eProcedure Client User Guide - February 2017
73
Index
commanding phases 32
Disconnect button 36
disconnect equipment module 36
information 30
navigating 30
release phases 32
reset phase 32
start a batch 31
start a phase 32
using 29
using hyperlinks 32
Event Journal 44
executing a control step 55
EXTERNAL control 36
material-based phase
bind to 47
material-based recipe 43
phase 60
MBR. See 43
modes 18, 19
Automatic 25
Manual 19, 25
O_Auto 19
S_Auto 19
Semi-Auto 26
O
off-line material binding 47
F
P
failure 18
Filter View
selecting 13
H
Hide Future command button 10
Hide Past command button 10
hold a batch 23
Hold Batch command button 10
home page
eProcedure Client 8
I
instruction files 53
instruction-based equipment module 60
Instructions View 53, 66
command buttons 54
control steps 55
phase
acquire 32
automatic processing 34
release 32
reset 32
semi-automatic processing 35
start 32
phases in use 18
Procedure View 37
command a batch 40
command buttons 39
information 37
navigate 39
SFC view 38
start a batch 40
table 39
view step properties 40
properties 40
Properties dialog box
Binding tab 40
M
manual mode 25
Manual Mode command button 10
manual phase
control 49
material binding 47
off-line 47
Material Server
lost communications with 44
74
R
Reactivate Step command button 10
recipe 18
Refresh command button 10
release a phase 32
Release command button 10
remove a batch 26
Remove Batch command button 10
Rockwell Automation Publication eProcedure Client User Guide - February 2017
Index
report verification
dual signature 70
single signature 70
reset
Timer step 50
Reset command button 10
reset phase 32
restart a batch 23
Restart Batch command button 10
Resume Batch command button 10
U
units in use 18
V
viewing
binding preferences 40
binding requirements 40
W
S
scale 19
Semi-Auto Mode command button 10
semi-auto phase processing 35
semi-auto processing 26
setpoint
change 51
SFC command button 10
SFC view 38
Show Future command button 10
Show Past command button 10
signature list 12
Signature List view 65
start
batch 23
phase 32
Start Batch command button 10
start time 18
state 18
Step Change command button 10
stop a batch 24
Stop Batch command button 10
warm boot
removes electronic signatures 65
removes reactivated steps 55
Z
Zoom In command button 10
Zoom Out command button 10
T
Table command button 10
Table view 39
interface 39
Timer Complete command button 10
Timer Reset command button 10
Timer steps 49
changing the setpoint 51
forcing to complete 50
resetting 50
Rockwell Automation Publication eProcedure Client User Guide - February 2017
75
Administrator Guide
FactoryTalk® eProcedure
Important User Information
Solid-state equipment has operational characteristics differing from those of electromechanical equipment. Safety Guidelines for the Application,
Installation, and Maintenance of Solid State Controls (publication SGI-1.1 available from your local Rockwell Automation sales office or online
at http://www.rockwellautomation.com/literature/) describes some important differences between solid-state equipment and hard-wired
electromechanical devices. Because of this difference, and also because of the wide variety of uses for solid-state equipment, all persons responsible for
applying this equipment must satisfy themselves that each intended application of this equipment is acceptable.
In no event will Rockwell Automation, Inc. be responsible or liable for indirect or consequential damages resulting from the use or application of this
equipment.
The examples and diagrams in this manual are included solely for illustrative purposes. Because of the many variables and requirements associated
with any particular installation, Rockwell Automation, Inc. cannot assume responsibility or liability for actual use based on the examples and
diagrams.
No patent liability is assumed by Rockwell Automation, Inc. with respect to use of information, circuits, equipment, or software described in this
manual.
Reproduction of the contents of this manual, in whole or in part, without written permission of Rockwell Automation, Inc., is prohibited.
Throughout this manual, when necessary, we use notes to make you aware of safety considerations.
WARNING: Identifies information about practices or circumstances that can cause an explosion in
a hazardous environment, which may lead to personal injury or death, property damage, or
economic loss.
ATTENTION: Identifies information about practices or circumstances that can lead to personal
injury or death, property damage, or economic loss. Attentions help you identify a hazard, avoid a
hazard, and recognize the consequence
SHOCK HAZARD: Labels may be on or inside the equipment, for example, a drive or motor, to
alert people that dangerous voltage may be present.
BURN HAZARD: Labels may be on or inside the equipment, for example, a drive or motor, to alert
people that surfaces may reach dangerous temperatures.
Important:
Identifies information that is critical for successful application and understanding of the product.
Allen-Bradley, Rockwell Software, and Rockwell Automation ControlLogix, eProcedure, FactoryTalk, RSBizWare, RSBizWare BatchHistorian, RSBizWare Historian, RSBizWare MaterialTrack, and RSLinx are
trademarks of Rockwell Automation, Inc.
Trademarks not belonging to Rockwell Automation are property of their respective companies.
Table of contents
Chapter 1
Configure and use
Batch components
Document organization .......................................................................................................9
Chapter 2
Customize
eProcedure
Use hyperlinks..................................................................................................................... 11
Make internal documents available ........................................................................ 11
Create a virtual directory .................................................................................. 12
Assign the virtual directory to an equipment resource ............................... 14
Edit the user.asp .................................................................................................................. 16
Add a custom logo to the user.asp ........................................................................... 16
Add a greeting to the user.asp .................................................................................. 17
ActiveX controls................................................................................................................. 18
Add ActiveX controls ................................................................................................ 18
Specify the timeout period ....................................................................................... 18
Prepare the SignatureList control for Internet Explorer .................................... 18
Chapter 3
Understand
communications
FactoryTalk eProcedure communications .................................................................... 23
Create a shared directory .................................................................................................. 23
Use OLE for Process Control (OPC)............................................................................ 24
OPC group support ................................................................................................... 24
Chapter 4
Implement security
Understand eProcedure security ..................................................................................... 25
Configure the eProcedure service ........................................................................... 26
Add the Batch Server user account to the client computer ............................... 26
Configure Batch clients on Windows XP ............................................................. 26
FactoryTalk Batch Client security .................................................................................. 26
Tighten security for FactoryTalk Batch Clients .................................................. 27
FactoryTalk Batch View security ............................................................................ 28
Security for FactoryTalk Batch commands........................................................... 29
Configure security for FactoryTalk Batch commands................................ 29
Enable Batch View confirm settings ............................................................... 31
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
3
Table of contents
Chapter 5
The FactoryTalk
Batch Service
Manager
Windows services ............................................................................................................... 33
FactoryTalk Batch Service Manager interface .............................................................. 34
Connection.................................................................................................................. 34
Service state.................................................................................................................. 35
Server............................................................................................................................. 36
Batch Server Statistics dialog box .................................................................................... 36
Batch Server Statistics dialog box - General tab ................................................... 37
Batch Server Statistics dialog box - Messages tab ................................................. 38
Batch Server Statistics dialog box - PCD Communications tab ....................... 39
Batch Server Statistics dialog box - View Communications tab ....................... 40
Start the FactoryTalk Batch Server service ................................................................... 40
FactoryTalk Batch Server overview ........................................................................ 43
Sample demonstration setup .................................................................................... 43
Batch Service Manager dialog box - Server options ............................................. 44
Enable a grace period ................................................................................................. 44
Grace periods in FactoryTalk Batch Server........................................................... 45
Add a custom service ................................................................................................. 45
Chapter 6
The FactoryTalk
Batch Server
4
FactoryTalk Batch Server service configuration .......................................................... 47
Specify the startup type ............................................................................................. 47
FactoryTalk Batch Server option configuration .......................................................... 48
Server Options dialog box - Project Settings tab .................................................. 49
Set project directories ........................................................................................ 50
Recipe storage ...................................................................................................... 50
Recipe versioning ................................................................................................ 51
Server Options dialog box - Restart Control tab ................................................. 51
Redundant servers .............................................................................................. 52
Define redundant servers .................................................................................. 52
Server Options dialog box - Batch Reporting tab ................................................ 54
Report Editor ...................................................................................................... 54
Perform end of batch archiving ....................................................................... 54
Perform incremental archiving ........................................................................ 55
Perform user-defined end of batch.................................................................. 56
None...................................................................................................................... 57
Never ..................................................................................................................... 57
Archiver Event Filters tab ......................................................................................... 57
Batch Server tab .......................................................................................................... 58
Hold propagation ............................................................................................... 58
Communications timeout ................................................................................ 59
Miscellaneous ...................................................................................................... 60
Batch identification ........................................................................................... 60
Cross Invocation Descriptors and Defaults tab ................................................... 61
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
Table of contents
Resource types ..................................................................................................... 61
Descriptors........................................................................................................... 61
Default values ...................................................................................................... 62
Hyperlink Descriptors and Defaults tab ............................................................... 62
Resource types ..................................................................................................... 62
Descriptors........................................................................................................... 63
Default values ...................................................................................................... 63
Material Policies tab................................................................................................... 63
Modify the .NET registry key .......................................................................................... 64
Use automatic restart control to restart the FactoryTalk Batch Server .................. 65
Restart the FactoryTalk Batch Server .................................................................... 65
Perform a manual failover................................................................................................. 66
Configure the FactoryTalk Batch Server for manual failover ........................... 66
Configure the material-enabled FactoryTalk Batch Server for manual failover
........................................................................................................................................ 67
Command handshake timeout ........................................................................................ 68
Chapter 7
Windows event log
View event log entry properties ....................................................................................... 71
Modify event log settings .................................................................................................. 75
Chapter 8
Cross invocation
Cross invocation overview................................................................................................ 77
Cross invocation string configuration ........................................................................... 79
Cross invocation string escape sequences ...................................................................... 80
Cross invocation string example ............................................................................. 82
FactoryTalk Batch View and ActiveX Controls configuration for cross
invocation ............................................................................................................ 82
Chapter 9
Work with the Phase
Simulator
Start the FactoryTalk Batch Phase Simulator .............................................................. 85
FactoryTalk Batch Phase Simulator interface ...................................................... 86
Modify a phase’s configuration........................................................................................ 86
Change the dwell time............................................................................................... 87
Change the sequence of requests ............................................................................. 87
Indicate a continuous phase ..................................................................................... 88
Change phase status during run time ............................................................................. 88
View/update report parameter tag values.............................................................. 91
Change the value of a unit tag.......................................................................................... 93
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
5
Table of contents
Chapter 10
Troubleshooting
Troubleshooting eProcedure ........................................................................................... 95
Objects embedded in HTML code do not display .............................................. 95
Control step reactivation error messages ............................................................... 96
Troubleshooting FactoryTalk Batch.............................................................................. 96
Handle abnormal FactoryTalk Batch termination ............................................. 96
Determine abnormal termination................................................................... 97
Name the log file copy ....................................................................................... 97
End of batch entries ........................................................................................... 97
Log tag verification information ............................................................................. 98
Tag verification log file ...................................................................................... 98
Windows event log ............................................................................................. 99
Performance chart .................................................................................................... 100
Open the FactoryTalk Batch performance chart ....................................... 100
FactoryTalk Batch performance chart ......................................................... 101
Troubleshoot errors ................................................................................................. 101
Chapter 11
Customize batch IDs
Enable editing of batch IDs ............................................................................................ 107
Disable editing of batch IDs........................................................................................... 108
Define a custom default batch ID ................................................................................. 108
Create a custom BatchIDCreation.dll ......................................................................... 109
Modify the user.asp file to allow editing of batch IDs .............................................. 111
Modify the user.asp file to prevent editing of batch IDs .......................................... 111
Chapter 12
Archive HTML
elements
HTML elements............................................................................................................... 115
Chapter 13
Change the
FactoryTalk Batch
server user account
New user account requirements for the FactoryTalk Batch Server ....................... 119
Configure your FactoryTalk Batch system ................................................................. 120
Change the server account password .................................................................... 121
Change the server user account for the FactoryTalk Batch Server service.... 122
Change the server user account in FactoryTalk Batch COM+ applications122
Change the server user account in My Computer properties.......................... 123
Configure your FactoryTalk Batch system ......................................................... 124
Server account password change locations .......................................................... 125
Legal Notices
Legal Notices ..................................................................................................................... 127
6
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
Table of contents
Index
Index ................................................................................................................................... 129
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
7
Chapter 1
Configure and use Batch
components
This guide contains instructions for procedures specific to
FactoryTalk eProcedure®, such as implementing security and configuring the userdefined area active server page.
Included are instructions for tasks specific to FactoryTalk® Batch, such as
configuring security and services to support eProcedure. Instructions are also
provided on the implementation and use of components not normally accessed or
used by batch operators, such as the FactoryTalk Batch Server, Simulator, and
performance chart.
Document
organization
The information in this document is presented in an order that should minimize
the effort required for the configuration and administration of a FactoryTalk
Batch system.
The following subjects are included:
•
Configuring Regional Settings, Communications, Security, Electronic
Signatures, and Batch Auditing
•
Using the FactoryTalk Batch Service Manager, Windows Event Log, Phase
Simulator, and Server
•
Configuring Batch IDs, the Server user account, and multiple instances of
FactoryTalk Batch View
•
General troubleshooting
See also
The FactoryTalk Batch Server on page 47
Batch identification on page 60
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
9
Chapter 2
Customize eProcedure
eProcedure is used to display hyperlinks associated with equipment resources and
to customize the appearance of the eProcedure Client. Hyperlinks are assigned to
equipment resources within the FactoryTalk Batch Equipment Editor.
The eProcedure Client is customized by editing the User.asp file. A company logo
and Internet URL can be added; batch IDs can be made editable or not. The URL
can point to an intranet site containing maintenance records or material safety
documents.
Use hyperlinks
You can use any valid URL to view web pages from the Equipment view, but you
can also configure hyperlinks for internal documents such as maintenance history
logs, maintenance schedules, personnel schedules, notes about operations, web
camera views of units or equipment, and startup or shutdown documentation.
Once the URL of a document (or web camera) is configured, you can view the
item through the browser. You can use the Back or Home button to return to the
Equipment view.
Hyperlinks can be assigned to any resources within the equipment database. These
hyperlinks are then made available within the eProcedure Client in the Equipment
view. You can use the hyperlinks to provide access to documents that reside on
your local intranet, pertaining to the specific equipment resource, or you may want
to provide access to a manufacturer’s web site. The following instructions outline
the method for making internal documents available via hyperlinks.
Make internal
documents available
In order to make documents or items accessible from within the FactoryTalk
Batch Client, you must first create a virtual directory that points to the directory
containing the documentation or image files.
A virtual directory is a directory not physically contained within the home
directory (/Inetpub) on the Web server. Virtual directories give you the ability to
publish information located on your hard drive. For example, if you create a virtual
directory for C:\Documents\Reports and give it an alias of Reports, users could view
the directory using the URL http://<servername>/Reports/.
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
11
Chapter 2
Customize eProcedure
Create a virtual directory
You must be logged on as a member of the Administrators group on the local
computer to perform the following procedures. On Windows Server 2008, only
server administrators can add and edit virtual directories.
On Windows 7 or Server 2008:
1. Ensure that Internet Information Services are enabled, then open IIS
Manager: From the Start menu, select All Programs > Accessories, and
then click Run.
2. In the Open box, type inetmgr, and then click OK.
3. In the Connections pane, expand the Sites node in the tree, and then
navigate to (local computer) > Web Sites > Default Web Site.
4. In the Actions pane, click View Virtual Directories.
5. On the Virtual Directories page, in the Actions pane, click Add Virtual
Directory.
6. In the Add Virtual Directory dialog box, type a name in the Alias text box.
This alias is used to access the content from a URL.
7. In the Physical path text box, type the physical path of the content folder, or
click Browse to navigate through the file system to find the folder.
8. Click OK.
On Windows XP:
1. In My Computer, navigate to the folder you want to share.
2. Right-click the folder, and then click Properties.
3. Select the Web Sharing tab.
4. Select Share this folder. The Edit Alias dialog box opens.
5. In the Alias box, type the name of the alias you want for this directory. By
default, the computer assigns the directory name as the alias if you do not
change the information.
6. Leave all other options with the default settings and click OK.
7. Click OK to exit the Properties dialog box.
12
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
Customize eProcedure
Chapter 2
This creates a virtual directory within your default web directory. For example, if
you are on a Windows XP workstation running Microsoft Personal Web Server,
the default web directory is normally C:\inetpub\wwwroot. Therefore, the virtual
directory appears as C:\inetpub\wwwroot\<new virtual directory>. (See
Microsoft’s online help for Microsoft Personal Web Server or Internet
Information Server (IIS) for more information on virtual directories.)
Important:
When you click OK in the Edit Alias dialog box, your changes take
effect immediately. Clicking Cancel does not cancel the alias
assignment.
Virtual Directory Examples
Example 1:
•
You want to create a virtual directory called Reports. The actual directory
is C:\Reports. Using the steps above, the virtual directory is created under
the default web site.
The hyperlink in the Equipment Editor is: /REPORTS/<file name>
•
You want to create a virtual directory called Pictures for custom icons to
reference from an instruction file. The actual directory is C:\Pictures. Using
the steps above, the virtual directory is created under the default web site.
The file reference in an instruction file form is: img
src=/Pictures/<picture.gif>
Example 2:
•
You want to create a virtual directory called Reports in the eProcedure
virtual directory. The actual directory is C:\Program Files\Rockwell
Software\Batch\Reports. In step 5 above, enter the
alias /eProcedure/Reports.
The hyperlink in the Equipment Editor is: REPORTS/<file name> (no
preceding slash).
•
You want to create a virtual directory called Pictures in the eProcedure
virtual directory. The actual directory is C:\Program Files\Rockwell
Software\Batch\Pictures. In step 5 above, enter the
alias /eProcedure/Pictures.
The file reference in an instruction file form would be: img
src=Pictures/<picture.gif> (no preceding slash).
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
13
Chapter 2
Customize eProcedure
Assign the virtual directory Follow the instructions in the FactoryTalk Batch Equipment Editor User Guide for
to an equipment resource setting up an equipment resource. The Server Options dialog box contains some
or all of the tabs on the following screen shots, depending on which FactoryTalk
Batch modules are installed on your system.
1. Open the Equipment Editor.
2. From the Options menu, click Server Options, and then select
the Hyperlink Descriptors and Defaults tab.
3. Select the desired resource type (this example uses Equipment Modules).
4. In the Descriptors area, type a descriptive name for each hyperlink you want
to associate with an equipment module. The example in the figure above
lists possible names.
5. If necessary, type or change the information listed in the Default
Values boxes.
6. Click OK.
7. Navigate to the desired equipment module and right-click to display
the Edit Equipment Module dialog.
8. Select the Hyperlink tab.
14
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
Customize eProcedure
Chapter 2
9. In the Hyperlink Configuration area, type each hyperlink. For the example
shown above, you would
type http://Server_Name/Reports/<doc_name>, where <doc_name> is
the desired HTML file to display.
10. Click OK when done. Stop and restart the FactoryTalk Batch Server
and eProcedure Server services (if Warm Restart is not selected in the
FactoryTalk Batch Service Manager). When the equipment module is used
in a batch and viewed in eProcedure, the hyperlink is displayed to the right
of the equipment module icon, as shown below.
11. When you click the hyperlink, the specified web page opens (see the
example below). To return to eProcedure, click the Back button on the
browser toolbar. Notice how the URL displays in the remote
Client’s Address box.
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
15
Chapter 2
Customize eProcedure
Edit the user.asp
The User.asp file is located in the \Program Files\Rockwell Software\Batch\web
directory on the FactoryTalk Batch Server computer. You can modify this file to
support requirements specific to your system. For example, you could add HTML
code to the User.asp that links eProcedure to displays of other manufacturing
applications, such as status information from a SCADA (supervisory control and
data acquisition) system. The User.asp can be modified so that documents are
always available (because they are not related to specific equipment). You can also
modify the User.asp to specify a timeout period for the Batch List ActiveX control.
(For more information on specifying the timeout period, see the Specify the
timeout period topic.)
Important:
Do not edit any ASPs other than User.asp. They are directly
related to the successful operation of eProcedure.
Other documents could be maintenance schedules, quality lab schedules,
personnel shift schedules, pages for e-mail sent to the area, or web mail e-mail
sender pages (to allow the operator to send e-mail from the area). You could even
point them to stock pages, where the company’s stock price and press releases are
posted. You could also add HTML that displays buttons linking to other
manufacturing applications like an HMI or LIMS (laboratory information
management systems).
See also
Specify the timeout period on page 18
Add a custom logo to
the user.asp
This example discusses how to add a custom logo and link to a web site to
the User.asp.
Tip:
Images and files must be placed in directories under \Batch\web\
to use relative ("./") paths. Otherwise, absolute path names must
be used (for example, "/full_path/Image.jpg").
1. Open User.asp in a text Editor such as Notepad and save it with the
name User.old. This allows you to recover the original file should you need
it.
2. Open the original User.asp file.
3. Locate the line that is highlighted in the file (as shown below).
16
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
Customize eProcedure
Chapter 2
4. Edit this line with the desired information:
•
The new URL
For example: http://www.acmecorp.com/safetydocs.html
•
The text to use when the mouse moves over the logo (Alt)
For example: IMG alt="Acme Corp"
•
The name of the new logo image (.gif or .jpg)
For example: src="./images/acmelogo.gif" (if the image has been copied
to the \Program Files\Rockwell Software\Batch\web\images directory)
or src="/fullpath/acmelogo.gif" (if the file is located outside
the \Program Files\Rockwell Software\Batch\web\images directory)
The new file should resemble the figure below:
5. Save the file as User.asp. Exit the text editor.
6. Open eProcedure to verify that the changes take place. The new eProcedure
opening page should resemble the image below. Note the mouse over text
and the URL in the status bar at the bottom of the window.
Add a greeting to the
user.asp
You can even add logic to the User.asp. The following example adds a greeting
based on the time of day.
If a user logs onto the eProcedure Client after midnight and before noon, the
greeting is "Good Morning!" At any other time the user is greeted with "Hello!"
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
17
Chapter 2
Customize eProcedure
ActiveX controls
eProcedure uses ActiveX controls to communicate with the FactoryTalk Batch
Server and allows you to monitor and interact with control recipes. These controls
are necessary for the correct operation of the program. You can specify the timeout
period for the batch list ActiveX control to allow for larger batches to be put on
the batch list without timing out. You can also embed additional ActiveX controls
in HTML recipe forms containing SOPs, which gives you even more flexibility
when running a batch recipe with eProcedure.
Add ActiveX controls
All controls must occur within a form in the instruction file or eProcedure ignores
the script. When creating an HTML file, the form is designated by the
<Form></Form> tags. (See the FactoryTalk eProcedure Instruction File Design
Guide for information on creating instruction files.)
Specify the timeout
period
In the User.asp file, you can specify the timeout period for the BatchList ActiveX
control. The default value is 60000 milliseconds, which equals 60 seconds. If batch
creation is taking longer than 60 seconds, you can increase the value as needed.
The following example highlights the line you must modify in the User.asp file.
Prepare the
SignatureList control
for Internet Explorer
In order for the SignatureList control to work in any client application, including
the eProcedure Client, that does not call CoInitializeSecurity (this includes
Internet Explorer, Visual Basic, and possibly HMI applications), the following
steps must be completed on the client computer:
1. If the FactoryTalk Batch Server runs under a local machine account
(workgroup), create an account with the same user name and password on
the client machine.
2. Open the Component Services window.
Windows Server 2008: Click the Start button, point to All Programs >
Administrative Tools, and then select Component Services.
The Component Services window opens.
18
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
Customize eProcedure
Chapter 2
Windows 7 or Windows XP: Click the Start button, navigate to the Control
Panel, double-click Administrative Tools, and then open Component
Services.
3. Open Component Services and Computers, right-click My Computer,
and then click Properties. The My Computer Properties dialog box
opens.
4. Click the [Default] COM Security tab, and then click the Edit Default
button in the Access Permissions area. The Access Permission dialog box
opens.
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
19
Chapter 2
Customize eProcedure
5. Click the Add button. The Select Users, Computers, or Groups dialog
box opens.
6. Select the correct location in the From this location box:
•
If the FactoryTalk Batch Server is running on a domain, select the
Server domain name.
•
If the FactoryTalk Batch Server is running on a local user account
(workgroup), select the Client computer name.
7. In the Enter the object names to select box, add the account the
FactoryTalk Batch Server runs as to the list and click Check Names. This
verifies that the account exists.
20
•
If the FactoryTalk Batch Server is running on a domain, choose the
Server’s domain account (for example, batchsvr).
•
If the FactoryTalk Batch Server is running on a local user account
(workgroup), select the name of the local account under which the
Server runs.
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
Customize eProcedure
Chapter 2
8. Select the new user or group in the Group or user name area and, in
the Permissions area, set Access Permission to Allow (Windows Server
2008) or Local Access and Remote Access to Allow (Windows 7 or XP).
9. Click OK to close the Access Permission and My Computer Properties
dialog boxes.
10. Close the Component Services window.
11. Log off and then log back on.
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
21
Chapter 3
Understand communications
FactoryTalk eProcedure itself requires very little in the way of special
configuration. Most of the required configuration is performed in the postinstallation procedures. (See the FactoryTalk eProcedure Getting Results Guide for
more information.) The information in this section is provided to enhance your
understanding of how eProcedure works in conjunction with FactoryTalk Batch.
FactoryTalk
eProcedure
communications
eProcedure uses OLE for Process Control (OPC) to communicate between
the eProcedure Server and the FactoryTalk Batch Server. Communication from
the eProcedure Client to the Server is HTTP (for web content) and DCOM for
live data.
Create a shared
directory
A shared directory allows computers on the network to read from and write to a
common recipe, area model, or data file. The FactoryTalk Batch installation
creates a shared directory named BATCHCTL where the FactoryTalk Batch
software is installed (the default is C:\Program Files (x86)\Rockwell
Software\Batch). If you installed your project files in a different directory,
configure that directory as a shared directory. To configure a shared directory,
administrative privileges are required.
To create a shared directory:
1. Navigate to the project file directory, then right-click the folder, and select
the sharing option.
2. Use the File Sharing dialog box to add each user or user group name that
requires access to the project file directory.
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
23
Chapter 3
Understand communications
3. Repeat for each user or user group, including the user accounts used by the
FactoryTalk Batch Server and FactoryTalk Event Archiver.
4. Select Share.
Use OLE for
Process Control
(OPC)
OPC group support
The FactoryTalk Batch Server supports the use of the OLE for Process Control
(OPC) communications protocol. OPC provides a defined set of COM interfaces
for data access functions.
The OPC communications protocol is used by the FactoryTalk Batch Server to
communicate with process-connected devices via a data server and to
communicate with FactoryTalk Batch View, SignatureList ActiveX control and
PC-Based phases. COM is used to communicate with ActiveX controls or other
high-level applications such as FactoryTalk Batch Material Manager.
Within the OPC protocol, data is accessed through collections of data items
referred to as groups. Different data servers have varying levels of OPC support,
including maximum numbers of groups, maximum numbers of items per group
and performance issues, and so on. Because of this, FactoryTalk Batch support of
OPC is flexible in order to achieve successful communication with as many
different data servers as possible. To achieve this, the FactoryTalk Batch Server is
flexible in its definition of Groups, and allows for different OPC grouping
configurations to communicate with the data server(s).
The manner in which the FactoryTalk Batch Server organizes the area model tags
into groups is defined by data server definition files (DSDF). These files are
located in the Batch\Dataservers directory. FactoryTalk Batch comes with a
predefined set of DSDF files. If you need to communicate with a data server for
which there is no predefined DSDF file, contact Rockwell Automation
Application Support.
24
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
Chapter 4
Implement security
FactoryTalk eProcedure takes advantage of the security features of the
FactoryTalk® Batch View. The permissions assigned to the users and groups for the
View commands are used within the eProcedure Client. The security implemented
for the View is also used within the eProcedure Client. (See the FactoryTalk Batch
Administrator Guide for more information.)
The logged in user should:
•
be an FactoryTalk Security user or a Windows-linked user
•
be a user with rights to all of the buttons
If operators wish to perform a function that is secured, for instance Abort, they
must enter a user name and password, which is checked against the FactoryTalk
Security settings defined in the FactoryTalk Directory. (See the FactoryTalk Batch
Administrator Guide for more information.)
Important:
Understand
eProcedure security
It is important to know that FactoryTalk Security cannot be used
to secure eProcedure instructions. However, instructions can be
secured through verification signatures.
There are distinct differences between the security capabilities of the
FactoryTalk eProcedure Client and the FactoryTalk Batch View:
•
Command buttons in the eProcedure Client are shown, but disabled, if the
user does not have the appropriate permissions.
•
The Reactivate Step button on the Instructions view of the eProcedure
Client and the ReactivateStep Confirm policy setting in FactoryTalk
Directory are specific to eProcedure.
Tip:
Because the ability to secure FactoryTalk eProcedure instruction files
does not currently exist in FactoryTalk Security, you can require an
electronic signature on Parameter Change to prevent unauthorized
users from executing instructions. (See Electronic signatures in
the FactoryTalk Batch Equipment Editor User Guide for more
information.)
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
25
Chapter 4
Implement security
Configure the
eProcedure service
The eProcedure Service is installed on the FactoryTalk Batch Server computer and
requires no special configuration. The eProcedure Service can be configured to
start manually by changing the startup type in the Services dialog box of the
Control Panel. (See the FactoryTalk Batch Administrator Guide for more
information.)
Add the Batch Server
user account to the
client computer
If the Batch Server user account is a workgroup account or if the FactoryTalk
Batch Server computer needs to access files on the client computer, you must add
the Batch Server user account to all FactoryTalk Batch client computers. (See
the FactoryTalk Batch Administrator Guide for more information.)
Configure Batch
clients on Windows XP
If a FactoryTalk Batch client is running on Windows XP Professional SP3 and
connecting to a remote FactoryTalk Batch Server, you must change the Local
Security Policy on the client computer. To allow the FactoryTalk Batch View to
connect to a remote FactoryTalk Batch Server complete to the following steps.
1. Point to Control Panel > Administrative Tools. Click Local Security
Policy. The Local Security Settings window opens.
2. Expand Local Policies, and then click Security Options.
3. Locate and double-click Network access: Sharing and security model for
local accounts. The Network access: Sharing and security model for
local accounts dialog box opens.
4. Select Classic - local users authenticate as themselves from the list.
5. Click OK to close the dialog box.
FactoryTalk Batch
Client security
FactoryTalk Batch View, FactoryTalk eProcedure, ActiveX controls, Equipment
Editor, and Recipe Editor use FactoryTalk Security, which allows security settings
to be shared among FactoryTalk enabled products across a network or on the
same computer. FactoryTalk Directory is the infrastructure which contains the
security policies defined for FactoryTalk Security secured resources.
FactoryTalk Batch secured resources include Batch Commands, Phase
Commands, the Batch View windows, and log ons to FactoryTalk Batch
components. For a complete list of FactoryTalk Batch secured objects and their
default security policy settings refer to the FactoryTalk Batch Administrator Guide.
FactoryTalk Batch product policies are created in the Local Directory and the
Network Directory when the FactoryTalk Services Platform installs. The
FactoryTalk Batch product polices are used to restrict access to the FactoryTalk
Batch client components and the features within them. (See the FactoryTalk Help
for more information.)
26
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
Implement security
Chapter 4
The FactoryTalk Services Platform installation process:
•
Creates both a FactoryTalk Local Directory and a FactoryTalk
Network Directory on the computer. When the install process finishes,
both directories are fully configured and ready for use.
Tip:
Tighten security for
FactoryTalk Batch
Clients
Security settings are completely separate in the Network Directory and
Local Directory. Changes you make to the security settings in the Network
Directory do not affect the Local Directory and vice versa.
•
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.
•
Allows any authenticated Windows user to log on to the FactoryTalk
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.
Restrict access to specific features of your individual FactoryTalk products. Only
users with access can use secured product features.
For example, when you set up product policies for FactoryTalk Batch, restrict use
of the Abort command to specific users. This prevents automated batch processes
from going down during run time.
To configure security for multiple features in FactoryTalk, use the Feature
Security for Product Policies dialog box.
To configure security for the FactoryTalk Batch features, refer to the secured
product policies defined for the FactoryTalk Batch Clients.
To tighten security for FactoryTalk Batch Clients:
•
Delete the Windows Authenticated Users group from the Local
Directory. Secure the FactoryTalk Batch 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 or groups to secure the FactoryTalk Batch
Clients.
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
27
Chapter 4
Implement security
•
Add user accounts and groups created in Windows to the FactoryTalk
Directory. Windows accounts added to the FactoryTalk Directory are
called Windows-linked user accounts and groups.
Windows Workgroup User Accounts are not supported in
FactoryTalk.
If you use Windows workgroups, you cannot administer user
accounts centrally for FactoryTalk Batch Client applications.
FactoryTalk Directory does not allow multiple user accounts
to have the same name and password.
•
Remove the All Users group from the FactoryTalk Batch product policies.
The FactoryTalk Services Platform installation process adds the All Users
group to all FactoryTalk product policies. To secure FactoryTalk Batch,
remove or restrict the All Users group for FactoryTalk Batch product
policies. For example, to restrict access to FactoryTalk Batch View windows,
remove the All Users group from the associated product policies and then
add the necessary user accounts.
•
Add user accounts and groups to the FactoryTalk Batch product policies.
To secure FactoryTalk Batch resources, add only the necessary user
accounts and groups to the corresponding product policies. For a complete
list of FactoryTalk Batch product policies, see FactoryTalk Batch default
policy settings.
See also
Security for FactoryTalk Batch commands on page 29
FactoryTalk Batch
View security
Configure FactoryTalk security to specify which FactoryTalk Batch View toolbar
buttons and windows are available to each logged on user. Removing a user group
from a security policy disables the corresponding toolbar button for all users who
are members of that user group. When a button is disabled, it no longer appears on
the toolbar.
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.)
To open FactoryTalk Help, click Start, point to All Programs > Rockwell
Software > FactoryTalk Tools, and then click FactoryTalk Help.
See also
Security for FactoryTalk Batch commands on page 29
28
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
Implement security
Security for
FactoryTalk Batch
commands
Chapter 4
Configure FactoryTalk Security to require user confirmation for batch commands
and phase commands. A command that has the confirm feature enabled does not
execute until the user account is validated in the Log on to Confirm User dialog
box.
To enable the Confirm feature, configure the FactoryTalk Batch product policy
for the command and then set the associated <Command> Confirm policy setting
to True. These policy settings are defined in FactoryTalk Directory for each
command button within FactoryTalk Batch View and every phase command
issued from the Phase Control window.
Tip:
When the Confirm feature is enabled for a command,
only active user accounts assigned to the Command are
allowed to execute the command. Users validated in
the Log on to Confirm User dialog box are not logged
on to FactoryTalk Batch View.
The <Command> Confirm policy settings are found in the following locations:
•
FactoryTalk Directory\Local | Network\
System\Policies\Product Policies\Batch\BatchView and
ActiveX\Commands
•
FactoryTalk Directory\Local | Network\
System\Policies\Product Policies\Batch\BatchView and
ActiveX\Phase Commands
See also
FactoryTalk Batch View security on page 28
Configure security for FactoryTalk Batch commands on page 29
Configure security for
FactoryTalk Batch
commands
To allow only specified users to issue commands against a batch or a phase, add
the appropriate users or user groups to the Command or Phase Command policy
setting. Then remove or restrict the All Users group.
To configure security for FactoryTalk Batch commands:
1. Open the FactoryTalk Administration Console and log on to the
appropriate FactoryTalk Directory.
2. Expand System > Policies > Product Policies > Batch > BatchView &
ActiveX.
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
29
Chapter 4
Implement security
3. Right-click Commands and then select Properties.
4. Select the policy setting to configure and then select the corresponding
browse button.
5. (optional) In the Configure Securable Action dialog box:
•
Select a user or group and then select Remove.
•
Allow or deny a user or group access to the feature by selecting or
clearing the corresponding check box and then selecting OK.
•
Add a user account or user group by selecting Add. This option displays
the Select User and Computer dialog box.
6. (optional) In the Select User or Group dialog box:
•
Select a user, user group, computer, or computer group and then
select OK.
•
Select Create New to create and then add a new user, user group,
computer, or computer group.
7. Select OK to close the View Properties dialog box.
Tip:
Restart all FactoryTalk Batch components to update security changes
made in the FactoryTalk Directory.
See also
FactoryTalk Batch View security on page 28
Security for FactoryTalk Batch commands on page 29
30
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
Implement security
Chapter 4
Enable Batch View confirm If you assign specific users and/or groups to a Batch Command or Phase
Command and enable the corresponding Confirm policy setting, then only the
settings
specified users are allowed to issue the command. (See the FactoryTalk Batch
Administrator Guide for more information.)
The Reactivate Step button on the Instructions view of the eProcedure Client is
disabled if you do not have permission to reactivate steps. When you access the
Instructions view, the eProcedure Client checks the FactoryTalk Security policy
settings for the command. If you have permission to reactivate steps, but
the CONFIRM value for the ReactivateStep policy setting is True, the Log on to
Confirm User dialog box prompts for a user ID and password when
the Reactivate Step button is clicked. If the user is authenticated, the step
reactivation proceeds. If not, an error message is displayed. (See the FactoryTalk
Batch Administrator Guide for more information.)
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
31
Chapter 5
The FactoryTalk Batch Service
Manager
The FactoryTalk Batch Service Manager is used with the FactoryTalk Batch
Server, eProcedure Server, and FactoryTalk Event Archiver, when FactoryTalk
Event Archiver is configured as a Windows service. The Service Manager manually
starts and stops the FactoryTalk Batch Server and manually starts, pauses,
continues or stops FactoryTalk Event Archiver services. The Service Manager
accesses the Batch Server Statistics dialog box, which gives access to COM server
information, COM client status, error information, and other FactoryTalk Batch
Server information.
Tip:
To command the FactoryTalk Batch Server or
FactoryTalk Event Archiver services, you must have local
administrator privileges on the computer where the
server and/or FactoryTalk Event Archiver services are
installed. If you do not have local administrator privileges,
you will have view-only privileges.
See also
Windows services on page 33
FactoryTalk Batch Service Manager interface on page 34
Batch Server Statistics dialog box on page 36
Start the batch server service on page 40
Add a custom service on page 45
Windows services
The FactoryTalk Batch Server and FactoryTalk Event Archiver operate as
Windows services. During FactoryTalk Batch installation, the user account
specified during the installation is assigned to the Log On As: This Account:
option, found in the (Administrative Tools) Services dialog box.
Running as a Windows service allows the FactoryTalk Batch Server to run in the
absence of an interactive Windows logon. Logging on or logging off Windows
during operation does not disrupt the server execution.
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
33
Chapter 5
The FactoryTalk Batch Service Manager
Configure the FactoryTalk Batch Server to start automatically, giving server
control to Windows Services, or control the FactoryTalk Batch Server manually
using the FactoryTalk Batch Service Manager. The Service Manager also controls
the type of boot method that the server uses, and runs the server in demo mode.
Tip:
Specifying the boot method or demo mode in the
FactoryTalk Batch Service Manager does not alter the
Batchsvr.ini file and has no effect on the server when
automatically starting.
See also
The FactoryTalk Batch Service Manager on page 33
FactoryTalk Batch
Service Manager
interface
The FactoryTalk Batch Service Manager interface is organized into three areas:
•
Connection
•
Service state
•
Server
See also
Connection on page 34
Service state on page 35
Server on page 36
Connection
The Connection area contains:
Item
Definition
Computer
Displays the selected computer.
Select Computer
Selects the computer where the service is located.
Service
Allows you to select a service from a list of batch
services for the selected computer.
See also
The FactoryTalk Batch Service Manager on page 33
Service state on page 35
Server on page 36
34
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
The FactoryTalk Batch Service Manager
Service state
Chapter 5
The Service State area contains buttons, text and a graphic traffic light service
state representation.
The following possible states and corresponding colors are displayed:
STARTING
None
RUNNING
Green
STOPPED
Red
PAUSED
Yellow
NOT CONNECTED
None
START PENDING
None
The Service State area contains the following buttons:
Item
Definition
Stop
Stops the selected service.
Pause
Pauses the selected service. This button is not
enabled for the batch server.
Start/
Continue
Starts the selected service or continues a service
that has been paused.
Tip:
The state of the FactoryTalk Batch Service Manager
(information from the Connection and Server groups) is
stored from the last time the Service Manager was run. These
values are written when the FactoryTalk Batch Server is
closed.
See also
The FactoryTalk Batch Service Manager on page 33
Connection on page 34
Server on page 36
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
35
Chapter 5
The FactoryTalk Batch Service Manager
The Server area contains:
Server
Item
Definition
Allow Demo Mode
The FactoryTalk Batch Server runs with full functionality
without a license for a two-hour period. After two hours,
the server stops running.
Allow Grace Period
The FactoryTalk Batch Server starts when a valid
activation is not found. The grace period is seven days,
after which a valid FactoryTalk Activation license is
required.
Cold Boot
The FactoryTalk Batch Server starts in a completely
initialized condition. All restart data is erased and all
recipe content is removed from the Batch List.
Warm Boot
The FactoryTalk Batch Server starts and attempts to
restore the set of batches that were on the batch list
when the server previously terminated. The restart files
are altered so only one warm restart may be attempted.
Warm All Boot
Restarts the FactoryTalk Batch Server only if it is able to
restore all of the batches to the batch list. Restart does
not alter the restart files so another warm-all or warm
restart may be attempted. This is the default setting for
automatic restarts.
Server Statistics
This button opens the Batch Server Statistics dialog
box.
See also
The FactoryTalk Batch Service Manager on page 33
Service state on page 35
Connection on page 34
Batch Server
Statistics dialog box
The Batch Server Statistics dialog box displays an overview of the current
system’s status. The data is view-only and cannot be modified. The COM server
and area model file referenced are specified in the Server Options dialog box
accessed from FactoryTalk Batch Equipment Editor. The Batch Server Statistics
dialog box is organized into four tabs.
See also
Batch Server Statistics dialog box - General tab on page 37
Batch Server Statistics dialog box - Messages tab on page 38
Batch Server Statistics dialog box - PCD Communications tab on page 39
Batch Server Statistics dialog box - View Communications tab on page 40
36
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
The FactoryTalk Batch Service Manager
Batch Server Statistics
dialog box - General
tab
Chapter 5
The General tab lists various data on the number of batches and prompts being
currently handled by the FactoryTalk Batch Server, as well as the Windows time
on the server, the time the batch server was started, and the name and creation
date of the current area model.
The General tab contains the following:
Field
Definition
Batch Count
The number of batches loaded in the FactoryTalk
Batch Server.
Prompts Count
The number of prompts currently existing within all
batches.
Version
The version number of the FactoryTalk Batch Server.
Time
The time as specified by Windows on the FactoryTalk
Batch Server.
Started at
The time the FactoryTalk Batch Server was started.
Area Model File Name
The name of the currently active area model.
Area Model Date
The creation date of the currently active area model.
See also
The FactoryTalk Batch Service Manager on page 33
Batch Server Statistics dialog box on page 36
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
37
Chapter 5
The FactoryTalk Batch Service Manager
Batch Server Statistics
dialog box - Messages
tab
The Messages tab is used to monitor FactoryTalk Batch Server log information.
The messages displayed in the three sections are the most recent messages written
to the server log by the server.
The Messages tab consists of the following:
Field
Definition
Info
The most recent Info-type entry in the log file. Info
entries are log entries recorded as a part of the normal
execution.
Warning
The most recent Warning-type entry in the log
file. Warning entries indicate that a minor irregularity
was detected in the system. The irregularity was
handled by the system or the system is not sure of the
occurrence’s implications.
Severe
The most recent Severe-type entry in the log
file. Severe entries indicate that a severe error
condition was encountered. The system handled the
situation as best it could.
See also
The FactoryTalk Batch Service Manager on page 33
Batch Server Statistics dialog box on page 36
38
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
The FactoryTalk Batch Service Manager
Batch Server Statistics
dialog box - PCD
Communications tab
Chapter 5
The PCD Communications tab is used to monitor the FactoryTalk Batch Server
communication status and any data servers that are communicating with the
server. Verification of all tags, phases, and equipment operation sequences
associated with the current area model is also performed.
The PCD Communications tab consists of the following components:
Field
Definition
Data Server Status
Lists of all configured data servers in the area model and
the communication status between FactoryTalk Batch and
these data server(s).
Tag Verify Status
Indicates if the verification function is READY, IN
PROGRESS, or COMPLETED.
Tag Verify Verified
Indicates the number of tags, phases, and equipment
operation sequences that the server has processed during
tag verification.
Tag Verify Bad
Indicates the number of tags, phases, and equipment
operation sequences that the server was unable to verify.
Bad tags, phases, and equipment operation sequences
indicate either the data server is unable to supply the data
requested by the FactoryTalk Batch Server or the data
was not of the expected type.
Tag Verify Total
Indicates the total number of tags, phases, and equipment
operation sequences.
Start
Starts the verification process.
Stop
Stops the verification process.
See also
The FactoryTalk Batch Service Manager on page 33
Batch Server Statistics dialog box on page 36
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
39
Chapter 5
The FactoryTalk Batch Service Manager
Batch Server Statistics
dialog box - View
Communications tab
The View Communications tab is used to monitor the number of Dynamic Data
Exchange (DDE), Component Object Model (COM) and Ole for Process
Control (OPC) conversations taking place between the FactoryTalk Batch Server
and Client software, such as FactoryTalk Batch View and ActiveX Controls.
The View Communications tab consists of the following:
Item
Definition
DDE Connections
The number of DDE communications attached to the
FactoryTalk Batch Server.
COM Connections
The number of COM communications attached to the
server.
OPC Connections
The number of OPC communications attached to the
server.
Items
The number of communication items the server is
currently supporting.
See also
The FactoryTalk Batch Service Manager on page 33
Batch Server Statistics dialog box on page 36
Start the
FactoryTalk Batch
Server service
40
The FactoryTalk Batch Service Manager communicates with the Windows
Services of the selected computer to determine available services. There may be a
noticeable delay as communications are established, marked by the cursor
displayed as an hourglass. If the FactoryTalk Batch Service Manager cannot
communicate with the selected computer’s Windows Services, a message box is
displayed stating that the FactoryTalk Batch Service Manager failed to connect to
the specified computer.
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
The FactoryTalk Batch Service Manager
Chapter 5
The FactoryTalk Batch Phase Simulator must be running to test FactoryTalk
Batch in a demo environment. For more information, see The FactoryTalk Batch
Phase Simulator in the FactoryTalk Batch Administrator Guide.
Important:
The FactoryTalk Batch Server cannot start if Security Authority
is enabled and there is a mismatch between the Security
Authority Identifiers (SAIs) in the area model and the FactoryTalk
Network Directory. For information on your recovery options,
see Troubleshooting in the FactoryTalk Batch Equipment Editor
User Guide.
To start the FactoryTalk Batch Server service:
1. Select the Start button, point to All Programs > Rockwell Software >
FactoryTalk Batch Suite > FactoryTalk Batch, and then select Batch
Service Manager. The Batch Service Manager opens.
2. Select Select Computer. The Select Computer dialog box opens.
Tip:
If running on Windows 7 or Windows Server 2008, run
the FactoryTalk Batch Service Manager as an
administrator.
3. In the Enter the object name to select area, enter the name of the
computer where the FactoryTalk Batch Server is installed (or select
the Advanced button to search for a computer).
4. Select OK to close the Select Computer dialog box.
5. From the Service list, select FactoryTalk Batch Server.
6. (optional) Select Allow Demo Mode if you want to run FactoryTalk Batch
in demo mode. If you run FactoryTalk Batch in the demo mode, be aware
that the Server stops after two hours of operation.
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
41
Chapter 5
The FactoryTalk Batch Service Manager
7. Select the method to use for restarting the server after a service halt.
•
Cold Boot: Restarts the server in a cold state. All journal data or recipe
content is erased upon startup. If Security Authority is enabled, SAIs in
a secured area model and any secured recipes must match the current
Network FactoryTalk Directory SAI.
•
Warm Boot: Restarts the server, restoring the set of batches that were
on the batch list when the server previously terminated. No validation
for Security Authority is performed.
•
Warm All Boot: Restarts the server only if it is able to restore all of the
batches to the batch list. No validation for Security Authority is
performed.
8. Select the Start/Continue button to start the service. Wait for the status to
change to RUNNING and the light is green.
9. Select the Server Statistics button. The Batch Server Statistics dialog box
opens.
10. Select the PCD Communications tab. The Data Server Status box
displays the status of the conversation. Make sure that conversation is
GOOD.
11. Select Start. The tag verification process begins. When tag verification is
COMPLETED, select OK, or select Stop to end the verification process
and then select OK.
Tip:
If the number of COM servers exceeds the viewable area
within the Data Server Status box, a scroll bar displays,
enabling you to scroll through the list.
12. Select Close. The Batch Service Manager dialog box closes.
Tip:
If software component conversation
becomes LOST while running in Demo mode, make sure
that the simulator is running and try starting the server(s)
again. For more information, see Start the FactoryTalk
Batch phase simulator.
See also
Batch Service Manager dialog box - Server options on page 44
Looking at the FactoryTalk Batch server on page 43
42
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
The FactoryTalk Batch Service Manager
FactoryTalk Batch
Server overview
Chapter 5
The FactoryTalk Batch Server is the engine that runs FactoryTalk Batch. It is this
component that allows integration with the process-connected devices (PCDs)
and third-party software packages.
The FactoryTalk Batch Server operates as a Windows Service, which means you
can configure the Server to start automatically and give control of the Server
service to the Windows Service Manager. Because the FactoryTalk Batch Server
runs as a service, logging on or off Windows during operation does not disrupt the
operation of the Server.
Using the FactoryTalk Batch Service Manager, you can control the FactoryTalk
Batch Server manually, select the boot method for the Server, and configure the
Server to run in Demo mode. Use the FactoryTalk Batch Equipment Editor to
configure the FactoryTalk Batch Server.
The FactoryTalk Batch Server coordinates the following functions:
•
Creating a Batch: Transforms the configured recipe into an executable
working recipe.
•
Executing a Recipe: Communicates with the process-connected devices to
execute phases.
•
Arbitrating Equipment: Allocates resources based on recipe and operator
requirements.
•
Collecting Data: Gathers and stores production information for reporting
and archiving.
•
Performing Client Communications: Transfers data between the processconnected devices (PCDs), operator displays, Human Machine Interfaces
(HMIs), databases, and various other software packages.
See the FactoryTalk Batch Equipment Editor User Guide and the FactoryTalk
Batch Administrator Guide for more detailed information about the FactoryTalk
Batch Server.
See also
Sample demonstration setup on page 43
Sample demonstration
setup
The installation process placed the SampleDemo1 and SampleDemo2 folders in
the BATCHCTL share on your hard drive. Within each of these SampleDemo
folders are four subfolders that contain the files for the area model. To run the
sample demonstrations, add a FactoryTalk Security user, configure the
FactoryTalk Batch Server to locate the area model, and then verify the recipes in
the area model.
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
43
Chapter 5
The FactoryTalk Batch Service Manager
Batch Service Manager
dialog box - Server
options
The following methods are available for restarting the FactoryTalk Batch Server
after a service halt:
Cold Boot
Restarts the FactoryTalk Batch Server in a cold state. All
journal data or recipe content is erased upon startup. If
Security Authority is enabled, SAIs in a secured area model
and any secured recipes must match the current Network
FactoryTalk Directory SAI.
Warm Boot
Restarts the FactoryTalk Batch Server, restoring the set of
batches that were on the batch list when the FactoryTalk
Batch Server previously terminated. No validation for
Security Authority is performed.
Warm All Boot
Restarts the FactoryTalk Batch Server only if it is able to
restore all of the batches to the batch list. No validation for
Security Authority is performed.
See also
Start the Batch Server service on page 40
Enable a grace period
Use the Allow Grace Period option on the Batch Service Manager dialog box to
start the FactoryTalk Batch Server in the event that it cannot find a valid
activation license. The grace period is seven days.
To enable a grace period:
1. Select Start > All Programs > Rockwell Software > FactoryTalk Batch
Suite > FactoryTalk Batch, and then select Batch Service Manager.
The Batch Service Manager opens.
2. Select Select Computer. The Select Computer dialog box opens.
3. In the Enter the object name to select area, enter the computer name
where the batch server is installed (or click the Advanced button to search
for a computer).
4. Click OK to close the Select Computer dialog box.
5. From the Service list, select FactoryTalk Batch Server.
6. Select Allow Grace Period enable grace period activation.
7. Click the Start/Continue button to start the service. Wait for the status to
change to RUNNING.
The FactoryTalk Batch Server searches for valid activations first. If the
appropriate activation is not found, the server will start under a grace period
activation. The FactoryTalk Batch Server checks for valid activation licenses
every four hours until it either finds one or the grace period expires.
44
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
The FactoryTalk Batch Service Manager
Chapter 5
8. Click Close. The Batch Service Manager dialog box closes.
See also
Grace periods in FactoryTalk Batch Server on page 45
Start the batch server service on page 40
Grace periods in
FactoryTalk Batch
Server
When the FactoryTalk Batch Server starts, it performs a license check. If a valid
activation is found, a successful license check is returned to the server. As a result
of the license check, the server determines which applications have a license.
If its normal license check process fails, the server requests grace period activation
from FactoryTalk Activation. The manner in which the grace period activation is
requested depends on the area model and why the license check process failed. The
server will log the request for, and receipt of, the grace period license.
When grace period activation is requested for multiple activations by one process,
the grace period is ended and the timer reset when any of the multiple activations
can be successfully obtained.
Every four hours the FactoryTalk Activation software attempts to check out each
activation requested as a grace period activation by the FactoryTalk Batch Server.
If any one of these activations is successfully checked out, the grace period for the
server ends.
Tip:
If the FactoryTalk Batch Server is started in the Demo
mode, an exception is made to the license and unit
checks. Even if no licenses are found, the server will run
for two hours and then shut down.
See also
Enable a grace period on page 44
Add a custom service
Define a custom service to command the FactoryTalk Batch Server and
FactoryTalk Event Archiver services using the FactoryTalk Batch Service
Manager. To make a service available to the Service Manager, you must enter the
file name of the executable for the service in a service registry key. This key is
located at:
HKEY_LOCAL_MACHINE\SOFTWARE\BATCHCTL\Services
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
45
Chapter 5
The FactoryTalk Batch Service Manager
To add a custom service:
1. In the Registry Editor, select
the HKEY_LOCAL_MACHINE\SOFTWARE\BATCHCTL\Service
s subkey.
2. From the Edit menu, select New > Key. A new key folder is added.
3. Enter the Key Name without the file extension.
See also
The FactoryTalk Batch Service Manager on page 33
46
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
Chapter 6
The FactoryTalk Batch Server
The FactoryTalk Batch Server is the FactoryTalk Batch component that controls
and coordinates system information, phases, and recipes. The FactoryTalk Batch
Server allows integration with process-connected devices and third-party software
packages. The FactoryTalk Batch Server must be started and remain active during
all batch functions.
See also
FactoryTalk Batch Server service configuration on page 47
FactoryTalk Batch Server option configuration on page 48
Modify the .NET registry key on page 64
FactoryTalk Batch
Server service
configuration
FactoryTalk Batch Server configuration can be verified and customized as needed.
Configuration includes specifying the startup method (Automatic or Manual),
specifying the restart type (Warm, Warm All, or Cold), and setting the server
options.
Tip:
The FactoryTalk Batch Server service is configured to run as a
Windows Server 2008 user. Changing the user account in
which the server runs is done through Services.
See also
The FactoryTalk Batch Server on page 47
Specify the startup type on page 47
Specify the startup
type
Verify the FactoryTalk Batch Server startup and account types using the Services
Administrative Tool. You must be logged on with local administrative privileges
to configure the server.
To specify the startup type:
1. Select Administrative Tools > Services.
2. From the list of services, double-click Batch Server.
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
47
Chapter 6
The FactoryTalk Batch Server
3. In the Startup type area, select Automatic to allow the batch server to start
automatically upon system startup.
4. Select the Log On tab.
5. From the Log On As area, select This account.
6. Select Browse. The Select Users dialog box opens.
7. Select the User to be used for the batch server, and then select OK.
8. In the Password box, enter the password for the batch server account.
9. In the Confirm password box, enter the password.
10. Select OK to close the Batch Server Properties dialog box.
11. Close the Services dialog box.
See also
FactoryTalk Batch Server service configuration on page 47
FactoryTalk Batch
Server option
configuration
Configure the FactoryTalk Batch Server and FactoryTalk Event Archiver using
the Server Options dialog box in FactoryTalk Batch Equipment Editor. The
configuration information for the server indicates how it communicates with
FactoryTalk Batch View and the data server(s). Configure FactoryTalk Event
Archiver to specify if and how electronic batch record files (.evt) are inserted into
the ODBC-compliant database.
Changing items such as FactoryTalk Batch Server information, area model, and
the error logging directory take effect when the server is restarted. Changing items
such as the recipe directory and batch journal directory take effect the next time
the server accesses these items. None of the items in FactoryTalk Event Archiver
configuration require the server to be restarted. These changes take effect the next
time the server needs that configuration item.
Important:
FactoryTalk Batch does not support the use of mapped drives. Do
not use mapped drives for project directories.
See also
Server Options dialog box - Project Settings tab on page 49
Server Options dialog box - Restart Control tab on page 51
Server Options dialog box - Batch Reporting tab on page 54
48
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
The FactoryTalk Batch Server
Server Options dialog
box - Project Settings
tab
Chapter 6
The default project settings for a computer on which the FactoryTalk Batch
Server is installed are universal naming convention (UNC) names for all except
the Initialization File Name. If the server is installed on another computer, then
the Initialization File Name would use UNC names.
See also
Set project directories on page 50
Recipe storage on page 50
Recipe versioning on page 51
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
49
Chapter 6
The FactoryTalk Batch Server
Set project directories
Set directories for the following: Primary Journal, Secondary Journal, Error
Logging, Instructions (if you are using FactoryTalk eProcedure), and Equipment
Database.
Important:
The Primary Journal path must be defined or the FactoryTalk
Batch Server will not start. The Primary Journal path must be
on the server computer in the BATCHCTL share. In addition, if
the Primary Journal or Secondary Journal path is invalid, the
server will not start. If an invalid path is used, an error message
indicating the invalid path is written to the batchsvr.log file.
To set project directories:
1. In FactoryTalk Batch Equipment Editor, select Options > Server Options.
2. Select the Project Settings tab.
3. Select Browse to open the Select Directory dialog box.
4. Select the appropriate directory, and then select OK to return to the Server
Options dialog box. The selected UNC directory path name is inserted into
the appropriate box.
See also
Server Options dialog box - Project Settings tab on page 49
FactoryTalk Batch Server option configuration on page 48
Recipe storage
In the FactoryTalk Batch Equipment Editor, Server Options dialog box,
the Store Recipes Using section is used to specify the format for storing recipes:
•
Binary Files
•
Microsoft SQL Server Database
•
XML Files
The default format is Binary Files. When the Binary Files option is selected,
recipes are stored in separate files according to recipe level. Procedures are stored as
.bpc files, Unit Procedures are stored as .upc files, and Operations are stored as
.uop files. Specify the appropriate directory.
When the Microsoft SQL Server Database option is selected, recipes are stored
in a SQL server database.
50
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
The FactoryTalk Batch Server
Chapter 6
When the XML Files option is selected, recipes are stored in separate .xml files.
Procedures are stored as .pxml files, Unit procedures as .uxml files and Operations
as .oxml files.
Tip:
If using SQL Server for recipe storage: If SQL Server is not
installed on the same computer as the Batch Client, to see a list of
available SQL Server databases in the Server Options dialog box,
install SQL Server’s Client Tools Connectivity option. Do a custom
install of SQL Server to install the Client Tools Connectivity option.
See also
Server Options dialog box - Project Settings tab on page 49
FactoryTalk Batch Server option configuration on page 48
Recipe versioning
Below the Store Recipes Using area is the Enable Recipe Versioning check box.
Check this box to enable Recipe Versioning, a system-enforced naming
convention that stores and protects recipe revisions. By default the box is
unchecked and recipe versioning is disabled.
Important:
FactoryTalk Full Edit access to FactoryTalk Batch Equipment
Editor is required to enable and disable recipe versioning.
See also
Recipe storage on page 50
Set project directories on page 50
Server Options dialog
box - Restart Control
tab
The Restart Control tab allows you to specify a restart method to initiate in the
event of a server computer failure. Selecting Cold Restart will restart the
FactoryTalk Batch Server in an uninitialized state and all recipe content is erased.
Selecting Warm Restart (the default) forces the server (or backup server) to
restart in the same state it was in prior to the failure, without any loss of journal
data or recipe content. Selecting Warm All Restart allows the server to restart
only if it is able to restore all of the batches to the batch list. Warm All Restart is
the default setting used by the automatic restart function.
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
51
Chapter 6
The FactoryTalk Batch Server
The Restart Control tab also allows you to specify primary and secondary path
names for the storage of files containing restart information. (See Specify the
startup type for more information.)
Important:
You must define a valid Primary Restart path or the FactoryTalk
Batch Server will not start, and the following error message is
logged in the Windows Server event log file: Unable to start
because RestartDirectoryPath key not specified in Batchsvr.ini.
In addition, if the Primary Restart or Secondary Restart path is
invalid, the server will not start.
See also
Redundant servers on page 52
Define redundant servers on page 52
Redundant servers
FactoryTalk Batch can be configured to store batch journals and batch restart
information in two separate locations. If there is a hardware failure on the primary
FactoryTalk Batch Server computer, secondary server performs a manual failover.
The second computer must be capable of running the server. Define redundant
servers by specifying the primary and secondary restart path names. These path
names indicate where system files are written to should the system experience a
failure. If the secondary path name is not specified, FactoryTalk Batch does not
create secondary files.
Tip:
Archiver recovery — The eventdir.txt and the archque.txt are not
updated as secondary files. As part of the manual failover procedure,
manually copy the files from the primary directory to the secondary
directory.
Install the area model file and all recipe files and, if using eProcedure, all
instruction files on both the primary server and the secondary server.
See also
Perform a manual failover on page 66
Define redundant servers
FactoryTalk Batch can be configured to store batch journals and batch restart
information in two separate locations.
To define redundant servers:
1. From the FactoryTalk Batch Equipment Editor Options menu, click
Server Options.
52
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
The FactoryTalk Batch Server
Chapter 6
2. Select the Restart Control tab.
3. In the Restart Type area, click on a selection, or accept the default, Warm
Restart.
4. Click the Primary Path browse button. The Select Directory dialog box
opens.
5. Select the MyProject\restart folder located in the BATCHCTL share on
the primary server’s hard drive (the default is c:\Program Files
(x86)\Rockwell Software\Batch\MyProject\restart), and then click OK.
6. Click the Secondary Path browse button. The Select Directory dialog box
opens.
7. Locate and select the MyProject\restart folder located in the
BATCHCTL share on the secondary server’s hard drive, and then click
OK.
8. Repeat steps 1 through 7 on the redundant server computer, selecting the
Batch\MyProject\restart folder on the redundant server as the Primary
Path. The Secondary Path can remain blank or point to another redundant
server. Additionally, you must configure a data server to communicate with
the process controller on the redundant server computer. The redundant
server computer needs to communicate with the process controller that is
running the phase logic.
Tip:
You must also verify that the primary and secondary journal project
directories are defined.
See also
Redundant servers on page 52
Server Options dialog box - Restart Control tab on page 51
Set project directories on page 50
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
53
Chapter 6
The FactoryTalk Batch Server
Server Options dialog
box - Batch Reporting
tab
Use the Batch Reporting tab to select the reporting application for generating
batch reports and archiving Batch data. Never is the default reporting application.
To use the Server Options dialog box - Batch Reporting tab:
1. Select the Batch Reporting tab.
2. Select the appropriate option from the Reporting Application area. The
following sections define the available reporting application options.
See also
Report Editor on page 54
Report Editor
As of version 10.00, the Report Editor functionality is no longer supported or
available. If you are currently using the Report Editor functionality, it is
recommended that you transition to the standard reporting that is available using
the Rockwell Automation Knowledgebase - Answer ID 62366.
See also
Server Options dialog box - Batch Reporting tab on page 54
Perform end of batch
archiving
Selecting Archiver (End of Batch) defers control of batch reporting to
FactoryTalk Event Archiver and only performs batch reporting upon removal of
the batch from the Batch List. The End of Batch runs in the security context of
the FactoryTalk Batch Server. When using End of Batch archiving, FactoryTalk
Event Archiver must be disabled as a Windows service and cannot be controlled
using the FactoryTalk Batch Service Manager. (See the FactoryTalk Event Archiver
User Guide for information on disabling FactoryTalk Event Archiver as a service.)
Tip:
54
If Event Journal Signatures are enabled, specify Archiver (End-ofBatch) archiving to ensure that all event journal records are properly
archived.
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
The FactoryTalk Batch Server
Chapter 6
To perform end of batch archiving:
1. Select Archiver (End of Batch).
2. In the Archiver area, select Delete files after archive to allow for the
deletion of the .evt files after FactoryTalk Event Archiver has stored the
data in the ODBC database.
Important:
Deleting files after archiving is not a reversible action and is
not recommended.
3. In Table Name, type the name of the table that contains the Batch data.
The default is BATCHHIS.
The Database Connect String box should contain, at a
minimum, ODBC;. It updates automatically when the data source is
selected the first time FactoryTalk Event Archiver is started after
installation. However, if you know the name of the data source,
enter ODBC;DSN=DataSourceName; and skip the FactoryTalk Event
Archiver setup function.
To change the default Table Name from BATCHHIS:
a.
Create a new table.
b. Update the stored procedure named BHInsert to use the new table
name. (See the FactoryTalk Event Archiver User Guide for instructions
on creating a new table.)
See also
Server Options dialog box - Batch Reporting tab on page 54
Perform incremental
archiving
Use Archiver (Incremental) to defer control of batch archiving to FactoryTalk
Event Archiver and to perform batch reporting at user-defined intervals during
batch execution. Specify the Incremental period between active archiving
in Minutes or Seconds. The minimum setting is 5 seconds. The maximum is
9999 minutes. Setting the value outside of this range causes FactoryTalk Event
Archiver to run in 5 minute incremental periods.
To update the incremental period after making changes, stop and restart the
Incremental Archiver.
Configure the Incremental Archiver with a Windows user account that has
administrative privileges to log on to the system. When using incremental
archiving, configure FactoryTalk Event Archiver to run as a Windows service with
an automatic startup type. Use the FactoryTalk Batch Service Manager to monitor
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
55
Chapter 6
The FactoryTalk Batch Server
and control FactoryTalk Event Archiver service. (See the FactoryTalk Event
Archiver User Guide for information on enabling FactoryTalk Event Archiver as a
service.)
To perform incremental archiving:
1. Select Archiver (Incremental).
2. In the Archiver area, select Delete files after archive to enable the deletion
of the .evt files after FactoryTalk Event Archiver has stored the data in the
ODBC database.
Important:
Deleting files after archiving is not a reversible action and is not
recommended.
3. In Table Name, type the name of the table that contains the batch data.
(The default is BATCHHIS.)
4. In Incremental Period, type a value and select Minutes or Seconds.
See also
Server Options dialog box - Batch Reporting tab on page 54
Perform user-defined end
of batch
Select User-Defined (End of Batch) to define a batch reporting application that
is not listed in the Reporting Application area. Specify paths and names of the
application’s .ini and .exe files.
To perform user-defined end of batch:
1. Select User-Defined (End of Batch).
2. Select the Executable File browse button to locate the application’s
executable file. The dialog box opens.
3. In the Select Archiver Executable File dialog box, select the appropriate
.exe file, and then select Open.
4. Select the Initialization File browse button to locate the application’s
initialization file.
5. In the Select Archiver Initialization File dialog box, select the appropriate
.ini file, and then select Open.
See also
Server Options dialog box - Batch Reporting tab on page 54
56
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
The FactoryTalk Batch Server
Chapter 6
Select this option if no batch reporting or archiving application is to be used.
None
See also
Server Options dialog box - Batch Reporting tab on page 54
Does not maintain a queue. This is the default selection.
Never
Important:
The Never setting causes the archiver queue file to not get written
to. For a custom archiver and when writing to this queue file, use a
setting other than Never and manually maintain the size of the
archive queue file.
See also
Server Options dialog box - Batch Reporting tab on page 54
Archiver Event Filters
tab
The options listed under the Archiver Event Filters tab determine what
electronic batch record data FactoryTalk Event Archiver inserts into
the BATCHHIS table. To enable an event filter, select the appropriate check box.
To disable an event filter, clear the appropriate check box.
To enable or disable an event filter:
1. Select the Archiver Event Filters tab.
2. Select the appropriate check boxes to indicate the event type data for the
FactoryTalk Event Archiver collection. Clear the check boxes for the data
that is not to be collected.
See also
FactoryTalk Batch Server option configuration on page 48
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
57
Chapter 6
The FactoryTalk Batch Server
Batch Server tab
The Batch Server tab allows you to select and/or configure FactoryTalk Batch
Server options (including the hold propagation type), watchdog communications
timeout settings, FactoryTalk Event Archiver log file size, minimum disk space
required to add a batch, default batch ID, and whether to enable/disable event
journal signatures.
See also
Hold propagation on page 58
Communications timeout on page 59
Miscellaneous on page 60
The Hold Propagation area allows you to indicate the hold propagation type to
use when the FactoryTalk Batch Server detects a failure caused by a watchdog
timeout, a handshake timeout, or a phase failure (PHASE_F > 0). A Hold
command associated with a failure propagates up through the recipe hierarchy as
high as the mode and selected option allows.
Hold propagation
58
Hold Propagation Type
Description
Phase
Only the affected phase is held, allowing the balance of the
phase’s unit and all other units to continue running.
Operation
Only the affected phase and the related operation are held,
allowing the balance of the operation’s unit and all other units to
continue running.
Unit
The phase and the related unit are held and all other units continue
running.
Batch
(Default) Holds the entire batch when a failure is detected by the
FactoryTalk Batch Server.
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
The FactoryTalk Batch Server
Chapter 6
The following diagram shows how a step’s mode can affect the hold propagation.
Depending on the step’s mode, the batch may be held at a lower level than the
selected hold propagation option.
See also
Batch Server tab on page 58
Communications timeout
The Communications Timeout area allows you to configure the FactoryTalk
Batch Server’s watchdog timer.
The Period (msec) box allows you to set the watchdog timer setpoint in
milliseconds. When the timer expires, the FactoryTalk Batch Server checks
communication with the process-connected device’s data server and performs the
set/reset test on the data server watchdog timer. In the event of a failed
conversation, the server attempts to reconnect. The default is 10000.
The Allowable Failures box allows you to indicate how many Set/Reset retries
the FactoryTalk Batch Server should perform before it declares that conversation
with the server is BAD and issues a HOLD command. The default is 5.
Tip:
The recommended configuration for Batch watchdog and PCD
watchdog is that the PLC watchdog timer setpoint must be configured to
have a value that is 5 % or less of the total value of the FactoryTalk
Batch Server watchdog timer’s period value and allowable failures value.
Example: If the server’s watchdog timeout period is set to 10000
milliseconds (10 seconds), and the allowable failures is set to 5, then set
the PLC watchdog timer setpoint to 47500 milliseconds (47.5 seconds):
.95 (5 x 10000) = 47500
Important:
When the watchdog times out in the PCD, the PLI should be
designed to set the Phase Failure Tag to a nonzero value that
represents an understandable message in the Phase Failure
Enumeration Set such as PCD1 Batch Watchdog Timed Out.
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
59
Chapter 6
The FactoryTalk Batch Server
(See the FactoryTalk Batch Equipment Editor User Guide for details on editing
enumerations and enumeration sets.)
See also
Batch Server tab on page 58
Miscellaneous
The Miscellaneous area allows you to define options relating to the batchsvr.log
and the batchSvr.ini file.
The Maximum Log File Size box allows you to input the maximum size (in bytes)
for the log file. When the log file reaches the maximum specified size, all new data
is appended to the top of the log and old information is overwritten.
The Minimum Disk Space box allows you to input the minimum disk space (in
bytes) that must be available before a batch can be added to batch list. This helps
to avoid data loss due to inadequate disk space.
The Default Batch ID box allows you to specify a default batch ID; this batch ID
automatically populates the Batch ID box when each batch is created.
Enable Event Journals Signatures turns event journal signatures on or off. The
Event Journal Signature function is a tool for detecting any unauthorized changes
to electronic batch records (.evt files). (See the FactoryTalk Batch System Files
Reference Guide for more information about Event Journal Signatures.)
Tip:
Do not edit the batchsvr.log or batchsvr.ini files directly unless you are
specifically instructed to do so by Rockwell Automation Technical Support.
The batchsvr.ini file contains data items that determine the configuration
of the FactoryTalk Batch Server and how the server operates in relation to
the other FactoryTalk Batch components.
See also
Batch Server tab on page 58
Batch identification on page 60
Batch identification
60
For purposes of batch identification, you can create custom default batch IDs, and
allow or prevent editing of batch IDs. You can also automatically generate custom
batch IDs. In order to implement this option, you must perform steps in
FactoryTalk Batch View and FactoryTalk Batch Equipment Editor, edit some
Visual Basic code and compile it into a new DLL. If you are using the FactoryTalk
Batch ActiveX controls, you can use the BatchID editable property to enable or
disable editing of batch IDs. For more information, see the FactoryTalk Batch
ActiveX Controls Library Reference.
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
The FactoryTalk Batch Server
Cross Invocation
Descriptors and
Defaults tab
Chapter 6
The Cross Invocation Descriptors and Defaults tab allows you to specify cross
invocation labels and set default cross invocation strings for different resource
types. Use FactoryTalk Batch Equipment Editor to define up to five cross
invocation strings for each resource within the area model. Each time a selection
changes in FactoryTalk Batch View and ActiveX Controls, the cross invocation
strings associated with the equipment resource are retrieved from the FactoryTalk
Batch Server and evaluated. The contents of these strings can indicate a shortcut
menu item and subitems, the caption(s) for the shortcut menu item(s), and the
data that is passed to the automation server.
See also
Resource types on page 61
Cross invocation on page 77
Resource types
Use the Resource Types list to select a resource type for cross invocation labels
and strings. Select one of the following from the list: Equipment
Modules, Process Cells, Resources, or Units.
See also
Cross Invocation Descriptors and Defaults tab on page 61
Descriptors
The Descriptors area allows you to enter up to five cross invocation labels for
each resource type. These labels are used within the resource’s Edit dialog box.
See also
Cross Invocation Descriptors and Defaults tab on page 61
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
61
Chapter 6
The FactoryTalk Batch Server
Default values
The Default Values area allows you to assign default cross invocation strings to
each of the cross invocation labels defined above for the selected resource type.
Any default cross invocation string can be overwritten when a specific resource
type instance is edited.
Tip:
Hyperlink Descriptors
and Defaults tab
Changes to the default value are not applied to the currently
configured equipment in your area model. However, any new
equipment you add to your area model uses the new default
value settings.
This feature is used in conjunction with FactoryTalk eProcedure only.
The Hyperlink Descriptors and Defaults tab specifies the hyperlink labels and
default values used with different resource types. The labels and default values are
used in the resource’s Edit dialog box. You can define up to five hyperlink labels
and default values for each resource within the area model. (Refer to the
FactoryTalk eProcedure Administrator Guide for additional hyperlink
information.)
The Resource Types list allows you to select a resource type for the hyperlink
labels and URLs you define. Select one of the following from the
list: Phases, Process Cells, Resources, or Units.
The Descriptors area allows you to enter up to five hyperlink labels for each
resource type. These labels are used within the resource’s Edit dialog box.
The Default Values area allows you to assign default URLs to each hyperlink label
defined for the selected resource type. Enter the URL address for the hyperlink in
the box that corresponds to the correct hyperlink label. The label in box 1 of
the Descriptors area corresponds to the URL address in box 1 of the Default
Values area. Default URLs can be overwritten when a specific resource type
instance is edited.
Tip:
If a hyperlink value is not defined, either as a default or when the specific
resource type instance is created, the hyperlink label is not visible
in eProcedure.
See also
FactoryTalk Batch Server option configuration on page 48
Resource types
Use the Resource Types list to select a resource type for hyperlink labels and
URLs. Select one of the following from the list: Phases, Process
Cells, Resources, or Units.
See also
Hyperlink Descriptors and Defaults tab on page 62
62
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
The FactoryTalk Batch Server
Descriptors
Chapter 6
In the Descriptors area, enter up to five cross invocation labels for each resource
type. These labels are used within the resource’s Edit dialog box.
See also
Hyperlink Descriptors and Defaults tab on page 62
Default values
Use the Default Values area to assign default URLs to each hyperlink label
defined for the selected resource type. Enter the URL address for the hyperlink in
the box that corresponds to the correct hyperlink label. The label in box 1 of
the Descriptors area corresponds to the URL address in box 1 of the Default
Values area. Default URLs can be overwritten when a specific resource type
instance is edited.
Tip:
If a hyperlink value is not defined, either as a default or when the specific
resource type instance is created, the hyperlink label is not visible
in eProcedure.
See also
Hyperlink Descriptors and Defaults tab on page 62
Material Policies tab
These features are used in conjunction with FactoryTalk Batch Material Manager
only.
•
Option When Material Server Communication is lost
•
Hold on Split Feed
Option when Material Server Communication is lost
When communication with the Material server is lost, these two options are
available: Failure and Hold or Switch to Manual.
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
63
Chapter 6
The FactoryTalk Batch Server
By default, the FactoryTalk Batch Server is configured to Failure and Hold. In
this case, batches are placed in the HELD state when communication with the
Material server is lost. The FactoryTalk Batch Server automatically resumes
communication with the Material server when it becomes available.
To run batches even when communication is lost, configure the FactoryTalk
Batch Server to Switch to Manual. In Manual mode, the server prompts the
operator for information normally supplied by the Material Server. Restore the
communication manually when the Material server becomes available. (For more
information on restoring communication manually, see the FactoryTalk Batch
Material Manager Administrator Guide.)
Hold on split feed
Choose the Yes option to hold batches or the No option to continue to run
batches in the event of a split feed.
The Yes option is the default option and the batch is HELD when a split feed
occurs.
For the No option, create a loop in the recipe so that the binding process can select
another container for material additions when a split feed occurs. Add a material
loop to the recipe with the Create Material Loop button in FactoryTalk Batch
Recipe Editor. (For information regarding material loops, see the FactoryTalk
Batch Recipe Editor User Guide.)
See also
FactoryTalk Batch Server option configuration on page 48
Modify the .NET
registry key
The .NET registry key contains the FactoryTalk Batch Server computer name and
is used by remote clients to locate the server computer. During a FactoryTalk
Batch Client computer installation, the setup program prompts you for the server
computer name and then places the name into the .NET key. In the event that
you change the server computer name, or if you are switching control to another
FactoryTalk Batch Server computer, you need to manually modify the .NET
registry key on all remote client computers to point to the server computer.
To modify the .NET registry key:
1. Open the Registry Editor.
2. Select the HKEY_LOCAL_MACHINE on Local Machine window.
Navigate to the SOFTWARE\BATCHCTL\Net subkey.
3. Double-click the Server registry value.
64
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
The FactoryTalk Batch Server
Chapter 6
4. Modify the value data: Server = <MachineName>, where <MachineName>
is the computer name on which the FactoryTalk Batch Server is installed.
See also
The FactoryTalk Batch Server on page 47
Use automatic
restart control to
restart the
FactoryTalk Batch
Server
The FactoryTalk Batch Server maintains a detailed record of every recipe’s state as
the recipe is running. If the server computer were to lose power or otherwise fail,
use the automatic restart control feature to restart the server. Upon restarting the
server on a failed server node, the following functions are placed into the state that
existed prior to termination of the server:
•
Control Recipes
•
Semi-Auto Phase Control
•
Arbitration
See also
Restart the FactoryTalk Batch Server on page 65
Restart the FactoryTalk
Batch Server
If the FactoryTalk Batch Server computer experiences a system failure, then
restarting the computer starts the server. However, if the FactoryTalk Batch
Server service fails, then you need to restart the service using the FactoryTalk
Batch Service Manager.
To restart the FactoryTalk Batch Server:
1. Open the FactoryTalk Batch View. Batches on the batch list prior to the
failure are still on the batch list. All batches that had phases in an active state
now have transitions in the HELD state, and are in MANUAL mode with a
failure.
2. Select the batch, and then click the Auto button to place a batch in
AUTOMATIC mode.
3. Click the Clear All Failures button to clear the failures.
4. Select the batch, and then click the Restart Batch button. The previously
active phases return to a RUNNING state and the batch completes.
See also
Use automatic restart control to restart the FactoryTalk Batch Server
on page 65
The FactoryTalk Batch Service Manager on page 33
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
65
Chapter 6
The FactoryTalk Batch Server
Perform a manual
failover
FactoryTalk Batch can be configured to store batch journals and batch restart
information in two separate locations. The use of a secondary server allows you to
perform a manual failover if there is a hardware failure on the primary
FactoryTalk Batch Server. The second computer must be capable of running the
server.
You must install your area model file and all recipe files (and all instruction files if
using eProcedure) on both the primary server and the secondary server.
Tip:
Archiver recovery - As part of the manual failover procedure you must
manually copy the eventdir.txt and the archque.txt from the primary
directory to the secondary directory.
See also
The FactoryTalk Batch Server on page 47
Define redundant servers on page 52
Configure the
FactoryTalk Batch
Server for manual
failover
When the FactoryTalk Batch Server fails, complete the following steps.
Tip:
If you are using FactoryTalk Batch Material Manager,
refer to the procedure for material-enabled configuration.
To configure the FactoryTalk Batch Server for manual failover:
1. Start the process-connected device communication software on the
secondary server. The secondary server computer needs to communicate
with the process controller that is running the phase logic.
2. Ensure that the secondary server’s project directories are assigned to local
directories in the Server Options dialog box located in FactoryTalk Batch
Equipment Editor.
3. Use the FactoryTalk Batch Service Manager to start the FactoryTalk Batch
Server on the secondary server computer, select Warm or Warm All as the
startup type. The secondary server allows the batches to be restarted based
upon information written by the primary server.
4. (optional) If you are also using eProcedure, use the FactoryTalk Batch
Service Manager to start the eProcedure Server on the secondary server
computer.
5. For each computer running FactoryTalk Batch View, enter the secondary
server’s computer name as the NET registry key value.
66
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
The FactoryTalk Batch Server
Chapter 6
6. Stop and restart each FactoryTalk Batch View instance and any other
software that communicates directly with the FactoryTalk Batch Server.
This causes the instance to connect with the secondary server.
Tip:
The existing batches are placed in the MANUAL mode with transitions in
the HELD state. Place the batches in AUTOMATIC mode, clear the
failures, and then restart the batch.
See also
Perform a manual failover on page 66
Modify the .NET registry key on page 64
Configure the material-enabled Batch server for manual failover on page 67
Configure the materialenabled FactoryTalk
Batch Server for
manual failover
Upon failure of the primary FactoryTalk Batch Server computer, if this is a
FactoryTalk Batch Material Manager system, complete the following steps:
To configure the material-enabled FactoryTalk Batch Server for manual
failover:
1. On the Material server computer, start the Network Editor.
2. Select the network model for the primary FactoryTalk Batch Server.
3. Right-click BATCHSERVER in the tree and select Remove Server.
4. From the File menu, click Synchronize.
5. Select the network model for the Material server.
6. Right-click any <Undefined> FactoryTalk Batch Server in the tree, and
then click Add Server.
7. Type a name in the Alias box.
8. Click the Computer Name box, and then select the computer to be used as
the secondary server.
9. From the File menu, click Synchronize.
10. Start the process-connected device communication software on the
secondary server. The secondary server computer needs to communicate
with the process controller running the phase logic.
11. Ensure that the project directories for the secondary server are assigned to
local directories. Use the Server Options dialog box in FactoryTalk Batch
Equipment Editor.
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
67
Chapter 6
The FactoryTalk Batch Server
12. Use the FactoryTalk Batch Service Manager to start the FactoryTalk Batch
Server software on the secondary server computer, select Warm or Warm
All as the startup type. The secondary server allows the batches to be
restarted based upon information written by the primary server.
13. If you are also using eProcedure, use the FactoryTalk Batch Service Manager
to start the eProcedure Server on the secondary server computer.
14. For each computer running the FactoryTalk Batch View, enter the
computer name of the secondary server as the NET registry key value.
15. Stop and restart each FactoryTalk Batch View instance and any other
software that communicates directly with the FactoryTalk Batch Server.
This causes the FactoryTalk Batch View instance to connect with the
secondary server.
Tip:
The existing batches are placed in the MANUAL mode with transitions in
the HELD state. Place the batches in AUTOMATIC mode, clear the
failures, and then restart the batch.
See also
Modify the .NET registry key on page 64
Command
handshake timeout
The FactoryTalk Batch Server uses a command handshake protocol ensuring that
commands issued to phases are handled in a serial manner and are not lost or
overwritten. The protocol has a configurable timeout period. When a command
handshake timeout condition occurs, an error is generated in the phase object that
represents the phase, and the batch is placed on HOLD based upon the configured
hold propagation settings. This allows the operator to disconnect the server from
the affected phase should the timeout period expire. Without this feature, the
server must be shut down and restarted if the phase stops responding.
When a command handshake timeout period occurs, the step representing the
troubled phase in the SFC display turns red and a failure is generated for the
phase. The message PHASE NOT RESPONDING is shown on the status bar
when the step is selected. It is also displayed in the Phase List Display area of the
Phase Control window when the phase is selected.
A System Message event type is logged into the electronic batch record. The
description includes the fact that a time-out occurred as well as the type and ID of
the command that timed out. In addition, the event is recorded in the FactoryTalk
Batch Server log file with a severity status of SEVERE and the description is the
type and ID of the timed-out command.
68
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
The FactoryTalk Batch Server
Chapter 6
If a communication error is detected while the command handshake is in process,
the command handshake timer is stopped. The timer is reset and restarted if
communication is successfully restored. If the command handshake completes
after the timeout period, then the commands that are pending the handshake
completion are processed. However, the error must be cleared before the batch can
be restarted.
In order to restart a batch, you must issue the CLEAR_FAILURES command. If
the command handshake completes successfully, the error is cleared and the batch
can be restarted. Otherwise, the error is not cleared and the batch is not restarted.
The operator should check the execution status of the process-connected device.
The Batchsvr.ini file contains an item used to configure the length of time, in
seconds, that the FactoryTalk Batch Server waits for a command handshake before
issuing a timeout. If the item is not included in the Batchsvr.ini file, it defaults
to 60. The valid range is 5 to 600.
[XMAN] CommandTimeOut=90
This value is read when the FactoryTalk Batch Server starts. If you change the
value, stop and restart the server.
See also
The FactoryTalk Batch Server on page 47
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
69
Chapter 7
Windows event log
The Windows Event Log service records application, system, and security
information. This information can be viewed using the Event Viewer.
Tip:
Supported Windows versions for FactoryTalk Batch are listed in
the FactoryTalk Batch Components Upgrade and Installation Guide.
See also
View event log entry properties on page 71
Modify event log settings on page 75
View event log entry
properties
From the Windows Event Viewer, you can double-click any log entry to display its
properties.
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
71
Chapter 7
Windows event log
There are 10 items for a Windows event log entry. Six of these are identical for all
FactoryTalk Batch Server events. These items, along with a description, are listed
below. The Category, Event ID, and Description are described in the table
following the list.
Item
Description
Date
Date that the event occurred.
Time
Time that the event occurred.
Type
Type of the event (i.e., Information, Error, etc.).
User
Configured domain user.
Computer
Computer on which the FactoryTalk Batch Server is running.
Source
BatchSvr
Category
Category of the event.
Event ID
ID of the event.
Description
Description of the event.
Data
File and line number within the FactoryTalk Batch Server
source code that generated the entry.
Category
Event Description
ID
Start
1000
Server demand started successfully in demo mode.
Start
1001
Server demand started successfully in production mode.
Start
1002
Server auto started successfully.
Start
1003
Server failed to auto start. See the Batchsvr.log file for more
information.
Start
1004
Server failed to demand start. See the Batchsvr.log file for more
information.
Important: Do not edit the Batchsvr.log files.The Batchsvr.log contains critical information
Technical Support needs to determine the cause of a FactoryTalk Batch Server failure.
Start
1005
Command line arguments are inconsistent.
Start
1006
Unexpected command line argument [Descriptive String].
Start
1007
Service handler not installed.
Start
1008
Not running as a service or StartServiceCtrlDispatcher failed.
Start
1009
Log directory does not exist. Validate ErrorLogDirectory key value
in Batchsvr.ini.
Important: Do not edit the Batchsvr.ini file unless specifically instructed by Technical Support.
72
Start
1010
Unable to start due to access permissions on log directory specified
by ErrorLogDirectory key value in Batchsvr.ini.
Start
1011
Batchsvr.log file could not be created/opened. Validate pathname
in Batchsvr.ini.
Start
1012
Unable to start. Log file (Batchsvr.log or Verify.log) does not have
write access permission.
Start
1013
Unable to start. Unable to access log file (Batchsvr.log
or Verify.log).
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
Windows event log
Chapter 7
Category
Event Description
ID
Start
1014
Unable to start. Verify.log file does not have write access
permission.
Start
1015
Unable to start due to missing Batchsvr.ini file.
Start
1016
Unable to start due to access permissions on Batchsvr.ini file.
Start
1017
Unable to start due to access problem with Batchsvr.ini file.
Start
1018
Access error on Batchsvr.ini detected prior to logging on as user
specified in Batchsvr.ini.
Start
1019
Access error on Batchsvr.ini detected while running as user
specified in Batchsvr.ini.
Start
1020
Access error on log file detected while running as user specified
in Batchsvr.ini.
Start
1021
Access error on event files detected while running as user specified
in Batchsvr.ini.
Start
1022
Unable to start because primary event file directory specified by
EventDirectoryPath key in Batchsvr.ini is missing.
Start
1023
Unable to start because secondary event file directory specified by
EventDirectoryPathSecondary key in Batchsvr.ini is missing.
Start
1024
Unable to start because of access permissions on primary event file
directory specified by EventDirectoryPath key in Batchsvr.ini.
Start
1025
Unable to start because of access permissions on secondary event
file directory specified by EventDirectoryPathSecondary key
in Batchsvr.ini.
Start
1026
Unable to start because of access permissions on Archque.txt file in
primary event file directory.
Start
1027
Unable to start because of access permissions on Archque.txt file in
secondary event file directory.
Start
1028
Unable to start because of access permissions on Eventdir.txt file in
primary event file directory.
Start
1029
Unable to start because of access permissions on Eventdir.txt file in
secondary event file directory.
Start
1030
Unable to start because RestartDirectoryPath key not specified
in Batchsvr.ini.
Start
1031
Unable to start because RestartDirectoryPath specified
in Batchsvr.ini missing.
Start
1032
Unable to start because of access permissions on
RestartDirectoryPath specified in Batchsvr.ini.
Start
1033
Unable to start because of access permissions (security?) on
RestartDirectoryPath specified in Batchsvr.ini.
Start
1034
Unable to start because RestartDirectoryPath2 specified
in Batchsvr.ini missing.
Start
1035
Unable to start because of access permissions on
RestartDirectoryPath2 specified in Batchsvr.ini.
Start
1036
Unable to start because of access permissions (security) on
RestartDirectoryPath2 specified in Batchsvr.ini.
Start
1037
Server started by an ActiveX client.
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
73
Chapter 7
74
Windows event log
Category
Event Description
ID
Start
1038
Domain user name is blank and must be initialized in the
SECURITY section of the Batchsvr.ini. The Server will not have any
network
credentials, which means it cannot access anything off node (i.e.,
data servers, event journal files, or recipes).
Start
1039
Internal Error. Call to CoInitializeSecurity failed.
Start
1040
Internal Error. Call to RegisterClassObjects failed.
Start
1041
The SQL Server database cannot be opened.
Boot
2000
Server warm booting.
Boot
2001
Server cold booting.
Boot
2002
Server started.
Boot
2003
Server warm all booting.
Boot
3000
Data Server: [Descriptive String] status changed to GOOD.
Boot
3001
Data Server: [Descriptive String] status changed to SUSPECT.
Boot
3002
Data Server: [Descriptive String] status changed to LOST.
Boot
3003
Data Server: [Descriptive String] status changed to BAD.
Boot
3004
Data Server: [Descriptive String] status changed to an unknown
conversation status.
Boot
3005
Data Server: [Descriptive String].
Shutdown
4000
Server shutting down.
Shutdown
4001
Server exception occurred. See the Batchsvr.log file for information.
Shutdown
4002
Server automatically shutting down from demo mode.
Tag_Verification
5000
Server tag verification process Started.
Tag_Verification
5001
Server tag verification process Aborted.
Tag_Verification
5002
Server tag verification completed, [Descriptive String1] of
[Descriptive String2] tags verified successfully.
Registration
6000
Server registered.
Registration
6001
Server unregistered.
Registration
6002
Server registered as a service.
Control
7000
Notify SCM: The service is stopping.
Control
7001
Notify SCM: Service stopped.
Control
7002
Notify SCM: The service is starting.
Control
7003
Notify SCM: The service is running.
Control
7004
SERVICE_CONTROL_STOP received from Service Control
Manager.
Control
7005
Unexpected SERVICE_CONTROL_PAUSE received from Service
Control Manager.
Control
7006
Unexpected SERVICE_CONTROL_CONTINUE received from
Service Control Manager.
Control
7007
SERVICE_CONTROL_INTERROGATE received from Service
Control Manager.
Control
7008
SERVICE_CONTROL_SHUTDOWN received from Service Control
Manager.
Control
7009
Bad Service Request.
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
Windows event log
Chapter 7
Category
Event Description
ID
Category_Debug
8000
Command Line: [Descriptive String].
Category_Debug
8001
Argument received from SCM or BatchSCM: [Descriptive String].
Category_Debug
8002
HRESULT = [Descriptive String].
Category_Debug
8003
Thread [Descriptive String] started.
Category_Debug
8004
Exception in object [Descriptive String1] in method [Descriptive
String2].
Category_Debug
8005
Service could not be marked for deletion by the SCM.
Category_Debug
8006
Debug: [Descriptive String].
See also
Windows event log on page 71
Modify event log settings on page 75
Modify event log
settings
In order to prevent the system event logs from exceeding the maximum allowable
size, configure the application and system log to overwrite events as needed.
To modify event log settings:
1. Open the Event Viewer:
Window Server 2008 SP1: Click the Start button, point to Control Panel
> Administrative Tools > Event Viewer.
Windows XP Professional SP3: Click the Start button, click Control Panel,
then Administrative Tools > Event Viewer.
2. Right-click Application, and then click Properties. The Application
Properties dialog box opens.
3. In the Log size area, select Overwrite events as needed, and then click OK.
4. Repeat steps 2 and 3 for the System.
5. Exit the Event Viewer.
See also
Windows event log on page 71
View event log entry properties on page 71
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
75
Chapter 8
Cross invocation
Cross Invocation is the means by which the FactoryTalk Batch View and ActiveX
Controls pass data to, and activate, an automation server such as an HMI or Visual
Basic program. The data passed is specific to an equipment resource selected from
the FactoryTalk Batch Client applications.
FactoryTalk Batch provides a procedure-centric view of the batches running in the
plant. The HMI provides an equipment-centric view of these batches. If the HMI
is an automation server that supports the Cross Invocation interface, cross
invocation can send equipment-specific information about a batch to your HMI.
The HMI can then act based on the data received. For example, it may invoke a
graphic specific to the selected equipment resource or information specific to an
Equipment Module’s running logic.
See also
Cross invocation overview on page 77
Cross invocation string configuration on page 79
Cross invocation string escape sequences on page 80
Cross invocation string example on page 82
FactoryTalk Batch View and ActiveX Controls configuration for cross
invocation on page 82
Cross invocation
overview
Cross invocation is accomplished by way of user-defined and selectable cross
invocation menu items. If configured for a selected equipment resource, the cross
invocation menu items are visible and selectable from:
•
FactoryTalk Batch View when the Goto HMI button is selected.
•
The ActiveX Controls when the ActiveX control shortcut menus are
invoked by right-clicking on the running object.
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
77
Chapter 8
Cross invocation
If a recipe step is not bound to an equipment resource:
•
The FactoryTalk Batch ProcedureView ActiveX control does not display
the Cross Invocation menu when you right-click on the step.
•
FactoryTalk Batch View displays a message indicating the step is not bound
when you select the Goto HMI button.
Within the FactoryTalk Batch Client applications, there are a number of
selectable procedural elements. Each of these procedural elements relates to a
specific equipment resource. Each equipment resource may be configured to have
cross invocation strings (defined on the Cross Invocation tab of any configurable
equipment resource in the area model).
Procedural Element > Equipment Resource > Cross Invocation Strings
Each cross invocation string defines the following:
•
The text for displaying the Cross invocation menu item.
•
The data for passing to the automation server.
The following table shows the various FactoryTalk Batch View windows and the
equipment resource to which a selected procedural element is linked. For cross
invocation to be implemented, the cross invocation strings must be configured for
the equipment resource.
FactoryTalk Batch View
window
Selectable elements
Corresponding equipment
resource
Batch List
Batch
Process Cell (Procedure)
Unit (Unit Proc or Operation)
Procedure as SFC/Table
Batch
Process Cell (Procedure)
Unit (Unit Proc or Operation)
Unit Procedure
Unit
Operation
Unit
Recipe Phase
Phase
Event Journal
Batch
Process Cell (Procedure)
Unacknowledged Prompts
Unacknowledged Prompts
Phase
Phase Control
Process Cell
Process Cell
Unit
Unit
Phase
Phase
Recipe
Process Cell (Procedure)
Unit (Unit Proc or Operation)
Arbitration
Unit (Unit Proc or Operation)
78
Process Cell
Process Cell
Unit
Unit
Phase
Phase
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
Cross invocation
Chapter 8
FactoryTalk Batch View
window
Selectable elements
Corresponding equipment
resource
Resource
Resource
Alarm Summary
N/A
N/A
Phase Summary
Phase
Phase
See also
Cross invocation on page 77
Cross invocation string configuration on page 79
Cross invocation
string configuration
Use FactoryTalk Batch Equipment Editor to define up to five cross invocation
strings for each resource defined within the area model. Each time a procedural
element is selected in FactoryTalk Batch View or from the ActiveX Controls, the
cross invocation strings associated with the equipment resource corresponding to
the selected element are retrieved from the FactoryTalk Batch Server and
evaluated. The contents of these strings become the caption(s) for the cross
invocation menu item(s) and optional sub-menu items as well as the context data
that is passed to the automation server. The context data is encapsulated in escape
sequences.
Cross invocation strings are defined according to the following syntax:
•
A cross invocation string must be enclosed entirely in square brackets [ ].
Anything outside of the square brackets is ignored by the Server.
•
Within the square brackets, the initial text (to the first semicolon) indicates
the menu item(s) caption(s).
•
All text within the square brackets after the first semicolon defines the
context data passed to the automation server when the menu item is
selected.
•
A single string can specify one cross invocation item with any number of
subitems. The first comma-delimited portion of the cross invocation string
identifies the menu item for the shortcut menu, and each subsequent substring identifies a subitem.
•
The data passed in response to all subitems is identical. Subitems are
optional.
Example:
[Menu Item, Subitem 1, Subitem 2; %P, %S, %R]
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
79
Chapter 8
Cross invocation
The cross invocation string portion that specifies the data to pass to the
automation server when selecting a menu item is defined by escape sequences. The
escape sequences are replaced by the context data they represent before the string
is passed. The valid escape sequences are identified in the following table along
with their meaning.
Escape
sequence
Replace by
%P
The path to the selected step. In some instances, this value can be
empty. (See Context Data Responses for more information.)
Examples:
CreateID
CreateID \t Procedure \t Unit Procedure \t Operation \t Phase
%N
Equipment resource name to which the selected control recipe
corresponds.
%C
Class name from which the equipment resource corresponding to the
step was created.
%T
Equipment resource type to which the selected control recipe
corresponds.
%S
Computer on which the FactoryTalk Batch Server is executing.
%B
Batch ID of the selected control recipe.
%M
Menu item caption that was selected. If submenu items exist, they
appear in the following order: the caption of the menu item appended
with a colon, then the index number of the submenu item appended
with a colon, and then the caption of the submenu item selected.
%R
Resource ID of the equipment resource to which the selected control
recipe corresponds.
See also
Cross invocation overview on page 77
Cross invocation
string escape
sequences
80
The escape sequences used in the cross invocation strings correspond to the
current selection in FactoryTalk Batch View or ActiveX Controls applications.
The context data passed to the automation server is relative to the current
selection. (See the FactoryTalk Batch View User Guide for information regarding
selectable elements.)
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
Cross invocation
Chapter 8
The following describes each escape sequence relative to the type of procedural
element selected:
Escape
Sequence
Procedure
Unit Procedure
Operation
Phase
%P
Path
Path
Path
Path
%N
Corresponding
Process Cell
Name
Corresponding
Unit name
Corresponding
Unit name
Corresponding
Phase name
%C
Corresponding
Corresponding
Process Cell class Unit Class name
name
Corresponding
Unit Class name
Corresponding
Phase Class name
%T
1 (Process Cell)
2 (Unit)
2 (Unit)
3 (Phase)
%S
Node
Node
Node
Node
%B
Batch ID
Batch ID
Batch ID
Batch ID
%M
Menu caption
Menu caption
Menu caption
Menu caption
%R
Corresponding
Process Cell
resource ID
Corresponding
Unit resource ID
Corresponding
Unit resource ID
Corresponding
Phase resource ID
If the control recipe runs across multiple process cells, the context data replaced by %N and %C
is the first process cell in the process cells list of associated with the recipe.
The following describes each escape sequence relative to the element selected
within the FactoryTalk Batch View Phase Control window. (See the FactoryTalk
Batch View User Guide for information regarding selectable elements.)
Escape
Sequence
Process Cell
Unit
Phases
%P
Empty
Path (if exists).
The context data that
replaces %P (when
selecting a unit) is the unit
procedure path or
operation that owns that
unit, and blank otherwise.
Create ID (if exists).
The context data that
replaces %P when selecting
an equipment phase is the
Create ID of the batch within
which the phase is
executing. This only exists if
that equipment phase is
currently executing within
the context of a batch.
%N
Name of process cell
Name of unit
Name of phase
%C
Process Cell Class
name
Unit Class name
Phase Class name
%T
1 (process cell)
2 (unit)
3 (phase)
%S
Node
Node
Node
%B
Empty
Batch ID (if exists)
Batch ID (if exists)
%M
Menu caption
Menu caption
%R
Process cell resource Unit resource ID
ID
Menu caption
Phase resource ID
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
81
Chapter 8
Cross invocation
See also
Cross invocation on page 77
Cross invocation string configuration on page 79
Cross invocation
string example
This is an example of a cross invocation string configured in FactoryTalk Batch
Equipment Editor and the resulting cross invocation menu as seen from
FactoryTalk Batch View.
[DETAIL DISPLAY, VIEW MODE, EDIT MODE; %P, %N, %T, %C, %S, %B,
%R, %M]
This illustrates the type of data that could be passed to the automation server
when the Batch ID is selected in FactoryTalk Batch View and the batch is
running.
Tip:
The automation server must be configured for responding appropriately to the
data.
See also
Cross invocation overview on page 77
Cross invocation string configuration on page 79
FactoryTalk Batch View
and ActiveX Controls
configuration for cross
invocation
82
Once the cross invocation strings are defined, FactoryTalk Batch View and
ActiveX Controls must be configured to support cross invocation.
FactoryTalk Batch View is configured to support cross invocation under the
General tab of the System Configuration and Defaults window. On this tab,
cross invocation must be selected and the program identifier of the automation
server must be specified.
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
Cross invocation
Chapter 8
Once configured in FactoryTalk Batch View, the cross invocation menu items
become visible when a procedural element is selected (that corresponds to an
Equipment Resource with configured cross invocation strings) followed by
selecting the Goto HMI button.
The ActiveX Controls are configured to support cross invocation when the
following two properties are configured for the ActiveX object:
•
InvocationProgID
•
ShowCustomMenu
The InvocationProgID property must contain the program identifier of the
automation server. The ShowCustomMenu property must be set to True so that
the cross invocation strings are visible on the ActiveX object’s shortcut menu
during runtime as shown:
See also
Cross invocation string configuration on page 79
Cross invocation overview on page 77
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
83
Chapter 8
84
Cross invocation
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
Chapter 9
Work with the Phase Simulator
FactoryTalk Batch comes with a phase logic simulation program that allows you to
run the FactoryTalk Batch software and simulate your batch process without
being connected to a PCD. The FactoryTalk Batch Phase Simulator imitates the
functionality of a data server and communicates with the FactoryTalk Batch
Server using the OPC communication protocol. This is a powerful tool for testing,
experimentation and demonstration purposes.
Tip:
The Simulator is automatically started by the FactoryTalk Batch Server
if required by the area model1.
The Simulator allows you to save report parameter values.
Tip:
When running a material-enabled phase, RUNNING logic should not
have any configured requests. You must set the FEED_COMPLETE
report parameter to 1 and set a value for the ACTUAL_AMOUNT
report parameter. Save the simulation file after making these changes.
1. Click the Start button
Start the
FactoryTalk Batch
Phase Simulator
2. Point to All Programs > Rockwell Software > FactoryTalk Batch Suite >
FactoryTalk Batch
3. Click Simulator.
The Phase Simulator opens. The FactoryTalk Batch Server and FactoryTalk
Batch View can now run in a simulated environment.
area model. The physical component of a batch facility. A database that consists of all
equipment in the facility and all of the tasks that it is capable of performing.
1
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017Rockwell Automation
Publication FactoryTalk eProcedure Administrator Guide - February 2017
85
Chapter 9
Work with the Phase Simulator
FactoryTalk Batch
Phase Simulator
interface
Upon startup, the Simulator reads the area model that is specified in
the Batchsvr.ini file. The area model file name is displayed on the title bar. By
default, when you first install the software it is set up to read ice_cream1.cfg, one of
the sample area models shipped with FactoryTalk Batch. This file contains the
equipment required to run the Sampledemo1 recipe. The Simulator simulates the
RUNNING, STOPPING, HOLDING, ABORTING, and RESTARTING
states for all phases configured in the recipe.
Tip:
The Simulator simulates only phase states for area models that have no
more than 50 parameters and 50 report parameters.
The Simulator menu bar consists of the following options:
Modify a phase’s
configuration
86
Option
Definition
File
Allows you to open a simulator (.sim) file, save a file, or exit the
Simulator.
Edit
Allows you to edit phase configuration, phase status, or unit tag
status.
Protocols
Allows you to enable or disable the Watchdog and/or Command
Handshake functions.
Help
Allows you to open the Phase Simulator About box.
The FactoryTalk Batch Phase Simulator allows you to edit a phase’s
configuration. You can set the following items for each sequencing state of a
phase:
•
Dwell Time: Indicates the length of time, in seconds, that a specific state is
active for the selected phase.
•
Time of Request: Indicates the time, within the dwell period, at which a
request is made.
•
Type of Request: Indicates the type of request to make. (Refer to the
FactoryTalk Batch PCD Programmer Technical Reference Guide for more
information about requests.)
•
Request Parameters: Each request can have up to three parameters that
further describe the request.
•
Continuous Phase Indication: A continuous phase is an equipment
module whose phase logic does not transition to the COMPLETE state.
You can simulate continuous phase logic by selecting Continuous Phase.
When a transition that follows a step running continuous phase logic
evaluates to TRUE, and the step is not involved in Transfer of Control,
then the Batch Server sends a STOP command to the equipment module. If
the equipment module with continuous phase logic is involved in Transfer
of Control, and the transition evaluates to TRUE, the Transfer of Control
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
Work with the Phase Simulator
Chapter 9
procedure is executed, transferring ownership of the equipment module
from the step prior to the transition to the step following the transition. A
NEW_PARAMETERS command is issued to the equipment module’s
phase logic when the Transfer of Control occurs, notifying the phase logic
that new recipe parameter values associated with the new recipe step are
available for download if the phase logic requests a download. (In order to
use a continuous phase in an actual batch, appropriate phase logic must be
written to define non-terminating behavior. Refer
to NEW_PARAMETERS command in the FactoryTalk Batch PCD
Programmer Technical Reference Guide for more information.)
1. From the Edit menu, select Phase Configuration. The Phase
Configuration dialog box opens.
2. From the Select Phase list, select the appropriate phase.
Change the dwell time
1. From the Select State list, select the state for which you want to change the
dwell time.
2. Type the desired dwell time for the selected state in the Dwell Time box.
3. Click the Update Phase button.
Change the sequence
of requests
1. Type an appropriate value in the @Time box (time is in seconds). This
value will determine when the request is processed. This value must not be
greater than the Dwell Time. For example, if the Dwell Time is 30 seconds,
and the @Time value is 20 seconds, this request will be processed after the
selected state has been active for 20 seconds.
2. Type an appropriate request number in the _RQ box. (Refer to the
FactoryTalk Batch PCD Programmer’s Technical Reference for information
on request numbers.)
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
87
Chapter 9
Work with the Phase Simulator
3. Type any required request parameter data in the Q01, Q02, and Q03 boxes.
These parameters are used to further define the request.
4. Click the Update Phase button.
5. Click Close to save the changes and exit this dialog box.
Indicate a continuous
phase
Select the Continuous Phase check box if this is a continuous phase.
Change phase
status during run
time
The status of a phase can be changed during run time, allowing you to test your
phase logic prior to implementation.
•
View parameter tag values and associated parameter names
•
View request tag values
•
Set owner of phase to External
•
Change the phase’s state for phases under External Control
•
Restore active requests for HELD/RESTARTED phases
•
Change report parameter tag values
•
Change value of the Failure bit
•
Set phase to COMPLETE
•
Acknowledge/Clear requests of phases under External control
The Phase Status dialog box is accessed through the Simulator’s Edit menu and
consists of the following sections and fields:
88
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
Work with the Phase Simulator
Chapter 9
Item
Definition
Select Phase
Allows you to select a phase from all configured phases
for the active area model.
Arrays
Allows you to select Phase Parameter Tags, Parameter
Report Tags, and Request Data Tags. The Parameter
column below the list displays the associated information.
All values are view-only, except the Report Parameter
Tags. You may modify a value for a Report Parameter
Tag and click the Update Report Data button to update
the report tag value in the FactoryTalk Batch Phase
Simulator.
Close
Closes the Phase Status dialog box.
Set Complete
Sets the active phase to its corresponding terminal state:
COMPLETE, HELD or ABORTED. The Request register
must contain a 0 before the Set Complete button can
take the active phase to its corresponding terminal state.
Update Report Data
Sends the current value in the Report Parameter Tag
Value field(s) to the FactoryTalk Batch Server.
Start/Stop
Issues the appropriate command, to the active phase,
based on the current state of the phase. The command is
issued if the Owner is set to 1 (one) for External.
Abort/Reset
Issues the appropriate command, (Abort or Reset), to the
active phase, based on the current state of the phase.
The command is issued if the Owner is set to 1 (one) for
External.
Hold/Restart
The active phase will be issued the appropriate command,
Hold or Restart, based on the current state of the phase.
The command is issued if the Owner is set to 1 (one) for
External.
Owner
Acts as a toggle, switching the value in the Owner
register between 0 (zero) and 1 (one). A 0 (zero)
represents FactoryTalk Batch as the owner and a 1 (one)
represents an External owner.
Ack/Clear Request
Acknowledges the current request (first click) and clears
the request (second click). When a request is
acknowledged, the value in the Request register is
changed to 10 (ten), indicating that the request
confirmation was received from the FactoryTalk Batch
Server. When the request is cleared, the value in
the Request register is changed to 0 (zero), indicating
that the request was cleared.
Set Request
Opens a dialog box that allows you to simulate sending a
request to the FactoryTalk Batch Server. (See the
FactoryTalk Batch PCD Programmer’s Technical
Reference for more information.)
Unit Register
Displays the Equipment ID of the unit ID that currently
owns the selected phase.
Status Register
Displays the current status for the phase:
10 = ABORTING
20 = HOLDING
30 = STOPPING
40 = RESTARTING
50 = RUNNING
60 = HELD
70 = COMPLETE
80 = STOPPED
90 = ABORTED
100 = IDLE
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
89
Chapter 9
Work with the Phase Simulator
Item
Definition
Request Register
Displays the current request for the selected phase, or
displays one of the following:
10 = Received confirmation from the FactoryTalk Batch
Server
20 = Previous request was canceled
30 = Previous request was not canceled
Step Index Register
Displays the active step index for the selected phase.
Step Buffer Register
Saves the step index number when the phase receives a
Hold command. When the phase is restarted, this value is
copied into the Step Index register.
Failure Register
Displays the value for the Failure register. A 0 (zero)
indicates there are no failures. You can enter any other
value to simulate a failure.
Owner Register
Indicates the current owner of the selected phase. A 0
(zero) indicates FactoryTalk Batch is the owner; a 1 (one)
indicates an external owner.
Pause Register
Indicates the status of the phase’s Pause bit. A 0 (zero)
indicates the Pause bit is OFF; a 1 (one) indicates the
Pause bit is ON. The Pause bit must be ON to allow for
semi-auto processing.
Paused Register
Displays the value for the Paused register. A 0 (zero)
indicates the phase has not received a Pause command.
Any other value indicates the phase has received a Pause
command.
Single Step Register
Indicates the status of the phase’s single step register.
A 0 (zero) indicates the single step mode is OFF; a 1
(one) indicates the single step mode is ON.
Restore Req Register Displays the Restore Request register value. A 0 (zero)
indicates that the request register contents are not copied
to the request buffer register when the phase receives a
Hold command; a 1 (one) indicates that the contents are
copied to the request buffer register when the phase
receives a Hold command.
Clear Req Register
Displays the Clear Request register value. A 0 (zero)
indicates that the request buffer register contents are not
copied to the request register when the phase receives a
Restart command. A value of 1 (one) indicates that the
contents will be copied from the request buffer register
when the phase receives a Restart command.
Download Req
Register
Displays the Download Request register value. A 0 (zero)
indicates that a download request was not issued; a 1
(one) indicates that a download request was issued.
Timer Acc Register
Displays the accumulated amount of time, in seconds,
that the active state for the selected phase has been
running.
View a Phase
1. From the Edit menu, select Phase Status. The Phase Status dialog box
opens.
2. Select the appropriate phase from the Select Phase list.
90
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
Work with the Phase Simulator
Chapter 9
The following sections discuss various functions available from the Phase
Status dialog box.
View Phase Parameter Tag Values
The phase parameter tag values are read-only and cannot be modified in the
Simulator. The FactoryTalk Batch Server writes these tags when a download
request is processed.
•
View/update report
parameter tag values
From the Arrays list, select Phase Parameter Tags. Each parameter tag
associated with this phase is displayed, along with its current value and type.
The report parameter tag values can be modified and uploaded to the FactoryTalk
Batch Server. The uploaded value(s) are reflected in the electronic batch record
(.evt files).
1. From the Arrays list, select Report Parameter Tags. Each report parameter
tag associated with this phase displays, along with its current value and type.
2. Type a new value for the appropriate Report Parameter Tag.
3. Click the Update Report Data button to update the tag value. The report
tag values are uploaded to the Batch Server when an upload request is
processed.
View Request Data Tag Values
The request data tag values are read-only. These may be set by the FactoryTalk
Batch Phase Simulator when making a configured request or may be written to the
FactoryTalk Batch Server when processing a phase logic Receive Message request.
•
From the Arrays list, select Request Data Tags. Each request data tag
associated with this phase displays, along with its current value and type.
Change Ownership of the Phase
The Owner button acts as a toggle, switching the value in the Owner register
between 0 (zero) and 1 (one). A 0 (zero) represents Batch as the owner and a 1
(one) represents an external owner.
1. From the Select Phase list, select the appropriate phase.
2. To set ownership to External, click the Owner button when the value in
the Owner register is 0 (zero).
To set ownership to Batch, click the Owner button when the value in
the Owner register is 1 (one).
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
91
Chapter 9
Work with the Phase Simulator
Command a Phase
The FactoryTalk Batch Phase Simulator allows you to change the state of a phase.
An active phase can be commanded to COMPLETE without gaining phase
ownership. All other state change commands require the phase be under external
control. The Start/Stop, Abort/Reset and Hold/Restart buttons are modal, in
that the command issued is determined based on the phase’s active state at the
time the button is clicked. Only legal state change commands are executed. For
example, if a phase is RUNNING and the Start/Stop button is clicked, the STOP
command is issued. START is not a legal command to a phase in the RUNNING
state. (Refer to the FactoryTalk Batch PCD Programmer’s Technical Reference
for additional information on legal state transitions.)
The following table shows the phase’s transition when the state change command
is received, along with the associated state value (##).
COMMAND
INITIAL STATE
FINAL STATE
COMPLETE
COMPLETE (70)
START
RUNNING (50)
STOP
STOPPING (30)
STOPPED (80)
ABORT
ABORTING (10)
ABORTED (90)
RESET
IDLE (100)
HOLD
HOLDING (20)
HELD (60)
RESTART
RESTARTING (40)
RUNNING (50)
1. Select the phase to command from the Select Phase list.
2. To set the phase to COMPLETE, select the Set Complete button.
3. For all other state change commands, set the Owner of the phase to
External.
4. Select the appropriate state change command button
(Start/Stop, Abort/Reset, or Hold/Restart). If the requested state change
is legal, the server sends the command to the FactoryTalk Batch View and
the phase transitions to the appropriate state. The new state value is
displayed in the Status register in the Phase Status dialog box.
If the phase is running and the Abort/Reset button is selected, the phase
goes to ABORTING. To transition the phase to the ABORTED state,
select the Set Complete button.
If a phase is running and the Hold/Restart button is selected, the phase
goes to HOLDING. To transition the phase to the HELD state, select
the Set Complete button.
92
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
Work with the Phase Simulator
Chapter 9
Acknowledge and Clear a Request
Requests must be acknowledged and then cleared to allow a phase to continue
processing when running under External control. The Ack/Clear Request button
must be selected twice, first to acknowledge the request, then to clear the request.
1. From the Select Phase list, select the phase to be commanded.
2. If the Request register contains a request, select the Ack/Clear Request
button to acknowledge the request. The value in the Request register
changes to 10 (ten), indicating that the request confirmation was received
from the Batch Server.
3. Click the Ack/Clear Request button to clear the request. Upon clearing
the request, the value in the Request register changes to 0 (zero), indicating
that the request was cleared. The phase continues to process.
Restore and Clear Requests
Requests generated by a phase can be stored in the request buffer registers should
the phase receive a Hold command. The requests can then be copied back to the
request registers when the phase receives a Restart command. The Restore Req
and Clear Req registers must both contain a 1 (one) to allow for the saving and
restoring of requests for a HELD/RESTARTED phase.
1. From the Select Phase list, select the phase to be commanded.
2. In the Restore Req register, type a 1 (one).
3. In the Clear Req register, type a 1 (one).
Change the value of
a unit tag
Values of unit tags configured in the area model can be changed during run time
in the Unit Tag Status dialog box.
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
93
Chapter 9
Work with the Phase Simulator
The Unit Tag Status dialog box consists of the following:
Item
Definition
Tagname
A list of all configured unit tags for the active area model.
Class
The class associated with the unit tag.
Type
The type value associated with the unit tag.
Item
The item (addressable location) associated with the unit tag.
Value
The current value for the unit tag. This value can be modified
and sent to the FactoryTalk Batch Server.
Update Values
Updates the tag values in the Simulator.
1. From the Simulator window, select Unit Tag Status from the Edit menu.
The Unit Tag Status dialog box opens.
2. Make any required modifications to the Unit Tag Values, and select
the Update Values button. The new values are written into the
FactoryTalk Batch Phase Simulator unit tags.
3. Select OK to return to the FactoryTalk Batch Phase Simulator window.
94
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
Chapter 10
Troubleshooting
This section contains information on possible troubleshooting solutions for
FactoryTalk® eProcedure and the FactoryTalk Batch Server.
Troubleshooting
eProcedure
This section contains information on eProcedure problems and possible workarounds.
Objects embedded in
HTML code do not
display
By design, the eProcedure service does not look for embedded objects in the
HTML template files. It simply passes that HTML code through to the Client
and allows the browser to interpret it. There are two approaches that can be used
to display objects embedded in the HTML code:
•
Put them in the default web share directory, which is the recommended
approach for objects that would span multiple projects.
OR
•
For project-specific objects, use the MMC (Internet Service Manager) to
create a virtual directory that points to the \project\instructions directory.
Security may be configured for this virtual directory such that it is read-only,
without scripting or browsing privileges. (See Creating a virtual directory
for more information.)
Modify the template file to reference the object via the virtual directory. The path
to the object will look something
like: http://iis_name/virtualdirectory/object.ext.
Tip:
Make sure the object’s HTML code occurs within the Form tags
in the instruction file.
See also
Creating a virtual directory on page 12
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
95
Chapter 10
Troubleshooting
Control step
reactivation error
messages
The following messages may be seen when attempting to reactivate a control step
in the eProcedure Client Instructions View:
Cannot reactivate step
Only past control steps that have not been reactivated, are in phases that are
currently in the RUNNING state, and do not have any pending reactivated steps
are eligible to be reactivated.
Cannot remove batch
If there are any incomplete Signature Requests pending for the batch, it cannot be
removed from the batch list. Complete all Signature Requests and try again.
Permission Denied
If you do not have security permission to reactivate steps, you will see the
"Permission denied to reactivate step" message. Another user with valid permission
will have to reactivate the step.
Troubleshooting
FactoryTalk Batch
This section contains information on error log and tag verification log generation,
and how these logs are used to troubleshoot system problems. This section also
contains a list of specific error messages that may be encountered after installing
and/or running FactoryTalk Batch, and possible troubleshooting solutions.
Handle abnormal
FactoryTalk Batch
termination
In the event of a FactoryTalk Batch Server failure, FactoryTalk Batch allows you
to restart your batches where they were before the failure. However, the ability to
restart your batches may not be enough. If the reason for the Server failure is not
something obvious, like a power failure, you will probably want to know the cause.
If you need Rockwell's Application Support group to assist you with the
determination, they need information regarding the Server’s status just prior to
the failure.
The FactoryTalk Batch Server is designed to write this critical information to a log
file. This file contains the information the Application Support group needs when
determining the cause of a Server failure. However, the log file is a circular file, and
96
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
Troubleshooting
Chapter 10
eventually overwrites itself. To eliminate the possibility of losing this critical
information, the Server copies the log file upon startup if it determines that the
Server terminated abnormally.
Determine abnormal
termination
Upon startup, the FactoryTalk Batch Server reads the value of the
AbnormalTermination field within the Batchsvr.ini file. If the field value is NO,
or the field is not present, then no action is taken. If the field value is YES, then
the current Batchsvr.log file is copied to the path specified by the
ErrorLogDirectory entry in the Batchsvr.ini file. The name of the copied log file is
determined based on the CopyFileID field.
After determining whether or not to make a copy of the current log file, the
FactoryTalk Batch Server writes a value of YES into the field. At completion of a
normal shutdown, the Server writes a value of NO into the field.
Name the log file copy
The value of the CopyFileID field is an integer from which a file name of the
following format is generated:
<nnn>.LOG
where <nnn> is the value of the CopyFileID field obtained from the Batchsvr.ini
file, with leading zeros. The leading zeroes help sort the files when viewed from
Windows Explorer or a similar program. Every time the FactoryTalk Batch Server
uses this value to generate a name for a copied log file, it increments the integer
value stored in the field. An attempt to increment the integer beyond a value of
999 results in a wrapping of the value back to one.
If this value is not present or is invalid, then a current value of one (1) is assumed.
This results in the creation of a log file copy with the name 001.log and the
updating of the field to a value of two (2).
If the FactoryTalk Batch Server generates a name for a copied log file, and the file
name already exists in the directory where the copy is to be stored, the Server
attempts to create a new name for the copied log file. The Server generates new log
file names by incrementing the CopyFileID value until an unused file name is
found. The integer used to generate this file name is incremented one last time and
this value stored into the CopyFileID field in the Batchsvr.ini file. If no unused file
names are found, then the Server is forced to overwrite the file name generated
with the CopyFileID field’s original value.
End of batch entries
The electronic batch record (.evt file) contains entries if the batch is terminated by
a FactoryTalk Batch Server cold boot, or if the batch is terminated due to an error
when attempting to restore the batch from a Server warm restart.
The electronic batch record contains three entries if one of the above-mentioned
methods for batch termination occurs. The first entry is a repeat of the Event File
Name event field. The second is a System Message event field indicating the reason
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
97
Chapter 10
Troubleshooting
the batch was terminated. The last is a System Message event field indicating the
end of the batch.
Example
Termination of FactoryTalk Batch Due to Cold Boot
Description
Event
PValue
Event File
Name
\\MachineName\Program Files\Rockwell Software\Batch\YourProject\
JOURNALS\4123.evt
YourBatchDescription
System
Message
Batch terminated by COLD boot of FactoryTalk Batch Server
YourBatchDescription
System
Message
End Of BATCH
Termination of FactoryTalk Batch During Warm Restart
Description
Event
PValue
Event File
Name
\\MachineName\Program Files\Rockwell Software\Batch\YourProject\
JOURNALS\4125.evt
YourBatchDescription
System
Message
Batch terminated due to error attempting to restore batch during WARM restart
YourBatchDescription
System
Message
End Of BATCH
Log tag verification
information
Tag verification is an operator-initiated process that causes the FactoryTalk Batch
Server to attempt to read the current value of most tags defined in the area model.
The tags are read up to 30 at a time, based on the value specified in
the Batchsvr.ini file, and as reads are completed, new reads are initiated.
The FactoryTalk Batch Server allows you to verify up to 30 tags in parallel to
reduce tag verify duration and the ability to stop a tag verification in progress via a
menu item on the Server. A dedicated log file, Verify.log, records the most recent
tag verification results. This file is replaced with a new copy each time a tag
verification is begun. The Verify.log file is written to the same directory as
the Batchsvr.log file.
Tag verification start, completion, and abort records are recorded in the standard
FactoryTalk Batch Server log file, Batchsvr.log. Individual tag results are recorded
in the tag verification log file, Verify.log.
Tag verification log file
98
The record structure in the Verify.log file is identical to the record structure used
in the Batchsvr.log file. The file structure reserves the first record for field labels.
The installation program installs a default tag verify results log file into the
directory specified by the ErrorLogDirectory value in the Batchsvr.ini file. The
default file contains two records. The first record is the standard header record
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
Troubleshooting
Chapter 10
that labels the fields. The second record indicates if the tag verify function was
performed. The format of this record is depicted below:
Field#
Name
Value
1
Time
This field is left blank.
2
Severity
INFO
3
File
This field is left blank.
4
Line
This field is left blank.
5
RC_ID
This field is left blank.
6
Batch ID
This field is left blank.
7
Path
This field is left blank.
8
Element ID
This field is left blank.
9
Element Name
This field is left blank.
10
Message
The text "Tag Verify Has Not Been Run"
The tag verification log file is not intended to wrap. In the event of an unexpected
problem or circumstance, the Verify.log file is limited to 9,000,000 bytes. If
the Verify.log file exceeds this size, the file is wrapped, just like the Batchsvr.log file.
An analysis of an existing tag verification log file showed that an area model with
888 tags generated a log file with a size of 159,050 bytes, which indicates an
average of 180 bytes per tag in the verification log file. This implies that a
9,000,000-byte file should be able to verify approximately 50,000 tags before the
log file would wrap.
The FactoryTalk Batch Server only keeps the tag verification log file open during
the tag verification process. When a program has a file open, the file cannot be
deleted or renamed. The Server overwrites any existing tag verification log file each
time a tag verification begins. If the Server encounters a tag verification log file
that is Read Only, the Server changes the protection on the file to allow it to be
overwritten.
The following events regarding tag verification are recorded in the Windows
Event Log.
Windows event log
Event
Generated Windows Event Log
Start
"Batch Server Tag Verification Process Started"
Abort
"Batch Server Tag Verification Process Aborted"
Completion
"Batch Server Tag Verification Completed, <xxx> of <yyy> tags
verified successfully" where <xxx> is the number of tags that were
successfully verified, and <yyy> is the total number of tags on which
verification was attempted.
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
99
Chapter 10
Troubleshooting
Performance chart
The performance chart included with FactoryTalk Batch is a pre-defined set of
charts for use with the Windows System Monitor.
Tip:
The predefined performance monitor charts are in English only.
Non-English customers must configure the charts manually. (Refer
to your Windows documentation for more information on
performance charts.)
The System Monitor can examine the use of computer resources by FactoryTalk
Batch components, as well as other processes and applications, and it can help
determine if a process or application is using too much CPU time or memory. The
pre-defined Performance Chart, supplied with FactoryTalk Batch, charts specific
processes that can affect the performance of FactoryTalk Batch, and can be an
important tool in identifying and troubleshooting system problems.
Tip:
The performance chart is intended to be used primarily as a
debugging and diagnostic tool by FactoryTalk Batch product
support personnel.
The Windows System Monitor is used to view chart data, alerts, logs and reports.
Additionally, charts can be saved for future review. To view the FactoryTalk Batch
performance chart, make sure that the System Monitor is set to chart view mode.
(Refer to your Windows documentation for more information on using the
System Monitor.)
Open the FactoryTalk
Batch performance chart
The performance chart automatically opens the Windows System Monitor with
the pre-defined charts loaded.
To open the FactoryTalk Batch performance chart:
1. Click the Start button.
2. Point to All Programs > Rockwell Software > FactoryTalk Batch Suite >
FactoryTalk Batch.
3. Click Performance Chart. The Performance dialog box opens with the
pre-defined charts listed.
See also
FactoryTalk Batch performance chart on page 101
100
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
Troubleshooting
FactoryTalk Batch
performance chart
Chapter 10
The FactoryTalk Batch performance chart is a pre-defined set of charts for use
with the Windows System Monitor.
Tip:
The predefined performance monitor charts are in English only. NonEnglish customers must configure the charts manually. (Refer to your
Windows documentation for more information on performance charts.)
The Windows System Monitor can examine the use of computer resources by
FactoryTalk Batch components, as well as other processes and applications, and
help determine if a process or application is using too much CPU time or memory.
The performance chart charts specific processes that can affect the performance of
FactoryTalk Batch, and is an important tool in identifying and troubleshooting
system problems.
Tip:
The performance chart is intended to be used primarily as a
debugging and diagnostic tool by FactoryTalk Batch product support
personnel.
The Windows System Monitor is used to view chart data, alerts, logs and reports.
Additionally, charts can be saved for future review. To view the FactoryTalk Batch
performance chart, make sure that the System Monitor is set to chart view mode.
Troubleshoot errors
This section outlines errors that may be encountered while running FactoryTalk
Batch and possible solutions to these errors.
Automatic repair of Batch component installation fails
This can happen if one or more necessary folders were unintentionally moved (in
Windows explorer). For example, if the Schema folder gets moved away from its
original install path, the install package starts up automatically and tries to ‘repair’
the problem. This ‘repair’ can clear out the Model and Server keys in the registry,
which can make the Batch client editors generate warning dialogs because they are
not able to find the Network Model.
If this happens, completely uninstall the application and then reinstall it.
FactoryTalk Batch Server does not start
Error Message: (none)
•
Journal path has not been defined in FactoryTalk Batch Server options.
Modify the FactoryTalk Batch Server options to include a valid Primary
Journal path. Verify that the Secondary Journal path, if defined, is valid.
•
Restart path has not been defined in FactoryTalk Batch Server options.
Modify the FactoryTalk Batch Server options to include a valid Primary
Restart path. Verify that the Secondary Restart path, if defined, is valid.
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
101
Chapter 10
Troubleshooting
•
Incorrect Net registry key value.
The FactoryTalk Batch Server is always installed with the default user and
password.
The FactoryTalk Batch Server’s logon/password settings are not migrated
from the Server .ini file during an upgrade. To run the Server as a different
user, you must change the logon/password settings, using the Control
Panel Services dialog box, after a new installation.
FactoryTalk Batch Server runs for a specific period of time and then stops,
and consistently stops at the same time interval.
Error Message: (none)
•
Check the FactoryTalk Batch Service Manager. If the Allow Demo Mode
check box is selected, this could be the problem.
FactoryTalk Batch Service Manager does not display the FactoryTalk Batch
Server and/or Event Archiver.
Error Message: (none)
•
The computer where the services are located is not selected.
Use the Select Computer button to select the appropriate computer.
•
The FactoryTalk Batch Server and/or Archiver services are not registered
with the Windows Registry.
To register a service, click the Start button, point to All Programs, and
then select Command Prompt. Navigate to the Program Files\Rockwell
Software\Batch\bin directory. To register the FactoryTalk Batch Server
type batchsrv /service at the command prompt, and then press enter. To
register the FactoryTalk Event Archiver, type batcharc /service at the
command prompt, and then press enter.
102
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
Troubleshooting
Chapter 10
FactoryTalk Batch Service Manager displays "Batch.Server Class" instead of
"Batch Server".
Error Message: (none)
•
The service displays the class name instead of the display name.
This is caused by DCOMCNFG configuring the FactoryTalk Batch Server
service to display the class name of the service instead of the display name.
When this occurs, the Server no longer supports its COM interface and
must be reinstalled.
The FactoryTalk Batch View/Client is properly configured, but can’t view the
Event Journals.
Error Message: (none)
•
There may be a version conflict in one or more of the required files.
The text in FactoryTalk Batch dialog boxes does not display properly.
Error Message: (none)
•
FactoryTalk Batch does not support the use of large system fonts.
Use the Display Properties dialog box to change the default system font
size to Small Fonts.
Unable to locate files.
Error Message: "The Recipe directory file could not be found."
•
The server options for the FactoryTalk Batch Server are not configured to
point to the folder that contains the Recipe.dir file. (See FactoryTalk Batch
Server option configuration in the FactoryTalk Batch Administrator Guide
for more information.)
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
103
Chapter 10
Troubleshooting
An Application Log error is generated.
Error Message: "The Application log file is full."
•
The Application log is not set for wrapping.
Use the Event Viewer to change the Application Event Log Wrapping setting
to Overwrite Events as Needed:
1. Click the Start button, point to All Programs > Administrative Tools,
and then select Event Viewer. The Event Viewer opens.
2. Right-click Application Log, and select Properties. The Application Log
Properties dialog box opens.
3. In the Log size section, select Overwrite events as needed.
4. Click OK.
5. Exit the Event Viewer.
A Licensing error message is generated in Microsoft Visual Basic.
Error Message: "License information for this component not found. You do not
have an appropriate license to use this functionality in the design environment."
•
The ActiveX controls did not install correctly.
Visual Basic should be installed before FactoryTalk Batch is installed. If you have
already installed FactoryTalk Batch:
1. Uninstall the FactoryTalk Batch client to remove the ActiveX controls.
(Refer to the FactoryTalk Batch Components Upgrade and Installation Guide
for information on removing the ActiveX Controls).
2. Re-install Visual Basic.
3. Re-install the FactoryTalk Batch client using the FactoryTalk Batch Setup
program.
104
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
Troubleshooting
Chapter 10
Recipes not visible from FactoryTalk Batch View program.
Error Message: (none)
•
When the Create a Batch button is clicked, no recipes show up in the Select
a Recipe dialog box.
The Released to Production item is not selected in the recipe header data.
For each recipe that should appear in the Select a Recipe dialog box, ensure
that the Released to Production check box is selected. This can be done by
selecting the Header data option for the recipe and selecting the Released
to Production check box.
List of available SQL Server databases not displayed in the Server Options
dialog box.
Error Message: (none)
When the browse button for SQL Server databases is clicked, no databases
are displayed in the Database Selection dialog box.
Install SQL Server’s ClientTools Connectivity option. Do a custom
installation of SQL Server to install the Client Tools Connectivity option.
Event Journal files are not being created.
Error Message: (none)
•
The primary journal directory must be located on the FactoryTalk Batch
Server computer in the BATCHCTL share. If the Primary Journals
directory is located on a computer other than the Server computer, or not
within the BATCHCTL share, and that computer becomes inaccessible, the
Server continues executing batches but is unable to create event journals for
those batches. You will not receive a notification of the problem.
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
105
Chapter 11
Customize batch IDs
For purposes of batch identification, you can create custom default batch IDs, and
allow or prevent editing of batch IDs. You can also automatically generate custom
batch IDs. In order to implement this option, you must perform steps in the
FactoryTalk Batch View and the FactoryTalk Batch Equipment Editor, edit some
Visual Basic code (provided with your FactoryTalk Batch installation CD) and
compile it into a new DLL. If you are using the FactoryTalk Batch ActiveX
controls, you can use the BatchID editable property to enable or disable editing of
batch IDs. (See the FactoryTalk Batch ActiveX Controls Library Reference for more
information.)
By default, eProcedure allows editing of batch IDs. However, you can modify
the user.asp file to disable editing of batch IDs; or to re-enable editing batch IDs if
it was disabled.
See also
Modify the user.asp file to prevent editing of batch IDs on page 111
Modify the user.asp file to allow editing of batch IDs on page 111
Enable editing of
batch IDs
The batch ID is shown on the Batch Creation dialog box when a batch is created,
and by default, is editable. However, if editing of batch IDs has been disabled,
follow these steps to enable this option.
1. Open the FactoryTalk Batch View.
2. Click the Configuration and Defaults button.
3. Enter your system configuration password, and then click OK.
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
107
Chapter 11
Customize batch IDs
4. Select the General tab, and in the BatchID Editing area, select the Allow
Editing of Batch ID check box.
Disable editing of
batch IDs
If you create a custom batch ID, we recommend that you prevent editing of batch
IDs. This ensures that the custom batch ID you specified appears when you add a
batch to the batch list, and that it cannot be changed by the operator.
The following steps disable editing of the batch ID. In this case, the box on
the Batch Creation dialog, which displays when a batch is added to the batch list,
is grayed out.
Tip:
If a failure occurs in the generation of a custom batch ID, the batch ID is
editable regardless of the setting.
1. Perform steps 1-3 in the section, "Enable Editing of Batch IDs."
2. Click the General tab, and then in the BatchID Editing section, deselect
the Allow Editing of Batch ID check box.
Define a custom
default batch ID
If you define a custom default batch ID, when a new batch is added to the batch
list, the box on the Batch Creation dialog is automatically populated with the
custom default batch ID.
To define a custom default batch ID:
1. Open the FactoryTalk Batch Equipment Editor.
2. From the Options menu, select Server Options.
3. Select the Batch Server tab.
108
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
Customize batch IDs
Chapter 11
4. In the Miscellaneous section, type a default batch ID in the Default Batch
ID box.
5. Select OK.
Create a custom
BatchIDCreation.dll
The option to automatically generate custom batch IDs, in any values or
increments you require, is easily implemented. If you choose this option, you must
modify some Visual Basic code, compile it into a new DLL (Dynamic Link
Library) file and then place it in the BATCHCTL\Bin folder. We recommend
that you make a back-up copy of the original BatchIDCreation.dll before making
any changes. The currently supported version of Visual Basic is shown in
the System Requirements of the FactoryTalk Batch Getting Results Guide.
Tip:
The FactoryTalk Batch Server and the Visual Basic development
environment must be installed on the same computer.
Tip:
If the AutoBatchID execute fails or the generated batch
ID contains invalid characters, the Batch ID box in the
FactoryTalk Batch View becomes editable even if
the Allow Editing of Batch ID check box in the
View/Configuration and Defaults/General is disabled. If
you created a default batch ID, it populates the Batch ID
box and is editable. This feature allows the operator to
enter the batch ID manually in the event of a failure.
To customize the DLL:
1. Copy the entire Custom folder, found on the FactoryTalk Batch CD,
including all subdirectories, to the local hard drive, leaving the structure
intact.
2. Double-click BatchIDCreation.vbp. The Visual Basic project opens. If you
see error messages about references that are not yet in the Visual Basic
project, click Yes until you see the message that Visual Basic is unable to set
the version compatible component. Click OK.
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
109
Chapter 11
Customize batch IDs
3. From the Project menu, select References. The References dialog box
opens.
There are several files that are required for references used in the Visual
Basic project. These references must be set manually within the Visual Basic
IDE.
4. From the Available References list, select the following references:
•
COM+ Services Type Library
The COM+ Runtime library, COMSVCS.dll, that is needed for
COM+ functionality. If this file is not on your system use MTXAS.dll.
•
OLE Automation
The OLE Automation support DLL, STDOLE32.tlb, which is usually
a standard Visual Basic reference.
•
batchidcreationinsertion 1.0 Type Library
The AutoBatchID type library, batchidcreationinsertion.tlb, required
to create your customized version of the BatchIDCreation.dll.
5. Click OK.
6. From the Project menu, select BatchIDCreation Properties. The Project
Properties dialog box opens.
7. Select the Component tab, and then select Binary Compatibility.
8. Click the browse button, locate C:\\Program Files\\Rockwell
Software\\Batch\Bin\BatchIDCreation.dll, and then click Open.
9. Click OK.
10. Modify the source code located between the Begin - Code Modifications
heading and the End - Code Modifications heading within
[GenerateBatch] to define the BatchID value.
Tip:
The batch ID can contain a maximum of 255 characters with no
spaces or invalid characters. The batch ID can be comprised of any
characters except the following: The defined list separator, single or
double quotes, brackets, parentheses, the percent sign (%), the tab
character ( \t ), the carriage return character ( \r ), or the new line
character ( \n ).
11. From the File menu, click Make BatchIDCreation.dll. The Make Project
dialog box opens. Compile the project into a .dll named BatchIDCreation
dll.
12. Click OK.
110
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
Customize batch IDs
Chapter 11
13. Replace the default BatchIDCreation.dll in the BATCHCTL\Bin folder
with the newly compiled BatchIDCreation.dll.
14. Restart your computer.
Modify the user.asp
file to allow editing
of batch IDs
In order for eProcedure to allow editing of batch IDs, modify the user.asp file.
1. Open Windows Explorer.
2. Navigate to C:\\Program Files\\Rockwell Software\\Batch\Web.
3. Open the user.asp file using Notepad or the Editor of your choice.
4. Set the following value to true:
<% const blnBatchIDEditable = true
5. Save the user.asp file.
6. Exit Notepad or the Editor you are using.
7. You must close and then restart the eProcedure Client for the change to
take effect.
Modify the user.asp
file to prevent
editing of batch IDs
In order to prevent editing batch IDs, modify the user.asp file.
1. Open Windows Explorer.
2. Navigate to C:\\Program Files\\Rockwell Software\\Batch\Web.
3. Open the user.asp file using Notepad or the Editor of your choice.
4. Set the following value to false:
<% const blnBatchIDEditable = false
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
111
Chapter 11
Customize batch IDs
5. Save the user.asp file.
6. Exit Notepad or the Editor you are using.
7. You must close and then restart the eProcedure Client for the change to
take effect.
112
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
Chapter 12
Archive HTML elements
The archived HTML represents the completed control step as the operator saw it
when it completed, and includes any data entered by the operator. When
an eProcedure user completes a control step, the eProcedure Client captures the
step’s HTML. Client-side scripting removes any script blocks the step may
contain and disables all dynamic elements in the step. The eProcedure Client then
sends the instructions to the eProcedure Server, which sends the step HTML to
the FactoryTalk Batch Server. The FactoryTalk Batch Server then writes the step
HTML to the event journal as part of an Instruction Complete event.
Script Blocks
Before sending control step HTML to the eProcedure Server, the eProcedure
Client removes all script blocks, and disables all buttons, text boxes, and other
dynamic HTML elements the step contains. For example, before being sanitized,
the HTML for a step may look like the following:
<FORM>
<INPUT type=button value="Click This Button"
onclick=ButtonClick>
<INPUT type=text value="Kilroy Was Here">
<IMG src=./images/Image.JPG onclick='msgbox "Hello!"'>
<SCRIPT language=vbscript>
sub ButtonClick
window.alert "Hi There"
end sub
</SCRIPT>
</FORM>
After sanitization, the HTML looks like this:
<FORM>
<INPUT type=button value="Click This Button"
onclick=ButtonClick disabled>
<INPUT type=text value="Kilroy Was Here" disabled>
<IMG src=./images/Image.JPG onclick='msgbox "Hello!"'
disabled>
</FORM>
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
113
Chapter 12
Archive HTML elements
Tip:
Images and files must be placed in directories
under \Batch\web\ to use relative ("./") paths. Otherwise,
absolute path names must be used (for example,
"/full_path/Image.jpg").
OBJECT Elements
In HTML stored in the event journal, <OBJECT> elements are removed and are
replaced with a message. Before sending control step HTML to the eProcedure
Server, the eProcedure Client removes all <OBJECT> elements and their child
elements the step contains and replaces them with the message "Note: Object
Removed For Archiving" and the class ID of the removed object. For example, the
HTML for a step may look like this:
<FORM>
Add a CIP Batch to the Batch List. Click "OK" when
done."&nbsp;"
<OBJECT classid=clsid:29DAC4FF-034F-11D3-91DE-0800366B4903
codeBase=./components/batchv01.cab height=100%
id=crl name=crl style="POSITION: relative" width=100%>
<PARAM NAME="Node" VALUE="DEV_CLCASE02">
</OBJECT>
</FORM>
After sanitization, removing the object element and its child element, and
inserting the message, the HTML would look like this:
<FORM>
Add a CIP Batch to the Batch List. Click "OK" when
done."&nbsp;"
<I>Note: Object clsid:29DAC4FF-034F-11D3-91DE-0800366B4903
Removed for Archiving</I>
</FORM>
TAB Characters and CRLFs
Before sending control step HTML to the eProcedure Server, the eProcedure
Client removes all TAB characters and CRLFs and replaces them with spaces. As
the event journal is a TAB-delimited document, and individual records are
separated by CRLFs, this prevents corruption of the data stored in the file. This
does not change the way HTML is rendered.
List Separator Characters, Parentheses, and Forward Slashes
List separator characters, parentheses, and forward slashes (/) will not be removed
from archived instructions.
114
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
Archive HTML elements
Chapter 12
HTML Placeholder
The eProcedure Server adds a hidden input element called "StepHTML" to all
active control steps. This is used by the eProcedure Client as a placeholder for step
HTML before step submission. When you view the source code of an active
instruction, the input element resembles the following: <input type=hidden
name=StepHTML id=StepHTML>
After sanitizing the instructions, the control step HTML is stored in this element.
Server-side scripting will extract the HTML from this element and send it to
the eProcedure Server.
HTML elements
The following list defines HTML elements that can be contained in an
instruction step, can be dynamic and therefore must be disabled before archiving.
(Source: MSDN Library. See the MSDN library for documentation as to the types
of events that can be defined for each element.)
Name
Description
a
Designates the start or destination of a hypertext link.
acronym
Indicates an acronym abbreviation.
address
Specifies information, such as address, signature, and authorship, of the
current document.
applet
Places executable content on the page.
area
Defines the shape, coordinates, and associated URL of one hyperlink
region within a client-side image map.
b
Specifies that the text should be rendered in bold.
Base
Specifies an explicit URL used to resolve links and references to external
sources such as images and style sheets.
baseFont
Sets a base font value to be used as the default font when rendering text.
bdo
Allows authors to disable the bidirectional algorithm for selected
fragments of text.
bgSound
Enables an author to create pages with background sounds or sound
tracks.
big
Specifies that the enclosed text should be displayed in a larger font than
the current font.
blockQuote
Sets apart a quotation in text.
Body
Specifies the beginning and end of the document body.
br
Inserts a line break.
button
Specifies a container for rich HTML that is rendered as a button.
caption
Specifies a brief description for a table.
center
Centers subsequent text and images.
cite
Indicates a citation by rendering text in italic.
Code
Specifies a code sample.
col
Specifies column-based defaults for the table properties.
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
115
Chapter 12
116
Archive HTML elements
Name
Description
a
Designates the start or destination of a hypertext link.
colGroup
Specifies property defaults for a column or group of columns in a table.
comment
Indicates a comment that is not displayed.
custom
Represents a user-defined element.
dd
Indicates the definition in a definition list. The definition is usually indented
in the definition list.
del
Indicates text that has been deleted from the document.
dfn
Indicates the defining instance of a term.
dir
Denotes a directory list.
div
Specifies a container that renders HTML.
Dl
Denotes a definition list.
Dt
Indicates a definition term within a definition list.
em
Emphasizes text, usually by rendering it in italic.
embed
Allows documents of any type to be embedded.
fieldSet
Draws a box around the text and other elements that the field set
contains.
font
Specifies a new font, size, and color to be used for rendering the enclosed
text.
frame
Specifies an individual frame within a FRAMESET element.
frameSet
Specifies a frameset, which is used to organize multiple frames and
nested framesets.
Head
Provides an unordered collection of information about the document.
hn
Renders text in heading style.
hr
Draws a horizontal rule.
html
Identifies the document as containing HTML elements.
i
Specifies that the text should be rendered in italic, where available.
iframe
Creates inline floating frames.
img
Embeds an image or a video clip in the document.
Input
Creates a variety of form input controls.
Input type=button
Creates a button control.
Input type=check box
Creates a check box control.
Input type=file
Creates a file upload object with a text box and Browse button.
input type=image
Creates an image control that, when clicked, causes the form to be
immediately submitted.
input type=password
Creates a single-line text entry control similar to the INPUT type=text
control, except that text is not displayed as the user enters it.
input type=radio
Creates a radio button control.
input type=reset
Creates a button that, when clicked, resets the form's controls to their
initial values.
input type=submit
Creates a button that, when clicked, submits the form.
input type=text
Creates a single-line text entry control.
ins
Specifies text that has been inserted into the document.
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
Archive HTML elements
Chapter 12
Name
Description
a
Designates the start or destination of a hypertext link.
isIndex
Causes the browser to display a dialog window that prompts the user for a
single line of input.
kbd
Renders text in a fixed-width font.
label
Specifies a label for another element on the page.
legend
Inserts a caption into the box drawn by the fieldSet object.
li
Denotes one item in a list.
link
Enables the current document to establish links to external documents.
listing
Renders text in a fixed-width font.
map
Contains coordinate data for client-side image maps.
marquee
Creates a scrolling text marquee.
menu
Creates an unordered list of items.
meta
Conveys hidden information about the document to the server and the
client.
noBR
Renders text without line breaks.
noFrames
Contains HTML for browsers that do not support FRAMESET elements.
noScript
Specifies HTML to be displayed in browsers that do not support scripting.
object
Inserts an object into the HTML page.
ol
Draws lines of text as a numbered list.
optGroup
Allows authors to group choices logically in a select element.
option
Denotes one choice in a SELECT element.
p
Denotes a paragraph.
plainText
Renders text in a fixed-width font without processing tags.
pre
Renders text in a fixed-width font.
q
Sets apart a quotation in text.
rt
Designates the ruby text for the RUBY element.
ruby
Designates an annotation or pronunciation guide to be placed above or
inline with a string of text.
s
Renders text in strike-through type.
samp
Specifies a code sample.
script
Specifies a script for the page that is interpreted by a script engine.
select
Denotes a list box or drop-down list.
small
Specifies that the enclosed text should be displayed in a smaller font.
span
Specifies an inline text container.
strike
Renders text in strike-through type.
strong
Renders text in bold.
style
Specifies a style sheet for the page.
sub
Specifies that the enclosed text should be displayed in subscript, using a
smaller font than the current font.
sup
Specifies that the enclosed text should be displayed in superscript, using
a smaller font than the current font.
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
117
Chapter 12
118
Archive HTML elements
Name
Description
a
Designates the start or destination of a hypertext link.
table
Specifies that the contained content is organized into a table with rows
and columns.
tBody
Designates rows as the body of the table.
td
Specifies a cell in a table.
textArea
Specifies a multiline text input control.
tFoot
Designates rows as the table's footer.
th
Specifies a header column. Header columns are centered within the cell
and are bold.
tHead
Designates rows as the table's header.
title
Contains the title of the document.
tr
Specifies a row in a table.
tt
Renders text in a fixed-width font.
u
Renders text that is underlined.
ul
Draws lines of text as a bulleted list.
var
Defines a programming variable. Typically renders in an italic font style.
xmp
Renders text used for examples in a fixed-width font.
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
Chapter 13
Change the FactoryTalk Batch
server user account
Depending on your facility’s security requirements you may need to change the
FactoryTalk Batch server user name and password periodically. If you change the
server’s user account after installing the FactoryTalk Batch components you must
configure your FactoryTalk Batch system to use the new server user account.
Tip:
The user account for the FactoryTalk Batch server, Batch
Archiver, eProcedure server services and the Batch COM+ Application
must be identical.
See also
New user account requirements for the FactoryTalk Batch server on page
119
New user account
requirements for the
FactoryTalk Batch
Server
When creating a new user account for the FactoryTalk Batch Server, the following
requirements must be met.
•
The password must be configured never to expire--if the password ever
expires, the service eventually fails to log on.
•
The user account must never be disabled or deleted--if this account is ever
disabled/deleted, the service eventually fails to log on.
•
The domain user account must have a unique name--if the user account is a
domain account, remove any local user accounts with the same name.
•
The user account/user group must exist on all workgroup computers--if you
want a local account to have access to resources on other computers in a
workgroup environment, you must create accounts with the same name and
password on each computer in the workgroup.
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
119
Chapter 13
Change the FactoryTalk Batch server user account
Configure your
FactoryTalk Batch
system
After you create a new user account for the FactoryTalk Batch Server, configure
your FactoryTalk Batch system.
To configure your FactoryTalk Batch system:
1. Configure the FactoryTalk Batch Server computer:
a.
Add the new server user account to the batchsvr_group and
administrators group. By adding the new account to
the batchsvr_group it inherits all the required user rights and access
permissions.
b. If FactoryTalk Batch Material Manager is part of your system, add the
new FactoryTalk Batch Server user account to the MTBatchServer
group on the Material Server computer.
c.
Add the new FactoryTalk Batch Server user account to
the FactoryTalk Batch Server service.
d. If you are running FactoryTalk Event Archiver in incremental mode,
add the new FactoryTalk Batch Server user account in the Batch
Archiver service.
e.
If FactoryTalk eProcedure is part of your system, add the new
FactoryTalk Batch Server user account to the eProcedure Server
service.
f.
Add the new FactoryTalk Batch Server user account to the Batch
COM object in Component Services > My Computer > COM+
Applications.
2. Configure the FactoryTalk Batch Client computer(s):
a.
If you are using workgroup security, create the new FactoryTalk Batch
Server user account on all FactoryTalk Batch Client computers in the
workgroup.
b. Add the new FactoryTalk Batch Server user account to Component
Services > My Computer > Properties > COM Security on all remote
FactoryTalk Batch View computers. Configure the account
with Access Permissions: Local Access and Remote Access.
120
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
Change the FactoryTalk Batch server user account
c.
Chapter 13
If eProcedure is part of your system, add the new FactoryTalk Batch
Server user account to Component Services > My Computer >
Properties > COM Security on all remote eProcedure Client
computers. Configure the account with Access Permissions: Local
Access and Remote Access.
See also
Server account password change locations on page 125
Change the server user account for the FactoryTalk Batch Server service
on page 122
Change the server user account in FactoryTalk Batch COM+ applications
on page 122
Change the server user account in My Computer properties on page 123
Change the server
account password
If you change the password for the existing FactoryTalk Batch Server user
account, change the password in these locations:
•
If you are using Workgroup security, change the password for the
FactoryTalk Batch Server user account on all FactoryTalk Batch computers
in the workgroup.
•
Change the password for the FactoryTalk Batch Server user account in the
FactoryTalk Batch server service.
•
•
If you are running FactoryTalk Event Archiver in incremental mode,
change the password for the FactoryTalk Batch Server user account to
the Batch Archiver service.
•
If eProcedure is part of your system, change the password for the
FactoryTalk Batch Server user account in the eProcedure Server
service.
Change the password for the FactoryTalk Batch Server account in
the Batch COM object in Component Services > My Computer
> COM+ Applications.
See also
Configure your FactoryTalk Batch system on page 120
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
121
Chapter 13
Change the FactoryTalk Batch server user account
Change the server user
account for the
FactoryTalk Batch
Server service
To change the user account for the FactoryTalk Batch Server service, complete
these steps on the server computer.
To change the server user account for the FactoryTalk Batch Server service:
1. Point to Administrative Tools > Services, and then click Services.
The Services dialog box opens.
2. Right-click Batch Server, and then click Properties. The FactoryTalk
Batch Server Properties dialog box opens.
3. On the Log On tab, select This Account and type the new user and/or
password.
4. Click OK.
•
If you are using FactoryTalk Event Archiver in incremental mode,
change the user account name and/or password for the Batch Archiver
service.
•
If eProcedure is part of your system, change the user account name
and/or password for the eProcedure Server service.
5. Close Services.
See also
Configure your FactoryTalk Batch system on page 120
Change the server user
account in FactoryTalk
Batch COM+
applications
To change the FactoryTalk Batch Server user account in Batch COM+
applications, complete these steps on the FactoryTalk Batch Server computer.
To change the server user account in FactoryTalk Batch COM+ applications:
1. Point to Administrative Tools > Component Services.
2. Expand Component Services, Computers, My Computer and COM+
Applications.
3. Right-click Batch, and then select Properties. The Batch Properties dialog
box opens.
122
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
Change the FactoryTalk Batch server user account
Chapter 13
4. On the Identity tab, select This user and type the new FactoryTalk Batch
Server user name and/or password.
5. Click OK.
Tip:
The new permissions are applied the next time the FactoryTalk Batch
Server is started on the computer.
See also
Server account password change locations on page 125
Change the server user
account in My
Computer properties
To change the FactoryTalk Batch Server user account in My Computer
properties, complete these steps on the FactoryTalk Batch Client computers.
To change the server user account in My Computer properties:
1. Point to Administrative Tools > Component Services.
2. Expand Component Services and Computers.
3. Right-click My Computer, and then click Properties. The My Computer
Properties dialog box opens.
4. On the COM Security tab, click the Edit Default button in the Access
Permissions area. The Access Permission dialog box opens.
5. Click the Add button to open the Select Users, Computers, or Groups
dialog box.
6. Type the new FactoryTalk Batch Server user account name and then
click OK.
7. In the Access Permission dialog box, select the new FactoryTalk Batch
Server account. In the Permissions list, select Allow for Local Access and
Remote Access.
8. Click OK twice.
9. Close Component Services.
10. Restart the computer.
See also
Server account password change locations on page 125
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
123
Chapter 13
Change the FactoryTalk Batch server user account
Configure your
FactoryTalk Batch
system
After you create a new user account for the FactoryTalk Batch Server, configure
your FactoryTalk Batch system.
To configure your FactoryTalk Batch system:
1. Configure the FactoryTalk Batch Server computer:
a.
Add the new server user account to the batchsvr_group and
administrators group. By adding the new account to
the batchsvr_group it inherits all the required user rights and access
permissions.
b. If FactoryTalk Batch Material Manager is part of your system, add the
new FactoryTalk Batch Server user account to the MTBatchServer
group on the Material Server computer.
c.
Add the new FactoryTalk Batch Server user account to
the FactoryTalk Batch Server service.
d. If you are running FactoryTalk Event Archiver in incremental mode,
add the new FactoryTalk Batch Server user account in the Batch
Archiver service.
e.
If FactoryTalk eProcedure is part of your system, add the new
FactoryTalk Batch Server user account to the eProcedure Server
service.
f.
Add the new FactoryTalk Batch Server user account to the Batch
COM object in Component Services > My Computer > COM+
Applications.
2. Configure the FactoryTalk Batch Client computer(s):
a.
If you are using workgroup security, create the new FactoryTalk Batch
Server user account on all FactoryTalk Batch Client computers in the
workgroup.
b. Add the new FactoryTalk Batch Server user account to Component
Services > My Computer > Properties > COM Security on all remote
FactoryTalk Batch View computers. Configure the account
with Access Permissions: Local Access and Remote Access.
124
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
Change the FactoryTalk Batch server user account
c.
Chapter 13
If eProcedure is part of your system, add the new FactoryTalk Batch
Server user account to Component Services > My Computer >
Properties > COM Security on all remote eProcedure Client
computers. Configure the account with Access Permissions: Local
Access and Remote Access.
See also
Server account password change locations on page 125
Change the server user account for the FactoryTalk Batch Server service
on page 122
Change the server user account in FactoryTalk Batch COM+ applications
on page 122
Change the server user account in My Computer properties on page 123
Server account
password change
locations
If you change the password for the existing FactoryTalk Batch Server user
account, change the password in these locations:
•
If you are using Workgroup security, change the password for the
FactoryTalk Batch Server user account on all FactoryTalk Batch computers
in the workgroup.
•
Change the password for the FactoryTalk Batch Server user account in the
FactoryTalk Batch server service.
•
•
If you are running FactoryTalk Event Archiver in incremental mode,
change the password for the FactoryTalk Batch Server user account to
the Batch Archiver service.
•
If eProcedure is part of your system, change the password for the
FactoryTalk Batch Server user account in the eProcedure Server
service.
Change the password for the FactoryTalk Batch Server account in
the Batch COM object in Component Services > My Computer
> COM+ Applications.
See also
Configure your FactoryTalk Batch system on page 120
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
125
Legal Notices
Legal Notices
Copyright notice
© 2017 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.
End User License Agreement (EULA)
You can view the Rockwell Automation End-User License Agreement ("EULA")
by opening the License.rtf file located in your product's install folder on your hard
drive.
Trademark Notices
Allen-Bradley, CompactLogix, ControlLogix, Connected Components
Workbench, eProcedure, FactoryTalk, GuardLogix, GuardPLC, Micro800,
MicroLogix, MobileView, MobileView Guard, PanelBuilder, PanelView,
PhaseManager, PlantLink, PlantPAx, PLC-2, PLC-3, PLC-5, PowerMonitor,
RSBizWare, RSBizWare BatchHistorian, RSBizWare Historian, RSBizWare
MaterialTrack, RSLinx, Rockwell Automation, Rockwell Software, SLC,
SoftLogix, Studio 5000, and XMare trademarks of Rockwell Automation, Inc.
Any Rockwell Automation software or hardware not mentioned here is also a
trademark, registered or otherwise, of Rockwell Automation, Inc.
For a complete list of products and their respective trademarks, go
to: http://www.rockwellautomation.com/rockwellautomation/legalnotices/overview.page?#tab4
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
127
Legal Notices
Warranty
This product is warranted in accordance with the product license. The product’s
performance may be affected by system configuration, the application being
performed, operator control, maintenance, and other related factors. Rockwell
Automation is not responsible for these intervening factors. The instructions in
this document do not cover all the details or variations in the equipment,
procedure, or process described, nor do they provide directions for meeting every
possible contingency during installation, operation, or maintenance. This
product’s implementation may vary among users.
This document is current as of the time of release of the product; however, the
accompanying software may have changed since the release. Rockwell Automation,
Inc. reserves the right to change any information contained in this document or
the software at any time without prior notice. It is your responsibility to obtain the
most current information available from Rockwell when installing or using this
product.
Environmental compliance
Rockwell Automation maintains current product environmental information on
its website at http://www.rockwellautomation.com/rockwellautomation/aboutus/sustainability-ethics/product-environmental-compliance.page
Contact Rockwell Automation
Customer Support Telephone — 1.440.646.3434
Online Support — http://www.rockwellautomation.com/support/
128
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
Index
.
.NET registry key 62
C
A
administrative Tools 31
allowable failures 56
Archiver
(Incremental) 52
event filters 55
service 118
automatic
restart control 63
B
Batch IDs
customize 58
Batch Server
cold boot 34
computer name 62
demo mode 31, 34
grace period 34
options 46
performance chart 99
warm all boot 34
warm boot 34
Batch Server Service
start 38
startup type 45
Batch Server Statistics
COM information 31
dialog box 35
Batch Service Manager
interface 32
BATCHHIS table
select 52
boot methods
cold boot 34
warm all boot 34
warm boot 34
command handshake timeout 66
communications timeout 56
cross invocation
default values 59
example 80
D
data server definition file (DSDF) 22
default
cross invocation values 59
hyperlink values 60
descriptors
cross invocation 59
hyperlink label 60
directory share 21
disable
Archiver service 52
DSDF 22
E
eProcedure
hyperlinks 60
event journal signatures
electronic batch records 56
Event Viewer 69
F
failure
handshake timeout 56
phase 56
watchdog timeout 56
H
hold propagation
setting 56
hyperlink
default values 60
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
129
Index
I
Incremental Archiver 52
U
M
User-Defined (End of Batch) 52
manual failover 64
Material Manager 61
Maximum Log File Size box 56
Minimum Disk Space box 56
O
Object Database Connectivity (ODBC) 46, 52
OLE for process control (OPC) 22
OPC groups 22
W
Windows Event Log
modify settings 73
Windows registry
.NET key 62
Windows services
Archiver 31
Batch Server 31
workgroup
configuring client 25
P
Period (msec) box 56
permissions 21
product policies 25
R
resource types
cross invocation 59
hyperlinks 60
S
security
Batch View 26
Server Options
Archiver (End of Batch) 52
Archiver (Incremental) 52
Archiver Event Filters 55
Batch Reporting tab 52
Batch Server tab 56
Cross Invocation tab 59
edit 46
redundant servers 49
Restart Control tab 49
Server Options dialog box 34
shared directory 21
130
Rockwell Automation Publication FactoryTalk eProcedure Administrator Guide - February 2017
Design Guide
FactoryTalk eProcedure Instruction File
Important User Information
Solid-state equipment has operational characteristics differing from those of electromechanical equipment. Safety Guidelines for the Application,
Installation, and Maintenance of Solid State Controls (publication SGI-1.1 available from your local Rockwell Automation sales office or online at
http://www.rockwellautomation.com/literature/) describes some important differences between solid-state equipment and hard-wired
electromechanical devices. Because of this difference, and also because of the wide variety of uses for solid-state equipment, all persons responsible for
applying this equipment must satisfy themselves that each intended application of this equipment is acceptable.
In no event will Rockwell Automation, Inc. be responsible or liable for indirect or consequential damages resulting from the use or application of this
equipment.
The examples and diagrams in this manual are included solely for illustrative purposes. Because of the many variables and requirements associated
with any particular installation, Rockwell Automation, Inc. cannot assume responsibility or liability for actual use based on the examples and
diagrams.
No patent liability is assumed by Rockwell Automation, Inc. with respect to use of information, circuits, equipment, or software described in this
manual.
Reproduction of the contents of this manual, in whole or in part, without written permission of Rockwell Automation, Inc., is prohibited.
Throughout this manual, when necessary, we use notes to make you aware of safety considerations.
WARNING: Identifies information about practices or circumstances that can cause an explosion in
a hazardous environment, which may lead to personal injury or death, property damage, or
economic loss.
ATTENTION: Identifies information about practices or circumstances that can lead to personal
injury or death, property damage, or economic loss. Attentions help you identify a hazard, avoid a
hazard, and recognize the consequence
SHOCK HAZARD: Labels may be on or inside the equipment, for example, a drive or motor, to
alert people that dangerous voltage may be present.
BURN HAZARD: Labels may be on or inside the equipment, for example, a drive or motor, to alert
people that surfaces may reach dangerous temperatures.
Important:
Identifies information that is critical for successful application and understanding of the product.
Allen-Bradley, Rockwell Software, and Rockwell Automation ControlLogix, eProcedure, FactoryTalk, RSBizWare, RSBizWare BatchHistorian, RSBizWare Historian, RSBizWare MaterialTrack, and RSLinx are
trademarks of Rockwell Automation, Inc.
Trademarks not belonging to Rockwell Automation are property of their respective companies.
Table of contents
Chapter 1
Introduction to
instruction files
Document organization .......................................................................................................5
Work with instruction files .................................................................................................5
Instruction file components ................................................................................................5
Operator instructions ...................................................................................................6
Batch-specific data.........................................................................................................6
Step verification signature ...........................................................................................7
Report data entry fields ................................................................................................7
Valid web content .........................................................................................................9
Chapter 2
Instruction files
Use Microsoft FrontPage to build instruction files..................................................... 11
Create a blank instruction file ................................................................................. 12
Add operator instructions ........................................................................................ 12
Include batch-specific data ....................................................................................... 13
Include a step verification signature template ...................................................... 14
Include report entry fields ........................................................................................ 15
Include report value confirmation .......................................................................... 16
Appendix A
Sample HTML code
Control step with operator instructions........................................................................ 19
Control step with report data .......................................................................................... 20
Control step with step verification ................................................................................. 21
Control step with confirmation ...................................................................................... 22
Control step with other web content............................................................................. 22
Insert a calendar control............................................................................................ 22
Insert an avi file ........................................................................................................... 24
Use VBScript in instruction files .................................................................................... 25
Appendix B
Archive dynamic
HTML elements
Legal Notices
Index
Archive dynamic HTML elements................................................................................. 27
Legal Notices ....................................................................................................................... 31
Index ..................................................................................................................................... 33
Rockwell Automation Publication FactoryTalk eProcedure Instruction File Design Guide - February 2017
3
Table of contents
4
Rockwell Automation Publication FactoryTalk eProcedure Instruction File Design Guide - February 2017
Chapter 1
Introduction to instruction files
This guide covers the building of instruction files for use in equipment database
creation and recipe development. This guide is intended for use as a reference by
the instruction file author.
Document
organization
Work with
instruction files
The following subjects are addressed:
•
Introducing instruction files
•
Using instruction files with FactoryTalk® eProcedure®
•
Building instruction files
•
HTML requirements for instruction file development
An instruction file is an HTML file that contains the control step(s) required to
manually execute a phase within FactoryTalk Batch. The instructions are
displayed within eProcedure’s web-based client during recipe execution.
Instruction files can include information such as operator instructions,
batch-specific information, data entry fields for report values, and standard
HTML components.
You need to create instruction files for each eProcedure or manual phase within
your equipment database. Each time you create an instance of the phase, you must
associate the instruction file with the new equipment module. Instruction files can
be created using any text editor or HTML editor. In this guide, Microsoft Word is
used to create the instruction file examples.
Instruction file
components
The fundamental element of an instruction file is the control step. Each
instruction file can contain multiple control steps. A control step must be
contained within an HTML form and the form must include a submit button.
The submit button is used to inform eProcedure when the control step is
complete. The control steps are executed sequentially in the order they are
encountered in the instruction file.
The following components can be used in a control step:
•
Operator instructions
•
Batch-specific data
•
Step verification signature
Rockwell Automation Publication FactoryTalk eProcedure Instruction File Design Guide - February 2017
5
Chapter 1
Introduction to instruction files
•
Report data entry fields
•
Valid web content
Operator instructions
With each control step, you can include as many lines of text as necessary to
describe the control step to the operator. You may find it easier to put your text in
tables, allowing you to see where the text is in relation to the submit button.
Batch-specific data
Each control step contains information specific to the batch currently running.
The eProcedure Server obtains batch-specific data at run-time by using the custom
tag <sop>, for example <sop>data{.attribute}</sop>. This tag tells the
eProcedure Server to replace the text between the tags with the appropriate
batch-specific data.
The following is a list of the batch-specific information you can include in your
control steps, including the required syntax:
Batch Data
<sop>BatchID</sop>
<sop>Cell</sop>
<sop>Unit</sop>
<sop>Phase</sop>
Parameter Data
<sop>parameter.Name</sop>
<sop>parameter.LowLowLowLimit</sop>
<sop>parameter.EU</sop>
<sop>parameter.LowLowLimit</sop>
<sop>parameter.High</sop>
<sop>parameter.LowLimit</sop>
<sop>parameter.Low</sop>
<sop>parameter.HighLimit</sop>
<sop>parameter.Type</sop>
<sop>parameter.HighHighLimit</sop>
<sop>parameter.Value</sop>
<sop>parameter.HighHighHighLimit</sop>
<sop>parameter.Default</sop>
(where parameter is the name of a phase parameter in the equipment database)
Report Data
<sop>report.Name</sop>
<sop>report.LowLowLowLimit</sop>
<sop>report.EU</sop>
<sop>report.HighLimit</sop>
<sop>report.Value</sop>
sop>report.HighHighLimit</sop>
<sop>report.LowLimit</sop>
<sop>report.HighHighHighLimit</sop>
<sop>report.LowLowLimit</sop>
<sop>report.Default</sop>
<sop>report.Type</sop>
(where report is the name of a phase report in the equipment database)
6
Rockwell Automation Publication FactoryTalk eProcedure Instruction File Design Guide - February 2017
Chapter 1
Introduction to instruction files
Step verification
signature
If a control step requires a verification signature before the operator is allowed to
continue processing, you can add step verification to the control step. You have
the option of requiring one to three sign-offs per verification signature. The
verification signature template is defined in the FactoryTalk Batch Equipment
Editor (see the FactoryTalk Batch Equipment Editor User Guide for more
information).
Important:
In earlier versions of eProcedure this feature used
<sop>VERIFY=GROUP1,GROUP2</sop>. In eProcedure version 7.00,
this changed to <sop>VERIFICATIONSIG=SignatureTemplate
</sop> as discussed in the following paragraph.
To specify a verification signature to be used for control step verification, enter:
<sop>VERIFICATIONSIG=SignatureTemplate</sop>
(where SignatureTemplate is the template name used for the verification
signature)
Report data entry
fields
Control steps can contain data entry fields that collect report data from the
operator. Data entry fields used to collect report data do not require the use of the
<sop> tag. Data entry fields are represented by a text box, text area, or list,
depending on the report data type. Text box controls and text area controls use
REAL, INT or STRING data types for reports, while drop-down box controls use
ENUMERATION data types for reports. You must set the HTML Name
property to match the report name so eProcedure knows which phase report to
associate with each data entry field.
REAL, INT or STRING Data Types
<INPUT TYPE="text" SIZE="20" NAME="report">
CONFIRM Data Types
You can configure a report parameter in an eProcedure instruction step to require
confirmation. The confirmation can require a comment or not, and can be
configured to trigger on the High/Low, High-High/Low-Low, or
High-High-High/Low-Low-Low limits (configured in the FactoryTalk Batch.
Rockwell Automation Publication FactoryTalk eProcedure Instruction File Design Guide - February 2017
7
Chapter 1
Introduction to instruction files
The available attributes are:
Attribute
Value
Description
Confirm
True/False
Determines if confirmation is required if a
report’s value is within the normal range.
Comment
True/False
Determines if a comment can be entered
with a confirmation if a report’s value is
within the normal range.
HLConfirm
True/False
Determines if confirmation is required if a
report’s value is outside the High or Low
limits but not outside the High High, High
High High, Low Low, or Low Low Low
limits.
HLComment
True/False
Determines if a comment can be entered
with a confirmation if a report’s value is
outside the High or Low limits but not
outside the High High, High High High,
Low Low, or Low Low Low limits.
HHLLConfirm
True/False
Determines if a confirmation is required if
a report’s value is outside the High High
or Low Low limits but not outside the High
High High or Low Low Low limits.
HHLLComment
True/False
Determines if a comment can be entered
with a confirmation if a report’s value is
outside the High High or Low Low limits
but not outside the High High High or Low
Low Low limits.
HHHLLLConfirm
True/False
Determines if a confirmation is required if
a report’s value is outside the High High
High or Low Low Low limits.
HHHLLLComment
True/False
Determines if a comment can be entered
with a confirmation if a report’s value is
outside the High High High or Low Low
Low limits.
Example:
The sample below contains an input for a report value; the report is configured to
require confirmation if the value is outside the High or Low limits, and allows the
operator to enter a comment.
<INPUT type=text NAME="report" HLConfirm=true HLComment=true>
(where report is the name of a phase report in the equipment database.)
ENUMERATION Data Types
<SELECT NAME="report" SIZE="1"></SELECT>
(where report is the name of a phase report in the equipment database.)
Tip:
8
It is recommended that a single instruction form includes no more than two
reports.
Rockwell Automation Publication FactoryTalk eProcedure Instruction File Design Guide - February 2017
Chapter 1
Introduction to instruction files
Valid web content
Controls steps can include any valid Web page components. The eProcedure
Server will ignore anything that does not meet the required naming conventions,
and your browser will interpret the component as it would in any other HTML
page. AVI files and calendar controls are two examples of valid Web page content.
(See the Control step with other web content topic for more information.)
See also
Control step with other web content on page 22
Rockwell Automation Publication FactoryTalk eProcedure Instruction File Design Guide - February 2017
9
Chapter 2
Instruction files
Instruction files must be created for each phase within your equipment database
and associated with the appropriate equipment modules within the FactoryTalk
Batch Equipment Editor.
You can use any text or HTML Editor to create instruction files. The instruction
files and examples included in this document use FrontPage® 2003 as the HTML
editor.
Tip:
Use Microsoft
FrontPage to build
instruction files
See Customizing eProcedure in the FactoryTalk eProcedure
Administrator Guide for information on customizing the eProcedure
display.
Microsoft FrontPage must be installed and set up correctly to enable the creation
of instruction files. Since you will be using forms for the eProcedure instruction
files, you must select Page Options from the Tools menu, then in the General
tab select Automatically enclose form fields within a form.
Rockwell Automation Publication FactoryTalk eProcedure Instruction File Design Guide - February 2017
11
Chapter 2
Instruction files
Create a blank
instruction file
The first step in building an instruction file is creating a blank instruction file.
1. Open Microsoft FrontPage. FrontPage opens to a new blank page.
2. From the Insert menu, select Form > Form. A new form is inserted on the
page with Submit and Reset buttons.
3. Click the Submit button and press Delete. Repeat for the Reset button,
leaving an empty form. The buttons are not needed as eProcedure inserts an
OK (submit) button at run time.
4. From the File menu, select Save. The Save As dialog box opens.
5. Navigate to the desired location, enter a file name in the File name box, and
then click Save. This file can be used as a starting point for all new
instruction files.
Add operator
instructions
You can add as many instruction lines as necessary in each form, and add as many
forms as required. The examples in this document use tables, but they are not
required.
1. Open or create a blank instruction file. (See the Create a blank instruction
file topic for more information.)
2. Add as many forms as needed for the instruction file.
3. Return to the first form in the document.
4. With the cursor in the left-hand column, enter instructions in the order in
which you want them performed. Add as many lines as necessary. For
example, you might enter: Prepare <sop>ADD_AMOUNT</sop> KG of
Egg.
5. Press OK to proceed.
12
Rockwell Automation Publication FactoryTalk eProcedure Instruction File Design Guide - February 2017
Chapter 2
Instruction files
6. Move to the next form and enter the required instructions. Repeat until all
instructions are added. The finished file will resemble this:
7. Save the file.
See also
Create a blank instruction file on page 12
Include batch-specific
data
You can add Batch data to your instructions. You must use the proper naming
conventions to allow the eProcedure Server to replace the tagged string with the
correct recipe data.
1. Open or create a blank instruction file. (See the Create a blank instruction
file topic for more information.)
2. Place the cursor within the instructions where you will display recipe data.
3. Using the correct naming conventions, enter the tagged data item.
Examples:
•
To display the batch ID to the operator at run-time, enter
<sop>BatchID</sop>.
•
To display the value of a parameter named AMOUNT, enter
<sop>AMOUNT.VALUE</sop>.
Rockwell Automation Publication FactoryTalk eProcedure Instruction File Design Guide - February 2017
13
Chapter 2
Instruction files
4. Save the file. The following example illustrates batch-specific data created in
FrontPage.
See also
Instruction File Components on page 5
Create a blank instruction file on page 12
Include a step
verification signature
template
You can require a step verification signature using a specific signature template for
a control step. You can add a step verification signature to any control step that
must be signed off before recipe execution continues. Signature templates are
defined in the FactoryTalk Batch Equipment Editor. The signature must be
complete before recipe execution continues.
1. Open or create a blank instruction file. (See the Create a blank instruction
file topic for more information.)
2. Place the cursor at the beginning of the first cell.
3. Using the correct naming conventions, enter the tagged data item.
Important:
In earlier versions of eProcedure this feature used
<sop>VERIFY=GROUP1,GROUP2</sop>. In eProcedure version
7.00, this changed to
<sop>VERIFICATIONSIG=SignatureTemplate</sop> as discussed
in the following paragraph.
Example:
<sop>VERIFICATIONSIG=SignatureTemplate</sop>
where SignatureTemplate is the name of the desired template.
See also
Create a blank instruction file on page 12
14
Rockwell Automation Publication FactoryTalk eProcedure Instruction File Design Guide - February 2017
Chapter 2
Instruction files
Include report entry
fields
You can add report entry fields to your instructions. You must use the proper
naming conventions to allow the eProcedure Server to store the correct data in the
batch record.
1. Open or create a blank instruction file. (See the Create a blank instruction
file topic for more information.)
2. Place the cursor within the instructions where you will display a report
entry field.
3. From the Insert menu, select Form > Textbox. A blank text box is added to
the instructions.
4. Double-click the text box. The Text Box Properties dialog box opens.
5. In the Name box, type the report parameter name defined in the
FactoryTalk Batch Equipment Editor. The following example uses the
<AMOUNT_ADDED> parameter.
6. Close the Text Box Properties dialog box. The following example
illustrates a text box in a form created in Microsoft FrontPage.
See also
Create a blank instruction file on page 12
Rockwell Automation Publication FactoryTalk eProcedure Instruction File Design Guide - February 2017
15
Chapter 2
Instruction files
Include report value
confirmation
While the verification method changed with RSBizWare eProcedure version 7.0,
you can still access a report value confirmation dialog box (Confirm Entry)
through the HTML code. By including the CONFIRM command in the HTML
code for the report entry control step, a Confirm Entry dialog box is generated
when the entered report value is outside the pre-determined limits. You can also
enable the optional comment field on the dialog box.
1. Place your cursor within an instruction file where you want the report entry
field (the Confirm and Comment data types must be associated with a
report parameter).
2. From the Insert menu, select Form >Textbox. A blank text box is added to
the instructions.
3. Double-click the text box. The Text Box Properties dialog box opens.
4. In the Name box, type the report parameter name used in the FactoryTalk
Batch Equipment Editor. The following example uses the
<AMOUNT_ADDED> parameter.
16
Rockwell Automation Publication FactoryTalk eProcedure Instruction File Design Guide - February 2017
Chapter 2
Instruction files
5. Click OK to close the Text Box Properties dialog box. The following
example illustrates a text box added to the form created in Microsoft
FrontPage.
6. Click the HTML tab at the bottom of the FrontPage window to display the
HTML code for the instructions.
7. Locate the line that corresponds with the text box just entered. Add the
code for the Confirm and/or Comment command at the end of the Report
name, before the closing bracket (>), as shown in the following example:
The example above uses the HLConfirm and HLComment parameters.
HLConfirm determines if confirmation is required when a report value is
outside the High or Low limits but not outside the High High, High High
High, Low Low, or Low Low Low limits. HLComment determines if a
comment can be entered with a confirmation when a report value is outside
the High or Low limits but not outside the High High, High High High,
Low Low, or Low Low Low limits.
Tip:
For a complete list of parameters used with the Confirm and Comment
data types, see the Control step with confirmation topic.
8. Save the file.
See also
Control Step with confirmation on page 22
Rockwell Automation Publication FactoryTalk eProcedure Instruction File Design Guide - February 2017
17
Chapter 2
18
Instruction files
Rockwell Automation Publication FactoryTalk eProcedure Instruction File Design Guide - February 2017
Appendix A
Sample HTML code
The following samples provide examples of the HTML code along with screen
shots of the code as it appears with the eProcedure Client.
The examples include controls steps with the following:
•
Operator instructions (see Control step with operator instructions.)
•
Operator instructions and Batch-specific data (see Control step with
report data.)
•
Report data entry fields of all data types (see Control step with step
verification.)
•
Non-eProcedure specific web content (see Control step with other web
content.)
See also
Control step with operator instructions on page 19
Control step with report data on page 20
Control step with step verification on page 21
Control step with other web content on page 22
Control step with
operator
instructions
<HTML>
<HEAD>
</HEAD>
<BODY LANG="EN-US" STYLE="tab-interval:.5in">
<FORM METHOD="Post"
ENCTYPE="application/x-www-form-urlencoded">
Execute viscosity test number <sop>TEST_ID</sop> on the
sample for batch <sop>BATCHID</sop> from <sop>CELL</sop>.
It will be necessary to conduct three individual tests. Refer
to the testing documentation for instructions.
</FORM>
</BODY>
</HTML>
Rockwell Automation Publication FactoryTalk eProcedure Instruction File Design Guide - February 2017
19
Appendix A
Sample HTML code
Control step with
report data
Report Data of Type Integer, Real, or String
<HTML>
<HEAD>
</HEAD>
<BODY LANG="EN-US" STYLE="tab-interval:.5in">
<FORM METHOD="Post"
ENCTYPE="application/x-www-form-urlencoded">
Enter the results from the three tests:
Player
Test1:
<INPUT TYPE=TEXT NAME="VISCOSITY1" SIZE="20"
MAXLENGTH="20"><sop>VISCOSITY1.EU</sop>
Player
Test2:
<INPUT TYPE=TEXT NAME="VISCOSITY2" SIZE="20"
MAXLENGTH="20"><sop>VISCOSITY2.EU</sop>
Player
Test3:
<INPUT TYPE=TEXT NAME="VISCOSITY3" SIZE="20"
MAXLENGTH="20"><sop>VISCOSITY3.EU</sop>
</FORM>
</BODY>
</HTML>
Report Data of Type Enumeration
<HTML>
<HEAD>
</HEAD>
<BODY LANG="EN-US" STYLE="tab-interval:.5in">
<FORM METHOD="Post"
ENCTYPE="application/x-www-form-urlencoded">
Enter the qualitative results of the tests: <SELECT
NAME="RESULTS" SIZE="1"></SELECT>
</FORM>
</BODY>
</HTML>
20
Rockwell Automation Publication FactoryTalk eProcedure Instruction File Design Guide - February 2017
Sample HTML code
Control step with
step verification
Appendix A
The following example uses a signature template called StepSig, which requires
one signature.
<HTML>
<HEAD>
</HEAD>
<BODY LANG="EN-US" STYLE="tab-interval:.5in">
<FORM METHOD="Post"
ENCTYPE="application/x-www-form-urlencoded">
Record final amount of Sugar added to batch in SP_MIXER1:
<INPUT TYPE="text" SIZE="20" NAME="ACTUAL_AMOUNT">KG
Press <b>OK</b> to continue.
Player
<sop>VerificationSig=StepSig</sop>
</FORM>
</BODY>
</HTML>
Rockwell Automation Publication FactoryTalk eProcedure Instruction File Design Guide - February 2017
21
Appendix A
Sample HTML code
Control step with
confirmation
The following example contains an input for a report value — the report is
configured to require confirmation if the value is outside the High or Low limits.
You can enter a comment, if desired.
<HTML>
<HEAD>
</HEAD>
<BODY LANG="EN-US" STYLE="tab-interval:.5in">
<FORM METHOD="Post"
ENCTYPE="application/x-www-form-urlencoded">
Enter a value for REPORT_1:
<INPUT TYPE="text" NAME="REPORT_1" HLConfirm="True"
HLComment="True">
</FORM>
</BODY>
</HTML>
Control step with
other web content
Insert a calendar
control
22
The instructions in this section were created with Microsoft FrontPage.
In the following example, a calendar is added to an instruction form. Tables
within the forms allow for easier placement of the calendar. The instruction file
will look similar to the following example:
Rockwell Automation Publication FactoryTalk eProcedure Instruction File Design Guide - February 2017
Appendix A
Sample HTML code
The HTML code for the previous example resembles the following:
(See the eProcedure Administrator Guide for information on using ActiveX
controls and scripting within your instruction files.)
Rockwell Automation Publication FactoryTalk eProcedure Instruction File Design Guide - February 2017
23
Appendix A
Sample HTML code
Insert an avi file
The following example shows a movie clip (.avi) file added to eProcedure
instruction forms.
The HTML code that inserts the .avi file into the instruction file resembles the
following:
24
Rockwell Automation Publication FactoryTalk eProcedure Instruction File Design Guide - February 2017
Appendix A
Sample HTML code
Use VBScript in
instruction files
If you want to use VBScript with <SOP> elements, the SOP parameters must be
included in a hidden span (labeled parameter1) that contains the <SOP>
element. At runtime the eProcedure Server replaces the <SOP> element with its
value and the VBScript accesses the value by referencing parameter1.
In the VBScript, insert the element <SOP>parameter1</SOP> where
parameter1 is a legal parameter for this phase:
<FORM>
<SPAN id="Parameter1
style=display:none><SOP>PARAMETER1</SOP></SPAN>
<SCRIPT language=vbscript>
msgbox document.all("Parameter1").innertext
</SCRIPT>
</FORM>
Rockwell Automation Publication FactoryTalk eProcedure Instruction File Design Guide - February 2017
25
Appendix B
Archive dynamic HTML elements
The following list defines HTML elements that can be contained in an instruction
step, can be dynamic and therefore must be disabled before archiving. (Source:
MSDN Library. See the MSDN library for documentation as to the types of
events that can be defined for each element.)
NAMES
DESCRIPTION
a
Designates the start or destination of a hypertext
link.
acronym
Indicates an acronym abbreviation.
address
Specifies information, such as address, signature,
and authorship, of the current document.
applet
Places executable content on the page.
area
Defines the shape, coordinates, and associated
URL of one hyperlink region within a client-side
image map.
b
Specifies that the text should be rendered in bold.
Base
Specifies an explicit URL used to resolve links and
references to external sources such as images and
style sheets.
baseFont
Sets a base font value to be used as the default
font when rendering text.
bdo
Allows authors to disable the bidirectional algorithm
for selected fragments of text.
bgSound
Enables an author to create pages with
background sounds or sound tracks.
big
Specifies that the enclosed text should be
displayed in a larger font than the current font.
blockQuote
Sets apart a quotation in text.
Body
Specifies the beginning and end of the document
body.
br
Inserts a line break.
button
Specifies a container for rich HTML that is
rendered as a button.
caption
Specifies a brief description for a table.
center
Centers subsequent text and images.
cite
Indicates a citation by rendering text in italic.
Code
Specifies a code sample.
Rockwell Automation Publication FactoryTalk eProcedure Instruction File Design Guide - February 2017
27
Appendix B
28
Archive dynamic HTML elements
NAMES
DESCRIPTION
col
Specifies column-based defaults for the table
properties.
colGroup
Specifies property defaults for a column or group of
columns in a table.
comment
Indicates a comment that is not displayed.
custom
Represents a user-defined element.
dd
Indicates the definition in a definition list. The
definition is usually indented in the definition list.
del
Indicates text that has been deleted from the
document.
dfn
Indicates the defining instance of a term.
dir
Denotes a directory list.
div
Specifies a container that renders HTML.
Dl
Denotes a definition list.
Dt
Indicates a definition term within a definition list.
em
Emphasizes text, usually by rendering it in italic.
embed
Allows documents of any type to be embedded.
fieldSet
Draws a box around the text and other elements
that the field set contains.
font
Specifies a new font, size, and color to be used for
rendering the enclosed text.
frame
Specifies an individual frame within a FRAMESET
element.
frameSet
Specifies a frameset, which is used to organize
multiple frames and nested framesets.
Head
Provides an unordered collection of information
about the document.
hn
Renders text in heading style.
hr
Draws a horizontal rule.
html
Identifies the document as containing HTML
elements.
i
Specifies that the text should be rendered in italic,
where available.
iframe
Creates inline floating frames.
img
Embeds an image or a video clip in the document.
Input
Creates a variety of form input controls.
Input
type=button
Creates a button control.
Input
type=check box
Creates a check box control.
Input type=file
Creates a file upload object with a text box and
Browse button.
input
type=image
Creates an image control that, when clicked,
causes the form to be immediately submitted.
Rockwell Automation Publication FactoryTalk eProcedure Instruction File Design Guide - February 2017
Appendix B
Archive dynamic HTML elements
NAMES
DESCRIPTION
input
type=password
Creates a single-line text entry control similar to the
INPUT type=text control, except that text is not
displayed as the user enters it.
input type=radio Creates a radio button control.
input type=reset Creates a button that, when clicked, resets the
form's controls to their initial values.
input
type=submit
Creates a button that, when clicked, submits the
form.
input type=text
Creates a single-line text entry control.
ins
Specifies text that has been inserted into the
document.
isIndex
Causes the browser to display a dialog window that
prompts the user for a single line of input.
kbd
Renders text in a fixed-width font.
label
Specifies a label for another element on the page.
legend
Inserts a caption into the box drawn by the fieldSet
object.
li
Denotes one item in a list.
link
Enables the current document to establish links to
external documents.
listing
Renders text in a fixed-width font.
map
Contains coordinate data for client-side image
maps.
marquee
Creates a scrolling text marquee.
menu
Creates an unordered list of items.
meta
Conveys hidden information about the document to
the server and the client.
noBR
Renders text without line breaks.
noFrames
Contains HTML for browsers that do not support
FRAMESET elements.
noScript
Specifies HTML to be displayed in browsers that do
not support scripting.
object
Inserts an object into the HTML page.
ol
Draws lines of text as a numbered list.
optGroup
Allows authors to group choices logically in a select
element.
option
Denotes one choice in a SELECT element.
p
Denotes a paragraph.
plainText
Renders text in a fixed-width font without
processing tags.
pre
Renders text in a fixed-width font.
q
Sets apart a quotation in text.
rt
Designates the ruby text for the RUBY element.
Rockwell Automation Publication FactoryTalk eProcedure Instruction File Design Guide - February 2017
29
Appendix B
30
Archive dynamic HTML elements
NAMES
DESCRIPTION
ruby
Designates an annotation or pronunciation guide to
be placed above or inline with a string of text.
s
Renders text in strike-through type.
samp
Specifies a code sample.
script
Specifies a script for the page that is interpreted by
a script engine.
select
Denotes a list box or drop-down list.
small
Specifies that the enclosed text should be
displayed in a smaller font.
span
Specifies an inline text container.
strike
Renders text in strike-through type.
strong
Renders text in bold.
style
Specifies a style sheet for the page.
sub
Specifies that the enclosed text should be
displayed in subscript, using a smaller font than the
current font.
sup
Specifies that the enclosed text should be
displayed in superscript, using a smaller font than
the current font.
table
Specifies that the contained content is organized
into a table with rows and columns.
tBody
Designates rows as the body of the table.
td
Specifies a cell in a table.
textArea
Specifies a multiline text input control.
tFoot
Designates rows as the table's footer.
th
Specifies a header column. Header columns are
centered within the cell and are bold.
tHead
Designates rows as the table's header.
title
Contains the title of the document.
tr
Specifies a row in a table.
tt
Renders text in a fixed-width font.
u
Renders text that is underlined.
ul
Draws lines of text as a bulleted list.
var
Defines a programming variable. Typically renders
in an italic font style.
xmp
Renders text used for examples in a fixed-width
font.
Rockwell Automation Publication FactoryTalk eProcedure Instruction File Design Guide - February 2017
Legal Notices
Legal Notices
Copyright notice
© 2017 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.
End User License Agreement (EULA)
You can view the Rockwell Automation End-User License Agreement ("EULA")
by opening the License.rtf file located in your product's install folder on your hard
drive.
Trademark Notices
Allen-Bradley, CompactLogix, ControlLogix, Connected Components
Workbench, eProcedure, FactoryTalk, GuardLogix, GuardPLC, Micro800,
MicroLogix, MobileView, MobileView Guard, PanelBuilder, PanelView,
PhaseManager, PlantLink, PlantPAx, PLC-2, PLC-3, PLC-5, PowerMonitor,
RSBizWare, RSBizWare BatchHistorian, RSBizWare Historian, RSBizWare
MaterialTrack, RSLinx, Rockwell Automation, Rockwell Software, SLC,
SoftLogix, Studio 5000, and XMare trademarks of Rockwell Automation, Inc.
Any Rockwell Automation software or hardware not mentioned here is also a
trademark, registered or otherwise, of Rockwell Automation, Inc.
For a complete list of products and their respective trademarks, go to:
http://www.rockwellautomation.com/rockwellautomation/legal-notices/overvie
w.page?#tab4
Warranty
This product is warranted in accordance with the product license. The product’s
performance may be affected by system configuration, the application being
performed, operator control, maintenance, and other related factors. Rockwell
Automation is not responsible for these intervening factors. The instructions in
this document do not cover all the details or variations in the equipment,
Rockwell Automation Publication FactoryTalk eProcedure Instruction File Design Guide - February 2017
31
Legal Notices
procedure, or process described, nor do they provide directions for meeting every
possible contingency during installation, operation, or maintenance. This
product’s implementation may vary among users.
This document is current as of the time of release of the product; however, the
accompanying software may have changed since the release. Rockwell Automation,
Inc. reserves the right to change any information contained in this document or
the software at any time without prior notice. It is your responsibility to obtain the
most current information available from Rockwell when installing or using this
product.
Environmental compliance
Rockwell Automation maintains current product environmental information on
its website at
http://www.rockwellautomation.com/rockwellautomation/about-us/sustainabili
ty-ethics/product-environmental-compliance.page
Contact Rockwell Automation
Customer Support Telephone — 1.440.646.3434
Online Support — http://www.rockwellautomation.com/support/
32
Rockwell Automation Publication FactoryTalk eProcedure Instruction File Design Guide - February 2017
Index
control step with report data 20
control step with verification 21
A
archiving
dynamic HTML 27
AVI file control in instruction files 23
B
batch
data 6
batch-specific data 6, 13
C
calendar control in instruction files 22
confirm report values 16
control step 5
D
data type
confirm 7
enumeration 7
INT 7
real 7
string 7
document organization 5
dynamic HTML
archiving 27
I
instruction files
adding valid web content 22
AVI file 23
calendar controls 22
components 5
batch-specific data 6
operator instructions 6
create in FrontPage 11
definition of 5
electronic signature template 7
operator instructions 12, 19
recipe data 13, 20
report entry fields 15, 20
step verification signature template 14
M
Microsoft FrontPage
operator instructions 12
recipe data 13
report entry fields 15
step verification signature 14
N
E
naming conventions
required syntax 6
electronic signatures
template 7
equipment database 5
O
operator instructions 6
F
FrontPage
create instruction files 11
P
parameter data 6
H
R
HTML code examples
control step with confirmation 22
control step with operator instructions 19
control step with other web content 22
report data 6
report data entry fields 7
required syntax 6
Rockwell Automation Publication FactoryTalk eProcedure Instruction File Design Guide - February 2017
33
Index
S
signature template 14
submit button 5
V
valid web content 8, 22, 23
34
Rockwell Automation Publication FactoryTalk eProcedure Instruction File Design Guide - February 2017
Rockwell Automation support
Rockwell Automation provides technical information on the web to assist you in using its products.
At http://www.rockwellautomation.com/support you can find technical and application notes, sample code, and links to software service packs. You
can also visit our Support Center at https://rockwellautomation.custhelp.com for software updates, support chats and forums, technical
information, FAQs, and to sign up for product notification updates.
In addition, we offer multiple support programs for installation, configuration, and troubleshooting. For more information, contact your local
distributor or Rockwell Automation representative, or visit http://www.rockwellautomation.com/services/online-phone.
Installation assistance
If you experience a problem within the first 24 hours of installation, review the information that is contained in this manual. You can contact
Customer Support for initial help in getting your product up and running.
United States or Canada
1.440.646.3434
Outside United States or Canada
Use the Worldwide Locator available at http://www.rockwellautomation.com/locations,
or contact your local Rockwell Automation representative.
New product satisfaction return
Rockwell Automation tests all of its products to ensure that they are fully operational when shipped from the manufacturing facility. However, if
your product is not functioning and needs to be returned, follow these procedures.
United States
Contact your distributor. You must provide a Customer Support case number (call the
phone number above to obtain one) to your distributor to complete the return process.
Outside United States
Please contact your local Rockwell Automation representative for the return procedure.
Documentation feedback
Your comments will help us serve your documentation needs better. If you have any suggestions on how to improve this document, complete the
feedback form, publication RA-DU002.
Publication Number: BWEPRO-UM011D-EN-P - February 2017
Supersedes Publication Number BWEPRO-UM011C-EN-P
Copyright © 2017 Rockwell Automation Technologies, Inc. All rights reserved. Printed in the U.S.A.
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertisement