You are on page 1of 282

ProcessLogix

Function Block
Parameters
1757 Series

Reference Manual

Important User Information

Because of the variety of uses for the products described in this


publication, those responsible for the application and use of these
products must satisfy themselves that all necessary steps have been
taken to assure that each application and use meets all performance
and safety requirements, including any applicable laws, regulations,
codes and standards. In no event will Allen-Bradley be responsible
or liable for indirect or consequential damage resulting from the use
or application of these products.
Any illustrations, charts, sample programs, and layout examples
shown in this publication are intended solely for purposes of
example. Since there are many variables and requirements associated
with any particular installation, Allen-Bradley does not assume
responsibility or liability (to include intellectual property liability) for
actual use based upon the examples shown in this publication.
Allen-Bradley publication SGI-1.1, Safety Guidelines for the
Application, Installation and Maintenance of Solid-State Control
(available from your local Allen-Bradley office), describes some
important differences between solid-state equipment and
electromechanical devices that should be taken into consideration
when applying products such as those described in this publication.
Reproduction of the contents of this copyrighted publication, in
whole or part, without written permission of Rockwell Automation, is
prohibited.
Throughout this publication, notes may be used to make you aware
of safety considerations. The following annotations and their
accompanying statements help you to identify a potential hazard,
avoid a potential hazard, and recognize the consequences of a
potential hazard:
WARNING

!
ATTENTION

!
IMPORTANT

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.

Identifies information about practices or


circumstances that can lead to personal injury or
death, property damage, or economic loss.

Identifies information that is critical for successful


application and understanding of the product.

Allen-Bradley is a trademark of Rockwell Automation

Rockwell Automation
Support

Rockwell Automation offers support services worldwide, with over 75


sales/support offices, 512 authorized distributors, and 260 authorized
systems integrators located throughout the United States alone, plus
Rockwell Automation representatives in every major country in the
world.

Local Product Support


Contact your local Rockwell Automation representative for:
sales and order support
product technical training
warranty support
support service agreements

Technical Product Assistance


If you need to contact Rockwell Automation for technical assistance,
first call your local Rockwell Automation representative, then:
Post-sales Technical Support, 440.646.5800
Web Links, http://www.ab.com

Your Questions or Comments on this Manual


If you find a problem with this manual, please notify us of it on the
How Are We Doing? form at the back of this manual.

Table of Contents
Important User Information . . . . . . . . . . . . . . . . .
Rockwell Automation Support . . . . . . . . . . . . . . .
Local Product Support . . . . . . . . . . . . . . . . . .
Technical Product Assistance . . . . . . . . . . . . .
Your Questions or Comments on this Manual .

Preface

Function Block Parameters

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

.
.
.
.
.

iii
iv
iv
iv
iv

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vii
Parameter Attriubutes. . . . . . . . . . . . . . . . . . . . . . . . . . . vii
.............................................. 1

Appendix A
Display Elements Appendix

Group Display Elements . . . . . . . . . . . . . . . . . . . . . . . . . . A-1


Detail Display Elements. . . . . . . . . . . . . . . . . . . . . . . . . . . A-3

Appendix B
Allen-Bradley Interface Appendix Array Channel Block Configuration for
Allen-Bradley Interface . . . . . . . . . . . . . . . . . . . . . . . . . .
About Allen-Bradley Interface. . . . . . . . . . . . . . . . . . .
AUXDATA Parameter Configuration . . . . . . . . . . . . . .
AUXDATA[6] Parameter Setting Details . . . . . . . . . . . .
DEVADDR Parameter Configuration . . . . . . . . . . . . . .
STARTINDEX and Number of Elements Parameter. . . .
Report by Exception Requirements . . . . . . . . . . . . . . .
Performance Considerations . . . . . . . . . . . . . . . . . . . .
Array Channel Block Execution State . . . . . . . . . . . . .
Write processing considerations . . . . . . . . . . . . . . . . .
Diagnostic procedures and data configuration. . . . . . .
Time-Out gate configuration. . . . . . . . . . . . . . . . . . . .
Status and error checking . . . . . . . . . . . . . . . . . . . . . .
Error messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Special FTA to KE/KF cabling considerations . . . . . . .
FTA direct to PLC-5 RS-232 Port cable considerations: .
Reference Specifications . . . . . . . . . . . . . . . . . . . . . . .

.
.
.
.
.
.
.
.

B-1
B-1
B-1
B-3
B-5
B-6
B-7
B-8
B-10
B-11
B-11
B-14
B-15
B-15
B-17
B-18
B-19

.
.
.
.
.
.
.
.
.

C-1
C-1
C-1
C-2
C-4
C-4
C-6
C-6
C-7

Appendix C
MODBUS Interface Appendix

Array Channel Block Configuration for


Generic MODBUS Interface . . . . . . . . . . . . . . . . . . . .
About Generic Modbus Interface . . . . . . . . . . . . .
AUXDATA Parameter Configuration . . . . . . . . . . .
STARTINDEX and Number of Elements Parameter.
Modbus loopback diagnostic . . . . . . . . . . . . . . . .
Performance Considerations . . . . . . . . . . . . . . . . .
Array Channel Block Execution State . . . . . . . . . .
Write Processing Considerations . . . . . . . . . . . . . .
Status and Error Checking . . . . . . . . . . . . . . . . . .

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

.
.
.
.
.
.
.
.
.

Publication 1757-RM811A-EN-P - May 2002

vi

Error Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-7


Special Modbus Slave FTA Implementation . . . . . . . . . . C-9
Reference Specifications . . . . . . . . . . . . . . . . . . . . . . . C-10

Publication 1757-RM811A-EN-P - May 2002

Preface

Introduction

This publication defines the user-visible parameters that exist in the


ProcessLogix System. It also provides a listing of the parameter
attributes that are applicable to ProcessLogix function blocks.

Parameter Attriubutes
The following table describes the attributes used to define each
parameter. If an attribute does not appear for a specific parameter, it
is not applicable to that parameter.
Table P.1 Parameter Attribute Descriptions

vii

Attribute

Description

Specific to
Block(s)

Defines which function block (or blocks) the table applies to. If a
parameter has different properties for different function blocks, there
will be multiple tables for the parameter.

Description

Includes the full parameter name; additional information describing


its basic purpose or function may also be available.

Data Type

Defines how the parameter data is viewed by the system


(See Table P.2 on page viii for additional details.).

Range

Defines the range of values for the data type (also defines ranges for
ViewOnly parameters).

Default Value

Defines the value assigned to the parameter by the system when no


selection is made during control building.

Config Load

Determines whether the parameter value is stored to CEE or SR during


module load from builder.

Access Lock

Defines who or what can change the parameters value or option


(See Table P.3 on page ix).

Residence

Defines where the parameter physically resides and executes


(See Table P.4 on page x).

Active Connector

Denotes (Yes or No) whether the Parameter has an active connector.

Related
Parameters

Lists parameters that are related by their use at configurations and


operations times.

Remarks

Includes additional information that is important to the understanding,


use, and operation of the parameter.

Publication 1757-RM811A-EN-P - May 2002

Preface

viii

Data Type
Multiple data types are supported in ProcessLogix. See Table P.2 for a
listing and description of these data types.
Table P.2 Supported Parameter Data Types
Boolean

Enumeration

32-Bit Real Number

Connection

64-Bit Real Number

Output Connection

16-Bit Integer

Input Connector

32-Bit Integer

Structure

Constant Integer

Float

8-Bit Unsigned Integer

Float64/Real64

16-Bit Unsigned Integer

String

32-Bit Unsigned Integer

TIME

BlockId(1) / Entity ID

Self-Defining Enumeration(2)

(1)

BlockId - A BlockId parameter value is text describing a blocks name. Example BlockId values are
SCM3.Step7 and SCM7.

(2)

Self-Defining Enumeration (SDEnum) - This data type is just like an Enumeration, except the enumeration
members are user-defined. Parameter A being an SDEnum of B means that B (String data type) defines the
enumeration members for A (SDEnum data type).

TIP

Publication 1757-RM811A-EN-P - May 2002

The numerical suffixes - 16, 32, and 64 - indicate the


number of memory bits used to store the value;
Real32 is commonly called single-precision, and
Real64 is double-precision. The difference in the
Integers is just the supported range of values.

Preface

ix

Access Lock
The ProcessLogix system supports six access levels. Each parameter
includes an Access Lock attribute that defines what access level a
program or operator must have in order to change the value of the
parameter. See Table P.3 for lists of these access levels and to see the
relationship between the access lock and the access level.
Table P.3 Supported Parameter Access Lock Levels
Access
Lock

Access Level
Operator Supervisor Engineer Program

Operator
Supervisor
Engineer

Continuous
Control

Applications
Developer

ViewOnly

Applications
Developer
Only
Engineer/
Applications
Developer

Program

Other
Function
Block

X
X

Control
Engineer Only

Publication 1757-RM811A-EN-P - May 2002

Preface

Residence
Parameters in ProcessLogix control strategies may reside in several
places. See Table P.4 for a listing and definition of the valid
residences.
Table P.4 Parameter Residences
Residence

Description

CEE
(Control Execution
Environment)

Supports execution of a set of function blocks for solving control


applications. It runs in the Hybrid Controller as a software layer
built on top of the control software infrastructure.

SR
(System Repository)

The file where all ProcessLogix server point data is stored.

ProcessLogix Server

ProcessLogix server:
Parameters resident at the server control how data for the point is
accessed or viewed by the operator, using the ProcessLogix Station
software.

TIP

Publication 1757-RM811A-EN-P - May 2002

All ProcessLogix parameters have attributes and/or


values stored within the Engineering Repository. In
addition, parameters of loaded blocks are stored in
one or more locations. These Repositories are the
ProcessLogix Run Time Repositories; SR, CEE and
server. Location within one or more of the Run Time
Repositories is described by the residency parameter
attribute.

Function Block Parameters

Parameter

Specific to
Block(s)

Description

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

ABORTALM.FL

SCM

Abort Alarm Flag

Boolean

Off (0)
On (1)

Off (0)

No

View Only

CEE

No

ABORTALM.PR,
ABORTALM.SV,
STATE

When On, indicates that the


Abort Alarm condition
(SCM's STATE has
transitioned to Abort) exists.

ABORTALM.PR

SCM

Abort State Alarm Enumeration


Priority - Specifies ALPRIOR
the alarm priority for
the Abort alarm

None (0)
Journal (1)
Low (2)
High (3)
Urgent (4)

Low (2)

Yes

Engineer/
Application
Developer

CEE

No

ABORTALM.FL,
ABORTALM.SV

ABORTALM.SV

SCM

Abort State Alarm 16-Bit Integer 0 to 15


Severity - Specifies
the alarm severity
for the Abort alarm.

Yes

Engineer

CEE

No

ABORTALM.FL,
ABORTALM.PR

ABORTLOCK

SCM

Abort Command
Access Lock

Enumeration Operator (0) Engineer Yes


CSCOACCLOC Engineer (1) (1)
K
View Only (2)
OtherFB (3)

Engineer

CEE

No

COMMAND

ACCDEV.FL [1..4]

Totalizer, Pulse
Input Totalizer

Accumulator
Boolean
Deviation Flag Indicates when an
accumulator
deviation trip point
(ACCDEV.TP [1-4])
has been reached.
There is one flag per
trip point.

View Only

CEE

No

ACCDEV.TP [1..4],
ACCTV, PV

Off (0):
Off (0)
ACCDEV.TP [n]
is less than or
equal to
ACCTV PV
On (1):
ACCDEV.TP [n]
is greater than
or equal to
ACCTV PV

No

Value of ABORTLOCK
restricts who can issue the
Abort command.

Function Block Parameters


1

Parameter

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Accumulator
64-Bit Real
Deviation Trip Point - Number
Used to determine
when the
accumulated value
(PV) is getting "near"
the target value
(ACCTV). Trip point
values are
expressed as
deviations from the
target value.

NaN, or
greater than
or equal to
0.0.

NaN

Yes

Engineer

CEE

No

ACCDEV.FL [1..4], PV, The function block compares


ACCTV
the actual deviation (ACCTV PV) with each deviation trip
point (ACCDEV.FL [1..4]),
when it is less than a single
trip point.
ACCDEV.FL [n] is set to On
when ACCDEV.TP [n] is
greater-than or equal to
ACCTV-PV

Pulse Input
Totalizer

Accumulator
Real
Deviation Trip Point Used to determine
when the
accumulated value
(PV) is getting near
the target value
(ACCTV). Trip point
values are
expressed as
deviations from the
target value.

NaN or
NaN
greater-than
or equal to 0.0

Yes

Engineer

CEE

No

>ACCDEV.FL(1-4), PV, The function block compares


ACCTV
the actual deviation (ACCTV PV) with each deviation trip
point (ACCDEV.TP(1-4)), and
sets a flag (ACCDEV.FL(1-4))
when it is less than a trip
point.

Flag, Numeric
FLAGARRAY,
NUMERICARRAY,
TEXTARRAY
SIFLAGARRCH,
SINUMARRCH,
SITEXTARRCH

Access Lock Enumeration


Specifies who can ACCLOCK
change the Flag
function blocks
state (using PV and
PVFL), and who can
change the Numeric
function blocks
value (PV).

Operator (0)
Engineer (1)
OtherFB (2)

Operator Yes
(0)

Engineer

CEE

No

Numeric only:PV
Flag only: PVFL
FLAGARRAY only:
PVFL [1..1000], STR
[1..120]
NUMERICARRAY
only: PV [1..200]
SI Channels only: PV
[1..64], PVFL [1..512],
STR [1..8]

Totalizer

Accumulator Target 64-Bit Real


Value - Specifies the Number
target value of the
accumulator.

NaN, or
0
greater-than
or equal-to 0.

Yes

Operator

CEE

No

PV, ACCTVFL,
ACCDEV.TP [1..4],
ACCDEV.FL [1..4]

ACCTV is displayed as the


set point of an Auxiliary
function block.

Pulse Input
Totalizer

Accumulator Target 64-Bit Real


Value Specifies
Number
the target value of
the accumulator.

NaN, or
greater-than
or equal-to
zero

Yes

Operator

CEE

No

PV, ACCTVFL,
ACCDEV.TP [1..4],
ACCDEV.FL [1..4]

ACCTV is displayed as the


set point of an Auxiliary
function block.

ACCDEV.TP [1..4] Totalizer

ACCTV

Description

Data Type

Notes
Function Block Parameters

Specific to
Block(s)

Parameter

Specific to
Block(s)

Description

Data Type

ACCTVFL

Totalizer

Accumulated-Target Boolean
-Value Reached Flag
- The "target
reached" flag for the
Totalizer function
block. It indicates if
the present variable
(PV) has reached the
target value
[ACCTV].

Pulse Input
Totalizer

ACTIVEFL
ACTIVEHANDLR
[1..8]

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Off (PV is less


than ACCTV)
On (PV is
greater than
or equal to
ACCTV)

No

View Only

CEE

No

PV, ACCTV

Accumulated-Target Boolean
-Value Reached Flag
- The "target
reached" flag for the
Totalizer function
block. It indicates if
the present variable
(PV) has reached the
target value
(ACCTV).

Off (0): PV is
less-than
ACCTV
On (1) PV is
greater-than
or equal-to
ACCTV

No

View Only

CEE

No

PV, ACCTV

Step

Step Active Flag

Boolean

Off (0)
On (1)

Off (0)

No

View Only

CEE

No

SCM

Active Handler Type Boolean


Flag

Off (0)
On (1)

Off (0)

No

View Only

CEE

No

Notes

Indicates if Step is currently


active (On) or not (Off).
ACTIVELOC.HANDLE
R,
ACTIVELOC.HANDLE
RN,
ACTIVELOC.HNDTYP
E, ACTIVELOC.STEP
[1..10],
ACTIVELOC.STEPN
[1..10],
ACTIVELOC.TIME
[1..10], TYPE

Function Block Parameters

There are eight different


handler types, corresponding
to the following numeric
values:
1 = EDIT (not user
defineable)
2 = MAIN
3 = CHECK
4 = INTERRUPT
5 = RESTART
6 = HOLD
7 = STOP
8 = ABORT
For example, if
ACTIVEHANDLR [5] = On,
then the currently active
handler is of type RESTART.
ACTIVEHANDLR [I] flag is On
when the currently active
handler is TYPE i.

Specific to
Block(s)

Description

Data Type

ACTIVELOC.
HANDLER

SCM

Active Handler
Name

ACTIVELOC.
HANDLERN

SCM

Active Handler
Name

ACTIVELOC.
HNDTYPE

SCM

ACTIVELOC.
STEP [1..10]

SCM

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

BlockId

Null
String

No

View Only

CEE

No

ACTIVELOC.HANDLE Contains the name (eg.


RN
SCMName.HandlerName) of
the currently active handler.
ACTIVELOC.HANDLER is a
BlockId parameter and not
supported in expressions. Its
Integer-32 Partner Parameter
ACTIVELOC.HANDLERN can
be used in Transition
Condition expressions and
Step Output expressions.

32-Bit Integer

Null
String

No

View Only

CEE

No

ACTIVELOC.HANDLE Contains the name (eg.


R
SCMName.HandlerName) of
the currently active handler.
ACTIVELOC.HANDLERN may
be used in Transition
Condition expressions and
Step Output expressions,
whereas
ACTIVELOC.HANDLER (a
BlockId parameter) is not
supported in expressions.

Active Handler Type 32-Bit Integer 0 to 8

No

View Only

CEE

No

TYPE

Active Step Name

Null
String

No

View Only

CEE

No

ACTIVELOC.STEPN
[1..10]

BlockId

Range

Notes

ACTIVELOC.STEP [i] contains


the currently active steps
name (eg.
SCMName.StepName). In
release R110, i must be 1.
ACTIVELOC.STEP [1..10] is a
BlockId parameter and not
supported in expressions. Its
Integer-32 Partner Parameter
ACTIVELOC.STEPN [1..10]
can be used in Transition
Condition expressions and
Step Output expressions.

Function Block Parameters

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

ACTIVELOC.
STEPN [1..10]

SCM

Active Step Name

32-Bit Integer Null String

ACTIVELOC.
TIME [1..10]

SCM

Active Step Time

32-Bit Integer 0 to
2147483647

Actual Ramp Rate (in Real


EUs per min) - There
is one ramp rate per
Ramp/Soak pair of
each profile.

ACTSOAKTIME
RampSoak
[1..NUMPROFILES
]
[1..NUMRAMPSO
AK]

Actual Soak Time (in Real


Minutes) - There is
one soak time per
Ramp/Soak pair.

ACTSOAKVAL
RampSoak
[1..NUMPROFILES
]
[1..NUMRAMPSO
AK]

Actual Soak Value - Real


There is one soak
value per
Ramp/Soak pair.

0.0 to 120.0

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

No

View Only

CEE

No

ACTIVELOC.STEP
[1..10]

ACTIVELOC.STEP [i] contains


the currently active steps
name (eg.
SCMName.StepName). In
release R110, i must be 1.
ACTIVELOC.STEPN [1..10]
may be used in Transition
Condition expressions and
Step Output expressions,
whereas ACTIVELOC.STEP
[1..10] (a BlockId parameter)
is not supported in
expressions.

No

View Only

CEE

No

PERIOD,ACTIVELOC. ACTIVELOC.TIME [i] contains


STEP [1..10]
the number of execution
cycles that the current step
has been active.

NaN

No

View Only

CEE

No

RampSoak

Actual Ramp Rate (in EUs per


min) - There is one ramp rate
per Ramp/Soak pair of each
profile.

0.0

No

View Only

CEE

No

NUMPROFILES,
NUMRAMPSOAK
[1..NUMPROFILES],
ACTRAMPRATE
[1..NUMPROFILES]
[1..NUMRAMPSOAK]
, ACTSOAKVAL
[1..NUMPROFILES]
[1..NUMRAMPSOAK]
, ACTSTARTOP
[1..NUMPROFILES],
ACTSTARTSEG
[1..NUMPROFILES]

The actual time is recorded


after a soak segment
completes. There is one
soak time per Ramp/Soak
pair of each profile.

NaN

No

View Only

CEE

No

NUMPROFILES,
NUMRAMPSOAK
[1..NUMPROFILES],
ACTSOAKTIME
[1..NUMPROFILES]
[1..NUMRAMPSOAK]
, ACTRAMPRATE
[1..NUMPROFILES]
[1..NUMRAMPSOAK]
, ACTSTARTOP
[1..NUMPROFILES],
ACTSTARTSEG
[1..NUMPROFILES]

The actual value is recorded


after a ramp segment
completes (and the soak
segment begins). There is
one soak value per
Ramp/Soak pair of each
profile.

Function Block Parameters

ACTRAMPRATE RampSoak
[1..NUMPROFILES
]
[1..NUMRAMPSO
AK]

Range

Parameter

Description

Data Type

ACTSTARTOP
RampSoak
[1..NUMPROFILES
]

Actual Starting
Output Value

ACTSTARTSEG
RampSoak
[1..NUMPROFILES
]

ACTVTNTIME

Step

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Real

View
Only

No

CEE

No

NUMPROFILES,
NUMRAMPSOAK
[1..NUMPROFILES],
ACTSOAKTIME
[1..NUMPROFILES]
[1..NUMRAMPSOAK]
, ACTSOAKVAL
[1..NUMPROFILES]
[1..NUMRAMPSOAK]
, ACTRAMPRATE
[1..NUMPROFILES]
[NUMRAMPSOAK],
ACTSTARTSEG
[1..NUMPROFILES]

Actual Starting
Segment ID

Real

View
Only

No

CEE

No

NUMPROFILES,
NUMRAMPSOAK
[1..NUMPROFILES],
ACTSOAKTIME
[1..NUMPROFILES]
[1..NUMRAMPSOAK]
, ACTSOAKVAL
[1..NUMPROFILES]
[1..NUMRAMPSOAK]
, ACTRAMPRATE
[1..NUMPROFILES]
[1..NUMRAMPSOAK]
, ACTSTARTOP
[1..NUMPROFILES]

Activation Time

Integer

No

View Only

CEE

Yes

Operator

CEE

No

ADVDEVALM.DBU

ADVDEVALM.DB PID, PIDFF, PosProp Advisory Deviation


Alarm Deadband

64-Bit Real
Number

Range

0.0 to 100.0 if 0.0


alarm
deadband
units
(ADVDEVALM.
DBU) are
Percent
Greater-than
or equal-to 0.0
if alarm
deadband
units
(ADVDEVALM.
DBU) are
Engineering
Units

Notes
Function Block Parameters

Specific to
Block(s)

Parameter

Specific to
Block(s)

Description

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

ADVDEVALM.DB PID, PIDFF, PosProp Advisory Deviation


U
Alarm Deadband
Units - Indicates if
ADVDEVALM.DB is
in Percent or
Engineering Units.

Enumeration
ALMDBU

Percent (0)
EU(1)

Percent
(0)

Yes

Engineer

CEE

No

ADVDEVALM.DB

ADVDEVALM.FL

PID, PIDFF, PosProp Advisory Deviation


Alarm Flag Indicates if an
advisory alarm has
been detected

Boolean

Off (0) (not in


Advisory
Deviation
alarm)
On (1) (in
Advisory
Deviation
alarm
condition)

Off (0)

No

View Only

CEE

No

ADVDEVALM.PR

PID, PIDFF, PosProp Advisory Deviation


Alarm Priority Defines the priority
of an advisory
deviation alarm.

Enumeration
ALPRIOR

None (0)
Journal (1)
Low (2)
High (3)
Urgent (4)

Low (2)

Yes

Engineer

CEE

No

ADVDEVALM.SV

PID, PIDFF, PosProp Advisory Deviation


Alarm Severity

16-Bit Integer 0 to 255

Yes

Engineer

CEE

No

ADVDEVALM.TM PID, PIDFF, PosProp Advisory Deviation DeltaTime


Alarm Filter Time (in
seconds) The
purpose of this
variable is to prevent
input spikes from
causing alarms.

0 to 60

Yes

CEE

No

ADVDEVAL
M.TP

If ADVDEVALM.TM
equals zero, an alarm
will be generated as
soon as the advisory
deviation exceeds
the trip point.

ADVDEVALM.TP

NaN, or
greater-than
or equal-to
zero.

NaN

Yes

Operator

CEE

No

PV, ADVSP

Alarm generation requires


[PV - ADVSP] >
ADVDEVALM.TP

Function Block Parameters

PID, PIDFF, PosProp Advisory Deviation 64-Bit Real


Alarm Trip Point (in Number
Engineering Units) An alarm will be
generated when the
difference between
the process variable
(PV) and Advisory
Setpoint value
(ADVSP) exceeds the
value in this
variable.

Notes

Specific to
Block(s)

ADVDEVOPT

PID, PIDFF, PosProp Advisory Deviation Enumeration


Option - Indicates if ENBSTATE
advisory deviation
alarming is
requested.

ADVS

PID, PIDFF, PosProp Advisory Setpoint


Value (in
Engineering Units)

64-Bit Real
Number

ADVSPP

PID, PIDFF, PosProp Advisory Setpoint


Value (in Percent)

64-Bit Real
Number

ALARM

nooN

ALARM output value Boolean

ALIAS [ ].AL

SCM

The base nested


Structure
parameter for alias.

ALIAS [ ].STATU

SCM

Internal parameter
for system use only.

ALIAS [ ].VALUE

SCM

Internal parameter
for system use only.

ALIASBLKTYP [ ] SCM

Alias Table
parameter
ALIASDATATYP [ SCM
]

ALIASOPT

Description

Data Type

Block type of the


aliases defined in
the Alias Table.

16-Bit Integer
(Template ID)

Block type of the


alias. Sized by
NUMALIASES.

Integer
(TEMPLATE
ID)

Access
Lock

Residence

Active
Connector

Enable (0):
Enable (0) Yes
Advisory
deviation
alarming is
requested
Disable (1):
Advisory
deviation
alarming is
not requested

Engineer

CEE

No

SPLOLM to
SPHILM

Yes

Operator

CEE

No

ADVSPP

No

View Only

CEE

No

ADVSP

No

View Only

CEE

No

No

Application
Developer

CEE

No

NUMALIASES

Internal parameter sized by


NUMALIASES.

Yes

Application
Developer

ERDB

No

NUMALIASES

Sized by NUMALIASES.

Application
Developer

ERDB

Yes

Application
Developer

ERDB

No

If ALIASOPT is
configured to False,
all the alias
parameters will not
be exposed in the
SCM configuration
form.

Yes

Application
Developer

ERDB

No

NUMALIASES

Off (0)
On (1)

Default

Off (0)

Config
Load

Related
Parameters

Notes

Internal parameter
for system use only.

Alias Table
parameter

Internal parameter
for system use only.

SCM

Alias Table Option - Boolean


Defines whether or
not an Alias Table
will be configured in
the SCM.

ALIASPRMTYP [ ] SCM

Range

Function Block Parameters

Parameter

Parameter type of
the aliases defined
in the Alias Table.

16-Bit Integer
(Param ID)

False (0)
True (1)

False (0)

Sized by NUMALIASES.

Parameter

Specific to
Block(s)

Description

Data Type

ALIASREF [ ] [ ]

SCM

Internal parameter
for system use only.

ALIASSRC [ ] [ ]

SCM

Internal parameter
for system use only.

ALMDB

DataAcq,
Overall Deadband
64-Bit Real
All RegCtl Blocks
for all analog alarms Number
except Fanout:
AutoMan, OvrdSel,
PID, PIDFF, PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

ALMDBU

DataAcq,
Overall Deadband
All RegCtl Blocks
unit for all analog
except Fanout:
alarms
AutoMan, OvrdSel,
PID, PIDFF, PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

ALMENBSTATE

CM, SCM, IOM,


CEE, CPM, RM

Enumeration
ALMDBU

Alarm Enable State - Boolean


Defines the alarm
reporting function
that is to be used,
when an alarm
condition is detected
by the function
block, or one of its
components.

Range

Default

Config
Load

Access
Lock

0.00

Yes

Percent (0)
Engineering
Units (1)

Percent
(0)

Off (0)
On (1)

On (1)

Residence

Related
Parameters

Notes

Engineer/Ap CEE
plication
Developer

No

ADVDEVALM.DB,
DEVHIALM.DB,
DEVLOALM.DB,
OPHIALM.DB,
OPLOALM.DB,
PVHHALM.DB,
PVHIALM.DB,
PVLLALM.DB,
PVLOALM.DB

Individual alarm deadbands


are not individually
configurable.

Yes

Application
Developer

CEE

No

ADVDEVALM.DBU,
DEVHIALM.DBU,
DEVLOALM.DBU,
OPHIALM.DBU,
OPLOALM.DBU,
PVHHALM.DBU,
PVHIALM.DBU,
PVLLALM.DBU,
PVLOALM.DBU

Individual alarm deadbands


are not individually
configurable.

Yes

Operator
CEE
RM only:
Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform.

No

INALM

For CM, when On,


ALMENBSTATE allows
alarms detected by
component blocks within the
CM to propagate out of the
CEE to alarm displays and
journals. When Off, alarms
reports do not propagate out
of the CEE, but alarm flags
reflect current alarm state.
When ALMENBSTATE
changes from Off to On, all
active alarms are
regenerated.

Function Block Parameters

Active
Connector

Description

Data Type

Range

Default

Config
Load

Access
Lock

ALMTM

DataAcq,
Filter Time for all
All RegCtl Blocks
alarms
except Fanout:
AutoMan, OvrdSel,
PID, PIDFF, PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

32-Bit
Unsigned
Integer

0 to 60

Yes

AREVISION

RM

Application
8-Bit
Revision. Identifies Unsigned
the minor revision of Integer
the RM application
code.

0 to 255

ARWNET [1..8]

All RegCtl Blocks:


AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Network Anti-Reset Enumeration


Windup Status for ARWNET
the primary - Applies
to function blocks
with multiple
initializable inputs.
Contains the windup
status of each
initializable input.

Normal (0):
The input is
free to move
in any
direction.
Hi (1):
The input
cannot move
higher, but is
free to move
lower.
Lo (2):
The input
cannot move
lower, but is
free to move
higher.
HiLo (3):
The input
cannot move
in any
direction.

Normal
(0)

Residence

Active
Connector

Related
Parameters

Notes

Engineer/Ap CEE
plication
Developer

No

ADVDEVALM.TM,
CMDDISALM.TM
[0..2],
CMDFALALM.TM
[0..2],
DEVHIALM.TM,
DEVLOALM.TM,
OPHIALM.TM,
OPLOALM.TM,
PVHHALM.TM,
PVHIALM.TM,
PVLLALM.TM,
PVLOALM.TM

Individual alarm deadbands


are not individually
configurable.

No

View Only
Not Loaded
Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform.

No

No

View Only

No

ARWOP

ARWNET(1) computation is
independent of whether gain
(K) is positive or negative.

CEE

Function Block Parameters

Specific to
Block(s)

10

Parameter

Specific to
Block(s)

Description

Data Type

ARWOP

All RegCtl Blocks:


AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Output Anti-Reset Enumeration


Windup Status ARWNET
Applies to function
blocks with, at most,
one output (OP)
connection.
Contains the windup
status of the OP
variable.

ARWOP [1..8]

Fanout

Output Anti-Reset Enumeration


Windup Status ARWNET
Applies to function
blocks with multiple
output
(<Ftw.Cbpr.Oxxxx
Parameters.OP
[1..8]>OP)
connections.
Contains the windup
status of each OP
variable.

ASACONNSTS

All IOM Function


Blocks except
Serial Interface
IOM for
Troubleshooting
only.
Refer to
ASACONNSTS
[0..7] for Serial
Interface IOM.

ASA Connection
Status

ASACONNSTS
[0..7]

Serial Interface
IOM

ASA Connection
Status

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Normal (0):
Normal
OP is free to (0)
move in either
direction.
Hi (1):
OP is free to
move in the
lower
direction.
Lo (2):
OP is free to
move in the
higher
direction.
HiLo (3):
OP cannot
move in any
direction.

No

View Only

CEE

No

ARWNET [1..8]

Normal:
Free to move
in either
direction.
Hi:
Free to move
in the lower
direction.
Lo:
Free to move
in the higher
direction.
HiLo:
Cannot move
in any
direction.

No

View Only

CEE

No

ARWNET [1..8]

32-Bit Integer 0x0 to 0x8000

No

View Only

CEE

No

0x4000 indicates
running/connected (good
status).

32-Bit Integer 0x0 to 0x8000

No

View Only

CEE

No

0x4000 indicates
running/connected (good
status).

Normal

Notes

Function Block Parameters

Parameter

11

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

ASAERRCODE

All IOM Function


ASA Error Code
Blocks except
Serial Interface
IOM To be used
for Troubleshooting
only.
Refer to
ASAERRCODE [0..7]
for Serial Interface
IOM.

32-Bit Integer

No

View Only

CEE

No

ASAERRINFO

General status code for


ASA/ControlNet messaging.

ASAERRCODE
[0..7]

Serial Interface
IOM

32-Bit Integer

No

View Only

CEE

No

ASAERRINFO [0..7]

General status code for


ASA/ControlNet messaging.

ASAERRINFO

All IOM Function


ASA Error
Blocks except
Information
Serial Interface
IOM for
Troubleshooting
only.
Refer to
ASAERRINFO [0..7]
for Serial Interface
IOM.

32-Bit Integer

No

View Only

CEE

No

ASAERRCODE

Extended status information


for ASA/ControlNet
messaging.

ASAERRINFO
[0..7]

Serial Interface
IOM

ASA Error
Information

32-Bit Integer

No

View Only

CEE

No

ASAERRCODE [0..7]

Extended status information


for ASA/ControlNet
messaging.

ASTEPID

DevCtl,
All RegCtl Blocks:
AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Active step handle in 32-Bit Integer 1 to 1023


Sequential Control
Module (SCM)
Control Request
(CONTROLREQ).

No

View Only

CEE

No

CONTROLREQ,
SCMASTEP [1..10]

AUTOSYNCCMD RM

Description

ASA Error Code

Auto
Synchronization
Command

Data Type

Enumeration

Range

Default

Never (0)
Never (0) No
Always (1)
Conditional (2)

Operator
Not Loaded
Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform.

No

Function Block Parameters

Specific to
Block(s)

12

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

AUTOSYNCOPT

RM

Auto
Synchronization
Option.

Enumeration

Never (0)
Never (0) No
Always (1)
Conditional (2)

View Only
Not Loaded
Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform.

No

Disabled (0)
Enabled (1)

Disabled No
(0)

View Only
Not Loaded
Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform.

No

Auto
Enumeration
Synchronization
State - Present State
of Redundancy
Module
Auto-Synchronizatio
n

AUXCMD

SCM

Auxiliary Sequential 32-Bit Integer


Control Module
(SCM) Command

No

Operator

CEE

No

AUXDATA [0..7]

SIFLAGARRCH,
SINUMARRCH,
SITEXTARRCH

Auxiliary
64-Bit Real
Configuration Data Number
Used for specifying
additional
configuration
parameters for the
FTA application; a
generic array is
provided because
each value can mean
different things for
different FTA
applications.
AUXDATA is
writable while
online.

NaN

Yes

Application
Developer

CEE

No

AUXDESC [0..10]

CEE, CPM

Internal parameter
for system use only.

AUXOPT

SCM

Auxiliary Sequential 32-Bit Integer


Control Module
(SCM) Request.

No

Engineer

CEE

No

Notes

AUXSTS,
AUXREQDATA [1..5]

Parameter for use with Batch


Level 3. AUXCMD reset
value is zero.

AUXCMD, AUXREQ, Parameter for use with Batch


AUXREQDATA [1..5], Level 3.
AUXSTS, AUXUNIT SCM AUXxx parameters are
used for interfacing to
RSBatch.

Function Block Parameters

AUTOSYNCSTAT RM

Related
Parameters

13

Description

AUXREQ

SCM

AUXREQDATA
[1..5]

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

Auxiliary Sequential 32-Bit Integer


Control Module
(SCM) Request.

No

Operator

CEE

No

AUXCMD, AUXSTS,
AUXREQDATA [1..5]

Parameter for use with Batch


Level 3.
The AUXREQ reset value is
zero.

SCM

Auxiliary SCM
Request Data

NaN

No

Operator

CEE

No

AUXCMD, AUXSTS,
AUXREQ

Parameter for use with Batch


Level 3.
The AUXREQDATA [1..5]
reset value is NaN.

AUXSTS

SCM

Auxiliary Sequential 32-Bit Integer


Control Module
(SCM) Status.

No

Operator

CEE

No

AUXCMD, AUXREQ, Parameter for use with Batch


AUXREQDATA [1..5] Level 3.
The AUXSTS reset value is
zero.

AUXUNIT

SCM

Auxiliary Unit.

No

Operator

CEE

No

AUXCMD, AUXREQ, Parameter for use with Batch


AUXREQDATA [1..5], Level 3.
AUXSTS, AUXOPT
SCM AUXxx parameters are
used for interfacing to
RSBatch.

AV

Pulse Input IOC,


Accumulated Value 64-Bit Real
Pulse Input w/ Fast Engineering Units Number
Cutoff IOC
value corresponding
to the raw pulse
count.

NaN

No

View Only

CEE

Yes

AVSTS

AV [0..7]

Pulse Input IOM

Accumulated Value 64-Bit Real


Engineering Units Number
value corresponding
to the raw pulse
count.

NaN

No

View Only

CEE

Yes

AVERSION

RM

Application Version. 8-Bit


Identifies the major Unsigned
revision of the RM Integer
application code.

No

View Only

Not Loaded No
Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform.

AVRAW

Pulse Input IOC,


Raw Accumulated
Pulse Input w/ Fast Value Raw pulse
Cutoff IOC
count.

32-Bit
Unsigned
Integer

No

View Only

CEE

No

AVRAW [0..7]

Pulse Input IOM

32-Bit
Unsigned
Integer

No

View Only

CEE

Yes

Raw Accumulated
Value Raw pulse
count.

Data Type

Range

64-Bit Real
Number

32-Bit Integer

0 to 255

Greater-than
or equal-to
zero.

AVRAWSTS

Function Block Parameters

Specific to
Block(s)

14

Parameter

Parameter

Specific to
Block(s)

AVRAWSTS

Data Type

Range

Pulse Input IOC,


Bad Raw
Pulse Input w/ Fast Accumulated Value
Cutoff IOC
Status.

Enumeration

Bad (0)
Uncertn (1)
Normal (2)
Manual (3)

AVSTS

Pulse Input IOC,


Bad Accumulated
Pulse Input w/ Fast Value Status
Cutoff IOC

Enumeration

Bad (0)
Uncertn (1)
Normal (2)
Manual (3)

B[1..6]

RegCalc

Real

BACKCALCCONN All RegCtl Blocks:


AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Description

Individual bias for


each input X[1]
through X[6].

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

No

View Only

CEE

No

AVRAW

Off

No

View Only

CEE

No

AV

0.0

Yes

Operator

CEE

No

X[1..6]

No

Application
Developer

CEE

Yes

BACKCALCOUT,
BACKCALCIN establishes the
BACKCALCOUT[1..4], initialization, override, and
BACKCALCOUT[1..8] windup propagation
between connected
Regulatory Control (RegCtl)
and Analog Output (AO)
Blocks. This is one half of
the
BACKCALCIN/BACKCALCOU
T connection.

BACKCALCIN establishes the


initialization, override, and
windup propagation
between connected
Regulatory Control (RegCtl)
and Analog Output (AO)
Blocks. This is one half of
the
BACKCALCIN/BACKCALCOU
T connection.

Function Block Parameters

Secondary Data
Structure
structure associated
with Regulatory
Control Block
output(s). Contains
Calculated Value
(CV) limits,
initialization, and
data windup status,
etc.. BACKCALCIN
is associated with
the secondary block,
and therefore is
related to the
number of outputs
used on the primary
block. Connecting
BACKCALCIN to its
BACKCALCOUT
partner is required
in order to establish
the initialization
path between the
two blocks.

Default

15

Description

BACKCALCIN

All RegCtl Blocks


except Fanout:
AutoMan, OvrdSel,
PID, PIDFF, PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

BACKCALCIN
[1..3]

DevCtl

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

Secondary Data
Structure
structure associated
with Regulatory
Control Block
output(s). Contains
Calculated Value
(CV) limits,
initialization, and
data windup status,
etc.. BACKCALCIN
is associated with
the secondary block,
and therefore is
related to the
number of outputs
used on the primary
block. Connecting
BACKCALCIN to its
BACKCALCOUT
partner is required
in order to establish
the initialization
path between the
two blocks.

No

View Only

CEE

Yes

BACKCALCOUT,
BACKCALCIN establishes the
BACKCALCOUT[1..4], initialization, override, and
BACKCALCOUT[1..8] windup propagation
between connected
Regulatory Control (RegCtl)
and Analog Output (AO)
Blocks. This is one half of
the
BACKCALCIN/BACKCALCOU
T connection.

BackCalc Record - Structure


Secondary Data
structure associated
with Device Control
Block output(s). This
structure contains
status information
from the Digital
Output Channel
(DOC) block.
BACKCALCIN is
associated with the
secondary block, and
therefore is related
to the number of
outputs used on the
primary block.
Connecting
BACKCALCIN to its
BACKCALCOUT
partner is required
in order to establish
the initialization
path between the
two blocks.

No

View Only

CEE

Yes

BACKCALCOUT

BACKCALCIN establishes the


initialization propagation
between connected Device
Control and Digital Output
Channel Blocks. This is one
half of the
BACKCALCIN/BACKCALCOU
T connection.

Function Block Parameters

Specific to
Block(s)

16

Parameter

Parameter

Specific to
Block(s)

Description

BACKCALCIN
[1..8]

Fanout

BACKCALCOUT

AOC, DOC, PWM


Channel, AutoMan,
Fanout, PID, PIDFF,
PosProp.

Data Type

Range

Default

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

Secondary Data
Structure
structure associated
with the Fanout
block output(s).
Contains Calculated
Value (CV) limits,
initialization, and
data windup status,
etc.. BACKCALCIN
is associated with
the secondary block,
and therefore is
related to the
number of outputs
used on the primary
block. Connecting
BACKCALCIN to its
BACKCALCOUT
partner is required
in order to establish
the initialization
path between the
two blocks.

No

View Only

CEE

Yes

BACKCALCOUT,
X1BACKCALOUT,
X2BACKCALOUT

BACKCALCIN establishes
the initialization, override,
and windup propagation
between connected
Regulatory Control (RegCtl)
and Analog Output (AO)
blocks. This is one half of
the
BACKCALCIN/BACKCALCOU
T connection.

BackCalc Record - Structure


Secondary Data
structure associated
with Regulatory
Control Block
input(s). Contains
Calculated Value
(CV) limits,
initialization, and
data windup status,
etc.. BACKCALCOUT
is associated with
the primary block,
and therefore is
related to the
number of inputs
used on the
secondary block.
Connecting
BACKCALCIN to its
BACKCALCOUT
partner is required
in order to establish
the initialization
path between the
two blocks.

No

View Only

CEE

No

BACKCALCIN,
BACKCALCIN[1..8]

BACKCALCOUT establishes
the initialization, override,
and windup propagation
between connected
Regulatory Control (RegCtl)
and Analog Output (AO)
blocks. This is one half of
the
BACKCALCIN/BACKCALCOU
T connection.

Function Block Parameters

Config
Load

17

Description

BACKCALCOUT
[1..4]

OvrdSel

BACKCALCOUT
[1..8]

Switch

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

Secondary Data
Structure
structure associated
with Regulatory
Control block
input(s). Contains
Calculated Value
(CV) limits,
initialization, and
data windup status,
etc. BACKCALCOUT
is associated with
the primary block,
and therefore is
related to the
number of inputs
used on the
secondary block.
Connecting
BACKCALCIN to its
BACKCALCOUT
partner is required
in order to establish
the initialization
path between the
two blocks.

No

View Only

CEE

No

BACKCALCIN

BACKCALCOUT establishes
the initialization, override,
and windup propagation
between connected
Regulatory Control (RegCtl)
and Analog Output (AO)
blocks. This is one half of
the
BACKCALCIN/BACKCALCOU
T connection.

Secondary Data
Structure
structure associated
with Regulatory
Control block
input(s). Contains
Calculated Value
(CV) limits,
initialization, and
data windup status,
etc. BACKCALCOUT
is associated with
the primary block,
and therefore is
related to the
number of inputs
used on the
secondary block.
Connecting
BACKCALCIN to its
BACKCALCOUT
partner is required
in order to establish
the initialization
path between the
two blocks.

No

View Only

CEE

No

BACKCALCIN

BACKCALCOUT establishes
the initializaiton, override,
and windup propagation
between connected
Regulatory Control (RegCtl)
and Analog Output (AO)
blocks. This is one half of
the
BACKCALCIN/BACKCALCOU
T connection.

Function Block Parameters

Specific to
Block(s)

18

Parameter

Specific to
Block(s)

Description

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

BACKLASHL

PosProp,
PidPosProp

Backlash Lower
compensation of
actuator (in
seconds).

Real

0.0 to 60.0
seconds

0.0
seconds

Yes

Supervisor

CEE

No

BACKLASHR

PosProp,
PidPosProp

Backlash Raise
Compensation of
actuator (in
seconds).

Real

0.0 to 60.0
seconds

0.0
seconds

Yes

Supervisor

CEE

No

BADCAL

AIC, AOC

Bad Calibration
Boolean
Indicator On a per
channel basis, this
parameter indicates
if calibration is bad
or missing.

Ok (0)
Ok (0)
BadCalibratio
n (1)

No

View Only

CEE

BADCAL[0..numC AIM, AOM


hans-1]

Bad Calibration
Boolean
Indicator On a per
channel basis, this
parameter indicates
if calibration is bad
or missing.

Ok (0)
Ok (0)
BadCalibratio
n (1)

No

View Only

CEE

BADCODE

All IO Channels,
SIFLAGARRCH,
SINUMARRCH,
SITEXTARRCH

Reason for Bad


States

No

View Only

CEE

BADCTLALM.FL

All RegCtl Blocks: Bad Control Alarm


AutoMan, Fanout, Flag
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Off (0)
On (1)

Off (0)

No

View Only

BADCTLALM.PR

All RegCtl Blocks:


AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

None (0)
Journal (1)
Low (2)
High (3)
Urgent (4)

Low (2)

Yes

Engineer

Integer

Boolean

Bad Control Alarm Enumeration


Priority Defines
ALPRIOR
the priority of a Bad
Control alarm.

Related
Parameters

Notes

No

CALBIAS

The BADCAL indicator may


also indicate that calibration
was aborted after inputs
were sampled or outputs
were referenced. This
condition is cleared by a
successful calibration.

No

CALBIAS

The BADCAL indicator may


also indicate that calibration
was aborted after inputs
were sampled or outputs
were referenced. This
condition is cleared by a
successful calibration.

CEE

No

BADCTLFL,
BADCTLALM.PR,
BADCTLALM.SV

CEE

No

BADCTLFL,BADCTLA
LM.FL,BADCTLALM.
SV

Function Block Parameters

Parameter

19

Description

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

BADCTLALM.SV

All RegCtl Blocks: Bad Control Alarm


AutoMan, Fanout, Severity
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

16-Bit Integer 0 to 255

Yes

Engineer

CEE

No

BADCTLFL,
BADCTLALM.FL,
BADCTLALM.PR

BADCTLFL

Automan, OvrdSel, Bad Control Flag


and Switch.
Indicates if a Bad
Control condition
exists.

Boolean

No

View Only

CEE

No

BADCTLALM.FL,
BADCTLALM.PR,
BADCTLALM.SV

BADCTLOPT

AutoMan, OvrdSel, Bad Control Option Enumeration


Switch.
Indicates what to do BADCTLOPT
when Calculated
Variable (CV) is NaN
(i.e., BADCTLFL =
On).

No_Shed (0): No_Shed Yes


ShedHold (1): (0)
ShedLow (2):
ShedHigh (3):
ShedSafe (4):

Engineer

CEE

No

BADCTLFL, ESWENB,
MODE, MODEATTR,
OP

Off (0): Bad


Off (0)
Control
condition does
not exist.
On (1): Bad
Control
condition
exists.

Notes

Function Block Parameters

Specific to
Block(s)

20

Parameter

BADINPTOPT[1..8 OvrdSel, Switch


]

Bad Input Option - Enumeration


Indicates if bad
BADINPTOPT
inputs (NaN) should
be included in the
input selection
process.

IgnoreBad (0): IncludeBa Yes


Ignore bad
d (1)
inputs.
IncludeBad
(1): Include
bad inputs.

Engineer /
Application
Developer

CEE

No

BADPV

DIC

Indicates the Digital Boolean


Input process
variable (PV) status.

Off (0)
On (1)

Off (0)

No

View Only

CEE

No

BADPVALM.FL

DataAcq, DevCtl

Bad PV Alarm Flag

Boolean

Off (0)
On (1)

Off (0)

No

View Only

CEE

No

BADPVALM.PR,
BADPVALM.SV,
HIALM, HIALM.PR,
HIALM.SV,
HIALM.TYPE

DevCtl Only: GPV,


NUMDINPTS
DevCtl Only: Illegal if
NUMDINPTS = 0.

BADPVALM.PR

DataAcq, DevCtl

Bad PV Alarm
Priority

Enumeration
ALMPR

None (0)
Journal (1)
Low (2)
High (3)
Urgent (4)

DataAcq Yes
only: Low
(2)
DevCtl
only:
None (0)

Engineer

CEE

No

DataAcq only:
BADPVALM.FL,
BADPVALM.SV,
PVSTSFL.BAD
DevCtl only:
BADPVALM.FL,
BADPVALM.SV,
NUMDINPTS

DevCtl only: Illegal if


NUMDINPTS = 0.

Specific to
Block(s)

Description

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

BADPVALM.SV

DataAcq, DevCtl

Bad PV Alarm
Severity

16-Bit Integer 0 to 15

Yes

Engineer

CEE

No

DevCtl Only:
BADPVALM.FL,
BADPVALM.PR,
NUMDINPTS
DataAcq Only:
BADPVALM.FL,
BADPVALM.PR,
PVSTSFL.BAD

DevCtl only: Illegal if


NUMDINPTS = 0.

BADPVFL

SIFLAGARRCH,
SINUMARRCH,
SITEXTARRCH

Bad PV Flag Flag Boolean


that indicates that
an error response
was received for the
last request sent by
this request block.
Note that this flag is
set to TRUE for both
local errors
(communication
errors that
prevented the
request from being
sent out on the
network, for
example) and
remote errors (the
target device could
not process the
request and so sent
an explicit failure
status). For alarming
on errors, connect
the ERRFL to a Flag
Block and configure
the Flag Block to
send an Alarm when
ERRFL is TRUE.

Off (0)

No

View Only

CEE

No

ERRFL

BADPVFL is always equal to


ERRFL. This parameter is
provided to be consistent
with other function blocks
that provide a BADPVFL.

BADSO

Pulse Input w/ Fast Bad Input State Flag Boolean


Cutoff IOC
When On, this
parameter indicates
the current value of
Output State (SO) is
does not necessarily
reflect the value of
the modules
terminal screws..

Off (0): Current Off (0)


value of
Output State
(SO) is valid.
On (1): Current
value of
Output State
(SO) is invalid.

No

View Only

CEE

No

Off (0)
On (1)

Affects Channels 6-7 only.


Function Block Parameters

Parameter

21

Description

Data Type

Range

Default

BADSO[6..7]

Pulse Input IOM

Bad Input State Flag Boolean


When On, this
parameter indicates
the current value of
Output State (SO) is
does not necessarily
reflect the value of
the modules
terminal screws..

Off (0): Current Off (0)


value of
Output State
(SO) is valid.
On (1): Current
value of
Output State
(SO) is invalid.

BASEPERIOD

CEE

Base Period for the Integer


CEE function block in
milliseconds (ms).

5 ms (0)
50ms (1)

50 ms (1)

BATTERYNOTOK CPM

Battery Not Okay - Boolean


When On, indicates
CPM Battery is
either in a low
voltage condition,
not connected, or
not present.

Off (0)
On (1)

Off (0)

BECMPRICMD

RM

Become Primary
Command

Boolean

True (0)
False (1)

True (0)

BFF

PIDFF

Feedforward Input
Bias

Real

Config
Load

Access
Lock

Residence

Active
Connector

No

View Only

CEE

No

Application
Developer

CEE

No

View Only

CEE

No

Operator.
Not Loaded
Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform.
Operator

CEE

Related
Parameters

Notes
Affects channels 6-7 only.

The base period must be set


in accordance with the
software personality image
that is loaded to the CPM
controller. The CEEREX2
personality image is used
with a 50 ms base cycle. The
FEEREX2 personality is used
with the 5 ms base cycle. If
the configured value is not
supported by the personality
image, an error will be
returned upon load of the
CPM/CEE block.
The 50 ms base period (or 50
ms CEE) supports block
execution periods from 50
ms to 2000 ms.
The 5 ms base period (or 5
ms CEE) supports block
execution periods from 5 ms
to 200 ms.
No

A diagnostic alarm is issued


from the CPM function block
whenever BATTERYNOTOK
goes to On.

No

SIFL, PV, FF, SP

Function Block Parameters

Specific to
Block(s)

22

Parameter

Specific to
Block(s)

Description

Data Type

BOOLVALUEOFF

TypeConvert

Used to convert
Boolean values to
Enumeration.

BOOLVALUEON

TypeConvert

Used to convert
Boolean values to
Enumeration.

BREVISION

RM

Boot Revision.
8-Bit
Identifies the minor Unsigned
revision of the RM Integer
boot code.

BVERSION

RM

BYPASS

BYPPERM

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

Enumeration Enum0 to
TCGENERICEN Enum63
UM

Enum0

Yes

Engineer

CEE

No

BOOLVALUEON

This is applicable for


conversion between Boolean
and Enumeration values.
The output Enumeration
value will be whatever the
BOOLVALUEOFF is set to.

Enumeration Enum0 to
TCGENERICEN Enum63
UM

Enum1

Yes

Engineer

CEE

No

BOOLVALUEOFF

This is applicable for


conversion between Boolean
and Enumeration values.
The output Enumeration
value will be whatever the
BOOLVALUEON is set to.

0 to 255

No

View Only
Not Loaded
Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform.

No

Boot Version.
8-Bit
Identifies the major Unsigned
revision of the RM Integer
boot code.

0 to 255

No

View Only
Not Loaded
Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform.

No

DevCtl

Permissive and
Interlock Bypass

Boolean

Off (0)
On (1)

Off (0)

Yes

Operator

CEE

No

BYPPERM,
Can be changed only where
NUMDOUTS, OI[0..2], BYPPERM = On. When On,
OP, PI[0..2]
Override and Permissive
Interlocks are bypassed.
Default to Off when
BYPPERM is set to Off.
Illegal if NUMDOUTS = 0.

DevCtl

Override and
Permissive Bypass
Permit

Boolean

Off (0)
On (1)

Off (0)

Yes

Engineer

CEE

No

BYPASS, OI[0..2],
When On, allows BYPASS to
PI[0..2],NUMDOUTS be set to bypass the
Permissive and Override
Interlocks OI[0..2] and
PI[0..2].
Illegal if NUMDOUTS = 0.

Function Block Parameters

Parameter

23

Description

Data Type

C [1..8]

Auxcalc

Results of up to
eight calculator
expressions.

64-Bit Real
Number

RegCalc

Expression result for Real


each user input
expression
EXPR[1..8]

Range

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

NaN

No

View Only

CEE

No

CSTS[1..8]

NaN

No

View Only

CEE

No

CSTS[1..8]

Off (0)

Yes

Engineer

CEE

No

C [1..10].BYPREQ, C
[1..10].FL
C [1..10].BYPPERM, C
[1..10].FL

Notes

C
Transition
[1..10].BYPPERM

Conditional Force
Permit

Boolean

C [1..10].BYPREQ Transition

Conditional Force
Request

Enumeration ToOff (0)


CSCOBYPREQ ToOn (1)
None (2)

None (2)

No

Operator

CEE

No

C
Transition
[1..10].CONFIGCO
DE

Condition
Configuration Code

Enumeration See below


CSCOCONFIG
CODECOND

None (0)

No

View Only

CEE

No

See C [1..10].CONFIGSTS for


additional information.

CEE

No

See C [1..10].CONFIGSTS for


additional information.

None (0)
Ok (1)
UnknownError (2)
ImplictConv (3)
LossOfPrecsn (4)
UnexpctEnd (5)
UnexpctComma (6)
ColonWoQMark (7)
FctNotMltArg (8)
ClosParenExp (9)
OperandExp (10)
MissingArg (11)
OperatorExp (12)
ColonExp (13)
TypeMismatch (14)
TypeNotSupp (15)
SyntaxError (16)
ExprTooCmplx (17)
NotEPcodeMe (18)
NotEDataStak (19)
UnsuppFeatur (20)
C
Transition
[1..10].CONFIGDE
SC

Conditional
Configuration
Descriptor

String

Off (0)
On (1)

Default

Range
ExprTooLong (21)
DivideByZero (22)
UnknownToken (23)
UnexpTokenOS (24)
UnknownFunc (25)
UnexpOCExpr2 (26)
UnexpOCExpr3 (27)
ZeroArgument (28)
UnexpToken (29)
InvalResult (30)
InvalTokenTb (31)
IntegerExp (32)
DoubleExp (33)
MissedImpl (34)
UnicodeConv (35)
ConstExprRem (36)
DuplExprRem (37)
ExtUse38 (38)
ExtUse39 (39)
ExtUse40 (40)
ExtUse41 (41)
None

If C [i].BYPPERM is On, C
[i].FL will be set according to
C [i].BYPREQ.

ExtUse42 (42)
ExtUse43 (43)
ExtUse44 (44)
ExtUse45 (45)
ExtUse46 (46)
ExtUse47 (47)
ExtUse48 (48)
ExtUse49 (49)
ExtUse50 (50)
UnSupConType (51)
UnExpClsParn (52)
CantAssRVal (53)
UnExpArrOpen (54)
ArrClsExpect (55)
ArrOpnExpect (56)
ArrIndxError (57)
StringExpect (58)
InvalidRefer (59)
TooManyConns (60)
CantConvInpt (61)
No

View Only

Function Block Parameters

Specific to
Block(s)

24

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

C
[1..10].CONFIGCODE,
C
[1..10].CONFIGDESC

Transition input condition


configuration status
parameters C
[1..10].CONFIGSTS, C
[1..10].CONFIGCODE, and C
[1..10].CONFIGDESC are set
on SCMSTATE transition
from Inactive to Validated.

Condition
Enumeration Ok (0)
Ok (0)
Configuration Status CSCOCONFIG Information (1)
Warning (2)
SevereWarn
(3)
Fail (4)
Error (5)
SevereError
(6)

No

View Only

CEE

No

C [1..10].DESC

Transition

Condition
Description

Yes

Application
Developer

SR

No

C [1..10].
EXECCODE

Transition

Condition Execution Enumeration None (0)


None (0)
Code
CSCOEXECCO ConfigError (1)
DE
ExprEvalFail
(2)
StoreFailed (3)
CommError (4)
StoreWarning
(5)
InternalErr (6)
CtrlReqErr (7)
DataTypeErr
(8)
StorePending
(9)

No

View Only

CEE

No

See C [1..10].EXECSTS for


additional information.

C [1..10].
EXECDESC

Transition

Condition Execution String


Code Descriptor

None

No

View Only

CEE

No

See C [1..10].EXECSTS for


additional information.

C [1..10].
EXECSTS

Transition

Condition Execution Enumeration Ok (0)


Ok (0)
Status
SCSCOEXECS Bypass (1)
TS
Info (2)
Warning (3)
Fail (4)
Error (5)
OkPaused (6)
BypassPaused
(7)
InfoPaused (8)
WarnPaused
(9)
FailPaused
(10)
ErrorPaused
(11)

No

View Only

CEE

No

C [1..10].EXPR

Transition

Condition Expression String

Yes

Application
Developer

SR

No

String

Maximum
string length
is 23
characters.

Length: 255
characters.

Null
String

Null
String

C [1..10].EXECCODE, Transition input condition


C [1..10].EXECDESC execution status parameters
C [1..10].EXECSTS, C
[1..10].EXECCODE, and C
[1..10].EXECDESC are update
when the transition is in the
Sequential Control Modules
(SCM) current scope of
execution.

Function Block Parameters

C
Transition
[1..10].CONFIGST
S

25

Description

C [1..10].
EXPRPCODE

Transition

Internal parameter
for system use only.

C [1..10].FL

Transition

Condition Status
Flag

C [1..10].
GATEASGN

Transition

Internal parameter
for system use only.

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

Boolean

Off (0)
On (1)

Off (0)

No

View Only

CEE

No

Boolean

Off (0)
On (1)

Off (0)

No

View Only

CEE

No

C [1..10].FL

C [i].INVOKFL on invoke
transition is updated from C
[i].FL at the time of handler
invocation.

C [1..10].INVOKFL Transition

Invoke Transition
Condition Invoke
Flag

C1

Engineering Units
64-Bit Real
scaling factor for the Number
calculation of
DELAYTIME or
Totalizer Process
Variable (PV).

Any Real
1.0
Number, NaN
is not allowed.

Yes

Deadtime:
Engineer
Totalizer,
Pulse Input
Totalizer:
Operator

CEE

No

DELAYTIME, D1

Pulse Input IOC,


Engineering Units
64-Bit Real
Pulse Input w/ Fast scale factor
Number
Cutoff IOC
(dimensionless)
For example, a factor
to convert gallons to
barrels.

Any Real
1.0
Number, NaN
is not allowed.

Yes

View Only

CEE

No

C2, AV, PV

For Pulse Input, C1 is used to


calculate AV and PL in EU as
follows:
AV in EU = (C1/C2) * Counter
Value
Frequency value in EU
(C1/C2) *
TIMEBASE*Counter Value.

Pulse Input IOM

3.4 e 38 to
3.4 e 38

Yes

Application
Developer

CEE

No

C2, AV, PL, TV

For Pulse Input IOM, C1 is


used to calculate AV and PL
in EU as follows:
AV in EU = (C1/C2) * AVRAW
PV in EU = (C1/C2) *
TIMEBASE *
pulses/(Frequency
Integration Period)
TV in EU = (C1/C2) * TVRAW

C1[0..7]

Totalizer, Pulse
Input Totalizer,
Deadtime

Engineering Units
64-Bit Real
scale factor
Number
(dimensionless) for
example, a factor to
convert gallons to
barrels.

1.0

Function Block Parameters

Specific to
Block(s)

26

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

C2

Pulse Input
Totalizer

Scaling factor for


64-Bit Real
consistency with
Number (Not
Pulse Input channels NaN)

Deadtime

Scaling factor for the Real Number


P2 input.

Range

Config
Load

Access
Lock

Residence

Active
Connector

Any Real
1.0
number, NaN
not allowed.

Yes

Operator

CEE

No

Any Real
1.0
Number, NaN
not allowed.

Yes

Engineer

CEE

No

1.0

Yes

View Only

CEE

1.0

Yes

Application
Developer

1.0

Yes

1.0

Pulse Input IOC,


Meter factor in
64-Bit Real
Pulse Input w/Fast pulses per
Number
Cutoff IOC
Engineering Units.
For example, the
number of pulses per
gallon.

3.4 e 38 to
3.4 e 38

Default

Related
Parameters

Notes

No

AV,PV

For Pulse Input IOM, this is


used to calculate AV and PV
in EU as follows:
AV in EU = (C1/C2) * Counter
Value
Frequency value in EU =
(C1/C2) * TIMEBASE *
Counter Value

CEE

No

AV, C2, PL, TV

For Pulse Input IOM, C2 is


used to calculate AV, PV, and
TV in EU as follows:
AV in EU = (C1/C2) * AVRAW
PV in EU = (C1/C2) *
TIMEBASE *
pulses/Frequency Integration
Period)
TV in EU = (C1/C2) * TVRAW

View Only

CEE

No

Yes

Application
Developer

CEE

No

C2[0..7]

Pulse Input IOM

Meter factor in
64-Bit Real
pulses per
Number
Engineering Unitls
for example, number
of pulses per gallon.

C3

Pulse Input IOC

Pulse Length scale 64-Bit Real


factor used to scale Number
the Pulse Period,
Pulse High and Pulse
Low values to
Engineering Units.

C3[0..5]

Pulse Input IOM

Pulse Length
64-Bit Real
measurement
Number
Engineering Units
conversion factor (in
Engineering Units
per unit of time).

CALBIAS

AIC, AOC

Calibration Bias
Specifies a bias
value which is
applied to the raw
analog data.

64-Bit Real
Number

No

View Only

CEE

No

BADCAL

CALBIAS[0..5] is accessible
by the Application Developer
on the Configuration Form
only.

CALBIAS
[0..numChans-1]

AIM, AOM

Calibration Bias
Specifies a bias
value which is
applied to the raw
analog data.

64-Bit Real
Number

Yes

Application
Developer

CEE

No

BADCAL

CALBIAS[0..5] is accessible
by the Application Developer
on the Configuration Form
only.

3.4 e 38 to
3.4 e 38

For Pulse Input IOM


(Channels 0-5 only), this is
used to calculate Pulse
Length in Engineering Units:
PL in EU = (C3) * Timer Latch
Value in microseconds.
Function Block Parameters
27

Description

CASREQFL

PID, PIDFF, PosProp Cascade Request


Boolean
RemCas, RatioBias Flag - If set, means
the function block
was in cascade, then
shed mode due to
input timeout, and
will return to
cascade as soon as
it fetches a good
input.

CATNUMBER

All IOM Function


Blocks

Catalog Number

Data Type

Range

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Off (0)
Off (0)
On (1): Mode
was shed due
to timeout;
waiting to
return to
cascade
mode.

No

Other
Function
Block

CEE

No

MODE

See
below

Yes

Application
Developer

CEE

No

Although loaded, this


parameter is not exposed on
any configuration form.

No

CCLNAME, CCLINFO Gives a count of the number


of CCLs loaded to the CPM at
any given time.

32-Bit Integer

Default

Notes

Function Block Parameters

Specific to
Block(s)

Default

1756-IF6I: 1
1756-IF16: 6
1756-IA16: 5
1756-IB32: 12
1756-IB16I: 6
1756-IA16I: 5
1756-IM16I: 6
1756-IA8D: 1
CCLCNT

CPM

Number of Loaded
Control Component
Libraries (CCLs) in
the Control
Processor Module
(CPM).

16-Bit Integer

CCLINFO

CPM

Control Component
Library (CCL)
management
information.

String (One
Dimensional
Array)

CCLLOADSTAT

CPM

Control Component
Library (CCL) load
status.

CCLNAME

CPM

List of loaded
libraries.

CCLPACKET

CPM

Library Load
Parameter

1756-IB16D: 2
1756-IR6I: 2
1756-IT6I: 5
TC- MUX021: 0
1756-OF6CI: 4
1756-OF6VI: 3
1756-OF8: 9
1756-OA16: 7

1756-OB32: 17
1756-OB16I: 7
1756-OA16I: 7
1756-OA8D: 4
1756-OB16D: 4
1757-PIM: 8

No

View Only

CEE

Null
String

No

View Only

CEE

16-Bit Integer None

No

View Only

CEE

No

String (One
Dimensional
Array)

Null
String

No

View Only

CPM

No

Engineer

CEE

0 to 49

0 to 40

CCLCNT, CCLNAME

Internal Control Component


Library (CCL) Management
Information.
Load status of CCL last
loaded to the CPM.

CCLCNT, CCLINFO

28

Parameter

Contains the names of all the


loaded libraries in the CPM.

Parameter

Specific to
Block(s)

Description

Data Type

Range

CEECOMMAND

CEE, CPM

Control Execution
Environment
Command

Enumeration Idle (0)


CEECOMMAN Run (1)
D
None (2)

CEESTATE

CEE, CM, SCM,


IOM, CPM

Control Execution
Enumeration
Environment State - CEESTATE
Gives current state
of CEE.

Default

Config
Load

Access
Lock

None (2)

No

No

Idle(0)
Idle(0)
Run(1)
Failed(2)
NotLoaded(3)

Residence

Related
Parameters

Notes

Supervisor or CEE
Engineer
whan an Idle
command is
stored to
CEECOMMA
ND and the
CEE is in the
Run state.
Supervisor,
Engineer or
Operator
when a
CEECOMMA
ND of Run is
stored and
the CEE is in
Idle.

No

CEESTATE

Stores to this parameter


cause CEESTATE to change
between Idle and Run.

View Only

No

CEECOMMAND,
EXECSTATE,
PCMSTATE

Although this parameter is


most logically associated
with the CEE function block,
it is exposed as a parameter
on CM, SCM, IOM and CPM
as well. Note that
CEESTATE can be changed
only by writing to the
CEECOMMAND parameter.
When CEESTATE is Run, all
active blocks within the CEE
execute. When CEESTATE is
Idle, only CPM FB, CEE FB
and IOM FBs execute. CEE FB
issues a change of state
notification whenever
CEESTATE is changed.
CEESTATE holds the value
NOTLOADED until the first
load of the CEE FB. If
CEESTATE is RUN before a
power down and RAM state
is preserved by battery until
the next power up, then
CEESTATE is changed to Idle
as part of database retention
startup.

CEE

Function Block Parameters

Active
Connector

29

Specific to
Block(s)

Description

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

Function Block Parameters

CHANINUSE[0..31 RM, Serial


]
Interface IOM

Channel In Use
Boolean
Indicates whether
the Channel is
currently being used
(a value of On) or not
(a value of Off).

Off (0)
On (1)

Off (0)

No

View Only
CEE
RM only:
Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform.

No

CHANSTS[0..31]

CHANSTS[0..31]

RM, Serial
Interface IOM

Channel Status
Enumeration
Provides a status for
each channel of the
module.

NotUsed(0)
Ok(1)
Bad(2)

NotUsed( No
0)

View Only
CEE
RM only:
Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform.

No

CHANINUSE[0..31],
ERRFL[0..31]

CHANTEXT

IOM

Channel In Use
Boolean
Indicates whether
the Channel is
currently being used
(a value of On) or not
(a value of Off).

Off (0)
On (1)

Off (0)

View Only

CEE

No

CIPNAME

RSPNUMARRAY
RSPFLAGARRAY
RSPTEXTARRAY

CIP Tag Name

Maximum of Blank
Yes
40 characters (no name)

Application
Developer

CEE

CJDISABLE

AIM, RM

Cold Junction
Boolean
Disable Appears
as a configuration
checkbox that when
enabled allows
CJOFFSET to be
configured.

Off (0)
On (1)

Yes

Application CEE
Developer
RM only:
Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform.

No

CJOFFSET

For AIM, CJDISABLE is only


configurable on the
Thermocouple Module.

CJOFFSET

AIC

Cold Junction Offset 64-Bit Real


- Offset to be added Number
to cold junction
temperature as a
correction factor.

-5 to +5
0.0
degrees (C or
F)

No

View Only

No

CJDISABLE,
CALBIAS</HH.

Configurable only when


CJDISABLE is set.

String

Off (0)

No

Not Loaded

30

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Yes

Application
Developer

CEE
(1756-IF16
not loaded)

No

CJDISABLE,
CJOFFSET is accessible by
CALBIAS[0..numChan the Application Developer on
s-1] (AIM only).
the Thermocouple AIM
Configuration Form only.
Configurable only when
CJDISABLE is set.

Standard No
(0)

View Only
Not Loaded
Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform.

No

Cold Junction Offset 64-Bit Real


- Offset to be added Number
to cold junction
temperature as a
correction factor.

-5 to +5
0.0
degrees (C or
F)

CLKADJUST

RM

Local clock
adjustment

Enumeration

Standard (0)
Daylight (1)

CLKTIME

RM

Clock time, as
reported by the
Redundancy
Module.

TIME

No

View Only
Not Loaded
Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform.

No

CLKZONE

RM

Time zone

16-Bit
Unsigned
Integer

No

View Only
Not Loaded
Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform.

No

CLROPREQFL

DevCtl

Clear Requested
Output Value
(OPREQ) Flag

Boolean

CMDATTR

Totalizer, Pulse
Input Totalizer

Totalizer Command Enumeration


Attribute - Specifies CMDATTR
who may store to
the COMMAND
parameter, (i.e., the
operator, another
function block, or
user program).

This parameter is not


supported in this release.

Off (0)
On (1)

Off (0)

No

Other
Function
Block

CEE

No

GOPREQ, OPREQ,
OPTYPE

Operator (0)
OtherFB (1)

Operator Yes
(0)

Operator

CEE

No

COMMAND

Function Block Parameters

CJOFFSET[0..num AIM
Chans-1]

Notes

31

Description

CMDDISALM.FL

DevCtl

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

Command Disagree Boolean


Alarm Flag

Off (0)
On (1)

Off (0)

No

View Only

CEE

No

CMDDISALM.PR,
CMDDISALM.SV,
CMDDISALM.TM[0..
2], GOP, GPV, HIALM,
NUMDINPTS,
NUMDOUTS, OP,
OPFINAL, PV

Illegal if NUMDINPTS = 0 or
NUMDOUTS = 0.
Illegal if all
CMDDISALM.TM[0..2] = 0.

CMDDISALM.PR DevCtl

Command Disagree Enumeration


Alarm Priority
ALPRIOR

None (0)
Journal (1)
Low (2)
High (3)
Urgent (4)

Low (2)

Yes

Engineer

CEE

No

CMDDISALM.FL,
CMDDISALM.SV,
CMDDISALM.TM[0..
2], NUMDINPTS,
NUMDOUTS

Illegal if NUMDINPTS = 0 or
NUMDOUTS = 0.
Illegal if
CMDDISALM.TM[0..2]= 0.

CMDDISALM.SV DevCtl

Command Disagree 16-Bit Integer 0 to 255


Alarm Severity

Yes

Engineer

CEE

No

CMDDISALM.FL,
CMDDISALM.PR,
CMDDISALM.TM[0..
2], NUMDINPTS,
NUMDOUTS

Illegal if NUMDINPTS = 0 or
NUMDOUTS = 0.
Illegal if all
CMDDISALM.TM[0..2] = 0.

CMDDISALM.TM[ DevCtl
0..2]

Command Disagree 32-Bit Integer 0 to 1000


Feedback Times seconds
The wait time for
each state, before
Command Disagree
Alarm becomes
active.

0 seconds Yes

Engineer

CEE

No

CMDDISALM.FL,
CMDDISALM.PR,
CMDDISALM.SV,
NUMDINPTS,
NUMDOUTS,
NUMSTATES

Function block must be


inactive to change to or from
0.
Illegal if NUMDINPTS = 0 or
NUMDOUTS = 0.
CMDDISALM.TM[2] is illegal
if NUMSTATES = 2.

CMDEXEC

SCM

Sequential Control Enumeration


Module (SCM)
CSCOEXECC
Execution Command

None (0)
Resume (1)
CheckConfig
(2)

None (0)

No

View Only

CEE

No

COMMAND

Used internally by the SCM


for execution stop and
restart related commands.
The COMMAND parameter
is the primary user interface
to the SCM.

CMDFALALM.FL

DevCtl

Command Fail Alarm Boolean


Flag

Off (0)
On (1)

Off (0)

No

View Only

CEE

No

CMDFALALM.PR,
CMDFALALM.SV,
CMDFALALM.TM[0..
2], GOP, GPV, HIALM,
NUMDINPTS,
NUMDOUTS, OP,
OPFINAL, PV

Illegal if NUMDINPTS = 0 or
NUMDOUTS = 0.
Illegal if all
CMDFALALM.TM[0..2] = 0.

CMDFALALM.PR DevCtl

Command Fail Alarm Enumeration


Priority
ALPRIOR

None (0)
Journal (1)
Low (2)
High (3)
Urgent (4)

Low (2)

Yes

Engineer

CEE

No

CMDFALALM.FL,
CMDFALALM.SV,
CMDFALALM.TM[0..
2], NUMDINPTS,
NUMDOUTS

Illegal if NUMDINPTS = 0 or
NUMDOUTS = 0.
Illegal if all
CMDFALALM.TM[0..2] = 0.

CMDFALALM.SV DevCtl

Command Fail Alarm 16-Bit Integer 0 to 255


Severity

Yes

Engineer

CEE

No

CMDFALALM.FL,
CMDFALALM.PR,
CMDFALALM.TM[0..
2], NUMDINPTS,
NUMDOUTS

Illegal if NUMDINPTS = 0 or
NUMDOUTS = 0.
Illegal if all
CMDFALALM.TM[0..2] = 0.

Function Block Parameters

Specific to
Block(s)

32

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

Command Fail Alarm 32-Bit Integer 0 to 1000


Time-outs The
seconds
wait time for each
state before
Command Fail Alarm
becomes active.

0 seconds Yes

Engineer

CEE

No

CMDDISALM.TM[0..
2], CMDFALALM.FL,
CMDFALALM.PR,
CMDFALALM.SV,
NUMDINPTS,
NUMDOUTS,
NUMSTATES

Function block must be


inactive to change to or from
0.
Must be less-than respective
CMDDISALM.TM[0..2].
Illegal if NUMDINPTS = 0 or
NUMDOUTS = 0.
CMDFALALM.TM[2] is illegal
if NUMSTATES =2.

COMMAND

SCM

Sequential Control Enumeration


Module (SCM)
CSCOCOMMA
Command - The
ND
SCM is commanded
by stores to this
parameter.

None (0)
Inactive (1)
Start (2)
Reset (3)
Interrupt (4)
Restart (5)
Hold (6)
Stop (7)
Abort (8)
Resume (9)
Active (10)

None (0)

No

Operator

CEE

No

STATE, MODE,
MODEATTR,
SSTEPLOCK,
ABORTLOCK,
CONTROLLOCK

Ability to change
COMMAND depends on the
current value of related
variables (listed above). See
the SCM State Transition
diagram for more details.

Timer

Timer Command Enumeration


Used by the operator TIMERCOMM
to control the
AND
operation of the
Timer function block.

None (0)
Reset (1)
Stop (2)
Restart (3)
Start (4)

None (0)

No

Operator

CEE

No

STATE, RESETFL,
Start: Timer is started; PV
STOPFL, RESTARTFL, starts incrementing.
STARTFL
Stop: Timer is stopped; PV
freezes.
Reset: Timer is reset; PV is
set to 0, and RV is set to SP.
Restart: Timer continues
from the point it last
stopped.

Totalizer, Pulse
Input Totalizer

Totalizer Command
Allows the
operator to control
the operation of a
Totalizer.

None (0):
No effect on
Totalizer.
Start (1):
Starts the
Totalizer.
Stop (2):
Stops the
Totalizer
Reset (3):
Resets the
Totalizer to
RESETVAL.

None (0)

No

Other
Function
Block

CEE

No

CMDATTR

Enumeration
COMMAND

Function Block Parameters

CMDFALALM.TM[ DevCtl
0..2]

33

Description

COMMAND
(cont)

REQFLAGARRAY,
REQNUMARRAY,
REQTEXTARRAY

Method that
Enumeration
specifies the type of
communication that
this block is
configured to
perform.
PLC5TypRead

CONFIGCODE

SCM, Handler,
RegCalc, Step,
Transition

Data Type

Configuration Code

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

See below

PLC5Typ
Read

Yes

Application
Developer

CEE

No

Range
Used if this block is to read data from a PLC-5 or a
CL5550 using the PLC-5 Typed Read Command.

PLC5TypWrite

Used if this block is to write data from a PLC-5 or a


CL5550 using the PLC-5 Typed write Command.

CIPRead

Used to read data from a CL5550

CIPWrite

Used to write data from a CL5550.

Enumeration See below


CSCOCONFIG
CODE

None (0)
UnknownError (1)
InternalErr (2)
ILLOwnHandle (3)
ILLHndlrHndl (4)
NextHNotNull (5)
ILLNNextTrns (6)
ConnInvObjs (7)
InvNextType (8)
NotImplNxTyp (9)
ILLExcConds (10)
ILLConds (11)
ILLOutputs (12)
IncObjects (13)
ILLNOutputs (14)
ILLNConds (15)

None (0)

No

View Only

Range
ILLGateLogic (16)
ActIgnored (32)
IncGateLogic (17)
EditIgnored (33)
NullGateUsed (18) TooFewCond (34)
OvlpGateInps (19)
MaxTmLtMinT (35)
SkipGateInps (20)
NegativeTime (36)
ILLInvkTObj (21)
EnbHdUnavail (37)
ILLInvkTCnfg (22)
DisHdUnavail (38)
ILLHndlrType (23)
EditNotPermt (39)
ILLHndlrSel (24)
IntGateError (40)
HndlrInstMis (25)
UserNullHnd (41)
ILLExcCProp (26)
UserEditHnd (42)
IncOpProp (27)
ILLObjAsHnd (43)
IncCondProp (28)
NonEditLostO (44)
IncInvkTProp (29)
NonOptGatLog (45)
IncPropagtn (30)
RefusedConn (46)
LostObjects (31)
ILLMultRef (47)

CEE

ConfHndErr (48)
CnfHndSurWrn (49)
ConfHndWarn (50)
ConfHndInfo (51)
ConfUnknCnfSt (52)
Spare53 (53)
Spare54 (54)
Spare55 (55)
Spare56 (56)
Spare57 (57)
Spare58 (58)
Spare59 (59)
Spare60 (60)
Spare61 (61)

No

Related
Parameters

Notes

Function Block Parameters

Specific to
Block(s)

34

Parameter

Parameter

Specific to
Block(s)

CONFIGCODE[1..8 Auxcalc
]

Description

Data Type

Configuration Code

None (0)
Ok (1)
UnknownError (2)
ImplicitConv (3)
LossOfPrecsn (4)
UnexpctEnd (5)
UnexpctComm (6)
ColonWoQMar (7)
FctNotMltArg (8)
ClosParenExp (9)
OperandExp (10)
MissingArg (11)
OperatorExp (12)
ColonExp (13)
TypeMismatch (14)
TypeNotSupp (15)

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Enumeration See below


None (0) No
Engineer/
AUXCALCCON
Application
FIGCODE
Developer
Range
SyntaxError (16)
IntegerExp (32)
ExtUse48 (48)
ExprTooCmplx (17) DoubleExp (33)
ExtUse49 (49)
NotEPcodeMe (18) MissedImpl (34)
ExtUse50 (50)
NotEDataStak (19) UnicodeConv (35)
UnSupConTyp (51)
UnsuppFeatur (20) ConstExprRem (36) UnExpClsParn (52)
ExprTooLong (21)
DuplExprRem (37)
CantAssRVal (53)
DivideByZero (22)
ExtUse38 (38)
UnExpArrOpen (54)
UnknownToken (23) ExtUse39 (39)
ArrClsExpect (55)
UnexpTokenO (24)
ExtUse40 (40)
ArrOpnExpect (56)
UnknownFunc (25) ExtUse41 (41)
ArrIndxError (57)
UnexpOCExpr2 (26) ExtUse42 (42)
StringExpect (58)
UnexpOCExpr3 (27) ExtUse43 (43)
InvalidRefer (59)
ZeroArgument (28) ExtUse44 (44)
TooManyConn (60)
UnexpToken (29)
ExtUse45 (45)
CantConvInpt (61)
InvalResult (30)
ExtUse46 (46)
InvalTokenTb (31)
ExtUse47 (47)

CEE

No

Handler, RegCalc,
SCM, Step,
Transition

Configuration
Descriptor

String

Maximum of None
39 characters.

No

View Only

CEE

No

CONFIGDESC
[1..8]

Auxcalc

Configuration
Descriptor

String

Maximum of None
39 characters.

No

View Only

CEE

No

CONFIGSTS

Handler, RegCalc,
SCM, Step,
Transition

Configuration Status Enumeration


AUXCALCCON
FIGSTS,
CSCOCONFIG

Ok (0)
Ok (0)
Information (1)
Warning (2)
SevereWarnin
g (3)
Fail (4)
Error (5)
SevereError
(6)

No

View Only

CEE

No

Configuration Status Enumeration


AUXCALCCON
FIGSTS,
CSCOCONFIG

Ok (0)
Ok (0)
Information (1)
Warning (2)
SevereWarnin
g (3)
Fail (4)
Error (5)
SevereError
(6)

No

View Only

CEE

No

CONFIGSTS[1..8] Auxcalc

Notes

Function Block Parameters

CONFIGDESC

Related
Parameters

35

Description

CONFIGURED

RM

CONFIRM[0..15]

Message

CONFIRMED[0..15 Message
]

Data Type

Range

Default

RM Configuration
Enumeration
Status. Value of
USER indicates the
module has been
configured to do
something different
than the
out-of-the-box
default.

Factory (0)
User (1)

Factory (0) No

View Only
Not Loaded
Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform.

No

Confirmation

Boolean

Off (0)
On (1)

Off (0)

Operator

CEE

No

Confirmed

Boolean

Off (0)
On (1)

View Only

CEE

No

CONNLISTSIZE

CM

Integer

CONTROLLOCK

SCM

CONTROLREQ

Sequential Control
DevCtl
All RegCtl Blocks: Module (SCM)
AutoMan, Fanout, Control Request
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Structure

COS

DIC

Change of State.

Boolean

Off (0)
On (1)

COS
[0..NumChans-1]

DIM

Change of State.

Boolean

Off (0)
On (1)

No

This block will


replace
PCMCOMMAND in
a later release.

CPMSTATE

This block will


replace PCMSTATE
at a later release.

Access
Lock

Residence

View Only

Control Access Lock Enumeration Operator (0) Operator Yes


CSCOACCLOC Engineer (1) (0)
K
View Only (2)
OtherFB (3)

CPMCOMMAND CPM
[0..numChans-1]

CPM

Config
Load

Active
Connector

Related
Parameters

Notes

CONTROLLOCK defines what


access lock is used for the
following changes:
MODE change to
SemiAuto or Manual
Issue a Hold COMMAND

Function Block Parameters

Specific to
Block(s)

36

Parameter

No

Engineer

CEE

No

MODE, COMMAND

No

Other
Function
Block

CEE

No

GOPREQ,
Invalid if Control Module
MODEATTR, OPREQ, SCMOPT = None.
OPTYPE,
SCMASTEP[1..10],
SCMID, SCMOPT

Off (0)

No

View Only

CEE

No

Off (0)

No

View Only

CEE

No

Specific to
Block(s)

Description

Data Type

CPUCYCLEAVG
[0..39]

CEE

Average percentage 64-Bit Real


of Central
Number
Processing Unit
(CPU) Processing
Power Used Per
Cycle.

Greater-than,
or equal-to
zero

CPUCYCLEMAX
[0..39]

CEE

Historical Maximum 64-Bit Real


of Central Processor Number
Unit (CPU)
Processing Power
Used Per Cycle.

Greater-than
or equal-to
zero.

CPUFREEAVG

CEE, CPM

Average free Central 64-Bit Real


Processing Unit
Number
(CPU) Processing
Power in the CPM

0.0 to 100.0

CPUFREEMIN

CPM

Historical Minimum 64-Bit Real


of Free CPU
Number
Processing Power in
the CPM.

CPV

LeadLag, Deadtime Overall scaling


factor for PV

Real Number

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

No

View Only

CEE

No

CPUCYCLEMAX[0..39 Each element gives a rolling


], STATSRESET
average of the CPU used by
each execution cycle. Units
are percent of 50 ms cycle.
Index corresponds to the
cycle number. Averaging can
be restarted by storing to the
STATSRESET parameter.
Characteristic time constant
of the average is 1 minute.
Wait 2-3 minutes to be sure
averaging has fully settled.

No

View Only

CEE

No

CPUCYCLEAVG[0..39] Each element gives the


, STATSRESET
historical maximum of the
CPU used by each execution
cycle. Units are percent of
50 ms cycle. Index
corresponds to the cycle
number. Historical maximum
can be reset to current
instantaneous value by
storing to the STATSRESET
parameter.

No

View Only

CEE

No

CPUFREEMIN,
STATSRESET

Gives rolling average of free


CPU not currently used for
processing by the CPM.
Units are percent. Averaging
can be restarted by storing to
the STATSRESET parameter.
Characteristic time constant
of the average is 1 minute.
Wait 2-3 minutes to be sure
averaging has fully settled.

0 to 100.0

No

View Only

CEE

No

CPUFREEAVG,
STATSRESET

Gives the historic minimum


of the unused CPU available
to the CPM. Units are
percent. Historical minimum
can be reset to current
instantaneous value by
storing to the STATSRESET
parameter.

Any Real
1.0
Number, NaN
not allowed.

Yes

Engineer

CEE

No

Function Block Parameters

Parameter

37

Description

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

CRCYCLEOVRN
[0..40]

CEE

Current Hour Cycle


Overruns.

16-Bit Real
Number

0 to 32767

No

View Only

CEE

No

LSCYCLEOVRN[0..40] Each element gives a count


of cycle overruns that have
occurred during the current
hour. Elements 0..39 give
the count for the
corresponding cycle.
Element 40 gives the total
count over all cycles. All
elements are reset to 0 once
an hour. Reset time is not
synchronized with wall clock
time.

CSRC [1..10][1..6] Transition

Internal parameter
for system use only.

CSTS[1..8]

AuxCalc

Expression Statuses Enumeration


PVSTS

Bad (0)
Uncertn (1)
Normal (2)
Manual (3)

Bad (0)

No

View Only

CEE

No

RegCalc

Expression result
Enumeration
status for each
PVSTS
result C [1] through C
[8].

Bad to Manual Bad (0)


(0 to 3)

No

View Only

CEE

No

CTLACTN

PID, PIDFF

Control Action - The Enumeration


output direction of a CTLACTN
PID function block
(direct or reverse).

Direct (0)
Reverse (1)

Reverse
(1)

Yes

Engineer

CEE

No

CTLEQN

PID, PIDFF, OvrdSel, Control Equation


Switch.
Type

EqA (0)
EqB (1)
EqC (2)
EqD (3)
EqE (4)
EqF (5)
EqG (6)

EqA (0)

Yes

Engineer /
Application
Developer

CEE

No

CTLINIT

All RegCtl Blocks:


AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Control Initialization Boolean


Request Flag - Used
to request one-shot
initialization of a
Regulatory Control
block. May be
written to by a user
program or another
function.

Off (0)
On (1)

Off (0)

No

Other
Function
Block

CEE

No

CURPROFILEID

RampSoak

Current Profile ID

Integer

1 to 10

Operator No

CEE

No

CURSEGID

CURSEGID

RampSoak

Current Segment ID. Integer

1 to 60

No

CEE

No

CURPROFILEID

Enumeration
CTLEQN

Operator

C [1..8]

Notes

Function Block Parameters

Specific to
Block(s)

38

Parameter

Parameter

Specific to
Block(s)

Description

CURSEGTYP

RampSoak

CUTOFF.LM

Data Type

Range

Default

Current Segment
Enumeration
Type (Ramp or Soak).

Ramp (0)
Soak (1)

Totalizer, Pulse
Input Totalizer,
Deadtime

Zero-Flow Cutoff
64-Bit Real
Limit in Engineering Number
Units - Allows the
user to specify a
cutoff limit such
that, when the value
of the RATE falls
below this limit, PV
remains constant (no
accumulation).

NaN, or
greater-than
or equal-to
0.0.

CV

All RegCtl Blocks:


AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

CV[1..8]

CVEUHI

Residence

Active
Connector

Ramp (0) No

View Only

CEE

No

Deadtime Yes
: NaN
Totalizer,
Pulse
Input
Totalizer:
0.0

Totalizer,
Pulse Input
Totalizer:
Engineer
Deadtime:
Supervisor

CEE

No

Calculated Value - 64-Bit Real


The result
Number
(calculated value) of
the function blocks.
The value may be in
Percent or
Engineering Units,
depending on the
function block.

NaN

No

Other
Function
Block

CEE

No

Fanout

Calculated Variable 64-Bit Real


for function blocks Number
with Multiple
Outputs - The result
(calculated value) of
the function block.
There is one CV for
each output.

NaN

Yes

Other
Function
Block

CEE

No

All RegCtl Blocks


except Fanout:
AutoMan, OvrdSel,
PID, PIDFF, PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Calculated Variable 64-Bit Real


(CV) High Range (in Number
Engineering Units) This value
corresponds to
100% of full-scale
value.

100.0

Yes

Engineer

CEE

No

Related
Parameters

Notes

CVEULO

If NUMSEC = 0, CV high and


low ranges are configured
for PID; otherwise, they track
the ranges of the
secondarys input (i.e. , the
other end of the control
output connection).
If NUMSEC = 0, CV high and
low ranges track the XEUHI
and XEULO in the blocks
which have X input.

Function Block Parameters

Access
Lock

Greater-than
or equal-to
CVEULO

Config
Load

39

Description

CVEUHI[1..8]

Fanout

CVEULO

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

Calculated Variable 64-Bit Real


(CV) High Range (in Number
Engineering Units) This value
corresponds to
100% of full-scale
value.

Greater-than
or equal-to
CVEULO[1..8]

100.0

Yes

Engineer

CEE

No

CVEULO[1..8]

If NUMSEC = 0, CV high and


low ranges are configured
for PID; otherwise, they track
the ranges of the
secondarys input (i.e., the
other end of the control
output connection).
If NUMSEC = 0, CV high and
low ranges track the XEUHI
and XEULO in the blocks
which have X input.

All RegCtl Blocks


except Fanout:
AutoMan, OvrdSel,
PID, PIDFF, PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Calculated Variable Real


(CV) Low Range (in
Engineering Units) This value
corresponds to 0%
of full scale.

Less-than or
equal-to
CVEUHI

0.0

Yes

Engineer

CEE

No

CVEUHI

If NUMSEC = 0, CV high and


low ranges are configured
for PID; otherwise, they track
the ranges of the
secondarys input (i.e., the
other end of the control
output connection).
If NUMSEC = 0, CV high and
low ranges track the XEUHI
and XEULO in the blocks
which have X input.

CVEULO[1..8]

Fanout

Calculated Variable Real


(CV) Low Range (in
Engineering Units) This value
corresponds to 0%
of full scale.

Less-than or
equal-to
CVEUHI[1..8]

0.0

Yes

Engineer

CEE

No

CVEUHI

If NUMSEC = 0, CV high and


low ranges are configured;
otherwise, they track the
ranges of the secondarys
input (i.e., the other end of
the control output
connection).
If NUMSEC = 0, CV high and
low ranges track the XEUHI
and XEULO in the blocks
which have X input.

CVINIT

RegCalc

Calculated Variable Real


(CV) under
initialization
conditions.

NaN

No

Other
Function
Block

CEE

No

CVINITSRC

RegCalc

CVINIT (Calculated
Variable under
initialization
conditions) source
selector.

X1 (0)

Yes

Engineer

CEE

No

CVORFB

RegCalc

Calculated Variable Real


(CV) under override
feedback conditions
(i.e, in the
non-selected path)

NaN

No

Other
Function
Block

CEE

No

Enumeration X1 to C8STS
REGCALCSELE (0 - 27)
CTOR

Function Block Parameters

Specific to
Block(s)

40

Parameter

Parameter

Specific to
Block(s)

Description

CVORFBSRC

RegCalc

CVSRC

RegCalc

Data Type

Default

Config
Load

Access
Lock

Residence

Active
Connector

Calculated Variable Enumeration X1 to C8STS


under override
REGCALCSELE (0 - 27)
feedback conditions CTOR
(CVORFB) source
selector.

X1 (0)

Yes

Engineer

CEE

No

Calculated Variable Enumeration X1 to C8STS


(CV) output source REGCALCSELE (0 - 27)
selector.
CTOR

X1 (0)

Yes

Engineer

CEE

No

Engineer

CEE

CYCLEOPT
RampSoak
[1..NUMPROFILES
]

Cycle Option.

Integer

CYCLETIME

PosProp,
PidPosProp

Cycle time for


Real
commanding raise or
lower pulses (in
seconds).

D1

Deadtime

Bias for the


calculation of
DELAYTIME.

D2

Range

Single (0)
RoundRob
RoundRob (1) (1)
Cyclic (2)
0.020 to
1000.0

Yes

Supervisor

CEE

No

Real Number

0.0

Yes

Supervisor

CEE

No

Deadtime

Bias for the P2 input. Real Number

0.0

Yes

Supervisor

CEE

No

DATATYPE

RSPNUMARRAY

DataType for
Enumeration
PCCC/CIP Access.
The type of data that
can be read from or
written to by a
remote device.

32-Bit Real
32-Bit
Number,
Real
8-Bit Signed Number
Integer,
16-Bit Signed
Integer,
32-Bit Signed
Integer,

Yes

Application
Developer

CEE

No

DEADBAND

GE, GT, LE, LT

Deadband Value
64-Bit Real
Defines the value of
the deadband for
Comparison
Functions.

Greater-than 0.005
or equal-to 0.

Yes

Engineer

CEE

No

DEADBAND1

EQ, NE

Deadband Value #1 64-Bit Real


Defines the value
of the (inner)
deadband.

Greater-than 0.005
or equal-to 0.
Less-than or
equal-to
DEADBAND2

Yes

Engineer

CEE

No

Notes

DELAYTIME, C1

Function Block Parameters

10.0

Related
Parameters

41

Description

Data Type

DEADBAND2

EQ, NE

Deadband Value #2 64-Bit Real


Defines the value
of the (outer)
deadband.

DEBUG

All IO Channels,
SIFLAGARRCH,
SINUMARRCH,
SITEXTARRCH.

Spare for debug


information

Integer

DELAYTABLE
[1..60]

Deadtime

Delay Table.

Real Number

DELAYTIME

2oo3, Delay,
Delay in seconds
MVote, Ondelay,
Offdelay, Watchdog

Integer

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Yes

Engineer

CEE

No

View Only

CEE

No

ViewOnly

CEE

No

Yes
Delay,
Ondelay,
Offdelay,
Watchdo
g:
2 seconds
2oo3,
MVote:
5 seconds

Engineer

CEE

No

Fixed
Delay:
Yes
Variable
Delay: No

Fixed Delay: CEE


Engineer
Variable
Delay:
ViewOnly

No

Fixed (0)

Yes

Engineer

CEE

No

No

ViewOnly

CEE

No

Greater-than 0.01
or equal-to
DEADBAND1
0

0-8000
seconds

Deadtime

Delay Time (in


Real Number
Minutes) If fixed
delay is configured,
it is a fixed time,
specified by the
user; for variable
delay, it is a
Parameter time,
calculated by the
function block.

Greater-than 0.0
or equal-to 0.0
minutes.

DELAYTYPE

Deadtime

Delay Type

DELCV

PID, PIDFF

Incremental Change 64-Bit Real


in Calculated
Variable (CV) , in
Percent.

NaN

DELTATIME

Totalizer

Delta Time

Enumeration Fixed (0)


of DELAYTYPE Variable (1)

Real

View Only

Related
Parameters

Notes

Function Block Parameters

Specific to
Block(s)

42

Parameter

NUMLOC

DELAYTYPE

DELAYTIME (cont.)

Parameter

Specific to
Block(s)

Description

Data Type

Range

DESC

Applies to all blocks


with alarming
capability except
Timer.
Also includes Flag
and Message
blocks.

Block Descriptor Used to specify


descriptive text for
the function block.
Appears on both
detail and group
displays.

String

Length: 24
Null
characters
string
Exceptions:
40 characters
for Step,
Transition,
and Handler.
23 characters
for DevCtl.

DEV

PID, PIDFF, PosProp Deviation - The


64-Bit Real
difference between
the Process Variable
(PV) and Set Point
(SP).

DEVADDR

SIFLAGARRCH,
SINUMARRCH,
SITEXTARRCH.

DEVHIALM.DB

PID, PIDFF, PosProp Deviation High


and RampSoak
Alarm Deadband

Serial Link Device


32-Bit Integer
Address Identifies
a device on the
serial link connected
to the FTA.
64-Bit Real

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Yes

Application
Developer

SR

No

KEYWORD, EUDESC This is a configurable


parameter which may be set
by the user prior to loading
the block to the controller.

NaN

No

ViewOnly

CEE

No

PV, SP

Yes

Application
Developer

CEE

No

Yes

Engineer/Ap CEE
plication
Developer

No

0.0 to 100.0, if 0.0


alarm
deadband
units
(DEVHIALM.D
BU) are in
Percent.
Greater-than
or equal to
0.0, if alarm
deadband
units
(DEVHIALM.D
BU) are
Engineering
Units (EUs).

PV, SP,
DEVHIALM.DBU,
DEVHIALM.FL,
DEVHIALM.PR,
DEVHIALM.SV,
DEVHIALM.TM,
DEVHIALM.TP

Notes

Function Block Parameters

Individual alarm deadbands


are not individually
configurable. The ALMDB
that is configured is loaded
to the block, then the block
copies the ALMDB value to
all the xxALM.DB of all
analog alarms on the block.
This includes ALMDBU and
ALMTM - thus, all analog
alarms get the same three
values through a one-time
configuration entering of the
three values.
If desired, the individual
alarm parameters
(xxALM.DB, xxALM.DBU, and
xxALM.TM) may be modified
after the block is loaded.
The block load will always
set all individual alarm
parameters to the three
configured values.

43

DEVHIALM.DBU

Description

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

PID, PIDFF, PosProp Deviation High


Enumeration
and RampSoak
Alarm Deadband
ALMDBU
Units - Indicates if
DEVHIALM.DB is in
Percent or
Engineering Units.

Percent (0)
EU (1)

Percent
(0)

Yes

Application
Developer

CEE

No

PV, SP,
DEVHIALM.DB,
DEVHIALM.FL,
DEVHIALM.PR,
DEVHIALM.SV,
DEVHIALM.TM,
DEVHIALM.TP

Individual alarm deadbands


are not individually
configurable. The ALMDB
that is configured is loaded
to the block, then the block
copies the ALMDB value to
all the xxALM.DB of all
analog alarms on the block.
This includes ALMDBU and
ALMTM - thus, all analog
alarms get the same three
values through a one-time
configuration entering of the
three values.
If desired, the individual
alarm parameters
(xxALM.DB, xxALM.DBU, and
xxALM.TM) may be modified
after the block is loaded.
The block load will always
set all individual alarm
parameters to the three
configured values.

DEVHIALM.FL

PID, PIDFF, PosProp Deviation High


and RampSoak
Alarm Flag Indicates if
DEVHIALM.TP has
been exceeded.

Boolean

Off (0):
Off (0)
DEVHIALM.TP
has not been
exceeded (i.e.,
no Deviation
High alarm).
On (1):
DEVHIALM.TP
has been
exceeded.

No

ViewOnly

CEE

No

PV, SP,
DEVHIALM.DB,
DEVHIALM.DBU,
DEVHIALM.PR,
DEVHIALM.SV,
DEVHIALM.TM,
DEVHIALM.TP

DEVHIALM.PR

PID, PIDFF, PosProp Deviation High


and RampSoak
Alarm Priority Defines the priority
of a Deviation High
alarm.

Enumeration
ALPRIOR

None (0)
Journal (1)
Low (2)
High (3)
Urgent (4)

Low (2)

Yes

Engineer

CEE

No

PV, SP,
DEVHIALM.DB,
DEVHIALM.DBU,
DEVHIALM.FL,
DEVHIALM.SV,
DEVHIALM.TM,
DEVHIALM.TP

DEVHIALM.SV

PID, PIDFF, PosProp Deviation High


and RampSoak
Alarm Severity

16-Bit Integer 0 to 15

Yes

Engineer

CEE

No

PV, SP,
DEVHIALM.DB,
DEVHIALM.DBU,
DEVHIALM.FL,
DEVHIALM.PR,
DEVHIALM.TM,
DEVHIALM.TP

Function Block Parameters

Specific to
Block(s)

44

Parameter

Parameter

Specific to
Block(s)

DEVHIALM.TM

DEVHIALM.TP

Description

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

PID, PIDFF, PosProp Deviation High


32-Bit
and RampSoak
Alarm Filter Time (in Unsigned
seconds) - The
Integer
purpose of this
variable is to prevent
input spikes from
causing alarms. An
alarm will only be
generated if the
deviation
consistently exceeds
the high deviation
trip point for more
than DEVHIALM.TM
seconds.

0 to 60

Yes

Engineer

CEE

No

PV, SP,
DEVHIALM.DB,
DEVHIALM.DBU,
DEVHIALM.FL,
DEVHIALM.PR,
DEVHIALM.SV,
DEVHIALM.TP

If DEVHIALM.TM = 0, an
alarm will be generated as
soon as the deviation
exceeds the high deviation
trip point.
Individual alarm deadbands
are not individually
configurable. The ALMDB
that is configured is loaded
to the block, then the block
copies the ALMDB value to
all the xxALM.DB of all
analog alarms on the block.
This includes ALMDBU and
ALMTM - thus, all analog
alarms get the same three
values through a one-time
configuration entering of the
three values.
If desired, the individual
alarm parameters
(xxALM.DB, xxALM.DBU, and
xxALM.TM) may be modified
after the block is loaded.
The block load will always
set all individual alarm
parameters to the three
configured values.

PID, PIDFF, PosProp Deviation High


64-Bit Real
and RampSoak
Alarm Trip Point (in Number
Engineering Units) Defines the upper
limit for the
deviation.

NaN, or 0.0 to NaN


[PVEUHI PVEULO]

Yes

Engineer

CEE

No

PVEUHI, PVEULO, PV,


SP, DEVHIALM.DB,
DEVHIALM.DBU,
DEVHIALM.FL,
DEVHIALM.PR,
DEVHIALM.SV,
DEVHIALM.TM

PID and PosProp only: Alarm


occurs when PV is higher
than (SP + DEVHIALM.TP).
RampSoak only: Alarm
occurs when
PV CV > DEVHIALM.TP.

Function Block Parameters


45

Description

Data Type

DEVLOALM.DB

PID, PIDFF, PosProp Deviation Low Alarm 64-Bit Real


and RampSoak
Deadband
Number

DEVLOALM.DBU PID, PIDFF, PosProp Deviation Low Alarm Enumeration


and RampSoak
Deadband Units - p - ALMDBU
Indicates if
DEVLOALM.DB is in
Percent or
Engineering Units.

Range

Default

Config
Load

Access
Lock

to 100.0 if
0.0
alarm
deadband
units
(DEVLOALM.D
BU) are
Percent
Greater-than
or equal to 0.0
if alarm
deadband
units
(DEVLOALM.D
BU) are
Engineering
Units (EUs).

Yes

Percent (0)
EU (1)

No

Percent
(0)

Residence

Active
Connector

Related
Parameters

Notes

Engineer/Ap CEE
plication
Developer

No

DEVLOALM.DBU

Individual alarm deadbands


are not individually
configurable. The ALMDB
that is configured is loaded
to the block, then the block
copies the ALMDB value to
all the xxALM.DB of all
analog alarms on the block.
This includes ALMDBU and
ALMTM - thus, all analog
alarms get the same three
values through a one-time
configuration entering of the
three values.
If desired, the individual
alarm parameters
(xxALM.DB, xxALM.DBU, and
xxALM.TM) may be modified
after the block is loaded.
The block load will always
set all individual alarm
parameters to the three
configured values.

Application
Developer

No

DEVLOALM.DB

Individual alarm deadbands


are not individually
configurable. The ALMDB
that is configured is loaded
to the block, then the block
copies the ALMDB value to
all the xxALM.DB of all
analog alarms on the block.
This includes ALMDBU and
ALMTM - thus, all analog
alarms get the same three
values through a one-time
configuration entering of the
three values.
If desired, the individual
alarm parameters
(xxALM.DB, xxALM.DBU, and
xxALM.TM) may be modified
after the block is loaded.
The block load will always
set all individual alarm
parameters to the three
configured values.

CEE

Function Block Parameters

Specific to
Block(s)

46

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

DEVLOALM.FL

PID, PIDFF, PosProp, Deviation Low Alarm Boolean


RampSoak
Flag Indicates if
DEVLOALM.TP has
been exceeded.

DEVLOALM.PR

PID, PIDFF, PosProp Deviation Low Alarm Enumeration


and RampSoak
Priority - Defines the ALPRIOR
priority of a
Deviation Low
alarm.

DEVLOALM.SV
DEVLOALM.TM

Range

Config
Load

Access
Lock

Residence

Active
Connector

Off (0):
Off (0)
DEVLOALM.TP
has not been
exceeded,;
i.e., no
Deviation Low
alarm.
On (1):
DEVLOALM.TP
has been
exceeded.

No

ViewOnly

CEE

No

None (0)
Journal (1)
Low (2)
High (3)
Urgent (4)

Low (2)

Yes

Engineer

CEE

No

PID, PIDFF, PosProp Deviation Low Alarm 16-Bit Integer 0 to 15


and RampSoak
Severity

Yes

Engineer

CEE

No

DEVLOALM.FL,
DEVLOALM.PR

PID, PIDFF, PosProp Deviation Low Alarm 32-Bit


and RampSoak
Filter Time (in
Unsigned
Seconds) - The
Integer
purpose of this
variable is to prevent
input spikes from
causing alarms. An
alarm will only be
generated if the
deviation is
consistently below
the low deviation
trip point for more
than DEVLOALM.TM
seconds.

Yes

Engineer

CEE

No

DEVLOALM.TP

0 to 60

Default

Related
Parameters

Notes

Function Block Parameters

If DEVLOALM.TM = 0, an
alarm will be generated as
soon as the deviation falls
below the low deviation trip
point.
Individual alarm deadbands
are not individually
configurable. The ALMDB
that is configured is loaded
to the block, then the block
copies the ALMDB value to
all the xxALM.DB of all
analog alarms on the block.
This includes ALMDBU and
ALMTM - thus, all analog
alarms get the same three
values through a one-time
configuration entering of the
three values.
If desired, the individual
alarm parameters
(xxALM.DB, xxALM.DBU, and
xxALM.TM) may be modified
after the block is loaded.
The block load will always
set all individual alarm
parameters to the three
configured values.

47

Description

Data Type

DEVLOALM.TP

PID, PIDFF, PosProp Deviation Low Alarm 64-Bit Real


and RampSoak
Trip Point (in
Number
Engineering Units) Defines the lower
limit for the
deviation.

DHCHANNEL

REQFLAGARRAY,
REQNUMARRAY,
REQTEXTARRAY:
when using PCCC
and COMMAND is
either:
PLC5TypRead or
PLC5TypWrite
and the target is on
DH+. This
parameter is
enabled only when
DHFL is True.

The DH+ channel the Enumeration


target node is
located on. This can
be one of two
channels A or B.
Unlike ControlNet,
the two DH+
channels are not
used merely for
redundant cabling.

DHDESTLINK

REQFLAGARRAY,
REQNUMARRAY,
REQTEXTARRAY:
when using PCCC
and COMMAND is
either:
PLC5TypRead or
PLC5TypWrite
and the target is on
DH+. This
parameter is
enabled only when
DHFL is True.

DHFL

REQFLAGARRAY,
REQNUMARRAY,
REQTEXTARRAY:
when using PCCC
and COMMAND is
either PLC5TypRead
or PLC5TypWrite

Range

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

NaN, or 0.0 to NaN


[PVEUHI PVEULO]

Yes

Engineer

CEE

No

SP, PV, PVEUHI,


PVEULO

A,B

Yes

Application
Developer

CEE

No

Destination Link for 32-Bit Integer 0 to 199


the DH+ route. This
parameter is used
only when using
DH+ Remote
Messaging, and
should be zero when
using DH+ Local
Messaging.

Yes

Application
Developer

CEE

No

This flag is TRUE


Boolean
when the target
device is on DH+. In
this case, the PATH
is the path to the
DHRIO module and
additional path
information is
required to get from
the DHRIO module
to the target device.

Off(0)

Yes

Application
Developer

CEE

No

Off(0)
On(1)

Default

Notes

Function Block Parameters

Specific to
Block(s)

48

Parameter

Check this box if the target


PLC-5 is on the DH+ network
and the PATH is the relative
path to the DHRIO module.
This check box is not enabled
if the COMMAND is
CIPREAD or CIPWRITE.

Parameter

Specific to
Block(s)

Description

Data Type

Default

Config
Load

Access
Lock

Residence

Active
Connector

DHNODE

REQFLAGARRAY,
REQNUMARRAY,
REQTEXTARRAY:
when using PCCC.
I.e., when the
COMMAND is one
of the following:
PLC5TypRead
PLC5TypWrite
And the target is on
DH+. This
parameter is
enabled only when
DHFL is True.

Node number of the Enumeration


target node on the
DH+ network. This
parameter has a
value from 0 to 77
octal.

0 to 77 octal.

0 octal

Yes

Application
Developer

CEE

No

DHSRCLINK

REQFLAGARRAY,
REQNUMARRAY,
REQTEXTARRAY:
when using PCCC.
I.e., when the
COMMAND is one
of the following:
PLC5TypRead
PLC5TypWrite
And the target is on
DH+. This
parameter is
enabled only when
DHFL is True.

Source link for the 32-Bit Integer 0 to 199


DH+ route. This
parameter is used
only when using
DH+ Remote
Messaging, and
should be zero when
using DH+ Local
Messaging.

Yes

Application
Developer

CEE

No

DI [1..4]

DevCtl

Digital Input Value

Boolean

Off (0)
On (1)

Off (0)

No

ViewOnly

CEE

Yes, Inside
Input

DIGFILTER

1797-IBN16

Digital Filter Time.

Enumeration

.25 ms Delay
.5 ms Delay
1 ms Delay
2 ms Delay
4 ms Delay
8 ms Delay
16 ms Delay
32 ms Delay

.25 ms
Delay

Yes

Application
Developer

CEE

No

Related
Parameters

Notes

DIPVMAP [0..15],
GPVAUTO,
NUMDINPTS,
NUMSTATES,
PVAUTO

The number of Elements


allowed is restricted by the
value of NUMDINPTS. For
example, if NUMDINPTS = 2,
then only DIPVMAP [0..3] are
legal.
DIGFILTER sets the filter time
for both input data and fault
detection for all sixteen (16)
channels. Input pulses or
fault states that are shorter
in duration than the specified
time will not be recognized
by the Discrete Input device
represented by the
1797-IBN16 Module function
block.

Function Block Parameters

Range

49

Description

DIGFILTER
[0..numChans-1]

AIM

DIPVMAP [0..15]

Data Type

Range

Default

Digital Filter (msec) 32-Bit Integer


This parameter is
a configurable time
constant used in a
first order lag filter
which is used to
remove noise from
inputs.

If [0],
minimum to
20100 ms
If not [0],
minimum to
100 ms

DevCtl

Actual State
Definitions.

String

DISCREP

2oo3, MVote

Discrepancy output
value.

Boolean

DISPPOS

RM

Display position.
Enumeration
Identifies the
Chassis A vs.
Chassis B
workstation display
field groups to which
the remainder of this
objects data should
be applied.

Undefined (0) Undefine No


Chassis_A (1) d (0)
Chassis_B (2)

ViewOnly
Not Loaded
Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform.

No

DISQSECCMD

RM

Disqualify
Secondary
Command

True (0)
False (1)

Operator
Not Loaded
Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform.

No

Boolean

Access
Lock

Residence

Active
Connector

0
Yes
(indicates
digital
filtering is
off)

ViewOnly See Notes

CEE

No

Bad (0)
InBet (1)
State0 (4)
State1 (5)
State2 (6)

Bad (0)

Yes

Engineer

CEE

No

Off (0)
On (1)

Off (0)

No

ViewOnly

CEE

No

True (0)

Config
Load

No

Related
Parameters

Notes
DIGFILTER [0..5] is accessible
by the Application Developer
on the Configuration Form
only.

DI [1..4], GPVAUTO,
NUMDINPTS,
NUMSTATES,
PVAUTO

The number of elements


allowed is restricted by the
value of NUMDINPTS. For
example, if NUMDINPTS = 2,
then only DIPVMAP [0..3] are
legal.
No member of DIPVMAP may
be assigned State2, if
NUMSTATES = 2.

Function Block Parameters

Specific to
Block(s)

50

Parameter

Parameter

Specific to
Block(s)

Description

DLCNBSLOT

IOM

DO [1..3]

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

Downlink ControlNet 32-Bit Integer 0 to (chassis


Module Slot Number
size 1)
in Chassis.

Yes

Application
Developer

SR

No

IOMSLOT,
ULCNBMAC

DLCNBSLOT refers to the


physical slot number of the
controller racks CNB
module. That CNB module
acts as the downlink to the
remote I/O chassis of
interest. Note that the slot
numbers start at zero, on the
left side of the rack.
If configuring an IOM located
in the same chassis as the
controller, leave this
parameter set to the default
value of zero.

DevCtl

Digital Output
Values

Boolean

Off (0)
On (1)

Off (0)

No

ViewOnly

CEE

No

GOPFINAL,
NUMDOUTS,
OPDOMAP [0..3]
[1..3], OPFINAL

Only valid if NUMDOUTS


allows the respective output.
DO [i] and PO [i] cannot be
connected simultaneously.

DOMSO

DOC

Output value

Boolean

Off (0)
On (1)

Off (0)

No

ViewOnly

CEE

No

DOMSO
[0..numChans-1]

DOM

Output value

Boolean

Off (0)
On (1)

Off (0)

No

ViewOnly

CEE

No

DONEFL

All Exchange
Library Request
Array function
blocks:
REQFLAGARRAY,
REQNUMARRAY,
REQTEXTARRAY

Flag indicating a
Boolean
successful response
was received for the
last request sent by
this request block.

Off(0)
On(1)

Off(0)

No

View Only

CEE

No

DOTYPE

DOC

Digital Output or
Pulse Width

Null (0)
So (1)
OnPulse (2)
OffPulse (3)

So (1)

Yes

Application
Developer

CEE

No

DPV

LeadLag, Deadtime Overall bias for PV Real Number


A bias that is
applied to the
calculation of PV.

0.0

Yes

Deadtime:
Supervisor
LeadLag:
Engineer

CEE

No

DRIVERNAME

CPM, RM

Null
String

No

Engineer

SR

No

Modulation
output type

String

Range

Length: 255
characters

ABORTALM.PR

Function Block Parameters

Default

Network Driver
Name

Data Type

51

Description

Data Type

EDGEDETECT

Pulse Input IOC,


Input Edge Detection Enumeration
Pulse Input w/ Fast specifies which
Cutoff IOC
edge of pulse to be
detected for
counting. All timing,
counting and
frequency functions
in the hardware
begin with the
transition of the
signal (applied to the
screw terminals)
from Low to High, or
High to Low.

EDGEDETECT
[0..7]

Pulse Input IOM

ELOF
[0..numChans-1]

DIM (only
Enable Loss of
configurable on the Power
8-channel, 120
VAC, Diagnostic
module)

Input Edge Detection Enumeration


specifies which
edge of pulse to be
detected for
counting.

Boolean

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Rising Edge
Rising
(0):
Edge (0)
Signal
transitions
from low
voltage to
high voltage
will cause an
Off-to-On
transition in
the ASIC
functions of
the module.
Falling Edge
(1):
Signal
transitions
from high
voltage to low
voltage will
cause an
Off-to-On
transition in
the ASIC
functions of
the module.

Yes

View Only

CEE

No

Rising Edge (0) Rising


Falling Edge Edge (0)
(1)

Yes

Application
Developer

CEE

No

RisingEdge mode
refers to
screw-terminal-input
transitions from low
voltages to high
voltage will cause an
Off-to-On transition
in the ASIC functions
of the module.
FallingEdge mode
refers to
screw-terminal-input
transitions from high
voltages to-low
voltage will cause an
Off-to-On transition
in the ASIC functions
of the module.

Off (0)
On (1)

Yes

Application
Developer

CEE

No

NOFIELDPWR
[0..numChans-1]

Off (0)

Related
Parameters

Notes

Function Block Parameters

Specific to
Block(s)

52

Parameter

Parameter

Specific to
Block(s)

Description

ENBHANDLER
[1..8]

SCM

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

Enable Handler Type Boolean

Off (0)
On (1)

Off (0)

No

Engineer

CEE

No

TYPE

ENBHANDLER [i] determines


if local and global conditions
can invoke the currently
selected TYPE i handler
invocation by COMMAND.
ENBHANDLER [i] can only be
changed to On if the TYPE i
handler is accessible brom
the current SCMSTATE. the
SCM changes ENBHANDLER
[1..8] to the defaults for a
given STATE when that
STATE is entered.

ENOLOAD [0..num DOM


Chans-1]

Enable No Load

Boolean

Off (0)
On (1)

Off (0)

Yes

Application
Developer

CEE

No

NOLOAD

ENOLOAD is only
configurable on diagnostic
modules.

ENTERSBYCMD

Enter Standby
Command

Boolean

True (0)
False (1)

True (0)

No

Operator
Not Loaded
Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform .

No

Off (0)
On (1)

Off (0)

Yes

Engineer

No

RM

ENUMBOOLMAP TypeConvert
[0..63]

Data Type

An array used when Boolean


converting
Enumerations to
Boolean values.

CEE

This is applicable for


conversioin between
Enumerations and Boolean
values. The output Boolean
value will be whatever the
corresponding
ENUMBOOLMAP value is set
to.

Function Block Parameters


53

Description

Data Type

ERRCODE
ERRCODE

SIFLAGARRCH,
SINUMARRCH,
SITEXTARRCH.

Detailed Error Code String


Provides an
indication of the
status of the array
data for each
Channel.

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

See below

Null
String

No

ViewOnly

CEE

No

ERRFL

Range
Length: 8 characters
Possible String values:
Ch_Incty:

The Channel block is InActive.

Md_Incty:

The SIM function block is InActive, so the Channel block cannot obtain new array data.

CEE_Idle:

Thee CEE is Idle, so the Channel block is not executing.

ChCfgErr:

A Channel block configuration error exists. Check that the Number of Elements configured is
appropriate for the Starting Index of the device. Or for the Serial Interface Text Array Channel
function block, that the configured NSTRING and STRLEN do not exceed 64 characters.

No_SIMFB:

The Channel block cannot locate its assigned SIM function block. Check that the SIM function
block is loaded to the CEE.

No_Data:

ERRCODE is setNo_Data when the Channel block is activated. This value should only be seen
for a short period of time before ERRCODE is set to either a good or bad value.

No_Conn:

The Channel block cannot obtain array data because a proper connection does not exist between
the CPM and SIM.

IO_Comm:

There is an I/O Communications problem between the CPM and SIM.

DataCond:

The Channel block has received a Data Conditioner it does not understand. A Data Conditioner is
an internal value sent by the FTA that indicates how the 64 bytes of data should be interpreted.

REQFLAGARRAY,
REQNUMARRAY,
REQTEXTARRAY

Error Status on the 32-Bit Integer


last request
operation. This
value is non-zero
when thet ERRFL
parameter is True.
The Error Status can
be used to debug the
reason for the
failure.

No

View Only

CEE

No

Notes

Function Block Parameters

Specific to
Block(s)

54

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

ERRCODE [0..31]

Serial Interface
IOM

Detailed Error Code String


Provides an
indication of the
status of the array
data for each
Channel.

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

See below

Null
String

No

ViewOnly

CEE

No

ERRFL [0..31]

BADPVFL, ERRCODE,
INITREQ

Notes

Range
Length: 8 characters
Possible String values:

ERRFL

NO_CONF:

Inital value set by SIM

CFG_LOAD:

Set by SIM when loading configuration to FTA

ARR_INIT:

Set by FTA after receiving configuration

CONFIG:

Set by SIM if it cannot load a configuration

FTA COMM:

Set by SIM if it cannot communicate with the FTA

#ELEMNT:

Set by SIM if number of elements does not match data


type (possibly also set by FTA)

SIFLAGARRCH,
SINUMARRCH,
SITEXTARRCH

Flag that indicates Boolean


that an error
response was
received for the last
request sent by this
request block. Note
that this flag is set
to TRUE for both
local errors and
remote errors . For
alarming on errors,
connect the ERRFL to
a Flag Block and
configure the Flag
Block to send an
Alarm when ERRFL
is TRUE.

Off (0): data is Off (0)


okay
On (1): data is
invalid

No

ViewOnly

CEE

No

All Exchange
Library Request
Array function
blocks:
REQFLAGARRAY,
REQNUMARRAY,
REQTEXTARRAY

Flat indicating an
Boolean
error response was
received for the last
request sent by this
request block.

Off(0)
On(1)

No

View Only

CEE

No

Off(0)

This block is set to True for


both local errors and remote
errors. For alarming on
erros, connect the ERRFL to a
Flag block and configure the
Flag block to send an alarm
when ERRFL is True.

55

Specific to
Block(s)

Description

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

ERRFL [0..31]

Serial Interface
IOM

Overall Error Flag Boolean


Indicates the validity
of the array data for
each Channel; when
Off the data is Ok,
and when On the
data is invalid.

Off (0)
On (1)

Off (0)

No

ViewOnly

CEE

No

ERRCODE [0..31]

ERRINFO

REQFLAGARRAY,
REQNUMARRAY,
REQTEXTARRAY

Extended Error
Status on the last
request operation.

No

ViewOnly

CEE

No

This value is zero


when the ERRFL
parameter is False,
and is non-zero when
the last request
operation resulted in
an error with an
Extended Error. The
Extended Error
Status can be used to
debug the reason for
the failure.

ERRORCODE

RM

Redundancy Module String


Status Code, as it
appears on the front
panel of the
Redundancy
Module.

Maximum of 6
characters

No

ViewOnly
Not Loaded
Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform.

No

ERRORDBL

PosProp,
PidPosProp (when
PV > SP)

Error Deadband for


the lower direction
(in percent).

Real

0.0 to 100.0% 5.0%

Yes

Supervisor

CEE

No

ERRORDBR

PosProp,
PidPosProp (when
PV < SP)

Error Deadband for


the raise direction
(in percent).

Real

0.0 to 100.0% 5.0%

Yes

Supervisor

CEE

No

ERRORMSGIDX

RM

Redundancy Module 16-Bit


Error Message
Unsigned
Index. Full error
Integer
code, which
references a
matching test string.

0 to 65535

No

ViewOnly
Not Loaded
Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform.

32-Bit Integer

No

Notes

56

Parameter

Parameter

Specific to
Block(s)

Description

ESWFL.CAS

All RegCtl Blocks:


AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RatioBias, RegCalc,
RemCas, Switch.

ESWFL.MAN

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

External Switch Flag Boolean


for Cascade Mode On means an
external source has
requested a change
to Cascade mode.

Off (0)
On (1)

Off (0)

No

Other
Function
Block

CEE

No

ESWENB, ESWPERM

All RegCtl Blocks:


AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RatioBias, RegCalc,
RemCas, Switch.

External Switch Flag Boolean


for Manual Mode On means an
external source has
requested a change
to Manual mode.

Off (0)
On (1)

Off (0)

No

Other
Function
Block

CEE

No

ESWENB, ESWPERM

ESWPERM

All RegCtl Blocks:


AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RatioBias, RegCalc,
RemCas, Switch.

External Mode
Enumeration
Switch Permissive - MODEPERM
Indicates if external
mode switching is
permitted.

Permit (0):
Not
External mode Permitted
switching is (1)
permitted.
Not Permitted
(1): External
mode
switching is
not permitted.

Yes, this Engineer/Ap CEE


paramete plication
r is
Developer
loadable.

No

ESWENB,
ESWFL.AUTO,
ESWFL.BCAS,
ESWFL.CAS,
ESWFL.MAN

ETRANS

DOM

Enable Idle to Fault

Off (0)
On (1)

Off (0)

Yes

Application
Developer

CEE

No

Although loaded, this


parameter is not
exposed on any
configuration form.

EUDESC

All Function Blocks Block Engineering


String
except IOChannels Units Descriptor
Used to describe an
important aspect of
the block, for
example,
Engineering Units.

Length: 15
characters

Null
String

Yes

Application
Developer

SR

No

DESC, KEYWORD

Boolean

Notes

57

Specific to
Block(s)

Description

EVALTRANS
[1..10] [1..10]

SCM

EVALTRANSN
[1..10] [1..10]

SCM

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Currently Evaluated BlockId


Transition Name

Null
String

No

ViewOnly

CEE

No

ACTIVELOC.STEP
EVALTRANS [i] [j] contains
[1..10], EVALTRANSN the name (eg.
[1..10] [1..10]
SCMName.TransitionName)
of the currently evaluated
transition of branch j of
thread i.
EVALTRANS [1..10] [1..10] is
a BlockId parameter and not
supported in expressions. Its
Integer-32 Partner Parameter
EVALTRANSN [1..10] [1..10]
can be used in Transition
Condition expressions and
Step Output expressions.

Currently Evaluated 32-Bit Integer


Transition Name

Null
String

No

ViewOnly

CEE

No

ACTIVELOC.STEP
[1..10], EVALTRANS
[1..10] [1..10]

EVALTRANS [i] [j] contains


the name (eg.
SCMName.TransitionName)
of the currently evaluated
transition of branch j of
thread i.
EVALTRANSN [1..10] [1..10]
may be used in Transition
Condition expressions and
Step Output expressions,
whereas EVALTRANS [1..10]
[1..10] (a BlockId parameter)
is not supported in
expressions.

Off (0)

No

ViewOnly

CEE

No

VERIFYLOST
[0..numChans-1]

EVERIFY may be configured


only on diagnostic modules.

EVENTFL
RampSoak
[1..NUMEVENTS]

RampSoak Event
Flags

Boolean

Off (0)
On (1)

EVENTBGNTIME RampSoak
[1..NUMPROFILES
]
[1..NUMEVENTS]

Event Start Time

Real

NaN, or
0.0
Greater-than
or equal-to 0.0

Yes

Supervisor

CEE

No

EVENTENDTIME RampSoak
[1..NUMPROFILES
]
[1..NUMEVENTS]

Event End Time

Real

NaN, or
0.0
Greater-than
or equal-to 0.0

Yes

Supervisor

CEE

No

EVENTSEGID
RampSoak
[1..NUMPROFILES
]
[1..NUMEVENTS]

Event Segment ID

Integer

0 to 100

Yes

Supervisor

CEE

No

EVERIFY
[0..numChans-1]

Enable Output Verify Boolean

Off (0)
On (1)

Off (0)

Yes

Application
Developer

CEE

No

DOM (see Notes)

Notes

58

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

Range

Default

EWIREOFF
[0..numChans-1]

DIM (configurable
only on Diagnostic
modules)

Enable Wire-Off
Diagnostic

Boolean

Wire-Off
Diagnostic
disabled (0)
Wire-Off
Diagnostic
enabled (1)

EXCMODEOPT

SCM

Execution Mode
Option

Enumeration None (0)


CSCOEXCMO Auto (1)
DEOPTION

EXECCODE

Handler, SCM,
Step, Transition.

EXECCODE [1..8]

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Wire-Off Yes
Diagnosti
c disabled
(0)

Application
Developer

CEE

No

WIREOFF
[0..numChans-1]

Auto (1)

No

Engineer

CEE

No

Execution Code

Enumeration None (0)


None (0)
CSCOEXECCO ConfigError (1)
DE
ExprEvalFail
(2)
StoreFailed (3)
CommError (4)
StoreWarning
(5)
InternalErr (6)
CtrlReqErr (7)
DataTypeErr
(8)
StorePending
(9)

No

ViewOnly

CEE

No

EXECDESC, EXECSTS

AuxCalc, RegCalc

Execution Code

None (0)
Enumeration None (0)
AUXCALCEXE ConfigError (1)
CCODE
ExprEvalFail
(2)
StoreFailed (3)
CommError (4)
StoreWarning
(5)
InternalErr (6)
CtrlReqErr (7)
DataTypeErr
(8)
StorePending
(9)

No

ViewOnly

CEE

No

EXECDESC [1..8],
EXECSTS [1..8]

EXECCOUNT

All IO Channels,
PWM Channel,
SIFLAGARRCH,
SINUMARRCH,
SITEXTARRCH

Execution Count

Integer

View Only

CEE

EXECDES

Handler, SCM,
Step, Transition,
AuxCalc, RegCalc

Execution Code
Descriptor

String

ViewOnly

CEE

No

EXECSTS, EXECCODE

Maximum of None
39 characters

No

Notes

When EXCMODEOPT is
Auto, the SCMMODE is
automatically set to Auto
whenever the active handler
changes.

59

Specific to
Block(s)

Description

Data Type

Range

EXECDESC [1..8]

Auxcalc

Execution Code
Descriptor

String

Maximum of None
39 characters.

EXECSTATE

CM, IOM, SCM

Execution state of
the block and its
components.

Enumeration Inactive (0)


of EXECSTATE Active (1)

EXECSTS

SCM, Handler,
Step, Transition,
AuxCalc, RegCalc.

Execution Status

Enumeration Ok (0)
Ok (0)
CSCOEXECST Bypass (1)
S
Info (2)
Warning (3)
Fail (4)
Error (5)
OkPaused (6)
BypassPaused
(7)
InfoPaused (8)
WarnPaused
(9)
FailPaused
(10)
ErrorPaused
(11)

TypeConvert

Execution Status Enumeration


Provides the overall TCEXECSTS
operation status of
the TypeConvert
function block.

Ok (0)
Warning (1)
Error (2)

Default

Inactive
(0)

Ok (0)

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

No

ViewOnly

CEE

No

EXECSTS [1..8],
EXECCODE [1..8]

No

Supervisor

CEE

No

CEESTATE, STATE
(for SCM)

No

ViewOnly

CEE

No

SCM component (Handler,


Step, Transition) status
parameters EXECSTS,
EXECCODE, and EXECDESC
are updated when they are in
the SCMs current scope of
execution. The SCMs status
parameters are
representative of the status
of the components in the
current scope.

No

ViewOnly

CEE

No

When EXECSTS is not Ok, it


means that either:
the input could not be
fetched,
the connection to the
input is lost,
it is bad data, or the input
is clamped during type
conversion.

For CMs: Only when


EXECSTATE is Active and the
CEESTATE is Run, are the
block and its component
blocks executing.
For IOMs: When EXECSTATE
is Active, the IOM is
executing regardless of
CEESTATE.
For both CMs and IOMs:
Block reload is only allowed
when the block is NOT
executing.
Note that EXECSTATE is
always initialized to
INACTIVE after load, reload
or snapshot restore,
regardless of its previous
state.

60

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

Default

Config
Load

Access
Lock

Residence

Active
Connector

EXECSTS [1..8]

Auxcalc

Execution Status

Enumeration Ok (0)
AUXCALCEXE Bypass (1)
CSTS
Info (2)
Warning (3)
Fail (4)
Error (5)

Ok (0)

No

ViewOnly

CEE

No

EXPR [1..8]

AuxCalc, RegCalc

Calculator
String
Expressions Each
may contain a
user-specified
logical, arithmetic or
conditional
expression of up to
eighty characters.

Length: up to Null
255
string
characters.
(This will be
unlimited in a
future
release.)

Yes

Engineer

CEE

No

EXPRPCODE [1..8] Auxcalc, RegCalc

Expression
Pseudo-code

String

Maximum of
220
characters.

Yes

Application
Developer

CEE

No

EXTRAPULSE

Extra Pulse Time


Option

Boolean

Off (0)
On (1)

Off (0)

Yes

Supervisor

CEE

No

0.0

No

View Only

CEE

No

PosProp,
PidPosProp

Range

Related
Parameters

Notes

EXTRAPULSETM PosProp,
PidPosProp

Extra Pulse Time left Real


over (in seconds)

This is the difference


between unclamped value
and clamped value of
RAISETIME or LOWERTIME.

EZCROSS
[0..numChans-1]

DOM

Enable Loss of
Power

Boolean

Off (0)
On (1)

Off (0)

Yes

Application
Developer

CEE

No

NOFIELDPWR
[0..numChans-1]

EZCROSS is only visible,


configured, and loaded on
the 8-channel 120V AC
diagnostic module.

FAILALM.FL

SCM

Sequential Control
Module (SCM) Fail
Alarm Flag

Boolean

Off (0)
On (1)

Off (0)

No

View Only

CEE

No

EXECSTS

FAILALM.FL is On when SCM


EXECSTS is Fail

FAILALM.PR

SCM

Sequential Control
Module (SCM) Fail
Alarm Priority

Enumeration
ALPRIOR

None (0)
Journal (1)
Low (2)
High (3)
Urgent (4)

Low (2)

Yes

Engineer

CEE

No

FAILALM.FL,
FAILALM.SV

FAILALM.SV

SCM

Sequential Control
Module (SCM) Fail
Alarm Severity

16-Bit Integer 0 to 15

Yes

Engineer

CEE

No

FAILALM.FL,
FAILALM.PR

61

Specific to
Block(s)

Description

Data Type

Range

Default

FAILSTATE
[0..numChans-1]

DOM

Shed Mode Shed


to Hold enabler.

Boolean

Use Safe
State (0)
Hold Last
Output State
(1)

FAULTDELAY

1797-OB4D

Fault Detection
Delay Time

Enumeration

FAULTENB [ ]

1797-OB4D

Enable Fault
Detection

FAULTRESET

1797-OB4D

Fault Reset

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

Use Safe Yes


State (0)

Application
Developer

CEE

No

SAFESTATE
[0..numChans-1]

In the event of controller


failure or loss of
communication between the
controller and the IOM, if
enabled, the output will hold
the last state processed. If
disabled, the output will
assume the Safe State.
Note that if the IOM device
itself fails, the output value
is not deterministic.

11 ms
12 ms
14 ms
18 ms
26 ms
42 ms

11 ms

Yes

Application
Developer

CEE

No

FAULTENB [ ],
LATCHENB

Determines the length of


time over which a fault must
be continuously present
before the device will
recognize the fault and
signal it.
Applies globally to all
channels on the device.

Boolean

Off(0)
On(1)

Off(0)

Yes

Application
Developer

CEE

No

FAULTRESET,
LATCHENB

Enables detection of wire-off


and short-circuit conditions.
Applies to individual
channel. There are four
channels associated with
this device.

Boolean

Off(0)
On(1)

Off(0)

Yes

Engineer

CEE

No

FAULTENB [ ],
LATCHENB

If LATCHENB has been


asserted so that detected
faults are latched, this
parameter is used to allow
generation of a Latched Fault
reset pulse to the device.
The engineer clicks on a
check box. The function
block generates the
appropriate pulse and clears
the checkbox when the reset
operation is complete.
Applies globally to all
channels on the device.

62

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

FAULTVALUE
[0..numChans-1]

AOM

Safe Value (in


64-Bit Real
percent) Specifies Number
a safe output value
to be assumed in the
event of a controller
failure or loss of
communication
between the
controller and IOM.
Note that
SHEDMODE must be
enabled in order to
configure and use
the FAULTVALUE.
Note that if the IOM
device itself fails,
the output value is
not deterministic.

FBORSTS

All RegCtl Blocks: Function Block


AutoMan, Fanout, Override Status
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

FBTYPE

PID

Enumeration
PTORST

Function Block Type Enumeration


Indicates type of FBTYPES
base template from
which the function
block was derived.

Range

NotCon (0)
Sel (1)
NotSel (2)

Default

Access
Lock

Residence

Active
Connector

Related
Parameters

50 for
Yes
modules
operating
in voltage
mode
only.
-25 for
modules
operating
in current
mode (or
current
and
voltage
modes).

Application
Developer

CEE

No

SAFESTATE
-25 is the recommended Safe
[0..numChans-1] (for Value for current mode.
DOM)
50 is the recommended Safe
Value for voltage mode.
Note that the non-isolated
(high-density) AOM allows
channels to be configured for
use in either voltage or
current mode. Since only
one default value can be
specified (-25), it is
recommended that the user
change the value to 50 (or
other safe value) if using
voltage mode.

NotCon
(0)

No

View Only

No

View Only

Null
Null
PID and all
Regulatory
Control
function
blocks
DataAcq
and all
Auxiliary
function
blocks
DigComp
DisDev
All Logic
function
blocks
All Utility
function
blocks
Sco

Config
Load

No

CEE

Notes

Indicates if the primary is


selected or not.

No

63

Specific to
Block(s)

Description

FETCHMODE

All IO Channels,
PWM Channel,
SIFLAGARRCH,
SINUMARRCH,
SITEXTARRCH

FF

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Fetch Mode - When Integer


this mode is set, the
IO Channel works
without the IOM
function block.

Off (0)

No

Engineer

CEE

No

PIDFF

Feed Forward Input Real


in Engineering Units.

NaN

FFCONN

PIDFF

Feed Forward Input


Connect.

FFOPT

PIDFF

Feedforward Option. Integer


FFOPT indicates if
feedforward is to be
added to or
multiplied by the
incremental PID
output.

Engineer

FFSTS

PIDFF

Feed Forward Input


Status

View Only

FILENUM

REQFLAGARRAY,
REQNUMARRAY,
REQTEXTARRAY

When using PCCC String


(i.e., when the
COMMAND is
PLC5TypRead or
PLC5TypWrite), this
parameter is the
PCCC File Name and
Offset in the target
device. This value is
the Logical ASCII
Symbolic Address
without the Logical
ASCII Identifier. The
following is an
example of a valid
value for this
parameter: N7:0
When using CIP (i.e.,
when the
COMMAND is
CIPRead or
CIPWrite), this
parameter is the
name of the file in
the target device.

Maximum of Null
40 characters String

FILTERHDR
[0..numChans-1]

DIM

Filter Grid Header

Maximum of Null
20 characters String

Related
Parameters

Direct Get, Direct Store

SIFL, PV, SP
Application
Developer

Integer

String

Yes

SIFL, PV, FF, SP

Application
Developer

CEE

View Only

SR

Notes

64

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

Range

Default

FILTEROFF
DIM
[0..numChans / 8]

Filter times for On to


Off transition in
milliseconds.
Configurable on
each DIM in groups
of 8 consecutive
channels.

DC Modules:
Enumeration
of
FILTERONOFF
AC Modules:
Enumeration
of
ACFILTERONO
FF

FILTEROFFON:
No Delay (0)
1 ms Delay (1)
2 ms Delay (2)
9 ms Delay (9)
18 ms Delay
(18)
ACFILTEROFFO
N:
9 ms Delay (9)
18 ms Delay
(18)

FILTERON
DIM
[0..numChans / 8]

Filter times for Off to DC Modules:


On transition in
Enumeration
milliseconds.
of
FILTEROFFON
AC Modules:
Enumeration
of
ACFILTEROFFO
N

FILTEROFFON:
No Delay (0)
1ms Delay (1)
2 ms Delay (2)
ACFILTEROFFO
N:
1 ms Delay (1)
2 ms Delay (2)

FREEMEM

CPM

Amount of currently 32-Bit Integer 0 to 4194304


free memory in CEE
Bytes
user memory pool.

FREEMEMINK

CPM

Amount of free
32-Bit Integer 0 to 4194304
memory in CEE user
Kbytes
memory pool.

FREEZETIME

All IO Channels,
PWM Channel,
SIFLAGARRCH,
SINUMARRCH,
SITEXTARRCH

Maximum Freeze
Time

Real

Access
Lock

Residence

Active
Connector

Related
Parameters

DC
Yes
Modules:
No Delay
(0)
AC
Modules:
9 ms
Delay (9)

Application
Developer

CEE

No

FILTERON
[0..numChans / 8]

DC
Yes
Modules:
No Delay
(0)
AC
Modules:
1 ms
Delay (1)

Application
Developer

CEE

No

FILTEROFF
[0..numChans / 8]

No

View Only

CEE

No

TOTALMEM,
USEDMEM,
MAXFREEBLKSZ

This parameter publishes


total amount of unused
memory in the user memory
pool. Free memory
decreases as blocks are
loaded and increases as
blocks are unloaded. The
difference between
TOTALMEM and FREEMEM
is equal to USEDMEM.

No

View Only

CEE

No

TOTALMEMINK,
USEDMEMINK,
MAXFREEINK

This parameter publishes


total amount of unused
memory in the user memory
pool. Free memory
decreases as blocks are
loaded and increases as
blocks are unloaded. The
difference between
TOTALMEMINK and
FREEMEMINK is equal to
USEDMEMINK.

Config
Load

Notes

View Only

65

Specific to
Block(s)

FREQPERIOD

Description

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Pulse Input IOC,


Frequency
Enumeration
Pulse Input w/ Fast Integration Period
Cutoff IOC
Period at which
Module calculates
frequency.

25ms (0)
50ms (1)
100ms (2)
200ms (3)
500ms (4)
1000ms (5)
2000ms (6)

1000ms
(5)

Yes

View Only

CEE

No

FREQPERIOD
[0..7]

Pulse Input IOM

Frequency
Enumeration
Integration Period
Period at which
Module calculates
frequency.

25ms (0)
50ms (1)
100ms (2)
200ms (3)
500ms (4)
1000ms (5)
2000ms (6)

1000ms
(5)

Yes

Application
Developer

CEE

No

FTAAOVRNFL

Serial Interface
IOM

FTA A Overrun Flag Boolean


Indicates whether
the FTA currently has
too many writes to
process and is in an
overrun condition
(value is On) or not
(value is Off).

Off (0)
On (1)

Off (0)

No

View Only

CEE

No

FTABOVRNFL

FTAASTS

Serial Interface
IOM

FTA A Status
Enumeration
Provides the current
status of the FTA.

FtaNotPresnt FtaNotPre No
(0)
snt (0)
TfaOk (1)
FtaConfig (2)
FtaSoftFail (3)

View Only

CEE

No

FTABSTS

FTABOVRNFL

Serial Interface
IOM

FTA B Overrun Flag Boolean


Indicates whether
the FTA currently has
too many writes to
process and is in an
overrun condition
(value is On) or not
(value is Off).

Off (0)
On (1)

No

View Only

CEE

No

FTAAOVRNFL

FTABSTS

Serial Interface
IOM

FTA B Status
Enumeration
Provides the current
status of the FTA.

FtaNotPresnt FtaNotPre No
(0)
snt (0)
TfaOk (1)
FtaConfig (2)
FtaSoftFail (3)

View Only

CEE

No

FTAASTS

Sel, Selreal

G Selector input
value

Off (0)
On (1)

Engineer

CEE

No

Boolean

Off (0)

Off (0)

Yes

Related
Parameters

Notes

PV in EU = (C1/C2) *
TIMEBASE *
pulses/(Frequency
Integration Period)

When an Overrun is
indicated, some requested
writes are not being
completed. Check the
application to see if the
quantity or rate of writes can
be reduced, or if possible,
split the load between two
FTAs, so that no overruns
occur.

When an Overrun is
indicated, some requested
writes are not being
completed. Check the
application to see if the
quantity or rate of writes can
be reduced, or if possible,
split the load between two
FTAs, so that no overruns
occur.

66

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

G [1..4].ALGID

Transition

Gate Algorithm ID
G [1].ALGID:
Secondary Gate (S)
Type
G [2..4].ALGID:
Primary Gate (Px)
Type

Enumeration
CSCOALGID

None (0)
On (1)
Off (2)
Connect (3)
Not (4)
Or (5)
Nor (6)
And (7)
Nand (8)
Xor (9)

None (0)

Yes

Application
Developer

CEE

No

G [1].ALGID defines the


secondary gate,
G [2].ALGID through G [4]
define the primary gates.

G
Transition
[1..4].FIRSTCOND

Gate First Condition 32-Bit Integer 0 to 10


Handle

No

ViewOnly

CEE

No

See G [1..4].ALGID for


additional information.

G
Transition
[1..4].NUMINPTS

Gate Number of
Inputs

32-Bit Integer 0 to 10

Yes

Application
Developer

CEE

No

See G [1..4].ALGID for


additional information.

G [1..4].SO

Transition

Gate Status Output

Boolean

Off (0)
On (1)

Off (0)

No

View Only

CEE

No

GAINHILM

AutoMan, Fanout, Gain High Limit - K, 64-Bit Real


PID, PIDFF, PosProp, KLIN, and
Number
RegCalc
KMODIFEXT will be
clamped to this limit.

Any value
greater than
GAINLOLM.

240.00

Yes

Engineer

CEE

No

GAINLOLM, K, KLIN and


KMODIFEXT

GAINLOLM

AutoMan, Fanout, Gain Low Limit - K, 64-Bit Real


PID, PIDFF, PosProp, KLIN, and
Number
RegCalc
KMODIFEXT will be
clamped to this limit

Any value less 0.00


than
GAINHILM.

Yes

Engineer

CEE

No

GAINHILM, K, KLIN and


KMODIFEXT

GAINOPT

PID, PIDFF

Gain Option.
Specifies how the
PID gain should be
calculated.

Enumeration
GAINOPT

Lin (0): Linear Lin (0)


Gain
Gap (1): Gap
Gain
Nonlin (2):
Nonlinear
Gain
Ext (3):
External Gain

Yes

Engineer/Ap CEE
plication
Developer

No

GAPHILM

PID, PIDFF

Gap High Limit.


Used if GAINOPT =
Gap (configured).

64-Bit Real
Number

0.00

Yes

Engineer

CEE

No

GAPLOLM

PID, PIDFF

Gap Low Limit.


Used if GAINOPT =
Gap (configured).

64-Bit Real
Number

0.00

Yes

Engineer

CEE

No

67

Specific to
Block(s)

Description

GENSTATE

RM

General State of the Enumeration


Redundancy Module

Undefined (0) Undefine No


Startup (1)
d (0)
Reload (2)
Fault (3)
Ok (4)

View Only
Not Loaded
Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform.

No

GENSTATEA

RM

RM Module General Enumeration


State. For each
[20]
module in the host
chassis, general
state of module

Undefined (0) Undefine No


Startup (1)
d (0)
Reload (2)
Fault (3)
Ok (4)

View Only
Not Loaded
Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform.

No

GOP

DevCtl

Generic Output (OP) Enumeration


GENSTATE

See below.

Other
Function
Block

CEE

Active (2):

Data Type

Range

Default

S0 (4)

Config
Load

No

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

No

GOPFINAL, GOPREQ,
MODEATTR,
NUMDOUTS,
NUMSTATES, OP,
OPFINAL, OPREQ,
SAFEOP,
SAFEREDTAG

Access is illegal if
NUMDOUTS = 0.
S2 is illegal if NUMSTATES =
2.
Once SAFEOP is configured,
GOP always defaults to
SAFEOP.
Active is illegal if
NUMSTATES = 3.

Range
Not configured SafeOP for two state device (i.e., if
SafeOp = State 0, Active will set OP to state 1).

Safe (3):

The state nominated as the SafeOP state on the State


Assignment form.

S0 (4):

State zero as defined on the State Assignment form.

S1 (5):

State one as defined on the State Assignment form.

S2 (6):

State two as defined on the State Assignment form.

GOPFINAL

DevCtl

Generic Field Output Enumeration


State (OPFINAL)
GENSTATE

S0 (4)
S1 (5)
S2 (6)

S0 (4)

No

ViewOnly

CEE

No

GOP, MODEATTR,
NUMDOUTS,
NUMSTATES, OP,
OPDOMAP [0..3]
[1..3], OPFINAL

Access is illegal, if
NUMDOUTS = 0.

GOPREQ

DevCtl

Generic Requested
Output Value
(OPREQ)

Null (0)
Active (2)
Safe (3)
S0 (4)
S1 (5)
S2 (6)

Null (0)

No

Other
Function
Block

CEE

No

CONTROLREQ, GOP,
OPREQ, OPTYPE,
NUMSTATES, OP,
SCMOPT

S2 is illegal if NUMSTATES =
2.
GOPREQ is illegal if
CONTROLOPT = None.

Enumeration
GENSTATE

68

Parameter

Parameter

Specific to
Block(s)

Description

GOPSCADA

DevCtl

GPV

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Generic Output for Enumeration State_0 (0)


ProcessLogix Server GENSTATESC State_1 (1)
detail displays - This
State_2 (2)
parameter
represents the three
user-defined states
so that they may be
represented clearly
in the detail
displays.

State_0
(0)

No

Operator

CEE

No

GOP, OP

DevCtl

Generic Process
Variable (PV)

Enumeration
GENSTATE

Null (0)
Inbet (1)
S0 (4)
S1 (5)
S2 (6)

Null (0)

No

View Only,
Other
Function
Block (see
Notes)

CEE

No

DIPVMAP [0..15],
GPVAUTO,
NUMDINPTS,
NUMSTATES, PV,
PVAUTO, PVSOURCE,
PVSRCOPT

Access is illegal, if
NUMDINPTS = 0.
S2 is illegal, if
NUMSTATES = 2.
InBet is illegal, if DIPVMAP
is not assigned to InBet.
Access Lock is View Only if
PVSOURCE = AUTO, MAN or
TRACK; or if PVSRCOPT is
ONLYAUTO.
Access Lock is Other
Function Block if PVSOURCE
= SUB.

GPVAUTO

DevCtl

Generic PVAUTO

Enumeration
GENSTATE

Null (0)
Inbet (1)
S0 (4)
S1 (5)
S2 (6)

Null (0)

No

View Only

CEE

No

DIPVMAP [0..15],
GPV, NUMDINPTS,
NUMSTATES, PV,
PVAUTO, PVSOURCE

Access is illegal, if
NUMDINPTS = 0.
S2 is illegal, if
NUMSTATES = 2.
InBet is illegal, if DIPVMAP
is not assigned to InBet.

HANDLER

Step, Transition,
Handler

Contains the name


of the Handler to
which that
Transition or Step
belongs.

BlockId

Null
String

No

View Only

CEE

No

NUM

HANDLERREF

Handler, Step,
Transition

Internal parameter
for system use only.

HIALM.PR

RegCtl, DevCtl,
DataAcq, SCM,
Flag

Highest Alarm
Enumeration
Priority - Indicates ALPRIOR
the priority of the
highest-level alarm
that currently exists
for the function
block.

None (0)

No

View Only

CEE

No

HIALM.TYPE,
HIALM.SV

None (0)
Journal (1)
Low (2)
High (3)
Urgent (4)

Notes

69

Specific to
Block(s)

Description

HIALM.TYPE

RegCtl, DataAcq,
SCM

Highest Alarm
Enumeration See below.
Detected - This
DACALMTYPE
variable is used by
the system to ensure
None (0):
that, when alarm
conditions exist for a
function block at the
NegROC (1):
same time, the most
PosROC (2):
important or
highest-level alarm
PvLo (3):
condition will
appear on both
PvHi (4):
detail and group
PvLoLo (5):
displays.
PvHiHi (6):

HIALM.TYPE

Data Type

Range

BadPV (7):
DevCtl

Flag

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

None (0)

No

View Only

CEE

No

HIALM.PR,
HIALM.SV

No

CEE

HIALM.PR,
HIALM.SV

No

CEE

OFFNRMALM.FL,
OFFNRMALM.PR,
OFFNRMALM.SV,
INALM

Range
No alarm exists
(Lowest-level alarm condition)
Negative Rate-of-Change alarm
Positive Rate-of-Change alarm
PV Low alarm
PV High alarm
PV Low Low alarm
PV High High alarm
Bad PV alarm

Highest Alarm
Enumeration See below.
None (0) No
View Only
Detected - This
DEVHIALM
variable is used by
Range
the system to ensure
None
(0)
No
alarm
that, when alarm
conditions exist for a
BadPv (1)
Bad PV alarm
function block at the
OffNormal
(2)
Off Normal alarm
same time, the most
important or
CmdDisagree (3)
Command Disagree alarm
highest-level alarm
condition will
CommandFail (4)
Command Fail alarm
appear on both
UnCommanded (5) Uncommanded alarm
detail and group
displays.
SafetyIlock (6)
Safety Interlock alarm
Oride0Ilock (7)

State0 Override Interlock alarm

Oride1Ilock (8)

State1 Override Interlock alarm

Oride2Ilock (9)

State2 Override Interlock alarm

Highest Alarm
Enumeration
Detected - Ensures HIALMFlag
that when alarm
conditions exist for a
function block at the
same time, the most
important or
highest-level alarm
condition will
appear on both
detail and group
displays.

None (0)
None (0)
OffNormal (1)

No

Engineer

Notes

70

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

HIGHENG
[0..numChans-1]

AIM, AOM
This parameter is
configurable only
on the AIM.

High Engineering (f) 64-Bit Real


Number

HIGHSIGNAL
[0..numChans-1]

AIM, AOM

High Signal

64-Bit Real
Number

HISTDESC

SCM

History Parameter
Descriptor

HOLDALM.FL

SCM

Hold Alarm Flag

HOLDALM.PR

SCM

Hold Alarm Priority - Enumeration


Specifies the alarm ALMPRIOR
priority for the Hold
alarm.

HOLDALM.SV

SCM

HOLDCMD

RampSoak

Range

Default

Config
Load

NaN,
greater-than
LOWENG

100.0

Residence

Active
Connector

Related
Parameters

AIM: Yes AIM:


AOM: No Application
Developer
AOM: View
Only

CEE

No

LOWENG
[0..numChans-1]

See
Notes.

No

View Only

CEE

No

SIPTYPE
[0..numChans-1],
INPUTRANGE
[0..numChans-1],
LOWSIGNAL
[0..numChans-1]

String

Maximum of Null
63 characters. String

Yes

Engineer

CEE

No

NUMHISTPARMS

Boolean

Off (0)
On (1)

Off (0)

No

View Only

CEE

No

HOLDALM.PR,
When this is On, it indicates
HOLDALM.SV, STATE that the Hold Alarm
condition (SCMSTATE has
transitioned to Hold or
Holding) exists.

None (0)
Journal (1)
Low (2)
High (3)
Urgent (4)

Low (2)

Yes

Engineer

CEE

No

HOLDALM.FL,
HOLDALM.SV

Hold Alarm Severity 16-Bit Integer 0 to 15


- Specifies the alarm
severity for the Hold
alarm.

Yes

Engineer

CEE

No

HOLDALM.FL,
HOLDALM.PR

RampSoak Hold Flag Boolean

Off (0)

No

Other
Function
Block

CEE

No

Off (0)
On (1)

Access
Lock

Notes

For AIMs, this parameter is


set within the controller,
based on the store of
INPUTRANGE.
For AOMs, this parameter is
set within the controller,
based on the store of
SIPTYPE.

71

Specific to
Block(s)

Description

Data Type

HOLDOPT

DevCtl,
All RegCtl Blocks:
AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

The Hold State


Enumeration
Option is a
REGEXOPT
configurable
parameter that
specifies the action
the control device
takes, when
SCMSTATE is
Holding or Held. This
option should be
disabled, when
sequencing actions
are required as part
of the SCM. In this
case, the SCM
should execute its
HOLD Handler. The
SCM can also
disable this option.

HOLDRATE

All RegCtl Blocks:


AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Hold State Set Point 64-Bit Real


(SP) Ramp Rate - The Number
value used for
setting SPRATEREQ
when HOLDOPT is
RampedSP.

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

None (0): no None (0)


changes
Man (1): set
MODEREQ =
Manual
Auto (2): set
MODEREQ =
Auto
Cas (3): set
MODEREQ =
Cas
FixedOP (4):
set OPREQ =
HOLDVAL
HoldPv (5): set
SPREQ = PV
FixedSP (6):
set SPTVREQ
= HOLDVAL,
and
SPRATEREQ =
NaN
RampedSP (7):
set SPTVREQ
= HOLDVAL,
and
SPRATEREQ =
HOLDRATE

Yes

Engineer

CEE

No

DevCtl only: OPREQ,


OPTYPE,
RESTARTOPT,
SAFEOP, SCMOPT,
STARTOPT, STOPOPT,

Defines values for SPREQ,


SPTVREQ, SPRATEREQ,
OPREQ and MODEREQ, when
the Control
Module.SCMSTATE
transitions to Held or
Holding.
DevCtl only: Illegal if
ControlModule.SCMOPT =
None.

NaN, 0, and NaN


Real Numbers

Yes

Engineer

CEE

No

HOLDOPT

Defines value for


SPRATEREQ, when HOLDOPT
= Ramped Set Point (SP)

72

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

HOLDVAL

All RegCtl Blocks:


AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Hold State Value - 64-Bit Real


The value used for Number
setting OPREQ,
when HOLDOPT is
FixedOP; or for
setting SPREQ or
SPTVREQ, when
HOLDOPT is FixedSP
or RampedSP.

OPEXLOLM to NaN
OPEXHILM,
when
HOLDOPT =
Fixed Output
(OP)
SPLOLM to
SPHILM,
when
HOLDOPT =
Fixed Set
Point (SP) or
Ramped Set
Point (SP)
(NaN, 0.0, or
positive and
negative real
numbers)

Yes

Engineer

CEE

No

HOLDOPT

Defines a value for OP when


HOLDOPT = FixedOP,
or a value for SP when
HOLDOPT = FixedSP,
or a value for SPTV when
HOLDOPT = RampedSP.

HWFAULT

DIC

Hardware fault
detected.

Boolean

No Fault
No Fault No
Detected (0) Detected
Fault Detected (0)
(1)

View Only

CEE

No

HWFAULT
[0..numChans-1]

DIM

Hardware fault
detected.

Boolean

No Fault
No Fault No
Detected (0) Detected
Fault Detected (0)
(1)

View Only

CEE

No

IC.BYPPERM

Step

Step Interrupt
Condition Bypass
Permit.

Boolean

Off (0)
On (1)

IC.BYPREQ

Step

Step Interrupt
Condition Bypass
Request.

Enumeration ToOff (0)


CSCOBYPREQ ToOn (1)
None (2)

Off (0)

Yes

Engineer

CEE

No

IC.BYPREQ, IC.FL

When On, IC.FL is set


according to IC.BYPREQ.

None (2)

No

Operator

CEE

No

IC.BYPPERM, IC.FL

See IC.BYPPERM for


additional information.

73

Specific to
Block(s)

Description

Data Type

IC.CONFIGCODE

Step

Common Interrupt
Condition
Configuration Code

Enumeration See below


CSCOCONFIG
CODECOND

None (0)
Ok (1)
UnknownErr (2)
ImplicitConv (3)
LossOfPrecsn (4)
UnexpctEnd (5)
UnexpctComma (6)
ColonWoQMark (7)
FctNotMltArg (8)
ClosParenExp (9)
OperandExp (10)
MissingArg (11)
OperatorExp (12)
ColonExp (13)
TypeMismatch (14)
TypeNotSupp (15)

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

None (0)

No

View Only

CEE

No

See IC.CONFIGSTS for


additional information.

See IC.CONFIGSTS for


additional information.

Range
SyntaxError (16)
IntegerExp (32)
ExprTooCmplx (17)
DoubleExp (33)
NotEPcodeMe (18) MissedImpl (34)
NotEDataStak (19)
UnicodeConv (35)
UnsuppFeatur (20)
ConstExprRem (36)
ExprTooLong (21)
DuplExprRem (37)
DivideByZero (22)
ExtUse38 (38)
UnknownToken (23) ExtUse39 (39)
UnexpTokenOS (24) ExtUse40 (40)
UnknownFunc (25)
ExtUse41 (41)
UnexpOCExpr2 (26) ExtUse42 (42)
UnexpOCExpr3 (27) ExtUse43 (43)
ZeroArgument (28) ExtUse44 (44)
UnexpToken (29)
ExtUse45 (45)
InvalResult (30)
ExtUse46 (46)
InvalTokenTb (31)
ExtUse47 (47)
String

Step

Common Interrupt
Condition
Configuration
Descriptor

Maximum of None
39 characters

No

View Only

CEE

No

IC.CONFIGSTS

Step

Common Interrupt Enumeration Ok (0)


Ok (0)
Condition
CSCOCONFIG Information (1)
Configuration Status STS
Warning (2)
SevereWarn
(3)
Error (4)
SevereError
(5)

No

View Only

CEE

No

IC.DESC

Step

Step Interrupt
String
Condition Descriptor

Yes

Application
Developer

SR

No

Null
String

Notes

ExtUse48 (48)
ExtUse49 (49)
ExtUse50 (50)
UnSupConType (51)
UnExpClsParn (52)
CantAssRVal (53)
UnExpArrOpen (54)
ArrClsExpect (55)
ArrOpnExpect (56)
ArrIndxError (57)
StringExpect (58)
InvalidRefer (59)
TooManyConnS (60)
CantConvInpt (61)

IC.CONFIGDESC

Length: 64
characters

Related
Parameters

IC.CONFIGCODE,
IC.CONFIGDESC

Interrupt input condition


configuration status
parameters IC.CONFIGSTS,
IC.CONFIGCODE, and
IC.CONFIGDESC are set on
SCMSTATE transition from
Inactive to Validated.

74

Parameter

Parameter

Specific to
Block(s)

Description

IC.EXECCODE

Step

IC.EXECDESC

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Step Interrupt
Enumeration None (0)
None (0)
Condition Execution CSCOEXECCO ConfigError (1)
Code
DE
ExprEvalFail
(2)
StoreFailed (3)
CommError (4)
StoreWarning
(5)
InternalErr (6)
CtrlReqErr (7)
DataTypeErr
(8)
StorePending
(9)

No

View Only

CEE

No

See IC.EXECSTS for


additional information.

Step

Step Interrupt
String
Condition Execution
Code Descriptor

Maximum of None
39 characters.

No

View Only

CEE

No

See IC.EXECSTS for


additional information.

IC.EXECSTS

Step

Step Interrupt
Enumeration Ok (0)
Ok (0)
Condition Execution CSCOEXECST Bypass (1)
Status
S
Info (2)
Warning (3)
Fail (4)
Error (5)
OkPaused (6)
BypassPaused
(7)
InfoPaused (8)
WarnPaused
(9)
FailPaused
(10)
ErrorPaused
(11)

No

View Only

CEE

No

IC.EXPR

Step

Step Interrupt
String
Condition Expression

String has a Null


maximum
String
length of 255
characters.

Yes

Application
Developer.

SR

No

IC.EXPRPCODE

Step

Internal parameter
for system use only.

IC.FL

Step

Step Interrupt
Condition Status
Flag

Boolean

Off (0)
On (1)

Off (0)

No

View Only

CEE

No

IC.INVOKFL

Step

Step Interrupt
Condition Invoke
Flag

Boolean

Off (0)
On (1)

Off (0)

No

View Only

CEE

No

IC.OPT

Step

Step Interrupt
Condition Option

Boolean

Off (0)
On (1)

Off (0)

Yes

Application
Developer

CEE

No

IC.EXECCODE,
IC.EXECDESC

Notes

Step Interrupt Condition


execution status parameter
IC.EXECSTS, IC.EXECCODE,
and IC.EXECDESC are
updated when the step is in
the Sequential Control
Modules (SCM) current
scope of execution.

IC.FL

75

Must be set to On, to enable


the Step Interrupt Condition.

Specific to
Block(s)

Description

Default

Config
Load

Access
Lock

Residence

Active
Connector

ICSRC [1..6]

Step

Internal parameter
for system use only.

ID

Step

Step ID (User
Defined)

No

Operator

CEE

No

General purpose parameter


provided for whatever the
user chooses. The SCM or
Step does not use this for
anything.

IFTRANS

AIM, excluding
non-isolated
(high-density)
modules

Idle/Fault Transition Boolean


Enable

On (1)

Yes

Application
Developer

CEE

No

Although loaded, this


parameter is not exposed on
any configuration form.

IN

Limit, Checkbad

Input value for the


IN connection.

64-Bit Real
Number

NaN

Yes

Engineer

CEE

No

Delay, FTrig,
Maxpulse,
Minpulse, Not,
Offdelay, Ondelay,
Pulse, RTrig, Trig,
Watchdog

Input value for the


IN connection

Boolean

Off (0)

No

Engineer

CEE

No

SHL, SHR, ROR,


ROL

Input value for the


IN connection.

16-Bit Integer 16-Bit Integer 0.0

Yes

Engineer

CEE

No

EQ, GE, GT, LE, LT,


NE, SelReal

Input value for the


IN connection.

Real

NaN

No

Engineer

CEE

No

Sel

Input value for the


IN connection

Boolean

Off (0)
On (1)

Off (0)

No

Engineer

CEE

No

2oo3

Input values for the Boolean


IN connection

Off (0)
On (1)

Off (0)

No

Engineer

CEE

No

IN [0..12]

Genlin

Input Coordinates 0 64-Bit Real


to 12 - These
Number
Parameters define
the input value at
the respective
coordinate for the
General
Linearization
function block.

Each
NaN
coordinate
must be
greater-than
the previous
coordinate,
and less-than
the next
coordinate.

Yes

Engineer

CEE

No

IN [1..8]

And, Mux, MVote, Input value for the


Nand, Nor, Or, Qor, IN connection
Xor,.

Boolean

Off (0)
On (1)

Off (0)

Yes

Engineer

CEE

No

Muxreal, Max, Min Input value for the


IN connection

64-Bit Real
Number

NaN

No

Engineer

CEE

No

Off (0)

No

Engineer

CEE

No

IN [0..2]

IN [1..20]

NooN

Data Type

Range

32-Bit Integer -2^31 to


(2^31)-1

Input values for the Boolean


IN connection

Off (0)
On (1)

Off (0)
On (1)

Off (0)
On (1)

Related
Parameters

OUT [0..12],
NUMSEGS

Notes

76

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

IN.BOOLEAN

TypeConvert

Boolean Input Value Boolean


Provides the value
fetched from the
TypeConvert
function block
source.

IN.ENUM

TypeConvert

Enumerated Input
Value

Off (0)
On (1)

Off (0)

No

View Only

CEE

Yes. The
EXECSTS
connection is
to IN.Src

No

View Only

CEE

Yes. The
EXECSTS
connection is
to IN.Src

IN.FLOAT32

TypeConvert

32-Bit Floating Point Real


Input Value
Provides value
fetched from the
TypeConvert
function blocks
source.

NaN

No

View Only

CEE

Yes. The
EXECSTS
connection is
to IN.SRC

IN.FLOAT64

TypeConvert

64-Bit Floating Point Real


Input Value
Provides value
fetched from the
TypeConvert
function blocks
source.

NaN

No

View Only

CEE

Yes. The
EXECSTS
connection is
to IN.SRC

IN.INT8

TypeConvert

Signed 8-Bit Input


Value

8-Bit Integer

-32768 to
32767

No

View Only

CEE

Yes. The
EXECSTS
connection is
to IN.SRC

IN.INT16

TypeConvert

Signed 16-Bit Input


Value

16-Bit Integer -32768 to


32767

No

View Only

CEE

Yes. The
EXECSTS
connection is
to IN.SRC

IN.INT32

TypeConvert

Signed 32-Bit Input


Value

32-Bit Integer -2147483648


to
2147483647

No

View Only

CEE

Yes. The
EXECSTS
connection is
to IN.SRC

IN.SDENUM

TypeConvert

Self Defining
Enumeration Input.

Integer

No

View Only

CEE

Yes. The
EXECSTS
connection is
to IN.SRC

IN.UINT16

TypeConvert

Unsigned 16-Bit
Input Value
Provides the value
fetched from the
TypeConvert
function blocks
source.

Unsigned
0 to 65535
16-Bit Integer

No

Other
Function
Block

CEE

Yes. The
EXECSTS
connection is
to IN.SRC

IN.UINT32

TypeConvert

Unsigned 32-Bit
Input Value

Unsigned
0 to
32-Bit Integer 4294967295

No

Other
Function
Block

CEE

Yes. The
EXECSTS
connection is
to IN.SRC

Enumeration

Positive
Integers

Related
Parameters

Notes

77

Specific to
Block(s)

Description

Data Type

INALM

All alarming basic


blocks and all
independent blocks
(RegCtl, CEE, CM,
CPM, DataAcq,
DevCtl, IOM, Flag,
SCM, Flag)

Function Block In
Boolean
Alarm Flag
Indicates if an alarm
condition has been
detected with this
function block.

INBADOPT

DIC

INBETFL

INITCONNECTD
[1..3]

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

Off (0):
Off (0)
Function block
is not in alarm
On (1):
Function block
is in alarm

No

View Only

CEE

No

ALMENBSTATE
DevCtl only:
CMDDISALM.FL,
CMDFALALM.FL,
SIALM.FL,
UNCMDALM.FL

Flag block only:


When INALM is On (1),
HIALM.TYPE will always
be OFFNRMLALM.
When INALM is Off (0),
HIALM.TYPE will always
be NONE.
CEE, CPM blocks: Indicates if
one or more diagnostic
alarms are presently active
within the block.

Input Bad Option - Enumeration


Configurable Value INBADOPT
from the following
range is substituted
when input is
determined to be
bad.

Off (0)
On (1)
Hold (2)
NaN (3)
Value (4)

Off (0)

Yes

Engineer

CEE

No

DevCtl

Process Variable (PV) Boolean


In Between State
Flag

Off (0)
On (1)

Off (0)

No

View Only

CEE

No

DIPVMAP [0..15],
GPV, PV,
NUMDINPTS

Illegal if DIPVMAP is not


selected for InBet.
Illegal if NUMDINPTS = 0.

DevCtl

Initialization
Connection Flag

Off (0)
On (1)

Off (0)

No

View Only

CEE

No

BACKCALCIN [1..3]

INITCONNECTD [i] is
automatically set to On (1) by
the function block (on the
Control Modules EXECSTATE
transition to Active) if the
BACKCALCIN [i] is connected
to a BACKCALCOUT
structure.

Boolean

Range

Default

78

Parameter

Parameter

Specific to
Block(s)

INITMAN

Description

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

DevCtl, Pulse Count Initialization Manual Boolean


Control, Pulse
Flag
Length Control

Off (0)
On (1)

Off (0)

No

View Only

CEE

No

Pulse Length Control:


BACKCALCOUT
DevCtl: GOP, GPV,
INITOPOPT,
NUMDOUTS, OP, PV,
SI

Illegal if NUMDOUTS = 0.
Pulse Length only: When the
Pulse Length function block
goes into initialization mode,
either because its Secondary
(DOC) requested it or
because the LOCALMAN is
On, INITMAN goes On. It is
reset to Off only when its
Primary (usually PosProp)
receives the initialization
request and its Secondary is
out of initialization.

All RegCtl Blocks:


AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Initialization Manual Boolean


Flag When On, it
indicates that the
function block is in
Initialization
Manual. INITMAN
goes On when either
a cascade is broken ,
or initialization is
requested by a
secondary.

Off (0)
On (1)

Off (0)

No

View Only

CEE

No

BACKCALCIN,
BACKCALCIN [1..3],
BACKCALCIN [1.8]

INITOPOPT

DevCtl

Output (OP)
Enumeration
Initialization Option ENABLE

Disable (0)
Enable (1)

Disable
(0)

Yes

Engineer

CEE

No

GOP, INITMAN,
NUMDOUTS, OP

Illegal if NUMDOUTS = 0.

INITREQ

Pulse Length
Control, Pulse
Count Control

Initialization request Boolean


for Primary.

Off (0)
(1)

On Off (0)

No

View Only

CEE

No

BACKCALCOUT

When the Pulse Length


Control function block goes
into an Initialization mode,
either because its Secondary
(DOC) requested it or
because the LOCALMAN is
on, INITREQ goes ON. It is
reset to OFF only when its
Primary (usually POSPROP)
receives the initialization
request and its Secondary is
out of initialization.

Off (0)
Off (0)
Initialization is
not requested.
On (1)
Initialization is
requested.

No

Other
Function
Block

CEE

No

If the flag is set, those


function blocks will reset
their calculated and/or
accumulated values. The
function block sets INITREQ
to On whenever it becomes
active. INITREQ may also be
set by other function blocks.

79

Deadtime, Leadlag Initialization


Boolean
Request Flag
Indicates if the
function block has
been requested to
initialize. If the flag
is On, those function
blocks will reset
their calculated
and/or accumulated
values.

Specific to
Block(s)

Description

INITREQ (cont.)

SIFLAGARRCH,
SINUMARRCH,
SITEXTARRCH

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

Initialization
Boolean
Request Flag
Indicates the validity
of the array data.

Off (0)
On (1)

Off (0)

No

View Only

CEE

No

BADPVFL, ERRFL,

INITREQ is always equal to


ERRFL; this parameter is
provided to be consistent
with other function blocks
that provide an INITREQ that
indicates whether the block
can be stored to at the
current time.

AOC, DOC, PWM


Channel

Initialization
Boolean
Request Flags - Used
by a function block;
it requests a primary
to initialize. There is
one flag for each
primary.

Off (0)
(1)

On Off (0)

No

View Only

CEE

No

INITVAL

INITREQ [0..2]

DevCtl

Initialization
Request Flag

Boolean

Off (0)
(1)

On Off (0)

No

View Only

CEE

No

GOP, OP

INITREQ [1..8]

All RegCtl Blocks:


AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Initialization
Boolean
Request Flags
Used by a function
block to request a
primary to initialize.
There is one flag for
each primary.

Off (0)
On (1)

Off (0)

No

View Only

CEE

No

INITVAL [1..8]

INITREQSRC

RegCalc

INITREQ
Enumeration X1 TOC8STS
(Initialization
REGCALCSELE
Request Flag) source CTOR
selector

No

Engineer

CEE

No

INITVAL

AOC, DOC, PWM


Channel

Initialization Value - 64-Bit Real


The value to which a Number
primary should
initialize. There is
one value for each
primary.

NaN

No

View Only

CEE

No

NaN

INITREQ

On indicates that the block


will be able to act on a
command to that state (index
0 corresponds to state 0,
index 1 to state 1, and index
2 to state 2.

80

Parameter

Parameter

Specific to
Block(s)

Description

INITVAL [1..8]

All RegCtl Blocks:


AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Initialization Value - 64-Bit Real


The value to which a Number
primary should
initialize. There is
one value for each
primary.

INITVALSRC

RegCalc

Initialization Value
(INITVAL) source
selector.

Enumeration X1 to C8STS
REGCALCSELE (0 - 27)
CTOR

Input Inversion
Status

Boolean

INPTINVSTS [1..8] And, Nand, Nor, Or, Input Inversion


Qor, Xor, Mux
Status
INPUTRANGE
[0..numChans-1]

AIM

Input Range

INSERTINDEX

CM, SCM

The number of
Integer
blocks ever inserted.

INPTINVSTS [1..2] Sel

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

No

View Only

CEE

No

X1 (0)

Yes

Engineer

CEE

No

Off (0)
On (1)

Off (0)

Yes

Engineer

CEE

No

Boolean

Off (0)
On (1)

Off (0)

Yes

Engineer

CEE

No

Enumeration
of
INPUTRANGE
Enumeration
of
INPUTRANGE
_TC for
Thermocouple
modules
Enumeration
of
INPUTRANGE
_RTD for RTD
modules

INPUTRANGE
-10V_to_10V
(0)
0V_to_5V (1)
0V_to_10V (2)
4mA_to_20m
A (3)
INPUTRANGE
_TC
12_to_78mV
(4)
12_to_30mV
(5)
INPUTRANGE
_RTD
1-487_ohms
(6)
2-1000_ohms
(7)
4-2000_ohms
(8)
8-4020_ohms
(9)

INPUTRA Yes
NGE:
4mA_to_
20mA (3)
INPUTRA
NGE_TC:
-12_to_7
8mV (4)
INPUTRA
NGE_RTD
:
1-487_oh
ms (6)

Application
Developer

CEE

No

View Only

Related
Parameters

Notes

NUMOFINPUTS

81

Specific to
Block(s)

Description

INSTSELECT

SCM

Alias instance
16-Bit Integer 1
1
selection.
NUMINSTAN
Represents selected
CES
instance column.

Alias Table
parameter

Currently selected
instance.

INTISWCMD

RM

Initiate Switch-over Boolean


Command

INVCOND [1..8]

SCM

Invoke Condition
Number

Invoked From
Handler Name

INVFRMHNDLER SCM
[1..8]

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

Yes

Engineer

CEE

No

NUMINSTANCES

Can be configured at
configuration time, and
modified at run-time.

Engineer

CEE

Integer
True (0)
False (1)

True (0)

No

Operator
Not Loaded
Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform.

32-Bit Integer 0 to 10

No

View Only

CEE

No

TYPE

INVCOND [i] contains the


number of the last condition
to change when TYPE i
handler was invoked through
the invoke transition. If
handler i invokes through
command or step condition,
INVCOND [i] = 0.

BlockId

Null
String

No

View Only

CEE

No

TYPE,
INVFRMHNDLERN
[1..8]

INVFRMHNDLER [i] contains


the name (eg.
SCMName.HandlerName) of
the handler from which the
TYPE i handler was last
invoked.
INVFRMHNDLER [1..8] is a
BlockId parameter and not
supported in expressions. Its
Integer-32 Partner Parameter
INVFRMHNDLERN [1..8] can
be used in Transition
Condition expressions and
Step Output expressions.

82

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

INVFRMHNDLER SCM
N [1..8]

Invoked From
Handler Name

INVFRMHNDTYP SCM
[1..8]

INVFROMSTEP
[1..8] [1..10]

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

32-Bit Integer

No

View Only

CEE

No

TYPE,
NVFRMHNDLER
[1..8]

INVFRMHNDLER [i] contains


the name (eg.
SCMName.HandlerName) of
the handler from which the
TYPE i handler was last
invoked.
INVFRMHNDLERN [1..8] may
be used in Transition
Condition expressions and
Step Output expressions,
whereas INVFRMHNDLER
[1..8] (a BlockId parameter) is
not supported in
expressions.

Invoked From
Handler Type

32-Bit Integer 0 to 8

No

View Only

CEE

No

TYPE

INVFRMHNDTYP [i] contains


the TYPE of handler from
which the TYPE i handler
was last invoked.

SCM

Invoked From Step


Name

BlockId

Null
String

No

View Only

CEE

No

TYPE,
INVFROMSTEP [i] [j] contains
NVFROMSTEPN [1..8] the name (eg.
[1..10]
SCMName.StepName) of
the step in thread j that was
active at the time of the
TYPE i handlers last
invocation.
INVFROMSTEP [1..8] is a
BlockId parameter and not
supported in expressions. Its
Integer-32 Partner Parameter
INVFROMSTEPN [1..8] can
be used in Transition
Condition expressions and
Step Output expressions.

INVFROMSTEPN SCM
[1..8] [1..10]

Invoked From Step


Name

32-Bit Integer

No

View Only

CEE

No

TYPE, NVFROMSTEP INVFROMSTEP [i] [j] contains


[1..8] [1..10]
the name (eg.
SCMName.StepName) of
the step in thread j that was
active at the time of the
TYPE i handlers last
invocation.
INVFRMHNDLERN [1..8] may
be used in Transition
Condition expressions and
Step Output expressions,
whereas INVFRMHNDLER
[1..8] (a BlockId parameter) is
not supported in
expressions.
83

Specific to
Block(s)

Description

INVOKE [1..8]

SCM

Internal parameter
for system use only.

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

32-Bit Integer 0 to 1023

No

View Only

CEE

No

NUM

Contains the number (NUM)


of the handlers invoke
transition.

2V

Yes

Application
Developer

CEE

No

INVOKT.HANDLE Handler

Invoke Transition
Handle

INVOKT.NEXTCO Handler
MP

Internal parameter
for system use only.

INVOLTTHRESH

Input Voltage
Threshold
Specifies level of
input.

Enumeration

INVREASON [1..8] SCM

Handler Invoke
Reason

Enumeration Unknown (0) Unknown No


CSCOEVENTR Command (1) (0)
EASON
LocalCond (2):
Steps
Interrupt or
Stop
Condition
GlobalCond
(3): Handlers
Invoke
Transition

View Only

CEE

No

TYPE

INVREASON [i] contains the


reason that the TYPE [i]
handler was last invoked.

INVTHREAD [1..8] SCM

Invoke Thread
Number

32-Bit Integer 0 to 10

No

View Only

CEE

No

TYPE, INVREASON
[1..8]

INVTHREAD [i] contains the


thread number of the step
whose local condition
caused the TYPE i handler to
be invoked. INVTHREAD [i] =
0 if INVREASON [i] is not
equal to LocalCond.

INVTIME [1..8]

SCM

Invoke Time of
Handler

32-Bit Integer 0 to
2147483647

No

View Only

CEE

No

IOCNUMBER

All IO Channels,
SIFLAGARRCH,
SINUMARRCH,
SITEXTARRCH

Internal parameter
for system use only.

Pulse Input IOM

2V
8V

Range is zero
based. This
parameters
range was 1
based in
previous
releases.

This value determines


whether the actual
screw-terminal-input is high
voltage or low voltage.

Provides the time that the


handler of type i was last
invoked. the time value is an
integer that can be compared
to other handler invoke
times; it has no correlation to
the time of day.

84

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

Range

Default

Config
Load

Access
Lock

IOCSTATE

All IO Channels,
SIFLAGARRCH,
SINUMARRCH,
SITEXTARRCH

IOC State

Integer

View Only

IOCTYPE

All IO Channels
except Pulse Input
IOM,
SIFLAGARRCH,
SINUMARRCH,
SITEXTARRCH.

Channel Type

Integer

Varies

View Only

IOMCONN

All IO Channels,
SIFLAGARRCH,
SINUMARRCH,
SITEXTARRCH

IO Module
Connector

IOMSLOT

All IOM function


blocks

IO Module Slot
Number in Chassis

32-Bit Integer 0 to (chassis


size 1)

Yes

IOMTYPE

All IOM function


blocks

This
non-configurable
parameter is a
description of the
respective IO
module type.

String

Length: 64
characters

Defined
appropria
tely on
each I/O
module
type. See
Note
below.

IOSCHEDOPT

CM, IOM

Internal parameter
for system use only.

IPADDRESS

CPM, RM

Ethernet IP Address String

Length: 15
characters

Null
String

Residence

Active
Connector

Related
Parameters

Notes

SR

No

DLCNBSLOT,
ULCNBMAC

IOMSLOT refers to the


physical chassis slot number
of the IOM under
configuration. Note that the
slot numbers start at zero,
which is on the left side of
the rack.
If configuring an IOM
co-located in the same
chassis as the controller, 0 is
not a valid slot for an IOM.
This location is reserved for
the CNB to the supervisory
network.

Not
View Only
configura
ble, but
loaded to
SR

SR

No

No

SR

No

SR

Application
Developer

Application
Developer

Engineer

Note that there is a standard


format for IOMTYPE
descriptor strings:
Module type, number of
channels, electrical
characteristics, auxiliary
descriptor.
For example: Analog Output,
6 ch, 4-20 mA, Isolated

ABORTALM.PR

85

Specific to
Block(s)

Description

Data Type

Mux, Muxreal

K Selector - Number Unsigned


of the input to be
Integer
outputted

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

0 to 7

Yes

Engineer

CEE

No

Related
Parameters

Automan, Fanout, Total Gain for


64-Bit Real
RegCalc, PID, PIDFF Calculated Variable Number
(CV).
The PID gain. Used
if GAINOPT = Lin
(configured).

GAINLOLM to 1.0
GAINHILM

Yes

Automan,
Fanot,
RegCalc,
QOR:
Engineer
PID, PIDFF:
Supervisor

CEE

No

Qor

K Selector

Integer

1 to 8

Yes

Engineer

CEE

No

K [1..4]

OvrdSel

Individual Gain for


Inputs X(1) through
X(4).

Real

GAINLOLM to 1.0
GAINHILM

Yes

Operator

CEE

No

GAINLOLM,
GAINHILM

K [1..8]

Fanout

Total Gain for each


output

64-Bit Real
Number

GAINLOLM to 1.0
GAINHILM

Yes

Engineer

CEE

No

GAINLOLM and
GAINHILM

K1

Fanout, RatioBias,
GenCas,
PidExtReset

Individual Gain for


the X1 Input.

Real

GAINLOLM to 1.0
GAINHILM

Yes

Operator

CEE

No

GAINLOLM and
GAINHILM

K2

Fanout, RatioBias,
GenCas,
PidExtReset

Individual Gain for


the X2 Input.

Real

GAINLOLM to 1.0
GAINHILM

Yes

Operator

CEE

No

GAINLOLM and
GAINHILM

KEYWORD

SCM, CM, IOM, RM Used to provide


String
summary description
of the block.

Length: 16
characters

Yes

Application SR
Developer
RM only:
Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform .

No

DESC, EUDESC

KFF

PIDFF

Gain for the


feedforward input.

Real

KL

PosProp,
PidPosProp

Overall gain for


Lower Pulse
Generation.

Real

KLIN

PID, PIDFF

Linear Gain factor. 64-Bit Real


Used if GAINOPT = Number
Gap, Nonlin, or Ext
(configured).

Null
String

1
0.0 to 10.0

Operator

CEE

GAINLOLM and
GAINHILM

SIFL, PV, FF, SP

1.0

Yes

Supervisor

CEE

No

GAINLOLM to 1.0
GAINHILM

Yes

Engineer

CEE

No

Notes

GAINLOLM and
GAINHILM

The block applies individual


user-specified gains (K [1..8])
to its outputs.

KEYWORD can be used to


provide a brief block
description on schematic
displays where DESC is too
long.

86

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

Range

KMODIFEXT

PID, PIDFF

External Gain
Modifier. Used if
GAINOPT = Ext
(configured).

64-Bit Real
Number

KMODIFGAP

PID, PIDFF

Gap Gain factor.


Used if GAINOPT =
Gap (configured)

64-Bit Real
Number

KMODIFNL

PID, PIDFF

Nonlinear Gain
64-Bit Real
Modifier (calculated) Number

KR

PosProp,
PidPosProp

Overall gain for


Raise Pulse
Generation.

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

GAINLOLM to 1.0
GAINHILM

Yes

Program

CEE

Default
Connector:
Input

GAINLOLM and
GAINHILM

0.0 to 1.0

Yes

Engineer

CEE

No

1.#QNAN No
0

ViewOnly

CEE

No

0.0 to 10.0

1.0

Yes

Supervisor

CEE

No

LAG1TIME

LeadLag

First Order Lag Time Real Number


(in Minutes) A
time constant used
as a first-order lag
compensation factor
by the LeadLag
function block.

0.0 to 1440.0
minutes

0.0

Yes

Engineer

CEE

No

LAG2TIME

If LAG2TIME = 0.0, there is


no second-order lag
compensation.

LAG2TIME

LeadLag

Second Order Lag


Real Number
Time (in Minutes)
A time constant
used as a first-order
lag compensation
factor by the
LeadLag function
block.

0.0 to 1440.0
minutes

0.0

Yes

Engineer

CEE

No

LAG1TIME

If LAG2TIME = 0.0, there is


no second-order lag
compensation.

LASTGOOD

Totalizer, Pulse
Input Totalizer

Last Good Value 64-Bit Real


This is the last good Number
accumulated value,
before the input
went bad.

NaN

No

View Only

CEE

No

PV

LASTGOODPV

DataAcq, PID,PIDFF, Last good Process


PosProp.
Variable (PV) value

NaN

No

View Only

CEE

No

PV, PVSTS

LASTGOPREQ

DevCtl

Null (0)

No

Other
Function
Block

CEE

No

GOPREQ,
LASTOPREQ,
LASTREQFL,
NUMSTATES,
OPREQ,
RESTARTOPT,
SCMOPT, STATETEXT
[0..6], SCMSTATE

Real

64-Bit Real
Number

Last Generic
Enumeration
Requested Output GENSTATE
Value (GOPREQ)
while
ControlModule.SMC
STATE is Running

Null (0)
S0 (1)
S1 (2)
S2 (3)

Default

1.0

Notes

NLFORM, NLGAIN

S2 is illegal if NUMSTATES =
2.
Illegal if
ControlModule.SCMOPT =
None.

87

Specific to
Block(s)

Description

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

LASTMODEREQ

All RegCtl Blocks:


AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Last value of
MODEREQ (Mode
Request), when
SCMMODE is
Running.

Enumeration
REGMODE

Man (0)
Auto (1)
Cas (2)
None (3)

None (3)

No

View Only

CEE

No

RESTARTOPT,
SCMSTATE, SCMOPT

LASTOPREQ

All RegCtl Blocks:


AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Last value of OPREQ 64-Bit Real


(Output Request),
Number
when SCMMODE is
Running.

OPEXLOLM to 0
OPEXHILM

No

View Only

CEE

No

RESTARTOPT,
SCMSTATE, SCMOPT

DevCtl

Last OPREQ (Output String


Request) while SCM
was running.

Length: 12
characters

STATETEX No
T [0]

View Only

CEE

No

GOPREQ,
LASTGOPREQ,
LASTREQFL,
NUMSTATES,
OPREQ,
RESTARTOPT,
SCMOPT</HH >,
SCMSTATE,
STATETEXT [0..6]

Notes

LASTOPREQ is a String set


equal to STATETEXT
(GOPREQ value while
Running).
STATETEXT [6] [State2] is
illegal if NUMSTATES = 2.
Illegal if
ControlModule.SCMOPT =
None.

LASTOPTYPE

DevCtl,
Last OPTYPE (Output Enumeration
All RegCtl Blocks: Type) stored when OPTYPE
AutoMan, Fanout, SCM was Running.
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Null (0)
Null (0)
Set (1)
NotStored (2)
Default (3)

No

View Only

CEE

No

LASTGOPREQ,
Illegal if
LASTOPREQ,
ControlModule.SCMOPT =
LASTREQFL, OPTYPE, None.
RESTARTOPT,
SCMOPT, SCMSTATE

LASTRATEREQ

PID, PIDFF, PosProp Last value of


64-Bit Real
SPRATEREQ (Set
Number
Point Rate Request),
when SCMMODE is
Running.

NaN, 0.0, Real 0.0


numbers.

No

View Only

CEE

No

RESTARTOPT,
SCMSTATE, SCMOPT

88

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

Range

LASTREQFL

DevCtl
Last Requested
All RegCtl Blocks: Parameters Flag
AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Boolean

Off (0): Dont Off (0)


show Last
Requested
Variables.
On (1): Display
Last
Requested
Variables.

LASTRESPTM

REQFLAGARRAY,
REQNUMARRAY,
REQTEXTARRAY

The number of
32-Bit Integer
execution cycles of
the container block
(Control Module)
between sending
the last request and
receipt of the
corresponding
response. If the
request is sent
during one execution
cycle and the
response received
before the next
execution cycle, this
parameter has a
value of 1.

LASTSERIAL

DOC

Last Serial Number

LASTSPREQ

PID, PIDFF, PosProp Last value of SPREQ 64-Bit Real


(Set Point Request), Number
when SCMMODE is
Running.

SPLOLM to
SPHILM

No

LASTSPTVREQ

PID, PIDFF, PosProp Last Requested Set 64-Bit Real


Point Target Value Number
(SPTVREQ) when
ControlModule.SCM
STATE = Running.

SPLOLM to
SPHILM

No

Integer

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

No

View Only

CEE

No

LASTOPREQ,
LASTOPTYPE,
RESTARTOPT,
SCMMODE,
SCMOPT,
SCMSTATE,
SCMASTEP [1..10]

Illegal if
ControlModule.SCMOPT =
None.

No

View Only

CEE

No

View Only

CEE

No

RESTARTOPT,
SCMSTATE, SCMOPT

View Only

CEE

No

RESTARTOPT,
SCMSTATE, SCMOPT

View Only

89

Specific to
Block(s)

Description

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

LASTSTEP

DevCtl

Last ASTEPID while Integer


SCM was Running
the Last Active Step
when themonitored
SCM was in Running
State.

All RegCtl Blocks:


AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Last value of
String
SCMASTEP [1..10]
(SCM Active STEP),
when SCMMODE is
Running.

Length: 8
characters

LASTSYNCABRT RM

Last Synchronization Enumeration


Abort Cause
[4]

NoAbort (0)
NoAbort
ModInsert (1) (0)
ModRemoval
(2)
ModMismatch
(3)
Editing (4)
StalledSync
(5)
SecFault (6)

LASTSYNCARES RM

LATCHENB

No

View Only

CEE

No

LASTOPREQ,
Illegal if
LASTOPTYPE, NUM, ControlModule.SCMOPT =
RESTARTOPT,
None.
SCMASTEP [1..10],
SCMMODE,
SCMOPT, SCMSTATE

Null
String

No

View Only

CEE

No

No

View Only
Not Loaded
Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform.

Last Synchronization Enumeration


Attempt Result
[4]

NoAttempt (0) NoAttem No


Abort (1)
pt (0)
Success (2)

View Only
Not Loaded
Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform.

1797-OB4D

Latch Mode Enable

Boolean

Off(0)
On(1)

Off(0)

Yes

Application
Developer

CEE

No

LEADTIME

LeadLag

Lead Time (in


Minutes) A time
constant used as a
lead compensation
factor by the
LeadLag function
block.

Real Number

-1440.0 to
1440.0
minutes

0.0

Yes

Engineer

CEE

No

FAULTENB [ ],
FAULTRESET

Notes

Enables latching of detected


faults. Only applicable if
fault detection is enabled.
Applies globally to all
channels on the device.
If LEADTIME = 0.0, there is
no lead compensation.

90

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

LOADSTATE

CM, SCM

Container block load Enumeration


state.
LOADSTATE

LOCALMAN

DevCtl, Pulse Count Local Manual Input. Boolean


Control, Pulse
Length Control

Off (0)
On (1)

LOCUTOFF

DataAcq

Low Signal Cutoff 64-Bit Real


Evaluates PVAUTO. Number

LOWENG
[0..numChans-1]

AIM, AOM
LOWENG is
configurable only
on the AIM.

Low Engineering (f)

64-Bit Real
Number

LOWERDEADTM PosProp,
PidPosProp

Lower Dead Time (in Real


seconds).

LOWERDESC

Lower Output
Descriptor.

PosProp,
PidPosProp

String

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

No

View Only

CEE

No

PREVLOADSTAT

This parameter is used by


container blocks to track the
state of load. During normal
operation it progresses to
READY by the time of load
completion. If an error is
detected during load it stops
at LOADFAILED. The only
way to get an SCM FB or CM
FB out of the LOADFAILED
state is to reload.
EXECSTATE cannot be set to
Active until LOADSTATE
reaches READY.

No

DevCtl:
CEE
Other
Function
Block
Pulse Count,
Pulse
Length:
Program

No

GOP, GPV,
Illegal if NUMDOUTS = 0 or
NUMDINPTS,
NUMDINPTS = 0.
NUMDOUTS, OP, PV LOCALMAN can be used to
indicate to the Pulse Length
Control function block that
the connected device is
being controlled locally and
not by the CEE.

PVEULO to
NaN
PVEUHI, NaN,
Greater-than
or equal-to 0.
See Notes

Yes

Engineer,
CEE
Applications
Developer

No

PVEULO, PVEUHI,
PVCHAR

NaN,
less-than
HIGHENG

AIM: Yes AIM:


AOM: No Application
Developer
AOM: View
Only

CEE

No

HIGHENG
[0..numChans-1]

No

View Only

CEE

No

Yes

Engineer

SR

No

LOADFAILED
(0)
UNLOADED
(1)
LOADINGPRO
G (2)
LDNGCMPTYP
ES (3)
CMLOADINGT
BR (4)
LOADINGCON
FIG (5)
LOADINGCON
N (6)
READY (7)
Off (0)

0.0

Lower

When LOCUTOFF is:


NaN: no action
Non-Nan: when PVAUTO
< LOCUTOFF, PVAUTO is
set to PVEULO.
Store to this parameter
requires CM to be inactive or
CEE in Idle.
LOCUTOFF is not applicable
if PVCHAR is None.

91

Specific to
Block(s)

Description

Data Type

LOWERLMFL

PosProp,
PidPosProp

Lower Pulse Limit


Boolean
Flag Used to
inhibit lower pulses
by the PosProp
function block and is
pulled from another
function block.

LOWERRATE

PosProp,
PidPosProp

LOWERTIME

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Off (0) Allow Off (0)


lower pulse
output.
On (1) Inhibit
lower pulse
output.

No

Other
Function
Block

CEE

No

Lower Output Stroke Real


Rate (in percent per
second).

0.0 to 100.0

Yes

Supervisor

CEE

No

PosProp,
PidPosProp

Lower Output Pulse Real


Time (in seconds).

MINPULSEL,
lesser of
MAXPULSEL,
and
CYCLETIME.

Yes

View Only

CEE

No

LOWSIGNAL
[0..numChans-1]

AIM, AOM

Low Signal

64-Bit Real
Number

See
Notes.

No

View Only

CEE

No

SIPTYPE
[0..numChans-1],
INPUTRANGE
[0..numChans-1],
HIGHSIGNAL
[0..numChans-1]

For AIMs, this parameter is


set within the controller
based on the store of
INPUTRANGE.
For AOMs, this parameter is
set within the controller
based on the store of
SIPTYPE.

LSCYCLEOVRN
[0..40]

CEE

Count of Cycle
Overruns in Last
Hour

16-Bit Integer 0 to 32,767

No

View Only

CEE

No

CRCYCLEOVRN
[0..40]

Each element gives a count


of cycle overruns that have
occurred during the previous
hour. Elements 0..39 give
the count for the
corresponding cycle.
Element 40 gives the total
count over all cycles. Ass
elements are copied from
CRCYCLEOVRN [0..40] once
an hour. Copy occurs at the
same time that
CRCYCLEOVRN [0..40] is
reset. It is not synchronized
with wall clock time.

MAINTOPT

DevCtl

Maintenance
Statistics Option

Boolean

Yes

Application
Developer

CEE

No

MAXTIME [0..2],
MAXTRANS [0..2],
NUMSIOVRD,
NUMTRANS [0..2],
RESETFL, STATETIME
[0..2]

100.0%
per
second

Off (0):
Off (0)
Maintenance
Statistics not
enabled.
On (1) :
Maintenance
Statistics
enabled.

Related
Parameters

Notes

If LOWERTIME <
MINPULSEL, no pulse is
issued.

92

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

MAJ

2oo3, MVote

Majority output
value

Boolean

Off (0)
On (1)

Off (0)

No

View Only

CEE

No

MAJORREV

All IOM Function


Blocks

Major revision code 32-Bit Integer


Intended to
contain a matching
or compatible
firmware major
version indicator.
Currently, this
functionality is
unused, thus all
values are defaulted
to zero.

Yes

Application
Developer

CEE

No

MAJRECFAULT

RM

Indication of a major Enumeration


recoverable fault in
the Redundancy
Module.

Ok (0)
Fault (1)

Ok (0)

No

View Only
Not Loaded
Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform
(through
Control
Builder or
Server).

No

MAJURECFAULT RM

Indication of a major Enumeration


unrecoverable fault
in the Redundancy
Module.

Ok (0)
Fault (1)

Ok (0)

No

View Only
Not Loaded
Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform
(through
Control
Builder or
Server).

No

Related
Parameters

Notes

MINORREV

Although loaded, this


parameter is not exposed on
any configuration form.

93

Specific to
Block(s)

MANPULSECMD PosProp,
PidPosProp

Description

Data Type

Range

Manual Pulse
Enumeration See below
Command Defines
the type of pulse
command the
Range
operator wants
None (0):
No change.
to issue.

Default

Config
Load

Access
Lock

Residence

Active
Connector

None (0)

Yes

Operator

CEE

No

Raise1 (1):

Raise output by MANPULSETIME each


keystroke.

Lower1 (2):

Lower output by MANPULSETIME each


keystroke.

Raise10 (3):

Raise output by
10 * MANPULSETIME each keystroke.

Lower10 (4):

Lower output by
10 * MANPULSETIME each keystroke.

MANPULSETIME PosProp,
PidPosProp

Manual Pulse Time Real


(in seconds)
Defines the duration
of a raise/lower
pulse that is issued
by operator
command.

0.0 to 60.0
seconds

1.0
seconds

Yes

Engineer

CEE

No

MAX

Maximum Limit.

Any real
number, not
NaN.

0.0

Yes

Engineer

CEE

No

No

View Only

CEE

No

Limit

MAXFREEBLKSZ CPM

64-Bit Real
Number

Size of largest
32-Bit Integer 0 to 4194304
contiguous memory
Bytes
block in CEE user
memory pool.

Related
Parameters

Notes

TOTALMEM,
FREEMEM,
USEDMEM

Block configurations such as


Sequential Control Module
(SCM) function blocks can
require large blocks of
contiguous memory.
MAXFREEBLKSZ gives the
largest amount of memory
currently available to a
contiguous block
configuration.
MAXFREEBLKSZ is always
less than or equal to
FREEMEM.

94

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

Range

MAXFREEINK

CPM

Size of largest
32-Bit Integer 0 to 4194304
contiguous memory
Kbytes
block in CEE user
memory pool.

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

No

View Only

CEE

No

TOTALMEMINK,
FREEMEMINK,
USEDMEMINK

Block configurations such as


Sequential Control Module
(SCM) function blocks can
require large blocks of
contiguous memory.
MAXFREEBLKSZ gives the
largest amount of memory
currently available to a
contiguous block
configuration.
MAXFREEBLKSZ is always
less than or equal to
FREEMEM.

MAXHISOAKDEV RampSoak
[1..NUMPROFILES
]

Maximum High Soak Real


Deviation - i.e.,
maximum deviation
between PV and
SOAKVAL(I)(j) during
soak segments
when PV >
SOAKVAL(I)(j).
Applies to all ramp
segments in a
profile.

NaN, or
NaN
greater-than
or equal-to 0.0

Yes

Engineer

CEE

No

MAXLOSOAKDEV
[1..NUMPROFILES]

MAXLOSOAKDEV RampSoak
[1..NUMPROFILES
]

Maximum Low Soak Real


Deviation - i.e.,
maximum deviation
between PV and
SOAKVAL(I)(j) during
soak segments
when PV <
SOAKVAL(I)(j).
Applies to all ramp
segments in a
profile.

NaN, or
NaN
greater-than
or equal-to 0.0

Yes

Engineer

CEE

No

MAXHISOAKDEV
[1..NUMPROFILES]

MAXPULSEL

PosProp,
PidPosProp

Maximum Output
Real
Pulse Time for Lower
Pulses (in seconds).

NaN,
60.0
MINPULSEL to seconds
60.0 seconds.

Yes

Supervisor

CEE

No

MAXPULSER

PosProp,
PidPosProp

Maximum Output
Real
Pulse Time for Raise
Pulses (in seconds).

NaN,
MINPULSER
to 60.0
seconds.

Yes

Supervisor

CEE

No

60.0
seconds

95

Specific to
Block(s)

Description

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

NaN, or
NaN
greater-than
or equal-to 0.0

Yes

Engineer

CEE

No

Related
Parameters

Notes

MAXRAMPDEV RampSoak
[1..NUMPROFILES
]

Maximum Ramp
Real
Deviation - i.e.,
maximum deviation
between PV and CV
during ramp
segments. Applies
to all ramp segments
in a profile.

MAXSOAKVAL
RampSoak
[1..NUMPROFILES
]

Maximum Soak
Target Value in a
profile.

Real

NaN

Yes

View Only

CEE

No

MAXTIME

Step

Maximum Active
Time

32-Bit Integer 0 or
greater-than
MINTIME

Yes

Operator

CEE

No

MINTIME, TIME

MAXTIME is the maximum


number of execution cycles
that the step can be active
before an SCM STEPALM is
generated. Setting
MAXTIME = 0 disables
STEPALM.

MAXTIME [0..2]

DevCtl

Maximum Duration
per State

64-Bit Real
Number

0.0 to 96000.0 0.0


hours (4000.0
days)

Yes

Engineer

CEE

No

MAINTOPT,
NUMSTATES

MAXTIME [2] is illegal if


NUMSTATES = 2.

MAXTIMEFL

Step

Maximum Step
Expired Flag.

Boolean

Off (0)
On (1)

Off (0)

No

View Only

CEE

No

TIME, MAXTIME

MAXTIMEFL is On when
Step TIME is greater-than
MAXTIME.

MAXTRANS [0..2] DevCtl

Maximum
Transitions per
State.

64-Bit Real
Number

0.0 to
Maximum
Real Number

0.0

Yes

Engineer

CEE

No

MAINTOPT,
NUMSTATES

MAXTRANS [2] is illegal if


NUMSTATES = 2.

MESSAGE [0..15] Message

Message Text

String

Maximum of Null
60 characters String

Yes

Operator

SR

MIN

Limit

Minimum input
value

64-Bit Real
Number

Any real
number, not
NaN.

0.0

Yes

Engineer

CEE

No

MINORREV

All IOM Function


Blocks

Minor revision code 32-Bit Integer


Intended to
contain a matching
or compatible
firmware minor
version indicator.
Currently, this
functionality is
unused, thus all
values are defaulted
to zero.

Yes

Application
Developer

CEE

No

MAJORREV

Although loaded, this


parameter is not exposed on
any configuration form.

96

Parameter

Parameter

Specific to
Block(s)

Description

MINPULSEL

PosProp,
PidPosProp

MINPULSER

MINRECFAULT

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Minimum Output
Real
Pulse Time for Lower
Pulses (in seconds).

NaN, 0.0 to
MAXPULSEL

0.0
seconds

Yes

Supervisor

CEE

No

MINPULSEL reflects the


physical properties of a
device, for example a valve.
It is the pulse duration
required to move that device.

PosProp,
PidPosProp

Minimum Output
Real
Pulse Time for Raise
Pulses (in seconds).

NaN, 0.0 to
MAXPULSER

0.0
seconds

Yes

Supervisor

CEE

No

MINPULSER reflects the


physical properties of a
device, for example a valve.
It is the pulse duration
required to move that device.

RM

Indication of a minor Enumeration


recoverable fault in
the Redundancy
Module.

Ok (0)
Fault (1)

Ok (0)

No

View Only
Not Loaded
Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform.

MINSOAKVAL
RampSoak
[1..NUMPROFILES
]

Minimum Soak
Value in a profile.

Real

NaN

Yes

View Only

CEE

No

MINTIME

Step

Step Minimum
Active Time

32-Bit Integer 0 to (2^31)-1

Yes

Operator

CEE

No

MINURECFAULT

RM

Indication of a minor Enumeration


unrecoverable fault
in the Redundancy
Module.

Ok (0)

No

View Only
Not Loaded
Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform.

Ok (0)
Fault (1)

Related
Parameters

TIME, MAXTIME

Notes

MINTIME is the minimum


number of execution cycles
that the step is active.
When Step TIME is
less-than-or-equal to
MINTIME it prevents the
transition(s) out of the step
from being evaluated.

No

97

Specific to
Block(s)

Description

Data Type

Range

Default

MODCOMPATA

RM

Indication of the
Enumeration
module pairs
[20]
assessment of their
compatibility

Undefined (0) Undefine No


Incompatible d (0)
(1)
Fully (2)
Standby (3)

View Only
Not Loaded
Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform.

No

MODE

SCM

Sequential Control Enumeration


Module (SCM) Mode MODE
- Defines the SCM
execution mode..

None (0)
Auto (1)
Auto (1)
SemiAuto (2)
SingleStep (3)
Manual (4)
Normal (5)

No

Operator

CEE

All RegCtl Blocks:


AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Mode - Defines the Enumeration


mode of a
REGMODE
Regulatory Control
function block.

See below

No

Operator

Manual
(Man)

Config
Load

Access
Lock

Manual (0):

Range
OP is stored by either the operator or a user program. The function
block doesnt derive OP, so the input (SP, X1, etc.) is ignored.

Automatic (1):

The function block derives OP. The input (SP, X1, etc.) may be
stored by either the operator or a user program.

Cascade (2):

The function block derives OP. The input is pulled from another
function block (the primary).

Backup
Cascade (3):

The function block derives OP. The input is pulled from a backup
cascade. (Note: Bcas only applies to the Remote Cascade FB.)

Residence

Active
Connector

Related
Parameters

Notes

No

CONTROLLOCK,
COMMAND,
EXCMODEOPT,
MODEATTR,
SSTEPLOCK

The ability to change MODE


to a certain value depends
on the following current
values: MODEATTR,
SSTEPLOCK, and
CONTROLLOCK.

CEE

No

MODEATTR

MODE change by a program


requires MODEATTR =
Program and REDTAG = Off;
MODE change by an operator
requires MODEATTR =
Operator, MODEPERM =
Permit, and REDTAG = Off.

CEE

No

Normal (4)
None (5)
DevCtl

Mode

Enumeration
MODE

Manual

Manual

No

View Only

Access is illegal if
NUMDOUTS = 0.
The value of this parameter
is fixed Manual to be
compatible with other
function blocks.

98

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

No

View Only

CEE

No

MODE

MODEAPPL [1] is On, if


Manual (Man) mode is valid;
otherwise, it is Off.
MODEAPPL [2] is On, if
Automatic (Auto) mode is
valid; otherwise, it is Off.
MODEAPPL [3] is On, if
Cascade (Cas) mode is valid;
otherwise, it is Off.

Operator

MODEAPPL [1..4] All RegCtl Blocks:


AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Mode Applicability - Boolean


Defines changes for
Regulatory Control
function blocks.

Off (0): Mode Off (0)


is not
supported
On (1): Mode
is supported

MODEATTR

SCM

Sequential Control Enumeration


Module (SCM) Mode MODEATTR
Attribute

Operator (1)
Program (2)
Normal (3)

CEE

No

COMMAND,
MODE and COMMAND can
CONTROLLOCK,
only be accessed by an
MODE, SSTEPLOCK, Operator, when MODEATTR
is Operator. When
MODEATTR is Program, only
programs can store to MODE
and COMMAND.

DevCtl

Mode Attribute
Enumeration See below
Operator Yes
Operator
CEE
determines where MODEATTR
(0)
state commands to
the Device Control
Function Blocks may
Range
originate, that is,
None (0):
who may set OP.
Operator (1): Only the operator may command the output state.

No

CONTROLREQ, GOP,
GOPREQ,
MODETRACK,
NUMDOUTS, OP,
OPREQ, REDTAG.

Access is illegal, if
NUMDOUTS = 0.
MODEATTR may not be
changed if REDTAG is on.

No

MODE, OP, SP, X1.

MODEATTR change requires


the Safety Interlock Flag
(SIFL) and REDTAG to be Off.
MODEATTR is displayed near
MODE on detail and group
displays. If MODEATTR is
Program, a -P appears to
the left of MODE; if it is
Operator, blanks are
displayed next to MODE.

All RegCtl Blocks:


AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Operator No
(1)

Program (2):

Only other Function Blocks (e.g. Logic FBs, SCM


programs) may command the output state by setting OP
or OPCMD [i].

Normal (3):

When Normal is stored to MODEATTR, the parameter


is set to the present value of NORMMODEATTR

Mode Attribute Enumeration


Defines whether the MODEATTR
operator or a user
program has the
authority to change
certain variables
within this function
block.

Operator (1): Operator No


The operator (1)
can set
MODE, OP, SP,
RATIO and
BIAS.
Program (2):
The program
(SCM) can set
MODE, OP, SP,
RATIO and
BIAS.

Operator

CEE

99

Specific to
Block(s)

MODEATTRFL.NO All RegCtl Blocks:


RM
AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.
DevCtl

MODEATTRFL.OP All RegCtl Blocks:


ER
AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.
DevCtl

Description

Data Type

Range

Normal Mode
Attribute Flag
Indicates if mode
attribute is normal;
i.e., MODEATTR =
NORMMODEATTR

Boolean

Normal Mode
Attribute Indicator
Flag

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Off (0): Mode Off (0)


attribute is not
normal
On (1): Mode
attribute is
normal

No

View Only

CEE

No

MODEATTR,
NORMMODEATTR

Boolean

Off (0): Mode Off (0)


attribute is not
normal
On (1): Mode
attribute is
normal

No

View Only

CEE

No

MODEATTR,
Value is On if MODEATTR =
MODEATTRFL.OPER, NORMMODEATTR
MODEATTRFL.PROG,

Operator Mode
Boolean
Attribute Flag
Indicates if the mode
attribute is Operator

Off (0): Mode Off (0)


attribute is not
Operator
On (1): Mode
attribute is
Operator

No

View Only

CEE

No

MODEATTR

Operator Mode
Attribute Indicator
Flag

Off (0): Mode Off (0)


attribute is not
Operator
On (1): Mode
attribute is
Operator

No

View Only

CEE

No

MODEATTR,
Value is On if MODEATTR =
MODEATTRFL.NORM Operator.

Boolean

Default

Notes

100

Parameter

Parameter

Specific to
Block(s)

MODEATTRFL.PR All RegCtl Blocks:


OG
AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Description

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

Program Mode
Boolean
Attribute Flag
Indicates if the mode
attribute is Program.

Off (0):
Off (0)
MODEATTR is
not currently
Program.
On (1):
MODEATTR is
currently
Program.

No

View Only

CEE

No

MODEATTR

Program Mode
Attribute Flag

Boolean

Off (0):
Off (0)
MODEATTR is
not currently
Program.
On (1):
MODEATTR is
currently
Program.

No

View Only

CEE

No

MODEATTR,
Value is On if MODEATTR =
MODEATTRFL.OPER, Program.
MODEATTRFL.NORM

MODEFL.AUTO

All RegCtl Blocks: Auto Mode Flag Boolean


AutoMan, Fanout, Indicates if the mode
OvrdSel, PID, PIDFF, is Auto.
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Off (0): Mode Off (0)


is not Auto.
On (0): Mode
is Auto.

No

View Only

CEE

No

MODE

MODEFL.BCAS

All RegCtl Blocks:


AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Backup Cascade
Boolean
Mode Flag
Indicates if the mode
is Backup Cascade.

Off (0): Mode Off (0)


is not Backup
Cascade.
On (1): Mode
is Backup
Cascade.

No

View Only

CEE

No

MODE

MODEFL.CAS

All RegCtl Blocks: Cascade Mode Flag - Boolean


AutoMan, Fanout, Indicates if the mode
OvrdSel, PID, PIDFF, is Cascade
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Off (0): Mode Off (0)


is not
Cascade.
On (1): Mode
is Cascade.

No

View Only

CEE

No

MODE

DevCtl

101

Specific to
Block(s)

Description

Data Type

MODEFL.MAN

All RegCtl Blocks: Manual Mode Flag - Boolean


AutoMan, Fanout, Indicates if the mode
OvrdSel, PID, PIDFF, is Manual.
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

MODEFL.NORM

All RegCtl Blocks: Norm Mode Flag


AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

MODEPERM

All RegCtl Blocks:


AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Mode Permissive - Enumeration


Indicates if the
MODEPERM
operator can change
the mode of a
function block.

MODEREQ

All RegCtl Blocks:


AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

The requested
Enumeration
MODE. The SCM
REGMODE
CONTROLREQ
(Control Request)
wants to change the
Regulatory Blocks
MODE.

Boolean

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Off (0): Mode Off (0)


is not Manual.
On (1): Mode
is Manual.

No

View Only

CEE

No

MODE

Off (0)
On (1)

No

View Only

CEE

No

Permit (0) Not


Yes
Operator is
Permitted
permitted to (1)
change the
mode.
Not Permitted
(1) - Operator
is not
permitted to
change the
mode.

Engineer

CEE

No

MODE

Man (0)
Auto (1)
Cas (2)
None (3)

Operator

CEE

No

CONTROLREQ,
LASTMODEREQ,
SCMOPT

Off (0)

None (3)

No

Notes

102

Parameter

Parameter

Specific to
Block(s)

Description

MODETRACK

DevCtl
All RegCtl Blocks:
AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

MODISREDUN

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Sequential Control Enumeration


Module (SCM) Mode MODETRACK
Tracking Option - A
configurable
parameter that
defines how the
regulatory control or
device control FB
will set the state of
the MODEATTR
based upon the
MODE of the SCM.

None (0)
OneShot (1)
SemiCont (2)
ContRtn (3)
Cont (4)

OneShot
(1)

Yes

Engineer

CEE

No

MODEATTR,
Is invalid if
ControlModule.SCM ControlModule.SCMOPT =
OPT,
None.
ControlModule.SCM
MODE,
ControlModule.SCM
STATE

CPM

Module is redundant Boolean

Off (0)
On (1)

Off (0)

No

Engineer

SR

No

ABORTALM.PR

MODTYPEA

RM

Module Type - For


Enumeration
each module in the [20]
host chassis, text
description of
module type based
on modules Product
Type and Product
Code values.

UNK (0)
--- (1)
CPM (2)
CNB (3)
RM (4)
AC (5)
OM (6)
SP1 (7)
SP2 (8)
SP3 (9)
SP4 (10)
SP5 (11)

--- (1)

No

View Only
Not Loaded
Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform.

No

PRODTYPEA,
PRODCODEA

MOMSTATE

DevCtl

Momentary Output
States

Enumeration
MOMSTATE

None (0)
None (0)
Mom_1 (1)
Mom_0 (2)
Mom_2 (3)
Mom_1_2 (4)
Mom_0_2 (5)
Mom_0_1 (6)

Yes

Engineer

CEE

No

GOP, NUMSTATES, Access is illegal, if


OP, OPDOMAP [0..3] NUMDOUTS = 0.
[1..3], SAFEOP
The function block must be
inactive to change
MOMSTATE.
MOMSTATE is inaccessible
if REDTAG is set.
MOMSTATE may not be set
if SEALOPT is Enabled.

MSGTYPE [0..15] Message

Message Type

Enumeration

Info (0)
Confirm (1)

Yes

Operator

CEE

No

MULREDUNSTAT CPM, RM

The state of the


module's
redundancy

Enumeration

CONFIGREDU CONFIGR No
N (0)
EDUN (0)
FORCEDREDU
N (1)
NONREDUN
(2)

Application
Developer

SR

No

MXRFBDEV

Maximum deviation
allowed between CV
and RFB, in percent.

PidExtReset

Data Type

Info (0)

ABORTALM.PR

Notes

This parameter is set


differently for CPM and RM:
CPM: CONFIGREDUN
RM: FORCEDREDUN

SIFL, PV, SP, RFB,


TRFB, S1.
103

Specific to
Block(s)

Description

Data Type

Range

Default

Config
Load

ROL, ROR, SHL,


SHR, nooN

Number of bits to be 16-Bit Integer 0 to 16


0
Yes
shifted
(nooN: 1 to 5) (nooN: 1)

NAME

All basic function


blocks (a basic
function block is
one that can be
instantiated in a
Control Module).

Name

Access
Lock

Residence

Active
Connector

Engineer

CEE

No

Related
Parameters

Notes

Enter a unique block name


up to 16 characters (or 16
unicode characters) to
identify the block in the
system. This name appears
on all related system
displays and any generated
reports. The name only
needs to be unique within
the Control Module or
Sequential Control Module,
not system-wide

NETELAPSEDTM RampSoak

Net Elapsed Time for Real


current RampSoak
Profile (in Minutes)

Greater-than 0.0
or equal to 0.0

No

NETWORKTYPE

CPM, RM

Network Type

Enumeration

ControlNet (0) ControlNe No


Ethernet (1)
t (0)

NEXTCOMP

Transition

Next Component
Reference

Output
Connection

Yes

View Only

CEE

No

TOTELAPSEDTM

Engineer

SR

No

ABORTALM.PR

Application
Developer

CEE

No

Does not include time for


stopped timers due to
deviation.

NEXTCOMP specifies the


SCM component that follows
the transition. The
transition.NEXTCOMP block
pin is exposed by default. It
may be connected to a single
step (through the steps
DESC parameter), or left
open (causing the handler to
end when the transition is
true).

104

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

NEXTCOMP
[1..10]

Step

Next Component
Reference

Output
Connection

NEXTHANDLE

Transition

Next Component
Handle

32-Bit Integer 0 to 1023

NEXTHANDLE
[1..10]

Step

Next Component
Handle

NEXTNUMBER

Step

NFLAG

NLFORM

Config
Load

Access
Lock

Residence

Active
Connector

Yes

Application
Developer

CEE

No

No

View Only

CEE

No

NUM, NEXTCOMP

Contains the number (NUM)


of the next SCM component
following the transition.

32-Bit Integer 0 to 1023

No

View Only

CEE

No

NUM, NEXTCOMP
[1..10]

NEXTHANDLE [i] contains


the number of the next
Sequential Control Module
(SCM) component connected
to NEXTCOMP [i].

Step Next
Component Handle
Count.

32-Bit Integer 0 to 10

No

View Only

CEE

No

NEXTCOMP [1..10]

Contains the number of


components (transitions)
following the step.

FLAGARRAY,
SIFLAGARRCH

Number of Flag
Values Specifies
the number of
boolean values in
the array of data
from the serial
device.

32-Bit Integer SIFLAGARRCH 1


: 0 to 512
FLAGARRAY: 0
to 1000

Yes

Application
Developer

CEE

No

SIFLAGARRCH only:
PVFL [1..512]
FLAGARRAY only:
PVFL [1..1000]

REQFLAGARRAY,
RSPFLAGARRAY

The number of
32-Bit Integer 1 to 512
Boolean values that
must be read or
written by this block.

Yes

Application
Developer

CEE

No

PID, PIDFF

Non-linear Gain
form. Used if
GAINOPT = Nonlin
(configured)

Yes

Engineer

CEE

No

Integer

Range

0 or 1

Default

Related
Parameters

Notes
NEXTCOMP specifies the
SCM component that follows
the step. The steps
NEXTCOMP [1] block pin is
exposed by default. It may
be connected to a single
transition through the
transitions DESC parameter
(which may have additional
corrections from other steps
NEXTCOMP [i]).
If left open, the handler will
end when the step
completes. The block pins
NEXTCOMP [2] through
NEXTCOMP [i] can be
exposed for i transitions out
of a step (with a maximum of
10).

105

Specific to
Block(s)

Description

Data Type

Range

Config
Load

Access
Lock

Residence

Active
Connector

NLGAIN

PID, PIDFF

Non-linear Gain
factor. Used if
GAINOPT = Nonlin
(configured).

64-Bit Real
Number

GAINLOLM to 0.0
GAINHILM

Yes

Engineer

CEE

No

NNUMERIC

NUMERICARRAY,
SINUMARRCH

Number of Numeric 32-Bit Integer


Values Specifies
the number of
numeric values in
the array of data
from the serial
device.

SINUMARRCH 1
: 0 to 64
NUMERICARR
AY: 0 to 200

Yes

Application
Developer

CEE

No

REQNUMARRAY,
RSPNUMARRAY

The number of
32-Bit Integer 1 to 64
integer or real
values that must be
read or written by
this block.

Yes

Application
Developer

CEE

No

NOFIELDPWR

DIC, DOC

No Field Power Boolean


Indicates that a loss
of field power has
occurred.

No loss of
power
detected (0)
Loss of power
detected (1)

No loss of No
power
detected
(0)

View Only

CEE

No

ELOF
Previously the LOF and
[0..numChans-1] (DIC ZCROSS parameters.
only), EZCROSS
[0..numChans-1]
(DOC only)

NOFIELDPWR
[0..numChans-1]

DIM, DOM

No Field Power Boolean


Indicates that a loss
of field power has
occurred.

No loss of
power
detected (0)
Loss of power
detected (1)

No loss of No
power
detected
(0)

View Only

CEE

No

ELOF
Previously the LOF and
[0..numChans-1]
ZCROSS parameters.
(DIM only), EZCROSS
[0..numChans-1]
(DOM only)

NOLOAD

DOC

Indicates when
Boolean
output current draw
is below the
threshold.

Current draw
is not below
threshold (0)
Current draw
is below
threshold (1)

Current No
draw is
not below
threshold
(0)

View Only

CEE

No

ENOLOAD
[0..numChans-1]

NOLOAD
[0..numChans-1]

DOM

Indicates when
Boolean
output current draw
is below the
threshold.

Current draw
is not below
threshold (0)
Current draw
is below
threshold (1)

Current No
draw is
not below
threshold
(0)

View Only

CEE

No

ENOLOAD
[0..numChans-1]

NORMAL

Flag

Normal State Defines the normal


state of the Flag
function block.

StateText (0)
StateText (1)
None

None

Supervisor
Engineer is
limited to
change
to/from
None.

CEE

No

STATETEXT [0..1], PV, Setting NORMAL to None


OFFNRMALM.FL
disables the Off-Normal
alarm.

Enumeration
STATETEXT,
None

Default

Yes

Related
Parameters

Notes

SINUMARRCH only: SINUMARRCH: The interface


PV [1..64]
to the serial device has a
NUMERICARRAY
maximum size of 64 bytes.
only: PV [1..200]

106

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

NORMMODE

DevCtl
All RegCtl Blocks:
AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Normal Mode Defines the normal


mode of a
Regulatory Control
function block.

Enumeration
REGMODE

Manual (Man)
Automatic
(Auto)
Cascade (Cas)
Backup
Cascade
(Bcas)
None

DevCtl:
Manual
(Man)
RegCtl:
None

Yes

Engineer

CEE

No

MODE

The mode of a RegCtl block


is derived at runtime, based
on current conditions.
However, the user may
configure a normal mode
(NORMMODE) and normal
attribute
(NORMMODEATTR), and go
to that mode by pressing the
NORM button on the
operator pane. When the
button is pressed, the
contents of NORMMODE is
copied to MODE, and
NORMMODEATTR is copied
to MODEATTR.

DevCtl

Normal Mode

Enumeration
MODE

Manual

Manual

Yes

Engineer

CEE

No

MODE

SCM

Normal Mode Defines the normal


mode of the SCM.

Enumeration
MODE

None (0)
SCM:
Auto (1)
None (0)
SemiAuto (2)
SingleStep (3)
Manual (4)
Normal (5)

Yes

Engineer

CEE

No

MODE

When Normal (5) is stored to


MODE, the SCM MODE is
set to the configured
NORMMODE. Only None (0)
and Auto (1) are valid for
SCM NORMMODE.

NORMMODEATT SCM, DevCtl,


R
All RegCtl Blocks:
AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Normal Mode
Attribute - Defines
the Normal Mode
Attribute of a
Regulatory Control
function block.

Enumeration
MODEATTR

None (0)
Oper (1)
Program (2)

None (0)

Yes

Engineer

CEE

No

MODEATTR
DevCtl only:
MODEATTR,
MODETRACK,
NUMDOUTS

Access Illegal if NUMDOUTS


= 0.

NOTCHFILTER
[0..numChans-1]

Isolated Modules:
Notch Filter
Non_Isolated
Modules: 3 dB Filter

Non-Isolated
Modules:
Enumeration
of
THREEDBFILT
R
Isolated
Modules:
Enumeration
of
NOTCHFILTER

Non-Isolated
Modules:
20 Hz (0)
Isolated
Modules:
50Hz (1)
60Hz (2)

Non-Isola Yes
ted
Modules:
20Hz (0)
Isolated
Modules:
60Hz (2)

Application
Developer

CEE

No

AIM

Note that for the


non-isolated Analog Input
modules, NOTCHFILTER is
configurable on a per-module
basis, rather than on a per
channel basis.

107

Specific to
Block(s)

Description

Data Type

NSTRING

TEXTARRAY,
SITEXTARRCH

Number of String
32-Bit Integer
Values Specifies
the number of string
values in the array of
data from the serial
device.

Range

Default

SITEXTARRCH 1
only: 0 to 8
TEXTARRAY
only: 0 to 120

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Yes

Application
Developer

CEE

No

SITEXTARRCH only: See below


STRLEN, STR [1..8]
TEXTARRAY only:
STRLEN, STR [1..120]

Notes
The Text Array block supports a maximum size of 960 two-byte characters. This number
is chosen based on the amount of data that can fit in one ControlNet message. This is
important when full array access is supported.
SITEXTARRCH only: With the interface to the serial device having a maximum size of
64-bytes, the table below shows how the 64-bytes are interpreted, based on the
NSTRING and STRLEN configured, and the resulting STR [ ] range. Illegal combinations
of NSTRING and STRLEN (those requiring more than 64-bytes of data) will be rejected.
NSTRING
1
2
4
8

STRLEN
64
32
16
8

REQTEXTARRAY,
RSPTEXTARRAY

The number of
32-Bit Integer 1 to 8
strings that must be
read or written by
this block. The
product of NSTRING
and STRLEN cannot
exceed 64.

Yes

Application
Developer

CEE

No

NULLPVFL

DevCtl

PV Bad Value Flag

Off (0)

No

View Only

CEE

No

NUM

Handler, Step,
Transition

Sequential Control 32-Bit Integer 0 to 1023


Module (SCM)
Component Number.

No

View Only

CEE

No

Greater-than 0
or equal to 0.0

No

View Only

CEE

No

NUMACCRQUAV CEE
G

Boolean

Average number of 64-Bit Real


Acyclic peer
Number
communication
parameter requests
per second.

Notes

Off (0)
On (1)

STR [ ] Range
1..1
1..2
1..4
1..8

DIPVMAP [0..15],
GPV, NUMDINPTS,
PV

This is not necessarily the


same as the BADPVALM.FL
alarm flag.
Access is illegal, if
NUMDINPTS = 0.
NUM is the number assigned
to each SCM component
when the SCM is loaded.

NUMACCRQUMAX,
STATSRESET

Rolling average of acyclic


parameter request
throughput. SCM step
outputs are the only block
mechanisms to cause acyclic
peer to peer communication
traffic.

108

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

Range

NUMACCRQUMA CEE
X

Number of Acyclic 64-Bit Real


parameter Requests Number
per second
Maximum.

NUMALIASES

SCM

Number of aliases
configured in the
Alias Table.

Alias Table
parameter

Defines the number Integer


of aliases in the
Alias Table.

NUMCCLRQU

CEE

Number of Cyclic
64-Bit Real
parameter requests Number
for peer data per
second.

Greater-than
or equal-to 0.0

NUMCHANS

All IOM Function


Blocks

Defines the
32-Bit Integer
maximum number of
channels supported
by the respective
IOM type.

Dependent
upon module
type.
(i.e., Pulse
Input IOM: 8)

NUMCMPCONTF CM
B

Internal parameter
for system use only.

NUMCOMPFB

CM, SCM

Internal parameter
for system use only.

NUMCONDS

Transition

Number of Input
Conditions

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

No

View Only

CEE

No

NUMACCRQUAVG,
STATSRESET

Historical maximum of
acyclic parameter request
throughput since last store to
STATSRESET. SCM step
outputs are the only block
mechanisms to cause acyclic
peer to peer communication
traffic.

Yes

Application
Developer

CEE

No

Application
Developer

CEE

View Only

CEE

No

SUBSCPERIOD

Value of NUMCCLRQU is
associated with the currently
loaded block configuration
and SUBSCPERIOD.
Note that this statistical
parameter is not affected by
STATSRESET.

Dependen Yes
t upon
module
type.
(i.e., Pulse
Input
IOM: 8)

Application
Developer

CEE

No

This parameter is not


configurable.

Application
Developer

CEE

No

The primary use is for sizing


the internal storage of SCM
FB. The user does not have
to explicitly configure
NUMCONDS; This value is
determined by the system
when the SCM is edited.

Greater-than
or equal-to 0.0

16-Bit Integer 0 to 500

32-Bit Integer 0 to 10

No

Yes

109

Specific to
Block(s)

Description

NUMCONN

All IOM Function


Blocks except
Serial Interface
IOM To be used
for Troubleshooting
only.
Refer to
NUMCONN [0..7]
for Serial Interface
IOM.

Data Type

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Number of
32-Bit Integer
Connections
Indicates a running
count of the number
of times that a
connection has been
formed to the
associated device.

No

View Only

CEE

No

NUMDISCONN,
NUMSHUTDOWN

NUMCONN [0..7] Serial Interface


IOM.

Number of
32-Bit Integer
Connections
Indicates a running
count of the number
of times that a
connection has been
formed to the
associated device.

No

View Only

CEE

No

NUMDISCONN [0..7],
NUMSHUTDOWN
[0..7]

NUMDINPTS

DevCtl

Number of Digital
Inputs

No

Engineer

CEE

No

See below

NUMDISCONN

All IOM Function


Blocks except
Serial Interface
IOM To be used
for Troubleshooting
only.
Refer to
NUMDISCONN
[0..7] for Serial
Interface IOM.

Number of
32-Bit Integer
Disconnects
Indicates a running
count of the number
of times that a
connection has been
closed due to fault
(rather than due to a
commanded
operation).

No

View Only

CEE

No

Integer

Range

0 to 4

Default

Notes

To change, the function block


must be InActive.
Related Parameters
BADPVALM.FL,
INBETFL,
BADPVALM.PR,
LOCALMAN,
BADPVALM.SV,
NULLPVFL,
CMDDISALM.FL,
PV,
CMDDISALM.PR,
PVAUTO,
CMDDISALM.SV,
PVFL [0..2],
CMDDISALM.TM [0..2], PVSOURCE,
CMDFALALM.FL,
PVSRCOPT,
CMDFALALM.PR,
SEALOPT,
CMDFALALM.SV,
STATETEXT [0..6],
CMDFALALM.TM [0..2], UNCMDALM.FL,
DI [1..4],
UNCMDALM.PR,
GPV,
UNCMDALM.SV
GPVAUTO,
NUMCONN,
NUMSHUTDOWN

110

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

NUMDISCONN
[0..7]

Serial Interface
IOM.

32-Bit Integer
Number of
Disconnects
Indicates a running
count of the number
of times that a
connection has been
closed due to fault
(rather than due to a
commanded
operation).

NUMDOUTS

DevCtl

Number of Digital
Outputs

Integer

Range

0 to 3

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

No

View Only

CEE

No

NUMCONN [0..7],
NUMSHUTDOWN
[0..7]

No

Engineer

CEE

No

See below

Notes

To change, the function block


must be InActive.

Related Parameters
BYPASS,
OIALM.PR [0..2],
CMDDISALM.FL,
OIALM.SV [0..2],
CMDDISALM.PR,
OP,
CMDDISALM.SV,
OPDOMAP [0..3] [1..3],
CMDDISALM.TM [0..2], OPFINAL,
CMDFALALM.FL,
OROPT,
CMDFALALM.PR,
PI [0..2],
CMDFALALM.SV,
PO [1..3],
CMDFALALM.TM [0..2], PULSEWIDTH [1..3],
DO [1..3],
PVSOURCE, REDTAG,
GOP,
SAFEOP, SEALOPT,
GOPFINAL,
SI,
INITMAN,
SIALM.FL, SIALM.OPT,
INITOPOPT,
SIALM.PR, SIALM.SV,
LOCALMAN,
STATETEXT [0..6],
MODEATTR,
UNCMDALM.FL,
OI [0..2],
UNCMDALM.PR,
OIALM.FL [0..2],
UNCMDALM.SV
OIALM.OPT [0..2],
NUMEVENTS
RampSoak
[1..NUMPROFILES
]

Number of Events in Integer


a Profile

1 to 16

Yes

Application
Developer

CEE

No

NUMRAMPSOAK
[1..NUMPROFILES]

NUMHANDLERS SCM

Internal parameter
for system use only.

NUMHISTPARMS SCM

Number of History
Parameters

32-Bit Integer 0 to 50

Yes

Application
Developer

CEE

No

HISTDESC

The user does not explicitly


configure NUMHISTPARMS.
It is determined by the
system when History values
are added or deleted.

111

Specific to
Block(s)

NUMINSTANCES SCM

Description

Data Type

Range

Number of instances 16-Bit Integer 0 to 100


configured in the
Alias Table.

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Yes

Application
Developer

CEE

No

Application
Developer

CEE

Yes

Engineer

CEE

No

DELAYTABLE [1..60],
DELAYTIME

Notes

Alias Table
parameter

Defines the number Integer


of instances or
columns in the Alias
Table.

NUMLOC

Deadtime

Number of Locations Integer


in Delay Table.

2 to 60

NUMNTFRQUAV
G

CEE

Number of
64-Bit Real
Notification
Number
Requests per second
Average.

Greater-than 0
or equal-to 0.0

No

View Only

CEE

No

NUMNTFRQUMAX,
STATSRESET

Rolling average of
notification request
throughput.

NUMNTFRQUMA CEE
X

Number of
64-Bit Real
Notification
Number
Requests per second
Maximum.

Greater-than
or equal-to 0.0

No

View Only

CEE

No

NUMNTFRQUAVG,
STATSRESET

Historical maximum of
notification request
throughput since last store of
STATSRESET.

NUMOFINPUTS

MVote, Min, Max

Number of
configured inputs

Integer

1 to 8

MVote: 3 Yes
Min, Max:
2

Engineer

CEE

No

EQ, GE, GT, LE, LT,


NE

Number of
configured inputs

Integer

1 to 2

Yes

Engineer

CEE

No

60

NUMONESHOT

All RegCtl Blocks: Number of OneShot 32-Bit Integer 0 to 32767


AutoMan, Fanout, requests.
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

No

View Only

CEE

No

NUMOUTPUTS

Step

Yes

Application
Developer

CEE

No

Step Total Number


of Outputs

32-Bit Integer 0 to 16

Primary use is for sizing


internal storage of SCM
function block. The user
does not have to explicitly
configure NUMOUTPUTS;
But this value is determined
by the system when the SCM
is edited.

112

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

NUMPARRSPAV
G

CEE

Average Number of 64-Bit Real


Parameter Get /
Number
Store Responses per
Second.

NUMPARRSPMA CEE
X

Maximum Number 64-Bit Real


of Parameter Get / Number
Store Responses per
Second.

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

Greater-than
or equal to 0.0

No

View Only

CEE

No

NUMPARRSPMAX,
STATSRESET

Gives a running time average


of parameter response
throughput being serviced by
the CEE. Units are
parameter responses per
second. Averaging restarts
from the current moment
when parameter
STATSRESET is stored.
Characteristic time constant
of the average is 1 minute.
Wait 2 - 3 minutes to be sure
averaging has fully settled.

Greater-than
or equal-to 0.0

No

View Only

CEE

No

NUMPARRSPAVG,
STATSRESET

Gives a historical maximum


of parameter response
throughput being serviced by
the CEE. Units are
parameter responses per
second. Search for
maximum restarts from the
current moment when
parameter STATSRESET is
stored.

NUMPRI

All RegCtl Blocks: Number of Primaries 32-Bit Integer


AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

0 to 8
0
(dependent on
the function
block)

No

View Only

CEE

No

NUMPROFILES

RampSoak

1 to 10

Yes

Application
Developer

CEE

No

NUMPROPREQ

All RegCtl Blocks: The number of


AutoMan, Fanout, propagation
OvrdSel, PID, PIDFF, requests
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

No

View Only

Not Loaded

No

Yes

Application
Developer

CEE

No

Integer
32-Bit Integer

Number of
Integer
Ramp/Soak Pairs in
a Profile

1 to 50

NUMEVENTS
[1..NUMPROFILES]
113

NUMRAMPSOAK RampSoak
[1..NUMPROFILES
]

Number of Profiles

Specific to
Block(s)

NUMRECPARMS SCM

Description

Data Type

Number of Recipe
Parameters

32-Bit Integer 0 to 50

NUMSEC

All RegCtl Blocks: Number of


AutoMan, Fanout, Secondaries
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

NUMSEGS

Genlin

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

Yes

Application
Developer

CEE

No

RECDESC [1..50],
RECSCALE [1..50],
RECMATCODE
[1..50], RECTARGET
[1..50],
RECTARGETMAX
[1..50],
RECTARGETMIN
[1..50]

The user does not explicitly


configure NUMRECPARS. it
is determined by the system
when Recipe values are
added or deleted

32-Bit Integer 0 to 8
0
(dependent on
the function
block)

No

View Only

CEE

No

Yes

Engineer

CEE

No

IN, OUT

Number of
Integer
Segments - Total
number of segments
defined to the
General
Linearization
function block.

Range

1 to 12

NUMSHUTDOWN All IOM Function


Blocks except
Serial Interface
IOM To be used
for Troubleshooting
only.
Refer to
NUMSHUTDOWN
[0..7] for Serial
Interface IOM.

Number of
32-Bit Integer
Shutdowns
Indicates a running
count of the number
of times that a
connection to the
associated device
has been closed due
to either a fault or
commanded
shutdown.

No

View Only

CEE

No

NUMCONN

NUMSHUTDOWN Serial Interface


[0..7]
IOM.

Number of
32-Bit Integer
Shutdowns
Indicates a running
count of the number
of times that a
connection to the
associated device
has been closed due
to either a fault or
commanded
shutdown.

No

View Only

CEE

No

NUMCONN [0..7]

114

Parameter

Parameter

Specific to
Block(s)

Description

NUMSIOVRD

DevCtl

NUMSLOTS

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Number of Safety
64-Bit Real
Interlock Trips The Number
accumulated number
of Safety Override
Interlocks since the
last reset of
maintenance
Statistics.

0.0 to
Maximum
Real Number

0.0

No

View Only

CEE

No

MAINTOPT, RESETFL, Default to 0.0 if MAINTOPT


SI
is set to Off.
Reset to 0.0 whenever
RESETFL is changed from Off
to On.

RM

Number of slots in
the host chassis

1 to 20

No

View Only
Not Loaded
Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform.

NUMSTATES

DevCtl

Number of Settable Integer


States

Yes

Engineer

No

CMDDISALM.FL,
CMDDISALM.PR,
CMDDISALM.SV,
CMDDISALM.TM
[0..2],
CMDFALALM.FL,
CMDFALALM.PR,
CMDFALALM.SV,
CMDFALALM.TM
[0..2], DIPVMAP
[0..15], GOP,
GOPFINAL, GPV,
GPVAUTO,
LASTOPREQ,
MAXTIME,
MAXTRANS [0..2],
MOMSTATE,
NUMTRANS [0..2],
OP, OPDOMAP [0..3]
[1..3], OPFINAL,
OPREQ, PI [0..2], PV,
PVAUTO, PVFL [0..2],
SAFEOP, STATETIME
[0..2]

NUMSTEPS

SCM

Internal parameter
for system use only.

NUMSYNCS

SCM

Internal parameter
for system use only.

NUMTBR

CM

Internal parameter
for system use only

32-Bit
Unsigned
Integer

2 to 3

CEE

Notes

The function block must be


inactive to change this
parameter.
Any member of DIPVMAP []
that may have been assigned
to state S2 will be changed
to Null, upon NUMSTATES
being set to = 2.

115

Specific to
Block(s)

Description

Data Type

NUMTHREADS

SCM

SCM Current
Number of Active
Threads

32-Bit Integer 0 to 10

NUMTRANS

SCM

Sequential Control 32-Bit Integer


Module (SCM) Total
Number of
Transitions

NUMTRANS [0..2] DevCtl

Total Number of
State Transitions
The accumulated
number of
transitions to the
reference state
since the last reset
of Maintenance
Statistics.

NUMXFERINST]

CM

Internal parameter
for system use only.

OFFNRMALM.FL

Flag

Off Normal Alarm


Flag

DevCtl

OFFNRMALM.PR Flag

DevCtl

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

No

View Only

CEE

No

Provides the current number


of active threads in the
execution of the SCM.

0.0

No

View Only

CEE

No

The primary use is for sizing


the internal storage of the
SCM function block. The
user does not have to
explicitly configure
NUMTRANS. This value is
determined by the system
when the SCM is loaded.

64-Bit Real
Number

0.0 to
Maximum
Real Number

0.0

No

View Only

CEE

No

GPV, MAINTOPT,
NUMSTATES, PV,
RESETFL

Defaulted to 0.0 if
MAINTOPT is not set On.
Reset to 0.0 whenever
RESETFL is set from Off to
On.
NUMTRANS [2] is illegal if
NUMSTATES = 2.

Boolean

Off (0)
On (1)

Off (0)

No

View Only

CEE

No

OFFNRMALM.PR,
OFFNRMALM.SV,
NORMAL, PV</HH

When On, it indicates that


the Flag function block is not
currently in the normal state.

Boolean
Off Normal Alarm
Flag - Indicates the
OFF-Normal
condition. The
Device is
OFF-Normal
wherever the
Process Variable (PV)
does not equal
OPREQ.

Off (0)
On (1)

Off (0)

No

View Only

CEE

No

BYPASS,
InActive when GOPREQ is
CMDDISALM.FL,
Null.
CMDDISALM.PR,
CMDDISALM.SV,
CMDDISALM.TM
[0..2], GOPREQ, GPV,
HIALM, OPREQ, PV

Off Normal Alarm


Priority

Enumeration
ALMPR

None (0)
Journal (1)
Low (2)
High (3)
Urgent (4)

Low (2)

Yes

Engineer

CEE

No

OFFNRMALM.FL,
OFFNRMALM.SV

Off Normal Alarm


Priority

Enumeration
ALPRIOR

None (0)
Journal (1)
Low (2)
High (3)
Urgent (4)

None (0)

Yes

Engineer

CEE

No

GOPREQ, OPREQ

InActive when GOPREQ is


Null.

116

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

OFFNRMALM.SV DevCtl, Flag

Off Normal Alarm


Severity

Integer

0 to 15

Yes

Engineer

CEE

No

OFFNRMALM.FL,
OFFNRMALM.PR
DevCtl Only:
GOPREQ, OPREQ

DevCtl only: InActive when


GOPREQ is Null.

OFFPULSE

DOC

Off Pulse - The Pin Real Number


would be connected
to DevCtl Pulsed
Output Value (PO)
Pin. The value
shows the remaining
pulse time.

No

Operator

CEE

Yes

ONPULSE

OHMOFFSET

AIC

10-Ohm Offset 32-Bit Integer -99 to 99


Corrective value for
use only with
10-ohm copper RTD.

No

View Only

CEE

No

CALBIAS,
SENSORTYPE
[0..numChans-1]

OHMOFFSET can only be


configured on the RTD input
module, and is only
configurable when
SENSORTYPE is set equal to
10_Cop_427.

OHMOFFSET
[0..numChans-1]

AIM

10-Ohm Offset 32-Bit Integer -99 to 99


Corrective value for
use only with
10-ohm copper RTD.

Yes

Application
Developer

CEE

No

CALBIAS
[0..numChans-1],
SENSORTYPE
[0..numChans-1]

OHMOFFSET can only be


configured on the RTD input
module.

OI [0..2]

DevCtl

Override Interlock

Boolean

Off (0)
On (1)

Off (0)

No

Engineer/
Other
Function
Block (see
Notes)

CEE

No

BYPASS, BYPPERM,
GOP, NUMDOUTS,
OIALM.FL [0..2],
OIALM.OPT [0..2],
OIALM.PR [0..2],
OIALM.SV [0..2], OP,
SAFEOP, SI,
SIALM.FL,
SIALM.OPT,
SIALM.PR, SIALM.SV

Engineer can change only if


function block is inactive.
OI(x) is illegal if NUMDOUTS
is less-than x.
These interlocks are not
active is BYPASS is set On.
The priority of the OI
interlocks is determined by
SAFEOP.
If SAFEOP = S0, then
priority is SI, 0, 1, 2.
If SAFEOP = S1, then
priority is SI, 1, 0, 2.
If SAFEOP = S2, then
priority is SI, 2, 0, 1.

OIALM.FL [0..2]

DevCtl

Override Interlock
Alarm Flag

Boolean

Off (0)
On (1)

Off (0)

No

View Only

CEE

No

BYPASS, BYPPERM, Always Off, if BYPASS is set


HIALM, INALM,
On.
NUMDOUTS, OI
[0..2], OIALM.OPT
[0..2], OIALM.PR
[0..2], OIALM.SV
[0..2]

OIALM.OPT [0..2] DevCtl

Override Interlock
Alarm Option.

Enumeration
OVRDALOP

No (0)
Yes (1)

Yes

Engineer

CEE

No

NUMDOUTS

Illegal if NUMDOUTS = 0.

117

Specific to
Block(s)

Description

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

OIALM.PR [0..2]

DevCtl

Override Interlock
Alarm Priority

Enumeration
ALPRIOR

None (0)
Journal (1)
Low (2)
High (3)
Urgent (4)

Low (2)

Yes

Engineer

CEE

No

NUMDOUTS, OI
[0..2], OIALM.FL
[0..2], OIALM.OPT
[0..2], OIALM.SV
[0..2]

Illegal if NUMDOUTS = 0.

OIALM.SV [0..2]

DevCtl

Override Interlock
Alarm Severity

16-Bit Integer 0 to 255

Yes

Engineer

CEE

No

NUMDOUTS, OI
[0..2], OIALM.FL
[0..2], OIALM.OPT
[0..2], OIALM.PR
[0..2]

Illegal if NUMDOUTS = 0.

OLDAV

Totalizer, Pulse
Input Totalizer

Old Accumulated
64-Bit Real
Value - The value of Number
the Process Variable
(PV), just before it
was reset. This
parameter makes
the old value
available to those
functions that need
it.

No

View Only

CEE

No

PV

ONPULSE

DOC

On Pulse - The Pin Real Number


would be connected
to DevCtl Pulsed
Output Value (PO)
Pin, and accepts
Pulse Order. The
value shows the
remaining pulse
time.

No

Operator

CEE

Yes

OP

All RegCtl Blocks


Output Value (in
except Fanout: PID, Percent)
RemCas, RatioBias,
RegCalc, Switch,
AutoMan, OvrdSel,
and RampSoak.

No

Operator

CEE

No

64-Bit Real
Number

Greater-than
or equal-to 0.0

OPEXLOLM to 0.0
OPEXHILM

OPEU

Output Value (OP) is


represented in percentage of
the Calculated Value (CV)
range (CVEULO and CVEUHI).

118

Parameter

Parameter

Specific to
Block(s)

Description

OP (cont.)

DevCtl

Commanded Output String


State

AOC, PWM
Channel

Output Value in
percent

Fanout

Output (OP) Values 64-Bit Real


(in percent) for
Number
function blocks with
Multiple Outputs There is one value
per output.

OP [1..8]

Data Type

Real Number

Range

Default

Length: 12
characters

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

STATETEX No
T [4]

Operator

CEE

No

BYPASS,
CMDDISALM.FL,
CMDDISALM.PR,
CMDDISALM.SV,
CMDDISALM.TM
[0..2],
CMDFALALM.FL,
CMDFALALM.PR,
CMDFALALM.SV,
CMDFALALM.TM
[0..2], GOP,
GOPFINAL, GOPREQ,
MOMSTATE,
NUMDOUTS,
NUMSTATES, OI
[0..2], OPDOMAP
[0..3] [1..3], OPFINAL,
OPREQ, SAFEOP,
SAFEREDTAG, SI,
STATETEXT [0..6],
UNCMDALM.FL,
UNCMDALM.PR,
UNCMDALM.SV.

OP is a String set equal to


STATETEXT [GOP].
Access is illegal, if
NUMDOUTS = 0.
STATETEXT [6] [State2] is
illegal if NUMSTATES = 2.
STATETEXT [2] [Active] is
illegal if SAFEOP = S2.

No

Operator

CEE

Yes

OPEXLOLM to OPEXLOL No
OPEXHILM
M

Operator

CEE

No

OPEU [1..8]

OP is represented in
percentage of the Calculated
Variable (CV) range (CVEULO
and CVEUHI).

119

Specific to
Block(s)

Description

Data Type

OP [1..16].
CONFIGCODE

Step

Output Configuration Enumeration See below.


None (0) No
View Only
CEE
Code
CSCOCONFIG
CODEOUTPUT
Range
SyntaxError (16)
IntegerExp (32)
ExtUse48 (48)
None (0)
ExprTooCmplx (17) DoubleExp (33)
ExtUse49 (49)
Ok (1)
NotEPcodeMe (18) MissedImpl (34)
ExtUse50 (50)
UnknownError (2)
ImplicitConv (3)
NotEDataStak (19) UnicodeConv (35)
UnsupConTyp (51)
UnsuppFeatur (20) ConsstExprRem (36) UnExpClsParn (52)
LossOfPrecsn (4)
UnexpctEnd (5)
ExprTooLong (21)
DuplExprRem (37)
CantAssRVal (53)
DstnInvalid (38)
UnExpArrOpen (54)
UnexpctComma (6) DivideByZero (22)
ColonWoQMark (7) UnknownToken (23) DstnCRqInval (39)
ArrClsExpect (55)
UnexpTokenOS (24) ExtUse40 (40)
ArrOpnExpect (56)
FctNotMltArg (8)
ClosParenExp (9)
UnknownFunc (25) ExtUse41 (41)
ArrIndxError (57)
UnexpOCExpr2 (26) ExtUse42 (42)
StringExpect (58)
OperandExp (10)
MissingArg (11)
UnexpOCExpr3 (27) ExtUse43 (43)
InvalidRefer (59)
ZeroArgument (28) ExtUse44 (44)
TooManyConnS (60)
OperatorExp (12)
ColonExp (13)
UnexpToken (29)
ExtUse45 (45)
CantConvInpt (61)
TypeMismatch (14) InvalResult (30)
ExtUse46 (46)
TypeNotSupp (15)
InvalTokenTb (31)
ExtUse47 (47)

No

See OP [1..16].CONFIGSTS
for additional information.

OP [1..16].
CONFIGDESC

Step

Output Configuration String


Descriptor

Maximum of Null
39 characters. String

No

View Only

CEE

No

See OP [1..16].CONFIGSTS
for additional information.

OP [1..16].
CONFIGSTS

Step

Output Configuration Enumeration Ok (0)


Ok (0)
Status
CSCOCONFIG Information (1)
STS
Warning (2)
SevereWarn
(3)
Fail (4)
Error (5)
SevereError
(6)

No

View Only

CEE

No

OP [1..16].DESC

Step

Output Description

Yes

Application
Developer

SR

No

OP [ ].DSTN

Step

Internal parameter
for system use only.

String

Range

Maximum
Length: 64
characters

Default

Null
String

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

OP
[1..16].CONFIGCODE,
OP
[1..16].CONFIGDESC

Notes

Step output configuration


status parameters OP
[1..16].CONFIGSTS, OP
[1..16].CONFIGCODE, OP
[1..16].CONFIGDESC are set
on SCM STATE transition
from Inactive to Validated.

120

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

OP [1..16].
DSTNCTRLREQ

Step

Output Destination
Control Request
Connector

OP [1..16].
EXECCODE

Step

OP [1..16].
EXECDESC

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

Output
Connector

No

Application
Developer

CEE

No

CONTROLREQ

Step outputs that store to


DevCtl or RegCtl function
blocks configured as Level 1
Device Drivers must make a
CONTROLREQ to the function
block. OP [i] is configured to
make a CONTROLREQ by
exposing the block pin OP
[i].DSTNCTRLREQ on the
step, and connecting it
(through a parameter
connector) to the function
blocks CONTROLREQ
parameter.

Output Execution
Code

Enumeration None (0)


None (0)
CSCOEXECCO ConfigError (1)
DE
ExprEvalFail
(2)
StoreFailed (3)
CommError (4)
StoreWarning
(5)
InternalErr (6)
CtrlReqErr (7)
DataTypeErr
(8)
StorePending
(9)

No

View Only

CEE

No

See OP [1..16].EXECSTS for


additional information.

Step

Output Execution
Code Descriptor

String

Maximum of Null
39 characters. String

No

View Only

CEE

No

See OP [1..16].EXECSTS for


additional information.

OP [1..16].
EXECSTS

Step

Output Execution
Status

Enumeration Ok (0)
Ok (0)
CSCOEXECST Bypass (1)
Info (2)
Warning (3)
Fail (4)
Error (5)
OkPaused (6)
BypassPaused
(7)
InfoPaused (8)
WarnPaused
(9)
FailPaused
(10)
ErrorPaused
(11)

No

View Only

CEE

No

OP [1..16].
EXPRPCODE

Step

Internal parameter
for system use only.

OP
Step output execution status
[1..16].EXECCODE,
parameters OP
OP [1..16].EXECDESC [1..16].EXECSTS, OP
[1..16].EXECCODE, and OP
[1..16].EXECDESC are
updated when the step is in
the SCMs current scope of
execution.

121

Specific to
Block(s)

Description

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

OP [1..16].
SRCEXPR

Step

Output Source
Expression

String

Maximum
Length: 255
characters

Null
String

Yes

Application
Developer

SR

No

OP [1..16].STATE

Step

Sequential Control Enumeration Edit (0)


Edit (0)
Module (SCM) Step CSCOPARTST Inactive (1)
Output State
ATE
Disabled (2)
Enabled (3)
Active (4)
ActiveComplt
(5)
ProcOutputs
(6)
ProcMessages
(7)
ProcMinWait
(8)

No

View Only

CEE

No

OP [1..16].TYPE

Step

Output Type

Yes

Application
Developer

CEE

OPBIAS

All RegCtl Blocks


except Fanout:
AutoMan, OvrdSel,
PID, PIDFF, PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Total Output Bias (in 64-Bit Real


Engineering Units) Number
OPBIAS is the sum
of two components:
a user-specified
fixed bias
(OPBIAS.FIX) and a
calculated floating
bias
(OPBIAS.FLOAT).

No

Operator

OPBIAS [1..8]

Fanout

Total Output Bias for 64-Bit Real


function blocks with Number
Multiple Outputs OPBIAS is the sum
of two components:
a user-specified
fixed bias (OPBIAS
[1..8].FIX) and a
calculated floating
bias (OPBIAS
[1..8].FLOAT).

No

Operator

Enumeration Null (0)


Null (0)
CSCOOPTYPE Set (1)
NotStored (2)

Related
Parameters

Notes

No

SCMOPT,
CONTROLREQ,
MODEREQ, OPREQ,
SPREQ, SPRATEREQ,
SPTVREQ

Null output type is valid only


if ControlModule.SCMOPT =
None. If
ControlModule.SCMOPT =
Fixed, then Control Requests
(CONTROLREQ) to the RegCtl
function block must use a set
output type, output requests
to the DevCtl function block,
and use a set of NotStored
output type.

CEE

No

OPBIAS.FIX,
OPBIAS.FLOAT,
OPBIAS.RATE

User may only store values


to this parameter if the mode
is manual or if containing
Control Module (CM) is
inactive. The following
occurs on a store to OPBIAS:
OPBIAS and OPBIAS.FIX
are both set to a new
value.
OPBIAS.FLOAT is set to zero.

CEE

No

OPBIAS.FIX,
OPBIAS.FLOAT,
OPBIAS.RATE

122

Parameter

Parameter

Specific to
Block(s)

Description

OPBIAS.FIX

All RegCtl Blocks


except Fanout:
AutoMan, OvrdSel,
PID, PIDFF, PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

Fixed Output Bias (in 64-Bit Real


Engineering Units) - Number
A user-specified bias
that is applied to the
function blocks
Calculated Variable
(CV).

0.0

Yes

Operator

CEE

No

OPBIAS,
OPBIAS.FLOAT,
OPBIAS.RATE

CV = OP + OPBIAS.FIX +
OPBIAS.FLOAT

OPBIAS [1..8].FIX Fanout

Fixed Output Bias (in 64-Bit Real


Engineering Units) - Number
A user specified bias
which is applied to
the function blocks
Calculated Variables
Outputs (CV [1..8]].

0.0

Yes

Operator

CEE

No

OPBIAS [1..8],
OPBIAS [1..8].FLOAT,
OPBIAS [1..8].RATE

OPBIAS.FLOAT

All RegCtl Blocks


except Fanout:
AutoMan, OvrdSel,
PID, PIDFF, PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Floating Output Bias 64-Bit Real


(in Engineering
Number
Units) - Used in
conjunction with
OPBIAS.RATE.

No

View Only

CEE

No

OPBIAS, OPBIAS.FIX, Floating bias is calculated as


OPBIAS.RATE
follows:
OPBIAS.FLOAT = CV(init) (CV(unbiased) + OPBIAS.FIX)
CV(init) = initialization value
received from secondary
CV(unbiased) = unbiased
calculated value
OPBIAS.FIX = fixed bias (user
specified)

OPBIAS [1..8].
FLOAT

Fanout

Floating Output Bias 64-Bit Real


(in Engineering
Number
Units) - Calculated
bias for each of
Fanout Blocks
output which is
applied to the
function blocks
Calculated Variables
Output (CV [1..8]].
OPBIAS [1..8].FLOAT
is used to ensure a
bumpless transition,
following
initialization or
mode change.

No

View Only

CEE

No

OPBIAS [1..8],
OPBIAS [1..8].FIX,
OPBIAS [1..8].RATE

OPBIAS.FLOAT(new value) =
OPBIAS.FLOAT(current value)
- (OPBIAS.RATE/ cycles/min)
where cycles per minute is
the number of function block
executions per minute.

123

Specific to
Block(s)

Description

OPBIAS.RATE

All RegCtl Blocks


except Fanout:
AutoMan, OvrdSel,
PID, PIDFF, PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

OPBIAS [1..8].
RATE

Data Type

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Output Bias Ramp 64-Bit Real


Rate (in Engineering Number
Units per Minute) Used in conjunction
with OPBIAS.FLOAT
to eliminate output
bumps when
initialization path is
done by the user.

NaN

Yes

Engineer

CEE

No

OPBIAS, OPBIAS.FIX, The Output Bias is the sum


OPBIAS.FLOAT
of two parts (OPBIAS.FIXED a fixed output bias, and
OPBIAS.FLOAT - a calculated
bias) and is generally used to
ensure a bumpless transfer
when the block initializes or
changes mode.

Fanout

Output Bias Ramp 64-Bit Real


Rate for function
Number
blocks with Multiple
Outputs - There is a
separate rate for
each output when
the initialization
path is broken by the
user.

NaN

Yes

Engineer

CEE

No

OPBIAS [1..8],
OPBIAS [1..8].FIX,
OPBIAS [1..8].FLOAT

OPCMD [0..2]

DevCtl

Output Command

Boolean

Off (0)
On (1)

Off (0)

No

Program

CEE

No

GOPREQ, OPREQ,
OPTYPE

OPDOMAP [0..3]
[1..3]

DevCtl

Output (OP) to
Boolean
Digital Output
Values (DO) Map of
Settable State
Assignments.

Off (0)
On (1)

Off (0)

Yes

Engineer

CEE

No

DO [1..3], GOP,
Illegal if NUMDOUTS = 0.
GOPFINAL, PO [1..3], OPDOMAP [2, x] is illegal, if
NUMDOUTS,
NUMSTATES = 2.
NUMSTATES, OP,
OPFINAL

OPEU

All RegCtl Blocks


Output Value (in
except Fanout:
Engineering Units)
AutoMan, OvrdSel,
PID, PIDFF, PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

No

Operator

CEE

Default
Connector:
Output

OP

64-Bit Real
Number

Range

Notes

If all the elements of OPCMD


are Off, the OPREQ will be
set to SAFEOP.
The priority of the OPCMD is
determined by SAFEOP.
If SAFEOP = S0, then
priority is 0, 1, 2.
If SAFEOP = S1, then
priority is 1, 0, 2.
If SAFEOP = S2, then
priority is 2, 0, 1.

124

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

OPEU [1..8]

Fanout

Output Values (in


Engineering Units)
for Function Blocks
with Multiple
Outputs - There is
one value per
output.

OPEUX

All RegCtl Blocks


OPEU Value and
except Fanout:
Status
AutoMan, OvrdSel,
PID, PIDFF, PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

OPEUX [1..8]

OPEXHIFL

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

64-Bit Real
Number

No

Operator

CEE

Default
Connector:
Output

OP [1..8]

Structure

No

View Only

CEE

No

OPEU

Fanout

OPEU Value and


Structure
Status for function
blocks with multiple
outputs.

No

View Only

CEE

No

OP [1..8], OPEU [1..8]

All RegCtl Blocks


except Fanout:
AutoMan, OvrdSel,
PID, PIDFF, PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Output (OP)
Boolean
Extended High Limit
Flag. Indicates if OP
is at its extended
high limit.

No

View Only

CEE

No

OPEXHILM

Off (0): OP is Off (0)


below its
extended high
limit.
On (1): OP is at
its extended
high limit.

Notes

OPEUX is a hidden
connection in Control Builder.
OPEUX is a two-part data
structure that contains:
OPEU (the output value in
engineering units) and a
status component. OPEUX
should be used when making
a cascade connection to a
secondary control block. The
OPEUX connection is
required in order for the
initialization path to be
established between the
primary and secondary
blocks.
This parameter will not
indicate any value on the
chart when the pin is
exposed, it shows ****.

125

Specific to
Block(s)

Description

Data Type

OPEXHIFL [1..8]

Fanout

Output (OP)
Boolean
Extended High Limit
Flag. Indicate if OP
[1..8] are at their
extended high limit.

OPEXHILM

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Off (0):
Off (0)
Corresponding
OP is below
its extended
high limit.
On (1):
Corresponding
OP is at its
extended high
limit.

No

View Only

CEE

No

OPEXHILM

All RegCtl Blocks: Output (OP)


64-Bit Real
AutoMan, Fanout, Extended High Limit Number
OvrdSel, PID, PIDFF, (in percentage)
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Greater than
OPLOLM

Yes

Engineer

CEE

No

OPEXHIFL

OPEXLOFL

All RegCtl Blocks:


AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Output (OP)
Boolean
Extended Low Limit
Flag. Indicates if OP
is at its extended
low limit.

Off (0): OP is Off (0)


above its
extended low
limit.
On (1): OP is at
its extended
low limit.

No

View Only

CEE

No

OPEXLOLM

OPEXLOFL [1..8]

Fanout

Output (OP)
Boolean
Extended Low Limit
Flag. Indicates if OP
[1..8] are at their
extended low limit.

Off (0):
Off (0)
Corresponding
OP is above its
extended low
limit.
On (1):
Corresponding
OP is at its
extended low
limit.

No

View Only

CEE

No

OPEXLOLM

106.9%

Notes

Only the Operator is


permitted to specify an
Output (OP) value that
exceeds the OPHILM value.
Even the operator is
prohibited from specifying
values greater than the
OPIXHILM, however.

126

Parameter

Parameter

Specific to
Block(s)

OPEXLOLM

OPFINAL

Description

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

All RegCtl Blocks: Output (OP)


64-Bit Real
AutoMan, Fanout, Extended Low Limit Number
OvrdSel, PID, PIDFF, (in percentage)
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Less than
OPHILM

-6.9%

Yes

Engineer

CEE

No

OPEXLOFL

DevCtl

Field Output State

String

Length: 12
characters

STATETEX No
T [4]

View Only

CEE

No

GOPFINAL, DO [1..3],
NUMDOUTS,
NUMSTATES,
NUMTRANS,
OPDOMAP [0..3]
[1..3], PO [1..3],
SEALOPT,
STATETEXT [0..6],
TATETIME [0..2]

OPFINAL is a String set equal


to STATETEXT (GOPFINAL).
Access is illegal if
NUMDOUTS = 0.
STATETEXT [6] [State2] is
illegal if NUMSTATES = 2.

AOC

Adjusted Output
Value

64-Bit Real
Number

No

View Only

CEE

No

OPFINAL
[0..numChans-1]

AOM

Adjusted Output
Value.

64-Bit Real
Number

No

View Only

CEE

No

OPHIALM.DB

All RegCtl Blocks


Output (OP) High
except Fanout:
Alarm Deadband
AutoMan, OvrdSel,
PID, PIDFF, PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

64-Bit Real
Number

Yes

Engineer/Ap CEE
plication
Developer

No

OP, OPHIALM.DBU,
OPHIALM.FL,
OPHIALM.PR,
OPHIALM.SV, ,
OPHIALM.TM,
OPHIALM.TP

See below.

0.0 to 100.0 if 0.0


alarm
deadband
units
(OPHILAM.DB
U) are Percent.
CVEULO to
CVEUHI if
alarm
deadband
units
(OPHIALM.DB
U) are
Engineering
Units.

Notes

Notes
The following rule is applied to OPHIALM.DB to prevent OPHI and OPLO alarm are both active at the
same time:
OPHIALM.DB <= (OPHIALM.TP - OPLOALM.TP)/2
(or PVLOALM.TP <= PVHIALM.TP - 2 PVLOALM.DB)
Individual alarm deadbands are not individually configurable. The ALMDB that is configured is
loaded to the block, then the block copies the ALMDB value to all the xxALM.DB of all analog
alarms on the block. This includes ALMDBU and ALMTM - thus, all analog alarms get the same
three values through a one-time configuration entering of the three values.
If desired, the individual alarm parameters (xxALM.DB, xxALM.DBU, and xxALM.TM) may be
modified after the block is loaded. The block load will always set all individual alarm parameters to
the three configured values.
When OPHIALM.DB is in Percent, the deadband units (OPHIALM.DBU) cannot be changed.

127

Specific to
Block(s)

Description

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

OPHIALM.DBU

All RegCtl Blocks


except Fanout:
AutoMan, OvrdSel,
PID, PIDFF, PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Output (OP) High


Alarm Deadband
Units - Indicates if
OPHILAM.DB is in
Percent or
Engineering Units.

Enumeration
ALMDBU

Percent (0)
EU (1)

Percent
(0)

Yes

Application
Developer

CEE

No

OP, OPHIALM.DB,
OPHIALM.FL,
OPHIALM.PR,
OPHIALM.SV,
OPHIALM.TM,
OPHIALM.TP

Individual alarm deadbands


are not individually
configurable. The ALMDB
that is configured is loaded
to the block, then the block
copies the ALMDB value to
all the xxALM.DB of all
analog alarms on the block.
This includes ALMDBU and
ALMTM - thus, all analog
alarms get the same three
values through a one-time
configuration entering of the
three values.
If desired, the individual
alarm parameters
(xxALM.DB, xxALM.DBU, and
xxALM.TM) may be modified
after the block is loaded.
The block load will always
set all individual alarm
parameters to the three
configured values.

OPHIALM.FL

All RegCtl Blocks


OP High Alarm Flag Boolean
except Fanout:
AutoMan, OvrdSel,
PID, PIDFF, PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Off (0) (not in


OP High
alarm)
On (1) (in Op
High alarm)

Off (0)

No

View Only

CEE

No

OP, OPHIALM.DB,
OPHIALM.DBU,
OPHIALM.PR,
OPHIALM.SV,
OPHIALM.TM,
OPHIALM.TP

OPHIALM.PR

All RegCtl Blocks


Output (OP) High
except Fanout:
Alarm Priority
AutoMan, OvrdSel,
PID, PIDFF, PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

None (0)
Journal (1)
Low (2)
High (3)
Urgent (4)

Low (2)

Yes

Engineer

CEE

No

OP, OPHIALM.DB,
OPHIALM.DBU,
OPHIALM.FL,
OPHIALM.SV,
OPHIALM.TM,
OPHIALM.TP

Enumeration
ALPRIOR

128

Parameter

Parameter

Specific to
Block(s)

Description

OPHIALM.SV

All RegCtl Blocks


Output (OP) High
except Fanout:
Alarm Severity
AutoMan, OvrdSel,
PID, PIDFF, PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

OPHIALM.TM

All RegCtl Blocks


except Fanout:
AutoMan, OvrdSel,
PID, PIDFF, PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

OPHIALM.TP

All RegCtl Blocks


Output (OP) High
except Fanout:
Alarm Trip Point (in
AutoMan, OvrdSel, Percent)
PID, PIDFF, PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Data Type

Range

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Yes

Engineer

CEE

No

OP, OPHIALM.DB,
OPHIALM.DBU,
OPHIALM.FL,
OPHIALM.PR,
OPHIALM.TM,
OPHIALM.TP

0 to 60

Yes

Engineer/Ap CEE
plication
Developer

No

OP, OPHIALM.DB,
OPHIALM.DBU,
OPHIALM.FL,
OPHIALM.PR,
OPHIALM.SV,
OPHIALM.TP

If OPHIALM.TM = 0, alarm
will be generated as soon as
OP exceeds the high trip
point.
Individual alarm deadbands
are not individually
configurable. The ALMDB
that is configured is loaded
to the block, then the block
copies the ALMDB value to
all the xxALM.DB of all
analog alarms on the block.
This includes ALMDBU and
ALMTM - thus, all analog
alarms get the same three
values through a one-time
configuration entering of the
three values.
If desired, the individual
alarm parameters
(xxALM.DB, xxALM.DBU, and
xxALM.TM) may be modified
after the block is loaded.
The block load will always
set all individual alarm
parameters to the three
configured values.

NaN, or
OPLOLM to
OPEXHILM

NaN

Yes

Engineer

No

OP, OPHIALM.DB,
OPHIALM.DBU,
OPHIALM.FL,
OPHIALM.PR,
OPHIALM.SV
OPHIALM.TM

If OPHIALM.TP = NaN, OP
high alarms are inhibited.
The following restriction is
applied to OPHIALM.TP to
prevent that OPHI and OPLO
alarm are both active at the
same time:
OPHIALM.DB <=
(OPHIALM.TP OPLOALM.TP)/2
(or OPHIALM.TP >=
OPLOALM.TP +
2 OPHIALM.DB)

16-Bit Integer 0 to 15

Output (OP) High


32-Bit
Alarm Filter Time (in Unsigned
seconds) - The
Integer
purpose of this
variable is to prevent
input spikes from
causing OP High
alarms. An alarm
will only be
generated if the OP
consistently exceeds
the high trip point
for more than the
configured alarm
filter time.

64-Bit Real
Number

CEE

Notes

129

Default

Specific to
Block(s)

Description

Data Type

OPHIFL

All RegCtl Blocks:


AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Output (OP) High


Boolean
Limit Flag - Indicates
if OP has reached
the high limit, as
specified by
OPHILM.

OPHIFL [1..8]

Fanout

Output (OP) High


Boolean
Limit Flag
Indicates if OP [1..8]
have reached the
high limit, as
specified by
OPHILM.

OPHILM

OPLOALM.DB

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Off (0): Output Off (0)


has not
reached the
high limit.
On (1): Output
has reached
the high limit.

No

View Only

CEE

No

OPHILM

Off (0): Output Off (0)


has not
reached the
high limit.
On (1): Output
has reached
the high limit.

No

View Only

CEE

No

OPHILM

All RegCtl Blocks: Output (OP) High


64-Bit Real
AutoMan, Fanout, Limit (in percentage) Number
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

NaN, or
OPLOLM to
OPEXHILM

Yes

Engineer

CEE

No

OPHIFL

All RegCtl Blocks


Output (OP) Low
except Fanout:
Alarm Deadband
AutoMan, OvrdSel,
PID, PIDFF, PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

0.0 to 100.0 if 0.0


alarm
deadband
units
(OPLOALM.DB
U) are Percent.
CVEULO to
CVEUHI if
alarm
deadband
units
(OPLOALM.DB
U) are EUs.

Yes

Engineer/Ap CEE
plication
Developer

No

OP, OPLOALM.DBU, See below.


OPLOALM.FL,
OPLOALM.PR,
OPLOALM.SV,
OPLOALM.TM,
OPLOALM.TP

64-Bit Real
Number

Range

Default

105.0%

Notes

Entering NaN disables limit


checking.
Only the operator is
permitted to specify an OP
value that exceeds the
OPHILM value. Programs
(SCM, etc.) can specify
output values up to the
OPHILM limit. If values
larger than this are
requested, then they are
clamped at the OPHILM
value.

Notes
The following restriction is applied to OPLOALM.DB to prevent that OPHI and OPLO alarm are both
active at the same time:
OPLOALM.DB <= (OPHIALM.TP - OPLOALM.TP)/2
Individual alarm deadbands are not individually configurable. The ALMDB that is configured is
loaded to the block, then the block copies the ALMDB value to all the xxALM.DB of all analog
alarms on the block. This includes ALMDBU and ALMTM - thus, all analog alarms get the same
three values through a one-time configuration entering of the three values.
If desired, the individual alarm parameters (xxALM.DB, xxALM.DBU, and xxALM.TM) may be
modified after the block is loaded. The block load will always set all individual alarm parameters to
the three configured values.
When the OPLOALM.DB is in Percent; the deadband units (OPLOALM.DBU) cannot be changed.

130

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

OPLOALM.DBU

All RegCtl Blocks


except Fanout:
AutoMan, OvrdSel,
PID, PIDFF, PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Output (OP) Low


Alarm Deadband
Units - Indicates if
OPLOALM.DB is in
Percent or
Engineering Units.

Enumeration
ALMDBU

Percent (0)
EU (1)

Percent
(0)

Yes

Application
Developer

CEE

No

OP, OPLOALM.DB,
OPLOALM.FL,
OPLOALM.PR,
OPLOALM.SV,
OPLOALM.TM,
OPLOALM.TP

Individual alarm deadbands


are not individually
configurable. The ALMDB
that is configured is loaded
to the block, then the block
copies the ALMDB value to
all the xxALM.DB of all
analog alarms on the block.
This includes ALMDBU and
ALMTM - thus, all analog
alarms get the same three
values through a one-time
configuration entering of the
three values.
If desired, the individual
alarm parameters
(xxALM.DB, xxALM.DBU, and
xxALM.TM) may be modified
after the block is loaded.
The block load will always
set all individual alarm
parameters to the three
configured values.

OPLOALM.FL

All RegCtl Blocks


Output (OP) Low
Alarm Flag
except Fanout:
AutoMan, OvrdSel,
PID, PIDFF, PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Boolean

Off (0): Not in Off (0)


OP Low alarm.
On (1): In OP
Low alarm.

No

View Only

CEE

No

OP, OPLOALM.DB,
OPLOALM.DBU,
OPLOALM.PR,
OPLOALM.SV,
OPLOALM.TM,
OPLOALM.TP

OPLOALM.PR

All RegCtl Blocks


Output (OP) Low
except Fanout:
Alarm Priority
AutoMan, OvrdSel,
PID, PIDFF, PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Enumeration
ALPRIOR

None (0)
Journal (1)
Low (2)
High (3)
Urgent (4)

Engineer Yes

CEE

No

OP, OPLOALM.DB,
OPLOALM.DBU,
OPLOALM.FL,
OPLOALM.SV,
OPLOALM.TM,
OPLOALM.TP

Low (2)

131

Specific to
Block(s)

Description

OPLOALM.SV

All RegCtl Blocks


Output (OP) Low
except Fanout:
Alarm Severity
AutoMan, OvrdSel,
PID, PIDFF, PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

OPLOALM.TM

All RegCtl Blocks


except Fanout:
AutoMan, OvrdSel,
PID, PIDFF, PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

OPLOALM.TP

All RegCtl Blocks


Output (OP) Low
except Fanout:
Alarm Trip Point (in
AutoMan, OvrdSel, percentage)
PID, PIDFF, PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Data Type

Range

16-Bit Integer 0 to 15

Output (OP) Low


32-Bit
Alarm Filter Time (in Unsigned
seconds) - The
Integer
purpose of this
variable is to prevent
input spikes from
causing OP Low
alarms. An alarm
will only be
generated if the OP
is consistently
below the low trip
point for more than
the configured alarm
filter time.

64-Bit Real
Number

0 to 60

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Yes

Engineer

CEE

No

OP, OPLOALM.DB,
OPLOALM.DBU,
OPLOALM.FL,
OPLOALM.PR,
OPLOALM.TM,
OPLOALM.TP

Yes

EngineerApp CEE
lication
Developer

No

OP, OPLOALM.DB,
OPLOALM.DBU,
OPLOALM.FL,
OPLOALM.PR,
OPLOALM.SV,
OPLOALM.TP

If OPLOALM.TM = 0, an
alarm will be generated as
soon as OP falls below the
low trip point.
Individual alarm deadbands
are not individually
configurable. The ALMDB
that is configured is loaded
to the block, then the block
copies the ALMDB value to
all the xxALM.DB of all
analog alarms on the block.
This includes ALMDBU and
ALMTM - thus, all analog
alarms get the same three
values through a one-time
configuration entering of the
three values.
If desired, the individual
alarm parameters
(xxALM.DB, xxALM.DBU, and
xxALM.TM) may be modified
after the block is loaded.
The block load will always
set all individual alarm
parameters to the three
configured values.

Yes

Engineer

No

OP, OPLOALM.DB,
OPLOALM.DBU,
OPLOALM.FL,
OPLOALM.PR,
OPLOALM.SV,
OPLOALM.TM,

If OPLOALM.TP = NaN, OP
low alarms are inhibited.
The following restriction is
applied to OPLOALM.TP to
prevent that OPHI and OPLO
alarm are both active at the
same time:
OPLOALM.DB <=
(OPHIALM.TP OPLOALM.TP)/2
(or OPLOALM.TP <=
OPHIALM.TP 2 OPLOALM.DB)

NaN, or
NaN
OPEXLOLM to
OPHILM

CEE

Notes

132

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

OPLOFL

All RegCtl Blocks


except Fanout:
AutoMan, OvrdSel,
PID, PIDFF, PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Output (OP) Low


Boolean
Limit Flag - Indicates
if OP has reached its
low limit, as
specified by
OPLOLM.

OPLOFL [1..8]

Fanout

Output (OP) Low


Boolean
Limit Flag - Indicates
if OP [1..8] have
reached its low limit,
as specified by
OPLOLM.

OPLOLM

OPMINCHG

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Off (0): Output Off (0)


has not
reached the
low limit.
On (1): Output
has reached
the low limit.

No

View Only

CEE

No

OPLOLM

Off (0): Output Off (0)


has not
reached the
low limit.
On (1): Output
has reached
the low limit.

No

View Only

CEE

No

OPLOLM

All RegCtl Blocks: Output (OP) Low


64-Bit Real
AutoMan, Fanout, Limit (in percentage) Number
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

NaN, or
-5.0%
OPEXLOLM to
OPHILM

Yes

Engineer

CEE

No

OPLOFL

Entering NaN disables limit


checking.

All RegCtl Blocks: Output (OP)


AutoMan, Fanout, Minimum Change
OvrdSel, PID, PIDFF, Limit (in Percent)
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

NaN, or a real 0.0%


number
greater than
or less than
zero.

Yes

Engineer

CEE

No

OP

Defines the minimum


amount that the output must
change before the function
blocks actually change the
OP. If this value is NaN, then
there is no minimum limit
set.
Entering NaN disables limit
checking.

64-Bit Real
Number

Range

Default

Notes

133

Specific to
Block(s)

Description

Data Type

OPREQ

All RegCtl Blocks:


AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

The requested OP
64-Bit Real
(Output) value. The Number
SCM CONTROLREQ
wants to change the
regulatory control
blocks output (OP).

OPEXLOLM to 0
OPEXHILM

DevCtl

The Output State


Requested

Length: 12
characters

String

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

No

Operator

CEE

No

SCMOPT,
CONTROLREQ,
LASTOPREQ,
OPTYPE,
LASTOPTYPE,
RESTARTOPT,
STARTOPT,
HOLDOPT, STOPOPT

OPREQ is illegal if
ControlModule.SCMOPT =
None.
While MODEATTR is
Operator, a pending OPREQ
can be terminated by the
operator setting it to NaN.

STATETEX No
T [0]

Other
Function
Block

CEE

No

GOP, GOPREQ,
HOLDOPT,
LASTOPREQ,
LASTOPTYPE,
MODEATTR,
NUMSTATES, OP,
OPTYPE,
RESTARTOPT,
SAFEOP, STARTOPT,
STATETEXT [0..6],
STOPOPT

OPREQ is a String set equal


to STATETEXT(GOPREQ).
If OPTYPE = Set, and
MODEATTR is Operator, the
Engineer may change
OPREQ.
STATETEXT [6] is illegal if
NUMSTATES = 2

Entering NaN disables limit


checking.

OPROCLM

All RegCtl Blocks: Output (OP) Rate of 64-Bit Real


AutoMan, Fanout, Change Limit (in
Number
OvrdSel, PID, PIDFF, Percent per minute)
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

NaN, or
NaN
Greater-than
or equal-to 0.1

Yes

Engineer

CEE

No

OPROCNEGFL,
OPROCPOSFL

OPROCNEGFL

All RegCtl Blocks


Output (OP)
except Fanout:
Negative Rate of
AutoMan, OvrdSel, Change Flag
PID, PIDFF, PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Off (0): OP
Off (0)
negative rate
of change is
above the
limit.
On (1): OP
negative rate
of change is
less-than or
equal-to the
limit.

No

View Only

CEE

No

OPROCLM

Boolean

134

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

Range

OPROCNEGFL
[1..8]

Fanout

Output (OP)
Negative Rate of
Change Flag

Boolean

OPROCPOSFL

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

Off (0): OP
Off (0)
negative rate
of change is
above the
limit.
On (1): OP
negative rate
of change is
below or
equal to the
the limit.

No

View Only

CEE

No

OPROCLM

This flag is set when the


Output rate of change
exceeds OPROCLM in the
negative direction

All RegCtl Blocks: Output (OP) Positive Boolean


AutoMan, Fanout, Rate of Change Flag
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Off (0): OP
Off (0)
positive rate
of change is
below the
limit.
On (1): OP
positive rate
of change is
above or equal
to the limit.

No

View Only

CEE

No

OPROCLM

OPROCPOSFL
[1..8]

Fanout

Off (0): OP
Off (0)
positive rate
of change is <
the limit.
On (1): OP
positive rate
of change is
>= the limit.

No

View Only

CEE

No

OPROCLM

OPSECDATA

All RegCtl Blocks: Internal parameter


AutoMan, Fanout, for system use only.
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

OPSECDATA [1..8] Fanout

Output (OP) Positive Boolean


Rate of Change Flag

Default

This flag is set when the


Output rate of change
exceeds OPROCLM in the
positive direction.

Internal parameter
for system use only.

135

Specific to
Block(s)

Description

Data Type

Range

OPSECDATA.
ARWSTS

All RegCtl Blocks:


AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Integer

View Only

OPSECDATA.
EUHI

All RegCtl Blocks:


AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Real

NaN

View Only

OPSECDATA.
EULO

All RegCtl Blocks:


AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Real

NaN

View Only

OPSECDATA.
INITREQ

All RegCtl Blocks:


AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Boolean

Off (0)

View Only

Off (0)
On (1)

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

136

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

Range

OPSECDATA.
INITVAL

All RegCtl Blocks:


AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Real

NaN

View Only

OPSECDATA.
ONESHOT

All RegCtl Blocks:


AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Integer

View Only

OPSECDATA.
ORFBVA

All RegCtl Blocks:


AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

64-Bit Real
Number

NaN

View Only

OPSECDATA.
OROFFS

All RegCtl Blocks:


AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Boolean

Off (0)

View Only

OPSOURCE

AOC, PWM
Channel

Output Source
Connector

OPSRC [1..16]
[1..6]

Step

Internal parameter
for system use only.

Off (0)
On (1)

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

Application
Developer

137

Specific to
Block(s)

Description

Data Type

OPTYPE

DevCtl,
All RegCtl Blocks:
AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Sequential Control Enumeration


Module (SCM)
OPTYPE
Control Output
Request Type Option

OPX

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

No

View Only

CEE

No

RegCtl only:
SCMOPT,
CONTROLREQ,
SCMSTATE,
SCMASTEP [1..10],
ASTEPID,
LASTOPTYPE, OP
[1..16].TYPE
DevCtl only:
HOLDOPT,
LASTOPTYPE,
OPREQ,
RESTARTOPT,
STARTOPT, STOPOPT

All RegCtl Blocks: Output (OP) Value in Structure


AutoMan, Fanout, Percent and Status.
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

No

View Only

CEE

No

OPEU

OPX [1..8]

Fanout

Output (OP) Value


and Status.

Structure

No

View Only

CEE

No

OPEU

ORBYPASSFL
[1..4]

OvrdSel

Override Bypass
Flags Indicates
which Override
Selector inputs (if
any) should be
bypassed.

Boolean

Off (0): Input is Off (0)


not bypassed.
On (1): Input is
bypassed.

Yes

Engineer

CEE

No

ORBYPPERM

Ovrdsel

Bypass Enable

Boolean

Off (0)
On (1)

Yes

Engineer/Ap CEE
plications
Developer

No

Null (0)
Null (0)
Set (1)
NotStored (2)
Default (3)

Off (0)

Notes

OPX is a two-part data


structure that contains: OP
(the output value in percent)
and a status component.
OPX can be used when
making a connection to an
AOC block. The OPX
connection is required in
order for the initialization
path to be established
between the Regulatory
Control (RegCtl) block and
the AOC block.
OPEUX can also be used in
the same capacity as the
OPX parameter.
This parameter will not
indicate any value (it shows
****) on the chart when the
pin is exposed.

138

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

Range

Default

ORDER

DevCtl

Execution Order
within containing
Control Module

Integer

0 to 65535

ORDERINCEE

CM, SCM, IOM

Order of execution of 16-Bit Integer 0 to 32,767


a container block
relative to other
container blocks
within the same
cycle of the CEE.

ORDERINCM

All basic function


blocks

Execution order of a 32-Bit Integer


component block
relative to other
component blocks
within a Control
Module (CM)
function block.

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

A multiple Yes
of 10,
establish
ed by
Control
Builder
when the
block is
created.

Point Build

CEE

No

10

Yes

Application
Developer

CEE

No

PHASE, PERIOD,
ORDERINCM

Determines the relative


execution order of container
blocks when they execute
within the same cycle. Block
with lower value execute
first. If user assigns the
same value to different
blocks, the CEE assigns a
distinct and repeatable
execution order (based on
the independent object
code), but does not change
the value of ORDERINCEE. In
this case, the user cannot
readily determine the order
of execution of any two
container blocks.
Note that ORDERINCEE can
only be changed through
block load.

1 to 32,767
10
A linearly
increasing
multiple of 10
starting at 10,
the actual
value
assigned by
Control
Builder
according to
the order of
insertion into
a CM function
block during
configuration.

Yes

Application
Developer

SR

No

ORDERINCEE,
PHASE, PERIOD

Determines the relative


execution order of
component blocks within a
Control Module (CM)
function block. In a given
CM, a block with a lower
value for ORDERINCM
executes before any block
with a higher value. If the
same value is assigned to
multiple blocks, the Control
Builder assigns a distinct and
repeatable execution order
(based on the dependent
object code), but does not
change the value of
ORDERINCM.
Note that ORDERINCM does
not apply to CM, IOM, SCM,
or SCM component blocks.

Other Notes
Enter a number to specify the desired
execution order for the block. For individual
function blocks, execution order specifies
the disignated order of execution of each
block relative to the other blocks in the
same Control Module. The block with the
lowest number in this parameter is
executed first, followed by the next lowest
and so on.

139

Specific to
Block(s)

Description

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

ORED

NooN

Ored output value

Boolean

Off (0)
On (1)

Off (0)

No

View Only

CEE

No

ORFBSTSSRC

RegCalc

Override feedback
status (ORFBSTS)
source selector.

Enumeration

X1 to C8STS
(0 - 27)

X1 (0)

Yes

Engineer

CEE

No

ORFBVALSRC

RegCalc

Override feedback
value source
selector

Enumeration X1 to C8STS
REGCALCSELE (0 - 27)
CTOR

X1 (0)

Yes

Engineer

CEE

No

OROFFSET

OvrdSel

Override Offset

Boolean

Off (0)
On (1)

Off (0)

Yes

Engineer/Ap CEE
plication
Developer

No

OROPT

OvrdSel

Override Option Indicates how the


nonselected inputs
to the Override
Selector block
should track the
selected input.

Boolean

Off (0):
Off (0)
Nonselected
inputs do not
use override
feedback
data. The
block acts as a
simple
high/low
selector.
On (1):
Nonselected
inputs should
use override
feedback
data.

Yes

Engineer/Ap CEE
plications
Developer

No

OUT

And, Checkbad,
Current output value Boolean
Delay, EQ, FTrig, GE,
GT, LE, LT,
Maxpulse,
Minpulse, Mux,
Nand, NE, Nor, Not,
Offdelay, Ondelay,
Or, Pulse, Qor, RTrig,
Sel, Trig,
Watchdog, Xor

Off (0)
On (1)

Off (0)

No

View Only

CEE

No

NaN

No

View Only

CEE

No

No

View Only

CEE

No

Limit, Muxreal,
Current output value 64-Bit Real
Max, Min, SelReal
Number
ROL, ROR, SHL,
SHR

Current output value 16-Bit Integer 16-Bit Integer 0.0

Related
Parameters

Notes

OROPT

This flag applies only to


upstream PIDs. It indicates if
the PID should apply a
calculated offset to the
override feedback value.

140

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

OUT [0..12]

Genlin

Output Coordinates 64-Bit Real


0 to 12 - These
Number
Parameters define
the output value at
the respective
coordinate for the
General
Linearization
function block.

Any Real
Number, not
NaN.

Yes

Engineer

CEE

No

IN [0..12], NUMSEGS

OUT.BOOLEAN

TypeConvert

Boolean Output
Value

Off (0)
On (1)

Off (0)

No

View Only

CEE

No

OUT.ENUM

TypeConvert

Enumerated Output Enumeration


Value

ENUM0

No

View Only

CEE

No

OUT.FLOAT32

TypeConvert

32-Bit Floating Point Real


Output Value

NaN

No

View Only

CEE

No

OUT.FLOAT64

TypeConvert

64-Bit Floating Point Real


Output Value

NaN

No

View Only

CEE

No

OUT.INT8

TypeConvert

8-Bit Integer Output 8-Bit Integer


Value

No

View Only

CEE

No

OUT.INT16

TypeConvert

16-Bit Integer
Output Value

16-Bit Integer -32768 to


32767

No

View Only

CEE

No

OUT.INT32

TypeConvert

32-Bit Integer
Output Value

32-Bit Integer -2147483648


to
2147483647

No

View Only

CEE

No

OUT.SDENUM

TypeConvert

Self-defining
SDENUM
Enumeration Output

12 character SDENUM No
string
0
corresponding
to ordinal
value.

ViewOnly

OUT.UINT16

TypeConvert

16-Bit Unsigned
Integer
Integer Output Value

0 to 65535

No

View Only

CEE

No

OUT.UINT32

TypeConvert

32-Bit Unsigned
Integer
Integer Output Value

0 to
4294967295

No

View Only

CEE

No

OUTSENSE

Pulse Input w/ Fast Output Safe State Boolean


Cutoff IOC
Selects safe state of
the associated
Output. When
target is reached,
the Output is set to
this state.

Off (0)
On (1)

Off (0)

Yes

Application
Developer

CEE

No

Boolean

Range

-128 to 127

Default

Notes

No

Affects Channels 6-7 only.

141

Specific to
Block(s)

Description

OUTSENSE [6..7]

Pulse Input IOM

OVERRANGE

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Output Safe State Boolean


Selects safe state of
the associated
Output. When
target is reached,
the Output is set to
this state.

Off (0)
On (1)

Off (0)

Yes

Application
Developer

CEE

No

AIC

Over Range Alarm Boolean


Indicator - Indicates
the input value is
above the valid
hardware input
range of the
channel.
Overrange and
Underrange
parameters are not
supported for the
1794 FLEX I/O
Analog Input
Module
(1794-IE8/B). When
selected, Parameter
ID error Err2088 will
appear.

Input is not in
an over-range
state (0)
Input is in an
over-range
state (1)

No

View Only

CEE

UNDERRANGE

OVERRANGE
[0..numChans-1]

AIM

Over Range Alarm Boolean


Indicator - Indicates
the input value is
above the valid
hardware input
range of the
channel.

Input is not in
an over-range
state (0)
Input is in an
over-range
state (1)

No

View Only

CEE

UNDERRANGE
[0..numChans-1]

P[1..6]

Auxcalc

Process Input Values 64-Bit Real


1 through 6.
Number

NaN

No

View Only

CEE

Yes, Input

P1

DataAcq,
Process Input Value 64-Bit Real
Deadtime, Totalizer, #1 - The current
Number
Genln, LeadLag.
value of the process
input to a Data
Acquisition function
block.

NaN

No

View Only

CEE

No

EqA

Yes

Engineer

CEE

Pulse Input Totalizer PV Equation Type Enumeration


Defines the equation PVEQN
(EqA, EqB, ...) to be
used with a given
function block.

0 EqA
1 EqB
2 EqC
3 EqD
4 EqE
5 - EqF

Related
Parameters

Notes
Affects Channels 6-7 only.

P1STS

142

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

P1CLAMPOPT

DataAcq

Process Input Value Enumeration


#1 (P1) Clamping
ENABLE
Option - Defines
whether P1
clamping is used for
this function block.
If P1CLAMPOPT =
Clamp, and the
Process Variable (PV)
is beyond its limits
(PVEXLOLM or
PVEXHILM), then PV
is set equal to the
limit that was
violated; PVSTS is
set to Uncertain.

Yes

Engineer

CEE

No

P1EU

DataAcq

P1EU value

P1FILTINIT

DataAcq

Process Input Value Boolean


#1 (P1) Filter
Initialization
Request Flag - Used
to reset the filtered
P1 value.

Off (0):
Off (0)
Initialization is
not requested.
On (1):
Initialization is
requested.

No

Other
Function
Block

CEE

No

If the flag is set, the function


block will set the filtered P1
value to the current P1 value.

P1FILTTIME

DataAcq

Process Input Value 64-Bit Real


#1 (P1) Filter Time (in Number
minutes)

0.0 to 60.0
minutes

0.0

Yes

Engineer

CEE

No

The default reading, 0.0,


means that no filtering will
be done.

P1STS

DataAcq,
Deadtime, Totalizer,
Genlin, Leadlag,
Pulse Input Totalizer

Status of the
Enumeration
Process Input #1 PVVALSTS
Indicates the current
status of P1.

Bad (0): The


P1 value is
bad (i.e.,
NaN).
Uncertn (1):
The status of
the value is
uncertain.
Normal (2):
The P1 value
is good.
Manual (3):
The P1 value
was manually
stored.

Bad (0)
Pulse
Input
Totalizer
only:
Normal
(2)

No

View Only

CEE

No

P1

P2

Deadtime

Process Input Value Real Number


#2

NaN

No

View Only

CEE

No

P2STS

Disable (0): Do Disable


not clamp the (0)
Process
Variable (PV)
value.
Enable (1):
Clamp the
Process
Variable (PV)
to its high or
low limit.

Real

NaN

Related
Parameters

Notes

View Only

143

Specific to
Block(s)

Description

Data Type

Range

P2STS

Deadtime

Status of Process
Input #2

Enumeration
PVVALSTS

PATH

REQFLAGARRAY,
REQNUMARRAY,
REQTEXTARRAY

PAUSEFL

SCM

PCMCOMMAND CPM

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Bad (0):
Normal
(ORD.0)The
(2)
value is bad
and has been
replaced with
NaN.
Uncertn (1):
(ORD.1)The
status of the
value is
uncertain.
Normal (2):
(ORD.2)The
value is good.
Manual (3):
(ORD.3)The
value was
manually
stored.

No

View Only

CEE

No

P2

Path to the target


String
device when the
target device is on
ControlNet. Path to
the DHRIO module
when the target
device is on DH+.
The path is specified
as a
comma-separated
string of path
segments.

Maximum of Null
40 characters String

Yes

Application
Developer

CEE

No

Pause Flag

Off (0)
On (1)

CEE

No

Boolean

Default

Off (0)

Command parameter Enumeration None (0)


None (0)
for changing
PCMCOMMA Shutdown (1)
PCMSTATE
ND

Notes

View Only
No

Engineer

PCMSTATE

Shutdown can be
commanded when the
CEESTATE is IDLE, which
takes the CPM to the
PIREADY (RDY) state. No
other value of PCMSTATE
can be commanded.
Note that in the future the
name of this parameter will
be changed to
CPMCOMMAND.

144

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

PCMSTATE

CPM

Current state of
CPM block.

Enumeration OFFNET (0)


of PCMSTATE TESTING (1)
BOOTING (2)
ALIVE (3)
LOADING (4)
OK (5)
FAILED (6)
PIREADY (7)
BACKUP (8)
NOTLOADED
(9)
NOCEE (10)
CEEIDLE (11)
CEERUN (12)
CEEMIX (13)

OK (5)

No

View Only

CEE

No

PCMCOMMAND

Note that in the future the


name of this parameter will
be changed to CPMSTATE.

PDELAYDIRCHG

Pulse Length
Control, Pulse
Count Control

Delay (in seconds) 64-Bit Real


before Pulse Output Number
begins to react.

Yes

Engineer

CEE

No

PERIOD

CM, IOM, SCM

Execution Period Enumeration See below.


DEFAULT Yes
Engineer
CEE
Specify an
of PERIOD
execution/processin
g period (or scan
Range
rate) of a CM or
IOM
only:
CEE
Configurable
Valid Range,
Valid Range,
SCM in milliseconds
5 TO 2000 ms: Range:
50 ms CEE
5 ms CEE
(ms). The Execution
5
TO
2000
ms:
50
to
2000
ms:
5 to 200 ms:
Period is the amount
of time between two DEFAULT(0)
DEFAULT(0)
DEFAULT(0)*
DEFAULT(0)*
consecutive
5ms(1),
5ms(1),
50ms(4)
5ms(1)
executions of the
10ms(2)
10ms(2)
100ms(5)
10ms(2)
block. For example,
20ms(3)
20ms(3)
200ms(6)
20ms(3)
if the Execution
50ms(4)
50ms(4)
500ms(7)
50ms(4)
Period of a CM is
100ms(5)
100ms(5)
1000ms(8)
100ms(5)
500 ms, then the
200ms(6)
200ms(6)
2000ms(9)
200ms(6)
block will run twice
500ms(7)
500ms(7)
per second. The
1000ms(8)
1000ms(8)
valid values and
2000ms(9)
2000ms(9)
function of the
*DEFAULT(0) is converted to an actual value upon load:
Default value for
PERIOD are different Converted to 1000 ms for the 50 ms CEE
Converted to 200 ms for the 5 ms CEE
for the 50 and 5 ms
CEE personalities as
described in the
Notes section.

No

Greater-than 0.0
or equal-to 0.0
and a multiple
of the
containing
Control
Module
PERIOD.

Pulse Delay after Direction


Change specifies (in
seconds) the delay time for
starting a pulse (on PORAISE,
POLOWER, and PO outputs)
after a change in direction
(PODIR output).
PHASE,
ORDERINCEE,
ORDERINCM

Determines execution period


for a container block and its
component blocks. Units are
in milliseconds. Can be
changed while the container
block is Inactive without
requiring reload.

145

Specific to
Block(s)

Description

PHASE

CM, IOM, SCM

PI[0..2]

Data Type

Range

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

Determines the set 16-Bit Integer 0 to (PERIOD 0


of cycles in which a
ms / 50 ms) - 1
container block
executes.

Yes

Engineer

CEE

No

ORDERINCM,
ORDERINCEE,
PERIOD,
CPUCYCLEAVG[0..39]

The combination of PHASE


and PERIOD determine the
set of cycles in which a
container block executes.

DevCtl

Permissive Interloks Boolean

On (1)

No

Other
Function
Block (see
Notes)

CEE

No

BYPASS, GOP,
NUMDOUTS,
NUMSTATES, OP

Engineer can change only


when the function block is
InActive or Box is idle.
Illegal if NUMDOUTS = 0.
PI[2] is illegal if NUMSTATES
= 2.
Permissives are ignored if
BYPASS is set On.

PL

Pulse Input IOC

Pulse Length Value 64-Bit Real


Engineering Units
Number
value corresponding
to the measured
pulse length.

NaN

No

View Only

CEE

No

PLSTS

PL = C3 * (pulse / period
length in microseconds)

PL[0..5]

Pulse Input IOM

Pulse Length Value 64-Bit Real


Engineering Units
Number
value corresponding
to the measured
pulse length. If
pulses stop
accumulating the
last non-zero value
will be reported.

NaN

No

View Only

CEE

No

PLSTS

Pulse Input IOC

Pulse Length Value


Status

Enumeration

Bad (0): Bad Off


Status is set
during loss of
communicatio
n, IOC or IOM
function block
is inactive.
Uncertn (1):
Normal (2):
Associated
data is valid.
Manual (3):

No

View Only

CEE

No

PL

PO

Pulse Length
Control, Pulse
Count Control

Pulse Output for


both Raise and
Lower pulses.

Boolean

Off (0)
On (1)

No

View Only

CEE

No

PORAISE, POLOWER, This is an output parameter


PODIR.
which produces pulses on
either a +PULSETIME or
PULSETIME value.

PO[1..3]

DevCtl

Pulsed Output
Values

Structure

No

View Only

CEE

No

DO[1..3], GOPFINAL, Only valid if NUMDOUTS


NUMDOUTS,
allows the respective output.
OPDOMAP[0..3][1..3],
OPFINAL,
PULSEWIDTH

Off (0)
On (1)

Default

Off (0)

For Pulse Input IOM


(Channels 0-5 only),
PL in EU = C3 * Timer Latch
Value in microseconds.

146

Parameter

Parameter

Specific to
Block(s)

Description

POCONNECTED
[1..3]

DevCtl

PODIR

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Pulse Connection
Boolean
Flag - Whenever the
respective PO(1..3) is
connected to a
DOC.ONPULSE or
DOC.OFFPULSE, the
parameter
POCONNECTED(1..3)
must be set to On.
This allows the
Device Control
function block to
know which outputs
are configured for
pulsing.
POCONNECTED[ ]
may not be
configured on the
form until at least
one PO[ ] parameter
is exposed on the
block.

Off (0)
On (1)

Off (0)

Yes

Operator

CEE

No

PULSEWIDTH,
PO[1..3]

Pulse Length
Control, Pulse
Count Control

Indicates direction Boolean


for Pulse Output:
Off-Lower, On-Raise.

Off (0)
On (1)

Off (0)

No

View Only

CEE

No

PORAISE, POLOWER,
PO.

POLOWER

Pulse Length
Control, Pulse
Count Control

Pulse Output for


Lower pulses.

Off (0)
On (1)

Off (0)

No

View Only

CEE

No

PORAISE, PO, PODIR This is an output parameter


which produces pulses on a
PULSETIME value.

POPERIOD

Pulse Count Control Period used for the 64-Bit Real


pulses generated (in Number
seconds).

Greater-than 0.010
0.0. Only
values that
are multiples
of two times
the FBs
execution
period are
valid, other
values are
clamped to
the greatest
multiple of
two times the
function
blocks
execution
period less
than the
entered value.

Yes

Engineer

CEE

No

Boolean

Notes

147

Specific to
Block(s)

Description

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

PORAISE

Pulse Length
Control, Pulse
Count Control

Pulse Output for


Raise pulses.

Boolean

Off (0)
On (1)

Off (0)

No

View Only

CEE

No

POLOWER, PO,
PODIR

This is an output parameter


which produces pulses on a
+PULSETIME value.

PREVISION

RM

Platform Revision. 8-Bit


Identifies the minor Unsigned
revision of the RM. Integer

No

View Only
Not Loaded
Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform
(through
Control
Builder or
Server).

No

PREVLOADSTAT

CM, SCM

Previous container
block load state.

No

View Only

CEE

No

LOADSTATE

This parameter captures the


previous value of
LOADSTATE during the
container block load process.
This information is useful in
debugging in the event that a
load failure is encountered
by the container block.

PROCESSED

Handler, Step,
Transition

Component has
Boolean
been processed flag.

No

View Only

CEE

No

0 to 255

Enumeration LOADFAILED
of LOADSTATE (0)
UNLOADED
(1)
LOADINGPRO
G (2)
LOADINGCMP
TYPES (3)
CMLOADINGT
BR (4)
LOADINGCON
FG (5)
LOADINGCON
N (6)
READY (7)
Off (0)
On (1)

Off (0)

An SCM components
Processed flag is set if it has
been included in the SCMs
execution thread. All
components processed flags
reset only when the SCM
STATE transitions to
Checking (either by a Reset
command or Check Handlers
Invoke Transition).

148

Parameter

Parameter

Specific to
Block(s)

Description

PRODCODE

RM

PRODCODEA

PRODTYPE

Data Type

Range

Default

Config
Load

Access
Lock

Product Code.
16-Bit
Identification of RM Unsigned
within product type Integer
(per ASA
specification).

0 to 65535

No

View Only
Not Loaded
Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform
(through
Control
Builder or
Server).

No

Handler, Step,
Transition

Module Product
Code. For each
module in the host
chassis, factory
assigned product
code

0 to 65535

No

View Only

CEE

No

All IOM Function


Blocks

IO Module Product 32-Bit Integer


Type The numeric
representation of a
high level
classification of
module type; see
default values.

10 for
Yes
Analog
Input/Out
put
Modules,
including
Thermoco
uple and
RTD.
7 for
Digital
Input/Out
put
Modules
12 for
Serial
Interface
Module
109 for
Pulse
Input
Module

Application
Developer

CEE

No

RM

Product Type.
16-Bit
Identification of
Unsigned
general RM type (per Integer
ASA specification).

View Only
Not Loaded
Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform.

16-Bit
Unsigned
Integer [20]

0 to 65535

No

Residence

Active
Connector

Related
Parameters

Notes

IOMTYPE

Although loaded, this


parameter is not exposed on
any configuration form.

No

149

Specific to
Block(s)

Description

Data Type

Range

Default

Config
Load

Access
Lock

PRODTYPEA

RM

Module Product
Type. For each
module in the host
chassis, factory
assigned product
type.

16-Bit
Unsigned
Integer [20]

0 to 65535

No

View Only
Not Loaded
Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform.

PROFILEDESC
RampSoak
[1..NUMPROFILES
]

Profile Descriptor

String

15 Characters Profile<#>
where
<#> is the
number of
profile.

PROFILEID

RampSoak

Profile ID

Integer

PROGCMD

RM

Program Command
Recognition

Enumeration

PROGCMDRECOG RM

Program Command Enumeration


Recognition.
Configurable option
regarding
Redundancy Module
recognition of user
program commands

PROGPACKET[0.. SCM, CM
2]

Internal parameter
for system use only.

Engineer

Residence

Active
Connector
No

CEE

View Only

Disabled (0)
Enabled (1)

Disabled No
(0)

Operator
Not Loaded
Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform.

No

Disabled (0)
Enabled (1)

Disabled No
(0)

View Only
Not Loaded
Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform.

No

Related
Parameters

Notes

150

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

PSTS[1..6]

Auxcalc

Status of PV Input Enumeration


Values 1 through 6 PVVALSTS
The current value
status of up to six PV
inputs to an
Auxiliary function
block.

PULSECMD

PosProp,
PidPosProp

Pulse Command Enumeration


Indicates the current PULSECMD
pulse command.

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Bad (0):The
Bad (0)
value is bad
and has been
replaced with
NaN.
Uncertn
(1):The status
of the value is
uncertain.
Normal
(2):The value
is good.
Manual
(3):The value
was manually
stored.

No

View Only

CEE

No

P[1..6]

Idle (0):
Output is not
being affected
by
PULSECMD.
Lower
(1):Output is
being
lowered.
Raise
(2):Output is
being raised.

No

View Only

CEE

No

Notes

151

Specific to
Block(s)

PULSEMODE

Pulse Input IOC,


Pulse Length
Enumeration
Pulse Input w/ Fast Measurement Mode
Cutoff IOC
Selects the portion
of pulse whose time
is measured.

PULSEMODE[0..5] Pulse Input IOM

Description

Data Type

Pulse Length
Enumeration
Measurement Mode
Selects the portion
of pulse whose time
is measured.

Range

Default

PulseHigh (0)
PulseLow (1)
Period (2)

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

PulseHigh Yes
(0)

Application
Developer

CEE

No

Period mode means the


Timer and Timer Latch
measures the period of the
input. That is, the time
elapsed between two
consecutive Off-to-On
transitions is recorded.
PulseHigh means the Timer
and Timer Latch measure the
high pulse width of the
input i.e. the time elapsed
between an initial Off-to-On
transition and a later
On-to-Off transition is
recorded.
Pulse Low means the Time
Measure Mode is Pulse Low.
The Timer and Timer Latch
measure the low pulse
width of t he input i.e. the
time elapsed between an
initial On-to-Off transition
and a later Off-to-On
transition is recorded.

PulseHigh Yes
PulseHigh
(0)
(0):Provides
the elapsed
time between
an Off-to-On
transition and
the next
On-to-Off
transition.
PulseLow
(1):Provides
the elapsed
time between
an On-to-Off
transition and
the next
Off-to-On
transition.
Period
(2):Provides
the elapsed
time between
two
consecutive
Of-to-On
transitions.

Application
Developer

CEE

No

Affects channels 0 to 5 only.

152

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

Range

PULSETIME

Pulse Length
Control, Pulse
Count Control,
PosProp,
PidPosProp.

Pulse Time
requested (in
seconds)

64-Bit Real
Number

PULSEWIDTH

NooN

Pulsewidth in
seconds

32-Bit Integer 0 to 8000


seconds

Pulse, Maxpulse,
Minpulse

Pulsewidth in
Seconds

Integer

PULSEWIDTH[1..3 DevCtl
]

Output Pulsewidth

64-Bit Real
Number

PV

DataAcq

Process Variable 64-Bit Real


Contains the current Number
value of the PV, after
it has been selected
from one of the
following sources: a
field device, another
function block, an
operator, or a
program.

Flag

Actual State String (Future:


Indicates the current Enumeration)
state of the Flag
function block.

Numeric

Timer

Default

Config
Load

Access
Lock

Residence

Active
Connector

No

View Only

CEE

Yes

5 seconds Yes

Engineer

CEE

No

0 to 8000
seconds

2 seconds Yes

Engineer

CEE

No

0.000 to
60.000
seconds

1.0

Yes

Engineer

CEE

No

DO[1..3],
NUMDOUTS

Access is illegal if the index


is greater-than NUMDOUTS.
Resolution may be entered in
.001 seconds (1 mSec), but is
dependent upon the
connected DO function block
execution rate.

NaN

No

Operator

CEE

No

PVSRCOPT,
PVSOURCE.

A PV change by an operator
requires that PVSRCOPT =
All, and PVSOURCE = Man.
A PV change by a program
requires that PVSRCOPT =
All, and PVSOURCE = Sub.

STATETEXT[0]: STATETEX No
PVFL = OFF
T[0]
STATETEXT[1]:
PVFL = ON

Defined by
ACCLOCK

CEE

No

STATETEXT[0..1],
PVFL

Actual State Real number


Indicates the current
state of the Numeric
function block.

PVLOLM to
PVHILM

No

Defined by
ACCLOCK

CEE

No

PVLOLM, PVHILM

For out of range values


stored by people (Operator,
Engineer, etc.), an error is
returned.
For out of range values
stored by other function
blocks or programs, the value
is clamped to the limit that is
exceeded and then stored to
PV.

Elapsed Time
Integer
Indicates the current
elapsed time value
of the Timer function
block.

0 to
0
2,147,483,647
(2^31 1)

No

View Only

CEE

No

RV, SO, SP,


TIMEBASE

Units are set by TIMEBASE.

NaN

Related
Parameters

Notes
This parameter is a structure,
the main value of which is
the Pulse Time requested, in
seconds. This parameter
usually gets its input from
the PosProp function block

153

Specific to
Block(s)

Description

PV (cont.)

DevCtl

Current Active State String

AIC

Input Process Value Real Number

PV[0..7]

Data Type

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

STATETEX No
T[0]

View Only,
Operator,
Other
Function
Block (see
Notes)

CEE

No

BADPVALM.FL,
BADPVALM.PR,
BADPVALM.SV,
CMDDISALM.FL,
CMDDISALM.PR,
CMDDISALM.SV,
CMDDISALM.TM[0..
2], CMDFALALM.FL,
CMDFALALM.PR,
CMDFALALM.SV,
CMDFALALM.TM[0..
2], DIPVMAP[0..15],
GPV, GPVAUTO,
NUMDINPTS,
NUMSTATES,
PVAUTO, PVSOURCE,
PVSRCOPT,
STATETEXT[0..6],
UNCMDALM.FL,
UNCMDALM.PR,
UNCMDALM.SV.

Access is illegal if
NUMDINPTS = 0.
PV is a String set equal to
STATETEXT(GPV).
Access lock is View Only if
PVSOURCE = AUTO or
TRACK or PVSRCOPT is
ONLYAUTO.
Access lock is Operator if
PVSOURCE = MAN.
Access lock is Other Function
Block if PVSOURCE = SUB.
STATETEXT[6] [State2] is
illegal if NUMSTATES = 2.

No

View Only

CEE

No

For AIC: PVSTS,


PVVALSTS,
HIGHENG[0..numCha
ns-1],
LOWENG[0..numCha
ns-1]

PID, PIDFF, PosProp Process Variable (in 64-Bit Real


Engineering Units) Number

NaN

No

View Only

CEE

Default
Connector:
Input

PVSTS, PVVALSTS

Totalizer, Pulse
Input Totalizer,
Deadtime, LeadLag,
Genlin, Auxcalc,
RampSoak

Function Block
64-Bit Real
Output - The
Number
calculated output of
an Auxiliary function
block.

NaN

No

View Only

CEE

No

Pulse Input IOC,


Frequency/Rate
64-Bit Real
Pulse Input w/ Fast Value Engineering Number
Cutoff IOC
Units value
corresponding to the
rate of pulses.

NaN

No

View Only

CEE

No

PVSTS

Pulse Input IOM

NaN

No

ViewOnly

CEE

No

PVSTS, PVVALSTS

Frequency/Rate
64-Bit Real
Value Engineering Number
Units value
corresponding to the
rate of pulses.

Range

Default

Length: 12
characters

Config
Load

PV = C1 / C2 * TIMEBASE *
pulses / (frequency
integration period)

154

Parameter

Parameter

Specific to
Block(s)

Description

PV[0..63]

REQNUMARRAY,
RSPNUMARRAY

PV[1..64]

Data Type

Default

Config
Load

Access
Lock

Residence

Active
Connector

Array of Real values 64-Bit Real


to be read from or
Number
written to the
third-party device.
Stores are accepted
to this parameter
only if COMMAND
indicates this is a
write block.

NaN

Yes

Operator

CEE

No

SINUMARRCH

Process Value, from 64-Bit Real


device Provides
Number
Numeric value form
the device.

NaN

Yes

Determined CEE
by ACCLOCK

PV[1..200]

NUMERICARRAY

Numeric Data
64-Bit Real
Provides access to Number
the Numeric values,
one element at a
time, for all other
function blocks of
the CEE. Initial
values can be
configured.

NaN

Yes

PVAUTO

DataAcq

Filtered and clamped 64-Bit Real


value of the Process Number
Input 1 (P1)

NaN

DevCtl

State of Actual
Inputs

String

Range

Length: 12
characters

Related
Parameters

Notes

No

ERRFL, NNUMERIC.

PV[i] provides access to the


array of data, one element at
a time, by all other function
blocks of the CEE. Initial
values can be configured, but
these will be overwritten
once good data is imaged
from the Serial Interface
Module. When ERRFL is On,
an error will be returned on
attempted Gets and Stores
to this parameter, to indicate
that there is a problem with
the array data.

Determined CEE
by ACCLOCK

No

NNUMERIC.

No

View Only

CEE

No

STATETEX No
T[0]

View Only

CEE

No

DIPVMAP[0..15],
GPV, GPVAUTO,
NUMDINPTS,
NUMSTATES, PV,
PVSOURCE,
STATETEXT[0..6]

Access is illegal if
NUMDINPTS = 0.
PVAUTO is a String set equal
to STATETEXT(GPVAUTO).
STATETEXT[6] [State2] is
illegal if NUMSTATES = 2.

155

Specific to
Block(s)

Description

Data Type

PVAUTOSTS

DataAcq

Status of the filtered Enumeration


and clamped value PVVALSTS
of the Process Input
1 (PVAUTO)

PVCHAR

DataAcq

PV Characterization Enumeration
Option: Defines the PVCHAR
characterization to
be used for
characterizing the PI
value.

PVCONN

PID, PIDFF, PosProp, Internal parameter


RampSoak
for system use only.

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Bad (0): The Bad (0)


PVAUTO value
was bad, it
was replaced
with NaN.
Uncertn (1):
The status of
the PVAUTO
value is
uncertain.
Normal (2):
The value is
good.
Manual (3):
The value was
manually
stored.

No

View Only

CEE

No

None (0):Do None (0)


nothing
(typically used
for RTD and
thermocouple
inputs).
Linear (1):0 to
100 input to
P1 is
converted to
Eus using
configured
PVEULO and
PVEUHI.
SquareRoot
(2):Square
root of 0 to
100 input to
P1 is taken,
then this value
is EUs using
configured
PVEULO and
PVEUHI.

Yes

Application
Developer

CEE

No

Related
Parameters

Notes

A floating point parameter


P1EU is used to represent
the converted EU value of P1.

156

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

PVEQN

Totalizer, Pulse
Input Totalizer

Process Variable (PV) Enumeration


Equation Type PVEQN
Defines which
equation is used
with a given function
block.
Equation:

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

See below.

EqA (0)

Yes

Engineer

CEE

No

Related
Parameters

Notes

Range

Bad Input Handling:

Warm Restart Handling:

EqA (0)

Stop accumulation while input is bad

Continue after input turns valid

EqB (1)

Use last good value if input is bad

Continue after input turns valid

EqC (2)

Stop if the input is bad and set PV to NaN

Continue after input turns valid

EqD (3)

Stop accumulation while input is bad

Stop after a warm restart

EqE (4)

Use last good value if input is bad

Stop after a warm restart

EqF (5)

Stop if the input is bad and set PV to NaN

Stop after a warm restart

PVERSION

SR

Platform Version.
8-Bit
Identifies the major Unsigned
revision of the RM. Integer

0 to 255

No

View Only

CEE

No

PVEUHI

DataAcq, PID,
PIDFF, PosProp,
RampSoak.

Process Variable (PV) Real


High Range (in
Engineering Units) This value
corresponds to
100% of full scale.

Greater-than
PVEULO and
less-than or
equal to
PVEXHILM.

100.0

Yes

Engineer

CEE

No

PVEULO

DataAcq, PID,
PIDFF, PosProp,
RampSoak

Process Variable (PV) Real


Low Range (in
Engineering Units) This value
corresponds to 0%
of full scale.

Less-than
PVEUHI and
Greater-than
or equal to
PVEXLOLM.

0.0

Yes

Engineer

CEE

No

PVEXHIFL

DataAcq

Process Variable (PV) Boolean


High Limit Flag
Indicates if PV has
exceeded its high
limit.

Off (0): PVs


Off (0)
high limit is
not exceeded.
On (1): PVs
high limit is
exceeded.

No

View Only

CEE

No

PVEXHILM

DataAcq

Process Variable (PV) 64-Bit Real


Low Limit (in
Number
Engineering Units) Used to detect and
clamp a bad Process
Variable (PV) value.

Greater-than
or equal to
PVEUHI.

Yes

Engineer

CEE

No

102.9

157

Specific to
Block(s)

Description

Data Type

PVEXLOFL

DataAcq

Process Variable (PV) Boolean


Low Limit Flag
Indicates if PV has
exceeded its low
limit.

PVEXLOLM

DataAcq

PVFL

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Off (0): PV low Off (0)


limit not
exceeded.
On (1): PV low
limit
exceeded.

No

View Only

CEE

No

Process Variable (PV) 64-Bit Real


Low Limit (in
Number
Engineering Units) Used to detect and
clamp a bad PV
value.

Less than or
equal to
PVEULO

-2.9

Yes

Engineer

CEE

No

Flag

Actual State Flag - Boolean


Indicates the current
state of the Flag
function block as a
Boolean.

Off (0)
On (1)

Off (0)

No

Defined by
ACCLOCK

CEE

No

DIC

Process Value Flag

Boolean

Off (0)
On (1)

Off (0)

No

View Only

CEE

No

PVFL[0..2]

DevCtl

Process Variable (PV) Boolean


State Flags PVFL(x)
is On when OP =
StateX.

Off (0)
On (1)

Off (0)

No

View Only

CEE

No

PVFL[0..511]

REQFLAGARRAY,
RSPFLAGARRAY

Array of Boolean
Boolean
values to be read
from or written to
the third-party
device. Stores are
accepted to this
parameter only if the
COMMAND
indicates that this is
a write block.

Off (0)
On (1)

Off (0)

Yes

Operator

CEE

No

PVFL[1..512]

SIFLAGARRCH

Process Value, from Boolean


device Provides
Boolean value from
the device.

Off (0)
On (1)

Off (0)

Yes

Determined CEE
by ACCLOCK

No

Related
Parameters

Notes

PV, STATETEXT[0..1],
STATE0, STATE1

GPV, PV,
DIPVMAP[0..15],
NUMDINPTS,
NUMSTATES

Access is illegal if
NUMDINPTS = 0.
PVFL[2] is illegal if
NUMSTATES =2.

ERRFL, NFLAG.

PVFL[i] provides access to


the array of data, one
element at a time, by all
other function blocks of the
CEE. Initial values can be
configured, but these will be
overwritten once good data
is imaged from the Serial
Interface Module. When
ERRFL is On, an error will be
returned on attempted Gets
and Stores to this parameter,
to indicate that there is a
problem with the array data.

158

Parameter

Parameter

Specific to
Block(s)

Description

PVFL[1..1000]

FLAGARRAY

PVFORMAT

Data Type

Range

Default

Config
Load

Access
Lock

Flag Data Provides Boolean


access to the
Boolean values, one
element at a time,
for all other function
blocks of the CEE.
Initial values can be
configured.

Off(0)
On(1)

Off(0)

Yes

DataAcq, Numeric,
PID, PIDFF, PosProp,
Auxcalc, Genlin,
Totalizer, LeadLag,
Deadtime, Pulse
Input Totalizer,
NUMERICARRAY.

Process Variable (PV) Enumeration


Display Format
PVFORMAT
Defines the decimal
format that is to be
used to display the
PV value. It contains
up to eight
characters, including
the minus sign and
decimal point.

PVHHALM.DB

DataAcq

PVHHALM.DBU

DataAcq

Active
Connector

Related
Parameters

Determined CEE
by ACCLOCK

No

NFLAG.

D0 (-XXXXXX.) D1
Yes
D1 (-XXXXX.X) (-XXXXX.
D2 (-XXXX.XX) X)
D3 (XXX.XXX)

Engineer

CEE

No

PV, SP.

Process Variable (PV) 64-Bit Real


High High Alarm
Number
Deadband

0.0 to 100.0 if 0.0


alarm
deadband
units
(PVHHALM.DB
U) are Percent.
PVEULO to
(PVEUHI if
alarm
deadband
units
(PVHHALM.DB
U) are
Engineering
Units.

No

Operator

CEE

No

PV, PVHHALM.DBU,
PVHHALM.FL,
PVHHALM.PR,
PVHHALM.SV,
PVHHALM.TM,
PVHHALM.TP.

PV High High Alarm Enumeration


Deadband Units ALMDBU
Indicates if
PVHIALM.DB is in
Percent or
Engineering Units.

Percent (0)
EU (1)

No

Engineer

CEE

No

PV, PVHHALM.DB,
PVHHALM.FL,
PVHHALM.PR,
PVHHALM.SV,
PVHHALM.TM,
PVHHALM.TP.

Percent
(0)

Residence

Notes

For more information on


DataAcq alarming, refer to
the Control Builder
Components Theory,
DATAACQ (Data Acquisition)
Block, Alarm processing.

159

Specific to
Block(s)

Description

Data Type

PVHHALM.FL

DataAcq

Process Variable (PV) Boolean


High High Alarm
Flag

PVHHALM.PR

DataAcq

Process Variable (PV) Enumeration


High High Alarm
ALPRIOR
Priority

PVHHALM.SV

DataAcq

PVHHALM.TM

PVHHALM.TP

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Off (0): PV
Off (0)
High High
alarm is not
active; PV is
less than
PVHHALM.TP
On (1): PV
High High
alarm is
active; PV is
greater than
or equal to
PVHHALM.TP

No

View Only

CEE

No

For more information on


DataAcq alarming, refer to
the Control Builder
Components Theory,
DATAACQ (Data Acquisition)
Block, Alarm processing.

None (0)
Journal (1)
Low (2)
High (3)
Urgent (4)

Low (2)

Yes

Engineer

CEE

No

For more information on


DataAcq alarming, refer to
the Control Builder
Components Theory,
DATAACQ (Data Acquisition)
Block, Alarm processing.

Process Variable (PV) 16-Bit Integer 0 to 15


High High Alarm
Severity

0.0

Yes

Engineer

CEE

No

For more information on


DataAcq alarming, refer to
the Control Builder
Components Theory,
DATAACQ (Data Acquisition)
Block, Alarm processing.

DataAcq

Process Variable (PV) 32-Bit


High High Alarm
Unsigned
Filter Time (Seconds) Integer
- The purpose of this
parameter is to
prevent input spikes
from causing PV
High High alarms.
An alarm will only
be generated if PV
consistently exceeds
the High High alarm
trip point for more
than the configured
alarm filter time.

0 to 60

No

Engineer

CEE

No

DataAcq

Process Variable (PV) 64-Bit Real


High High Alarm Trip Number
Point Defines the
trip point for a PV
High High alarm.

NaN or
PVHIALM.TP
to PVEUHI.

NaN

Yes

Engineer

CEE

No

PV, PVHHALM.DB,
PVHHALM.DBU,
PVHHALM.FL,
PVHHALM.PR,
PVHHALM.SV,
PVHHALM.TP.

Notes

For more information on


DataAcq alarming, refer to
the Control Builder
Components Theory,
DATAACQ (Data Acquisition)
Block, Alarm processing.

For more information on


DataAcq alarming, refer to
the Control Builder
Components Theory,
DATAACQ (Data Acquisition)
Block, Alarm processing.

160

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

PVHIALM.DB

DataAcq

Process Variable (PV) 64-Bit Real


High Alarm
Number
Deadband

PVHIALM.DBU

DataAcq

PVHIALM.FL

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

0.0 to 100.0: If 0.0


alarm
deadband
units
(PVHIALM.DB
U) are Percent.
PVEULO to
PVEUHI, If
alarm
deadband
units
(PVHIALM.DB
U) are
Engineering
Units.

No

Operator

CEE

No

PV, PVHIALM.DBU,
PVHIALM.FL,
PVHIALM.PR,
PVHIALM.SV,
PVHIALM.TM,
PVHIALM.TP

PVHIALM.DB will always set


all individual alarm
deadbands to their overall
value (ALMDB).

Process Variable (PV) Enumeration


High Alarm
ALMDBU
Deadband Units
Indicates if
PVHIALM.DB is in
Percent or
Engineering Units.

Percent (0)
EU (1)

No

Engineer

CEE

No

PV, PVHIALM.DB,
PVHIALM.FL,
PVHIALM.PR,
PVHIALM.SV,
PVHIALM.TM,
PVHIALM.TP

For more information on


DataAcq alarming, refer to
the Control Builder
Components Theory,
DATAACQ (Data Acquisition)
Block, Alarm processing.

DataAcq

Process Variable (PV) Boolean


High Alarm Flag
Indicates if a PV
High alarm has been
issued.

Off (0): PV
Off (0)
High alarm is
not active; PV
is less than
PVHIALM.TP.
On (1): PV
High alarm
present; PV is
greater than
or equal to
PVHIALM.TP
for the
configured
alarm time.

No

View Only

CEE

No

For more information on


DataAcq alarming, refer to
the Control Builder
Components Theory,
DATAACQ (Data Acquisition)
Block, Alarm processing.

PVHIALM.PR

DataAcq

Process Variable (PV) Enumeration


High Alarm Priority - ALPRIOR
Priority of a PV High
alarm

None (0)
Journal (1)
Low (2)
High (3)
Urgent (4)

Low (2)

Yes

Engineer

CEE

No

For more information on


DataAcq alarming, refer to
the Control Builder
Components Theory,
DATAACQ (Data Acquisition)
Block, Alarm processing.

PVHIALM.SV

DataAcq

Process Variable (PV) 16-Bit Integer 0 to 15


High Alarm Severity
- Severity of a PV
High alarm

Yes

Engineer

CEE

No

For more information on


DataAcq alarming, refer to
the Control Builder
Components Theory,
DATAACQ (Data Acquisition)
Block, Alarm processing.

Percent
(0)

161

Specific to
Block(s)

Description

PVHIALM.TM

DataAcq

PVHIALM.TP

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

Process Variable (PV) 32-Bit


High Alarm Filter
Unsigned
Time (seconds)
Integer

0 to 60

No

Engineer

CEE

No

PV, PVHIALM.DB,
PVHIALM.DBU,
PVHIALM.FL,
PVHIALM.PR,
PVHIALM.SV,
PVHIALM.TP

For more information on


DataAcq alarming, refer to
the Control Builder
Components Theory,
DATAACQ (Data Acquisition)
Block, Alarm processing.

DataAcq

Process Variable (PV) 64-Bit Real


High Alarm Trip
Number
Point - Defines the
trip point for a PV
High alarm.

NaN or
NaN
PVLOALM.TP
to
PVHHALM.TP

Yes

Engineer

CEE

No

PVHILM

Numeric

Process Variable (PV) 64-Bit Real


High Limit
Number

Greater than
PVLOLM

Yes

Engineer

CEE

No

PVLOLM, PV.

When NaN, the limit is not


checked on stores to PV.
When there is some value,
stores to PV must be less
than PVHILM.

PVHISIGCHG.CT

DataAcq

Process Variable (PV) 32-Bit Integer Greater-than 0


High
or equal-to 0.
Significant-Change
Count - The number
of times the PV low
alarm has been
re-annunciated
(because
PVHIALM.TP has
been exceeded).

No

View Only

CEE

No

PVHISIGCHG.TP

For more information on


DataAcq alarming, refer to
the Control Builder
Components Theory,
DATAACQ (Data Acquisition)
Block, PV significant-change
alarming.

PVHISIGCHG.TP

DataAcq

Process Variable (PV) 64-Bit Real


High
Number
Significant-Change
Trip Point - If PV is
between the High
and High-High alarm
limits, the High
alarm will be
re-annunciated (if PV
increases by this
amount).

Yes

Engineer

CEE

No

PVHISIGCHG.CT

For more information on


DataAcq alarming, refer to
the Control Builder
Components Theory,
DATAACQ (Data Acquisition)
Block, PV significant-change
alarming.

NaN, or
greater-than
0.0.

NaN

NaN

For more information on


DataAcq alarming, refer to
the Control Builder
Components Theory,
DATAACQ (Data Acquisition)
Block, Alarm processing.

162

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

PVLLALM.DB

DataAcq

Process Variable (PV) 64-Bit Real


Low Low Alarm
Number
Deadband

PVLLALM.DBU

DataAcq

PVLLALM.FL

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

0.0 to 100.0: If 0.0


alarm
deadband
units
(PVLLALM.DB
U) are Percent
PVEULO to
PVEUHI If
alarm
deadband
units
(PVLLALM.DB
U) are
Engineering
Units.

Yes

Operator

CEE

No

PV, PVLLALM.DBU,
PVLLALM.FL,
PVLLALM.PR,
PVLLALM.SV,
PVLLALM.TM,
PVLLALM.TP.

Process Variable (PV) Enumeration


Low Low Alarm
ALMDBU
Deadband Units Indicates if
PVLLALM.DB is in
Percent or
Engineering Units.

Percent (0)
EU (1)

Yes

Engineer

CEE

No

PV, PVLLALM.DB,
PVLLALM.FL,
PVLLALM.PR,
PVLLALM.SV,
PVLLALM.TM,
PVLLALM.TP.

DataAcq

Process Variable (PV) Boolean


Low Low Alarm Flag
Indicates if a PV
Low Low alarm has
been issued.

Off (0): PV Low Off (0)


Low Alarm is
not active; PV
is less than
PVLLALM.TP.
On (1): PV Low
Low Alarm
present; PV is
greater than
or equal to
PVLLALM.TP.

No

View Only

CEE

No

PVLLALM.PR

DataAcq

Process Variable (PV) Enumeration


Low Low Alarm
ALPRIOR
Priority

None (0)
Journal (1)
Low (2)
High (3)
Urgent (4)

Low (2)

Yes

Engineer

CEE

No

PVLLALM.SV

DataAcq

Process Variable (PV) 16-Bit Integer 0 to 15


Low Low Alarm
Severity

Yes

Engineer

CEE

No

Percent
(0)

Notes

163

Specific to
Block(s)

Description

PVLLALM.TM

DataAcq

PVLLALM.TP

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

Process Variable (PV) 32-Bit


Low Low Alarm
Unsigned
Filter Time (Seconds) Integer

0 to 60

Yes

Engineer

CEE

No

PV, PVLLALM.DB,
PVLLALM.DBU,
PVLLALM.FL,
PVLLALM.PR,
PVLLALM.SV,
PVLLALM.TP.

The purpose of this


parameter is to prevent input
spikes from causing PV Low
Low alarms. An alarm will
only be generated if PV is
consistently below the Low
Low alarm trip point for more
than the configured alarm
filter time.
If PVLLALM.TM = 0, an alarm
will be generated as soon as
PV exceeds the trip point.

DataAcq

Process Variable (PV) 64-Bit Real


Low Low Alarm Trip Number
Point Defines the
trip point for a PV
Low Low alarm.

NaN, PVEULO NaN


to
PVLOALM.TP

Yes

Engineer

CEE

No

PVLOALM.DB

DataAcq

Process Variable (PV) 64-Bit Real


Low Alarm
Number
Deadband

0.0 to 100.0: If 0.0


alarm
deadband
units
(PVLOALM.DB
U) are Percent.
PVEULO to
PVEUHI: If
alarm
deadband
units
(PVLOALM.DB
U) are
Engineering
Units.

Yes

Operator

CEE

No

PV, PVLOALM.DBU,
PVLOALM.FL,
PVLOALM.PR,
PVLOALM.SV,
PVLOALM.TM,
PVLOALM.TP

PVLOALM.DBU

DataAcq

Process Variable (PV) Enumeration


Low Alarm
ALMDBU
Deadband Units
Indicates if
PVLOALM.DB is in
Percent or
Engineering Units.

Percent (0)
EU (1)

No

Engineer

CEE

No

PV, PVLOALM.DB,
PVLOALM.FL,
PVLOALM.PR,
PVLOALM.SV,
PVLOALM.TM,
PVLOALM.TP.

Percent
(0)

For more information on


DataAcq alarming, refer to
the Control Builder
Components Theory,
DATAACQ (Data Acquisition)
Block, Alarm processing.

164

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

PVLOALM.FL

DataAcq

Process Variable (PV) Boolean


Low Alarm Flag
Indicates if a PV Low
alarm has been
issued.

PVLOALM.PR

DataAcq

Process Variable (PV) Enumeration


Low Alarm Priority - ALPRIOR
Priority of a PV Low
alarm

PVLOALM.SV

DataAcq

PVLOALM.TM

PVLOALM.TP

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Off (0): PV Low Off (0)


alarm is not
active; PV >
PVLALM.TP.
On (1): PV Low
alarm present;
PV <=
PVLALM.TP
for the
configured
alarm time.

No

View Only

CEE

No

None (0)
Journal (1)
Low (2)
High (3)
Urgent (4)

Low (2)

Yes

Engineer

CEE

No

Process Variable (PV) 16-Bit Integer 0 to 15


Low Alarm Severity

0.0

Yes

Engineer

CEE

No

DataAcq

Process Variable (PV) 32-Bit


Low Alarm Filter
Unsigned
Time (Seconds)
Integer

0 to 60

0.0

No

Engineer

CEE

No

DataAcq

Process Variable (PV) 64-Bit Real


Low Alarm Trip Point Number
- Defines the trip
point for a PV Low
alarm.

NaN, or
PVLLALM.TP
to
PVHIALM.TP

NaN

Yes

Engineer

CEE

No

Related
Parameters

Notes
The flag is set only when PV
is below the trip point for the
configured alarm time.

PV, PVLOALM.DB,
PVLOALM.DBU,
PVLOALM.FL,
PVLOALM.PR,
PVLOALM.SV,
PVLOALM.TP.

The purpose of this


parameter is to prevent input
spikes from causing PV Low
alarms. An alarm will only
be generated if PV
consistently exceeds the
Low alarm trip point for more
than the configured alarm
filter time.
If PVLOALM.TM = 0, an
alarm will be generated as
soon as PV falls below the
trip point.
For more information on
DataAcq alarming, refer to
the Control Builder
Components Theory,
DATAACQ (Data Acquisition)
Block, Alarm processing.

165

Specific to
Block(s)

Description

Data Type

PVLOLM

Numeric

Process Variable (PV) 64-Bit Real


Low Limit
Number

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

Real number
less than
PVHILM

NaN

Yes

Engineer

CEE

No

PVHILM, PV

When NaN, the limit is not


checked on stores to PV.
When there is some value,
stores to PV must be greater
than PVLOLM.

PVLOSIGCHG.CT DataAcq

Process Variable (PV) 32-Bit Integer Greater-than


Low
or equal-to 0
Significant-Change
Count - The number
of times the PV low
alarm has been
re-annunciated
(because
PVLOALM.TP has
been exceeded).

No

View Only

CEE

No

PVLOSIGCHG.TP

PVLOSIGCHG.TP DataAcq

Process Variable (PV) 64-Bit Real


Low
Number
Significant-Change
Trip Point - If PV is
between its low and
low-low alarm
limits, the low alarm
will be
re-annunciated if PV
decrease by this
amount.

NaN

No

Engineer

CEE

No

PVLOSIGCHG.CT

NaN, or
greater-than
0.0.

Re-alarming is disabled if
PVLOSIGCHG.TP = NaN.

166

Parameter

Parameter

Specific to
Block(s)

Description

PVMANOPT

PID, PIDFF

Process Variable (PV) Enumeration


Manual Option BADCTLOPT
Indicates what to do
when PVSTS =
Manual.
NoShed (0):

PosProp

Data Type

Range

Default

Config
Load

See below.

ShedHold Yes
(1)

Access
Lock

Residence

Active
Connector

Related
Parameters

Engineer

CEE

No

PVSTS, ESWENB,
MODE, MODEATTR,
OP

Notes

Range
Do nothing (i.e., behave the same as if PVSTS = Normal).

ShedHold (1):

Set MODE to Manual, and MODEATTR to Operator; disable External


Mode Switching, and hold OP at the last good value.

ShedLow (2):

Set MODE to Manual, and MODEATTR to Operator, disable External


Mode Switching, and set OP to its extended low limit (OPEXLOLM).

ShedHigh (3):

Set MODE to Manual, and MODEATTR to Operator, disable External


Mode Switching, and set OP to its extended high limit (OPEXHILM).

ShedSafe (4):

Set MODE to Manual and MODEATTR to Operator, disable External


Mode Switching, and set OP to the configured safe value (SAFEOP).
If SAFEOP is NaN, OP is held at the last good value.

Process Variable (PV) Enumeration


Manual Option Indicates what to do
when PVSTS =
Manual.

PVP

PID, PIDFF, PosProp, Process Variable (PV) 64-Bit Real


DataAcq
Value (in Percent)
Number

PVRAW

AIC

Process Variable
from Analog Input
device.

64-Bit Real
Number

PVRAW
[0..numChans-1]

AIM

Process Variable
from Analog Input
device, indexed by
channel number.

64-Bit Real
Number

NO_SHED
Idle
SHEDHIGH
Raise
SHEDLOW
Lower
SHEDSAFE
Depends on
Safe State
SHEDHOLD Idle

ShedHold Yes
(1)

Engineer

CEE

No

PVSTS, ESWENB,
MODE, MODEATTR,
OP

NaN

No

View Only

CEE

No

PV, PVEULO, PVEUHI

No

View Only

CEE

No

No

View Only

CEE

No

167

Specific to
Block(s)

Description

Data Type

PVSOURCE

DataAcq, DevCtl

Process Variable (PV) Enumeration


Source - Identifies PVSOURCE
the source of the PV
input.

PVSRC

Auxcalc

PVSRCOPT

DevCtl, DataAcq

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

Yes

DataAcq:
Operator
DevCtl:
ViewOnly,
Operator
(see Notes)

CEE

No

DevCtl only: GPV,


GPVAUTO,
NUMDINPTS,
NUMDOUTS, PV,
PVAUTO, PVSRCOPT

Access illegal if
NUMDINPTS = 0.
PVSOURCE may not be set =
Track if NUMDOUTS = 0.
ViewOnly and defaulted to
Auto if PVSRCOPT =
OnlyAuto.
If PVSOURCE is not Man and
the function block is
InActive, PV is defaulted to
Null.

Process Variable (PV) Enumeration See below.


P1 (0)
Yes
source: Any of
CALCOUTSELE
P[1..6], PVSTS,
CTOR
C[1..8] or CSTS[1..8]
Range
P1 (0) C2 (7)
P1STS (14) C2STS (21)
P2 (1) C3 (8)
P2STS (15) C3STS (22)
P3 (2) C4 (9)
P3STS (16) C4STS (23)
P4 (3) C5 (10) P4STS (17) C5STS (24)
P5 (4) C6 (11) P5STS (18) C6STS (25)
P6 (5) C7 (12) P6STS (19) C7STS (26)
C1 (6) C8 (13) C1STS (20) C8STS (27)

Engineer

CEE

No

PVSTSSRC

Process Variable (PV) Enumeration


Source Option
PVSRCOPT
Identifies the PV
source selection
options available to
this function block.

Engineer

CEE

No

DevCtl Only: GPV,


NUMDINPTS, PV,
PVSOURCE

Sub (0):PV
Auto (2)
value is
provided by a
user program.
Man (1):PV
value is
provided by
the operator
Auto (2):PV
value is
fetched from
another
function block.

OnlyAuto
OnlyAuto Yes
(0):PV may
(0)
only be
fetched from
another
function
block, via an
active input
connection;
PV source
selection is
not available.
All (1):PV may
be fetched
from another
function block,
or provided by
an operator or
a user
program, it
depends on
the
PVSOURCE.

DevCtl Only:
Access is illegal if
NUMDINPUTS = 0.
If set to OnlyAuto, and the
function block is Inactive, PV
is set to Null.

168

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

PVSTS

PID, PIDFF, PosProp, Process Variable (PV) Enumeration


DataAcq,
Status - Contains the PVVALSTS
RampSoak, AuxCalc status of the
PV value.

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

See below.

Bad (0)

No

View Only

CEE

No

PV, PVVALSTS

Notes

Range
The PV value was bad and replaced with NaN.

Bad (0):
Uncertain (1):

The status of the PV value is uncertain, stored


by a program.

Normal (2):

The PV value is good.

Manual (3):

The PV value was manually entered.

Bad Process Variable Boolean


(PV) Status Flag Indicates if the PV
status is Bad.

Off (0): PVSTS Off (0)


is not Bad.
On (1): PVSTS
is Bad.

No

View Only

CEE

No

PV, PVSTS,
PVSTSFL.BAD,
PVSTSFL.MAN,
PVSTSFL.NORM,
PVSTSFL.UNCER.

AIC

Process Variable (PV) 32-Bit Integer Good (0)


Status.
Bad (1)

Good (0)

No

View Only

CEE

No

PV, PVVALSTS

DIC

PV Status

Boolean

Off (0)
On (1)

Off (0)

No

View Only

CEE

No

PVSTS[0..numCha DIM, DOM (not


ns-1]
exposed on the
DOM)

DIM: PV Status
DOM: Echoback
Status

Boolean

Off (0)
On (1)

Off (0)

No

View Only

CEE

No

PVSTS[0..63]

REQNUMARRAY,
RSPNUMARRAY

Array of Status
Enumeration
Values. These
values are obtained
from the Status of
the last request.

View Only

CEE

No

PVSTS[1..64]

SINUMARRCH

Process Value Status Enumeration


Indicates the
status of the
corresponding
Numeric value.

Bad (0)
Uncertain (1)
Normal (2)
Manual (3)

No

View Only

CEE

No

ERRFL, PV[1..64].

PVSTSFL.BAD

PID, PIDFF, PosProp,


DataAcq,
Deadtime, Leadlag,
Auxcalc, Genlin,
Totalizer, Pulse
Input Totalizer

Bad Process Variable Boolean


(PV) Status Flag Indicates if the PV
status is Bad.

Off (0): PVSTS Off (0)


is not Bad.
On (1): PVSTS
is Bad.

No

View Only

CEE

No

PV, PVSTS,
PVSTSFL.MAN,
PVSTSFL.NORM,
PVSTSFL.UNCER,
PVVALSTS.

PVSTSFL.MAN

PID, PIDFF, PosProp,


RampSoak,
DataAcq, Leadlag,
Auxcalc, Genlin,
Totalilzer, Pulse
Input Totalizer.

Manual Process
Boolean
Variable (PV) Status
Flag - Indicates that
the PVSTS is
Manual.

Off (0): PVSTS Off (0)


is not Manual.
On (1): PVSTS
is Manual.

No

View Only

CEE

No

PV, PVSTS,
PVSTSFL.BAD,
PVSTSFL.NORM,
PVSTSFL.UNCER,
PVVALSTS.

Normal
(2)

169

Deadtime, Genlin,
Leadlag, Totalizer

Specific to
Block(s)

Description

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

PVSTSFL.NORM

PID, PIDFF, PosProp,


RampSoak,
DataAcq, Leadlag,
Deadtime, Auxcalc,
Genlin, Totalizer,
Pulse Input
Totalizer.

Normal Process
Boolean
Variable (PV) Status
Flag - Indicates that
the PVSTS is
Normal.

Off (0): PVSTS Off (0)


is not Normal.
On (1): PVSTS
is Normal.

No

View Only

CEE

No

PV, PVSTS,
PVSTSFL.BAD,
PVSTSFL.MAN,
PVSTSFL.UNCER,
PVVALSTS.

PVSTSFL.UNCER PID, PIDFF, PosProp,


RampSoak,
DataAcq, Leadlag,
Deadtime, Auxcalc,
Genlin, Totalizer,
Pulse Input
Totalizer.

Uncertain Process Boolean


Variable (PV) Status
Flag - Indicates
whether the Process
Variable (PV) status
is Uncertain.

Off (0): PVSTS Off (0)


is not
Uncertain.
On (1): PVSTS
is Uncertain.

No

View Only

CEE

No

PV, PVSTS,
PVSTSFL.BAD,
PVSTSFL.MAN,
PVSTSFL.NORM,
PVVALSTS.

PVSTSSRC

Auxcalc

PVSTS source: Any Enumeration See below.


P1STS
Yes
of P[1..6], PVSTS,
CALCOUTSELE
(14)
C[1..8] or CSTS[1..8]. CTOR
Range
P1 (0) C2 (7)
P1STS (14) C2STS (21)
P2 (1) C3 (8)
P2STS (15) C3STS (22)
P3 (2) C4 (9)
P3STS (16) C4STS (23)
P4 (3) C5 (10) P4STS (17) C5STS (24)
P5 (4) C6 (11) P5STS (18) C6STS (25)
P6 (5) C7 (12) P6STS (19) C7STS (26)
C1 (6) C8 (13) C1STS (20) C8STS (27)

Engineer

CEE

No

PVSRC

PVTRAKOPT

PID, PIDFF, PosProp Process Variable (PV) Enumeration


Tracking Option TRACKING
Indicates whether
the Set Point (SP) is
to track PV when the
function block is
either in Manual
mode or being
initialized.

NoTrack (0):SP NoTrack


is never set
(0)
equal to PV.
Track
(1):Manual
mode or
initialization
causes SP to
track PV.

Yes

Operator

CEE

No

PVVAL

DIC

Process Value.

Boolean

Off (0)
On (1)

Off (0)

No

View Only

CEE

No

PVVAL
[0..numChans-1]

DIM, DOM (not


exposed on the
DOM)

DIM: Process Value. Boolean


DOM: Echoback
Value.

Off (0)
On (1)

Off (0)

No

View Only

CEE

No

Notes

SP is set equal to PV if
PVTRAKOPT = Track and the
function block is:
in manual mode.
being initialized from a
secondary.
undergoing a 1-shot
initialization.

170

Parameter

Parameter

Specific to
Block(s)

PVVALSTS

Description

Data Type

Range

Default

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

PID, PIDFF, PosProp Process Variable (PV) Structure


Value and Status
Structure containing
the current PV value
plus the status
(PVSTS).

No

View Only

CEE

Default
Connector:
Input

PV, PVSTS

Use this parameter to pass


the status of the PV along
with the PV value in all input
connections. The status of
the PV is monitored
automatically by the PID
block, and if PVSTS is
MANUAL, you may choose to
configure the SHED response
of the PID block.

AIC, DIC, DataAcq,


Auxcalc, Genlin,
Totalizer, Deadtime,
Leadlag, Pulse
Input Totalizer.

Process Variable (PV) Structure


Value and Status Structure containing
the current PV Value
and Status (PVSTS).

No

View Only

CEE

No

PV, PVSTS

For AIC: Use this parameter


to pass the status of PV
along with the PV value in all
input connections. The
status of the PV is monitored
automatically by the PID
block and if PVSTS is
MANUAL you may choose to
configure the SHED response
of the PID block.

PVVALSTS[0..63]

REQNUMARRAY,
RSPNUMARRAY

Array of (Real Value, Structure


Status) pairs. These
values are obtained
from the Status of
the last request.

No

View Only

CEE

No

PVVALSTS[1..64]

SINUMARRCH

PV Value and Status Structure


Provides Numeric
value from the
device, along with a
Status field.

No

View Only

CEE

No

ERRFL, PVFL[1..512]

This structure is
automatically used when the
block fetching PVFL[i] is
capable of interpreting the
ValueStatus structure.

PVVALSTS[0..511] SIFLAGARRCH

PV Value and Status Structure


Provides Boolean
value from the
device, along with a
Status field.

No

View Only

CEE

No

ERRFL, PVFL[1..512]

This structure is
automatically used when the
block fetching PVFL[i] is
capable of interpreting the
ValueStatus structure.

RSPFLAGARRAY

An array of (Boolean Structure


Value, Status) pairs.
These values are
obtained from the
value of the
corresponding PVFL
and the Status of the
last response.

No

View Only

CEE

No

PWMPERIOD

PWM Channel

PWM Period in
Seconds

64-Bit Real
Number

10

Yes

Engineer

CEE

No

PWMPERIOD is configured
on the PWM Channel block.

PWMPERIOD
[0..numChans-1]

DOM

PWM Period in
Seconds

64-Bit Real
Number

10

No

View Only

CEE

No

PWMPERIOD is not
configured on the DOM.

171

Config
Load

Specific to
Block(s)

Description

SR, RS

The Q output value. Boolean

QUALPROGA

RM

Qualification
progress indication
for each module in
the host chassis

SR, RS

The R input value.

RAISEDEADTM

PosProp,
PidPosProp

Raise Dead Time (in Real


seconds).

RAISEDESC

PosProp,
PidPosProp

Raise Output
Descriptor.

RAISELMFL

PosProp,
PidPosProp

Raise Pulse Limit


Boolean
Flag Used to
inhibit Raise pulses
by the PosProp
function block and is
pulled from another
function block.

Off (0): Allow Off (0)


raise pulse
output.
On (1): Inhibit
raise pulse
output.

RAISERATE

PosProp,
PidPosProp

Raise Output Pulse Real


Rate The raise
stroke rate (in
percent per second).

0.0 to 100.0

RAISETIME

PosProp,
PidPosProp

Raise Output Pulse


Time (in seconds).

MINPULSER,
Lesser of
MAXPULSER
and
CYCLETIME.

RAMPRATE
RampSoak
[1..NUMPROFILES
] [1..NUMRAMP
SOAK]

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Off (0)
On (1)

Off (0)

Yes

Engineer

CEE

No

8-Bit
Unsigned
Integer [20]

0 to 255

No

View Only
Not Loaded
Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform.

No

Boolean

Off (0)
On (1)

Off (0)

Yes

Engineer

CEE

No

No

View Only

CEE

No

Yes

Engineer

SR

No

No

Other
Function
Block

CEE

No

100%/sec Yes
.

Supervisor

CEE

No

No

View Only

CEE

Yes

Supervisor

CEE

String

Real

Ramp Rate (in EUs Real


per minute) - The
target ramp rates,
specified by the
user. There is one
ramp rate per
Ramp/Soak pair in a
profile.

Raise

NaN

Related
Parameters

Notes

No

MINPULSER

If RAISETIME < MINPULSER,


no raise pulse is issued.

No

NUMPROFILES,
Negative values are
NUMRAMPSOAK
accepted to allow ramping
[1..NUMPROFILES], down.
SOAKTIME
[1..NUMPROFILES]
[1..NUMRAMPSOAK]
, SOAKVAL
[1..NUMPROFILES]
[1..NUMRAMPSOAK]
, STARTOPT,
STARTSEG
[1..NUMPROFILES].

172

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

RAMSCRUBERRS CPM

Indicates presence
of RAM error when
On.

Boolean

Off (0)
On (1)

Off (0)

No

View Only

CEE

No

Errors detected within


DRAM are corrected through
a scrub operation. Detected
error count should remain
low. However, if it gets
above a certain threshold,
this parameter is set to On.
When RAMSCRUBERRS
goes On, the CPM function
block issues a diagnostic
alarm.

RAMSWEEPERR

CPM

Indicates presence
of RAM error when
On.

Boolean

Off (0)
On (1)

Off (0)

No

View Only

CEE

No

When On, indicates the


presence of one or more
single bit memory faults
which could not be corrected
by the DRAM scrub process.
When RAMSWEEPERR goes
On, the CPM function block
issues a diagnostic alarm.

RATE

Pulse Input Totalizer PI Input Flow Rate in Real


Engineering Units.
This value is used in
Analog Operation
algorithm, when P1
input goes Bad.

NAN, or
greater-than
or equal-to
zero.

0.0

Yes

Engineer

CEE

No

RATE = C1/C2 * TIMEBASE *


Pulses / (integration time in
sec).

RDNCAPABILITY CPM

Redundancy Capable Boolean


Hardware Indicator

No

View Only

CEE

No

RDNCHASSISID

Redundancy Physical Enumeration ChassisUndef ChassisU No


Chassis ID
RDNCHASSISI (0)
ndef (0)
D
ChassisA (1)
ChassisB (2)

View Only

CEE

No

CPM

Off (0)
On (1)

Related
Parameters

RDNCHASSISID

Notes

Indicates whether or not the


CPM hardware is capable of
supporting redundancy.
Identifies a specific physical
chassis in a redundant
chassis pair without regard
to chassis redundancy state.
Note that this is a
user-configurable attribute of
the Redundancy Module
(RM) which the RM
distributes to all chassis
resident redundancy
compliant modules.

173

Specific to
Block(s)

Description

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

RDNDELAYAVG

CPM

Redundancy Delay
Average

64-Bit Real
Number

0.0 to 100.0

0.0

No

View Only

CEE

No

RDNDELAYMAX,
STATSRESET

Gives rolling average of


redundancy delay Central
Processing Unit (CPU) in
percent. Redundancy delay
CPU is that processing stolen
from any of the tasks
currently active to delay until
redundancy resources are
freed. The average is
computed by a one-minute,
first order lag filter.
Averaging can be restarted
by triggering the
STATSRESET parameter.

RDNDELAYMAX

CPM

Redundancy Delay
Maximum

64-Bit Real
Number

0.0 to 100.0

0.0

No

View Only

CPM

No

RDNDELAYMAX,
STATSRESET

Historical maximum
redundancy delay Central
Processing Unit (CPU) value
observed since last store to
STATSRESET.

RDNSYNCSTATE CPM

Control Processor
Module (CPM)
Synchronization
State

Enumeration NOTINSYNC SYNCMAI None


RDNSYNCSTA (0)
NT (3)
TE
PARNERVISBL
(1)
SYNCINPROG
(2)
SYNCMAINT
(3)

View Only

CEE

No

RDNCAPABILITY

Indicates level of CPM


synchronization with
redundancy partner CPM.

RDNXFERAVG

CPM

Redundancy Transfer 64-Bit Real


Rate Average
Number

Greater-than 0.0
or equal-to 0.0

No

View Only

CEE

No

RDNXFERMAX,
STATSRESET

Rolling average of CPM


generated redundancy
private path throughput.
Averaging can be restarted
by triggering the
STATSRESET parameter.

RDNXFERMAX

CPM

Redundancy Transfer 64-Bit Real


Rate Maximum.
Number

Greater-than 0.0
or equal-to 0.0

No

View Only

CEE

No

RDNXFERAVG,
STATSRESET

Historical maximum of
Control Processor Module
(CPM) generated redundancy
private path throughput
since last store to
STATSRESET.

READINESS

RM

Ability of the RM to Enumeration


assume control of
the assigned
function. i.e., to
become a Primary.

Undefined (0) Undefine No


NoPartner (1) d (0)
Disqualified
(2)
Syncing (3)
Synchronized
(4)
Standby (5)

View Only. Not Loaded


Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform.

No

174

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

Range

READINESSA

RM

For each module in


host chassis,
readiness state of
module.

Enumeration
[20]

Undefined (0) Undefine No


NoPartner (1) d (0)
Disqualified
(2)
Syncing (3)
Synchronized
(4)
Standby (5)

View Only. Not Loaded


Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform.

No

READYFL

All Exchange
Library Request
Array function
blocks:
REQFLAGARRAY,
REQNUMARRAY,
REQTEXTARRAY

The flag indicating Boolean


whether the request
array block is in a
state that allows it
to issue a request.
This parameter is
False if the block is
not successfully
loaded and when
there is an
outstanding request
with a response has
not been received.

Off(0)
On(1)

Off(0)

No

View Only

CEE

No

RECDESC [1..50]

SCM

Recipe Parameter
Descriptor

String

Length: 23
characters

Null
String

Yes

Engineer

CEE

RECMATCODE
[1..50]

SCM

Recipe Parameter
Material Code

32-Bit Integer -2147483648


to
2147483647

Yes

Engineer/Ap CEE
plication
Developer

RECOVMSGIDX

RM

Redundancy Module 16-Bit


Recovery Message Unsigned
Index. Full recovery Integer
code, which
references a
matching test string.

0 to 65535

No

View Only. Not Loaded


Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform.

RECSCALE [1..50] SCM

Recipe Parameter
Scale Allowed
Option

Boolean

Off (0)
On (1)

Off (0)

Yes

Engineer

RECTARGET
[1..50]

Recipe Parameter
Target Value

64-Bit Real
Number

NaN

Yes

Operator

SCM

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

No

NUMRECPARMS

RECDESC [i] defines the


descriptor for the ith recipe
parameter.

No

NUMRECPARMS

RECMATCODE [i] defines


material code for the Ith
recipe parameter.

CEE

No

NUMRECPARMS

RECSCALE [i] defines the


scale allowed option for the
ith recipe parameter. When
On, the ith recipe parameter
is indicated as scaled. The
SCM does not do the scaling.

CEE

No

NUMRECPARMS

175

Specific to
Block(s)

Description

Data Type

RECTARGETMAX SCM
[1..50]

Recipe Parameter
Target Value
Maximum

64-Bit Real
Number

RECTARGETMIN
[1..50]

SCM

Recipe Parameter
Target Value
Minimum

64-Bit Real
Number

REDTAG

DevCtl,
All RegCtl Blocks:
AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Red Tag - Allows the Boolean


user to set the FB as
being
out-of-service; this
indicates that the FB
or the associated
control strategy
needs repair, or is
being repaired.

Off (0): Block Off


operates
normally
On (1):
Operator
cannot make
changes to the
block

REDUNSTATE

RM

Redundancy State of Enumeration


the RM and the
Chassis.

Undefined (0) Undefine No


Primary (1)
d (0)
Secondary (2)

View Only. Not Loaded


Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform.

No

REDUNSTATEA

RM

For each module in Enumeration


host chassis,
[20]
redundancy state of
module

Undefined (0) Undefine No


Primary (1)
d (0)
Secondary (2)

View Only. Not Loaded


Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform.

No

REFRESHMS

RM

Refresh Interval in
milliseconds.

0 to
4294967295

No

View Only
Not Loaded
Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform.

No

REMSOAKTIME

RampSoak

Remaining Soak
Real
Time for the current
SOAK segment.

0.0 - 120.0

0.0

No

Operator

No

32-Bit
Unsigned
Integer

Range

Default

NaN

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Yes

Engineer

CEE

No

NUMRECPARMS

Yes

Engineer

CEE

No

NUMRECPARMS

No

Engineer

CEE

No

DevCtl only:
MODEATTR,
NUMDOUTS

CEE

SOAKTIME
[1..NUMPROFILES]
[1..NUMRAMPSOAK]

Notes

DevCtl:
Illegal if NUMDOUTS = 0.
Illegal if MODEATTR is not
Operator.
Illegal if present state is
Momentary.
RegCtl MODE must be
Manual before REDTAG can
be turned On.

176

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

RESADDR [1..10]

SCM

Resume Address
Name

RESADDRFUTUR SCM
[1..10]

Resume Address
Future Name

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

BlockId

Null
String

No

Engineer

CEE

No

RESADDRFUTUR
RESADDR [i] contains the
[1..10], UPDRESOPT, name (eg.
RESADDRN [1..10]
SCMName.StepName) of the
Step in thread i that will
become the active step on
return to the Main or
Interrupt handlers from an
exception.
It can only be set to a valid
step name in the Main or
Interrupt handler that was
preempted.
RESADDR [1..10] is a BlockId
parameter and not supported
in expressions. Its
Integer-32 Partner Parameter
RESADDRN [1..10] can be
used in Transition Condition
expressions and Step Output
expressions.

BlockId

Null
String

No

Engineer

CEE

No

RESADDR [1..10],
UPDRESOPT,
RESADDRFUTRN
[1..10]

RESADDRFUTUR [i] contains


the name (eg.
SCMName.StepName) of the
step in thread i that
RESADDR [i] will be set to if
the currently active Main or
Interrupt hander is
preempted. It can only be
set to a valid step name in
the currently active Main or
Interrupt handler. If a steps
UPDRESOPT is On, the step
will update RESADDRFUTUR
to its own name, for its
thread.
RESADDRFUTUR [1..10] is a
BlockId parameter and not
supported in expressions. Its
Integer-32 Partner Parameter
RESADDRFUTRN [1..10] can
be used in Transition
Condition expressions and
Step Output expressions.

177

Specific to
Block(s)

Description

Data Type

RESADDRFUTRN SCM
[1..10]

Resume Address
Future Number

RESADDRN [1..10] SCM

Resume Address
Number

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

32-Bit Integer

No

Engineer

CEE

No

RESADDR [1..10],
UPDRESOPT

RESADDRFUTUR [i] contains


the name (eg.
SCMName.StepName) of the
step in thread i that
RESADDR [i] will be set to if
the currently active Main or
Interrupt hander is
preempted. It can only be
set to a valid step name in
the currently active Main or
Interrupt handler. If a steps
UPDRESOPT is On, the step
will update RESADDRFUTUR
to its own name, for its
thread.
RESADDRFUTRN [1..10] may
be used in Transition
Condition expressions and
Step Output expressions,
whereas RESADDRFUTUR
[1..10] (a BlockId parameter)
is not supported in
expressions.

32-Bit Integer

No

Engineer

CEE

No

RESADDRFUTUR
RESADDR [i] contains the
[1..10], UPDRESOPT, name (eg.
RESADDR [1..10]
SCMName.StepName) of the
Step in thread i that will
become the active step on
return to the Main or
Interrupt handlers from an
exception.
It can only be set to a valid
step name in the Main or
Interrupt handler that was
preempted.
RESADDRN [1..10] may be
used in Transition Condition
expressions and Step Output
expressions, whereas
RESADDR [1..10] (a BlockId
parameter) is not supported
in expressions.

178

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

RESETFL

Totalizer, Pulse
Input Totalizer

Reset Totalizer
Boolean
Command Flag When this flag
changes from Off to
On, the Totalizer
function block resets
the PV to equal the
value of the
RESETVAL variable.

RESETFL (cont.)

Timer

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Off (0): Do not Off (0)


reset the
accumulator.
On (1): Reset
the
accumulator.

No

Other
Function
Block

CEE

No

RESETVAL, STARTFL,
STOPFL

Reset Command
Boolean
Flag Provides
ability to issue Reset
command to the
Timer function block
using Boolean
parameter.

Off (0): Do not Off (0)


reset the
accumulator.
On (1): Reset
the
accumulator.

No

Other
Function
Block

CEE

No

STOPFL, RESTARTFL, An Off-to-On transition of


STARTFL,
RESETFL causes the timer to
COMMAND
be reset.

Pulse Input IOC,


Reset Counter Flag Boolean
Pulse Input w/ Fast storing On to this
Cutoff IOC
parameter will
cause the pulse
count to reset to 0;
reading this
parameter always
returns a value of
Off.

Off (0): Do not Off (0)


reset the
accumulator.
On (1): Reset
the
accumulator.

No

Operator

CEE

No

SO,

DevCtl

Boolean
Maintenance
Statistics Reset Flag
When set from Off
to On, resets all
Maintenance
Statistics to their
default or 0 values.

Off (0): Do not Off (0)


reset the
accumulator.
On (1): Reset
the
accumulator.

No

Operator,
Other
Function
Block (see
Notes)

CEE

No

MAINTOPT,
MAXTIME [0..2],
MAXTRANS [0..2],
NUMSIOVRD,
NUMTRANS [0..2],
REDTAG, STATETIME
[0..2].

RESETFL [0..7]

Pulse Input IOM

Reset Counter Flag Boolean


Storing On to this
parameter will
cause the pulse
count associated
with the Pulse Input
Channel to reset to
0. RESETFL is
edge-triggered, so
reading this
parameter always
returns a value of
Off.

Off (0): Normal Off (0)


value
On (1): Storing
On will reset
accumulated
value in
device.

No

Engineer

CEE

No

SO [6..7]

RESETTIMR

RampSoak

Reset Segment
Timer On Profile.

Unchecked ( ) Unchecke Yes


Checked (X)
d( )

Engineer

CEE

No

Boolean

Range

Default

Notes

Illegal if MAINTOPT is not


set On.
Operator may reset only
when REDTAG is set on.

Access in monitoring mode.


179

Specific to
Block(s)

Description

Data Type

Range

RESETVAL

Totalizer, Pulse
Input Totalizer

Accumulator Reset 64-Bit Real


Value - Value that
Number
the Totalizer
function block uses
to reset the
accumulator. When
RESET is applied,
the Process Variable
(PV) is set to
RESETVAL.

RESTARTFL

Timer

Restart Command
Boolean
Flag - Provides
ability to issue
Restart command to
the Timer function
block.

RESTARTOPT

DevCtl
All RegCtl Blocks:
AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Sequential Control Enumeration None (0)


Module (SCM)
RESTARTOPT LastReq (1)
Restart Option
Indicates activity for
device when
ControlModule.SCM
STATE returns to
Restarting or
Running.

RFB

PidExtReset

Reset feedback
value.

ROCNEGALM.FL

DataAcq

Negative
Rate-of-Change
Alarm Flag
Indicates if a
negative
rate-of-change
alarm has been
issued.

Boolean

Off (0):
Off (0)
Negative
rate-of-chang
e alarm does
not exist.
On (1):
Negative
rate-of-chang
e alarm
present.

No

View Only

CEE

No

For more information on


DataAcq alarming, refer to
the Control Builder
Components Theory,
DATAACQ (Data Acquisition)
Block, Alarm processing.

ROCNEGALM.PR DataAcq

Negative
Rate-of-Change
Alarm Priority

Enumeration
ALPRIOR

None (0)
Journal (1)
Low (2)
High (3)
Urgent (4)

Yes

Engineer

CEE

No

For more information on


DataAcq alarming, refer to
the Control Builder
Components Theory,
DATAACQ (Data Acquisition)
Block, Alarm processing.

Off (0)
On (1)

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

0.0

Yes

Engineer

CEE

No

RESETFL

Off (0)

No

Other
Function
Block

CEE

No

RESETFL, STOPFL,
STARTFL,
COMMAND

None (0)

Yes

Engineer

CEE

No

HOLDOPT,
Illegal if
LASTOPREQ,
ControlModule.SCMOPT =
LASTOPTYPE,
None.
LASTSTEP, OPREQ,
OPTYPE, SAFEOP,
SCMASTEP [1..10],
SCMOPT,
SCMSTATE,
STARTOPT, STOPOPT

An Off-to-On transition of
RESTARTFL causes the timer
to restart.

SIFL, PV, SP, TRFB,


S1.

Low (2)

180

Parameter

Parameter

Specific to
Block(s)

Data Type

ROCNEGALM.SV DataAcq

Negative
Rate-of-Change
Alarm Severity

16-Bit Integer 0 to 15

ROCNEGALM.TP DataAcq

Negative
64-Bit Real
Rate-of-Change
Number
Alarm Trip Point (in
Engineering Units
per minute) Maximum change in
the Process Variable
(PV), in the negative
direction, before a
negative
rate-of-change
alarm is issued.

NaN, or
greater-than
or equal-to
0.0.

ROCPOSALM.FL

DataAcq

Positive
Rate-of-Change
Alarm Flag Indicates if a
positive
rate-of-change
alarm has been
issued.

Boolean

ROCPOSALM.PR DataAcq

Positive
Rate-of-Change
Alarm Priority

Enumeration
ALPRIOR

ROCPOSALM.SV DataAcq

Positive
Rate-of-Change
Alarm Severity

16-Bit Integer 0 to 15

ROCPOSALM.TP

Positive
64-Bit Real
Rate-of-Change
Number
Alarm Trip Point (in
Engineering Units
per minute) Maximum change in
the Process Variable
(PV), in the positive
direction, before a
positive
rate-of-change
alarm is issued.

DataAcq

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Yes

Engineer

CEE

No

For more information on


DataAcq alarming, refer to
the Control Builder
Components Theory,
DATAACQ (Data Acquisition)
Block, Alarm processing.

NaN

Yes

Engineer

CEE

No

PV, ROCNEGALM.FL, For more information on


ROCNEGALM.PR,
DataAcq alarming, refer to
ROCNEGALM.SV,
the Control Builder
Components Theory,
DATAACQ (Data Acquisition)
Block, Alarm processing.

Off (0):
Off (0)
Positive
rate-of-chang
e alarm does
not exist.
On (1):
Positive
rate-of-chang
e alarm
present.

No

View Only

CEE

No

PV, ROCPOSALM.PR,
ROCPOSALM.SV,
ROCPOSALM.TP.

None (0)
Journal (1)
Low (2)
High (3)
Urgent (4)

Low (2)

Yes

Engineer

CEE

No

PV, ROCPOSALM.FL,
ROCPOSALM.SV,
ROCPOSALM.TP.

Yes

Engineer

CEE

No

PV, ROCPOSALM.FL,
ROCPOSALM.PR,
ROCPOSALM.TP.

NaN

Yes

Engineer

CEE

No

PV, ROCPOSALM.FL, For more information on


ROCPOSALM.PR,
DataAcq alarming, refer to
ROCPOSALM.SV
the Control Builder
Components Theory,
DATAACQ (Data Acquisition)
Block, Alarm processing.

NaN, or
greater-than
or equal-to
0.0.

Related
Parameters

Notes

181

Description

Specific to
Block(s)

Description

Data Type

Range

Default

RSTPROCESSED

SCM

Reset Processed
Command

Boolean

Off (0)
On (1)

Off (0)

RT

RatioBias

Ratio Input Value (in Real


Engineering Units) The value by which
X1 is multiplied.

RTLOLM to
RTHILM

Config
Load

Access
Lock

Residence

Operator

Active
Connector

Related
Parameters

Notes

RT is an initializable input.

No

Yes

Operator

CEE

No

RTHILM, RTLOLM

No

View Only

CEE

No

RatioBias function
block maintains
separate BACKCALC
records for each of
its primaries, i.e.,
RTBACKCALOUT for
RT primary and
X1BACKCALOUT for
X1 primary.

CEE

No

RTLOLM

RTHILM

RTBACKCALOUT RatioBias

RT Secondary Data - Structure


Contains limits,
initialization data,
windup status, etc.
for the RT primary.

RTCONN

RatioBias

RT Connector

RTHIFL

RatioBias

RT High Flag

Boolean

Off (0)
On (1)

Off (0)

RTHILM

RatioBias

Ratio High Limit (in


Engineering Units)

Real

Greater-than
RTLOLM

100.0

RTLOFL

RatioBias

RT Low Flag

Boolean

Off (0)
On (1)

Off (0)

RTLOLM

RatioBias

Ratio Low Limit (in


Engineering Units)

Real

Less-than
RTHILM

0.001

Yes

Engineer

CEE

No

RTPPRESENT

AIM

RTP Present.

Boolean

Off (0)
On (1)

Off (0)

Yes

Application
Developer

CEE

No

RV

Timer

Remaining Time Integer


Indicates the current
remaining time until
the Timer function
block will time out.

0 to
0
2,147,483,647
(2^31-1)

No

View Only

CEE

No

RS, SR

S input value

Off (0)
On (1)

Yes

Engineer

CEE

No

S1

PidExtReset

Tracking control
switch.

Application
Developer

Boolean

Off (0)

View Only
Yes

Engineer
View Only

RTPPRESENT is only
configurable on the
Thermocouple module.
SP, PV, SO,
TIMEBASE

SIFL, PV, SP, RFB,


TRFB.

RV is equal to the difference


between the Set Point and
Process Variable (SP - PV).
Units are set by TIMEBASE.

182

Parameter

Parameter

Specific to
Block(s)

SAFEOP

Description

Data Type

Range

RegCtl Blocks:
Safe Output (OP)
AutoMan, Fanout, Value (in Percent)
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

64-Bit Real
Number

DevCtl

Safe Output State

SAFEOPCMD

PosProp,
PidPosProp

Safe Output (OP)


Command.

SAFEOUTPUT

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

NaN, or
NaN
OPEXLOLM to
OPEXHILM

Yes

Engineer

CEE

No

Enumeration
GENSTATE

S0(4): State0, S0(4)


State1, State2
S1(5): State1,
State0, State2
S2(6): State2,
State0, State1

Yes

Engineer

No

CEE

DIPVMAP [0..15],
STOPOPT, GOP,
GOPREQ, GPV,
HOLDOPT,
NUMDOUTS,
NUMSTATES, OI
[0..2], OP, OPCMD
[0..2], OPDOMAP
[0..3] [1..3], OPREQ,
PV, RESTARTOPT,
SEALOPT, SI,
STARTOPT

Enumeration
PULSECMD

Idle (0)
Raise (1)
Lower (2)

Idle (0)

Yes

Operator

CEE

No

PULSECMD,

Pulse Input w/ Fast Output Safe State Boolean


Cutoff IOC
Selects safe state of
the associated
Output. When
target is reached the
output is set to this
state.

Off (0)
On (0)

Off (0)

Yes

Application
Developer

CEE

No

Affects Channels 6-7 only.

SAFEOUTPUT
[6..7]

Pulse Input IOM

Output Safe State Boolean


Selects safe state of
the associated
Output. When
target is reached the
output is set to this
state.

Off (0)
On (0)

Off (0)

Yes

Application
Developer

CEE

No

Affects Channels 6-7 only.

SAFEREDTAG

DevCtl

Safe State Before


Boolean
RedTag Requires
that Output (OP) be
Safe before RedTag
may be set.

Off (0)
On (1)

Off (0)

Yes

Engineer

CEE

No

NaN causes the last good


value of OP to be used.

GOP, OP, REDTAG,


SAFEOP

Illegal if NUMDOUTS = 0.
SAFEOP may not be assigned
to a Momentary State.
S2 is illegal if NUMSTATES =
2.SAFEOP (cont.)

Illegal if NUMDOUTS = 0.

183

Specific to
Block(s)

Description

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

SAFESTATE
[0..numChans-1]

DOM

Safe State
Boolean
Specifies a safe
output state to be
assumed in the
event of a controller
failure or loss of
communication
between the
controller and IOM.

Off (0)
On (1)

Off (0)

Yes

Application
Developer

CEE

No

FAILSTATE
[0..numChans-1]

FAILSTATE must be enabled


in order to configure and use
the SAFESTATE.
If the IOM device itself fails,
the output value is not
deterministic.

SAMPLERATE

AIM, AOM
(Note that although
a part of the
configuration
assembly,
SAMPLERATE is not
used for output
modules.)

Sample Rate (msec) 32-Bit Integer Default Values


Defines the input
module sampling
period.

25 msec, No
with the
following
exception
s:
50 msec
for
Thermoco
uple and
RTD AIM
250 msec
for
Non-Isola
ted
(high-den
sity) AIM

AIM:
Application
Developer
AOM: View
Only

CEE

No

SIPTYPE
[0..numChans-1]

The parameter is not loaded,


but appears on the AIM
configuration form for
informational purposes.

SC.BYPPERM

Step

Step Stop Condition Boolean


Bypass Permit

Off (0)

Yes

Engineer

CEE

No

SC.BYPREQ, SC.FL

When On, SC.FL is set


according to SC.BYPREQ.

SC.BYPREQ

Step

Step Stop Condition Enumeration ToOff (0)


Bypass Request
CSCOBYPREQ ToOn (1)
None (2)

None (2)

No

Operator

CEE

No

SC.BYPPERM, SC.FL See SC.BYPPERM for


additional information.

Off (0)
On (1)

184

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

SC.CONFIGCODE Step

Step Stop Condition Enumeration See below.


None (0) No
View Only
Configuration Code CSCOCONFIG
CODECOND
Range
SyntaxError (16)
IntegerExp (32)
ExtUse48 (48)
None (0)
ExprTooCmplx (17) DoubleExp (33)
ExtUse49 (49)
Ok (1)
NotEPcodeMe (18) MissedImpl (34)
ExtUse50 (50)
UnknownError (2)
ImplicitConv (3)
NotEDataStak (19) UnicodeConv (35) UnSupConType (51)
UnsuppFeatur (20)
ConstExprRem (36) UnExpClsParn (52)
LossOfPrecsn (4)
UnexpctEnd (5)
ExprTooLong (21)
DuplExprRem (37) CantAssRVal (53)
ExtUse38 (38)
UnExpArrOpen (54)
UnexpctComma (6) DivideByZero (22)
ColonWoQMark (7) UnknownToken (23) ExtUse39 (39)
ArrClsExpect (55)
UnexpTokenOS (24) ExtUse40 (40)
ArrOpnExpect (56)
FctNotMltArg (8)
ClosParenExp (9)
UnknownFunc (25) ExtUse41 (41)
ArrIndxError (57)
UnexpOCExpr2 (26) ExtUse42 (42)
StringExpect (58)
OperandExp (10)
MissingArg (11)
UnexpOCExpr3 (27) ExtUse43 (43)
InvalidRefer (59)
ZeroArgument (28) ExtUse44 (44)
TooManyConnS (60)
OperatorExp (12)
ColonExp (13)
UnexpToken (29)
ExtUse45 (45)
CantConvInpt (61)
TypeMismatch (14) InvalResult (30)
ExtUse46 (46)
TypeNotSupp (15)
InvalTokenTb (31)
ExtUse47 (47)

CEE

No

See SC.CONFIGSTS for


additional information.

SC.CONFIGDESC Step

Step Stop Condition String


Configuration
Description

Maximum of None
39 characters.

No

View Only

CEE

No

See SC.CONFIGSTS for


additional information.

SC.CONFIGSTS

Step

Step Stop Condition Enumeration Ok (0)


Ok (0)
Configuration Status CSCOCONFIG Information (1)
STS
Warning (2)
SevereWarn
(3)
Error (4)
SevereError
(5)

No

View Only

CEE

No

SC.DESC

Step

Stop Stop Condition String


Description

Yes

Application
Developer

SR

No

SC.EXECCODE

Step

Step Stop Condition Enumeration None (0)


None (0)
Execution Code
CSCOEXECCO ConfigError (1)
DE
ExprEvalFail
(2)
StoreFailed (3)
CommError (4)
StoreWarning
(5)
InternalErr (6)
CtrlReqErr (7)
DataTypeErr
(8)
StorePending
(9)

No

View Only

CEE

No

String Length: Null


23 characters String

SC.CONFIGCODE,
SC.CONFIGDESC

Stop input condition


configuration status
parameters SC.CONFIGSTS,
SC.CONFIGCODE, and
SC.CONFIGDESC are set on
SCM STATE transition from
Inactive to Validated.

See SC.EXECSTS for


additional information.

185

Specific to
Block(s)

Description

Data Type

SC.EXECDESC

Step

Step Stop Condition String


Execution Code
Descriptor

SC.EXECSTS

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Maximum of None
39 characters.

No

View Only

CEE

No

Step

Step Stop Condition Enumeration Ok (0)


Ok (0)
Execution Status
CSCOEXECST Bypass (1)
S
Info (2)
Warning (3)
Fail (4)
Error (5)
OkPaused (6)
BypassPaused
(7)
InfoPaused (8)
WarnPaused
(9)
FailPaused
(10)
ErrorPaused
(11)

No

View Only

CEE

No

SC.EXPR

Step

Step Stop Condition String


Expression

String Length: Null


255
String
characters

Yes

Application
Developer

SR

No

SC.EXPRPCODE

Step

Internal parameter
for system use only.

SC.FL

Step

Step Stop Condition Boolean


Status Flag

Off (0)
On (1)

Off (0)

No

View Only

CEE

No

SC.INVOKFL

Step

Step Stop Condition Boolean


Invoke Flag

Off (0)
On (1)

Off (0)

No

View Only

CEE

No

SC.OPT

Step

Step Stop Condition Boolean


Option

Off (0)
On (1)

Off (0)

Yes

Application
Developer

CEE

No

SCANAREA

CM, CEE, CPM (100 Name of the Server String


and 200), SCM,
area.
IOM, RM

Maximum of 2 Null
characters
string

Application SCAN
Developer
RM only:
Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform.

No

Related
Parameters

Notes
See SC.EXECSTS for
additional information.

SC.EXECCODE,
SC.EXECDESC

Step Stop Condition


execution status parameters
SC.EXECSTS, SC.EXECCODE,
and SC.EXECDESC are
updated when the step is in
the Sequential Control
Modules (SCM) current
scope of execution.

SC.FL

Provides the status of the


steps stop condition at the
time the stop handler was
invoked.
SC.OPT must be set to On, to
enable the Step Stop
Condition.

186

Parameter

Parameter

Specific to
Block(s)

Description

SCANASSOCDSP CEE, CM, CPM (100 Name of Server


and 200), SCM,
Associated Display
IOM, RM

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

String

Maximum of
255
characters

Null
String

Application SCAN
Developer
RM only:
Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform.

No

SCANCTRLLVL

CEE, CM, CPM (100 Server security level. Integer


and 200), SCM,
IOM, RM.

0 to 255

200

Application SCAN
Developer.
RM only:
Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform.

No

SCANEUHI

SCM, IOM, CM,


Server engineering
CEE, CPM (100 and units high.
200), RM

String

Maximum of
255
characters.

Null
String

Application SCAN
Developer
RM only:
Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform.

No

SCANEULO

SCM, IOM, CM,


Server engineering
CEE, CPM (100 and units low.
200), RM

String

Maximum of
255
characters.

Null
String

Application SCAN
Developer
RM only:
Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform.

No

Related
Parameters

Notes

187

Specific to
Block(s)

SCANGRPDTL

SCANPNTDTL

Description

Data Type

Range

Default

CEE, CM, CPM (100 Name of Server


and 200), SCM,
group display.
IOM, RM

String

Maximum of
255
characters.

Null
String

Application SCAN
Developer
RM only:
Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform.

No

CEE, CM, CPM (100 Name of Server


and 200), SCM,
detail display.
IOM, RM

String

Maximum of
255
characters

Null
String

Application SCAN
Developer.
RM only:
Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform.

No

0 to 32,767

No

View Only

CEE

Null
String

Yes

Engineer

Manual
(4)

No

View Only

SCMASTEP [1..10] CM

Monitored
Sequential Control
Module (SCM)
Active Step

Integer

SCMID

CM

Sequential Control
Module Identifier

Entity Id
(Independent
Block Code)

SCMMODE

CM

Monitored
Enumeration None (0)
Sequential Control of SCMMODE Auto (1)
Module (SCM) Mode
SemiAuto (2)
SnglStep (3)
Manual (4)
Normal (5)

SCMMONITOR

SCM

Internal parameter
for system use only.

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

No

SCMOPT,
SCMMODE,
SCMSTATE

Invalid if SCMOPT = None.

CEE

No

SCMOPT

Identifies the SCM


controlling the Control
Module contained devices.
Applicable only when
SCMOPT is not equal to
NONE.

CEE

No

SCMOPT, SCMASTEP SCMMODE is invalid if


[1..10], SCMSTATE SCMOPT is NONE.

188

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

SCMMONSRC

CM

Internal parameter
for system use only.

SCMNAME

CM

Name of associated String


Sequential Control
Module (SCM).

String Length: Null


16 characters String

Yes

Application
Developer

SR

No

SCMASTEP [1..10], The block designated by


SCMID, SCMMODE, SCMNAME is the SCM
SCMSTATE
associated with the CM.
Parameters SCMASTEP
[1..10], SCMID, SCMMODE
and SCMSTATE reflect the
status of this SCM.
SCM Name is configurable
on CM configuration form. It
identifies the related SCM
and it cannot be changed
on-line.
This entry is not required if
SCMOPT selection is None.

SCMOPT

CM

Sequential Control
Module (SCM)
Option

None (0)
Fixed (1)
Dynamic (2)

Yes

Application
Developer

CEE

No

SCMID

Depending on the order in


which blocks are loaded, the
following status may be
returned for this parameter:
Referenced FB Not Found.
This indicates that a function
block was referenced which
has not yet been loaded to
the controller. When this
happens, no action is
required except to load the
referenced block before
putting the strategy on
control.

Enumeration
SCMOPT

None (0)

Specifies the relationship of


the Control Module and its
contained devices SCMs.

189

Specific to
Block(s)

Description

Data Type

Range

SCMSTATE

CM

Monitored
Enumeration
Sequential Control SCMSTATE
Module (SCM) State

SCSRC [1..6]

Step

Internal parameter
for system use only.

SDENUMTEXT

Type Convert

Enumeration Text

String

Maximum 12
characters

SEALOPT

DevCtl

Seal-in Option.

Enumeration
ENABLE

Disable (0)
Enable (1)

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

No

View Only

CEE

No

SCMOPT, SCMASTEP Invalid if SCMOPT = None.


[1..10], SCMMODE

SDENUM Yes
0 to
SDENUM
63

Engineer

SR

No

Disable
(0)

Engineer

CEE

No

Loading (0)
Null (2)
Loaded (1)
Inactive (2)
Validated (3)
Running (4)
Complete (5)
Checking (6)
Idle (7)
Interrupting
(8)
Interrupted (9)
Restarting (10)
Restarted (11)
Holding (12)
Held (13)
Stopping (14)
Stopped (15)
Aborting (16)
Aborted (17)
CommErr (18)

Yes

GOP, GOPFINAL,
MOMSTATE,
NUMDOUTS,
NUMDINPTS, OP,
OPFINAL, SAFEOP

Notes

Illegal if NUMDOUTS = 0 or
NUMDINPTS = 0.
Function block must be
InActive to change
SEALOPT.
Illegal if MOMSTATE is not
NONE.
Illegal if Command Disagree
is not configured [All
CMDDISALM.TM [x] = 0].

190

Parameter

Parameter

Specific to
Block(s)

SECINITOPT [1..8] All RegCtl Blocks:


AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Description

Data Type

Secondary
Enumeration
Initialization Option ENBSTATE
Indicates if a
Regulatory Control
function block
should accept or
ignore initialization
requests, and
override feedback
data from the
secondary. There is
one option
parameter for each
secondary. (The
number of
secondaries
depends on the
function block type.)

Range

Default

Config
Load

Disable (0):
Ignore
initialization
and override
data from
secondary.
Enable (1):
Accept
initialization
and override
data from
secondary.

Enable (1) Yes

Access
Lock

Residence

Active
Connector

Related
Parameters

Engineer

CEE

No

BACKCALCIN,
BACKCALCIN [1..3],
BACKCALCIN [1..8]

SECINITOPT1

RampSoak

SECMODNAME

CPM, RM

The name of the


secondary module.

BLOCKID

None

No

Engineer

SR

No

ABORTALM.PR

SECNAMESTRIN CPM, RM
G

The name of the


secondary module

String

None

Engineer

SR

No

ABORTALM.PR

SECTMPNAME

The name of the


String
secondary template

None

Application
Developer

SR

No

ABORTALM.PR

CPM, RM

Checked
(X)

Notes

No

191

Specific to
Block(s)

Description

Data Type

SELHANDLER
[1..8]
SELHANDLER
[1..8]

SCM

Selected Handler
Handle

BlockId

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

Null
String

Yes

Engineer

CEE

No

TYPE

A handler of TYPE is
assigned by setting
SELHANDLER [i] to that
handlers name (eg.
SCMName.HandlerName).
For example, to change the
selected Hold Handler (TYPE
6) to another named
Long-Hold, the assignment
SELHANDLER [6] =
LONGHOLD.Name would be
made. The recommended
method of deselecting a
handler of TYPE i is to set
SELHANDLER [i] = 0.
The selected handler of a
given TYPE can only be
changed if it is not currently
executing. The Main handler
selection cannot be changed
once the SCM transitions to
Running. The Interrupt
handler selection cannot be
changed if the currently
selected Interrupt handler is
being preempted. The Null
and Edit handler selections
cannot be changed by the
user or program.

192

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

SELHANDLERN
[1..8]

SCM

Specifies the
32-Bit Integer
component number
(within the CM) of
the selected handler
of the SCM for each
handler type.

No

Engineer

CEE

No

SELHANDLER [1..8]

The index identifies the


handler type as follows:
1-Edit, 2-Main, 3-Check,
4-Interrupt, 5-Restart,
6-Hold, 7-Stop, 8-Abort.
SELHANDLERN [1] cannot be
changed. SELHANDLERN [i]
cannot be changed when
handler type i is active, e.g.
the selected Hold handler
cannot be changed (via
SELHANDLERN [6]) when the
SCM STATE is Holding.
Setting SELHANDLERN [i] to
a value of 2047 will cause
the default null handler to be
selected for handler type i,
which means having no
user-defined handler
selected.
An SCM can be used to
change the selected handler,
using an Output expression.
For example:
SCMName.SELHANDLERN
[7] :=
SCMName.StopHandlerNam
e.NUM.
This will change the selected
Stop handler to the handler
StopHandlerName.

SELXDESC

Switch, OvrdSel,
RemCas

Selected Input
String
Descriptor 15-character
descriptor for the
currently-selected
input to the OvrdSel
and Switch function
blocks.

Length: 15
characters

Null
String

No

View Only

CEE

No

XDESC [1..8]

SELXFL [1..4]

OvrdSel

Input Selection Flags Boolean


- Identifies the
currently-selected
input to the OvrdSel
function block.
There is one flag per
input.

Off (0): Input is


not selected.
On (1): Input is
selected

SELXFL [1] No
= On (1)
All others
=Off (0)

View Only

CEE

No

SELXINP

193

Specific to
Block(s)

Description

SELXFL [1..8]

Switch, OvrdSel

SELXINP

Data Type

Range

Default

Input Selection Flags Boolean


- Identifies the
currently-selected
input to the Switch
function block.
There is one flag per
input.

Off (0): Input is


not selected.
On (1): Input is
selected

Switch

Selection ID Integer
Identifies the
currently-selected
input to the function
block.

OvrdSel, RemCas

SENDFL

SENDFL [0..15]

Access
Lock

Residence

Active
Connector

Related
Parameters

SELXFL [1] No
= On (1)
All others
=Off (0)

Operator

CEE

No

SELXINP

1 to 8

No

Operator

CEE

No

SELXFL [1..8],
SELXDESC

Selection ID Integer
Identifies the
currently-selected
input to the function
block.

1 to 4

No

View Only

CEE

No

SELXFL [1..8],
SELXDESC

All Exchange
Library Request
Array function
blocks:
REQFLAGARRAY,
REQNUMARRAY,
REQTEXTARRAY

The flag used as a Boolean


trigger for the
request block to
send a request to
the target. A
request is sent tothe
target when this flag
transitions from
False to True if the
READYFL parameter
was previously True.
For periodic reads or
writes, the READYFL
must be connected
to the SENDFL.

Off(0)
On(1)

Off(0)

No

View Only

CEE

No

Message

Send Flag

Off (0)
On (1)

Off (0)

Operator

CEE

Boolean

Config
Load

Notes

194

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

Range

Default

Config
Load

SENSORTYPE
[0..numChans-1]

AIM

Sensor Type

Enumeration See below.


SENSOR_ Yes
Application CEE
of
RTD:
Developer
SENSOR_RTD
Ohms (0)
for RTD AIM
SENSOR_
Enumeration
TC: MV
of
(0)
SENSOR_TC
for
Range
Thermocouple
SENSOR_RTD
SENSOR_TC
AIM
Ohms (0)
1000_PI_3916 (8)
MV (0) K (5)
100_PI_385 (1)
10_Cop_427 (9)
B (1)
N (6)
200_PI_385 (2)
120_Ni_672 (10)
C (2)
R (7)
500_PI_385 (3)
100_Ni_618 (11)
E (3)
S (8)
1000_PI_385 (4) 120_Ni_618 (12)
J (4)
T (9)
100_PI_3916 (5) 200_Ni_618 (13)
200_PI_3916 (6) 500_Ni_618 (14)
500_PI_3916 (7)

SERIALNUM

RM

Redundancy Module 32-Bit


Serial Number
Unsigned
Integer

0 to
4294967295

SHORT

DOC

Indicates that a
short circuit or
overload condition
exists.

Boolean

Short
condition does
not exist (0)
Short
condition
exists (1)

SHORT
[0..numChans-1]

DOM

Indicates that a
short circuit or
overload condition
exists.

Boolean

SI

DevCtl

Safety Override
Interlock

Boolean

No

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

No

OHMOFFSET
[0..numChans-1]

Configurable only on RTD


and Thermocouple AIMs.

GOP, NUMDOUTS, OI
[0..2], OP, SAFEOP,
SIALM.FL,
SIALM.OPT,
SIALM.PR,
SIALM.SV.

Engineer can change only


when function block is
inactive or CEE is idle.
Illegal if NUMDOUTS = 0

View Only. Not Loaded


RM only:
Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform.

No

Short
No
condition
does not
exist (0)

View Only

CEE

No

Short
condition does
not exist (0)
Short
condition
exists (1)

Short
No
condition
does not
exist (0)

View Only

CEE

No

Off (0)
On (1)

Off (0)

Engineer,
Other
Function
Block, (see
Notes)

CEE

No

No

195

Specific to
Block(s)

SIALM.FL

SIALM.OPT

Description

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

DevCtl
Safety Override
All RegCtl Blocks: Alarm
AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Boolean

Off (0): Is not


in Safety
Interlock
alarm.
On (1): Is in
Safety
Interlock
alarm
condition.

Off (0)

No

View Only

CEE

No

SIFL, SIALM.OPT,
DevCtl Only: Illegal if
SIALM.PR, SIALM.SV NUMDOUTS = 0.
DevCtl Only: INALM,
HIALM, NUMDOUTS,
SI

DevCtl

Safety Interlock
Alarm Option

Enumeration
OVRDALOP

No
Yes

Yes

Engineer

CEE

No

SIFL, SIALM.FL,
Illegal if NUMDOUTS = 0.
SIALM.PR, SIALM.SV To change, function block
must be InActive.

All RegCtl Blocks:


AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Safety Interlock
Enumeration
Alarm Option ENBSTATE
Indicates if Safety
Interlock alarming is
enabled.

Checked (X): Checked


Enable Safety (X)
Interlock
alarming
Unchecked ( ):
Disable Safety
Interlock
alarming

Yes

Engineer/Ap CEE
plication
Developer

No

SIFL, SIALM.FL,
SIALM.OPT
SIALM.PR, SIALM.SV

None (0)
Journal (1)
Low (2)
High (3)
Urgent (4)

Low (2)

Yes

Engineer

CEE

No

SIFL, SIALM.FL,
SIALM.OPT,
SIALM.SV
DevCtl Only:
NUMDOUTS, SI

DevCtl Only: Illegal if


NUMDOUTS = 0.

Yes

Engineer

CEE

No

SIFL, SIALM.FL,
SIALM.OPT,
SIALM.PR
DevCtl Only:
NUMDOUTS, SI

DevCtl Only: Illegal if


NUMDOUTS = 0.

SIALM.PR

DevCtl
Safety Interlock
All RegCtl Blocks: Alarm Priority
AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Enumeration
ALPRIOR

SIALM.SV

DevCtl
Safety Interlock
All RegCtl Blocks: Alarm Severity
AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

16-Bit Integer 0 to 15

Notes

196

Parameter

Parameter

Specific to
Block(s)

SIFL

SIOPT

Description

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

All RegCtl Blocks: Safety Interlock Flag Boolean


AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Off (0)
On (1)

Off (0)

No

Other
Function
Block

CEE

Default
Connector:
Input

SIOPT, SIALM.FL,
SIALM.OPT,
SIALM.PR, SIALM.SV

All RegCtl Blocks:


AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

See below.

ShedHold Yes
(1)

Engineer

CEE

No

SIFL, ESWENB,
MODE, MODEATTR,
OP

Safety Interlock
Enumeration
Option Indicates BADCTLOPT
what to do when
Safety Interlock Flag
(SIFL) is On.
No_Shed (0):

Notes

Range
MODE remains unchanged and OP is held at the last good value.

ShedHold (1): MODE is shed to Manual, MODEATTR goes to Operator, external


mode switching is disabled, and OP is held at the current value.
ShedLow (2):

MODE is shed to Manual, MODEATTR goes to Operator, external


mode switching is disalbed, and OP goes to OPEXLOLM.

ShedHigh (3): MODE is shed to Manual, MODEATTR goes to Operator, external


mode switching is disabled, and OP goes to OPEXHILM.
ShedSafe (4): MODE is shed to Manual, MODEATTR goes to Operator, external
mode switching is disabled, and OP goes to SAFEOP.
SIPTYPE
[0..numChans-1]

AIM, AOM

Channel Type /
Range Mode

Enumeration:
SIPTYPE
Enumeration:
RANGEMODE
(8-channel
AOM only)

SIPTYPE:
10V_Input (65)
RTD_SIP (66)
Thermocouple
(67)
10V_Output
(88)
4-20mA_Cur
(89)
RANGEMODE:
Voltage_Mod
e (0)
Current Mode
(1)

SLOTNUMBER

CPM, RM

Module Slot Number 32-Bit Integer 1 to 15

Specified Yes
appropria
tely on a
per
module
basis.

Application
Developer

CEE

No

Engineer

SR

No

No

SIPTYPE is only configurable


on an 8-channel AOM, which
operates in both current and
voltage modes.

ABORTALM.PR,

For the parameter to be


valid, the Default may not be
zero.

197

Specific to
Block(s)

Description

SO

Timer, Transition

DOC

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

Timer Status Output Boolean


- Indicates when the
timer has expired.

Off (0)
On (1)

Off (0)

No

View Only

CEE

No

SP, PV, RV

SO is set to On when the


timer expires, (i.e., PV = SP).
SO is returned to Off when
the timer is reset.

Status Output

Boolean

Off (0)
On (1)

Off (0)

No

Operator

CEE

Yes

DOMSO
[0..numChans-1]

Pulse Input w/ Fast Output State


Boolean
Cutoff IOC
Indicates current
state of the Output
associated with the
Pulse Input channel.

Off (0)
On (1)

Off (0)

No

View Only

CEE

No

Pulse Input IOM

Output State
Boolean
Indicates current
state of the Output
associated with the
Pulse Input Channel.

Off (0): Current Off (0)


state of the
output screw
is
de-energized.
On (1): Current
state of the
output screw
is energized.

No

Engineer

CEE

No

SO

SOAKTIME
RampSoak
[1..NUMPROFILES
]
[1..NUMRAMPSO
AK]

Soak Time (in


Minutes) - The
target soak times,
specified by the
user. There is one
soak time per
Ramp/Soak pair.

0.0 to 120.0

0.0

Yes

Supervisor

CEE

No

NUMRAMPSOAK
[1..NUMPROFILES],
RAMPRATE
[1..NUMPROFILES]
[1..NUMRAMPSOAK]
, SOAKVAL
[1..NUMPROFILES]
[1..NUMRAMPSOAK]
, STARTOP
[1..NUMPROFILES],
<STARTSEG
[1..NUMPROFILES]

SOAKVAL
RampSoak
[1..NUMPROFILES
]
[1..NUMRAMPSO
AK]

Soak Value (in


Real
Engineering Units) The target soak
values, specified by
the user. There is
one soak value per
Ramp/Soak pair.

NaN

Yes

Supervisor

CEE

No

NUMRAMPSOAK
[1..NUMPROFILES],
RAMPRATE
[1..NUMPROFILES]
[1..NUMRAMPSOAK]
, SOAKTIME
[1..NUMPROFILES]
[1..NUMRAMPSOAK]
, STARTOP
[1..NUMPROFILES],
STARTSEG
[1..NUMPROFILES]

SO [6..7]

Data Type

Real

This parameter can be set


from the Control Builder
configuration form. Writing
this parameter overrides any
SO set from the associated
PI channel with fast cutoff
block.

198

Parameter

Parameter

Specific to
Block(s)

SOCMDOFF

Description

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Pulse Input w/ Fast Command Status


Boolean
Cutoff IOC
Output Off storing
On to this parameter
will cause the
Output associated
with the Pulse Input
channel to be set
Off; reading this
parameter always
returns a value of
Off.

Off (0)
On (1)

Off (0)

No

Operator

CEE

No

SO

SOCMDON

Pulse Input w/ Fast Command Status


Boolean
Cutoff IOC
Output On storing
On to this parameter
will cause the
Output associated
with the Pulse Input
channel to be set
On; reading this
parameter always
returns a value of
On.

Off (0)
On (1)

Off (0)

No

Operator

CEE

No

SO

SOSOURCE

DOC

SOSTS

Pulse Input w/ Fast Status of Output


Cutoff IOC
(SO)

Boolean

Good (0)
Bad (1)

Good (0)

No

View Only

CEE

No

SO

SP

PID, PIDFF, PosProp Setpoint Value (in


Engineering Units)

64-Bit Real
Number

SPLOLM to
SPHILM

0.0

Yes

Operator

CEE

Yes

Timer

Integer

0 to
0
2,147,483,647
(2^31-1)

Yes

Operator

CEE

No

Timer Status Output


(SO) Source
Connector

Preset Time Value Sets the amount of


time that the Timer
function block is to
run.

Notes

Application
Developer

SP is an initializable input for


all function blocks
PV, RV, SO,
TIMEBASE

Units are set by TIMEBASE.

199

Specific to
Block(s)

Description

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

SPCONN

PID, PIDFF, PosProp Internal parameter Depending on


for system use only. the order in
which blocks
are loaded,
the following
status may be
returned for
this
parameter:
Referenced
FB Not
Found. This
indicates that
a function
block was
referenced
which has not
yet been
loaded to the
controller.
When this
happens, no
action is
required
except to load
the referenced
block before
putting the
strategy on
control.

SPEUHI

PID, PIDFF, PosProp Set Point (SP) High 64-Bit Real


Range (in
Number
Engineering Units) This value
corresponds to
100% of full-scale
value.

Same as
PVEUHI

Same as
PVEUHI

No

View Only

CEE

No

PVEUHI, PVEULO,
SPEULO

SPEUHI tracks PVEUHI

SPEULO

PID, PIDFF, PosProp Set Point (SP) Low 64-Bit Real


Range (in
Number
Engineering Units) This value
corresponds to 0%
of full-scale value.

Same as
PVEULO

Same as
PVEULO

No

View Only

CEE

No

PVEUHI, PVEULO,
SPEUHI

SPEULO tracks PVEULO.

SPFORMAT

PID, PIDFF, PosProp Set Point Display


Format

D0 (0)
D1 (1)
D2 (2)
D3 (3)

D1 (1)

No

View Only

No

PVFORMAT

Enumeration
PVFORMAT

200

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

SPHIFL

PID, PIDFF, PosProp Set Point (SP) High Boolean


Limit Flag
Indicates if SP has
exceeded its upper
limit, as specified by
the Set Point High
Limit (SPHILM).

SPHILM

Range

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Off (0): SP
Off (0)
high limit is
not exceeded.
On (1): SP high
limit is
exceeded.

No

View Only

CEE

No

SPHILM

PID, PIDFF, PosProp Set Point (SP) High 64-Bit Real


Limit (in Engineering Number
Units) - Defines the
upper limit for the
SP value.

NaN, or
SPLOLM to
PVEUHI

100.00

Yes

Engineer

CEE

No

SPHIFL

SPLOFL

PID, PIDFF, PosProp Set Point (SP) Low Boolean


Limit Flag
Indicates if SP has
exceeded its lower
limit, as specified by
the Set Point Low
Limit (SPLOLM).

Off (0): SP low Off (0)


limit not
exceeded.
On (1): SP low
limit
exceeded.

No

View Only

CEE

No

SPLOLM

SPLOLM

PID, PIDFF, PosProp Set Point (SP) Low 64-Bit Real


Limit (in Engineering Number
Units) - Defines the
lower limit for the
SP value.

NaN, or
PVEULO to
SPHILM

0.00

Yes

Engineer

CEE

No

SPLOFL

SPP

PID, PIDFF, PosProp Setpoint Value (in


Percent)

NaN

No

Operator

CEE

No

SP

SPRATEREQ

PID, PIDFF, PosProp Requested Set Point 64-Bit Real


(SP) ramp rate (from Number
Sequential Control
Module (SCM)
Control Request)

NaN, positive 0.0


or negative
Real number,
or 0.0

No

Operator

CEE

No

CONTROLREQ,
SPTVREQ,
LASTRATEREQ,
RESTARTOPT,
SCMOPT

A pending SPRATEREQ can


be canceled by setting it to
NaN.
Operator change requires
MODEATTR = Operator. A
SPRATEREQ should
immediately be followed by
a SPTVREQ.

SPREQ

PID, PIDFF, PosProp The requested SP


64-Bit Real
(Set Point) value.
Number
The SCM
CONTROLREQ wants
a step-change in the
regulatory control
blocks SP.

SPLOLM to
SPHILM

No

Operator

CEE

No

CONTROLREQ,
LASTSPREQ,
RESTARTOPT,
SCMOPT

A pending SPREQ can be


canceled by setting it to
NaN. Operator change
requires MODEATTR =
Operator.

64-Bit Real
Number

Default

Notes

Entering NaN disables SP


limit checking, by forcing
SPHILM to its extreme value
(PVEUHI).

Entering NaN disables SP


limit checking, by forcing
SPLOLM to its extreme value
(PVEULO).

201

Specific to
Block(s)

SPTV

PID, PIDFF, PosProp Set Point (SP) Target 64-Bit Real


Value (in
Number
Engineering Units)
Contains the target
SP value when SP
ramping is being
used.

SPTVDEVFL

SPTVDEVMAX

Description

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

NaN or
SPLOLM to
SPHILM

No

Operator

CEE

No

SPTVP

To invoke SP ramping, the


user must store a target SP
value (SPTV).
Note: In order to store the
SPTV, target value
processing must be enabled
byt not running (i.e.,
SPTVOPT = Enable, and
SPTVSTATE = Off or Preset).
When SPTV is stored, and
the function block is active,
the following will occur:
The system calculates a
ramp time (SPTVTIME),
based on the normal ramp
rate.
SPTVSTATE goes to Preset.

PID, PIDFF, PosProp Set Point (SP) Target Boolean


Value Deviation Flag
- This flag is set to
On (1) when the
difference between
the Process Variable
(PV) and the ramping
SP is greater than
SPTVDEVMAX.
While
SPTVDEVMAX is
exceeded, the
ramping is
temporarily stopped.
Ramping resumes
once the difference
between SP and PV
is less than
SPTVDEVMAX.

Off (0):
Off (0)
Deviation is
within limits.
On (1):
Deviation
exceeds
maximum; Set
Point (SP)
ramping has
temporarily
stopped.

No

View Only

CEE

No

SPTVDEVMAX

See below.

PID, PIDFF, PosProp Set Point (SP) Target 64-Bit Real


Value Maximum
Number
Deviation - The
maximum deviation
allowed during set
point ramping, in
engineering units.

NaN, or
greater than
0.0.

NaN

Notes
If the function block has a SP and PV input, the user can specify a maximum ramp deviation
(SPTVDEVMAX). If the maximum deviation is exceeded, SP ramping will stop until PV catches up
with the SP.
SPTVDEVMAX is the maximum deviation allowed during set point ramping, in engineering
units/min.
Guaranteed Maximum Ramp processing works as follows:
SPTVDEVMAX may be NaN or greter than zero. NaN means do not check ramp deviation.
If SPTVDEVMAX is not NaN, set point ramping stops when the absolute value of the deviation
(|PV - SP|) exceeds SPTVDEVMAX. The deviation flag (SPTVDEVFL) is set, and SPTVSTATE
remains in Run.
Ramping resumes as soon as the absolute value of the deviation returns within the limit. When
ramping resumes, the deviation flag (SPTVDEVFL) is reset.
Note: If the user has specified a ramp time, and ramping is interrupted by Guaranteed Max Ramp
processing, then the actual ramp time will be greater than the user-specified time.
Yes

Engineer

CEE

No

SPTVDEVFL

202

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

SPTVNORMRATE PID, PIDFF, PosProp Set Point (SP) Target 64-Bit Real
Value Normal Ramp Number
Rate - The rate that
the set point will
ramp, in engineering
units/min.

NaN, or
greater than
0.0.

NaN

Yes

Operator

CEE

No

SPTVTIME

This parameter allows the


user to start SP ramping
without having to specify a
ramp time. SPTVNORMRATE
may be NaN or greater than
zero. NaN means change
immediately (i.e., ramp time
= 0).
If the function block has a SP
and PV input, specify a
maximum deviation allowed
between PV and SP during
ramping (SPTVDEVMAX).

SPTVOPT

PID, PIDFF, PosProp Set Point (SP) Target Enumeration


Value Option ENBSTATE
Indicates if SP target
value processing is
requested.

Disable (0):
Disable
Target value (0)
processing is
not requested.
Enable (1):
Target value
processing is
requested.

Yes

Engineer

CEE

No

SPTV, SPTVDEVMAX, To invoke SP ramping, the


SPTVNORMRATE,
user must store a target SP
SPTVSTATE
value (SPTV).
Note: In order to store to
SPTV, target value
processing must be enabled
but not running (i.e.,
SPTVOPT = Enable, and
SPTVSTATE = Off or Preset).
When SPTV is stored, and
the function block is active,
the following will occur:
The system calculates a
ramp time (SPTVTIME),
based on the normal ramp
rate.
SPTVSTATE goes to Preset.

SPTVP

PID, PIDFF, PosProp Set Point (SP) Target 64-Bit Real


Value (in Percent)
Number

NaN

No

View Only

CEE

No

SPTV

SPTVRATE

PID, PIDFF, PosProp Set Point (SP) Target 64-Bit Real


Value Ramp Rate
Number
(calculated)

NaN

No

View Only

CEE

No

SPTVTIME

SPTVREQ

PID, PIDFF, PosProp Requested Set Point 64-Bit Real


(SP) target value.
Number
The SCM
CONTROLREQ sets a
target value in
regulatory control
blocks SP in
preparation for an
SP ramp request.

No

Operator

CEE

No

SPRATEREQ

NaN, or
SPLOLM to
SPHILM

A pending SPTVREQ can be


canceled by setting it to
NaN. Operator change
requires MODEATTR =
Operator.

203

Specific to
Block(s)

Description

Data Type

SPTVSTATE

PID, PIDFF, PosProp Set Point (SP) Target Enumeration


Value Processor
TVPROC
State - State of the
ramping function. A
state of RUN(2) is
required to start
ramping.

SPTVTIME

PID, PIDFF, PosProp Set Point (SP) Target 64-Bit Real


Value Ramp Time
Number

SRC

Auxcalc, RegCalc

Internal parameter Depending on


for system use only. the order in
which blocks
are loaded,
the following
status may be
returned for
this
parameter:
Referenced
FB Not
Found. This
indicates that
a function
block was
referenced
which has not
yet been
loaded to the
controller.
When this
happens, no
action is
required
except to load
the referenced
block before
putting the
strategy on
control.

SSTEPLOCK

SCM

Single Step Mode


Access Lock

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Off (0): No
Off (0)
target value
processing.
Preset (1):
Set-up the SP
target value
and ramp
time.
Run (2):
Perform the
SP ramping
function.

No

Operator

CEE

No

Greater than
or equal to
0.0.

Yes

Operator

CEE

No

SPTVRATE

Enumeration Operator (0) Engineer Yes


CSCOACCLOC Engineer (1) (1)
K
View Only (2)
OtherFB (3)

Engineer

CEE

No

MODE

0.0

Related
Parameters

Notes

The value of SSTEPLOCK


restricts who can change the
Sequential Control Module
(SCM) MODE to SingleStep.

204

Parameter

Parameter

Specific to
Block(s)

Description

STARTFL

Totalizer, Pulse
Input Totalizer

STARTINDEX

Data Type

Range

Default

Start Totalizer
Boolean
Command Flag When this flag
changes from Off to
On, the Totalizer
function block starts
the accumulator.

Off (0): Do not


start the
accumulator
On (1): Start
the
accumulator

Timer

Start Command Flag Boolean


- Provides the ability
to issue the Start
command to Timer
function block.

Off (0)
On (1)

SIFLAGARRCH,
SINUMARRCH,
SITEXTARRCH

Starting Element
Index Identifies
the start of the
contiguous array in
the device.

32-Bit Integer 0 to 99,999

STARTOP
RampSoak
[1..NUMPROFILES
]

Starting Output (OP) Real


Value for a
RampSoak profile.

STARTOPT

Starting State
Option - A
configurable
parameter that
specifies the action
the control device
takes, when
SCMSTATE is
Checking, Idle, or
Complete.

DevCtl,
All RegCtl Blocks:
AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Enumeration
REGEXCOPT

None (0):

See below.

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Off (0): Do No
not start
the
accumula
tor

Other
Function
Block

CEE

No

RESETFL, STOPFL

Off (0)

No

Other
Function
Block

CEE

No

RESETFL, STOPFL,
RESTARTFL,
COMMAND

Yes

Application
Developer

CEE

No

0.0

Yes

Operator

CEE

No

STARTSEG
[1..NUMPROFILES]

None (0)

Yes

Engineer

CEE

No

STARTRATE,
STARTVAL

Range
No changes

Man (1):

Set MODEREQ = Manual

Auto (2):

Set MODEREQ = Auto

Cas (3):

Set MODEREQ = Cas

FixedOP (4):

Set OPREQ = STARTVAL

HoldPV (5):

Set SPREQ = PV

FixedSP (6):

Set SPREQ = STARTVAL, and


SPRATEREQ = NaN

Notes

An Off-to-On transition of
STARTFL starts the timer.

Refer to the Allen-Bradley


Interface Appendix and the
MODBUS Interface Appendix
in the Control Builder
Parameter Reference for
additional configuration
data.

Defines values for SPREQ,


SPRATEREQ, OPREQ, and
MODEREQ when
MONSCOSTATE = Ready,
Checking, or End.
Illegal if SCMOPT = None.

RampedSP (7): Set SPTVREQ = STARTVAL, and


SPRATEREQ = STARTRATE

205

Specific to
Block(s)

Description

STARTRATE

All RegCtl Blocks:


AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Starting State Set 64-Bit Real


Point (SP) Ramp Rate Number
- The value used for
setting SPRATEREQ,
when STARTOPT is
Ramped SP.

STARTSEG
RampSoak
[1..NUMPROFILES
]
STARTVAL

All RegCtl Blocks:


AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

NaN, 0.0, or NaN


positive or
negative Real
numbers

Yes

Engineer

CEE

No

STARTOPT

Defines value for


SPRATEREQ, when
STARTOPT = RampedSP.

Starting Segment ID Integer

Greater than
zero

Yes

Operator

CEE

No

STARTOP
[1..NUMPROFILES]

Starting State Value 64-Bit Real


- The value used for Number
setting OPREQ,
when STARTOPT is
FixedOP; or for
setting SPREQ or
SPTVREQ, when
STARTOPT is
FixedSP or
RampedSP.

OPEXLOLM to NaN
OPEXHILM,
when
STARTOPT =
FixedOP.
SPLOLM to
SPHILM,
when
STARTOPT =
FixedSP or
RampedSP.
(NaN, 0.0,
positive or
negative real
numbers)

Yes

Engineer

CEE

No

STARTOPT

Defines a value for OP, when


STARTOPT = FixedOP;
or a value for SP, when
STARTOPT = FixedSP;
Or a value for SPTV, when
STARTOPT = RampedSP.

206

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

STATE

Totalizer, Pulse
Input Totalizer

Totalizer State Enumeration


Indicates the current STATE
state of the Totalizer
function block.

Timer

Timer State Indicates current


state of Timer
function block.

SCM

SCM State Indicates current


state of the SCM
function block.

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Stopped (0)
Stopped
Running (1) - (0)
(accumulating)

No

View Only

CEE

No

RESETFL, STARTFL,
STOPFL

Enumeration
TIMERSTATE

Stopped (0)
Running (1)

Stopped
(0)

No

View Only

CEE

No

COMMAND

Enumeration
CSCOSTATE

See below.

Inactive
(2)

No

View Only

CEE

No

Refer to the SCM STATE


transition diagram, SCM
STATE and COMMAND
interraction, in the Control
Builder Components Theory
Manual for additional
information.

STATE (cont.)

Loading (0)
Loaded (1)
Inactive (2)
Validated (3)
Running (4)
Complete (5)
Checking (6)

Range

Range
Idle (7)
Interrupting (8)
Interrupted (9)
Restarting (10)
Restarted (11)
Holding (12)
Held (13)

Default

Stopping (14)
Stopped (15)
Aborting (16)
Aborted (17)
CommErr (18)

Notes

Handler, Step,
Transition

Sequential Control
Module (SCM)
Component State

Enumeration Edit (0)


Edit (0)
CSCOPARTST Inactive (1)
ATE
Disabled (2)
Enabled (3)
Active (4)
ActiveComplt
(5)
ProcOutputs
(6)
ProcMessages
(7)
ProcMinWait
(8)

No

View Only

CEE

No

STATE0

Flag

State 0 Indicator

Boolean

Off (0)
On (1)

Off (0)

No

View Only

CEE

No

PV, PVFL, STATE1

Value is On, when Flag


function block is in State 1
(Process Variable (PV) shows
STATETEXT [0] and PVFL is
Off).

STATE1

Flag

State 1 Indicator

Boolean

Off (0)
On (1)

Off (0)

No

View Only

CEE

No

PV, PVFL, STATE0

Value is On, when Flag


function block is in State 1
(Process Variable (PV) shows
STATETEXT [1] and PVFL is
On).

207

Specific to
Block(s)

Description

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

STATETEXT [0..1] Flag

State Descriptor
String
Text - Defines text
for the two states of
the Flag FB;
STATETEXT [0]
corresponds to the
Boolean state of Off
for the Flag, while
STATETEXT [1]
corresponds to On.

Length: 12
characters

Off,
On

Yes

Engineer

CEE

No

NORMAL, PV

STATETEXT [0..6] DevCtl

Text for Defined


States

String

Length: 12
characters

Null
String

Yes

Engineer

CEE

No

LASTOPREQ,
NUMDINPTS,
NUMDOUTS, PV,
PVAUTO, OP,
OPFINAL, OPREQ

Access is illegal if
NUMDINPTS = 0, and
NUMDOUTS = 0.

STATETIME [0..2] DevCtl

Accumulated State
Time - The amount
of time (in hours)
that the device has
spent in any of the
settable states.

DeltaTime

0 to 4000 days 0

No

View Only

CEE

No

GPV, MAINTOPT,
NUMSTATES, PV,
RESETFL

Defaulted to 0 if MAINTOPT
is not set On.
Reset to 0 whenever
RESETFL is set from Off to
On.
STATETIME [2] is illegal if
NUMSTATES = 2.

STATSRESET

Reset statistics
Boolean
command parameter

On (0)
Off (1)

No

Operator

CEE

No

CPUFREEAVG,
CPUFREEMIN,
CPUCYCLEAVG
[0..39],
CPUCYCLEMAX
[0..39],
NUMPARRSPAVG,
NUMPARRSPMAX,
NUMNTFRQUAVG,
NUMNTFRQUMAX,
NUMACCRQUMAX,
RDNDELAYAVG,
RDNDELAYMAX,
RDNXFERAVG,
RDNXFERMAX

Store to this parameter


causes initialization of all
statistics parameters
maintained within the CPM
and CEE (listed above). Any
attempts to read this
parameter will return Off(1).

CEE, CPM

Off (0)

208

Parameter

Parameter

Specific to
Block(s)

Description

STDTIME

RM

STEPALM.FL

Data Type

Range

Default

Standard or Daylight Enumeration


Savings Time

Standard (0)
Daylight (1)

Standard No
(0)

SCM

Sequential Control Boolean


Module (SCM) Step
Timeout Alarm Flag

Off (0)
(1)

STEPALM.PR

SCM

Sequential Control Enumeration


Module Step
ALPRIOR
Timeout Alarm
Priority - Specifies
alarm priority for the
SCM Step Timeout
alarm.

None (0)
Journal (1)
Low (2)
High (3)
Urgent (4)

STEPALM.SV

SCM

STICTIONL

STICTIONR

On Off (0)

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

When On, this indicates that


the SCM Step Timeout Alarm
condition (the Active SCM
Step has remained active for
longer than the configured
maximum step time,
MAXTIME) exists.

Operator
Not Loaded
RM only:
Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform
(through
Control
Builder or
Server).

No

View Only

CEE

No

STEPALM.PR,
STEPALM.SV,
MAXTIME

Low (2)

Yes

Engineer

CEE

No

STEPALM.FL,
STEPALM.SV

Sequential Control 16-Bit Integer 0 to 15


Module (SCM) Step
Timeout Alarm
Severity - Specifies
the alarm severity
for the SCM Step
Timeout alarm.

Yes

Engineer

CEE

No

STEPALM.FL,
STEPALM.PR

PosProp,
PidPosProp

Stiction Lower
Compensation of
actuator (in
seconds).

Real

0.0 to 60.0

0.0

Yes

Supervisor

CEE

No

PosProp,
PidPosProp

Stiction Raise
Compensation of
actuator (in
seconds).

Real

0.0 to 60.0

0.0

Yes

Supervisor

CEE

No

209

Specific to
Block(s)

Description

STOPALM.FL

SCM

STOPALM.PR

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Sequential Control Boolean


Module (SCM) Stop
Alarm Flag

Off (0)
On (1)

Off (0)

No

View Only

CEE

No

STOPALM.PR,
When On, it indicates that
STOPALM.SV, STATE the Stop Alarm condition
(SCM STATE has transitioned
to Stopping or Stopped)
exists.

SCM

Sequential Control Enumeration


Module (SCM ) Stop ALPRIOR
Alarm Priority

None (0)
Journal (1)
Low (2)
High (3)
Urgent (4)

Low (2)

Yes

Engineer

CEE

No

STOPALM.FL,
STOPALM.SV

See STOPALM.FL for


additional information.

STOPALM.SV

SCM

Sequential Control 16-Bit Integer 0 to 15


Module (SCM) Stop
Alarm Severity

Yes

Engineer

CEE

No

STOPALM.FL,
STOPALM.PR

See STOPALM.FL for


additional information.

STOPFL

Totalizer, Pulse
Input Totalizer

Stop Totalizer
Boolean
Command Flag When flag changes
form Off to On, the
Totalizer block stops
the accumulator.

Off (0): Do not


stop the
accumulator
On (1): Stop
the
accumulator

Off (0): Do No
not stop
the
accumula
tor

Other
Function
Block

CEE

No

RESETFL, STARTFL

Timer

Stop Command Flag Boolean


- Provides ability to
issue Stop command
to Timer function
block.

Off (0)
On (1)

Off (0)

Other
Function
Block

CEE

No

RESETFL,
RESTARTFL,
STARTFL,
COMMAND

No

Notes

An Off-to-On transition of
STOPFL stops the timer.

210

Parameter

Parameter

Specific to
Block(s)

Description

STOPOPT

All RegCtl Blocks:


AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

STOPRATE

Data Type

Active
Connector

Related
Parameters

Fail State Option A Enumeration See below.


None (0) Yes
Engineer
CEE
configurable
REGEXCOPT
parameter that
specifies the action
Range
the control device
None (0):
No changes
takes, when
SCMSTATE is
Man (1):
Set MODEREQ = Manual
Stopping or
Auto (2):
Set MODEREQ = Auto
Stopped, or Aborting
or Aborted. This
Cas
(3):
Set
MODEREQ = Cas
option should be
disabled, when
FixedOP (4):
Set OPREQ = STOPVAL
sequencing actions
HoldPV
(5):
Set SPREQ = PV
are required as part
of the SCM. In this
FixedSP (6):
Set SPREQ = STOPVAL, and SPRATEREQ = NaN
case, the SCM
RampedSP
(7):
Set SPTVREQ = STOPVAL, and SPRATEREQ =
should execute its
STOPRATE
Stop Handler. The
SCM can also
disable this option.

No

STOPVAL, STOPRATE Defines values for the


following: SPREQ,
SPRATEREQ, OPREQ and
MODEREQ when
ControlModule. SCMSTATE =
Stopping or Stopped.

DevCtl

Fail State Option

All RegCtl Blocks:


AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Stop State Set Point 64-Bit Real


(SP) Ramp Rate - The Number
value used for
setting SPRATEREQ,
when STOPOPT is
RampedSP.

Enumeration
DDOPTIONS

Range

None (0)
SafeOp (1)

Default

None (0)

NaN, 0.0,
NaN
positive or
negative Real
numbers

Config
Load

Access
Lock

Residence

Notes

Yes

Engineer

CEE

No

HOLDOPT, OPREQ,
Illegal if
OPTYPE,
ControlModule.SCMOPT =
RESTARTOPT,
None.
SAFEOP, SCMASTEP
[1..10], SCMOPT,
SCMSTATE,
STARTOPT

Yes

Engineer

CEE

No

STOPOPT

Defines values for


SPRATEREQ when STOPOPT
= RampedSP.

211

Specific to
Block(s)

Description

Data Type

STOPVAL

All RegCtl Blocks:


AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Stop State Value - 64-Bit Real


The value used for Number
setting OPREQ,
when STOPOPT is
FixedOP; or for
setting SPREQ or
SPTVREQ, when
STOPOPT is FixedSP
or RampedSP.

STR [0..7]

REQTEXTARRCH,
RSPTEXTARRAY

STR [1..8]

SITEXTARRCH

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

OPEXLOLM to NaN
OPEXHILM
when
STOPOPT =
FixedOP
SPLOLM to
SPHILM when
STOPOPT =
FixedSP or
RampedSP.
(NaN, 0.0,
positive or
negative Real
numbers)

Yes

Engineer

CEE

No

STOPOPT

Defines a value for: Output


(OP) when STOPOPT =
FixedOP;
Or SP when STOPOPT =
FixedSP;
Or SPTV when STOPOPT =
RampedSP.

Array of strings to be String


read from or written
to the third-party
device. Stores are
accepted to this
parameter only if hte
COMMAND
indicates that this is
a write block.

Length: 8, 16,
or 64
characters, as
specified by
STRLEN.

Yes

Operator

CEE

No

ERRFL, NSTRING,
STRLEN

STR [i] provides access to the


array of data, one element at
a time, by all other function
blocks of the CEE. Initial
values can be configured, but
these will be overwritten
once good data is imaged
from the Serial Interface
Module. When ERRFL is On,
an error will be returned on
attempted Gets and Stores
to this parameter, to indicate
that there is a problem with
the array data.

Process Value
Provides String
value from the
device.

Length: 8, 16, Null


or 64
String
characters, as
specified by
STRLEN.

Yes

Determined CEE
by ACCLOCK

No

ERRFL, NSTRING,
STRLEN

STR [i] provides access to the


array of data, one element at
a time, by all other function
blocks of the CEE. Initial
values can be configured, but
these will be overwritten
once good data is imaged
from the Serial Interface
Module. When ERRFL is On,
an error will be returned on
attempted Gets and Stores
to this parameter, to indicate
that there is a problem with
the array data.

String

Range

Default

212

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

Range

Default

STR [1..120]

TEXTARRAY

String Data
Provides access to
the String values,
one element at a
time, for all other
function blocks of
the CEE. Initial
values can be
configured.

String

Length: 8, 16, Null


32, or 64
String
characters, as
specified by
STRLEN.

STRLEN

TEXTARRAY,
SITEXTARRCH

String Length of
32-Bit Integer Length: 8, 16, 8
String Values
32, or 64
Specifies the
characters.
number of
characters per string
value.

Config
Load

Access
Lock

Yes

Yes

Residence

Active
Connector

Related
Parameters

Determined CEE
by ACCLOCK

No

NSTRING, STRLEN

Application
Developer

No

TEXTARRAY:
See below.
NSTRING, STR
[1..120]
SITEXTARRCH:
NSTRING, STR [1..8]

CEE

Notes

Notes
The Text Array block supports a maximum size of 960 two-byte characters. This number is
chosen based on the amount of data that can fit in one ControlNet message. This is important
when full array access is supported. The following table shows the maximum data
combinations of NSTRING and STRLEN that are possible. Illegal combinations of NSTRING
and STRLEN (those requiring more than 960 two-byte characters of data) will be rejected.
NSTRING

STRLEN

STR [ ] Range

15

64

1..15

30

32

1..30

60

16

1..60

120

1..120

SITEXTARRCH only: With the interface to the serial device haivng a maximum size of
64-bytes, the table below shows how the 64-bytes are interpreted, based on the NSTRING
and STRLEN configured, and the resulting STR [ ] range. Illegal combinations of NSTRING and
STRLEN (those requiring more than 64-bytes of data) will be rejected.

REQTEXTARRAY,
RSPTEXTARRAY

STRLEN

STR [ ] Range

64

1..1

32

1..2

16

1..4

1..8

Yes

Application
Developer

CEE

No

213

The maximum length 32-Bit Integer 1 to 8


of each string that
must be read or
written. The product
of NSTRING and
STRLEN cannot
exceed 64.

NSTRING

Specific to
Block(s)

Description

SUBSCPERIOD

CEE

Peer Update Rate for Enumeration See below.


Peer-to-Peer
of
communications
SUBSPERIOD
between two or
more CEEs (Control
Execution
Environments) in
milliseconds (ms)
from the
following Range.

Configurable
Range:
10 to 1000 ms
DEFAULT (0)
10 ms (1)
20 ms (2)
50 ms (3)
100 ms (4)
200 ms (5)
500 ms (6)
1000 ms (7)

Range
Valid Range for
50 ms CEE:
100 to 1000 ms
DEFAULT (0)
100 ms (4)
200 ms (5)
500 ms (6)
1000 ms (7)

Data Type

Range

Valid Range for


50 ms CEE:
10 to 1000 ms
DEFAULT (0)
10 ms (1)
20 ms (2)
50 ms (3)
100 ms (4)
200 ms (5)
500 ms (6)
1000 ms (7)

Default

Config
Load

DEFAULT Yes
(0)
DEFAULT
is
converted
to an
actual
value
upon
load:
Converted
to 500 ms
for the 50
ms CEE
Converted
to 100 ms
to the 5
ms CEE

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

Engineer

CEE

No

BASEPERIOD

See below.

Notes
The Peer Update Rate (SUBSCPERIOD parameter is the rate at which
this CEE subscribes to data from other CEEs through peer-to-peer
communications. In the event of a peer-to-peer communications
problem such as a broken cable, the connection will timeout, returning
an error. The valid values and function of the DEFAULT value for
SUBSCPERIOD are different for the 50 and 5 ms CEE personalities as
described below.
50 ms CEE:
Valid Range: DEFAULT, 100, 200, 500, 1000 ms
DEFAULT value is converted to 500 ms upon load to a 50 ms CEE.
Connection timeout time is approximately 5.2 seconds.
5 ms CEE:
Valid Range: DEFAULT, 10, 20, 50, 100, 200, 500, 1000 ms
DEFAULT value is converted to 100 ms upon load to a 5 ms CEE.
Connection timeout time is approximately 5.2 seconds.

SWAPCTRLCMD

RM

Swap Control
Command

Boolean

True (0)
False (1)

No

Not Loaded
Operator
RM only:
Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform.

SWAPPOSCMD

RM

Swap Position
Command

Enumeration

Chassis_A (0)
Chassis_B (1)

No

Operator
Not Loaded
RM only:
Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform.

214

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

Range

SWAPSBYCMD

RM

Swap to Standby
Command

Boolean

True (0)
False (1)

SYNCSECCMD

RM

Synchronize
Secondary
Command

Boolean

True (0)
False (1)

T1

PID, PIDFF

Integral Time
Constant (in
Minutes)

64-Bit Real
Number

T1HILM

PID, PIDFF

T1 High Limit

T1LOLM

PID, PIDFF

T2

Config
Load

Access
Lock

No

Operator
Not Loaded
RM only:
Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform.

True (0)

No

Operator
Not Loaded
RM only:
Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform.

T1LOLM to
T1HILM

0.0

Yes

Supervisor

64-Bit Real
Number

T1LOLM to
1660.0

1440.0

Yes

T1 Low Limit

64-Bit Real
Number

Greater than
T1HILM

0.0

PID, PIDFF

Derivative Time
Constant (in
Minutes)

64-Bit Real
Number

T2LOLM to
T2HILM

T2HILM

PID, PIDFF

T2 High Limit

64-Bit Real
Number

T2LOLM to
1440.0

T2LOLM

PID, PIDFF

T2 Low Limit

64-Bit Real
Number

0.0 to T2HILM 0.0

TARGETSTEP
[1..10]

SCM

Target Step Name

BlockId

TBREF [0..2]

CM

Structure

Default

Related
Parameters

CEE

No

T1HILM, T1LOLM

Engineer

CEE

No

T1, T1LOLM

Yes

Engineer

CEE

No

T1, T1HILM

0.0

Yes

Supervisor

CEE

No

T2HILM, T2LOLM

1440.0

Yes

Engineer

CEE

No

T2, T2LOLM

Yes

Engineer

CEE

No

T2, T2HILM

No

Operator

CEE

No

MODE, STATE,
SSTEPLOCK

No

Application
Developer

CEE

No

Notes

TARGETSTEP [i] defines the


name (eg.
SCMName.StepName) of the
Step on thread i that will
become the active step when
a Resume COMMAND is
given. It may only be
changed while the
SCM.MODE = SingleStep.
215

Active
Connector

Null
String

Residence

Specific to
Block(s)

Description

Data Type

Range

Default

TEMPMODE

AIM

Temperature Mode

Enumeration
of
TEMPMODE

Celcius (0)
Farenheit (1)

TGTDATATYPE

REQNUMARRAY
when COMMAND
is PLC5TypWrite or
CIPWrite

The data type in the Enumeration


target device. The
data values will be
converted into this
type before being
written to the target
device. The
following values are
supported for this
parameter:
32-Bit Real
Number
8-Bit Signed
Integer
16-Bit Signed
Integer
32-Bit Signed
Integer

Access
Lock

Residence

Active
Connector

Celcius (0) Yes

Application
Developer

CEE

No

Yes

Application
Developer

CEE

No

TGTRNGDEF

SCM

Internal parameter
for system use only.

TGTRNGDEFOPT SCM

Internal parameter
for system use only.

THREAD [1..10]

SCM

Internal parameter
for system use only.

THRESHOLD

TypeConvert

Threshold for
converting floating
point values to
boolean values

0.001

Yes

Engineer

CEE

No

IN.FLOAT32,
IN.FLOAT64,
OUT.BOOLEAN

TIME

Step

Current Time in Step 32-Bit Integer 0 to


2147483647

No

View Only

CEE

No

MAXTIME, MINTIME TIME contains the number of


execution cycles that the
step has been active. It is
reset to 0 when the step is
reentered.

32-Bit Real
Number

Real

Config
Load

Related
Parameters

Notes
Configurable only on RTD
and Thermocouple AIMs.

This is applicable for


conversion between floating
point and boolean values.
If the input value is larger
than THRESHOLD, then the
OUT is TRUE. Otherwise it is
FALSE.
If the THRESHOLD = NaN, for
any nonzero input value, OUT
is TRUE. Otherwise it is
FALSE.

216

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

TIME [1..8]

SCM

Current Time in
Handler

32-Bit Integer 0 to
2147483647

No

View Only

CEE

No

TYPE

TIME [i] contains the number


of execution cycles since the
TYPE i handler was last
invoked. It contains 0 if
the TYPE i handler is not
currently active.

TIMEBASE

Totalizer

Totalizer Time Base - Enumeration


Defines whether the TIMEBASE
Process Input Value
(P1) input should be
sampled every
second, minute, or
hour.

Seconds (0)
Minutes (1)
Hours (2)

Minutes
(1)

Yes

Engineer

CEE

No

Timer

Time Base Sets


the units that are
used in the Timer
function block.

Enumeration
TIMEBASE

Seconds (0)
Minutes (1)
Cycles (2)

Seconds
(0)

Yes

Engineer

CEE

No

SP, PV, RV

Start Timer is started; PV


starts incrementing.
Stop Timer is stopped; PV
freezes.
Reset Timer is reset; PV is
set to 0, and RV is set to SP.
Restart - Timer continues
from the point it last
stopped.

Pulse Input IOC,


Pulse Input w/ Fast
Cutoff IOC, Pulse
Input Totalizer

Time Base Used to Enumeration


scale a pulse
frequency to
Engineering Units.
(Units of time used
for RATE value
calculation.)

Seconds (0)
Minutes (1)
Hours (2)

Seconds
(0)

Yes

Application
Developer
Pulse Input
Totalizer
only:
Engineer

CEE

No

TIMEBASE [0..7]

Pulse Input IOM

Time Base Units of Enumeration


time for frequency
and pulse length
values calculated in
Engineering Units.

Seconds (0)
Minutes (1)
Hours (2)

Seconds
(0)

Yes

Application
Developer

CEE

No

TMOUTFL

All RegCtl Blocks:


AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Timeout Flag Indicates if an


initializable input
has timed-out.

Off (0): No
Off (0)
time-out
On (1): Input
has timed-out

No

View Only

CEE

No

Boolean

Range

TMOUTMODE,
TMOUTTIME

217

Specific to
Block(s)

Description

Data Type

TMOUTMODE

Fanout, OvrdSel,
PID, PIDFF, PosProp,
RemCas, RatioBias,
and RegCalc.

Timeout Shed Mode Enumeration


- The mode that a
REGMODE
function block sheds
to when an
initializable input
times out.

TMOUTTIME

All RegCtl Blocks:


AutoMan, Fanout,
OvrdSel, PID, PIDFF,
PosProp,
PulseCount,
PulseLength,
RampSoak,
RemCas, RatioBias,
RegCalc, and
Switch.

Timeout Time - The Integer


maximum time
between successive
updates on an
initializable input.
If the updates are
not received within
the specified time,
the input is assumed
to have timed out.

TOTALMEM

CPM

Total size of CEE


user memory pool.

TOTALMEMINK

CPM

Total size of CEE


user memory pool.

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

None (0): No Man (2)


mode
shedding
Auto (1): Shed
to Auto mode
Man (2): Shed
to Manual
mode

Yes

Engineer

CEE

No

TMOUTFL,
TMOUTTIME

0 to 1000
seconds

Yes

Engineer

CEE

No

TMOUTFL,
TMOUTMODE

When the connection for


which timeout processing is
used (eg. SP on Pid) is from a
different controller
(peer-to-peer) it is important
to note that the timeout time
(TMOUTTIME) configured in
the RegCtl block is actually
in addition to the CDA
timeout of the peer
connection. The CDA
timeout is equal to 4 times
the CEE subscription rate.
For example, with a CEE
subscription rate of 100
milliseconds, and a
TMOUTTIME of 5 seconds,
the actual time (after data
can no longer be fetched)
before the RegCtl block
executes the timeout action
will be at least 5.4 seconds
(4 100ms + 5s).

32-Bit Integer 0 to 4194304


Bytes

No

View Only

CEE

No

FREEMEM,
USEDMEM,
MAXFREEBLKSZ

The difference between


TOTALMEM and FREEMEM
is equal to USEDMEM.

32-Bit Integer 0 to 4194304


Kbytes

No

View Only

CEE

No

FREEMEMINK,
USEDMEMINK,
MAXFREEINK

The difference between


TOTALMEMINK and
FREEMEMINK is equal to
USEDMEMINK.

TOTALTIME [1..50] RampSoak

Total (configured)
Real
Time for a
RampSoak Profile (in
Minutes)

Greater-than
or equal to 0.0

No

View Only

CEE

No

TOTELAPSEDTM RampSoak

Total Elapsed Time Real


for current
RampSoak Profile (in
Minutes)

Greater-than 0.0
or equal to 0.0

No

View Only

CEE

No

NETELAPSEDTM

Notes

218

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

TP

EQ, GE, GT, LE, LT,


NE

Trip Point Value

64-Bit Real
Number

TRACKING

RemCas, Switch

Input Tracking
Boolean
Option Allows the
selected input to be
changed without
bumping the output.

TRFB

PidExtReset

Tracking value.

TRUNCATEOPT

TypeConvert

Choice for truncating Enumeration Truncate (0)


or rounding integers. TCTRUNCATE Round (1)
TYPE

TV

Pulse Input w/ Fast Target Value used 64-Bit Real


Cutoff IOC
by Pulse Input
Number
Module for fast
cutoff comparison;
value is in
Engineering Units.

TV [6..7]

Pulse Input IOM

TVPROC

Pulse Input w/ Fast Target Value


Boolean
Cutoff IOC
Processing Flag. If
On, it indicates Pulse
Input Module fast
cutoff comparison is
enabled.

Target Value Used 64-Bit Real


for fast cutoff
Number
comparison. Value
is in Engineering
Units.

Range

Default

Config
Load

Access
Lock

0.5

Yes

Engineer/Pro CEE
gram

No

Yes

Engineer/Ap CEE
plication
Developer

No

Off (0):
On (1)
Tracking is
disabled
On (1):
Tracking is to
be done

Residence

Active
Connector

Related
Parameters

Notes
Used to compare against
constant values, when only
one input is configured.

SIFL, PV, SP, RFB, S1.


Truncate
(0)

Yes

Engineer

CEE

None

IN.FLOAT32,
IN.FLOAT64,
OUT.INT16,
OUT.INT32,
OUT.UINT16,
OUT.UINT32

Greater-than 0.0
or equal-to 0.0

No

Operator

CEE

No

SO

Greater-than 0.0
or equal-to 0.0

No

Engineer

CEE

Yes

SO [6..7], TVRAW
[6..7],

Off (0)
On (1)

No

View Only

CEE

No

SO, TV,

Off (0)

Selecting truncate would


truncate the numbers, in the
case of data type conversion,
from floating point to integer.
Otherwise the block will
round the numbers during
type conversion.

This parameter can be set


from the Control Builder
configuration form. Writing
this parameter enables the
fast cutoff functionality and
overwrites any TV set from
the associated PI channel
with fast cutoff block.
Note: After the AV meets or
exceeds the TV setting the
output, the TV value must be
re-written to enable the
Fast-Cutoff functionality.

219

Specific to
Block(s)

Description

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

TVPROC [6..7]

Pulse Input IOM

Target Value
Boolean
Processing Flag. If
On, it indicates Pulse
Input Module fast
cutoff comparison is
enabled.

Off (0)
On (1)

Off (0)

No

View Only

CEE

No

SO [6..7], TVRAW
[6..7],

TVRAW [6..7]

Pulse Input IOM

Raw Target Value 32-Bit Integer Greater-than 0.0


used by Pulse Input
or equal-to 0.0
Module for fast
cutoff comparison;
corresponds to
AVRAW [0..7] .

No

View Only

CEE

No

SO [6..7], TV [6..7]

TYPE

Handler

Handler Type

Yes

Engineer

CEE

No

SELHANDLER [1..8],
ENBHANDLER [1..8],
INVREASON [1..8],
INVCOND [1..8],
INVFROMSTEP [1..8]
[1..10],
INVFRMHNDTYP
[1..8],
INVFRMHNDLER
[1..8], TIME [1..8],
ACTIVEHANDLR
[1..8]

Enumeration Null (0)


CSCOHANDLE Edit (1)
RTYPE
Main (2)
Check (3)
Interrupt (4)
Restart (5)
Hold (6)
Stop (7)
Abort (8)

Hold (6)

Notes

Contains the TYPE of the


currently active handler. For
example, if
ACTIVELOC.HNDTYPE = 5,
then the currently active
handler is of type RESTART.
The ordinal of the handler
TYPE is the index for the
listed Related Parameters.
For example, to determine if
the Hold handlers invoke
transition is currently being
evaluated, the state of the
ENBHANDLER [6] flag would
be examined.

220

Parameter

Parameter

Specific to
Block(s)

Description

ULCNBMAC

IOM

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

Uplink MAC address 32-Bit Integer 0 to indicate 0


of the IO rack.
local IOM;
1 to 99 are
valid CNB
Module
addresses for
remote
chassis.

Yes

Application
Developer

SR

No

DLCNBSLOT,
IOMSLOT

ULCNBMAC refers to the


ControlNet Module address
in the remote IO chassis.
Upon insertion and
power-up, the CNB Module
address is displayed in the
LCD display with an A#
prefix. The CNB Module
address is configured or
changed by adjusting two
rotary dials on top of the
CNB Module. The dial for
the 1s digit is located
towards the back of the
module, and the dial for the
10s digit is towards the front
of the module. Use a small
screwdriver to adjust.
If configuring an IOM located
in the same chassis as the
controller, leave this
parameter set to the default
value of 0.

CPM, RM

Uplink MAC address 32-Bit Integer 1-99

No

Engineer

SR

No

ABORTALM.PR

For the parameter to be


valid, the Default may not be
zero.

UNCMDALM.FL

DevCtl

Uncommanded
Change Alarm Flag

Boolean

Off (0)
On (1)

Off (0)

No

View Only

CEE

No

GOP, GPV,
CMDDISALM.FL,
CMDDISALM.PR,
CMDDISALM.SV,
CMDDISALM.TM
[0..2], NUMDINPTS,
PV, OP

Illegal if NUMDINPTS = 0, or
if NUMDOUTS = 0.
UNCMDALM.FL is always
enabled, when
CMDDISALM.xx is enabled.

UNCMDALM.PR

DevCtl

Uncommanded
Change Alarm
Priority

Enumeration
ALPRIOR

None (0)
Journal (1)
Low (2)
High (3)
Urgent (4)

Low (2)

Yes

Engineer

CEE

No

UNCMDALM.SV

DevCtl

Uncommanded
Change Alarm
Severity

16-Bit Integer 0 to 255

0.0

Yes

Engineer

CEE

No

221

Specific to
Block(s)

Description

Data Type

Range

Default

Config
Load

UNDERRANGE

AIC

Under Range Alarm Boolean


Indicator - Indicates
that the input value
is under the valid
hardware input
range of the
channel.
Overrange and
Underrange
parameters are not
supported for the
1794 FLEX I/O
Analog Input
Module
(1794-IE8/B). When
selected, Parameter
ID error Err2088 will
appear.

Input is not in No
an
under-range
state (0)
Input is in an
under-range
state (1)

UNDERRANGE
[0..numChans-1]

AIM

Under Range Alarm Boolean


Indicator - Indicates
that the input value
is under the valid
hardware input
range of the
channel.

Input is not in
an
under-range
state (0)
Input is in an
under-range
state (1)

Input is No
not in an
under-ran
ge state
(0)

UNITTEXT

CM, SCM

Unit Text

String

Length: 2
characters

Null
String

UPDATOPT

All IO Channels,
IOM,
SIFLAGARRCH,
SINUMARRCH,
SITEXTARRCH

Update Option

Integer

UPDRESOPT

Step

Update Resume
Address Option

Boolean

Residence

Active
Connector

No

OVERRANGE

ViewOnly

CEE

No

Engineer

CEE

No

CEE

No

ViewOnly CEE

Yes

Off (0) - The On (1)


first Step of
the Main
handler
should not be
set to Off.
See warning
in Notes.
On (1)

Access
Lock

Related
Parameters

Notes

OVERRANGE
[0..numChans-1]

Unit Text is configurable on


the CM configuration form. It
associates the Control
Module, and all events
generated by its contained
basic blocks to a Unit.

View Only

Yes

Engineer

RESADDRFUTUR
[1..10], RESADDR
[1..10]

WARNING: Always select


the Update Restart Address
for the first STEP in a Main
Handler. This sets the
UPDRESOPT parameter On(1)
and ensures that the SCM
always has somewhere to
return to from Exception
Handlers.
See RESADDRFUTUR [1..10]
for additional information on
this parameter.

222

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

USEDMEM

CPM

Total amount of
unused memory in
CEE user memory
pool.

32-Bit Integer 0 to 4194304


Bytes

USEDMEMINK

CPM

Total amount of
unused memory in
CEE user memory
pool.

32-Bit Integer 0 to 4194304


Kbytes

USESIM

CPM

Simulate CEE on NT Boolean

VENDOR

All IOM Function


Blocks

Numeric code
representing I/O
vendor identity.

32-Bit Integer

Range

Off (0)
On (1)

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

No

View Only

CEE

No

TOTALMEM,
FREEMEM,
MAXFREEBLKSZ

This parameter publishes


total amount of used memory
in the user memory pool.
Used memory increases as
blocks are loaded and
decreases as blocks are
unloaded. The difference
between TOTALMEM and
USEDMEM is equal to
FREEMEM.

No

View Only

CEE

No

TOTALMEMINK,
FREEMEMINK,
MAXFREEINK

This parameter publishes


total amount of used memory
in the user memory pool.
Used memory increases as
blocks are loaded and
decreases as blocks are
unloaded. The difference
between TOTALMEM and
USEDMEM is equal to
FREEMEM.

Off (0)

No

Application
Developer

SR

No

ABORTALM.PR

3
Yes
Note that
this
paramete
r is not
currently
set with
specific
default
values for
different
IO
vendors.

Application
Developer

CEE

No

Although loaded, this


parameter is not exposed on
any configuration form.

223

Specific to
Block(s)

Description

VENDORID

RM

VERIFYLOST

Range

Default

Config
Load

Access
Lock

Vendor Identification 16-Bit


Code.
Unsigned
Integer

0 to 65535

No

ViewOnly
Not Loaded
RM only:
Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform.

No

DOC

Output Verify
Indicates that the
actual state of the
output does not
match the
commanded state.

Boolean

Output
matches the
commanded
state: (0)
Output does
not match the
commanded
state: (1)

Output
No
matches
the
command
ed state:
(0)

ViewOnly

CEE

No

EVERIFY
[0..numChans-1]

VERIFYLOST
[0..numChans-1]

DOM

Output Verify
Indicates that the
actual state of the
output does not
match the
commanded state.

Boolean

Output
matches the
commanded
state: (0)
Output does
not match the
commanded
state: (1)

Output
No
matches
the
command
ed state:
(0)

ViewOnly

CEE

No

EVERIFY
[0..numChans-1]</HH
>

VERSION

SCM, CM

Version Descriptor

String

String Length: Null


7 characters String

Engineer

CEE

No

Descriptor that can be used


to document a version for the
block.

VOLTAGE

Pulse Input IOC,


Input Voltage
Pulse Input w/ Fast Threshold
Cutoff IOC
specifies level of
input.

Enumeration

See below.

Application
Developer

CEE

No

This value determines


whether the actual
screw-terminal-input is high
voltage or low voltage.

Application
Developer

CEE

No

This value determines


whether the actual
screw-terminal-input is high
voltage or low voltage.

Low (0):

High (1):

VOLTAGE [0..7]

Pulse Input IOM

Input Voltage
Threshold
specifies level of
input.

Data Type

Yes

2Volts (0) Yes

Residence

Active
Connector

Range
Signals with a voltage lower than 2 volts are
considered to be low voltage while signals
with a voltage equal-to or highter-than 2 volts
are considered to be high voltage

Related
Parameters

Notes

Signals with a voltage lower than 8 volts are


considered to be low voltage while signals
with a voltage equal-to or highter-than 8 volts
are considered to be high voltage
Enumeration

Low (0)
High (1)

2V (0)

Yes

224

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

Notes

VOTED

nooN

Voted output value

Boolean

Off (0)
On (1)

Off(0)

No

View Only

CEE

No

WCTCLKTIME

RM

Clock Time

TIME

N/A

No

Not Loaded
Operator
RM only:
Requests to
read or store
to any RM
parameter
must come
from the
Supervisory
platform.

No

WIREOFF

DIC

Indicates the
Boolean
absence of a field
wire (sensor /
actuator) or the
break in field wiring.

Wire-off
condition not
detected (0)
Wire-off
condition
detected (1)

Wire-off No
condition
not
detected
(0)

ViewOnly

CEE

No

EWIREOFF[0..numCh
ans-1]

WIREOFF
[0..numChans-1]

DIM

Indicates the
Boolean
absence of a field
wire (sensor /
actuator) or the
break in field wiring.

Wire-off
condition not
detected (0)
Wire-off
condition
detected (1)

Wire-off No
condition
not
detected
(0)

ViewOnly

CEE

No

EWIREOFF[0..numCh
ans-1]

X [1..4]

OvrdSel

X-input Values for


64-Bit Real
function blocks with Number
Multiple Inputs

XEULO to
XEUHI

NaN

No

View Only

Not Loaded

Yes

X [1..4] are initializable


inputs for the OvrdSel
function block.
X [1..6] are for RegCalc, only
X [1] is an initializable input.
X [1..8] are initializable
inputs for the Switch
function block.
X1 is an initializable input for
all other function blocks.

X [1..6]

RegCalc

X-input Values for


64-Bit Real
function blocks with Number
Multiple Inputs

XEULO to
XEUHI

NaN

No

View Only

Not Loaded

Yes

X [1..4] are initializable


inputs for the OvrdSel
function block.
X [1..6] for RegCalc, only X
[1] is initializable input.
X [1..8] are initializable
inputs for the Switch
function block.
X1 is an initializable input for
all other function blocks.

225

Specific to
Block(s)

Description

X [1..8]

Switch, Ovrdsel,
and RegCalc

X1

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

X-input Values for


64-Bit Real
function blocks with Number
Multiple Inputs

XEULO to
XEUHI

NaN

No

View Only

Not Loaded

Yes

X [1..4] are initializable


inputs for the OvrdSel
function block.
X [1..6] for RegCalc, only X
[1] is initializable input.
X [1..8] are initializable
inputs for the Switch
function block.
X1 is an initializable input for
all other function blocks.

RatioBias, RemCas, The X1 Input Value, 64-Bit Real


Fanout, AutoMan in Engineering Units. Number

XEULO to
XEUHI

NaN

No

View Only

CEE

No

X1 is an initializable input for


all function blocks.

No

View Only

CEE

No

X1BACKCALOUT RemCas, RatioBias, Back Calculation


Structure
RegCalc
Data from
Secondary Block Secondary Data
structure associated
with Remote
Cascade (REMCAS)
Block X1 input.
Contains Control
Variable (CV) limits,
initailization, and
data windup status,
etc. X1BACKCALOUT
is associated with
the primary block.
Connecting
BACKCALCIN to its
X1BACKCALOUT
partner is required
in order to establish
the initialization
path between the
two blocks.
X1CONN

AutoMan, Fanout,
RemCas

Internal parameter
for system use only.

X1P

Fanout, AutoMan

The X1 Value in
Percent

X1SECDATA

RatioBias, RemCas, Internal parameter


Fanout, and
for system use only.
AutoMan

X1STS

Fanout, AutoMan

64-Bit Real
Number

The X1 Input Status Enumeration


PVSTS

0 to 100

NaN

No

View Only

CEE

No

Bad (0)
Uncertn (1)
Normal (2)
Manual (3)

Bad (0)

No

View Only

CEE

No

Related
Parameters

BACKCALCIN,
BACKCALCIN [1..8]

X1

Notes

X1BACKCALOUT establishes
the initialization, override,
and windup propagation
between connected Remote
Cascade (REMCAS) and
Regulatory Control Blocks.
This is one half of the
BACKCALCIN/X1BACKCALO
UT connection. Applicable to
the REMCAS block.

226

Parameter

Parameter

Specific to
Block(s)

Description

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

X2

RemCas

The X2 Input Value

64-Bit Real
Number

XEULO to
XEUHI

NaN

No

View Only

CEE

Default
Connector:
Input for the
RemCas
function
block.

No

View Only

CEE

No

BACKCALCOUT,
X2BACKCALOUT establishes
BACKCALCOUT [1..8] the initialization, override,
and windup propagation
between connected Remote
Cascade (RemCas) and
Regulatory Control (RegCtl)
blocks. This is one half of
the
BACKCALCIN/X2BACKCALO
UT connection.

0.0

Yes

Engineer

CEE

No

X [1..6], XK [1..6],
XKB [1..6]

X2BACKCALOUT RemCas

Back Calculation
Structure
Data from secondary
block - Secondary
Data structure
associated with
Remote Cascade
(RemCas) block X2
input. Contains
Control Variable (CV)
limits, initialization,
and data windup
status, etc.
X2BACKCALOUT is
associated with the
primary block.
Connecting
BACKCALCIN to its
X2BACKCALOUT
partner is required
in order to establish
the initialization
path between the
two blocks.

X2CONN

RemCas

Internal parameter
for system use only.

X2SECDATA

RemCas

Internal parameter
for system use only.

XB [1..6]

RegCalc

Individual biases for Real


input X [1] through X
[6].

XCONN [1..4]

Switch

Internal parameter
for system use only.

XCONN [1..8]

OvrdSel, Switch

Internal parameter
for system use only.

XDESC [1..2]

RemCas.

The X-Input
Descriptors

String

Length - 15
characters

Null
String

Yes

Operator

CEE

No

XDESC [1..4]

OvrdSel

The X-Input
Descriptors

String

Length - 15
characters

Null
String

Yes

Operator

CEE

No

Related
Parameters

Notes
X2 is an initializable input for
the RemCas function block.

227

Specific to
Block(s)

Description

Data Type

Range

Default

Config
Load

Access
Lock

Residence

Active
Connector

Related
Parameters

XDESC [1..8]

Switch

The X-Input
Descriptors

String

Length - 15
characters

Null
String

Yes

Operator

CEE

No

XEUHI

RegCtl Blocks with The X-Input High


x-inputs: RemCas, Range (in
RatioBias, RegCalc, Engineering Units)
Fanout, Switch,
AutoMan, and
OvrdSel.

64-Bit Real
Number

Greater than
or equal to
XEULO

100.0

Yes

Engineer

CEE

No

XEULO

RegCtl Blocks with The X-Input Low


x-inputs: RemCas, Range (in
RatioBias, RegCalc, Engineering Units)
Fanout, Switch,
AutoMan, and
OvrdSel.

64-Bit Real
Number

Less than or
equal to
XEUHI

0.0

Yes

Engineer

CEE

No

XK [1..6]

RegCalc

Individual gains for Real


input X [1] through X
[6]

1.0

Yes

Engineer

CEE

No

X [1..6], XB [1..6],
XKB [1..6]

XKB [1..6]

RegCalc

Individual input
Real
values after
individual biases
and gains have been
applied to X [1]
through X [6].

NaN

No

ViewOnly

CEE

No

X [1..6], XB [1..6], XK
[1..6]

XSTS [0..5]

RegCalc

X Input Status

Integer

XWHIFL

RegCalc

X input windup
high flag

Boolean

Off (0)
On (1)

Off (0)

No

Other
Function
Block

CEE

No

XWLOFL

XWLOFL

RegCalc

X input windup
low flag

Boolean

Off (0)
On (1)

Off (0)

No

Other
Function
Block

CEE

No

XWHIFL

View Only

Notes

228

Parameter

Appendix

Display Elements Appendix

Group Display Elements

The Group Display Elements supplied with ProcessLogix Server are


listed in the following table.

Table A.1 Group Display Elements


Object

Display Elements

Notes

Background Display

sys205.dsp

It is necessary to replace the existing background display to use the new faceplate
displays.

CEE

sysGrpCEEA.dsp

Control Execution Environments

Generic I/O Modules

sysGrpIOMA.dsp

Any I/O Modules

AI Modules

sysGrpAIA.dsp

Analog Input Modules

Hi Density AI Modules

sysGrpAI16A.dsp

High Density Analog Input Modules

AO Modules

sysGrpAOA.dsp

Analog Output Modules

Hardware Group Displays

Hi Density AO Modules sysGrpAO8A.dsp

High Density Analog Output Modules

Digital Output Modules sysGrpDOA.dsp

Digital Output I/O Modules


Now includes 1756-OA16, 1756-OA16I, 1756-OB16D, 1756-OB16I, and 1756-OA8D,
previously named sysGrpDXA.dsp.

Digital I/O Modules

sysGrpDXA.dsp

BOTH Digital Input and Digital Output I/O Modules

32-Point Digital I/O


Modules
(1756-IB32)
(1756-OB32)

sysGrpDX32A.dsp
sysGrpDO32A.dsp

Note: Due to the large number of dynamic points contained on these displays, only 4 of
these group faceplates may be configured for any one group display.
Note that sysGrpDO32A.dsp should be used as the group display for the 32-point
output modules. This is not currently the default value. The user must modify the
default entry so that it reads sysGrpDO32A.dsp.

Flex 16 Channel Digital


Input

sysGrpFlexDimCntr.dsp

1794-IA16, 1794-IB16, 1794-IV16

Flex 8 Channel Analog


Input

sysGrpFlexAI8A.dsp

1794-IE8

Flex 4 Channel Analog


Output

sysGrpAO4A.dsp

1794-OE4

Flex EX 4 Channel
Digital Output

sysGrpDO4A.dsp

1797-OB4D

Flex 8 Channel Analog


Input

sysGrpRailAI8A.dsp

1794-IR8, 1794-IT8, 1797-IE8NF, 1797-IRT8

CPM

sysGrpCPMA.dsp

Control Processors (Primary or non-redundant)

CPMSA

sysGrpCPMSA.dsp

Control Processors (Secondary)

SIM

sysGrpSIA.dsp

Serial Interface Module

PIM

sysGrpPIA.dsp

Pulse Input Module

Publication 1757-RM811A-EN-P - May 2002

A-2

Display Elements Appendix

Table A.1 Group Display Elements


Object

Display Elements

Notes

RM

sysGrpRMA.dsp

Redundancy Module

Fieldbus Linking Device


(1757-CN2FF)

sysGrpLD.dsp

Fieldbus Linking Device

FIM

sysGrpFIM.dsp

Fieldbus Interface Module

LINK

sysGrpLINK.dsp

Fieldbus Link

Fieldbus Device

sysGrpFFDevice.dsp

Fieldbus Device

Profibus Interface
Module

sysGrpPBIM.dsp

Generic Profibus
Device

sysGrpPfbDevice.dsp

Profibus Analog Input


Module

sysGrpPfbAim.dsp

Profibus Analog Output


Module

sysGrpPfbAom.dsp

Profibus Digital Input


Module

sysGrpPfbDim.dsp

Profibus Digital Output


Module

sysGrpPfbDom.dsp

Profibus Encoder
Device

sysGrpPfbEncoder.dsp

Profibus Motor Drive


Device

sysGrpPfbProfiDrive.dsp

Selected Control Module Group Displays


PID Control

sysGrpPIDA.dsp

PID Control CMs. NOTE: PID BLOCK IN CONTROL MODULE MUST BE NAMED PIDA
AND DATA ACQUISITION BLOCK MUST BE NAMED DACA.

SCM

sysGrpSCMA.dsp

Sequential Control Modules

Device Control

sysGrpDEVCTLA.dsp

Device Control CMs. NOTE: Device Control BLOCK IN CONTROL MODULE MUST BE
NAMED DEVCTLA.

Ramp/ Soak Control

sysGrpRAMPA.dsp

Ramp/Soak Control CMs. NOTE: Ramp/Soak BLOCK IN CONTROL MODULE MUST BE


NAMED RS.

Data Acquisition

sysGrpDACA.dsp

CMs with Data Acq block. NOTE: Data Acq BLOCK IN CONTROL MODULE MUST BE
NAMED DACA.

Publication 1757-RM811A-EN-P - May 2002

Display Elements Appendix

Detail Display Elements

A-3

ProcessLogix Display templates are located in


Honeywell/client/system/r400. These displays can be used as
templates for creating your own displays or they can be used as is,
provided that your function block names match the names built into
the pre-built detail displays. See Notes in the tables for any
restrictions on function block names. The Detail Displays supplied are
listed in the table below.

Table A.2 Detail Display Elements


Object

Display Elements

Notes

Generic

sysDtlCDA.dsp

The display used if no detail display is specified in the system. From here, you can
access the main page for any other template.

CEE

sysDtlCEEA.dsp

Main CEE Page (CEE State, Parameter Throughput, etc.)

sysDtlCEEB.dsp
sysDtlCEEC.dsp

Load Balancing Page (CPU Usage by Cycle)

sysDtlDEVCTLA.dsp

Main Device Control Page (Execution State, alarms, interlocks, etc.) NOTE: DEVICE
CONTROL BLOCK IN CONTROL MODULE MUST BE NAMED DEVCTLA

sysDtlDEVCTLB.dsp

Input State Page

sysDtlDEVCTLC.dsp

Output State Page

sysDtlDEVCTLD.dsp

Alarm Configuration Page

SysDtlDEVCTLE.dsp

Maintenance Page

SysDtlDEVCTLF.dsp

Connections to SCMs, ProcessLogix Displays, etc.

sysDtlDEVCTLG.dsp

CB Visualization Chart

sysDtlIOMA.dsp

I/O Module Main Page (Execution State, Slot Number, etc.) for any I/O Module.

sysDtlIOMB.dsp

CB Visualization Configuration Details

sysDtlAIA.dsp

Analog Input Module Main Page (Exec. State, Slot #, etc.).

sysDtlAIB.dsp

CB Visualization Configuration Details

sysDtlAOA.dsp

Analog Output Module Main Page (Exec. State, Slot #, etc.).

sysDtlAOB.dsp

CB Visualization Configuration Details

SysDtlAI16A.dsp
SysDtlAI16B.dsp

Hi Density AI Module Main Page (Exec. State, Slot #, etc.)


Channel Information Page

Device Control
Control Module

Generic IOM
AI IOM
AO IOM
AI IOM
(Hi Density)

Publication 1757-RM811A-EN-P - May 2002

A-4

Display Elements Appendix

Table A.2 Detail Display Elements


Object

Display Elements

Notes

AO IOM
(Hi Density)

SysDtlAO8A.dsp

Hi Density AO Module Main Page (Exec. State, Slot #, etc.)

SysDtlAO8B.dsp

Channel Information Page

SysDtlDIA.dsp

Digital Input Module Main Page (Exec. State, Slot #, etc.).

SysDtlDIB.dsp

Channel Information Page

sysDtlDIC.dsp

CB Visualization Configuration Details

SysDtlDOA.dsp

Digital Output Main Page (Execution State, Slot Number, etc.).

SysDtlDOB.dsp

Channel Information Page. Supports 8pt, 16pt. Diagnostic Modules.

sysDtlDOC.dsp

CB Visualization Configuration Details

sysDtlDI32A.dsp

High Density Digital Input Module Main Page

sysDtlDI32B.dsp

Channel Information Page

sysDtlDI32C.dsp

CB Visualization Configuration Details

SysDtlDO32A.dsp

High Density Digital Output Module Main Page

SysDtlDO32B.dsp

Channel Information Page

sysDtlDO32C.dsp

CB Visualization Configuration Details

sysDtlRailCAI8A.dsp

1797-IE8NF Main Page8 Channel Analog Input

sysDtlRailCAI8B.dsp

Status Data Page

sysDtlRailCAI8C.dsp

Status Data Page

sysDtlRailTAI8A.dsp

1797-IRT8 Main Page8 Channel Temperature Input

sysDtlRailTAI8B.dsp

Status Data Page

sysDtlRailTAI8C.dsp

Configuration Page

sysDtlRailCAO8A.dsp
1797-OE8

Main Page8 Channel Analog Output

sysDtlRailCAO8B.dsp

Status Data Page

sysDtlRailCAO8C.dsp

Configuration Page

sysDtlRailBI16A.dsp

1797-IBN16 Main Page 16 Channel Digital Input

sysDtlRailBI16B.dsp

Status Data Page

sysDtlRailBI16C.dsp

Configuration Page

sysDtlRailBO4A.dsp

1797-OB4D Main Page4 Channel Digital Output

sysDtlRailBO4B.dsp

Status Data Page

sysDtlRailBO4C.dsp

Configuration Page

sysDtlFlexCAI8A.dsp

Flex Analog Input Main Page

sysDtlFlexCAI8B.dsp

Status Data Page

sysDtlFlexCAI8C.dsp

Configuration Page

sysDtlFlexCAO4A.dsp

Flex Analog Output Main Page

DI IOM

DO IOM

32 POINT DI
(Hi Density)

32 POINT DO
(Hi Density)

Flex EX AI IOM

Flex EX AO IOM

Flex EX DI IOM

Flex EX DO IOM

Flex AI IOM

Flex AO IOM

Publication 1757-RM811A-EN-P - May 2002

Display Elements Appendix

A-5

Table A.2 Detail Display Elements


Object

Display Elements

Notes

sysDtlFlexCAO4B.dsp

Status Data Page

sysDtlFlexCAO4C.dsp

Configuration Page

sysDtlFlexDimA.dsp

FlexDigital Input Main Page

sysDtlFlexDimB.dsp

Status Data Page

sysDtlFlexDimC.dsp

Configuration Page

sysDtlFlexBOA.dsp

Flex Digital Output Main Page

sysDtlFlexBOB.dsp

Status Data Page

sysDtlFlexTIMA.dsp

Flex Temperature Analog Input Main Page

sysDtlFlexTIMB.dsp

Status Data Page

sysDtlFlexTIMC.dsp

Configuration Page

CPM
(Non Redundant &
Primary)

SysDtlCPMA.dsp

CPM Main Page (Memory & CPU Usage, etc.)

CPM
(Secondary)

SysDtlCPMSA.dsp

Secondary CPM Main Page (Memory & CPU Usage, etc.)

PID Control
Control Module

SysDtlPIDA.dsp

PID Main Page (Execution State, alarms, set point ramping, etc.)
Note: Pid block in Control Module must be named PIDA and Data Acquisition
Block must be named DACA.

SysDtlPIDB.dsp

PID Loop Tuning Display

sysDtlPIDC.DSP

Setpoint Configuration Page

sysDtlPIDD.dsp

PV, OP Configuration

sysDtlPIDE.dsp

Alarm Configuration Page

sysDtlPIDF.dsp

Connections to SCMs, ProcessLogix Displays, etc.

sysDtlPIDG.dspCB

Visualization Chart

sysDtlSCMA.dsp

Sequential Control Module Main Page (States, Alarms, etc.)

sysDtlSCMB.dsp

SCM State Diagram

sysDtlSCMC.dsp

Recipe Parameters 1-16

sysDtlSCMC2.dsp

Recipe Parameters 17-33

sysDtlSCMC3.dsp

Recipe Parameters 34-50

sysDtlSCMD.dsp

History Parameters 1-16

sysDtlSCMD2.dsp

History Parameters 17-33

sysDtlSCMD3.dsp

History Parameters 34-50

sysDtlSCME.dsp

SCM Handler Selections

Flex DI IOM

Flex DO IOM
Flex Temperature
IOM

SCM

Publication 1757-RM811A-EN-P - May 2002

A-6

Display Elements Appendix

Table A.2 Detail Display Elements


Object

Display Elements

Notes

Ramp/Soak
Control Module

SysDtlRAMPA.dsp

Ramp/Soak (Main Page)


NOTE: Ramp/Soak block in Control Module must be named RS

SysDtlRAMPB.dsp

Ramp/Soak (Graph)

SysDtlRAMPC.dsp

Ramp/Soak (Profile Summary)

SysDtlRAMPD.dsp

Ramp/Soak (Alarms)

SysDtlRAMPE.dsp

Ramp/Soak (Connections)

SysDtlProfile1.dsp
SysDtlProfile2.dsp
SysDtlProfile3.dsp
SysDtlProfile4.dsp
SysDtlProfile5.dsp
SysDtlProfile6.dsp
SysDtlProfile7.dsp
SysDtlProfile8.dsp
SysDtlProfile9.dsp
SysDtlProfile10.dsp

Ramp/Soak (Profile Detail Pages)

Pulse Input Module SysDtlPIA.dsp

Pulse Input Module (Main Page)

SysDtlPIB.dsp

Pulse Input Module (Status Data)

SysDtlPIC.dsp

Pulse Input Module (Configuration)

SysDtlSIA.dsp

Serial Interface Module (Main Page)

SysDtlSIB.dsp

Serial Interface Module (Channel Data)

sysDtlDACA.dsp

Data Acquisition (Main Page)

sysDtlDACB.dsp

Data Acquisition (Alarms)

SysDtlDACC.dsp

Data Acquisition (Connections)

sysDtlRMA.dsp

Primary & Secondary Redundancy Module (Main Page)

sysDtlRMB.dsp

Redundancy Module (RM Profile Page)

SysDtlRMC.dsp

Redundancy Module (Config Page Primary Only)

SysDtlRMD.dsp

Redundancy Module (Sync Page Primary Only)

SysDtlRME.dsp

Redundancy Module (Chassis Profile Page)

Fieldbus Linking
Device

sysDtlLD.dsp

Fieldbus Linking Device (1757-CN2FF)

FIM

sysDTLFIM.dsp

Fieldbus Interface Module (Main Page)

Fieldbus Link

sysdtlLink.dsp

Fieldbus Link (Main Page)

Fieldbus Device

SysDtlFFDEVICE.dsp

Fieldbus Device (Process Page)

Profibus Interface
Module

sysDtlPBIM.dsp

Profibus Interface Module

Profibus Devices

sysDtlPfbAim.dsp

Profibus Analog Input Module

sysDtlPfbAom.dsp

Profibus Analog Output Module

sysDtlPfbDevice.dsp

Generic Profibus Device

Serial Interface
Module
Data Acquisition
Control Module

RM

Publication 1757-RM811A-EN-P - May 2002

Display Elements Appendix

A-7

Table A.2 Detail Display Elements


Object

Analog Point

Display Elements

Notes

sysDtlPfbDim.dsp

Profibus Digital Input Module

sysDtlPfbDom.dsp

Profibus Digital Output Module

sysDtlPfbEncoder.dsp

Profibus Encoder Device

sysDtlPfbProfiDrive.dsp

Profibus Profidrive Device

sysDtlAna.dsp

Analog Point General Page

sysDtlAnaScanDetail.dsp

Scanning Page

sysDtlAnaAlarms.dsp

Alarm Page

sysDtlAnaHistory.dsp

History Page

sysDtlAnaAuxiliary.dsp

Auxiliary Page

sysDtlAnaHistorySummary.dsp History Summary Page


Status Point

sysDtlSta.dsp

Analog Point General Page

sysDtlStaScanDetail.dsp

Scanning Page

sysDtlStaAlarms.dsp

Alarm Page

sysDtlStaHistory.dsp

History Page

sysDtlStaHistorySummary.dsp

History Summary Page

Publication 1757-RM811A-EN-P - May 2002

A-8

Display Elements Appendix

Publication 1757-RM811A-EN-P - May 2002

Appendix

Allen-Bradley Interface Appendix

Array Channel Block


Configuration for
Allen-Bradley Interface

About Allen-Bradley Interface


The Serial Interface Array Channel function blocks communicate with
Allen-Bradley Programmable Logic Controllers (PLC) through the
Serial Interface I/O Module (SIM).
The SIM communicates with the Allen-Bradley (A-B) FTA. The A-B
FTA communicates with the Allen-Bradley KE/KF Computer Interface
Module (CIM) using EIA-232-D protocol at 19,200 baud with even
parity. The KE/KF module communicates with PLCs on an
Allen-Bradley Data Highway or Data Highway Plus using DF1
protocol with embedded responses. Direct connection to the PLC-5
RS-232 port is also supported. Refer to Allen-Bradley Data Highway
protocol manuals for details.
The Allen-Bradley PLC families supported are PLC-2, PLC-3, and
PLC-5. The PLC-5 family consists of the 5/10, 5/15, 5/25, 5/40, and
5/60 models.

AUXDATA Parameter Configuration


The following table summarizes the AUXDATA parameter
configuration that defines Serial Interface Array Channel block
communications with the Allen-Bradley PLC.
IMPORTANT

When the AUXDATA[07] parameters are not being


used with a Allen-Bradley interface, they should be
set to the default value of NaN (Not a Number).

Publication 1757-RM811A-EN-P - May 2002

B-2

Allen-Bradley Interface Appendix

Table B.1 AUXDATA Parameter Configuration


Parameter

Function

Description

AUXDATA[0] to
AUXDATA[3]

These parameters
are not applicable to
an Allen-Bradley
interface.

Set these parameters to NaN when communicating with an Allen-Bradley PLC.

AUXDATA[4]

Specifies the
Allen-Bradley PLC
family type.

Use the following setting for a given PLC type.


2.0 for PLC-2 type
3.0 for PLC-3 type
5.0 for PLC-5 type
You can access different PLC family types through the same FTA by using multiple Serial
Interface Array Channel blocks with the desired family type setting specified for each Array
Channel blocks AUXDATA[4] parameter.
You can access PLC-3 or PLC-5 type controllers using PLC-2 emulation by setting the
AUXDATA[4] parameter value to 2.0.
For diagnostic related Array Channel blocks, you must set the AUXDATA[4] parameter to 0
for a Computer Interface Module or NaN for a loopback test. See the following section
Diagnostic data configuration for details.

AUXDATA[5]

Specifies the
Allen-Bradley PLC
file number.

Use the following setting for a given PLC type.


NaN for PLC-2 type
0 to 999 for PLC-3 or PLC-5 type
For diagnostic related Array Channel blocks, you must set the AUXDATA[5] parameter to -1
for a Computer Interface Module or PLC type, or -3 for a loopback test. See the following
section Diagnostic data configuration for details.

AUXDATA[6]

Specifies the data


type for
Allen-Bradley PLC 2
or PLC-5 type or the
section ID for a
PLC-3 type.

See the paragraph following this table for details about making AUXDATA[6] settings for a
given PLC type.
Different settings are required for diagnostic related Array Channel blocks. See the following
section Diagnostic data configuration for details.

AUXDATA[7]

Specifies the
Allen-Bradley PLC
scan rate.

Each Array Channel block can have a different scan rate. The Allen-Bradley interface supports
either polling or Report by Exception (RBE) independent of the scan rate. Use the following
setting for a given scan rate.
0 to scan the channel as fast as possible
1 to 255 to scan the channel once every 1 to 255 seconds
256 to scan the channel once after configuration or after link or device failure recovery (then
only Report by Exception)
Notes:
Use higher priority scanning for time-critical data, and slower scanning or RBE for lower
priority channels where data changes infrequently.
If all channels are set for very fast scan (0 to 2 seconds), actual performance may be less than
one update per second, especially when writes are used.
A setting greater than 256 causes a POL FREQ error.
If more than one Array Channel block is configured to map the same PLC memory area, only
one of the blocks will be updated with RBE data.
After the first scan is completed with a setting of 256, Array data is updated when RBE data is
received for that channel or after any communication error (but not after configuration errors).
The RBE feature is independent of the scan rate. See the section Report by Exception
requirements for details.

Publication 1757-RM811A-EN-P - May 2002

Allen-Bradley Interface Appendix

B-3

AUXDATA[6] Parameter Setting Details


The following tables list the AUXDATA[6] parameter settings required
for a given data type and A-B PLC type. It also lists the Array Channel
block associated with a given data type as well as the data range and
maximum number of elements.

ATTENTION

An unexpected write may take place when changing


AuxData[6] (data type) online, in the following
scenario:
1. Data Type was 4 or 5 (read only unsigned).
2. An online value change was attempted. The
change is ignored.
3. Data Type is changed to other writable numeric
type.
The previously-attempted change is now accepted
and passed to the PLC.

Table B.2 PLC-2 Type Settings


Data Type

AUXDATA[6] Setting

Array Channel Function Block

Data Range

Max. No. Elem.

Output

SIFLAGARRCH

ON/OFF

512

Input

SIFLAGARRCH

ON/OFF

512

Status

SIFLAGARRCH

ON/OFF

512

Bit

SIFLAGARRCH

ON/OFF

512

Integer

4,5

SINUMARRCH (unsigned 16 Bit)

0 to 65535

32

Floating Point

Unsupported (VAX F Format)

Integer

SINUMARRCH (signed 16 Bit)

-32768 to 32767 32

Floating Point

SINUMARRCH (IEEE Single Precision)

-34E38 to 34E38 16

ASCII

SITEXTARRCH

Printable
Characters

TIP

8 of 8
4 of 16
2 of 32
1 of 64

The PLC-2 controller only recognizes status or


integer data types. The interface handles other data
types by requesting single or multiple elements for
integer data according to the AUXDATA[6] setting.
The SIM does not support the VAX F format.

Publication 1757-RM811A-EN-P - May 2002

B-4

Allen-Bradley Interface Appendix

Table B.3 PLC-3 Type Settings


Data Type

AUXDATA[6] Setting

Array Channel Function Block

Data Range

Max. No.
Elem.

Output

SIFLAGARRCH

ON/OFF

512

Input

SIFLAGARRCH

ON/OFF

512

Integer

SINUMARRCH (signed 16 Bit)

-32768 to 32767

32

Floating Point

Unsupported (VAX F Single Precision) _

Binary

SIFLAGARRCH

ON/OFF

512

ASCII

SITEXTARRCH

Printable Characters

8 of 8
4 of 16
2 of 32
1 of 64

Status

13

SIFLAGARRCH

ON/OFF

512

TIP

The setting for AUXDATA[6] corresponds to the


PLC-3 controller Section Identifier.
The PLC-3 controller does not support these data
types: timers, counters, decimal, high order (two
word) integers, and pointers.
The SIM does not support the VAX F format.

Table B.4 PLC-5 Type Settings


Data Type

AUXDATA[6]
Setting

Array Channel Function Block

Data Range

Max. No.
Elem.

Output

SIFLAGARRCH

ON/OFF

512

Input

SIFLAGARRCH

ON/OFF

512

Status

SIFLAGARRCH

ON/OFF

512

Bit

SIFLAGARRCH

ON/OFF

512

Integer

4,5(1)

SINUMARRCH (unsigned 16 Bit)

0 to 65535

32

Integer

SINUMARRCH (signed 16 Bit)

-32768 to 32767

32

Floating Point

SINUMARRCH (IEEE Single Precision)

-34E38 to 34E38

16

ASCII

SITEXTARRCH

Printable Characters

8 of 8
4 of 16
2 of 32
1 of 64

(1)

These Allen-Bradley file types are read only and writes to them are ignored.

Publication 1757-RM811A-EN-P - May 2002

Allen-Bradley Interface Appendix

TIP

B-5

The setting for AUXDATA[6] corresponds to the


PLC-5 controller file type, except 9 is assigned for
string data. Configure the PLC-5 file to use data
type 'A' (ASCII), not data type 'ST' (string).
Timers/counters require three words per
timer/counter. Presets and accumulated values
are read only. They can only be modified in
ladder logic.
The following restrictions also apply for PLC-5:
If the AUXDATA[5] setting is 0, then
AUXDATA[6] must be set to 0 (output data).
If the AUXDATA[5] setting is 1, then
AUXDATA[6] must be set to 1 (input data).
If the AUXDATA[5] setting is 2, then
AUXDATA[6] must be set to 2 (status).

DEVADDR Parameter Configuration


You configure the device address (DEVADDR) parameter to specify
the Node Address for the A-B PLC in octal. For example, if the PLC
Node Address is 758, enter 75 as the device address setting in the
Array Channel block configuration form. More than one Array
Channel block can have the same device address.
The valid Node Address range is 08 to 3768. (Note that the FTA
firmware does the octal to decimal conversion automatically, so do
not convert the octal address to decimal.)

Publication 1757-RM811A-EN-P - May 2002

B-6

Allen-Bradley Interface Appendix

STARTINDEX and Number of Elements Parameter


The value configured for the STARTINDEX parameter in a given Array
Channel block determines the PLC data table location and function.
Only one type of external data (Flag, Numeric, or String) can be
accessed per Array Channel block. The following paragraphs describe
the setting considerations for a given PLC type.
PLC-2 Type: Use the appropriate octal address within the PLC-2
data table. For example, if the octal address is 1768, enter 176 as
the start index setting in the Array Channel block configuration
form.
PLC-3 Type: Use either the word part of the PLC-3 address or
the structure value for the floating point data. For all data types
except input/output (I/O), the decimal range is 0 to 999910. For
I/O data, enter the start index setting in the Array Channel block
configuration form as an octal number. The range for actual I/O
is 08 to 3778 and the range for storage locations is 4008 to 77778.
The PLC-3 Context and External Data Tables are only supported
to the extent that Context is fixed equals 1 (current context) and
the External Data Table is always equal to E3.
PLC-5 Type: Use the file start index depending on the type of
data (Flag, Numeric, String).
For flag data, the start index setting represents the word address
within the file. If the AUXDATA[6] setting is 0 (Output) or 1
(Input), enter the start index for a Flag Array Channel block as
an octal number in the range of 0008 to 1778. A non-octal digit
or an out-of-range value causes a STARTIDX error.
Specify all other start index settings as integers, including flag
array data except as noted above for input or output data type.
The SIM does not check file size.
The number of elements parameter (NFLAG, NNUMERIC, or
NSTRING) in a Flag Array, Numeric Array, or Text Array Channel
block determines the number of flags, numerics, or strings in a
given data array. The tables in AUXDATA[6] Parameter Setting
Details section, on page B-3, list the maximum number of
elements for a given data type for reference.

Publication 1757-RM811A-EN-P - May 2002

Allen-Bradley Interface Appendix

B-7

Report by Exception Requirements


Before an FTA will accept RBE data, the following conditions must be
true.
The corresponding Array Channel block must be configured.
The channel must have been scanned at least once.
The sending devices source address (SRC) must match the Array
Channel blocks configured device address (DEVADDR)
parameter.
The quantity of the data received by the FTA in an RBE request
must match the quantity of the data configured for the
destination Array Channel block.
The command code (CMD) and the function number (FNC) in
the Allen-Bradley communication messages must be as specified
in the following table.
An RBE_FULL error results if even one RBE message is rejected
without indication back to the device that generated the
message.
RBE data is rejected by any Array Channel block configured to
map diagnostic counter data, or run a diagnostic loop, or by any
PLC-5 configured for Timer/Counter data.
For a PLC-5 controller, the Data Type (AUXDATA[6]) parameter
must match the file type start index configured for the
destination Array Channel block.
Note that configuring more than one Array Channel block to map the
same PLC memory area results in only one of the Array Channel
blocks being updated with RBE data.

Publication 1757-RM811A-EN-P - May 2002

B-8

Allen-Bradley Interface Appendix

Table B.5
Function

PLC-2

PLC-3

PLC-5

Data Read by SIM from PLC


(All Data Types)

Basic Command Set: Unprotected


Read
CMD: 01
FNC: N/A

Specific command Word Range


Read
CMD:0F
FNC: 01

Specific command Word


Range Read
CMD:0F
FNC: 01

Data Write by SIM to PLC


(Flag Data Type)

Basic Command Set: Unprotected Specific command Bit Write


CMD:0F
Bit Write
FNC: 02
CMD: 05
FNC: N/A

Data Write by SIM to PLC


(Other Data Types)

Basic Command Set: Unprotected


Write
CMD: 08
FNC: N/A

Specific command Word Range


Write
CMD:0F
FNC: 00

Specific command Word


Range Write
CMD:0F
FNC: 00

Data Write by PLC to SIM (RBE) Basic Command Set: Unprotected


(All Data Types)
Write
CMD: 08
FNC: N/A

Specific command Word Range


Write
CMD:0F
FNC: 00

Specific command Typed


Write(1)
CMD:0F
FNC: 67

(1)

Specific command
Read-Modify-Write
CMD:0F
FNC: 26

These functions must use the Logical Binary Addressing format or the RBE message is rejected by the SIM. Other formats including PLC-3 Symbolic and PLC-5 Logical
ASCII will be rejected.

Performance Considerations
IMPORTANT

Publication 1757-RM811A-EN-P - May 2002

Since the Serial Interface I/O Module (SIM)


bandwidth is limited, the Array Channel blocks
only process writes which change the current
process value. This eliminates unnecessary
repeated writes.
In ProcessLogix systems with redundant
Controller configurations, the writes are not
guaranteed during a failover. The store attempt
may occur in the Primary Controller, but it may
not reach the SIM before the failover occurs. The
Secondary Controller does not attempt to resend
the data.

Allen-Bradley Interface Appendix

B-9

An active SIM function block processes the following actions once per
its publication period of 250 milliseconds. The publication rate is the
same whether the SIM block is assigned to a 5ms-CEE or a 50ms-CEE
type.
Load Serial Interface Array Channel block configurations to the
SIM.
Send Array Channel block write requests to the SIM.
Monitor status of the SIM, and report diagnostics, as applicable.
Of course, these actions are not performed when the SIM block is
inactive. When the SIM block is inactive, the Array Channel blocks set
their data to applicable default values.
The SIM block collects the writes for each array channel and sends
them to the SIM every 250ms. The following table lists the maximum
number writes a SIM block supports per channel in every 250ms
cycle. If the SIM blocks write list becomes full, it rejects a write to the
array channel block.
Table B.6 Max number of writes per channel
Array Channel Block

Maximum Number of Writes


(Channel/250ms)

SINUMARRCH

SIFLAGARRCH

16

SITEXTARRCH (STRLEN = 8)

SITEXTARRCH (STRLEN = 16)

SITEXTARRCH (STRLEN = 32)

SITEXTARRCH (STRLEN = 64)

Writes to Array Channel Blocks can also be rejected because the SIM
is not keeping up with the writes being sent by the SIM block. Write
overruns are indicated by the SIM block FTAAOVRNFL and
FTABOVRNFL parameters. To provide an overrun condition alarm,
connect the overrun parameters to a FLAG function block configured
to generate an OffNormal alarm.
For an Allen-Bradley interface, all configured Array Channel blocks
scan the PLC devices in a circular sequence at the specified scan rate
with the read data requests. A write data request preempts the read
requests (and/or response to any RBE requests). The number of
consecutive write data requests is limited to eight (8), after which a
Report by Exception request or scan read request is serviced. If
outputs, RBE requests, and scan read requests are stacked
continuously, the RBE requests and scan read requests are alternately
serviced after every eight outputs. This slows data acquisition
considerably.
Publication 1757-RM811A-EN-P - May 2002

B-10

Allen-Bradley Interface Appendix

Channels with a scan frequency of 3 to 255 seconds are scanned once


upon block activation and then at the configured scan rate. RBE
messages reset the scan interval timer, therefore frequent RBE
messages can prevent unnecessary scanning.
There is a limit to the number of write requests per second that can be
serviced before read response is significantly affected. Because of the
time ladder logic takes to execute the maximum number of write
requests per second to a PLC running ladder logic should be limited
even further. Your Rockwell Automation representative can provide
test data and reports on PLC modules certified to date.

Array Channel Block Execution State


The Array Channel block uses the Execution State (EXECSTATE) and
Execution Period (PERIOD) parameter settings for the Control Module
that contains it. When the Control Module is activated, the Array
Channel block sends its configuration to the SIM function block for
loading in the SIM/FTA. Inactivating and activating the Control
Module/Array Channel block, reloads the configuration.
IMPORTANT

Publication 1757-RM811A-EN-P - May 2002

It may take a few seconds after the Array Channel


block is activated for the configuration to be loaded
to the SIM/FTA and good data to be imaged from the
device to the Array Channel block. During this time,
short duration BADPV alarms may occur on blocks
that are accessing the channels array data.

Allen-Bradley Interface Appendix

B-11

Write processing considerations


The Array Channel block array data can be written to either through a
one-time store from a Sequential Control Module, an operator, or
continually through a wired connection.
Upon receiving a store request, the Array Channel block forwards the
requested store to the SIM block. The SIM block forwards the store
request to the SIM and FTA. The stored value is not saved in the Array
Channel block. The Array Channel block value does not change until
the imaged value shows the new value, indicating that the store really
made it to the end device.
TIP

Use a read-back check to verify that a write is


successful in reaching the external device. A
read-back check reads the parameter just written and
compares it to the value written. When the compared
values are equal, it guarantees that the write was
successful all the way to the serial device. The
feedback time varies based on SIM, FTA, and device
performance.

Diagnostic procedures and data configuration


Diagnostic data is stored as single or double bytes of information in
the Allen-Bradley Highway module. The various PLC modules hold
diagnostic information in different forms and in different RAM
locations. This data is referred to as the Diagnostic Counters.
The Allen-Bradley diagnostic commands supported by the procedures
that follow are:
Diagnostic Status
Diagnostic Read
Diagnostic Counters Reset
Only modules whose diagnostic information address is returned as a
reply to a Diagnostic Status Command in the seventh and eighth bytes
are supported (PLC-5 returns 0). This address is added to the value
specified in the STARTINDEX as an offset, and a Diagnostic Read
collects data into the SIM. Therefore, you do not need to know the
starting address for diagnostic data.

Publication 1757-RM811A-EN-P - May 2002

B-12

Allen-Bradley Interface Appendix

Because of differences between modules, you must be familiar with


the equipment to properly configure an Array Channel block for
diagnostic purposes. It is also up to you to interpret the diagnostic
data returned. The software automatically reformats data from
diagnostic counters for easier interpretation.
You can cause a Diagnostic Counters Reset by executing a write to
any element of the diagnostic array counters. Note that a write to any
one diagnostic counter resets all the diagnostic counters in the
module.
Use the settings in the following table to configure a Numeric Array
Channel block to acquire diagnostic information from an
Allen-Bradley KE/KF Computer Interface Module (CIM). Numeric data
is used for diagnostic counters.
Table B.7 Numeric Array Channel Settings
Parameter

Setting for Diagnostic Data

DEVADDR

The node address (specified in octal)

AUXDATA[4]

0 (indicates CIM)

AUXDATA[5]

-1 (indicates diagnostic counter)

AUXDATA[6]

11 for up to 32 values of 2-byte data


7 for up to 32 values of 2-byte data
20 for up to 64 values of single-byte data

AUXDATA[7]

Scan frequency

STARTINDEX

Offset into Allen-Bradley Diagnostic Table(1)

NNUMERIC

Number of diagnostic words/bytes

(1)

Publication 1757-RM811A-EN-P - May 2002

You must know which CIM is used because each model can have different meanings for its offset values.

Allen-Bradley Interface Appendix

B-13

Use the settings in the following table to configure a Numeric Array


Channel block to acquire diagnostic information from an
Allen-Bradley PLC. Numeric data is used for diagnostic counters.
Table B.8 Acquire Diagnostic Information from a PLC
Parameter

Setting for Diagnostic Data

DEVADDR

The node address (specified in octal)

AUXDATA[4]

2, 3, or 5 (indicates PLC type)

AUXDATA[5]

-1 (indicates diagnostic counter)

AUXDATA[6]

11 for up to 32 values of 2-byte data


7 for up to 32 values of 2-byte data
20 for up to 64 values of single-byte data

AUXDATA[7]

Scan frequency

STARTINDEX

Offset into Allen-Bradley Diagnostic Table(1)

NNUMERIC

Number of diagnostic words/bytes

(1)

You must know which PLC model is used because each model can have different meanings for its offset values.

Use the settings in the following table to configure a Text Array


Channel block to set up a diagnostic loop. A repetitive diagnostic loop
can be set up to check the integrity of transmissions over the
communications link. It works by transmitting a message of a certain
length from the FTA which causes the A-B device to reply by
transmitting the same data back to the FTA. String data is used for this
purpose.
Table B.9 Set Up a Diagnostic Loop
Parameter

Setting for Diagnostic Data

DEVADDR

The node address (specified in octal)

AUXDATA[4]

NaN

AUXDATA[5]

-3

AUXDATA[6]

NaN

AUXDATA[7]

Scan frequency (but not 256)

STARTINDEX

STRLEN

64 characters

NSTRING

Publication 1757-RM811A-EN-P - May 2002

B-14

Allen-Bradley Interface Appendix

Counters check the attempted/successful transactions and when the


block is active, monitor data block.str[1] should contain the message:
Loopback Test: Attempted - xxxxx Pass - xxxxx
Where xxxxx is a pass/failure count.
Any communication errors are displayed, but the BADPVFL is not set
for a diagnostic loop.
TIP
The loopback test can run along with other Array
Channel block scans, but doing so adversely affects
performance.

Time-Out gate configuration


The time-out gate feature checks for communication between the FTA
and the Allen-Bradley device. This lets the PLC know that the Serial
Interface is working.
By configuring an Array Channel block for a periodic write (such as
every 10, 20 or 30 seconds), the PLC issues a Report by Exception
message. This causes the FTA to return a status message that the
ladder logic can monitor and react to.
If the FTA fails, the PLC receives a status code 2016 and/or a timeout
occurs indicating to the PLC that the host is not communicating. When
the FTA recovers, the condition clears and the normal 00 status
(message was successful) returns.

Publication 1757-RM811A-EN-P - May 2002

Allen-Bradley Interface Appendix

B-15

Status and error checking


Several Array Channel block and SIM block parameters provide status
reporting. Error information appears in the form of a detailed code or
status flag. If configured, Error information appears on the Array
Channel block in the Monitoring tab in Control Builder (CB) or the
Channel and SIM block detail displays. You should periodically check
these block parameters.
BADPVFL/ERRFL: Provides overall status of array data (ON =
bad). The overall status is bad when there are communication
problems or the SIM block is inactive.
INITREQ: Tied to ERRFL status. It always equals the status of the
ERRFL. This parameter is provided for the sake of consistency
with other function blocks to indicate if the block can be stored
to at the current time.
ERRCODE: When ERRFL is ON, provides a detailed 8-character
string. Refer to the Notifications Reference and the following
Error Messages section for more information.

Error messages
The following table lists some possible Serial Interface and
Allen-Bradley communication errors for reference. You may also need
to refer to the Allen-Bradley documentation for error messages
specific to the PLC.
Table B.10 Select Error Code Descriptions
ERRCODE String

Description

Serial Interface Error Codes


# ELEMNT

Number of elements is out of range for the given Array Channel block.

ARR INIT

Array Channel block is configured, but no valid data has been received.

AUXMATCH

AUXDATA[2] and AUXDATA[3] configuration settings do not match the other channels in the FTA. All channels must
agree.

BAUD/PAR

The Baud Rate/Parity setting in AUXDATA[3] is not a valid setting.

CEE Idle

The CEE is Idle, so the function blocks are executing.

CFG LOAD

SIM is loading configuration to FTA.

ChCfgErr

Array Channel block configuration error exists. Check block configuration carefully.

Ch Inctv

Control Module containing the Array Channel block is inactive.

CONFIG

Can not load configuration to the SIM. Check all configuration data carefully.

DataCond

Array Channel block does not understand Data Conditioner (internal value) sent by the FTA.

Publication 1757-RM811A-EN-P - May 2002

B-16

Allen-Bradley Interface Appendix

Table B.10 Select Error Code Descriptions


ERRCODE String

Description

Serial Interface Error Codes (cont.)


DataType

Array Channel block is not supported or out of range for this device.

DEV ADDR

Configured device address is out of range.

Fac Test

A factory test diagnostic is in progress.

FTA COMM

SIM can not communicate with the FTA.

Inv Resp

An invalid field device response has occurred.

IO Comm

There is an I/O communications problem between the CPM and the SIM.

KPA ADDR

Keep Alive coil address in out of range.

MAX CONF

Catch All configuration error.

Md Inctv

The SIM function block is inactive, so the Array Channel block can not get new array data.

NO CONF

No configuration (Channel is not viewable at the operator Station).

No Conn

The Array Channel block can not get data because a proper connection does not exist between the CPM and the SIM.

No Data

Transient condition that occurs when the Control Module containing the Array Channel block is activated. Condition
clears once ERRFL is set OFF or ON.

No SIMFB

Array Channel block can not locate its assigned SIM block. Be sure the SIM block is loaded to the CEE.

PLC TYPE

PLC type is not supported.

POL FREQ

Polling frequency is out of range.

SIG/MOD

AUXDATA[2] setting is not valid.

Startidx

The STARTINDEX address is out of range.

STR LEN

Illegal string length for diagnostic loop channel type.

TMOT VAL

Message timeout value is out of range.

Allen-Bradley Communication Error Codes


ABEXT_mm

Allen-Bradley remote station specific EXT STS error (refer to Allen-Bradley documentation).

ABSTS_nn

Allen-Bradley local/remote station specific STS error (refer to Allen-Bradley documentation)

ACKTMOUT

Timed out waiting for ACK from CIM device.

ARR INIT

Point configured, but no valid data received yet.

CHECKSUM

Incorrect BCC detected on the last received message.

CIM_NAK

Received a NAK from the CIM device.

INV RESP

Invalid response received from the Allen-Bradley device.

MAXMSGST

Catch all Serial Interface error.

MSGTMOUT

Timed out waiting for the Allen-Bradley device to reply to the last request.

OK_POLL

No errors exist against the Array Channel block whose poll rate is within 0 to 255.

OK_RBE

No errors exist against the Array Channel block whose poll rate is 256.

PARITY

Incorrect parity on at least one character in the last received message.

RBE_FULL

RBE buffer full due to too many Report by Exception requests from the PLC devices.

Publication 1757-RM811A-EN-P - May 2002

Allen-Bradley Interface Appendix

B-17

Special FTA to KE/KF cabling considerations


As previously mentioned, an Allen-Bradley KE/KF Computer Interface
Module (CIM) is usually used to communicate with an A-B FTA. The
recommended KE/KF CIM configuration is full duplex, even parity,
BCC, embedded response disabled, 19,200 baud, and diagnostic
pass-through. A special cable with 25-pin (male) to 15-pin (male)
connectors and wired as shown below is requied to connect the
KE/KF CIM to the A-B FTA.
Figure 10.1 Connecting the KE/KF to the FTA

42780

Publication 1757-RM811A-EN-P - May 2002

B-18

Allen-Bradley Interface Appendix

FTA direct to PLC-5 RS-232 Port cable considerations:


To make a direct connection between the FTA and a PLC-5, you must
configure the PLC-5 serial port as RS-232, full duplex, even parity,
19,200 baud, and diagnostic pass through, ignore duplicate messages.
Do not configure the port as RS-422 or RS-485. You will need a null
modem cable with 25-pin male connections to connect the PLC-5 to
the A-B FTA. The cable connections are shown below for reference.
Figure 10.2 Connecting the PLC-5 to the FTA

42781

Publication 1757-RM811A-EN-P - May 2002

Allen-Bradley Interface Appendix

B-19

Reference Specifications
The following table lists some general specifications relevant to the
Serial Interface function.
Table B.11 Serial Interface Specifications
Function

Description

Serial Interface Array Channel


FTA Channel Capacity

Up to 16 channels per SI FTA

SIM Channel Capacity

Up to 32 channels per SIM (2 FTAs)

Data capacity per Array Channel


(contiguous data in PLC)

512 Flags (Boolean/coils), or


64 Numerics (8-Bit integers), or
32 Numerics (integers), or
16 Numerics (reals), or
1 string of 64 characters, or
2 string of 32 characters, or
4 string of 16 characters, or
8 string of 8 characters

Reads per Port(1)

Up to 2048 Booleans/second, or
Up to 128 integers/second, or
Up to 64 reals/second, or
Up to 4, 64-character strings/second, or
Weighted combinations of the above

Writes per Port(1)

10 channels/second

Publication 1757-RM811A-EN-P - May 2002

B-20

Allen-Bradley Interface Appendix

Table B.11 Serial Interface Specifications


Function

Description

Allen-Bradley Serial Interface


Model Numbers
A-B SI FTA

????????

SIM

TC-MUX021

SIM FTA Power Adapter

???????? (24 Vdc, 18-36 Vdc, 0.4A maximum)


???????? (85 to 265 Vac, 47-63 Hz, 12W maximum)

General
Interface Type

EIA-RS232-D

Number of Serial Ports

2 per SIM, 1 per FTA

Power Adapter to FTA Distance

300 meters (984 feet)

Baud Rate

19,200 baud

Serial Data Format

8 data Bits with even parity

Common Mode Operation

250 Vrms (continuous)

ESD Protection

IEEE SWC 472-1974

EIA-RS232-D Support
Interface Type

Serial asynchronous

Lines Supported

TXD, RXD, Logic GND, Protectiv GND (Compatible with CCIT V.24; CCIT V.28)

FTA to Device Distance

15 meters (49 feet)

Allen-Bradley Specific
Protocol

Full duplex Allen-Bradley DF1 with embedded responses

Transmission Mode

Character oriented

Serial Line Mode

RS232

Parity

Even

Number of Stop Bits

Modem Control Support

Off

ACK Timeout

3.2 seconds

FTA Message Response Timeout

4.0 seconds

Data Format Supported

Booleans, Reals, Signed/Unsigned Integers, ASCII Strings

CIM Communications Options

Pass-through diagnostic requests


Ignore handshaking
Accept duplicate message
BCC error check

PLC Types Supported

PLC-2
PLC-3 (Native Mode and PLC-2 Mode)
PLC-5, except PLC-5/20 (Native Mode and PLC-2 Mode)

(1)

Read and write performance is sensitive to a number of variables, including the PLC type, scan time, PLC network configuration and traffic, amount of data access from
other devices, and the overall health of the PLC network. For best results, a direct PLC connection is recommended. The ratings listed do not represent best performance
figures. Read performance degrades with increased writes.

Publication 1757-RM811A-EN-P - May 2002

Appendix

MODBUS Interface Appendix

Array Channel Block


Configuration for Generic
MODBUS Interface

About Generic Modbus Interface


Many devices that use the AEG Modicon Modbus RTU protocol can
communicate with the ProcessLogix system through the Array Channel
blocks for the SIM. Refer to Modbus documentation for a description
of the Modbus protocol.

AUXDATA Parameter Configuration


The following table summarizes the AUXDATA parameter
configuration that defines Serial Interface Array Channel block
communications with the Generic Modbus.
Table C.A Serial Interface Array Channel Communications with Generic Modbus
Parameter

Function

Description

AUXDATA[0]

Specifies the Keep Alive Address for a


Modbus coil.

This parameter tells the Modbus system that the ProcessLogix subsystem is
functioning. It can be configured separately on each array channel block, but
no two array channel blocks should write to the same coil. The coil address
must be within the range 00001 to 09999.
Note: When this parameter is NaN, the Keep Alive function is inactive. If you
want to check the Keep Alive coil, you must program the Modbus device to do
so.

AUXDATA[1]

Specifies the time interval in seconds


to wait before attempting a message
retry.

If a valid response is not received after three tries (original plus two retires), a
MSGTMOUT error results. The range is 0.25 to 5 seconds on NaN. If NaN is
specified, the default timeout is 1.5 seconds. A timeout value can be
configured separately for each array channel block.

Publication 1757-RM811A-EN-P - May 2002

C-2

MODBUS Interface Appendix

Table C.A Serial Interface Array Channel Communications with Generic Modbus
The first valid array channel block loaded to the Controller with values in
AUXDATA[2] and AUXDATA[3] sets the mode and baud rate for the FTA
communications. This means that AUXDATA[2] AUXDATA[3] must contain the
same value for all array blocks configured through the same FTA. If array
blocks loaded later to that FTA have different AUXDATA[2]/[3] values, an
AUXMATCH error results.
The modem control feature switches the following signals: RTS, CTS, DSR,
DTR, and DCD. When AUXDATA[2] is NaN, the protocol is EIA-232 and modem
control is OFF.

AUXDATA[2]

Specifies the signaling protocol and


modem control in an integer/decimal
format: mmm.n
Where mmm is the signaling protocol
and n is the modem control (0 = OFF
and 1 = ON).
For example, 232.1 indicates EIA-232
with modem control ON. The other
choices are 232.0 and 485.0. EIA-232
permits use of an external modem.

AUXDATA[3]

Specifies the baud rate in an


The legal baud rates are 19200, 9600, 4800, 2400, and 1200. NaN (dashes)
integer/decimal format: bbbbb.n
results in a default value of 19200 baud with odd parity.
Where bbbbb is the baud rate and n is
the parity (0 = None, 1 = Odd, 2 = Even).

AUXDATA[4] to These parameters are not applicable to Set these parameters to NaN when communicating with a Modbus.
AUXDATA[7]
a Generic Modbus interface.

STARTINDEX and Number of Elements Parameter


The value configured for the STARTINDEX parameter in a given Array
Channel block determines the Modbus Start Index and function. Only
one type of external data can be accessed per Array Channel block.
The number of elements parameter (NFLAG, NNUMERIC, or
NSTRING) in a Flag Array, Numeric Array, or Text Array Channel
block determines the number of flags, numerics, or strings in a given
data array.
The following table shows the relationship between Modbus functions
and the STARTINDEX and number of elements parameters. The Start
Index Ranges defines the Modbus address map. The most significant
digit in this column identifies the Modbus function (for example, read
coil status). The lower four digits define the starting address to access
data for the given Modbus function. The address ranges 2xxxx, 4xxxx,
5xxxx, 7xxxx, 8xxxx, and 9xxxx all address the same xxxx registers in
the PLC, but with different data formats. When multiple numeric data
types are used, you must configure the STARTINDEX for each array to
avoid overlapping arrays.
The maximum number of elements specifies the maximum number of
flags, numerics, or strings that can be configured for a given Start
Index Range and block type. All of the specified elements are read in
a single transaction.

Publication 1757-RM811A-EN-P - May 2002

MODBUS Interface Appendix

C-3

Table C.B
Start Index Modbus Function
Ranges
00001 09999

Read FC

Array Channel Function Block

Data Range

Max. No.
Elem.

SIFLAGARRCH
Read/Write Bit Flags

ON/OFF

512

SIFLAGARRCH
Read Only Bit Flags

ON/OFF

512

SINUMARRCH
Word Swapped IEEE FI.Pt Read/Write

-34E38 to
34E38

16

SINUMARRCH
Signed Integer Words Read only

-32768 to
32767

32

SINUMARRCH
Signed Integer Array Read/Write

-32768 to
32767

32

SITEXTARRCH
ASCII Encoded Bytes Read/Write

Printable
Characters

8 0f 8
4 or 16
2 or 32
1 of 64

Write FC

Read Coil Status

01

Force Single Coil

05

Read Input Status

02

Not Applicable

N/A

Read Holding Registers

03

Preset Multiple Registers

16(2)

Read Input Registers

04

Not Applicable

N/A

Read Holding Registers

03

Preset Single Register

06

Read Holding Registers

03

Preset Single Register

06

60000(1)

Loopback Diagnostics

08

SITEXTARRCH
Loopback Test

None

1 of 64

70001
79999

Read Holding Registers

03

SINUMARRCH
IEEE Floating Point Read/Write

-34E38 to
34E38

16

Preset Multiple Registers

16(2)

Read Holding Registers

03

SINUMARRCH
IEEE FI. Pt in Addr-1 Read/Write

-34E38 to
34E38

16

Preset Multiple Registers

16(2)

Read Holding Registers

03

SINUMARRCH
Unsigned Integer Words Read/Write

0 to 65535

32

Preset Single Register

06

10001
19999
20001
29999(1)
30001
39999
40001
49999
50001
59999(1)

80002
89999(1)
90001
99999

(1)

These ranges are extensions to the Modbus protocol specifications to support certain Modbus devices.

(2)

Function Code 16 is used to write a multiword data type in one transaction.

Publication 1757-RM811A-EN-P - May 2002

C-4

MODBUS Interface Appendix

Modbus loopback diagnostic


The loopback test consists of sending a test message to the Modbus
device and waiting for the proper response. To do this, configure a
TEXT array channel block as follows.
STARTINDEX = 60000 (loopback test address)
NSTRING = 1
STRLEN = 64
When the block is active, the monitor data block.str[1] should contain
the message:
Loopback Test: Attempted xxxxx

Pass xxxxx

Where xxxxx is a pass/failure count.


TIP
The loopback test can run along with other Array
Channel block scans, but doing so adversely affects
performance.

Performance Considerations
IMPORTANT

Publication 1757-RM811A-EN-P - May 2002

Since the Serial Interface I/O Module (SIM)


bandwidth is limited, the Array Channel blocks
only process writes which change the current
process value. This eliminates unnecessary
repeated writes.
In ProcessLogix systems with redundant
Controller configurations, the writes are not
guaranteed during a failover. The store attempt
may occur in the Primary Controller, but it may
not reach the SIM before the failover occurs. The
Secondary Controller does not attempt to resend
the data.

MODBUS Interface Appendix

C-5

An active SIM function block processes the following actions once per
its publication period of 250 milliseconds. The publication rate is the
same whether the SIM block is assigned to a 5ms-CEE or a 50ms-CEE
type.
Load Serial Interface Array Channel block configurations to the
SIM.
Send Array Channel block write requests to the SIM.
Monitor status of the SIM, and report diagnostics, as applicable.
Of course, these actions are not performed when the SIM block is
inactive. When the SIM block is inactive, the Array Channel blocks set
their data to applicable default values.
The SIM block collects the writes for each array channel and sends
them to the SIM every 250ms. The following table lists the maximum
number writes a SIM block supports per channel in every 250ms
cycle. If the SIM blocks write list becomes full, it rejects a write to the
array channel block.
Table C.C
Array Channel Block

Maximum Number of Writes


(Channel/250ms)

SINUMARRCH

SIFLAGARRCH

16

SITEXTARRCH (STRLEN = 8)

SITEXTARRCH (STRLEN = 16)

SITEXTARRCH (STRLEN = 32)

SITEXTARRCH (STRLEN = 64)

Writes to Array Channel Blocks can also be rejected because the SIM
is not keeping up with the writes being sent by the SIM block. Write
overruns are indicated by the SIM block FTAAOVRNFL and
FTABOVRNFL parameters. To provide an overrun condition alarm,
connect the overrun parameters to a FLAG function block configured
to generate an OffNormal alarm.

Publication 1757-RM811A-EN-P - May 2002

C-6

MODBUS Interface Appendix

Array Channel Block Execution State


The Array Channel block uses the Execution State (EXECSTATE) and
Execution Period (PERIOD) parameter settings for the Control Module
that contains it. When the Control Module is activated, the Array
Channel block sends its configuration to the SIM function block for
loading in the SIM/FTA. Inactivating and activating the Control
Module/Array Channel block, reloads the configuration.
IMPORTANT

It may take a few seconds after the Array Channel


block is activated for the configuration to be loaded
to the SIM/FTA and good data to be imaged from the
device to the Array Channel block. During this time,
short duration BADPV alarms may occur on blocks
that are accessing the channels array data.

Write Processing Considerations


The Array Channel block array data can be written to either through a
one-time store from a Sequential Control Module, an operator, or
continually through a wired connection.
Upon receiving a store request, the Array Channel block forwards the
requested store to the SIM block. The SIM block forwards the store
request to the SIM and FTA. The stored value is not saved in the Array
Channel block. The Array Channel block value does not change until
the imaged value shows the new value, indicating that the store really
made it to the end device.
TIP

Publication 1757-RM811A-EN-P - May 2002

Use a read-back check to verify that a write is


successful in reaching the external device. A
read-back check reads the parameter just written and
compares it to the value written. When the compared
values are equal, it guarantees that the write was
successful all the way to the serial device. The
feedback time varies based on SIM, FTA, and device
performance.

MODBUS Interface Appendix

C-7

Status and Error Checking


Several Array Channel block and SIM block parameters provide status
reporting. Error information appears in the form of a detailed code or
status flag. If configured, Error information appears on the Array
Channel block in the Monitoring tab in Control Builder (CB) or the
Channel and SIM block detail displays. You should periodically check
these block parameters.
BADPVFL/ERRFL: Provides overall status of array data (ON =
bad). The overall status is bad when there are communication
problems or the SIM block is inactive.
INITREQ: Tied to ERRFL status. It always equals the status of the
ERRFL. This parameter is provided for the sake of consistency
with other function blocks to indicate if the block can be stored
to at the current time.
ERRCODE: When ERRFL is ON, provides a detailed 8-character
string. Refer to the Notifications Reference and the following
Error Messages section for more information.

Error Messages
The following table lists some possible Serial Interface and
Allen-Bradley communication errors for reference. You may also need
to refer to the Allen-Bradley documentation for error messages
specific to the PLC.
Table C.D Select Error Code Descriptions
ERRCODE String

Description

Serial Interface Error Codes


# ELEMNT

Number of elements is out of range for the given Array Channel block.

ARR INIT

Array Channel block is configured, but no valid data has been received.

AUXMATCH

AUXDATA[2] and AUXDATA[3] configuration settings do not match the other channels in the FTA. All channels must
agree.

BAUD/PAR

The Baud Rate/Parity setting in AUXDATA[3] is not a valid setting.

CEE Idle

The CEE is Idle, so the function blocks are executing.

CFG LOAD

SIM is loading configuration to FTA.

ChCfgErr

Array Channel block configuration error exists. Check block configuration carefully.

Ch Inctv

Control Module containing the Array Channel block is inactive.

CONFIG

Can not load configuration to the SIM. Check all configuration data carefully.

DataCond

Array Channel block does not understand Data Conditioner (internal value) sent by the FTA.

Publication 1757-RM811A-EN-P - May 2002

C-8

MODBUS Interface Appendix

Table C.D Select Error Code Descriptions


ERRCODE String

Description

Serial Interface Error Codes (cont.)


DataType

Array Channel block is not supported or out of range for this device.

DEV ADDR

Configured device address is out of range.

Fac Test

A factory test diagnostic is in progress.

FTA COMM

SIM can not communicate with the FTA.

Inv Resp

An invalid field device response has occurred.

IO Comm

There is an I/O communications problem between the CPM and the SIM.

KPA ADDR

Keep Alive coil address in out of range.

MAX CONF

Catch All configuration error.

Md Inctv

The SIM function block is inactive, so the Array Channel block can not get new array data.

NO CONF

No configuration (Channel is not viewable at the operator Station).

No Conn

The Array Channel block can not get data because a proper connection does not exist between the CPM and the SIM.

No Data

Transient condition that occurs when the Control Module containing the Array Channel block is activated. Condition
clears once ERRFL is set OFF or ON.

No SIMFB

Array Channel block can not locate its assigned SIM block. Be sure the SIM block is loaded to the CEE.

PLC TYPE

PLC type is not supported.

POL FREQ

Polling frequency is out of range.

SIG/MOD

AUXDATA[2] setting is not valid.

Startidx

The STARTINDEX address is out of range.

STR LEN

Illegal string length for diagnostic loop channel type.

TMOT VAL

Message timeout value is out of range.

Modbus Communication Error Codes


CHECKSUM

Incorrect checksum received.

Ex or xx

Modbus device error codes (Hex). Refer to device documentation.

NO CTS

Modem did not respond with Clear To Send within the message timeout time.

NO DSR

Modem is not asserting Data Set Ready as expected.

Parity
Checksum
MSGTMOUT
ChrTmout

A Modbus device communication error has occurred.

RX OVFLO

A receive buffer overflow occurred on a message response received from the Modbus device.

Publication 1757-RM811A-EN-P - May 2002

MODBUS Interface Appendix

C-9

Special Modbus Slave FTA Implementation


The following table summarizes the tasks and information associated
with implementing a Modbus Slave FTA. The Modbus Slave FTA is
available as a repeatable special product (hardware part number
51191029-Tab, documentation part number 51191030).
Table C.E Implementing a Modbus Slave FTA
Task/Information

Action/Reference

Restrictions

Configuration

In each Master and Slave Array Channel pair, configure the identical settings for the device address (DEVADDR)
and start index (STARTINDEX) parameters.
Configure identical, non-overlapping data areas in Master and Slave Array Channel pairs. For example, if Array 1
is 32 integers with a STARTINDEX of 90001, then Array 2 must have a STARTINDEX of 00033. If Array 1 is 512
Booleans with a STARTINDEX of 00000 and Array 2 is 16 floating points, then Array 2 must have a STARTINDEX
of 70513 and Array 3 must have a STARTINDEX of x00001 + 512 +16 = 529.
In all Slave Array Channels, set AUXDATA[4] parameter to a non-zero value (1.0) to enable the Remote Terminal
Unit (RTU) protocol.
In all Master Array Channels, set AUXDATA[1] parameter to recommended 3.0 second timeout.
In all Master and Slave Array Channel pairs, configure the identical settings for AUXDATA[2] and AUXDATA[3]
parameters.
For short distances, the default is RS-232 direct connection with NaN settings for both AUXDATA[2] and
AUXDATA[3] parameters.
For long distance, use RS485 connection with a 485.0 setting for the AUXDATA[2] parameter and a 19200.1
setting for the AUXDATA[3] parameter.

Common Errors

If the Master accesses a device address that does not match an existing Slave Array configuration, the Slave
responds with an Ex-2 error and freezes. After the Master address is corrected, you must restart or reconfigure
the Slave.
If the Slave Array is configured with overlapping data areas between arrays, it returns the STRTINDX error code.
If the Slave Array is configured with a conflicting device address, it returns the DEV ADDR error code.
If the Slave is configured for a STARTINDEX address of 8xxxx, it causes an Ex-2 error code in the Master. The
8xxxx address (IEEE Float at address 1) is not supported.

Must pair only one Master and one Slave.


Since the Slave responds to all addresses, no other multidrop devices are permitted.
To avoid the Ex-2 error, configure and load the Slave FTA first.
You can configure different device addresses for each Array Channel pair, but only addresses 1 to 15 are legal.

Publication 1757-RM811A-EN-P - May 2002

C-10

MODBUS Interface Appendix

Reference Specifications
The following table lists some general specifications relevant to the
Serial Interface function.
Table C.F Serial Interface Specifications
Function

Description

Serial Interface Array Channel


FTA Channel Capacity

Up to 16 channels per SI FTA

SIM Channel Capacity

Up to 32 channels per SIM (2 FTAs)

Data capacity per Array Channel


(contiguous data in PLC)

512 Flags (Boolean/coils), or


64 Numerics (8-Bit integers), or
32 Numerics (integers), or
16 Numerics (reals), or
1 string of 64 characters, or
2 string of 32 characters, or
4 string of 16 characters, or
8 string of 8 characters

Reads per Port(1)

Up to 2048 Booleans/second, or
Up to 128 integers/second, or
Up to 64 reals/second, or
Up to 4, 64-character strings/second, or
Weighted combinations of the above

Writes per Port(1)

10 channels/second

Allen-Bradley Serial Interface


Model Numbers
SIM

Publication 1757-RM811A-EN-P - May 2002

TC-MUX021

MODBUS Interface Appendix

C-11

Table C.F Serial Interface Specifications


Function

Description

General
Interface Type

EIA-RS232-D or EIA-485

Number of Serial Ports

2 per SIM, 1 per FTA

Power Adapter to FTA Distance

300 meters (984 feet)

Protocol

Modbus

Transmission Mode

RTU

Serial Line Mode

RS232 or RS485

Selectable Baud Rates

1200, 2400, 4800, 9600, 19200 bps

Serial Data Format

8 data bits with programmable ninth bit (parity)

Selectable Parity

None, odd, or even

Common Mode Operation

250 Vrms (continuous)

ESD Protection

IEEE 801.2

Surge Protection

IEEE SWC 472-1974

Number of Stop Bits

Modem Control Support

Selectable On/Off

Keep Alive Cell Write

Configurable address

Message Response Timeout Time

Configurable timeout

Inter-Message Stall Time

3.5 Character Time minimum

Data Formats Supported

Boolean, Real, ASCII Strings, Signed Integers, Unsigned Integers

Exception Errors Reported

Keep Alive, Message Response Timeout, Signaling Mode/Modem Support, Baud Rate, Parity

EIA-RS232-D Support
Interface Type

Serial asynchronous

Lines Supported

TXD, RXD, Logic GND, Protectiv GND (Compatible with CCIT V.24; CCIT V.28)

FTA to Device Distance

15 meters (49 feet) (Cable capacitance = 2500 pF maximum.)

EIA-485 Support
Interface Type

Serial asynchronous half duplex only

Lines Supported

Two wire differential pair: DATA+, DATA-, Protective GND (shield)

Number of Transceivers

15 drops maximum

FTA to Device Distance

1.2 Km (4000 ft) maximum

(1)

Read and write performance is sensitive to a number of variables, including the PLC type, scan time, PLC network configuration and traffic, amount of data access from
other devices, and the overall health of the PLC network. For best results, a direct PLC connection is recommended. The ratings listed do not represent best performance
figures. Read performance degrades with increased writes.

Publication 1757-RM811A-EN-P - May 2002

C-12

MODBUS Interface Appendix

Publication 1757-RM811A-EN-P - May 2002

How Are We Doing?


Your comments on our technical publications will help us serve you better in the future.
Thank you for taking the time to provide us feedback.
You can complete this form and mail it back to us, visit us online at www.ab.com/manuals, or
email us at RADocumentComments@ra.rockwell.com
Pub. Title/Type ProcessLogix Function Block Parameters
Cat. No.

1757 Series

Pub. No.

1757-RM811A-EN-P

Pub. Date May 2002

Part No.

957603-63

Please complete the sections below. Where applicable, rank the feature (1=needs improvement, 2=satisfactory, and 3=outstanding).
Overall Usefulness

Completeness
(all necessary information
is provided)

Technical Accuracy
(all provided information
is correct)

How can we make this publication more useful for you?

Can we add more information to help you?

Clarity
1
(all provided information is
easy to understand)

Other Comments

Your Name

procedure/step

illustration

feature

example

guideline

other

explanation

definition

Can we be more accurate?


text

illustration

How can we make things clearer?

You can add additional comments on the back of this form.

Location/Phone

Your Title/Function

Would you like us to contact you regarding your comments?


___No, there is no need to contact me
___Yes, please call me
___Yes, please email me at __________________________
___Yes, please contact me via ________________________

Return this form to:

Allen-Bradley Marketing Communications, 1 Allen-Bradley Dr., Mayfield Hts., OH 44124-9705


Phone: 440-646-3176 Fax: 440-646-3525 Email: RADocumentComments@ra.rockwell.com

Publication ICCG-5.21- January 2001

PN 955107-82

PLEASE FASTEN HERE (DO NOT STAPLE)

PLEASE FOLD HERE

NO POSTAGE
NECESSARY
IF MAILED
IN THE
UNITED STATES

BUSINESS REPLY MAIL


FIRST-CLASS MAIL PERMIT NO. 18235 CLEVELAND OH
POSTAGE WILL BE PAID BY THE ADDRESSEE

1 ALLEN-BRADLEY DR
MAYFIELD HEIGHTS OH 44124-9705

PLEASE REMOVE

Other Comments

Publication 1757-RM811A-EN-P - May 2002 17

PN 957603-63
2002 Rockwell International Corporation. Printed in the U.S.A.