Rockwell Automation Operator Prompt Reference Manual

Reference Manual

Rockwell Automation Library of Process Objects:

Operator Prompt (P_Prompt)

Version 3.5


	IMPORTANT	This manual applies to the Rockwell Automation Library of Process Objects version 3.5 or earlier.
		For Rockwell Automation Library of Process Objects version 5.0, see
		• PROCES-RM200
		For Rockwell Automation Library of Process Objects version 4.0 or later, use the following manuals:
		• PROCES-RM013 contains logic instructions
		• PROCES-RM014 contains display elements

Important User Information

Read this document and the documents listed in the additional resources section about installation, configuration, and operation of this equipment before you install, configure, operate, or maintain this product. Users are required to familiarize themselves with installation and wiring instructions in addition to requirements of all applicable codes, laws, and standards.

Activities including installation, adjustments, putting into service, use, assembly, disassembly, and maintenance are required to be carried out by suitably trained personnel in accordance with applicable code of practice.

If this equipment is used in a manner not specified by the manufacturer, the protection provided by the equipment may be impaired.

In no event will Rockwell Automation, Inc. be responsible or liable for indirect or consequential damages resulting from the use or application of this equipment.

The examples and diagrams in this manual are included solely for illustrative purposes. Because of the many variables and requirements associated with any particular installation, Rockwell Automation, Inc. cannot assume responsibility or liability for actual use based on the examples and diagrams.

No patent liability is assumed by Rockwell Automation, Inc. with respect to use of information, circuits, equipment, or software described in this manual.

Reproduction of the contents of this manual, in whole or in part, without written permission of Rockwell Automation, Inc., is prohibited.

Throughout this manual, when necessary, we use notes to make you aware of safety considerations.

WARNING: Identifies information about practices or circumstances that can cause an explosion in a hazardous environment, which may lead to personal injury or death, property damage, or economic loss.

ATTENTION: Identifies information about practices or circumstances that can lead to personal injury or death, property damage, or economic loss. Attentions help you identify a hazard, avoid a hazard, and recognize the consequence.

IMPORTANT Identifies information that is critical for successful application and understanding of the product.

Labels may also be on or inside the equipment to provide specific precautions.

SHOCK HAZARD: Labels may be on or inside the equipment, for example, a drive or motor, to alert people that dangerous voltage may be present.

BURN HAZARD: Labels may be on or inside the equipment, for example, a drive or motor, to alert people that surfaces may reach dangerous temperatures.

ARC FLASH HAZARD: Labels may be on or inside the equipment, for example, a motor control center, to alert people to potential Arc Flash. Arc Flash will cause severe injury or death. Wear proper Personal Protective Equipment (PPE). Follow ALL Regulatory requirements for safe work practices and for Personal Protective Equipment (PPE).

Allen-Bradley, Rockwell Software, Rockwell Automation, RSLogix, Logix5000, FactoryTalk, PlantPAx, and ControlLogix are trademarks of Rockwell Automation, Inc.

Trademarks not belonging to Rockwell Automation are property of their respective companies.

		Table of Contents
Preface	Software Compatibility and Content Revision. . . . . . . .	. . . . . . . . . . . . . . . . 5
	Additional Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	. . . . . . . . . . . . . . . 6
Operator Prompt (P_Prompt)	Guidelines. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	. . . . . . . . . . . . . . . 8
	Functional Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	. . . . . . . . . . . . . . . 9
	Prompt Demonstrations . . . . . . . . . . . . . . . . . . . . . . . . .	. . . . . . . . . . . . . 10
	Programming Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	. . . . . . . . . . . . . 20
	Configure a Standalone Prompt . . . . . . . . . . . . . . . . . .	. . . . . . . . . . . . . 20
	Configure the Prompt with the Sequencer Object. .	. . . . . . . . . . . . . 23
	Display Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	. . . . . . . . . . . . . 27
	Input Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	. . . . . . . . . . . . . 29
	Selection Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	. . . . . . . . . . . . . 30
	Response Prompts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	. . . . . . . . . . . . . 31
	Sequencer Branching Configuration . . . . . . . . . . . . . .	. . . . . . . . . . . . . 32
	Required Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	. . . . . . . . . . . . . 33
	Controller File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	. . . . . . . . . . . . . 33
	Visualization Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	. . . . . . . . . . . . . 33
	Controller Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	. . . . . . . . . . . . . 35
	Prompt InOut Structure . . . . . . . . . . . . . . . . . . . . . . . . .	. . . . . . . . . . . . . 35
	Prompt Input Structure. . . . . . . . . . . . . . . . . . . . . . . . . .	. . . . . . . . . . . . . 35
	Prompt Output Structure . . . . . . . . . . . . . . . . . . . . . . . .	. . . . . . . . . . . . . 36
	Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	. . . . . . . . . . . . . 37
	Display Elements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	. . . . . . . . . . . . . 37
	Status/Quality/Threshold Indicators . . . . . . . . . . . . .	. . . . . . . . . . . . . 37
	Using Display Elements. . . . . . . . . . . . . . . . . . . . . . . . . .	. . . . . . . . . . . . . 38
	Faceplates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	. . . . . . . . . . . . . 40
	P_Prompt Configuration . . . . . . . . . . . . . . . . . . . . . . . .	. . . . . . . . . . . . . 40
	P_Prompt Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	. . . . . . . . . . . . . 44
	P_Prompt Selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . .	. . . . . . . . . . . . . 45

Rockwell Automation Publication SYSLIB-RM046C-EN-P - January 2016

Table of Contents

Notes:

4	Rockwell Automation Publication SYSLIB-RM046C-EN-P - January 2016

Preface

This manual contains new and updated information. Changes throughout this revision are marked by change bars, as shown to the right of this paragraph.

Software Compatibility and

Content Revision

Table 1 - Summary of Changes

Topic	Page

Updated version in rung import file from 3_1 to 3_5	33

Split visualization files table by type and reordered to align with installation requirements	33

For the latest compatible software information and to download the Rockwell Automation® Library of Process Objects, see the Product Compatibility and Download Center at http://www.rockwellautomation.com/rockwellautomation/support/pcdc.page.

For general library considerations, see Rockwell Automation Library of Process Objects, publication PROCES-RM002.

Rockwell Automation Publication SYSLIB-RM046C-EN-P - January 2016

Preface

Additional Resources

These documents contain additional information concerning related products from Rockwell Automation.

Resource	Description

PlantPAx® Distributed Control System Selection Guide,	Provides information to assist with equipment
publication PROCES-SG001	procurement for your PlantPAx system.

PlantPAx Distributed Control System Reference Manual,	Provides characterized recommendations for
publication PROCES-RM001	implementing your PlantPAx system.

FactoryTalk® View Machine Edition User Manual,	Provides details on how to use this software package for
publication VIEWME-UM004	creating an automation application.

FactoryTalk View Site Edition User Manual,	Provides details on how to use this software package for
publication VIEWSE-UM006	developing and running human-machine interface (HMI)
	applications.

Logix5000™ Controllers Add-On Instructions	Provides information for designing, configuring, and
Programming Manual, publication 1756-PM010	programming Add-On Instructions.

For general library considerations, see Rockwell	Details how to monitor an input condition to raise an
Automation Library of Process Objects,	alarm. Information includes acknowledging, resetting,
publication PROCES-RM002	inhibiting, and disabling an alarm. Generally the P_Alarm
	faceplate is accessible from the Alarms tab.

Rockwell Automation Sequencer Object Reference	Provides details on how to configure a sequence by using
Manual, publication PROCES-RM006	the Sequencer Object.

You can view or download publications at http:/www.rockwellautomation.com/literature/. To order paper copies of technical documentation, contact your local Allen-Bradley distributor or Rockwell Automation sales representative.

6	Rockwell Automation Publication SYSLIB-RM046C-EN-P - January 2016

Operator Prompt (P_Prompt)

The P_Prompt (Operator Prompt) Add-On Instruction is a universal mechanism for operator interaction that can be used within a control scheme. The instruction presents an operator with configurable message or data fields and accepts operator response data and confirmation.

Add-On Instruction

Faceplate

Global Object

Rockwell Automation Publication SYSLIB-RM046C-EN-P - January 2016

Operator Prompt (P_Prompt)

Guidelines

The configuration data for a set of prompts are stored in an array of user-defined types (UDTs). Each configured prompt instance is a member of the Prompts array. By referencing different members of the prompt configuration array, the same P_Prompt instruction can be used to access multiple user-prompt combinations, one at a time.

A single prompt can include the following:

•An 82-character message

•Up to four numeric value displays

•Up to four numeric value entries

•Choose one choice among 2…4 options

•Up to four text responses

The RespData tag at the bottom of the P_Prompt function block lets you define where to store operator responses. This tag stores any operator response as a string in the application.

8	Rockwell Automation Publication SYSLIB-RM046C-EN-P - January 2016

Operator Prompt (P_Prompt)

Functional Description

Use a prompt to request input from an operator. The input can be any of the following:

•Acknowledging the prompt

•Viewing and confirming data

•Making a selection

•Entering numeric data

•Entering text data

Do not use a prompt in place of an alarm or an alert:

•An alarm, per ANSI/ISA-18.2-2009, is used to notify an operator of an abnormal situation that requires a response

•An alert is used to notify an operator of an abnormal situation that does not require a response

•A prompt requires a response, but does not advise of an abnormal situation

	Normal Operation	Abnormal Situation

Operator Response Not Required	Normal values and status	Alert

Operator Response Required	Prompt (P_Prompt)	Alarm (P_Alarm)

Rockwell Automation Publication SYSLIB-RM046C-EN-P - January 2016

Operator Prompt (P_Prompt)

Prompt Demonstrations

There are two separate demonstrations that show how you can use the prompt functionality:

•Standalone prompt

•Sequencer prompt faceplates (see page 13)

Standalone Prompt

In its simplest form, the P_Prompt instruction provides operator interaction and can be invoked from a number of users. This example shows how to program and configure the P_Prompt instruction to solicit an operator comment.

The example below shows the logic for the Prompt instruction to continually reset to provide for more operator entries.

The Inp_Req is set to '1' to buffer the prompt configuration and trigger the

prompt. This causes the prompt button on the FactoryTalk View display to be active.

10	Rockwell Automation Publication SYSLIB-RM046C-EN-P - January 2016

Operator Prompt (P_Prompt)

Click the prompt button to access the prompt faceplate shown below to let the operator enter a comment in the text box.

The Boolean output (Out_Cfm) remains low (0) until the operator clicks the Acknowledge button (green check mark circled below) on the prompt faceplate in the FactoryTalk View client.

Clicking this button on the faceplate causes the boolean output (Out_Cfm) to transition to a one (1).

The function block logic then inverts the Boolean value and feeds it back to the Inp_Req input. When this input goes to zero (0), it causes the output

(Out_Cfm) to be reset to zero (0), which reasserts the input again and retriggers the instruction.

Rockwell Automation Publication SYSLIB-RM046C-EN-P - January 2016

Operator Prompt (P_Prompt)

The standalone prompt example is achieved by setting the following values in the configuration array element zero [0].

The desired configuration can be moved into the configuration array from other Logix entities or populated from a P_Prompt configuration display. The P_Prompt configuration display can be called from the global object file (RA-UI) Prompt Objects.ggfx.

For additional information, see the following:

•Standalone programming basics, page 20

•Tag configuration options, page 27

12	Rockwell Automation Publication SYSLIB-RM046C-EN-P - January 2016

Operator Prompt (P_Prompt)

Sequencer Prompt Faceplates

This section illustrates basic prompt functionality by using the Sequencer Object (P_Seq) instruction and faceplates.

IMPORTANT This demonstration uses the Sequencer’s Run Time Detail faceplate as an example only. You can use the prompt with other tasks and processing tools.

1.After placing the Sequencer’s display element into your project, click the object.

Our example is Seq Prompt Scaling.

Operator Attention Required Breadcrumb

The Operator tab for the P_Seq instruction appears with buttons, including the Prompt (circled below).

Prompt

Access to Detail Faceplate

These same buttons also are available on the Run Time Detail faceplate that visually arranges the progress of the steps and prompts.

Rockwell Automation Publication SYSLIB-RM046C-EN-P - January 2016

Operator Prompt (P_Prompt)

2.Click the magnifying glass button to access the Run Time Detail faceplate.

Prompt Button

Prompts

Sequence Steps

IMPORTANT The following faceplates show different types of prompts that can be configured for a sequence. Our example shows the prompts in close succession merely as a teaching tool and likely is not the case for your sequence.

See the Sequencer Object Reference Manual, publication PROCES-RM006, for how to configure a sequence by using the Sequencer Object.

14	Rockwell Automation Publication SYSLIB-RM046C-EN-P - January 2016

Operator Prompt (P_Prompt)

3. Click the Start commandbutton.

Prompt Example 1

Column turns green to show the current step in progress.

Prompt icon appears to notify the operator that some type of interaction is necessary.

4.Click the Prompt button when it appears during a step.

You also can click the Prompt button when it is active on the Sequencer’s Run Time Detail faceplate or the Operator tab.

A Prompt window appears to tell the operator what action is necessary.

5.Click to acknowledge the prompt.

The sequence continues until the next configured prompt occurs.

Rockwell Automation Publication SYSLIB-RM046C-EN-P - January 2016

+ 33 hidden pages