Professional Documents
Culture Documents
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
Chapter 2
Appendix A
Appendix B
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
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.
Work with An instruction file is an HTML file that contains the control step(s) required to
instruction files 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 The fundamental element of an instruction file is the control step. Each
instruction file can contain multiple control steps. A control step must be
components 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.
• 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
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>
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>
6 Rockwell Automation Publication FactoryTalk eProcedure Instruction File Design Guide - February 2017
Introduction to instruction files Chapter 1
Step verification If a control step requires a verification signature before the operator is allowed to
signature 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).
<sop>VERIFICATIONSIG=SignatureTemplate</sop>
Report data entry Control steps can contain data entry fields that collect report data from the
fields 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.
Rockwell Automation Publication FactoryTalk eProcedure Instruction File Design Guide - February 2017 7
Chapter 1 Introduction to instruction files
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.
Tip: It is recommended that a single instruction form includes no more than two
reports.
8 Rockwell Automation Publication FactoryTalk eProcedure Instruction File Design Guide - February 2017
Introduction to instruction files Chapter 1
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
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.
Use Microsoft 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
FrontPage to build files, you must select Page Options from the Tools menu, then in the General
instruction files 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 The first step in building an instruction file is creating a blank instruction file.
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 You can add as many instruction lines as necessary in each form, and add as many
instructions 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.)
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
Instruction files Chapter 2
6. Move to the next form and enter the required instructions. Repeat until all
instructions are added. The finished file will resemble this:
See also
Include batch-specific You can add Batch data to your instructions. You must use the proper naming
data 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:
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
Include a step You can require a step verification signature using a specific signature template for
verification signature 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
template 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.)
3. Using the correct naming conventions, enter the tagged data item.
Example:
<sop>VERIFICATIONSIG=SignatureTemplate</sop>
where SignatureTemplate is the name of the desired template.
See also
14 Rockwell Automation Publication FactoryTalk eProcedure Instruction File Design Guide - February 2017
Instruction files Chapter 2
Include report entry You can add report entry fields to your instructions. You must use the proper
fields 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
Rockwell Automation Publication FactoryTalk eProcedure Instruction File Design Guide - February 2017 15
Chapter 2 Instruction files
Include report value While the verification method changed with RSBizWare eProcedure version 7.0,
confirmation 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
Instruction files Chapter 2
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:
See also
Rockwell Automation Publication FactoryTalk eProcedure Instruction File Design Guide - February 2017 17
Chapter 2 Instruction files
18 Rockwell Automation Publication FactoryTalk eProcedure Instruction File Design Guide - February 2017
Appendix A
The following samples provide examples of the HTML code along with screen
shots of the code as it appears with the eProcedure Client.
See also
Rockwell Automation Publication FactoryTalk eProcedure Instruction File Design Guide - February 2017 19
Appendix A Sample HTML code
<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>
<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 Appendix A
Control step with The following example uses a signature template called StepSig, which requires
one signature.
step verification
<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 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.
confirmation 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 The instructions in this section were created with Microsoft FrontPage.
other web content
Insert a calendar In the following example, a calendar is added to an instruction form. Tables
control within the forms allow for easier placement of the calendar. The instruction file
will look similar to the following example:
22 Rockwell Automation Publication FactoryTalk eProcedure Instruction File Design Guide - February 2017
Sample HTML code Appendix A
The HTML code for the previous example resembles the following:
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
Sample HTML code Appendix A
Use VBScript in 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>
instruction files element. At runtime the eProcedure Server replaces the <SOP> element with its
value and the VBScript accesses the value by referencing parameter1.
<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
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.
Rockwell Automation Publication FactoryTalk eProcedure Instruction File Design Guide - February 2017 27
Appendix B 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.
28 Rockwell Automation Publication FactoryTalk eProcedure Instruction File Design Guide - February 2017
Archive dynamic HTML elements Appendix B
NAMES DESCRIPTION
input Creates a single-line text entry control similar to the
type=password INPUT type=text control, except that text is not
displayed as the user enters it.
input type=radio Creates a radio button control.
Rockwell Automation Publication FactoryTalk eProcedure Instruction File Design Guide - February 2017 29
Appendix B 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.
30 Rockwell Automation Publication FactoryTalk eProcedure Instruction File Design Guide - February 2017
Legal Notices
You can view the Rockwell Automation End-User License Agreement ("EULA")
by opening the License.rtf file located in your product's install folder on your hard
drive.
Trademark Notices
Warranty
This product is warranted in accordance with the product license. The product’s
performance may be affected by system configuration, the application being
performed, operator control, maintenance, and other related factors. Rockwell
Automation is not responsible for these intervening factors. The instructions in
this document do not cover all the details or variations in the equipment,
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
32 Rockwell Automation Publication FactoryTalk eProcedure Instruction File Design Guide - February 2017
Index
control step with report data 20
A control step with verification 21
archiving
dynamic HTML 27
I
AVI file control in instruction files 23
instruction files
adding valid web content 22
B AVI file 23
batch calendar controls 22
data 6 components 5
batch-specific data 6, 13 batch-specific data 6
operator instructions 6
create in FrontPage 11
C definition of 5
calendar control in instruction files 22 electronic signature template 7
confirm report values 16 operator instructions 12, 19
control step 5 recipe data 13, 20
report entry fields 15, 20
step verification signature template 14
D
data type
confirm 7
M
enumeration 7 Microsoft FrontPage
INT 7 operator instructions 12
real 7 recipe data 13
string 7 report entry fields 15
document organization 5 step verification signature 14
dynamic HTML
archiving 27
N
naming conventions
E required syntax 6
electronic signatures
template 7
O
equipment database 5
operator instructions 6
F
P
FrontPage
create instruction files 11 parameter data 6
H R
HTML code examples report data 6
control step with confirmation 22 report data entry fields 7
control step with operator instructions 19 required syntax 6
control step with other web content 22
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 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.
Copyright © 2017 Rockwell Automation Technologies, Inc. All rights reserved. Printed in the U.S.A.