Rockwell Automation Flowmeter Dosing User Manual

Reference Manual

Rockwell Automation Library of Process Objects: Flowmeter

Dosing (P_DoseFM)

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, and Rockwell Automation are trademarks of Rockwell Automation, Inc. Trademarks not belonging to Rockwell Automation are property of their respective companies.

Table of Contents

Preface

Flowmeter Dosing (P_DoseFM)

Software Compatibility and Content Revision. . . . . . . . . . . . . . . . . . . . 5

Additional Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Functional Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Required Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Controller File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Visualization Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Controller Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Flowmeter Dosing Input Structure. . . . . . . . . . . . . . . . . . . . . . . . . . 13

Flowmeter Dosing Output Structure . . . . . . . . . . . . . . . . . . . . . . . . 19

Flowmeter Dosing Local Configuration Tags . . . . . . . . . . . . . . . . 23

Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Alarms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Simulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Programming Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Display Elements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Graphic Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Status/Quality Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

Mode Indicators. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Alarm Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Maintenance Bypass Indicator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Using Display Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Quick Display. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Faceplate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Operator Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Maintenance Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Engineering Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Diagnostics Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

Trends Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

Alarms Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

Flowmeter Dosing Faceplate Help . . . . . . . . . . . . . . . . . . . . . . . . . . 58

Rockwell Automation Publication SYSLIB-RM020G-EN-E - February 2017

3

Table of Contents

Notes:

4	Rockwell Automation Publication SYSLIB-RM020G-EN-E - February 2017

Preface

Software Compatibility and

Content Revision

Table 1 - Summary of Changes

Topic	Page
Visualization Files: Global Objects (.ggfx) - Process Diagnostic Objects	12

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-RM020G-EN-E - February 2017

5

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.
Rockwell Automation Library of Process Objects,	Provides general considerations for the PlantPAx system
publication PROCES-RM002	library of process objects.
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 that can involve multiple users and servers,
	distributed over a network.
Logix5000™ Controllers Add-On Instructions	Provides information for designing, configuring, and
Programming Manual, publication 1756-PM010	programming Add-On Instructions.
Rockwell Automation Library of Process Objects: Common	Details how to monitor an input condition to raise an
Alarm Block (P_Alarm) Reference Manual, publication	alarm. Information includes acknowledging, resetting,
SYSLIB-RM002	inhibiting, and disabling an alarm. Generally the P_Alarm
	faceplate is accessible from the Alarms tab.
Rockwell Automation Library of Process Objects: Common	Explains how to choose the Mode (owner) of an
Mode Block (P_Mode) Reference Manual, publication	instruction or control strategy. The Mode instruction is
SYSLIB-RM005	usually embedded within other instructions to extend
	their functionality. It is possible to use a standalone Mode
	instruction to enhance a program where modes are
	wanted.

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-RM020G-EN-E - February 2017

Flowmeter Dosing (P_DoseFM)

Guidelines

The P_DoseFM (Flowmeter Dosing) Add-On Instruction controls an ingredient addition that uses a flowmeter to measure the quantity of ingredient added. The flowmeter can be an analog flowmeter (signal proportional to flow), a pulse generating flowmeter (pulse count proportional to quantity delivered), or a digital flowmeter providing flow rate or quantity (totalized flow) information.

Global Objects

Faceplate

Add-On Instruction

Use this instruction in these situations:

•You want to control basic dosing (ingredient addition) with basic features, such as bulk/dribble rate selection, preact, automatic preact adjustment, and the ability to start, pause, and resume flow.

•You are measuring the quantity of ingredient added by using a flowmeter. The flowmeter can provide an analog flow rate, an analog quantity (total), or a pulse count with rollover. This instruction is designed to work well with high-speed counting input cards, such as the 1756-HSC (High-Speed Counter) module or the 1756-CFM (Configurable Flowmeter) module.

Rockwell Automation Publication SYSLIB-RM020G-EN-E - February 2017

7

Flowmeter Dosing (P_DoseFM)

Do not use this instruction in these situations:

•You are transferring material by using a weigh scale to measure the quantity of material before and after transfer. Use the P_DoseWS (Dosing with

Weigh Scale) instruction instead.

•You need to control precision blending. This instruction excludes capability for controlled-rate addition, such as ratio control, digital blending, or precision blending. Contact your Rockwell Automation representative for a blending solution.

•You only need a totalizer (integrator). Use the built-in TOT instruction instead.

You could need additional logic in these situations:

•You need more complicated sequencing, including special actions when restarting, aborting, or holding an addition. This sequencing is a good candidate for an equipment phase. Equipment phase logic can drive the P_DoseFM instruction by using its Program mode commands and settings.

•The equipment requires complicated start-up and shutdown logic. You can provide this logic separately and use the P_DoseFM outputs to trigger the startup and shutdown of ingredient delivery.

8	Rockwell Automation Publication SYSLIB-RM020G-EN-E - February 2017

Flowmeter Dosing (P_DoseFM)

Functional Description

A typical sequence of operator commands, settings, and subsequent instruction actions by using the P_DoseFM instruction to perform ingredient dosing in operator mode is depicted in the following diagram.

Rockwell Automation Publication SYSLIB-RM020G-EN-E - February 2017

9

Flowmeter Dosing (P_DoseFM)

The primary operations of the P_DoseFM instruction include the following:

•Provides inputs for rate (flow rate or quantity per time) and quantity (total or pulse count).

•Provides the ability to use a pulse count as the Quantity PV, with configurable rollover count.

•Provides the ability to totalize the flow rate PV to determine the quantity delivered when the flowmeter provides a rate signal but no quantity.

•Provides the ability to calculate the flow rate given the quantity by differentiating with respect to time when the meter provides a total or pulse count but no rate. If the rate PV is calculated from an input quantity, the P_DoseFM instruction uses a first-order (lag) filter on the calculated rate PV signal to reduce the impact of jitter, scan time, quantization error, or input signal noise.

•Provides a low rate cutoff function, used to ignore flow rate values near zero to deal with noise or zero calibration error in the rate signal.

•Provides the ability to use a flowmeter with built-in totalizer. Forwards the totalizer clear command to the flowmeter and checks that the flowmeter's total was reset. Once the total is cleared, the instruction checks for unrequested flow; that is, an increase in the delivered total before flow is actually started, and raises a zero fault if such flow occurs.

•Provides outputs to control associated equipment (pumps, valves, and so forth) to start and stop flow. The operator or the program could start the ingredient addition, then pause, and resume it if needed.

•Monitors the status of controlled equipment (pumps, valves, and so forth).

Flow is stopped and an alarm is raised on an equipment fault or if the equipment fails to respond as commanded.

•Monitors rate and/or quantity input communication status and provides indication of uncertain or bad rate PV or quantity PV. Flow is stopped and an alarm is raised on a bad PV or communication loss.

•Provides program or operator entry of a quantity to deliver (setpoint) and calculates the quantity remaining to deliver and percent complete during delivery.

•Provides program or operator entry of high and low tolerance limits. Lets the program or operator initiate a tolerance check after delivery is complete. Provides a warning if under tolerance and lets the operator bump the flow to make up the shortage. The bump can be set up as a timed bump or as an operator jog-like function. Provides an alarm if over tolerance and inhibits further flow.

•Includes the ability to automatically switch to a lower dribble flow rate as the quantity delivered approaches setpoint. Provides operator or program entry of the dribble quantity. Provides run, dribble, and stop outputs to controlled equipment.

10	Rockwell Automation Publication SYSLIB-RM020G-EN-E - February 2017

Flowmeter Dosing (P_DoseFM)

Required Files

•Uses a preact value to stop flow to account for material in the pipe, time for equipment to stop, and delays in measurement, scan, communication, and so forth. Provides operator or program entry of the preact value. Provides an optional automatic preact correction based on the error in delivery when tolerance is checked. The auto correction lets the preact ‘learn’ the correct value over time.

•Uses the standard mode (P_Mode) instruction to provide mode

(ownership) for entry of settings and acceptance of commands. See the Operating Modes section for more information.

Add-On Instructions are reusable code objects that contain encapsulated logic that can streamline implementing your system. This lets you create your own instruction set for programming logic as a supplement to the instruction set provided natively in the ControlLogix® firmware. An Add-On Instruction is defined once in each controller project, and can be instantiated multiple times in your application code as needed.

Controller File

The P_DoseFM_3_5-00_AOI.L5X Add-On Instruction must be imported into the controller project to be used in the controller configuration. The service release number (boldfaced) can change as service revisions are created.

Visualization Files

This Add-On Instruction has associated visualization files that provide a common user interface. These files can be downloaded from the Product

Compatibility and Download Center at http://www.rockwellautomation.com/rockwellautomation/support/pcdc.page.

IMPORTANT The visualization file dependencies require Process Library content imports to occur in a specific order as reflected in the following tables:

•Images

•Global Objects

•Standard Displays

•HMI Tags

•Macros

Images are external graphic files that can be used in displays. They must be imported for FactoryTalk View to make use of them.

When PNG files are imported, they are renamed by FactoryTalk View with a .bmp file extension, but retain a .png format.

Rockwell Automation Publication SYSLIB-RM020G-EN-E - February 2017

11

Flowmeter Dosing (P_DoseFM)

Table 2 - Visualization Files: Images (.png)

FactoryTalk View SE Software	FactoryTalk View ME Software	Description
All .png files in the images folder	All .png files in the images folder	These are the common icons used in the global objects and
		standard displays for all Process Objects.

The Global Object files (.ggfx file type) in the following table are Process Library display elements that are created once and referenced multiple times on multiple displays in an application. When changes are made to a Global Object, all instances in the application are automatically updated.

Table 3 - Visualization Files: Global Objects (.ggfx)

FactoryTalk View SE Software	FactoryTalk View ME Software	Description
(RA-BAS) Common Faceplate Objects	(RA-BAS-ME) Common Faceplate Objects	Global objects used on process object faceplates.
(RA-BAS) Process Alarm Objects	(RA-BAS-ME) Process Alarm Objects	Global objects used for managing alarms on process
		object faceplates.
(RA-BAS) Process Diagnostic Objects	(RA-BAS-ME) Process Diagnostic Objects	Diagnostic global objects used on process object
		faceplates.
(RA-BAS) Process Faceplate Analog Objects	(RA-BAS-ME) Process Faceplate Analog Objects	Analog global objects used on process object faceplates.
(RA-BAS) Process Faceplate Misc Objects	(RA-BAS-ME) Process Faceplate Misc Objects	Miscellaneous global objects used on process object
		faceplates.
(RA-BAS) Process Graphics Library	(RA-BAS-ME) Process Graphics Library	Process global object device symbols used to build
		process graphics
(RA-BAS) Process Help Objects	(RA-BAS-ME) Process Help Objects	Global objects used for all process objects help displays.
(RA-BAS) Process Mode Objects	(RA-BAS-ME) Process Mode Objects	Global objects used for managing modes on process
		object faceplates.

The Standard Display files (.gfx file type) in the following table are the Process

Library displays that you see at runtime.

Table 4 - Visualization Files: Standard Displays (.gfx)

FactoryTalk View SE Software	FactoryTalk View ME Software	Description
(RA-BAS) Common-AnalogEdit	N/A	Faceplate used for analog input data entry. The FactoryTalk
		View ME faceplates use the native analog input data entry
		so no file is required.
(RA-BAS) P_Alarm-Faceplate	(RA-BAS-ME) P_Alarm-Faceplate	The faceplate that is used for managing alarms for
		the object.
(RA-BAS) P_Alarm-Help	(RA-BAS-ME) P_Alarm-Help	Alarm Help information that is accessed from the
		P_AIarm faceplate.
(RA-BAS) P_DoseFM-Faceplate	(RA-BAS-ME) P_DoseFM-Faceplate	The faceplate that is used for the object
(RA-BAS) P_DoseFM-Quick	(RA-BAS-ME) P_DoseFM-Quick	The Quick display that is used for the object
(RA-BAS) P_Mode-Config	(RA-BAS-ME) P_Mode-Config	The Configuration Display used to configure the
		P_Mode object.
(RA-BAS) P_Mode-Help	(RA-BAS-ME) P_Mode-Help	Mode Help information that is accessed from the
		Help faceplate.
(RA-BAS) Process Dose Family-Help	(RA-BAS-ME) Process Dose Family-Help	The Help display for Dose objects
(RA-BAS) P_AIChan-Faceplate	(RA-BAS-ME) P_AIChan-Faceplate	Optional
		The Channel faceplate used for the object.
		Use this file if your Analog Input has an associated
		P_AIChan object and you enable navigation to its
		faceplate from the Analog Input faceplate.

12	Rockwell Automation Publication SYSLIB-RM020G-EN-E - February 2017

Flowmeter Dosing (P_DoseFM)

Table 4 - Visualization Files: Standard Displays (.gfx)

FactoryTalk View SE Software	FactoryTalk View ME Software	Description
(RA-BAS) P_AIChan-Help	(RA-BAS-ME) P_AIChan-Help	Optional
		Channel Help information that is accessed from the
		P_AIChan Help faceplate.
		Use this file if you use the Analog Input Channel faceplate.

HMI Tags are created in a FactoryTalk View ME application to support tab switching on Process Library faceplates. The HMI tags may be imported via the comma-separated values file (.csv file type) in the following table.

Table 5 - Visualization Files: HMI Tags (.csv)

FactoryTalk View SE Software	FactoryTalk View ME Software	Description
N/A	FTVME_PlantPAxLib_Tags_3_5_xx.csv	These tags must be imported into the
	where xx = the service release number.	FactoryTalk View ME project to support switching tabs on
		any Process Object faceplate.

Controller Code

This section describes the parameter references for this Add-On Instruction.

Flowmeter Dosing Input Structure

Input parameters include the following:

•Input data elements (Inp_) are typically used to connect field inputs from

I/O modules or signals from other objects.

•Configuration data elements (Cfg_) are used to set configurable capabilities and features of the instruction.

•Commands (PCmd_, OCmd_, MCmd_) are used by program logic, operators, and maintenance personnel to request instruction actions.

•Settings (PSet_, OSet_, MSet_) are used by program logic, operators, and maintenance personnel to establish runtime setpoints, thresholds, and so forth. A Setting (without a leading P, O, or M) establishes runtime settings regardless of role or mode.

Rockwell Automation Publication SYSLIB-RM020G-EN-E - February 2017

13

Flowmeter Dosing (P_DoseFM)

Table 7 - P_DoseFM Input Parameters

Input Parameter	Data	Alias For	Default	Description
	Type
EnableIn	BOOL		1	Ladder Diagram:
				If the rung-in condition is true, the instruction’s Logic routine executes. If the
				rung-in condition is false, the instruction’s EnableInFalse routine executes.
				Function Block Diagram:
				If true, or not connected, the instruction’s Logic routine executes. If the
				parameter is exposed as a pin and wired, and the pin is false, the instruction’s
				EnableInFalse routine executes.
				Structured Text:
				No effect. The instruction’s Logic routine executes.
Inp_RatePV	REAL		0.0	Flow rate from flowmeter (Engineering Units/time, see Cfg_RateTime).
Inp_QtyPV	REAL		0.0	Quantity from flowmeter (Engineering Units or pulse count).
Inp_RunFdbk	BOOL		0	1	= Controlled equipment is delivering (running).
Inp_DribbleFdbk	BOOL		0	1	= Controlled equipment is delivering at dribble.
Inp_StopFdbk	BOOL		0	1	= Controlled equipment is confirmed stopped.
Inp_RatePVBad	BOOL		0	1	= Rate PV input quality = bad (fail).
Inp_RatePVSrcQ	SINT		0	Flow rate signal source and quality (enumeration).
Inp_RatePVUncertain	BOOL		0	1	= Rate PV input quality = uncertain.
Inp_QtyPVBad	BOOL		0	1	= Quantity PV input quality = bad (fail).
Inp_QtyPVSrcQ	SINT		0	Quantity signal source and quality (enumeration).
Inp_QtyPVUncertain	BOOL		0	1	= Quantity PV input quality = uncertain.
Inp_CtrldEqpFault	BOOL		0	Controlled equipment device or I/O status:
				0	= OK
				1	= Fail
Inp_Sim	BOOL		0	Simulation input. When set to 1, the instruction simulates a working dosing
				action. When set to 0, the instruction controls dosing normally.
Inp_Reset	BOOL		0	Input parameter used to programmatically reset alarms. When set to 1, all
				alarms requiring reset are reset.
Cfg_HasDribble	BOOL		0	1	= Slow to dribble before complete.
				0	= Run full flow until complete.
Cfg_HasEqpFdbk	BOOL		0	1	= Controlled equipment provides run, dribble (if used) and stop feedback.
Cfg_UseEqpFdbk	BOOL		0	1	= Use run/dribble/stop feedback.
				0	= Assume equipment state.
Cfg_AutoAdjPreact	BOOL		0	1	= Enable automatic adjustment of preact after each tolerance check.
Cfg_CalcRate	BOOL		0	1	= Differentiate Inp_Qty to get rate.
				0	= Use Inp_Rate.
Cfg_CalcQty	BOOL		0	1	= Integrate Inp_Rate to get quantity.
				0	= Use Inp_Qty.
Cfg_SetTrack	BOOL		1	This parameter is used to set up bumpless behavior of setting parameters
				when switching modes. When this parameter is 1, in Program mode the
				operator settings track the program settings; in Operator mode the program
				settings track the operator settings; and the simulation inputs match the
				output values (transitions are bumpless).
				When this parameter is 0, the operator settings and program settings are not
				modified by this instruction. In this case, when the mode is changed, the
				effective value of the setting can change depending on the program-set and
				operator-set values.

14	Rockwell Automation Publication SYSLIB-RM020G-EN-E - February 2017

				Flowmeter Dosing (P_DoseFM)
Table 7 - P_DoseFM Input Parameters
Input Parameter	Data	Alias For	Default	Description
	Type
Cfg_HasChanObjRate	BOOL		0	1 = Tells HMI a Channel object (P_AIChan, and so forth) is used for
				Inp_RatePV.
				IMPORTANT: The name of the Channel Rate object in the controller must be
				this object's name with the suffix ‘_ChanRate’. For example, if your P_DoseFM
				object has the name‘DoseFM123’, then its Channel Rate object must be named
				‘DoseFM123_ChanRate’.
Cfg_HasChanObjQty	BOOL		0	1 = Tells HMI a Channel object (P_AIChan, and so forth) is used for Inp_QtyPV.
				IMPORTANT: The name of the Channel Quantity object in the controller must
				be this object's name with the suffix ‘_ChanQty’. For example, if your
				P_DoseFM object has the name ‘DoseFM123’, then its Channel Quantity object
				must be named ‘DoseFM123_ChanQty’.
Cfg_PCmdClear	BOOL	Mode.Cfg_PCmdClear	1	When this parameter is 1, program commands are cleared once they are acted
				upon. When set to 0, program commands remain set until cleared by the
				application program logic.
				IMPORTANT: Clearing this parameter online can cause unintended program
				command execution.
Cfg_ProgDefault	BOOL	Mode.Cfg_ProgDefault	0	This parameter defines the default mode. When this parameter is 1, the mode
				defaults to Program if no mode is being requested. When this parameter is 0,
				the mode defaults to Operator if no mode is being requested.
				IMPORTANT: Changing this parameter online can cause unintended mode
				changes.
Cfg_ShedOnEqpFault	BOOL		0	1 = Stop delivery and alarm on equipment fault.
				0 = Alarm only on equipment fault.
Cfg_HasOverTolAlm	BOOL	OverTol.Cfg_Exists	0	These parameters determine whether the corresponding alarm exists and is
				checked or if the alarm does not exist and is not used. When these parameters
Cfg_HasUnderTolAlm		UnderTol.Cfg_Exists
				are 1, the corresponding alarm exists.
Cfg_HasZeroFaultAlm		ZeroFault.Cfg_Exists
Cfg_HasEqpFaultAlm		EqpFault.Cfg_Exists
Cfg_OverTolResetReqd	BOOL	OverTol.Cfg_ResetReqd	0	These parameters determine whether a reset is required to clear the alarm
				status. When these parameters are 1, the alarm is latched ON when the alarm
Cfg_UnderTolResetReqd		UnderTol.Cfg_ResetReqd
				occurs. After the alarm condition returns to normal, a reset is required to clear
				the alarm status (for example, OCmd_Reset, Inp_Reset, or
Cfg_ZeroFaultResetReqd		ZeroFault.Cfg_ResetReqd
				EqpFault.OCmd_Reset are required to clear Alm_EqpFault alarm after the
Cfg_EqpFaultResetReqd		EqpFault.Cfg_ResetReqd		alarm is set and the equipment returns to normal).
				When these parameters are 0, no reset is required and the alarm status is
				cleared when the alarm condition returns to normal.
				IMPORTANT: If the reset clears the alarm, it also acknowledges the alarm.
Cfg_OverTolAckReqd	BOOL	OverTol.Cfg_AckReqd	1	These parameters determine whether an acknowledgement is required for an
				alarm. When these parameters are 1, the acknowledge (ack) bit is cleared
Cfg_UnderTolAckReqd		UnderTol.Cfg_AckReqd	1
				when the alarm occurs. An acknowledge command (for example,
				PCmd_EqpFaultAck or EqpFault.OCmd_Ack) is required to acknowledge the
Cfg_ZeroFaultAckReqd		ZeroFault.Cfg_AckReqd	1
				alarm. When set to 0, the Acknowledge bit is set when an alarm occurs
Cfg_EqpFaultAckReqd		EqpFault.Cfg_AckReqd	1	indicating an acknowledged alarm and no acknowledge command is required.
Cfg_OverTolSeverity	INT	OverTol.Cfg_Severity	750	These parameters determine the severity of each alarm. This drives the color
				and symbols that are used to indicate alarm status on the faceplate and global
Cfg_UnderTolSeverity		UnderTol.Cfg_Severity	500
				object.
				The following are valid values:
Cfg_ZeroFaultSeverity		ZeroFault.Cfg_Severity	1000
				1…250 = Low
Cfg_EqpFaultSeverity		EqpFault.Cfg_Severity	1000
				251…500 = Medium
				501…750 = High
				751…1000 = Urgent
				IMPORTANT: For FactoryTalk View software version 7.0, these severity
				parameters drive only the indication on the global object and faceplate. The
				Alarms & Events definition severity drives the color and symbol that is used on
				the alarm banner and alarm summary as well as the value returned by
				FactoryTalk Alarms & Events display commands.
Cfg_MaxQty	REAL		1.00E+38	Maximum allowed quantity to deliver (setpoint) (engineering units).

Rockwell Automation Publication SYSLIB-RM020G-EN-E - February 2017

15

Flowmeter Dosing (P_DoseFM)

Table 7 - P_DoseFM Input Parameters

Input Parameter	Data	Alias For	Default	Description
	Type
Cfg_EUQtyMult	REAL		1.0	Rate to quantity engineering units multiplier (for example, gallons to barrels.).
Cfg_Rollover	REAL		0.0	Quantity rollover (for example, maximum count for pulse input).
Cfg_CountsPerEU	REAL		1.0	Number of counts in Inp_QtyPV that equal 1.0 engineering units.
Cfg_RateTime	REAL		1.0	Time factor for rate (60.0 for engineering units/minute, 3600.0 for engineering
				units/hour) (in seconds).
Cfg_RateFiltTC	REAL		0.1	Filter time constant (seconds) for calculated rate.
Cfg_LoRateCutoff	REAL		0.0	Rate below which to report zero flow (Inp_RatePV units).
Cfg_SettleT	REAL		1.0	Time to allow flow to stop before allowing tolerance check (seconds).
Cfg_BumpT	REAL		0.0	Bump (manual top-off) time (seconds), 0.0 = use Bump command as a ‘jog’.
Cfg_AutoAdjPct	REAL		10.0	Percentage of delivery error to auto-adjust preact (%).
Cfg_SimRate	REAL		1.0	Rate at which to deliver when running in simulation (engineering units/rate
				time).
Cfg_SimDribbleRate	REAL		0.1	Rate at which to dribble when running in simulation (engineering units/rate
				time).
Cfg_ClearPulseT	DINT		1	Time to pulse Out_Clear to clear external totalizer (seconds).
Cfg_FaultT	DINT		10	Time for equipment feedback to follow output before fault (seconds).
Cfg_OperKeep	SINT		2#0000_0000	Operator keeps control in Program mode:
				Bit .0 = Operator keeps Start/stop
				Bit .1 = Operator keeps Setpoint
				Bit .2 = Operator keeps Dribble/preact
				Bit .3 = Operator keeps Tolerances
Cfg_ProgKeep	SINT		2#0000_0000	Program keeps control in Operator mode:
				Bit .0 = Program keeps Start/stop
				Bit .1 = Program keeps Setpoint
				Bit .2 = Program keeps Dribble/preact
				Bit .3 = Program keeps Tolerances
PSet_SP	REAL		0.0	Program setting of total quantity to deliver (engineering units).
PSet_DribbleQty				Program setting of quantity to dribble (engineering units).
PSet_Preact				Program setting of quantity before total to stop flow (engineering units).
PSet_TolHi				Program setting of high tolerance threshold (OK quantity > SP).
PSet_TolLo				Program setting of low tolerance threshold (OK quantity < SP).
PSet_Owner	DINT		0	Program owner request ID (non-zero) or release (zero).
OSet_SP	REAL		0.0	Operator setting of total quantity to deliver (engineering units).
OSet_DribbleQty				Operator setting of quantity to dribble (engineering units).
OSet_Preact				Operator setting of quantity before total to stop flow (engineering units).
OSet_TolHi				Operator setting of high tolerance threshold (OK quantity > SP).
OSet_TolLo				Operator setting of low tolerance threshold (OK quantity < SP).

16	Rockwell Automation Publication SYSLIB-RM020G-EN-E - February 2017

Flowmeter Dosing (P_DoseFM)

Table 7 - P_DoseFM Input Parameters

	Input Parameter	Data	Alias For	Default	Description
		Type
	PCmd_ClearTot	BOOL		0	When Cfg_PCmdClear is 1:
					• Set PCmd_ClearTot to 1 to clear the totalizer quantity
	PCmd_StartTot
					• Set PCmd_StartTot to 1 to start the totalizer
	PCmd_StopTot				• Set PCmd_StopTot to 1 to stop the totalizer
					• These parameters reset automatically
					When Cfg_PCmdClear is 0:
					• Set PCmd_ClearTot to 1 to clear the totalizer quantity
					• Set PCmd_StartTot to 1 to start the totalizer
					• Set PCmd_StopTot to 1 to stop the totalizer
					• These parameters do not reset automatically
	PCmd_StartFlow	BOOL		0	When Cfg_PCmdClear is 1:
					• Set PCmd_StartFlow to 1 to start delivery
	PCmd_StopFlow
					• Set PCmd_StopFlow to 1 to stop delivery
	PCmd_CheckTol				• Set PCmd_CheckTolerances to 1 to check tolerances
					• These parameters reset automatically
					When Cfg_PCmdClear is 0:
					• Set PCmd_StartFlow to 1 to start delivery
					• Set PCmd_StopFlow to 1 to stop delivery
					• Set PCmd_CheckTolerances to 1 to check tolerances
					• These parameters do not reset automatically
	PCmd_Bump	BOOL		0	When PCmd_Bump is set to 1:
					• If the configured bump time (Cfg_BumpT) is nonzero, then bump delivery
					for the configured bump time
					– PCmd_Bump is cleared automatically
					• If the configured bump time (Cfg_BumpT) is zero, then bump delivery until
					PCmd_Bump is returned to 0
					– PCmd_Bump is not cleared automatically
					• Cfg_PCmdClear is not affected by this parameter
	PCmd_Acq	BOOL	Mode.PCmd_Acq	0	When Cfg_PCmdClear is 1:
		BOOL		0	• Set PCmd_Acq to 1 to Acquire
	PCmd_Rel		Mode.PCmd_Rel
					• Set PCmd_Rel to 1 to Release
					• These parameters reset automatically
					When Cfg_PCmdClear is 0:
					• Set PCmd_Acq to 1 to Acquire
					• Set PCmd_Acq to 0 to Release
					• PCmd_Rel is not used
					• These parameters do not reset automatically
	PCmd_Lock	BOOL	Mode.PCmd_Lock	0	When Cfg_PCmdClear is 1:
		BOOL		0	• Set PCmd_Lock to 1 to Lock
	PCmd_Unlock		Mode.PCmd_Unlock
					• Set PCmd_Unlock to 1 to Unlock
					• These parameters reset automatically
					When Cfg_PCmdClear is 0:
					• Set PCmd_Lock to 1 to Lock
					• Set PCmd_Lock to 0 to Unlock
					• PCmd_Unlock is not used
					• These parameters do not reset automatically
	PCmd_Reset	BOOL		0	• Set PCmd_Reset to 1 to reset all alarms requiring reset
					• This parameter is always reset automatically
	PCmd_OverTolAck	BOOL	OverTol.PCmd_Ack	0	• Set PCmd_<Alarm>Ack to 1 to Acknowledge alarm
					• The parameter is reset automatically
	PCmd_UnderTolAck		UnderTol.PCmd_Ack
	PCmd_ZeroFaultAck		ZeroFault.PCmd_Ack
	PCmd_EqpFaultAck		EqpFault.PCmd_Ack

Rockwell Automation Publication SYSLIB-RM020G-EN-E - February 2017

17

Flowmeter Dosing (P_DoseFM)

Table 7 - P_DoseFM Input Parameters

Input Parameter	Data	Alias For	Default	Description
	Type
PCmd_OverTolSuppress	BOOL	OverTol.PCmd_Suppress	0	When Cfg_PCmdClear is 1:
				• Set PCmd_<Alarm>Suppress to 1 to suppress alarm
PCmd_UnderTolSuppress		UnderTol.PCmd_Suppress
				• Set PCmd_<Alarm>Unsuppress to 1 to unsuppress alarm
PCmd_ZeroFaultSuppress		ZeroFault.PCmd_Suppress		• These parameters reset automatically
				When Cfg_PCmdClear is 0:
PCmd_EqpFaultSuppress		EqpFault.PCmd_Suppress
				• Set PCmd_<Alarm>Suppress to 1 to suppress alarm
PCmd_OverTolUnsuppress	BOOL	OverTol.PCmd_Unsuppress	0	• Set PCmd_<Alarm>Suppress to 0 to unsuppress alarm
				• PCmd_<Alarm>Unsuppress is not used
PCmd_UnderTolUnsuppress		UnderTol.PCmd_Unsuppress
				• These Parameters do not reset automatically
PCmd_ZeroFaultUnsuppress		ZeroFault.PCmd_Unsuppress
PCmd_EqpFaultUnsuppress		EqpFault.PCmd_Unsuppress
PCmd_OverTolUnshelve	BOOL	OverTol.PCmd_Unshelve		• Set PCmd_<Alarm>Unshelve to 1 to Unshelve alarm
				• The parameter is reset automatically
PCmd_UnderTolUnshelve		UnderTol.PCmd_Unshelve
PCmd_ZeroFaultUnshelve		ZeroFault.PCmd_Unshelve
PCmd_EqpFaultUnshelve		EqpFault.PCmd_Unshelve
OCmd_ClearTot	BOOL		0	Operator commands to clear totalizer quantity, start totalizer, or stop totalizer.
OCmd_StartTot
OCmd_StopTot
OCmd_StartFlow	BOOL		0	Operator commands to start delivery, stop/pause delivery, or check tolerances.
OCmd_StopFlow
OCmd_CheckTol
OCmd_Bump	BOOL		0	Operator command to bump delivery for under tolerance.
MCmd_Acq	BOOL	Mode.MCmd_Acq	0	Maintenance command to acquire ownership (Operator/Program/Override to
				Maintenance)
MCmd_Rel	BOOL	Mode.MCmd_Rel	0	Maintenance command to release ownership (Maintenance to Operator/
				Program/Override)
OCmd_AcqLock	BOOL	Mode.OCmd_AcqLock	0	Operator command to acquire and lock mode in Operator.
OCmd_Unlock	BOOL	Mode.OCmd_UnlockRel	0	Operator command to unlock Operator mode.
OCmd_Reset	BOOL		0	Operator command to reset all alarms requiring reset.
OCmd_ResetAckAll	BOOL		0	Operator command to acknowledge and reset all alarms and latched shed
				conditions.

18	Rockwell Automation Publication SYSLIB-RM020G-EN-E - February 2017