Advanced Process

Manager
Parameter Reference
Dictionary
AP09-540
 Implementation
Advanced Process Manager - 3

Advanced Process
Manager
Parameter Reference
Dictionary
AP09-540
Release 520
10/96
 Copyright, Trademarks, and Notices

© Copyright 1995 - 1996 by Honeywell Inc.

Revision 04 - October 28, 1996

While this information is presented in good faith and believed to be accurate,

Honeywell disclaims the implied warranties of merchantability and fitness for a
particular purpose and makes no express warranties except as may be stated
in its written agreement with and for its customer.

In no event is Honeywell liable to anyone for any indirect, special or

consequential damages. The information and specifications in this document
are subject to change without notice.

TDC 3000 and TotalPlant are U.S. registered trademarks of Honeywell Inc.
Other brand or product names are trademarks of their respective owners.
 About This Publication
This publication defines the parameters for the APM data point types implemented through
TotalPlant Solution (TPS) System network release 500 - 520. TPS is the evolution of
TDC 3000X.

Change bars are used to indicate paragraphs, tables, or illustrations containing changes
that have been made to this manual effective with Release 520. Pages revised only to
correct minor typographical errors contain no change bars.

APM Parameter Reference Dictionary 10/96

APM Parameter Reference Dictionary 10/96
 Table of Contents

1 INTRODUCTION

1.1 Purpose
1.2 Use of This Publication
1.3 Parameter Definition Format
1.4 Parameters Per Point Type and Algorithm Type
1.5 Full Points and Component Points
1.6 Abbreviations
1.7 CL Access
1.7.1 Parameters Not Accessible to CL
1.7.2 CL Restricted Parameters
2 PARAMETERS PER POINT TYPE

2.1 Analog Input (AnalgIn)

2.2 Analog Output (AnalgOut)
2.3 Array
2.4 Box (APM Box)
2.5 Box Flag
2.6 Box Numeric
2.7 Box Timer
2.8 Device Control (DevCont)
2.9 Digital Composite (DigComp)
2.10 Digital Input (DigIn)
2.11 Digital Output (DigOut)
2.12 IOP
2.13 Logic
2.14 Process Module (ProcMod)
2.15 Universal Control Network
2.16 UCN Node Data Point
3 PARAMETERS PER ALGORITHM TYPE

3.1 Auto Manual (AutoMan)

3.2 Calculator (Calcultr)
3.3 Data Acquisition (DataAcq)
3.4 Flow Compensation (FlowComp)
3.5 General Linearization (GenLin)
3.6 High-Low Average (HiLoAvg)
3.7 Incremental Summer (IncrSum)
3.8 Middle-of-3 (MidOf3)
3.9 Override Selector (ORSel)
3.10 Pid
3.11 Pid with External Reset Feedback (PidErfb)
3.12 Pid with Feed Forward (PidFf)
3.13 Pid with Position Proportional (PidPosPr)
3.14 Position Proportional (PosProp)
3.15 Ramp Soak (RampSoak)
3.16 Ratio Control (RatioCtl)
3.17 Summer
3.18 Switch
3.19 Totalizer (Totalizr)
3.20 Variable Dead Time with Lead/Lag (VdtLdLag)

$–Y PARAMETER DEFINITIONS

APM Parameter Reference Dictionary i 10/96

APM Parameter Reference Dictionary ii 10/96
 1

INTRODUCTION
Section 1

1.1 PURPOSE

This publication defines the user-visible parameters that exist in the TotalPlant Solution
(TPS) System Advanced Process Manager (APM) and Network Interface Module (NIM).
It also provides listings of parameters that are applicable to various APM point types and
algorithms.

For information on how the parameters are related to each other in terms of point types and
algorithms, refer to the Advanced Process Manager Control Functions and Algorithms
manual in the Implementation/Advanced Process Manager - 1 binder.

1.2 USE OF THIS PUBLICATION

Use this publication during configuration and during operation when detailed information
about APM and NIM parameters is required.

For use in data point configuration, this publication provides definitions for each entry that
can be made on the Advanced Process Manager Point Configuration Forms, AP88-500 in
the Implementation/Advanced Process Manager - 1 binder, and in the Parameter Entry
Displays at the Universal Station.

For use in process operation, this publication provides information about the parameters
that appear for the process data points and APM Box Data Point on the displays of
Universal Stations that are running with the Operator personality.

1.3 PARAMETER DEFINITION FORMAT

In this dictionary, the parameter definitions are listed in alphabetical order according to the
parameter name, which can be up to eight characters in length. Each parameter in this
publication is defined using the format shown below for the ALMOPT parameter, as an
example. The following paragraphs describe the entries that appear within each parameter
definition.

ALMOPT (DigIn)
Type: e($ALMOPT) Alarming Option—Defines the alarming option for a digital input point whose
Lock: Eng/PB DITYPE is Status.
Default: None
PtRes: APM
Range: 0-None (No alarms are to be detected)
1-Offnorml (Off Normal; alarm if current PV state is not the PVNORMAL state. PVNORMAL is
defined by the STATETXT(0) or STATETXT(1) descriptor, as configured by the user.)
2-ChngofSt (An alarm is generated when the digital input changes state in either direction).

Helpful Hint: ALMOPT configuration requires DITYPE = Status.

APM Parameter Reference Dictionary 1-1 10/96

 1.3

For many parameters, the function of the parameter is described using the long name of the
parameter (Alarm Option), followed by a description as shown in the above example.
Some parameters in this dictionary do not have functional descriptions following the long
name; this is because the long name of the parameter sufficiently describes the parameter
function.

Type

This entry is the data type that defines how the parameter is viewed by the system. The
following data types are used in this dictionary:

• E:—Enumeration; the value for the parameter is chosen from a set of predefined
character strings. In the above example, the enumerations of $ALMOPT are None,
Offnorml.

• SD_ENM:—Self-Defining Enumeration; the value for the parameter is chosen from

the user-defined character strings.

• [Link]—consists of a 1-16 character tag name, a period, and a 1-8 character

parameter name.

• Integer—a 16-bit whole number that does not contain a decimal point (+ 32767).

• Logical—a binary type with the values of ON (True) and OFF (False), or 0 (Off) and
1 (On).

• NaN—although not a data type, is used to represent "Not A Number" and is stored in
IEEE format.

• Prm_Id—1-8 character parameter name.

• Real—a 32-bit floating-point number in IEEE format.

• String_L—a character string of maximum length = L. Same as Ascii_L.

• Time—The time of day in one of the following formats: DDD HH:MM:SS for
durations, and DDMMYY HH:MM:SS for an absolute date or time stamp.

• Universal [Link]—Universal Entity Parameter Identifier. It is basically the same as

[Link], but the entity name can be entered as an external 16-character tag name or as
the APM's internal hardware reference address. The hardware reference address syntax
can be used to access parameters of points (within this same APM) that are untagged
or tagged.

APM Parameter Reference Dictionary 1-2 10/96

 1.3

The following are examples of hardware reference addresses*:

Type Hardware Reference Address

AO Processor Output ![Link] (Parameter OP of Slot #3 of AO processor

#11)

DI Processor PV ![Link] (Parameter PVFL of Slot #7 of DI processor

#5)

DO Processor ![Link] (Parameter SO of Slot #12 of DO processor

#15)
Status Output

DO Processor ![Link] (Parameter ONPULSE of Slot #12 of

DO
ON Pulse Command processor #15)

DO Processor ![Link] (Parameter OFFPULSE of Slot #12 of

OFF Pulse Command DO processor #15)

Lock
The access lock defines "who" or "what" can change the parameter's value or option and the
access level defines "who" or "what" is requesting a parameter value or option change. For
example, if a requestor with an access level of Supr tries to change a parameter that has an
access lock of Engr, the request will be denied. The two charts below describe how access
levels and access locks work.
Access Level Used By Who Or What When A
Parameter Change Request Is Made

Oper Operator
Supr or Sup Supervisor
Engr, Eng, or Eg Engineer
Cont Continuous_Control (from a Module on the LCN)
OnProc On Process
APMMCc APMM_Continuous_Control (from APMM)
Prog CL/APM Sequence_Programs
PtBld or PB Point_Builder (Data Entity Builder)
Access Lock Access Level of Requestors That Can Change The Parameter

Oper Oper Supr Engr Cont APMMCc Prog PtBld

Supr Supr Engr Cont APMMCc Prog PtBld
Engr Engr Cont APMMCc Prog PtBld
OnProc Oper Supr Engr
Sup/Eg Supr Engr
EgOnly Engr
Prog Cont APMMCc Prog PtBld
Eng/PB Engr PtBld
PtBld PtBld
View (Read Only)
______________
*The Analog Input address ![Link] is not supported because the Analog Input point does not
have a useable default database.

APM Parameter Reference Dictionary 1-3 10/96

 1.4

Default
The default for the parameter is the default value assigned by the system. The system
automatically enters the default value for a parameter when a range or a selection is not
entered for a parameter during point building. The default values are also shown on the
configuration forms and parameter entry displays.
PtRes
This defines where the parameter physically resides. The following residency locations are
used in the parameter definitions:
PtRes Definition

APM Advanced Process Manager

NIM Network Interface Module
SI Serial Interface

Range

This defines the range of the value that can be entered for this parameter. Integers that
precede APM resident enumeration parameters are sometimes needed by advanced CL
users. These integers specify the member’s position within the set (that is, the ordinal).
CL programs external to the UCN (such as AM/CL) will see the same enumeration
strings, but in some cases, with different ordinal values.

Helpful Hint
Some parameter definitions contain a Helpful Hint box at the end of the definition. This
box contains additional information about the parameter, such as prerequisites, etc.

1.4 PARAMETERS PER POINT TYPE AND ALGORITHM TYPE

In addition to the parameter definitions, this dictionary also contains listings of the
parameters that are applicable to each APM point type and algorithm type. Parameters-per-
point-type are defined in Section 2; parameters-per-algorithm-type are defined in Section 3.

1.5 FULL POINTS AND COMPONENT POINTS

Separate functional elements of the APM are used to implement various parts of typical
control loops and control strategies. Each of these functional elements can be assigned a
user-defined tag name to allow for location-independent reference to the data associated
with that function. For example, point tags are assigned by the user for analog input and
analog output slots. The I/O Processor data (engineering-unit range for inputs,
characterization option for outputs, etc.) is configured as part of the point-build process for
these points. A separate tag is configured for each regulatory control (RegCtl) slot that is
linked to the assigned analog I/O tags through input/output connections.

APM Parameter Reference Dictionary 1-4 10/96

 1.6
The APM provides a configurable parameter called PNTFORM (Point Form) that allows
the user to define which points are to be used as the primary operator interface for point
data. The PNTFORM parameter provides the user with two choices for point form: "Full"
and "Component." Points that are configured as having "Full" point form include
descriptor data and alarm-related parameters. This information is needed when the point is
to be used as the primary operator interface to the point's data.

Points that are configured as having "Component" point form do not require descriptor
data and alarm-related parameters, because this type of information is suppressed for
"Component" points. This point form should be used for points that provide inputs to the
"Full" point and also for those points that handle the outputs from the "Full" points.
"Component" points should be used as part of the "Full" point that has been designated a
primary operator interface point.
1.6 ABBREVIATIONS

AM Application Module
AnalgIn Analog Input Data Point
AnalgOut Analog Output Data Point
AO Analog Output
APM Advanced Process Manager
APMM Advanced Process Manager Module
APM Box APM Box Data Point
Array Array Data Point
AutoMan Auto Manual algorithm
Box Box Data Point
Calcultr Calculator algorithm
CM Computing Module 50 or 60
DevCtl Device Control Data Point
DI Digital Input
DigComp Digital Composite Data Point
DigIn Digital Input Data Point
DigOut Digital Output Data Point
DISOE Digital Input Sequence of Events
DO Digital Output
Flag Flag Data Point
FlowComp Flow Compensation algorithm
FTA Field Termination Assembly
GenLin General Linearization algorithm
HiLoAvg High Low Average algorithm
HLAI High Level Analog Input
IncrSum Incremental Summer algorithm

APM Parameter Reference Dictionary 1-5 10/96

 1.6

IOL I/O Link

IOP I/O Processor
Logic Logic Data Point (Slot)
LCN Local Control Network
LLAI Low Level Analog Input (or LLAI-8)
LLMUX Low Level Analog Input Multiplexer (or LLAI-16/32)
MidOf3 Middle-of-3 Selector algorithm
NIM Network Interface Module
ORSel Override Selector algorithm
PI Pulse Input
Pid Proportional, Integral, Derivative,
PidErfb Proportional, Integral, Derivative with External Reset Feedback algorithm
PidFf PID with Feedforward algorithm
PidPosPr PID With Position Proportional algorithm
PosProp Position Proportional algorithm
ProcMod Process Module Data Point
RampSoak Ramp Soak algorithm
RatioCtl Ratio Control algorithm
RegCtl Regulatory Control Data Point or algorithm
RegPV Regulatory PV Data Point or algorithm
SI Serial Interface
SDI Serial Device Interface
STI Smart Transmitter Interface
Switch Switch algorithm
Summer Summer algorithm
Timer Timer Data Point
Totalizr Totalizer algorithm
UCN Universal Control Network
VdtLdLag Variable Deadtime Lead Lag algorithm

APM Parameter Reference Dictionary 1-6 10/96

 1.7

1.7 CL ACCESS

1.7.1 Parameter Not Accessible to CL

Parameter $EVNTREC is not accessible to Control Language (CL) sequences.

1.7.2 CL Restricted Parameters

The following parameters are not accessible to PM/CL sequences. They are not directly
available to AM/CL sequences. Access to AM/CL is through a custom data segment
parameters attached to AM regulatory points as described below.
BHALMFL1-BHALMFL7
NODESTS
NODETYP
UCNRECHN
These parameters are available to user schematics using the NIM reserved data point, e.g.,
$[Link], where uu = UCN number and nn = UCN node number.

AM/CL programs can access the restricted parameters as Regulatory Point General inputs
(using ordinary point parameter access). They must be transferred to parameters of AM
regulatory points. There are two ways to do this:

1. Boolean parameters (BHALMFLn), can be referenced as general inputs to a Switch

algorithm. A CL program can access the switch parameters.

2. For Enumerations (NODEOPER, NODESTS, NODETYP, POSITION, AND

UNRECHN) a custom data segment is created to allow the parameters to be referenced
as general inputs and transferred to user-defined parameters (of a RegCtl Point) that can
be accessed by Cl.

APM Parameter Reference Dictionary 1-7 10/96

APM Parameter Reference Dictionary 1-8 10/96
 2

PARAMETERS PER POINT TYPE

Section 2

This section contains listings of parameters that are applicable to each data point type in the
APM, except for the Regulatory Control and Regulatory PV data points which can be found
in Section 3. Refer to Sections $ - X for the definitions of the parameters.

2.1 Analog Input (AI)

The parameters of the Analog Input Data points are listed below in alphabetical order. (F)
indicates that the parameter is applicable when the PNTFORM = Full.
$AUXUNIT (F) LRL PVALDB (F) PVLLFL SLWSRCID
ALENBST (F) LRV PVALDBEU (F) PVLLPR (F) PVTV (F)
ASSOCDSP MODNUM PVAUTO PVLLTP (F) PVTVP (F)
AVDELTHS NAME PVAUTOST PVLOFL RJTEMP
AVSTS NODENUM PVCALC PVLOPR (F) S1
BADPVFL (F) NODETYP PVCHAR PVLOTP (F) SECVAR
BADPVPR (F) NTWKNUM PVCLAMP PVP SENSRTYP
C1 OTDENBLE PVEUHI PVRAW SERIALNO
C2 OVERVAL (F) PVEULO PVRAWHI SFSTS
CJTACT PIUOTDCF PVEXEUHI PVRAWLO SLOTNUM
COMMAND PNTFORM PVEXEULO PVROCNFL SLWSRCID
CONTCUT (F) PNTMODTY PVEXHIFL PVROCNPR (F) STATE
DAMPING PNTNODTY PVEXLOFL PVROCNTP (F) STI_EU
DECONF PNTSTATE PVFORMAT PVROCPFL STISWVER
EUDESC PNTTYPE PVHHFL PVROCPPR (F) STITAG
HIGHAL (F) PRIMMOD (F) PVHHPR (F) PVROCPTP (F) TCRNGOPT
HIGHALPR (F) PTDESC PVHHTP (F) PVSOURCE (F) TF
INPTDIR PTEXECST PVHIFL PVSRCOPT (F) TIMEBASE
KEYWORD PTINAL PVHIPR (F) PVSTS UNIT
LASTPV PV PVHITP (F) PVTEMP URL
LOCUTOFF URV

2.2 Analog Output (AO)

The parameters of the Analog Output Data point are listed below in alphabetical order. (F)
indicates that the parameter is applicable when the PNTFORM = Full.
ASSOCDSP MODNUM OPFINAL OPOUT2 PNTTYPE
CASREQ (F) NAME OPIN0 OPOUT3 PRIMMOD (F)
EUDESC NMODATTR (F) OPIN1 OPOUT4 PTDESC
KEYWORD NMODE (F) OPIN2 OPOUT5 PTEXECST
LOCALMAN NODENUM OPIN3 OPTDIR RCASOPT
MODATTR (F) NODETYP OPIN4 PNTFORM REDTAG (F)
MODE (F) NTWKNUM OPIN5 PNTMODTY RINITREQ (F)
MODEAPPL (F) OP OPOUT0 PNTNODTY SLOTNUM
MODEPERM (F) OPCHAR OPOUT1 PNTSTATE STDBYMAN
UNIT

APM Parameter Reference Dictionary 2-1 10/96

 2.3

2.3 Array

The parameters of the Array Data Point are listed below in alphabetical order.
AB_DATA1 ERRCODE NN PNTNODTY STRDESC
AB_DATA2 EXTDATA NNDESC PNTTYPE STRLEN
AB_DATA3 FL NNUMERIC PRIMMOD (F) STRSTIX
AB_DATA4 FLDESC NNSTIX PTDESC STSMSG
ASSOCDSP FLSTIX NODENUM SCANPRI TIME
AUXDATA1 FTANUM NODETYP SLOTNUM TIMEDESC
AUXDATA2 INITREQ NSTRING SPLOCK TIMESECS
AUXDATA3 IOPNUM NTIME STR8 TIMESTIX
AUXDATA4 KEYWORD NTWKNUM STR16 UNIT
BADPVFL (F) NFLAG OVERLAP STR32 USERID
DEVADDR PNTFORM STR64
PNTFORM STR64

2.4 Box (APM Box)

The parameters of the Advanced Process Manager Box Data Point are listed below in
alphabetical order.
BADPVTXT IOLPERSW LSPPXORN NODESTS SAFOPCMD
CHPINOPR IOMCARD LSUCNORN NODETYP SCANRATE
CRUCNORN IOMCHAER MDMHWREV NODFSTAT SCANPER
CRIOLORN IOMCHASL MINUTE NPMSLOT SECOND
CRPPXORN IOMCHBER MONTH NPVSLOT SEQPRGSZ
CTLOPT IOMCHBSL MOVPVTXT NSTRING SEQPROC
CTLPATCH IOMCMD NARRSLOT NTIME STR8
CYCLETIM IOMCOMER NCTLSLOT NTIMER SUMSLTSZ
DATE IOMFILE NDCSLOT PKGOPT SWTCHACT
DAY IOMOPER NDEVSLOT PMMCHAER TIME
DB_VALID IOMRECHN NFASTCTL PMMCHASL TMCMD
EUNDESC IOMREALT NFASTDC PMMCHBER TMPV
FL IOMSEVER NFASTDEV PMMCHBSL TMSP
FTA1TYPE IOMSTS NFASTLOG PMMCMD TMRV
FTA2TYPE IOMTYPE NFASTPV PMMCOMER TMSO
HOUR IONTOKEN NFLAG PMMCTLST TMST
IOLASTS IOP NLOGSLOT PMMFLPOS TMTB
IOLBSTS IOPNUM NN PMMOPER UTSDRIFT
IOLCHAER IOPSTR1 NNUMERIC PMMRECCH UTSNODE
IOLCHASL IOPSTR2 NODEASSN PMMSEVER UTSTBCRV
IOLCHBER IORECCHN NODECMD PMMSFSTS UTSTIME
IOLCHBSL IOSTKNDR NODECONF PMMSTS UTSTIMST
IOLCHERT IOSSTS NODENUM POSITION WEEKDAY
IOLCMD IOTKNSTL NODEOPER RJTEMP YEAR
LSIOLORN

Some of the parameters in the above listing are arrays and are not defined in this
publication.

APM Parameter Reference Dictionary 2-2 10/96

 2.5

2.5 Box Flag

The parameters of the Box Flag Data Point are listed below in alphabetical order. (F)
indicates that the parameter is applicable when the PNTFORM = Full; an * indicates that
the parameter is applicable to flag slots 1-128.
$AUXUNIT (F)* EIPPCODE (F)* NODETYP PRIMMOD (F)* SLOTNUM
ALENBST (F)* EUDESC NTWKNUM PTDESC STATE0
ALPRIOR HIGHAL (F)* OFFNRMPR (F) PV STATE1
ASSOCDSP KEYWORD PNTNODTY PVFL STATETXT
BOXCLR NAME PNTFORM S0BOXCLR UNIT
CONTCUT (F)* NODENUM PNTTYPE S1BOXCLR

2.6 Box Numeric

The parameters of the Box Numeric Data Point are listed below in alphabetical order.
ASSOCDSP NODENUM PNTNODTY PRIMMOD (F) PVFORMAT
EUDESC NODETYP PNTFORM PTDESC SLOTNUM
KEYWORD NTWKNUM PNTTYPE PV UNIT
NAME

2.7 Box Timer

The parameters of the Box Timer Data Point are listed below in alphabetical order.
ASSOCDSP NODENUM PTDESC RV STATE
COMMAND NODETYP PERIOD SLOTNUM TIMEBASE
EUDESC NTWKNUM PRIMMOD (F) SO TIMOUTFL
KEYWORD PNTNODTY PV SP UNIT
NAME PNTTYPE

APM Parameter Reference Dictionary 2-3 10/96

 2.8

2.8 Device Control (DevCtl)

The parameters of the Device Control Data Point are listed below in alphabetical order. (F)
indicates that the parameter is applicable when the PNTFORM = Full.
$AUXUNIT (F) (#Inputs>0) MAINDAT OVRDALPR (F)
ACCELTIM MAINTOPT OVRDSIFL
ALENBST (F) MANMODFL P0 (#Outputs>0)
ASSOCDSP MASKTIM P1 (#Outputs>0)
BADPVFL (F) MAXTIM0H P2 (#Outputs>0)
BADPVPR (F) MAXTIM1H PAUSETIM
BADPVTXT (#Inputs>0) MAXTIM2H PERIOD
BADSVFL MAXTRAN0 PGALGID 1-4
BADSVPR (F) MAXTRAN1 PGDSTN 1-4
BOXCLR MAXTRAN2 PGPLSWTH 1-4
BYPASS MODATTR (#Outputs>0) PGSO 1-4
CMDDISFL MODE (#Outputs>0) PIALGID 1-12
CMDDISPR (F) MODEAPPL (#Outputs>0) PIDEADBD1-12
CMDFALFL MODEPERM (#Outputs>0) PINN 1-12
CMDFALTM MODNUM PISO 1-12
CONTCUT (#Inputs>0) MOMSTATE (#Outputs>0) PISRC 1-12
D1 (#Inputs=1) MOVPVFL (#Inputs>0) PNTFORM
D1_0 (#Inputs=1) MOVPVTXT PNTMODTY
D1_1 (#Inputs=2) NAME PNTNODTY
D2 (#Inputs=2) NI0 (#Outputs>0) PNTSTATE
D2D1_00 (#Inputs=2) NI1 (#Outputs>0) PNTTYPE
D2D1_01 (#Inputs=2) NI2 (#Outputs>0) PRIMMOD (F)
D2D1_10 (#Inputs=2) NMODATTR (#Outputs>0) PTDESC
D2D1_11 NMODE (#Outputs>0) PTEXECST
DB_VALID NN PTINAL
DEADBAND NNINSET 1-10 PULSEWTH (#Outputs>0)
DEADTIME (#Inputs>0) NODENUM PV (#Inputs>0)
DISRC 1 - 2 (#Outputs>0) NODETYP PVAUTO (#Inputs>0)
DODSTN NODINPTS PVFL (#Inputs>0)
EIPPCODE (F) NODOPTS PVNORMAL (F)
EUDESC (#Inputs>0) NOLINPTS PVNORMFL
EVTOPT (F) NOLOPTS PVSOURCE (F) (#Inputs>0)
FBTIME (F) NONECONF PVSRCOPT (F) (#Inputs>0)
FL 1-12 NONE_OP1-3 PVSTATES 0-4 (#Inputs>0)
HIGHAL (F) NOPGATE PVTXTOPT
HIGHALPR NOSGATE REDTAG (F) (#Outputs>0)
HISVPEAK (#Outputs>0) NOSIOVRD RESETFL
I0 NOSTATES S0BOXCLR
I0CONF (#Outputs>0) NOTRANS0 S1BOXCLR
I1 NOTRANS1 S2BOXCLR
I1CONF (#Outputs>0) NOTRANS2 SEALOPT
I2 NSI0 (#Outputs>0) SECVAR
I2CONF NTWKNUM SGALGID 1-2
INITMAN OFFNRMFL SGDSTN 1-2
INITREQ OFFNRMPR (F) SGPLSWTH 1-2
KEYWORD OP (#Outputs>0) SGSO 1-2
L OPCMD (#Outputs>0) SI0
LIBADOPT OPFINAL (#Outputs>0) SI0ALOPT
LIDESC OPRATRFL (#Outputs>0) SI0ALPR (F)
LISRC 1-12 OROPT (#Outputs>0) SI0CONF
LMREV OVRCTIM SIALGID 1-12
LMSRC (#Outputs>0) OVRDCONF SIDLYTIM 1-12
LOCALMAN OVRDDESC SIDSTN 1-12
LODSTN 1-2 OVRDI0FL SISO 1-12
LOENBL 1-2 OVRD1FL SLOTNUM
LOGICSRC OVRD2FL SO 0-2
LOSRC 1-2 OVRDALOP SOCMD

APM Parameter Reference Dictionary 2-4 10/96

 2.8

2.8 Device Control (DevCtl) con’t

Continuation of the Device Control parameters are listed below in alphabetical order. (F)
indicates that the parameter is applicable when the PNTFORM = Full.
ST0_OP1 (#Outputs>0) STSMSG SVSRC
ST0_OP2 (#Outputs>=2) SVALDB SVTV
ST0_OP3 (#Outputs>=3) SVALDBEU SVTVP
ST1_OP1 (#Outputs>0) SVDESC TRANTIM0
ST1_OP2 (#Outputs>=2) SVEUDESC TRANTIM1
ST1_OP3 (#Outputs>=3) SVEUHI TRANTIM2
ST2_OP1 (#Outputs>0) SVEULO UNCMDFL
ST2_OP2 (#Outputs>=2) SVHHFL UNIT
ST2_OP3 (#Outputs>=3) SVHHPR (F) USERID
STATE0 SVHHTP
STATE1 SVHHTPP
STATE2 SVHIFL
STATTIM0 SVHIPR (F)
STATTIM1 SVHITP
STATTIM2 SVHITPP
STATETXT0-4 SVP
STCHGOPT SVPEAK

APM Parameter Reference Dictionary 2-5 10/96

 2.9

2.9 Digital Composite (DigComp)

The parameters of the Digital Composite Data Point are listed below in alphabetical order.
(F) indicates that the parameter is applicable when the PNTFORM = Full.
$AUXUNIT (F) (#Inputs>0) MAXTRAN2 PNTNODTY
ALENBST (F) MODATTR (#Outputs>0) PNTSTATE
ALPRIOR MODE (#Outputs>0) PNTTYPE
ASSOCDSP MODEAPPL (#Outputs>0) SI0
BADCTLPR MODEPERM (#Outputs>0) PRIMMOD (F)
BADPVFL (F) (#Inputs>0) MODNUM PTDESC
BADPVPR (F) MOMSTATE (#Outputs>0) PTEXECST
BADPVTXT MOVPVFL (#Inputs>0) PTINAL
BOXCLR MOVPVTXT PULSEWDTH (#Outputs>0)
BYPASS NAME PV (#Inputs>0)
CMDDISFL NI0 (#Outputs>0) PVAUTO (#Inputs>0)
CMDDISPR (F) NI1 (#Outputs>0) PVFL 0-2 (#Inputs>0)
CMDFALFL NI2 (#Outputs>0) PVNORMAL (F)
CMDFALTM NMODATTR (#Outputs>0) PVSOURCE (F) (#Inputs>0)
CONTCUT (F) NMODE (#Outputs>0) PVSRCOPT (F) (#Inputs>0)
D1 (#Inputs>0) NODENUM PVSTATES 0-4 (#Inputs>0)
D1_0 (#Inputs=1) NODETYP PVTXTOPT
D1_1 (#Inputs=1) NODINPTS REDTAG (F) (#Outputs>0)
D2 (#Inputs=2) NODOPTS RESETFL
D2D1_00 (#Inputs=2) NONECONF S0BOXCLR
D2D1_01 (#Inputs=2) NONE_OP1-3 S1BOXCLR
D2D1_10 (#Inputs=2) NOSIOVRD S2BOXCLR
D2D1_11 (#Inputs=2) NOSTATES SEALOPT
DISRC 1-2 (#Inputs>0) NOTRANS1 SI0ALOPT
DODSTN 1-3 (#Outputs>0) NOTRANS0 SI0ALPR (F)
EIPPCODE (F) NOTRANS2 SI0CONF
EUDESC NSI0 (#Outputs>0) SLOTNUM
EVTOPT (F) (#Inputs>0) NTWKNUM SO (#Outputs>0)
FBTIME (F) OFFNRMFL SOCMD (#Outputs>0)
HIGHAL (F) OFFNRMPR (F) ST0_OP1 (#Outputs>0)
HIGHALPR OP (#Outputs>0) ST0_OP2 (#Outputs>=2)
I0 (#Outputs>0) OPCMD (#Outputs>0) ST0_OP3 (#Outputs>=3)
I0CONF OPFINAL (#Outputs>0) ST1_OP1 (#Outputs>0)
I0DESC OPRATRFL (#Outputs>0) ST2_OP1 (#Outputs>0)
I1 (#Outputs>0) OVRDALOP ST1_OP2 (#Outputs>=2)
I1CONF OPSTTEXT ST2_OP2 (#Outputs>=2)
I1DESC (#Outputs>0) OVRDALPR (F) ST1_OP3 (#Outputs>=3)
I2 OROPT (#Outputs>0) ST2_OP3 (#Outputs>=3)
I2CONF OVRDCONF STATE0
I2DESC OVRDDESC STATE1
INITMAN OVRDI0FL STATE2
INITREQ OVRDI1FL STATETXT 0-4
KEYWORD OVRDI2FL STATTIM0
LOCALMAN (#Outputs>0) OVRDSIFL STATTIM1
LOGICSRC P0 (#Outputs>0) STATTIM2
MAINDAT P1 (#Outputs>0) STCHGOPT
MAINTOPT P2 (#Outputs>0) STSMSG
MAXTIM0H PAUSETIM TRANTIM1
MAXTIM1H PERIOD TRANTIM2
MAXTIM2H PNTFORM UNCMDFL
MAXTRAN0 PNTMODTY UNIT
MAXTRAN1 USERID

APM Parameter Reference Dictionary 2-6 10/96

 2.10

2.10 Digital Input (DigIn)

The parameters of the Digital Input Data point are listed below in alphabetical order. (L),
(S), or (A)—parameter applies only when DITYPE = Latched, Status, or Accum. (F)
indicates that the parameter is applicable when the PNTFORM = Full.
$AUXUNIT (S) (F) DLYTIME (S) (F) OVERVAL (A) (F) PVRAW
ALENBST (S) (F) EIPPCODE (S) (L) (F) PNTFORM PVSOURCE (L) (F)
ALMOPT (S) (F) EUDESC PNTNODTY PVSRCOPT (S) (L) (F)
ALPRIOR EVTOPT (L) (F) PNTMODTY RESETFL (A)
ASSOCDSP HIGHAL (S) PNTSTATE RESETVAL (A)
AV (A) INPTDIR (F) PNTTYPE S0BOXCLR (S) (L)
AVTV (A) KEYWORD PRIMMOD (F) S1BOXCLR (S) (L)
AVTVFL (A) MODNUM PTDESC SLOTNUM
BADPVFL (F) NAME PTEXECST STARTFL (A)
BADPVPR NODENUM PV (S) (L) STATE (A)
BOXCLR (L) NODETYP PVAUTO (S) (L) STATE0 (S) (L)
COMMAND (A) NTWKNUM PVCHGDLY (S) (L) (F) STATE1 (S) (L)
CONTCUT (S) (F) OFFNRMFL (S) PVFL (S) (L) STATETXT 0-2 (S) (L)
COUNTDWN (A) OFFNRMPR (S) (F) PVNORMAL (S) (F) STOPFL (A)
DEBOUNCE (S) (L) OLDAV (A) PVNORMFL (S) UNIT
DITYPE (F) OVERFLOW (A)

2.11 Digital Output (DigOut)

The parameters of the Digital Output Data point are listed below in alphabetical order. (S)
or (P) parameter applies only when DOTYPE = Status or Pulse Width Modulated
(PWM). This point type is available only in the component form.
ASSOCDSP NODENUM PERIOD (P) PRIMMOD (F) SO (S)
DOTYPE NODETYP PNTFORM PTDESC STATE0 (S)
EUDESC NTWKNUM PNTMODTY PTEXECST STATE1 (S)
INITREQ OFFPULSE (S) PNTNODTY S0BOXCLR (S) STDBYMAN
KEYWORD ONPULSE (S) PNTSTATE S1BOXCLR (S) UNIT
MODNUM OP (P) PNTTYPE SLOTNUM
NAME OPTDIR (P)

2.12 IOP

The parameters of the Input/Output Processor Point are listed below in alphabetical order.
CALIBALL IOMACTYP IOMTYPE IORECCHN RJRAW
CALIBRJ IOMFWREV IOMSTS LINEPERD SLOT0SF
FAILOPT IOMHWREV IONTOKEN MAXSLOTS STDBYSTS
FTAPRES IOMLHFST IOPSTR1 NODETYP SWTCHACT
FREQ6050 IOMOPER IOPSTR2 PIUOTDCF WARMSTRT

Some of the parameters in the above listing are arrays and are not defined in this
publication.

APM Parameter Reference Dictionary 2-7 10/96

 2.13

2.13 Logic

The parameters of the Logic Data Point are listed below in alphabetical order. (F) indicates
that the parameter is applicable when the
PNTFORM = Full.
$AUXUNIT (F) C1SRC LISRC 1-12 NOLOPTS R2 1-24
ALENBST (F) C2SRC LODSTN 1-12 NTWKNUM S1 1-24
ASSOCDSP C3SRC LOENBL 1-12 PERIOD S1REV 1-24
C1DESC C4SRC LOGALGID 1-24 PNTFORM S2 1-24
C2DESC CONTCUT LOGMIX PNTMODTY S2REV 1-24
C3DESC DEADBAND 1-24 LOSRC 1-12 PNTNODTY S3 1-24
C4DESC DLYTIME 1-24 MODNUM PNTSTATE S3REV 1-24
C1FL EIPPCODE (F) NAME PNTTYPE S4 1-24
C2FL FL1-12 NN1-8 PRIMMOD (F) SLOTNUM
C3FL GENDESC 1-12 (F) NODENUM PRMDESC 1-12 SO 1-24
(F)
C4FL HIGHAL NODESC (F) PTDESC STSMSG
C1PR (F) HIGHALPR NODETYP PTEXECST UNIT
C2PR (F) L1-12 NOLINPTS PTINAL USERID
C3PR (F) LIBADOPT NOLOGBLK R1 1-24
C4PR (F)

2.14 Process Module (ProcMod)

The parameters of the Process Module Data Point are listed below in alphabetical order. (F)
indicates that the parameter is applicable when the PNTFORM = Full.
ABHEMSD MSGPEND PHREMTIM SEQNAME STR16 1-8
ABHHOLD NAME (F) PNTFORM SEQOBJSZ STR32 1-4
ABHRSTR NN 1-80 PNTNODTY SEQPR (F) STR64 1-2
ABHSHDN NODENUM PNTTYPE SEQSLTSZ STRLEN
ACP (F) NODETYP PRIMMOD (F) SLOTNUM STSMSG
ALPRIOR (F) NTWKNUM PROCMOD SNAME 1-2 SUSPSTAT
ANAME 1-3 OVERPHAS PTDESC SPLOCK SUSPTIME
ASSOCDSP OVERSTAT RESTART SSTEP 1-2 TIME 1-4
ASTEP 1-3 OVERSTEP RSTROPT SSTMT 1-2 UNIT
ASTMT 1-3 PERIOD RUNSTATE STATMENT USERID
CNTLLOCK PHASE SEQERR STEP
FL 1-27 PHASEAL SEQEXEC STR8 1-16
PHASETIM SEQMODE

APM Parameter Reference Dictionary 2-8 10/96

 2.15

2.15 UCN Network

Listed below in alphabetical order are the parameters of the UCN Data Point (system
parameter $NTWRKnn where nn = the UCN number).
CHPINHWY HWYCTLST NIMADDR NIMREV NMSGTXT
CLPZMXC LOADSCOP NIMDAY NIMVERS TIMESYNC
CLPZMXP MSGTXT 0-15 NIMMONTH NIMYEAR UPGRADE

2.16 UCN Node Data Point

The parameters of the NIM Data Point ($NMuuNnn) are listed below in alphabetical order.
uu is the UCN network number, and nn is the UCN node number.
$UCNLSB 1-50 LOADSCOP NODESTS UTSDRIFT
CABLESTS MDMHWREV NODETYP UTSNODE
CLPZMXC MODNUM TIMESYNC UTSTBCRV
CLPZMXP NMSGTXT UCNRECHN UTSTIME
NODESTAT UPGRADE UTSTIMST

APM Parameter Reference Dictionary 2-9 10/96

APM Parameter Reference Dictionary 2-10 10/96
 3

PARAMETERS PER ALGORITHM TYPE

Section 3

This section contains listings of parameters that are applicable to each PV and control
algorithm in the APM. Refer to Sections $ - X for the definitions of the parameters.

3.1 Auto Manual (AutoMan)

The parameters of the Auto Manual control algorithm are listed below in alphabetical order.
(F) indicates that the parameter is applicable when the PNTFORM = Full.
$AUXUNIT (F) CVEUHI MODNUM OPLOLM RATE1
ALENBST (F) CVEULO NAME OPLOPR (F) RCASOPT
ARWNET ESWAUTO NMODATTR OPLOTP (F) RCASSHED
ARWOP ESWCAS NMODE OPMCHLM REDTAG (F)
ASSOCDSP ESWENBST NOCINPTS OPRATRFL RINITREQ
AUTMODFL ESWMAN NOCOPTS OPROCLM RINITVAL
B EUDESC NODENUM OVERVAL (F) SAFEOP
B0 EXTSWOPT NODETYP PERIOD SHEDMODE
BADCTLFL HIGHAL (F) NTWKNUM PNTFORM SHEDTIME
BADCTLOP HIGHALPR (F) OP PNTMODTY SHUTDOWN
BADCTLPR (F) INITMAN OPALDB (F) PNTNODTY SLOTNUM
CASREQ K OPEU PNTSTATE STDBYMAN
CIDSTN KEYWORD OPHAFL (F) PNTTYPE STSMSG
CISRC LOCALMAN OPHIFL PRIMMOD (F) UNIT
CODSTN MANMODFL OPHILM PTDESC USERID
CONTCUT (F) MODATTR OPHIPR (F) PTEXECST X1
CTLALGID MODE OPHITP (F) PTINAL X2
CTLEQN MODEAPPL OPLAFL (F) PTORST XEUHI
CTRLINIT MODEPERM OPLOFL RARWSTS XEULO
CV

3.2 Calculator (Calcultr)

The parameters of the Calculator PV algorithm are listed below in alphabetical order. (F)
indicates that the parameter is applicable when the PNTFORM = Full.
$AUXUNIT (F) NODENUM PIDSTN PVEUHI PVLOTP (F)
ALENBST (F) NODETYP PISRC PVEULO PVP
ASSOCDSP NOPINPTS PNTFORM PVEXEUHI PVROCNFL
BADPVFL (F) NTWKNUM PNTMODTY PVEXEULO PVROCNPR (F)
BADPVPR (F) OVERVAL (F) PNTNODTY PVEXHIFL PVROCNTP (F)
C1 P1 PNTSTATE PVEXLOFL PVROCPFL
C2 P1STS PNTTYPE PVFORMAT PVROCPPR (F)
C3 P2 PRIMMOD (F) PVHHFL PVROCPTP (F)
C4 P2STS PTDESC PVHHPR (F) PVSGCHTP (F)
CALCEXP P3 PTEXECST PVHHTP (F) PVSOURCE (F)
CONTCUT (F) P3STS PTINAL PVHIFL PVSRCOPT (F)
EUDESC P4 PV PVHIPR (F) PVSTS
HIGHAL (F) P4STS PVALDB (F) PVHITP (F) PVTV (F)
HIGHALPR (F) P5 PVALDBEU (F) PVINIT PVTVP (F)
KEYWORD P5STS PVALGID PVLLFL SLOTNUM
LASTPV P6 PVAUTO PVLLPR (F) STSMSG
MODNUM P6STS PVAUTOST PVLLTP (F) TF
N PERIOD PVCALC PVLOFL UNIT
NAME PVCLAMP PVLOPR (F) USERID

APM Parameter Reference Dictionary 3-1 10/96

 3.3

3.3 Data Acquisition (DataAcq)

The parameters of the Data Acquisition PV algorithm are listed below in alphabetical order.
(F) indicates that the parameter is applicable when the PNTFORM = Full.
$AUXUNIT (F) NTWKNUM PV PVHHFL PVROCNPR (F)
ALENBST (F) OVERVAL (F) PVALDB (F) PVHHPR (F) PVROCNTP (F)
ASSOCDSP P1 PVALDBEU (F) PVHHTP (F) PVROCPVFL
BADPVFL (F) P1STS PVALGID PVHIFL PVROCPPR (F)
BADPVPR (F) PERIOD PVAUTO PVHIPR (F) PVROVPTP (F)
CONCUT (F) PIDSTN PVAUTOST PVHITP (F) PVSGCHTP (F)
EUDESC PISRC PVCALC PVINIT PVSOURCE (F)
HIGHAL (F) PNTFORM PVCLAMP PVLLFL PVSRCOPT (F)
HIGHALPR (F) PNTMODTY PVEUHI PVLLPR (F) PVSTS
KEYWORD PNTNODTY PVEULO PVLLTP (F) PVTV (F)
LASTPV PNTSTATE PVEXEUHI PVLOFL PVTVP (F)
MODNUM PNTTYPE PVEXEULO PVLOPR (F) SLOTNUM
NAME PRIMMOD (F) PVEXHIFL PVLOTP (F) STSMSG
NODENUM PTDESC PVEXLOFL PVP TF
NODETYP PTEXECST PVFORMAT PVROCNFL UNIT
NOPINPTS PTINAL USERID

3.4 Flow Compensation (FlowComp)

The parameters of the Flow Compensation PV algorithm are listed below in alphabetical
order. (F) indicates that the parameter is applicable when the PNTFORM = Full.
$AUXUNIT (F) MODNUM PTEXECST PVHHTP (F) PVSRCOPT (F)
ALENBST (F) NAME PTINAL PVHIFL PVSTS
ASSOCDSP NODENUM PV PVHIPR (F) PVTV (F)
BADPVFL (F) NODETYP PVALDB (F) PVHITP PVTVP (F)
BADPVPR (F) NOPINPTS PVALDBEU (F) PVINIT Q
C NTWKNUM PVALGID PVLLFL QSTS
C1 OVERVAL (F) PVAUTO PVLLPR (F) RG
C2 P PVAUTOST PVLLTP (F) RP
COMPHILM PERIOD PVCALC PVOFL RQ
COMPLOLM P0 PVCHAR PVLOPR (F) RT
COMPTERM PIDSTN PVCLAMP PVLOTP (F) RX
CONTCUT (F) PISRC PVEQN PVP SLOTNUM
EUDESC PNTFORM PVEUHI PVROCNFL STSMSG
F PNTMODTY PVEULO PVROCNPR (F) T
FSTS PNTNODTY PVEXEUHI PVROCNTP (F) T0
G PNTSTATE PVEXEULO PVROCPFL TF
GSTS PNTTYPE PVEXHIFL PVROCPPR (F) TSTS
HIGHAL (F) PRIMMOD (F) PVEXLOFL PVROCPTP (F) UNIT
HIGHALPR (F) PSTS PVFORMAT PVSGCHTP (F) USERID
KEYWORD PTDESC PVHHFL PVSOURCE (F) X
LASTPV PVHHPR (F) XSTS

APM Parameter Reference Dictionary 3-2 10/96

 3.5

3.5 General Linearization (GenLin)

The parameters of the General Linearization PV algorithm are listed below in alphabetical
order. (F) indicates that the parameter is applicable when the PNTFORM = Full.
$AUXUNIT (F) IN12 OUT12 PVAUTOST PVLOPR (F)
ALENBST (F) KEYWORD OVERVAL (F) PVCALC PVLOTP (F)
ASSOCDSP LASTPV P1 PVCLAMP PVP
BADPVFL (F) MODNUM P1STS PVEUHI PVROCNFL
BADVPR (F) NAME PERIOD PVEULO PVROCNPR (F)
CONTCUT (F) NODENUM PIDSTN PVEXEUHI PVROCNTP (F)
EUDESC NODETYP PISRC PVEXEULO PVROCPFL
HIGHAL (F) NOPINPTS PNTFORM PVEXHIFL PVROCPPR (F)
HIGHALPR (F) NTWKNUM PNTMODTY PVEXLOFL PVROCPTP (F)
IN0 OUT0 PNTNODTY PVFORMAT PVSGCHTP (F)
IN1 OUT1 PNTSTATE PVHHFL PVSOURCE (F)
IN2 OUT2 PNTTYPE PVHHPR (F) PVSRCOPT (F)
IN3 OUT3 PRIMMOD (F) PVHHTP (F) PVSTS
IN4 OUT4 PTDESC PVHIFL PVTV (F)
IN5 OUT5 PTEXECST PVHIPR (F) PVTVP (F)
IN6 OUT6 PTINAL PVHITP (F) SEGTOT
IN7 OUT7 PV PVINIT SLOTNUM
IN8 OUT8 PVAUTO PVLLFL STSMSG
IN9 OUT9 PVALDB (F) PVLLPR (F) TF
IN10 OUT10 PVALDBEU (F) PVLLTP (F) UNIT
IN11 OUT11 PVALGID PVLOFL USERID

3.6 High-Low Average (HiLoAvg)

The parameters of the High-Low Average PV algorithm are listed below in alphabetical
order. (F) indicates that the parameter is applicable when the PNTFORM = Full.
$AUXUNIT (F) NODETYP PNTFORM PVEULO PVP
ALENBST (F) NOPINPTS PNTMODTY PVEXEUHI PVROCNFL
ASSOCDSP NTWKNUM PNTNODTY PVEXEULO PVROCNPR (F)
BADPVFL (F) OVERVAL (F) PNTSTATE PVEXHIFL PVROCNTP (F)
BADPVPR (F) P1 PNTTYPE PVEXLOFL PVROCPFL
CONTCUT (F) P1STS PRIMMOD (F) PVFORMAT PVROCPPR (F)
EUDESC P2 PTDESC PVHHFL PVROCPTP (F)
FORCE P2STS PTEXECST PVHHPR (F) PVSGCHTP (F)
FRCPERM P3 PTINAL PVHHTP (F) PVSOURCE (F)
FSELIN P3STS PV PVHIFL PVSRCOPT (F)
HIGHAL (F) P4 PVALDB (F) PVHIPR (F) PVSTS
HIGHALPR (F) P4STS PVALDBEU (F) PVHITP (F) PVTV (F)
KEYWORD P5 PVALGID PVINIT PVTVP (F)
LASTPV P5STS PVAUTO PVLLFL SELINP
MODNUM P6 PVAUTOST PVLLPR (F) SLOTNUM
N P6STS PVCALC PVLLTP (F) STSMSG
NAME PERIOD PVCLAMP PVLOFL TF
NMIN PIDSTN PVEQN PVLOPR (F) UNIT
NODENUM PISRC PVEUHI PVLOTP (F) USERID

APM Parameter Reference Dictionary 3-3 10/96

 3.7

3.7 Incremental Summer (IncrSum)

The parameters of the Incremental Summer control algorithm are listed below in
alphabetical order. (F) indicates that the parameter is applicable when the PNTFORM =
Full.
$AUXUNIT (F) ESWCAS MODNUM OPLOLM RCASOPT
ALENBST (F) ESWENBST NAME OPLOPR (F) RCASSHED
ARWNET ESWMAN NMODATTR OPLOTP (F) REDTAG (F)
ARWOP EUDESC NMODE OPMCHLM RINITREQ
ASSOCDSP EXTSWOPT NOCINPTS OPRATRFL RINITVAL
AUTMODFL HIGHAL (F) NOCOPTS OPROCLM SAFEOP
BADCTLFL HIGHALPR (F) NODENUM OVERVAL (F) SHEDMODE
BADCTLPR (F) INITMAN NODETYP PERIOD SHEDTIME
CASREQ K1 NTWKNUM PNTFORM SHUTDOWN
CIDSTN K2 OP PNTMODTY SLOTNUM
CISRC K3 OPALDB (F) PNTNODTY STDBYMAN
CODSTN K4 OPEU PNTSTATE STSMSG
CONTCUT (F) KEYWORD OPHAFL (F) PNTTYPE UNIT
CTLALGID LOCALMAN OPHIFL PRIMMOD (F) USERID
CTRLINIT M OPHILM PTDESC X1
CV MANMODFL OPHIPR (F) PTEXECST X2
CVEUHI MODATTR OPHITP (F) PTINAL X3
CVEULO MODE OPLAFL (F) PTORST X4
DELCV MODEAPPL OPLOFL RARWSTS XEUHI
ESWAUTO MODEPERM XEULO

3.8 Middle-of-3 (MidOf3)

The parameters of the Middle-Of-3 PV algorithm are listed below in alphabetical order.
(F) indicates that the parameter is applicable when the PNTFORM = Full.
$AUXUNIT (F) OVERVAL (F) PTEXECST PVFORMAT PVROCNPR (F)
ALENBST (F) P1 PTINAL PVHHFL PVROCNTP (F)
ASSOCDSP P1STS PV PVHHPR (F) PVROCPFL
BADPVFL (F) P2 PVALDB (F) PVHHTP (F) PVROCPPR (F)
BADPVPR (F) P2STS PVALDBEU (F) PVHIFL PVROCPTP (F)
CONTCUT (F) P3 PVALGID PVHIPR (F) PVSGCHTP (F)
EUDESC P3STS PVAUTO PVHITP (F) PVSOURCE (F)
HIGHAL (F) PERIOD PVAUTOST PVINIT PVSRCOPT (F)
HIGHALPR (F) PIDSTN PVCALC PVLLFL PVSTS
KEYWORD PISRC PVCLAMP PVLLPR (F) PVTV (F)
LASTPV PNTFORM PVEQN PVLLTP (F) PVTVP (F)
MODNUM PNTMODTY PVEUHI PVLOFL SELINP
NAME PNTNODTY PVEULO PVLOPR (F) SLOTNUM
NODENUM PNTSTATE PVEXEUHI PVLOTP (F) STSMSG
NODETYP PNTTYPE PVEXEULO PVP TF
NOPINPTS PRIMMOD (F) PVEXHIFL PVROCNFL UNIT
NTWKNUM PTDESC PVEXLOFL USERID

APM Parameter Reference Dictionary 3-4 10/96

 3.9

3.9 Override Selector (ORSel)

The parameters of the Override Selector control algorithm are listed below in alphabetical
order. (F) indicates that the parameter is applicable when the PNTFORM = Full.
$AUXUNIT (F) CTRLINIT MODNUM OPLOPR (F) RCASOPT
ALENBST (F) CV NAME OPLOTP (F) RCASSHED
ARWNET CVEUHI NMODATTR OPMCHLM REDTAG (F)
ARWOP CVEULO NMODE OPRATRFL RINITREQ
ASSOCDSP ESWAUTO NOCINPTS OPROCLM RINITVAL
AUTMODFL ESWCAS NOCOPTS OROFFSET SAFEOP
BADCTLFL ESWENBST NODENUM OROPT SELXINP
BADCTLOP ESWMAN NODETYP OVERVAL (F) SHEDMODE
BADCTLPR (F) EUDESC NTWKNUM PERIOD SHEDTIME
BYPASS EXTSWOPT OP PNTFORM SHUTDOWN
BYPASSX1 HIGHAL (F) OPALDB (F) PNTMODTY SLOTNUM
BYPASSX2 HIGHALPR (F) OPEU PNTNODTY STDBYMAN
BYPASSX3 INITMAN OPHAFL (F) PNTSTATE STSMSG
BYPASSX4 KEYWORD OPHIFL PNTTYPE UNIT
CASREQ LOCALMAN OPHILM PRIMMOD (F) USERID
CIDSTN M OPHIPR (F) PTDESC X1
CISRC MANMODFL OPHITP (F) PTEXECST X2
CODSTN MODE OPLAFL (F) PTINAL X3
CONTCUT (F) MODEAPPL OPLOFL PTORST X4
CTALGID MODATTR OPLOLM RARWSTS XEUHI
CTLEQN MODEPERM XEULO

APM Parameter Reference Dictionary 3-5 10/96

 3.10

3.10 Pid

The parameters of the Pid control algorithm are listed below in alphabetical order. (F)
indicates that the parameter is applicable when the PNTFORM = Full.
$AUXUNIT (F) DEVHITP (F) NLGAIN PTEXECST RARWSTS
ADVDEVFL DEVLOFL NMODATTR PTINAL RATIO
ADVDEVPR (F) DEVLOPR (F) NMODE PTORST RBOPT
ADVDEVTP (F) DEVLOTP (F) NOCINPTS PV RCASOPT
ADVSP (F) ESWAUTO NOCOPTS PVALDB (F) RCASSHED
ADVSPP (F) ESWCAS NODENUM PVALDBEU (F) REDTAG (F)
ALENBST (F) ESWENBST NODETYP PVAUTO RINITREQ
ARWNET ESWMAN NTWKNUM PVAUTOST RINITVAL
ARWOP EUDESC OP PVEUHI RTHILM
ASPPROC (F) EXTSWOPT OPCMD PVEULO RTLOLM
ASSOCDSP GAINOPT OPALDB (F) PVFORMAT SAFEOP
AUTMODFL GAPHI OPEU PVHHFL SAFOPCMD
BADCTLFL GAPLO OPHAFL (F) PVHHPR (F) SHEDMODE
BADCTLOP HIGHAL (F) OPHIFL PVHHTP (F) SHEDTIME
BADCTLPR (F) HIGHALPR (F) OPHILM PVHIFL SHUTDOWN
BADPVFL (F) INITMAN OPHIPR (F) PVHIPR (F) SLOTNUM
BADPVPR (F) K OPHISRC PVHITPID SP
BIAS KEXT OPHITP (F) PVLLFL SPEUHI
BSHILM KEYWORD OPLAFL (F) PVLLPR (F) SPEULO
BSLOLM KGAP OPLOFL PVLLTP (F) SPFORMAT
CASREQ KLIN OPLOLM PVLOFL SPHIFL
CIDSTN KNL OPLOPR (F) PVLOTP (F) SPHILM
CISRC LASTPV OPLOSRC PVLOPR (F) SPLOFL
CODSTN LMSRC OPLOTP (F) PVP SPLOLM
CONTCUT (F) LOCALMAN OPMCHLM PVROCNFL SPOPT
CTLACTN MANMODFL OPRATRFL PVROCNPR (F) SPP
CTLALGID MANOPCMD OPROCLM PVROCNTP (F) SPTV
CTLEQN MANOPTIME OVERVAL (F) PVROCPFL SPTVP
CTRLINIT MAXPULSE PERIOD PVROCPPR (F) STDBYMAN
CV MODATTR PIDFORM PVROCPTP (F) STSMSG
CVEUHI MODE PNTFORM PVSGCHTP (F) T1
CVEULO MODEAPPL PNTMODTY PVSOURCE (F) T2
DELCV MODEPERM PNTNODTY PVSRCOPT (F) TVPROC
DEV MODNUM PNTSTATE PVSTS UNIT
DEVHIFL NAME PNTTYPE PVTRACK USERID
DEVHIPR (F) NLFM PTDESC RAMPTIME

APM Parameter Reference Dictionary 3-6 10/96

 3.11

3.11 Pid with External Reset Feedback (PidErfb)

The parameters of the Pid with External Reset Feedback control algorithm are listed below
in alphabetical order. (F) indicates that the parameter is applicable when the PNTFORM =
Full.
$AUXUNIT (F) DEVHIPR (F) NMODATTR PV RBOPT
ADVDEVFL DEVHITP (F) NMODE PVALDB (F) RCASOPT
ADVDEVPR (F) DEVLOFL NOCINPTS PVALDBEU (F) RCASSHED
ADVDEVTP (F) DEVLOPR (F) NOCOPTS PVAUTO REDTAG (F)
ADVSP (F) DEVLOTP (F) NODENUM PVAUTOST RFB
ADVSPP (F) ESWAUTO NODETYP PVEUHI RINITREQ
ALENBST (F) ESWCAS NTWKNUM PVEULO RINITVAL
ARWNET ESWENBST OP PVFORMAT RTHILM
ARWOP ESWMAN OPALDB (F) PVHHFL RTLOLM
ASPPROC (F) EUDESC OPEU PVHHTP (F) S1
ASSOCDSP EXTSWOPT OPHAFL (F) PVHHPR (F) SAFEOP
AUTMODFL GAINOPT OPHIFL PVHIFL SHEDMODE
BADCTFL GAPHI OPHILM PVHIPR (F) SHEDTIME
BADCTLOP GAPLO OPHIPR (F) PVHITP (F) SHUTDOWN
BADCTLPR (F) HIGHAL (F) OPHITP (F) PVLLFL SLOTNUM
BADPVFL (F) HIGHALPR (F) OPLAFL (F) PVLLPR (F) SP
BADPVPR (F) INITMAN OPLOFL PVLLTP (F) SPEUHI
BIAS K OPLOLM PVLOFL SPEULO
BSHILM K1 OPLOPR (F) PVLOTP (F) SPFORMAT
BSLOLM KEXT OPLOTP (F) PVLOPR (F) SPHIFL
CASREQ KEYWORD OPMCHLM PVP SPHILM
CIDSTN KGAP OPRATRFL PVROCNFL SPLOFL
CISRC KLIN OPROCLM PVROCNPR (F) SPLOLM
CODSTN KNL OVERVAL (F) PVROCNTP (F) SPOPT
CONTCUT (F) LASTPV PERIOD PVROCPFL SPP
CTLACTN LOCALMAN PIDFORM PVROCPPR (F) SPTV
CTLALGID MANMODFL PNTFORM PVROCPTP (F) SPTVP
CTLEQN MODATTR PNTMODTY PVSGCHTP (F) STSMSG
CTRLINIT MODE PNTNODTY PVSOURCE (F) STDBYMAN
CV MODEAPPL PNTSTATE PVSRCOPT (F) T1
CVEUHI MODEPERM PNTTYPE PVSTS T2
CVEULO MODNUM PTDESC PVTRACK TRFB
DELCV NAME PTEXECST RAMPTIME TVPROC
DEV NLFM PTINAL RARWSTS UNIT
DEVHIFL NLGAIN PTORST RATIO USERID

APM Parameter Reference Dictionary 3-7 10/96

 3.12

3.12 Pid with Feed Forward (PidFf)

The parameters of the Pid with Feed Forward control algorithm are listed below in
alphabetical order. (F) indicates that the parameter is applicable when the PNTFORM =
Full.
$AUXUNIT (F) DEVHIPR (F) NLGAIN PTORST RARWSTS
ADVDEVFL DEVHITP (F) NMODATTR PV RATIO
ADVDEVPR (F) DEVLOFL NMODE PVALDB (F) RBOPT
ADVDEVTP DEVLOPR (F) NOCINPTS PVALDBEU (F) RCASOPT
ADVSP (F) DEVLOTP (F) NOCOPTS PVAUTO RCASSHED
ADVSPP (F) ESWAUTO NODENUM PVAUTOST REDTAG (F)
ALENBST (F) ESWCAS NODETYP PVEUHI RINITREQ
ARWNET ESWENBST NTWKNUM PVEULO RINITVAL
ARWOP ESWMAN OP PVFORMAT RTHILM
ASPPROC (F) EUDESC OPALDB (F) PVHHFL RTLOLM
ASSOCDSP EXTSWOPT OPEU PVHHPR (F) SAFEOP
AUTMODFL FF OPHAFL (F) PVHHTP (F) SHEDMODE
BADCTLFL FFOPT OPHIFL PVHIFL SHEDTIME
BADCTLOP GAINOPT OPHILM PVHIPR (F) SHUTDOWN
BADCTLPR (F) GAPHI OPHIPR (F) PVHITP (F) SLOTNUM
BADPVFL (F) GAPLO OPHITP (F) PVLLFL SP
BADPVPR (F) HIGHAL (F) OPLAFL (F) PVLLPR (F) SPEUHI
BFF HIGHALPR (F) OPLOFL PVLLTP (F) SPEULO
BIAS INITMAN OPLOLM PVLOFL SPFORMAT
BSHILM K OPLOPR (F) PVLOTP (F) SPHIFL
BSLOLM KEXT OPLOTP (F) PVLOPR (F) SPHILM
CASREQ KEYWORD OPMCHLM PVP SPLOFL
CIDSTN KFF OPRATRFL PVROCNFL SPLOLM
CISRC KGAP OPROCLM PVROCNPR (F) SPOPT
CODSTN KLIN OVERVAL (F) PVROCNTP (F) SPP
CONTCUT (F) KNL PERIOD PVROCPFL SPTV
CTLACTN LASTPV PIDFORM PVROCPPR (F) SPTVP
CTLALGID LOCALMAN PNTFORM PVROCPTP (F) STDBYMAN
CTLEQN MANMODFL PNTMODTY PVSGCHTP (F) STSMSG
CTRLINIT MODATTR PNTNODTY PVSOURCE (F) T1
CV MODE PNTSTATE PVSRCOPT (F) T2
CVEUHI MODEAPPL PNTTYPE PVSTS TVPROC
CVEULO MODEPERM PTDESC PVTRACK UNIT
DELCV MODNUM PTEXECST RAMPTIME USERID
DEV NAME PTINAL
DEVHIFL NLFM

APM Parameter Reference Dictionary 3-8 10/96

 3.13

3.13 PID with Position Proportional (PidPosPr)

The parameters of the PID Position Proportional control algorithm are listed below in
alphabetical order.
$AUXUNIT (F) DEVHIPR (F) MODATTR PVALDBEU (F) RATIO
ADVDEVFL DEVHITP (F) MODE PVAUTO RBOPT
ADVDEVPR (F) DEVLOFL MODEAPPL PVAUTOST RCASOPT
ADVDEVTP (F) DEVLOPR (F) MODEPERM PVEUHI RCASSHED
ADVSP (F) DEVLOTP (F) MODNUM PVEULO REDTAG (F)
ADVSPP (F) ESWAUTO NAME PVFORMAT RINITREQ
ALENBST (F) ESWCAS NLFM PVHHFL RINITVAL
ARWNET ESWENBST NLGAIN PVHHPR (F) RP
ARWOP ESWMAN NMODATTR PVHHTP (F) RT
ASPPROC (F) EUDESC NMODE PVHIFL RTHILM
ASSOCDSP EXTSWOPT NOCINPTS PVHIPR (F) RTLOLM
AUTMODFL GAINOPT NOCOPTS PVHITP (F) SAFEOPCMD
BADCTLFL GAPHI NODENUM PVLLFL SHEDMODE
BADCTLOP GAPLO NODETYP PVLLPR (F) SHEDTIME
BADCTLPR (F) HIGHAL (F) NTWKNUM PVLLTP (F) SHUTDOWN
BADPVFL (F) HIGHALPR (F) OPCMD PVLOFL SLOTNUM
BADPVPR (F) INITMAN OPHIFL PVLOPR (F) SP
BADPVR (F) K OPHISRC PVLOTP (F) SPEUHI
BIAS K1 OPLOFL PVP SPEULO
BSHILM KEXT OPLOSRC PVROCNFL SPFORMAT
BSLOLM KEYWORD OVERVAL (F) PVROCNPR (F) SPHIFL
CASREQ KGAP PERIOD PVROCNTP (F) SPHILM
CIDSTN KLIN PIDFORM PVROCPFL SPLOFL
CISRC KNL PNTFORM PVROCPPR (F) SPLOLM
CODSTN LASTPV PNTMODTY PVROCPTP (F) SPOPT
CONTCUT (F) LMSRC PNTNODTY PVSGCHTP (F) SPP
CTLACTN LOCALMAN PNTSTATE PVSOURCE (F) SPTV
CTLALGID LOWERTIM PNTTYPE PVSRCOPT (F) SPTVP
CTLEQN LOWRDSTN PRIMMOD (F) PVSTS STDBYMAN
CTRLINIT LOWRRATE PTDESC PVTRACK STSMSG
CYCLETIM MANMODFL PTEXECST RAISDSTN T1
DEADBAND MANOPCMD PTINAL RAISETIM T2
DEADTIME MANOPTIM PTORST RAISRATE TVPROC
DELCV MAXPULSE PV RAMPTIME UNIT
DEV MINPULSE PVALDB (F) RARWSTS USERID
DEVHIFL

APM Parameter Reference Dictionary 3-9 10/96

 3.14

3.14 Position Proportional (PosProp)

The parameters of the Position Proportional control algorithm are listed below in
alphabetical order. (F) indicates that the parameter is applicable when the PNTFORM =
Full.
$AUXUNIT (F) DEVHITP (F) MODNUM PVAUTOST RAMPTIME
ADVDEVFL DEVLOFL NAME PVEUHI RARWSTS
ADVDEVPR (F) DEVLOPR (F) NMODATTR PVEULO RCASOPT
ADVDEVTP (F) DEVLOTP (F) NMODE PVFORMAT RCASSHED
ADVSP (F) ESWAUTO NOCINPTS PVHHFL REDTAG (F)
ADVSPP (F) ESWCAS NOCOPTS PVHHPR (F) RINITREQ
ALENBST (F) ESWENBST NODENUM PVHHTP (F) RINITVAL
ARWNET ESWMAN NODETYP PVHIFL RP
ARWOP EUDESC NTWKNUM PVHIPR (F) RT
ASPPROC (F) EXTSWOPT OPCMD PVHITP (F) SAFOPCMD
ASSOCDSP HIGHAL (F) OPHIFL PVLLFL SHEDMODE
AUTMODFL HIGHALPR (F) OPHISRC PVLLPR (F) SHEDTIME
BADCTLFL INITMAN OPLOFL PVLLTP (F) SHUTDOWN
BADCTLOP KEYWORD OPLOSRC PVLOFL SLOTNUM
BADCTLPR (F) LASTPV OVERVAL (F) PVLOPR (F) SP
BADPVFL (F) LMSRC PERIOD PVLOTP (F) SPEUHI
BADPVR (F) LOCALMAN PNTFORM PVP SPEULO
CASREQ LOWERTIM PNTMODTY PVROCNFL SPFORMAT
CIDSTN LOWRDSTN PNTNODTY PVROCNPR (F) SPHIFL
CISRC LOWRRATE PNTSTATE PVROCNTP (F) SPHILM
CODSTN LTIMHILM PNTTYPE PVROCPFL SPLOFL
CONTCUT (F) MANMODFL PRIMMOD (F) PVROCPPR (F) SPLOLM
CTLALGID MANOPCMD PTDESC PVROCPTP (F) SPOPT
CTRLINIT MANOPTIM PTEXECST PVSGCHTP (F) SPP
CYCLETIM MAXPULSE PTINAL PVSOURCE (F) SPTV
DEADBAND MINPULSE PTORST PVSRCOPT (F) SPTVP
DEADTIME MODATTR PV PVSTS STDBYMAN
DEV MODE PVALDB (F) RAISDSTN STSMSG
DEVHIFL MODEAPPL PVALDBEU (F) RAISETIM TVPROC
DEVHIPR (F) MODEPERM PVAUTO RAISRATE UNIT
USERID

APM Parameter Reference Dictionary 3-10 10/96

 3.15

3.15 Ramp Soak (RampSoak)

The parameters of the Ramp Soak control algorithm are listed below in alphabetical order.
(F) indicates that the parameter is applicable when the PNTFORM = Full.
$AUXUNIT (F) ESWAUTO OP RATE4 SOAKT9
ADVDEVFL ESWCAS OPEU RATE5 SOAKT10
ADVDEVPR (F) ESWENBST OPHIFL RATE6 SOAKT11
ADVDEVTP (F) ESWMAN OPHILM RATE7 SOAKT12
ADVSP (F) EUDESC OPLOFL RATE8 SOAKV1
ADVSPP (F) EXTSWOPT OPLOLM RATE9 SOAKV2
ALENBST (F) HIGHAL (F) OPMCHLM RATE10 SOAKV3
ARWNET HIGHALPR (F) OPRATRFL RATE11 SOAKV4
ARWOP HOLDCMD OPROCLM RATE12 SOAKV5
ASPPROC (F) INITMAN OVERVAL (F) REDTAG (F) SOAKV6
ASSOCDSP KEYWORD PERIOD REMSOAKT SOAKV7
AUTMODFL LASTPV PNTFORM RINITREQ SOAKV8
BADCTLFL LOCALMAN PNTMODTY RINITVAL SOAKV9
BADCTLPR (F) MANMODFL PNTNODTY S1 SOAKV10
CASREQ MODATTR PNTSTATE S1BGNTIM SOAKV11
CIDSTN MODE PNTTYPE S1ENDTIM SOAKV12
CISRC MODEAPPL PRIMMOD S1SEGID SP
CODSTN MODEPERM PTDESC S2 SPEUHI
CONTCUT (F) MODNUM PTEXECST S2BGNTIM SPEULO
CTLALGID MXRMPDEV` PTINAL S2ENDTIM SPFORMAT
CTRLINIT MXSOKDEV PTORST S2SEGID SPHIFL
CURSEGID NAME PV SAFEOP SPHILM
CV NMODATTR PVEUHI SEGTYPE SPLOFL
CVEUHI NMODE PVEULO SHUTDOWN SPLOLM
CVEULO NOCINPTS PVFORMAT SLOTNUM SPOPT
CYCLEOPT NOCOPTS PVP SOAKT1 SPP
DEV NODENUM PVSTS SOAKT2 SPTV
DEVHIPR (F) NODETYP RAMPTIME SOAKT3 SPTVP
DEVHIFL NORSSEQ RARWSTS SOAKT4 STDBYMAN
DEVHITP (F) NTWKNUM RATE1 SOAKT5 STSMSG
DEVLOFL NXTSOAKV RATE2 SOAKT6 TVPROC
DEVLOPR (F) RATE3 SOAKT7 UNIT
DEVLOTP (F) SOAKT8 USERID

APM Parameter Reference Dictionary 3-11 10/96

 3.16

3.16 Ratio Control (RatioCtl)

The parameters of the Ratio-Control control algorithm are listed below in alphabetical
order. (F) indicates that the parameter is applicable when the PNTFORM = Full.
$AUXUNIT (F) DEVHITP (F) NTWKNUM PV RAMPTIME
ADVDEVFL DEVLOFL OP PVALDB (F) RARWSTS
ADVDEVPR (F) DEVLOPR (F) OPALDB (F) PVALDBEU (F) RCASOPT
ADVDEVTP (F) DEVLOTP (F) OPEU PVAUTO RCASSHED
ADVSP (F) ESWAUTO OPHAFL (F) PVAUTOST REDTAG (F)
ADVSPP (F) ESWCAS OPHIFL PVEUHI RINITREQ
ALENBST (F) ESWENBST OPHILM PVEULO RINITVAL
ARWNET ESWMAN OPHIPR (F) PVFORMAT SAFEOP
ARWOP EUDESC OPHITP (F) PVHHFL SHEDMODE
ASPPROC (F) EXTSWOPT OPLAFL (F) PVHHPR (F) SHEDTIME
ASSOCDSP HIGHAL (F) OPLOFL PVHHTP (F) SHUTDOWN
AUTMODFL HIGHALPR (F) OPLOLM PVHIFL SLOTNUM
B1 INITMAN OPLOPR (F) PVHIPR (F) SP
B2 K1 OPLOTP (F) PVHITP (F) SPEUHI
BADCTLFL K2 OPMCHLM PVLLFL SPEULO
BADCTLPR (F) KEYWORD OPRATRFL PVLLPR (F) SPFORMAT
BADPVFL (F) LASTPV OPROCLM PVLLTP (F) SPHIFL
BADPVPR (F) LOCALMAN OVERVAL (F) PVLOFL SPHILM
CASREQ MANMODFL PERIOD PVLOPR (F) SPLOFL
CIDSTN MODATTR PNTFORM PVLOTP (F) SPLOLM
CISRC MODE PNTMODTY PVP SPOPT
CODSTN MODEAPPL PNTNODTY PVROCNFL SPP
CONTCUT (F) MODEPERM PNTSTATE PVROCNPR (F) SPTV
CTLALGID MODNUM PNTTYPE PVROCNTP (F) SPTVP
CTRLINIT NAME PRIMMOD (F) PVROCPFL STDBYMAN
CV NMODATTR PTDESC PVROCPPR (F) STSMSG
CVEUHI NMODE PTEXECST PVROCPTP (F) TVPROC
CVEULO NOCINPTS PTINAL PVSGCHTP (F) UNIT
DEV NOCOPTS PTORST PVSOURCE (F) USERID
DEVHIFL NODENUM PVSRCOPT (F) X2
DEVHIPR NODETYP PVSTS

APM Parameter Reference Dictionary 3-12 10/96

 3.17

3.17 Summer

The parameters of the Summer PV algorithm are listed below in alphabetical order. (F)
indicates that the parameter is applicable when the PNTFORM = Full.
$AUXUNIT (F) MODNUM PERIOD PVCLAMP PVLOPR (F)
ALENBST (F) NAME PISRC PVEQN PVLOTP (F)
ASSOCDSP NODENUM PIDSTN PVEULO PVP
BADPVFL (F) NODETYP PNTFORM PVEUHI PVROCNFL
BADPVPR (F) NOPINPTS PNTMODTY PVEXEUHI PVROCNPR (F)
C NTWKNUM PNTNODTY PVEXEULO PVROCNTP (F)
C1 OVERVAL (F) PNTSTATE PVEXHIFL PVROCPFL
C2 P1 PNTTYPE PVEXLOFL PVROCPPR (F)
C3 P1STS PRIMMOD (F) PVFORMAT PVROCPTP (F)
C4 P2 PTDESC PVHHFL PVSGCHTP (F)
C5 P2STS PTEXECST PVHHPR (F) PVSOURCE (F)
C6 P3 PTINAL PVHHTP (F) PVSRCOPT (F)
CONTCUT P3STS PV PVHIFL PVSTS
D P4 PVALDB (F) PVHIPR (F) PVTV (F)
EUDESC P4STS PVALDBEU (F) PVHITP (F) PVTVP (F)
HIGHAL (F) P5 PVALGID PVINIT SLOTNUM
HIGHALPR (F) P5STS PVAUTO PVLLFL STSMSG
KEYWORD P6 PVAUTOST PVLLPR (F) TF
LASTPV P6STS PVCALC PVLLTP (F) UNIT
N PVLOFL USERID

3.18 Switch

The parameters of the Switch control algorithm are listed below in alphabetical order. (F)
indicates that the parameter is applicable when the PNTFORM = Full.
$AUXUNIT (F) ESWCAS NOCINPTS OPROCLM S2
ALENBST (F) ESWENBST NOCOPTS OVERVAL (F) S3
ARWNET ESWMAN NODENUM PERIOD S4
ARWOP EUDESC NODETYP PNTFORM SAFEOP
ASSOCDSP EXTSWOPT NTWKNUM PNTMODTY SELXINP
AUTMODFL HIGHAL (F) OP PNTNODTY SHEDMODE
BADCTFL HIGHALPR (F) OPALDB (F) PNTSTATE SHEDTIME
BADCTLOP INITMAN OPEU PNTTYPE SHUTDOWN
BADCTLPR (F) KEYWORD OPHAFL (F) PRIMMOD (F) SLOTNUM
CASREQ LOCALMAN OPHIFL PTDESC STDBYMAN
CIDSTN M OPHILM PTEXECST STSMSG
CISRC MANMODFL OPHIPR (F) PTINAL TRACKING
CODSTN MODATTR OPHITP (F) PTORST UNIT
CONTCUT (F) MODE OPLAFL (F) RARWSTS USERID
CTLALGID MODEAPPL OPLOFL RCASOPT X1
CTLEQN MODEPERM OPLOLM RCASSHED X2
CTRLINIT MODNUM OPLOPR (F) REDTAG (F) X3
CV NAME OPLOTP (F) RINITREQ X4
CVEUHI NMODATTR OPMCHLM RINITVAL XEUHI
CVEULO NMODE OPRATRFL S1 XEULO
ESWAUTO

APM Parameter Reference Dictionary 3-13 10/96

 3.19

3.19 Totalizer (Totalizr)

The parameters of the Totalizer PV algorithm are listed below in alphabetical order. (F)
indicates that the parameter is applicable when the PNTFORM = Full.
$AUXUNIT (F) LASTPV PNTTYPE PVEXLOFL PVROCPFL
ACCTYPE MODNUM PRIMMOD (F) PVFORMAT PVROCPPR (F)
ALENBST (F) NAME PTDESC PVHHFL PVROCPTP (F)
ASSOCDSP NODENUM PTEXECST PVHHPR (F) PVSGCHTP (F)
AVDEV1FL NODETYP PTINAL PVHHTP (F) PVSOURCE (F)
AVDEV1TP NOPINPTS PV PVHIFL PVSRCOPT (F)
AVDEV2FL NTWKNUM PVALDB (F) PVHIPR (F) PVSTS
AVDEV2TP OLDAV PVALDBEU (F) PVHITP (F) PVTV (F)
AVTV OVERVAL (F) PVALGID PVINIT PVTVP (F)
AVTVFL P1 PVAUTO PVLLFL RESETFL
BADPVFL (F) P1STS PVAUTOST PVLLPR (F) RESETVAL
BADPVPR (F) P2 PVCALC PVLLTP (F) SLOTNUM
C P2STS PVCLAMP PVLOFL STARTFL
COMMAND PERIOD PVEQN PVLOPR (F) STATE
CONTCUT (F) PIDSTN PVEUHI PVLOTP (F) STOPFL
CUTOFFLM PISRC PVEULO PVP STSMSG
EUDESC PNTFORM PVEXEUHI PVROCNFL TF
HIGHAL (F) PNTMODTY PVEXEULO PVROCNPR (F) TIMEBASE
HIGHALPR (F) PNTNODTY PVEXHIFL PVROCNTP (F) UNIT
KEYWORD PNTSTATE USERID

3.20 Variable Dead Time with Lead/Lag (VdtLdLag)

The parameters of the Variable Dead Time with Lead/Lag PV algorithm are listed below in
alphabetical order. (F) indicates that the parameter is applicable when the PNTFORM =
Full.
$AUXUNIT (F) NAME PRIMMOD (F) PVEXLOFL PVROCNTP (F)
ALENBST (F) NLOC PTDESC PVFORMAT PVROCPFL
ASSOCDSP NODENUM PTEXECST PVHHFL PVROCPPR (F)
BADPVFL (F) NODETYP PTINAL PVHHPR (F) PVROCPTP (F)
BADPVPR (F) NOPINPTS PV PVHHTP (F) PVSGCHTP (F)
C NTWKNUM PVALDB (F) PVHIFL PVSOURCE (F)
C1 OVERVAL (F) PVALDBEU (F) PVHIPR (F) PVSRCOPT (F)
C2 P1 PVALGID PVHITP (F) PVSTS
CONTCUT (F) P1STS PVAUTO PVINIT PVTV (F)
CUTOFFLM P2 PVAUTOST PVLLFL PVTVP (F)
D P2STS PVCALC PVLLPR (F) SLOTNUM
D1 PERIOD PVCLAMP PVLLTP (F) STSMSG
D2 PIDSTN PVEQN PVLOFL TD
EUDESC PISRC PVEUHI PVLOPR (F) TF
HIGHAL (F) PNTFORM PVEULO PVLOTP (F) TLD
HIGHALPR (F) PNTMODTY PVEXEUHI PVP TLG1
KEYWORD PNTNODTY PVEXEULO PVROCNFL TLG2
LASTPV PNTSTATE PVEXHIFL PVROCNPR (F) UNIT
MODNUM PNTTYPE USERID

APM Parameter Reference Dictionary 3-14 10/96

 $ADD

-$-

$ADD (Array)
Type: Logical Add Point Last Parameter Indicator— The last parameter sent to the APM
Lock: PtBld during point build of an array point.
Default: On
PtRes: APM
Range: Off
On

Helpful Hint: Do not remove $ADD from an exception build file or the point will not load
properly.

$AUXUNIT
Type: E:UNIT Auxiliary Unit— The Auxiliary Unit of an alarmable process point. If an
Lock: Oper Auxiliary Unit ID is specified, alarms from this point go to the Auxiliary
Default: Null Unit instead of the Primary Unit. If the $AUXUNIT parameter is set to null
PtRes: NIM (- -), alarms go to the Primary Unit. Available in Release 520 and later
software.

Range: A-Z, 0-9 and Null - (Any valid unit ID as configured in the NCF)

Helpful Hint: A Network configuration option sets the keylevel required to change
$AUXUNIT.

$DBVALID (APM Box)

Type: E:$ACCSRC
APM
Database Valid
Lock: Eng
Default: DBInvalid
PtRes: APM
Range: 0-DB_Valid (An IOP database is valid and the IOP can be started)
1-DBInvalid (An IOP database is not valid and the IOP will not start)

APM Parameter Reference Dictionary $-1 10/96

 $IOMPADD(1)

$IOMPADD(1)–(168)
Type: Integer IOP Address—Returns the physical address of the IOP with (soft address)
Lock: View (File-1)*16 + card + 127
Default: N/A
PtRes: APM
Range: 0, 129 - 255

$UCNLSB(1)–(50)
Type: Real Local UCN Communications Statistics
Lock: View
Default:
PtRes: APM
Range:

$UCNLSB(45) (NIM)
Type: Real Local Statistics Block— The number of auto reconnects.
Lock: View
Default: 0
PtRes: APM, NIM
Range: ≤0

APM Parameter Reference Dictionary $-2 10/96

 AB_DATA1

-A-

AB_DATA1 (SI - Array)

Type: Real Auxiliary A-B Data 1—Specifies the Allen-Bradley PLC family type: 2.0,
Lock: Eng 3.0,
Default: NaN or 5.0. Refer to the APM/HPM Serial Interface Options manual when
PtRes: APM configuring for diagnostics.
Range: N/A

Helpful Hint: Use of this parameter is only required to configure Serial Interface mapping
to/from an Allen-Bradley programmable logic controller device. This
parameter should be set to NAN if it is not being used.

AB_DATA2 (SI - Array)

Type: Real Auxiliary A-B Data 2—Specifies the Allen-Bradley PLC File Number (in
Lock: Eng decimal) from which data is read into the Array point for PLC-3 or PLC-5
Default: NaN controllers. Must be NaN for PLC-2.
PtRes: APM
Range: 0 - 999, NaN

Helpful Hint: Use of this parameter is only required to configure Serial Interface mapping
to/from an Allen-Bradley programmable logic controller device. This
parameter should be set to NAN if it is not being used.

AB_DATA3 (SI - Array)

Type: Real Auxiliary A-B Data 3—Specifies the data type for Allen-Bradley PLC-2 or
Lock: Eng PLC-5 controllers or section ID for PLC-3 controllers. Refer to the
Default: NaN APM/HPM Serial Interface Options manual for additional information.
PtRes: APM
Range: 0 - 13

Helpful Hint: Use of this parameter is only required to configure Serial Interface mapping
to/from an Allen-Bradley programmable logic controller device. This
parameter should be set to NAN if it is not being used.

AB_DATA4 (SI - Array)

Type: Real Auxiliary A-B Data 4—Specifies the Allen-Bradley PLC scan frequency: 0
Lock: Eng indicates that the point is to be scanned as fast as possible. 1–255 indicates
Default: NaN the number of seconds for the polling period; 256 = scan once. Note that the
PtRes: APM report by exception feature can work with any scan rate selection. Refer to
the APM/HPM Serial Interface Options manual for more information.
Range: 0 - 256

Helpful Hint: Use of this parameter is only required to configure Serial Interface mapping
to/from an Allen-Bradley programmable logic controller device. This
parameter should be set to NAN if it is not being used.

APM Parameter Reference Dictionary A-1 10/96

 ABHEMSD

ABHEMSD (ProcMod)
Type: Logical Abnormal Handler Emergency Shutdown Enable Flag—Indicates if the
Lock: View Emergency Shutdown abnormal handler sequence is currently enabled.
Default: Off
PtRes: APM
Range: On (Emergency Shutdown abnormal handler is enabled)
Off (Emergency Shutdown abnormal handler not enabled)

ABHHOLD (ProcMod)
Type: Logical Abnormal Handler Hold Enable Flag—Indicates if the Hold abnormal
Lock: View handler sequence is currently enabled.
Default: Off
PtRes: APM
Range: On (Hold abnormal handler is enabled)
Off (Hold abnormal handler not enabled)

ABHRSTR (ProcMod)
Type: Logical Abnormal Handler Restart Enable Flag—Indicates if the Restart abnormal
Lock: View handler sequence is currently enabled.
Default: Off
PtRes: APM
Range: On (Restart abnormal handler is enabled)
Off (Restart abnormal handler not enabled)

ABHSHDN (ProcMod)
Type: Logical Abnormal Handler Shutdown Enable Flag—Indicates if the Shutdown
Lock: View abnormal handler sequence is currently enabled.
Default: Off
PtRes: APM
Range: On (Shutdown abnormal handler is enabled)
Off (Shutdown abnormal handler not enabled)

ACCELTIM
(DevCtl)
Type: Time Acceleration Time—The amount of time the SECVAR parameter
(Duration) exceeded the SVHITP parameter while not in State0. This parameter resets
Lock: View to zero each time the state transitions to State0.
Default: 0
PtRes: APM
Range: 0 to 4000 days (With a resolution of 1 second)

ACCTYPE
(Totalizer)
Type: E:$ACCTYPE Accumulator Operation Mode—Specifies the type of input.
Lock: Eng/PB
Default: Analog
PtRes: APM

Range: 0-Pulse Pulse input

1-Analog Analog input

APM Parameter Reference Dictionary A-2 10/96

 ACP

ACP (ProcMod)
Type: Ent_Id Advanced Control Point ID—Defines the name of the point in the CG or
Lock: PtBld CM to which this process module is assigned. The NIM notifies the
Default: Null advanced control point when the process module sends a special sequence
PtRes: NIM message.

Range: Tag name can be up to 16 characters, and the

permissible character set is as follows:
Alphabetics A-Z (uppercase only)
Numerics 0-9 (an all numeric tag name is not allowed)
Underscore (_) cannot be used as the first character
or the last character, and consecutive
underscores are not allowed.
Embedded space characters are not allowed.

ACTPRIM(1)–(40) (APM
Box)
Type: E:$ACTPRIM Acting Primary I/O module—
Lock: View Specifies the acting primary I/O
Default: module.
PtRes: APM nn = 1–40 corresponds to the 40
logical I/O modules.
Applies to primary IOP only.
Range: 0-IOM_A (The A module is the acting primary)
1-IOM_B (The B module is the acting primary)

ADVDEVFL
Type: Logical Advisory Deviation Alarm Flag—Indicates whether an advisory alarm has
Lock: View been detected.
Default: Off
PtRes: APM
Range: Off (Alarm has not been detected)
On (Alarm has been detected. PV - ADVSP is greater than ADVDEVTP)

Helpful Hint: ADVDEVFL is never On unless SPOPT = Asp.

ADVDEVPR
Type: E:ALPRIOR Advisory Deviation Alarm Priority—Determines the priority of the advisory
Lock: Engr deviation alarm.
Default: Low
PtRes: NIM
Range: JnlPrint (Alarm is historized and reported to the printer but not annunciated)
Printer (Alarm is reported to the printer but not historized and not annunciated)
Emergncy (Alarm is historized, annunciated, and reported to all alarm summary displays)
High (Alarm is historized, reported to Area Alarm Summary Display and Unit Alarm
Summary
Display)
Low (Alarm is historized, reported to the Unit Alarm Summary Display, and annunciated)
Journal (Alarm is historized but not reported to Universal Stations and not annunciated)
NoAction (Alarm is not reported to the system and not annunciated)
Helpful Hint: ADVDEVPR configuration requires SPOPT = Asp.

APM Parameter Reference Dictionary A-3 10/96

 ADVDEVTP

ADVDEVTP
Type: Real Advisory Deviation Alarm Trip Point—An alarm will be generated when
Lock: Supr the difference between PV and ADVSP exceeds the value in this parameter.
Default: NaN
PtRes: APM
Range: > 0.0
NaN

Helpful Hint: 1. ADVDEVTP change requires SPOPT = Asp .

2. Alarm generation requires ASPPROC = Enable and
abs(PV - ADVSP) > ADVDEVTP.
When abs(PV - ADVSP) < ADVDEVTP * .9 alarm returns to normal.

ADVSP
Type: Real Advisory Setpoint in Engineering Units
Lock: Supr
Default: N/A
PtRes: APM
Range: SPLOLM to SPHILM

Helpful Hint: ADVSP change requires (SPOPT = Asp) + (ASPPROC = Enable).

Alarm generation requires ASPPROC = Enable and
abs(PV - ADVSP) > ADVDEVTP.
When abs(PV - ADVSP) < ADVDEVTP * .9 alarm returns to normal.

ADVSPP
Type: Real Advisory Setpoint in Percent
Lock: View
Default: N/A
PtRes: APM
Range: N/A

Helpful Hint: ADVSPP cannot be viewed unless SPOPT = Asp.

APM Parameter Reference Dictionary A-4 10/96

 ALENBST

ALENBST
Type: E:ALENBST Alarm Enable Status—Defines the alarm reporting function that is to be
Lock: Oper used when an alarm condition is detected in this data point. Note that even
Default: Enable when alarms are disabled, the alarm indicators still appear on the Group and
PtRes: NIM Detail displays. With Release 510 and later software, the word DIS appears
in half height text above the tag name on the Point Detail or Group Display
for a point with ALENBEST set to Disable.

Range: Displayed Logged Reported to EIP

Enable Yes Yes Yes
Disable No Yes Yes
Inhibit No No No

Helpful Hint: ALENBST should not be set to Disable or Inhibit for points critical to safe
operations. For Box Flag points, this parameter applies to only slots 1
through 128.

Reference: See Engineer’s Reference Manual, SW09-505, Section 8, Alarm

Management,
for more information on what should happen under different possible alarm
actions.

NOTE

The access lock for the ALENBST parameter is configurable through System-Wide
Values.

ALMOPT (DigIn)
Type: E:$ALMOPT Alarming Option—Defines the alarming option for a digital input point
Lock: Eng/PB whose DITYPE is Status.
Default:
None
PtRes:APM
Range:0-None (No alarms are to be detected.)
1-Offnorml (Off Normal; alarm if current PV state is not the PVNORMAL state.
PVNORMAL
is defined by the STATETXT(0) or STATETXT(1) descriptor, as configured by the user.
2-ChngofSt (An alarm is generated when the digital input changes state in either direction.
Note that IOP firmware must support Change of State Reporting.)

Helpful Hint: ALMOPT configuration requires DITYPE = Status.

APM Parameter Reference Dictionary A-5 10/96

 ALPRIOR
ALPRIOR (ProcMod)
Type: E:ALPRIOR Alarm Priority—Defines the alarm priority for Process Module points. Note
Lock: Engr that
Default: Low even when the alarm priority is Journal, the alarm indicators still appear on
PtRes: NIM the Group and Detail displays.
Range: Emergncy (Alarm is historized, annunciated, and reported to all alarm summary displays)
High (Alarm is historized, reported to Area Alarm Summary Display and Unit Alarm
Summary
Display)
Low (Alarm is historized, reported to the Unit Alarm Summary Display, and annunciated)
JnlPrint (Alarm is historized and reported to the printer but not annunciated)
Printer (Alarm is reported to the printer but not historized and not annunciated)
Journal (Alarm is historized but not reported to Universal Stations and not annunciated)
NoAction (Alarm is not reported to the system and not annunciated)

Helpful Hint: Access to ALPRIOR is by schematic or CL. ALPRIOR is retained in R500

for compatibility with earlier software. Use SEQPR for new points.

Reference: See Engineer’s Reference Manual, SW09-505, Section 8, Alarm

Management,
for more information on what should happen under different possible alarm
actions.

ALPRIOR (DigIn, DigCmp, FL)

Type: E:ALPRIOR Composite Alarm Priority—When read, returns a value equal to the highest
Lock: Engr configured priority among all alarm parameters for the point. When written,
Default: Low sets all of the point’s alarm priority parameters equal to the value being
PtRes: NIM stored. Note that individual parameters such as BADPVPR, etc. can be
stored individually.
If a point’s separate alarm priorities are all set to the same priority,
ALPRIOR is compatible with R400 and earlier software.
Range: Emergncy (Alarm is historized, annunciated, and reported to all alarm summary displays)
High (Alarm is historized, reported to Area Alarm Summary Display and Unit Alarm
Summary
Display)
Low (Alarm is historized, reported to the Unit Alarm Summary Display, and annunciated)
JnlPrint (Alarm is historized and reported to the printer but not annunciated)
Printer (Alarm is reported to the printer but not historized and not annunciated)
Journal (Alarm is historized but not reported to Universal Stations and not annunciated)
NoAction (Alarm is not reported to the system and not annunciated)

Helpful Hint: Access to ALPRIOR is by schematic or CL. No value is actually read from
ALPRIOR on a read and no value is actually stored to ALPRIOR on a write. Values are
copied to and from the separate alarm priorities.

Reference: See Engineer’s Reference Manual, SW09-505, Section 8, Alarm

Management,
for more information on what should happen under different possible alarm
actions.

ANAME(1)–(3) (ProcMod)
Type: String_8 Abnormal Sequence Name—Indicates the name of the abnormal handler
Lock: View currently being executed by the process module. A value of " " means that
Default: Spaces an abnormal handler is not executing. ANAME(1) returns the abnormal
PtRes: APM handler name, while both ANAME(2) and ANAME(3) return the names of
the two abnormal subroutine levels being executed.
Range: N/A

APM Parameter Reference Dictionary A-6 10/96

 AOCALIB

AOCALIB(1)–(168)
Type: Logical AO Calibration In Progress Flag—Shows which AO modules are in the
Lock: Eng/PB process of calibration.
Default:
PtRes: APM
Range: Off (No calibration in progress)
On (Calibration in progress)

ARWNET (RegCtl)
Type: E:WINDUP Windup Status of the Input—Indicates the windup status for the SP or
Lock: View another initializable input.
Default: Normal
PtRes: APM
Range: 0-Normal (Free to move in either direction)
1-Hi (Free to move in the lower direction)
2-Lo (Free to move in the higher direction)
3-HiLo (Not free to move in any direction)

ARWOP (RegCtl)
Type: E:WINDUP Windup Status of the Output—Indicates the output (OP) windup status.
Lock: View
Default: Normal
PtRes: APM
Range: 0-Normal (Free to move in either direction)
1-Hi (Free to move in the lower direction)
2-Lo (Free to move in the higher direction)
3-HiLo (Not free to move in any direction)

ASSOCDSP
Type: String_8 Associated Display—Specifies a user configured schematic that is
Lock: Engr associated with this point. Available on Release 510 and later software.
Default: Blank
PtRes: NIM
Range: N/A

Helpful Hint: The specified associated display can be called from a Point Detail Display,
or from any summary display or the Group display when the point is selected.

ASPPROC (RegCtl)
Type: E:ASPPROC Advisory SP Processor State
Lock: Supr
Default: Disable
PtRes: APM
Range: 0-Disable (Disallow advisory deviation alarming)
1-Enable (Allow advisory deviation alarming)

Helpful Hint: ASPPROC change requires SPOPT = Asp.

APM Parameter Reference Dictionary A-7 10/96

 ASTEP

ASTEP(1)–(3)
(ProcMod)
Type: String_8 Abnormal Step Name—ASTEP(1) indicates the step name of the abnormal
Lock: View handler that is executing in this process module. A value of “ “ means no
Default: Spaces abnormal handler is presently executing. Both ASTEP(2) and ASTEP(3)
PtRes: APM indicate the step names of the first and second level subroutines called from
the abnormal handler.
Range: N/A

ASTMT(1)–(3)
(ProcMod)
Type: Integer Abnormal Statement Number—ASTMT(1) indicates the statement number
Lock: View of the abnormal handler that is presently executing in the process module.
Default: Blank Both ASTMT(2) and ASTMT(3) give statement numbers for first and second
PtRes: APM level subroutines executing from an abnormal handler. A value of 0 indicates
no sequence is being executed.
Range: 0 to 255

AUTMODFL (RegCtl)
Type: Logical Automatic Mode Flag—Indicates whether the current mode of the point is
Lock: View Automatic.
Default: N/A
PtRes: APM
Range: Off (Current mode is not Automatic)
On (Current mode is Automatic)

AUXDATA1 (SI-Array — Generic

Modbus)
Type: Real FTA Driver Auxiliary Data 1—Keep Alive Address for Modbus devices.
Lock: Eng Specifies the address of a coil that is written to every 10 seconds (Force
Default: NaN Single Coil On function). NaN (dashes) = Keep Alive function is inactive.
PtRes: APM
Range: 1 - 9999, NaN

Helpful Hint: AUXDATA1 can be configured separately for each Array point. No two
Array points should write to the same coil address. This parameter should be set to
NAN if it is not being used.

AUXDATA2 (SI-Array — Generic

Modbus)
Type: Real FTA Driver Auxiliary Data 2— Specifies the time interval that the FTA
Lock: Eng waits before a message retry to the Modbus is attempted. NaN (dashes)
Default: NaN indicates a 1.5 second timeout.
PtRes: APM
Range: .25 - 5 Sec., NaN

Helpful Hint: After three retries, a message timeout error is displayed on the Point Detail
display. AUXDATA2 can be configured separately for each Array point.
This parameter should be set to NAN if it is not being used.

APM Parameter Reference Dictionary A-8 10/96

 AUXDATA3

AUXDATA3 (SI-Array — Generic

Modbus)
Type: Real FTA Driver Auxiliary Data 3—Signaling [Link] support (in
Lock: Eng integer/decimal format). Integer = 232 or 485.
Default: NaN (232 = EIA-232, 485 = EIA-485 Multidrop).
PtRes: APM Decimal (EIA-232 only) = .0 or .1 (.0 = no modem control, .1 = modem
control).
NaN (dashes) = 232.0 (EIA-232 without modem control).

Range: 232.0, 232.1, or 485.0

Helpful Hint: All array points that are loaded to the same FTA must have the same
AUXDATA3 settings. This parameter should be set to NAN if it is not being
used.

AUXDATA4 (SI-Array — Generic

Modbus)
Type: Real FTA Driver Auxiliary Data 4—Baud [Link] (in integer/decimal
Lock: Eng format).
Default: NaN Baud Rates = 1200, 2400, 4800, 9600, or 19200.
PtRes: APM Parity: .0 = no parity, .1 = odd parity, .2 = even parity.
NaN (dashes) = 9600.1 = (9600 baud, odd parity).

Range: integer = 1200, 2400, 4800, 9600, or 19200

decimal = .0, .1, or .2

Helpful Hint: All array points that are loaded to the same FTA must have the same
AUXDATA4 settings. This parameter should be set to NAN if it is not being
used.

AV (DigIn)
Type: Integer Accumulated Value in Engineering Units—Indicates the current value
Lock: Oper accumulated in the accumulator.
Default: 0
PtRes: APM
Range: 0..32767

AVDELTHS (PI)
Type: Integer
The Last Half-
second’s AV
Lock: View
Default: 0
PtRes: APM
Range: > 0

AVDEV1FL (Totalizr)
Type: Logical Accumulated Value; 1st Deviation Flag—Indicates whether PVCALC is
Lock: View greater than AVTV minus AVDEV1TP. (PVCALC > AVTV - AVDEV1TP).
Default: N/A This is the first "slowdown" or "near-target" flag.
PtRes: APM
Range: Off (PVCALC is not > AVTV - AVDEV1TP)
On (PVCALC is > AVTV - AVDEV1TP)

APM Parameter Reference Dictionary A-9 10/96

 AVDEV1TP

AVDEV1TP (Totalizr)
Type: Real Accumulated Value; 1st Deviation Trip Point (deviation from AVTV)
Lock: Supr
Default: NaN
PtRes: APM
Range: > 0.0,
NaN

AVDEV2FL (Totalizr)
Type: Logical Accumulated Value; 2nd Deviation Flag—Indicates whether PVCALC is
Lock: View greater than AVTV minus AVDEV2TP. (PVCALC > AVTV - AVDEV2TP).
Default: N/A This is the second "slowdown" or "near-target" flag.
PtRes: APM
Range: Off (PVCALC is not > AVTV - AVDEV2TP)
On (PVCALC is > AVTV - AVDEV2TP)

AVDEV2TP (Totalizr)
Type: Real Accumulated Value; 2nd Deviation Trip Point (deviation from AVTV)
Lock: Supr
Default: NaN
PtRes: APM
Range: > 0.0,
NaN

AVGTF (NIM, APM Box)

Type: Real Average Statistics Single Lag Filter Time Constant—Defines the filter
Lock: View time in the single lag filter used to calculate average values of the
Default: 1.00 Minutes performance statistics.
PtRes: APM
Range: N/A

AVSTS (PI)
Type: E:PVVALST Value Status of AV
Lock: View
Default: Bad
PtRes: APM
Range: 0-Bad
2-Normal

APM Parameter Reference Dictionary A-10 10/96

 AVTV

AVTV (DigIn)
Type: Integer Accumulator Target Value—Specifies the target value of the accumulator.
Lock: Oper AVTV appears on a group or detail display as the SP value.
Default: 0
PtRes: APM
Range: 0 to 32767

Helpful Hint: AVTV change requires DITYPE = Accum.

AVTV (Totalizr)
Type: Real Accumulator Target Value—Specifies the target value of the totalizer.
Lock: Oper AVTV appears on a group or detail display as the SP value.
Default: NaN
PtRes: APM
Range: N/A,
NaN

AVTV F L
Type: Logical Accumulated Value Target Reached Flag—AVTVFL is the accumulated
Lock: View value's "target value reached" flag. It is turned On whenever PVCALC ≥
Default: N/A AVTV. Parameter AVTV contains the target value last entered by the
PtRes: APM operator.
Range: Off
On

APM Parameter Reference Dictionary A-11 10/96

APM Parameter Reference Dictionary A-12 10/96
 B

-B-

B
(AutoMan)
Type: Real Overall Bias—Defines the overall bias which consists of B0 plus B1.
Lock: Oper Refer to the APM Control Functions and Algorithms manual for a detailed
Default: 0.0 description.
PtRes: APM
Range: N/A

B0 (AutoMan)
Type: Real Last Operator-Entered Output Bias
Lock: View
Default: 0.0
PtRes: APM
Range: N/A

B1
(RatioCtl)
Type: Real Output Bias Constant—If the Calcultr PV algorithm is being used in
Lock: Supr conjunction with this algorithm, the value of B1 should be the same as C3.
Default: 0.0
PtRes: APM
Range: N/A

B2
(RatioCtl)
Type: Real Bias for Input X2—If the Calcultr PV algorithm is being used in
Lock: Supr conjunction with this algorithm, the value of B2 should be the same as C4.
Default: 0.0
PtRes: APM
Range: N/A

BADCTLFL
Type: Logical Bad-Control Alarm Flag—Indicates whether a bad control alarm has been
Lock: View detected.
Default: Off
PtRes: APM
Range: Off (Bad-control alarm not present)
On (Bad-control alarm present)

APM Parameter Reference Dictionary B-1 10/96

 BADCTLOP

BADCTLOP
Type: Bad Control Option—Indicates if the mode sheds to manual when bad PV
E:$BADCTL or CV occurs for regulatory control points. It also shows the value of the
O output.
Lock: Engr
Default: No_Shed
PtRes: APM
Range: 0-No_Shed (The point holds its output and mode, resuming control after initialization upon
recovery)
1-ShedHold (The mode sheds to manual, the mode attribute goes to operator, while the
output is
held and external mode switching is disabled)
2-ShedLow (The mode sheds to manual, the mode attribute goes to operator, while the
output
goes to -6.9% and external mode switching is disabled)
3-ShedHigh (The mode sheds to manual, the mode attribute goes to operator, while the
output
goes to 106.9% and external mode switching is disabled)
4-ShedSafe (The mode sheds to manual, the mode attribute goes to operator, while the
output
goes to SafeOP and external mode switching is disabled. If SafeOP is NaN, the
output is held as if the Bad Control Option is ShedHold.

BADCTLPR
Type: E:ALPRIOR Bad Control Alarm Priority—Defines the priority of the bad control alarm.
Lock: Engr
Default: Low
PtRes: NIM
Range: JnlPrint (Alarm is historized and reported to the printer but not annunciated)
Printer (Alarm is reported to the printer but not historized and not annunciated)
Emergncy (Alarm is historized, annunciated, and reported to all alarm summary displays)
High (Alarm is historized, reported to Area Alarm Summary Display and Unit Alarm
Summary
Display)
Low (Alarm is historized, reported to the Unit Alarm Summary Display, and annunciated)
Journal (Alarm is historized but not reported to Universal Stations and not annunciated)
NoAction (Alarm is not reported to the system and not annunciated)

BADOCFL (RegCtl)
Type: Logical Bad Output Connection Flag (BADOC) Alarm—ON indicates that the
Lock: View RegCtl point cannot drive at least one Analog Output point (out of 4
Default: OFF possible). The alarm appears on the Alarm Summary display and in the
PtRes: APM Real Time Journal as a BADOC alarm. If it is the highest level alarm on
the point, it appears on the Point Detail or Group displays as BOC.

Range: Off (Point is not in alarm)

On (Point is in alarm)

APM Parameter Reference Dictionary B-2 10/96

 BADOC1FL

BADOC1FL
Type: Logical Bad Output Connection Flag 1—ON indicates that the RegCtl point
Lock: View cannot drive Output 1 to an AO point (if configured).
Default: OFF
PtRes: APM
Range: Off
On

BADOC2FL
Type: Logical Bad Output Connection Flag 2—ON indicates that the RegCtl point
Lock: View cannot drive Output 2 to an AO point (if configured).
Default: OFF
PtRes: APM
Range: Off
On

BADOC3FL
Type: Logical Bad Output Connection Flag 3—ON indicates that the RegCtl point
Lock: View cannot drive Output 3 to an AO point (if configured).
Default: OFF
PtRes: APM
Range: Off
On

BADOC4FL
Type: Logical Bad Output Connection Flag 4—ON indicates that the RegCtl point
Lock: View cannot drive Output 4 to an AO point (if configured).
Default: OFF
PtRes: APM
Range: Off
On

APM Parameter Reference Dictionary B-3 10/96

 BADOCPR

BADOCPR (RegCtl)
Type: E:ALPRIOR Bad Output Connection (BADOC) Alarm Priority—Indicates the priority
Lock: Engr of the Bad Output Connection (BADOC) alarm
Default: Low
PtRes: NIM
Range: NoAction
JnlPrint
Printer
Journal
Low
High
Emergncy

Helpful Hint: The value of this parameter can be changed on the Point Detail display with
Engineering keylevel access.

BADOCOPT (RegCtl)
Type: Logical Bad Output Connection Alarm Option (BADOC)—ON indicates that the
Lock: Eng/Pb Bad Output Connection (BADOC) alarm can be generated (or is permitted).
Default: OFF
PtRes: APM
Range: Off (BADOC alarms are suppressed)
On (BADOC alarms are permitted)

Helpful Hint: The value of this parameter can be changed on the Point Detail display with
Engineering keylevel access.

BADPVFL
Type: Logical Bad PV Flag—Indicates that a bad PV value has been detected at this data
Lock: View point. For an analog input, a bad PV is defined as a PV whose value is NaN
Default: Off (Not a Number).
PtRes: APM
Range: Off (PV is not bad)
On (PV is bad)

BADPVFL (Array)
Type: Logical Serial Interface Database Status Flag—This parameter can be set by
Lock: View either an Array point, a Serial Interface IOP, or a Serial Interface FTA-driver
program when the data in the array is not being updated. An example would
be loss of communications between the SI FTA and the field device. When
the EXTDATA parameter = None, BADPVFL is always Off.

Default: On when
EXTDATA = IO_FL,
IO_NN, IO_STR
Off when
EXTDATA = None
PtRes: APM

Range: Off (Data is not bad)

On (Data is bad)

APM Parameter Reference Dictionary B-4 10/96

 BADPVFL

BADPVFL
(DI)
Type: Logical Bad PV Flag—Indicates that a bad PV value has been detected at this data
Lock: View point.
Default: On BADPVFL is shown on the detailed display only when PNTFORM = Full.
PtRes: APM
For a Digital Input, the Bad PV Flag is on when:
• The PV source is not equal to Manual and DITYPE is set to
Accumulator.
• The PV source has just been switched to Substituted but the PV has not
yet been updated.
• The PV source = Substitute or Auto and PTEXECST = Inactive or the
module is not in the RUN state.
• PVSOURCE = Auto and there is no FTA connected or there is a Soft
Fail
that is preventing this chanel from working.

Range: Off (PV is not bad)

On (PV is bad)

BADPVFL (DevCtl,
DigComp)
Type: Logical Bad PV Flag—For a Digital Composite or Device Control point, the Bad
Lock: View PV Flag is is set to ON when the PV is bad.
Default: Off
PtRes: APM
Range: Off (PV is not bad)
On (PV is bad)

BADPVPR
Type: E:ALPRIOR Bad PV Alarm Priority—Defines the priority of the bad PV alarm.
Lock: Engr
Default: Low
PtRes: NIM
Range: Emergncy (Alarm is historized, annunciated, and reported to all alarm summary displays)
High (Alarm is historized, reported to Area Alarm Summary Display and Unit Alarm
Summary
Display)
Low (Alarm is historized, reported to the Unit Alarm Summary Display, and annunciated)
JnlPrint (Alarm is historized and reported to the printer but not annunciated)
Printer (Alarm is reported to the printer but not historized and not annunciated)
Journal (Alarm is historized but not reported to Universal Stations and not annunciated)
NoAction (Alarm is not reported to the system and not annunciated)

APM Parameter Reference Dictionary B-5 10/96

 BADPVTXT

BADPVTXT (DevCtl, DigComp,

NIM)
Type: String_8 Bad PV State Descriptor—Defines the state descriptor that is displayed
Lock: PtBld when the digital composite or device control point state is indeterminate or
Default: BAD bad. The bad state can result when the PV input signals from the process
PtRes: NIM are in an inconsistent state (e.g., for a valve, the limit switches indicating
open and closed are on at the same time). This state descriptor is
configured on a per point basis and is valid only when the PVTXTOPT
parameter is On.

Range: The permissible character set for the up to eight character descriptor is as follows:
Alphabetics A-Z (upper case only)
Numerics 0-9,
Underscore (_)

BADSVFL (DevCtl)
Type: Logical Bad SV Alarm Flag—Indicates a bad secondary value alarm.
Lock: View
Default: Off
PtRes: APM
Range: Off (Good data being read)
On (SV parameter = BAD or NaN)

BADSVPR (DevCtl)
Type: E:ALPRIOR Bad SV Alarm Priority—Indicates the alarm priority for the secondary
Lock: Engr value.
Default: Low
PtRes: NIM
Range: JnlPrint (Alarm is historized and reported to the printer but not annunciated)
Printer (Alarm is reported to the printer but not historized and not annunciated)
Emergncy (Alarm is historized, annunciated, and reported to all alarm summary displays)
High (Alarm is historized, reported to Area Alarm Summary Display and Unit Alarm
Summary
Display)
Low (Alarm is historized, reported to the Unit Alarm Summary Display, and annunciated)
Journal (Alarm is historized but not reported to Universal Stations and not annunciated)
NoAction (Alarm is not reported to the system and not annunciated)

BFF (PidFf)
Type: Real Feed Forward Input Bias—Defines the bias value for multiplicative
Lock: Supr action.
Default: 0.0
PtRes: APM
Range: N/A

BHALMFL1–BHALMFL7
Type: String_2 Alarm Flags
Lock: View
Default:
PtRes: NIM
Range: Hexadecimal characters 00 - FF

APM Parameter Reference Dictionary B-6 10/96

 BIAS
BIAS (Pid)
Type: Real Bias—Defines the value which is added to the SP.
Lock: Oper
Default: 0.0
PtRes: APM
Range: BSLOLM to BSHILM

BNDRESET (NIM, APM

Box)
Type: Logical Bounds (Minimum/Maximum) Statistics Reset Flag—A write of ON
Lock: Oper resets the following maximum/minimum statistics to their default values:
Default: Off APM CPU free percentage events, UCN transaction, UCN parameter
PtRes: APM statistics and UCN average statistics.
Range: Off/On

Helpful Hint: A read of BNDRESET always returns OFF.

BNDRSTIM (NIM, APM

Box)
Type: Time Time of Last Bounds (Minimum/Maximum) Statistics Reset.
Lock: View
Default: Time of APM
Startup
PtRes: APM
Range: N/A

Helpful Hint: This statistic can be viewed on the Toolkit Displays.

BOXCLR(0)–(2) (DevCtl,
DigComp)
Type: Box Color for Digital Displays—Defines the color of the upper, middle,
E:BOXCOLO and lower boxes that are used to display the current state of the point on
R the Group and Detail Displays. The lower box and its default (Red) do
Lock: Eng/PB not apply if NOSTATES = 2 for this point.

Default: Green [Upper-

box default (State 1)]
Yellow
[Middle-box default
(State 0)]
Red [Lower-
box default (State 2)]
PtRes: NIM
Range: Red
Green
White
Black
Cyan
Yellow
Blue
Magenta

Helpful Hint: BOXCLR has an access lock of View if PNTFORM = Component.

APM Parameter Reference Dictionary B-7 10/96

 BOXCLR(0)–(1)

BOXCLR(0)–(1) (DigIn, Flag)

Type: Box Color for Digital Displays—Defines the color of the upper and
E:BOXCOLO lower boxes that are used to display the current state of the point on the
R Group and Detail Displays. Boxes are applicable when DITYPE is
Lock: Eng/PB Latched or Status.

Default: Green [Upper

box default color (State
1)]
Yellow
[Lower-box default
color(State 0)]
PtRes: NIM
Range: Red
Green
White
Black
Cyan
Yellow
Blue
Magenta

BSHILM
Type: Real Bias High Limit—Defines the upper limit of the bias.
Lock: Supr
Default: 50.0
PtRes: APM
Range: > BSLOLM,
NaN

Helpful Hint: Entering NaN disables the BSHILM function with NaN being stored in the
database.

BSLOLM
Type: Real Bias Low Limit—Defines the lower limit of the bias.
Lock: Supr
Default: -50.0
PtRes: APM
Range: < BSHILM,
NaN

Helpful Hint: Entering NaN disables the BSLOLM function with NaN being stored in the
database.

APM Parameter Reference Dictionary B-8 10/96

 BYPASS

BYPASS (DevCtl,
DigComp)
Type: Logical Interlock Bypass—Allows bypassing the permissive and override interlocks
Lock: Oper when ON. The Safety Override Interlock (SI0) is not affected. Only applies
Default: Off if Override Option (OROPT) is selected.
PtRes: APM
Range: Off (Interlocks not bypassed)
On (Interlocks bypassed)

BYPASS (ORSel)
Type: Logical Override Input Bypass Enable—Allows the operator to select the bypass
Lock: Oper function for the X1-X4 inputs.
Default: Off
PtRes: APM
Range: Off (Bypass of inputs is not allowed)
On (Bypass of inputs is allowed)

BYPASSX1–BYPASSX4 (ORSel)
Type: Logical Bypass X1–X4 Input—Refer to the APM Control Functions and Algorithms
Lock: Oper manual for a detailed description. BYPASSXn being On does not bypass
X1–X4 unless BYPASS = On.
Default: BYPASSX1 =
Off
BYPASSX2–
X4 = On
PtRes: APM
Range: Off
On

APM Parameter Reference Dictionary B-9 10/96

APM Parameter Reference Dictionary B-10 10/96
 C

-C-

C (FlowComp, Summer, Totalizer, and

VdtLdLg)
Type: Real Scale Factor—Value in C is used in the calculation of PVCALC. Refer to
Lock: Supr the APM Control Functions and Algorithms manual for the equation.
Default: 1.0
PtRes: APM
Range: Anything except NaN

C1–C2 (FlowComp)
Type: Real Correction Constants—Values in C1 and C2 are used in the calculation of
Lock: Supr PVCALC, and serve as factors in compensating for assumed design
Default: 1.0 conditions. Refer to the APM Control Functions and Algorithms manual for a
PtRes: APM detailed description.
Range: C1 > 0.1
C2 > 0.1

C1–C2 (PI)
Type: Real Scaling Constants—Values in C1 and C2 are used in the calculation of
Lock: Supr PVCALC. Refer to the APM Control Functions and Algorithms manual for a
Default: 1.0 detailed description.
PtRes: APM
Range: C1 > 0
C2 > 0

C1–C2
(VdtLdLg)
Type: Real Scaling Constant For Input P1–P2—Values in C1 and C2 are used in the
Lock: Supr calculation of TD (fixed time delay) and TDNEW (calculated new delay
Default: 1.0 time).
PtRes: APM
Range: > 0.0

C1–C4 (Calcultr)
Type: Real Intermediate Results of Calculations
Lock: Supr
Default: N/A
PtRes: APM
Range: N/A

APM Parameter Reference Dictionary C-1 10/96

 C1–C6

C1–C6 (Summer)
Type: Real Scaling Constants 1-6—Defines the scaling constants to be used with the
Lock: Supr respective inputs P1-P6.
Default: 1.0
PtRes: APM
Range: N/A

C1–C4DESC (Logic)
Type: String_8 Custom Alarm Descriptors—Defines the state for each of the four custom
Lock: Engr alarms.
Default: Blank
PtRes: APM
Range: 8 Character String

C1–C4FL (Logic)
Type: Logical Custom Alarm Flags—Defines the state for each of the four custom alarms.
Lock: Program These flags can be written to if C1–C4SRC=None.
Default: Off
PtRes: APM
Range: Off (A custom alarm is not active)
On (A custom alarm is active)

C1–C4PR (Logic)
Type: E:ALPRIOR Custom Alarm Priorities—Defines the alarm priorities for each of the four
Lock: Engr custom alarms.
Default: Low
PtRes: NIM
Range: JnlPrint (Alarm is historized and reported to the printer but not annunciated)
Printer (Alarm is reported to the printer but not historized and not annunciated)
Emergncy (Alarm is historized, annunciated, and reported to all alarm summary displays)
High (Alarm is historized, reported to Area Alarm Summary Display and Unit Alarm
Summary
Display)
Low (Alarm is historized, reported to the Unit Alarm Summary Display, and annunciated)
Journal (Alarm is historized but not reported to Universal Stations and not annunciated)
NoAction (Alarm is not reported to the system and not annunciated)

C1–C4SRC (Logic)
Type: Custom Alarm Source—Indicates the alarm source for each of the four
E:$LGALSR custom alarms.
C
Lock: PtBld
Default: None
PtRes: APM
Range: NONE (No source configured for alarms)
L1..L12 (Alarm source is the configured input connection; they can be either On or Off)
SO1..SO24 (Alarm source is the status output (SOn) from another logic block)
FL1..FL12 (Alarm source is a local flag; they can be either On or Off)

APM Parameter Reference Dictionary C-2 10/96

 CABLESTS

CABLESTS (NIM)
Type: Integer Overall Cable Status for a UCN Node
Lock: View
Default: N/A
PtRes: NIM
Range: 0-(Both cables are OK)
1-(Cable A has failed)
2-(Cable B has failed)
3-(Both cables have failed)

CALCEXP (Calcultr)
Type: String_40 Calculator Expression—Allows the user to set up an equation that can be
Lock: Eng/PB up to 40 characters in length, which is to be solved by the Calcultr
Default: blank algorithm. Input values P1-P6 and intermediate results values C1-C4 can be
PtRes: APM used in the equation.
Range: N/A

CALIBALL (1)–
(168)
Type: Logical Full Calibration Enable Flag
Lock: Eng/PB
Default: Off
PtRes: APM
Range: Off (Card calibration is disabled)
On (Card calibration is enabled)

CALIBRJ (1)–
(168)
Type: Logical Reference Junction Calibration Enable Flag
Lock: Eng/PB
Default: Off
PtRes: APM
Range: Off (Disable Reference Junction calibration)
On (Enable Reference Junction calibration)

APM Parameter Reference Dictionary C-3 10/96

 CASREQ

CASREQ (AnalgOut, RegCtl)

Type: E:CASREQ Remote Cascade Request Flag—Defines whether the remote cascade mode
Lock: Prog has been requested for the data point. The remote cascade mode exists
Default: NotReq when MODE is changed to Cas and RCASOPT is Ddc or DdcRsp. When a
PtRes: APM request to change MODE to Cas is received from a US or a program, MODE
does not immediately change to Cas. Instead, CASREQ is set to Request
and a -C appears to the right of the mode indicator on the Group and Detail
displays. When continuous control in an AM determines that CASREQ
contains Request, it requests the mode to go to Cas, and changes CASREQ
to NotReq.

Should the point shed while it is in the remote cascade mode, MODE goes
to the state defined in SHEDMODE, and CASREQ goes back to Request.

Range: 0-NotReq (Remote cascade mode request not made)

1-Request (Remote cascade mode request made; operator or program has requested the
cascade mode)

Helpful Hint: CASREQ does not apply for an AnalgOut point if RCASOPT = None.
CASREQ does not apply for a RegCtl point unless RCASOPT = Spc, Ddc,
or DdcRsp.
If Spc has been entered for the RCASOPT parameter, the AM writes to the
setpoint.
Ddc is the only remote cascade option for an analog output point.

CHPINHWY (UCN)
Type: E:CHPINDAC Automatic Checkpoint Inhibit
Lock: Supr
Default: Enable
PtRes: NIM
Range: 0-Enable (Enable automatic checkpointing of data bases on this UCN)
1-Inhibit (Inhibit automatic checkpointing)

CHPINOPR (APM Box)

Type: E:CHPINDAC Automatic Checkpoint Inhibit Operation—Defines whether
Lock: Supr automatic
Default: Enable database saves are to be performed for the devices connected to this
PtRes: NIM NIM.
Range: Enable (Automatic database saves are enabled)
Inhibit (Automatic database saves are inhibited)

APM Parameter Reference Dictionary C-4 10/96

 CIDSTN(1)–CIDSTN(4)

CIDSTN(1)–CIDSTN(4) (RegCtl)
Type: Prm_ID Control Input Connection Destination—Defines the parameter name (PV,
Lock: PtBld SP, etc.) in the RegCtl point that is to receive the value fetched using the
Default: Based on "[Link]" or the hardware reference address specified in
CTLALGID, parameter CISRC, Control Input Connection Source.
CTLEQN, N
PtRes: APM
Range: N/A

Helpful Hint: 1. CIDSTN must contain a legitimate parameter of one to eight characters.
2. Default to PV, SP, or some other parameter depends on parameters
CTLALGID, CTLEQN, and M.

CISRC(1)–CISRC(4) (RegCtl)
Type: [Link] Control Input Connection Source—Defines the "[Link]" of
Lock: PtBld the parameter whose value is to be obtained and then stored in one of up to
Default: [Link] four RegCtl algorithm inputs. Refer to the APM Control Functions and
PtRes: APM Algorithms manual for a detailed description.
Range: Use [Link] for tagged points where Tagname can be up to 16 characters, and
the permissible character set is as follows:
Alphabetics A-Z (uppercase only)
Numerics 0-9 (an all numeric tag name is not allowed)
Underscore (_) cannot be used as the first character or the last character, and
consecutive
underscores are not allowed.
Embedded space characters are not allowed.
An * is used to default to this point's tag name.
Parameter name can be up to eight characters and must be a legitimate parameter
name.

CJTACT (STI)
Type: Logical Internal Cold Junction Temperature—Defines whether the smart
Lock: Eng/PtBld temperature transmitter's internal cold-junction reference is to be used, or an
Default: On externally-provided cold-junction reference is to be used.
PtRes: APM
Range: On (Transmitter's internal cold-junction temperature is active)
Off (External cold-junction temperature is active)

CLPZMXC (UCN)
Type: Logical Overall Cable Status for UCN Cable A
Lock: View
Default: N/A
PtRes NIM
Range: Off (Cable A status is OK)
On (Cable A status is not OK)

APM Parameter Reference Dictionary C-5 10/96

 CLPZMXP

CLPZMXP (UCN)
Type: Logical Overall Cable Status for UCN Cable B
Lock: View
Default: N/A
PtRes NIM
Range: Off (Cable B status is OK)
On (Cable B status is not OK)

CMDDISFL (DevCtl, DigComp)

Type: Logical Command Disagree Alarm Flag—Indicates whether a field device did not
Lock: View go to the commanded state within the allowed feedback time.
Default: Off
PtRes: APM
Range: Off (No command disagree alarm)
On (Command disagree alarm has been detected by this point)

Helpful Hint: A slow-responding field device can cause a premature alarm. If so, adjust
the
time in parameter FBTIME.

CMDDISPR (DevCtl,
DigComp)
Type: E:ALPRIOR Command Disagree Alarm Priority—Defines the alarm priority of
Lock: Engr command disagree, command fail, and uncommanded change alarms.
Default: Low
PtRes: NIM
Range Emergncy (Alarm is historized, annunciated, and reported to all alarm summary displays)
High (Alarm is historized, reported to Area Alarm Summary Display and Unit Alarm
Summary
Display)
Low (Alarm is historized, reported to the Unit Alarm Summary Display, and annunciated)
JnlPrint (Alarm is historized and reported to the printer but not annunciated)
Printer (Alarm is reported to the printer but not historized and not annunciated)
Journal (Alarm is historized but not reported to Universal Stations and not annunciated)
NoAction (Alarm is not reported to the system and not annunciated)

CMDFALFL (DevCtl,
DigComp)
Type: Logical Command Fail Alarm Flag—Indicates if the PV failed to move after the
Lock: View output command within the allowed command fail time. Command Fail
Default: Off Alarm priority is determined by CMDDISPR.
PtRes: APM
Range: Off (PV moved after the output command)
On (PV did not move after the output command)

APM Parameter Reference Dictionary C-6 10/96

 CMDFALTM

CMDFALTM (DevCtl,
DigComp)
Type: Integer Command Fail Timeout—Sets the amount of time (in seconds) that
Lock: Supr if the point should wait before generating a “command fail” alarm, if the
CMDFALTM PV has not changed after changing the output. Command Fail Alarm
is changed priority is determined by CMDDISPR.
from
a non-zero
value
to a zero
value,
else Eng/PB
Default: 0
PtRes: APM
Range: 0 to 999 seconds (0 indicates command fail alarming is disabled)

CMDHWREV
Type: String_2 APMM Communications Daughter Card Revision
Lock: View
Default:
PtRes: APM
Range: Hexadecimal characters 00 - FF

CNTLLOCK
Type: E:ACCLVL Control Lock—Attempts to write values in the following parameters are
Lock: Engr subject to the access-lock value contained in CNTLLOCK. The check is
Default: OPERATOR bypassed for the exceptions.
PtRes: APM
Parameter Exceptions
PROCMOD New value = START
SEQEXEC None
SEQMODE None
OVERPHAS SEQEXEC = FAIL or ERROR
OVERSTEP SEQEXEC = FAIL or ERROR
OVERSTAT SEQEXEC = FAIL or ERROR

Range: 0-OPERATOR - Operator and higher keylock positions allow store access.
1-SUPERVIS - Supervisor and higher keylock positions allow store access.
2-ENGINEER - Engineer and higher keylock positions allow store access.
3-PROGRAM - Only the program has store access.

APM Parameter Reference Dictionary C-7 10/96

 CODSTN
CODSTN(1)–CODSTN(4) (RegCtl)
Type: Universal Control Output Connection Destination—Defines up to four different
[Link] "[Link]" or hardware reference address destinations to which
Lock: PtBld the output value from RegCtl point is to be written. Refer to the APM
Default: [Link] Control Functions and Algorithms manual for a detailed description.
PtRes: APM
Range: Use [Link] for tagged points where Tagname can be up to 16 characters, and
the permissible character set is as follows:
Alphabetics A-Z (uppercase only)
Numerics 0-9 (an all numeric tag name is not allowed)
Underscore (_) cannot be used as the first character or the last character, and
consecutive
underscores are not allowed.
Embedded space characters are not allowed.
An * is used to default to this point's tag name.
Parameter name can be up to eight characters and must be a legitimate parameter
name.

Use the hardware reference address ![Link] for untagged or tagged points
where
MT is the IOP type, such as AO (analog output)
mm is the IOP Card number (1-40)
ss is the slot number on the IOP Card (refer to SLOTNUM parameter)
Parameter name can be up to eight characters and must be a legitimate parameter
name.

COMCFAVG (APM
Box)
Type: Real Average APM Communication CPU Free Percentage—The average
Lock: View percent of time the Communications Processor is not busy.
Default: NaN
PtRes: APM
Range: 0 - 100

Helpful Hint: This statistic can be viewed on the Toolkit Displays.

COMCFMAX (APM
Box)
Type: Real Maximum APM Communication CPU Free Percentage—The
Lock: View maximum percent of time the Communications Processor is not busy.
Default: NaN
PtRes: APM
Range: 0 - 100

Helpful Hint: This statistic can be viewed on the Toolkit Displays.

COMCFMIN (APM
Box)
Type: Real Minimum APM Communication CPU Free Percentage—The
Lock: View minimum percent of time the Communications Processor is not busy.
Default: NaN
PtRes: APM
Range: 0 - 100

Helpful Hint: This statistic can be viewed on the Toolkit Displays.

APM Parameter Reference Dictionary C-8 10/96

 COMDAUGH

COMDAUGH
Type: Logical APMM Communications Daughter Card Present Flag.
Lock: View
Default:
PtRes: APM
Range: Off (No daughter card present)
On (Daughter card present)

COMDAY
Type: Integer Creation Day of APMM Communications Personality.
Lock: View
Default: N/A
PtRes: APM
Range: 1 - 31

COMFWREV
Type: String_2 APMM Communications Firmware Revision.
Lock: View
Default:
PtRes: APM
Range: Hexadecimal characters 00 - FF

COMHWREV
Type: String_2 APMM Communications Hardware Revision.
Lock: View
Default:
PtRes: APM
Range: Hexadecimal characters 00 - FF

COMMAND
(DigIn)
Type: Accumulator Commands—Allow the operator to control the
E:COMMAN accumulator.
D
Lock: Oper
Default: None
PtRes: APM
Range: 0-None (No effect on accumulator)
1-Start (Start the accumulator)
2-Stop (Stop the accumulator)
3-Reset (Reset the accumulation to zero)

Helpful Hint: COMMAND applies only when DITYPE = Accum.

APM Parameter Reference Dictionary C-9 10/96

 COMMAND

COMMAND (STI)
Type: Command—Allows the user to do database transfers between the STI point
E:COMMAN and the smart transmitter, and to calibrate the transmitter.
D
Lock: Oper
Default: None
PtRes: APM

NOTE

During an up-load operation, previously unseen data is read from the transmitter
database
and stored in the STI database. If this data is not desired, the data can be restored by
using the checkpoint restore or load IDF functions.

Range: 0-None (A command has not been issued by the STI point)
1-DnLoadDb (Loads the transmitter parameters from the STI point data base into the
transmitter)
2-UpLoadDb (Loads the transmitter data base from the transmitter into the STI point)
3-Set_LRV (Sets the Lower Range Value)
4-Set_URV (Sets the Upper Range Value)
5-Cor_LRV (Corrects the Lower Range Value)
6-Cor_URV (Corrects the Upper Range Value)
7-Cor_Inpt (Corrects the zero point for the PV value)
8-RstCor (Sets all input calibration parameters to their default values)

Helpful Hint: If PV or PV_SV has been entered for the DECONF parameter, the only
command supported is DnLoadDB.

COMMAND (Timer)
Type: Timer Commands—Allow the operator to control the operation of the
E:COMMAN timer data point.
D
Lock: Oper
Default: None
PtRes: APM
Range: 0-None (No effect on the timer)
1-Start (Starts the timer)
2-Stop (Stops the timer)
3-Reset (Resets the timer to zero)
4-RestStrt (Resets the timer, then starts the timer)

COMMAND
(Totalizr)
Type: Totalizer Commands—Allow the operator to control the operation of the
E:COMMAN totalizer.
D
Lock: Oper
Default: None
PtRes: APM
Range: 0-None (No effect on totalizer)
1-Start (Starts the totalizer)
2-Stop (Stops the totalizer)
3-Reset (Resets the totalizer to RESETVAL)

APM Parameter Reference Dictionary C-10 10/96

 COMMONTH

COMMONTH
Type: Integer Creation Month of APMM Communications Personality
Lock: View
Default: N/A
PtRes: APM
Range: 1 - 12

COMNAME
Type: String_8 APMM Communications Personality Name
Lock: View
Default:
PtRes: APM
Range:

COMPHILM (FlowComp)
Type: Real Compensation Term High Limit—Defines the upper limit of the
Lock: Supr COMPTERM (compensation term) parameter.
Default: 1.25
PtRes: APM
Range: COMPLOLM to 10.0,
NaN

Helpful Hint: Entering NaN disables high-limit checking by forcing its value to the
extreme
(10.0).

COMPLOLM (FlowComp)
Type: Real Compensation Term Low Limit—Defines the lower limit of the
Lock: Supr COMPTERM (compensation term) parameter.
Default: 0.8
PtRes: APM
Range: 0.0 to COMPHILM,
NaN

Helpful Hint: Entering NaN disables low-limit checking by forcing its value to the extreme
(0.0).

COMPTERM (FlowComp)
Type: Real Compensation Term—This term differs in each of the five flow
Lock: View compensation equations, A through E. Refer to the APM Control Functions
Default: 1.0 and Algorithms manual for a detailed description.
PtRes: APM
Range: COMPLOLM to COMPHILM

APM Parameter Reference Dictionary C-11 10/96

 COMREV

COM RE V
Type: Integer APMM Communications Software Revision
Lock: View
Default:
PtRes: APM
Range:

COMVERS
Type: Integer APMM Communications Software Version
Lock: View
Default:
PtRes: APM
Range:

COMYEAR
Type: Integer Creation Year of APMM Communications Personality
Lock: View
Default: N/A
PtRes: APM
Range: 0 - 99

CONTCUT
Type: Logical Contact Cut Out —Defines whether alarms detected at this data point are
Lock: Prog to be cut out to prevent this data point's alarms from being reported to the
Default: Off operator. The alarms continue to be reported to the AM or CM through the
PtRes: APM EIPPCODE parameter.

CONTCUT can be used to cutout alarms on a point when the alarms are
generated because of specific conditions at other points which themselves
have alarms. As an example, the user could configure a logic point so that
the logic point would monitor the nuisance alarm conditions and then store
the contact cutout state of this point using an output connection. It can also
be stored by the sequence program in the APM or the AM which could
monitor the process conditions to determine when the alarms have to be
suppressed.

Range: Off (Alarms are not cut out)

On (Alarms are cut out)

Helpful Hint: Cutout alarms behave the same as inhibited alarms; that is, when a point's
contact cutout state is true—
• alarms are not distributed to the US or HM
• return to normal events are not distributed to the US or HM
• EIP events triggered by the alarm condetion are not distributed

For APM Box Flag points, CUTOUT applies to only slots 1–128.

APM Parameter Reference Dictionary C-12 10/96

 COUNTDWN

COUNTDWN (DigIn)
Type: Logical Accumulator Count Down Flag—Determines whether the accumulator is
Lock: Eng/PB to count down or count up.
Default: Off
PtRes: APM
Range: Off (Accumulator is to count up)
On (Accumulator is to count down)

Helpful Hint: COUNTDWN configuration requires DITYPE = Accum.

CPMSGSEC (NIM)
Type: Real Number of Checkpoint Messages—Specifies the Number of Checkpoint
Lock: View Messages per second.
Default: 0
PtRes: NIM
Range: N/A

CPTIMAVG (NIM)
Type: Real Averaage Time to Complete a Checkpoint Request—Specifies the
Lock: View Average Time (in msec.) to Complete a Checkpoint Request.
Default: 0
PtRes: NIM
Range: N/A

APM Parameter Reference Dictionary C-13 10/96

 CPTIMMAX

CPTIMMAX (NIM)
Type: Real Maximum Time to Complete a Checkpoint Request—Specifies the
Lock: View Maximum Time (in msec.) to Complete a Checkpoint Request.
Default: 0
PtRes: NIM
Range: N/A

CRIOLORN (1)–(4) (APM

Box)
Type: Integer Current Hour IOL Fetch/Store Overrun Counter—A counter that
Lock: View accumulates and shows the number of I/O Link fetch/store time outs that
Default: 0 have occurred during the current hour. In arrays 1 through 4, the counter is
PtRes: APM indexed by the cycle. In array 0, the counter is totaled for all cycles.
Range: >0

CRPPXORN (0)–(8) (APM

Box)
Type: Integer Current Hour Point Processing Overrun Counter—A counter that
Lock: View accumulates and shows the number of APMM point processing overruns that
Default: 0 have occurred during the current hour. In arrays 1 through 8, the counter is
PtRes: APM indexed by the cycle. In array 0, the counter is totaled for all cycles.
Range: >0

CRUCNORN (APM Box)

Type: Integer Current-Hour UCN Access Overruns—Indicates the number of UCN
Lock: View access overruns that have occurred in the current hour. Refer to the APM
Default: 0 Control Functions and Algorithms manual for a detailed description of
PtRes: APM overrun handling.
Range: >0

CTLACTN
Type: E:POLARITY Control Action—Defines the direct/reverse action of this algorithm's
Lock: Eng/PB output.
Default: Reverse
PtRes: APM
Range: 0-Direct (As PV increases, output increases)
1-Reverse (As PV increases, output decreases)

APM Parameter Reference Dictionary C-14 10/96

 CTLALGID

CTLALGID (RegCtl)
Type: Control Algorithm Identifier—Defines the algorithm that is to be
E:$PMMCTA used for this RegCtl point.
L
Lock: PtBld
Default: Null
PtRes: APM
Range: 0-Null (No algorithm selected)
1-Pid (Proportional, Integral, Derivative)
2-PidFf (PID with Feedforward)
3-PidErfb (PID with External Reset Feedback)
7-RatioCtl (Ratio Control)
8-RampSoak (Ramp Soak)
9-AutoMan (Auto Manual Station)
10-IncrSum (Incremental Summer)
11-Switch (Switch)
12-ORSel (Override Selector)
13-PosProp (Position Proportional)
14-PIDPosProp (PID with Position Proportional output)

CTLCFAVG (APM
Box)
Type: Real Average APM Control Processor CPU Free Percentage—The average
Lock: View percent of time the APM Control Processor is not busy.
Default: NaN
PtRes: APM
Range: 0 - 100

Helpful Hint: This statistic can be viewed on the Toolkit Displays

CTLCFMAX (APM
Box)
Type: Real Maximum APM Control Processor CPU Free Percentage—The
Lock: View maximum percent of time the APM Control Processor is not busy.
Default: NaN
PtRes: APM
Range: 0 - 100

Helpful Hint: This statistic can be viewed on the Toolkit Displays.

CTLCFMIN (APM
Box)
Type: Real Minimum APM Control Processor CPU Free Percentage—The
Lock: View minimum percent of time the APM Control Processor is not busy.
Default: NaN
PtRes: APM
Range: 0 - 100

Helpful Hint: This statistic can be viewed on the Toolkit Displays.

APM Parameter Reference Dictionary C-15 10/96

 CTLDAY

CTLDAY
Type: Integer Creation Day of APMM Control Personality
Lock: View
Default: N/A
PtRes: APM
Range: 1 - 31

CTLEQN
(AutoMan)
Type: E:ALGOEQN Control Equation Type
Lock: Eng/PB
Default: EqA
PtRes: APM
Range: 0-EqA (CV = X1 + B +BI)
1-EqB (CV = X1 + (K*X2) + BI)

CTLEQN
(ORSel)
Type: E:ALGOEQN Control Equation Type—Defines whether the highest or the lowest
Lock: PtBld input is to be selected.
Default: EqA
PtRes: APM
Range: 0-EqA (Selects the highest input)
1-EqB (Selects the lowest input)

CTLEQN (Pid)
Type: E:ALGOEQN Control Equation Type—Defines how Proportional (P) or gain,
Lock: PtBld Integral (I) or reset, and Derivative (D) action is applied to a PID-type
Default: EqA algorithm's calculated Error (PV - SP).
PtRes: APM
Range: 0-EqA (P, I, and D act on Error)
1-EqB (P and I act on Error, D acts on PV)
2-EqC (I acts on Error, P and D act on PV)
3-EqD (Integral-only control)

CTLEQN
(Switch)
Type: E:ALGOEQN Control Equation Type—Defines whether the operator, the user-written
Lock: Eng/PB program, or the logic slot controls the selection of one of the four inputs
Default: EqA (X1-X4) as the input to this algorithm.
PtRes: APM
Range: 0-EqA (Operator controls switch position)
1-EqB (Program or logic point controls switch position)

APM Parameter Reference Dictionary C-16 10/96

 CTLFWREV

CTLFWREV
Type: String_2 APMM Control Firmware Revision
Lock: View
Default: N/A
PtRes: APM
Range: Hexadecimal characters 00 - FF

CTLHWREV
Type: String_2 APMM Control Hardware Revision
Lock: View
Default: N/A
PtRes: APM
Range: Hexadecimal characters 00 - FF

CTLMONTH
Type: Integer Creation Month of APMM Control Personality
Lock: View
Default: N/A
PtRes: APM
Range: 1 - 12

CTLNAME
Type: String_8 APMM Control Personality Name
Lock: View
Default: N/A
PtRes: APM
Range:

CTLOPT (APM Box)

Type: Logical APMM Control Processor Option
Lock: PtBld
Default: On
PtRes: APM
Range: On (All point types can be configured)
Off (DigComp, Logic, RegCtl, or RegPV points cannot be configured; only I/O points can be
configured. This usually means that the control processor hardware is missing from the
APM).

APM Parameter Reference Dictionary C-17 10/96

 CTLREDUN

CTLREDUN
Type: Logical APMM Control Redundancy Present Flag
Lock: View
Default:
PtRes: APM
Range: Off
On

CTLREV
Type: Integer APMM Control Personality Revision
Lock: View
Default:
PtRes: APM
Range:

CTLVERS
Type: Integer APMM Control Personality Version
Lock: View
Default:
PtRes: APM
Range:

CTLYEAR
Type: Integer Creation Year of APMM Control Personality
Lock: View
Default: N/A
PtRes: APM
Range: 0 - 99

CTRLINIT (RegCtl)
Type: Logical Control Initialization Request Flag—A user-written program or a logic slot
Lock: Prog can cause a data point to initialize by setting the point's control
Default: Off initialization-request flag to On.
PtRes: APM
Range: Off
On

APM Parameter Reference Dictionary C-18 10/96

 CURCOMFL

CURCOMFL
Type: Current APMM Communications Board Failure
E:$PMMHFS
T
Lock: View
Default:
PtRes: APM
Range: Null (Unknown Error)
Pwrdwn (Power Down )
Lr_Par (Parity Error)
Lr_Lram (Local Ram Error)
Lr_Ck (Local Ram Check)
Lr_Exc (Local Ram Exception)
Lr_Hrev (Local Ram Hardware Revision)
Mm_Hrev (Memory Board Hardware Revision)
Lr_Tmr (Local Ram Timer Error)
Lr_Ptrn (Local Ram Pattern Check Error)
Lr_Byte (Local Ram Byte Error)
Lr_Adcd (Local Ram Address Decode Test)
Lr_Addl (Local Ram Additional Check)
Lr_Clrr (Local Ram Scrub Incomplete)
Sr_Par (Shared Ram Parity)
Sr_Ptrn (Shared Ram Pattern Check Error)
Sr_Adcd (Shared Ram Address Decode Test)
Sr_Addl (Shared Ram Additional Checks)
Gr_Par (Global Ram Parity)
Gr_Ptrn (Global Ram Pattern Check Error)
Gr_Byte (Global Ram Byte Error)
Gr_Adcd (Global Ram Address Decode Test)
Gr_Addl (Global Ram Additional Checks)
Gr_Clrr (Global Ram Scrub Incomplete)
31_Nr (IOL Processor, No Response or Failure)
31_Aliv (IOL Processor, Transmitter Not Alive)
31_Iltn (IOL Processor, Illegal Transition)
Nmi_Unk (Unknown NMI Request)
Baducnn (UCN Address Parity or Duplicate Address)
Nr (No Response From Other Processor)
Mrft (Memory Reference Table (Pattern Build Fail)
Nomtos (No MTOS Readout)
Llc_Comm (LLC Communication Fatal Error)
Ucndrv (UCN Driver, Fatal Error)
Rd_Hrev (Redundancy Card Version/Revision Mismatch)
Sw_Error (Software Error)
Md_Hrev (Modem Card Version/Revision Mismatch)
Da_Ptrn (Daughter Card Pattern Test)
Da_Byte (Daughter Card Byte Write Test)
Da_Adcd (Daughter Card Address Decode)
Da_Addl (Daughter Card Additional Test)
Da_Clrr (Daughter Card Scrub Incomplete)
Rd_Snps (Redundancy Card 96 Kw Snapshot Error)
Rd_Bslk (Redundancy Card Bus Lock Fail)

APM Parameter Reference Dictionary C-19 10/96

 CURCTLFL

CURCTLFL
Type: Current APMM Control Failure
E:$PMMHFS
T
Lock: View
Default:
PtRes: APM
Range: Null (Unknown Error)
Pwrdwn (Power Down )
Lr_Par (Parity Error)
Lr_Lram (Local Ram Error)
Lr_Ck (Local Ram Check)
Lr_Exc (Local Ram Exception )
Lr_Hrev (Local Ram Hardware Revision)
Mm_Hrev (Memory Board Hardware Revision)
Lr_Tmr (Local Ram Timer Error)
Lr_Ptrn (Local Ram Pattern Check Error)
Lr_Byte (Local Ram Byte Error)
Lr_Adcd (Local Ram Address Decode Test)
Lr_Addl (Local Ram Additional Checks)
Lr_Clrr (Local Ram Scrub Incomplete)
Sr_Par (Shared Ram Parity)
Sr_Ptrn (Shared Ram Pattern Check Error)
Sr_Adcd (Shared Ram Address Decode Test)
Sr_Addl (Shared Ram Additional Checks)
Gr_Par (Global Ram Parity)
Gr_Ptrn (Global Ram Pattern Check Error)
Gr_Byte (Global Ram Byte Error)
Gr_Adcd (Global Ram Address Decode Test)
Gr_Addl (Global Ram Additional Checks)
Gr_Clrr (Global Ram Scrub Incomplete)
31_Nr (IOL Processor, No Response or Failure)
31_Aliv (IOL Processor, Transmitter Not Alive)
31_Ilatn (IOL Processor, Illegal Transition)
Nmi_Unk (Unknown NMI Request)
Baducnn (UCN Address Parity or Duplicate Address)
Nr (No Response From Other Processor)
Mrft (Memory Reference Table - Pattern Build Fail)
Nomtos (No MTOS Readout)
Llc_Comm (LLC Communication Fatal Error)
Ucndrv (UCN Driver, Fatal Error)
Rd_Hrev (Redundancy Card Version/Revision Mismatch)
Sw_Error (Software Error)
Md_Hrev (Modem Card Version/Revision Mismatch)
Da_Ptrn (Daughter Card Pattern Test )
Da_Byte (Daughter Card Byte Write Test )
Da_Adcd (Daughter Card Address Decode)
Da_Addl (Daughter Card Additional Tests)
Da_Clrr (Daughter Card Scrub Incomplete)
Rd_Snps (Redundancy Card 96 Kw Snapshot Error)
Rd_Bslk (Redundancy Card Bus Lock Fail)

APM Parameter Reference Dictionary C-20 10/96

 CURIOLFL

CURIOLFL
Type: E:$IOMHF Current APMM IOL Interface Failure
Lock: View
Default:
PtRes: APM
Range: Unknown - (Unknown Error)
Powerdwn - (Power Is Off)
Invprgex (Invalid Program Execution)
Epromerr (EPROM Error)
Ramcnter (Ram Contents Error)
Ramadrer (Ram Address Error)
Dpaerror (Device Physical Address Error)
Dsaerror (Device Soft Address Error)
Rxbufofl (Receive Buffer Overflow Error)
Ioljaber (IOL Jabber Error; Module saw or talked too much on link)
Badpgjmp (Bad Program Jump)
Adcincmp (A/D Incompatible)
Adoutovf (A/D Overflow)
Adoutudf (A/D Underflow)
Adccaler (A/D Calibration Error)
Baddcltc (Bad DC LTC)
Dmt_tmot (Deadman Time Out)
Mltoutfl (Multiple Output Failure)
Datbusfl (Data Bus Failure)
Baddarng (Bad A/D Range)
Mstrtmot (Master Timeout)
Ctrcktfl (Counter Circuit Failure)

CURPINAM (n)
Type: String_8 Current PI Filename—Defines the personality Image filename that
Lock: View currently resides in this IOP whenre n is the IOP number 1 - 40.
Default: N/A
PtRes: IOP
Range: N/A

CURSEGID (RampSoak)
Type: E:CURSEGID Current Segment ID—Defines the current ramp or soak segment.
Lock: Oper
Default: Ramp1
PtRes: APM
Range: 0-Ramp1 1-Soak1
2-Ramp2 3-Soak2
: and :
20-Ramp11 21-Soak11
22-Ramp12 23-Soak12

APM Parameter Reference Dictionary C-21 10/96

 CUTOFFLM

CUTOFFLM (Totalizr)
Type: Real Zero-Flow Cutoff Limit—Allows the user to specify a cutoff limit such that
Lock: Supr when the value of input parameter P1 falls below the limit specified, its
Default: 0.0 value is replaced by 0.0.
PtRes: APM
Range: > 0.0,
NaN (Cutoff limit is not applicable)

CUTOFFLM (VdtLdLag)
Type: Real Zero-Flow/Belt-Speed Cutoff Limit—Allows the user to specify a cutoff
Lock: Supr limit for equations C and D.
Default: NaN
PtRes: APM
Range: > 0.0,
NaN (Bypasses the limit check)

CV
Type: Real Calculated Variable—The result (calculated value) of the calculation of
Lock: Prog the control algorithm. The value can be in percent or in engineering units
Default: NaN depending on the control algorithm.
PtRes: APM
Range: N/A

CVEUHI
Type: Real Calculated Value's High Limit in Engineering Units
Lock: Engr
Default: 100.0
(GPM,
PPH, etc.)
PtRes: APM
Range: > CVEULO

Helpful Hint: CV ranges track X-input ranges if CTLALGID = AutoMan, ORSel, IncrSum,
or Switch. For CTLALGID = PidErfb and RampSoak, CV ranges are
configurable. For CTLALGID = Pid, Pidff, and RatioCtl, if NOCOPTS = 0,
then the CV ranges are configurable, otherwise, the CV ranges track the
ranges of the secondary output connection.

CVEULO
Type: Real Calculated Value's Low Limit in Engineering Units
Lock: Engr
Default: 0.0 (GPM,
PPH, etc.)
PtRes: APM
Range: < CVEUHI

Helpful Hint: Same as above for CVEUHI.

APM Parameter Reference Dictionary C-22 10/96

 CYCLEOPT

CYCLEOPT (RampSoak)
Type: Ramp/Soak Cycle Option—Defines whether the ramp/soak cycle stops
E:$CYCLOP after a single cycle, or is continuous. For detailed information, refer to
T the APM Control Functions and Algorithms manual.
Lock: Oper
Default: Cyclic
PtRes: APM
Range: 0-Single (Stop after completing one complete cycle)
1-Cyclic (Repeat complete cycles over and over)

Helpful Hint: If Cyclic is entered, repeats complete ramp/soak cycles after Mode is
changed from Man to Auto. If Single is entered, performs one ramp/soak cycle and
then stops.

CYCLETIM (PosProp, PIDPosPr)

Type: Real PosProp Output Cycle Time in Seconds—Determines the rate at which
Lock: Supr raise or lower output pulses are going to be generated. PV - SP determines
Default: 10.0 seconds the width of the output pulse.
PtRes: APM

Range: 0.25 to 1000.0 seconds

APM Parameter Reference Dictionary C-23 10/96

APM Parameter Reference Dictionary C-24 10/96
 D

-D-

D (Summer, VdtLdLag)
Type: Real Overall Bias—Defines the overall bias used in calculating PVCALC.
Lock: Supr
Default: 0.0
PtRes: APM
Range: N/A

D1 (VdtLdLag)
Type: Real Fixed Deadtime in Minutes—Bias value for the variable time delay.
Lock: Supr
Default: 0.0 minutes
PtRes: APM
Range: 0.0 to 400.0 minutes

D1, D2 (DigComp, DevCtl)

Type: Logical Digital Input 1 Status and Digital Input 2 Status—Separately indicates
Lock: View whether input 1 and input 2 are on or off.
Default: Off
PtRes: APM
Range: Off (No input present)
On (Input is present)

D1_0 (DigComp,
DevCtl)
Type: E:$PVSTATS Digital Input 1 Equal to A PV State of 0—Defines the PV state that
Lock: View corresponds to input D1 = Off. D1_0 = true only if INPTDIR = Direct and
Default: PVState0 the field contact feeding D1 is open, or INPTDIR = Reverse and contact is
PtRes: APM cleared.
Range: 0-PVState0 (STATETXT(0) describes D1 = 0)
1-PVState1 (STATETXT(1) describes D1 = 0)

Helpful Hint: Applies only if NODINPTS = 1. D1_0 is always the opposite state of D1_1.

D1_1 (DigComp,
DevCtl)
Type: E:$PVSTATS Digital Input 1 Equals A PV State of 1—D1_1 defines the PV state that
Lock: Eng/PB corresponds to D1 (Input 1 status) = On. D1_1 = true only if INPTDIR =
Default: PVState1 Direct and the field contact feeding D1 is closed, or INPDIR = Reverse
PtRes: APM and contact is open.
Range: 0-PVState0 (STATETXT(0) describes D1 = 1)
1-PVState1 (STATETXT(1) describes D1 = 1)

Helpful Hint: D1_1, Digital Input 1 Equal To A PV State Of 1, applies only if NODINPTS
=
1. D1_1 is always the opposite state of D1_0 and vice versa.

APM Parameter Reference Dictionary D-1 10/96

 D2

D2 (VdtLdLag)
Type: Real Bias for Input P2
Lock: Supr
Default: 0.0
PtRes: APM
Range: > 0.0

D2D1_00 (DigComp, DevCtl)

Type: E:$PVSTATS D2_D1 Zero_Zero PV State—Defines the PV state descriptor that is to
Lock: Eng/PB be used and displayed when inputs D2 and D1 are both Off (00).
Default: MovPV
PtRes: APM
Range: 0-PVState0 (STATETXT(0) descriptor)
1-PVState1 (STATETXT(1) descriptor)
2-BadPV (BADPVTXT descriptor)
3-MovPV (MOVPVTXT descriptor)
4-PVState2 (STATETXT(2) descriptor)

Helpful Hint: D2D1_00 configuration requires NODINPTS = 2. Option PVState2 cannot

be selected unless NOSTATES = 3. STATETXT(0–2) is configured for each
DigComp or DevCtl point; BADPVTXT and MOVPVTXT are configured
during Box Data Point configuration for all DigComp or DevCtl points in this
box.

D2D1_01 (DigComp, DevCtl)

Type: E:$PVSTATS D2D1 Zero_One PV State—Defines the PV state descriptor that is to be
Lock: Eng/PB used and displayed when input D2 is Off and input D1 is On (01).
Default: PVState1
PtRes: APM
Range: 0-PVState0 (STATETXT(0) descriptor)
1-PVState1 (STATETXT(1) descriptor)
2-BadPV (BADPVTXT descriptor)
3-MovPV (MOVPVTXT descriptor)
4-PVState2 (STATETXT(2) descriptor)

Helpful Hint: D2D1_01 configuration requires NODINPTS = 2. Option PVState2 cannot

be
specified unless NOSTATES =3. STATETXT(0–2) is configured for each
DigComp or DevCtl tag name; BADPVTXT and MOVPVTXT are configured
during Box Data Point configuration for all DigComp or DevCtl points in the
box.

APM Parameter Reference Dictionary D-2 10/96

 D2D1_10

D2D1_10 (DigComp, DevCtl)

Type: E:$PVSTATS D2D1 One_Zero PV State—Defines the PV state descriptor that is to be
Lock: Eng/PB used and displayed when input D2 is On and input D1 is Off (10).
Default: PVState0
PtRes: APM
Range: 0-PVState0 (STATETXT(0) descriptor)
1-PVState1 (STATETXT(1) descriptor)
2-BadPV (BADPVTXT descriptor)
3-MovPV (MOVPVTXT descriptor)
4-PVState2 (STATETXT(2) descriptor)

Helpful Hint: D2D1_10 configuration requires NODINPTS = 2. Option PVState2 cannot

be
specified unless NOSTATES = 3. STATETXT(0–2) is configured for each
DigComp or DevCtl point; BADPVTXT and MOVPVTXT are configured
during Box Data Point configuration for all DigComp or DevCtl points in the
box.

D2D1_11 (DigComp, DevCtl)

Type: E:$PVSTATS D2D1 One_One PV State—Defines the PV state descriptor that is to be
Lock: Eng/PB used and displayed when inputs D2 and D1 are both On (11).
Default: BadPV
PtRes: APM
Range: 0-PVState0 (STATETXT(0) descriptor)
1-PVState1 (STATETXT(1) descriptor)
2-BadPV (BADPVTXT descriptor)
3-MovPV (MOVPVTXT descriptor)
4-PVState2 (STATETXT(2) descriptor)

Helpful Hint: D2D1_11 configuration requires NODINPTS = 2. Option PVState2 cannot

be
specified unless NOSTATES = 3. STATETXT(0–2) is configured for each
DigComp or DevCtl point; BADPVTXT and MOVPVTXT are configured
during Box Data Point configuration for all DigComp or DevCtl points in the
box.

APM Parameter Reference Dictionary D-3 10/96

 DAMPING

DAMPING (STI)
Type: Real Damping—Defines the first-order PV filtering option for the smart
Lock: Supr/View transmitter. User can also implement PV filtering by using this parameter or
Default: 0.0 the TF parameter; however, DAMPING is the preferred parameter. If
PtRes: APM DAMPING has been configured at the transmitter using the Universal
Station, the STI IOP adjusts the entered value to one of the values in the
range shown below for the appropriate transmitter type. For Multivariable
transmitters with SENSRTYP = SFM the IOP will not adjust the damping
value.

Any real number in the range of damping specified by the transmitter user
manual can be used. It can be changed only when the STI point execution
state PTEXECST is Inactive.
Range:
Transmitter Type
Spt Stt Sfm

0.0 0.0 0.0

0.16 0.30 0.5
0.32 0.70 1.0
0.48 1.5 2.0
1.00 3.10 3.0
2.0 6.3 4.0
4.0 12.7 5.0
8.00 25.5 10.0
16.0 51.1 50.0
32.0 102.3 100
NaN NaN NaN

DATE (APM Box)

Type: Time Current Date/Time—Value of the LCN date in the APM.
Lock: View
Default: N/A
PtRes: APM
Range: N/A

DAY (APM Box)

Type: Integer Current Day—Value of the LCN date in the APM.
Lock: View
Default: N/A
PtRes: APM
Range: 1 to 31

DB_VALID(1)–(40) (APM Box)

Type: E:$DBVALID Database Valid—Indicates if the database is valid. The IOP cannot be set
Lock: Engr to RUN unless the database is valid.
Default: Invalid
PtRes: APM
Range: Valid (Database is valid)
Invalid (Database is not valid)

APM Parameter Reference Dictionary D-4 10/96

 DEADBAND

DEADBAND(1)–(24)
(Logic)
Type: Real Deadband Value—Defines the value of the deadband for the specified logic
Lock: Supr block within the logic slot.
Default: 1.0
PtRes: APM
Range: > 0.0

Helpful Hint: DEADBAND requires LOGALGID = EQ, NE, GT, GE, LT, or LE.

DEADBAND
Type: Real Deadband in Percent of Full Scale—Defines the error deadband.
Lock: Supr
Default: 5.0 %
PtRes: APM
Range: 0.0 to 100.0 %

DEADTIME
Type: Real Deadtime (in seconds)—Additional pulse time required to overcome the
Lock: Supr friction in the motor when it begins to move or change direction. It is added
Default: 0.0 to the calculated pulse time except when the pulse that was issued in the
PtRes: APM last cycle time was in the same direction (as the pulse this time), and the
pulse width was equal to CYCLETIM.
Range: 0.0 to 60.0 seconds

DEBOUNCE (DigIn)
Type: Integer Contact Debounce Time in Milliseconds— The length of time an input
Lock: Engr/PB must remain in a new state for it to be declared as a valid event by the
Default: 10 DISOE IOP. Refer to the Absolute Delay Across parameter located in the
milliseconds Digital Input Processor table of the APM Specification and Technical Data.
PtRes: APM
Range: 0 to 50 milliseconds

DECONF (STI)
Type: E:$DECONF Digitally Enhanced Configuration Mode—Defines the contents of the data
Lock: Eng/View that will be sent by the smart transmitter to the STI point.
Default: Pv_Sv_Db The use of Pv_Db and Pv_Sv_Db is recommended because they offer
PtRes: APM database mismatch detection and on-process mismatch recovery.

This parameter can be changed only when the STI point execution state
PTEXECST is Inactive.

Range: 0-Analog (Not Supported)

1-Pv (Transmits only the PV; 4-byte format)
2-Pv_Sv (Transmits the PV and the secondary variable (SV); 4-byte format)
3-PV_Db (Transmits the PV and the transmitter database; 6-byte format)
4-Pv_Sv_Db (Transmits the PV, SV, and the transmitter database; 6-byte format)
Helpful Hint: For the PV_Db and Pv_Sv_Db selections, one byte of the transmitter
database
is transmitted each time the PV is transmitted to the STI IOP.

APM Parameter Reference Dictionary D-5 10/96

 DELCV

DELCV
(IncrSum)
Type: Real Delta CV in Engineering Units—Indicates the calculated change in the
Lock: View CV output value in engineering units.
Default: N/A
PtRes: APM
Range: N/A

DELCV
(Pid)
Type: Real Delta CV in Percent—Indicates the calculated change in the CV output
Lock: View value in percent.
Default: N/A
PtRes: APM
Range: N/A

DEV (RegCtl)
Type: Real Deviation—Indicates the deviation (PV - SP) in engineering units.
Lock: View
Default: N/A
PtRes: APM
Range: N/A

DEVADDR (Array)
Type: Real Serial Link Device Address—Indicates the serial link address of the
Lock: PtBld device containing data.
Default: NaN
PtRes: APM
Range: N/A

DEVHIFL (RegCtl)
Type: Logical Deviation High Alarm Flag—Indicates whether the DEVHITP has been
Lock: View exceeded.
Default: Off
PtRes: APM
Range: Off (No DEVHI alarm)
On (DEVHITP has been exceeded)

APM Parameter Reference Dictionary D-6 10/96

 DEVHIPR

DEVHIPR (RegCtl)
Type: E:ALPRIOR Deviation High Alarm Priority—Defines the priority of the deviation high
Lock: Engr alarm.
Default: Low
PtRes: NIM
Range: JnlPrint (Alarm is historized and reported to the printer but not annunciated)
Printer (Alarm is reported to the printer but not historized and not annunciated)
Emergncy (Alarm is historized, annunciated, and reported to all alarm summary displays)
High (Alarm is historized, reported to Area Alarm Summary Display and Unit Alarm
Summary
Display)
Low (Alarm is historized, reported to the Unit Alarm Summary Display, and annunciated)
Journal (Alarm is historized but not reported to Universal Stations and not annunciated)
NoAction (Alarm is not reported to the system and not annunciated)

DEVHITP (RegCtl)
Type: Real Deviation High Alarm Trip Point—Defines the upper limit for the
Lock: Supr deviation.
Default: NaN
PtRes: APM
Range: > 0.0,
NaN

Helpful Hint: Alarm occurs when the PV is higher than SP + DEVHITP.

DEVLOFL (RegCtl)
Type: Logical Deviation Low Alarm Flag—Indicates whether the DEVLOTP has been
Lock: View exceeded.
Default: Off
PtRes: APM
Range: Off (DEVLOTP has not been exceeded)
On (DEVLOTP has been exceeded)

DEVLOPR (RegCtl)
Type: E:ALPRIOR Deviation Low Alarm Priority—Defines the priority of the deviation low
Lock: Engr alarm.
Default: Low
PtRes: NIM
Range: JnlPrint (Alarm is historized and reported to the printer but not annunciated)
Printer (Alarm is reported to the printer but not historized and not annunciated)
Emergncy (Alarm is historized, annunciated, and reported to all alarm summary displays)
High (Alarm is historized, reported to Area Alarm Summary Display and Unit Alarm
Summary
Display)
Low (Alarm is historized, reported to the Unit Alarm Summary Display, and annunciated)
Journal (Alarm is historized but not reported to Universal Stations and not annunciated)
NoAction (Alarm is not reported to the system and not annunciated)

APM Parameter Reference Dictionary D-7 10/96

 DEVLOTP

DEVLOTP (RegCtl)
Type: Real Deviation Low Alarm Trip Point—Defines the lower limit for the
Lock: Supr deviation.
Default: NaN
PtRes: APM
Range: > 0.0,
NaN

Helpful Hint: Alarm occurs when the PV is lower than SP - DEVLOTP.

DHTIMMAX(1) - (5) (NIM)

Type: Real Maximum Time to Complete a Data Handler Request—Specifies the
Lock: View maximum time to complete a Data Handler request in msec.
Default: 0
PtRes: NIM
Range: N/A

DISP_SIM (APM Box)

Type: Logical Simulation Indicator Display Switch—see also SIM_TXT
Lock: Prog
Default: N/A
PtRes: APMM
Range: Off (Simulation indicator is not required to be displayed
On (Simulation indicator is required to be displayed

APM Parameter Reference Dictionary D-8 10/96

 DISRC(1)–(2)

DISRC(1)–(2) (DigComp, DevCtl)

Type: Universal Digital Composite and Device Control Input-Connection Source—
[Link] Specify the sources whose values are to be fetched and delivered to Digital
Lock: PtBld Composite data point inputs D1 and D2. The source can be specified using
Default: [Link] the "[Link]" format or the hardware reference address format.
PtRes: APM Refer to the APM Control Functions and Algorithms manual for a detailed
description.

Range: Use [Link] format for tagged points where Tagname can be up to 16 characters
and the permissible character set is as follows:
Alphabetics A-Z (uppercase only)
Numerics 0-9 (an all numeric tag name is not allowed)
Underscore (_) cannot be used as the first character or the last character, and
consecutive underscores are not allowed.
Embedded space characters are not allowed.
An * is used to default to this point's tag name.
Parameter name can be up to eight characters, and must be a legitimate parameter
name.

Some possible input-connection sources are

a."DigIn slot [Link]"
b."DigOut slot [Link]"
c."Logic slot [Link](nn)" where nn = 1–24
d."Logic slot [Link](nn)" where nn = 1–12
e."ProcMod slot [Link](nnn)" where nnn = 1–127
f."Box Flag slot [Link]
g."" for a box flag that resides in the same box;
nnnn = 1–16,384
h."$[Link](nnnn)" for a box flag that resides in a different APM box on the
same UCN; hh is the NIM UCN address, xx is the APM box number, and
nnnn = 1–4095

Use the hardware reference address ![Link] for untagged or tagged points
where
MT is the IOP type, such as DI (Digital Input)
mm is the IOP Card number (1–40)
The letter "S" is a constant
ss is the slot number on the IOP Card (refer to SLOTNUM parameter)
Parameter name can be up-to-eight characters and must be a legitimate parameter
name.

DIT Y P E
Type: E:$DITYPE Digital Input Type—Defines the type of digital input point.
Lock: PtBld
Default: Status
PtRes: APM
Range: 0-Status (Point is to be used for alarming and event reporting)
1-Latched (Point is to be used for event reporting)
2-Accum (Point is to be used for accumulating pulses)

APM Parameter Reference Dictionary D-9 10/96

 DLYTIME

DLYTIME
(DigIn)
Type: Integer Delay Time—For an off-normal alarm, defines the time (in seconds) that a
Lock: Supr point
Default: 5 seconds with a previously detected alarm condition is guaranteed to remain in alarm,
PtRes: APM even if the condition clears. If an alarm condition exists when the delay
timer expires, the point is held in alarm.

For a change of state (COS) alarm, if the PV is in the same state when the
delay timer expires, future state changes are immediately alarmed. If the
PV is in the opposite state, a second COS alarm is produced and the delay
timer is restarted.
Range: 0 to 60 seconds

DLYTIME(1)–(24) (Logic)
Type: Real Alarm Delay in Seconds for Logic Block
Lock: Supr
Default: 1 second
PtRes: APM
Range: 1–8000 seconds

Helpful Hint: DLYTIME requires LOGALGID = Pulse, MinPulse, MaxPulse,

OnDelay, OffDelay, or Watchdog.

APM Parameter Reference Dictionary D-10 10/96

 DODSTN

DODSTN(1)–(3) (DigComp, DevCtl)

Type: Universal Digital Composite and Device Control Output-Connection Destination—
[Link] Specifies up to three output connection destinations that are to receive the
Lock: PtBld OP output from this point. The destination can be specified using the
Default: [Link] "[Link]" format or the hardware reference address format.
PtRes: APM Refer to the APM Control Functions and Algorithms manual for a detailed
description.
Range: Use [Link] for tagged points where Tagname can be up to 16 characters and
the permissible character set is as follows:
Alphabetics A-Z (uppercase only)
Numerics 0-9 (an all numeric tag name is not allowed)
Underscore (_) cannot be used as the first character or the last character, and
consecutive underscores are not allowed.
Embedded space characters are not allowed.
An * is used to default to this point's tag name.
Parameter name can be up to eight characters, and must be a legitimate parameter
name.

Some possible output-connection destinations are

a."DigOut slot [Link] or OFFPULSE"
b."DigOut slot [Link]"
c."Logic slot [Link](nn)" where nn = 7–12
d."ProcMod [Link](nnn)" where nnn = 1–127
e."Flag slot [Link]
f."" for a box flag that resides in the same APM box; nnnn = 1–16,384.
g."$[Link](nnnn)" for a box flag that resides in a different APM box on the
same UCN; hh is the NIM UCN address, xx is the APM box number, and
nnnn = 1–4095.

Use the hardware reference address ![Link] for untagged or tagged points
where
MT is the IOP type, such as DO (Digital Output)
mm is the IOP Card number (1–40)
The letter "S" is a constant.
ss is the slot number on the IOP Card (refer to SLOTNUM parameter)
Parameter name can be up to eight characters and must be a legitimate parameter
name.

DOTYPE (DigOut)
Type: E:$DOTYPE Digital Output Type—Determines the type of digital output point.
Lock: PtBld
Default: Status
PtRes: APM
Range: 0-Status (Status output type)
1-Pwm (Pulse Width Modulated output type)

DSA
Type: Integer Device Soft Address—The logical address of an IOP: 1-40 for primary
Lock: View IOPs and 129 - 168 for secondary IOPs.
Default: N/A
PtRes: APM
Range: 1 - 40 for primary IOPs
129 - 168 for secondary IOPs

APM Parameter Reference Dictionary D-11 10/96

APM Parameter Reference Dictionary D-12 10/96
 EIPPCODE

-E-

EIPPCODE
Type: Ent_Id Event-Initiated Processing Point Identifier—Defines the tag name of the
Lock: Engr point in the AM or CM that is to be notified when an event is detected by
Default: Null this point.
PtRes: NIM
Range: Tag name of the data point can be up to 16 characters and the permissible character set is
as follows:
Alphabetics A-Z (uppercase only)
Numerics 0-9 (an all numeric tag name is not allowed)
Underscore (_) cannot be used as the first character or the last character, and consecutive
underscores are not allowed.
Embedded space characters are not allowed.

Helpful Hint: EIPPCODE configuration requires PNTTYPE = DigIn, DigComp, Logic,

Flag or DevCtl and EVTOPT = Eip or Eip_Soe. For APM Box Flag points, this
parameter applies only to slots 1 through 128.

APM Parameter Reference Dictionary E-1 10/96

 ERRCODE

ERRCODE (Array)
Type: String_8 Serial Interface/Serial Link Communication Error Code—When the
Lock: View BADPVFL parameter = ON, this parameter provides additional information
Default: Spaces if initialized by the serial interface FTA driver program.
PtRes: APM
SI Array Point Error Code Values

APM

APM Idle—When the APMM status is IDLE, Array point configuration may
or may not be loaded to the SI IOP.
Iop Comm—When the APMM status is RUN, Array point configuration is
NOT loaded to the SI IOP.

SI IOP

No_FTA—Appears when the power adapter panel is not connected to the

IOP.
FTA_Comm—Appears when the corresponding FTA is not connected to the
power adapter panel, or when communication between the IOP and FTA has
failed.
CFG_Load—Appears when configuration data is downloaded to the FTA.
Mod_Idle—Appears when configuration data is downloaded to the FTA and
the IOP is in IDLE mode, or when the IOP operating state is switched from
RUN to IDLE.

SI IOP FTA Common

Dev Addr—The device address has a configuration error

Data Type—The data type has a configuration error
Startidx—The start index has a configuration error
# Elemnt—A number of elements configuration error has occurred
Config—An application-specific configuration error has occurred
Inv Resp—An invalid field device response has occurred
Parity, Checksum, MsgTmout, ChrTmout—A field device
communication error has occurred
Ex or xx—An exception or other field device error has occurred. The “xx”
error code is specific to the field device
Fac Test—A factory test is in progress
OK—No errors exist

Range: N/A

APM Parameter Reference Dictionary E-2 10/96

 ESWAUTO

ESWAUTO (RegCtl)
Type: Logical External Switching Flag for Automatic Mode—When On, means that this
Lock: Prog point's operating mode has been switched from some mode other than
Default: Off automatic to the automatic mode by an external source.
PtRes: APM
Range: Off
On

ESWCAS (RegCtl)
Type: Logical Eternal Switching Flag for Cascade Mode—When On, means that this
Lock: Prog point's operating mode has been switched from some mode other than
Default: Off cascade to cascade mode, by an external source.
PtRes: APM
Range: Off
On

ESWENBST (RegCtl)
Type: External Mode Switching Enable State—Defines whether external
E:ENBLSTA mode switching is permitted for this point.
T
Lock: Oper
Default: Disable
PtRes: APM
Range: 0-Disable (Does not allow external switching of point's mode)
1-Enable (Allows external switching of point's mode)

Helpful Hint: ESWENBST cannot be changed if parameter SHUTDOWN is On or if

parameter REDTAG is On.

ESWMAN (RegCtl)
Type: Logical External Switching Flag for Manual Mode—When On, means that this
Lock: Prog point's operating mode has been switched from some mode other than the
Default: Off manual mode to the manual mode by an external source.
PtRes: APM
Range: Off
On

APM Parameter Reference Dictionary E-3 10/96

 EUDESC

EUDESC
Type: String_8 Engineering Units Descriptor—An eight-character descriptor that defines
Lock: PtBld the name of the engineering units (EU) that are displayed on the Group and
Default: Blank Detail Displays for this point as shown in Figure N-1 (see NAME). In this
PtRes: NIM figure, LBS/SEC is the engineering unit descriptor.

Range: Permissible character set consists of all characters on the Engineer' s Keyboard. Basically
this set consists of alphabetics A-Z, numerics 0-9, and the following special characters:
space ! % & ' ( ) * + - / : ; > < = ? _ , . $

EUNDESC (1)–
(168)
Type: String_72 IOP Generic Descriptor—Used as additional display text to help the
Lock: View operator diagnose potential problems with the IOP. It is primarily used with
Default: Blanks diagnostic displays.
PtRes: APM
Range: nn = 1-40
specifies one of the 40
acting primaries.
nn = 129-168
specifies one of the 40
acting secondaries.

EVRCINPG
Type: Logical NIM Event Recovery in Progress Flag
Lock: View
Default:
PtRes: APM
Range: Off
On

EVTOPT
(DigComp)
Type: E:$EVTOPT Event Reporting Option—If EVTOPT = Eip and the PV changes or a PV
Lock: PtBld alarm is generated, the AM or CM data point named EIPPCODE is notified
Default: None and a "process special" on that data point takes place.
PtRes: APM
Range: 0-None (Event-Initiated Processing is not allowed)
1-Eip (Process special is triggered in AM/CM)

Helpful Hint: EVTOPT configuration requires NODINPTS > 0.

APM Parameter Reference Dictionary E-4 10/96

 EVTOPT

EVTOPT (DevCtl, DigIn)

Type: E:$EVTOPT Event Reporting Option—If EVTOPT = Eip and the PV changes, the AM
Lock: PtBld or CM data point named EIPPCODE is notified and a "process special" on
Default: None that data takes place. If EVTOPT = Soe and a PV change occurs,
PtRes: APM Sequence Of Events Processing is notified. If EVTOPT = EipSoe, the
actions in both apply.

Range: 0-None (Neither Eip nor Soe is allowed)

1-Eip (Process special is triggered in AM/CM)
2-Eip_Soe (Eip and Soe are both allowed)
3-Soe (Point notifies Sequence of Events Processing)

Helpful Hint: EVTOPT configuration requires DITYPE = Status or Latched. If DITYPE =

Latched, EVTOPT cannot = EIPSOE or SOE.

EXTDATA (Array)
Type: External Data Option—Indicates if either the Array point flags,
E:$EXTDAT numerics, or strings are mapped from a serial interface.
A
Lock: PtBld
Default: None
PtRes: APM
Range: None (None of the flags, numerics, or strings are mapped from a serial interface)
IO_FL (IO flags are mapped from a serial interface)
IO_NN (IO numerics are mapped from a serial interface)
IO_STR (IO strings are mapped from a serial interface)
UCN_FL (Reserved for future use)
UCN_NN (Reserved for future use)
UCN_STR (Reserved for future use)

Helpful Hint: You can map either flags, numerics, or strings from the Serial
Interface to a single Array point.

EXTSWOP
T
Type: External Mode Switching Option—External mode switching is typically
E:EXTSWOP used to establish mode interlocks, or under certain process conditions, to
T restrict the use of a mode that invokes a higher level of control. Refer to
Lock: Eng/PB the APM Control Functions and Algorithms manual for a detailed
Default: None description of external mode switching.
PtRes: APM
Range: 0-None (No external mode switching is allowed)
1-Ems (External source can change point's mode)
2-Emp (Not implemented)

APM Parameter Reference Dictionary E-5 10/96

APM Parameter Reference Dictionary E-6 10/96
 F

-F-

F (FlowComp)
Type: Real Flow Input—Indicates the value of the uncompensated flow input. This
Lock: View input is a square-rooted, differential pressure input.
Default: NaN
PtRes: APM
Range: N/A

FAILCODE
Type: E:IOMHF I/O Processor Hard Fail Status—
Lock: View
Default: N/A
PtRes: IOP

Range: 0-Unknown (Unknown status)

1-PowerDwn(This IOP Powered Down)
2-InvPrgEx(Invalid Program Execution)
3-EpromErr(EPROM Checksum Error)
4-RamCntEr(RAM Contents Error)
5-RamAdrEr(RAM Addressing Error)
6-DpaError(Device Physical Address Error)
7-DsaError(Device Soft Address Error)
8-RxBufOfl(I/O Link Receive Buffer Overflow)
9-IOLJaber(I/O Link Jaber Circuit Failure)
10-
11-BadPgJmp(Illegal Value of Case Control)
12-AdCIncmp(A to D Conversion Incomplete)
13-AdOutOvf(A to D Output Value Overflow)
14-AdOutUdf(A to D Output is less than Zero)
15-AdCCalEr(A to D Calibration is incorrect)
16-BadDcLtc(Bad DC LTC)
17-Dmt_Tmot(Dead Man Timer Timeout)
18-MLtOutFl(Multiple Output Failure)
20-BadDaRng(Bad D to A Range)
21-MstrTmot(Master 68K Timeout)
22-
23-
24-

FAILOPT(1)–(168) (IOP)
Type: E:$FAILOPT Failure Option for Outputs—Defines the state which an AO or DO IOP
Lock: Eng/PB goes into if the IOP itself, or the APMM fails. If the IOP failure is due to
Default: Unpower power loss, outputs go to unpowered regardless of the FAILOPT value.
PtRes: APM When power is restored to the module, outputs are reset regardless of the
FAILOPT values.
Range: 0-Hold (Hold output at last good value)
1-Unpower (Remove power from the output)

APM Parameter Reference Dictionary F-1 10/96

 FBTIME

FBTIME (DevCtl,
DigComp)
Type: Integer Feedback Time—Sets the amount of time (in seconds) that the point
Lock: Supr if should wait before generating a "command disagree" alarm after the operator
CMDFALTM has issued a start/stop-type command to a field device.
is changed
from
a non-zero
value
to a zero
value,
else Eng/PB
Default: 0
PtRes: APM
Range: 0 to 1000 seconds (0 indicates that command disagree alarming is disabled)

Helpful Hint: FBTIME can be increased to compensate for a slow-responding field device
that does not respond to the operator’s command in time to prevent a
command-disagree alarm.

FF (PidFf)
Type: Real Feed Forward Algorithm Input—FF is the feedforward input signal value
Lock: View that is added to (FFOPT = Add) or multiplied by (FFOPT = Multiply) the
Default: N/A PidFf algorithm's incremental output, before the full-value output is
PtRes: APM accumulated. FF is normally a parameter with a percentage value.
Range: N/A

FFOPT (PidFf)
Type: E:FFOPT Feed Forward Type—Determines whether a PidFf algorithm's feedforward
Lock: Eng/PB input signal (FF) is added to or multiplied by the incremental output, before
Default: Multiply the full-value output is accumulated.
PtRes: APM
Range: 0-Add (Scaled Feedforward + Feedback)
1-Multiply (Feedback x Scaled, Biased Feedforward)

FL(i) (Array)
Type: Logical Array Point Flag Variables—The flags are mapped from either the
Lock: Determined APM box (defined by FLSTIX and NFLAG parameters), or from a serial
by interface IOP-connected device (when EXTDATA=IO_FL, mapping is
SPLOCK defined by IOPNUM, FTANUM, DEVADDR, FLSTIX, and NFLAG
parameter parameters).
Default: N/A
PtRes: APM
Range: 1 ≤ i ≤ Array
parameter NFLAG

APM Parameter Reference Dictionary F-2 10/96

 FL

FL(1)–(12) (DevCtl,
Logic)
Type: Logical Logic Slot Flags—Twelve flags, FL(1) to FL(12), are provided for each
Lock: View; FL1- logic slot. The states of flags FL(1) to FL(6) are controlled by the APM
FL5 and cannot be changed by the user. FL(7)-FL(12) are assigned by the
Prog; FL6 user for controlling the path of the logic in the respective logic slot. Refer
Oper; FL7- to the APM Control Functions and Algorithms manual for a detailed
FL12 description
Default: FL2 = On,
rest = Off These flags are local to the logic slot and are different than the 127 flags
PtRes: APM provided with each process module, and the 1023 flags provided in each
APM box.
Range: Off (Flag is off)
On (Flag is set)

FL(1)–(127) (ProcMod)
Type: Logical Local Flag Variables—Each process module in the APM has 127 local
Lock: Determined flags that can be used for implementing batch operations. These flags are
by SPLOCK local to the process module and are different than the 12 logic-slot flags, and
parameter the 1023 flags provided in each APM box.
Default: Off
PtRes: APM
Range: Off (Flag is off)
On (Flag is set)

FL(1)–(16,384) (APM Box)

Type: Logical Box Flag Variables—Each APM box has a set of 16,384 local flag
Lock: Oper variables that can be used by process modules in this APM to implement
Default: Off batch operations. The first 2047 box flags are taggable. These flags are
PtRes: APM local to the APM box and are different than the 12 logic-slot flags, and the
127 flags provided in each process module. The LCN index limit is 4095;
there is no index limit for the UCN. Array points can be used to address
flags with an index greater than 4095.
Range: Off (Flag is off)
On (Flag is set)

Helpful Hint: For the first 128 flags, the On state is alarmed.

FLDESC (Array)
Type: String_64 FL Array Descriptor— Describes FL data for the Array point.
Lock: PtBld
Default: Spaces
PtRes: APM
Range: N/A

APM Parameter Reference Dictionary F-3 10/96

 FLSTIX

FLSTIX (Array)
Type: Real Flag Array Start Index—Defines the flag array start index in Box FL
Lock: PtBld variables or serial interface-connected devices.
Default: 0.0
PtRes: APM
Range: 0 to 99,999 (When EXTDATA = IO_FL, 0 can be a valid device index)
0 to 16,384 (When EXTDATA ≠ IO_FL, 0 indicates that no flags are configured)

FORCE (HiLoAvg)
Type: Logical Forced Input Request Flag—Defines whether the operator, a user-written
Lock: Oper program, or an input connection has requested that an input be used as the
Default: Off forced input for this algorithm.
PtRes: APM
Range: Off (No request to force an input)
On (Request has been made to force an input)

Helpful Hint: FORCE change requires FRCPERM = On.

FRCPERM (HiLoAvg)
Type: Logical Forced Input Permissive—Defines whether an operator or a user-written
Lock: Eng/PB program can force-select an input. FRCPERM must be On before the
Default: Off operator or a program can select an input to be used as a forced input to this
PtRes: APM algorithm.
Range: Off (Forced-selection function is disabled)
On (Forced- selection function is enabled)

FREQ6050(1)–(168)
Type: E:FRQ6050 Frequency 60/50Hz—Defines the 60/50 Hz frequency configuration needed
Lock: Eng/PB for a Low Level AI Mux or STI Temperature Transmitter. For the STI, if a
Default: 60Hz mismatch occurs between this parameter and the transmitter's internal 60
PtRes: APM Hz/50 Hz frequency parameter, a database download from the STI IOP to
Range: 0-60 Hz the transmitter will clear this condition.
1-50 Hz

FRQUTAVG (NIM, APM

Box)
Type: Real Average UCN Fetch Request Trip Time—The average time in
Lock: View milliseconds it takes to receive a response to this node’s UCN fetch
Default: NaN requests.
PtRes: APM
Range: N/A

Helpful Hint: This statistic can be viewed on the Toolkit Displays.

APM Parameter Reference Dictionary F-4 10/96

 FRQUTMAX

FRQUTMAX (NIM, APM

Box)
Type: Real Maximum UCN Fetch Request Trip Time—The maximum time in
Lock: View milliseconds it takes to receive a response to this node’s UCN fetch
Default: NaN requests.
PtRes: APM
Range: N/A

Helpful Hint: This statistic can be viewed on the Toolkit Displays.

FRSPTAVG (NIM, APM

Box)
Type: Real Average UCN Fetch Response Trip Time—The average time in
Lock: View milliseconds for this node to respond to fetch requests from other UCN
Default: NaN nodes.
PtRes: APM
Range: N/A

Helpful Hint: This statistic can be viewed on the Toolkit Displays.

FRSPTMAX (NIM, APM

Box)
Type: Real Maximum UCN Fetch Response Trip Time—The maximum time in
Lock: View milliseconds for this node to respond to fetch requests from other UCN
Default: NaN nodes.
PtRes: APM
Range: N/A

Helpful Hint: This statistic can be viewed on the Toolkit Displays.

FSELIN (HiLoAvg)
Type: E:PINP Force Selected Input—Defines the one of six inputs to be used as the
Lock: Oper/PB forced input to this algorithm.
Default: SelectP1
PtRes: APM
Range: 1-SelectP1 (Input P1 is the forced input)
2-SelectP2 (Input P2 is the forced input)
3-SelectP3 (Input P3 is the forced input)
4-SelectP4 (Input P4 is the forced input)
5-SelectP5 (Input P5 is the forced input)
6-SelectP6 (Input P6 is the forced input)

Helpful Hint: FSELIN change by an operator requires FRCPERM = On.

APM Parameter Reference Dictionary F-5 10/96

 FSTS

FSTS (FlowComp)
Type: E:PVVALST Flow Input Value Status—Indicates the current status of flow input F.
Lock: View
Default: Bad
PtRes: APM
Range: 0-Bad (Value is bad and replaced with NaN)
1-Uncertn (Status of the value is uncertain)
2-Normal (Value is good)

FTA1TYPE, FTA2TYPE (APM

Box)
Type: E:$FTATYPE Type of FTA Connected to the LLMUX IOP—The FTA type applies to
Lock: View both FTA positions (1 and 2). The LLMUX supplies 16 points per FTA for
Default: None a total of 32 points.
PtRes: APM
Range: 0-None
1-TC
2-RTD

FTACONN(1)–(168) (APM Box)

Type: E:$FTACON FTA connection to I/O module file. Indicates which FTA connector is
Lock: View connected to this module. It is primarily used with the diagnostic displays.
Default: CONN_A nn = 1–40 specifies FTA connection for one of the 40 acting primaries. nn =
PtRes: APM 129–168 specifies FTA connection for one of the 40 acting secondaries.
Range: 0-CONN_A (Module is connected to FTA connector A)
1-CONN_B (Module is connected to FTA connector B)

FTANUM (Array)
Type: Integer IOP FTA Number—Indicates the FTA number of the serial interface IOP.
Lock: PtBld
Default: 1
PtRes: APM
Range: 1 to 10

Helpful Hint: Only FTA Numbers 1 and 2 are presently applicable.

FTAPRES(1)–(168)
Type: Logical IOP FTA Present Flag—For primary and secondary IOPs.
Lock: View
Default:
PtRes: APM
Range: Off ( FTA Missing)
On ( FTA Present)

APM Parameter Reference Dictionary F-6 10/96

 G

-G-

G
(FlowComp)
Type: Real Specific Gravity Input—Indicates the value of the measured or calculated
Lock: View specific gravity or molecular weight.
Default: 1.0
PtRes: APM
Range: N/A

GAINOPT (Pid)
Type: E:GAINOPT Gain (K) Option
Lock: Eng/PB
Default: Lin
PtRes: APM
Range: 0-Lin (Applies linear gain, with overall gain (K) = KLIN)

1-Gap (Reduces the sensitivity of control action when the PV is within a narrow band
around the
setpoint. If the PV is outside the gap, overall gain (K) = KLIN. If (SP - GAPLO) < PV
<
(SP + GAPHI), K = KLIN times KGAP)

2-Nonlin (Makes control action proportional to the error (PV - SP) squared with overall
gain (K) =KLIN times KNL, where KNL = NLFM plus (NLGAIN times PV - SP)/100)

3-Ext (Applies external gain. Overall gain (K) = KLIN times KEXT, where KEXT is the
positive external gain modifier)

GAPHI (Pid)
Type: Real Gap High Limit—Defines the upper limit of the gap in the same
Lock: Supr engineering units as the PV.
Default: 0.0
PtRes: APM
Range: > 0.0

GAPLO
(Pid)
Type: Real Gap Low Limit—Defines the bottom limit of the gap in the same
Lock: Supr engineering units as the PV.
Default: 0.0
PtRes: APM
Range: > 0.0

APM Parameter Reference Dictionary G-1 10/96

 GENDESC

GENDESC (1)–(12)
Type: String_8 Generic Descriptors—Define up to 12 generic descriptors that can be
Lock: PtBld assigned to logic-slot parameters. As an example, six descriptors could be
Default: Blanks assigned to six logic-slot inputs, two descriptors to the logic block flags
PtRes: NIM which will describe the current state of the logic slot based on the inputs,
and two descriptors to the SO outputs from the logic slot. Refer to the
description of the PRMDESC parameter, and to the APM Control Functions
and Algorithms manual for a detailed description.
Range: Permissible character set for the eight-character generic descriptors consists of all characters
on the Engineer' s Keyboard. Basically this set consists of alphabetics A-Z, numerics 0-9,
and the following special characters: space ! " % & ' ( ) * + - / : ; > < = ? _ ,
. $

Helpful Hint: Example: GENDESC(7) is the descriptor for parameter PRMDESC(7), etc.

GENDESC(nn)
Type: String_72 Generic Descriptor—Used as additional display text to help the operator
Lock: View diagnose potential problems with the IOP. It is primarily used with
Default: Blanks diagnostic displays.
PtRes: APM nn = 1–40 specifies one of the 40 acting primaries.
nn = 129–168 specifies one of the 40 acting secondaries.

GSTS
Type: E:PVVALST Gravity Input Value Status—Indicates the status of the gravity input
Lock: View value.
Default: Normal
PtRes: APM
Range: 0-Bad (Value is bad and replaced with NaN)
1-Uncertn (Status of the value is uncertain)
2-Normal (Value is good)

APM Parameter Reference Dictionary G-2 10/96

 HIGHAL

-H-

HIGHAL (AnalgIn, RegCtl, RegPV)

Type: E:ALMTYPE Highest Alarm Detected—Indicates the highest alarm currently detected
Lock: View at the data point. This parameter is used by the system to ensure that
Default: NoAlarm when two or more different types of alarms occur on a point at the same
PtRes: NIM time, the most important or highest level alarm appears on the point's
Group, Detail, and Alarm Summary displays. For example, if both the PV
High High and PV Hi alarm priorities are set to Emergency, and both are
in alarm, HIGHAL contains the PVHH value.
Range: NoAlarm (No alarm exists—lowest level alarm)
AdvDev (Advisory Deviation)
DevHi (Deviation High)
DevLo (Deviation Low)
PVRocN (PV Rate Of Change Negative)
PVRocP (PV Rate Of Change Positive)
PVHi (PV High)
PVHH (PV High High)
PVLo (PV Low)
PVLL (PV Low Low)
BadCtl (Bad Control)
BadPV (Bad PV—highest level alarm)
BOC (Bad Output Alarm)

HIGHAL (DevCtl, DigComp, DigIn, Flag, Logic)

Type: E:ALMTYPE Highest Alarm Detected—Indicates the highest alarm currently detected
Lock: View at the data point. This parameter is used by the system to ensure that
Default: NoAlarm when two or more different types of alarms occur on a point at the same
PtRes: NIM time, the most important or highest level alarm appears on the point's
Group, Detail, and Alarm Summary displays.
Range: NoAlarm (No alarm has been detected)
OffNorm (Current PV state is not the configured PVNORMAL state. For a flag point, the
off-normal state (STATE1) is the alarmed state.)
UnCEvt (Uncertain event was detected. Does not apply to a flag point.)
CmdDis (Command Disagree; field device did not respond to commanded output state.
Does not apply to a flag point.)
BadPV (PV is bad)
C1 - C4ALM (1 to 4 custom logic alarms)
Chngofst (State has changed)
Cmdfail (PV failed to change after OP changed)
SVHI (SECVAR>SVHITP)
SVHH (SECVAR>SVHHTP)
BadSV (SECVAR is Bad)
OVRDI2 (Override Interlock I2)
OVRDI1 (Override Interlock I1)
OVRDI0 (Override Interlock I0)
OVRDSI0 (Safety Override Interlock)
BadCtl (Bad Control) (DevCtl and DigComp only)

APM Parameter Reference Dictionary H-1 10/96

 HIGHALPR

HIGHALPR
Type: E:ALPRIOR Highest Level Alarm's Priority—Defines the priority of the highest alarm
Lock: View currently detected at the data point. Associated with HIGHAL
Default: NoAction
PtRes: NIM
Range: Emergncy (Alarm is historized, annunciated, and reported to all alarm summary displays)
High (Alarm is historized, reported to Area Alarm Summary Display and Unit Alarm
Summary
Display)
Low (Alarm is historized, reported to the Unit Alarm Summary Display, and annunciated)
JnlPrint (Alarm is historized and reported to the printer but not annunciated)
Printer (Alarm is reported to the printer but not historized and not annunciated)
Journal (Alarm is historized but not reported to Universal Stations and not annunciated)
NoAction (Alarm is not reported to the system and not annunciated)

HISVPEAK (DevCtl)
Type: Real Highest Peak SECVAR Value—The highest peak value of the SECVAR
Lock: View parameter since the most recent reset of maintenance statistics.
Default: 0.0
PtRes: APM
Range: ≥0

HLCALIB(1)–(168)
Type: Logical HLAI in Calibration Flag—Shows which HLAIs are presently in
Lock: Eng/Pb calibration
Default:
PtRes: APM
Range: Off - Calibration is not in progress
On - Calibration is in progress

HOLDCMD (RampSoak)
Type: Logical Hold Command Flag—If On, allows users to hold the ramp or soak
Lock: Prog segment at its current position to customize the guaranteed ramp and soak
Default: Off function.
PtRes: APM
Range: Off
On

HWYCTLST (UCN)
Type: E:$NODFSTA UCN Network Functional State
Lock: Supr
Default: Basic
PtRes: NIM
Range: Full (All LCN devices can do read/write operations to this UCN)
Basic (AM and CM cannot write to this UCN)

APM Parameter Reference Dictionary H-2 10/96

 I0–2

-I-
I0–2 (DevCtl, DigComp)
Type: Logical Override Interlocks for Output States 0-2—Override interlocks force the
Lock: Engr commanded output to a specific state regardless of the condition of the
Default: Off permissive interlocks or the previous point state. The operator and user
PtRes: APM program cannot change the output state when any override interlock is On.
An override interlock is provided for each of the three states. Refer to the
APM Control Functions and Algorithms manual for a detailed description.
Range: Off (Override interlock has no effect on the point state)
On (Override interlock sets the point to the respective state)

Helpful Hint: 1. When I0 is On, forces the output to STATE0, regardless of the
permissives
or any other overrides.
2. When I1 is On and I0 is Off, forces the output to a STATE1, regardless
of the permissives or any other overrides.
3. When I2 is On and I0 and I1 are both Off, forces the output to STATE2
regardless of the permissives or any other overrides.
4. I0-I2 change by the engineer, requires PTEXECST = InActive
or PNTSTATE = Idle for each interlock.

I0CO NF
(DigComp,DevCtl)
Type: Logical Override Interlock 0 Alarm Confirmation Flag—Indicates that the
Lock: Oper Override Interlock 0 Alarm needs to be confirmed.
Default: Off
PtRes: APM
Range: N/A

I0DESC-I2DESC
(DigComp)
Type: String_8 I0-I2 Alarm Descriptor—The override Interlock for States 0, 1, or 2
Lock: Engr indicating which text should be copied into the OVRDDESC parameter
Default: Blank when an override alarm occurs. The text appears in the Alarm Display and
PtRes: APM can be configured to indicate the cause for the alarm.

Range: 8 Character String

I1CO NF
(DigComp,DevCtl)
Type: Logical Override Interlock 1 Alarm Confirmation Flag—Indicates that the
Lock: Oper Override Interlock 1 Alarm needs to be confirmed.
Default: Off
PtRes: APM
Range: N/A
I2CO NF
(DigComp,DevCtl)
Type: Logical Override Interlock 2 Alarm Confirmation Flag—Indicates that the
Lock: Oper Override Interlock 2 Alarm needs to be confirmed.
Default: Off
PtRes: APM
Range: N/A

APM Parameter Reference Dictionary I-1 10/96

 IN0-12

IN0–12 (GenLin)
Type: Real Input Coordinates 0–12—Define the input value at the respective
Lock: Supr coordinate. IN0 <IN1 <IN2 ......., <IN12
Default: NaN
PtRes: APM
Range: > prev. coord.
< next coord.

INITMAN
Type: Logical Initialization Manual Flag—When On, indicates that this point is in
Lock: View Initialization Manual. The mode of the point does not change; however,
Default: Off INIT appears on the point’s detail or group display to indicate that the point
PtRes: APM is in Initialization Manual. While the point is in Initialization Manual, an
operator, supervisor, or engineer cannot change the point’s output. The
output is indisposable because initialization is being requested from
downstream. Upon leaving Initialization Manual, the point’s output is
initialized from the point’s secondary as determined by the point’s output
connection.

Range: Off (Mode ≠ Initialization Manual)

On (Mode = Initialization Manual)

Helpful Hint: OP changes with Operator, Supervisor, or Engineer access level, requires
MODE = Man and INITMAN = Off. SP changes with Operator, Supervisor, or Engineer
access level, for non-PID algorithms requires MODE = Auto and INITMAN = Off, while for
PID algorithms requires that MODE = Auto, and also that INITMAN = Off and PTEXECST
= Active if PVTRACK = Track.

INITMAN (DigComp, DevCtl, RegCtl)

Type: Logical Initialization Manual Flag—On, indicates that an output is storing to a DO
Lock: View point that has its INITREQ flag set and the point is forced into initialization.
Default: On When the DO point becomes available, the initialization state is cleared.
PtRes: APM
Range: Off (Mode ≠ Initialization Manual)
On (Mode = Initialization Manual)

INITREQ(1)–(4)
(RegCtl)
Type: Logical Initialization Request Flags (1–4)—Indicates whether an initialization
Lock: View request has been made. Each flag represents a request to the primary point
Default: Off pushing to the corresponding input to be initialized as follows:
PtRes: APM Flag 1: SP or X1
Flag 2: RATIO or X2
Flag 3: X3
Flag 4: X4
Range: Off (No initialization request)
On (Initialization request)

APM Parameter Reference Dictionary I-2 10/96

 INITREQ

INITREQ (Array)
Type: Logical Initialization Request Flag—Indicates whether a Serial Interface-connected
Lock: View device can be written to, where OFF = yes, or ON = no. The flag is always
OFF if EXTDATA = None.
Default: On when
EXTDATA = IO_FL,
IO_NN, or IO_STR
Off when
EXTDATA = None
PtRes: APM
Range: Off (EXTDATA=None, or Serial interface-connected device can be written to)
On (Serial interface-connected device cannot be written to)

INITREQ (AO, DO)

Type: Logical Initialization Request Flag—When On, indicates that control strategies in
Lock: View the APM cannot manipulate the output to the field. It is set to ON when:
Default: On
PtRes: APM • the PWM type output is configured
• the point is inactive
• the module is idle
• there is a soft failure such that the channel is not working
• The output is connected to standby-manual device

Range: Off (No initialization request)

On (Initialization request)

INITREQ(0)–(2) (DigComp,
DevCtl)
Type: Logical Initialization Request Flag—When On, indicates that CL programs or logic
Lock: View can not change the output to State(i), where i = 0, 1, or 2.
Default: On
PtRes: APM

Range: Off
On

INITVAL
Type: Real Initialization Value—Indicates the value to which the primary point is to be
Lock: View initialized.
Default: N/A
PtRes: APM
Range: N/A

APM Parameter Reference Dictionary I-3 10/96

 INPTDIR

INPTDIR (AnalgIn)
Type: E:POLARITY Analog Input Direction—Specifies direct or reverse action for the PV
Lock: Eng/PB input at this data point. Direct means PVCALC increases as PVRAW
Default: Direct increases. Reverse means PVCALC decreases as PVRAW increases.
PtRes: APM
Range: 0-Direct (Highest energy from sensor = 100% PV)
1-Reverse (Highest energy from sensor = 0% PV)

Helpful Hint: INPTDIR configuration applies only if PVCHAR = Linear or Sqrroot.

STATE 1
BOX
(Upper)
STATETXT (1)

STATE 0
BOX
(Lower)
STATETXT (0)

PVRAW INPTDIR = INPTDIR =

State Direct Reverse

PV = ON. PV = OFF.
State 1 Box is State 0 Box is
ON lighted. lighted.
State 0 Box is State 1 Box is
extinguished. extinguished.

PV = OFF. PV = ON.
State 0 Box is State 1 Box is
OFF lighted. lighted.
State 1 Box is State 0 Box is
extinguished. extinguished.

Figure I -1 — INPTDIR vs. Display Indicators 2065

APM Parameter Reference Dictionary I-4 10/96

 INPTDIR

INPTDIR
(DigIn)
Type: E:POLARITY Digital Input Direction—Defines the contact conditions required to light
Lock: Eng/PB the upper or lower boxes on a Group or Detail Display for a digital input
Default: Direct point. See Figure I-1.
PtRes: APM

Range: 0-Direct
State 0 (lower) box lighted =>PVRAW = Off
State 1 (upper) box lighted =>PVRAW = On

1-Reverse
State 0 (lower) box lighted =>PVRAW = On
State 1 (upper) box lighted =>PVRAW = Off

IOLASTS (APM Box)

Type: Logical I/O Link Cable A Status
Lock: View
Default: Off
PtRes: APM
Range: Off (I/O Link cable A not in error)
On (I/O Link cable A in error)

IOLBSTS (APM Box)

Type: Logical I/O Link Cable B Status
Lock: View
Default: Off
PtRes: APM
Range: Off (I/O Link cable B not in error)
On (I/O Link cable B in error)

IOLCHAER (APM Box)

Type: Integer I/O Link Channel A Error Count
Lock: View
Default: 0
PtRes: APM
Range: >0

APM Parameter Reference Dictionary I-5 10/96

 IOLCHASL

IOLCHASL (APM Box)

Type: Integer I/O Link Channel A Silence Count
Lock: View
Default: 0
PtRes: APM
Range: >0

IOLCHBER (APM
Box)
Type: Integer I/O Link Channel B Error Count
Lock: View
Default: 0
PtRes: APM
Range: >0

IOLCHBSL (APM Box)

Type: Integer I/O Link Channel B Silence Count
Lock: View
Default: 0
PtRes: APM
Range: >0

IOLCHERT (APM
Box)
Type: Integer I/O Link Channel Error Threshold—Defines the acceptable number of
Lock: EngOnly I/O Link channel errors per minute before disabling the periodic I/O Link
Default: 10 channel swap.
PtRes: APM
Range: >0

IOLCMD (APM Box)

Type: E:$IOLCMD I/O Link Command
Lock: EngOnly
Default: None
PtRes: APM
Range: 0-None (No effect)
1-SelChnA (Select I/O Link Channel A)
2-SelChnB (Select I/O Link Channel B)
3-EnbPerSw (Enable periodic swapping of IOL cables)
4-DisPerSw (Disable periodic swapping of IOL cables)
5-RsIoLCom (Reset IOL communication error count to 0)

APM Parameter Reference Dictionary I-6 10/96

 IOLPERSW

IOLPERSW (APM Box)

Type: I/O Link Periodic Cable Swap
E:ENBLSTA
T
Lock: View
Default: N/A
PtRes: APM
Range: 0-Disable (Swapping of I/O Link cables A & B is disabled)
1-Enable (Swapping of I/O Link cables A & B is enabled)

IOMACTYP(1)–(168)
Type: E:$PMMDTY IOP Actual Type — Actual type of IOP at module
Lock: View address. This should match the configured type.
Default: None
PtRes: APM
Range: None (Not Configured)
LLAI (Low Level Analog Input)
HLAI (High Level Analog Input)
DI (Digital Input)
DO (Digital Output)
AO (Analog Output
APMM (APM Module)
LLMUX (Low Level Analog Multiplexer)
STIM (Smart Transmitter Interface Module)
PI (Pulse Input)

IOMCARD(1)–(168) (APM Box)

Type: Integer I/O module card position for the acting primary/secondary (used for
Lock: View diagnostic displays).
Default: N/A nn = 1 - 40 correspond to card positions of the 40 acting primaries
PtRes: APM nn = 129 - 168 correspond to card positions of the 40 acting secondaries
Range: 1-15

IOMCARDA(1)–(40) (APM Box)

Type: Integer I/O module A card position. 1–40 specifies one of the 40 logical
Lock: PtBld I/O modules. The corresponding IOP must be connected to FTA
Default: 0 in IOP connector A. Applies to the primary IOP only.
database;
per PKGOPT
on GDF
PtRes: APM
Range: 0 - 15 (0 specifies Not Connected)

APM Parameter Reference Dictionary I-7 10/96

 IOMCARDB

IOMCARDB(1)–(40) (APM Box)

Type: Integer I/O module B card position. 1-40 specifies one of the 40 logical
Lock: PtBld I/O modules. The corresponding IOP must be connected to FTA
Default: 0 in IOP connector B. Applies to primary IOP only.
database;
none on GDF
PtRes: APM
Range: 0 - 15 (0 specifies Not Connected)

IOMCHAER(1)–(168)
Type: Integer IOP
Lock: View Channel A
Default: N/A Error
PtRes: APM Count—for
a specific
IOP
Range: 0 - 255

IOMCHASL(1)–(168)
Type: Integer IOP
Lock: View Channel A
Default: N/A Silence
PtRes: APM Count—for
a specific
IOP
Range: 0 - 255

IOMCHBER(1)–(168)
Type: Integer IOP Channel B Error Count—for a specific IOP
Lock: View
Default: N/A
PtRes: APM
Range: 0 - 255

IOMCHBSL(1)–(168)
Type: Integer IOP Channel B Silence Count—for a specific IOP
Lock: View
Default: N/A
PtRes: APM
Range: 0 - 255

APM Parameter Reference Dictionary I-8 10/96

 IOMCMD

IOMCMD (APM Box)

Type: E:$IOMCMD IOP Module Command—Indicates IO module state, or whether to swap
Lock: Oper redundant pairs.
Default: None
PtRes: APM
Range: None
Run
Idle
Swap

IOMCOMER(1)–(168)
Type: IOP Communications Error Status—for a specific
E$:IOMCOM IOP
MIOP
Lock: View
Default: N/A
PtRes: APM

Range: None - No error

Invalert - Invalid alert; message bit problem
Invdest - Invalid destination
Invchcnt - Invalid character count; message corrupted
Invsourc - Invalid source
Invcmd - Invalid command
Checksum - Checksum error
No_resp - No response
Chtimout - Channel time out
Msgovrun- Message overrun
Gaperror - Gap error; message gap too long
Lpbckerr - Loopback error
Nth_0 - Next token holder equals zero
Tknrecov - Token recovery in progress
Rplbufov - Reply buffer overflow

IOMFILE(1)–(168) (APM Box)

Type: Integer I/O Module File Position for the Acting Primary/Secondary
Lock: View (used for diagnostic displays).
Default: N/A nn = 1 - 40 are file positions of the 40 acting primaries.
PtRes: APM nn = 129 - 168 are file positions of the 40 acting secondaries.

Range: 0 - 8 (0 specifies Not Connected)

IOMFILEA(1)–(40) (APM Box)

Type: Integer I/O Module A File Position—1-40 specifies one of the 40 logical
Lock: PtBld I/O modules. The corresponding IOP must be connected to FTA
Default: 0 in IOP data connector A. Applies to the primary IOP only.
base;
per PKGOPT
on GDF
PtRes: APM
Range: 0 - 8 (0 specifies Not Connected)

APM Parameter Reference Dictionary I-9 10/96

 IOMFILEB(1)–(40)

IOMFILEB(1)–(40) (APM Box)

Type: Integer I/O Module B File Position—1-40 specifies one of the 40 logical
Lock: PtBld I/O modules. The corresponding IOP must be connected to FTA
Default: 0 in IOP data connector B. Applies to the primary IOP only.
base;
none on GDF
PtRes: APM
Range: 0 - 8 (0 specifies Not Connected)

IOMFWREV(1)–(168)
Type: Ascii_2 IOP Card Firmware Revision Status
Lock: View (This is not the same as the external letter code on the card)
Default: N/A
PtRes: APM
Range: X.Y X = Version, Y = Revision
(For Release 300, X = 3)

IOMHWREV(1)–(168)
Type: Ascii_2 IOP Card Hardware Revision Status
Lock: View The status of R300 boards appears as $2x, the status of R210
Default: N/A appears as $0x, where x is the version (0=A, 1=B, 2=C, etc.)
PtRes: APM
Range: Hexadecimal characters 00–FF

IOMLHFST(1)–(168)
Type: E:$IOMHF Input/Output Processor Last Hard Fail Status—Refer to the APM Service
Lock: View Manual for a detailed description and the recommended corrective action.
Default: N/A
PtRes: APM
Range: 0-Unknown (Unknown Status)
1-PowerDwn (This IOP Powered Down)
2-InvPrgEx (Invalid Program Execution)
3-EpromErr (EPROM Checksum Error)
4-RamCntEr (RAM Contents Error)
5-RamAdrEr (RAM Addressing Error)
6-DpaError (Device Physical Address Error)
7-DsaError (Device Soft Address Error)
8-RxBufOfl (I/O-Link Receive Buffer Overflow)
9-IOLJaber (I/O-Link Jabber Circuit Failure)
11-BadPgJmp (Illegal Value of Case Control)
12-AdCIncmp (A-to-D Conversion Incomplete)
13-AdOutOvf (A-to-D Output Value Overflow)
14-AdOutUdf (A-to-D Output is less than Zero)
15-AdCCalEr (A-to-D Calibration is incorrect)
16-BadDcLtc (Bad DC LTC)
17-Dmt_Tmot (Dead Man Timer Timeout)
18-MLtOutFl (Multiple Output Failures)
20-BadDaRng (Bad D-to-A Range)
21-MstrTmot (Master 68 k Timeout)

APM Parameter Reference Dictionary I-10 10/96

 IOMNUM

IOMNUM
Type: Integer IOP Number—IOMNUM specifies the IOP on the I/O Link that this point
Lock: PtBld references for its process data.
Default: N/A
PtRes: APM
Range: 1 to 40

IOMOPER(1)–(168) (APM Box,

IOP)
Type: E:$PRIMSEC Input/Output Processor In Operation
Lock: View
Default: N/A
PtRes: APM
Range: 0-Primary (Primary IOP is operating)
1- Secondry (Secondary IOP is operating)

IOMREALT (APM Box)

Type: E:$PMMDTY Actual Input/Output Processor Type
Lock: View
Default: None
PtRes: APM
Range: 0-None (Not Configured)
1-LLAI
2-HLAI (High-Level Analog Input)
3-DI (Digital Input)
4-DO (Digital Output)
5-AO (Analog Output)
7-LLMUX (Low-Level Analog Multiplexer)
14-STIM (Smart Transmitter Interface Module)
17-PI (Pulse Input)

IOMRECHN(1)–(168) (APM Box)

Type: E:$RECCHN IOP Receive Channel
Lock: View
Default: N/A
PtRes: APM
Range: ChannelA
ChannelB

APM Parameter Reference Dictionary I-11 10/96

 IOMSEVER

IOMSEVER(1)–(168) (APM
Box)
Type: E:$SEVERTY Error Severity Based on Input/Output Processor State
Lock: View nn = 1 - 40 specifies the severity of 1 of the 40 acting primaries
Default: N/A nn = 129 - 168 specifies the severity of 1 of the 40 acting secondaries
PtRes: APM
Range: Ok (I/O Processor has no errors and is OK)
Fail (I/O Processor has failed)
Inform (I/O Processor should be calibrated soon)
Warning (I/O Processor is on the verge of failing)

IOMSTS(1)–(168) (APM
Box)
Type: E:$IOMSTS Input/Output Module State
Lock: View nn = 1 - 40 specifies the status of 1 of the 40 acting primaries
Default: N/A nn = 129 - 168 specifies the status of 1 of the 40 acting secondaries
PtRes: APM
Range: 0-PowerOn (Transient state when power is turned on)
1-Idle (In the Idle State)
2-OK (Running)
3-NoResp (No Response)
4-IdleSF (In the Idle State and has a Soft Failure)
5-SoftFail (Running and has a Soft Failure)
6-CommErr (Communication Error)
7-ConfgMis (Configuration Mismatch)
8-NotConfg (This IOP is Not Configured)
9-NonExist (This IOP does Not Exist)

UnAvail (Transient state during which status for this IOP is unavailable)

IOMTYPE(1)–(168) (IOP)
Type: E:$PMMDTY Input/Output Processor Type
Lock: View
Default: None
PtRes: APM

Range: 0-None (Not Configured)

1-LLAI (Low Level Analog Input)
2-HLAI (High Level Analog Input, 16 slot)
3-DI (Digital Input, 32 slot)
4-DO (Digital Output, 32 slot)
5-AO (Analog Output, 8 slot)
7-LLMUX (Low Level Analog Multiplexer)
10-SI (Serial Interface)
14-STIM (Smart Transmitter Interface Module)
16DISOE (Digital Input, Sequence of Events)
17-PI (Pulse Input)
24-AO16 (Analog Output, 16 slot)
25DO32 (Digital Output, 32 slot)

APM Parameter Reference Dictionary I-12 10/96

 IOMTYPE

IOMTYPE (APM Box)

Type: E:$PMMDTY Configured Input/Output Processor Type
Lock: PtBld
Default: NotConfg
PtRes: APM
Range: 0-NotConfg (Not Configured)
1-LLAI (Low-Level Analog Input)
2-HLAI (High-Level Analog Input)
3-DI (Digital Input)
4-DO (Digital Output)
5-AO (Analog Output)
7-LLMUX (Low-Level Analog Multiplexer)
14-STIM (Smart Transmitter Interface Module)
17-PI (Pulse Input)

IONTOKEN (APM Box)

Type: Integer IOP Next Token Holder
Lock: View
Default: N/A
PtRes: APM

NOTE

This parameter is available to the nodes on the LCN, but cannot be accessed on the
UCN, either by APM/CL programs or print connections.

Range: 0, or 128 to 255

IOPDESC(1 - 40)
Type: String_8 IOP Description—Provides an 8-character description of the IOP.
Lock: View
Default: Spaces
PtRes: APM

Helpful Hint: An 8-character string is read from the IOP's EPROM and stored in the
APMM. The text string appears on the IOP Detail Display. Even if the IOP fails, an
operator can identify the IOP/FTA for maintenance. Not all IOPs have this feature yet.

Range: 8 characters

IOPNUM (Array)
Type: Integer Serial Interface IOP Module Number—Defines the module number of the
Lock: PtBld serial interface IOP.
Default: N/A
PtRes: APM
Range: 1 to 127

APM Parameter Reference Dictionary I-13 10/96

 IOPSTR1

IOPSTR1(1)–(40) (APM
Box)
Type: String_64 IOP String for FTA #1—Contains user-defined string data shown in the
Lock: View Box Detail display such as the FTA application name, its revision number,
Default: Spaces and date. NN = 1-40 specifies the Serial Interface IOP module number.
PtRes: SI
Range: N/A

IOPSTR2 (1)–(40) (APM

Box)
Type: String_64 IOP String for FTA #2—Contains user-defined string data shown in the
Lock: View Box Detail display such as the FTA application name, its revision number,
Default: Spaces and date. NN = 1-40 specifies the Serial Interface IOP module number.
PtRes: SI
Range: N/A

IORECCHN (APM Box)

Type: E:$RECCHN I/O Link Receive Cable—The cable the I/O module is currently listening
Lock: PtBld on.
Default: None
PtRes: APM
Range: A (I/O module is listening on Cable A)
B (I/O module is listening on Cable B)

IOREDOPT(1)–(40) (APM Box)

Type: E:$REDOPT IOP Redundancy Option—Indicates if an IOP is configured for
Lock: PtBld redundancy
Default: NonRedun
PtRes: APM
Range: 0-Redun
1-NonRedun

IOSTKNDR
Type: Integer IOP Token Drop Count
Lock: View
Default: N/A
PtRes: APM
Range: 0 to 32767

APM Parameter Reference Dictionary I-14 10/96

 K

-K-

K
(AutoMan)
Type: Real Gain Constant for X2 Input—Refer to the APM Control Functions and
Lock: Supr Algorithms manual for a detailed description.
Default: 1.0
PtRes: APM
Range: N/A

K (Pid)
Type: Real Overall Gain—Value of K depends on the chosen gain option. Refer to the
Lock: Supr APM Control Functions and Algorithms manual for a detailed description.
Default: 1.0
PtRes: APM
Range: 0.0 to 240.0

K
(PosProp)
Type: Real Gain Constant
Lock: Supr
Default: 1.0
PtRes: APM
Range: 0.0 to 10.0

K1
(PidErfb)
Type: Real External Reset Feedback Gain
Lock: Supr
Default: 0.0
PtRes: APM
Range: 0.0 to 1.0

K1 (PIDPosPr)
Type: Real Gain Constant
Lock: Supr
Default: 1.0
PtRes: APM
Range: 0.0 to 10.0

APM Parameter Reference Dictionary K-1 10/96

 K1–K2

K1–K2
(RatioCtl)
Type: Real K1 = Ratio Scale Factor; K2 = Scale Factor for X2 Input—When used in
Lock: Supr conjunction with the Calcultr algorithm, K1 must be equal to C1, and K2
Default: 1.0 must be equal to C2.
PtRes: APM
Range: N/A

K1–K4 (IncrSum)
Type: Real Gain Constants for X1–X4 Inputs
Lock: Supr
Default: 1.0
PtRes: APM
Range: > 0.0

KEXT(Pid)
Type: Real External Gain Modifier—Defines the external gain modification factor. It
Lock: Prog can be entered by a user-written program, or it can be an input from another
Default: 1.0 data point.
PtRes: APM
Range: 0.0 to 240.0

KEYWORD
Type: String_8 Keyword Descriptor— An eight-character descriptor that is used to
Lock: PtBld describe an important aspect of this particular data point. For example, in
Default: Blank Figure N-1 (see NAME) the keyword for the data point is REFLUX.
PtRes: NIM
Range: Alphabetics A-Z (upper case only).
Numerics 0-9 (an all numeric keyword is not allowed).
Underscore (_) cannot be used as the first character or the last character in a keyword.
Consecutive underscores are not allowed. Do not use quote marks (").

KFF (PidFf)
Type: Real Gain for Feed Forward Input—Scale factor which is used in converting
Lock: Supr the FF input value to percent.
Default: 1.0
PtRes: APM
Range: > 0.0 to < 1.0

APM Parameter Reference Dictionary K-2 10/96

 KGAP

KGAP (Pid)
Type: Real Gap Gain Factor—Defines the gain-modification factor.
Lock: Supr
Default: 1.0
PtRes: APM
Range: 00 to 1.0

KLIN (Pid)
Type: Real Linear Gain Factor—Defines the linear gain in percent per percent.
Lock: Supr
Default: 1.0
PtRes: APM
Range: 0.0 to 240.0

KNL (Pid)
Type: Real Nonlinear Gain Modifier—Indicates the calculated value of the nonlinear
Lock: View gain modifier.
Default: N/A
PtRes: APM
Range: N/A

APM Parameter Reference Dictionary K-3 10/96

APM Parameter Reference Dictionary K-4 10/96
 L(1)–(12)

-L-

L(1)–(12) (DevCtl, Logic)

Type: Logical, Real Value of the External Input—L(1)–L(12) are the 12 inputs to a logic slot
Lock: View fetched with input connections from other points. Each input can be a
Default: N/A Boolean, an Integer, or a Real number. Integer input values are converted to
PtRes: APM real numbers before being stored into the database.
Range: Real

Helpful Hint: L, if accessed from the LCN, must be accessed as a Logical data type.

LASTPV (RegCtl, RegCPV)

Type: Real Last PV Value—Indicates the value of the PV before the value became bad
Lock: View (BADPVFL).
Default: NaN
PtRes: APM
Range: N/A

LCNRECHN (APM
Box)
Type: E:$RECCHN LCN Receive Channel—Indicates the LCN channel to which the NIM is
Lock: View listening.
Default: ChanneLA
PtRes: APM
Range: 0-ChanneLA (NIM is listening to LCN channel A)
1-ChanneLB (NIM is listening to LCN channel B)

LDNGNODE (APM
Box)
Type: Integer UCN Node Performing Personality Image Load to This Node
Lock: View
Default:
PtRes: APM
Range:

LIBADOPT (DevCtl, Logic)

Type: E:$LIBADOP Logic Bad Input Handling Option—If a Boolean input is not
Lock: PtBld successfully fetched for an input connection to the logic slot, its value is
Default: Hold defaulted to one of the values (Off, On, Hold) selected through this
PtRes: APM parameter. Refer to the APM Control Functions and Algorithms manual for
a detailed description.
Range: 0-On (On state is substituted for bad input)
1-Off (Off state is substituted for bad input)
2-Hold (Last good value is substituted for bad input)

APM Parameter Reference Dictionary L-1 10/96

 LIBRYNUM

LIBRYNUM
Type: Integer NIM Library Number—Specifies the number of the NIM Library being
Lock: PtBld configured. For PED use only.
Default: 1
PtRes: NIM
Range: 1-3

LIBRYTXT(1)–(1000)
Type: String_8 NIM Library Text
Lock: PtBld
Default: N/A
PtRes: NIM
Range: N/A

LIDESC(1)–(12)
(DevCtl)
Type: String_8 Input Descriptor—External input descriptors.
in an Array
(1..12)
Lock: Engr
Default: Blank
PtRes: APM
Range: 8 Character String

LINEPERD (1)–
(168)
Type: Real Line Period in Microseconds
Lock: View
Default: N/A
PtRes: APM
Range: 15616.0 to 21759.0

APM Parameter Reference Dictionary L-2 10/96

 LISRC(1)_(12)

LISRC(1)–(12) (DevCtl, Logic)

Type: Universal Logic Input Connection Source—Define the parameters whose current
[Link] values are to be supplied to one or more of up-to-12 logic slot or Device
Lock: PtBld Control inputs. The parameters can be specified using the
Default: [Link] "[Link]" format or the hardware reference address format.
PtRes: APM Refer to the APM Control Functions and Algorithms manual for a detailed
description.
Range: Use [Link] for tagged points where Tagname can be up to 16 characters and
the permissible character set is as follows:
Alphabetics A-Z (uppercase only)
Numerics 0-9 (an all numeric tag name is not allowed)
Underscore (_) cannot be used as the first character or the last character, and
consecutive underscores are not allowed.
Embedded space characters are not allowed.
An * is used to default to this point's tag name.
Parameter name can be up to eight characters and must be a legitimate parameter
name.

Some possible input-connection sources are

a. “AnalgIn slot [Link]”
b."DigIn slot [Link]"
c."Logic slot [Link](nn)" where nn = 1–24
d."Logic slot [Link](nn)" where nn = 1–12
e.”Logic slot [Link](nn)” where nn = 1-8
f."ProcMod slot [Link](nnn)" where nnn = 1–127
g.”ProcMod slot [Link](nn)” where nn = 1–80
h.”RegCtl slot [Link]”
i.”RegPV slot [Link]”
j."Box Flag slot [Link]
k.”Box Numerics slot [Link]” where nnnnn = 1-16,384
l."" for a box flag that resides in the same box where nnnnn = 1–
16,384
m."$[Link](nnnn)" for a box flag that resides in a different APM box on the
same UCN; hh is the NIM UCN address, xx is the APM box number, and
nnnn = 1–4095 (data access limit)

Use the hardware reference address ![Link] for untagged or tagged points
where
MT is the IOP type, such as DI (Digital Input)
mm is the IOP Card number (1–40)
The letter "S" is a constant
ss is the slot number on the IOP Card (refer to SLOTNUM parameter)
Parameter name can be up to eight characters and must be a legitimate parameter
name.

LMREV (DevCtl)
Type: E:POLARITY Local Manual Polarity—Indicates whether point processing inverts the
Lock: Engr/PB local manual input value.
Default: Direct
PtRes: APM
Range: Direct (Value is not inverted)
Reverse (Value is inverted)

APM Parameter Reference Dictionary L-3 10/96

 LMSRC

LMSRC
Type: Universal Local Manual Source—The input connection for the local manual
[Link] input. Only inputs with logical data types are valid.
Lock: PtBld
Default: [Link]
PtRes: APM
Range: Use [Link] for tagged points where Tagname can be up to 16 characters and
the permissible character set is as follows:
Alphabetics A-Z (uppercase only)
Numerics 0-9 (an all numeric tag name is not allowed)
Underscore (_) cannot be used as the first character or the last character, and
consecutive underscores are not allowed.
Embedded space characters are not allowed.
An * is used to default to this point's tag name.
Parameter name can be up to eight characters and must be a legitimate parameter
name.

Some possible input-connection sources are

a."DigIn slot [Link]"
b."Logic slot [Link](nn)" where nn = 1–24
c."Logic slot [Link](nn)" where nn = 1–12
d."ProcMod slot [Link](nnn)" where nnn = 1–127
e."Box Flag slot [Link]
f."" for a box flag that resides in the same box where nnnn = 1–16,384
g."$[Link](nnnn)" for a box flag that resides in a different APM box on the
same UCN; hh is the NIM UCN address, xx is the APM box number, and
nnnn = 1–4095 (data access limit)

Use the hardware reference address ![Link] for untagged or tagged points
where
MT is the IOP type, such as DI (Digital Input)
mm is the IOP Card number (1–40)
The letter "S" is a constant
ss is the slot number on the IOP Card (refer to SLOTNUM parameter)
Parameter name can be up to eight characters and must be a legitimate parameter
name.

LOADFAIL
Type: Integer Node Load Failure Information
Lock: View
Default:
PtRes: APM
Range:

LOADFLAG
Type: String_2 Load Flag
Lock: View
Default:
PtRes: APM
Range: Hexadecimal characters 00 to FF

LOADPCKT
Type: Integer Current Personality Image Packet Being Loaded to This Node
Lock: View
Default:
PtRes: APM
Range:

APM Parameter Reference Dictionary L-4 10/96

 LOADSCOP

LOADSCOP (NIM)
Type: E:$LOADSCP Load Scope—Defines the scope of the point-build procedure for NIM and
Lock: PtBld APM configuration. Indicates whether the point information is loaded to
Default: NIMAndPm both the NIM and APM or to the NIM only. A value of NIMONLY is
PtRes: NIM typically used to configure points only in the NIM during installation of a
new system without APMs.

NOTE

When points are built to a NIM and the NIM is restarted with no database, the points
need
to be reloaded from checkpoint or the points must be reconfigured. If the database is to
be reconfigured, the APMM must be in Idle, and the point execution state must be
Inactive. This allows the point build operation to override the database that already
exists there.

NOTE

To delete active entities from the APM database, the point must be put to the inactive
state. An alternative is to delete the entity in the NIM only by changing the LOADSCOP
parameter for the NIM to NimOnly and deleting the point. Be sure to restore
LOADSCOP to NimAndPM after deleting points.

Range: NimOnly (Configured data is to be loaded into the NIM only)

NimAndPm (Configured data is to be loaded into the NIM and APM)

LOADSTAT
Type: E:LOADSTAT Load Status
Lock: View
Default:
PtRes: APM
Range: Notload
Loaded
Loading
Unlding

LOCALMAN (AnalgOut, RegCtl)

Type: Logical Local Manual Flag—Indicates whether the associated hardware output of
Lock: View this point is being controlled by a manually-operated analog display.
Default: Off
PtRes: APM
Range: Off (Output is not being controlled by an Analog Display)
On (Output is being controlled by an Analog Display)

APM Parameter Reference Dictionary L-5 10/96

 LOCALMAN

LOCALMAN (DigComp, DevCtl)

Type: Logical Local Manual Flag—When On, indicates that the output(s) is being locally
Lock: Prog controlled and not by the APM. When this flag is on, it usually indicates
Default: Off that the "hand/off/auto" switch is not in the "auto" position.
PtRes: APM
Range: Off
On

LOCUTOFF
Type: Real Low Signal Cut Off For Flow Inputs—Defines the low cut-off point for
Lock: Eng/PB flow inputs.
Default: NaN
PtRes: APM
Range: PVEULO to PVEUHI; > 0
NaN

Helpful Hint: LOCUTOFF configuration applies only if PVCHAR = Linear or Sqrroot.

LODSTN(1)–(12) (Logic)
Type: Blind Record Logic Output-Connection Destination—Specifies up to 12 destinations to
in an Array which the current values of the logic slot outputs are supplied. The
(1..12) destinations can be specified using the "[Link]" format or the
Lock: PtBld hardware reference address format. Refer to the APM Control Functions and
Default: [Link] Algorithms manual for a detailed description.
PtRes: APM
Range: Use [Link] for tagged points where Tagname can be up to 16 characters, and
the permissible character set is as follows:
Alphabetics A-Z (uppercase only)
Numerics 0-9 (an all numeric tag name is not allowed)
Underscore (_) cannot be used as the first character or the last character, and
consecutive underscores are not allowed.
Embedded space characters are not allowed.
An * is used to default to this point's tag name.
Parameter name can be up to eight characters, and must be a legitimate parameter
name.

Some possible output-connection destinations are

a."DigOut slot [Link] or OFFPULSE"
b."DigOut slot [Link]"
c."Logic slot [Link](nn)" where nn = 7–12
d."ProcMod [Link](nnn)" where nnn = 1–127
e."Flag slot [Link]
f."" for a box flag that resides in the same APM box where
nnnn = 1-16,384.
g."$[Link](nnnn)" for a box flag that resides in a different APM box on the
same UCN; hh is the UCN number, xx is the APM box number of the destination
parameter, and nnnn = 1-4095 (data access limit).
Use the hardware reference address ![Link] for untagged or tagged points
where
MT is the IOP type, such as DO (Digital Output)
mm is the IOP Card number (1-40)
The letter "S" is a constant
ss is the slot number on the IOP Card (refer to SLOTNUM parameter)
Parameter name can be up to eight characters and must be a legitimate parameter
name.

APM Parameter Reference Dictionary L-6 10/96

 LODSTN(1)–(2)

LODSTN(1)–(2) (DevCtl)
Type: Blind Record Device Control Output Connection Destination—Specifies up to 2
in an Array destinations to which the current values of the Device Control slot outputs
(1..2) are supplied. The destinations can be specified using the
Lock: PtBld "[Link]" format or the hardware reference address format
Default: Null Refer to the APM Control Functions and Algorithms manual for a detailed
PtRes: APM description.
Range: Use [Link] for tagged points where Tagname can be up to 16 characters and
the permissible character set is as follows:
Alphabetics A-Z (uppercase only)
Numerics 0-9 (an all numeric tag name is not allowed)
Underscore (_) cannot be used as the first character or the last character, and
consecutive underscores are not allowed.
Embedded space characters are not allowed.
An * is used to default to this point's tag name.
Parameter name can be up to eight characters and must be a legitimate parameter
name.

Some possible output-connection destinations are

a."DigOut slot [Link] or OFFPULSE"
b."DigOut slot [Link]"
c."Logic slot [Link](nn)" where nn = 7–12
d."ProcMod [Link](nnn)" where nnn = 1–127
e."Flag slot [Link]
f."" for a box flag that resides in the same APM box where
nnnn = 1-16,384.
g."$[Link](nnnn)" for a box flag that resides in a different APM box on the
same UCN; hh is the UCN number, xx is the APM box number of the destination
parameter, and nnnn = 1-4095 (data access limit).

Use the hardware reference address ![Link] for untagged or tagged points
where
MT is the IOP type, such as DI (Digital Input)
mm is the IOP Card number (1–40)
The letter "S" is a constant
ss is the slot number on the IOP Card (refer to SLOTNUM parameter)
Parameter name can be up to eight characters and must be a legitimate parameter
name.

APM Parameter Reference Dictionary L-7 10/96

 LOENBL(1)–(2)

LOENBL(1)–(2) (DevCtl)
Type: E:$PMDVPRM Device Control Output Enable—Allows the respective output
in an Array connection defined by LODSTN to write the value of the specified
(1..2) Device Control parameter to the destination. The logic output is
Lock: PtBld allowed when the enable function, selected from the list below, is On.
Default: FL2 If the FL1 parameter is specified and the output data type is logical,
PtRes: APM output occurs only during change (normally, it is continuous).

Range: FL1...FL12 [Local flag; either a 1 (On) or a 0 (Off)]

D1, D2 [Digital PV inputs, either a 1 (On) or a 0 (Off)]
SI0 [Safety interlocks, either a 1 (On) or a 0 (Off)]
I0, I1, I2 [Interlocks, either a 1 (On) or a 0 (Off)]
P0, P1, P2 [Permissives, either a 1 (On) or a 0 (Off)]
PISO1..PISO12 [Primary Input Gate Values (logical)]
SISO1..SISO12 [Secondary Input Gate Values (logical)]
PGSO1..PGSO4 [Primary Gate Output Values (logical)]
SGSO1, SGSO2 [Secondary Gate Output Values (logical])
L1..L12 [Logic input value to device control slot (logical)]

LOENBL(1)–(12) (Logic)
Type: E:$PMMLGPM Logic Output Enable—Allows the respective output connection
Lock: PtBld defined by LODSTN to write the value of the specified logic-slot
Default: FL2 parameter to the destination. The logic output is allowed when the
PtRes: APM enable function, selected from the list below, is On. If the FL1
parameter is specified and the output data type is logical, output occurs
only during change (normally, it is continuous).

Range: FL1...FL12 [Local flag; either a 1 (On) or a 0 (Off)]

SO1...SO24 [Logic-block output; either a 1 (On) or a 0 (Off]
L1...L12 [Logic input value to logic slot (logical)]

APM Parameter Reference Dictionary L-8 10/96

 LOGALGID

LOGALGID(1)–(24) (Logic)
Type: E:$PMMLGAL Logic Block Algorithm Identifier—Defines the logic algorithm to be
Lock: PtBld used for a particular logic block. A different logic algorithm can be
Default: NULL specified for each logic block within a logic slot. Refer to the APM
PtRes: APM Control Functions and Algorithms manual for a detailed description of
each logic algorithm.
Range:Algorithm ID Description Input(s)
0-NULL No logic algorithm is executed ---
1-AND AND Gate *S1, S2, S3
2-OR OR Gate *S1, S2, S3
3-NOT NOT Gate S1
4-NAND NAND Gate *S1, S2, S3
5-NOR NOR Gate *S1, S2, S3
6-XOR XOR Gate S1, S2
7-QOR2 Qualified OR Gate with 2 Inputs On S1, S2, S3, S4
8-QOR3 Qualified OR Gate with 3 inputs On S1, S2, S3, S4
9-SWITCH Switch S1, S2, S3
10-EQ Compare equal with deadband R1, R2,
DEADBAND
11-NE Compare not equal with deadband R1, R2,
DEADBAND
12-GT Compare > than with deadband R1, R2,
DEADBAND
13-GE Compare > than or = with deadband R1, R2,
DEADBAND
14-LT Compare < than with deadband R1, R2,
DEADBAND
15-LE Compare < than or = with deadband R1, R2,
DEADBAND
16-CheckBad Check for Bad R1
17-Pulse Fixed-size Pulse S1, DLYTIME
18-MinPulse Pulse with minimum time limit S1, DLYTIME
19-MaxPulse Pulse with maximum time limit S1, DLYTIME
20-Delay Either Direction S1
21-OnDly Off-On Delay S1, DLYTIME
22-OffDly On-Off Delay S1, DLYTIME
23-WatchDog Watchdog Timer FL6
24-FlipFlop Flip Flop S1, S2, S3
25-ChDetect Change Detect S1, S2 , S3

*Inputs S1–S3 can be inverted as required

LOGICSRC (DigComp, DevCtl)

Type: Ent_Id Logic Source— Specifies the tag name of a point, usually a logic slot, that
Lock: PtBld is controlling the interlock signals.
Default: Null
PtRes: NIM
Range: Tag name can be up to sixteen characters and the permissible character set is as follows:
Alphabetics A-Z (uppercase only)
Numerics 0-9 (an all numeric tag name is not allowed)
Underscore (_) cannot be used as the first character or the last character, and consecutive
underscores are not allowed.
Embedded space characters are not allowed.

APM Parameter Reference Dictionary L-9 10/96

 LOGMIX

LOGMIX (Logic)
Type: E:$LOGMIX Logic Mix—Defines the number of input connections, logic blocks, and
Lock: PtBld output connections this logic slot contains.
Default: 12_24_4
PtRes: APM
Input Connections Number of Output Connections
Range: LISRC(1)-LISRC(12) Logic Blocks LOSRC(1)-LOSRC(12)
12_24_4 12 24 4
12_16_8 12 16 8
12_8_12 12 8 12

LOSRC(1)–(2) (DevCtl)
Type: E:$PMDVPRM Device Control Output Connection Source—Defines the Device
in an Array Control parameter that is to provide its value to the output connection
(1..2) specified by parameter LODSTN(n), Device Control Output
Lock: PtBld Connection Destination.
Default: FL1
PtRes: APM
Range: FL1...FL12 [Local flag; either a 1 (On) or a 0 (Off])
D1, D2 [Digital PV inputs, either a 1 (On) or a 0 (Off)]
SI0 [Safety interlocks, either a 1 (On) or a 0 (Off)]
I0, I1, I2 [Interlocks, either a 1 (On) or a 0 (Off)]
P0, P1, P2 [Permissives, either a 1 (On) or a 0 (Off)]
PISO1..PISO12 [Primary Input Gate Values (logical)]
SISO1..SISO12 [Secondary Input Gate Values (logical)]
PGSO1..PGSO4 [Primary Gate Output Values (logical)]
SGSO1, SGSO2 [Secondary Gate Output Values (logical)]
L1..L12 [Logic input value to device control slot (either logical or real)]
NN1..NN8 [Local numerics (real)]
PINN1..PINN12 [Numeric constant for arithmetic comparisons (real)]
SECVAR [Secondary variable input value (real)]

LOSRC(1)–(12) (Logic)
Type: E:$PMMLGPM Logic Output Connection Source—Defines the logic-slot parameter
Lock: Eng/PB that is to provide its value to the output connection specified by
Default: FL1 parameter
PtRes: APM LODSTN(n), Logic Output Connection Destination.
Range: FL1...FL12 [Local flag; either a 1 (On) or a 0 (Off)]
SO1...SO24 [Logic block output; logical 1 or 0)]
L1...L12 [Input to the logic slot (logical or real value)]
NN1...NN8 [Local numeric; data type of Real]

LOWERTIM
Type: Real Lower Output Pulse Time (In Seconds)—Indicates the lower output pulse
Lock: View time in seconds. This value is clamped to MAXPULSE or CYCLETIM,
Default: N/A whichever is lower. If LOWERTIM is smaller than RP*MINPULSE, no
PtRes: APM pulse is issued.
Range: N/A

APM Parameter Reference Dictionary L-10 10/96

 LOWRDSTN

LOWRDSTN
Type: Universal Lower OP Pulse Destination—Defines the destination of the Lower output
[Link] pulse. LOWRDSTN must point to parameter ONPULSE or parameter
Lock: PtBld OFFPULSE of a DigOut point.
Default: Null
PtRes: APM
Range: ONPULSE
OFFPULSE

LOWRRATE
Type: Real Lower OP Stroke Rate in Percent/Second
Lock: Supr
Default: 100.0%/sec.
PtRes: APM
Range: >0.0 percent/second

LRL (STI)
Type: Real Lower Range Limit—Indicates the lower range limit of the PV at the smart
Lock: View transmitter. This limit is fixed and cannot be changed. Refer to description
Default: NaN of the STI_EU parameter for the LRL engineering units.
PtRes: APM
Range: N/A, NaN

LRV (STI)
Type: Real Lower Range Value—Defines the lower end of the operating range for the
Lock: Supr/View PVRAW value. User entry for PVEULO is the user-entered engineering-unit
Default: NaN value that corresponds to LRV. Refer to description of the STI_EU
PtRes: APM parameter for the LRV engineering units.

This parameter can be changed only when the STI point execution state
PTEXECST is Inactive.

Range: N/A, NaN

LSEQNUMR
Type: Integer Last Sequence Number—Specifies the sequence number of the last
Lock: Eng personality image file packet received by the IOP.
Default: 0
PtRes: IOP
Range:

APM Parameter Reference Dictionary L-11 10/96

 LSIOLORN

LSIOLORN(0)–(4) (APM Box)

Type: Integer Last Hour's I/O Link Fetch/Store Overruns—Indicates the number of I/O
Lock: View Link access overruns that have been detected in the last hour. LSIOLORN
Default: 0 is set equal to the contents of CRIOLORN, every hour on the hour.
PtRes: APM
Range: >0

LSPPXORN(0)–(8) (APM Box)

Type: Integer Last Hour's Point Processing Fetch/Store Overruns—Indicates the
Lock: View number of point processing overruns that have been detected in the last hour.
Default: 0 LSPPXORN is set equal to the contents of parameter CRPPXORN, every
PtRes: APM hour on the hour.
Range: >0

LSUCNORN (APM Box)

Type: Integer Last Hour's UCN Access Overruns—LSUCNORN is set equal to the
Lock: View contents of parameter CRUCNORN, the current hour's UCN Access
Default: 0 Overruns, every hour on the hour.
PtRes: APM
Range: >0

APM Parameter Reference Dictionary L-12 10/96

 M

-M-

M (IncrSum, ORSel, Switch)

Type: Integer Number of Inputs
Lock: PtBld
Default: 2
PtRes: APM
Range: 2 to 4

MAINDAT (DevCtl, DigComp)

Type: Time Maintenance Reset Statistics Date—The date and time of the reset of
Lock: Engr maintenance statistics that can also be written by the engineer. Statistics can
Default: Time of Point be reset by the operator only when the device is red tagged, while programs
Build can reset them at any time. Resetting is accomplished by setting the
PtRes: APM RESETFL to ON.
Range: Time Stamp (DD MMM YY HH:MM:SS)

Helpful Hint: This parameter is reset when the RESETFL parameter = ON.

MAINTOPT (DevCtl, DigComp)

Type: Logical Maintenance Option—Indicates if the maintenance statistics option is
Lock: PtBld used.
Default: Off
PtRes: APM
Range: Off (Maintenance statistics are not available)
On (Maintenance statistics are available)

MANMODFL (RegCtl)
Type: Logical Manual Mode Flag—Indicates whether the current mode of the slot is
Lock: View Manual.
Default: N/A
PtRes: APM
Range: Off (Current mode is other than Manual)
On (Current mode is Manual)

MANOPCMD
Type: E:$MANOPCM Manual Output Pulse Command—Defines the output pulse command
Lock: Oper issued by the operator for raising and lowering the output. See also,
Default: None MANOPTIM.
PtRes: APM
Range: 0-None (No change)
1-Raise_1 (Raise output by 1 MANOPTIM each keystroke)
2-Lower_1 (Lower output by 1 MANOPTIM each keystroke)
3-Raise_10 (Raise output by 10 MANOPTIMs each keystroke)
4-Lower_10 (Lower output by 10 MANOPTIMs each keystroke)

APM Parameter Reference Dictionary M-1 10/96

 MANOPTIM

MANOPTIM
Type: Real Manual Output Pulse Time (in seconds)—Defines the width of the raise
Lock: Eng/PB or lower output pulse that is issued by the operator.
Default: 1.0
PtRes: APM
Range: 0.0 to 60.0 seconds

MASKTIM (DevCtl)
Type: Integer Masktime—The amount of time the SECVAR parameter alarms are masked
Lock: Supr after a change in the output state.
Default: 0
PtRes: APM
Range: 0 to 1000 seconds

MAXPULSE
Type: Real Maximum Pulse Time Limit—Defines the maximum pulse time limit. If
Lock: Supr the calculated pulse time is greater than this value then a pulse of length
Default: 60 MAXPULSE is issued.
PtRes: APM
Range: MINPULSE to 60.0 seconds
NaN

MAXSLOTS
Type: Real Maximum Available Slots—Returns the maximum number of slots that can
Lock: View be configured in an IOP.
Default: 0
PtRes: IOP
Range: 0 - 127 slots

Helpful Hint: Applies to the following IOP types: AO16, DI32 and DO32.

MAXTIM0H (DevCtl, DigComp)

Type: Real Maximum Time Allowed in State 1—The maximum amount of time
Lock: Supr (based on the PV) in hours allowed for state 1.
Default: 0
PtRes: APM
Range: N/A

MAXTIM1H (DevCtl, DigComp)

Type: Real Maximum Time Allowed in State 1—The maximum amount of time
Lock: Supr (based on the PV) in hours allowed for state 2.
Default: 0
PtRes: APM
Range: N/A

APM Parameter Reference Dictionary M-2 10/96

 MAXTIM2H

MAXTIM2H (DevCtl, DigComp)

Type: Real Maximum Time Allowed in State 2—The maximum amount of time
Lock: Supr (based on the PV) in hours allowed for state 3.
Default: 0
PtRes: APM
Range: N/A

MAXTRAN0–2 (DevCtl, DigComp)

Type: Time Maximum Number of Transitions into State—This is the maximum
Lock: Supr number of transitions allowed in each state, and is the target value for
Default: 0.0 maintenance statistics.
PtRes: APM
Range: 0 (There is no limit)

MDMHWREV (APM Box, NIM)

Type: String_2 Modem Hardware Revision
Lock: View
Default:
PtRes: APM, NIM
Range: Hexadecimal Characters 00 to FF

MEMFWREV
Type: String_2 Memory Firmware Revision
Lock: View
Default:
PtRes: APM
Range: Hexadecimal Characters 00 to FF

MEMHWREV
Type: String_2 Memory Hardware Revision
Lock: View
Default:
PtRes: APM
Range: Hexadecimal Characters 00 to FF

APM Parameter Reference Dictionary M-3 10/96

 MINPULSE

MINPULSE
Type: Real Minimum Pulse Time Limit—Defines the minimum pulse time limit for
Lock: Supr the Raise pulse. If the calculated pulse time value is smaller than this
Default: 0.0 value, no pulse is issued.
PtRes: APM
Range: 0.0 seconds to MAXPULSE
NaN

MINUTE (APM Box)

Type: Integer Current Minute—Value of the LCN time in the APM.
Lock: View
Default: N/A
PtRes: APM
Range: 0 to 59

MODATTR
Type: E:MODATTR Mode Attribute—Defines whether the operator or the sequence program
Lock: Oper has the authority to change certain parameters of this data point. At the
Default: Operator Universal Station, the mode attribute is displayed next to the mode of the
PtRes: APM data point. If the mode attribute is Program, a -P appears to the left of
MODE. If the attribute is operator, blanks are displayed to the left of
mode.

Range: 0-Operator (Operator can set Mode, OP, SP, Ratio, Bias)
1-Program (Program can set Mode, OP, SP, Ratio, Bias)
2-Normal
3-None (No mode attribute)

Helpful Hint: MODATTR change requires SHUTDOWN = Off and REDTAG = Off. When
the "normal mode" button on the Operator's keyboard is pressed, MODATTR
=
NMODATTR unless NMODATTR = None.

APM Parameter Reference Dictionary M-4 10/96

 MODE

MODE
(AnalgOut)
Type: E:MODE Mode—Defines the current mode of the data point. Parameter MODATTR
Lock: Oper determines whether operator or the sequence program provides the output
Default: Man value for this point. If PNTFORM is Component, then MODE parameter is
PtRes: APM not applicable for this data point.
Range: 1-Man (Operator or Program provides the point's output value (OP))
2-Cas (Data point receives its output value from a primary data point.
If RCASOPT is DDC, data point receives its output value from an AM point.)
5-Normal (Parameter NMODE determines this point's mode)

Helpful Hint: 1. MODE change by a program requires MODATTR = Program and

REDTAG = Off.
2. MODE change by an operator requires MODATTR = Operator,
MODEPERM = Permit, and REDTAG = Off.

MODE (DigComp, DevCtl)

Type: E:MODE Mode of Digital Composite and Device Control Slot—Defines the current
Lock: Oper mode of the data point. Parameter MODATTR determines whether operator
Default: Man or the sequence program provides the output value for this point. If
PtRes: APM PNTFORM is Component, then MODE parameter is not applicable for this
data point.
Range: 1-Man (Operator or Program controls slot's output (OP))
5-Normal (Parameter NMODE contains slot's mode)

Helpful Hint: 1. MODE change by a program requires MODATTR = Program,

SHUTDOWN = Off, and REDTAG = Off.
2. MODE change by an operator requires MODATTR = Operator,
MODEPERM = Permit, SHUTDOWN = Off, and REDTAG = Off.

APM Parameter Reference Dictionary M-5 10/96

 MODE

MODE (RegCtl)
Type: E:MODE Mode of Regulatory Control Slot—Defines the mode of the RegCtl point.
Lock: Oper
Default: Man
PtRes: APM
Range: 1-Man (Operator or discontinuous program controls slot's output (OP), regardless of any
automatic control strategy)
2-Cas (Upstream slot's OP is this slot's SP)
3-Auto (OP value is computed by the configured RegCtl algorithm, and the setpoint
(SP)
comes from the local setpoint (LSP) location in the RegCtl point. An operator
or a
discontinuous program can change the setpoint value.
4-Bcas (Local cascade mode where the RegCtl point receives its setpoint from the OP
of a
primary data point, even though the entry for the RCASOPT parameter is Spc,
DdcRsp, or Rsp (where the AM provides the setpoint). In this way, should the
AM
or the NIM fail, the control strategy will shed to the local cascade mode.)
5-Normal (Parameter NMODE determines the normal mode of this slot)

Helpful Hint: 1. MODE change by a program requires MODATTR = Program

and REDTAG = Off.
2. MODE change by an operator requires MODATTR = Operator,
MODEPERM = Permit, and REDTAG = Off.

MODEAPPL(1)–(4) (DevCtl, DigComp,

RegCtl)
Type: Logical Mode Applicability—Defines changes for Regulatory Control
Lock: View points:
Default: Man=On MODEAPPL[1] = ON if MAN mode if valid, else it is OFF
MODEAPPL MODEAPPL[2] = ON if AUTO mode is valid, else it is OFF
[Auto]=Off MODEAPPL[3] = ON if CAS mode is valid, else it is OFF
MODEAPPL [Bcas]=Off MODEAPPL[4] = ON if BCAS mode is valid, else it is OFF
MODEAPPL[Cas]=Off
Static for DevCtl
and Digcomp points
PtRes: APM
Range: N/A

MODEPERM (AO)
Type: E:MODEPERM Mode Permissive—Determines whether the operator can change the
Lock: Eng/PB mode of this data point.
Default: Permit
PtRes: APM
Range: 0-Permit (Operator can change this point's mode)
1-NotPerm (Operator cannot change this point's mode)

APM Parameter Reference Dictionary M-6 10/96

 MODEPERM

MODEPERM (DevCtl, DigComp,

RegCtl)
Type: E:MODEPERM Mode Permissive—Determines whether the operator can change the
Lock: Eng mode of this data point.
Default: Permit
PtRes: APM
Range: 0-Permit (Operator can change this point's mode)
1-NotPerm (Operator cannot change this point's mode)

MODNUM
Type: Integer APMM/IOP Module Number—Defines the module number in the APM.
Lock: PtBld The APMM is module number 0; the IOP Cards are module numbers 1–40.
Default: N/A
PtRes: NIM
Range: 0 to 40 (0 is reserved for the APMM)

MOMSTATE (DevCtl, DigComp)

Type: E:$MOMSTAT Momentary Output States—Defines which of the output states are
Lock: Eng/PB momentary. Refer to the APM Control Functions and Algorithms manual
Default: None for a detailed description.
PtRes: APM
Range: 0-None (No momentary output states)
1-Mom_1 (State 1 is momentary if NOSTATES = 2 or 3)
2-Mom_0 (State 0 is momentary if NOSTATES = 2)
3-Mom_2 (State 2 is momentary if NOSTATES = 3)
4-Mom_1_2 (State 1 and State 2 are momentary; valid if NOSTATES = 3)

MONTH (APM Box)

Type: Integer Current Month—The value of the LCN date in the APM.
Lock: View
Default: N/A
PtRes: APM
Range: 1 to 12 (January to December)

MOVPVFL
Type: Logical Moving PV Flag—Indicates whether the PV is moving from one state to
Lock: View another state.
Default: Off
PtRes: APM
Range: Off (PV is not moving)
On (PV is moving)

APM Parameter Reference Dictionary M-7 10/96

 MOVPVTXT

MOVPVTXT (APM Box, DevCtl,

DigComp)
Type: String_8 Moving PV Text Descriptor—Defines the state descriptor that is displayed
Lock: PtBld when the Digital Composite or Device Control point is changing states
Default: MOVING (moving from one state to another), or is in-between states. This descriptor,
PtRes: NIM defined on the APM box point, is displayed for all Digital Composite or
Device Control points in this APM box if PVTXTOP, defined on the Digital
Composite or Device Control point, = OFF. This parameter contains the
text for a configured moving PV on a per point basis if the PVTXTOPT is
ON.

Range: The permissible character set for the up to eight character descriptor is as follows:
Alphabetics A-Z (uppercase only)
Numerics 0-9,
Underscore (_)

MSGPEND (ProcMod)
Type: Logical Sequence Message Pending—Indicates that a confirmable sequence
Lock: View message requiring confirmation has been issued to the operator.
Default: None
PtRes: APM
Range: N/A

MSGTXT(0)–(15) (NIM)
Type: String_8 Status Message Text—Indicates the text for the self-defined enumeration of
in an Array STSMSG. MSGTXT(0) is always NONE, and cannot be configured. Refer
(0..15) to “Status Messages” in the Control Functions and Algorithms Manual for
Lock: PtBld more information.
Default: Blank
PtRes: NIM
Range: 0 to 15

MXRMPDEV (RampSoak)
Type: Real Maximum Ramp Deviation Value—If the PV falls behind the SP during a
Lock: Supr ramp segment by more than the value of MXRMPDEV, the ramping action
Default: NaN is stopped until the PV reaches the SP.
PtRes: APM
Range: > 0.0,
NaN

MXSOKDEV (RampSoak)
Type: Real Maximum Soak Deviation Value—If the PV falls behind the SP during a
Lock: Supr soak segment by more than the value of MXSOKDEV, the soak timer is
Default: NaN stopped until the PV reaches SP.
PtRes: APM
Range: > 0.0,
NaN

APM Parameter Reference Dictionary M-8 10/96

 N

-N-

N (Calcultr)
Type: Integer Number of Inputs—Defines the number of inputs to this algorithm.
Lock: PtBld
Default: 1
PtRes: APM
Range: 1 to 6

N (HiLoAvg, Summer)
Type: Integer Number of Inputs—Defines the number of inputs to this algorithm.
Lock: PtBld
Default: 2
PtRes: APM
Range: 2 to 6 inputs

NAME
Type: String_16 Tag Name—Identifies this point to the system and on displays, reports, and
Lock: PtBld logs. Figure N-1 shows examples of the Group and Detail Displays on which
Default: N/A the tag name appears.
PtRes: NIM
Digital Input, Digital Output, Analog Output, Flag, and Numeric-type data
points do not have to be configured by using the point builder (DEB). All
other types of data points have to be configured by using the DEB and
require that a tag name be specified during the point build process.
Range: Tag name can be up to 16 characters, and the permissible character set is as follows:
Alphabetics A-Z (uppercase only)
Numerics 0-9 (an all numeric tag name is not allowed)
Underscore (_) cannot be used as the first character or the last character, and consecutive
underscores are not allowed.
Embedded space characters are not allowed.

NARRSLOT (APM Box)

Type: Integer Number of Array Slots in an APM
Lock: PtBld
Default: 0
PtRes: APM
Range: 0 to 256

NCTLSLOT (APM Box)

Type: Integer Number of Regulatory Control Slots in an APM—Refer to the APM
Lock: PtBld Control Functions and Algorithms manual for a detailed description of APM
Default: 0 processing capacity.
PtRes: APM
Range: 0 to 160

APM Parameter Reference Dictionary N-1 10/96

 GROUP DISPLAY

TAG NAME
F 3HP
FC1ØØT1 E. U. DESCRIPTOR
LBS/SEC
REFLUX KEYWORD
5Ø.7
5Ø.9U
25.9

DETH REFLUX PUMP - A CONTR POINT DESCRIPTOR

DETAIL DISPLAY
TAG NAME POINT DESCRIPTOR UNIT ID

FC1ØØT1 DETH REFLUX PUMP A CONTR UNIT XX

.ØØ% -

75% -

5Ø% -

25% -

Ø% - TAG NAME
F 3HP
FC1ØØT1 E. U. DESCRIPTOR
LBS/SEC
REFLUX KEYWORD
P 5Ø.7
V 5Ø.9U
OUT % 25.9
MAN

Figure N-1 — Locations of Terms on Group and Detail Displays 1850

APM Parameter Reference Dictionary N-2 10/96

 NDCSLOT

NDCSLOT (APM Box)

Type: Integer Number of Digital Composite Slots in an APM—Refer to the APM
Lock: PtBld Control Functions and Algorithms manual for a detailed description of APM
Default: 0 processing capacity.
PtRes: APM
Range: 0 to 512

NDEVSLOT (APM Box)

Type: Integer Number of Device Control Points Configured—The number of Device
Lock: PtBld Control points in an APM Box point. Refer to the APM Control Functions
Default: 0 and Algorithms manual for a detailed description of APM processing
PtRes: APM capacity.
Range: 0 to 160

NEIPRQU (NIM)
Type: Real Number of Event Initiated Processing Requests—The number of Event
Lock: View Initiated Processing requests sent in the last 15 seconds.
Default: 0
PtRes: NIM
Range: N/A

NFASTCTL (APM Box)

Type: Integer Number of Fast Regulatory Control Slots—Fast slots are processed four
Lock: PtBld times per second.
Default: 0
PtRes: APM
Range: 0 to 40, cannot exceed NCTLSLOT

NFASTDC (APM Box)

Type: Integer Number of Fast Digital Composite Slots—Fast slots are processed four
Lock: PtBld times per second.
Default: 0
PtRes: APM
Range: 0 to 400, cannot exceed NDCSLOT

APM Parameter Reference Dictionary N-3 10/96

 NFASTDEV

NFASTDEV (APM Box)

Type: Integer Number of Fast Device Control Points Configured— The number of fast
Lock: PtBld device control points in an APM Box data point. Fast slots are processed
Default: 0 four times per second.
PtRes: APM
Range: 0 to 40, cannot exceed NDEVSLOT

NFASTLOG (APM Box)

Type: Integer Number of Fast Logic Slots—Fast slots are processed four times per
Lock: PtBld second.
Default: 0
PtRes: APM
Range: 0 to 40, cannot exceed NLOGSLOT

NFASTPV (APM Box)

Type: Integer Number of Fast Regulatory PV slots—Fast slots are processed four times
Lock: PtBld per second.
Default: 0
PtRes: APM
Range: 0 to 40, cannot exceed NPVSLOT

NFLAG (APM Box)

Type: Integer Number of Flags in APM Box Data Point—The APM always provides 16,
Lock: View 384 box flag variables.
Default: 16, 384
PtRes: APM
Range: 16,384

NFLAG (Array)
Type: Integer Number of Flags in Array Point FL Array— Defines the number of
Lock: PtBld mapped flags from either the APM box (EXTDATA≠ IO_FL) or a serial
Default: 0 interface IOP-connected device (EXTDATA=IO_FL).
PtRes: APM
Range: 0 to 512 (When EXTDATA = IO_FL)
0 to 1023 (When EXTDATA ≠ IO_FL)

NI0–2 (DevCtl, DigComp)

Type: Logical Inverted Interlocks Value—The negative value of the corresponding
Lock: Engr interlock.
Default: On
PtRes: APM
Range: On (Interlock inactive)
Off (Interlock active)

Helpful Hint: This parameter can be changed by the engineer only if the point is inactive
or if the APM is idle.

APM Parameter Reference Dictionary N-4 10/96

 NIMDAY

NIMDAY (NIM)
Type: Integer Day in Which the NIM Personality was Created
Lock: View
Default: 1
PtRes: NIM
Range: 1 to 31

Helpful Hint: This parameter is accessed using $[Link] (where uu = UCN

Network number).

NIMMONTH (NIM)
Type: Integer Month in Which the NIM Personality was Created
Lock: View
Default: 1
PtRes: NIM
Range: 1 to 12

Helpful Hint: This parameter is accessed using $[Link] (where uu =

UCN Network number).

NIMREV (NIM)
Type: Integer Revision Number of the NIM Personality
Lock: View
Default: 0
PtRes: NIM
Range: N/A

Helpful Hint: This parameter is accessed using $[Link] (where uu = UCN

Network number).

NIMVERS (NIM)
Type: Integer Version Number of the NIM Personality
Lock: View
Default: 0
PtRes: NIM
Range: N/A

Helpful Hint: This parameter is accessed using $[Link] (where uu = UCN

Network number).

APM Parameter Reference Dictionary N-5 10/96

 NIMYEAR

NIMYEAR (NIM)
Type: Integer Year in Which the NIM Personality was Created
Lock: View
Default: 0
PtRes: NIM
Range: 0 - 99

Helpful Hint: This parameter is accessed using $[Link] (where uu = UCN

Network number).

NLFM
Type: Integer Nonlinearity Form—Defines the form of the nonlinear gain.
Lock: Supr
Default: 1
PtRes: APM
Range: 0 or 1

NLGAIN
(Pid)
Type: Real Nonlinear Gain—Defines the value of the nonlinear gain factor KNL.
Lock: Supr
Default: 0.0
PtRes: APM
Range: 0.0 to 240.0

NLOC (VdtLdLag)
Type: Integer Number of Locations in Delay Table
Lock: Eng
Default: 30
PtRes: APM
Range: 2 to 30

NLOGSLOT (APM Box)

Type: Integer Number of Logic Slots in the APM—Refer to the APM Control Functions
Lock: PtBld and Algorithms manual for a detailed description of APM processing
Default: 0 capacity.
PtRes: APM
Range: 0 to 80

NMIN (HiLoAvg)
Type: Integer Minimum Number of Good Inputs—Defines the minimum number of
Lock: Supr valid inputs (PV status is good or uncertain) to this algorithm.
Default: 1
PtRes: APM
Range: 1 to N (N is the number of inputs selected by N parameter)

APM Parameter Reference Dictionary N-6 10/96

 NMODATTR

NMODATTR (RegCtl)
Type: E:MODATTR Normal Mode Attribute—Defines whether an operator or a program can
Lock: Engr change certain parameters such as the mode, SP, or OP of a data point
Default: None when the point is in the normal mode.
PtRes: APM
Range: 0-Operator (MODATTR can be set equal to Operator)
1-Program (MODATTR can be set equal to Program)
2-Normal
3-None (MODATTR is not affected by this parameter)

Helpful Hint: If NMODATTR = Operator or Program and the "normal mode" button on the
Operator's keyboard is pressed, MODATTR = NMODATTR. If NMODATTR
is to be changed, the engineer must change it.

NMODE (AnalgOut)
Type: E:MODE Normal Mode—Allows user to define the normal mode for this data point.
Lock: Engr/PB
Default: None
PtRes: APM
Range: 0-None (No configured "normal" operating mode)
1-Man (Manual is configured "normal" mode)
2-Cas (Cascade is configured "normal" mode)

Helpful Hint: NMODE configuration for the Cas option requires RCASOPT = Ddc.

NMODE (DevCtl,
DigComp)
Type: E:MODE Normal Mode—Allows user to define the normal mode for this data point.
Lock: View
Default: Man
PtRes: APM
Range: 1-Man (Manual is the "normal" operating mode)

NMODE (RegCtl)
Type: E:MODE Normal Mode—Allows user to define the normal mode for this data point.
Lock: Engr
Default: None
PtRes: APM
Range: 0-None (No configured "normal" operating mode)
1-Man (Manual is the "normal" operating mode)
2-Cas (Cascade is the "normal" operating mode)
3-Auto (Automatic is the "normal" operating mode)
4-Bcas (Backup Cascade is the "normal" operating mode)

Helpful Hint: Mode. If NMODATTR = None and the "normal mode" button on the
Operator's
keyboard is pressed, MODE is set to the contents of NMODE.

APM Parameter Reference Dictionary N-7 10/96

 NMSGTXT

NMSGTXT (NIM)
Type: Integer Number of Message Text Items—Defines the number of message text
Lock: PtBld items that you can enter. See MSGTXT.
Default: 0
PtRes: NIM
Range: 0 to 15

NN(i) (Array)
Type: Real Array Point Numeric Variables—Numerics are mapped from either the
Lock: Determined APM box (defined by NNUMERIC and NNSTIX parameters) or from a serial
by interface IOP-connected device (when EXTDATA=IO_NN, mapping is
SPLOCK defined by the IOPNUM, FTANUM, DEVADDR, NNSTIX, and NNUMERIC
parameter parameters).
Default: N/A
PtRes: APM
Range: 1 ≤ i ≤ Array parameter NNUMERIC

NN(1)–(8) (DevCtl,
Logic)
Type: Real Numerics 1-8—Eight numerics are provided with each device control and
Lock: Supr logic slot. The numerics can be used as reference values for the comparison
Default: NaN logic algorithms, or they can be used as source parameters for the output
PtRes: APM connections when writing predefined analog constants to other points. The
Range: N/A values of the numerics can be changed from the Universal Station, by other
device control logic slots, or by user-written programs.

NN(1)–(80) (ProcMod)
Type: Real Numeric Variables—Each process module in the APM has 80 numerics
Lock: Determined that can be used for implementing batch operations.
by SPLOCK
parameter
Default: NaN
PtRes: APM
Range: N/A

NN(1)–(16,384) (APM Box)

Type: Real Numeric Value—This is an array of up to 16,384 numeric variables. The
Lock: Oper upper bound of this array is determined by the NNUMERIC parameter.
Default: NaN Numerics NN(1) to NN (2047) are taggable. Numerics NN(1) to NN (4095)
PtRes: APM are accessible from the LCN by using hardware form [].
Numerics 4096 through 16,384 are accessible only through Array points.
Range: N/A

APM Parameter Reference Dictionary N-8 10/96

 NNDESC

NNDESC (Array)
Type: String_64 NN Array Descriptor—Describes NN data for the Array point.
Lock: PtBld
Default: Spaces
PtRes: APM
Range: N/A

NNINSET(1)–(10) (DevCtl)
Type: Integer Numeric 1 - 10—A set of 10 integers that are used by the primary input
in an Array gate IN_SET algorithm.
(1..10)
Lock: Supr
Default: 0
PtRes: APM
Range: 0 to 32767

NNSTIX (Array)
Type: Real Numeric Array Start Index—Defines the start index in Box NN variables,
Lock: PtBld or a serial interface-connected device.
Default: 0
PtRes: APM
Range: 0 to 99,999 (When EXTDATA=IO_NN, 0 can be valid device index)
0 to Box parameter NNUMERIC (When EXTDATA≠IO_NN, 0 indicates no numerics are
configured)

NNUMERIC (APM Box)

Type: Integer Number of Numerics in APM Box Data Point—The number of box
Lock: PtBld numerics is determined in intervals of 16 numerics.
Default: 0
PtRes: APM
Range: 0 to 16,384

NNUMERIC (Array)
Type: Integer Number of Numerics in Array Point NN Array—Defines the number of
Lock: PtBld numerics mapped from either the HPM box (EXTDATA≠ IO_NN), or a
Default: 0 serial interface IOP-connected device (EXTDATA=IO_NN). For external
PtRes: APM data, the valid range depeneds on how numeric data is organized in the
device.

Range: 0 - 16 (Floats), 0 - 32 (Integers), 0 - 64 (Byte Integers) When EXTDATA = IO_NN

0 to 240 When EXTDATA ≠ IO_NN

NOCINPTS (RegCtl)

APM Parameter Reference Dictionary N-9 10/96

Type: Integer Number of Control Input Connections—Defines the number of control
Lock: PtBld input connections for this algorithm.
Default: Based on
CTLALGID,
CTLEQN, M
PtRes: APM
Range: 0 to 4

APM Parameter Reference Dictionary N-10 10/96

 NOCOPTS

NOCOPTS (RegCtl)
Type: Integer Number of Control Output Connections—Defines the number of control
Lock: PtBld output connections from this RegCtl point.
Default: 1
PtRes: APM
Range: 0 to 4

Helpful Hint: Control output engineering ranges (CVEULO, CVEUHI) must be entered
for CTLALGID = PidErfb and Rampsoak, and must be entered for
CTLALGID = Pid, PidFf, and RatioCtl when NOCOPTS = 0. For
CTLALGID = Pid, PidFf, and RatioCtl, with NOCOPTS > 0, the CV
ranges are obtained from a secondary output connection.

NODEASSN (APM Box)

Type: E:$NODEASN Node Assignment—Defines whether this NIM or another NIM is the
Lock: PtBld primary NIM for this UCN.
Default: ThisNIM
PtRes: NIM
Range: ThisNIM (The NIM being configured is responsible for parameter fetch/stores,
alarming, AM control strategy and checkpointing on this UCN.)

RemotNIM (Another NIM is connected to this UCN. The Remote NIM is on a separate
“logical” UCN and must be used when configuring, checkpointing, and restoring
the database through that UCN.)

Helpful Hint: NODEASSN configuration requires NODETYP = NIM or APM (or HPM or
LM).

NODECMD (APM Box)

Type: E: $PMCMD Node Command
Lock: Eng
Default: None
PtRes: APMM
Range: 0 None (No request made to the APM)
1 Run (APM requested to goto the run state)
2 Idle (APM requested to goto the idle state)
3 Warmstrt (APM requested)
4 Coldstrt (APM requested)
5 Pause (APM requested to goto the Simul_Pause state)
6 Resume (APM requested to goto the Simul_Run state)

NODECONF (APM Box)

Type: E:$PMCONF Node Configuration for the APM—Currently not used. This parameter
Lock: View must always be set to manual.
Default: Manual
PtRes: APM
Range: Manual
Auto

APM Parameter Reference Dictionary N-11 10/96

 NODENUM

NODENUM (NIM)
Type: Integer Node Number—Defines the address of the NIM on the UCN.
Lock: PtBld
Default: N/A
PtRes: NIM
Range: 1 to 64

NOTE

The node number assigned to the NIM should be the lowest node number on the UCN
(see TIMESYNC).

NODENUM (APM Box)

Type: Integer Node Number—Defines the address of the APMs on the UCN. NODENUM
Lock: PtBld assigned for any APM must be odd whether PKGOPT equals
Default: N/A Option 1 (nonredundant) or Option 2 (redundant). Because of this restriction
PtRes: NIM and because the NIM takes up one odd address and the next even address,
Range: 1 to 64 the maximum number of APM's that can be on the UCN is 31. The primary
APMM is assigned an odd address, the associated secondary (redundant)
APMM is assigned the next (even) address.

NODEOPER
Type: E:$PRIMSEC Node Operating Mode
Lock: View
Default:
PtRes: NIM
Range: Primary (APM/NIM is the acting primary node)
Secndry (APM/NIM is the acting secondary)

NODESC (Logic)
Type: Integer Number of Generic Descriptors—Defines the number of user-defined
Lock: PTBLD generic descriptors that are to be used on this logic slot. For each
Default: 0 descriptor, the parameter in the logic slot to which the generic descriptor is
PtRes: NIM attached is defined by the PRMDESC(n) parameter, and the corresponding
Range: 0 to 12 descriptors are defined by the GENDESC(n) parameters. This allows the
user to customize the descriptors used for displaying the logic slot on the
Universal Station displays.

APM Parameter Reference Dictionary N-12 10/96

 NODESTS

NODESTS (NIM)
Type: E: $DSPSTAT NIM Node Summary Status—Indicates the current overall status of the
Lock: View NIM.
Default: N/A
PtRes: NIM
Range: OffNet (NIM cannot communicate with APMM)
OK (NIM is performing normally)

NODESTS (NIM, APM

Box)
Type: E: Node Summary Status
$DSPSTAT
Lock: View
Default: N/A
PtRes: APMM
Range: 0 OK (APM is performing normally)
1 IOIDL (At least one IOP has entered the idle state)
2 Idle
3 PF_IOIDL (Partial failure in one or more idle IOPs)
4 PF_IDLE (Partial failure in APMM that is in idle state)
5 PartFail (Partial failure in APMM that is in run state)
6 Failed (APMM has sent a “Failed” message to the NIM)
7 Alive (No events reports or point processing)
8 Loading (APMM ‘s personality or data base is loading)
9 PowerOn (Transitional state when Power is applied to APMM)
10 Offnet (NIM cannot communicate with APM)
11 NoSynch
12 NotConfg (APMM cannot be found on the UCN)
13 ConfgMis (IOP mismatch in NIM box point)
20 S_OK (OK in IOSM)
21 S_IOIDL (IOIDL in IOSM)
22 S_IDLE (IDLE in IOSM)
23 S_PFIOIL (PF_IOIDL in IOSM)
24 S_PFIDLE (PF_IDLE in IOSM)
25 S_PTFail (PartFail in IOSM)
26 S_Pause (APM is in the Simulation Pause state)

Helpful Hint: Loading the APMM's operating personality requires NODESTS = Alive.

NODESTAT (NIM)
Type: E:$NODESTA NIM's Node Status
Lock: View
Default: N/A
PtRes: NIM
Range: OffNet (NIM is not running on UCN)
OK (NIM is configured and running)

APM Parameter Reference Dictionary N-13 10/96

 NODESTAT

NODESTAT (APM)
Type: E:$NODESTA APM Node Status
Lock: View
Default: N/A
PtRes: APM
Range: OffNet (APM is not running on UCN)
ConfgMis (APM has a configuration mismatch)
OK (APM is configured and running)

NODETYP (NIM)
Type: E:$UCNNDTY UCN Node Type—Defines the node type of this UCN node.
Lock: PtBld
Default: NIM
PtRes: NIM
Range: NIM (Network Interface Module)

NODETYP (APM Box)

Type: E:$UCNNDTY UCN Node Type—Defines the node type of this UCN node.
Lock: PtBld
Default: APM
PtRes: NIM
Range: APM (Advanced Process Manager)

NODETYP (APM
Points)
Type: E:$UCNNDTY UCN Node Type—Defines which node type supports this point.
Lock: PtBld
Default: APM
PtRes: NIM
Range: APM (Advanced Process Manager)

NODFSTAT (APM Box)

Type: E:$NODFSTA Node's Functional Status—Defines the status of the UCN node.
Lock: Supr
Default: Basic
PtRes: NIM
Range: Full (All LCN devices can read/write from/to this node)
Basic (AM and CM cannot write to this node)

APM Parameter Reference Dictionary N-14 10/96

 NODINPTS

NODINPTS (DevCtl, DigComp)

Type: Integer Number of Digital Inputs—Defines the number of digital input connections
Lock: PtBld to this data point.
Default: 1
PtRes: APM
Range: 0 (No inputs)
1 (One input)
2 (Two inputs)

NODOPTS (DevCtl,
DigComp)
Type: Integer Number of Digital Outputs—Defines the number of digital output
Lock: PtBld connections from this data point.
Default: 1
PtRes: APM
Range: 0 (No outputs)
1 (One output)
2 (Two outputs)
3 (Three outputs)

NOLINPTS (DevCtl, Logic)

Type: Integer Number of Logic Inputs—Indicates the number of logic inputs to this logic
Lock: View (Logic), or Device Control slot.
PtBld
(DevCtl)
Default: 12 (Logic)
0 (DevCtl)
PtRes: APM
Range: 0 to 12

NOLOGBLK (Logic)
Type: Integer Number of Logic Blocks—Indicates the number of logic blocks that have
Lock: View been configured for a particular logic slot.
Default: N/A
PtRes: APM
Range: 0 to 24

NOLOPTS (DevCtl, Logic)

Type: Integer Number of Logic Output Connections—Indicates the number of output
Lock: View (Logic) connections from this logic slot.
PtBld
(DevCtl)
Default: N/A
PtRes: APM
Range: 0 to 12 (Logic), 0 to 2 (DevCtl)

APM Parameter Reference Dictionary N-15 10/96

 NOPGATE

NOPGATE (DevCtl)
Type: Integer Number of Primary Gates—Indicates the number of primary gates
Lock: PtBld configured for a particular Device Control slot.
Default: 0
PtRes: APM
Range: 0 to 4

Helpful Hint: All configured primary gates must have at least one input.

NOPINPTS (RegPV)
Type: Integer Number of PV Input Connections—Defines the number of PV input
Lock: View connections to this algorithm.
Default: Based on
PVALGID,
PVEQN, N
PtRes: APM
Range: 0 to 6

NORQUAVG (NIM, APM

Box)
Type: Real Average number of Nodes to which UCN Requests are made—
Lock: View Indicates the average number of UCN nodes per second that this node is
Default: 0 requesting communications with.
PtRes: APM
Range: N/A

Helpful Hint: This statistic can be viewed on the Toolkit Displays.

NORQUMAX (NIM, APM

Box)
Type: Real Maximum number of Nodes to which UCN Requests are made—
Lock: View Indicates the maximum number of UCN nodes per second that this node is
Default: 0 requesting communications with.
PtRes: APM
Range: N/A

Helpful Hint: This statistic can be viewed on the Toolkit Displays.

NORSPAVG (NIM, APM

Box)
Type: Real Average number of Nodes to which UCN Responses are made—
Lock: View Indicates the average number of UCN nodes per second that this node is
Default: 0 responding to.
PtRes: APM
Range: N/A

APM Parameter Reference Dictionary N-16 10/96

 Helpful Hint: This statistic can be viewed on the Toolkit Displays.

APM Parameter Reference Dictionary N-17 10/96

 NORSPMAX

NORSPMAX (NIM, APM

Box)
Type: Real Maximum number of Nodes to which UCN Responses are made—
Lock: View Indicates the maximum number of UCN nodes per second that this node is
Default: 0 responding to.
PtRes: APM
Range: N/A

Helpful Hint: This statistic can be viewed on the Toolkit Displays.

NORSSEQ (RampSoak)
Type: Integer Number of Ramp/Soak Pairs in the Sequence
Lock: Eng/PB
Default: 2
PtRes: APM
Range: 2 to 12

NOSGATE (DevCtl)
Type: Integer Number of Secondary Gates— Indicates the number of secondary gates
Lock: PtBld configured for a particular Device Control slot.
Default: 0
PtRes: APM
Range: 0 to 2

Helpful Hint: All configured secondary gates must have at least one input.

NOTRAAVG (NIM, APM

Box)
Type: Real Average number of Nodes to which UCN Transactions are made.
Lock: View This value indicates the average number of UCN nodes (per second) that
Default: 0 this node is communicating with (both requests and responses).
PtRes: APM
Range: N/A

Helpful Hint: This statistic can be viewed on the Toolkit Displays.

NOTRAMAX (NIM, APM

Box)
Type: Real Maximum number of Nodes to which UCN Transactions are made.
Lock: View This value indicates the maximum number of UCN nodes (per second)
Default: 0 that this node is communicating with (both requests and responses).
PtRes: APM
Range: N/A

Helpful Hint: This statistic can be viewed on the Toolkit Displays.

APM Parameter Reference Dictionary N-18 10/96

 NOSIOVRD

NOSIOVRD (DevCtl,
DigComp)
Type: Real Number of Safety Interlock Overrides— The number of safety interlock
Lock: View overrides that have accumulated since the most recent reset of maintenance
Default: 0.0 statistics.
PtRes: APM
Range: 0 (No limit)

NOSTATES (DevCtl, DigComp)

Type: Integer Number of Digital States—Defines the number of states in this point.
Lock: PtBld • State 1 is the first active state
Default: 2 • State 0 is the inactive (middle) state
PtRes: APM • State 2 is the second active state
Refer to the APM Control Functions and Algorithms manual for a detailed
description.
Range: 2 (Two states can be configured: STATE 0 and STATE 1)
3 (Three states can be configured: STATE 0, STATE 1, and STATE 2)

NOTRANS0–2 (DevCtl,
DigComp)
Type: Real Accumulated Transitions—The number of transitions to each state of the
Lock: View OPFINAL parameter since the most recent reset of maintenance statistics.
Default: 0.0 The MAXTRAN parameter does not limit the number of transactions unless
PtRes: APM the user writes a program to read MAXTRAN, comparing it to NOTRANS,
and thereby causing it to stop.
Range: 0 (No limit)

NPARAVG (NIM, APM

Box)
Type: Real Average number of UCN Parameter Accesses per Second—Average
Lock: View number of UCN parameter accesses per second between this node and all
Default: 0 other nodes, including both requests and responses.
PtRes: APM
Range: N/A

Helpful Hint: This statistic can be viewed on the Toolkit Displays.

NPARMAX (NIM, APM

Box)
Type: Real Maximum number of UCN Parameter Accesses per Second—
Lock: View Maximum number of UCN parameter accesses per second between this
Default: 0 node and all other nodes, including both requests and responses.
PtRes: APM
Range: N/A

Helpful Hint: This statistic can be viewed on the Toolkit Displays.

APM Parameter Reference Dictionary N-19 10/96

 NPMSLOT

NPMSLOT (APM Box)

Type: Integer Number of Process Module Slots—Refer to the APM Control Functions
Lock: PtBld and Algorithms manual for a detailed description of APM processing
Default: 0 capacity.
PtRes: APM
Range: 0 to 160

NPRQUAVG(0-64) (NIM, APM

Box)
Type: Real Average number of UCN Parameter Requests—Average number of
Lock: View UCN parameter requests per second issued from this node to node n.
Default: 0
PtRes: APM
Range: N/A

NOTE

The node address (n) is an odd number (1, 3, 5,...63). Using an even number
results in a Parameter_Invalid error. Using n = 0 returns average total
number of parameter requests to all other nodes.

Helpful Hint: This statistic can be viewed on the Toolkit Displays.

NPRQUMAX(0-64) (NIM, APM

Box)
Type: Real Maximum number of UCN Parameter Requests—Maximum number of
Lock: View UCN parameter requests per second issued from this node to node n.
Default: 0
PtRes: APM
Range: N/A

NOTE

The node address (n) is an odd number (1, 3, 5,...63). Using an even number
results in a Parameter_Invalid error. Using n = 0 returns maximum total
number of parameter requests to all other nodes.

Helpful Hint: This statistic can be viewed on the Toolkit Displays.

APM Parameter Reference Dictionary N-20 10/96

 NPRSPAVG

NPRSPAVG(0-64) (NIM, APM

Box)
Type: Real Average number of UCN Parameter Responses—Average number of
Lock: View UCN parameter responses per second issued from this node to node n.
Default: 0
PtRes: APM
Range: N/A

NOTE

The node address (n) is an odd number (1, 3, 5,...63). Using an even number
results in a Parameter_Invalid error. Using n = 0 returns average total
number of parameter responses to all other nodes.

Helpful Hint: This statistic can be viewed on the Toolkit Displays.

NPRSPMAX(0-64) (NIM, APM

Box)
Type: Real Maximum number of UCN Parameter Responses—Maximum number
Lock: View of UCN parameter responses per second issued from this node to node n.
Default: 0
PtRes: APM
Range: N/A

NOTE

The node address (n) is an odd number (1, 3, 5,...63). Using an even number
results in a Parameter_Invalid error. Using n = 0 returns maximum total
number of parameter responses to all other nodes.

Helpful Hint: This statistic can be viewed on the Toolkit Displays.

NPVSLOT (APM Box)

Type: Integer Number of Regulatory PV Slots—Refer to the APM Control Functions and
Lock: PtBld Algorithms manual for a detailed description of APM processing capacity.
Default: 0
PtRes: APM
Range: 0 to 80

APM Parameter Reference Dictionary N-21 10/96

 NSCANITM

NSCANITM (APM Box)

Type: Integer Number of Scan Items in APM Scan Table.
Lock: View
Default: 0
PtRes: APM
Range: 0 - 50

NSI0 (DevCtl, DigComp)

Type: Logical Inverted Interlocks Value—The negative value of the corresponding
Lock: Engr interlock.
Default: On
PtRes: APM
Range: On (Safety interlock inactive)
Off (Safety interlock active)

Helpful Hint: This parameter can be changed by the engineer only if the point is inactive,
or if the APM is idle.

NSTRING (APM Box)

Type: Integer Number of Strings in APM Box Data Point
Lock: PtBld
Default: 0
PtRes: APM
Range: 0 to 16,384

NSTRING (Array)
Type: Integer Number of Strings in Array Point String Array—Defines the number of
Lock: PtBld strings (length specified by the STRLEN parameter) mapped to the Array
Default: 0 point from either the APM box (EXTDATA≠ IO_STR), or a serial interface
PtRes: APM IOP-connected device (EXTDATA=IO_STR).
Range: 0 to 8 (When EXTDATA=IO_STR)
0 to 240 (When EXTDATA≠ IO_STR)

Helpful Hint: When EXTDATA≠ IO_STR, the range for this parameter applies regardless
of the value of the STRLEN parameter (up to 240 strings, either 8, 16, 32, or
64 characters in length can be mapped to the Array point from the APM
box).
When EXTDATA=IO_STR, only 64 characters of string data are available
(i.e., one 64-character string, two 32-character strings, four 16-character
strings, or eight 8-character strings).

NTIME (APM Box)

Type: Integer Number of Times in APM Box Data Point
Lock: PtBld
Default: 0
PtRes: APM
Range: 0 to 4,096

APM Parameter Reference Dictionary N-22 10/96

 NTIME

NTIME (Array)
Type: Integer Number of Times in Array Point Time Array—Defines the number of
Lock: PtBld Times the Array point has mapped from the APM box.
Default: 0
PtRes: APM
Range: 0 to 240

NTIMER (APM Box)

Type: Integer Number of Timer Points in the APM Box Data Point
Lock: View
Default: 64
PtRes: APM
Range: 64

NTRAAVG (NIM, APM

Box)
Type: Real Average number of UCN Transactions —Average number of UCN
Lock: View transactions (requests and responses) per second between this node and all
Default: 0 other nodes.
PtRes: APM
Range: N/A

Helpful Hint: This statistic can be viewed on the Toolkit Displays.

NTRAMAX (NIM, APM

Box)
Type: Real Maximum number of UCN Transactions —Maximum number of UCN
Lock: View transactions (requests and responses) per second between this node and all
Default: 0 other nodes.
PtRes: APM
Range: N/A

Helpful Hint: This statistic can be viewed on the Toolkit Displays.

APM Parameter Reference Dictionary N-23 10/96

 NTRQUAVG

NTRQUAVG(0-64) (NIM, APM

Box)
Type: Real Average number of UCN Transaction Requests—Average number of
Lock: View UCN transaction requests per second issued from this node to node n.
Default: 0
PtRes: APM
Range: N/A

NOTE

The node address (n) is typically an odd number (1, 3, 5,...63). Using an even
number results in a Parameter_Invalid error. Using n = 0 returns average
total number of transaction requests to all other nodes.

Helpful Hint: This statistic can be viewed on the Toolkit Displays.

NTRQUMAX(0-64) (NIM, APM

Box)
Type: Real Maximum number of UCN Transaction Requests—Maximum number
Lock: View of UCN transaction requests per second issued from this node to node n.
Default: 0
PtRes: APM
Range: N/A

NOTE

The node address (n) is an odd number (1, 3, 5,...63). Using an even number
results in a Parameter_Invalid error. Using n = 0 returns maximum total
number of transaction requests to all other nodes.

Helpful Hint: This statistic can be viewed on the Toolkit Displays.

NTRSPAVG(0-64) (NIM, APM

Box)
Type: Real Average number of UCN Transaction Responses—Average number of
Lock: View UCN transaction responses per second issued from this node to node n.
Default: 0
PtRes: APM
Range: N/A

NOTE
The node address (n) is an odd number (1, 3, 5,...63). Using an even number
results in a Parameter_Invalid error. Using n = 0 returns average total
number of transaction responses to all other nodes.

Helpful Hint: This statistic can be viewed on the Toolkit Displays.

APM Parameter Reference Dictionary N-24 10/96

 NTRSPMAX

NTRSPMAX(0-64) (NIM, APM

Box)
Type: Real Maximum number of UCN Transaction Responses—Maximum number
Lock: View of UCN transaction responses per second issued from this node to node n.
Default: 0
PtRes: APM
Range: N/A

NOTE

The node address (n) is an odd number (1, 3, 5,...63). Using an even number
results in a Parameter_Invalid error. Using n = 0 returns maximum total
number of transaction responses to all other nodes.

Helpful Hint: This statistic can be viewed on the Toolkit Displays.

NTWKNUM
Type: Integer Network Number—Defines on which UCN the NIM and APMs reside.
Lock: PtBld
Default: N/A`
PtRes: NIM
Range: 1 to 20

NXTPINAM (N)
Type: String_8 Next PI File to be loaded—Defines the personality image file that will be
Lock: Eng loaded on the next personality load request for this IOP.
Default: N/A
PtRes: IOP
Range: N/A

NXTSOAKV (RampSoak)
Type: Real Next Soak Value
Lock: View
Default: N/A
PtRes: APM
Range: > 0.0

APM Parameter Reference Dictionary N-25 10/96

APM Parameter Reference Dictionary N-26 10/96
 OFFNRMFL

-O-

OFFNRMFL (DevCtl, DigIn,

DigComp)
Type: Logical Off-Normal Alarm Flag—Indicates whether an off-normal alarm has been
Lock: View detected at this data point.
Default: Off
PtRes: APM
Range: Off (No alarm)
On (Current PV state is not the same as the configured PVNORMAL state.)

OFFNRMPR (DevCtl, DigComp, DigIn,

FL)
Type: E:ALPRIOR Offnormal Alarm Priority—Indicates priority of the off normal or change
Lock: Engr of state alarm.
Default:
Low
PtRes: NIM
Range Emergncy (Alarm is historized, annunciated, and reported to all alarm summary displays)
High (Alarm is historized, reported to Area Alarm Summary Display and Unit Alarm
Summary
Display)
Low (Alarm is historized, reported to the Unit Alarm Summary Display, and annunciated)
JnlPrint (Alarm is historized and reported to the printer but not annunciated)
Printer (Alarm is reported to the printer but not historized and not annunciated)
Journal (Alarm is historized but not reported to Universal Stations and not annunciated)
NoAction (Alarm is not reported to the system and not annunciated)

OFFPULSE (DigOut)
Type: Real Off Pulse Command—Command that sets output SO to Off for the
Lock: Oper specified number of seconds. At the end of the pulse time, SO is set to On.
Default: N/A If 0.0 is entered for OFFPULSE, SO is immediately set to On.
PtRes: APM
Range: 0.0 to 60.0 seconds

Helpful Hint: OFFPULSE can be written to by only those entities that possess the
APMM Cont_Ctl (continuous control) access level. These are Digital
Composite points, Logic points, and Regulatory Control Position
Proportional points.

APM Parameter Reference Dictionary O-1 10/96

 OLDAV

OLDAV (DigIn)
Type: Integer Old Accumulated Value—The value of parameter AV (accumulated
Lock: View value) just before the accumulator was reset. This parameter makes the
Default: N/A previous accumulated value available for those functions that need it.
PtRes: APM
Range: >0

OLDAV
(Totalizr)
Type: Real Old Accumulated Value—The value of parameter PVCALC (calculated
Lock: View PV) just before it is reset. This parameter makes the previous total
Default: N/A available to those functions that need it.
PtRes: APM
Range: > 0.0

ONPULSE (DigOut)
Type: Real On Pulse Command—Command that sets output SO to On for the specified
Lock: Oper number of seconds. At the end of the pulse time, SO is set to Off. If 0.0 is
Default: N/A entered for ONPULSE, SO is immediately set to Off.
PtRes: APM
Range: 0.0 to 60.0 seconds

Helpful Hint: ONPULSE can be written to by only those entities that possess the APMM
Cont_Ctl (continuous control) access level. These are Digital Composite
points, Logic points, and Regulatory Control Position Proportional points.

OP
(AnalgOut)
Type: Real Output in Percent—Defines the output value from this point in percent.
Lock: Oper
Default: -6.9% of full scale
PtRes: APM
Range: -6.9 to 106.9%

Helpful Hint: To manually change the output value requires MODE = Man and
REDTAG = Off.

APM Parameter Reference Dictionary O-2 10/96

 OP

OP (DevCtl, DigComp)
Type: E:SD-ENM:STATETXT Digital State Output—Indicates the last commanded
Lock: Oper output state. See also OPFINAL. For Status Outputs, use SO.
Default: STATETXT(0)
PtRes: APM
Range: STATETXT(0) Descriptor
STATETXT(1) Descriptor
STATETXT(2) Descriptor (internally set to $NULL for two-state devices)
STATETXT(3) None (Not configurable)

Helpful Hint: OP indicates text for the last commanded output state (i.e., On, Run, etc.).
Output state change requires MODE = Man, SHUTDOWN = Off, and
REDTAG = Off.

OP (DigOut)
Type: Real Pulsed Digital Output—OP is the percent on-time for the pulsed output. It
Lock: Prog can be written to by only the controlling slot in the APMM, such as from the
Default: 0.0% PosProp RegCtl algorithm. Output change requires DOTYPE = Pwm. OP
PtRes: APM (DigOut) has the same access-level requirement as OFFPULSE and
Range: 0.0 to 100.0% ONPULSE; the writing entity must have an APMM access level of
Cont_Ctrl (continuous
control). For Status Outputs, use SO.

For direct action, pulse-on time is calculated as follows:

Pulse On-Time = OP% * PERIOD

100
For reverse action:

Pulse On-Time = 100% - OP% * PERIOD

100
Refer to PERIOD parameter for length of period.

OP (RegCtl)
Type: Real Regulatory Control Output—OP is derived from CV, the variable
Lock: Oper calculated by the control algorithm. OP is checked for minimum
Default: -6.9% of full scale output change, output rate-of-change, and output high and low
PtRes: APM limits. If any of the limits is exceeded, OP is adjusted or clamped
Range: -6.9 to 106.9% as applicable. OP remains in percent of full scale if it is going to a
final control element through an IOP Card. If OP is going to a
secondary data point, its value is converted to the engineering units
of the receiving data
point's setpoint (SP).

Helpful Hint: OP change requires MODE = Man, SHUTDOWN = Off, and REDTAG = Off.
If the OP is manually set above or below the OP limits and the mode is then
changed to automatic or cascade, a process bump may occur.

APM Parameter Reference Dictionary O-3 10/96

 OPALDB

OPALDB (RegCtl)
Type: Real Output Alarm Dead Band—The deadband for the Regulatory
Lock: EngPB Control OP alarm. It is used to prevent excessive recurrence of
Default: 5 Output Units alarms by adjusting the range of the output at which the alarm
PtRes: APM "returns to normal." Available on Release 510 and later software.
Range: 0 to 25 Output
Units

Helpful Hint: The value of OPALDB must be less than or equal to (OPHITP - OPLOTP)/2.

OPCHAR
Type: Logical Output Characterization Option—Defines whether the output
Lock: PtBld characterization option is to be used for this data point. If this
Default: Off option is to be implemented, the user must supply the values for the
PtRes: APM input coordinates (OPIN 1–4) and output coordinates (OPOUT 1–4).
Refer to the APM Control Functions and Algorithms manual for a
detailed description of output characterization.
Range: On (Output characterization is to be used)
Off (Output characterization is not to be used)

OPCMD (DevCtl, DigComp)

Type: Logical Output Command
Lock: Prog
Default: Off
PtRes: APM
Range: Off (Commands the output state to State0)
On (Commands the output state to State1)

Helpful Hint: If state change did not occur, OPCMD has to be set to the current state,
and then to the desired state.

OPCMD
Type: E:$OPCMD Output Command—Indicates the current output command.
Lock: View
Default: NA
PtRes: APM
Range: 0-Idle (Output is not being affected by Output Command)
1-Lower (Output is being lowered)
2-Raise (Output is being raised)

APM Parameter Reference Dictionary O-4 10/96

 OPEU

OPEU
Type: Real Output Value in Engineering Units
Lock: View
Default: N/A
PtRes: APM
Range: N/A

OPFINAL
(AO)
Type: Real Final Percent Output Sent to Control Element—Output value
Lock: View after direct or reverse control action and output characterization
Default: -6.9% of have all been applied. If output has been configured for direct
full scale action (OPTDIR), 0.0% represents 4 mA to the control element and
PtRes: APM 100% represents 20 mA. If configured for reverse action, 0.0%
Range: N/A represents 20 mA, and 100% represents 4 mA.

OPFINAL (DevCtl, DigComp)

Type:
E:SD_ENM:STATETX
T Final Output Sent to Control Element—The output value that was last
Lock: Oper stored. This value can differ from the OP parameter if a sealin has occurred,
Default: Statetxt(0) state change is active, or the Array/SI read-back check evaluates OPFINAL
PtRes: APM to be NONE. If LOCALMAN = ON, then OP and OPFINAL follow the PV.

Range: Statetxt(0) (Self-defining enumeration)

Statetxt(1) (Self-defining enumeration)
Statetxt(2) (Self-defining enumeration)—internally set to $NULL for two-state devices.
Statetxt(3) NONE (not configurable)

OPHAFL
(RegCtl)
Type: Logical Output High Alarm Flag—Indicates when a Regulatory Control Output
Lock: View High alarm has been detected at this data point. This flag is set when the
Default: Off output value (OP) exceeds OPHITP and is reset when OP is below OPHITP
PtRes: APM minus the deadband. Available on Release 510 and later software.

Range: Off (OP High Alarm is off)

On (OP High Alarm is on)

Helpful Hint: Refer to the diagram with OPLAFL.

APM Parameter Reference Dictionary O-5 10/96

OPHIFL (RegCtl)
Type: Logical Output High Limit Flag—Indicates whether the OP value has reached its
Lock: Prog upper
Default: Off limit specified by OPHILM. If this parameter is set by a program, it will
PtRes: APM inhibit “raise” commands.
Range: Off
On (OP value has reached its upper limit)

OPHILM

OPHILM
Type: Real Output High Limit in Percent
Lock: Supr
Default: 105.0%
PtRes: APM
Range: OPLOLM to 106.9%,
NaN

Helpful Hint: Entering NaN disables limit checking by forcing OPHILM to its extreme
value
(106.9%).

OPHIPR (RegCtl)
Type: E:Alprior Output High Alarm Priority—Specifies the priority of the Regulatory
Lock: EngPB Control Output High alarm. Available on Release 510 and later software.
Default:
Low
PtRes: NIM
Range: JnlPrint (Alarm is historized and reported to the printer but not annunciated)
Printer (Alarm is reported to the printer but not historized and not annunciated)
Emergncy (Alarm is historized, annunciated, and reported to all alarm summary displays)
High (Alarm is historized, reported to Area Alarm Summary Display and Unit Alarm
Summary
Display)
Low (Alarm is historized, reported to the Unit Alarm Summary Display, and annunciated)
Journal (Alarm is historized but not reported to Universal Stations and not annunciated)
NoAction (Alarm is not reported to the system and not annunciated)

APM Parameter Reference Dictionary O-6 10/96

 OPHISRC

OPHISRC
Type: Universal Output High Flag Input Source—Defines the input connection that
[Link] fetches the OPHIFL parameter to determine windup state.
Lock: PtBld
Default: Null
PtRes: APM
Range: Use [Link] for tagged points where Tagname can be up to 16 characters and
the permissible character set is as follows:
Alphabetics A-Z (uppercase only)
Numerics 0-9 (an all numeric tag name is not allowed)
Underscore (_) cannot be used as the first character or the last character, and
consecutive underscores are not allowed.
Embedded space characters are not allowed.
An * is used to default to this point's tag name.
Parameter name can be up to eight characters and must be a legitimate parameter
name.

Some possible input-connection sources are

a."DigIn slot [Link]"
b."Logic slot [Link](nn)" where nn = 1–24
c."Logic slot [Link](nn)" where nn = 1–12
d."ProcMod slot [Link](nnn)" where nnn = 1–127
e."Box Flag slot [Link]
f."" for a box flag that resides in the same box where nnnn = 1–16, 384
g."$[Link](nnnn)" for a box flag that resides in a different APM box on the
same UCN; hh is the NIM UCN address, xx is the APM box number, and
nnnn = 1–4095 (Data access limit)

Use the hardware reference address ![Link] for untagged or tagged points
where
MT is the IOP type, such as DI (Digital Input)
mm is the IOP Card number (1–40)
The letter "S" is a constant
ss is the slot number on the IOP Card (refer to SLOTNUM parameter)
Parameter name can be up to eight characters and must be a legitimate parameter
name.

OPHITP (RegCtl)
Type: Real Output High Alarm Trip Point—The Regulatory Control Output High
Lock: Supr alarm is set when the output value (OP) exceeds the high alarm limit
Default: NaN specified by OPHITP. The alarm is removed when OP returns to normal. A
PtRes: APM suitable dead band is provided by OPALDB. See also OPHIPR and the
drawing with OPLAFL. Available on Release 510 and later software.

Range: OPLOTP to OPHILM, NaN

Helpful Hint: The Regulatory Control Output High alarm is only available for points
configured as full. The alarm is disabled if OPHITP is not configured.

OPIN0
Type: Real Input Coordinate Number 0 in Percent—Defines the OPIN0 coordinate
Lock: View when output characterization has been selected (OPCHAR is On). This
Default: -6.9% coordinate is fixed at -6.9%.
PtRes: APM
Range: N/A

APM Parameter Reference Dictionary O-7 10/96

 OPIN1-4
OPIN1–4
Type: Real Input Coordinate Number 1, 2, 3, or 4 in Percent—Define the OPIN1–
Lock: Supr OPIN4 coordinates when output characterization has been selected
Default: N/A (OPCHAR is On).
PtRes: APM
Range: ≥ previous coordinate
≤ next coordinate

OPIN5
Type: Real Input Coordinate Number 5 in Percent—Defines the OPIN5 coordinate
Lock: View when output characterization has been selected (OPCHAR is On). This
Default: 106.9% coordinate is fixed at 106.9%.
PtRes: APM
Range: N/A

OPLAFL
(RegCtl)
Type: Logical Output Low Alarm Flag—Indicates if a Regulatory Control Output Low
Lock: View alarm has been detected at this data point. This flag is set when the output
Default: Off value (OP) is less than OPLOTP and is reset when OP is above OPLOTP
PtRes: HPM plus the deadband. Available on Release 510 and later software.

Range: Off (OP Low alarm is off).

On (OP Low alarm is on).

The drawing below illustrates the relationship of the output high/low alarm flags, the low
alarm trip point OPLOTP, and the deadband OPALDB.

OP

OPHITP
OPHAFL is turned off
if OP is below this point
OPALDB

OPLAFL is turned off

if OP is above this point

OPHITP - OPALDB

OPLOTP + OPALDB OPALDB

OPLOTP
0

APM Parameter Reference Dictionary O-8 10/96

 OPLOFL

OPLOFL
Type: Logical Output Low Limit Flag—Indicates whether the output value OP has
Lock: Prog reached the low limit. This parameter must be set by a program or logic
Default: Off point. It will inhibit "raise" commands.
PtRes: APM
Range: Off (OP is above the low limit)
On (OP has reached the low limit)

OPLOLM
Type: Real Output Low Limit in Percent
Lock: Supr
Default: -5.0%
PtRes: APM
Range: -6.9% to OPHILM,
NaN

Helpful Hint: Entering NaN disables limit checking by forcing OPLOLM to its extreme
value (-6.9%).

OPLOPR (RegCtl)
Type: E:Alprior Output Low Alarm Priority—Specifies the priority of the Regulatory
Lock: EngPB Control Output Low alarm. Available on Release 510 and later software.
Default:
Low
PtRes: NIM
Range: JnlPrint (Alarm is historized and reported to the printer but not annunciated)
Printer (Alarm is reported to the printer but not historized and not annunciated)
Emergncy (Alarm is historized, annunciated, and reported to all alarm summary displays)
High (Alarm is historized, reported to Area Alarm Summary Display and Unit Alarm
Summary
Display)
Low (Alarm is historized, reported to the Unit Alarm Summary Display, and annunciated)
Journal (Alarm is historized but not reported to Universal Stations and not annunciated)
NoAction (Alarm is not reported to the system and not annunciated)

APM Parameter Reference Dictionary O-9 10/96

 OPLOSRC

OPLOSRC
Type: Universal Output Low Flag Input Source—Indicates which input connection fetches
[Link] the OPLOFL parameter to determine the windup state.
Lock: APM
Default: PtBld
PtRes: Null
Range: Use [Link] for tagged points where Tagname can be up to 16 characters and
the permissible character set is as follows:
Alphabetics A-Z (uppercase only)
Numerics 0-9 (an all numeric tag name is not allowed)
Underscore (_) cannot be used as the first character or the last character, and
consecutive underscores are not allowed.
Embedded space characters are not allowed.
An * is used to default to this point's tag name.
Parameter name can be up to eight characters and must be a legitimate parameter
name.

Some possible input-connection sources are

a."DigIn slot [Link]"
b."Logic slot [Link](nn)" where nn = 1–24
c."Logic slot [Link](nn)" where nn = 1–12
d."ProcMod slot [Link](nnn)" where nnn = 1–127
e."Box Flag slot [Link]
f."" for a box flag that resides in the same box where nnnn = 1–4095
g."$[Link](nnnn)" for a box flag that resides in a different APM box on the
same UCN; hh is the NIM UCN address, xx is the APM box number, and
nnnn = 1–4095 (Data access limit)

Use the hardware reference address ![Link] for untagged or tagged points
where
MT is the IOP type, such as DI (Digital Input)
mm is the IOP Card number (1–40)
The letter "S" is a constant
ss is the slot number on the IOP Card (refer to SLOTNUM parameter)
Parameter name can be up to eight characters and must be a legitimate parameter
name.

OPLOTP
(RegCtl)
Type: Real Output Low Alarm Trip Point—The Regulatory Control Output Low alarm
Lock: Supr is set when the output value (OP) drops below the low alarm limit specified
Default: NaN by OPLOTP. The alarm is removed when OP returns to normal. A suitable
PtRes: APM dead band is provided by OPALDB. See also OPLOPR. Available on
Release 510 and later software.

Range: OPLOLM to OPHITP, NaN

Helpful Hint: The Regulatory Control Output Low alarm is only available for points
configured as full. The alarm is disabled if OPLOTP is not configured.

APM Parameter Reference Dictionary O-10 10/96

 OPMCHLM

OPMCHLM
Type: Real Output Minimum Change in Percent
Lock: Supr
Default: 0.0
PtRes: APM
Range: > 0.0,
NaN

Helpful Hint: OP changes only if new output % - old output % is greater than the
percentage
in parameter OPMCHLM. Entering NaN disables limit checking by forcing
OPMCHLM to its extreme value (0.0).

OPOUT 0
Type: Real Output Coordinate Number 0 in Percent—Defines the OPOUT0
Lock: View coordinate when output characterization has been selected. (OPCHAR =
Default: -6.9% On) This coordinate is fixed at a value of -6.9%.
PtRes: APM
Range: N/A

OPOUT1–4
Type: Real Output Coordinates Number 1, 2, 3, or 4 in Percent—Define the
Lock: Supr OPOUT1–OPOUT4 coordinates when output characterization has been
Default: N/A selected (OPCHAR is On).
PtRes: APM
Range: ≥ previous coordinate
≤ next coordinate

OPOUT 5
Type: Real Output Coordinate Number 5 in Percent—Defines the OPOUT5
Lock: View coordinate when output characterization has been selected. (OPCHAR =
Default: 106.9% On) This coordinate is fixed at a value of 106.9%.
PtRes: APM
Range: N/A

OPRATRFL
Type: Logical Operator Mode Attribute Flag—Indicates whether the current mode
Lock: View attribute is Operator.
Default: N/A
PtRes: APM
Range: Off (Current mode attribute is Program or None)
On (Current mode attribute is Operator)

APM Parameter Reference Dictionary O-11 10/96

 OPRINPUT

OPRINPUT (ProcMod)
Type: Real Operator Input—Defines the value entered by the operator in response to the last
Lock: Oper sequence message.
Default: 0.0
PtRes: APM
Range: N/A

OPROCLM
Type: Real Output Rate of Change Limit in Percent Per Minute
Lock: Supr
Default: NaN
PtRes: APM
Range: > 0.1
NaN

Helpful Hint: Entering NaN disables limit checking.

OPTDIR
(AnalgOut)
Type: E:POLARITY Analog Output Direct/Reverse Action—Defines the output action of the
Lock: Eng/PB OPFINAL value of the data point.
Default: Direct
PtRes: APM
Range: 0-Direct (For final OP: 0% = 4 mA; 100% = 20 mA)
1-Reverse (For final OP: 0% = 20 mA; 100% = 4 mA)

OPTDIR
(DigOut)
Type: E:POLARITY Output Direction—Defines the direct/reverse action of the PWM digital
Lock: Eng/PB output.
Default: Direct
PtRes: APM
Range: 0-Direct (OP is the % On time)
1-Reverse (OP is the % Off time)

OROFFSET (ORSel)
Type: Logical Override Offset—When OROFFSET is On, override initialization of Pid-
Lock: Eng/PB type algorithm points connected to this ORSel algorithm applies an override
Default: On offset equal to Gain times Error (PV - SP).
PtRes: APM
Range: Off (No override offset is applied)
On (Offset of Gain times Error is applied)

APM Parameter Reference Dictionary O-12 10/96

 OROPT

OROPT (DevCtl, DigComp)

Type: Logical Override Option—Allows the operator to bypass permissive and override
Lock: Eng/PB interlocks by setting BYPASS On.
Default: Off
PtRes: APM
Range: On (Override option enabled)
Off (Override option disabled)

OROPT (ORSel)
Type: Logical Override Option—Defines whether the operator can put the point in a
Lock: Eng/PB bypass state where any of the X1-X4 inputs can be bypassed. Also, when
Default: Off on, the feedback value is propagated to nonselected primaries of the
PtRes: APM override selector algorithm. Refer to the APM Control Functions and
Algorithms manual for a detailed description.
Range: Off (No override)
On (Inputs can be overridden)

OUT0–12 (GenLin)
Type: Real Output Coordinates 0 -12—Define the output value at the respective
Lock: Supr coordinates.
Default: NaN
PtRes: APM
Range: Any value but NaN

OVERFLO
W
Type: Logical Accumulation Overflow Flag—Indicates whether the accumulated value
Lock: View has overflowed.
Default: Off
PtRes: APM
Range: Off (No overflow)
On (Overflow)

OVERLAP (Array)
Type: Integer Overlapping Array Slot Number— Indicates the Array slot number
Lock: View containing the data being referenced by the slot currently being built.
Default: 0
PtRes: APM
Range: 0 through the number of Array slots (NARRSLOT)

APM Parameter Reference Dictionary O-13 10/96

 OVERPHAS

OVERPHAS (ProcMod)
Type: E:JUMPDIR Override Current Phase—Allows the operator to override the current
Lock: ONPROC and phase of the sequence by skipping forward to the next phase, or backward to
CNTLLOCK the previous phase. A phase can be overridden in this manner only when the
parameters sequence execution state is PAUSE, FAIL, or ERROR.
Default: Blank
PtRes: APM
Range: 0-Forward (Skip to next phase)
1-Backward (Go back to previous phase)

OVERSTAT (ProcMod)
Type: E:JUMPDIR Override Current Statement—Allows the operator to override the current
Lock: ONPROC and statement of the sequence by skipping forward to the next statement, or
CNTLLOCK backward to the previous statement. A statement can be overridden in this
parameters manner only when the sequence execution state is PAUSE, FAIL, or
Default: Blank ERROR.
PtRes: APM
Range: 0-Forward (Skip to next statement)
1-Backward (Go back to previous statement)

OVERSTEP (ProcMod)
Type: E:JUMPDIR Override Current Step—Allows the operator to override the current step of
Lock: ONPROC the sequence by skipping forward to the next step, or backward to the
Default: Blank previous step. A step can be overridden in this manner only when the
PtRes: APM sequence execution state is PAUSE, FAIL, or ERROR.
Range: 0-Forward (Skip to next step)
1-Backward (Go back to previous step)

APM Parameter Reference Dictionary O-14 10/96

 OVERVAL

OVERVAL
Type: Integer Overview Value in Percent—Defines the amount of deviation (PV - SP,
Lock: Eng/PB in percent) that causes the PV to reach the overview limit. For digital
Default: 25 points, the display shows the current state of the point.
PtRes: NIM As shown in Figure O-1, The baseline shows the normal operating value for
this PV.
Range: 0 to 100 (Entering a 0 suppresses the value; value is not shown on the display)

OVERVIEW LIMIT

DEVIATION TO REACH
OVERVIEW LIMIT

BASELINE
(Normal Value)

Figure O-1 — Overview Limit 1302

OVRCTIM (DevCtl)
Type: Time Time Over High Trip Limit—The amount of time the SECVAR parameter
Lock: View is continuously greater than the SECVAR high trip limit.
Default: 0
PtRes: APM
Range: Duration (0 to 9999 days, with a resolution to 1 second)

OVRDALOP (DevCtl,
DigComp)
Type: E:$OVRALOP Override Alarm Option—The override alarm option for I0, I1, and I2
Lock: Eng/PB parameters.
Default: None
PtRes: APM
Range: 0-None (No override alarming)
1-Auto_Rtn (Return to normal when override is cleared)
2-Cnfm_Rqd (Confirm to clear, after interlock is cleared)

APM Parameter Reference Dictionary O-15 10/96

 OVRDALPR

OVRDALPR (DevCtl, DigComp)

Type: E:ALPRIOR Override Alarm Priority—Defines the priority of an override alarm.
Lock: Engr
Default:
Low
PtRes: APM
Range: JnlPrint (Alarm is historized and reported to the printer but not annunciated)
Printer (Alarm is reported to the printer but not historized and not annunciated)
Emergncy (Alarm is historized, annunciated, and reported to all alarm summary displays)
High (Alarm is historized, reported to Area Alarm Summary Display and Unit Alarm
Summary
Display)
Low (Alarm is historized, reported to the Unit Alarm Summary Display, and annunciated)
Journal (Alarm is historized but not reported to Universal Stations and not annunciated)
NoAction (Alarm is not reported to the system and not annunciated)

OVRDCONF (DevCtl,
DigComp)
Type: Logical Override Confirmation Flag—Indicates one of the four override alarms
Lock: Oper SI0CONF or I0CONF-I2CONF has not yet been confirmed. This flag is
Default: Off also used to confirm the alarm.
PtRes: APM
Range: Off (An alarm is not waiting for confirmation)
On (An alarm is waiting for confirmation)

OVRDDESC (DevCtl,
DigComp)
Type: String_8 Override Alarm Descriptor—Input connections and logic gating are
Lock: View examined in order to determine which input was the source of change for the
Default: Blank interlock. For the Device Control point, descriptor text for this parameter is
PtRes: APM taken from LIDESC (1-12). Descriptive text for the Digital Composite point
is taken from SI0 DESC or I0-I2 DESC parameters.

Range: SI0 Desc (Current interlock or input descriptor)

I0 - I2 Desc (Current interlock or input descriptor)
L1 - L12 Desc (Current interlock or input descriptor, Device Control only)

OVRDI0FL, OVRDI1FL, OVRDI2FL,

OVRDSIFL
(DevCtl, DigComp)
Type: Logical Override and Safety Override Alarm Flag—Indicates that an override is
Lock: View active, or that a confirmable override was cleared, but not yet confirmed.
Default: Off
PtRes: APM
Range: Off (Override flag is not active)
On (Override flag is active)

APM Parameter Reference Dictionary O-16 10/96

 P

-P-

P (FlowComp)
Type: Real Pressure Input—Indicates the measured actual gage pressure.
Lock: View
Default: 1.0
PtRes: APM
Range: > 0.0

P0
(FlowComp)
Type: Real Zero Reference for Pressure—P0 is the zero reference pressure input and
Lock: Supr is in the same engineering units as the P input. P0 is typically 14.696 if P is
Default: 0.0 in psig or 101.325 if P is in kiloPascals. Enter the absolute value of the
PtRes: APM number.
Range: N/A

P0–P2 (DevCtl, DigComp)

Type: Logical Permissive Interlocks for Output States 0, 1, & 2—Permissive interlocks
Lock: Engr are controlled by logic slot outputs, and each interlock determines whether
Default: On the operator and user program are allowed to use the respective state, or are
PtRes: APM locked out from that state. A permissive interlock (P0-P2) is provided for
each state (STATE0-STATE2). The permissive interlocks themselves never
cause the outputs to change. P0-P2 can be changed by a logic block or a
program when the point is active and the mode attribute is Program. Refer
to the APM Control Functions and Algorithms manual for a detailed
description.

Range: Off (Respective state is locked out)

On (Respective state is permitted to be used)

Helpful Hint: P0–P2 configuration requires PTEXECST = InActive or PNTSTATE = Idle.

P1–P6 (RegPV)
Type: Real PV Inputs 1-6—Indicates the current values at the inputs to the RegPV
Lock: View algorithm. For Totalizers, P2 is the floating point input of AV.
Default: NaN
PtRes: APM
Range: N/A,
NaN

P1STS–P6STS
Type: E:PVVALST P1–P6 Status—Indicate the status of the up to six inputs at the RegPV
Lock: View algorithm.
Default: Bad
PtRes: APM
Range: 0-Bad (Value is bad and replaced with NaN)
1-Uncertn (Status of the value is uncertain)
2-Normal (Value is good)

APM Parameter Reference Dictionary P-1 10/96

 PAUSETIM

PAUSETIM (DevCtl, DigComp)

Type: Integer State 0 Pause Time—The amount of time to pause in State 0 on an OP
Lock: Supr state change, if the STCHGOPT parameter equals STATE0.
Default: 0
PtRes: APM
Range: 0 to 1000 seconds

PERIOD (ProcMod, Timer)

Type: Real Period—Defines the processing period in seconds.
Lock: View
Default: 1 seconds
PtRes: APM
Range: 1 seconds

PERIOD (DevCtl, DigComp, Logic, RegCtl,

RegPV)
Type: Real Period—Defines the processing period in seconds.
Lock: View
Default: 1 second
PtRes: APM
Range: 0.25, 0.5, or 1.0 seconds

PERIOD (DigOut)
Type: Real Period—Defines length of period for an SO output from DigOut point that
Lock: Eng/PB has been configured for a PWM output.
Default: 10.0 seconds
PtRes: APM
Range: 1.0 to 120.0 seconds

PGALGID(1)–(4) (DevCtl)
Type: E:$GTALGID Primary Gate Algorithm ID—Defines the algorithm IDs for primary gates.
in an Array The Boolean logic gates beginning with “P” have a user-defined pulse size.
(1..4)
Lock: PtBld
Default: Null
PtRes: APM
Range: NULL (No algorithm)
AND (And Gate algorithm)
OR (Or Gate algorithm)
NAND (Nand Gate algorithm)
NOR (Nor Gate algorithm)
XOR (Exclusive Or Gate algorithm)
PAND (Pulse Nand Gate algorithm)
POR (Pulse Or Gate algorithm)
PNAND (Pulse Nand Gate algorithm)
PNOR (Pulse Nor Gate algorithm)
PXOR (Pulse Exclusive-Or Gate algorithm)

APM Parameter Reference Dictionary P-2 10/96

 PGDSTN(1)–(4)

PGDSTN(1)–(4) (DevCtl)
Type: Primary Gate Destination—Defines the output destination of the primary
E:$GATDST gate.
N
in an Array
(1..4)
Lock: PtBld
Default: None
PtRes: APM
Range: None (No destination)
SI0 (Output goes to Safety Interlock)
I0, I1, I2 (Output goes to Interlock)
P0, P1, P2 (Output goes to Permissives)
SOCMD0, SOCMD1, SOCMD2 (Output is commanded to go to SOCMD0, 1 or 2)
OPCMD (Output is commanded to go to OPCMD parameter)
SG1, SG2 (Output goes to Secondary gates 1 or 2)

PGPLSWTH(1)–(4) (DevCtl)
Type: Integer Primary Gate Pulse Width—Indicates the pulse width for primary gates
in an Array whose algorithm starts with a “P”.
(1..4)
Lock: Supr
Default: 0
PtRes: APM
Range: 0 to 8000 seconds

PGSO(1)–(4) (DevCtl)
Type: Logical Primary Gate Status Output—Indicates the output value of the primary
in an Array gate.
(1..4)
Lock: View
Default: Off
PtRes: APM
Range: Off
On

PHASE (ProcMod)
Type: String_8 Phase Name—Indicates the current phase of the sequence executing in the
Lock: View process module.
Default: Spaces
PtRes: APM
Range: N/A

PHASEAL (ProcMod)
Type: Logical Phase Alarm—Indicates whether the current phase of the sequence has
Lock: View been completed within the specified time.
Default: Off
PtRes: APM
Range: On (Phase has not been completed in the specified time)
Off (No phase alarm)

APM Parameter Reference Dictionary P-3 10/96

 PHASETIM

PHASETIM (ProcMod)
Type: Integer Phase Time —Indicates the time remaining in minutes in the current phase
Lock: View before a phase alarm is generated. The maximum time allowed for the
Default: 0 seconds phase is defined by the phase statement.
PtRes: APM
Range: 0 to 9999 minutes

PHREMTIM (ProcMod)
Type: Time Phase Time Remaining—Indicates the time remaining in time duration
Lock: View before a phase alarm is generated. This value is displayed in the APM
Default: 0 seconds Detail display.
PtRes: APM
Range: N/A

PIALGID (1)–(12) (DevCtl)

Type: E:$I1ALGID Primary Input Gate Algorithm ID—The XX algorithms compare this input
in an Array to the PINN (1)-(12) parameter, and the IN_SET algorithm compares it to
(1..12) the range of 10 values in the NNINSET (1)-(10) parameter. The XX2
Lock: PtBld algorithms compare this input defined by the PISRC(1)-(12) parameter.
Default: Null
PtRes: APM
Range: NULL (No algorithm)
INVERT (Invert Logical algorithm)
GT (Greater Than algorithm)
GE (Greater Than or Equal To algorithm)
LT (Less Than algorithm)
LE (Less Than or Equal To algorithm)
EQ (Equal To algorithm)
NE (Not Equal To algorithm)
GT2 (Greater Than algorithm)
GE2 (Greater Than or Equal To algorithm)
LT2 (Less Than algorithm)
LE2 (Less Than or Equal To algorithm)
EQ2 (Equal To algorithm)
NE2 (Not Equal To algorithm)
IN_SET (Compares the input to values in the INSET array)

PIDEADBD(1)–(12) (DevCtl)
Type: Real Primary Input Gate Deadband—The deadband for primary input gates
in an Array that is configured for an arithmetic algorithm.
(1..12)
Lock: Supr
Default: 1.0
PtRes: APM
Range: >0

APM Parameter Reference Dictionary P-4 10/96

 PIDFORM

PIDFORM
Type: E:PIDFORM PID Controller Form—Defines the type of Pid controller form. Refer to
Lock: Eng/PB the APM Control Functions and Algorithms manual for a detailed
Default: Interact description.
PtRes: APM
Range: 0-Interact [(Proportional + Integral) x Derivative]
1-Ideal (Proportional + Integral + Derivative)

PIDSTN(1)-(6)
Type: [Link] PV Input Connection Destination—Defines the parameter in the data point
Lock: View that is to receive the value provided by the respective input connection.
Default: Based on There can be up to six input-connection destinations for a RegPV point.
PVALGID,
PVEQN, & N
PtRes: APM
Range: 1–8 character valid parameter name

PINN (1)–(12) (DevCtl)

Type: Real Primary Input Constants Numeric—The numeric constant for arithmetic
Lock: Supr comparisons of primary input gates using XX algorithms.
Default: 0.0
PtRes: APM
Range: <> NaN

PISO (1)–(12) (DevCtl)

Type: Logical Primary Input Gate Output Value—Indicates the output value of the
in an Array primary input gate.
(1..12)
Lock: View
Default: Off
PtRes: APM
Range: Off
On

PISRC(1)–(12) (DevCtl)
Type: Primary Input Source—The source for the second input of primary input
E:$GATESR gates for arithmetic comparison algorithms that use a second external input
C (i.e., XX2 algorithms).
in an Array
(1..12)
Lock: PtBld
Default: Null
PtRes: APM
Range: NULL (No source for input)
L1..L12 (These values correspond with the LISRC(1)—(12) parameter)

APM Parameter Reference Dictionary P-5 10/96

 PISRC(1)–PISRC(6)

PISRC(1)–PISRC(6)
Type: [Link] PV Input Connection Source—Define the parameters whose current values
Lock: PtBld are to be fetched and then written to the up to six RegPV algorithm inputs.
Default: [Link] The source parameter name can be specified using the
PtRes: APM "[Link]" format. Refer to the APM Control Functions and
Algorithms manual for a detailed description.
Range: Use [Link] for tagged points where Tag name can be up to 16 characters and
the
permissible character set is as follows:
Alphabetics A-Z (uppercase only)
Numerics 0-9 (an all numeric tag name is not allowed)
Underscore (_) cannot be used as the first character or the last character, and
consecutive underscores are not allowed.
Embedded space characters are not allowed.
An * is used to default to this point's tag name.
Parameter name can be up to eight characters, and must be a legitimate parameter
name.

PIUOTDCF (STI, LLMUX)

Type: Logical Open Thermocouple Detection Enable—Defines whether the point is to
Lock: Eng/View detect an open thermocouple condition. This parameter is configurable for
Default: On each STI point that is connected to a smart temperature transmitter and for
PtRes: APM each LLMUX point.

This parameter is a view-only parameter when the point execution state

PTEXECST is Active.

Range: On (Detect an open thermocouple condition)

Off (Do not detect an open thermocouple)

PIUOTDCF(1)–(168) (LLAI)
Type: Logical LLAI Open Sensor Detection Enable—Defines whether an
Lock: Supr open-sensor condition is to be detected for all eight LLAI points.
Default: On
PtRes: APM
Range: On (Detect open-sensor conditions)
Off (Do not detect open-sensor conditions)

APM Parameter Reference Dictionary P-6 10/96

 PKGOPT

PKGOPT (APM Box)

Type: E:$PKGOPT APMM Hardware Packaging Option. The tables below show the default
Lock: PtBld hardware location for each choice.
Default: REDUN
PtRes: APM
Range: 0-NONREDUN (APMM is not redundant; can have up to 40 I/O Modules)
1-REDUN (Redundant APMMs in the same file; can have up to 40 I/O Modules)
2-REDUN_2F (Redundant APMMs in two separate files; can have up to 40 I/O Modules)
3-REDUN_IO(Redundant APMMs/two separate files/can have full redundant IOPs)
4-NODEFALT (Sets file/card positions of IOPs to 0). On download to the APM,
changes to NONREDUN, REDUN, or REDUN_2F based on actual hardware.

Helpful Hints: Parameter NODENUM must be equal to an odd number no matter

which option is selected for PKGOPT.

During Node Specific configuration, if you choose Nonredund or Redun_IO, you must type
in file and card numbers for the I/O cards. Refer to the tables below or the APM Node
Specific Configuration Form if necessary.

NONREDUN REDUN
Hardware File Card Slot Hardware File Card Slot
APMM 1 1-5 APMM’s 1 1 - 10
IOM-A 1 - 10 1 6 - 15 IOM-A 1 - 5 1 11 - 15
IOM-A 11 - 25 2 1 - 15 IOM-A 6 - 20 2 1 - 15
IOM-A 26 - 40 3 1 - 15 IOM-A 21 - 3 1 - 15
35
IOM-A 36 - 4 1-5
40

REDUN_2F REDUN_I/O
Hardware File Card Slot Hardware File Card Slot
Primary APMM 1 1-5 Primary APMM 1 1-5
Secondary 2 1-5 Secondary 2 1-5
APMM APMM
IOM-A 1 - 10 1 6 - 15 IOM-A 1 - 10 1 6 - 15
IOM-A 11 - 20 2 6 - 15 IOM-A 11 - 25 3 1 - 15
IOM-A 21 - 35 3 1 - 15 IOM-A 26 - 40 5 1 - 15
IOM-A 36 - 40 4 1-5 IOM -B 1 - 10 2 6 - 15
IOM -B 11 - 25 4 1 - 15
IOM -B 26 - 40 6 1 - 15

APM Parameter Reference Dictionary P-7 10/96

 PMEVOVFL

PMEVOVFL
Type: Logical APMM Event Overflow Flag
Lock: View
Default:
PtRes: APM
Range: Off (No overflow)
On (Overflow has occurred)

PMMCHAER (APM Box)

Type: Integer APMM I/O Link Channel A Error Count
Lock: View
Default: 0
PtRes: APM
Range: >0

PMMCHASL (APM Box)

Type: Integer APMM I/O Link Channel A Silence Count
Lock: View
Default: 0
PtRes: APM
Range: >0

PMMCHBER (APM Box)

Type: Integer APMM I/O Link Channel B Error Count
Lock: View
Default: 0
PtRes: APM
Range: >0

PMMCHBSL (APM Box)

Type: Integer APMM I/O Link Channel B Silence Count
Lock: View
Default: 0
PtRes: APM
Range: >0

APM Parameter Reference Dictionary P-8 10/96

 PMMCMD

PMMCMD (APM Box)

Type: E:$PMMCMD APMM Command
Lock: OnProc
Default: None
PtRes: APM

NOTE

When points are built to a NIM and the NIM is restarted with no database, the points
need
to be reloaded from checkpoint or the points must be reconfigured. If the database is to
be reconfigured, the APMM must be in Idle, and the point execution state must be
Inactive. This allows the point build operation to override the database that already
exists there.

Range: 0-None (No command request has been issued)

1-Run (To "Run" state for processing points)
2-Idle (To "Idle" state for reloading the database)
3-RsIoLCom (Reset I/O Link communication error count = 0)
4-ShutDown (To "Alive" state for reloading personality)
5-RsUcnLsb (Reset the Local Statistics Block to zeroes)
6-SelChnA (Select Input/Output Link Channel A)
7-SelChnB (Select Input/Output Link Channel B)
8-Warmstrt (Warm Start)
9-Coldstrt (Cold Start)
10-SwapPri (Switchover to the redundant APMM)

PMMCOMER (APM Box)

Type: E:$IOMCOMM APMM I/O Link Communication Error Status
Lock: View
Default: N/A
PtRes: APM
Range: 0-None (No communication errors)
1-InvAlert (Invalid Alert—message bit problem)
2-InvDest (Invalid Destination)
3-InvChCnt (Invalid Character Count)
4-InvSourc (Invalid Source)
5-InvCmd (Invalid Command)
6-Checksum (Data record Checksum Error)
7-No_Resp (No Response)
8-ChTimOut (Channel Time Out)
9-MsgOvRun (Message Overrun)
10-GapError (Message gap is too long)
11-LpBckErr (Loop Back Error)
12-NTH_0 (Next Token Holder equals zero)
13-TknRecov (Token Recovery in progress)
14-RplBufOv (Reply Buffer Overflow)

APM Parameter Reference Dictionary P-9 10/96

 PMMCTLST

PMMCTLST (APM Box)

Type: Logical APMM Control Processor Status
Lock: View
Default: Off
PtRes: APM
Range: Off (Control processor has not failed)
On (Control processor has failed)

PMMIOLST (APM Box)

Type: E:$IOMSTS
Lock: View
Default:
PtRes: APM
Range: Notconfg (IOP not configured)
Confgmis (Configuration mismatch detected)
OK (Module is running with no soft fail errors)
Idle (Module is idle with no soft fail errors)
Softfail (Module is running with soft fail error(s) present)
Idlesf (Module is idle with soft failure error(s) present)
Nonexist (Module does not exist at this address)
Noresp (No response from module)
Poweron (Module state is Power On)
Commerr (Communication error to IOP)
Unavail (Module is unavailable for communication)

PMMOPER (APM Box)

Type: E:$OPERATE Process Manager Module Operation—Indicates the type of APMM.
Lock: View
Default: N/A
PtRes: APM
Range: 0-NonRedun (This APMM has no redundant APMM to back it up)
1-Primary (This APMM is the primary point processor)
2-Secondry (This APMM is the secondary APMM that backs up the primary APMM)

PMMRECCH (APM Box)

Type: E:$RECCHN APMM I/O Link Current Receive Channel
Lock: View
Default: N/A
PtRes: APM
Range: 0-ChannelA (Channel A is channel currently receiving)
1-ChannelB (Channel B is channel currently receiving)

PMMRECHN
Type: E:$RECCHN APMM Active Receive Channel
Lock: View
Default: N/A
PtRes: APM
Range: ChannelA
ChannelB

APM Parameter Reference Dictionary P-10 10/96

 PMMSFST

PMMSFST(1)–(96)
Type: Logical APMM Soft Failure
Lock: View
Default:
PtRes: APM
Range: Off
On

PMMSTS (APM Box)

Type: APMM Primary Status
E:$NODEST
A
Lock: View
Default: N/A
PtRes: APM
Range: 0-OffNet (NIM cannot communicate with the APMM)
1-ConfgMs (Configuration mismatch detected)
2-Idle (Event reports but no point processing)
3-IdleSF (Soft failure occurred in Idle state)
4-OK (APMM is operating normally)
5-SoftFail (Soft failure while APMM is running)
6-Fail (APMM can be accessed but CPU is halted; box hard failure has been detected )
10-Alive (No event reports or point processing)
11-AliveSF (Soft failure during Idle state)
12-Test (APMM is in the test mode)
13-TestSF (Soft failure has been detected while the APMM is in the test mode)
15-Loading (Personality or data base is loading)
16 S_Idle (Idle in IOSM)
17 S_Idle SF (IdleSF in IOSM)
18 S_OK (OK in IOSM)
19 S_SFFail (SoftFail in IOSM)
20 S_Pause (HPM is in the Simulation Pause state)

Helpful Hint: Loading the APMM's operating personality software requires PMMSTS =
Alive.
Loading the APMM's database requires PMMSTS = Idle. Use parameter
PMMCMD's "Shutdown" and "Idle" command requests, respectively.

APM Parameter Reference Dictionary P-11 10/96

 PNTFORM

PNTFORM
Type: E:$PNTFORM Point Form—Defines the form of the data point that is implemented.
Lock: View/PB Refer to the APM Control Functions and Algorithms manual for a detailed
Default: Full description of this function.
PtRes: APM
Range: 0-Full (Point is fully displayed and alarmed)
1-Componnt (Point is partially displayed but not alarmed)

Helpful Hint: This parameter is not applicable to DigOut points.

PNTMODTY
Type: E:$PMMDTY Point's Module Type—Defines where the data point resides. Control
Lock: View points such as DigComp, RegPV, RegCtl, Logic, Process Module, Array,
Default: N/A Box Flags, Box Numerics, and Box Timers reside in the APMM.
PTRes: NIM
Range: AO (Analog Output)
AO_16 (Analog Output 16 point)
DI (Digital Input)
DO (Digital Output)
DO_32 (Digital Output 32 point)
HLAI (High-Level Analog Input)
LLAI (Low-Level Analog Input)
STIM (Smart Transmitter Interface)
NotConfg (Not Configured)
PI (Pulse Input)
APMM (Advanced Process Manager Module)
LLMUX (Low-Level Analog Input Multiplexer)
DISOE (Sequence of Events)
SI (Serial Interface)

PNTNODTY
Type: E:$UCNNDTY Point's Node Type—Defines the type of node on the UCN
Lock: View
Default: N/A
PtRes: NIM
Range: NIM (Network Interface Module)
APM (Advanced Process Manager)
NotConfg (Node not configured)

PNTSTATE
Type: E:PNTSTATE Point's Overall State—Defines the state of the data point, which is based
Lock: View on the state of the APMM and the IOP Card in which it resides.
Default: N/A
PtRes: NIM
Range: Failed (NIM cannot communicate with point's APMM/IOP)
Idle (Point's APMM or IOP is in the Idle State)
OK (Point's APMM or IOP is the Run State and is OK)
Uncertn (Point's APMM or IOP is uncertain)

APM Parameter Reference Dictionary P-12 10/96

 PNTTYPE

PNTTYPE
Type: E:PNTTYPE Point Type—Defines the type of point in the APM.
Lock: PtBld
Default: Null
PtRes: APM
Range: 0-Null (Not configured)
1-AnalgIn (Analog Input including LLMUX and Pulse Input)
2-AnalgOut (Analog Output)
4-DigIn (Digital Input)
5-DigOut (Digital Output)
6-DigCom (Digital Composite)
8-RegPV (Regulatory PV)
9-RegCtl (Regulatory Control)
10-Logic (Logic)
11-Array (Array)
12-Flag (Flag)
13-Numeric (Numeric)
14-ProcModl (Process Module)
22-Timer (Timer)
28-DevCtl (Device Control)

Helpful Hint: PNTTYPE of DigOut has a restriction that PNTFORM cannot be = Full.

POSITION (APM Box)

Type: E:$POSITIN APMM File Position
Lock: View
Default: N/A
PtRes: APM
Range: 0-Right (APMM cards are in card file slots 6–10)
1-Left (APMM cards are in card file slots 1–5)
2-File_1 (APMM cards are in card file 1)
3-File_2 (APMM cards are in card file 2)
4-Pref
5-Non_Pref
6-None
7-Unknown (Not able to determine file position from hardware)

PR2PREFF (APM Box)

Type: Real Peer-to-Peer Communication Efficiency (in percent)— Indicates the
Lock: View rate of successful and on time UCN transactions from this node.
Default: 100
PtRes: APM
Range: 0 - 100

Helpful Hint: This statistic is displayed on the Control Configuration page of the APM
Diagnostic Display.

APM Parameter Reference Dictionary P-13 10/96

 PRIMMOD

PRIMMOD
Type: Ent_Id Primary Module Identifier—Typically used in Batch Processing, this
Lock: Engr parameter contains the tag name of an APM point to which this data point is
Default: Null assigned. Other points that belong to the Batch Equipment Unit should have
PtRes: NIM their PRIMMOD set to this same point. Primmod is used to collect alarms
and events from this point along with others related to the specified Primary
Module point. Information is collected into a common file, accessible from
the Event History Menu.

Range: Tag name of the process module point can be up to 16 characters, and the permissible
character set is as follows:
Alphabetics A-Z (uppercase only)
Numerics 0-9 (an all numeric tag name is not allowed)
Underscore (_) cannot be used as the first character or the last character, and consecutive
underscores are not allowed.
Embedded space characters are not allowed.

Helpful Hint: For Box Flag points, this parameter applies to only slots 1 through 128.
LCN entities that can be stored to PRIMMOD in NIM points are restricted to local NIM
points.

PRMDESC(1)–(12) (Logic)
Type: E:$PMMLGPM Parameter Descriptor Assignment—Defines up to 12 logic-slot
Lock: Eng/PB parameters to which custom generic descriptors entered through
Default: N/A parameters GENDESC(1-12) are to be assigned.
PtRes: NIM
Range: L1...L12 (Logic-slot inputs)
FL1...FL12 (Logic-slot flags)
NN1...NN8 (Logic-slot numerics)
SO1...SO24 (Logic-slot outputs)

PROCMOD (ProcMod)
Type: E:PROCMOD Process Module Operating State—Represents the operational condition
Lock: Determined of a process module. Refer to the APM Control Functions and Algorithms
by manual for a state diagram.
CNTLLOCK
parameter
Default: Off
PtRes: APM
Range: 0-Off (Off)
2-Norm (Normal)
4-Hold (Hold)
5-Shdn (Shutdown)
6-Emsd (Emergency Shutdown)
7-Strt (Start)
8-Stop (Stop)

APM Parameter Reference Dictionary P-14 10/96

 PRPMMSTS

PRPMMSTS
Type: E:$NODESTA Previous APMM Status
Lock: View
Default:
PtRes: APM

Range: Offnet (APMM is offnet with no communications possible)

Confgmis (APMM is in configuration mismatch)
Idle (APMM is idle)
Idlesf (APMM is idle with soft failure(s))
OK (APMM is running with no errors)
Softfail (APMM is running with soft failure(s))
Fail (APMM has failed)
Poweron (APMM is in Power On state-startup condition from power loss)
Alive (APMM has passed self diagnostics and is ready to accept personality)
Alivesf (APMM diagnostics have soft failure)
Loading (APMM is loading personality)
Notconfg (APMM is not configured on network)
Unavail (APMM is unavailable on network for communications)
Test (APMM is in Test mode)
Testsf (APMM is in Test mode with a soft failure(s))

APM Parameter Reference Dictionary P-15 10/96

 PRVCOMFL

PRVCOMFL
Type: E:$PMMHFST Previous APMM Communications Board Failure
Lock: View
Default:
PtRes: APM
Range: NULL (Unknown Error)
PWRDWN (Power is Off)
LR_PAR (Local Ram Parity Error)
LR_LRAM (Local Ram Error)
LR_CK (Local Ram Check)
LR_EXC (Local Ram Exception )
LR_HREV (Local Ram Hardware Revision)
MM_HREV (Memory Board Hardware Revision)
LR_TMR (Local Ram Timer Error)
LR_PTRN (Local Ram Pattern Check Error)
LR_BYTE (Local Ram Byte Error)
LR_ADCD (Local Ram Address Decode Test)
LR_ADDL (Local Ram Additional Checks)
LR_CLRR (Local Ram Scrub Incomplete)
SR_PAR (Shared Ram Parity)
SR_PTRN (Shared Ram Pattern)
SR_ADCD (Shared Ram Address Decode Test)
SR_ADDL (Shared Ram Additional Checks)
GR_PAR (Global Ram Parity)
GR_PTRN (Global Ram Pattern Check Error)
GR_BYTE (Global Ram Byte Error)
GR_ADCD (Global Ram Address Decode Test)
GR_ADDL (Global Ram Additional Checks)
GR_CLRR (Global Ram Scrub Incomplete)
31_NR (IOL Processor, No Response or Failure)
31_ALIV (IOL Processor, Transmitter Not Alive)
31_ILTN (IOL Processor, Illegal Transition)
NMI_UNK (Unknown NMI Request)
BADUCNN (UCN Address Parity or Duplicate Address)
NR (No Response From Other Processor)
MRFT (Memory Reference Table - Pattern Build Fail)
NOMTOS (No MTOS Readout)
LLC_COMM (LLC Communication Fatal Error)
UCNDRV (UCN Driver, Fatal Error)
RD_HREV (Redundancy Card Version/Revision Mismatch)
SW_ERROR (Software Error)
MD_HREV (Modem Card Version/Revision Mismatch)
DA_PTRN (Daughter Card Pattern Test)
DA_BYTE (Daughter Card Byte Write Test)
DA_ADCD (Daughter Card Address Decode)
DA_ADDL (Daughter Card Additional Tests)
DA_CLRR (Daughter Card Scrub Incomplete)
RD_SNPS (Redundancy Card 96 Kw Snapshot Error)
RD_BSLK (Redundancy Card Bus Lock Fail)

APM Parameter Reference Dictionary P-16 10/96

 PRVCTLFL

PRVCTLFL
Type: E:$PMMHFST Previous APMM Control Failure
Lock: View
Default:
PtRes: APM

Range: NULL (Unknown Error)

PWRDWN (Power is Off)
LR_PAR (Local Ram Parity Error)
LR_LRAM (Local Ram Error)
LR_CK (Local Ram Check)
LR_EXC (Local Ram Exception )
LR_HREV (Local Ram Hardware Revision)
MM_HREV (Memory Board Hardware Revision)
LR_TMR (Local Ram Timer Error)
LR_PTRN (Local Ram Pattern Check Error)
LR_BYTE (Local Ram Byte Error)
LR_ADCD (Local Ram Address Decode Test)
LR_ADDL (Local Ram Additional Checks)
LR_CLRR (Local Ram Scrub Incomplete)
SR_PAR (Shared Ram Parity)
SR_PTRN (Shared Ram Pattern)
SR_ADCD (Shared Ram Address Decode Test)
SR_ADDL (Shared Ram Additional Checks)
GR_PAR (Global Ram Parity)
GR_PTRN (Global Ram Pattern Check Error)
GR_BYTE (Global Ram Byte Error)
GR_ADCD (Global Ram Address Decode Test)
GR_ADDL (Global Ram Additional Checks)
GR_CLRR (Global Ram Scrub Incomplete)
31_NR (IOL Processor, No Response or Failure)
31_ALIV (IOL Processor, Transmitter Not Alive)
31_ILTN (IOL Processor, Illegal Transition)
NMI_UNK (Unknown NMI Request)
BADUCNN (UCN Address Parity or Duplicate Address)
NR (No Response From Other Processor)
MRFT (Memory Reference Table - Pattern Build Fail)
NOMTOS (No MTOS Readout)
LLC_COMM (LLC Communication Fatal Error)
UCNDRV (UCN Driver, Fatal Error)
RD_HREV (Redundancy Card Version/Revision Mismatch)
SW_ERROR (Software Error)
MD_HREV (Modem Card Version/Revision Mismatch)
DA_PTRN (Daughter Card Pattern Test)
DA_BYTE (Daughter Card Byte Write Test)
DA_ADCD (Daughter Card Address Decode)
DA_ADDL (Daughter Card Additional Tests)
DA_CLRR (Daughter Card Scrub Incomplete)
RD_SNPS (Redundancy Card 96 Kw Snapshot Error)
RD_BSLK (Redundancy Card Bus Lock Fail)

APM Parameter Reference Dictionary P-17 10/96

 PRVIOLFL

PRVIOLFL
Type: E:$IOMHF Previous IOL Failure
Lock: View
Default:
PtRes: APM
Range: UNKNOWN (Unknown Error)
POWERDWN (Power is Off)
INVPRGEX (Invalid Program Execution)
EPROMERR (EPROM Error)
RAMCNTER (Ram Contents Error)
RAMADRER (Ram Address Error)
DPAERROR (Physical Address Error)
DSAERROR (Soft Address Error)
RXBUFOFL (Receive Buffer Overflow)
IOLJABER (IOL Jabber Circuit - saw too much traffic)
BADPGJMP (Bad Program Jump)
ADCINCMP (A/D Incomplete)
ADOUTOVF (A/D Output Overflow)
ADOUTUDF (A/D Output Underflow)
ADCCALER (A/D Calibration Error)
BADDCLTC (Bad DC LTC)
DMT_TMOT (Dead Man Time Out)
MLTOUTFL (Multiple Output Failure)
DATBUSFL (Data Bus Failure)
BADDARNG (Bad D/A Range)
MSTRTMOT (Master Time Out 68 K)
CTRCKTFL (Counter Circuit Failure)

PSTS (FlowComp)
Type: E:PVVALST Pressure Input Value Status—Status of the P input value.
Lock: View
Default: Normal
PtRes: APM
Range: 0-Bad (Value is bad and replaced with NaN)
1-Uncertn (Status of the value is uncertain)
2-Normal (Value is good)

PTDESC
Type: String_24 Point Descriptor—A 24-character descriptor which is used to describe the
Lock: PtBld point and appears on the Group and Detail Displays for the point. Refer to
Default: Blank Figure N-1.
PtRes: NIM
Range: Permissible character set consists of all characters on the Engineer' s Keyboard. Basically
this set consists of alphabetics A-Z, numerics 0-9, and the following special characters:
space ! % & ' ( ) * + - / : ; > < = ? _ , . $

APM Parameter Reference Dictionary P-18 10/96

 PTEXECST

PTEXECST
Type: E:PTEXECST Point Execution State—Defines the current execution state of the point.
Lock: Supr
Default: Inactive
PtRes: APM
Range: 0-Inactive (Point is not scanned or processed)
1-Active (Point is scanned and processed)

PTINAL (RegCtl, RegPV)

Type: Logical Point in Alarm Indicator—Indicates when an alarm condition has been
Lock: View detected at this point.
Default: Off
PtRes: APM
Range: Off (Point is not in alarm)
On (Point is in alarm)

PTORST (RegCtl)
Type: E:ORSTATUS Point Override Status—Indicates the override status of the point.
Lock: Prog
Default: NotCon
PtRes: APM
Range: 0-NotCon (Not connected to ORSel algorithm. Also indicates that point has been returned
from inactive to active status, or it is undergoing a cold restart, or it is being
initialized.)
1-Sel (Selected as a part of ORSel strategy)
2-NotSel (Not selected as a part of ORSel strategy)

PTSTSIOL
Type: Redundant Partner Status as Seen From the IOL
E:$NODEST
A
Lock: View
Default:
PtRes: APM
Range: OffNet (NIM cannot communicate with the APMM)
ConfgMis (Configuration mismatch detected)
Idle (Event reports but no point processing)
Idlesf (Soft failure occurred in Idle state)
Ok (APMM is operating normally)
SoftFail (Soft failure while APMM is running)
Fail (APMM can be accessed but CPU is halted; box hard failure has been detected)
Powron (Power is on)
Alive (No event reports or point processing)
Alivesf (Soft failure during Idle state)
Test (APMM is in the Test mode)
TestSF (Soft failure has been detected while the APMM is in the Test mode)
Loading (Personality or database is loading)
Notconfg
Nosynch
Unavail

APM Parameter Reference Dictionary P-19 10/96

 PTSTSUCN

PTSTSUCN
Type: Redundant Partner Status as Seen From the UCN
E:$NODEST
A
Lock: View
Default:
PtRes: APM
Range: Offnet (NIM cannot communicate with the APMM)
Confgms (Configuration mismatch detected)
Idle (Event reports but no point processing)
Idlesf (Soft failure occurred in Idle state)
Ok (APMM is operating normally)
Softfail (Soft failure while APMM is running)
Fail (APMM can be accessed but CPU is halted; box hard failure has been detected)
Powron (Power is on)
Alive (No event reports or point processing)
Alivesf (Soft failure during Idle state)
Test (APMM is in the Test mode)
Testsf (Soft failure has been detected while the APMM is in the Test mode)
Loading (Personality or database is loading)
Notconfg
Nosynch
Unavail

PULSEWTH (DevCtl, DigComp)

Type: Real Pulse Width for Point Outputs
Lock: Supr
Default: 1.0 second
PtRes: APM
Range: 0.0 to 60.0 seconds

Helpful Hint: PULSEWTH change requires DODSTN= "[Link]" or

OFFPULSE. When On is to be written to the DigOut module, a pulse of the
specified width is generated. When Off is to be written, no pulse is
generated.

PV (AnalgIn, PI)
Type: Real Process Variable—PV is the PV's current value after the PV is selected
Lock: Oper from one of the following possible sources: a field device, an operator, or a
Default: NaN program. See PVSRCOPT and PVSOURCE.
PtRes: APM
Range: PVEXEUHI to PVEXEULO,
NaN

Helpful Hint: PV change by a program requires PVSRCOPT = All and PVSOURCE = Sub.
PV change by an operator requires PVSRCOPT = All and PVSOURCE =
Man.

APM Parameter Reference Dictionary P-20 10/96

 PV

PV (DevCtl, DigComp)
Type: Current State—PV is the PV's current state after the PV is
E:SD_ENM:PVSTATE selected from one of the following possible sources: a field
S device, an operator, a program, or the output of the PV's data
Lock: Oper point. See PVSRCOPT and PVSOURCE.
Default: BADPVTXT
PtRes: APM

Range: 0-PVSTATES (0) (Defined by STATETXT (0))

1-PVSTATES (1) (Defined by STATETXT (1))
2-PVSTATES (2) (Defined by BADPVTXT)
3-PVSTATES (3) (Defined by MOVPVTXT)
4-PVSTATES (4) (Defined by STATETXT(2))

Helpful Hint: PV change by a program requires PVSRCOPT = All and PVSOURCE = Sub.
PV change by an operator requires PVSRCOPT = All and PVSOURCE =
Man.

PV (DigIn)
Type: Current State—Indicates the current state of the PV input to
E:SD_ENM:STATETX this data point. Not appropriate if DITYPE = ACCUM.
T
Lock: Oper
Default: Off
PtRes: APM
Range: STATETXT(0) or STATETXT(1)

Helpful Hint: PV is derived from the open or closed state of field contacts and from the
configured direct or reverse input direction (INPTDIR).

PV change by a program requires DITYPE = Latched or status,

PVSRCOPT = All, and PVSOURCE = Sub.
PV change by an operator requires DITYPE = Latched or status,
PVSRCOPT = All, and PVSOURCE = Man.

PV (Flag)
Type: Current State—Indicates the current state of the flag data
E:SD_ENM:STATETX point, and it is derived from PVFL. STATETXT(1) is the
T alarmed state.
Lock: Oper
Default: Blank
PtRes: APM
Range: STATETXT(0) or STATETXT(1)

PV (Numeric)
Type: Real Process Variable—Indicates the value of the numeric. This value maps
Lock: Oper into parameter NN(n) in the APM box where n = SLOTNUM.
Default: NaN
PtRes: APM
Range: N/A

APM Parameter Reference Dictionary P-21 10/96

 PV

PV (RegCtl, RegPV)
Type: Real Process Variable—Indicates the current value of the PV after the PV is
Lock: View for selected from one of the following possible sources: a field device, an
RegCtl, operator, or a program. See PVSRCOPT and PVSOURCE.
Oper for
RegPV
Default: NaN
PtRes: APM
Range: N/A

Helpful Hint: PV change by a program requires PVSRCOPT = All and PVSOURCE = Sub.
PV change by an operator requires PVSRCOPT = All and PVSOURCE =
Man.

PV (Timer)
Type: Integer Current Value—Indicates the current time in seconds or minutes. The
Lock: View timer starts at 0 and is incremented towards the preset time established by
Default: 0 the SP parameter.
PtRes: APM
Range: 0 to 32000

PVALDB (RegCtl, RegPV)

Type: E:PVALDB PV Alarm Deadband—Alarm deadband is used to prevent excessive
Lock: Eng/PB recurrence of alarms by adjusting the percent of Engineering Unit range at
Default: One which the alarm "returns to normal."
PtRes: APM
Range: 0-Half (1/2 of 1% of Engineering Unit range)
1-One (1% of Engineering Unit range)
2-Two (2% of Engineering Unit range)
3-Three (3% of Engineering Unit range)
4-Four (4% of Engineering Unit range)
5-Five (5% of Engineering Unit range)
6-EU (Specify deadband in Engineering Units)

PVALDBEU (RegCtl, RegPV)

Type: Real EU value of alarm deadband
Lock: Eng/PB
Default: NaN
PtRes: APM
Range: > 0.0

APM Parameter Reference Dictionary P-22 10/96

 PVALGID

PVALGID
Type: E:$PMMPVAG PV Algorithm Identifier—Defines which PV algorithm is to be used
Lock: PtBld for a RegPV point.
Default: Null
PtRes: APM
Range: 0-Null (No algorithm configured)
1-DataAcq (Data Acquisition)
2-FlowComp (Flow Compensation)
3-MidOf3 (Middle-Of-3 Selector)
4-HiLoAvg (High Low Average Selector)
5-Summer (Summer)
6-VdtLdLag (Variable Dead Time with Lead Lag)
7-TotaLizr (Totalizer)
8-GenLin (General Linearization)
9-Calcultr (Calculator)

PVAUTO (AnalgIn, PI)

Type: Real PV Auto Value—Value of the PV after PVCALC is range checked, filtered,
Lock: View and clamped.
Default: NaN
PtRes: APM
Range: N/A

PVAUTO (DevCtl, DigComp)

Type: E:PVSTATES Current PV State—Indicates the current PV state, based on the states of
Lock: View the inputs to the point.
Default: BADPVTXT
PtRes: APM
Range: 0-STATETXT(0)
1-STATETXT(1)
2-BADPVTXT
3-MOVPVTXT
4-STATETXT(2) (only if NOSTATES is 3)

PVAUT O
(DigIn)
Type: E:STATETXT Current PV State—Indicates the current PV state that corresponds to the
Lock: View field contact input after direct/reverse correction.
Default: N/A
PtRes: APM
Range: STATETXT(0) or STATETXT(1)

PVAUTO (RegCtl)
Type: Real PV Auto Value Fetched Using Control Input Connection—Indicates the
Lock: View current value of the PV when the RegCtl point is in the Auto mode.
Default: NaN
PtRes: APM
Range: N/A

APM Parameter Reference Dictionary P-23 10/96

 PVAUTO

PVAUTO (RegCtl, RegPV)

Type: Real PV Auto Value—Indicates the current value of the PV after the algorithm
Lock: View calculation is performed, the range is checked, and the PV is filtered and
Default: NaN clamped.
PtRes: APM
Range: N/A

PVAUTOST (RegCtl, RegPV)

Type: E:PVVALST PV Auto Value Status—Indicates the current status of the PVAUTO
Lock: View value.
Default: Bad
PtRes: APM
Range: 0-Bad (All inputs, or result in PVCALC is bad)
1-Uncertn (Final result in PVCALC is an uncertain value)
2-Normal (Final result in PVCALC is a normal value)

PVCALC (AnalgIn, PI)

Type: Real Calculated PV—PVCALC is the PV value in Engineering Units after the
Lock: View raw PV (PVRAW) input to this data point has been characterized. The
Default: NaN value of PVRAW is the PV value provided by the Field Termination
PtRes: APM Assembly (FTA).
Range: PVEXEUHI to PVEXEULO,
NaN

PVCALC (RegPV)
Type: Real Calculated PV—Indicates the value of the PV after the PV has been
Lock: View calculated by the PV algorithm.
Default: NaN
PtRes: APM
Range: N/A,
NaN

APM Parameter Reference Dictionary P-24 10/96

 PVCHAR

PVCHAR
Type: E:VALCHAR PV Characterization Option—Defines the display characterization to be
Lock: PtBld used for characterizing the input PV value. Characterization is based on
Default: Linear the field sensor type.
PtRes: APM

HLAI, LLMUX & LLAI — PV Characterization

Valid normal Valid extended
range range
______________________________________________________ (PVEULO– (PVEXEULO–
X = Allowable Sensor Type PVEUHI) PVEXEUHI)
(SENSRTYP) in Degrees C in Degrees C
(when TCRNGOPT
(when TCRNGOPT
Range PNT- pt4- 0- 1- 0-100 T Slide R = Normal for =
Extended for
MODTY 2V 5V 5V mV C wire T SENSRTYP =
SENSRTYP =
D Thermcpl)
Thermcpl)
0-Jtherm HLAI X X X -200 to 1200 N/A
LLAI X -100 to 750 -200 to 1200
LLMUX X -100 to 750 -200 to 1200
1-Ktherm HLAI X X X 0 to 1100 -200 to 1370
LLAI X 0 to 1100 -200 to 1370
LLMUX X 0 to 1100 -200 to 1370
2-Etherm HLAI X X X -200 to 1000 N/A
LLAI X -150 to 500 -200 to 1000
LLMUX X -150 to 500 -200 to 1000
3-Ttherm HLAI X X X -230 to 400 N/A
LLAI X -200 to 300 -230 to 400
LLMUX X -200 to 300 -230 to 400
4-Btherm HLAI X X X 100 to 1820 N/A
LLAI X 600 to 1650 100 to 1820
LLMUX X 600 to 1650 100 to 1820
5-Stherm HLAI X X X 0 to 1700 N/A
LLAI X 550 to 1500 0 to 1700
LLMUX X 550 to 1500 0 to 1700
6-Rtherm HLAI X X X 0 to 1700 N/A
LLAI X 550 to 1500 0 to 1700
LLMUX X 550 to 1500 0 to 1700
7-RPtherm HLAI X X X 0 to 1700 N/A
LLAI X 550 to 1500 0 to 1700
LLMUX X 550 to 1500 0 to 1700
8-DinRtd HLAI X X X -180 to 800 N/A
LLAI X -200 to 850 N/A
LLMUX X -200 to 850 N/A
9-JisRtd HLAI X X X -180 to 650 N/A
LLAI X -200 to 650 N/A
LLMUX X -200 to 650 N/A
10-NicklRtd HLAI X X X -45 to 315 N/A
LLAI X -45 to 315 N/A
LLMUX X -45 to 315 N/A
11-CopprRtd HLAI X X X -20 to 250 N/A
LLAI X -20 to 250 N/A
LLMUX X -20 to 250 N/A
12-Linear HLAI X X X X N/A N/A
LLAI X X X N/A N/A
LLMUX X N/A N/A
13-Sqrroot HLAI X X X N/A N/A
LLAI X X N/A N/A
N/A = Not Applicable

APM Parameter Reference Dictionary P-25 10/96

 PVCHAR

STI — PV Characterization
(Pressure and Magnetic Flow Transmitters)

Range Spt_Dp Spt_Gp Spt_Ap Sfm

Linear X X X X

Sqrroot X -- -- --

X = Allowable Sensor Type

STI — PV Characterization (Temperature Transmitters)

Normal Range Maximum Range

Range (PVEULO to PVEUHI) (PVEXEULO to PVEXEUHI)
in Degrees C (except in Degrees C (except
where noted) where noted)

Linear -50 to 220 mV -

1000 to 1000 mV

Thermocouples

Btherm 400 to 1820 200 to 1820

Etherm -100 to 1000 -200 to 1000

Jtherm -180 to 1200 -200 to 1200
Ktherm -170 to 1250 -200 to 1370

NiNiMoTC 600 to 1300 600 to 1300

Ntherm -100 to 1300 -200 to 1300
Rtherm 0 to 1760 -50 to 1760
Stherm 0 to 1760 -50 to 1760
Ttherm -120 to 400 -250 to 400
W3W25TC 0 to 2300 0 to 2300
W5W26TC 0 to 2300 0 to 2300

RTDs

Cu10RTD -20 to 250 -20 to 250

Cu25RTD -20 to 250 -20 to 250
Pt100 DinRtd -200 to 450 -200 to 850
Pt100 JisRtd -200 to 450 -200 to 640
Pt200 RTD -200 to 450 -200 to 850
Pt500 RTD -200 to 450 -200 to 850
RH Rad 420 to 1800 700 to 1800

RTD Ohms 0 to 4KΩ 0 to 4KΩ

APM Parameter Reference Dictionary P-26 10/96

 PVCHAR

PVCHAR
(FlowComp)
Type: E:VALCHAR PV Characterization Option—Defines the display characterization to be
Lock: PtBld used for characterizing the input PV value of Regulatory PV point
Default: SqRoot configuring with Flow Compensation.
PtRes: APM
Range: 12-Linear (The COMPTERM compensation is not square rooted)
13 SqRoot (The COMPTERM compensation is square rooted)

PVCHGDLY
Type: Integer PV Change Delay time in Seconds—Defines the time(in seconds) that a
Lock: Supr point with a previously detected PV change event is guaranteed to remain
Default: 0 seconds at the new value even if the PV returns to its original value. If the point
PtRes: APM remains at its new value when the delay timer expires, the point is held at
the new value.
Range: 0 to 60 seconds

Helpful Hint: PVCHGDLY requires that EVTOPT = EIP, SOE, or EIPSOE.

PVCLAMP
Type: E:PVCLAMP PV Clamping Option—Defines whether PV clamping is to be used for
Lock: Eng/PB this data point. If PVCLAMP = Clamp and the PV extended range is
Default: NoClamp exceeded, PV value status PVSTS is marked Uncertain and the PV is set
PtRes: APM equal to the extended limit that was violated.

Range: 0-NoClamp (No clamping of the PV value)

1-Clamp (Clamp PV value at range extension limit)

PVEQN
(FlowComp)
Type: E:ALGOEQN PV Equation Type—Defines the equation type (EqA-EqE) to be used for
Lock: PtBld this PV algorithm. Refer to the APM Control Functions and Algorithms
Default: EqA manual for more information.
PtRes: APM
Range: Comp. Inputs Type of Compensation
0-EqA G Mass/Volumetric flow of liquid
1-EqB P and T Mass flow of gases and vapors
2-EqC G, P, and T Mass flow of gases and vapors w/specific gravity
3-EqD G, P, and T Volumetric flow of gases and vapors
4-EqE P, T, X, and Q Mass flow of steam

G = measured or calculated specific gravity or molecular weight, P = measured actual gage pressure,
T = measured actual temperature, X = measured actual steam compressibility and Q = measured
actual steam quality.

PVEQN
(HiLoAvg)

APM Parameter Reference Dictionary P-27 10/96

Type: E:ALGOEQN PV Equation Type—Defines the equation type (EqA-EqC) to be used for
Lock: Eng/PB this PV algorithm. Refer to the APM Control Functions and Algorithms
Default: EqA manual for more information.
PtRes: APM
Range: 0-EqA (Select and identify highest of up to six inputs)
1-EqB (Select and identify lowest of up to six inputs)
2-EqC (Calculate the average of up to six inputs)

PVEQN

PVEQN (MidOf3)
Type: E:ALGOEQN PV Equation Type—Defines the equation type (EqA-EqC) to be used for
Lock: Eng/PB this PV algorithm. Refer to the APM Control Functions and Algorithms
Default: EqA manual for more information.
PtRes: APM
Range: 0-EqA (Highest good input when one or two are bad)
1-EqB (Lowest good input when one or two are bad)
2-EqC (Average of all good inputs)

PVEQN (Summer)
Type: E:ALGOEQN PV Equation Type—Defines the equation type (EqA or EqB) to be used
Lock: PtBld for this PV algorithm. Refer to the APM Control Functions and Algorithms
Default: EqA manual for more information.
PtRes: APM
Range: 0-EqA (P1 input is scaled and biased)
1-EqB (Up to six inputs are scaled and summed with an overall bias applied)

PVEQN (Totalizr)
Type: E:ALGOEQN PV Equation Type—Defines the equation type (EqA-EqF) to be used for
Lock: Eng/PB this PV algorithm. Refer to the APM Control Functions and Algorithms
Default: EqA manual for more information.
PtRes: APM
Range: Option Warm Restart Action Bad Input Handling
0-EqA Continue Use zero
1-EqB Continue Use last good value
2-EqC Continue Set Bad and stop
3-EqD Set Bad, and stop Use zero
4-EqE Set Bad, and stop Use last good value
5-EqF Set Bad, and stop Set Bad and stop

PVEQN
(VdtLdLag)
Type: E:ALGOEQN PV Equation Type—Defines the equation type (EqA-EqD) to be used for
Lock: PtBld this PV algorithm. Refer to the APM Control Functions and Algorithms
Default: EqA manual for more information.
PtRes: APM
Range: 0-EqA (Lead-Lag)
1-EqB (Fixed dead time)
2-EqC (Variable dead time)
3-EqD (Variable dead time with two lags)

Helpful Hint: For Equations C and D, the dead time is changed in steps of
NLOC*NRATE*TS
where NLOC is configurable from 2 to 30, for better resolution of dead time.

APM Parameter Reference Dictionary P-28 10/96

 PVEUHI

PVEUHI (RegCtl, RegPV)

Type: Real PV High Range in Engineering Units—Note that PVEUHI cannot be
Lock: Engr written with NaN. NaN is the default value only.
Default: NaN
PtRes: APM
Range: PVEULO to PVEXEUHI, NaN

Helpful Hint: For Smartline transmitters, refer to Table A-3 in the PM/APM Smartline
Transmitter Integration Manual, PM12-410.

PVEULO (RegCtl, RegPV)

Type: Real PV Low Range in Engineering Units—Note that PVEULO cannot be
Lock: Engr written with NaN. NaN is the default value only.
Default: NaN
PtRes: APM
Range: PVEXEULO to PVEUHI, NaN

Helpful Hint: For Smartline transmitters, refer to Table A-3 in the PM/APM Smartline
Transmitter Integration Manual, PM12-410.

PVEXEUHI
Type: Real PV Extended Engineering Unit Range High—Both PVEXEUHI and
Lock: Engr PVEXEULO are used to clamp or detect a bad PV value. Refer to
Default: NaN parameter PVEXEULO. Note that PVEXEUHI cannot be written with NaN.
PtRes: APM NaN is the default value only.
Range: > PVEUHI, NaN

PVEXEULO
Type: Real PV Extended Engineering Unit Low Range—For the LLAI IOP with
Lock: Engr Thermocouple and RTD sensor types, extended PV range parameters are
Default: NaN VIEW ONLY. Their values are defaulted based on the sensor types, the
PtRes: APM thermocouple range option, and temperature scale. The tables below show
the default values in degrees C. For other engineering units, these values
are appropriately converted. Note that PVEXEULO cannot be written with
NaN. NaN is the default value only.
Range < PVEULO, NaN

Defaults for Extended Range PV Parameters When SENSRTYP = THERMCPL, PVTEMP = Degrees C
TCRNGOPT = NORMAL TCRNGOPT = EXTENDED
PVCHAR PVEXEULO PVEXEUHI PVEXEULO PVEXEUHI
Btherm 600 1650 100 1820
Etherm -150 500 -200 1000
Jtherm -100 750 -200 1200
Ktherm 0 1100 -100 1370
Rtherm 550 1500 0 1700
RPtherm 550 1500 0 1770
Stherm 550 1500 0 1700
Ttherm -200 300 -230 400

APM Parameter Reference Dictionary P-29 10/96

 PVEXHIFL

PVEXEULO (continued)
Defaults for Extended Range PV Parameters When SENSRTYP = RTD, PVTEMP = Degrees C
PVCHAR PVEXEULO PVEXEUHI

PtDinRTD -180 800

PtJisRTD -180 650
NicklRTD -45 315
CopprRTD -20 250

PVEXHIFL
Type: Logical PV Extended High Range Violation—Indicates that the PV has exceeded
Lock: View the extended-high range alarm trip point.
Default: Off
PtRes: APM
Range: Off (Extended high range not exceeded)
On (Extended high range exceeded)

PVEXLOFL
Type: Logical PV Extended Low Range Violation—Indicates that the PV has exceeded
Lock: View the extended-low range alarm trip point.
Default: Off
PtRes: APM
Range: Off (Extended low range not exceeded)
On (Extended low range exceeded)

PVFL(0)–(2) (DevCtl, DigComp)

Type: Logical PV Flag—Indicates the current PV state as three separate Boolean
Lock: View parameters. PVFL(n) is On when the PV is in state "n" where n is 0, 1, or 2.
Default: Off
PtRes: APM
Range: Off (PV is not in the respective state)
On (PV is in the respective state)

PVFL (DigIn,
Flag)
Type: Logical PV Flag—Represents the current PV state as a Boolean value.
Lock: Oper
Default: Off
PtRes: APM
Range: Off [PV = STATETXT(0)]
On [PV = STATETXT(1)]

APM Parameter Reference Dictionary P-30 10/96

 PVFORMAT

PVFORMAT (RegCtl, RegPV)

Type: E:VALFORMT PV Decimal Point Format—Defines the decimal format that is to be
Lock: Engr used to display the PV and SP values. It contains up to eight characters
Default: D1 including the minus sign and decimal point.
PtRes: APM
Range: 0-D0 (-XXXXXX.)
1-D1 (-XXXXX.X)
2-D2 (-[Link])
3-D3 (-[Link])

PVHHFL (RegCtl, RegPV)

Type: Logical PV High High Alarm Flag—Indicates whether the PV has exceeded the
Lock: View alarm trip point established by the PVHHTP parameter.
Default: Off
PtRes: APM
Range: Off (High High limit not exceeded)
On (High High limit exceeded)

PVHHPR (RegCtl, RegPV)

Type: E:ALPRIOR PV High High Alarm Priority—Defines the priority of the PV high high
Lock: Engr alarm.
Default:
Low
PtRes: NIM
Range: JnlPrint (Alarm is historized and reported to the printer but not annunciated)
Printer (Alarm is reported to the printer but not historized and not annunciated)
Emergncy (Alarm is historized, annunciated, and reported to all alarm summary displays)
High (Alarm is historized, reported to Area Alarm Summary Display and Unit Alarm
Summary
Display)
Low (Alarm is historized, reported to the Unit Alarm Summary Display, and annunciated)
Journal (Alarm is historized but not reported to Universal Stations and not annunciated)
NoAction (Alarm is not reported to the system and not annunciated)

Helpful Hint: PVHHPR configuration requires PVHHTP ≠ NaN.

PVHHTP (AnalgIn, RegPV)

Type: Real PV High High Alarm Trip Point—Defines the PV high high alarm trip
Lock: Supr point for this point.
Default: NaN
PtRes: APM
Range: PVHITP to PVEXEUHI, NaN

Helpful Hint: PVHHTP configuration requires PVHITP ≠ NaN.

APM Parameter Reference Dictionary P-31 10/96

 PVHHTP

PVHHTP (RegCtl, RegPV)

Type: Real PV High High Alarm Trip Point—Defines the PV high high alarm trip
Lock: Supr point for this point.
Default: NaN
PtRes: APM
Range: PVHITP to PVEUHI, NaN

Helpful Hint: PVHHTP configuration requires PVHITP≠ NaN.

PVHIFL (RegCtl, RegPV)

Type: Logical PV High Alarm Flag—Indicates that the PV has exceeded the alarm trip
Lock: View point established by parameter PVHITP.
Default: Off
PtRes: APM
Range: Off (No PV High alarm)
On (High PV alarm)

PVHIPR (RegCtl, RegPV)

Type: E:ALPRIOR PV High Alarm Priority—Defines the priority of the PV high alarm for this
Lock: Engr point.
Default:
Low
PtRes: NIM
Range: JnlPrint (Alarm is historized and reported to the printer but not annunciated)
Printer (Alarm is reported to the printer but not historized and not annunciated)
Emergncy (Alarm is historized, annunciated, and reported to all alarm summary displays)
High (Alarm is historized, reported to Area Alarm Summary Display and Unit Alarm
Summary
Display)
Low (Alarm is historized, reported to the Unit Alarm Summary Display, and annunciated)
Journal (Alarm is historized but not reported to Universal Stations and not annunciated)
NoAction (Alarm is not reported to the system and not annunciated)

Helpful Hint: PVHIPR configuration requires PVHITP ≠ NaN.

PVHITP
Type: Real PV High Alarm Trip Point—Defines the trip point for the PV high alarm
Lock: Supr for this point.
Default: NaN
PtRes: APM
Range: PVLOTP to PVHHTP, NaN

PVINIT
Type: Logical PV Initialization Request Flag—Indicates that an initialization request has
Lock: Prog been made for this point.
Default: Off
PtRes: APM
Range: Off (No 1-shot initialization)
On (Initializes the PV filter and the algorithm for a 1-shot single sample time).

APM Parameter Reference Dictionary P-32 10/96

 PVLLFL

PVLLFL (RegCtl, RegPV)

Type: Logical PV Low Low Alarm Flag—Indicates that the PV has exceeded the alarm
Lock: View trip point established by the PVLLTP parameter.
Default: Off
PtRes: APM
Range: Off (PV > Low Low alarm trip point)
On (PV < Low Low alarm trip point)

PVLLPR (RegCtl, RegPV)

Type: E:ALPRIOR PV Low Low Alarm Priority—Determines the priority of the PV low low
Lock: Engr alarm for this data point.
Default:
Low
PtRes: NIM
Range: JnlPrint (Alarm is historized and reported to the printer but not annunciated)
Printer (Alarm is reported to the printer but not historized and not annunciated)
Emergncy (Alarm is historized, annunciated, and reported to all alarm summary displays)
High (Alarm is historized, reported to Area Alarm Summary Display and Unit Alarm
Summary
Display)
Low (Alarm is historized, reported to the Unit Alarm Summary Display, and annunciated)
Journal (Alarm is historized but not reported to Universal Stations and not annunciated)
NoAction (Alarm is not reported to the system and not annunciated)

Helpful Hint: PVLLPR configuration requires PVLLTP ≠ NaN.

PVLLTP (AnalgIn, RegPV, PI)

Type: Real PV Low Low Alarm Trip Point—Defines the trip point for the PV low low
Lock: Supr alarm for this point.
Default: NaN
PtRes: APM
Range: PVEXEULO to PVLOTP, NaN

Helpful Hint: PVLLTP configuration requires PVLOTP ≠ NaN.

PVLLTP (RegCtl)
Type: Real PV Low Low Alarm Trip Point—Defines the trip point for the PV low low
Lock: Supr alarm for this point.
Default: NaN
PtRes: APM
Range: PVEULO to PVLOTP, NaN

Helpful Hint: PVLLTP configuration requires PVLOTP ≠ NaN.

PVLOFL (RegCtl, RegPV)

Type: Logical PV Low Alarm Flag—Indicates that the PV has exceeded the alarm trip
Lock: View point established by parameter PVLOTP.
Default: Off
PtRes: APM
Range: Off (PV > Low alarm trip point)
On (PV < Low alarm trip point)

APM Parameter Reference Dictionary P-33 10/96

 PVLOPR

PVLOPR (RegCtl, RegPV)

Type: E:ALPRIOR PV Low Alarm Priority—Defines the priority of the PV low alarm for this
Lock: Engr point.
Default:
Low
PtRes: NIM
Range: JnlPrint (Alarm is historized and reported to the printer but not annunciated)
Printer (Alarm is reported to the printer but not historized and not annunciated)
Emergncy (Alarm is historized, annunciated, and reported to all alarm summary displays)
High (Alarm is historized, reported to Area Alarm Summary Display and Unit Alarm
Summary
Display)
Low (Alarm is historized, reported to the Unit Alarm Summary Display, and annunciated)
Journal (Alarm is historized but not reported to Universal Stations and not annunciated)
NoAction (Alarm is not reported to the system and not annunciated)

Helpful Hint: PVLOPR configuration requires PVLOTP ≠ NaN.

PVLOTP (RegCtl, RegPV)

Type: Real PV Low Alarm Trip Point—Defines the trip point for the PV low alarm for
Lock: Supr this point.
Default: NaN
PtRes: APM
Range: PVLLTP to PVHITP,
NaN

PVNORMAL (DevCtl, DigIn, DigComp)

Type: E:STATETXT PV Normal State—Defines the normal state of the PV using the
Lock: Supr appropriate STATETXT descriptor.
(Engr to
change
to/from
NONE)
Default: N/A
PtRes: APM
Range: STATETXT(0) descriptor (Defaulted to Off for PV State 0)
STATETXT(1) descriptor (Defaulted to On for PV State 1)
STATETXT(2) descriptor (Defaulted to State2 for PV State 2; internally set to $NULL for
two- state devices; does not apply to DigIn point)
NONE (No off normal checking)

Helpful Hint: PV normal state text descriptor describes the normal (desired) state,
such as Run, Stop, Open, Closed.

APM Parameter Reference Dictionary P-34 10/96

 PVNORMFL

PVNORMFL (DevCtl, DigIn, DigComp)

Type: Logical PV Normal State Flag—Indicates whether the normal state of the PV is
Lock: Supr active.
Default: Off
PtRes: APM
Range: Off (Point is in a state other than the normal state)
On (Normal state is active)

Helpful Hint: PVNORMFL change requires ALMOPT = Offnorm for Digital Input points,
or that PVNORMAL ≠ None for Digital Composite or Device Control points.
If set to On, causes text in STATETXT (1) to be used to describe the normal
state of the PV, otherwise text in STATETXT (0) is used.

PVP (RegCtl, RegPV)

Type: Real PV in Percent—Defines the PV as a percentage.
Lock: View
Default: NaN
PtRes: APM
Range: N/A

PVRAW (AnalgIn)
Type: Real PV Raw Value—Indicates the raw input value of the PV from the Field
Lock: Operator Termination Assembly (FTA) before PV characterization is performed. The
Default: NaN units of value for the PV are determined by the field sensor type as
PtRes: APM described below.
Range: N/A

Helpful Hint: If sensor type is 0.4–2 V, 1 - 5 V, 0 - 5 V, PVRAW is in percent; if sensor

type is T/C, PVRAW is in microvolts; if sensor type is in RTD, PVRAW is
in milliohms; if sensor type is slidewire, PVRAW is in ratio; if sensor type is
0–100 mV, PVRAW is in millivolts.

PVRAW (DigIn)
Type: Logical Raw State of Field Contacts—Indicates the current state of the field
Lock: View contacts.
Default: Off
PtRes: APM
Range:
Off Open contacts
On Closed contacts

APM Parameter Reference Dictionary P-35 10/96

 PVRAW

PVRAW (PI)
Type: Real PV Raw Value—Indicates the raw input value of the PV in pulses per
Lock: View second.
Default: NaN
PtRes: APM
Range: N/A

PVRAW (STI)
Type: Real PV Raw Value—Indicates the raw input value of the PV in % of span based
Lock: View on the transmitter PV after PV characterization (PVCHAR) and DAMPING
Default: NaN have been performed. The span of the PV is determined by using LRV as a
PtRes: APM 0%-point and URV as a 100%-point.
Range: N/A

PVRAWHI
Type: Real PV Raw High Range—Defines the high end of the normal operating range
Lock: Eng/PB for the raw PV value (PVRAW). For a slidewire input, the units are ratio,
Default: NaN for a 0_100_MV input, the units are in millivolts.
PtRes: APM
Range: PVRAWLO to 100 for a 0_100_mv input (microvolts)
PVRAWLO to 1 for a slidewire input (ratio)

PVRAWLO
Type: Real PV Raw Low Range—Defines the low end of the normal operating range for
Lock: Eng/PB the raw PV value (PVRAW).
Default: NaN
PtRes: APM
Range: 0–PVRAWHI (0 to 100 microvolts for a 0_100 mv input, or 0 to 1 ratio for a slidewire input)

PVROCNFL (RegCtl, RegPV)

Type: Logical PV Negative Rate-of-Change Alarm Flag—Indicates that the PV negative
Lock: View rate-of-change has exceeded the value established by the PVROCNTP
Default: Off parameter.
PtRes: APM
Range: Off (No PV negative rate-of-change alarm)
On (PV negative rate-of-change alarm)

APM Parameter Reference Dictionary P-36 10/96

 PVROCNPR

PVROCNPR (RegCtl, RegPV)

Type: E:ALPRIOR PV Negative Rate-of-Change Alarm Priority—Defines the priority of the
Lock: Engr PV negative rate-of-change alarm for this point.
Default:
Low
PtRes: NIM
Range: JnlPrint (Alarm is historized and reported to the printer but not annunciated)
Printer (Alarm is reported to the printer but not historized and not annunciated)
Emergncy (Alarm is historized, annunciated, and reported to all alarm summary displays)
High (Alarm is historized, reported to Area Alarm Summary Display and Unit Alarm
Summary
Display)
Low (Alarm is historized, reported to the Unit Alarm Summary Display, and annunciated)
Journal (Alarm is historized but not reported to Universal Stations and not annunciated)
NoAction (Alarm is not reported to the system and not annunciated)

Helpful Hint: PVROCNPR configuration requires PVROCNTP ≠ NaN.

PVROCNTP (RegCtl, RegPV)

Type: Real PV Negative Rate-of-Change Trip Point—Defines the trip point for the PV
Lock: Supr negative rate-of-change alarm for this point. Operation is the same as for
Default: NaN PVROCPTP except for the direction of change.
PtRes: APM
The maximum rate of change value must be less than the absolute value of:
60
(PVEUHI-PVEULO) * .
8

Range: > 0.0,

NaN

Helpful Hint: For RegPV points, RegCtl points, and points in a HLAI or LLAI, the
maximum rate of change is one step away from PVEXEUHI to PVEXEULO
in eight seconds; therefore, the maximum rate of change is
(PVEXEUHI - PVEXEULO) * 7.5 units/minute. For SENSRTYP = RTD, the
maximum is [800 - (-180)] * 7.5, which is 7350.

PVROCPFL (RegCtl, RegPV)

Type: Logical PV Positive Rate-of-Change Alarm Flag—Indicates that the positive
Lock: View rate-of-change of the PV has exceeded the value established by the
Default: Off PVROCPTP parameter.
PtRes: APM
Range: Off (No PV positive rate-of-change alarm)
On (PV positive rate-of-change alarm)

APM Parameter Reference Dictionary P-37 10/96

 PVROCPPR

PVROCPPR (RegCtl, RegPV)

Type: E:ALPRIOR PV Positive Rate-of-Change Alarm Priority—Defines the priority of the
Lock: Engr positive rate-of-change PV alarm for this point.
Default:
Low
PtRes: NIM
Range: JnlPrint (Alarm is historized and reported to the printer but not annunciated)
Printer (Alarm is reported to the printer but not historized and not annunciated)
Emergncy (Alarm is historized, annunciated, and reported to all alarm summary displays)
High (Alarm is historized, reported to Area Alarm Summary Display and Unit Alarm
Summary
Display)
Low (Alarm is historized, reported to the Unit Alarm Summary Display, and annunciated)
Journal (Alarm is historized but not reported to Universal Stations and not annunciated)
NoAction (Alarm is not reported to the system and not annunciated)

Helpful Hint: PVROCPPR configuration requires PVROCPTP ≠ NaN.

PVROCPTP (RegCtl, RegPV)

Type: Real
Lock: Supr PV Positive Rate-of-Change Trip Point—Defines the positive PV rate-of-
Default: NaN change limit in engineering units/minute for this point; for example 25
PtRes: APM degrees per minute. The PV value is checked every four seconds. The rate
of change alarm trips if the PV rate-of-change value is exceeded for two
successive scans. The alarm is reset if the PV rate-of-change falls below the
rate of change value for two successive scans.

The maximum rate of change value must be less than the absolute value of:
60
(PVEUHI-PVEULO) * .
8
Range: > 0.0,
NaN

Helpful Hint: For RegPV points, RegCtl points, and points in HLAI or LLAI, the
maximum
rate of change is one step away from PVEXEUHI to PVEXEULO in eight
seconds; therefore, the maximum rate of change is:
(PVEXEUHI - PVEXEULO) * 7.5 units/minute.
Example: for SENSRTYP = RTD, the maximum is: [800 - (-180)] *7.5,
which = 7350.

PVSGCHTP (RegCtl, RegPV)

Type: Real PV Significant Change Alarm Trip Point—Defines the alarm trip point for
Lock: Supr an increment of change that occurs between configured PVHITP and
Default: NaN PVHHTP or PVLOTP and PVLLTP alarms. For example, consider a
PtRes: APM temperature point with limits of PVHITP = 800 degrees, PVHHTP = 850,
Range: > 0.0, and PVSGCHTP = 10. When the temperature rises to 800 degrees, the
NaN PVHITP alarm is annunciated, and should the temperature continue to
increase, the alarm is annunciated again when the temperature reaches 810
degrees, 820 degrees, and so on. This allows the alarm to be reannunciated
to remind the operator of the existence of an alarm condition.

APM Parameter Reference Dictionary P-38 10/96

 PVSOURCE

PVSOURCE (RegCtl, RegPV)

Type: E:PVSOURCE PV Source—Defines the source of the PV input to this data point. The
Lock: Oper PV goes to bad when PVSOURCE is switched from Man to Sub.
Default: Auto
PtRes: APM
Range: 0-Sub (Value is provided by a sequence program)
1-Man (PV is supplied by operator or program)
2-Auto (Field wiring or memory fetch supplies PV)
3-Track (PV tracks OP (DigComp points only))

Helpful Hint: PVSOURCE change by an operator requires PVSRCOPT = All and DITYPE
=
Latched if PNTTYPE = DigIn.

PVSRCOPT (RegCtl, RegPV)

Type: E:PVSRCOPT PV Source Option—Defines the PV source options available in this data
Lock: Eng/PB point.
Default: OnlyAuto
PtRes: APM
Range: 0-OnlyAuto (PV source selection is not available and field wiring or memory fetch supplies
PV)
1-All (PV is provided by an operator, by a sequence program, or by field wiring)

Helpful Hint: PVSRCOPT change by an operator requires DITYPE = Latched if

PNTTYPE= DigIn.

PVSTATES(0)–(4) (DevCtl,
DigComp)
Type: String_8 PV State Descriptors—The PV state descriptors contain the text that
Lock: View describes the five (0-4) possible states of a DigComp or DevCtl PV. The
Default: N/A descriptors are set equal to whatever is configured in BADPVTXT and
PtRes: NIM MOVPVTXT during APM Box configuration and in STATETXT(0),
Range: N/A STATETXT(1), and
STATETXT(2) during point configuration (if PVTXTOPT = ON).

Helpful Hint: PVSTATES, if accessed by Control Language programs, obey the

following rules:
a. PVSTATES (0) = STATETXT (0)
b. PVSTATES (1) = STATETXT (1)
c. PVSTATES (2) = BADPVTXT
d. PVSTATES (3) = MOVPVTXT
e. PVSTATES (4) = STATETXT (2); does not apply unless
NOSTATES = 3

PVSTS (RegCtl, RegPV)

Type: E:PVVALST Status Of PV Input Value—Defines the current status of the PV value.
Lock: View
Default: Bad
PtRes: APM
Range: 0-Bad (Value is bad and replaced with NaN. For an STI point, value can be set to
Bad based on transmitter gross status.)
1-Uncertn (Status of the value is uncertain)
2-Normal (Value is good)

APM Parameter Reference Dictionary P-39 10/96

 PVTEMP

PVT E M P
Type: E:TEMPTURE PV Temperature Scale—Defines the temperature scale to be used in
Lock: PtBld characterizing the PV input.
Default: Degrees C
PtRes: APM
Range: 0-Degrees C (Celsius)
1-Degrees F (Fahrenheit)
2-Degrees R (Rankin)
3-Degrees K (Kelvin)

Helpful Hint: PVTEMP is to be configured when PVCHAR = TC or RTD.

PVTRACK (Pid)
Type: E:TRACKING PV Tracking Option—Defines whether SP is to be set equal to PV.
Lock: Eng/PB
Default: NoTrack
PtRes: APM
Range: 0-NoTrack (SP is never set equal to PV)
1-Track (Man mode or initialization causes SP to track PV)

Helpful Hint: SP is set equal to PV if PVTRACK = Track and the point is:
a. in manual mode
b. being initialized from a secondary
c. undergoing 1-shot initialization during the first sample time after
becoming active.

PVTV
Type: Real PV Target Value in Engineering Units—Defines the target value of the
Lock: Oper PV in engineering units.
Default: NaN
PtRes: APM
Range: PVEXEULO to PVEXEUHI,
NaN

PVTVP
Type: Real PV Target Value in Percent—Indicates the target value of the PV in
Lock: View percent.
Default: NaN
PtRes: APM
Range: > 0.0%, NaN

PVTXTOPT (DevCtl,
DigComp)
Type: Logical PV Text Option—Indicates whether the BADPVTXT and MOVPVTXT
Lock: PtBld parameters are configured for this point, or if the default from the box data
Default: Off point should be used.
PtRes: NIM
Range: Off (The parameters are not configured for this point)
On (The parameters are configured for this point)

APM Parameter Reference Dictionary P-40 10/96

 Q

-Q-

Q
Type: Real Steam Quality Factor Input—Indicates the measured actual steam quality
Lock: View factor.
Default: 1.0
PtRes: APM
Range: > 0.0,
NaN

QSTS (FlowComp)
Type: E:PVVALST Q Input Value Status—Indicates the status of the steam quality-factor
Lock: View input.
Default: Normal
PtRes: APM
Range: 0-Bad (Value is bad and replaced by NaN)
1-Uncertn (Status of the value is uncertain)
2-Normal (Value is good)

APM Parameter Reference Dictionary Q-1 10/96

APM Parameter Reference Dictionary Q-2 10/96
 R1

-R-

R1(1)–(24), R2(1)–(24)
(Logic)
Type: E:$PMMLGPM Real Inputs 1 & 2—Defines the sources that provide the input values
Lock: PtBld for the R1 and R2 inputs of certain logic blocks.
Default: L1
PtRes: APM
Range: 32..47-L1...L12 (Values from Input Connections)
48..51-NN1...NN8 (Local Numerics)

Helpful Hint: R1 configuration requires LOCALGID = EQ, NE, GT, GE, LT, LE, or
CHECKBAD.

RAISDSTN
Type: Universal Raise Output Pulse Destination—Defines the destination of the Raise
[Link] output pulse. RAISDSTN must point to parameters ONPULSE or
Lock: PtBld OFFPULSE of a DigOut data point.
Default: Null
PtRes: APM
Range: ONPULSE
OFFPULSE

RAISETIM
Type: Real Raise Output Pulse Time—Indicates the Raise output pulse time in
Lock: View seconds. It is clamped to MAXPULSE or CYCLETIM, whichever is lower.
Default: N/A If the value of RAISETIM is smaller than MINPULSE, no pulse is issued.
PtRes: APM
Range: N/A,
NaN

RAISRATE
Type: Real Raise OP Stroke Rate in Percent/Second
Lock: Supr
Default: 100.0% per
sec.
PtRes: APM
Range: > 0.0% per second

APM Parameter Reference Dictionary R-1 10/96

 RAMPTIME

RAMPTIME
Type: Real Ramp Time in Minutes
Lock: Oper
Default: 0.0
PtRes: APM
Range: > 0.0

Helpful Hint: RAMPTIME change by an operator requires SPOPT = Tv. The minimum
value
is clamped to TS, the point sample time in minutes, while the maximum
value
is clamped to 32767*TS. To change the RAMPTIME from a logic point
requires Node=Auto and Mode Attribute=Program.

RARWSTS (RegCtl)
Type: E:WINDUP Remote Anti-Reset Windup Status
Lock: View
Default: Normal
PtRes: APM
Range: 0-Normal (Free to move in either direction)
1-Hi (Free to move lower)
2-Lo (Free to move higher)
3-HiLo (Not free to move in any direction)

Helpful Hint: RARWSTS applies only if RCASOPT = Spc, Ddc, or DdcRsp.

RATE1 (RatioCtl)
Type: Real Internal Bias Ramps Down Rate—Rate in EUs per minute at which the
Lock: Supr internal bias (BI) ramps down from the initialization value to the last value
Default: NaN entered by the operator. If BIAS = NaN, initialization for the primary is
PtRes: APM determined through back calculation. If zero is entered, the ramp down of
BI is disabled.
Range: > 0.0, NaN

RATE1 (AutoMan)
Type: Real Rate at Which Bias Ramps Down—Rate at which the bias (B) ramps down
Lock: Supr from the initialization value to the last value entered by the operator. If zero
Default: 0.0 is entered, the ramp down of B is disabled. If set to NaN, the internal bias
PtRes: APM BI will instantaneously change to 0 and cause a bump in the output.
Range: > 0.0, NaN

RATE1–12 (RampSoak)
Type: Real Ramp Rate for Ramp Soak Segments 1–12
Lock: Supr
Default: NaN
PtRes: APM
Range: Negative values are accepted to allow ramping down.

APM Parameter Reference Dictionary R-2 10/96

 RATIO

RATIO (Pid)
Type: Real Ratio—Defines the ratio value by which the SP is multiplied.
Lock: Oper
Default: 1.0
PtRes: APM
Range: RTLOLM to RTHILM

RBOPT
(Pid)
Type: E:RBOPT Ratio/Bias Option—Defines the type of ratio/bias option to be used for this
Lock: Eng/PB algorithm. Refer to the APM Control Functions and Algorithms manual for a
Default: NoRatBi detailed description of bias and ratio options.
PtRes: APM
Range: 0-NoRatBi (No ratio/bias is used to calculate the SP)
1-FixRatBi (Fixed ratio (R) and fixed bias (B) are used)
2-AutoRat (R is back-calculated during initialization)
3-AutoBi (B is back-calculated during initialization)

Helpful Hint: RBOPT applies to only PID-type RegCtl algorithms.

RCASOPT
(AnalgOut)
Type: E:$RCASOPT Remote Cascade Option—Defines whether the AM is to provide the
Lock: Eng/PB output value for this data point. This option is available only when the
Default: None point has been configured as a Full point.
PtRes: APM
Range: 0-None (No cascade mode of any type is allowed)
2-Ddc (Direct Digital Control; in cascade mode, AM point controls this point's OP)

RCASOPT (AutoMan, IncrSum, ORSel,

Switch)
Type: E:$RCASOPT Remote Cascade Option—Defines the type of remote cascade mode to
Lock: Eng/PB be used. Refer to the APM Control Functions and Algorithms manual for a
Default: None detailed description.
PtRes: APM
Range: 0-None (Only local cascade mode is allowed)
2-Ddc (In cascade mode, AM point provides the output OP for this data point)

APM Parameter Reference Dictionary R-3 10/96

 RCASOPT

RCASOPT
(Pid)
Type: E:$RCASOPT Remote Cascade Option—Defines the type of remote cascade mode to
Lock: Eng/PB be used. Refer to the APM Control Functions and Algorithms manual for a
Default: None detailed description.
PtRes: APM
Range: 0-None (Local cascade is the only valid cascade)
1-Spc (AM writes to SP within SP limits)
2-Ddc (AM writes to OP. No OP limits)
3-Rsp (AM writes to SP when this point is in Auto and is being initialized by its secondary.
SP
limits are applied)
4-DdcRsp (AM does Ddc and Rsp functions)

Helpful Hint: MODE for a point cannot be changed to Cascade by the operator or program
if
a. parameter RCASOPT is configured to Ddc, Spc, or DdcRsp
b. the AM strategy has not yet stored to MODE, SP, or OP.
Even if PVTRACK = Track, PV tracking is not performed in auto mode with
INITMAN = On if RCASOPT = Rsp.

RCASOPT (RegCtl)
Type: E:$RCASOPT Remote Cascade Option—Defines the type of remote cascade mode to
Lock: Eng/PB be used. Refer to the APM Control Functions and Algorithms manual for a
Default: None detailed description.
PtRes: APM
Range: 0-None (Only local cascade mode is allowed)
1-Spc (In cascade mode, AM point provides the SP for this point)
2-DDC (In cascade mode, AM point provides the OP for this point)
3-Rsp (In Auto mode with INITMAN = ON, the AM point provides the SP for this point)
4-DDCRsp (In cascade mode, AM point provides the OP for this point)

RCASSHED (RegCtl)
Type: Logical Remote Cascade Shed—Indicates whether the mode has shed from the Cas
Lock: View mode to the preconfigured backup mode.
Default: Off
PtRes: APM
Range: Off (No mode shed)
On (Mode has shed to the preconfigured backup mode)

Helpful Hint: RCASSHED applies only if RCASOPT = Spc, Ddc, or DdcRsp.

RDNHWRE
V
Type: String_2 APMM Control Daugher Card Revision
Lock: View
Default:
PtRes: APM
Range: Hexadecimal Characters 00 to FF

APM Parameter Reference Dictionary R-4 10/96

 REDTAG

REDTAG (RegCtl)
Type: E:REDTAG Red Tag State—Allows the user to set the point as being "out of service,"
Lock: Sup/Eng indicating that this point or the associated control loop needs repair or is
Default: Off being repaired. Once this point is put in the red tag condition, the output OP
PtRes: APM is frozen at the last value or state.
Range: 0-Off (Data point is in service. Point's OP is not frozen)
1-On (Data point is out of service = point's OP is frozen)

Helpful Hint: REDTAG change requires MODE = Man and MODATTR = Oper. Once a
point is red tagged, parameters MODE, MODATTR, and OP (output) cannot
be changed. In addition, for a RegCtl point, ESWENBST cannot be
changed.

REMSOAKT (RampSoak)
Type: Real Remaining Soak Time—Indicates the amount of time remaining in the
Lock: Oper current soak segment.
Default: 0.0
PtRes: APM
Range: 0.0 to 120.0 minutes

RESETFL (DevCtl,
DigComp)
Type: Logical Reset Maintenance Statistics Flag—Used to reset maintenance statistics.
Lock: Oper
Default: Off
PtRes: APM
Range: Off
On (Storing to this parameter resets maintenance statistics)

Helpful Hint: This parameter can be reset by the operator only while it is red tagged. A
program may reset at anytime.

RESETFL (DigIn)
Type: Logical Reset Flag—Resets the accumulator to zero when the command flag
Lock: Prog transitions from the Off to the On state.
Default: Off
PtRes: APM
Range: Off (No Reset command)
On (Reset command is issued to the accumulator)

Helpful Hint: RESETFL change requires DITYPE = Accum

RESETFL
(Totalizr)
Type: Logical Reset Totalizer Command Flag—Resets the total RESETVAL when this
Lock: Prog flag changes from Off to On.
Default: Off
PtRes: APM
Range: Off
On

APM Parameter Reference Dictionary R-5 10/96

 RESETVAL

RESETVAL
(DigIn)
Type: Integer Accumulator Reset Value—Value that is preset in the accumulator. Value
Lock: Oper can then be incremented or decremented depending on the COUNTDWN
Default: 0 parameter.
PtRes: APM
Range: 0–32767

RESETVAL
(Totalizr)
Type: Real Reset Value—Value used for presetting the value to be totaled.
Lock: Oper
Default: 0.0
PtRes: APM
Range: N/A

RESTART (ProcMod)
Type: E:RESTART Process Module Restart State—Indicates the type of restart last
Lock: View performed by the process module. This value will be set to a value other
Default: None than “None” until the first preemption point.
PtRes: APM

Helpful Hint: RESTART can be used to determine if the startup was caused by failover.
Following failover, RESTART takes on the value “Failover.” This value
remains until the first preemption point after which it returns to “None.”

Range: 0-None (Has not been restarted)

1-Failover (Running for the first time after a failover)
3-Warm (Running for the first cycle after a warm start)
4-Cold (Running for the first cycle after a cold start, or a power up to Run)
5-PTACTVN (Running for the first cycle following the transition from Off state to Run
state)

RFB
(PidErfb)
Type: Real Reset Feedback Input in Percent—Indicates the PV value of another
Lock: View data point that is receiving its setpoint from this data point.
Default: N/A
PtRes: APM
Range: > 0.0

APM Parameter Reference Dictionary R-6 10/96

 RG

RG (FlowComp)
Type: Real Reference Specific Gravity—Defines the reference specific gravity or
Lock: Supr reference molecular weight, in the same engineering units as G (measured
Default: 1.0(molecular or calculated specific gravity or molecular weight).
weight)
PtRes: APM
Range: N/A

RINITREQ (RegCtl)
Type: Logical Remote Initialization Request—Indicates whether an initialization
Lock: View request has been made.
Default: On for
AnalgOut,
Off for
RegCtl
PtRes: APM
Range: Off (No request)
On (Request has been made)

Helpful Hint: RINITREQ does not apply if RCASOPT = None.

RINITVAL (RegCtl)
Type: Real Remote Initialization Value
Lock: View
Default: NaN
PtRes: APM
Range: N/A,
NaN

Helpful Hint: RINITVAL does not apply if RCASOPT = None.

RJRAW(1)–(168)
Type: Real Reference Junction's Raw Count in µVolts
Lock: View
Default: NaN
PtRes: APM
Range: N/A

APM Parameter Reference Dictionary R-7 10/96

 RJTEMP

RJTEMP (LLAI)
Type: Real Reference Junction Temperature—Displays the current temperatures
Lock: View (°C) of the reference junction sensor. This value is updated only if the
Default: NaN thermocouple input is configured.
PtRes: APM
Range: N/A

RP (FlowComp)
Type: Real Reference Pressure—RP is the reference pressure input and it is in the
Lock: Supr same Engineering Unit as the P (measured or actual gage pressure) input.
Default: 1.0
PtRes: APM
Range: N/A

RP
Type: Real Minimum Pulse Time Ratio
Lock: Supr
Default: 1.0
PtRes: APM
Range: 0.01 to 100.0

RQ (FlowComp)
Type: Real Reference Steam Quality Factor—Defines the reference steam quality
Lock: Supr factor which is in the same units as the Q (measured actual steam quality)
Default: 1.0 input.
PtRes: APM
Range: N/A

RSPBGP$$ (RampSoak)
Type: Real Ramp/Soak Percent Bar Graph Parameter—If in a ramp sequence, the
Lock: View value of the next soak percent is displayed. If in a soak sequence, the value
Default: N/A of parameter REMSOAKT as a percent of total soak time is displayed.
PtRes: APM
Range: > 0.0

APM Parameter Reference Dictionary R-8 10/96

 RSTROPT

RSTROPT (ProcMod)
Type: E:$RSTROPT Restart Option—Defines how the sequence program is to be started
Lock: Eng following an Idle to Run, or power up to Run transition or a warm restart.
Default: Off
PtRes: APM
Range: 0-Off (Sequence is waiting for the operator command to start)
1-Restart (Sequence is to be restarted from the beginning)

RT (FlowComp)
Type: Real Reference Temperature—RT is the reference temperature input and is in
Lock: Supr the same Engineering Unit as the T (measured actual temperature) input.
Default: 1.0
PtRes: APM
Range: N/A

RT
Type: Real Deadtime Ratio
Lock: Supr
Default: 1.0
PtRes: APM
Range: 0.01 to 100.0

RTHILM
(Pid)
Type: Real Ratio High Limit
Lock: Supr
Default: 100.0
PtRes: APM
Range: RTLOLM to 100.0,
NaN

Helpful Hint: Entering NaN forces RTHILM to its extreme value (100.0%).

APM Parameter Reference Dictionary R-9 10/96

 RTLOLM

RTLOLM
(Pid)
Type: Real Ratio Low Limit
Lock: Supr
Default: 0.01
PtRes: APM
Range: 0.01 to RTHILM,
NaN

Helpful Hint: Entering NaN forces RTLOLM to its extreme value (0.01).

RUNSTATE (ProcMod)
Type: Logical Run State—Indicates that the point is in the RUN sequence execution state.
Lock: View
Default: Off
PtRes: APM
Range: Off (Process Module point is not in the RUN state)
On (Process Module point is in the RUN state)

RV (Timer)
Type: Integer Remaining Time—Indicates the amount of time remaining (in seconds or
Lock: View minutes) that the timer is to run.
Default: 0
PtRes: APM
Range: >0

Helpful Hint: RV represents remaining time computed as SP - PV. If SP = 0, RV

is always 0.

RX (FlowComp)
Type: Real Reference Steam Compressibility—Defines the reference steam
Lock: Supr compressibility, and is in the same engineering units as the X (measured
Default: 1.0 actual steam compressibility).
PtRes: APM
Range: Anything except NaN

APM Parameter Reference Dictionary R-10 10/96

 S0BOXCLR

-S-

S0BOXCLR, S1BOXCLR, S2BOXCLR

Type: E:BOXCOLORState Box Color—Used only for US displays; corresponds to the box colors
Lock: View configured using S0BOXCLR - BOXCLR(0), S1BOXCLR - BOXCLR(1),
Default: N/A S2BOXCLR - BOXCLR(2).
PtRes: NIM
Range: Red
Green
White
Black
Cyan
Yellow
Blue
Magenta

S1
(PidErfb)
Type: Logical Tracking Switch—Determines whether the CV value of this data point is
Lock: Prog replaced by the tracking value.
Default: Off
PtRes: APM
Range: Off (CV value is not replaced)
On (CV value is replaced by the tracking value)

S1 (STI)
Type: String_127 Transmitter Status—Indicates the current status of the smart transmitter
Lock: View associated with this STI point. Transmitter status consists of
Default: Blank - Transmitter scratch pads 1, 2, 3 & 4
PtRes: APM - Detailed transmitter status
Range: N/A, Blank - List of parameters whose values are not the same in both the STI IOP
database and the transmitter's database. (Parameters are
mismatched.)

S1, S2 (RampSoak)
Type: Logical Mark 1 and Mark 2 Flags—These flags are used to indicate to other data
Lock: View points that a specified time has elapsed from the beginning of a specified
Default: Off ramp or soak segment. Refer to the APM Control Functions and Algorithms
PtRes: APM manual for detailed information.
Range: Off
On

APM Parameter Reference Dictionary S-1 10/96

 S1–S4

S1(1)–(24) through S4(1)–(24) (Logic)

Type: E:$PMMLGPM Status Inputs 1-4—Defines the input source for each of the S1-S4
Lock: PtBld inputs to the logic block.
Default: L1
PtRes: APM
Range: FL1...FL12 (Input source is a local flag; they can be either On or Off)
SO1...SO24 (Input source is the status output (SOn) from another logic block.)
L1...L12 (Input source is the configured input connection; they can be either On or Off)

S1–S4 (Switch)
Type: Logical Select X1-X4 Request Flag—Indicate whether the respective input (X1-X4)
Lock: Oper has been selected as the input to this algorithm.
Default: On
PtRes: APM
Range: Off
On (Respective input has been selected)

S1BGNTIM, S2BGNTIM (RampSoak)

Type: Real Mark 1 and Mark 2 Begin Times—Times at which Mark Function Flag
Lock: Supr S1 or S2 is turned on. Refer to the APM Control Functions and Algorithms
Default: 0.0 manual for detailed information.
PtRes: APM
Range: > 0.0 to 120 minutes

S1ENDTIM, S2ENDTIM (RampSoak)

Type: Real Mark 1 and Mark 2 End Time—Times at which Mark Function Flags S1
Lock: Supr and S2 are turned Off. Refer to the APM Control Functions and Algorithms
Default: 0.0 manual for detailed information.
PtRes: APM
Range: > 0.0 to 120 minutes

S1REV(1)–(24) through S3REV(1)–(24)

(Logic)
Type: Logical S1, S2, S3 Inputs Reversed—Allows the user to selectively reverse
Lock: PtBld (invert) any of the inputs to a logic block.
Default: Off
PtRes: APM
Range: Off (Input is direct)
On (Input is reversed)

Helpful Hint: Reversed (inverted) inputs apply only to LOGALGID = And, Or, Nand, and
Nor.

APM Parameter Reference Dictionary S-2 10/96

 S1SEGID, S2SEGID

S1SEGID, S2SEGID (RampSoak)

Type: E:CURSEGID Mark 1 and Mark 2 Segment Identifiers—Refer to the APM Control
Lock: Supr Functions and Algorithms manual for detailed information.
Default:Ramp1
PtRes: APM
Range: 0-Ramp1 1-Soak1
2-Ramp2 3-Soak2
: and :
20-Ramp11 21-Soak11
22-Ramp12 23-Soak12

SAFEOP
Type: Real Safe Operation For Safety Shutdown—Defines the safe output value (OP)
Lock: Engr for a point when the SHUTDOWN parameter is set to On.
Default: N/A
PtRes: APM
Range: -6.9 to 106.9%,
NaN

SAFOPCMD (PosProp, PIDPosPr)

Type: E:$SFOPCMD Safe OP Command—Defines the Safe OP state for position proportional
Lock: Engr and PID position proportional.
Default: Idle
PtRes: APM
Range: 0-IDLE (Output does not change)
1-RAISE (Output is raised)
2-LOWER (Output is lowered)

SCANPER (APM
Box)
Type: Real SI Data Scan Period—Defines the period that the APMM Control Processor
Lock: PtBld scans serial interface data that is mapped to the Array point.
Default: 1.0
PtRes: APM
Range: .25 seconds
.5 seconds
1.0 seconds

SCANPRI (Array)
Type: E:$SCANPRI SI Data FTA Scan Priority—Indicates which scan priority the serial
Lock: PtBld interface FTA is using when reading data from the serial link.
Default: Low
PtRes: APM
Range: Low (Scan at low priority)
High (Scan at high priority)

APM Parameter Reference Dictionary S-3 10/96

 SCANRATE

SCANRATE (APM Box)

Type: E:$PMMSNRT Scan Rate—Defines the number of times that all slots of a particular type are
Lock: PtBld scanned and processed. Refer to the APM Control Functions and Algorithms
Default: Reg1Log1 manual for information on how to determine the processing capacity of the
PtRes: APM APM.
Range: RegCtl & RegPV Logic, DigComp & DevCtl ProcMod
Scan Freq Scan Freq Scan Freq
0-Null ---- ---- ----
1-Reg1Log1 1 second 1 second 1 second
2-Reg1Log2 1 second 1/2 second 1 second
3-Reg1Log4 1 second 1/4 second 1 second
5-Reg2Log2 1/2 second 1/2 second 1 second
6-Reg2Log4 1/2 second 1/4 second 1 second
8-Reg4Log4 1/4 second 1/4 second 1 second

CAUTION
If you attempt to load a new SCANRATE or a new point mix from the DEB, the following items should be
noted:
a. if the new SCANRATE and point mix are accepted by the APMM and if they differ in any way from
their previous values, then the point database will be set to the default state and must be
reloaded from the IDF.
b. If the SCANRATE or any part of the point mix is rejected by the APMM, then the APMM database
remains unchanged; the SCANRATE and the point mix also remain unchanged.
c. If the SCANRATE and the point mix are equivalent to the previous values, then the APMM
database remains unchanged.

SEALOPT (DevCtl, DigComp)

Type: E:$SEALOPT Seal-in Circuit Option—Configures the seal-in circuit option.
Lock: Eng/PB
Default: None
PtRes: APM
Range: 0-None (Sealin is not configured)
1-Sealin (Sealin is configured)

SECOND (APM
Box)
Type: Integer Current Second
Lock: View
Default: N/A
PtRes: APM
Range: 0 to 59

SECSYNC
Type: E:$SECSYNC Secondary Synchronization Status
Lock: View
Default:
PtRes: APM
Range: Synched (Modules are synchronized)
NoSynch (Modules are out of synchronization)

APM Parameter Reference Dictionary S-4 10/96

 SECVAR

SECVAR (DevCtl)
Type: Real Secondary Variable—The analog feedback, normally the motor current or
Lock: View flow.
Default: 0.0
PtRes: APM
Range: Real Numbers including NaN

SECVAR (STI)
Type: Real Secondary Variable—Displays the value of the secondary variable of the
Lock: View smart transmitter as follows:
Default: NaN Pressure transmitter—temperature of the transmitter
PtRes: APM Temperature transmitter—cold junction temperature
Flow transmitter—totalized value.
Range: N/A, NaN

SEGTOT (GenLin)
Type: Integer Total Number of Segments—Defines the total number of segments in the
Lock: Supr curve.
Default: 1
PtRes: APM
Range: 1 to 12

SEGTYPE (RampSoak)
Type: E:SEGTYPE Segment Type—Indicates the current segment being executed by the
Lock: View RegCtl point.
Default: N/A
PtRes: APM
Range: 0-Ramp (Ramp segment)
1-Soak (Soak segment)

SELINP (HiLoAvg, MidOf3)

Type: E:PINP Selected Input—Indicates the selected input for the algorithm.
Lock: View
Default: SelectP1
PtRes: APM
Range: 1-SelectP1 (HiLoAvg and MidOf3 algorithms)
2-SelectP2 (HiLoAvg and MidOf3 algorithms)
3-SelectP3 (HiLoAvg and MidOf3 algorithms)
4-SelectP4 (Only HiLoAvg algorithm)
5-SelectP5 (Only HiLoAvg algorithm)
6-SelectP6 (Only HiLoAvg algorithm)

APM Parameter Reference Dictionary S-5 10/96

 SELXINP

SELXINP (ORSel, Switch)

Type: E:XINP Selected X Input—For the ORSel algorithm, this parameter indicates the
Lock: View inputs to the algorithm that have not been bypassed by the BYPASS1-
(for ORSel) BYPASS4 parameters. For the Switch algorithm, this parameter allows
Oper the operator to specify the input (X1-X4) to the algorithm. Refer to the
(for Switch) APM Control Functions and Algorithms manual for a detailed description.
Default: SelectX1
PtRes: APM
Range: 1-SelectX1
2-SelectX2
3-SelectX3
4-SelectX4

SENSRTYP (HLAI &

LLAI)
Type: E:$SENSRTY Sensor Type—Defines the type of field sensor connected to the Field
Lock: PtBld Termination Assembly (FTA). 0_100_mV, Thermocouple, and RTD
Default: 1_5_V sensor types do not apply for HLAI. P4_2_V and slidewire sensor types do
PtRes: APM not apply for LLAI. Refer to PVCHAR for more information.
Range: 0-1_5_V (1 to 5 volts)
1-0_5_V (0 to 5 volts)
2-0_100_mV (0 to 100 millivolts)
3-Thermcpl (Thermocouple)
4-RTD (Resistance Temperature Device)
5-P4_2_V (0.4 to 2 volts)
6-Slidwire (Slidewire Resistance Device)

SENSRTYP (LLMUX)
Type: E:$SENSRTY Sensor Type—Defines the type of field sensor connected to the Field
Lock: PtBld Termination Assembly (FTA). Refer to PVCHAR for more information.
Default: 0 - 100 mV
PtRes: APM
Range: 2-0_100_mV (0 to 100 millivolts)
3-Thermcpl (Thermocouple)
4-RTD (Resistance Temperature Device)

SENSRTYP (STI)
Type: E:$SENSRTY Sensor Type—Defines the Smart Transmitter type. Refer to PVCHAR for
Lock: PtBld more information. Note that SENSRTYP must match the FTA. The point
Default: Spt_Dp status is set to SOFTFAIL if a mismatch occurs.
PtRes: APM
Range: 8-SPT_DP (ST3000—differential pressure)
9-SPT_GP (ST3000—gauge pressure)
10-SPT_AP (ST3000—absolute pressure)
11-STT (STT3000—temperature)
12-SFM (MagneW 3000—magnetic flow and most Multivariable transmitters)

Helpful Hint: For multivariable transmitters, refer to the transmitter manual for the default
value of the specific device.

APM Parameter Reference Dictionary S-6 10/96

 SEQERR

SEQERR (ProcMod)
Type: Integer Sequence Error—Indicates that a sequence error or failure was detected.
Lock: View A code is displayed to indicate the nature of the error or failure. When an
Default: 0 error is detected, the sequence execution state is changed to ERROR; when
PtRes: APM a failure is detected, the execution state is changed to FAIL.
Range: 0 (No error)
1-100 (Not used)
Error Codes
101 (Not used)
102 (Array index error)
103 (Illegal IMD code)
104 (Illegal variable/operator code)
105 (Interpreter stack overflow)
106 (GOTO destination error)
107 (Key level error)
108 (Configuration mismatch error)
109 (I/O Link prefetch overflow)
110 (Subroutine nesting level error)
111 (Illegal value error)
112 (Fail statement)
113 (IOL-Prefetch buffer full)
114 (IOL-Poststore buffer full)
115 (UCN-Prefetch buffer full)
116 ((UCN-Postore buffer full)
117-164 (Not used)
Failure Codes
165 (Sequence has been halted by the operator)
166 (Sequence jumped to an abnormal condition handler which was not enabled)
167 (Not used)
168 (Timeout condition occurred on WAIT statement)
169 (An attempt was made to start a sequence that has not been loaded)
170 (Communication error in READ/WRITE statement)
171 (Communication error detected during I/O Link access. This error is also generated for
all post-store problems)
172 (Range Error)
173 (An attempt was made to write to a point that was not in the proper mode)
174 (Interlock error)
175-255 (Not used)

SEQEXEC (ProcMod)
Type: E:SEQEXEC Sequence Execution State—Indicates the current execution state of the
Lock: View sequence program that is executing in the process module. Refer to the
Default: NL APM Control Functions and Algorithms manual for a detailed description of
PtRes: APM the execution states.
Range: 0-NL (Not Loaded)
1-DLL (Down-line loading is in progress)
2-Loaded (Sequence has been loaded into the process module)
3-End (Sequence has stopped because it has run to completion)
4-Pause (Sequence has stopped because of a PAUSE statement, or after each step is
executed while in the SnglStep sequence execution mode.)
5-Fail (Sequence has stopped because a sequence failure was detected)
6-Error (Sequence has stopped because a sequence error was detected)
7-Run (Sequence is running in the process module)

APM Parameter Reference Dictionary S-7 10/96

 SEQMODE

SEQMODE (ProcMod)
Type: E:SEQMODE Sequence Execution Mode—Defines the manner in which the sequence
Lock: Determined is executed.
by
CNTLLOCK
parameter
Default: Auto
PtRes: APM
Range: 0-Auto (Normal mode of sequence operation. Sequence runs from beginning to end without
operator intervention.)
1-SemiAuto (Sequence stops at all PAUSE statements in the sequence. Operator action is
required to restart the sequence.)
2-SnglStep (Sequence is executed one step at a time, and operator action is required to
resume execution. This mode is normally used for debugging.)

SEQNAME (ProcMod)
Type: String_8 Sequence Name—Defines the name of the CL sequence that currently
Lock: View resides in the process module.
Default: Blank
PtRes: APM
Range: N/A

SEQOBJSZ (ProcMod)
Type: Integer Sequence Program Size—Indicates the number of memory blocks used by
Lock: View the sequence currently loaded in this process module.
Default: 0
PtRes: APM
Range: >0

SEQPR (ProcMod)
Type: E:ALPRIOR Sequence Priority—Defines the alarm priority for Process Module points.
Lock: Engr Note that even when the Sequence priority is Journal, the alarm indicators
Default:
Low still appear on the Group and Detail displays.
PtRes: NIM
Range: Emergncy (Alarm is historized, annunciated, and reported to all alarm summary displays)
High (Alarm is historized, reported to Area Alarm Summary Display and Unit Alarm
Summary
Display)
Low (Alarm is historized, reported to the Unit Alarm Summary Display, and annunciated)
JnlPrint (Alarm is historized and reported to the printer but not annunciated)
Printer (Alarm is reported to the printer but not historized and not annunciated)
Journal (Alarm is historized but not reported to Universal Stations and not annunciated)
NoAction (Alarm is not reported to the system and not annunciated)

SEQPRGSZ (APM Box)

Type: Integer Sequence Program Size—Gives total APM memory available for
Lock: View sequence program, in blocks.
Default: N/A
PtRes: APM
Range: N/A

APM Parameter Reference Dictionary S-8 10/96

 SEQPROC

SEQPROC (APM Box)

Type: Sequence Processing Rate—Specifies the number of processing units per
E:$SEQPRO Process Module data points that can be processed each quarter second
C cycle.
Lock: PtBld
Default: 1_PU
PtRes: APM
Range: 1_PU One PU per Process Module point is allocated per scan (40 points can be processed
per scan)
2_PU Two PUs per Process Module point are allocated per scan (20 points can be processed
per scan)

SEQSLTSZ (ProcMod)
Type: Integer Sequence Slot Size—Defines the size of the program memory allocated for
Lock: PtBld this process module in terms of blocks. Each block is 32 words long. The
Default: 0 actual size is limited by the available memory.
PtRes: APM
Range: >0

SERIALNO (STI)
Type: String_8 Serial Number/PROM Number of the Smart Transmitter
Lock: View
Default: Blank
PtRes: APM
Range: N/A

SGALGID(1)–(2) (DevCtl)
Type: E:$GTALGID Secondary Gate ID— Defines the algorithm IDs for secondary gates.
in an Array
(1..2)
Lock: PtBld
Default: None
PtRes: APM
Range: NULL (No algorithm)
AND (And Gate algorithm)
OR (Or Gate algorithm)
NAND (Nand Gate algorithm)
NOR (Nor Gate algorithm)
XOR (Exclusive Or Gate algorithm)
PAND (Pulse Nand Gate algorithm)
POR (Pulse or Gate algorithm)
PNAND (Pulse Nand Gate algorithm)
PNOR (Pulse Nor Gate algorithm)
PXOR (Pulse Exclusive or Gate algorithm)

APM Parameter Reference Dictionary S-9 10/96

 SGDSTN

SGDSTN(1)–(2) (DevCtl)
Type: Secondary Gate Destination— Defines the output destination for the
E:$GATDST secondary gates.
N
in an Array
(1..2)
Lock: PtBld
Default: None
PtRes: APM
Range: None (No destination)
SI0 (Output goes to Safety Interlock)
I0, I1, I2 (Output goes to Interlocks)
P0, P1, P2 (Output goes to Permissives)
SOCMD0, SOCMD1, SOCMD2 (Output is commanded to go to SOCMD0, 1 or 2)
OPCMD (Output is commanded to go to OPCMD parameter)

SGPLSWTH(1)–(2)
(DevCtl)
Type: Integer Pulse Width for Secondary Gate— Indicates the pulse width for gates
in an Array whose algorithms begin with “P”.
(1..2)
Lock: Supr
Default: 0
PtRes: APM
Range: 0 to 8000

SGSO(1)–(2) (DevCtl)
Type: Logical Status Output for Secondary Gates
in an Array
(1..2)
Lock: View
Default: Off
PtRes: APM
Range: Off
On

APM Parameter Reference Dictionary S-10 10/96

 SHEDMODE

SHEDMODE (RegCtl)
Type: E:MODE Shedmode—Defines the mode to which this point sheds when it sheds from
Lock: Engr the Cas mode.
Default: Man
PtRes: APM
Range: 1-Man (Manual)
3-Auto (Automatic; applies to only Pid, PosProp, and RatioCtl algorithms)
4-Bcas (Backup Cascade)

Helpful Hint: 1. SHEDMODE configuration requires RCASOPT = Spc or Ddc for Pid
algorithm.
2. SHEDMODE configuration requires RCASOPT = Ddc for the following
algorithms:
AutoMan
IncrSum
ORSel
Switch
3. SHEDMODE configuration requires RCASOPT = Spc for the following
algorithms:
PosProp
RatioCtl

SHEDTIME (RegCtl)
Type: Integer Remote Cascade Shed Time—Defines the amount of time between
Lock: Eng/PB successive updates of the SP or OP value from the AM. If the update is not
Default: 0 received within the specified time, the AM or the NIM is assumed to have
PtRes: APM failed, and the backup control strategy is substituted by means of changing
the mode to a preconfigured backup mode.
Range: 0 to 1000 seconds

Helpful Hint: SHEDTIME configuration requires RCASOPT = Spc, Ddc, or DdcRsp,

which indicates that the SP or OP value is provided by the AM. To disable mode
shed, use the default value of 0 for this parameter.

SHUTDOWN (RegCtl)
Type: Logical Shutdown Command Flag—This optional parameter allows the user to
Lock: Prog implement safety interlocks that can effectively shutdown a single control
Default: Off loop. When the SHUTDOWN flag is set to On by a user-written program or
PtRes: APM logic block, the mode and mode attribute are changed to Man and Oper,
Range: Off respectively, and the OP output is set equal to a predefined safe output
On value (SAFEOP). As long as the SHUTDOWN flag is On, the MODE,
MODATTR, ESWENBST, and OP parameter values cannot be changed.
When the SHUTDOWN flag is set to Off, the control loop must be manually
restarted.

Helpful Hint: Before a program sets this flag to the On state, it should write into parameter
SAFEOP a safe shutdown value of 0%, 100%, or NaN (which causes the
last good OP value to be used).
A Logic Point or CL program must be used to reset the Shutdown Flag.

APM Parameter Reference Dictionary S-11 10/96

 SI0

SI0 (DevCtl, DigComp)

Type: Logical Safety Override Interlock Flag
Lock: Engr
Default: Off
PtRes: APM
Range: Off (Override is not active)
On (Override is active)

Helpful Hint: This parameter can be changed by the engineer only when the point is
inactive or when the APM is idle.

SI0ALOPT (DevCtl, DigComp)

Type: E:$OVRALOP SI0 Safety Override Alarm—Indicates the required action to be
Lock: Eng/PB performed when a safety interlock occurs.
Default: None
PtRes: APM
Range: None (No override alarming)
Auto_Rtn (Return to normal when override is cleared)
Cnfm_Rqd (Confirm to clear, after interlock is cleared)

SI0ALPR (DevCtl, DigComp)

Type: E:ALPIROR Override SI0 Alarm Priority—Indicates the alarm priority for the safety
Lock: Engr override.
Default:
NoAction
PtRes: NIM
Range: JnlPrint (Alarm is historized and reported to the printer but not annunciated)
Printer (Alarm is reported to the printer but not historized and not annunciated)
Emergncy (Alarm is historized, annunciated, and reported to all alarm summary displays)
High (Alarm is historized, reported to Area Alarm Summary Display and Unit Alarm
Summary
Display)
Low (Alarm is historized, reported to the Unit Alarm Summary Display, and annunciated)
Journal (Alarm is historized but not reported to Universal Stations and not annunciated)
NoAction (Alarm is not reported to the system and not annunciated)

SIALGID(1)–(12) (DevCtl)
Type: E:$I2ALGID Secondary Input Gate Algorithm ID—Indicates the algorithm IDs for
in an Array secondary input gates.
(1..12)
Lock: PtBld
Default: Null
PtRes: APM
Range: NULL (No algorithm)
DLY (Input is Delayed algorithm)
ONDLY (On Delay algorithm, transition to ON is delayed)
OFFDLY (Off Delay algorithm, transition to OFF is delayed)
PULSE (Input is Pulsed algorithm)
MAXPULSE (Maximum Pulse Width algorithm)
MINPULSE (Minimum Pulse Width algorithm)

APM Parameter Reference Dictionary S-12 10/96

 SIDLYTIM(1)–(12)

SIDLYTIM(1)–(12)
(DevCtl)
Type: Integer Secondary Input Gate Delay/Pulse Width—Indicates the delay or pulse
in an Array width for secondary input gates.
(1..12)
Lock: Supr
Default: 0
PtRes: APM
Range: 0 to 8000 seconds

SIDSTN(1)–(12) (DevCtl)
Type: Destination for Secondary Input Gates—Defines the output destination of
E:$GATDST the secondary gate.
N
in an Array
(1..12)
Lock: PtBld
Default: None
PtRes: APM
Range: None (No destination)
SI0 (Output goes to Safety Interlock)
I0, I1, I2 (Output goes to Interlocks)
P0, P1, P2 (Output goes to Permissives)
SOCMD0, SOCMD1, SOCMD2 (Output is commanded to go to SOCMD0, 1 or 2)
OPCMD (Output is commanded to go to OPCMD)
SG1, SG2 (Output goes to Secondary gates 1 or 2)
PG1, PG2, PG3, PG4 (Output goes to Primary gates 1, 2, 3 or 4)

SIM_TXT (NIM)
Type: String_8 Simulation Indicator—see also DISP_SIM
Lock: View
Default: N/A
PtRes: APM
Range: N/A

SI0CONF
(DigComp,DevCtl)
Type: Logical Safety Override Interlock Alarm Confirmation Flag—Indicates that the
Lock: Oper safety override interlock alarm needs to be confirmed.
Default: Off
PtRes: APM
Range: N/A

APM Parameter Reference Dictionary S-13 10/96

 SISO

SISO(1)–(12) (DevCtl)
Type: Logical Status Output for Secondary Input Gates—Indicates the output value of
in an Array the secondary input gate.
(1..12)
Lock: View
Default: Off
PtRes: APM
Range: Off
On

SLOTNUM
Type: Integer Slot Number—Defines the slot number where this point resides. For IOP
Lock: PtBld point types (AnalgIn, AnalgOut, DigIn, DigOut), it defines the hardware
Default: N/A subslot on the module (IOP card) in which the point resides; refer to
PtRes: NIM description of MODNUM parameter. For control points (DigComp, DevCtl,
and Array), Logic, RegPV, RegCtl, Flag, Numeric, Timer and ProcMod) it
defines the software slot in the PMM. The processing capacity of the APM
depends on the number and mix of configured control points. Refer to the
APM Control Functions and Algorithms manual for a detailed description of
how to determine the processing capacity of the APM, based on the amount
of control points being used.

For multivariable Smartline transmitters, note that although the transmitter

is connected to only one slot, you must allocate adjacent slots for the other
PVs.

Range: AnalgIn (1-16 for HLAI and STI)

AnalgIn (1-8 for LLAI)
Array (1-256, but ≤ the value of NARRSLOT)
DevCtl (1-160, but ≤ the value of NDEVSLOT)
DigComp (1-512, but ≤ the value of NDCSLOT)
DigIn (1-32)
DigOut (1-16 or 1-32)
Flag (APM Box Flag 1-2047)
LLMUX (1-32)
Logic (1-80, but ≤ the value of NLOGSLOT)
Numeric (APM Box Numeric 1-2047)
ProcMod (1-160, but ≤ the value of NPMSLOT)
PI (1-8)
RegCtl (1-160, but ≤ the value of NCTLSLOT)
RegPV (1-80, ≤ the value of NPVSLOT)
Timer (APM box Timer 1-64)
AnalgOut (1-8 or 1-16)

Helpful Hint: SLOTNUM configuration for Array, DigComp, DevCtl, Flag, Numeric,
Timer,
ProcMod, Logic, RegCtl, and RegPV points require CTLOPT = On.

SLOT0SF(1)–(168)
Type: String_96 Slot 0 Soft Failures—Returns blind record of box soft failures present at a
Lock: View module address.
Default:
PtRes: APM
Range: Hexadecimal Characters 00 to FF

APM Parameter Reference Dictionary S-14 10/96

 SLWSRCID

SLWSRCID
(AnalgIn)
Type: Integer Slidewire Voltage Source Identifier— Defines the slot number of the
Lock: Eng/PB voltage source for the slidewire.
Default: 1
PtRes: APM
Range: 1–16
Helpful Hint: SLWSRCID configuration requires SENSRTYP = Slidewire.

SNAME(1)–(2)
(ProcMod)
Type: String_8 Subroutine Name— Indicates the name of the subroutine currently used by
Lock: View the process module. A value of “ “ means that no subroutine is executing.
Default: Spaces SNAME(1) and SNAME(2) display the name of the first and second level
PtRes: APM subroutines called from the main sequence.
Range: N/A

SO (DigOut)
Type: Logical Status Output— The output from a DigOut point.
Lock: Oper
Default: Off
PtRes: APM
Range: Off (Field contact is to be de-energized.)
On (Field contact is to be energized.)

Helpful Hint: Only the APMM Cont_Ctl access level can write to this parameter.

SO (Timer)
Type: Logical Status Output of Timer— Indicates whether the PV (elapsed time) has
Lock: View reached the SP (preset time).
Default: Off
PtRes: APM
Range: On (PV has reached the SP)
Off (PV has not reached the SP)

APM Parameter Reference Dictionary S-15 10/96

 SO

SO(1)–(24) (Logic)
Type: Logical Logic Block Status Output— Indicates the output state of the logic block.
Lock: View
Default: Off
PtRes: APM
Range: Off (Output is false)
On (Output is true)

SO(0)–(2) (DevCtl, DigComp)

Type: Logical Status output array— Indicates the current output state of the Digital
Lock: View Composite slot.
Default: Off s = (0) for state 0
PtRes: APM s = (1) for state 1
Range: Off s = (2) for state 2
On

SOAKT1–12
Type: Real Soak Time for Soak Segments 1–12— Define the soak time in minutes for
Lock: Supr each soak segment.
Default: 0.0
PtRes: APM
Range: 0.0 to 120.0 minutes

SOAKV1–12
Type: Real Soak Value for R/S Segments 1–12— Defines the soak values in
Lock: Supr engineering units for each soak segment.
Default: NaN
PtRes: APM
Range: N/A

SOCMD(0)–(2) (DevCtl, DigComp)

Type: Logical Output Status Command— When commanding an OFF to ON write, the
Lock: Prog OP is commanded to the state corresponding to the array element written on
Default: OFF an off-to-on transition.
PtRes: APM
Range: On (The OP is commanded to the state corresponding to ‘i’. 0=State 0, 1=State 1, 2=State
2 if
SOCMD (i) was previously OFF)
Off (No action)

APM Parameter Reference Dictionary S-16 10/96

 SP

SP (RegCtl)
Type: Real Setpoint of the PV in Engineering Units
Lock: Oper
Default: 0.0
PtRes: APM
Range: SPLOLM to SPHILM

Helpful Hint: SP usually does not require a control input connection. If a cascade
connection to SP is required, it is typically configured by specifying a
control
output connection on the primary point.

SP (Timer)
Type: Integer Preset Time— Defines the amount of time in seconds or minutes that the
Lock: Oper timer is to run.
Default: 0
PtRes: APM
Range: 0 to 32000

SPEUHI (RegCtl)
Type: Real Setpoint Engineering Unit High Range
Lock: View
Default: N/A
PtRes: APM
Range: > SPEULO

SPEULO (RegCtl)
Type: Real Setpoint Engineering Unit Low Range
Lock: View
Default: N/A
PtRes: APM
Range: < SPEUHI

SPFORMAT (RegCtl)
Type: E:VALFORMT Setpoint Decimal Point Format— Indicates the format of the SP value.
Lock: View SPFORMAT tracks with the selected PVFORMAT.
Default: N/A
PtRes: APM
Range: 0-D0 (XXXX.)
1-D1 (XXX.X)
2-D2 ([Link])
3-D3 ([Link])

APM Parameter Reference Dictionary S-17 10/96

 SPHIFL

SPHIFL (RegCtl)
Type: Logical Setpoint High Limit Violation Flag— Indicates the SP has exceeded the
Lock: View upper limit established by SPHILM.
Default: Off
PtRes: APM
Range: Off (High limit not exceeded)
On (High limit exceeded)

SPHILM (RegCtl)
Type: Real Setpoint High Limit—Defines the upper limit for the SP.
Lock: Supr
Default: NaN
PtRes: APM
Range: SPLOLM to SPEUHI,
NaN

Helpful Hint: SPHILM does not apply for the RampSoak algorithm. Entering NaN
disables
limit checking by forcing SPHILM to its extreme value (SPEUHI).

SPLOCK (ProcMod)
Type: E:ACCLVL Setpoint Lock—Stores to the process module point’s own flags, numeric,
Lock: Engr strings, and time parameters, and are checked against the access lock
Default: Operator specified by SPLOCK.
PtRes: APM
Range: 0-Operator (Operator and higher keylock positions allow store access.)
1-Supervis (Supervisor and higher keylock positions allow store access.)
2-Engineer (Engineer and higher keylock positions allow store access.)
3-Program(Only the program has store access.)

SPLOCK (Array)
Type: E:ACCLVL Setpoint Lock—Indicates the access lock for array point parameters FL,
Lock: Engr NN, STRn and TIME.
Default: Operator
PtRes: APM
Range: 0-Operator (Operator and higher keylock positions allow store access.)
1-Supervis (Supervisor and higher keylock positions allow store access.)
2-Engineer (Engineer and higher keylock positions allow store access.)
3-Program(Only the program has store access.)

APM Parameter Reference Dictionary S-18 10/96

 SPLOFL

SPLOFL (RegCtl)
Type: Logical Setpoint Low Limit Violation Flag— Indicates that the SP has exceeded
Lock: View the lower limit established by SPLOLM.
Default: Off
PtRes: APM
Range: Off (Low limit is not exceeded)
On (Low limit is exceeded)

SPLOLM (RegCtl)
Type: Real Setpoint Low Limit— Defines the lower limit for the SP.
Lock: Supr
Default: NaN
PtRes: APM
Range: SPEULO to SPHILM,
NaN

Helpful Hint: SPLOLM does not apply for the RampSoak algorithm. Entering NaN
disables
limit checking by forcing SPLOLM to its extreme value (SPEULO).

SPOPT (RegCtl)
Type: E:SPOPT Setpoint Option
Lock: Eng/PB
Default: None
PtRes: APM
Range: 0-None (No specialized options are available)
1-TV (Target Value processing; provides a smooth transition from an existing setpoint to a
desired setpoint)
2-Asp (Advisory setpoint processing for Advisory Deviation Alarming)

Helpful Hint: SPOPT does not apply for the RampSoak algorithm. If component has been
entered for the PNTFORM parameter, the Asp option cannot be configured.

SPP (RegCtl)
Type: Real Setpoint in Percent
Lock: View
Default: N/A
PtRes: APM
Range: N/A

SPTV (RegCtl)
Type: Real Setpoint Target Value in Engineering Units
Lock: Oper
Default: N/A
PtRes: APM
Range: SPLOLM to SPHILM,
NaN

Helpful Hint: SPTV change requires SPOPT = TV.

APM Parameter Reference Dictionary S-19 10/96

 SPTVP

SPTVP (RegCtl)
Type: Real Setpoint Target Value in Percent
Lock: View
Default: N/A
PtRes: APM
Range: > 0.0

Helpful Hint: SPTVP change requires SPOPT = TV.

SRQUTAVG (NIM, APM

Box)
Type: Real Average UCN Store Request Trip Time—The average time in
Lock: View milliseconds that it takes to receive a response to this node’s UCN store
Default: NaN request.
PtRes: APM
Range: N/A

Helpful Hint: This statistic can be viewed on the Toolkit Displays.

SRQUTMAX (NIM, APM

Box)
Type: Real Maximum UCN Store Request Trip Time—The maximum time in
Lock: View milliseconds that it takes to receive a response to this node’s UCN store
Default: NaN request.
PtRes: APM
Range: N/A

Helpful Hint: This statistic can be viewed on the Toolkit Displays.

SRSPTAVG (NIM, APM

Box)
Type: Real Average UCN Store Response Trip Time—The average time in
Lock: View milliseconds that it takes this node to respond to UCN store requests from
Default: NaN other nodes.
PtRes: APM
Range: N/A
Helpful Hint: This statistic can be viewed on the Toolkit Displays.

SRSPTMAX (NIM, APM

Box)
Type: Real Maximum UCN Store Response Trip Time—The maximum time in
Lock: View milliseconds that it takes this node to respond to UCN store requests from
Default: NaN other nodes.
PtRes: APM
Range: N/A
Helpful Hint: This statistic can be viewed on the Toolkit Displays.

APM Parameter Reference Dictionary S-20 10/96

 SSTEP

SSTEP(1)–(2) (ProcMod)
Type: String_8 Subroutine Step Name— Indicates the current step of the subroutine
Lock: View executing in this Process Module. A value of “ “ means that no subroutine
Default: Spaces is executing. SSTEP(1) and SSTEP(2) display the step name of the first
PtRes: APM and second level subroutines called from the main sequence.
Range: N/A

SSTMT(1)–(2) (ProcMod)
Type: Integer Subroutine Statement Number— This parameter points to the statement
Lock: View number (in the NIM sequence library) of the current subroutine. A value of
Default: 0 0 indicates that no subroutine is executing. The array index indicates
PtRes: APM nesting level.
Range: 0 to 255

ST0_OP1–3 (DevCtl, Digcomp)

Type: Logical State 0, Outputs 1 through 3— Defines the value (On or Off) that is to be
Lock: Eng/PB written to output number 1, 2, and 3 when the OP is in State 0.
Default: Off
PtRes: APM
Range: Off
On

ST1_OP1–3 (DevCtl, Digcomp)

Type: Logical State 1, Outputs 1, 2, and 3— Defines the value (On or Off) that is to be
Lock: Eng/PB written to output number 1, 2, and 3 when the OP is in State 1.
Default: Off
PtRes: APM
Range: Off
On

ST2_OP1–3 (DevCtl, Digcomp)

Type: Logical State 2–Outputs 1, 2, and 3— Defines the value (On or Off) that is to be
Lock: Eng/PB written to output number 1, 2, and 3 when the OP is in State 2.
Default: Off
PtRes: APM
Range: Off
On

APM Parameter Reference Dictionary S-21 10/96

 STARTFL

STARTFL
Type: Logical Start Command Flag— Starts DigIn accumulator or RegPV totalizer when
Lock: Prog flag transitions from Off to On.
Default: Off
PtRes: APM
Range: Off (No effect on accumulator/totalizer)
On (Allows the accumulator/totalizer to begin counting up/down)

STATE
(STI)
Type: E:STATE Current State—Indicates the current state of the STI point.
Lock: View
Default: N/A
PtRes: APM
Range: 2-Loading (Indicates that database loading between the STI point and the transmitter is
occurring.)
3-Loadcomp (Indicates that the database transfer between the STI point and the transmitter
has been successfully completed)
4-Loadfail (Indicates that the parameter transfer between the STI point and the transmitter
has not been successfully completed)
5-Calib (Indicates that certain parameters are being calibrated at the transmitter by the STI
point)
6-Calcomp (Indicates that the calibration has been successfully completed)
7-Calfail (Indicates that the calibration has not been successfully completed)
8-OK (Normal state; indicates that the STI point and the transmitter are OK. Transmitter is
updating the PV value at the STI point. STATE remains OK when the point is made
inactive.)
9-DBChange (Indicates that a database mismatch between the STI point and the transmitter
has been detected. Transmitter is not updating the PV value at the STI point. STATE
remains DBChange when the point is made inactive.)

STATE (Timer, DigIn)

Type: E:STATE Timer State— Indicates the current state of the timer data point.
Lock: View
Default: Stopped
PtRes: APM
Range: 0-Stopped
1-Running

STATE (Totalizr)
Type: E:STATE Accumulator State— Indicates the current state of the totalizer.
Lock: View
Default: Stopped
PtRes: APM
Range: 0-Stopped (Stopped)
1-Running (Accumulating)

APM Parameter Reference Dictionary S-22 10/96

 STATE0–2

STATE0–2
Type: String_8 Current State— These parameters represent the state text (STATETXT)
Lock: View descriptors as follows:
Default: 1 = On STATE0 = STATETXT(0)
0 = Off STATE1 = STATETXT(1)
2 = State 2 STATE2 = STATETXT(2); Digital Composite and DevCtl points only
PtRes: NIM Refer to the APM Control Functions and Algorithms manual for a detailed
description of the Digital Composite point states.
Range: N/A

STATETXT(0)–(3) (DevCtl, DigIn, DigComp,

Flag)
Type: String_8 State Descriptor Text— Define the states of the point using descriptors
Lock: PtBld which can have up to eight characters.
Default: 1 = On
0 = Off STATETXT (1) corresponds to the first ACTIVE state, or the state
2 = State 2 corresponding to PVFL = On (direct acting) or PVFL = Off (reverse
3 = None (State acting). On the Group or Detail Display, it is in the upper box.
3)
PtRes: NIM STATETXT (0) corresponds to the INACTIVE state, or the state
corresponding to PVFL = Off (direct acting) or On (reverse acting). On
the Group or Detail Display, it is the middle box for a Digital Composite
or DevCtl point. For a Digital Input point, it is the lower box.

STATETXT (2) corresponds to the second ACTIVE state. On the Group

or Detail Display for a Digital Composite or DevCtl point, it is in the
lower box. STATETXT(2) does not apply to Digital Input and Flag
points. When a two- state device is configured, STATETXT(2) is
internally set to $NULL.

STATETXT (3) “NONE” (not configurable).

STATETXT(3) does not apply to Digital Input and Flag points.

Range: N/A

Helpful Hint: STATETXT has an access lock of View if PNTFORM = Componnt.

STATETXT (2) for State 2 applies only if NOSTATES = 3 for digital
composite or device control points.

STATMENT (ProcMod)
Type: Integer Statement— Indicates the current statement of the sequence executing in
Lock: View this process module. A statement number of 0 indicates that no statement is
Default: 0 being executed.
PtRes: APM
Range: 1 to 255

APM Parameter Reference Dictionary S-23 10/96

 STATTIM0– 2
STATTIM0–2 (DevCtl,
DigComp)
Type: Time State Time— The amount of time based on the PV that has accumulated for
(Duration) States 0, 1, and 2 since the most recent reset of maintenance statistics.
Lock: View
Default: 0
PtRes: APM
Range: 0 - 4000 Days (1 second resolution)

STCHGOPT (DevCtl, DigComp)

Type: E:$STCHGOP State Change Option— State0 passed through before entering a new
Lock: Engr/PB state. If command disagree alarming is not configured, the point will wait
Default: 0-None for the number of seconds designated in the PAUSETIM parameter after
PtRes: 1-APM State0 is commanded. If alarming is configured, the system will wait for
the PV to go to State0 (or when the feedback timer expires) before
starting the pause timer.

Range: None (State change option is not configured)

State0 (State change option is configured)

STDBYMAN (AnalgOut, DigOut, RegCtl)

Type: Logical Standby Manual Flag— Indicates whether the associated hardware output
Lock: View is connected to a standby manual device. It is not an indication of whether
Default: Off or not the output is isolated from the process.
PtRes: APM
Range: Off (Output is not connected to standby-manual device)
On (Output is connected to standby-manual device)

STDBYSTS(1)–(168)
Type: Logical Standby Status Flag— Returns blind record of STDBYMAN status
Lock: View
Default:
PtRes: APM
Range: Off (No Standby Manual present)
On (Standby Manual is activated)

STEP (ProcMod)
Type: String_8 Step Name— Indicates the step name of the sequence executing in this
Lock: View process module.
Default: Spaces
PtRes: APM
Range: N/A

APM Parameter Reference Dictionary S-24 10/96

 STI_EU

STI_EU
(STI)
Type: E:STI_EU Smart Transmitter Engineering Units—Specifies the units of
Lock: Eng measurement for parameters LRL, LRV, URL, and URV.
Default: InH20
PtRes: APM For multivariable Smart Transmitters with a SENSRTYP of SFM, choose
BLANK. For multivariable slots with a SENSRTYP of SPT_DP, SPT_AP,
SPT_GP, or STT, choose the preferred STI_EU (engineering units). When
BLANK is selected the limit values URL, LRL, URV and LRV are
displayed in the base engineering units specified in the transmitter user
manual.
Helpful Hint: Loading an invalid STI_EU type causes an error. An attempt to correct it
from the Detail Display is rejected as CONFIG MISMATCH. To recover, load the correct
STI_EU parameter from the PED or perform an UPLOAD from the point Detail Display.
Range:
0-InH20 (Pressure transmitter—Inches of water)
1-MMHG (Pressure transmitter—Millimeters of mercury)
2-PSI (Pressure transmitter—Pounds per square inch)
3-KPA (Pressure flow transmitter—Kilopascals)
4-MPA (Pressure transmitter—Millipascals)
5-MBar (Pressure transmitter—Millibars)
6-Bar (Pressure transmitter—Bars)
7-G_SQCM (Pressure transmitter—Grams per square centimeter)
8-KG_SQCM (Pressure flow transmitter—Kilograms per square centimeter)
9-MMH20 (Pressure transmitter—Millimeters of water)
10-INHG (Pressure transmitter—Inches of mercury)
11-Deg_C (Temperature transmitter—Degrees Centigrade)
12-Deg_F (Temperature transmitter—Degrees Fahrenheit)
13-Deg_K (Temperature transmitter—Degrees Kelvin)
14-Deg_R (Temperature transmitter—Degrees Rankine)
15-MV (Temperature transmitter—Millivolts)
16-V (Temperature transmitter—Volts)
17-Ohms (Temperature transmitter—RTD Ohms)
18-CM_HR (Magnetic flow transmitter (volume)—Cubic Meters per hour)
19-Gal_HR (Magnetic flow transmitter (volume)—Gallons per hour)
20-LIT_HR (Magnetic flow transmitter (volume)—Liters per hour)
21-CC_HR (Magnetic flow transmitter (volume)—Cubic Centimeters per hour)
22-CM_Min (Magnetic flow transmitter (volume)—Cubic Meters per hour)
23-Gal_Min (Magnetic flow transmitter (volume)—Gallons per minute)
24-Lit_Min (Magnetic flow transmitter (volume)—Liters per minute)
25-CC_Min (Magnetic flow transmitter (volume)—Cubic centimeters per minute)
26-CM_Day (Magnetic flow transmitter (volume)—Cubic meters per day)
27-Gal_Day (Magnetic flow transmitter (volume)—Gallons per day)
28-KGal_Day (Magnetic flow transmitter (volume)—Thousands of gallons per day)
29-BRL_Day (Magnetic flow transmitter (volume)—Barrels per day)
30-CM_Sec (Magnetic flow transmitter (volume)—Centimeters per second)
31-KG_HR* (Magnetic flow transmitter (mass)—Kilograms per hour)
32-LBS_HR* (Magnetic flow transmitter (mass)—Pounds per hour)
33-Ft_Sec (Magnetic flow transmitter (velocity)—Feet per second)
34-M_Sec (Magnetic flow transmitter (velocity)—Meters per second)
35-KG_Min* (Magnetic flow transmitter (mass)—Kilograms per minute)
36-KG_Sec* (Magnetic flow transmitter (mass)—Kilograms per second)
37-LBS_Min* (Magnetic flow transmitter (mass)—Pounds per minute)
38-LBS_Sec* (Magnetic flow transmitter (mass)—Pounds per second)
39-PRCNT (Percent)
______________
*Not implemented

APM Parameter Reference Dictionary S-25 10/96

 STISWVER

STI_EU enumerations (con’t)

40-BLANK (Blank) - Multivariable transmitter with SFM SENSRTYP

41-LBS (Pounds)
42-KG (Kilograms)
43-TONS (Tons)
44-GRAMS (Grams)
45-OZ (Ounces)
46-GAL (Gallons)
47-BRL (Barrels)
48-CUB_M (Cubic Meters)
49-LITERS (Liters)
50-MLITRES (Milliliters)
51-FL_OZ (Fluid ounce)
52-FEET (Feet)
53-METERS (Meters)
54-MM (Millimeters)
55-INCHES (Inches)
56-KG_CUM (Kilograms per cubic meter)
57-G_CUM (Grams per cubic Meter)
58-LBS_CUFT (Pounds per cubic foot)
59-LBS_CUIN (Pounds per cubic inch)

STISWVER (STI)
Type: String_8 Software Revision Level of the Smart Transmitter
Lock: View
Default: Blank
PtRes: APM
Range: N/A

STIT AG
(STI)
Type: String_8 Transmitter Tag Name—Identifies the name of the Smart Transmitter to
Lock: Eng/PB the system and on displays, reports, and logs.
Default: All Spaces
PtRes: APM

Helpful Hint: For multivariable transmitters, an identical STITAG must be entered for
each active slot related to that transmitter. The IOP uses the number of identical STITAG
names to calculate the number of PVs associated with with a given transmitter.

Range: Tag name can be up to 8 characters, and the permissible character set is as follows:
Alphabetics A-Z (uppercase or lowercase)
Numerics 0-9
Embedded space characters are allowed.

APM Parameter Reference Dictionary S-26 10/96

 STOPFL

STOPFL
Type: Logical Stop Command Flag— Stops the DigIn accumulator or RegPV totalizer
Lock: Prog when the flag transitions from Off to On.
Default: Off
PtRes: APM
Range: Off (No effect on the accumulator/totalizer)
On (Stops the accumulator/totalizer from counting up/down)

STR8(1)–(16,384) (APM
Box)
Type: String_8 Box String Variables— The upper bound limit of this array is determined
Lock: Oper by the NSTRING Box parameter. The LCN index limit is 4095, while no
Default: Spaces limit exists for the UCN. Array points may be used to address strings with
PtRes: APM an index greater than 4095.
Range: N/A

STR8(1)–(16) (ProcMod)
Type: String_8 Local String Variables—Each Process Module point has 16 local STR8
Lock: Determined variables that are different from the APM Box STR8 variables.
by
SPLOCK
parameter
Default: Spaces
PtRes: APM
Range: N/A

STR16(1)–(8) (ProcMod)
Type: String_16 Local String Variables—Each Process Module point has 8 local STR16
Lock: Determined variables that overlay the local STR8 variables [for example,
by STR16(1)=STR8(1) concatenated with STR8(2)].
SPLOCK
parameter
Default: Spaces
PtRes: APM
Range: N/A

APM Parameter Reference Dictionary S-27 10/96

 STR32

STR32(1)–(4) (ProcMod)
Type: String_32 Local String Variables— Each Process Module point has four local STR32
Lock: Determined variables that overlay the local STR8 variables.
by
SPLOCK
parameter
Default: Spaces
PtRes: APM
Range: N/A

STR64(1)–(2) (ProcMod)
Type: String_64 Local String Variables—Each Process Module point has two local STR64
Lock: Determined variables that overlay the local STR8 variables [for example,
by STR64(1)=STR8(1-8)].
SPLOCK
parameter
Default: Spaces
PtRes: APM
Range: N/A

STR8(i) (Array)
Type: String_8 Array Point String Variables—8-character string variables that are
Lock: Determined mapped to the Array point. The number of variables is dependent on the
by NSTRING and STRLEN variables.
SPLOCK
parameter
Default: N/A
PtRes: APM
Range: 1 ≤ i ≤ (Array parameter NSTRING)/(8/STRLEN)

STR16(i) (Array)
Type: String_16 Array Point String Array Variables—16-character string variables that are
Lock: Determined mapped to the Array point. These variables overlay the STR8 variables.
by
SPLOCK
parameter
Default: N/A
PtRes: APM
Range: 1 ≤ i ≤ (Array parameter NSTRING)/(16/STRLEN)

APM Parameter Reference Dictionary S-28 10/96

 STR32(i)

STR32(i) (Array)
Type: String_32 Array Point String Variables—32-character string variables mapped to the
Lock: Determined Array point that overlay the STR8 variables.
by
SPLOCK
parameter
Default: N/A
PtRes: APM
Range: 1 ≤ i ≤ (Array parameter NSTRING)/(32/STRLEN)

STR64(i) (Array)
Type: String_64 Array Point String Variables—64-character string variables mapped to the
Lock: Determined Array point that overlay the STR8 variables.
by
SPLOCK
parameter
Default: N/A
PtRes: APM
Range: 1 ≤ i ≤ (Array parameter NSTRING)/(64/STRLEN)

STRDESC (Array)
Type: String_64 String Array Descriptor—64-character string describing the Array point
Lock: PtBld string data.
Default: Spaces
PtRes: APM
Range: N/A

STRLEN (Array)
Type: Integer Array Point String Length— Indicates the length of the configured string
Lock: PtBld (with the STRSTIX and NSTRING parameters) displayed on the Array
Default: 8 Point Detail display. Strings can be accessed by STR8, STR16, STR32 or
PtRes: APM STR64 regardless of this value.
Range: 8, 16, 32, 64

STRLEN (ProcMod)
Type: Integer Process Module String Length— Indicates the displayed string length on
Lock: PtBld the Process Module Detail display. Strings can still be accessed by STR8,
Default: 8 STR16, STR32, or STR64 regardless of this value.
PtRes: APM
Range: 8, 16, 32, 64

APM Parameter Reference Dictionary S-29 10/96

 STRSTIX

STRSTIX (Array)
Type: Real String Array Start Index—Defines the string array start index in Box
Lock: PtBld STR8 variables, or the Serial Interface-connected device.
Default: 0
PtRes: APM
Range: 0 to Box parameter NSTRING (When EXTDATA≠IO_STR, 0 indicates no strings are
configured)
0 to 99,999 (When EXTDATA=IO_STR, 0 can be a valid device index)

STRTFAIL(1)–(6)
Type: String_2 Startup/Failover Information
Lock: View
Default:
PtRes: APM
Range: Hexadecimal characters 00 to FF

STSMSG
Type: E:MSGTXT Status Message— A self-defining enumeration of the MSGTXT parameter
Lock: Oper that provides additional descriptive information regarding the red tag, batch
Default: MSGTXT(0) state, or device state.
PtRes: APM
Range: MSGTXT(0) to MSGTXT(15)

SUMSLTSZ (APM Box)

Type: Integer Total Configured Memory for Sequence Programs—This parameter
Lock: View equals the sum of all Process Module SEQSLTSZ parameters, and is
Default: 0 shown on the APMM Control Configuration display.
PtRes: APM
Range: >0

SUSPSTAT (ProcMod)
Type: E:$SUSPST Suspend State
Lock: View
Default: None
PtRes: APM
Range: 0-None
2-Feedback
3-Wait
4-ConfMsg
5-InputMsg

APM Parameter Reference Dictionary S-30 10/96

 SUSPTIME

SUSPTIME (ProcMod)
Type: Integer Suspension Timer—The remaining time (in minutes) before the
Lock: View sequence program resumes execution. This timer is started when a
Default: 0 sequence program executes a wait statement.
PtRes: APM
Range: 0 to 32, 767 minutes

SVALDB (DevCtl)
Type: E:PVALDB SECVAR Alarm Deadband— The deadband for the SECVAR alarm.
Lock: Engr/PB
Default: One
PtRes: APM
Range: 0-Half (1/2 of 1% of Engineering Unit range)
1-One (1% of Engineering Unit range)
2-Two (2% of Engineering Unit range)
3-Three (3% of Engineering Unit range)
4-Four (4% of Engineering Unit range)
5-Five (5% of Engineering Unit range)
6-EU (Value is defined by SVALDBEU parameter)

SVALDBEU (DevCtl)
Type: Real SECVAR Alarm Deadband in Engineering Units— Indicates the alarm
Lock: Engr/PB deadband in engineering units when the SVALDB parameter = EU.
Default: 0.0
PtRes: APM
Range: Allowable Engineering Units

SVDESC (DevCtl)
Type: String_8 SECVAR Descriptor— Defines the SECVAR parameter or secondary
Lock: PtBld variable descriptor.
Default: Blank
PtRes: APM
Range: 8 Character String

SVEUDESC (DevCtl)
Type: String_8 SECVAR Engineering Unit Descriptor— Defines the engineering unit
Lock: PtBld descriptor for the SECVAR parameter or secondary variable descriptor.
Default: Blank
PtRes: APM
Range: 8 Character String

APM Parameter Reference Dictionary S-31 10/96

 SVEUHI

SVEUHI (DevCtl)
Type: Real SECVAR Range High— Defines the high engineering unit range for the
Lock: Engr/PB SECVAR parameter.
Default: NaN
PtRes: APM
Range: <> NaN

SVEULO (DevCtl)
Type: Real SECVAR Range Low— Defines the low engineering unit range for the
Lock: Engr/PB SECVAR parameter.
Default: NaN
PtRes: APM
Range: <> NaN

SVHHFL (DevCtl)
Type: Logical SECVAR High-High Alarm Flag
Lock: View
Default: Off
PtRes: APM
Range: Off (SECVAR parameter is below the SVHHTP parameter minus the deadband)
On (SECVAR parameter has exceeded the SVHHTP parameter)

SVHHPR (DevCtl)
Type: E:ALPIOR SECVAR High-High Alarm Priority
Lock: Engr
Default: Low
PtRes: NIM
Range: JnlPrint (Alarm is historized, reported to printer, but not annunciated)
Printer (Reported to printer only)
Emergncy (Reported to all alarm summary displays)
High (Reported to Area Alarm Summary Display and Unit Alarm Summary Display)
Low (Reported to Unit Alarm Summary Display)
Journal (Logged but not reported to Universal Stations)
NoAction (Alarm is not reported to the system)

APM Parameter Reference Dictionary S-32 10/96

 SVHHTP

SVHHTP (DevCtl)
Type: Real SECVAR High-High Alarm Trip Point— No alarms are generated when
Lock: Supr this parameter is set to NaN.
Default: NaN
PtRes: APM
Range: ≥ SVHITP or NaN

SVHHTPP (DevCtl)
Type: Real SECVAR High-High Trip Point Percent— The SECVAR High-High Trip
Lock: Supr Point in terms of engineering units in percent.
Default: NaN
PtRes: APM
Range: 0 to 100

SVHIFL (DevCtl)
Type: Logical SECVAR High Alarm Flag— This flag is set when the SECVAR exceeds
Lock: View SVHITP and is reset when SECVAR is below SVHIFL minus deadband.
Default: Off
PtRes: APM
Range: Off (SECVAR parameter is below SVHIFL minus the deadband)
On (SECVAR parameter has exceeded SVHIFL)

APM Parameter Reference Dictionary S-33 10/96

 SVHIPR

SVHIPR (DevCtl)
Type: E:ALPRIOR SECVAR High Alarm Priority
Lock: Engr
Default:
Low
PtRes: NIM
Range: JnlPrint (Alarm is historized and reported to the printer but not annunciated)
Printer (Alarm is reported to the printer but not historized and not annunciated)
Emergncy (Alarm is historized, annunciated, and reported to all alarm summary displays)
High (Alarm is historized, reported to Area Alarm Summary Display and Unit Alarm
Summary
Display)
Low (Alarm is historized, reported to the Unit Alarm Summary Display, and annunciated)
Journal (Alarm is historized but not reported to Universal Stations and not annunciated)
NoAction (Alarm is not reported to the system and not annunciated)

SVHITP (DevCtl)
Type: Real SECVAR High Alarm Trip Point— When this parameter is set to NaN, no
Lock: Supr alarms are generated.
Default: NaN
PtRes: APM
Range: ≥ SVEULO or NaN

SVHITPP (DevCtl)
Type: Real SECVAR High Alarm Trip Point Percent— The SECVAR High Trip Point
Lock: Supr in terms of engineering units percent.
Default: NaN
PtRes: APM
Range: 0 to 100

SVP (DevCtl)
Type: Real SECVAR in Percent of Engineering Range— The percentage for this
Lock: View parameter is calculated from the SECVAR parameter, using both the
Default: NaN SVEVHI and SVELVO parameters.
PtRes: APM
Range: 0 to 100

APM Parameter Reference Dictionary S-34 10/96

 SVPEAK

SVPEAK (DevCtl)
Type: Real Peak Value of SECVAR— Indicates the highest value of the SECVAR
Lock: View parameter since the device changed from state 0.
Default: NaN
PtRes: APM
Range: Real or NaN

SVSRC (DevCtl)
Type: Universal SECVAR Input Connection— Specifies input connection to which the
[Link] current values of Device Control inputs are supplied. The connection can be
Lock: PtBld specified using the "[Link]" format or the hardware reference
Default: Null address format Refer to the APM Control Functions and Algorithms manual
PtRes: APM for a detailed description.
Range: Use [Link] for tagged points where Tagname can be up to 16 characters and
the permissible character set is as follows:
Alphabetics A-Z (uppercase only)
Numerics 0-9 (an all numeric tag name is not allowed)
Underscore (_) cannot be used as the first character or the last character, and
consecutive underscores are not allowed.
Embedded space characters are not allowed.
An * is used to default to this point's tag name.
Parameter name can be up to eight characters and must be a legitimate parameter
name.

Some possible input-connection sources are

a."Logic slot [Link](nn)" where nn = 1–8
b."ProcMod slot [Link](nnn)" where nnn = 1–80
c."Box Numerics slot [Link]” where nnnnn = 1-16,384
d."" for a box flag that resides in the same box where nnnn = 1–16,384

Use the hardware reference address ![Link] for untagged or tagged points
where
MT is the IOP type, such as AI (Analog Input)
mm is the IOP Card number (1–40)
The letter "S" is a constant
ss is the slot number on the IOP Card (refer to SLOTNUM parameter)
Parameter name can be up to eight characters and must be a legitimate parameter
name.

SVTV (DevCtl)
Type: Real Secondary Variable Target Value— Indicates the normal or operating
Lock: Oper setpoint for the SECVAR parameter.
Default: NaN
PtRes: APM
Range: SVEULO to SVEUHI

APM Parameter Reference Dictionary S-35 10/96

 SVTVP

SVTVP (DevCtl)
Type: Real Secondary Variable Target Value in Percent— Indicates the normal or
Lock: Oper operating setpoint for the SECVAR parameter as a percent.
Default: NaN
PtRes: APM
Range: 0 to 100

SWTCHACT (1)–(40) (APM

Box)
Type: Logical IOP Synchronization—When this parameter is Off (inactive), the backup
Lock: View request line from the IOP's partner is not asserted. When this parameter is
Default: On On (active), the backup request line from the IOP's partner is asserted.
PtRes: APM
Range: On-Active
Off-Inactive

SYNCHSTS(1)–(40) (APM Box)

Type: E:$SYNCHST Primary/secondary Database Synchronization Status. It is set to
Lock: View WARNING when a database inconsistency is first detected, but the
Default: None secondary appears capable of providing backup. It changes to FAIL when
PtRes: APM the APMM has tried to resync but does not succeed or a secondary failure
prevents synchronization.
nn = 1–40 corresponds to the 40 logical I/O modules.
Applies to primary IOP only.

Range: 0-OK - (the secondary is synchronized with the

primary and can provide backup if necessary.)
1-WARNING - (database inconsistency detected
but secondary can probably provide backup).
2-FAIL - (APMM has tried to resynchronize but
has not succeeded or, secondary has also failed).

APM Parameter Reference Dictionary S-36 10/96

 T

-T-

T (FlowComp)
Type: Real Temperature Input—Indicates the measured actual temperature.
Lock: View
Default: 1.0
PtRes: APM
Range: > 0.0

T0 (FlowComp)
Type: Real Zero Reference for Temperature—T0 is the zero reference temperature
Lock: Supr input and it is in the same engineering units as the T (measured actual
Default: 0.0 temperature) input. T0 is typically -459.69 degrees F or -273.15 degrees C.
PtRes: APM Enter the absolute value of the temperature.
Range: N/A

T1
Type: Real Integral Time in Minutes—Defines the integral time constant in
Lock: Supr minutes-per-repeat.
Default: 0.0 minutes
PtRes: APM
Range: 0.0 to 1440.0 minutes

Helpful Hint: Integral action can be disabled by setting T1 equal to 0.0.

T2
Type: Real Derivative Time in Minutes—Defines the derivative time constant.
Lock: Supr
Default: 0.0 minutes
PtRes: APM
Range: 0.0 to 1440.0 minutes

Helpful Hint: Derivative action can be disabled by setting T2 equal to 0.0

TCRNGOPT
Type: E:$TCRNGOP Thermocouple Range Option—Defines the thermocouple range option.
Lock: Eng/PB Applies only if a thermocouple (TC) sensor type is used for this data
Default: Normal point.
PtRes: APM
Range: 0-Normal (Use PVEXEULO's normal range table)
1-Extended (Use PVEXEULO's extended range table)

Helpful Hint: TCRNGOPT configuration requires IOTYPE = LLAI or LLMUX and

SENSRTYP = Thermcpl. Refer to parameter PVEXEULO.

APM Parameter Reference Dictionary T-1 10/96

 TD

TD (VdtLdLag)
Type: Real Total Dead Time in Minutes—Defines the fixed delay time in minutes for
Lock: Supr equation B, and the actual variable delay time in minutes for equations C
Default: 0.0 and D.
PtRes: APM
Range: > 0.0 minutes

TF
Type: Real PV Filter Lag Time in Minutes—Defines the filtering time lag to be used
Lock: Supr after the PV range has been checked. A value of 0.0 specifies that the PV is
Default: 0.0 minutes not delayed.
PtRes: APM
Range: 0.0 to 60.0 minutes

TIME(1)–(4095) (APM Box)

Type: Time Box Time Variables—The upper limit of this array is determined by the
Lock: Oper NTIME parameter. The LCN index limit is 4,095, while the limit on the
Default: 0 seconds UCN is 4096. Array points may be used to address Times with an index
PtRes: APM greater than 4095.
Range: N/A

TIME(i) (Array)
Type: Time Array Point Time Variables— Times are mapped from the APM Box
Lock: Determined defined by the TIMESTIX and NTIME parameters.
by
SPLOCK
parameter
Default: N/A
PtRes: APM
Range: 1 ≤ i ≤ Array parameter NTIME

TIME(1)–(4) (ProcMod)
Type: Time Local Time Variables— Four local Time variables are available in each
Lock: Determined Process Module point. These variables are different than the APM Box
by Time variables.
SPLOCK
parameter
Default: 0 seconds
PtRes: APM
Range: N/A

TIMEBASE (Timer)
Type: E:TIMEBASE Time Base—Defines the time base to be used for the Timer data point.
Lock: Engr
Default: Seconds
PtRes: APM
Range: 0-Seconds
1-Minutes

APM Parameter Reference Dictionary T-2 10/96

 TIMEBASE

TIMEBASE (Totalizr, PI)

Type: E:TIMEBASE Totalizer Time Base—Defines whether time base is in seconds,
Lock: Eng/PB minutes, or hours.
Default: Minutes
PtRes: APM
Range: 0-Seconds (PV and Setpoint engineering units (gallons, etc.) per second)
1-Minutes (PV and Setpoint engineering units (gallons, etc.) per minute)
2-Hours (PV and Setpoint engineering units (gallons, etc.) per hour)

TIMEDESC (Array)
Type: String_64 Time Array Descriptor—Sixty four-character string describing Time
Lock: PtBld data.
Default: Spaces
PtRes: APM
Range: N/A

TIMESECS(1)–(240) (Array)
Type: Time Array Point Time Variables—Times mapped from the APM box
Lock: Determined defined by TIMESTIX and NTIME parameters.
by SPLOCK
parameter
Default: N/A
PtRes: APM
Range: 1 ≤ i ≤ NTIME Array parameter

TIMESTIX (Array)
Type: Real Time Array Start Index—Defines the Time data start index in the Box
Lock: PtBld Time variables.
Default: 0
PtRes: APM
Range: 0 to Box parameter NTIME (0 indicates there are no Times configured for this point)

TIMESYNC (UCN)
Type: E:ENBLSTAT Timesynch Control—Defines whether SOE timesynch can be performed
Lock: PtBld by this NIM or NIM pair. Normally, the NIM with the lowest address is
Default: Disable configured for this function.
PtRes: NIM
Range: Enable (This NIM or NIM pair is able to perform SOE time synchronization)
Disable (This NIM or NIM pair does not perform SOE time synchronization, but can receive
and
report SOE events)

TLD (VdtLdLag)
Type: Real Lead Time Constant in Minutes—Defines the lead-compensation time
Lock: Supr constant in minutes. A 0 (zero) entry specifies no lead compensation.
Default: 0.0 minutes
PtRes: APM
Range: -1440.0 to 1440.0 minutes

APM Parameter Reference Dictionary T-3 10/96

 TLG1, TLG2

TLG1, TLG2 (VdtLdLag)

Type: Real Lag Time Constant
Lock: Supr
Default: 0.0 minutes
PtRes: APM
Range: 0.0 to 1440.0 minutes (0 specifies no lag compensation)

TMCMD(1)–(64) (APM Box)

Type: E:COMMAND Timer Command—An array of commands issued to the 64 Timer data
Lock: Oper points.
Default: N/A
PtRes: APM
Range: 0-None (A command has not been issued to the timer)
1-Start (Starts the timer)
2-Stop (Stops the timer)
3-Reset (Resets the timer to 0)
4-RestStrt (Resets the timer to 0, and starts the timer)

TMPV(1)–(64) (Timer)
Type: Integer Timer PV—Indicates the current (elapsed) time of the Timer data point in
Lock: View seconds or minutes.
Default: 0
PtRes: APM
Range: >0

TMRV(1)–(64) (Timer)
Type: Integer Timer RV—Indicates the remaining time (TMSP minus TMPV) for the
Lock: View Timer data point.
Default: 0
PtRes: APM
Range: >0

TMSO(1)–(64) (Timer)
Type: Logical Timer Status Output—Indicates the current state of the timer output.
Lock: View
Default: Off
PtRes: APM
Range: Off (TMPV ≠ TMSP; elapsed time has not reached the preset time)
On (TMPV = TMSP; elapsed time has reached the preset time)

TMSP(1)–(64) (Timer)
Type: Integer Timer Setpoint—Defines the preset time of the Timer data point, in
Lock: Oper seconds or minutes.
Default: 0
PtRes: APM
Range: 0 to 32000

APM Parameter Reference Dictionary T-4 10/96

 TMST(1)–(64)

TMST(1)–(64) (Timer)
Type: E:STATE Timer State—Indicates the current state of the Timer data point.
Lock: View
Default: Stopped
PtRes: APM
Range: 0-Stopped (Timer is currently stopped)
1-Running (Timer is currently running)

TMTB(1)–(64) (Timer)
Type: E:TIMEBASE Timer Time Base—Defines the time base of the timer.
Lock: Engr
Default: Seconds
PtRes: APM
Range: 0-Seconds
1-Minutes

TRACKING
Type: Logical Selected Input Tracking—Allows the selected input to be changed without
Lock: Eng/PB bumping the output.
Default: Off
PtRes: APM
Range: Off (Tracking disabled)
On (Tracking is to be used)

Helpful Hint: If On, causes nonselected inputs to track the selected input.

TRANTIM0–2 (DevCtl,
DigComp)
Type: Time Transition Time—The date and time of the most recent transition to each
Lock: View state based on the PV.
Default: 0
PtRes: APM
Range: Time Stamp

TRATAVG (NIM, APM Box)

Type: Real Average UCN Transaction Trip Time—The average UCN transaction
Lock: View trip time in milliseconds for both fetch and store responses from this node
Default: NaN to other UCN nodes.
PtRes: APM
Range: N/A

Helpful Hint: This statistic can be viewed on the Toolkit Displays

APM Parameter Reference Dictionary T-5 10/96

 TRATMAX

TRATMAX (NIM, APM Box)

Type: Real Maximum UCN Transaction Trip Time—The maximum UCN
Lock: View transaction trip time in milliseconds for both fetch and store responses
Default: NaN from this node to other UCN nodes.
PtRes: APM
Range: N/A

Helpful Hint: This statistic can be viewed on the Toolkit Displays.

TRFB (PidErfb)
Type: Real Tracking Feedback Input in Engineering Units—Indicates the value of
Lock: View the PV or SP of another data point that is receiving its setpoint from this
Default: NaN data point.
PtRes: APM
Range: N/A

TSTS (FlowComp)
Type: E:PVVALST Temperature Input Value Status—Status of the T input value.
Lock: View
Default: Normal
PtRes: APM
Range: 0-Bad (Value is bad and replaced with NaN)
1-Uncertn (Status of the value is uncertain)
2-Normal (Value is good)

TVPROC (RegCtl)
Type: E:TVPROC Target Value Processor State
Lock: Oper
Default: Off
PtRes: APM
Range: 0-Off (No target value processing)
1-Preset (Set up setpoint target value and ramp time)
2-Run (Perform ramping function)

Helpful Hint: TVPROC applies only if SPOPT = TV.

APM Parameter Reference Dictionary T-6 10/96

 UCNRECHN

-U-
UCNRECHN (APM Box,
NIM)
Type: E:$RECCHN UCN Receive Channel—Indicates the channel to which the node is
Lock: View listening.
Default: ChannelA
PtRes APM, NIM
Range: 0-ChannelA
1-ChannelB

UCNSCANT (APM Box)

Type: Real Peer-to-Peer Scan Period in seconds
Lock: Eng/PB
Default: 0.5
PtRes: APM
Range: 0.5, 1.0

UCNSFREV
Type: Integer UCN Software Revision
Lock: View
Default: N/A
PtRes APM

UCNSFVER
Type: Integer UCN Software Version
Lock: View
Default: N/A
PtRes APM

APM Parameter Reference Dictionary U-1 10/96

 UNCMDFL

UNCMDFL (DevCtl, DigComp)

Type: Logical Uncommanded Change Alarm Flag—Indicates whether an uncommanded
Lock: View change has been detected in the field device. (Field device has changed
Default: Off its state without a command.)
PtRes APM
Range: Off (No uncommanded change alarm)
On (Uncommanded change alarm has been detected by this point)

UNIT
Type: String_2 Unit Identifier—Defines the process unit to which this point is assigned.
Lock: PtBld The unit identifier is originally assigned during network configuration, and it
Default: N/A appears in displays and listings throughout the system.
PtRes NIM
Restriction: Two characters are required; blanks are not allowed. For
example, unit 3 must be entered as 03.
CL and Picture Editor — An integer is returned. This number is
equivalent to the unit position in the Unit Names configuration list.

Range: A-Z, 0-9 (up to 100 unit IDs can be configured)

UPGRADE (UCN)
Type: E:UPGRADE NIM Upgrade Status
Lock: Oper
Default: OK
PtRes NIM
Range: OK (NIM has not been upgraded and is OK)
Upgrade (NIM is upgraded and is questionable)

APM Parameter Reference Dictionary U-2 10/96

 URL

URL (STI)
Type: Real Upper Range Limit—Indicates the upper range limit of the PV at the
Lock: Eng/View Smart Transmitter. This limit is a fixed limit and cannot be changed. Refer
Default: NaN to the description of the STI_EU parameter for the URL engineering units.
PtRes: APM During configuration, the value entered for this parameter must agree with
the URL value of the transmitter. Although any value can be entered during
configuration, a database mismatch will occur when the point is put on-
process because the transmitter's URL value and the STI IOP's URL value
are not the same. If the values are not the same, the STATE parameter value
becomes DBChange and PVSTS becomes Bad. Refer to URL in the
PM/APM Smartline Transmitter Integration Manual for more information.
The corresponding LRL parameter is not a configurable parameter at the
Universal Station.
The upper range limits for the Smart Transmitters are as follows:
For the ST3000 Smart Pressure Transmitters (Spt_Dp, Spt_Gp and Spt_Ap):
Xmtr Range URL (In H2O)

400 inH2O 400.0

600 inH2O 600.0
780 mmHga 400.0
100 PSI 2768.0
200 PSI 5536.13
500 PSI/A 13840.34
1500 PSI 41521.0
2000 PSI 55361.35
3000 PSI 83042.02
6000 PSI 166084.0
10000 PSI 276806.7

For the STT3000 Smart Temperature Transmitter (Stt):

Sensor Type URL
(PVCHAR) (in Degrees C except where noted)
Linear (mV) 1000 mV
Thermocouples:
B 1820
E 1000
J 1200
K 1370
NiNiMoTC 1300
N 1300
R 1760
S 1760
T 400
W5W26TC 2300
W3W25TC 2300

APM Parameter Reference Dictionary U-3 10/96

 URV

RTDs:
Cu10RTD 250
Cu25RTD 250
DINRTD 850
JISRTD 640
NicklRTD 150
Pt200 850
Pt500 850
RHRad 1800
RTD (ohms) 4000 Ω

For the MagneW 3000 Magnetic Flowmeter (Sfm):

πD2
URL (in meters3/hour) = x 3600 x (N + 1)
4x106

where: D = the detector diameter in millimeters as follows: 2.5, 5, 10, 15,

25, 40, 50, 80, 100, 150, 200, 300, 350, 400, 500, 600, or 700
N = the number of dummy submerged detectors, from 0 to 9
Range: N/A, NaN

URV (STI)
Type: Real Upper Range Value—Defines the upper end of the operating range for the
Lock: Supr/View PVRAW value. Refer to the description of the STI_EU parameter for the
Default: NaN URV engineering units.
PtRes: APM
Range: N/A, NaN Although the following maximum values can be entered, values greater than
the URL are not recommended and accuracy is not guranteed in such cases.

For a pressure transmitter (Spt): URVmax = 2.0 x URL

For a temperature transmitter (Stt): URVmax = 2.0 x URL
For a magnetic flow transmitter (Sfm): URVmax = 12.0 x URL

This parameter is a view-only parameter when the STI point execution state
PTEXECST is Active (indicating that changes cannot be made in this
parameter value from the Universal Station).

USERID
Type: String_16 User ID Reservation—The user ID that currently has reserved this point.
Lock: Oper The user can be changed by either a point, program, or operator. The
Default: Dashes operator can overwrite the USERID parameter at anytime. A program can
PtRes APM store a nonblank string in this parameter only if it is blank. If the USERID
string starts with three or more dashes (- - -), only the operator can
overwrite the ID.
Range: 16 Character String

UTSDRIFT (APM Box,

NIM)
Type: Integer UCN Node Clock Drift—Indicates the current APMM clock drift rate,
Lock: View calculated by averaging the LCN clock interval and SYNCH CLOCK
Default: N/A interval over multiple synchs. Averaging does not occur until UCN time
PtRes APM, NIM synchronization is in a steady state.
Range:

APM Parameter Reference Dictionary U-4 10/96

 UTSNODE

UTSNODE (APM Box,

NIM)
Type: Integer Last UCN Syncher Node—Describes which node is the synch master or
Lock: View syncher. Normally, this is the primary NIM, even though the secondary
Default: 0 NIM can also be the syncher. The syncher function performs periodic time
PtRes APM, NIM synchronization on the UCN.

Range: 0, 1 to 64 (0 specifies No Syncher Node)

UTSTBCRV (APM Box,

NIM)
Type: String_2 TBC Revision—The token bus controller revision number in hexidecimal
Lock: View format.
Default: N/A
PtRes APM, NIM
Range: 5 to 15

UTSTIME (APM Box, NIM)

Type: Time Current Time in LCN Node—Identifies the current time of day for this
Lock: View LCN node, and is useful if there are multiple LCNs or UCNs.
Default: N/A
PtRes APM, NIM
Range: N/A

UTSTIMST (APM Box,

NIM)
Type: E:$UCNTMST Timesynch State of the UCN Node—The state of time
Lock: View synchronization for each UCN node.
Default: 0
PtRes APM, NIM
Range: 0-Initial (Waiting for the first complete synch operation)
1-Failed (The maximum amount of time has elapsed and no synch operation has occurred,
or the NIM does not have a functioning EPNI board)
2-Degraded (In nonsyncher NIMs and APMMs, an excessive amount of time has elapsed
without
a complete synch operation. In APMMs, the drift limit between the LCN and
APMM clock has been exceeded)
3-LCN_Bad (Synch operations are taking place on a regular basis, but the NIM’s clock is
not
synched with the LCN)
4-LCN_OK (Synch operations are occurring regularly and the NIM’s clock is properly
synched
with the LCN)
5-OK (Synch operations are working in an optimal manner)

APM Parameter Reference Dictionary U-5 10/96

APM Parameter Reference Dictionary U-6 10/96
 WARMSTRT(1)–(168)

-W-

WARMSTRT(1)–(168)
Type: Logical Warm Start Flag
Lock: View
Default:
PtRes IOP
Range: On (Warm start executed)
Off (Cold start executed)

WEEKDAY (APM Box)

Type: Integer Current Weekday—The current weekday based on LCN wall clock time.
Lock: View
Default: N/A
PtRes APM
Range: 1 to 7 (Sunday to Saturday)

WITHBIAS(1)–(40) (APM Box)

Type: Logical I/O Module Physical Bias State—ON Indicates that the preferred
Lock: View primary is really the acting primary; OFF indicates that it is not.
Default: ON For IOPs that do not have hardware bias (e.g., HLAI, DI, etc.),
PtRes APM the status of ON is always returned. Applies to primary IOP only.

Range: On (The preferred primary is the acting primary)

Off (The preferred primary is not the acting primary)

APM Parameter Reference Dictionary W-1 10/96

APM Parameter Reference Dictionary W-2 10/96
 X

-X-

X (FlowComp)
Type: Real Steam Compressibility Input—Indicates the measured actual steam
Lock: View compressibility.
Default: 1.0
PtRes APM
Range: > 0.0

X1
(AutoMan)
Type: Real X1 Input Value to be Biased
Lock: Prog
Default: NaN
PtRes APM
Range: NaN

X1–4 (IncrSum, ORSel)

Type: Real Inputs 1-4—Current values of the inputs to this algorithm.
Lock: Prog
Default: NaN
PtRes APM
Range: > 0.0,
NaN

X2
(AutoMan)
Type: Real Bias Adjustment Input
Lock: View
Default: N/A
PtRes APM
Range: N/A

X2
(RatioCtl)
Type: Real Input Number 2—Indicates the value of the uncontrolled process variable.
Lock: View Source should be the same as for P2 of the Calcultr algorithm, if it is being
Default: N/A used in conjunction with the Calcultr algorithm.
PtRes APM
Range: N/A

APM Parameter Reference Dictionary X-1 10/96

 X2FILT

X2FILT (RatioCtl)
Type: Real Filtered value of the X2 input
Lock: View
Default: N/A
PtRes APM
Range: N/A

Helpful Hint: Filter time is determined by X2TF.

X2TF (RatioCtl)
Type: Real X2 input filter lag time in minutes
Lock: Supr
Default: 0.0
PtRes APM
Range: 0 - 60 minutes

XEUHI (AutoMan, IncrSum,

ORSel)
Type: Real X Input Engineering Unit High Range—Defines the upper limit of the
Lock: Engr value of the X input or inputs.
Default: 100.0
(equivalent
to 100%)
PtRes APM
Range: > XEULO

XEULO (AutoMan, IncrSum, ORSel)

Type: Real X Input Engineering Unit Low Range—Defines the lower limit of the
Lock: Engr value of the X input or inputs.
Default: 0.0
(equivalent
to 0%)
PtRes APM
Range: < XEUHI

XSTS (FlowComp)
Type: E:PVVALST X Input Value Status—Status of the steam compressibility input.
Lock: View
Default: Normal
PtRes APM
Range: 0-Bad (Value is bad and replaced with NaN)
1-Uncertn (Status of the value is uncertain)
2-Normal (Value is good)

APM Parameter Reference Dictionary X-2 10/96

 YEAR

-Y-

YEAR (APM Box)

Type: Integer Current Year—The value of the LCN date in the APM.
Lock: View
Default: N/A
PtRes APM
Range: 1979 to 2115

APM Parameter Reference Dictionary Y-1 10/96

APM Parameter Reference Dictionary Y-2 10/96
 READER COMMENTS

Honeywell IAC's Automation College welcomes your comments and suggestions to improve
future editions of this and other publications.

You can communicate your thoughts to us by fax or mail using this form, or by placing a toll-
free telephone call. We would like to acknowledge your comments—please include your
complete name, address, and telephone number.

BY FAX: 1-602-313-4842

BY MAIL: Honeywell Inc.

Industrial Automation and Control
Automation College
2820 W. Kelton Lane
Phoenix, AZ 85023-3028

BY TELEPHONE In the USA, use our toll-free number 1-800-822-7673 (available in the
48 contiguous states except Arizona; in Arizona dial 1-602-313-5558).

Title of Publication: APM Parameter Reference DictionaryIssue Date: 10/96

Publication Number: AP09-540 Writer: Andrea Simmons

COMMENTS:_____________________________________________________________
__________________________________________________________________________
__________________________________________________________________________
__________________________________________________________________________
__________________________________________________________________________
__________________________________________________________________________
__________________________________________________________________________

RECOMMENDATIONS:___________________________________________________
__________________________________________________________________________
__________________________________________________________________________
__________________________________________________________________________
__________________________________________________________________________
__________________________________________________________________________

Name ____________________________________________ Date ____________________

Title ______________________________________________________________________
Company __________________________________________________________________
Address ___________________________________________________________________
City ______________________________ State __________ ZIP ____________________
Telephone____________________________ FAX _________________________________
Industrial Automation and Control Helping You Control Your World
Honeywell Inc.
16404 North Black Canyon Highway
Phoenix, Arizona 85023-3033