0% found this document useful (0 votes)
14 views273 pages

APACSLIB

Uploaded by

teodomi
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
14 views273 pages

APACSLIB

Uploaded by

teodomi
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 273

Preface

ES Library 1

Symbols and Faceplates 2


SIMATIC

PCS 7
APACS+ ES Library User's Guide
for V7.1

Manual

04/2009
A5E02453738-01
Legal information
Warning notice system
This manual contains notices you have to observe in order to ensure your personal safety, as well as to prevent
damage to property. The notices referring to your personal safety are highlighted in the manual by a safety alert
symbol, notices referring only to property damage have no safety alert symbol. These notices shown below are
graded according to the degree of danger.

DANGER
indicates that death or severe personal injury will result if proper precautions are not taken.

WARNING
indicates that death or severe personal injury may result if proper precautions are not taken.

CAUTION
with a safety alert symbol, indicates that minor personal injury can result if proper precautions are not taken.

CAUTION
without a safety alert symbol, indicates that property damage can result if proper precautions are not taken.

NOTICE
indicates that an unintended result or situation can occur if the corresponding information is not taken into
account.
If more than one degree of danger is present, the warning notice representing the highest degree of danger will
be used. A notice warning of injury to persons with a safety alert symbol may also include a warning relating to
property damage.
Qualified Personnel
The device/system may only be set up and used in conjunction with this documentation. Commissioning and
operation of a device/system may only be performed by qualified personnel. Within the context of the safety notes
in this documentation qualified persons are defined as persons who are authorized to commission, ground and
label devices, systems and circuits in accordance with established safety practices and standards.
Proper use of Siemens products
Note the following:

WARNING
Siemens products may only be used for the applications described in the catalog and in the relevant technical
documentation. If products and components from other manufacturers are used, these must be recommended
or approved by Siemens. Proper transport, storage, installation, assembly, commissioning, operation and
maintenance are required to ensure that the products operate safely and without any problems. The permissible
ambient conditions must be adhered to. The information in the relevant documentation must be observed.

Trademarks
All names identified by ® are registered trademarks of the Siemens AG. The remaining trademarks in this
publication may be trademarks whose use by third parties for their own purposes could violate the rights of the
owner.
Disclaimer of Liability
We have reviewed the contents of this publication to ensure consistency with the hardware and software
described. Since variance cannot be precluded entirely, we cannot guarantee full consistency. However, the
information in this publication is reviewed regularly and any necessary corrections are included in subsequent
editions.

Siemens AG A5E02453738-01 Copyright © Siemens AG 2009.


Industry Sector Ⓟ 04/2009 Technical data subject to change
Postfach 48 48
90026 NÜRNBERG
GERMANY
Preface

Purpose of ES Manual
This manual provides information necessary to use the ES Library in order to migrate
APACS+ systems to a PCS 7 environment.

Where can I find the latest version of this document?


The latest version of this manual can be found on the Internet:
http://support.automation.siemens.com/US/view/en/35202373
The ReadMe file can be found here:
http://support.automation.siemens.com/US/view/en/35201997

Required Basic Knowledge


Readers are presumed to be experts in the use of APACS+ and knowledgeable in the use of
PCS 7.

Where is this Manual valid?


This manual is valid for the software package PCS 7 APACS+ ES Library Rev 7.1.

Training Centers
Siemens Technical Training Centers provides extensive training for all levels of plant
personnel to ensure optimal performance from APACS+ and PCS 7 control systems.
Classes include extensive hands-on activities using appropriate equipment, making the
training directly and immediately applicable.
On-line information is available: http://www.sitrain.com.
Siemens also offers a number of training courses to familiarize you with the SIMATIC S7
automation system. Please contact your regional training center or our central training center
in D 90327 Nuremberg, Germany, for details:
Telephone: +49 (911) 895-3200 or Internet http://www.sea.siemens.com/sitrain.

APACS+
Advanced Process Control Systems

See also
ES Library ReadMe (http://support.automation.siemens.com/US/View/en/35201997)
ES Library UserManual (http://support.automation.siemens.com/US/View/en/35202373)

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 3
Preface

A&D Technical Support


Worldwide, available 24 hours a day:

1¾UQEHUJ

-RKQVRQ&LW\ %HLMLQJ

United States: Johnson City, TN Worldwide: Nürnberg Asia / Australia: Beijing


Technical Support and Authorization Technical Support Technical Support and Authorization
Local time: Monday to Friday 24 hours a day, 365 days a year Local time: Monday to Friday
8:00 AM to 5:00 PM Phone:+49 (180) 5050-222 8:00 AM to 5:00 PM
Telephone:+1 (423) 262 2522 Fax:+49 (180) 5050-223 Phone:+86 10 64 75 75 75
or +1 (800) 333-7421 (USA only) Email for technical support Fax:+86 10 64 74 74 74
Fax:+1 (423) 262 2289 (mailto:[email protected]). Email for technical support
An Internet site is available for support GMT:+1:00 (mailto:[email protected])
requests .
(http://www.siemens.com/automation/s GMT:+8:00
upport-request).

Automation and Drives Service and Support International (http://www.siemens.com/automation/service&support)


The languages of the SIMATIC Hotlines and the authorization hotline are generally German and English.

APACS+ ES Library User's Guide for V7.1


4 Manual, 04/2009, A5E02453738-01
Table of contents

Preface ...................................................................................................................................................... 3
1 ES Library.................................................................................................................................................. 9
1.1 PCS 7 ES Option for APACS+.......................................................................................................9
1.1.1 Introduction - The PCS 7 ES Option for APACS+™......................................................................9
1.1.2 Library Description .........................................................................................................................9
1.2 Library Function Blocks................................................................................................................10
1.2.1 Introduction ..................................................................................................................................10
1.2.2 The Quality Code Display ............................................................................................................11
1.2.3 AALM_AFB...................................................................................................................................11
1.2.3.1 AALM_AFB: Analog Alarm...........................................................................................................11
1.2.3.2 AALM_AFB Input Output..............................................................................................................14
1.2.4 AM_AFB .......................................................................................................................................22
1.2.4.1 AM_AFB: Auto/Manual.................................................................................................................22
1.2.4.2 AM_AFB Input Output ..................................................................................................................23
1.2.5 ANALOG_ALM_BLK ....................................................................................................................24
1.2.5.1 ANALOG_ALM_BLK: Analog Alarm ............................................................................................24
1.2.5.2 ANALOG_ALM_BLK Input Output ...............................................................................................27
1.2.6 BLK_VLV_1OUT_BLK..................................................................................................................32
1.2.6.1 BLK_VLV_1OUT: Block Valve with One Output ..........................................................................32
1.2.6.2 BLK_VLV_1OUT_BLK Input Output.............................................................................................34
1.2.7 BLK_VLV_2OUT_BLK..................................................................................................................36
1.2.7.1 BLK_VLV_2OUT: Block Valve with Two Outputs ........................................................................36
1.2.7.2 BLK_VLV_2OUT_BLK Input Output.............................................................................................38
1.2.8 CASCADE_BLK ...........................................................................................................................41
1.2.8.1 CASCADE: Cascade Controller...................................................................................................41
1.2.8.2 CASCADE_BLK Input Output ......................................................................................................45
1.2.9 DALM_AFB ..................................................................................................................................58
1.2.9.1 DALM_AFB: Discrete Alarm.........................................................................................................58
1.2.9.2 DALM_AFB Input Output .............................................................................................................60
1.2.10 DISCRETE_ALM_BLK .................................................................................................................64
1.2.10.1 DISCRETE_ALM_BLK .................................................................................................................64
1.2.10.2 DISCRETE_ALM_BLK Input Output ............................................................................................65
1.2.11 EXT_SET_BLK.............................................................................................................................66
1.2.11.1 EXT_SET: External Setpoint Controller .......................................................................................66
1.2.11.2 EXT_SET_BLK Input Output........................................................................................................69
1.2.12 MOTOR_A_BLK ...........................................................................................................................78
1.2.12.1 MOTOR_A_BLK: Standard Motor ................................................................................................78
1.2.12.2 MOTOR_A_BLK Input Output ......................................................................................................81
1.2.13 MOTOR_A_ALM_BLK..................................................................................................................86
1.2.13.1 MOTOR_A_ALM: Motor with Alarm .............................................................................................86
1.2.13.2 MOTOR_A_ALM_BLK Input Output.............................................................................................89
1.2.14 MOTOR_1OUT_BLK....................................................................................................................92
1.2.14.1 MOTOR_1OUT: Motor with One Output......................................................................................92
1.2.14.2 MOTOR_1OUT_BLK Input Output...............................................................................................94
1.2.15 MOTOR_2OUT_BLK....................................................................................................................97
1.2.15.1 MOTOR_2OUT: Motor with Two Outputs ....................................................................................97
1.2.15.2 MOTOR_2OUT_BLK Input Output...............................................................................................99

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 5
Table of contents

1.2.16 PID_AFB.................................................................................................................................... 101


1.2.16.1 PID_AFB: Proportional-Integral-Derivative ............................................................................... 101
1.2.16.2 PID_AFB Input Output............................................................................................................... 102
1.2.17 PRIMARY_BLK ......................................................................................................................... 104
1.2.17.1 PRIMARY: Primary Controller................................................................................................... 104
1.2.17.2 PRIMARY_BLK Input Output .................................................................................................... 107
1.2.18 RATIO_SET_BLK...................................................................................................................... 113
1.2.18.1 RATIO_SET: Ratio Setpoint Controller ..................................................................................... 113
1.2.18.2 RATIO_SET_BLK Input Output................................................................................................. 117
1.2.19 SECONDARY_BLK................................................................................................................... 124
1.2.19.1 SECONDARY: Secondary Controller ....................................................................................... 124
1.2.19.2 SECONDARY_BLK Input Output.............................................................................................. 127
1.2.20 SETPNT_AFB ........................................................................................................................... 134
1.2.20.1 SETPNT_AFB: Setpoint ............................................................................................................ 134
1.2.20.2 SETPNT_AFB Input Output ...................................................................................................... 136
1.2.21 SINGLE_LOOP_BLK................................................................................................................. 138
1.2.21.1 SINGLE_LOOP_BLK................................................................................................................. 138
1.2.21.2 SINGLE_LOOP_BLK Input Output............................................................................................ 141
1.2.22 SINGLE_LP_EM_BLK ............................................................................................................... 146
1.2.22.1 SINGLE_LP_EM: Single Loop Controller with Emergency Manual .......................................... 146
1.2.22.2 SINGLE_LP_EM_BLK Input Output .......................................................................................... 149
1.2.23 SINGLE_LP_SS_BLK................................................................................................................ 156
1.2.23.1 SINGLE_LP_SS: Single Loop Controller with Standby Sync.................................................... 156
1.2.23.2 SINGLE_LP_SS_BLK Input Output........................................................................................... 159
1.2.24 VALVE_A_ALM_BLK................................................................................................................. 166
1.2.24.1 VALVE_A_ALM: Valve with Alarm ............................................................................................ 166
1.2.24.2 VALVE_A_ALM_BLK Input Output............................................................................................ 168
1.2.25 VALVE_A_AFB.......................................................................................................................... 172
1.2.25.1 VALVE_A_AFB: Standard Valve............................................................................................... 172
1.2.25.2 VALVE_A_AFB Input Output..................................................................................................... 175
1.3 Template Charts........................................................................................................................ 180
1.3.1 ANALOG_ALM_AT.................................................................................................................... 181
1.3.2 BLK_VLV_1OUT_AT ................................................................................................................. 182
1.3.3 BLK_VLV_2OUT_AT ................................................................................................................. 182
1.3.4 CASCADE_AT .......................................................................................................................... 183
1.3.5 DISCRETE_ALM_AT ................................................................................................................ 185
1.3.6 EXT_SET_AT ............................................................................................................................ 185
1.3.7 MOTOR_A_ALM_AT ................................................................................................................. 186
1.3.8 MOTOR_1OUT_AT ................................................................................................................... 188
1.3.9 MOTOR_2OUT_AT ................................................................................................................... 189
1.3.10 PRIMARY_SECONDARY_AT................................................................................................... 190
1.3.11 RATIO_SET_AT ........................................................................................................................ 191
1.3.12 SINGLE_LOOP_AT................................................................................................................... 193
1.3.13 SINGLE_LP_EM_AT ................................................................................................................. 194
1.3.14 SINGLE_LP_SS_AT.................................................................................................................. 195
1.3.15 VALVE_A_ALM_AT................................................................................................................... 196
1.4 Message class .......................................................................................................................... 197
1.5 Differences between APACS+ and PCS 7 ............................................................................... 198
1.5.1 General Differences .................................................................................................................. 198
1.5.2 Alarm Differences...................................................................................................................... 202
1.5.3 APACS+ versus PCS 7 Controller Algorithm Comparison ....................................................... 202
1.6 Customizing the Library ............................................................................................................ 204
1.7 Performance Data ..................................................................................................................... 208

APACS+ ES Library User's Guide for V7.1


6 Manual, 04/2009, A5E02453738-01
Table of contents

1.8 Hidden Functions .......................................................................................................................210


1.8.1 DINTToInt64...............................................................................................................................210
1.8.2 AddInt64.....................................................................................................................................210
1.8.3 NegateInt64................................................................................................................................211
1.8.4 SHLInt64 ....................................................................................................................................211
1.8.5 SHRInt64....................................................................................................................................212
1.8.6 REALToDPReal .........................................................................................................................212
1.8.7 AddDPReal ................................................................................................................................212
1.8.8 NegateDPReal ...........................................................................................................................213
1.8.9 DPRealToReal ...........................................................................................................................213
1.8.10 Int64ToDINT...............................................................................................................................214
1.8.11 TIME_DIFF.................................................................................................................................214
1.8.12 ALM_PROC................................................................................................................................214
1.8.13 PID_AFB_Calc_Coeff.................................................................................................................215
1.8.14 DALM_Test_Alarm .....................................................................................................................215
1.8.15 MOVE_BOOL.............................................................................................................................216
1.8.16 NON_RETAIN_BOOL ................................................................................................................216
2 Symbols and Faceplates ....................................................................................................................... 219
2.1 Common HMI Elements.............................................................................................................219
2.1.1 Symbols .....................................................................................................................................219
2.1.2 Analog Input Dialog Box ............................................................................................................220
2.1.3 Discrete Input Dialog Box ..........................................................................................................221
2.1.4 Time Input Dialog Box................................................................................................................221
2.1.5 Confirmation Dialog Box ............................................................................................................222
2.1.6 Operator Change Confirmation..................................................................................................222
2.1.7 Global HMI Elements .PDL Files ...............................................................................................223
2.1.8 Displayed Decimal Points ..........................................................................................................223
2.1.9 Common Faceplate Elements....................................................................................................225
2.1.10 Redundant Server Architecture..................................................................................................225
2.1.11 Synchronization and Persistence of HMI Tag Values................................................................226
2.2 SINGLE_LOOP_BLK .................................................................................................................228
2.2.1 SINGLE_LOOP_BLK Standard View.........................................................................................228
2.2.2 SINGLE_LOOP_BLK Tuning View ............................................................................................229
2.2.3 SINGLE_LOOP_BLK Alarm View ..............................................................................................230
2.2.4 SINGLE_LOOP_BLK Ramp View ..............................................................................................231
2.2.5 SINGLE_LOOP_BLK Limits View ..............................................................................................232
2.2.6 SINGLE_LOOP_BLK Trend View ..............................................................................................232
2.2.7 SINGLE_LOOP_BLK Faceplate Overview Window...................................................................234
2.2.8 SINGLE_LOOP_BLK Faceplate Frame .....................................................................................234
2.2.9 SINGLE_LOOP_BLK Faceplate View List .................................................................................235
2.2.10 SINGLE_LOOP_BLK Loop Display Mode .................................................................................235
2.2.11 SINGLE_LOOP_BLK View .PDL Files.......................................................................................236
2.3 Other Faceplates .......................................................................................................................238
2.3.1 ANALOG_ALM_BLK ..................................................................................................................238
2.3.2 DISCRETE_ALM_BLK ...............................................................................................................241
2.3.3 MOTOR_1OUT_BLK..................................................................................................................244
2.3.4 MOTOR_2OUT_BLK..................................................................................................................246
2.3.5 MOTOR_A_BLK .........................................................................................................................247
2.3.6 MOTOR_A_ALM_BLK................................................................................................................249
2.3.7 BLK_VLV_1OUT_BLK................................................................................................................254
2.3.8 BLK_VLV_2OUT_BLK................................................................................................................256
2.3.9 VALVE_A_BLK...........................................................................................................................257
2.3.10 VALVE_A_ALM_BLK .................................................................................................................261

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 7
Table of contents

2.3.11 EXT_SET_BLK.......................................................................................................................... 264


2.3.12 RATIO_SET_BLK...................................................................................................................... 265
2.3.13 PRIMARY_BLK ......................................................................................................................... 266
2.3.14 SECONDARY_BLK................................................................................................................... 266
2.3.15 CASCADE_BLK ........................................................................................................................ 266
2.3.16 SINGLE_LP_EM_BLK ............................................................................................................... 267
2.3.17 SINGLE_LP_SS_BLK................................................................................................................ 267
Glossary ................................................................................................................................................ 269
Index...................................................................................................................................................... 271

APACS+ ES Library User's Guide for V7.1


8 Manual, 04/2009, A5E02453738-01
ES Library 1
1.1 PCS 7 ES Option for APACS+

1.1.1 Introduction - The PCS 7 ES Option for APACS+™


The PCS 7 ES Option for APACS+ is a SIMATIC PCS 7 library intended for users who have
an APACS+ background. The library also contains blocks from the APACS+ Basic
Application Library that have been ported to both PCS 7 FBs and PCS 7 Continuous
Function Charts (CFCs).

1.1.2 Library Description

The PCS 7 ES Option for APACS+ is a SIMATIC PCS 7 library is composed of Source
Charts (CFCs) and Structured Control Language (SCL) source files that emulate many of the
Derived Function Blocks (DFBs) in the APACS+ Basic Application Library. The source charts
and source files are also provided as compiled APACS+ function block types that may be
used with their matching faceplates and graphic symbols. Template Charts show how the
APACS+ function block types are typically used.
This library supplies a set of building blocks for users who want to construct PCS 7
applications based on APACS+ structures. These components are:

Ported APACS+ Blocks These function blocks provide the functionality of APACS+
standard function blocks.
Source (CFC) Charts and Source These charts and files provide the functionality of APACS+
(SCL) Files derived function blocks and give users the ability to customize the
types and create new types.
APACS+ Function Block Types These function blocks provide the functionality of APACS+
derived function blocks in a form that has connected faceplates
and graphic symbols.
Template (CFC) Charts These charts provide examples of APACS+ function block types
integrated with other PCS 7 blocks to facilitate easier user
implementation within the PCS 7 ES.
Additional Topics:

Faceplates and Graphic Symbols These pre-configured Human-Machine Interface (HMI) elements
provide the ability to display/modify data associated with an
APACS+ function block type.
Customizing the Library These instructions describe customization of the source charts
and files, including compilation to create new block types and
modification of the graphical elements.

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 9
ES Library
1.2 Library Function Blocks

1.2 Library Function Blocks

1.2.1 Introduction
A PCS 7 function block serves the same purpose as a function block in APACS+. A function
block runs a pre-configured algorithm that is not user configurable. There are block
parameters that can be used to define the operation of the algorithm, just as softlist
parameters were used in APACS+. Block parameters can be displayed as input/output nubs
on the block by the user.

PCS 7 PCS 7 Original APACS+


Function Block FB Number Standard Function Block
AM_AFB FB 500 AM (Auto/Manual)
PID_AFB FB 501 PID (Proportional-Integral-Derivative)
SETPNT_AFB FB 502 SETPNT (Setpoint)
AALM_AFB FB 503 HLLAALM (Hi-Level Link Analog Alarm)
DALM_AFB FB 504 HLLDALM (Hi-Level Link Discrete Alarm)
MOTOR_A_AFB FB 505 MOTOR_A (Standard Motor)
VALVE_A_AFB FB 506 VALVE_A (Standard Valve)
A PCS 7 chart is used in the creation of a Function Block Type. In APACS+ a Derived
Function Block (DFB or UDFB) is equivalent to a Function Block Type. PCS 7 faceplates can
be connected to a single block in the controller. The CFC for Single Loop contains four
blocks (Setpoint, PID, AutoManual and Alarm). Therefore, the Single Loop faceplate could
not be connected to the CFC. In essence, the Function Block Type is a compiled version of
the CFC. We have provided the CFC to make it easier to customize the function blocks
provided. The user can modify the CFC chart and then compile it to create a new Function
Block Type.
The blocks marked by an * below are implemented in the SCL language rather than via the
CFC charts. The user may also customize these Function Block Types by using the SCL
Editor in SIMATIC Manager to modify and re-compile them.

PCS 7 PCS 7 Original APACS+


Function Block FB Number Basic Application Library Block
ANALOG_ALM_BLK FB 600 ANALOG_ALARM (Analog Alarm)
* BLK_VLV_1OUT_BLK FB 601 BLK_VLV_1OUT (Block Valve with One Output)
* BLK_VLV_2OUT_BLK FB 602 BLK_VLV_2OUT (Block Valve with Two Outputs)
CASCADE_BLK FB 603 CASCADE (Cascade Controller)
DISCRETE_ALM_BLK FB 604 DISCRETE_ALARM (Discrete Alarm)
EXT_SET_BLK FB 605 EXT_SET (External Setpoint Controller)
* MOTOR_1OUT_BLK FB 606 MOTOR_1OUT (Motor with One Output)
* MOTOR_2OUT_BLK FB 607 MOTOR_2OUT (Motor with Two Outputs)
PRIMARY_BLK FB 608 PRIMARY (Primary Controller)
RATIO_SET_BLK FB 609 RATIO_SET (Ratio Setpoint Controller)
SECONDARY_BLK FB 610 SECONDARY (Secondary Controller)
SINGLE_LOOP_BLK FB 611 SINGLE_LOOP (Single Loop Controller)

APACS+ ES Library User's Guide for V7.1


10 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

PCS 7 PCS 7 Original APACS+


Function Block FB Number Basic Application Library Block
SINGLE_LP_EM_BLK FB 615 SINGLE _LOOP_EM (Single Loop Controller w/Emergency Manual)
SINGLE_LP_SS_BLK FB 612 SINGLE_LOOP_SS (Single Loop Controller w/ Standby Sync)
MOTOR_A_ALM_BLK FB 613 MOTOR_A_ALM (Motor with Alarm)
VALVE_A_ALM_BLK FB 614 VALVE_A_ALM (Valve with Alarm)

1.2.2 The Quality Code Display

The Quality Code Display


The ES Library _BLK blocks contain Quality Code information that is displayed with icons on
their faceplate displays, the following graphic shows how to interpret these icons.

In order for the Quality Code Icons to appear on the Faceplates, the QUALITY output of the
Channel Driver blocks must be connected to the appropriate QCxxx input of the ES Library
blocks.

1.2.3 AALM_AFB

1.2.3.1 AALM_AFB: Analog Alarm

Function Block Name AALM_AFB


Function Block Number FB503

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 11
ES Library
1.2 Library Function Blocks

Function
The Analog Alarm Function Block (AALM_AFB) is intended for detecting and signaling
abnormal data values. This block contains an Enable input, Alarm output, and NAK (not
acknowledged) output for each of the following alarm types:

• High • Out Of Range


• Low • Quality Not Good
• Absolute Deviation • Absolute Rate Of Change
• High Deviation • Increasing Rate Of Change
• Low Deviation • Decreasing Rate Of Change
• High High
• Low Low

Calling OBs and Start-up


Calling OBs
This block is called in the watchdog interrupt OB into which the block is installed (for
example, OB32).
Start-up Characteristics
This function block has no special startup properties.

Operator Control and Monitoring (M&C Relevant)


There is no associated faceplate for this block.

Message Characteristics

Assignment of message texts and message class to the block parameters

Note
During runtime, the string $$BlockComment$$ will be replaced by the comment for the FB
instance that is in alarm.

ALARM_8P ID Message # Message Class Default Message Text


Message_class
EV_ID 1 Warning - above HIGH - $$BlockComment$$ - Limit =
@4%f@
EV_ID 2 Warning - below LOW - $$BlockComment$$ - Limit =
@5%f@
EV_ID 3 Alarm - above HIGH_DEV - $$BlockComment$$ - Limit =
@6%f@

APACS+ ES Library User's Guide for V7.1


12 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

ALARM_8P ID Message # Message Class Default Message Text


Message_class
EV_ID 4 Alarm - below LOW_DEV - $$BlockComment$$ - Limit =
@7%f@
EV_ID 5 Alarm - above ABSOLUTE_DEV - $$BlockComment$$ -
Limit = @8%f@
EV_ID 6 PLC Process Control OUT_OF_RANGE - $$BlockComment$$
Message - Failure
EV_ID 7 PLC Process Control QUALITY_NOT_GOOD -
Message - Failure $$BlockComment$$
EV_ID2 1 Alarm - above HIGH_ HIGH - $$BlockComment$$ - Limit
= @4%f@
EV_ID2 2 Alarm - below LOW_ LOW - $$BlockComment$$ - Limit
= @5%f@
EV_ID2 3 Warning - above INC_ROC - $$BlockComment$$ - Limit =
@6%f@
EV_ID2 4 Warning - below DEC_ROC - $$BlockComment$$ - Limit =
@7%f@
EV_ID2 5 Warning - above ABS_ROC - $$BlockComment$$ - Limit =
@8%f@

Assignment of auxiliary process values to the block parameters

ALARM_8P ID Value Block Parameter


EV_ID @1%s@ BA_NA
EV_ID @2%d@ BA_ID
EV_ID @3%d@ STEP_NO
EV_ID @4%f@ HIGH_LIMIT
EV_ID @5%f@ LOW_LIMIT
EV_ID @6%f@ H_DEV_LIMIT
EV_ID @7%f@ L_DEV_LIMIT
EV_ID @8%f@ A_DEV_LIMIT
EV_ID2 @1%s@ BA_NA
EV_ID2 @2%d@ BA_ID
EV_ID2 @3%d@ STEP_NO
EV_ID2 @4%f@ HH_LIMIT
EV_ID2 @5%f@ LL_LIMIT
EV_ID2 @6%f@ I_ROC_LIMIT
EV_ID2 @7%f@ D_ROC_LIMIT
EV_ID2 @8%f@ A_ROC_LIMIT

See also
AALM_AFB Input Output (Page 14)

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 13
ES Library
1.2 Library Function Blocks

1.2.3.2 AALM_AFB Input Output

Input

Name Data Type Explanation Initial OC&M Valid Values


PV REAL Process Value – This input is the value 0 True
to be monitored for alarms.
DEV REAL Deviation – The difference between this 0 False
input and the (PV) input is monitored
when a deviation alarm is selected.
EN_HIGH BOOL When TRUE, the High alarm is enabled. False True
EN_LOW BOOL When TRUE, the Low alarm is enabled. False True
EN_H_DEV BOOL When TRUE, the High Deviation alarm is False True
enabled.
EN_L_DEV BOOL When TRUE, the Low Deviation alarm is False True
enabled.
EN_A_DEV BOOL When TRUE, the Absolute Deviation False True
alarm is enabled.
EN_OORANGE BOOL When TRUE, the Out of Range alarm is False True
enabled
EN_QUALITY BOOL When TRUE, the Quality Not Good False True
alarm is enabled.
EN_HH BOOL When TRUE, the High High alarm is False True
enabled.
EN_LL BOOL When TRUE, the Low Low alarm is False True
enabled.
EN_I_ROC BOOL When TRUE, the Increasing Rate of False True
Change alarm is enabled.
EN_D_ROC BOOL When TRUE, the Decreasing Rate of False True
Change alarm is enabled.
EN_A_ROC BOOL When TRUE, the Absolute Rate of False True
Change alarm is enabled.
OOS BOOL Out of Service indicator. False True
QBAD BOOL Bad quality indicator – This value is a False False
hardware diagnostic showing whether
the quality of (PV) is bad. This input
should be connected to the QBAD output
of the channel driver feeding (PV). It is
initialized to FALSE so that the quality is
good if the parameter is unconnected.
EV_ID DWORD Event ID – This value is a unique None False
message number supplied by PCS 7.
There is one for each message (i.e.
ALARM_8P) block called.
EV_ID2 DWORD Event ID - This value is a unique None False
message number supplied by PCS 7.
There is one for each message (i.e.
ALARM_8P) block called.
BA_NA STRING[32] Batch name '' False

APACS+ ES Library User's Guide for V7.1


14 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid Values


BA_ID DWORD Batch ID number 0 False
STEP_NO DWORD Batch step number 0 False

Note
This list differs from the inputs of the AALM_AFB block in APACS+ as follows:
• In APACS+, there are only four enables. There is now an enable for every alarm type.
• The parameter QBAD was added to get quality information from the control system.
• The parameters EV_ID and EV_ID2 were added to support the message system.
• Batch parameters BA_NA, BA_ID, STEP_NO are added to pass batch values in alarm
messages.

Output

Name Data Explanation Initial OC&M Valid Values


Type
ALM_HIGH BOOL When TRUE, the High alarm is detected and False False
enabled.
NAK_HIGH BOOL When TRUE, the High alarm is tripped but False False
not acknowledged.
ALM_LOW BOOL When TRUE, the Low alarm is detected and False False
enabled.
NAK_LOW BOOL When TRUE, the Low alarm is tripped but False False
not acknowledged.
ALM_H_DEV BOOL When TRUE, the High Deviation alarm is False False
detected and enabled.
NAK_H_DEV BOOL When TRUE, the High Deviation alarm is False False
tripped but not acknowledged.
ALM_L_DEV BOOL When TRUE, the Low Deviation alarm is False False
detected and enabled.
NAK_L_DEV BOOL When TRUE, the Low Deviation alarm is False False
tripped but not acknowledged.
ALM_A_DEV BOOL When TRUE, the Absolute Deviation alarm False False
is detected and enabled.
NAK_A_DEV BOOL When TRUE, the Absolute Deviation alarm False False
is tripped but not acknowledged.
ALM_OORANGE BOOL When TRUE, the Out of Range alarm is False False
detected and enabled.
NAK_OORANGE BOOL When TRUE, the Out of Range alarm is False False
tripped but not acknowledged.
ALM_QUALITY BOOL When TRUE, Quality Not Good alarm is False False
detected and enabled.
NAK_QUALITY BOOL When TRUE, the Quality Not Good alarm is False False
tripped but not acknowledged.

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 15
ES Library
1.2 Library Function Blocks

Name Data Explanation Initial OC&M Valid Values


Type
ALM_HH BOOL When TRUE, High High alarm is detected False False
and enabled.
NAK_HH BOOL When TRUE, the High High alarm is tripped False False
but not acknowledged.
ALM_LL BOOL When TRUE, the Low Low alarm is detected False False
and enabled.
NAK_LL BOOL When TRUE, the Low Low alarm is tripped False False
but not acknowledged.
ALM_I_ROC BOOL When TRUE, the Increasing Rate of Change False False
alarm is detected and enabled.
NAK_I_ROC BOOL When TRUE, Increasing Rate of Change False False
alarm is tripped but not acknowledged.
ALM_D_ROC BOOL When TRUE, the Decreasing Rate of False False
change alarm is detected and enabled.
NAK_D_ROC BOOL When TRUE, the Decreasing Rate of False False
change alarm is tripped but not
acknowledged.
ALM_A_ROC BOOL When TRUE, the Absolute Rate of Change False False
alarm is detected and enabled.
NAK_A_ROC BOOL When TRUE, Absolute Rate of Change False False
alarm is tripped but not acknowledged.
MSG1_ERR BOOL First ALARM_8P error False False
MSG1_STAT WORD First ALARM_8P status W#16#0 False
MSG2_ERR BOOL Second ALARM_8P error False False
MSG2_STAT WORD Second ALARM_8P status W#16#0 False

Note
This list differs from the outputs of the AALM_AFB block in APACS+ as follows:
• In APACS+, there are only four alarms and four NAKs. There is now one of each for
every alarm type.
• The STATUS and CMD outputs have been removed.
• MSG1_ERR, MSG1_STAT, MSG2_ERR, and MSG2_STAT have been added to provide
the status of the message processing. For specific values, see the online help for
ALARM_8P.

APACS+ ES Library User's Guide for V7.1


16 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

Input/output

Name Data Type Explanation Initial OC&M Valid


Values
HIGH_LIMIT REAL The value (in engineering 0 True
units) to which the (PV)
input is compared for the
High alarm.
HIGH_DEADBAND REAL The amount of 0.5 True
engineering units by
which (PV) must be
within the limit for the
High alarm to clear.
HIGH_DELAYIN TIME The amount of time the T#0d0h0m0s0ms False
input must reach or
exceed the High limit to
trip an alarm.
HIGH_DELAYOUT TIME The amount of time the T#0d0h0m0s0ms False
input must be within the
High limit and deadband
to cause the alarm to
clear.
LOW_LIMIT REAL The value (in engineering 0 True
units) to which the (PV)
input is compared for the
Low alarm.
LOW_DEADBAND REAL The amount of 0.5 True
engineering units by
which (PV) must be
within the limit for the
Low alarm to clear.
LOW_DELAYIN TIME The amount of time the T#0d0h0m0s0ms False
input must reach or
exceed the Low limit to
trip an alarm.
LOW_DELAYOUT TIME The amount of time the T#0d0h0m0s0ms False
input must be within the
Low limit and deadband
to cause the alarm to
clear.
H_DEV_LIMIT REAL The value (in engineering 0 True
units) to which (PV) –
(DEV) is compared for
the High Deviation alarm.
H_DEV_DEADBAND REAL The amount of 0.5 True
engineering units by
which (PV) – (DEV) must
be within the limit for the
High Deviation alarm to
clear.

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 17
ES Library
1.2 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid


Values
H_DEV _DELAYIN TIME The amount of time the T#0d0h0m0s0ms False
input must reach or
exceed the High
Deviation limit to trip an
alarm.
H_DEV_DELAYOUT TIME High Deviation Alarm T#0d0h0m0s0ms False
Delay Out input. It is the
amount of time the input
must be within the
H_DEV_LIMIT value and
H_DEV_DEADBAND
value to cause the alarm
to clear.
L_DEV_LIMIT REAL The value (in engineering 0 True
units) to which (DEV) –
(PV) is compared for the
Low Deviation alarm.
L_DEV_DEADBAND REAL The amount of 0.5 True
engineering units by
which (DEV) – (PV) must
be within the limit for the
Low Deviation alarm to
clear.
L_DEV _DELAYIN TIME The amount of time the T#0d0h0m0s0ms False
input must reach or
exceed the Low
Deviation limit to trip an
alarm.
L_DEV_DELAYOUT TIME The amount of time the T#0d0h0m0s0ms False
input must be within the
Low Deviation limit and
deadband to cause the
alarm to clear.
A_DEV_LIMIT REAL The value (in engineering 0 True
units) to which ABS [(PV)
– (DEV)] must be within
the limit for the Absolute
Deviation alarm to clear.
A_DEV_DEADBAND REAL The amount of 0.5 True
engineering units by
which ABS [(PV) –
(DEV)] must be within the
limit for the Absolute
Deviation alarm to clear.
A_DEV _DELAYIN TIME The amount of time the T#0d0h0m0s0ms True
input must reach or
exceed the Absolute
Deviation limit to trip an
alarm.

APACS+ ES Library User's Guide for V7.1


18 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid


Values
A_DEV_DELAYOUT TIME The amount of time the T#0d0h0m0s0ms False
input must be within the
Absolute Deviation limit
and deadband to cause
the alarm to clear.
OORANGE_DELAYIN TIME The amount of time the T#0d0h0m0s0ms False
input must be outside the
limits EINH, EINL, to trip
the Out of Range alarm.
OORANGE_DELAYOUT TIME The amount of time the T#0d0h0m0s0ms False
input must be within the
limits EINH, EINL to
cause the Out of Range
alarm to clear.
QUALITY_DELAYIN TIME The amount of time the T#0d0h0m0s0ms False
input quality must be bad
to trip the Quality Not
Good alarm.
QUALITY_DELAYOUT TIME The amount of time the T#0d0h0m0s0ms False
input quality must be
good to cause the Quality
Not Good alarm to clear.
HH_LIMIT REAL The value (in engineering 0 True
units) to which the (PV)
input is compared for the
High High alarm.
HH_DEADBAND REAL The amount of 0.5 True
engineering units by
which (PV) must be
within the limit for the
High High alarm to clear.
HH_DELAYIN TIME The amount of time the T#0d0h0m0s0ms False
input must reach or
exceed the High High
limit to trip an alarm.
HH_DELAYOUT TIME The amount of time the T#0d0h0m0s0ms False
input must be within the
High High limit and
deadband to cause the
alarm to clear.
LL_LIMIT REAL The value (in engineering 0 True
units) to which the (PV)
input is compared for the
Low Low alarm.
LL_DEADBAND REAL The amount of 0.5 True
engineering units by
which (PV) must be
within the limit for the
Low Low alarm to clear.

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 19
ES Library
1.2 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid


Values
LL_DELAYIN TIME The amount of time the T#0d0h0m0s0ms False
input must reach or
exceed the Low Low limit
to trip an alarm.
LL_DELAYOUT TIME The amount of time the T#0d0h0m0s0ms False
input must be within the
Low Low limit and
deadband to cause the
alarm to clear.
I_ROC_LIMIT REAL The value (in 0 True
engineering) units per
minute) to which the (PV)
input is compared for the
Increasing Rate of
Change alarm.
I_ROC_DEADBAND REAL The amount of 0.5 True
engineering units by
which (PV) must be
within the limit for the
Increasing Rate of
Change alarm to clear.
I_ROC_DELAYIN TIME The amount of time the T#0d0h0m0s0ms False
input must reach or
exceed the Increasing
Rate of Change limit to
trip an alarm.
I_ROC_DELAYOUT TIME The amount of time the T#0d0h0m0s0ms False
input must be within the
Increasing Rate of
Change limit and
deadband to cause the
alarm to clear.
D_ROC_LIMIT REAL The value (in engineering 0 True
units per minute) to which
the (PV) input is
compared for the
Decreasing Rate of
Change alarm.
D_ROC_DEADBAND REAL The amount of 0.5 True
engineering units by
which (PV) must be
within the limit for the
Decreasing Rate of
Change alarm to clear.
D_ROC_DELAYIN TIME The amount of time the T#0d0h0m0s0ms False
input must reach or
exceed the Decreasing
Rate of Change limit to
trip an alarm.

APACS+ ES Library User's Guide for V7.1


20 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid


Values
D_ROC_DELAYOUT TIME The amount of time the T#0d0h0m0s0ms False
input must be within the
Decreasing Rate of
Change limit and
deadband to cause the
alarm to clear.
A_ROC_LIMIT REAL The value (in engineering 0 True
units per minute) to which
the (PV) input is
compared for the
Absolute Rate of Change
alarm.
A_ROC_DEADBAND REAL The amount of 0.5 True
engineering units by
which (PV) must be
within the limit for the
Absolute Rate of Change
alarm to clear.
A_ROC_DELAYIN TIME The amount of time the T#0d0h0m0s0ms False
input must reach or
exceed the Absolute
Rate of change limit to
trip an alarm.
A_ROC_DELAYOUT TIME The amount of time the T#0d0h0m0s0ms False
input must be within the
Absolute Rate of Change
limit and deadband to
cause the alarm to clear.
EINL REAL The PV low value used 0 True
for the Out of Range
alarm.
EINH REAL The PV high value used 100.0 True
for the Out of Range
alarm.
DISABLE_ON_OOS BOOL When set to TRUE, the False False
block is disabled if (OOS)
is also TRUE.

Note
This list differs from the softlist parameters of the AALM_AFB block in APACS+ as follows:
• The ALARM_TYPE parameters have been eliminated because there are now twelve sets
of parameters instead of just four. The type is now part of each parameter name.
• There is now a LIMIT, DEADBAND, DELAYIN, and DELAYOUT parameter for each
alarm type that requires it.
• The PCS 7 OS provides a ringback mechanism. The RINGBACK parameters have been
removed.

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 21
ES Library
1.2 Library Function Blocks

See also
AALM_AFB: Analog Alarm (Page 11)

1.2.4 AM_AFB

1.2.4.1 AM_AFB: Auto/Manual

Function Block Name AM_AFB


Function Block Number FB500

Function
The Auto/Manual Function Block (AM_AFB) regulates the source of a control loop output.
Generally, the block outputs either the Input (IN) value in automatic mode or its Internal
Output (IOUT) value in manual mode. When the block is in standby mode, the external
variable (EXTV) is written to the output (OUT).
The block's IN input is usually connected to the output of a PID block.The OUT value is
limited by both low and high limit (LOLIM and HILIM) In/Out parameters. The purpose of
these output limits is to prevent the output from being inadvertently driven beyond a process
or hardware operating limit. The Internal Output value can be changed via the Computer
Output (COUT) or the Auto/Manual function block itself (in track mode). The Computer
Output is written to by an operator command. The function block assigns the (OUT) value to
(COUT) as well. All values are in Engineering Units.

Calling OBs and Start-up


Calling OBs
This block is called in the watchdog interrupt OB into which the block is installed (for
example, OB32). Additionally, it is called in OB100 and in OB102 (see Start-up
Characteristics).
Start-up Characteristics
On a warm restart, OB100 is called and parameters retain the values they had immediately
before the restart. On a cold restart, OB102 is called and parameters are initialized with the
last downloaded values.
The warm and cold startup behavior of OUT is configurable. As delivered, OUT will be forced
to 0.0.
To force the OUT parameter to a specified value on a restart, set the RSTRT_OUT_FLAG to
true ("Force OUT") and configure RSTRT_OUT_VALUE with the desired forced value. The
RSTRT_OUT_VALUE will be used to initialize OUT, if and only if the RSTRT_OUT_FLAG is
true and the block restarts in Manual mode (AUTO = "Manual"). If RSTRT_OUT_FLAG is set
to false ("Default"), the OUT parameter will be set in accordance with default PCS 7
behavior.

APACS+ ES Library User's Guide for V7.1


22 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

WARNING
Using "Default" for the RSTRT_OUT_FLAG could result in your output device retaining its
last operating state after a restart. Use "Forced" for the restart flag and configure the
associated restart value to ensure a known restart state.

If restart parameter values are changed offline, the configuration must be compiled (changes
only) and downloaded (changes only) to the controller in order for the settings to take effect
upon restart. If restart parameter values are changed online (via CFC Test mode), the
configuration must be compiled (entire program) and downloaded (entire program) to the
controller in order for the settings to take effect upon cold restart. This step is not necessary
for the online changes to take effect upon a warm restart.

Operator Control and Monitoring (M&C Relevant)


There is no associated faceplate for this block.

See also
AM_AFB Input Output (Page 23)

1.2.4.2 AM_AFB Input Output

Input

Name Data Type Explanation Initial OC&M Valid Values


IN REAL Input variable. Generally, this input 0 False
should be the PID function block's output
in a simple single loop control application.
AUTO BOOL Auto Mode input False False
EXTV REAL External Variable input 0 False
STNDBY BOOL Standby Mode input False False
RSTRT_OUT_FLAG BOOL Default:Retain on WS, Use load val on True False
CS. Force: Use RSTRT_OUT_VALUE on
restart
RSTRT_OUT_VALUE REAL Init restart value for OUT if 0 False
RSTRT_OUTFLAG true and manual
mode

Output

Name Data Type Explanation Initial OC&M Valid


Values
OUT REAL Calculated output variable that has been limited 0 False
IOUT REAL Internal Output 0 False

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 23
ES Library
1.2 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid


Values
LL BOOL True when the algorithm is imposing a low limit on (OUT) False False
HL BOOL True when the algorithm is imposing a high limit on (OUT) False False

Note
The list differs from the outputs of the AM block in APACS+ as follows:
• COUT has been moved from Output to Input/Output.

Input/output

Name Data Type Explanation Initial OC&M Valid


Values
COUT REAL Computer Output, typically written to by an operator 0 True
command.
SLIST_OUT REAL Internal copy of IOUT 0 False
LOLIM REAL This is the (OUT) low limit input. -3.3 True
HILIM REAL This is the (OUT) high limit input. 103.3 True
INTRK BOOL Setting INTRK=TRUE causes the Internal Output to track True False
the (IN) when EXTTRK=FALSE or when
(STNDBY)=FALSE and (AUTO)=TRUE.
EXTTRK BOOL Setting EXTTRK=TRUE causes the Internal Output to True False
track the External Variable when (STNDBY)=TRUE.

Note
This list differs from the softlist parameters of the AM block in APACS+ as follows:
• COUT has been moved from Output to Input/Output.

See also
AM_AFB: Auto/Manual (Page 22)

1.2.5 ANALOG_ALM_BLK

1.2.5.1 ANALOG_ALM_BLK: Analog Alarm

Function Block Name ANALOG_ALM_BLK


(compiled version of the Chart)
Function Block Number FB600

APACS+ ES Library User's Guide for V7.1


24 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

Chart Name ANALOG_ALM


See also, Template Chart ANALOG_ALM_AT
(usage example)

Function
The Analog Alarm Function Block (ANALOG_ALM_BLK) is a factory-compiled function block
ready-to-use analog indicator with alarms. It is based on the APACS+ ANALOG_ALARM
block in the Basic Application Library. As delivered, the PV (Process Variable) input value is
monitored for both high and low alarms. The ALARM output value provides the overall alarm
status. In addition, there is an alarm output for each analog alarm type. Alarms are
annunciated on the HMI.
The ENG_UNITS and DESC In/Outs are for holding values for the engineering units and
descriptor, respectively.

Calling OBs and Start-up


Calling OBs
This block is called in the watchdog interrupt OB into which the block is installed (for
example, OB32).
Start-up Characteristics
This function block has no special startup properties.

Operator Control and Monitoring (M&C Relevant)


See Faceplate Information

Message Characteristics

Assignment of message texts and message class to the block parameters

Note
During runtime, the string $$BlockComment$$ will be replaced by the comment for the FB
instance that is in alarm.

ALARM_8P ID Message # Message Class Message_class Default Message Text


EV_ID 1 Warning - above HIGH - $$BlockComment$$ - Limit = @4%f@
EV_ID 2 Warning - below LOW - $$BlockComment$$ - Limit = @5%f@
EV_ID 3 Alarm - above HIGH_DEV - $$BlockComment$$ - Limit = @6%f@
EV_ID 4 Alarm - below LOW_DEV - $$BlockComment$$ - Limit = @7%f@
EV_ID 5 Alarm - above ABSOLUTE_DEV - $$BlockComment$$ - Limit =
@8%f@

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 25
ES Library
1.2 Library Function Blocks

ALARM_8P ID Message # Message Class Message_class Default Message Text


EV_ID 6 PLC Process Control Message OUT_OF_RANGE - $$BlockComment$$
- Failure
EV_ID 7 PLC Process Control Message QUALITY_NOT_GOOD - $$BlockComment$$
- Failure
EV_ID2 1 Alarm - above HIGH_ HIGH - $$BlockComment$$ - Limit = @4%f@
EV_ID2 2 Alarm - below LOW_ LOW - $$BlockComment$$ - Limit = @5%f@
EV_ID2 3 Warning - above INC_ROC - $$BlockComment$$ - Limit = @6%f@
EV_ID2 4 Warning - below DEC_ROC - $$BlockComment$$ - Limit = @7%f@
EV_ID2 5 Warning - above ABS_ROC - $$BlockComment$$ - Limit = @8%f@

Assignment of auxiliary process values to the block parameters

ALARM_8P ID Value Block Parameter


EV_ID @1%s@ BA_NA
EV_ID @2%d@ BA_ID
EV_ID @3%d@ STEP_NO
EV_ID @4%f@ H_LIM
EV_ID @5%f@ L_LIM
EV_ID @6%f@ HD_LIM
EV_ID @7%f@ LD_LIM
EV_ID @8%f@ AD_LIM
EV_ID2 @1%s@ BA_NA
EV_ID2 @2%d@ BA_ID
EV_ID2 @3%d@ STEP_NO
EV_ID2 @4%f@ HH_LIM
EV_ID2 @5%f@ LL_LIM
EV_ID2 @6%f@ IR_LIM
EV_ID2 @7%f@ DR_LIM
EV_ID2 @8%f@ AR_LIM

See also
ANALOG_ALM_BLK Input Output (Page 27)

APACS+ ES Library User's Guide for V7.1


26 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

1.2.5.2 ANALOG_ALM_BLK Input Output

Input

Name Data Type Explanation Initial OC&M Valid Values


PV REAL Process Value 0 True
QC_PV BYTE Quality Code for PV 16#80 True QC Values
(Page 11)
DEV REAL Deviation 0 False
H_EN TRUE Enable High Alarm True True
L_EN BOOL Enable Low Alarm True True
HD_EN BOOL Enable High Deviation Alarm False True
LD_EN BOOL Enable Low Deviation Alarm False True
AD_EN BOOL Enable Absolute Deviation False True
Alarm
OOR_EN BOOL Enable Out of Range Alarm False True
QUAL_EN BOOL Enable Quality Not Good False True
Alarm
HH_EN BOOL Enable High High Alarm False True
LL_EN BOOL Enable Low Low Alarm False True
IR_EN BOOL Enable Increasing Rate of False True
Change Alarm
DR_EN BOOL Enable Decreasing Rate of False True
Change Alarm
AR_EN BOOL Enable Absolute Rate of False True
Change Alarm
OOS BOOL Out of Service indicator False True
QBAD BOOL Bad quality indicator False False
EV_ID DWORD Event ID Compiler False
generated for the
type, N/A for the
chart
EV_ID2 DWORD Event ID Compiler False
generated for the
type, N/A for the
chart
BA_EN BOOL Batch enabled False True
OCCUPIED BOOL Batch occupied False True
BA_ID DWORD Batch ID number 0 True
BA_NA STRING[32] Batch name '' True
STEP_NO DWORD Batch step number 0 True
DecimalPlacesPV INT Decimal places displayed in 2 True
HMI for PV
ConfirmChange BOOL If TRUE changes from HMI False True
must be confirmed

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 27
ES Library
1.2 Library Function Blocks

Output

Name Data Explanation Initial OC&M Valid Values


Type
ALARM BOOL Alarm indicator False False
H_ALM BOOL When TRUE, the High alarm is detected and enabled. False False
L_ALM BOOL When TRUE, the Low alarm is detected and enabled. False False
HD_ALM BOOL When TRUE, the High Deviation alarm is detected and False False
enabled.
LD_ALM BOOL When TRUE, the Low Deviation alarm is detected and False False
enabled.
AD_ALM BOOL When TRUE, the Absolute Deviation alarm is detected False False
and enabled.
OOR_ALM BOOL When TRUE, the Out of Range alarm is detected and False False
enabled.
QUAL_ALM BOOL When TRUE, the Quality Not Good alarm is detected False False
and enabled.
HH_ALM BOOL When TRUE, the High High alarm is detected and False False
enabled.
LL_ALM BOOL When TRUE, the Low Low alarm is detected and False False
enabled.
IR_ALM BOOL When TRUE, the Increasing Rate of Change alarm is False False
detected and enabled.
DR_ALM BOOL When TRUE, the Decreasing Rate of Change alarm is False False
detected and enabled.
AR_ALM BOOL When TRUE, the Absolute Rate of Change alarm is False False
detected and enabled.

Input/output

Name Data Explanation Initial OC&M Valid Values


Type
H_LIM REAL The value (in engineering units) to which 100 True
the (PV) input is compared for the High
alarm.
H_DB REAL The amount of engineering units by 0.5 True
which (PV) must be within the limit for
the High alarm to clear.
H_DELAYIN TIME The amount of time the input must reach T#0MS False 0 to
or exceed the High limit to trip an alarm. 24d20h31m23s6
47ms
H_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the High limit and deadband to 24d20h31m23s6
cause the alarm to clear. 47ms
L_LIM REAL The value (in engineering units) to which 0 True
the (PV) input is compared for the Low
alarm.

APACS+ ES Library User's Guide for V7.1


28 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

Name Data Explanation Initial OC&M Valid Values


Type
L_DB REAL The amount of engineering units by 0.5 True
which (PV) must be within the limit for
the Low alarm to clear.
L_DELAYIN TIME The amount of time the input must reach T#0MS False 0 to
or exceed the Low limit to trip an alarm. 24d20h31m23s6
47ms
L_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the Low limit and deadband to 24d20h31m23s6
cause the alarm to clear. 47ms
HD_LIM REAL The value (in engineering units) to which 0 True
(PV) – (DEV) is compared for the High
Deviation alarm.
HD_DB REAL The amount of engineering units by 0.5 True
which (PV) – (DEV) must be within the
limit for the High Deviation alarm to
clear.
HD_DELAYIN TIME The amount of time the input must reach T#0MS False 0 to
or exceed the High Deviation limit to trip 24d20h31m23s6
an alarm. 47ms
HD_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the High Deviation limit and 24d20h31m23s6
deadband to cause the alarm to clear. 47ms
LD_LIM REAL The value (in engineering units) to which 0 True
(DEV) - (PV) is compared for the Low
Deviation alarm.
LD_DB REAL The amount of engineering units by 0.5 True
which (DEV) - (PV) must be within the
limit for the Low Deviation alarm to
clear.
LD_DELAYIN TIME The amount of time the input must reach T#0MS False 0 to
or exceed the Low Deviation limit to trip 24d20h31m23s6
an alarm. 47ms
LD_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the Low Deviation limit and 24d20h31m23s6
deadband to cause the alarm to clear. 47ms
AD_LIM REAL The value (in engineering units) to which 100 True
ABS((PV) – (DEV)) is compared for the
Absolute Deviation alarm.
AD_DB REAL The amount of engineering units by 0.5 True
which ABS((PV) – (DEV)) must be within
the limit for the Absolute Deviation alarm
to clear.
AD_DELAYIN TIME The amount of time the input must reach T#0MS False 0 to
or exceed the Absolute Deviation limit to 24d20h31m23s6
trip an alarm. 47ms
AD_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the Absolute Deviation limit and 24d20h31m23s6
deadband to cause the alarm to clear. 47ms

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 29
ES Library
1.2 Library Function Blocks

Name Data Explanation Initial OC&M Valid Values


Type
HH_LIM REAL The value (in engineering units) to which 0 True
the (PV) input is compared for the High
High alarm.
HH_DB REAL The amount of engineering units by 0.5 True
which (PV) must be within the limit for
the High High alarm to clear.
HH_DELAYIN TIME The amount of time the input must reach T#0MS False 0 to
or exceed the High High limit to trip an 24d20h31m23s6
alarm. 47ms
HH_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the High High limit and deadband 24d20h31m23s6
to cause the alarm to clear. 47ms
LL_LIM REAL The value (in engineering units) to which 0 True
the (PV) input is compared for the Low
Low alarm.
LL_DB REAL The amount of engineering units by 0.5 True
which (PV) must be within the limit for
the Low Low alarm to clear.
LL_DELAYIN TIME The amount of time the input must reach T#0MS False 0 to
or exceed the Low Low limit to trip an 24d20h31m23s6
alarm. 47ms
LL_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the Low Low limit and deadband 24d20h31m23s6
to cause the alarm to clear. 47ms
IR_LIM REAL The value (in engineering units per 0 True
minute) to which the (PV) input is
compared for the Increasing Rate of
Change alarm.
IR_DB REAL The amount of engineering units by 0.5 True
which (PV) must be within the limit for
the Increasing Rate of Change alarm to
clear.
IR_DELAYIN TIME The amount of time the input must reach T#0MS False 0 to
or exceed the Increasing Rate of 24d20h31m23s6
Change limit to trip an alarm. 47ms
IR_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the Increasing Rate of Change 24d20h31m23s6
limit and deadband to cause the alarm 47ms
to clear.
DR_LIM REAL The value (in engineering units per 0 True
minute) to which the (PV) input is
compared for the Decreasing Rate of
Change alarm.
DR_DB REAL The amount of engineering units by 0.5 True
which (PV) must be within the limit for
the Decreasing Rate of Change alarm to
clear.
DR_DELAYIN TIME The amount of time the input must reach T#0MS False 0 to
or exceed the Decreasing Rate of 24d20h31m23s6
Change limit to trip an alarm. 47ms

APACS+ ES Library User's Guide for V7.1


30 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

Name Data Explanation Initial OC&M Valid Values


Type
DR_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the Decreasing Rate of Change 24d20h31m23s6
limit and deadband to cause the alarm 47ms
to clear.
AR_LIM REAL The value (in engineering units per 0 True
minute) to which the (PV) input is
compared for the Absolute Rate of
Change alarm.
AR_DB REAL The amount of engineering units by 0.5 True
which (PV) must be within the limit for
the Absolute Rate of Change alarm to
clear.
AR_DELAYIN TIME The amount of time the input must reach T#0MS False 0 to
or exceed the Absolute Rate of Change 24d20h31m23s6
limit to trip an alarm. 47ms
AR_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the Absolute Rate of Change limit 24d20h31m23s6
and deadband to cause the alarm to 47ms
clear.
OOR_DELAYIN TIME The amount of time the input must be T#0MS False 0 to
outside the limits EINH, EINL to trip the 24d20h31m23s6
Out of Range alarm. 47ms
OOR_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the limits EINH, EINL to cause the 24d20h31m23s6
Out of Range alarm to clear. 47ms
QUAL_DELAYIN TIME The amount of time the input quality T#0MS False 0 to
must be bad to trip the Quality Not Good 24d20h31m23s6
alarm. 47ms
QUAL_DELAYOUT TIME The amount of time the input quality T#0MS False 0 to
must be good to cause the Quality Not 24d20h31m23s6
Good alarm to clear. 47ms
DISABLE_ON_OOS BOOL When set to TRUE, the block is disabled False False
if (OOS) is also TRUE.
PV_EUMIN REAL Engineering Input Low 0 True
PV_EUMAX REAL Engineering Input High 100 True

See also
ANALOG_ALM_BLK: Analog Alarm (Page 24)
Introduction (Page 10)

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 31
ES Library
1.2 Library Function Blocks

1.2.6 BLK_VLV_1OUT_BLK

1.2.6.1 BLK_VLV_1OUT: Block Valve with One Output

Function Block Name BLK_VLV_1OUT_AFB


(compiled version of the Chart)
Function Block Number FB601
Chart Name BLK_VLV_1OUT
See also, Template Chart BLK_VLV_1OUT_AT
(usage example)

Function
The Block Valve with One Output (BLK_VLV_1OUT) is intended for use as an open/close
block valve with one output. It is designed for a normally closed valve with auto/manual
operation, pulse commands, and interlocking. An alarm is provided for failure to reach the
desired state.
The [A_OPEN] and [A_CLSE] inputs are intended to input command pulses from a
sequence. The parameter AUTO determines the source of the open/close commands. In
auto mode (AUTO=TRUE) the auto inputs [A_OPEN] and [A_CLSE] are active, and in
manual mode (AUTO=FALSE), the parameters OPEN and CLOSE are active. OPEN,
CLOSE, and AUTO are to be manipulated via the operator interface. OPEN and CLOSE are
to be set TRUE; they are reset automatically.
A positive transition of auto open [A_OPEN] or manual open OPEN (depending on the
mode), latches the output [OUT]. Interlock [INTRLK] must be TRUE to allow the latch. A
positive transition of auto close [A_CLSE] or manual close CLOSE (also mode-dependent)
unlatches the output. The internal open and close timers determine if the valve has failed to
reach its desired state, and the failure output [FAIL] will become TRUE accordingly, which
triggers the alarm.
Although the BLK_VLV_1OUT block was implemented in ladder logic in APACS, it has been
implemented in SCL in PCS 7 due to differences between APACS+ and PCS 7 ladder logic.
The BLK_VLV_1OUT is a logical and functional equivalent to the corresponding APACS+
ladder networks. Comments in the provided SCL source code relate elements in the PCS 7
SCL code to corresponding elements in the original APACS+ ladder network.

Calling Obs and Start-up


Calling OBs
This block is called in the watchdog interrupt OB into which the block is installed (for
example, OB32). Additionally, it is called in OB100 and in OB102 (see Start-up
Characteristics).
Start-up Characteristics
On a warm restart, OB100 is called and parameters retain the values they had immediately
before the restart. On a cold restart, OB102 is called and parameters are initialized with the
last downloaded values.

APACS+ ES Library User's Guide for V7.1


32 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

The warm and cold startup behavior of AUTO and OUT is configurable, allowing the user to
override the default PCS 7 behavior described above if necessary. As delivered, AUTO will
be forced to "Manual" and OUT will be forced to "False" on a CPU restart.
To force the AUTO parameter to a specified value on a restart, set the RSTRT_AUTO_FLAG
to true ("Force AUTO") and configure RSTRT_AUTO_VALUE with the desired forced value
("Auto" or "Manual"). The RSTRT_AUTO_VALUE will be used to initialize AUTO, if and only
if the RSTRT_AUTO_FLAG is true. If RSTRT_AUTO_FLAG is set to false ("Default"), the
AUTO parameter will be set in accordance with default PCS 7 behavior.
To force the OUT parameter to a specified value on a restart, set the RSTRT_OUT_FLAG to
true ("Force OUT") and configure RSTRT_OUT_VALUE with the desired forced value ("True"
or "False"). The RSTRT_OUT_VALUE will be used to initialize OUT, if and only if the
RSTRT_OUT_FLAG is true. If RSTRT_OUT_FLAG is set to false ("Default"), the OUT
parameter will be set in accordance with default PCS 7 behavior.

WARNING
Using "Default" for the RSTRT_OUT_FLAG could result in your output device retaining its
last operating state after a restart. Similarly, using "Default" for the RSTRT_AUTO_FLAG
could result in your process running in automatic mode after a restart. Use "Forced" for the
restart flags and configure the associated restart values to ensure a known restart state.

If restart parameter values are changed offline, the configuration must be compiled (changes
only) and downloaded (changes only) to the controller in order for the settings to take effect
upon restart. If restart parameter values are changed online (via CFC Test mode), the
configuration must be compiled (entire program) and downloaded (entire program) to the
controller in order for the settings to take effect upon cold restart. This step is not necessary
for the online changes to take effect upon a warm restart.

Operator Control and Monitoring (M&C Relevant)


See Faceplate Information

Message Characteristics

Assignment of message texts and message class to the block parameters

Note
During runtime, the string $$BlockComment$$ will be replaced by the comment for the FB
instance that is in alarm.

Message # Message Class Message_class Default Message Text


1 PLC Process Control Message - Failure Valve Feedback Failure - $$BlockComment$$

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 33
ES Library
1.2 Library Function Blocks

Assignment of auxiliary process values to the block parameters

Value Block Parameter


@1%s@ BA_NA
@2%d@ BA_ID
@3%d@ STEP_NO

See also
BLK_VLV_1OUT_BLK Input Output (Page 34)

1.2.6.2 BLK_VLV_1OUT_BLK Input Output

Input

Name Data Type Explanation Initial OC&M Valid


Values
OP_VER BOOL OP_VER feedback to verify False True
that the valve is open
QC_OP_VER BYTE Quality Code for OP_VER 16#80 True Quality
Codes
(Page 11)
CL_VER BOOL CL_VER feedback to verify False True
that the valve is closed
QC_CL_VER BYTE Quality Code for CL_VER 16#80 True Quality
Codes
(Page 11)
A_OPEN BOOL A false-to-true transition of False False
A_OPEN opens the valve
when in AUTO mode
(AUTO=true).
A_CLSE BOOL A false-to-true transition of False False
A_CLSE closes the valve
when in AUTO mode
(AUTO=true).
INTRLK BOOL INTRLK forbids activation of False True
the valve
SAMPLE_T REAL Sample Time (in seconds) Compiler False
generated
RSTRT_AUTO_FLAG BOOL Default retain on WS, Use False True
load val on CS. Force: Use
RSTRT_AUTO_VALUE on
restart
RSTRT_AUTO_VALUE BOOL Init restart value for Auto False False
Mode if RSTRT_AUTO_FLAG
true

APACS+ ES Library User's Guide for V7.1


34 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid


Values
RSTRT_OUT_FLAG BOOL Default retain on WS, Use False True
load val on CS. Force: Use
RSTRT_AUTO_VALUE on
restart
RSTRT_OUT_VALUE BOOL Init restart value for OUT if False False
RSTRT_OUT_FLAG true
EV_ID DWORD Event ID Compiler False
generated
LIOP_MAN_SEL BOOL Select AUTO/MANUAL: False False
1 = Linking, 0 = Operator
active
AUT_L BOOL Linkable input for False False
AUTO/MANUAL mode, 1 =
AUTO
BA_EN BOOL Batch enabled False True
OCCUPIED BOOL Batch occupied False True
BA_ID DWORD Batch ID number 0 True
BA_NA STRING[32] Batch name '' True
STEP_NO DWORD Batch step number 0 True
ConfirmChange BOOL If TRUE changes from HMI False True
must be confirmed
QC_OUT_IN BYTE Quality Code input for output 16#80 True Quality
OUT Codes
(Page 11)

Note
This list differs from the inputs of the BLK_VLV_1OUT_BLK block in APACS+ as follows:
• Restart parameters (RSTRT_...) did not exist in APACS+.
• EV_ID and SAMPLE_T did not exist in APACS+.

Output

Name Data Type Explanation Initial OC&M Valid Values


OUT BOOL OUT is used to actuate the valve False True
QC_OUT BYTE Quality Code for output OUT 16#80 True Quality Codes
(Page 11)
ALARM BOOL ALARM is used to signa 1 internal logic when the False False
Valve is in alarm
FAIL BOOL FAIL signals if the valve failed to open or close False True
after an OPEN or CLOSE request
TRANS BOOL TRANS signals that the valve is in transition (i.e. False True
OP_VER, CL_VER both false)

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 35
ES Library
1.2 Library Function Blocks

Input/output

Name Data Type Explanation Initial OC&M Valid Values


AUTO BOOL AUTO select auto mode (uses False True
A_OPEN, A_CLSE) vs manual mode
(uses OPEN, CLOSE)
A1EN BOOL A1EN is used to enable/disable the True True
internal alarm
A1LIM BOOL Alarm 1 limit True False
A1DELAYIN TIME Into alarm 1 delay time T#0MS False 0 to
24d20h31m23s
647ms
A1DELAYOUT TIME Out of alarm 1 delay time T#0MS False 0 to
24d20h31m23s
647ms
OOS BOOL OOS indicates that the internal alarm is False True
Out of Service
DISABLE_ON_OOS BOOL Disable on Out of Service False False
OPEN BOOL OPEN opens the valve when in Manual False True
mode (AUTO=false)
CLOSE BOOL CLOSE closes the valve when in False True
Manual mode (AUTO=false)
TRAV_T TIME TRAV_T sets time limit for confirmation T#10S True
of open/close request

See also
BLK_VLV_1OUT: Block Valve with One Output (Page 32)

1.2.7 BLK_VLV_2OUT_BLK

1.2.7.1 BLK_VLV_2OUT: Block Valve with Two Outputs

Function Block Name BLK_VLV_2OUT_BLK


(compiled version of the Chart)
Function Block Number FB602
Chart Name BLK_VLV_2OUT
See also, Template Chart BLK_VLV_2OUT_AT
(usage example)

Function
The Block Valve with Two Outputs (BLK_VLV_2OUT) is intended for use as an open/close
block valve with both an open output and a close output. It is designed for a valve with

APACS+ ES Library User's Guide for V7.1


36 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

auto/manual operation, pulse commands, and interlocking. An alarm is provided for failure to
reach the desired state.
The [A_OPEN] and [A_CLSE] inputs are intended to input command pulses from a
sequence. The parameter AUTO determines the source of the open/close commands. In
auto mode (AUTO=TRUE), the auto inputs [A_OPEN] and [A_CLSE] are active, and in
manual mode (AUTO=FALSE), the parameters OPEN and CLOSE are active. OPEN,
CLOSE, and AUTO are to be manipulated via the operator interface. OPEN and CLOSE are
to be set TRUE; they are reset automatically.
A positive transition of auto open [A_OPEN] or manual open OPEN (depending on the
mode) latches the internal OPEN_LATCH and pulses the open output [OP_OUT]. Interlock
[INTRLK] must be TRUE to allow the latch. A positive transition of auto close [A_CLSE] or
manual close CLOSE (also mode-dependent) unlatches the internal OPEN_LATCH and
pulses the close output [CL_OUT]. The internal open and close timers pulse the outputs and
determine if the valve has failed to reach its desired state, and the failure output [FAIL] will
become TRUE accordingly, which triggers the alarm.
Although the BLK_VLV_2OUT block was implemented in ladder logic in APACS, it has been
implemented in SCL in PCS 7 due to differences between APACS+ and PCS 7 ladder logic.
The BLK_VLV_2OUT is a logical and functional equivalent to the corresponding APACS+
ladder networks. Comments in the provided SCL source code relate elements in the PCS 7
SCL code to corresponding elements in the original APACS+ ladder network.

Calling OBs and Start-up


Calling OBs
This block is called in the watchdog interrupt OB into which the block is installed (for
example, OB32). Additionally, it is called in OB100 and in OB102 (see Start-up
Characteristics).
Start-up Characteristics
On a warm restart, OB100 is called and parameters retain the values they had immediately
before the restart. On a cold restart, OB102 is called and parameters are initialized with the
last downloaded values.
The warm and cold startup behavior of AUTO is configurable, allwoing the user to override
the default PCS 7 behavior described above if necessary. As delivered, AUTO will be forced
to "Manual" and OUT will be forced to "False" on a CPU restart.
To force the AUTO parameter to a specified value on a restart, set the RSTRT_AUTO_FLAG
to true ("Force AUTO") and configure RSTRT_AUTO_VALUE with the desired forced value
("Auto" or "Manual"). The RSTRT_AUTO_VALUE will be used to initialize AUTO, if and only
if the RSTRT_AUTO_FLAG is true. If RSTRT_AUTO_FLAG is set to false ("Default"), the
AUTO parameter will be set in accordance with default PCS 7 behavior.

WARNING
Using "Default" for the RSTRT_AUTO_FLAG could result in your process running in
automatic mode after a restart. Use "Forced" for the restart flag and configure the associate
restart value to ensure a known restart state.

The OP_OUT and CL_OUT outputs will be automatically cleared on a restart.


If restart parameter values are changed offline, the configuration must be compiled (changes
only) and downloaded (changes only) to the controller in order for the settings to take effect

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 37
ES Library
1.2 Library Function Blocks

upon restart. If restart parameter values are changed online (via CFC Test mode), the
configuration must be compiled (entire program) and downloaded (entire program) to the
controller in order for the settings to take effect upon cold restart. This step is not necessary
for the online changes to take effect upon a warm restart.

Operator Control and Monitoring (M&C Relevant)


See Faceplate Information

Message Characteristics

Assignment of message texts and message class to the block parameters

Note
During runtime, the string $$BlockComment$$ will be replaced by the comment for the FB
instance that is in alarm.

Message # Message Class Message_class Default Message Text


1 PLC Process Control Message - Failure Valve Feedback Failure - $$BlockComment$$

Assignment of auxiliary process values to the block parameters

Value Block Parameter


@1%s@ BA_NA
@2%d@ BA_ID
@3%d@ STEP_NO

1.2.7.2 BLK_VLV_2OUT_BLK Input Output

Input

Name Data Type Explanation Initial OC&M Valid Values


OP_VER BOOL OP_VER feedback to verify False True
that the valve is open
QC_OP_VER BYTE Quality Code for OP_VER 16#80 True Quality
Codes
(Page 11)
CL_VER BOOL CL_VER feedback to verify False True
that the valve is closed

APACS+ ES Library User's Guide for V7.1


38 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid Values


QC_CL_VER BYTE Quality Code for CL_VER 16#80 True Quality
Codes
(Page 11)
A_OPEN BOOL A_OPEN is intended to allow False False
internal logic to automatically
open the valve
A_CLSE BOOL A_CLSE is intended to allow False False
internal logic to automatically
close the valve
INTRLK BOOL INTRLK forbids activation of False True
the valve
SAMPLE_T REAL Sample time (in seconds) Compiler False
generated
RSTRT_AUTO_FLAG BOOL Default retain on WS, Use load False True
val on CS. Force: Use
RSTRT_AUTO_VALUE on
restart
RSTRT_AUTO_VALUE BOOL Init restart value for Auto Mode False False
if RSTRT_AUTO_FLAG true
EV_ID DWORD Event ID Compiler False
generated
LIOP_MAN_SEL BOOL Select AUTO/MANUAL: False False
1 = Linking, 0 = Operator
active
AUT_L BOOL Linkable input for False False
AUTO/MANUAL mode, 1 =
AUTO
BA_EN BOOL Batch enabled False True
OCCUPIED BOOL Batch occupied False True
BA_ID DWORD Batch ID number 0 True
BA_NA STRING[32] Batch name '' True
STEP_NO DWORD Batch step number 0 True
ConfirmChange BOOL If TRUE changes from HMI False True
must be confirmed
QC_OP_OUT_IN BYTE Quality Code input for output 16#80 True Quality
OP_OUT Codes
(Page 11)
QC_CL_OUT_IN BYTE Quality Code input for output 16#80 True Quality
CL_OUT Codes
(Page 11)

Note
This list differs from the inputs of the BLK_VLV_2OUT_BLK block in APACS+ as follows:
• Restart parameters (RSTRT_...) did not exist in APACS+.
• EV_ID and SAMPLE_T did not exist in APACS+.

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 39
ES Library
1.2 Library Function Blocks

Output

Name Data Type Explanation Initial OC&M Valid Values


OP_OUT BOOL OP_OUT is used to request that the valve open T#0MS False 0 to
24d20h31m23s6
47ms
QC_OP_OU BYTE Quality Code output for OP_OUT 16#80 True Quality Codes
T (Page 11)
CL_OUT BOOL CL_OUT is used to request that the valve close False False
QC_CL_OU BYTE Quality Code for CL_OUT 16#80 True Quality Codes
T (Page 11)
ALARM BOOL ALARM is used to signal internal logic when the False False
Valve is in alarm
FAIL BOOL FAIL signals if the valve failed to open or close False True
after an OPEN or CLOSE request
TRANS BOOL TRANS signals that the valve is in transition (i.e. False True
OP_VER, CL_VER both false)
OUT BOOL OUT is used to let the OS 'see' the internal False True
OPEN_LATCH coil
QC_OUT BYTE Quality Code for OUT for faceplate display - worst 16#80 True Quality Codes
of QC_OP_OUT and QC_CL_OUT (Page 11)

Input/output

Name Data Type Explanation Initial OC&M Valid Values


AUTO BOOL AUTO select auto mode (uses A_OPEN, False True
A_CLSE) vs manual mode (uses OPEN,
CLOSE)
A1EN BOOL A1EN is used to enable /disable the True True
internal alarm
A1LIM BOOL Alarm 1 limit True False
A1DELAYIN TIME Into alarm 1 delay time T#0MS False 0 to
24d20h31m23s647ms
A1DELAYOUT TIME Out of alarm 1 delay time T#0MS False 0 to
24d20h31m23s647ms
OOS BOOL OOS indicates that the internal alarm is False True
Out of Service
DISABLE_ON_OOS BOOL Indicates that the internal alarm is Out of False False
Service
OPEN BOOL OPEN opens the valve w hen in Manual False True
mode (AUTO=false)
CLOSE BOOL Closes the valve when in Manual mode False True
(AUTO=false)
TRAV_T TIME TRAV_T sets time limit for confirmation T#10S True
of open/close request

APACS+ ES Library User's Guide for V7.1


40 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

1.2.8 CASCADE_BLK

1.2.8.1 CASCADE: Cascade Controller

Function Block Name CASCADE_BLK


(compiled version of the Chart)
Function Block Number FB603
Chart Name CASCADE
See also, Template Chart CASCADE_AT
(usage example)

Function
CASCADE_BLK is a compiled version of the CASCADE source chart. Within the chart, there
are two connected control loops, primary and secondary. Each contains SETPNT_AFB and
PID_AFB blocks along with alarming logic. The secondary loop also contains an AM_AFB
block.
The primary controller tracks the secondary process variable [S_PV] when the cascaded
loops are in manual mode (AUTO=FALSE) or secondary mode (CASC=FALSE). The
PRI_SETPOINT block supplies the setpoint [P_SP_OUT] to the PRI_CONTROLLER block.
The PRI_SETPOINT block has a ramping feature for auto mode. The setpoint tracks the
primary process variable [P_PV] in manual or secondary mode. The PRI_CONTROLLER
block is a PID block; it operates when both AUTO and CASC are TRUE and tracks the
secondary process variable [S_PV] if either is FALSE. The PRI_CONTROLLER block output
becomes the external setpoint to the secondary control loop.
The SEC_SETPOINT block supplies the setpoint [S_SP] to the SEC_CONTROLLER block.
The SEC_SETPOINT block has a ramping feature for secondary mode (CASC=FALSE). In
cascade mode (CASC=TRUE), the external setpoint (the output from the primary loop)
becomes the secondary controller setpoint, and the SEC_SETPOINT block internal setpoint
ISP tracks the external setpoint, thereby ensuring no change in setpoint during transition to
secondary mode. The setpoint tracks the secondary process variable [S_PV] in manual
mode (AUTO=FALSE).
The SEC_CONTROLLER block is a PID_AFB block; it operates in auto mode
(AUTO=TRUE) and tracks the downstream output [OUT] in manual mode (AUTO=FALSE).
The SEC_AUTO_MANUAL block provides manual control of the output. In auto mode the
SEC_CONTROLLER block output becomes the loop output [OUT]. In manual mode the
SEC_AUTO_MANUAL block internal output IOUT becomes the loop output.

Calling OBs and Start-up


Calling OBs
This block is called in the watchdog interrupt OB into which the block is installed (for
example, OB32). Additionally, it is called in OB100 and in OB102 (see Start-up
Characteristics).
Start-up Characteristics

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 41
ES Library
1.2 Library Function Blocks

On a warm restart, OB100 is called and parameters retain the values they had immediately
before the restart. On a cold restart, OB102 is called and parameters are initialized with the
last downloaded values.
The warm and cold startup behavior of AUTO, P_SP, S_SP, CASC, and OUT is
configurable, allowing the user to override the default PCS 7 behavior described above, if
necessary. As delivered, AUTO will be forced to "Manual", CASC will be forced to "Cascade"
and OUT will be forced to 0.0 on a CPU restart. P_SPand S_SP will be set in accordance
with default PCS 7 behavior.
To force the AUTO parameter to a specified value on a restart, set the RSTRT_AUTO_FLAG
to true ("Force AUTO") and configure RSTRT_AUTO_VALUE with the desired forced value
("Auto" or "Manual"). The RSTRT_AUTO_VALUE will be used to initialize AUTO, if and only
if the RSTRT_AUTO_FLAG is true. If RSTRT_AUTO_FLAG is set to false ("Default"), the
AUTO parameter will be set in accordance with default PCS 7 behavior.
To force the P_SP parameter to a specified value on a restart, set the P_RSTRT_SP_FLAG
to true ("Force SP") and configure P_RSTRT_SP_VALUE with the desired forced value. The
P_RSTRT_SP_VALUE will be used to initialize P_SP, if the P_RSTRT_SP_FLAG is true and
either
● the block is forced to start in Auto mode, or
● AUTO is not forced and the block restarts with Auto mode (AUTO="Auto") and in
Cascade (CASC = "Cascade").
If P_RSTRT_SP_FLAG is set to false ("Default"), the P_SP parameter will be set in
accordance with default PCS 7 behavior.
To force the S_SP parameter to a specified value on a restart, set the S_RSTRT_SP_FLAG
to true ("Force SP") and configure S_RSTRT_SP_VALUE with the desired forced value. The
S_RSTRT_SP_VALUE will be used to initialize S_SP, if and only if the S_RSTRT_SP_FLAG
is true and the block restarts in Auto mode (AUTO="Auto") and not in Cascade
(CASC="Secondary"). If S_RSTRT_SP_FLAG is set to false ("Default"), the S_SP parameter
will be set in accordance with default PCS 7 behavior.
To force the CASC parameter to a specified value on a restart, set the RSTRT_CASC_FLAG
to true ("Force CASC") and configure RSTRT_CASC_VALUE with the desired forced value
("Secondary or Cascade"). The RSTRT_CASC_VALUE will be used to initialize CASC, if and
only if the RSTRT_CASC_FLAG is true. If RSTRT_CASC_FLAG is set to false ("Default"),
the CASC parameter will be set in accordance with default PCS 7 behavior. If CASC is true
following a restart, then S_SP will be set to the Primary loop's OUT value.
To force the OUT parameter to a specified value on a restart, set the RSTRT_OUT_FLAG to
true ("Force OUT") and configure RSTRT_OUT_VALUE with the desired forced value. The
RSTRT_OUT_VALUE will be used to initialize OUT, if and only if the RSTRT_OUT_FLAG is
true and the block restarts in Manual mode (AUTO = "Manual"). If RSTRT_OUT_FLAG is set
to false ("Default"), the OUT parameter will be set in accordance with default PCS 7
behavior.

WARNING
Using "Default" for the RSTRT_OUT_FLAG could result in your output device retaining its
last operating state after a restart. Similarly, using "Default" for the RSTRT_AUTO_FLAG
could result in your process running in automatic mode after a restart. Use "Forced" for the
restart flags and configure the associated restart values to ensure a known restart state.

APACS+ ES Library User's Guide for V7.1


42 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

If restart parameter values are changed offline, the configuration must be compiled (changes
only) and downloaded (changes only) to the controller in order for the settings to take effect
upon restart. If restart parameter values are changed online (via CFC Test mode), the
configuration must be compiled (entire program) and downloaded (entire program) to the
controller in order for the settings to take effect upon cold restart. This step is not necessary
for the online changes to take effect upon a warm restart.

Operator Control and Monitoring (M&C Relevant)


See Faceplate Information

Message Characteristics

Assignment of message texts and message class to the block parameters

Note
During runtime, the string $$BlockComment$$ will be replaced by the comment for the FB
instance that is in alarm.

ALARM_8P ID Message # Message Class Default Message Text


Message_class
EV_ID 1 Warning - above Pri HIGH - $$BlockComment$$ - Limit = @4%f@
EV_ID 2 Warning - below Pri LOW - $$BlockComment$$ - Limit = @5%f@
EV_ID 3 Alarm - above Pri HIGH_DEV - $$BlockComment$$ - Limit = @6%f@
EV_ID 4 Alarm - below Pri LOW_DEV - $$BlockComment$$ - Limit = @7%f@
EV_ID 5 Alarm - above Pri ABSOLUTE_DEV - $$BlockComment$$ - Limit = @8%f@
EV_ID 6 PLC Process Control Pri OUT_OF_RANGE - $$BlockComment$$
Message - Failure
EV_ID 7 PLC Process Control Pri QUALITY_NOT_GOOD - $$BlockComment$$
Message - Failure
EV_ID2 1 Alarm - above Pri HIGH_ HIGH - $$BlockComment$$ - Limit = @4%f@
EV_ID2 2 Alarm - below Pri LOW_ LOW - $$BlockComment$$ - Limit = @5%f@
EV_ID2 3 Warning - above Pri INC_ROC - $$BlockComment$$ - Limit = @6%f@
EV_ID2 4 Warning - below Pri DEC_ROC - $$BlockComment$$ - Limit = @7%f@
EV_ID2 5 Warning - above Pri ABS_ROC - $$BlockComment$$ - Limit = @8%f@
EV_ID3 1 Warning - above Sec HIGH - $$BlockComment$$ - Limit = @4%f@
EV_ID3 2 Warning - below Sec LOW - $$BlockComment$$ - Limit = @5%f@
EV_ID3 3 Alarm - above Sec HIGH_DEV - $$BlockComment$$ - Limit = @6%f@
EV_ID3 4 Alarm - below Sec LOW_DEV - $$BlockComment$$ - Limit = @7%f@
EV_ID3 5 Alarm - above Sec ABSOLUTE_DEV - $$BlockComment$$ - Limit = @8%f@
EV_ID3 6 PLC Process Control Sec OUT_OF_RANGE - $$BlockComment$$
Message - Failure
EV_ID3 7 PLC Process Control Sec QUALITY_NOT_GOOD - $$BlockComment$$
Message - Failure

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 43
ES Library
1.2 Library Function Blocks

ALARM_8P ID Message # Message Class Default Message Text


Message_class
EV_ID4 1 Alarm - above Sec HIGH_ HIGH - $$BlockComment$$ - Limit = @4%f@
EV_ID4 2 Alarm - below Sec LOW_ LOW - $$BlockComment$$ - Limit = @5%f@
EV_ID4 3 Warning - above Sec INC_ROC - $$BlockComment$$ - Limit = @6%f@
EV_ID4 4 Warning - below Sec DEC_ROC - $$BlockComment$$ - Limit = @7%f@
EV_ID4 5 Warning - above Sec ABS_ROC - $$BlockComment$$ - Limit = @8%f@

Assignment of auxiliary process values to the block parameters

ALARM_8P ID Value Block Parameter


EV_ID @1%s@ BA_NA
EV_ID @2%d@ BA_ID
EV_ID @3%d@ STEP_NO
EV_ID @4%f@ P_H_LIM
EV_ID @5%f@ P_L_LIM
EV_ID @6%f@ P_HD_LIM
EV_ID @7%f@ P_LD_LIM
EV_ID @8%f@ P_AD_LIM
EV_ID2 @1%s@ BA_NA
EV_ID2 @2%d@ BA_ID
EV_ID2 @3%d@ STEP_NO
EV_ID2 @4%f@ P_HH_LIM
EV_ID2 @5%f@ P_LL_LIM
EV_ID2 @6%f@ P_IR_LIM
EV_ID2 @7%f@ P_DR_LIM
EV_ID2 @8%f@ P_AR_LIM
EV_ID3 @1%s@ BA_NA
EV_ID3 @2%d@ BA_ID
EV_ID3 @3%d@ STEP_NO
EV_ID3 @4%f@ S_H_LIM
EV_ID3 @5%f@ S_L_LIM
EV_ID3 @6%f@ S_HD_LIM
EV_ID3 @7%f@ S_LD_LIM
EV_ID3 @8%f@ S_AD_LIM
EV_ID4 @1%s@ BA_NA
EV_ID4 @2%d@ BA_ID
EV_ID4 @3%d@ STEP_NO
EV_ID4 @4%f@ S_HH_LIM
EV_ID4 @5%f@ S_LL_LIM
EV_ID4 @6%f@ S_IR_LIM
EV_ID4 @7%f@ S_DR_LIM
EV_ID4 @8%f@ S_AR_LIM

APACS+ ES Library User's Guide for V7.1


44 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

See also
CASCADE_BLK Input Output (Page 45)

1.2.8.2 CASCADE_BLK Input Output

Input

Name Data Type Explanation Initial OC&M Valid Values


P_PV REAL Primary Process 0 True
Variable
QC_P_PV BYTE Quality Code for P_PV 16#80 True Quality
Codes
(Page 11)
S_PV REAL Secondary Process 0 True
Variable
QC_S_PV BYTE Quality Code for S_PV 16#80 True Quality
Codes
(Page 11)
P_INIT BOOL Transitions of the INIT False False
input cause the
initialization equation
to be performed
P_TSP REAL SP target value for SP 0 True
ramping
P_H_EN BOOL Enable primary High True True
Alarm
P_L_EN BOOL Enable primary Low True True
Alarm
P_HD_EN BOOL Enable primary High False True
Deviation Alarm
P_LD_EN BOOL Enable primary Low False True
Deviation Alarm
P_AD_EN BOOL Enable primary True True
Absolute Deviation
Alarm
P_OOR_EN BOOL Enable primary Out of False True
Range Alarm
P_QUAL_EN BOOL Enable primary Quality False True
Not Good Alarm
P_HH_EN BOOL Enable primary High False True
High Alarm
P_LL_EN BOOL Enable primary Low False True
Low Alarm
P_IR_EN BOOL Enable primary False True
Increasing Rate of
Change Alarm

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 45
ES Library
1.2 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid Values


P_DR_EN BOOL Enable primary False True
Decreasing Rate of
Change Alarm
P_AR_EN BOOL Enable primary False True
Absolute Rate of
Change Alarm
P_OOS BOOL Primary Out of Service False True
indicator
P_QBAD BOOL Bad quality indicator False False
EV_ID DWORD Event ID Compiler generated False
for the type or N/A if
used as chart *
EV_ID2 DWORD Event ID Compiler generated False
for the type or N/A if
used as chart *
EV_ID3 DWORD Event ID Compiler generated False
for the type or N/A if
used as chart *
EV_ID4 DWORD Event ID Compiler generated False
for the type or N/A if
used as chart *
S_TSP REAL SP target value for SP 0 True
ramping
S_H_EN BOOL Enable secondary True True
High Alarm
S_L_EN BOOL Enable secondary Low True True
Alarm
S_HD_EN BOOL Enable secondary False True
High Deviation Alarm
S_LD_EN BOOL Enable secondary Low False True
Deviation Alarm
S_AD_EN BOOL Enable secondary True True
Absolute Deviation
Alarm
S_OOR_EN BOOL Enable secondary Out False True
of Range Alarm
S_QUAL_EN BOOL Enable secondary False True
Quality Not Good
Alarm
S_HH_EN BOOL Enable secondary False True
High High Alarm
S_LL_EN BOOL Enable secondary Low False True
Low Alarm
S_IR_EN BOOL Enable secondary False True
Increasing Rate of
Change Alarm
S_DR_EN BOOL Enable secondary False True
Decreasing Rate of
Change Alarm

APACS+ ES Library User's Guide for V7.1


46 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid Values


S_AR_EN BOOL Enable secondary False True
Absolute Rate of
Change Alarm
S_OOS BOOL Secondary Out of False True
Service indicator
S_QBAD BOOL Bad quality indicator False False
SAMPLE_T REAL Scan Rate. Use only Compiler generated False
when compiling CFC for the type or N/A if
as block type. used as chart *
RSTRT_AUTO_FLAG BOOL Default:Retain on WS, True False
Use load val on CS.
Force:Use
RSTRT_AUTO_VALU
E on restart
RSTRT_AUTO_VALUE BOOL Init restart value for False False
Auto Mode if
RSTRT_AUTO_FLAG
true
P_RSTRT_SP_FLAG BOOL Default:Retain on WS, False False
Use load val on CS.
Force:Use
RSTRT_SP_VALUE
on restart.
P_RSTRT_SP_VALUE REAL Init restart value for SP 0 False
if RSTRT_SP_FLAG
true and Auto mode
RSTRT_CASC_FLAG BOOL Default:Retain on WS, True False
Use load val on CS.
Force:Use
RSTRT_EXT_VALUE
on restart.
RSTRT_CASC_VALUE BOOL Init restart value for False False
EXTernal if
RSTRT_EXT_FLAG
true
S_RSTRT_SP_FLAG BOOL Default:Retain on WS, False False
Use load val on CS.
Force:Use
RSTRT_SP_VALUE
on restart.
S_RSTRT_SP_VALUE REAL Init restart value for SP 0 False
if RSTRT_SP_FLAG
true and Auto mode
RSTRT_OUT_FLAG BOOL Default:Retain on WS, True False
Use load val on CS.
Force:Use
RSTRT_OUT_VALUE
on restart

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 47
ES Library
1.2 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid Values


RSTRT_OUT_VALUE REAL Init restart value for 0 False
OUT if
RSTRT_OUT_FLAG
true and manual mode
BA_EN BOOL Batch enabled False True
OCCUPIED BOOL Batch occupied False True
BA_ID DWORD Batch ID number 0 True
BA_NA STRING[32] Batch name '' True
STEP_NO DWORD Batch step number 0 True
DecimalPlacesP_PV INT Decimal places 2 True
displayed in HMI for
Primary PV, SP etc.
DecimalPlacesS_PV INT Decimal places 2 True
displayed in HMI for
Secondary PV, SPetc.
DecimalPlacesOUT INT Decimal places 2 True
displayed in HMI for
OUT, OUT Limits
ConfirmChange BOOL If TRUE changes from False True
HMI must be
confirmed
LIOP_MAN_SEL BOOL Select 0 False
AUTO/MANUAL:
1 = Linking, 0 =
Operator active
AUT_L BOOL Linkable input for 0 False
AUTO/MANUAL
mode, 1 = AUTO
LIOP_P_ISP_SEL BOOL Select Primary internal 0 False
SP: 1 = from Link, 0 =
from Operator
P_SP_L REAL Linkable input for 0.0 False
Primary internal
Setpoint
LIOP_S_ISP_SEL BOOL Select Secondary 0 False
internal SP: 1 = from
Link, 0 = from
Operator
S_SP_L REAL Linkable input for 0.0 False
Secondary internal
Setpoint
LIOP_EXT_SEL BOOL Select 0 False
External/Internal SP
flag: 1 = from Link, 0 =
from Operator
EXTRNL_L BOOL Linkable input to select 0 False
External/Internal SP
flag, 1=Extrnl

APACS+ ES Library User's Guide for V7.1


48 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid Values


LIOP_OUT_SEL BOOL Select writing to OUT: 0 False
1 = from Link, 0 = from
Operator
OUT_L REAL Linkable input to be 0.0 False
written to Secondary
OUT

Note
This list differs significantly from the inputs of the CASCADE_BLK block in APACS+. In the
APACS+ version, only the P_PV and S_PV inputs are present (and in APACS+, they are
named PRI_PV and SEC_PV, respectively).

Output

Name Data Type Explanation Initial OC&M Valid Values


P_SP_OUT REAL Calculated set point value 0 False
S_SP_OUT REAL Calculated set point value 0 False
OUT REAL Calculated output variable that has been 0 False
limited
QC_OUT BYTE Quality Code for output OUT 16#80 True Quality
Codes
(Page 11)
ALARM BOOL Alarm Status False False
S_ESP REAL Provides S_ESP tag for the OS 0 True
P_H_ALM BOOL When TRUE, the primary High alarm is False False
detected and enabled.
P_L_ALM BOOL When TRUE, the primary Low alarm is False False
detected and enabled.
P_HD_ALM BOOL When TRUE, the primary High Deviation False False
alarm is detected and enabled.
P_LD_ALM BOOL When TRUE, the primary Low Deviation False False
alarm is detected and enabled.
P_AD_ALM BOOL When TRUE, the primary Absolute False False
Deviation alarm is detected and enabled.
P_OOR_ALM BOOL When TRUE, the primary Out of Range False False
alarm is detected and enabled.
P_QUAL_ALM BOOL When TRUE, the primary Quality Not Good False False
alarm is detected and enabled.
P_HH_ALM BOOL When TRUE, the primary High High alarm False False
is detected and enabled.
P_LL_ALM BOOL When TRUE, the primary Low Low alarm is False False
detected and enabled.
P_IR_ALM BOOL When TRUE, the primary Increasing Rate of False False
Change alarm is detected and enabled.

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 49
ES Library
1.2 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid Values


P_DR_ALM BOOL When TRUE, the primary Decreasing Rate False False
of Change alarm is detected and enabled.
P_AR_ALM BOOL When TRUE, the primary Absolute Rate of False False
Change alarm is detected and enabled.
S_H_ALM BOOL When TRUE, the secondary High alarm is False False
detected and enabled.
S_L_ALM BOOL When TRUE, the secondary Low alarm is False False
detected and enabled.
S_HD_ALM BOOL When TRUE, the secondary High Deviation False False
alarm is detected and enabled.
S_LD_ALM BOOL When TRUE, the secondary Low Deviation False False
alarm is detected and enabled.
S_AD_ALM BOOL When TRUE, the secondary Absolute False False
Deviation alarm is detected and enabled.
S_OOR_ALM BOOL When TRUE, the secondary Out of Range False False
alarm is detected and enabled.
S_QUAL_ALM BOOL When TRUE, the secondary Quality Not False False
Good alarm is detected and enabled.
S_HH_ALM BOOL When TRUE, the secondary High High False False
alarm is detected and enabled.
S_LL_ALM BOOL When TRUE, the secondary Low Low alarm False False
is detected and enabled.
S_IR_ALM BOOL When TRUE, the secondary Increasing False False
Rate of Change alarm is detected and
enabled.
S_DR_ALM BOOL When TRUE, the secondary Decreasing False False
Rate of Change alarm is detected and
enabled.
S_AR_ALM BOOL When TRUE, the secondary Absolute Rate False False
of Change alarm is detected and enabled.
S_VL_EUMIN_OUT REAL Copy of secondary VL_EUMIN Input 0 False
S_VL_EUMAX_OUT REAL Copy of secondary VL_EUMAX Input 0 False

Note
The P_SP and S_SP outputs in APACS+ have been converted to P_SP_OUT and
S_SP_OUT, respectively. They are used to interconnect the set-point value to other entities
on a chart. The OS interaction is handled by the P_SP and S_SP InOut parameters.
The hidden S_ESP output was also added to support OS interaction. The S_ESP output is
driven by the primary PID's OUT output.
Alarm outputs have been added for each analog alarm type.

APACS+ ES Library User's Guide for V7.1


50 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

Input/output

Name Data Type Explanation Initial OC&M Valid Values


CASC BOOL Cascade mode False True
AUTO BOOL Auto/manual mode control False True
P_SP REAL Computer set point value 0 True
P_RAMP BOOL SP ramping on/off mode control False True
P_R_TIME TIME Ramp time T#0MS True 0 to
24d20h31m23s647ms
P_SPL REAL Set point low limit 0 True
P_SPH REAL Set point high limit 100 True
P_R_RATE REAL Ramp rate (in engineering units per 0 True
min)
P_USE_RR BOOL Ramp mode control. Use RTIME or False True
RRATE to control ramp
P_PV_TRACK BOOL Internal setpoint tracking control. True True
When Track, internal setpoint tracks
PV
P_PG REAL Proportional Gain 0.001 True 0.001 to 100.0
P_TI REAL Time-Integral Minutes per Reset 4000 True 0.0 to 4000.0
P_TD REAL Time-Derivative Minutes 0 True 0.00 to 100.0
P_DG REAL Derivative Gain 10 True 2.00 to 20.00
P_DIR BOOL Reverse or Direct action False True
P_ADAPTIVE_PG_ BOOL Adaptive Gain Init flag True False
INIT
P_PV_EUMIN REAL Engineering unit: Input, Low 0 True
P_PV_EUMAX REAL Engineering unit: Input, High 100 True
P_VL_EUMIN REAL Engineering unit: Output, Low 0 True
P_VL_EUMAX REAL Engineering unit: Output, High 100 True
P_H_LIM REAL The value (in engineering units) to 100 True
which the (P_PV) input is compared
for the High alarm.
P_H_DB REAL The amount of engineering units by 0.5 True
which (P_PV) must be within the limit
for the High alarm to clear.
P_H_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the High limit to trip 24d20h31m23s647ms
an alarm.
P_H_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the High limit and deadband to 24d20h31m23s647ms
cause the alarm to clear.
P_L_LIM REAL The value (in engineering units) to 0 True
which the (P_PV) input is compared
for the Low alarm.
P_L_DB REAL The amount of engineering units by 0.5 True
which (P_PV) must be within the limit
for the Low alarm to clear.

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 51
ES Library
1.2 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid Values


P_L_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the Low limit to trip 24d20h31m23s647ms
an alarm.
P_L_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the Low limit and deadband to 24d20h31m23s647ms
cause the alarm to clear.
P_HD_LIM REAL The value (in engineering units) to 0 True
which (P_PV) – (DEV) is compared
for the High Deviation alarm.
P_HD_DB REAL The amount of engineering units by 0.5 True
which (P_PV) – (DEV) must be within
the limit for the High Deviation alarm
to clear.
P_HD_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the High Deviation 24d20h31m23s647ms
limit to trip an alarm.
P_HD_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the High Deviation limit and 24d20h31m23s647ms
deadband to cause the alarm to
clear.
P_LD_LIM REAL The value (in engineering units) to 0 True
which (DEV) - (P_PV) is compared
for the Low Deviation alarm.
P_LD_DB REAL The amount of engineering units by 0.5 True
which (DEV) - (P_PV) must be within
the limit for the Low Deviation alarm
to clear.
P_LD_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the Low Deviation 24d20h31m23s647ms
limit to trip an alarm.
P_LD_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the Low Deviation limit and 24d20h31m23s647ms
deadband to cause the alarm to
clear.
P_AD_LIM REAL The value (in engineering units) to 100 True
which ABS((P_PV) – (DEV)) is
compared for the Absolute Deviation
alarm.
P_AD_DB REAL The amount of engineering units by 0.5 True
which ABS((P_PV) – (DEV)) must be
within the limit for the Absolute
Deviation alarm to clear.
P_AD_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the Absolute 24d20h31m23s647ms
Deviation limit to trip an alarm.
P_AD_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the Absolute Deviation limit 24d20h31m23s647ms
and deadband to cause the alarm to
clear.

APACS+ ES Library User's Guide for V7.1


52 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid Values


P_HH_LIM REAL The value (in engineering units) to 0 True
which the (P_PV) input is compared
for the High High alarm.
P_HH_DB REAL The amount of engineering units by 0.5 True
which (P_PV) must be within the limit
for the High High alarm to clear.
P_HH_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the High High limit to 24d20h31m23s647ms
trip an alarm.
P_HH_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the High High limit and 24d20h31m23s647ms
deadband to cause the alarm to
clear.
P_LL_LIM REAL The value (in engineering units) to 0 True
which the (P_PV) input is compared
for the Low Low alarm.
P_LL_DB REAL The amount of engineering units by 0.5 True
which (P_PV) must be within the limit
for the Low Low alarm to clear.
P_LL_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the Low Low limit to 24d20h31m23s647ms
trip an alarm.
P_LL_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the Low Low limit and 24d20h31m23s647ms
deadband to cause the alarm to
clear.
P_IR_LIM REAL The value (in engineering units per 0 True
minute) to which the (P_PV) input is
compared for the Increasing Rate of
Change alarm.
P_IR_DB REAL The amount of engineering units by 0.5 True
which (P_PV) must be within the limit
for the Increasing Rate of Change
alarm to clear.
P_IR_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the Increasing Rate 24d20h31m23s647ms
of Change limit to trip an alarm.
P_IR_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the Increasing Rate of Change 24d20h31m23s647ms
limit and deadband to cause the
alarm to clear.
P_DR_LIM REAL The value (in engineering units per 0 True
minute) to which the (P_PV) input is
compared for the Decreasing Rate of
Change alarm.
P_DR_DB REAL The amount of engineering units by 0.5 True
which (P_PV) must be within the limit
for the Decreasing Rate of Change
alarm to clear.

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 53
ES Library
1.2 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid Values


P_DR_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the Decreasing Rate 24d20h31m23s647ms
of Change limit to trip an alarm.
P_DR_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the Decreasing Rate of 24d20h31m23s647ms
Change limit and deadband to cause
the alarm to clear.
P_AR_LIM REAL The value (in engineering units per 0 True
minute) to which the (P_PV) input is
compared for the Absolute Rate of
Change alarm.
P_AR_DB REAL The amount of engineering units by 0.5 True
which (P_PV) must be within the limit
for the Absolute Rate of Change
alarm to clear.
P_AR_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the Absolute Rate of 24d20h31m23s647ms
Change limit to trip an alarm.
P_AR_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the Absolute Rate of Change 24d20h31m23s647ms
limit and deadband to cause the
alarm to clear.
P_OOR_DELAYIN TIME The amount of time the input must be T#0MS False 0 to
outside the limits EINH, EINL to trip 24d20h31m23s647ms
the Out of Range alarm.
P_OOR_DELAYOU TIME The amount of time the input must be T#0MS False 0 to
T within the limits EINH, EINL to cause 24d20h31m23s647ms
the Out of Range alarm to clear.
P_QUAL_DELAYIN TIME The amount of time the input quality T#0MS False 0 to
must be bad to trip the Quality Not 24d20h31m23s647ms
Good alarm.
P_QUAL_DELAYO TIME The amount of time the input quality T#0MS False 0 to
UT must be good to cause the Quality 24d20h31m23s647ms
Not Good alarm to clear.
P_DISABLE_ON_O BOOL When set to TRUE, the block is False False
OS disabled if (OOS) is also TRUE.
S_SP REAL Computer set point value 0 True
S_RAMP BOOL SP ramping on/off mode control False True
S_R_TIME TIME Ramp time T#0MS True 0 to
24d20h31m23s647ms
S_SPL REAL Set point low limit 0 True
S_SPH REAL Set point high limit 100 True
S_R_RATE REAL Ramp rate (in engineering units per 0 True
min)
S_USE_RR BOOL Ramp mode control. Use RTIME or False True
RRATE to control ramp
S_PV_TRACK BOOL Internal setpoint tracking control. True True
When Track, internal setpoint tracks
PV

APACS+ ES Library User's Guide for V7.1


54 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid Values


S_PG REAL Proportional Gain 0.001 True 0.001 to 100.0
S_TI REAL Time-Integral Minutes per Reset 4000 True 0.0 to 4000.0
S_TD REAL Time-Derivative Minutes 0 True 0.00 to 100.0
S_DG REAL Derivative Gain 10 True 2.00 to 20.00
S_DIR BOOL Reverse or Direct action False True
S_ADAPTIVE_PG_ BOOL Adaptive Gain Init flag True False
INIT
S_PV_EUMIN REAL Engineering unit: Input, Low 0 True
S_PV_EUMAX REAL Engineering unit: Input, High 100 True
S_VL_EUMIN REAL Engineering unit: Output, Low 0 True
S_VL_EUMAX REAL Engineering unit: Output, High 100 True
S_VL REAL Computer Output, typically written to 0 True
by an operator command
QC_OUT_IN BYTE Quality Code for output OUT 16#80 True Quality Codes (Page 11)
S_VLL REAL OUT low limit input -3.3 True
S_VLH REAL OUT high limit input 103.3 True
S_H_LIM REAL The value (in engineering units) to 100 True
which the (S_PV) input is compared
for the High alarm.
S_H_DB REAL The amount of engineering units by 0.5 True
which (S_PV) must be within the limit
for the High alarm to clear.
S_H_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the High limit to trip 24d20h31m23s647ms
an alarm.
S_H_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the High limit and deadband to 24d20h31m23s647ms
cause the alarm to clear.
S_L_LIM REAL The value (in engineering units) to 0 True
which the (S_PV) input is compared
for the Low alarm.
S_L_DB REAL The amount of engineering units by 0.5 True
which (S_PV) must be within the limit
for the Low alarm to clear.
S_L_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the Low limit to trip 24d20h31m23s647ms
an alarm.
S_L_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the Low limit and deadband to 24d20h31m23s647ms
cause the alarm to clear.
S_HD_LIM REAL The value (in engineering units) to 0 True
which (S_PV) – (DEV) is compared
for the High Deviation alarm.
S_HD_DB REAL The amount of engineering units by 0.5 True
which (S_PV) – (DEV) must be within
the limit for the High Deviation alarm
to clear.

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 55
ES Library
1.2 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid Values


S_HD_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the High Deviation 24d20h31m23s647ms
limit to trip an alarm.
S_HD_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the High Deviation limit and 24d20h31m23s647ms
deadband to cause the alarm to
clear.
S_LD_LIM REAL The value (in engineering units) to 0 True
which (DEV) - (S_PV) is compared
for the Low Deviation alarm.
S_LD_DB REAL The amount of engineering units by 0.5 True
which (DEV) - (S_PV) must be within
the limit for the Low Deviation alarm
to clear.
S_LD_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the Low Deviation 24d20h31m23s647ms
limit to trip an alarm.
S_LD_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the Low Deviation limit and 24d20h31m23s647ms
deadband to cause the alarm to
clear.
S_AD_LIM REAL The value (in engineering units) to 100 True
which ABS((S_PV) – (DEV)) is
compared for the Absolute Deviation
alarm.
S_AD_DB REAL The amount of engineering units by 0.5 True
which ABS((S_PV) – (DEV)) must be
within the limit for the Absolute
Deviation alarm to clear.
S_AD_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the Absolute 24d20h31m23s647ms
Deviation limit to trip an alarm.
S_AD_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the Absolute Deviation limit 24d20h31m23s647ms
and deadband to cause the alarm to
clear.
S_HH_LIM REAL The value (in engineering units) to 0 True
which the (S_PV) input is compared
for the High High alarm.
S_HH_DB REAL The amount of engineering units by 0.5 True
which (S_PV) must be within the limit
for the High High alarm to clear.
S_HH_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the High High limit to 24d20h31m23s647ms
trip an alarm.
S_HH_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the High High limit and 24d20h31m23s647ms
deadband to cause the alarm to
clear.

APACS+ ES Library User's Guide for V7.1


56 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid Values


S_LL_LIM REAL The value (in engineering units) to 0 True
which the (S_PV) input is compared
for the Low Low alarm.
S_LL_DB REAL The amount of engineering units by 0.5 True
which (S_PV) must be within the limit
for the Low Low alarm to clear.
S_LL_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the Low Low limit to 24d20h31m23s647ms
trip an alarm.
S_LL_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the Low Low limit and 24d20h31m23s647ms
deadband to cause the alarm to
clear.
S_IR_LIM REAL The value (in engineering units per 0 True
minute) to which the (S_PV) input is
compared for the Increasing Rate of
Change alarm.
S_IR_DB REAL The amount of engineering units by 0.5 True
which (S_PV) must be within the limit
for the Increasing Rate of Change
alarm to clear.
S_IR_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the Increasing Rate 24d20h31m23s647ms
of Change limit to trip an alarm.
S_IR_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the Increasing Rate of Change 24d20h31m23s647ms
limit and deadband to cause the
alarm to clear.
S_DR_LIM REAL The value (in engineering units per 0 True
minute) to which the (S_PV) input is
compared for the Decreasing Rate of
Change alarm.
S_DR_DB REAL The amount of engineering units by 0.5 True
which (S_PV) must be within the limit
for the Decreasing Rate of Change
alarm to clear.
S_DR_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the Decreasing Rate 24d20h31m23s647ms
of Change limit to trip an alarm.
S_DR_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the Decreasing Rate of 24d20h31m23s647ms
Change limit and deadband to cause
the alarm to clear.
S_AR_LIM REAL The value (in engineering units per 0 True
minute) to which the (S_PV) input is
compared for the Absolute Rate of
Change alarm.
S_AR_DB REAL The amount of engineering units by 0.5 True
which (S_PV) must be within the limit
for the Absolute Rate of Change
alarm to clear.

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 57
ES Library
1.2 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid Values


S_AR_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the Absolute Rate of 24d20h31m23s647ms
Change limit to trip an alarm.
S_AR_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the Absolute Rate of Change 24d20h31m23s647ms
limit and deadband to cause the
alarm to clear.
S_OOR_DELAYIN TIME The amount of time the input must be T#0MS False 0 to
outside the limits EINH, EINL to trip 24d20h31m23s647ms
the Out of Range alarm.
S_OOR_DELAYOU TIME The amount of time the input must be T#0MS False 0 to
T within the limits EINH, EINL to cause 24d20h31m23s647ms
the Out of Range alarm to clear.
S_QUAL_DELAYIN TIME The amount of time the input quality T#0MS False 0 to
must be bad to trip the Quality Not 24d20h31m23s647ms
Good alarm.
S_QUAL_DELAYO TIME The amount of time the input quality T#0MS False 0 to
UT must be good to cause the Quality 24d20h31m23s647ms
Not Good alarm to clear.
S_DISABLE_ON_O BOOL When set to TRUE, the block is False False
OS disabled if (OOS) is also TRUE.

See also
CASCADE: Cascade Controller (Page 41)

1.2.9 DALM_AFB

1.2.9.1 DALM_AFB: Discrete Alarm

Function Block Name DALM_AFB


Function Block Number FB504

Function
The Discrete Alarm Function Block (DALM_AFB) is intended for detecting and signaling
abnormal discrete data values. This block is used to detect the discrete states (TRUE or
FALSE) of up to eight inputs. When an alarm state is detected, an ALM output value and the
corresponding NAK output value are set to TRUE. Once the alarm has been acknowledged,
the NAK output value is set to FALSE. A given ALM output value is FALSE when its alarm
state does not match the corresponding IN input value.
The Out-Of-Service (OOS) output value indicates to monitoring devices when the alarm
block has been put in the Out-Of-Service state.

APACS+ ES Library User's Guide for V7.1


58 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

Calling OBs and Start-up


Calling OBs
This block is called in the watchdog interrupt OB into which the block is installed (for
example, OB32).
Start-up Characteristics
This function block has no special startup properties.

Operator Control and Monitoring (M&C Relevant)


There is no associated faceplate for this block.

Message Characteristics

Assignment of message texts and message class to the block parameters

Note
During runtime, the string $$BlockComment$$ will be replaced by the comment for the FB
instance that is in alarm.

Message # Message Class Default Message Text


1 PLC Process Control Message - Failure DISCRETE - $$BlockComment$$
2 PLC Process Control Message - Failure DISCRETE - $$BlockComment$$
3 PLC Process Control Message - Failure DISCRETE - $$BlockComment$$
4 PLC Process Control Message - Failure DISCRETE - $$BlockComment$$
5 PLC Process Control Message - Failure DISCRETE - $$BlockComment$$
6 PLC Process Control Message - Failure DISCRETE - $$BlockComment$$
7 PLC Process Control Message - Failure DISCRETE - $$BlockComment$$
8 PLC Process Control Message - Failure DISCRETE - $$BlockComment$$

Assignment of auxiliary process values to the block parameters

Value Block Parameter


@1%s@ BA_NA
@2%d@ BA_ID
@3%d@ STEP_NO

See also
DALM_AFB Input Output (Page 60)

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 59
ES Library
1.2 Library Function Blocks

1.2.9.2 DALM_AFB Input Output

Input

Name Data Type Explanation Initial OC&M Valid Values


IN1 BOOL This is the value to be monitored for alarm1. False True
EN1 BOOL When TRUE, alarm1 is enabled. False True
IN2 BOOL This is the value to be monitored for alarm2. False False
EN2 BOOL When TRUE, alarm2 is enabled. False False
IN3 BOOL This is the value to be monitored for alarm3. False False
EN3 BOOL When TRUE, alarm3 is enabled. False False
IN4 BOOL This is the value to be monitored for alarm4. False False
EN4 BOOL When TRUE, alarm4 is enabled. False False
IN5 BOOL This is the value to be monitored for alarm5. False False
EN5 BOOL When TRUE, alarm5 is enabled. False False
IN6 BOOL This is the value to be monitored for alarm6. False False
EN6 BOOL When TRUE, alarm6 is enabled. False False
IN7 BOOL This is the value to be monitored for alarm7. False False
EN7 BOOL When TRUE, alarm7 is enabled False False
IN8 BOOL This is the value to be monitored for alarm8. False False
EN8 BOOL When TRUE, alarm8 is enabled. False False
OOS BOOL Out-Of-Sevice indicator. False True
EV_ID DWORD Event ID – This value is a unique message None False
number supplied by PCS 7. There is one for
each message (i.e. ALARM_8P) block called.
BA_NA STRING[32] Batch name '' False
BA_ID DWORD Batch ID number 0 False
STEP_NO DWORD Batch step number 0 False

Note
This list differs from the inputs of the DALM_AFB block in APACS+ as follows:
• There are now eight inputs and enables.
• Only the first alarm's input and enable will be visible, so that the block will look like the
APACS+ HLLDA1 block.
• The parameter EV_ID was added to support the message system.
• Batch parameters BA_NA, BA_ID, STEP_NO are added to pass batch values in alarm
messages.

APACS+ ES Library User's Guide for V7.1


60 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

Output

Name Data Type Explanation Initial OC&M Valid Values


ALM1 BOOL When TRUE, alarm1 is detected and enabled. False False
NAK1 BOOL When TRUE, alarm1 alarm is tripped but not False False
acknowledged.
ALM2 BOOL When TRUE, alarm2 is detected and enabled. False False
NAK2 BOOL When TRUE, alarm2 is tripped but not False False
acknowledged.
ALM3 BOOL When TRUE, alarm3 is detected and enabled. False False
NAK3 BOOL When TRUE, alarm3 is tripped but not False False
acknowledged.
ALM4 BOOL When TRUE, alarm4 is detected and enabled. False False
NAK4 BOOL When TRUE, alarm4 is tripped but not False False
acknowledged.
ALM5 BOOL When TRUE, alarm5 is detected and enabled. False False
NAK5 BOOL When TRUE, alarm5 is tripped but not False False
acknowledged.
ALM6 BOOL When TRUE, alarm6 is detected and enabled. False False
NAK6 BOOL When TRUE, alarm6 is tripped but not False False
acknowledged.
ALM7 BOOL When TRUE, alarm7 is detected and enabled. False False
NAK7 BOOL When TRUE, alarm7 is tripped but not False False
acknowledged.
ALM8 BOOL When TRUE, alarm8 is detected and enabled. False False
NAK8 BOOL When TRUE, alarm8 is tripped but not False False
acknowledged.
MSG_ERR BOOL ALARM_8P error False False
MSG_STAT WORD ALARM_8P status False W#16#0

Note
This list differs from the outputs of the DALM_AFB block in APACS+ as follows:
• There are now eight alarms and NAKs.
• Only the first alarm's output and NAK are visible. This makes the block look similar to the
APACS+ HLLDA1 block.
• The STATUS and CMD outputs have been removed.
• MSG_ERR and MSG_STAT have been added to provide the status of the message
processing. For specific values, see the online help for ALARM_8P.

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 61
ES Library
1.2 Library Function Blocks

Input/output

Name Data Explanation Initial OC&M Valid Values


Type
ALARM1_LIMIT BOOL The value to which the IN1 False True
value is compared for
alarm1.
ALARM1_DELAYIN TIME The amount of time the T#0d0h0m0s0ms False
input must remain at the
limit to trip alarm1.
ALARM1_DELAYOUT TIME The amount of time the T#0d0h0m0s0ms False
input must remain not at the
limit to cause alarm1 to
clear.
ALARM2_LIMIT BOOL The value to which IN2 is False False
compared for alarm2.
ALARM2_DELAYIN TIME The amount of time the T#0d0h0m0s0ms False
input must remain at the
limit to trip alarm2.
ALARM2_DELAYOUT TIME The amount of time the iput T#0d0h0m0s0ms False
must remain not at the limit
to cause alarm2 to clear.
ALARM3_LIMIT BOOL The value to which the IN3 False False
is compared for alarm3.
ALARM3_DELAYIN TIME The amount of time the T#0d0h0m0s0ms False
input must remain at the
limit to trip alarm3.
ALARM3_DELAYOUT TIME The amount of time the T#0d0h0m0s0ms False
input must remain not at the
limit to cause alarm3 to
clear.
ALARM4_LIMIT BOOL The value to which IN4 is False False
compared for alarm4.
ALARM4_DELAYIN TIME The amount of time the T#0d0h0m0s0ms False
input must remain at the
limit to trip alarm4.
ALARM4_DELAYOUT TIME The amount of time the T#0d0h0m0s0ms False
input must remain not at the
limit to cause alarm4 to
clear.
ALARM5_LIMIT BOOL The value to which IN5 is False False
compared for alarm5.
ALARM5_DELAYIN TIME The amount of time the T#0d0h0m0s0ms False
input must remain at the
limit to trip alarm5.
ALARM5_DELAYOUT TIME The amount of time the T#0d0h0m0s0ms False
input must remain not at the
limit to cause alarm5 to
clear.
ALARM6_LIMIT BOOL The value to which IN6 is False False
compared for alarm6.

APACS+ ES Library User's Guide for V7.1


62 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

Name Data Explanation Initial OC&M Valid Values


Type
ALARM6_DELAYIN TIME The amount of time the T#0d0h0m0s0ms False
input must remain at the
limit to trip alarm6.
ALARM6_DELAYOUT TIME The amount of time the T#0d0h0m0s0ms False
input must remain not at the
limit to cause alarm6 to
clear.
ALARM7_LIMIT BOOL The value to which IN7 is False False
compared for alarm7.
ALARM7_DELAYIN TIME The amount of time the T#0d0h0m0s0ms False
input must remain at the
limit to trip alarm7.
ALARM7_DELAYOUT TIME The amount of time the T#0d0h0m0s0ms False
input must remain not at the
limit to cause alarm7 to
clear.
ALARM8_LIMIT BOOL The value to which IN8 is False False
compared for alarm8.
ALARM8_DELAYIN TIME The amount of time the T#0d0h0m0s0ms False
input must remain at the
limit to trip alarm8.
ALARM8_DELAYOUT TIME The amount of time the T#0d0h0m0s0ms False
input must remain not at the
limit to cause alarm8 to
clear.
DISABLE_ON_OOS BOOL When set to TRUE, the False
block is disabled if (OOS) is
also TRUE.

Note
This list differs from the softlist parameters of the DALM_AFB block in APACS+ as follows:
• The PCS 7 OS provides a ringback mechanism, so the ringback parameters have been
removed.
• There are now eight LIMIT, DELAYIN, and DELAYOUT parameters.

See also
DALM_AFB: Discrete Alarm (Page 58)

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 63
ES Library
1.2 Library Function Blocks

1.2.10 DISCRETE_ALM_BLK

1.2.10.1 DISCRETE_ALM_BLK

Function Block Name DISCRETE_ALM_BLK


(compiled version of the Chart)
Function Block Number FB604
Chart Name DISCRETE_ALM
See also, Template Chart DISCRETE_ALM_AT
(usage example)

Function
The Discrete Alarm (DISCRETE_ALM_BLK) block is a factory-compiled function block. It is
intended for use as a discrete indicator with alarm. The ALARM output provides the alarm
status of the block. The block signals an alarm on the HMI when the discrete input (DIN) is in
an undesired state.

Calling OBs and Start-up


Calling OBs
This block is called in the watchdog interrupt OB into which the block is installed (for
example, OB32).
Start-up Characteristics
This function block has no special startup properties.

Operator Control and Monitoring (M&C Relevant)


See Faceplate Information AALM_AFB

Message Characteristics

Assignment of message texts and message class to the block parameters

Note
During runtime, the string $$BlockComment$$ will be replaced by the comment for the FB
instance that is in alarm.

Message # Message Class Message_class Default Message Text


1 PLC Process Control Message - Failure DISCRETE - $$BlockComment$$

APACS+ ES Library User's Guide for V7.1


64 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

Assignment of auxiliary process values to the block parameters

Value Block Parameter


@1%s@ BA_NA
@2%d@ BA_ID
@3%d@ STEP_NO

See also
DISCRETE_ALM_BLK Input Output (Page 65)

1.2.10.2 DISCRETE_ALM_BLK Input Output

Input

Name Data Type Explanation Initial OC&M Valid Values


DIN BOOL The discrete False True
parameter being
monitored.
QC_DIN BYTE Quality Code for 16#80 True Quality
DIN Codes
(Page 11)
ENABLE BOOL Enable Alarm 1 True True
OOS BOOL Out of Service False True
Indicator
EV_ID DWORD Event ID Compiler generated False
for the type, N/A for
the chart
BA_EN BOOL Batch enabled False True
OCCUPIED BOOL Batch occupied False True
BA_ID DWORD Batch ID number 0 True
STEP_NO DWORD Batch step 0 True
number
BA_NA STRING[32] Batch name '' True
ConfirmChange BOOL If TRUE changes False True
from HMI must be
confirmed

Note
The APACS+ list only includes the DI input. Other inputs are hidden from view, so that from
a user perspective, the DISCRETE_ALM_BLK looks like its APACS+ counterpart. The DI
input was changed to DIN for compatibility with the HMI.

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 65
ES Library
1.2 Library Function Blocks

Output

Name Data Type Explanation Initial OC&M Valid Values


ALARM BOOL Alarm 1 False False

Input/output

Name Data Type Explanation Initial OC&M Valid


Values
LIM BOOL Alarm Limit False True
DELAYIN TIME Into Alarm Delay Time T#0d0h0m0s0ms False
DELAYOUT TIME Out of Alarm Delay Time T#0d0h0m0s0ms False
DISABLE_ON_OOS BOOL Disable on Out of Service False False

See also
DISCRETE_ALM_BLK (Page 64)

1.2.11 EXT_SET_BLK

1.2.11.1 EXT_SET: External Setpoint Controller

Function Block Name EXT_SET_BLK


(compiled version of the Chart)
Function Block Number FB605
Chart Name EXT_SET
See also, Template Chart EXT_SET_AT
(usage example)

Function
The External Setpoint Controller (EXT_SET_BLK) block is a factory-compiled function block.
It is intended for use as an external-set PID controller with tracking setpoint. High and low
alarms are provided for the process variable. Another alarm is provided to detect absolute
deviation between the process variable and setpoint.
EXT_SET_BLK is a compiled version of the EXT_SET source chart. Within the chart, there is
a control loop that contains SETPNT_AFB, PID_AFB, and AM_AFB blocks along with
alarming logic.
The SETPOINT block supplies the setpoint [SP_OUT] to the CONTROLLER block. The
SETPOINT block has a ramping feature for internal mode (EXT=FALSE). In external mode
(EXT=TRUE), the external setpoint [ESP] becomes the controller setpoint, and the
SETPOINT block's internal setpoint (ISP) tracks the external setpoint, thereby ensuring no

APACS+ ES Library User's Guide for V7.1


66 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

change in setpoint during transition to internal mode. The setpoint tracks the process
variable [PV] in manual mode (AUTO=FALSE).
The CONTROLLER block is a PID block. It operates in auto mode (AUTO=TRUE) and tracks
the downstream output [OUT] in manual mode (AUTO=FALSE). The AUTO_MANUAL block
provides manual control of the output. In auto mode the CONTROLLER block output
becomes the loop output [OUT]. In manual mode the AUTO_MANUAL block internal output
IOUT becomes the loop output.

Calling OBs and Start-up


Calling OBs
This block is called in the watchdog interrupt OB into which the block is installed (for
example, OB32). Additionally, it is called in OB100 and in OB102 (see Start-up
Characteristics).
Start-up Characteristics
On a warm restart, OB100 is called and parameters retain the values they had immediately
before the restart. On a cold restart, OB102 is called and parameters are initialized with the
last downloaded values.
The warm and cold startup behavior of AUTO, SP, EXT, and OUT is configurable, allowing
the user to override the default PCS 7 behavior described above if necessary. As delivered,
AUTO will be forced to "Manual" EXT will be forced to "Internal" and OUT will be forced to
0.0 on a CPU restart. SP will be set in accordance with default PCS 7 behavior.
To force the AUTO parameter to a specified value on a restart, set the RSTRT_AUTO_FLAG
to true ("Force AUTO") and configure RSTRT_AUTO_VALUE with the desired forced value
("Auto" or "Manual"). The RSTRT_AUTO_VALUE will be used to initialize AUTO, if and only
if the RSTRT_AUTO_FLAG is true. If RSTRT_AUTO_FLAG is set to false ("Default"), the
AUTO parameter will be set in accordance with default PCS 7 behavior.
To force the SP parameter to a specified value on a restart, set the RSTRT_SP_FLAG to
true ("Force SP") and configure RSTRT_SP_VALUE with the desired forced value. The
RSTRT_SP_VALUE will be used to initialize SP, if and only if the RSTRT_SP_FLAG is true
and the block restarts in Auto mode (AUTO="Auto"). If RSTRT_SP_FLAG is set to false
("Default"), the SP parameter will be set in accordance with default PCS 7 behavior.
To force the EXT parameter to a specified value on a restart, set the RSTRT_EXT_FLAG to
true ("Force EXT") and configure RSTRT_EXT_VALUE with the desired forced value
("Internal or External"). The RSTRT_EXT_VALUE will be used to initialize EXT, if and only if
the RSTRT_EXT_FLAG is true. If RSTRT_EXT_FLAG is set to false ("Default"), the EXT
parameter will be set in accordance with default PCS 7 behavior. Forcing the EXT parameter
to "External" will cause the SP to be set to the ESP, thereby overriding the SP restart
parameter settings.
To force the OUT parameter to a specified value on a restart, set the RSTRT_OUT_FLAG to
true ("Force OUT") and configure RSTRT_OUT_VALUE with the desired forced value. The
RSTRT_OUT_VALUE will be used to initialize OUT, if and only if the RSTRT_OUT_FLAG is
true and the block restarts in Manual mode (AUTO = "Manual"). If RSTRT_OUT_FLAG is set
to false ("Default"), the OUT parameter will be set in accordance with default PCS 7
behavior.

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 67
ES Library
1.2 Library Function Blocks

WARNING
Using "Default" for the RSTRT_OUT_FLAG could result in your output device retaining its
last operating state after a restart. Similarly, using "Default" for the RSTRT_AUTO_FLAG
could result in your process running in automatic mode after a restart. Use "Forced" for the
restart flags and configure the associated restart values to ensure a known restart state.

If restart parameter values are changed offline, the configuration must be compiled (changes
only) and downloaded (changes only) to the controller in order for the settings to take effect
upon restart. If restart parameter values are changed online (via CFC Test mode), the
configuration must be compiled (entire program) and downloaded (entire program) to the
controller in order for the settings to take effect upon cold restart. This step is not necessary
for the online changes to take effect upon a warm restart.

Operator Control and Monitoring (M&C Relevant)


See Faceplate Information

Message Characteristics

Assignment of message texts and message class to the block parameters

Note
During runtime, the string $$BlockComment$$ will be replaced by the comment for the FB
instance that is in alarm.

ALARM_8P ID Message # Message Class Default Message Text


Message_class
EV_ID 1 Warning - above HIGH - $$BlockComment$$ - Limit = @4%f@
EV_ID 2 Warning - below LOW - $$BlockComment$$ - Limit = @5%f@
EV_ID 3 Alarm - above HIGH_DEV - $$BlockComment$$ - Limit = @6%f@
EV_ID 4 Alarm - below LOW_DEV - $$BlockComment$$ - Limit = @7%f@
EV_ID 5 Alarm - above ABSOLUTE_DEV - $$BlockComment$$ - Limit = @8%f@
EV_ID 6 PLC Process OUT_OF_RANGE - $$BlockComment$$
Control Message -
Failure
EV_ID 7 PLC Process QUALITY_NOT_GOOD - $$BlockComment$$
Control Message -
Failure
EV_ID2 1 Alarm - above HIGH_ HIGH - $$BlockComment$$ - Limit = @4%f@
EV_ID2 2 Alarm - below LOW_ LOW - $$BlockComment$$ - Limit = @5%f@
EV_ID2 3 Warning - above INC_ROC - $$BlockComment$$ - Limit = @6%f@

APACS+ ES Library User's Guide for V7.1


68 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

ALARM_8P ID Message # Message Class Default Message Text


Message_class
EV_ID2 4 Warning - below DEC_ROC - $$BlockComment$$ - Limit = @7%f@
EV_ID2 5 Warning - above ABS_ROC - $$BlockComment$$ - Limit = @8%f@

Assignment of auxiliary process values to the block parameters

ALARM_8P ID Value Block Parameter


EV_ID @1%s@ BA_NA
EV_ID @2%d@ BA_ID
EV_ID @3%d@ STEP_NO
EV_ID @4%f@ H_LIM
EV_ID @5%f@ L_LIM
EV_ID @6%f@ HD_LIM
EV_ID @7%f@ LD_LIM
EV_ID @8%f@ AD_LIM
EV_ID2 @1%s@ BA_NA
EV_ID2 @2%d@ BA_ID
EV_ID2 @3%d@ STEP_NO
EV_ID2 @4%f@ HH_LIM
EV_ID2 @5%f@ LL_LIM
EV_ID2 @6%f@ IR_LIM
EV_ID2 @7%f@ DR_LIM
EV_ID2 @8%f@ AR_LIM

See also
EXT_SET_BLK Input Output (Page 69)

1.2.11.2 EXT_SET_BLK Input Output

Input

Name Data Type Explanation Initial OC&M Valid Values


PV REAL Process Variable 0 True
QC_PV BYTE Quality Code for PV 16#80 True Quality Codes
(Page 11)
TSP REAL SP target value for 0 True
SP ramping
H_EN BOOL Enable High Alarm True True
L_EN BOOL Enable Low Alarm True True
HD_EN BOOL Enable High False True
Deviation Alarm

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 69
ES Library
1.2 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid Values


LD_EN BOOL Enable Low False True
Deviation Alarm
AD_EN BOOL Enable Absolute True True
Deviation Alarm
OOR_EN BOOL Enable Out of False True
Range Alarm
QUAL_EN BOOL Enable Quality Not False True
Good Alarm
HH_EN BOOL Enable High High False True
Alarm
LL_EN BOOL Enable Low Low False True
Alarm
IR_EN BOOL Enable Increasing False True
Rate of Change
Alarm
DR_EN BOOL Enable Decreasing False True
Rate of Change
Alarm
AR_EN BOOL Enable Absolute False True
Rate of Change
Alarm
OOS BOOL Out of Service False True
indicator
QBAD BOOL Bad quality indicator False False
EV_ID DWORD Event ID Compiler False
generated for the
type or N/A if used
as chart *
EV_ID2 DWORD Event ID Compiler False
generated for the
type or N/A if used
as chart *
ESP REAL External set point 0 True
SAMPLE_T REAL Current scan rate Compiler False
supplied by OS generated for the
type or N/A if used
as chart *
RSTRT_AUTO_FLAG BOOL Default: Retain on True False
WS, Use load value
on CS. Force: Use
RSTRT_AUTO_VAL
UE on restart
RSTRT_AUTO_VALUE BOOL Init restart value for False False
Auto Mode if
RSTRT_AUTO_FLA
G true

APACS+ ES Library User's Guide for V7.1


70 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid Values


RSTRT_EXT_FLAG BOOL Default: Retain on True False
WS, Use load value
on CS. Force: Use
RSTRT_EXT_VALU
E on restart
RSTRT_EXT_VALUE BOOL Init restart value for False False
EXTernal if
RSTRT_EXT_FLAG
true
RSTRT_SP_FLAG BOOL Default: Retain on False False
WS, Use load value
on CS. Force: Use
RSTRT_SP_VALUE
on restart.
RSTRT_SP_VALUE REAL Init restart value for 0 False
SP if
RSTRT_SP_FLAG
true and Auto mode.
RSTRT_OUT_FLAG BOOL Default: Retain on True False
WS, Use load value
on CS. Force: Use
RSTRT_OUT_VALU
E on restart.
RSTRT_OUT_VALUE REAL Init restart value for 0 False
OUT if
RSTRT_OUT_FLAG
true and manual
mode
BA_EN BOOL Batch enabled False True
OCCUPIED BOOL Batch occupied False True
BA_ID DWORD Batch ID number 0 True
BA_NA STRING[32] Batch name '' True
STEP_NO DWORD Batch step number 0 True
DecimalPlacesPV INT Decimal places 2 True
displayed in HMI for
PV, SP etc.
DecimalPlacesOUT INT Decimal places 2 True
displayed in HMI for
OUT, OUT Limits
ConfirmChange BOOL If TRUE changes False True
from HMI must be
confirmed
LIOP_MAN_SEL BOOL Select 0 False
AUTO/MANUAL:
1 = Linking, 0 =
Operator active
AUT_L BOOL Linkable input for 0 False
AUTO/MANUAL
mode, 1 = AUTO

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 71
ES Library
1.2 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid Values


LIOP_EXT_SEL BOOL Select 0 False
External/Internal SP
flag: 1 = from Link, 0
= from Operator
EXTRNL_L BOOL Linkable input to 0 False
select
External/Internal SP
flag, 1=Extrnl
LIOP_ ISP_SEL BOOL Select internal SP: 1 0 False
= from Link, 0 = from
Operator
SP_L REAL Linkable input for 0.0 False
internal Setpoint
LIOP_OUT_SEL BOOL Select writing to 0 False
OUT: 1 = from Link,
0 = from Operator
OUT_L REAL Linkable input to be 0.0 False
written to OUT

Note
This list differs significantly from the inputs of the EXT_SET_BLK block in APACS+, since the
APACS+ list includes only the PV input and ESP (actually named EXT_SP in APACS+)
input.
*The Update Sampling Time option must be checked when compiling a chart that contains
the EXT_SET_BLK for these values to be automatically generated by the compiler.

Input parameters added for PCS 7 V6.1 include:


● Batch parameters BA_EN, OCCUPIED are added to support future batch faceplate view.
● Batch parameters BA_NA, BA_ID, STEP_NO are added to pass batch values in alarm
messages.
● DecimalPlacesPV, DecimalPlacesOUT added to control the number of displayed decimal
places in HMI.
● ConfirmChange added to give APACS users expected feel of "one-step" operator entry.
● LIOP_MAN_SEL and AUT_L provide a linkable connection for the program to set AUTO,
without using SET_VAL.
● LIOP_ISP_SEL and SP_L provide a linkable connection for the program to set internal
Setpoint, without using SET_VAL.
● LIOP_OUT_SEL and OUT_L provide a linkable connection for the program to set OUT,
without using SET_VAL.
● LIOP_EXT_SEL and EXTRNL_L provide a linkable connection for the program to set
External Setpoint mode, without using SET_VAL.

APACS+ ES Library User's Guide for V7.1


72 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

Output

Name Data Explanation Initial OC&M Valid Values


Type
SP_OUT REAL Calculated set point value 0 False
OUT REAL Calculated output variable that has been limited 0 False
QC_OUT BYTE Quality Code for output OUT 16#80 True Quality
Codes
(Page 11)
ALARM BOOL Alarm Status False False
H_ALM BOOL When TRUE, the High alarm is detected and False False
enabled.
L_ALM BOOL When TRUE, the Low alarm is detected and False False
enabled.
HD_ALM BOOL When TRUE, the High Deviation alarm is False False
detected and enabled.
LD_ALM BOOL When TRUE, the Low Deviation alarm is False False
detected and enabled.
AD_ALM BOOL When TRUE, the Absolute Deviation alarm is False False
detected and enabled.
OOR_ALM BOOL When TRUE, the Out of Range alarm is detected False False
and enabled.
QUAL_ALM BOOL When TRUE, the Quality Not Good alarm is False False
detected and enabled.
HH_ALM BOOL When TRUE, the High High alarm is detected False False
and enabled.
LL_ALM BOOL When TRUE, the Low Low alarm is detected and False False
enabled.
IR_ALM BOOL When TRUE, the Increasing Rate of Change False False
alarm is detected and enabled.
DR_ALM BOOL When TRUE, the Decreasing Rate of Change False False
alarm is detected and enabled.
AR_ALM BOOL When TRUE, the Absolute Rate of Change alarm False False
is detected and enabled.
VL_EUMIN_OUT REAL Copy of Engineering unit: Output, Low 0 False
VL_EUMAX_OUT REAL Copy of Engineering unit: Output, High 0 False

Note
The APACS+ SP output was renamed to SP_OUT to avoid conflict with the newly added SP
In/Out parameter. SP_OUT is used to interconnect the set-point value to other entities on a
chart. The OS interaction is handled by the SP InOut parameter.

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 73
ES Library
1.2 Library Function Blocks

Input/output

Name Data Type Explanation Initial OC&M Valid Values


AUTO BOOL Auto/manual mode control False True
EXT BOOL External/internal mode control False True
SP REAL Computer set point value 0 True
RAMP BOOL SP ramping on/off mode control False True
R_TIME TIME Ramp time T#0MS True 0 to
24d20h31m23s647ms
SPL REAL Set point low limit 0 True
SPH REAL Set point high limit 100 True
R_RATE REAL Ramp rate (in engineering units per 0 True
min)
USE_RR BOOL Ramp mode control. Use RTIME or False True
RRATE to control ramp
PV_TRACK BOOL Internal setpoint tracking control. True True
When Track, internal setpoint tracks
PV
PG REAL Proportional Gain 0.001 True 0.001 to 100.0
TI REAL Time-Integral Minutes per Reset 4000 True 0.0 to 4000.0
TD REAL Time-Derivative Minutes 0 True 0.00 to 100.0
DG REAL Derivative Gain 10 True 2.00 to 20.00
DIR BOOL Reverse or Direct action False True
ADAPTIVE_PG_INIT BOOL Adaptive Gain Init flag False True
PV_EUMIN REAL Engineering unit: Input, Low 0 True
PV_EUMAX REAL Engineering unit: Input, High 100 True
VL_EUMIN REAL Engineering unit: Output, Low 0 True
VL_EUMAX REAL Engineering unit: Output, High 100 True
VL REAL Computer Output, typically written to 0 True
by an operator command
QC_OUT_IN BYTE Quality Code input for output OUT 16#80 True Quality Codes
(Page 11)
VLL REAL OUT low limit input -3.3 True
VLH REAL OUT high limit input 103.3 True
H_LIM REAL The value (in engineering units) to 100 True
which the (PV) input is compared for
the High alarm.
H_DB REAL The amount of engineering units by 0.5 True
which (PV) must be within the limit for
the High alarm to clear.
H_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the High limit to trip 24d20h31m23s647ms
an alarm.
H_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the High limit and deadband to 24d20h31m23s647ms
cause the alarm to clear.

APACS+ ES Library User's Guide for V7.1


74 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid Values


L_LIM REAL The value (in engineering units) to 0 True
which the (PV) input is compared for
the Low alarm.
L_DB REAL The amount of engineering units by 0.5 True
which (PV) must be within the limit for
the Low alarm to clear.
L_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the Low limit to trip 24d20h31m23s647ms
an alarm.
L_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the Low limit and deadband to 24d20h31m23s647ms
cause the alarm to clear.
HD_LIM REAL The value (in engineering units) to 0 True
which (PV) – (DEV) is compared for
the High Deviation alarm.
HD_DB REAL The amount of engineering units by 0.5 True
which (PV) – (DEV) must be within
the limit for the High Deviation alarm
to clear.
HD_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the High Deviation 24d20h31m23s647ms
limit to trip an alarm.
HD_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the High Deviation limit and 24d20h31m23s647ms
deadband to cause the alarm to clear.
LD_LIM REAL The value (in engineering units) to 0 True
which (DEV) - (PV) is compared for
the Low Deviation alarm.
LD_DB REAL The amount of engineering units by 0.5 True
which (DEV) - (PV) must be within the
limit for the Low Deviation alarm to
clear.
LD_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the Low Deviation 24d20h31m23s647ms
limit to trip an alarm.
LD_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the Low Deviation limit and 24d20h31m23s647ms
deadband to cause the alarm to clear.
AD_LIM REAL The value (in engineering units) to 100 True
which ABS((PV) – (DEV)) is
compared for the Absolute Deviation
alarm.
AD_DB REAL The amount of engineering units by 0.5 True
which ABS((PV) – (DEV)) must be
within the limit for the Absolute
Deviation alarm to clear.
AD_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the Absolute 24d20h31m23s647ms
Deviation limit to trip an alarm.

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 75
ES Library
1.2 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid Values


AD_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the Absolute Deviation limit and 24d20h31m23s647ms
deadband to cause the alarm to clear.
HH_LIM REAL The value (in engineering units) to 0 True
which the (PV) input is compared for
the High High alarm.
HH_DB REAL The amount of engineering units by 0.5 True
which (PV) must be within the limit for
the High High alarm to clear.
HH_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the High High limit to 24d20h31m23s647ms
trip an alarm.
HH_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the High High limit and 24d20h31m23s647ms
deadband to cause the alarm to clear.
LL_LIM REAL The value (in engineering units) to 0 True
which the (PV) input is compared for
the Low Low alarm.
LL_DB REAL The amount of engineering units by 0.5 True
which (PV) must be within the limit for
the Low Low alarm to clear.
LL_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the Low Low limit to 24d20h31m23s647ms
trip an alarm.
LL_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the Low Low limit and 24d20h31m23s647ms
deadband to cause the alarm to clear.
IR_LIM REAL The value (in engineering units per 0 True
minute) to which the (PV) input is
compared for the Increasing Rate of
Change alarm.
IR_DB REAL The amount of engineering units by 0.5 True
which (PV) must be within the limit for
the Increasing Rate of Change alarm
to clear.
IR_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the Increasing Rate 24d20h31m23s647ms
of Change limit to trip an alarm.
IR_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the Increasing Rate of Change 24d20h31m23s647ms
limit and deadband to cause the
alarm to clear.
DR_LIM REAL The value (in engineering units per 0 True
minute) to which the (PV) input is
compared for the Decreasing Rate of
Change alarm.
DR_DB REAL The amount of engineering units by 0.5 True
which (PV) must be within the limit for
the Decreasing Rate of Change alarm
to clear.

APACS+ ES Library User's Guide for V7.1


76 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid Values


DR_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the Decreasing Rate 24d20h31m23s647ms
of Change limit to trip an alarm.
DR_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the Decreasing Rate of Change 24d20h31m23s647ms
limit and deadband to cause the
alarm to clear.
AR_LIM REAL The value (in engineering units per 0 True
minute) to which the (PV) input is
compared for the Absolute Rate of
Change alarm.
AR_DB REAL The amount of engineering units by 0.5 True
which (PV) must be within the limit for
the Absolute Rate of Change alarm to
clear.
AR_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the Absolute Rate of 24d20h31m23s647ms
Change limit to trip an alarm.
AR_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the Absolute Rate of Change 24d20h31m23s647ms
limit and deadband to cause the
alarm to clear.
OOR_DELAYIN TIME The amount of time the input must be T#0MS False 0 to
outside the limits EINH, EINL to trip 24d20h31m23s647ms
the Out of Range alarm.
OOR_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the limits EINH, EINL to cause 24d20h31m23s647ms
the Out of Range alarm to clear.
QUAL_DELAYIN TIME The amount of time the input quality T#0MS False 0 to
must be bad to trip the Quality Not 24d20h31m23s647ms
Good alarm.
QUAL_DELAYOUT TIME The amount of time the input quality T#0MS False 0 to
must be good to cause the Quality 24d20h31m23s647ms
Not Good alarm to clear.
DISABLE_ON_OOS BOOL When set to TRUE, the block is False False
disabled if (OOS) is also TRUE.

See also
EXT_SET: External Setpoint Controller (Page 66)

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 77
ES Library
1.2 Library Function Blocks

1.2.12 MOTOR_A_BLK

1.2.12.1 MOTOR_A_BLK: Standard Motor

Function Block Name MOTOR_A_BLK


Function Block Number FB505

Function
The Standard Motor Function Block (MOTOR_A_BLK) provides standard motor start/stop
functions that can be easily interfaced to an operator station. This block is based on the
APACS+ MOTOR_A function block. This block can receive commands from programmed
logic, such as a sequential function chart (SFC) while in automatic mode, or it can receive
operator-entered commands from an operator interface while in manual mode.
The PROOF input receives the state of the motor (TRUE = running and FALSE = stopped).
The OUT output sets the state of the motor (TRUE = running and FALSE = stop).
The AUTO parameter indicates the auto/manual state. This state can be changed external to
the block. It can also be changed by the block itself, depending on In/Out parameters. When
the block is in manual mode (AUTO = FALSE), commands to the block are received via a
write of TRUE to the START or STOP In/Out parameters. The block automatically resets
these values after receiving the command. When the block is in auto mode (AUTO = TRUE),
commands to the block are received via the A_STRT and A_STOP inputs. Since auto mode
is intended for use with commands sent by an SFC, there are some In/Out settings that
accommodate this use:
● When AUTO_TRACK is TRUE, the AUTO mode tracks the MODE input (intended to be
the mode of the SFC), such that AUTO is set TRUE when MODE becomes TRUE.
● If MODE_HOLD_AUTO is TRUE, AUTO is held TRUE as long as MODE is TRUE. When
FALSE, the AUTO value is set when the MODE input value is TRUE, but can then be
manually changed.
● If ACCEPT_ANY_AUTO is TRUE, AUTO is set TRUE whenever the A_STRT (Automatic
Start) or A_STOP (Automatic Stop) input changes state.
When in auto mode, the positive transition of A_STOP (POS_TRANS_ASTOP) value
determines the function of the A_STRT and A_STOP inputs. If the POS_TRANS_ASTOP is
TRUE, the commands need to be FALSE-to-TRUE transitions for both the A_STRT and
A_STOP inputs. Unlike the START and STOP command values, the A_STRT and A_STOP
input values must be reset external to the block. If POS_TRANS_ASTOP value is FALSE,
the same value should be placed on both the A_STRT and A_STOP inputs so that a FALSE-
to-TRUE transition sends a start command and a TRUE-to-FALSE transition sends a stop
command. To avoid the need to generate such a transition for these commands when
POS_TRANS_ASTOP is FALSE, the AUTO_TRANS_REQ value can be set FALSE. The
A_STRT input (with the same value on the A_STOP input) is used as the desired state of the
motor (TRUE = running, FALSE = stop).
There are many permissive/interlock features built into this block. The PERMIT input, if
configured, must be TRUE to permit any start command to take effect. The block has 11
interlock inputs (INT01 ... INT11), but only the first two are visible by default. All of the
configured interlock inputs must be TRUE for the motor to start or remain running; the
INTRLK (Interlock) output value indicates whether all configured interlock inputs are TRUE.
The OVERRD (Override) value represents the override status: when TRUE, any FALSE

APACS+ ES Library User's Guide for V7.1


78 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

interlocks (or permit) are overridden, the INTRLK value is set TRUE, and the motor is
allowed to run. OVERRD may be enabled by a tag write from outside the block. For display
at an HMI, there are In/Out values that hold descriptors for the permit (PERMIT) and the
interlock (INT01...INT11) inputs.
This block contains failure-checking features that set the FAIL value to TRUE when a
problem is detected. The detected problems include:
● Failure to start before the STRT_T has expired
● Failure to stop before the STOP_T has expired
● Loss of proof
● Uncommanded stop due to loss of an interlock (enabled by setting the FAIL_ON_INTRLK
value to TRUE)
● Rejected start command due to missing permissive or interlock (checking for this failure is
always enabled when MODE = TRUE and for all conditions by setting the
FAIL_ON_STRT_CMD value to TRUE.)
The FAIL value is set TRUE when a fail condition is detected. It remains TRUE until it is
reset by a tag write from outside of the block (by acknowledge logic or an operator
command). When FAIL is TRUE, the OUT output value is held FALSE. The ALARM_STATE
value, an integer, is provided to indicate the specific failure condition that occurred.
The READY output indicates that the motor is ready to receive auto commands, where
TRUE indicates that the motor is in auto mode and the interlocks are not overridden. The
STATE output is an integer value that represents the various states of the motor.
The MOTOR_A_BLK supports alarming. An alarm message will be generated if the FAIL
parameter becomes TRUE. In APACS+, this functionality was not part of the MOTOR_A
block, but was instead handled by ProcessSuite.

Interlock Configuration
The Interlock parameters are not extensible as they were in 4-mation. In the PCS 7
implementation of this block, all of the Interlocks exist with only the first two visible by default.
If more than two interlocks are required, each additional interlock must be made visible.
For each required interlock, configure the following:
● Connect a boolean interlock condition to the Interlock input.
● Configure the description so that it is no longer null ("). If the description is left as a null,
the faceplate will not display the status for this interlock. The faceplate is designed to hide
an interlock condition when the interlock description is null.

Calling OBs and Start-up


Calling OBs
This block is called in the watchdog interrupt OB into which the block is installed (for
example, OB32). Additionally, it is called in OB100 and in OB102 (see Start-up
Characteristics).
Start-up Characteristics
On a warm restart, OB100 is called and parameters retain the values they had immediately
before the restart. On a cold restart, OB102 is called and parameters are initialized with the
last downloaded values.

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 79
ES Library
1.2 Library Function Blocks

The warm and cold startup behavior of AUTO and OUT is configurable, allowing the user to
override the default PCS 7 behavior described above if necessary. As delivered, AUTO will
be forced to "Manual" and OUT will be forced to "False" on a CPU restart.
To force the AUTO parameter to a specified value on a restart, set the RSTRT_AUTO_FLAG
to true ("Force AUTO") and configure RSTRT_AUTO_VALUE with the desired forced value
("Auto" or "Manual"). The RSTRT_AUTO_VALUE will be used to initialize AUTO, if and only
if the RSTRT_AUTO_FLAG is true. If RSTRT_AUTO_FLAG is set to false ("Default"), the
AUTO parameter will be set in accordance with default PCS 7 behavior.
To force the OUT parameter to a specified value on a restart, set the RSTRT_OUT_FLAG to
true ("Force OUT") and configure RSTRT_OUT_VALUE with the desired forced value ("True"
or "False"). The RSTRT_OUT_VALUE will be used to initialize OUT, if and only if the
RSTRT_OUT_FLAG is true. If RSTRT_OUT_FLAG is set to false ("Default"), the OUT
parameter will be set in accordance with default PCS 7 behavior.

WARNING
Using "Default" for the RSTRT_OUT_FLAG could result in your output device retaining its
last operating state after a restart. Similarly, using "Default" for the RSTRT_AUTO_FLAG
could result in your process running in automatic mode after a restart. Use "Forced" for the
restart flags and configure the associated restart values to ensure a known restart state.

If restart parameter values are changed offline, the configuration must be compiled (changes
only) and downloaded (changes only) to the controller in order for the settings to take effect
upon restart. If restart parameter values are changed online (via CFC Test mode), the
configuration must be compiled (entire program) and downloaded (entire program) to the
controller in order for the settings to take effect upon cold restart. This step is not necessary
for the online changes to take effect upon a warm restart.

Operator Control and Monitoring (M&C Relevant)


See Faceplate Information

Message Characteristics

Assignment of message texts and message class to the block parameters

Note
During runtime, the string $$BlockComment$$ will be replaced by the comment for the FB
instance that is in alarm.

Message # Message Class Default Message Text


1 PLC Process Control Message - Failure Motor Feedback Failure - $$BlockComment$$

APACS+ ES Library User's Guide for V7.1


80 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

Assignment of auxiliary process values to the block parameters

Value Block Parameter


@1%s@ BA_NA
@2%d@ BA_ID
@3%d@ STEP_NO

See also
MOTOR_A_BLK Input Output (Page 81)

1.2.12.2 MOTOR_A_BLK Input Output

Input

Name Data Type Explanation Initial OC&M Valid Values


PROOF BOOL Running status feedback False True
signal from the motor
QC_PROOF BYTE Quality Code for PROOF 16#80 True See Quality Codes
(Page 11)
A_STRT BOOL Automatic Start command False False
input
A_STOP BOOL Automatic Stop command False False
input
PERMIT BOOL Permitted to Start input True True
MODE BOOL Mode input from of a False False
sequential function chart.
0=Manual, 1=Auto
INT01 BOOL Interlock 1 True True
INT02 BOOL Interlock 2 True True
INT03 BOOL Interlock 3 True True
INT04 BOOL Interlock 4 True True
INT05 BOOL Interlock 5 True True
INT06 BOOL Interlock 6 True True
INT07 BOOL Interlock 7 True True
INT08 BOOL Interlock 8 True True
INT09 BOOL Interlock 9 True True
INT10 BOOL Interlock 10 True True
INT11 BOOL Interlock 11 True True
RSTRT_AUTO_FLAG BOOL Default: Retain on WS, Use True False
load val on CS. Force: Use
RSTRT_AUTO_VALUE on
restart

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 81
ES Library
1.2 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid Values


RSTRT_AUTO_VALUE BOOL Init restart value for Auto False False
Mode if
RSTRT_AUTO_FLAG true
RSTRT_OUT_FLAG BOOL Default: Retain on WS, Use True False
load val on CS. Force: Use
RSTRT_OUT_VALUE on
restart
RSTRT_OUT_VALUE BOOL Init restart value for OUT if False False
RSTRT_OUT_FLAG
PERMIT_DESC STRING[32] Permit Description '' True
INT01_DESC STRING[32] Interlock 1 Description '' True
INT02_DESC STRING[32] Interlock 2 Description '' True
INT03_DESC STRING[32] Interlock 3 Description '' True
INT04_DESC STRING[32] Interlock 4 Description '' True
INT05_DESC STRING[32] Interlock 5 Description '' True
INT06_DESC STRING[32] Interlock 6 Description '' True
INT07_DESC STRING[32] Interlock 7 Description '' True
INT08_DESC STRING[32] Interlock 8 Description '' True
INT09_DESC STRING[32] Interlock 9 Description '' True
INT10_DESC STRING[32] Interlock 10 Description '' True
INT11_DESC STRING[32] Interlock 11 Description '' True
EV_ID DWORD Event ID (Compiler False
generated)
LIOP_MAN_SEL BOOL Select AUTO/MANUAL: False False
1 = Linking, 0 = Operator
active
AUT_L BOOL Linkable input for False False
AUTO/MANUAL mode, 1 =
AUTO
BA_EN BOOL Batch enabled False True
OCCUPIED BOOL Batch occupied False True
BA_ID DWORD Batch ID number 0 True
STEP_NO DWORD Batch step number 0 True
BA_NA STRING[32] Batch name '' True
ConfirmChange BOOL If TRUE changes from HMI False True
must be confirmed
QC_OUT_IN BYTE Quality Code input for 16#80 True See Quality Codes
output OUT (Page 11)

APACS+ ES Library User's Guide for V7.1


82 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

Note
This list differs from the inputs of the MOTOR_A_AFB block in APACS+ as follows:
• Each input shown above with datatype STRING was a softlist parameter in APACS+.
• The INT01_DESC through INT09_DESC have slightly different names than their APACS+
counterparts. In APACS+ a leading zero was excluded, making the names INT1_DESC
through INT9_DESC.
• EV_ID parameter is a new input and is required for the PCS 7 version to support
alarming. This parameter did not exist in APACS+.
• Restart parameters (RSTRT_... ) did not exist in APACS+.
• LIOP_MAN_SEL and AUT_L added to provide alternate for SET_VAL function.
• Batch parameters BA_EN, OCCUPIED are added to support future batch faceplate view.
• Batch parameters BA_NA, BA_ID, STEP_NO are added to pass batch values in alarm
messages.
• ConfirmChange added to give APACS+ users expected feel of "one-step" operator entry

Output

Name Data Type Explanation Initial OC&M Valid Values


OUT BOOL The block's Output that is used to False True
ultimately control the motor.
QC_OUT BYTE Quality Code for output OUT 16#80 True See Quality
Codes (Page 11)
ALARM BOOL Indicates when the motor is in alarm. False False
INTRLK BOOL Interlock OK output False True
READY BOOL Ready output False False
STATE INT State of the motor 0 False
ALARM_STATE INT Alarm state 0 False

Note
This list differs from the outputs of the MOTOR_A_AFB block in APACS+ as follows:
• FAIL and AUTO and OVERRD have been moved to In/Out in PCS 7.
• ALARM_STATE is a new output. In APACS+, it was a softlist parameter.
• ALARM is a new output and is present to support the alarming functionality. This output
along with the alarm functionality did not exist in APACS+.
• INTRLK nub is named INT_OK in APACS+. The ProcessSuite name "INTRLK" was
preferred.

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 83
ES Library
1.2 Library Function Blocks

Integer Values for Motor State

VALUE STATE FAIL OVERRD PROOF OUT INTRLK &


PERMIT
0 Undefined - - - - -
1 Transition False False < >OUT < >PROOF True
2 Stopped False False False False True
3 Running False False True True -
4 Stopped and Fail True - False - -
5 Running and Fail True - True - -
6 Stopped and Override False True False - -
7 Running and Override False True True - -
8 Stopped and Interlock not OK False False False False False
"<>" means "not equal to"
"-" means "don't care"

Integer Values for Motor Alarm (Failure) State

Value State Status


0 OK No alarm
1 Failed to Start PROOF value not reset in time after OUT value was set TRUE
2 Failed to Stop PROOF value went FALSE while OUT value remained TRUE
3 Loss of PROOF PROOF value went FALSE while OUT value remained TRUE
4 Inappropriate PROOF PROOF value went TRUE while OUT value remained FALSE
5 Uncommanded Stop INTRLK value went FALSE while OUT value was TRUE, causing OUT to
be SET FALSE
6 Rejected Start Command INTRLK or PERMIT value was FALSE when a start command was
issued

Input/output

Name Data Type Explanation Initial OC&M Valid Values


FAIL BOOL Indicates whether motor has fault False True
condition
AUTO BOOL Auto mode output False True
OVERRD BOOL Override output False True
AUTO_TRACK BOOL If true, block is set to auto mode False False
when SFC transitions to AUTO
(MODE becomes "True").
MODE_HOLD_AUTO BOOL Indicates whether block held in auto False False
mode while MODE is "True"
ACCEPT_ANY_AUTO BOOL When true, block is set to auto when False False
A_STRT or A_STOP changes state

APACS+ ES Library User's Guide for V7.1


84 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid Values


POS_TRANS_ASTOP BOOL Indicates whether a positive True False
transition is required to stop the
motor
AUTO_TRANS_REQ BOOL When true the A_STRT and A_STOP True False
inputs need to change state to issue
start/stop
FAIL_ON_INTRLK BOOL Fail on interlock. When TRUE and False False
the loss of an interlock stops the
motor (ie. Uncommanded stop), the
FAIL status is set TRUE, and the
ALARM_STATE parameter is set to
its appropriate valve.
FAIL_ON_STRT_CMD BOOL Fail on start command. When TRUE False False
and a start command is rejected due
to the interlocks of permissive, the
FAIL status is set TRUE and the
ALARM_STATE is set to its
appropriate value.
START BOOL Start command value for manual False True
mode
STOP BOOL Stop command value for manual False True
mode
STRT_T TIME Maximum time allowed to start the T#10S True
motor
STOP_T TIME Maximum time allowed to stop the T#10S True
motor
A1EN BOOL Alarm 1 Enable True True
A1LIM BOOL Alarm 1 Limit True False
A1DELAYIN TIME Into Alarm 1 Delay Time T#0MS False 0 to
24d20h31m23s
647ms
A1DELAYOUT TIME Out of Alarm 1 Delay Time T#0MS False 0 to
24d20h31m23s
647ms
OOS BOOL Out of Service indicator False True
DISABLE_ON_OOS BOOL Disable on Out of Service False False

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 85
ES Library
1.2 Library Function Blocks

Note
This list differs from the softlist parameters of the MOTOR_A_AFB block in APACS+ as
follows:
• FAIL, AUTO, and OVERRD which were outputs in APACS+, have been moved to In/Out
in PCS 7. This is necessary to allow writes from the HMI.
• ALARM_STATE was moved to Output.
• The PT_DESC parameter has been eliminated. Instead, the Comment property of the
block is being used to contain the point description information. This is because the
faceplate will automatically display the information provided in the Comment field..
• INT01_DESC through INT10_DESC and PERMIT_DESC have been moved to Inputs.
• STRT_T and STOP_T are named START_T and STOP_T in APACS+. The ProcessSuite
names STRT_T and STOP_T are preferred.
• The following alarm parameters are new: A1EN, A1LIM, A1DELAYIN, A1DELAYOUT,
OOS, DISABLE_ON_OOS. These are needed to support the alarming functionality.

See also
MOTOR_A_BLK: Standard Motor (Page 78)

1.2.13 MOTOR_A_ALM_BLK

1.2.13.1 MOTOR_A_ALM: Motor with Alarm

Function Block Name MOTOR_A_ALM_BLK


(compiled version of the Chart)
Function Block Number FB613
Chart Name MOTOR_A_ALM
See also, Template Chart MOTOR_A_ALM_AT
(usage example)

Function
This block provides standard motor start/stop equipment module functions (similar to the
MOTOR_1OUT). Device alarming functions are provided by this block.
This factory-compiled block is an encapsulation of the MOTOR_A_BLK block with a discrete
alarm block. To provide thorough alarm reporting, the alarm state value of the
MOTOR_A_BLK block is used to create separate alarms for the following conditions:
● Failure to start (or loss of proof)
● Failure to stop (or unexpected proof)
● Uncommanded stop or rejected start command (due to interlock)

APACS+ ES Library User's Guide for V7.1


86 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

The latched fail state of the MOTOR_A_BLK block is unlatched automatically when the alarm
is acknowledged.
The parameters are generally identically to those of the MOTOR_A_BLK block. See
MOTOR_A_BLK for more details and a complete description of the functionality of this block.

Calling OBs and Start-up


Calling OBs
This block is called in the watchdog interrupt OB into which the block is installed (for
example, OB32). Additionally, it is called in OB100 and in OB102 (see Start-up
Characteristics).
Start-up Characteristics
On a warm restart, OB100 is called and parameters retain the values they had immediately
before the restart. On a cold restart, OB102 is called and parameters are initialized with the
last downloaded values.
The warm and cold startup behavior of AUTO and OUT is configurable, allowing the user to
override the default PCS 7 behavior described above if necessary. As delivered, AUTO will
be forced to "Manual" and OUT will be forced to "False" on a CPU restart.
To force the AUTO parameter to a specified value on a restart, set the RSTRT_AUTO_FLAG
to true ("Force AUTO") and configure RSTRT_AUTO_VALUE with the desired forced value
("Auto" or "Manual"). The RSTRT_AUTO_VALUE will be used to initialize AUTO, if and only
if the RSTRT_AUTO_FLAG is true. If RSTRT_AUTO_FLAG is set to false ("Default"), the
AUTO parameter will be set in accordance with default PCS 7 behavior.
To force the OUT parameter to a specified value on a restart, set the RSTRT_OUT_FLAG to
true ("Force OUT") and configure RSTRT_OUT_VALUE with the desired forced value ("True"
or "False"). The RSTRT_OUT_VALUE will be used to initialize OUT, if and only if the
RSTRT_OUT_FLAG is true. If RSTRT_OUT_FLAG is set to false ("Default"), the OUT
parameter will be set in accordance with default PCS 7 behavior.

WARNING
Using "Default" for the RSTRT_OUT_FLAG could result in your output device retaining its
last operating state after a restart. Similarly, using "Default" for the RSTRT_AUTO_FLAG
could result in your process running in automatic mode after a restart. Use "Forced" for the
restart flags and configure the associated restart values to ensure a known restart state.

If restart parameter values are changed offline, the configuration must be compiled (changes
only) and downloaded (changes only) to the controller in order for the settings to take effect
upon restart. If restart parameter values are changed online (via CFC Test mode), the
configuration must be compiled (entire program) and downloaded (entire program) to the
controller in order for the settings to take effect upon cold restart. This step is not necessary
for the online changes to take effect upon a warm restart.

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 87
ES Library
1.2 Library Function Blocks

Interlock Configuration
All of the Interlocks for this block are visible by default. For each required interlock, configure
the following:
● Connect a boolean interlock condition to the Interlock input.
● Configure the description so that it is no longer null ("). If the description is left as a null,
the faceplate will not display the status for this interlock. The faceplate is designed to hide
an interlock condition when the interlock description is null.

Operator Control and Monitoring (M&C Relevant)


See Faceplate Information

Message Characteristics

Assignment of message texts and message class to the block parameters

Note
During runtime, the string $$BlockComment$$ will be replaced by the comment for the FB
instance that is in alarm.

Message # Message Class Message_class Default Message Text


1 PLC Process Control Message - Failure Failure to start - $$BlockComment$$
2 PLC Process Control Message - Failure Failure to stop - $$BlockComment$$
3 PLC Process Control Message - Failure Uncommanded stop or rejected start command (due to
interlock) - $$BlockComment$$

Assignment of auxiliary process values to the block parameters

Value Block Parameter


@1%s@ BA_NA
@2%d@ BA_ID
@3%d@ STEP_NO

See also
MOTOR_A_ALM_BLK Input Output (Page 89)

APACS+ ES Library User's Guide for V7.1


88 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

1.2.13.2 MOTOR_A_ALM_BLK Input Output

Input

Name Data Type Explanation Initial OC&M Valid Values


PROOF BOOL Running status False True
feedback signal from
the motor
QC_PROOF BYTE Quality Code for 16#80 True See Quality Codes
PROOF (Page 11)
A_STOP BOOL Automatic Stop False False
command input
PERMIT BOOL Permitted to Start input True True
MODE BOOL Mode input from of a False False
sequential function
chart
INT01 BOOL Interlock 1 True True
INT02 BOOL Interlock 2 True True
INT03 BOOL Interlock 3 True True
INT04 BOOL Interlock 4 True True
INT05 BOOL Interlock 5 True True
INT06 BOOL Interlock 6 True True
INT07 BOOL Interlock 7 True True
INT08 BOOL Interlock 8 True True
INT09 BOOL Interlock 9 True True
INT10 BOOL Interlock 10 True True
INT11 BOOL Interlock 11 True True
PERMIT_DESC STRING[32] Permit Description '' True
INT01_DESC STRING[32] Interlock 1 Description '' True
INT02_DESC STRING[32] Interlock 2 Description '' True
INT03_DESC STRING[32] Interlock 3 Description '' True
INT04_DESC STRING[32] Interlock 4 Description '' True
INT05_DESC STRING[32] Interlock 5 Description '' True
INT06_DESC STRING[32] Interlock 6 Description '' True
INT07_DESC STRING[32] Interlock 7 Description '' True
INT08_DESC STRING[32] Interlock 8 Description '' True
INT09_DESC STRING[32] Interlock 9 Description '' True
INT10_DESC STRING[32] Interlock 10 Description '' True
INT11_DESC STRING[32] Interlock 11 Description '' True
A1EN BOOL Enable Alarm 1 True True
A2EN BOOL Enable Alarm 2 True True
A3EN BOOL Enable Alarm 3 True True
A4EN BOOL Enable Alarm 4 False True
OOS BOOL Out of Service indicator False True

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 89
ES Library
1.2 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid Values


EV_ID DWORD Event ID Compiler False
generated for
the type or
N/A if used as
chart *
RSTRT_AUTO_FLAG BOOL Default retain on WS, False True
Use load val on CS.
Force: Use
RSTRT_AUTO_VALUE
on restart
RSTRT_AUTO_VALUE BOOL Init restart value for False False
Auto Mode if
RSTRT_AUTO_FLAG
true
RSTRT_OUT_FLAG BOOL Default retain on WS, False True
Use load val on CS.
Force: Use
RSTRT_AUTO_VALUE
on restart
RSTRT_OUT_VALUE BOOL Init restart value for False False
OUT if
RSTRT_OUT_FLAG
true
BA_EN BOOL Batch enabled False True
OCCUPIED BOOL Batch occupied False True
BA_ID DWORD Batch ID number 0 True
BA_NA STRING[32] Batch name '' True
STEP_NO DWORD Batch step number 0 True
ConfirmChange BOOL If TRUE changes from False True
HMI must be confirmed
LIOP_MAN_SEL BOOL Select False False
AUTO/MANUAL:
1 = Linking, 0 =
Operator active
AUT_L BOOL Linkable input for False False
AUTO/MANUAL mode,
1 = AUTO
QC_OUT_IN BYTE Quality Code input for 16#80 True See Quality Codes
output OUT (Page 11)

Output

Name Data Type Explanation Initial OC&M Valid Values


OUT BOOL Output used to ultimately control the motor False True
QC_OUT BYTE Quality Code for output OUT 16#80 True Quality Codes
(Page 11)
INTRLK BOOL Interlock OK output False True
READY BOOL Ready output False False

APACS+ ES Library User's Guide for V7.1


90 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid Values


STATE INT State of the motor 0 False
ALARM_STATE INT Alarm state 0 False
ALM1 BOOL Alarm 1 False False
ALM2 BOOL Alarm 2 False False
ALM3 BOOL Alarm 3 False False
ALM4 BOOL Alarm 4 False False

Input/output

Name Data Type Explanation Initial OC&M Valid Values


FAIL BOOL Indicates whether motor has fault False True
condition
AUTO BOOL Auto mode output False True
OVERRD BOOL Override output False True
START BOOL Start command value for manual mode False True
STOP BOOL Stop command value for manual mode False True
STRT_T TIME Maximum time required to start the T#10S True
motor
STOP_T TIME Maximum time required to stop the T#10S True
motor
AUTO_TRACK BOOL If true, block is set to auto mode when False False
SFC transitions to AUTO
MODE_HOLD_AUTO BOOL Indicates whether block held in auto False False
mode
ACCEPT_ANY_AUTO BOOL When true, block is set to auto when False False
A_S TRT or A_STOP changes state
POS_TRANS_ASTOP BOOL Indicates whether a positive transition is False False
required to stop the motor
AUTO_TRANS_REQ BOOL When true the A_STRT and A_STOP False False
inputs need to change state to issue
start/stop
FAIL_ON_INTRLK BOOL Fail on interlock True False
FAIL_ON_STRT_CMD BOOL Fail on start command True False
A1LIM BOOL Alarm 1 Limit True False
A1DELAYIN TIME Into Alarm 1 Delay Time T#0MS False 0 to
24d20h31m
23s647ms
A1DELAYOUT TIME Out of Alarm 1 Delay Time T#0MS False 0 to
24d20h31m
23s647ms
A2LIM BOOL Alarm 2 Limit True False
A2DELAYIN TIME Into Alarm 2 Del ay Time T#0MS False 0 to
24d20h31m
23s647ms

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 91
ES Library
1.2 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid Values


A2DELAYOUT TIME Out of Alarm 2 Delay Time T#0MS False 0 to
24d20h31m
23s647ms
A3LIM BOOL Alarm 3 Limit True False
A3DELAYIN TIME Into Alarm 3 Delay Time T#0MS False 0 to
24d20h31m
23s647ms
A3DELAYOUT TIME Out of Alarm 3 Delay Time T#0MS False 0 to
24d20h31m
23s647ms
A4LIM BOOL Alarm 4 Limit True False
A4DELAYIN TIME Into Alarm 4 Delay Time T#0MS False 0 to
24d20h31m
23s647ms
A4DELAYOUT TIME Out of Alarm 4 Delay Time T#0MS False 0 to
24d20h31m
23s647ms
DISABLE_ON_OOS BOOL Disable on Out of Service False False

See also
MOTOR_A_ALM: Motor with Alarm (Page 86)

1.2.14 MOTOR_1OUT_BLK

1.2.14.1 MOTOR_1OUT: Motor with One Output

Function Block Name MOTOR_1OUT_BLK


(compiled version of the Chart)
Function Block Number FB606
Chart Name MOTOR_1OUT
See also, Template Chart MOTOR_1OUT_AT
(usage example)

Function
The Motor with One Output (MOTOR_1OUT) is intended for use as a start/stop motor with
one output. The block is designed for a motor with auto/manual operation, pulse commands,
and interlocking. An alarm is provided for failure to reach the desired state.
The [A_STRT] and [A_STOP] inputs are intended to input command pulses from a
sequence. The local variable AUTO determines the source of the start/stop commands. In
auto mode (AUTO=TRUE) the auto parameters [A_STRT] and [A_STOP] are active, and in
manual mode (AUTO=FALSE) the parameters START and STOP are active. START, STOP,

APACS+ ES Library User's Guide for V7.1


92 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

and AUTO are to be manipulated via the operator interface. START and STOP are to be set
TRUE; they are reset automatically.
A positive transition of auto start [A_STRT] or manual start [START] (depending on the
mode) latches the output [OUT]. Interlock [INTRLK] must be TRUE to allow the latch. A
positive transition of auto stop [A_STOP] or manual stop STOP (also mode-dependent)
unlatches the output. The start and stop timers determine if the motor has failed to reach its
desired state, and the failure output [FAIL] will become TRUE accordingly, which triggers the
alarm.
Although the MOTOR_1_OUT block was implemented in ladder logic in APACS, it has been
implemented in SCL in PCS 7 due to differences between APACS+ and PCS 7 ladder logic.
The MOTOR_1OUT is a logical and functional equivalent to the corresponding APACS+
ladder networks. Comments in the provided SCL source code relate elements in the SCL
code to corresponding elements in the original APACS+ ladder network.

Calling OBs and Start-up


Calling OBs
This block is called in the watchdog interrupt OB into which the block is installed (for
example, OB32). Additionally, it is called in OB100 and in OB102 (see Start-up
Characteristics).
Start-up Characteristics
On a warm restart, OB100 is called and parameters retain the values they had immediately
before the restart. On a cold restart, OB102 is called and parameters are initialized with the
last downloaded values.
The warm and cold startup behavior of AUTO and OUT is configurable, allowing the user to
override the default PCS 7 behavior described above if necessary. As delivered, AUTO will
be forced to "Manual" and OUT will be forced to "False" on a CPU restart.
To force the AUTO parameter to a specified value on a restart, set the RSTRT_AUTO_FLAG
to true ("Force AUTO") and configure RSTRT_AUTO_VALUE with the desired forced value
("Auto" or "Manual"). The RSTRT_AUTO_VALUE will be used to initialize AUTO, if and only
if the RSTRT_AUTO_FLAG is true. If RSTRT_AUTO_FLAG is set to false ("Default"), the
AUTO parameter will be set in accordance with default PCS 7 behavior.
To force the OUT parameter to a specified value on a restart, set the RSTRT_OUT_FLAG to
true ("Force OUT") and configure RSTRT_OUT_VALUE with the desired forced value ("True"
or "False"). The RSTRT_OUT_VALUE will be used to initialize OUT, if and only if the
RSTRT_OUT_FLAG is true. If RSTRT_OUT_FLAG is set to false ("Default"), the OUT
parameter will be set in accordance with default PCS 7 behavior.

WARNING
Using "Default" for the RSTRT_OUT_FLAG could result in your output device retaining its
last operating state after a restart. Similarly, using "Default" for the RSTRT_AUTO_FLAG
could result in your process running in automatic mode after a restart. Use "Forced" for the
restart flags and configure the associated restart values to ensure a known restart state.

If restart parameter values are changed offline, the configuration must be compiled (changes
only) and downloaded (changes only) to the controller in order for the settings to take effect
upon restart. If restart parameter values are changed online (via CFC Test mode), the
configuration must be compiled (entire program) and downloaded (entire program) to the

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 93
ES Library
1.2 Library Function Blocks

controller in order for the settings to take effect upon cold restart. This step is not necessary
for the online changes to take effect upon a warm restart.

Operator Control and Monitoring (M&C Relevant)


See Faceplate Information

Message Characteristics

Assignment of message texts and message class to the block parameters

Note
During runtime, the string $$BlockComment$$ will be replaced by the comment for the FB
instance that is in alarm.

Message # Message Class Message_class Default Message Text


1 PLC Process Control Message - Failure Motor Feedback Failure - $$BlockComment$$

Assignment of auxiliary process values to the block parameters

Value Block Parameter


@1%s@ BA_NA
@2%d@ BA_ID
@3%d@ STEP_NO

See also
MOTOR_1OUT_BLK Input Output (Page 94)

1.2.14.2 MOTOR_1OUT_BLK Input Output

Input

Name Data Type Explanation Initial OC&M Valid Values


PROOF BOOL PROOF is used as False True
feedback to confirm that
the motor is running
QC_PROOF BYTE Quality Code for 16#80 True See Quality
PROOF Codes
(Page 11)

APACS+ ES Library User's Guide for V7.1


94 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid Values


A_STRT BOOL A_STRT is intended to False False
allow internal logic to
automatically start the
motor
A_STOP BOOL A_STOP is intended to False False
allow internal logic to
automatically stop the
motor
INTRLK BOOL INTRLK forbids False True
activation of the motor
SAMPLE_T REAL Sample time (in 0.1 False
seconds)
RSTRT_AUTO_FLAG BOOL Default retain on WS, False True
Use load val on CS.
Force: Use
RSTRT_AUTO_VALUE
on restart
RSTRT_AUTO_VALUE BOOL Init restart value for False False
Auto Mode if
RSTRT_AUTO_FLAG
true
RSTRT_OUT_FLAG BOOL Default retain on WS, False True
Use load val on CS.
Force: Use
RSTRT_AUTO_VALUE
on restart
RSTRT_OUT_VALUE BOOL Init restart value for False False
OUT if
RSTRT_OUT_FLAG
true
EV_ID DWORD Event ID Compiler False
generated
LIOP_MAN_SEL BOOL Select AUTO/MANUAL: False False
1 = Linking, 0 =
Operator active
AUT_L BOOL Linkable input for False False
AUTO/MANUAL mode,
1 = AUTO
BA_EN BOOL Batch enabled False True
OCCUPIED BOOL Batch occupied False True
BA_ID DWORD Batch ID number 0 True
BA_NA STRING[32] Batch name '' True
STEP_NO DWORD Batch step number 0 True
ConfirmChange BOOL If TRUE changes from False True
HMI must be confirmed
QC_OUT_IN BYTE Quality Code input for 16#80 True Quality Codes
output OUT (Page 11)

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 95
ES Library
1.2 Library Function Blocks

Note
This list differs from the inputs of the MOTOR_1OUT_BLK block in APACS+ as follows:
• Restart parameters (RSTRT_...) did not exist in APACS+.
• EV_ID and SAMPLE_T did not exist in APACS+.

Output

Name Data Type Explanation Initial OC&M Valid Values


OUT BOOL OUT is used to actuate the motor False True
QC_OUT BYTE Quality Code output for OUT 16#80 True Quality Codes
(Page 11)
ALARM BOOL ALARM is used to signal internal logic when False False
the Motor is in alarm
FAIL BOOL FAIL motor failed to start or stop after a False True
start or stop request
START_FAIL BOOL START_FAIL is used to indicate if the motor False False
failed to start

Input/output

Name Data Type Explanation Initial OC&M Valid Values


AUTO BOOL AUTO set auto mode (use A_STRT, False True
A_STOP) vs manual mode (use
START, STOP)
A1EN BOOL A1EN is used to enable /disable the True True
internal alarm
A1LIM BOOL Alarm 1 limit True False
A1DELAYIN TIME Into alarm 1 delay time T#0MS False 0 to
24d20h31m23s647ms
A1DELAYOUT TIME Out of alarm 1 delay time T#0MS False 0 to
24d20h31m23s647ms
OOS BOOL OOS is used to signal that the internal False True
alarm is Out Of Service
DISABLE_ON_OOS BOOL Disable on Out of Service False False
START BOOL START is used to start the motor False True
when in Manual mode (AUTO=false)
STOP BOOL STOP is used to stop the motor when False True
in Manual mode (AUTO=false)
STRT_T TIME START_TIME sets time limit for T#10S True
PROOF to go true
STOP_T TIME STOP_TIME sets time limit for PROOF T#10S True
to go false

APACS+ ES Library User's Guide for V7.1


96 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

See also
MOTOR_1OUT: Motor with One Output (Page 92)

1.2.15 MOTOR_2OUT_BLK

1.2.15.1 MOTOR_2OUT: Motor with Two Outputs

Function Block Name MOTOR_2OUT_BLK


(compiled version of the Chart)
Function Block Number FB607
Chart Name MOTOR_2OUT
See also, Template Chart MOTOR_2OUT_AT
(usage example)

Function
The Motor with Two Outputs (MOTOR_2OUT) block is intended for use as a start/stop motor
with a start output and a stop output. The block is designed for a motor with auto/manual
operation, pulse commands, and interlocking. An alarm is provided for failure to reach the
desired state.
The [A_STRT] and [A_STOP] inputs are intended to input command pulses from a
sequence. The parameter AUTO determines the source of the start/stop commands. In auto
mode (AUTO=TRUE), the auto parameters [A_STRT] and [A_STOP] are active, and in
manual mode (AUTO=FALSE) the parameters START and STOP are active. START, STOP,
and AUTO are to be manipulated via the operator interface. START and STOP are to be set
TRUE; they are reset automatically.
A positive transition of auto start [A_STRT] or manual start [START] (depending on the
mode) latches the internal START_LATCH and pulses the start output [STRT_O]. Interlock
[INTRLK] must be TRUE to allow the latch. A positive transition of auto stop [A_STOP] or
manual stop STOP (also mode-dependent) unlatches the internal START_LATCH and
pulses the stop output [STOP_O]. The start and stop timers pulse the outputs and determine
if the motor has failed to reach its desired state, and the failure output [FAIL] will become
TRUE accordingly, which triggers the alarm.
Although the MOTOR_2OUT block was implemented in ladder logic in APACS, it has been
implemented in SCL in PCS 7 due to differences between APACS+ and PCS 7 ladder logic.
The MOTOR_2OUT is a logical and functional equivalent to the corresponding APACS+
ladder network. Comments in the provided SCL source code relate elements in the SCL
code to corresponding elements in the original APACS+ ladder network.

Calling OBs and Start-up


Calling OBs
This block is called in the watchdog interrupt OB into which the block is installed (for
example, OB32). Additionally, it is called in OB100 and in OB102 (see Start-up
Characteristics).

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 97
ES Library
1.2 Library Function Blocks

Start-up Characteristics
On a warm restart, OB100 is called and parameters retain the values they had immediately
before the restart. On a cold restart, OB102 is called and parameters are initialized with the
last downloaded values.
The warm and cold startup behavior of AUTO is configurable, allowing the user to override
the default PCS 7 behavior described above if necessary. As delivered, AUTO will be forced
to "Manual" and OUT will be forced to "False" on a CPU restart.
To force the AUTO parameter to a specified value on a restart, set the RSTRT_AUTO_FLAG
to true ("Force AUTO") and configure RSTRT_AUTO_VALUE with the desired forced value
("Auto" or "Manual"). The RSTRT_AUTO_VALUE will be used to initialize AUTO, if and only
if the RSTRT_AUTO_FLAG is true. If RSTRT_AUTO_FLAG is set to false ("Default"), the
AUTO parameter will be set in accordance with default PCS 7 behavior.

WARNING
Using "Default" for the RSTRT_AUTO_FLAG could result in your process running in
automatic mode after a restart. Use "Forced" for the restart flag and configure the associate
restart value to ensure a known restart state.

The STRT_O and STOP_O outputs will be automatically cleared on a restart.


If restart parameter values are changed offline, the configuration must be compiled (changes
only) and downloaded (changes only) to the controller in order for the settings to take effect
upon restart. If restart parameter values are changed online (via CFC Test mode), the
configuration must be compiled (entire program) and downloaded (entire program) to the
controller in order for the settings to take effect upon cold restart. This step is not necessary
for the online changes to take effect upon a warm restart.

Operator Control and Monitoring (M&C Relevant)


See Faceplate Information

Message Characteristics

Assignment of message texts and message class to the block parameters

Note
During runtime, the string $$BlockComment$$ will be replaced by the comment for the FB
instance that is in alarm.

Message # Message Class Message_class Default Message Text


1 PLC Process Control Message - Failure Motor Feedback Failure - $$BlockComment$$

APACS+ ES Library User's Guide for V7.1


98 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

Assignment of auxiliary process values to the block parameters

Value Block Parameter


@1%s@ BA_NA
@2%d@ BA_ID
@3%d@ STEP_NO

See also
MOTOR_2OUT_BLK Input Output (Page 99)

1.2.15.2 MOTOR_2OUT_BLK Input Output

Input

Name Data Type Explanation Initial OC&M Valid Values


PROOF BOOL PROOF is used as False True
feedback to confirm that
the motor is running
QC_PROOF BYTE Quality Code for 16#80 True See Quality
PROOF Codes
(Page 11)
A_STRT BOOL A_STRT is intended to False False
allow internal logic to
automatically start the
motor
A_STOP BOOL A_STOP is intended to False False
allow internal logic to
automatically stop the
motor
INTRLK BOOL INTRLK forbids False True
activation of the motor
SAMPLE_T REAL Sample time (in Compiler False
seconds) generated
RSTRT_AUTO_FLAG BOOL Default retain on WS, False True
Use load val on CS.
Force: Use
RSTRT_AUTO_VALUE
on restart
RSTRT_AUTO_VALUE BOOL Init restart value for False False
Auto Mode if
RSTRT_AUTO_FLAG
true
EV_ID DWORD Event ID Compiler False
generated

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 99
ES Library
1.2 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid Values


LIOP_MAN_SEL BOOL Select AUTO/MANUAL: False False
1 = Linking, 0 =
Operator active
AUT_L BOOL Linkable input for False False
AUTO/MANUAL mode,
1 = AUTO
BA_EN BOOL Batch enabled False True
OCCUPIED BOOL Batch occupied False True
BA_ID DWORD Batch ID number 0 True
BA_NA STRING[32] Batch name '' True
STEP_NO DWORD Batch step number 0 True
ConfirmChange BOOL If TRUE changes from False True
HMI must be confirmed
QC_STRT_O_IN BYTE Quality Code for output 16#80 True See Quality
STRT_O Codes
(Page 11)
QC_STRT_O_IN BYTE Quality Code for output 16#80 True See Quality
STRT_O Codes
(Page 11)

Note
This list differs from the inputs of the MOTOR_2OUT_BLK block in APACS+ as follows:
• Restart parameters (RSTRT_...) did not exist in APACS+.
• EV_ID and SAMPLE_T did not exist in APACS+.

Output

Name Data Type Explanation Initial OC&M Valid Values


STRT_O BOOL STRT_O is used to actuate the motor start False False
QC_STRT_O BYTE Quality Code for output STRT_O 16#80 True See Quality
Codes
(Page 11)
STOP_O BOOL STOP_O is used to actuate the motor stop False False
QC_STOP_O BYTE Quality Code for output STOP_O 16#80 True See Quality
Codes
(Page 11)
ALARM BOOL ALARM is used to signal internal logic when the False False
Motor is in alarm
FAIL BOOL FAIL motor failed to start or stop after a start or False True
stop request
OUT BOOL OUT is used to let the OS 'see' the internal False True
START_LATCH coil

APACS+ ES Library User's Guide for V7.1


100 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid Values


QC_OUT BYTE Quality Code for OUT for faceplate display, worst 16#80 True See Quality
of QC_OP_OUT and QC_CL_OUT Codes
(Page 11)
START_FAIL BOOL START_FAIL is used to indicate if the motor False False
failed to start

Input/output

Name Data Type Explanation Initial OC&M Valid Values


AUTO BOOL AUTO set auto mode (use A_STRT, False True
A_STOP) vs manual mode (use
START, STOP)
A1EN BOOL A1EN is used to enable /disable the True True
internal alarm
A1LIM BOOL True True
A1DELAYIN TIME Into alarm 1 delay time T#0MS False 0 to
24d20h31m23s647ms
A1DELAYOUT TIME Out of alarm 1 delay time T#0MS False 0 to
24d20h31m23s647ms
OOS BOOL OOS is used to signal that the internal True False
alarm is Out Of Service
DISABLE_ON_OOS BOOL Disable on Out of Service False False
START BOOL START is used to start the motor when True False
in Manual mode (AUTO=false)
STOP BOOL STOP is used to stop the motor when in True False
Manual mode (AUTO=false)
STRT_T TIME START_TIME sets time limit for PROOF T#10S True
to go true
STOP_T TIME STOP_TIME sets time limit for PROOF T#10S True
to go false

See also
MOTOR_2OUT: Motor with Two Outputs (Page 97)

1.2.16 PID_AFB

1.2.16.1 PID_AFB: Proportional-Integral-Derivative

Function Block Name PID_AFB


Function Block Number FB501

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 101
ES Library
1.2 Library Function Blocks

Function
The PID_AFB performs Proportional-Integral-Derivative (PID) control functions. It can also
be used as the basis for a PI controller by setting the derivative time value to 0.0 min. The
block utilizes reset feedback, allowing for various control schemes including override, reset
limiting, etc.
When the AUTO value = FALSE, the block operates in tracking mode (OUT value = FDBK
value). The PID block inputs (PV, SP & FDBK) and its outputs (OUT, ERR) are in
engineering units. The PID equation is defined using normalized values. Engineering values
are converted to and from normalized values with user-defined operating limits for both the
process input and process output. The operating limits are obtained from the process
flowsheets or sensor/actuator ranges. Any transition of the INIT input causes execution of
the initialization equations which recalculate the reset component so that the OUT value
does not experience a bump due to proportional action.

Note
Normal limits for the TI In/Out value are from 0.001 to 4000.0. In the special case of TI =
4000.0, all integral action is removed from the output calculation.

Calling OBs and Start-up


Calling OBs
This block is called in the watchdog interrupt OB into which the block is installed (for
example, OB32).
Start-up Characteristics
This function block has no special startup properties.

Operator Control and Monitoring (M&C Relevant)


There is no associated faceplate for this block.

See also
PID_AFB Input Output (Page 102)

1.2.16.2 PID_AFB Input Output

Input

Name Data Type Explanation Initial OC&M Valid Values


PV REAL Process variable input 0 True
SP REAL Setpoint input 0 False
FDBK REAL Reset feedback input 0 False
AUTO BOOL Track command input. When Manual, the False False
block is in a tracking mode [OUT=FDBK].

APACS+ ES Library User's Guide for V7.1


102 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid Values


INIT BOOL Transitions of the INIT input cause the False False
initialization equation to be performed.
SAMPLE_T REAL Current scan rate supplied by compiler False

Note
This list differs from the inputs of the PID_AFB block in APACS+ as follows:
• The SAMPLE_T input is required for the block to obtain the scan rate.

Output

Name Data Type Explanation Initial OC&M Valid Values


OUT REAL Calculated output. It is limited from -3.3 to 0 False
+103.3% of range EOUTL to EOUTH.
ERR REAL Error output [(PV) – (SP)]. False

Input/output

Name Data Type Explanation Initial OC&M Valid Values


PG REAL Proportional Gain 0.001 True 0.001 to 100.0
TI REAL Time-Integral Minutes per Reset 4000.0 True 0.0 to 4000.0
TD REAL Time-Derivative Minutes 0 True 0.00 to 100.0
DG REAL Derivative Gain 10.0 True 2.00 to 20.00
DIR_ACT BOOL Reverse or Direct action False True
EINL REAL Engineering unit: Input, Low 0 True
EINH REAL Engineering unit: Input, High 100.0 True
EOUTL REAL Engineering unit: Output, Low 0 True
EOUTH REAL Engineering unit: Output, High 100.0 True
ADAPTIVE_PG_INT BOOL Adaptive Gain Init flag True False

See also
PID_AFB: Proportional-Integral-Derivative (Page 101)

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 103
ES Library
1.2 Library Function Blocks

1.2.17 PRIMARY_BLK

1.2.17.1 PRIMARY: Primary Controller

Function Block Name PRIMARY_BLK


(compiled version of the Chart)
Function Block Number FB608
Chart Name PRIMARY
See also, Template Chart PRIMARY_SECONDARY_AT
(usage example)

Function
The Primary Controller (PRIMARY_BLK) block is a factory-compiled function block. It is
intended for use as a primary single-loop PID controller with tracking setpoint as part of a
cascade control circuit. The PRIMARY_BLK block is designed to be used with the
SECONDARY_BLK block to form a cascade circuit when it is preferable to control the
primary and secondary loops separately. Normally, the output from the primary loop is to be
the setpoint to the secondary loop, and the cascade status of the secondary loop is to be fed
to the primary loop. High and low alarms are provided for the process variable, and an alarm
is provided for absolute deviation between process variable and setpoint.

Calling OBs and Start-up


Calling OBs
This block is called in the watchdog interrupt OB into which the block is installed (for
example, OB32). Additionally, it is called in OB100 and in OB102 (see Start-up
characteristics).
Start-up Characteristics
On a warm restart, OB100 is called and parameters retain the values they had immediately
before the restart. On a cold restart, OB102 is called and parameters are initialized with the
last downloaded values.
The warm and cold startup behavior of AUTO, SP, and OUT is configurable, allowing the
user to override the default PCS 7 behavior described above, if necessary. As delivered,
AUTO will be forced to "Manual" and OUT will be forced to 0.0 on a CPU restart. SP will be
set in accordance with default PCS 7 behavior.
To force the AUTO parameter to a specified value on a restart, set the RSTRT_AUTO_FLAG
to true ("Force AUTO") and configure RSTRT_AUTO_VALUE with the desired forced value
("Auto" or "Manual"). The RSTRT_AUTO_VALUE will be used to initialize AUTO, if and only
if the RSTRT_AUTO_FLAG is true. If RSTRT_AUTO_FLAG is set to false ("Default"), the
AUTO parameter will be set in accordance with default PCS 7 behavior.
To force the SP parameter to a specified value on a restart, set the RSTRT_SP_FLAG to
true ("Force SP") and configure RSTRT_SP_VALUE with the desired forced value. The
RSTRT_SP_VALUE will be used to initialize SP, if the RSTRT_SP_FLAG is true and either

APACS+ ES Library User's Guide for V7.1


104 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

● The block is forced to start in Auto mode, or


● AUTO is not forced and the block restarts with Auto mode (AUTO="Auto") and in
secondary cascade (CASC_S = "True").
If RSTRT_SP_FLAG is set to false ("Default"), the SP parameter will be set in accordance
with default PCS 7 behavior.
To force the OUT parameter to a specified value on a restart, set the RSTRT_OUT_FLAG to
true ("Force OUT") and configure RSTRT_OUT_VALUE with the desired forced value. The
RSTRT_OUT_VALUE will be used to initialize OUT, if and only if the RSTRT_OUT_FLAG is
true and the block restarts in Manual mode (AUTO = "Manual"). If RSTRT_OUT_FLAG is set
to false ("Default"), the OUT parameter will be set in accordance with default PCS 7
behavior.

WARNING
Using "Default" for the RSTRT_OUT_FLAG could result in your output device retaining its
last operating state after a restart. Similarly, using "Default" for the RSTRT_AUTO_FLAG
could result in your process running in automatic mode after a restart. Use "Forced" for the
restart flags and configure the associated restart values to ensure a known restart state.

If restart parameter values are changed offline, the configuration must be compiled (changes
only) and downloaded (changes only) to the controller in order for the settings to take effect
upon restart. If restart parameter values are changed online (via CFC Test mode), the
configuration must be compiled (entire program) and downloaded (entire program) to the
controller in order for the settings to take effect upon cold restart. This step is not necessary
for the online changes to take effect upon a warm restart.

Operator Control and Monitoring (M&C Relevant)


See Faceplate Information

Message Characteristics

Assignment of message texts and message class to the block parameters

Note
During runtime, the string $$BlockComment$$ will be replaced by the comment for the FB
instance that is in alarm.

ALARM_8P ID Message # Message Class Default Message Text


Message_class
EV_ID 1 Warning - above HIGH - $$BlockComment$$ - Limit = @4%f@
EV_ID 2 Warning - below LOW - $$BlockComment$$ - Limit = @5%f@
EV_ID 3 Alarm - above HIGH_DEV - $$BlockComment$$ - Limit = @6%f@
EV_ID 4 Alarm - below LOW_DEV - $$BlockComment$$ - Limit = @7%f@
EV_ID 5 Alarm - above ABSOLUTE_DEV - $$BlockComment$$ - Limit = @8%f@

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 105
ES Library
1.2 Library Function Blocks

ALARM_8P ID Message # Message Class Default Message Text


Message_class
EV_ID 6 PLC Process Control OUT_OF_RANGE - $$BlockComment$$
Message - Failure
EV_ID 7 PLC Process Control QUALITY_NOT_GOOD - $$BlockComment$$
Message - Failure
EV_ID2 1 Alarm - above HIGH_ HIGH - $$BlockComment$$ - Limit = @4%f@
EV_ID2 2 Alarm - below LOW_ LOW - $$BlockComment$$ - Limit = @5%f@
EV_ID2 3 Warning - above INC_ROC - $$BlockComment$$ - Limit = @6%f@
EV_ID2 4 Warning - below DEC_ROC - $$BlockComment$$ - Limit = @7%f@
EV_ID2 5 Warning - above ABS_ROC - $$BlockComment$$ - Limit = @8%f@

Assignment of auxiliary process values to the block parameters

ALARM_8P ID Value Block Parameter


EV_ID @1%s@ BA_NA
EV_ID @2%d@ BA_ID
EV_ID @3%d@ STEP_NO
EV_ID @4%f@ H_LIM
EV_ID @5%f@ L_LIM
EV_ID @6%f@ HD_LIM
EV_ID @7%f@ LD_LIM
EV_ID @8%f@ AD_LIM
EV_ID2 @1%s@ BA_NA
EV_ID2 @2%d@ BA_ID
EV_ID2 @3%d@ STEP_NO
EV_ID2 @4%f@ HH_LIM
EV_ID2 @5%f@ LL_LIM
EV_ID2 @6%f@ IR_LIM
EV_ID2 @7%f@ DR_LIM
EV_ID2 @8%f@ AR_LIM

See also
PRIMARY_BLK Input Output (Page 107)

APACS+ ES Library User's Guide for V7.1


106 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

1.2.17.2 PRIMARY_BLK Input Output

Input

Name Data Type Explanation Initial OC&M Valid Values


PV REAL Process Variable 0 True
QC_PV BYTE Quality Code for PV 16#80 True Quality Codes
(Page 11)
FDBK REAL Controller tracks feedback when 0 False
(AUTO=FALSE) or
(CASC_S=FALSE)
QC_FDBK BYTE Quality Code for FDBK 16#80 True Quality Codes
(Page 11)
CASC_S BOOL Secondary cascade status False False
INIT BOOL Transitions of the INIT input cause False False
the initialization equation to be
performed
TSP REAL SP target value for SP ramping 0 True
H_EN BOOL Enable High Alarm True True
L_EN BOOL Enable Low Alarm True True
HD_EN BOOL Enable High Deviation Alarm False True
LD_EN BOOL Enable Low Deviation Alarm False True
AD_EN BOOL Enable Absolute Deviation Alarm True True
OOR_EN BOOL Enable Out of Range Alarm False True
QUAL_EN BOOL Enable Quality Not Good Alarm False True
HH_EN BOOL Enable High High Alarm False True
LL_EN BOOL Enable Low Low Alarm False True
IR_EN BOOL Enable Increasing Rate of Change False True
Alarm
DR_EN BOOL Enable Decreasing Rate of Change False True
Alarm
AR_EN BOOL Enable Absolute Rate of Change False True
Alarm
OOS BOOL Out of Service indicator False True
QBAD BOOL Bad quality indicator False False
EV_ID DWORD Event ID DW#16#5 False
EV_ID2 DWORD Event ID DW#16#6 False
SAMPLE_T REAL Scan Rate. Use only when compiling 0.1 False
CFC as block type.
RSTRT_AUTO_FLAG BOOL Default: Retain on WS, Use load True False
value on CS. Force: Use
RSTRT_AUTO_VALUE on restart
RSTRT_AUTO_VALUE BOOL Init restart value for Auto Mode if False False
RSTRT_AUTO_FLAG true

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 107
ES Library
1.2 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid Values


RSTRT_SP_FLAG BOOL Default: Retain on WS, Use load False False
value on CS. Force: Use
RSTRT_SP_VALUE restart.
RSTRT_SP_VALUE REAL Init restart value for SP if 0 False
RSTRT_SP_FLAG true and Auto
mode.
RSTRT_OUT_FLAG BOOL Default: Retain on WS, Use load True False
value on CS. Force: Use
RSTRT_OUT_VALUE on restart.
RSTRT_OUT_VALUE REAL Init restart value for OUT if 0 False
RSTRT_OUT_FLAG true and
manual mode
BA_EN BOOL Batch enabled False True
OCCUPIED BOOL Batch occupied False True
BA_ID DWORD Batch ID number 0 True
BA_NA STRING[32] Batch name '' True
STEP_NO DWORD Batch step number 0 True
DecimalPlacesPV INT Decimal places displayed in HMI for 2 True
PV, SP etc.
DecimalPlacesOUT INT Decimal places displayed in HMI for 2 True
OUT, OUT Limits
ConfirmChange BOOL If TRUE changes from HMI must be False True
confirmed
LIOP_MAN_SEL BOOL Select AUTO/MANUAL: 0 False
1 = Linking, 0 = Operator active
AUT_L BOOL Linkable input for AUTO/MANUAL 0 False
mode, 1 = AUTO
LIOP_ ISP_SEL BOOL Select internal SP: 1 = from Link, 0 = 0 False
from Operator
SP_L REAL Linkable input for internal Setpoint 0.0 False
LIOP_OUT_SEL BOOL Select writing to OUT: 1 = from Link, 0 False
0 = from Operator
OUT_L REAL Linkable input to be written to OUT 0.0 False

Note
This list differs significantly from the inputs of the PRIMARY_BLK block in APACS+. In
APACS+, only the PV, FDBK and CASC_S inputs are present.

Output

Name Data Type Explanation Initial OC&M Valid Values


SP_OUT REAL Calculated set point value 0 False
OUT REAL Calculated output variable that has been limited 0 False
QC_OUT BYTE Quality Code for OUT 16#80 True

APACS+ ES Library User's Guide for V7.1


108 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid Values


ALARM BOOL Alarm Status False False
SS BOOL Secondary Standby flag True True
H_ALM BOOL When TRUE, the High alarm is detected and False False
enabled.
L_ALM BOOL When TRUE, the Low alarm is detected and False False
enabled.
HD_ALM BOOL When TRUE, the High Deviation alarm is detected False False
and enabled.
LD_ALM BOOL When TRUE, the Low Deviation alarm is detected False False
and enabled.
AD_ALM BOOL When TRUE, the Absolute Deviation alarm is False False
detected and enabled.
OOR_ALM BOOL When TRUE, the Out of Range alarm is detected False False
and enabled.
QUAL_ALM BOOL When TRUE, the Quality Not Good alarm is False False
detected and enabled.
HH_ALM BOOL When TRUE, the High High alarm is detected and False False
enabled.
LL_ALM BOOL When TRUE, the Low Low alarm is detected and False False
enabled.
IR_ALM BOOL When TRUE, the Increasing Rate of Change alarm False False
is detected and enabled.
DR_ALM BOOL When TRUE, the Decreasing Rate of Change alarm False False
is detected and enabled.
AR_ALM BOOL When TRUE, the Absolute Rate of Change alarm is False False
detected and enabled.

Note
The APACS+ SP output has been converted to SP_OUT. SP_OUT is used to interconnect
the set-point value to other entities on a chart. The OS interaction is handled by the SP InOut
parameter.

Input/output

Name Data Type Explanation Initial OC&M Valid Values


AUTO BOOL Auto/manual mode control False True
SP REAL Computer set point value 0 True
RAMP BOOL SP ramping on/off mode control False True
R_TIME TIME Ramp time T#0MS True 0 to
24d20h31m23s647ms
SPL REAL Set point low limit 0 True
SPH REAL Set point high limit 100 True
R_RATE REAL Ramp rate (in engineering units per min) 0 True

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 109
ES Library
1.2 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid Values


USE_RR BOOL Ramp mode control. Use RTIME or False True
RRATE to control ramp
PV_TRACK BOOL Internal setpoint tracking control. When True True
Track, internal setpoint tracks PV
PG REAL Proportional Gain 0.001 True 0.001 to 100.0
TI REAL Time-Integral Minutes per Reset 4000 True 0.0 to 4000.0
TD REAL Time-Derivative Minutes 0 True 0.00 to 100.0
DG REAL Derivative Gain 10 True 2.00 to 20.00
DIR BOOL Reverse or Direct action False True
ADAPTIVE_PG_INIT BOOL Adaptive Gain Init flag True False
PV_EUMIN REAL Engineering unit: Input, Low 0 True
PV_EUMAX REAL Engineering unit: Input, High 100 True
VL_EUMIN REAL Engineering unit: Output, Low 0 True
VL_EUMAX REAL Engineering unit: Output, High 100 True
VL REAL Computer Output, typically written to by 0 True
an operator command
QC_OUT_IN BYTE Quality Code input for output OUT 16#80 True
VLL REAL OUT low limit input -3.3 True
VLH REAL OUT high limit input 103.3 True
H_LIM REAL The value (in engineering units) to 100 True
which the (PV) input is compared for the
High alarm.
H_DB REAL The amount of engineering units by 0.5 True
which (PV) must be within the limit for
the High alarm to clear.
H_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the High limit to trip an 24d20h31m23s647ms
alarm.
H_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the High limit and deadband to 24d20h31m23s647ms
cause the alarm to clear.
L_LIM REAL The value (in engineering units) to 0 True
which the (PV) input is compared for the
Low alarm.
L_DB REAL The amount of engineering units by 0.5 True
which (PV) must be within the limit for
the Low alarm to clear.
L_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the Low limit to trip an 24d20h31m23s647ms
alarm.
L_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the Low limit and deadband to 24d20h31m23s647ms
cause the alarm to clear.
HD_LIM REAL The value (in engineering units) to 0 True
which (PV) – (DEV) is compared for the
High Deviation alarm.

APACS+ ES Library User's Guide for V7.1


110 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid Values


HD_DB REAL The amount of engineering units by 0.5 True
which (PV) – (DEV) must be within the
limit for the High Deviation alarm to
clear.
HD_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the High Deviation limit 24d20h31m23s647ms
to trip an alarm.
HD_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the High Deviation limit and 24d20h31m23s647ms
deadband to cause the alarm to clear.
LD_LIM REAL The value (in engineering units) to 0 True
which (DEV) - (PV) is compared for the
Low Deviation alarm.
LD_DB REAL The amount of engineering units by 0.5 True
which (DEV) - (PV) must be within the
limit for the Low Deviation alarm to
clear.
LD_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the Low Deviation limit 24d20h31m23s647ms
to trip an alarm.
LD_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the Low Deviation limit and 24d20h31m23s647ms
deadband to cause the alarm to clear.
AD_LIM REAL The value (in engineering units) to 100 True
which ABS((PV) – (DEV)) is compared
for the Absolute Deviation alarm.
AD_DB REAL The amount of engineering units by 0.5 True
which ABS((PV) – (DEV)) must be
within the limit for the Absolute
Deviation alarm to clear.
AD_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the Absolute Deviation 24d20h31m23s647ms
limit to trip an alarm.
AD_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the Absolute Deviation limit and 24d20h31m23s647ms
deadband to cause the alarm to clear.
HH_LIM REAL The value (in engineering units) to 0 True
which the (PV) input is compared for the
High High alarm.
HH_DB REAL The amount of engineering units by 0.5 True
which (PV) must be within the limit for
the High High alarm to clear.
HH_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the High High limit to 24d20h31m23s647ms
trip an alarm.
HH_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the High High limit and deadband 24d20h31m23s647ms
to cause the alarm to clear.
LL_LIM REAL The value (in engineering units) to 0 True
which the (PV) input is compared for the
Low Low alarm.

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 111
ES Library
1.2 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid Values


LL_DB REAL The amount of engineering units by 0.5 True
which (PV) must be within the limit for
the Low Low alarm to clear.
LL_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the Low Low limit to trip 24d20h31m23s647ms
an alarm.
LL_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the Low Low limit and deadband 24d20h31m23s647ms
to cause the alarm to clear.
IR_LIM REAL The value (in engineering units per 0 True
minute) to which the (PV) input is
compared for the Increasing Rate of
Change alarm.
IR_DB REAL The amount of engineering units by 0.5 True
which (PV) must be within the limit for
the Increasing Rate of Change alarm to
clear.
IR_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the Increasing Rate of 24d20h31m23s647ms
Change limit to trip an alarm.
IR_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the Increasing Rate of Change 24d20h31m23s647ms
limit and deadband to cause the alarm
to clear.
DR_LIM REAL The value (in engineering units per 0 True
minute) to which the (PV) input is
compared for the Decreasing Rate of
Change alarm.
DR_DB REAL The amount of engineering units by 0.5 True
which (PV) must be within the limit for
the Decreasing Rate of Change alarm to
clear.
DR_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the Decreasing Rate of 24d20h31m23s647ms
Change limit to trip an alarm.
DR_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the Decreasing Rate of Change 24d20h31m23s647ms
limit and deadband to cause the alarm
to clear.
AR_LIM REAL The value (in engineering units per 0 True
minute) to which the (PV) input is
compared for the Absolute Rate of
Change alarm.
AR_DB REAL The amount of engineering units by 0.5 True
which (PV) must be within the limit for
the Absolute Rate of Change alarm to
clear.
AR_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the Absolute Rate of 24d20h31m23s647ms
Change limit to trip an alarm.

APACS+ ES Library User's Guide for V7.1


112 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid Values


AR_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the Absolute Rate of Change limit 24d20h31m23s647ms
and deadband to cause the alarm to
clear.
OOR_DELAYIN TIME The amount of time the input must be T#0MS False 0 to
outside the limits EINH, EINL to trip the 24d20h31m23s647ms
Out of Range alarm.
OOR_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the limits EINH, EINL to cause 24d20h31m23s647ms
the Out of Range alarm to clear.
QUAL_DELAYIN TIME The amount of time the input quality T#0MS False 0 to
must be bad to trip the Quality Not Good 24d20h31m23s647ms
alarm.
QUAL_DELAYOUT TIME The amount of time the input quality T#0MS False 0 to
must be good to cause the Quality Not 24d20h31m23s647ms
Good alarm to clear.
DISABLE_ON_OOS BOOL When set to TRUE, the block is disabled False False
if (OOS) is also TRUE.

See also
PRIMARY: Primary Controller (Page 104)

1.2.18 RATIO_SET_BLK

1.2.18.1 RATIO_SET: Ratio Setpoint Controller

Function Block Name RATIO_SET_BLK


(compiled version of the Chart)
Function Block Number FB609
Chart Name RATIO_SET
See also, Template Chart RATIO_SET_AT
(usage example)

Function
The Ratio Setpoint Controller (RATIO_SET_BLK) block is a factory-compiled function block.
It is intended for use as a ratio-set PID controller with tracking setpoint. An external input is
multiplied by a desired ratio value (i.e. a controlled variable divided by wild variable) to
calculate the external setpoint. The process variable is divided by the external input for
display of the actual ratio. Both high and low alarms are provided for the process variable,
and an additional alarm is provided to detect an absolute deviation between the process
variable and setpoint.
RATIO_SET_BLK is a compiled version of the RATIO_SET source chart. Within the chart,
there is a control loop that contains PID_AFB and AM_AFB blocks along with alarming logic.

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 113
ES Library
1.2 Library Function Blocks

The loop also uses two SETPNT_AFB blocks; the RATIO block provides an input of the ratio
calculation, the result of which is the external setpoint of the SETPOINT block.
The RATIO block holds the desired ratio, modified via the computer setpoint (RAT_DES),
and the low and high range values of the ratio. The RATIO_MIN and RATIO_MAX values are
used by the ACT_RAT_LIMIT block (described below). The ratio input [RAT_INP] is
multiplied by the desired ratio (from the RATIO block) to calculate the external setpoint. The
SETPOINT block supplies the setpoint [SP] to the CONTROLLER block. The SETPOINT
block has a ramping feature for internal mode (EXT=FALSE). In external mode
(EXT=TRUE), the calculated external setpoint becomes the controller setpoint, and the
SETPOINT block internal setpoint (ISP) tracks the external setpoint, thereby ensuring no
change in setpoint during transition to internal mode. The setpoint tracks the process
variable [PV] in manual mode (AUTO=FALSE).
The CONTROLLER block is a PID_AFB block. It operates in auto mode (AUTO=TRUE) and
tracks the downstream output [OUT] in manual mode (AUTO=FALSE). The AUTO_MANUAL
block provides manual control of the output. In auto mode, the CONTROLLER block output
becomes the loop output [OUT]. In manual mode, the AUTO_MANUAL block's internal
output (IOUT) becomes the loop output.
The ACT_RAT_LIMIT block is used to apply limits to the actual ratio [RAT_ACT], which is the
quotient of the process variable and the external input.

Calling OBs and Start-up


Calling OBs
This block is called in the watchdog interrupt OB into which the block is installed (for
example, OB32). Additionally, it is called in OB100 and in OB102 (see Start-up
Characteristics).
Start-up Characteristics
On a warm restart, OB100 is called and parameters retain the values they had immediately
before the restart. On a cold restart, OB102 is called and parameters are initialized with the
last downloaded values.
The warm and cold startup behavior of AUTO, SP, RAT_DES, EXT, and OUT is
configurable, allowing the user to override the default PCS 7 behavior described above if
necessary. As delivered, AUTO will be forced to "Manual", EXT will be forced to "Internal"
and OUT wil be forced to 0.0 on a CPU restart. SP and RAT_DES will be set in accordance
with default PCS 7 behavior: the value will be retained on a warm restart or set to the last
downloaded value on a cold restart.
To force the AUTO parameter to a specified value on a restart, set the RSTRT_AUTO_FLAG
to true ("Force AUTO") and configure RSTRT_AUTO_VALUE with the desired forced value
("Auto" or "Manual"). The RSTRT_AUTO_VALUE will be used to initialize AUTO, if and only
if the RSTRT_AUTO_FLAG is true. If RSTRT_AUTO_FLAG is set to false ("Default"), the
AUTO parameter will be set in accordance with default PCS 7 behavior.
To force the SP parameter to a specified value on a restart, set the RSTRT_SP_FLAG to
true ("Force SP") and configure RSTRT_SP_VALUE with the desired forced value. The
RSTRT_SP_VALUE will be used to initialize SP, if and only if the RSTRT_SP_FLAG is true
and the block restarts in Auto mode (AUTO="Auto"). If RSTRT_SP_FLAG is set to false
("Default"), the SP parameter will be set in accordance with default PCS 7 behavior.
To force the RAT_DES parameter to a specified value on a restart, set the RSTRT_
RAT_DES _FLAG to true ("Force RAT_DES") and configure RSTRT_ RAT_DES _VALUE
with the desired forced value. The RSTRT_ RAT_DES _VALUE will be used to initialize

APACS+ ES Library User's Guide for V7.1


114 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

RAT_DES, if and only if the RSTRT_ RAT_DES _FLAG is true and the block restarts in Auto
mode (AUTO="Auto"). If RSTRT_ RAT_DES _FLAG is set to false ("Default"), the RAT_DES
parameter will be set in accordance with default PCS 7 behavior.
To force the EXT parameter to a specified value on a restart, set the RSTRT_EXT_FLAG to
true ("Force EXT") and configure RSTRT_EXT_VALUE with the desired forced value
("Internal or External"). The RSTRT_EXT_VALUE will be used to initialize EXT, if and only if
the RSTRT_EXT_FLAG is true. If RSTRT_EXT_FLAG is set to false ("Default"), the EXT
parameter will be set in accordance with default PCS 7 behavior. Forcing the EXT parameter
to "External" will cause the SP to be set to the ESP, thereby overriding the SP restart
parameter settings.
To force the OUT parameter to a specified value on a restart, set the RSTRT_OUT_FLAG to
true ("Force OUT") and configure RSTRT_OUT_VALUE with the desired forced value. The
RSTRT_OUT_VALUE will be used to initialize OUT, if and only if the RSTRT_OUT_FLAG is
true and the block restarts in Manual mode (AUTO = "Manual"). If RSTRT_OUT_FLAG is set
to false ("Default"), the OUT parameter will be set in accordance with default PCS 7
behavior.

WARNING
Using "Default" for the RSTRT_OUT_FLAG could result in your output device retaining its
last operating state after a restart. Similarly, using "Default" for the RSTRT_AUTO_FLAG
could result in your process running in automatic mode after a restart. Use "Forced" for the
restart flags and configure the associated restart values to ensure a known restart state.

If restart parameter values are changed offline, the configuration must be compiled (changes
only) and downloaded (changes only) to the controller in order for the settings to take effect
upon restart. If restart parameter values are changed online (via CFC Test mode), the
configuration must be compiled (entire program) and downloaded (entire program) to the
controller in order for the settings to take effect upon cold restart. This step is not necessary
for the online changes to take effect upon a warm restart.

Operator Control and Monitoring (M&C Relevant)


See Faceplate Information

Message Characteristics

Assignment of message texts and message class to the block parameters

Note
During runtime, the string $$BlockComment$$ will be replaced by the comment for the FB
instance that is in alarm.

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 115
ES Library
1.2 Library Function Blocks

ALARM_8P ID Message # Message Class Default Message Text


Message_class
EV_ID 1 Warning - above HIGH - $$BlockComment$$ - Limit = @4%f@
EV_ID 2 Warning - below LOW - $$BlockComment$$ - Limit = @5%f@
EV_ID 3 Alarm - above HIGH_DEV - $$BlockComment$$ - Limit = @6%f@
EV_ID 4 Alarm - below LOW_DEV - $$BlockComment$$ - Limit = @7%f@
EV_ID 5 Alarm - above ABSOLUTE_DEV - $$BlockComment$$ - Limit = @8%f@
EV_ID 6 PLC Process Control OUT_OF_RANGE - $$BlockComment$$
Message - Failure
EV_ID 7 PLC Process Control QUALITY_NOT_GOOD - $$BlockComment$$
Message - Failure
EV_ID2 1 Alarm - above HIGH_ HIGH - $$BlockComment$$ - Limit = @4%f@
EV_ID2 2 Alarm - below LOW_ LOW - $$BlockComment$$ - Limit = @5%f@
EV_ID2 3 Warning - above INC_ROC - $$BlockComment$$ - Limit = @6%f@
EV_ID2 4 Warning - below DEC_ROC - $$BlockComment$$ - Limit = @7%f@
EV_ID2 5 Warning - above ABS_ROC - $$BlockComment$$ - Limit = @8%f@

Assignment of auxiliary process values to the block parameters

ALARM_8P ID Value Block Parameter


EV_ID @1%s@ BA_NA
EV_ID @2%d@ BA_ID
EV_ID @3%d@ STEP_NO
EV_ID @4%f@ H_LIM
EV_ID @5%f@ L_LIM
EV_ID @6%f@ HD_LIM
EV_ID @7%f@ LD_LIM
EV_ID @8%f@ AD_LIM
EV_ID2 @1%s@ BA_NA
EV_ID2 @2%d@ BA_ID
EV_ID2 @3%d@ STEP_NO
EV_ID2 @4%f@ HH_LIM
EV_ID2 @5%f@ LL_LIM
EV_ID2 @6%f@ IR_LIM
EV_ID2 @7%f@ DR_LIM
EV_ID2 @8%f@ AR_LIM

See also
RATIO_SET_BLK Input Output (Page 117)

APACS+ ES Library User's Guide for V7.1


116 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

1.2.18.2 RATIO_SET_BLK Input Output

Input

Name Data Type Explanation Initial OC&M Valid


Values
PV REAL Process Variable 0 True
QC_PV BYTE Quality Code for PV 16#80 True Quality
Codes
(Page 11)
RAT_INP REAL External Input. Ratio thereof sets 0 True
loop's setpoint
QC_RAT_INP BYTE Quality Code for RAT_INP 16#80 True Quality
Codes
(Page 11)
TSP REAL SP target value for SP ramping 0 True
H_EN BOOL Enable High Alarm True True
L_EN BOOL Enable Low Alarm True True
HD_EN BOOL Enable High Deviation Alarm False True
LD_EN BOOL Enable Low Deviation Alarm False True
AD_EN BOOL Enable Absolute Deviation Alarm True True
OOR_EN BOOL Enable Out of Range Alarm False True
QUAL_EN BOOL Enable Quality Not Good Alarm False True
HH_EN BOOL Enable High High Alarm False True
LL_EN BOOL Enable Low Low Alarm False True
IR_EN BOOL Enable Increasing Rate of False True
Change Alarm
DR_EN BOOL Enable Decreasing Rate of False True
Change Alarm
AR_EN BOOL Enable Absolute Rate of Change False True
Alarm
OOS BOOL Out of Service indicator False True
QBAD BOOL Bad quality indicator False False
EV_ID DWORD Event ID DW#16#5 False
EV_ID2 DWORD Event ID DW#16#6 False
SAMPLE_T REAL Current scan rate supplied by OS 0.1 False
RSTRT_AUTO_FLAG BOOL Default: Retain on WS, Use load True False
value on CS. Force: Use
RSTRT_AUTO_VALUE on restart
RSTRT_AUTO_VALUE BOOL Init restart value for Auto Mode if False False
RSTRT_AUTO_FLAG true
RSTRT_EXT_FLAG BOOL Default: Retain on WS, Use load True False
value on CS. Force: Use
RSTRT_EXT_VALUE on restart
RSTRT_EXT_VALUE BOOL Init restart value for EXTernal if False False
RSTRT_EXT_FLAG true

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 117
ES Library
1.2 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid


Values
RSTRT_SP_FLAG BOOL Default: Retain on WS, Use load False False
value on CS. Force: Use
RSTRT_SP_VALUE on restart.
RSTRT_SP_VALUE REAL Init restart value for SP if 0 False
RSTRT_SP_FLAG true and Auto
mode.
RSTRT_RAT_DES_FLAG BOOL Default: Retain on WS, Use load False False
value on CS. Force: Use
RSTRT_OUT_VALUE on restart.
RSTRT_RAT_DES_VALUE REAL Init restart value for RAT_DES if 0 False
RSTRT_ RAT_DES _FLAG true.
RSTRT_OUT_FLAG BOOL Default: Retain on WS, Use load True False
value on CS. Force: Use
RSTRT_OUT_VALUE on restart.
RSTRT_OUT_VALUE REAL Init restart value for OUT if 0 False
RSTRT_OUT_FLAG true and
manual mode.
BA_EN BOOL Batch enabled False True
OCCUPIED BOOL Batch occupied False True
BA_ID DWORD Batch ID number 0 True
BA_NA STRING[32] Batch name '' True
STEP_NO DWORD Batch step number 0 True
DecimalPlacesPV INT Decimal places displayed in HMI 2 True
for PV, SP etc.
DecimalPlacesOUT INT Decimal places displayed in HMI 2 True
for OUT, OUT Limits
DecimalPlacesRATIO INT Decimal places displayed in HMI 2 True
for RAT_ACT, RAT_DES
ConfirmChange BOOL If TRUE changes from HMI must False True
be confirmed
LIOP_MAN_SEL BOOL Select AUTO/MANUAL: 0 False
1 = Linking, 0 = Operator active
AUT_L BOOL Linkable input for AUTO/MANUAL 0 False
mode, 1 = AUTO
LIOP_EXT_SEL BOOL Select External/Internal SP flag: 1 0 False
= from Link, 0 = from Operator
EXTRNL_L BOOL Linkable input to select 0 False
External/Internal SP flag, 1=Extrnl
LIOP_ ISP_SEL BOOL Select internal SP: 1 = from Link, 0 False
0 = from Operator
SP_L REAL Linkable input for internal Setpoint 0.0 False
LIOP_OUT_SEL BOOL Select writing to OUT: 1 = from 0 False
Link, 0 = from Operator
OUT_L REAL Linkable input to be written to 0.0 False
OUT

APACS+ ES Library User's Guide for V7.1


118 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid


Values
LIOP_RATIO_SEL BOOL Select desired ratio: 1 = from 0 False
Link, 0 = from Operator
RAT_DES_L REAL Linkable input for desired ratio 0.0 False

Output

Name Data Type Explanation Initial OC&M Valid Values


SP_OUT REAL Calculated set point value 0 False
OUT REAL Calculated output variable that has been 0 False
limited
QC_OUT BYTE Quality Code for output OUT 16#80 True Quality Code
(Page 11)
RAT_ACT REAL Actual Ratio Value. Quotient of PV and 0 True
RAT_INP subject to limits
DESRAT REAL Desired ratio of PV to RAT_INP 0 False
ALARM BOOL Alarm Status False False
ESP REAL External set point 0 True
H_ALM BOOL When TRUE, the High alarm is detected and False False
enabled.
L_ALM BOOL When TRUE, the Low alarm is detected and False False
enabled.
HD_ALM BOOL When TRUE, the High Deviation alarm is False False
detected and enabled.
LD_ALM BOOL When TRUE, the Low Deviation alarm is False False
detected and enabled.
AD_ALM BOOL When TRUE, the Absolute Deviation alarm is False False
detected and enabled.
OOR_ALM BOOL When TRUE, the Out of Range alarm is False False
detected and enabled.
QUAL_ALM BOOL When TRUE, the Quality Not Good alarm is False False
detected and enabled.
HH_ALM BOOL When TRUE, the High High alarm is detected False False
and enabled.
LL_ALM BOOL When TRUE, the Low Low alarm is detected False False
and enabled.
IR_ALM BOOL When TRUE, the Increasing Rate of Change False False
alarm is detected and enabled.
DR_ALM BOOL When TRUE, the Decreasing Rate of Change False False
alarm is detected and enabled.
AR_ALM BOOL When TRUE, the Absolute Rate of Change False False
alarm is detected and enabled.
VL_EUMIN_OUT REAL Copy of Engineering unit: Output, Low 0 False
VL_EUMAX_OUT REAL Copy of Engineering unit: Output, High 0 False

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 119
ES Library
1.2 Library Function Blocks

Input/output

Name Data Explanation Initial OC&M Valid Values


Type
AUTO BOOL Auto/manual mode control False True
EXT BOOL External/internal mode control False True
SP REAL Computer set point value 0 True
RAMP BOOL SP ramping on/off mode control False True
R_TIME TIME Ramp time T#0MS True 0 to
24d20h31m23s647ms
SPL REAL Set point low limit 0 True
SPH REAL Set point high limit 100 True
R_RATE REAL Ramp rate (in engineering units per 0 True
min)
USE_RR BOOL Ramp mode control. Use RTIME or False True
RRATE to control ramp
PV_TRACK BOOL Internal setpoint tracking control. When True True
Track, internal setpoint tracks PV
PG REAL Proportional Gain 0.001 True 0.001 to 100.0
TI REAL Time-Integral Minutes per Reset 4000 True 0.0 to 4000.0
TD REAL Time-Derivative Minutes 0 True 0.00 to 100.0
DG REAL Derivative Gain 10 True 2.00 to 20.00
DIR BOOL Reverse or Direct action False True
ADAPTIVE_PG_INIT BOOL Adaptive Gain Init flag True False
PV_EUMIN REAL Engineering unit: Input, Low 0 True
PV_EUMAX REAL Engineering unit: Input, High 100 True
VL_EUMIN REAL Engineering unit: Output, Low 0 True
VL_EUMAX REAL Engineering unit: Output, High 100 True
VL REAL Computer Output, typically written to 0 True
by an operator command
QC_OUT_IN BYTE Quality Code input for output OUT 16#80 True Quality Code
(Page 11)
VLL REAL OUT low limit input -3.3 True
VLH REAL OUT high limit input 103.3 True
H_LIM REAL The value (in engineering units) to 100 True
which the (PV) input is compared for
the High alarm.
H_DB REAL The amount of engineering units by 0.5 True
which (PV) must be within the limit for
the High alarm to clear.
H_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the High limit to trip an 24d20h31m23s647ms
alarm.
H_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the High limit and deadband to 24d20h31m23s647ms
cause the alarm to clear.

APACS+ ES Library User's Guide for V7.1


120 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

Name Data Explanation Initial OC&M Valid Values


Type
L_LIM REAL The value (in engineering units) to 0 True
which the (PV) input is compared for
the Low alarm.
L_DB REAL The amount of engineering units by 0.5 True
which (PV) must be within the limit for
the Low alarm to clear.
L_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the Low limit to trip an 24d20h31m23s647ms
alarm.
L_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the Low limit and deadband to 24d20h31m23s647ms
cause the alarm to clear.
HD_LIM REAL The value (in engineering units) to 0 True
which (PV) – (DEV) is compared for
the High Deviation alarm.
HD_DB REAL The amount of engineering units by 0.5 True
which (PV) – (DEV) must be within the
limit for the High Deviation alarm to
clear.
HD_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the High Deviation 24d20h31m23s647ms
limit to trip an alarm.
HD_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the High Deviation limit and 24d20h31m23s647ms
deadband to cause the alarm to clear.
LD_LIM REAL The value (in engineering units) to 0 True
which (DEV) - (PV) is compared for the
Low Deviation alarm.
LD_DB REAL The amount of engineering units by 0.5 True
which (DEV) - (PV) must be within the
limit for the Low Deviation alarm to
clear.
LD_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the Low Deviation 24d20h31m23s647ms
limit to trip an alarm.
LD_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the Low Deviation limit and 24d20h31m23s647ms
deadband to cause the alarm to clear.
AD_LIM REAL The value (in engineering units) to 100 True
which ABS((PV) – (DEV)) is compared
for the Absolute Deviation alarm.
AD_DB REAL The amount of engineering units by 0.5 True
which ABS((PV) – (DEV)) must be
within the limit for the Absolute
Deviation alarm to clear.
AD_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the Absolute 24d20h31m23s647ms
Deviation limit to trip an alarm.

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 121
ES Library
1.2 Library Function Blocks

Name Data Explanation Initial OC&M Valid Values


Type
AD_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the Absolute Deviation limit and 24d20h31m23s647ms
deadband to cause the alarm to clear.
HH_LIM REAL The value (in engineering units) to 0 True
which the (PV) input is compared for
the High High alarm.
HH_DB REAL The amount of engineering units by 0.5 True
which (PV) must be within the limit for
the High High alarm to clear.
HH_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the High High limit to 24d20h31m23s647ms
trip an alarm.
HH_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the High High limit and 24d20h31m23s647ms
deadband to cause the alarm to clear.
LL_LIM REAL The value (in engineering units) to 0 True
which the (PV) input is compared for
the Low Low alarm.
LL_DB REAL The amount of engineering units by 0.5 True
which (PV) must be within the limit for
the Low Low alarm to clear.
LL_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the Low Low limit to 24d20h31m23s647ms
trip an alarm.
LL_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the Low Low limit and deadband 24d20h31m23s647ms
to cause the alarm to clear.
IR_LIM REAL The value (in engineering units per 0 True
minute) to which the (PV) input is
compared for the Increasing Rate of
Change alarm.
IR_DB REAL The amount of engineering units by 0.5 True
which (PV) must be within the limit for
the Increasing Rate of Change alarm
to clear.
IR_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the Increasing Rate of 24d20h31m23s647ms
Change limit to trip an alarm.
IR_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the Increasing Rate of Change 24d20h31m23s647ms
limit and deadband to cause the alarm
to clear.
DR_LIM REAL The value (in engineering units per 0 True
minute) to which the (PV) input is
compared for the Decreasing Rate of
Change alarm.
DR_DB REAL The amount of engineering units by 0.5 True
which (PV) must be within the limit for
the Decreasing Rate of Change alarm
to clear.

APACS+ ES Library User's Guide for V7.1


122 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

Name Data Explanation Initial OC&M Valid Values


Type
DR_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the Decreasing Rate 24d20h31m23s647ms
of Change limit to trip an alarm.
DR_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the Decreasing Rate of Change 24d20h31m23s647ms
limit and deadband to cause the alarm
to clear.
AR_LIM REAL The value (in engineering units per 0 True
minute) to which the (PV) input is
compared for the Absolute Rate of
Change alarm.
AR_DB REAL The amount of engineering units by 0.5 True
which (PV) must be within the limit for
the Absolute Rate of Change alarm to
clear.
AR_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the Absolute Rate of 24d20h31m23s647ms
Change limit to trip an alarm.
AR_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the Absolute Rate of Change 24d20h31m23s647ms
limit and deadband to cause the alarm
to clear.
OOR_DELAYIN TIME The amount of time the input must be T#0MS False 0 to
outside the limits EINH, EINL to trip the 24d20h31m23s647ms
Out of Range alarm.
OOR_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the limits EINH, EINL to cause 24d20h31m23s647ms
the Out of Range alarm to clear.
QUAL_DELAYIN TIME The amount of time the input quality T#0MS False 0 to
must be bad to trip the Quality Not 24d20h31m23s647ms
Good alarm.
QUAL_DELAYOUT TIME The amount of time the input quality T#0MS False 0 to
must be good to cause the Quality Not 24d20h31m23s647ms
Good alarm to clear.
DISABLE_ON_OOS BOOL When set to TRUE, the block is False False
disabled if (OOS) is also TRUE.
RATIO_MIN REAL Minimum value of the ratio 0 True
RATIO_MAX REAL Maximum value of the ratio 1 True
RAT_DES REAL Desired ratio of PV to EXT_INP 0 True

See also
RATIO_SET: Ratio Setpoint Controller (Page 113)

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 123
ES Library
1.2 Library Function Blocks

1.2.19 SECONDARY_BLK

1.2.19.1 SECONDARY: Secondary Controller

Function Block Name SECONDARY_BLK


(compiled version of the Chart)
Function Block Number FB610
Chart Name SECONDARY
See also, Template Chart PRIMARY_SECONDARY_AT
(usage example)

Function
The Secondary Controller (SECONDARY_BLK) block is a factory-compiled function block. It
is intended for use as an external-set PID controller with tracking setpoint as part of a
cascade circuit. The SECONDARY_BLK block is designed to be used with the
PRIMARY_BLK block to form a cascade circuit when it is preferable to control the primary
and secondary loops separately. Normally, the output from the primary loop is to be the
setpoint to the secondary loop, and the cascade status of the secondary loop is to be fed to
the primary loop. High and low alarms are provided for the process variable, and an alarm is
provided for absolute deviation between process variable and setpoint.
SECONDARY_BLK is a compiled version of the SECONDARY source chart. Within the
chart, there is a control loop that contains SETPNT_AFB, PID_AFB, and AM_AFB blocks
along with alarming logic.
The SETPOINT block supplies the setpoint [SP] to the CONTROLLER block. The
SETPOINT block has a ramping feature for internal mode (EXT=FALSE). In external mode
(EXT=TRUE), the external setpoint [ESP] becomes the controller setpoint, and the
SETPOINT block internal setpoint ISP tracks the external setpoint, thereby ensuring no
change in setpoint during transition to internal mode. The setpoint tracks the process
variable [PV] in manual mode (AUTO=FALSE).
The CONTROLLER block is a PID_AFB block. It operates in auto mode (AUTO=TRUE) and
tracks the downstream output [OUT] in manual mode (AUTO=FALSE). The AUTO_MANUAL
block provides manual control of the output. In auto mode, the CONTROLLER block output
becomes the loop output [OUT]. In manual mode, the AUTO_MANUAL block internal output
IOUT becomes the loop output.

Calling OBs and Start-up


Calling OBs
This block is called in the watchdog interrupt OB into which the block is installed (for
example, OB32). Additionally, it is called in OB100 and in OB102 (see Start-up
Characteristics).
Start-up Characteristics
On a warm restart, OB100 is called and parameters retain the values they had immediately
before the restart. On a cold restart, OB102 is called and parameters are initialized with the
last downloaded values.

APACS+ ES Library User's Guide for V7.1


124 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

The warm and cold startup behavior of AUTO, SP, EXT, and OUT is configurable, allowing
the user to override the default PCS 7 behavior described above if necessary. As delivered,
AUTO will be forced to "Manual", EXT will be forced to "Internal" and OUT will be forced to
0.0 on a CPU restart. SP will be set in accordance with default PCS 7 behavior.
To force the AUTO parameter to a specified value on a restart, set the RSTRT_AUTO_FLAG
to true ("Force AUTO") and configure RSTRT_AUTO_VALUE with the desired forced value
("Auto" or "Manual"). The RSTRT_AUTO_VALUE will be used to initialize AUTO, if and only
if the RSTRT_AUTO_FLAG is true. If RSTRT_AUTO_FLAG is set to false ("Default"), the
AUTO parameter will be set in accordance with default PCS 7 behavior.
To force the SP parameter to a specified value on a restart, set the RSTRT_SP_FLAG to
true ("Force SP") and configure RSTRT_SP_VALUE with the desired forced value. The
RSTRT_SP_VALUE will be used to initialize SP, if and only if the RSTRT_SP_FLAG is true
and the block restarts in Auto mode (AUTO="Auto"). If RSTRT_SP_FLAG is set to false
("Default"), the SP parameter will be set in accordance with default PCS 7 behavior.
To force the EXT parameter to a specified value on a restart, set the RSTRT_EXT_FLAG to
true ("Force EXT") and configure RSTRT_EXT_VALUE with the desired forced value
("Internal or External"). The RSTRT_EXT_VALUE will be used to initialize EXT, if and only if
the RSTRT_EXT_FLAG is true. If RSTRT_EXT_FLAG is set to false ("Default"), the EXT
parameter will be set in accordance with default PCS 7 behavior. Forcing the EXT parameter
to "External" will cause the SP to be set to the ESP, thereby overriding the SP restart
parameter settings.
To force the OUT parameter to a specified value on a restart, set the RSTRT_OUT_FLAG to
true ("Force OUT") and configure RSTRT_OUT_VALUE with the desired forced value. The
RSTRT_OUT_VALUE will be used to initialize OUT, if and only if the RSTRT_OUT_FLAG is
true and the block restarts in Manual mode (AUTO = "Manual"). If RSTRT_OUT_FLAG is set
to false ("Default"), the OUT parameter will be set in accordance with default PCS 7
behavior.

WARNING
Using "Default" for the RSTRT_OUT_FLAG could result in your output device retaining its
last operating state after a restart. Similarly, using "Default" for the RSTRT_AUTO_FLAG
could result in your process running in automatic mode after a restart. Use "Forced" for the
restart flags and configure the associated restart values to ensure a known restart state.

If restart parameter values are changed offline, the configuration must be compiled (changes
only) and downloaded (changes only) to the controller in order for the settings to take effect
upon restart. If restart parameter values are changed online (via CFC Test mode), the
configuration must be compiled (entire program) and downloaded (entire program) to the
controller in order for the settings to take effect upon cold restart. This step is not necessary
for the online changes to take effect upon a warm restart.

Operator Control and Monitoring (M&C Relevant)


See Faceplate Information

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 125
ES Library
1.2 Library Function Blocks

Message Characteristics

Assignment of message texts and message class to the block parameters

Note
During runtime, the string $$BlockComment$$ will be replaced by the comment for the FB
instance that is in alarm.

ALARM_8P ID Message # Message Class Default Message Text


Message_class
EV_ID 1 Warning - above HIGH - $$BlockComment$$ - Limit = @4%f@
EV_ID 2 Warning - below LOW - $$BlockComment$$ - Limit = @5%f@
EV_ID 3 Alarm - above HIGH_DEV - $$BlockComment$$ - Limit = @6%f@
EV_ID 4 Alarm - below LOW_DEV - $$BlockComment$$ - Limit = @7%f@
EV_ID 5 Alarm - above ABSOLUTE_DEV - $$BlockComment$$ - Limit = @8%f@
EV_ID 6 PLC Process Control OUT_OF_RANGE - $$BlockComment$$
Message - Failure
EV_ID 7 PLC Process Control QUALITY_NOT_GOOD - $$BlockComment$$
Message - Failure
EV_ID2 1 Alarm - above HIGH_ HIGH - $$BlockComment$$ - Limit = @4%f@
EV_ID2 2 Alarm - below LOW_ LOW - $$BlockComment$$ - Limit = @5%f@
EV_ID2 3 Warning - above INC_ROC - $$BlockComment$$ - Limit = @6%f@
EV_ID2 4 Warning - below DEC_ROC - $$BlockComment$$ - Limit = @7%f@
EV_ID2 5 Warning - above ABS_ROC - $$BlockComment$$ - Limit = @8%f@

Assignment of auxiliary process values to the block parameters

ALARM_8P ID Value Block Parameter


EV_ID @1%s@ BA_NA
EV_ID @2%d@ BA_ID
EV_ID @3%d@ STEP_NO
EV_ID @4%f@ H_LIM
EV_ID @5%f@ L_LIM
EV_ID @6%f@ HD_LIM
EV_ID @7%f@ LD_LIM
EV_ID @8%f@ AD_LIM
EV_ID2 @1%s@ BA_NA
EV_ID2 @2%d@ BA_ID
EV_ID2 @3%d@ STEP_NO
EV_ID2 @4%f@ HH_LIM
EV_ID2 @5%f@ LL_LIM
EV_ID2 @6%f@ IR_LIM

APACS+ ES Library User's Guide for V7.1


126 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

ALARM_8P ID Value Block Parameter


EV_ID2 @7%f@ DR_LIM
EV_ID2 @8%f@ AR_LIM

See also
SECONDARY_BLK Input Output (Page 127)

1.2.19.2 SECONDARY_BLK Input Output

Input

Name Data Type Explanation Initial OC&M Valid


Values
PV REAL Process Variable 0 True
QC_PV BYTE Quality Code for PV 16#80 True Quality
Codes
(Page 11)
ESP REAL External Setpoint (output from primary 0 True
controller)
TSP REAL SP target value for SP ramping 0 True
H_EN BOOL Enable High Alarm True True
L_EN BOOL Enable Low Alarm True True
HD_EN BOOL Enable High Deviation Alarm False True
LD_EN BOOL Enable Low Deviation Alarm False True
AD_EN BOOL Enable Absolute Deviation Alarm True True
OOR_EN BOOL Enable Out of Range Alarm False True
QUAL_EN BOOL Enable Quality Not Good Alarm False True
HH_EN BOOL Enable High High Alarm False True
LL_EN BOOL Enable Low Low Alarm False True
IR_EN BOOL Enable Increasing Rate of Change Alarm False True
DR_EN BOOL Enable Decreasing Rate of Change Alarm False True
AR_EN BOOL Enable Absolute Rate of Change Alarm False True
OOS BOOL Out of Service indicator False True
QBAD BOOL Bad quality indicator False False
EV_ID DWORD Event ID DW#16#5 False
EV_ID2 DWORD Event ID DW#16#6 False
SAMPLE_T REAL Scan Rate. Use only when compiling CFC 0.1 False
as block type.
RSTRT_AUTO_FLAG BOOL Default: Retain on WS, Use load value on True False
CS. Force: Use RSTRT_AUTO_VALUE
on restart
RSTRT_AUTO_VALUE BOOL Init restart value for Auto Mode if False False
RSTRT_AUTO_FLAG true

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 127
ES Library
1.2 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid


Values
RSTRT_EXT_FLAG BOOL Default: Retain on WS, Use load value on True False
CS. Force: Use RSTRT_EXT_VALUE on
restart
RSTRT_EXT_VALUE BOOL Init restart value for EXTernal if False False
RSTRT_EXT_FLAG true
RSTRT_SP_FLAG BOOL Default: Retain on WS, Use load value on False False
CS. Force: Use RSTRT_SP_VALUE on
restart.
RSTRT_SP_VALUE REAL Init restart value for SP if 0 False
RSTRT_SP_FLAG true and Auto mode.
RSTRT_OUT_FLAG BOOL Default: Retain on WS, Use load value on True False
CS. Force: Use RSTRT_OUT_VALUE on
restart.
RSTRT_OUT_VALUE REAL Init restart value for OUT if 0 False
RSTRT_OUT_FLAG true and manual
mode
BA_EN BOOL Batch enabled False True
OCCUPIED BOOL Batch occupied False True
BA_ID DWORD Batch ID number 0 True
BA_NA STRING[32] Batch name '' True
STEP_NO DWORD Batch step number 0 True
DecimalPlacesPV INT Decimal places displayed in HMI for PV, 2 True
SP etc.
DecimalPlacesOUT INT Decimal places displayed in HMI for OUT, 2 True
OUT Limits
ConfirmChange BOOL If TRUE changes from HMI must be False True
confirmed
LIOP_MAN_SEL BOOL Select AUTO/MANUAL: 0 False
1 = Linking, 0 = Operator active
AUT_L BOOL Linkable input for AUTO/MANUAL mode, 0 False
1 = AUTO
LIOP_ ISP_SEL BOOL Select internal SP: 1 = from Link, 0 = from 0 False
Operator
SP_L REAL Linkable input for internal Setpoint 0.0 False
LIOP_OUT_SEL BOOL Select writing to OUT: 1 = from Link, 0 = 0 False
from Operator
OUT_L REAL Linkable input to be written to OUT 0.0 False

Note
This list differs significantly from the inputs of the SECONDARY_BLK block in APACS+. In
APACS+, only the PV and EXT_SP inputs are present. EXT_SP is now ESP.

APACS+ ES Library User's Guide for V7.1


128 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

Output

Name Data Type Explanation Initial OC&M Valid


Values
SP_OUT REAL Calculated set point value 0 False
OUT REAL Calculated output variable that 0 False
has been limited
QC_OUT BYTE Quality Code for output OUT 16#80 True Quality
Codes
(Page 11)
ALARM BOOL Alarm Status False False
CASC_S BOOL Cascade status True False
H_ALM BOOL When TRUE, the High alarm is False False
detected and enabled.
L_ALM BOOL When TRUE, the Low alarm is False False
detected and enabled.
HD_ALM BOOL When TRUE, the High Deviation False False
alarm is detected and enabled.
LD_ALM BOOL When TRUE, the Low Deviation False False
alarm is detected and enabled.
AD_ALM BOOL When TRUE, the Absolute False False
Deviation alarm is detected and
enabled.
OOR_ALM BOOL When TRUE, the Out of Range False False
alarm is detected and enabled.
QUAL_ALM BOOL When TRUE, the Quality Not False False
Good alarm is detected and
enabled.
HH_ALM BOOL When TRUE, the High High False False
alarm is detected and enabled.
LL_ALM BOOL When TRUE, the Low Low False False
alarm is detected and enabled.
IR_ALM BOOL When TRUE, the Increasing False False
Rate of Change alarm is
detected and enabled.
DR_ALM BOOL When TRUE, the Decreasing False False
Rate of Change alarm is
detected and enabled.
AR_ALM BOOL When TRUE, the Absolute Rate False False
of Change alarm is detected
and enabled.
VL_EUMIN_OUT REAL Copy of VL_EUMIN Input 0 False
VL_EUMAX_OUT REAL Copy of VL_EUMAX Input 0 False

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 129
ES Library
1.2 Library Function Blocks

Note
The SP output has been converted to SP_OUT. SP_OUT is used to interconnect the set-
point value to other entities on a chart. The OS interaction is handled by the SP InOut
parameter.

Input/output

Name Data Type Explanation Initial OC&M Valid Values


AUTO BOOL Auto/manual mode control False True
EXT BOOL Select between internal and False True
external setpoint
SP REAL Computer set point value 0 True
RAMP BOOL SP ramping on/off mode control False True
R_TIME TIME Ramp time T#0MS True 0 to
24d20h31m23s647ms
SPL REAL Set point low limit 0 True
SPH REAL Set point high limit 100 True
R_RATE REAL Ramp rate (in engineering units 0 True
per min)
USE_RR BOOL Ramp mode control. Use RTIME False True
or RRATE to control ramp
PV_TRACK BOOL Internal setpoint tracking control. True True
When Track, internal setpoint
tracks PV
PG REAL Proportional Gain 0.001 True 0.001 to 100.0
TI REAL Time-Integral Minutes per Reset 4000 True 0.0 to 4000.0
TD REAL Time-Derivative Minutes 0 True 0.00 to 100.0
DG REAL Derivative Gain 10 True 2.00 to 20.00
DIR BOOL Reverse or Direct action False True
ADAPTIVE_PG_INIT BOOL Adaptive Gain Init flag True False
PV_EUMIN REAL Engineering unit: Input, Low 0 True
PV_EUMAX REAL Engineering unit: Input, High 100 True
VL_EUMIN REAL Engineering unit: Output, Low 0 True
VL_EUMAX REAL Engineering unit: Output, High 100 True
VL REAL Computer Output, typically written 0 True
to by an operator command
QC_OUT_IN BYTE Quality Code input for output OUT 16#80 True Quality Codes
(Page 11)
VLL REAL OUT low limit input -3.3 True
VLH REAL OUT high limit input 103.3 True
H_LIM REAL The value (in engineering units) to 100 True
which the (PV) input is compared
for the High alarm.

APACS+ ES Library User's Guide for V7.1


130 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid Values


H_DB REAL The amount of engineering units 0.5 True
by which (PV) must be within the
limit for the High alarm to clear.
H_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the High limit to 24d20h31m23s647ms
trip an alarm.
H_DELAYOUT TIME The amount of time the input must T#0MS False 0 to
be within the High limit and 24d20h31m23s647ms
deadband to cause the alarm to
clear.
L_LIM REAL The value (in engineering units) to 0 True
which the (PV) input is compared
for the Low alarm.
L_DB REAL The amount of engineering units 0.5 True
by which (PV) must be within the
limit for the Low alarm to clear.
L_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the Low limit to 24d20h31m23s647ms
trip an alarm.
L_DELAYOUT TIME The amount of time the input must T#0MS False 0 to
be within the Low limit and 24d20h31m23s647ms
deadband to cause the alarm to
clear.
HD_LIM REAL The value (in engineering units) to 0 True
which (PV) – (DEV) is compared
for the High Deviation alarm.
HD_DB REAL The amount of engineering units 0.5 True
by which (PV) – (DEV) must be
within the limit for the High
Deviation alarm to clear.
HD_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the High 24d20h31m23s647ms
Deviation limit to trip an alarm.
HD_DELAYOUT TIME The amount of time the input must T#0MS False 0 to
be within the High Deviation limit 24d20h31m23s647ms
and deadband to cause the alarm
to clear.
LD_LIM REAL The value (in engineering units) to 0 True
which (DEV) - (PV) is compared
for the Low Deviation alarm.
LD_DB REAL The amount of engineering units 0.5 True
by which (DEV) - (PV) must be
within the limit for the Low
Deviation alarm to clear.
LD_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the Low Deviation 24d20h31m23s647ms
limit to trip an alarm.
LD_DELAYOUT TIME The amount of time the input must T#0MS False 0 to
be within the Low Deviation limit 24d20h31m23s647ms
and deadband to cause the alarm
to clear.

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 131
ES Library
1.2 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid Values


AD_LIM REAL The value (in engineering units) to 100 True
which ABS((PV) – (DEV)) is
compared for the Absolute
Deviation alarm.
AD_DB REAL The amount of engineering units 0.5 True
by which ABS((PV) – (DEV)) must
be within the limit for the Absolute
Deviation alarm to clear.
AD_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the Absolute 24d20h31m23s647ms
Deviation limit to trip an alarm.
AD_DELAYOUT TIME The amount of time the input must T#0MS False 0 to
be within the Absolute Deviation 24d20h31m23s647ms
limit and deadband to cause the
alarm to clear.
HH_LIM REAL The value (in engineering units) to 0 True
which the (PV) input is compared
for the High High alarm.
HH_DB REAL The amount of engineering units 0.5 True
by which (PV) must be within the
limit for the High High alarm to
clear.
HH_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the High High 24d20h31m23s647ms
limit to trip an alarm.
HH_DELAYOUT TIME The amount of time the input must T#0MS False 0 to
be within the High High limit and 24d20h31m23s647ms
deadband to cause the alarm to
clear.
LL_LIM REAL The value (in engineering units) to 0 True
which the (PV) input is compared
for the Low Low alarm.
LL_DB REAL The amount of engineering units 0.5 True
by which (PV) must be within the
limit for the Low Low alarm to
clear.
LL_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the Low Low limit 24d20h31m23s647ms
to trip an alarm.
LL_DELAYOUT TIME The amount of time the input must T#0MS False 0 to
be within the Low Low limit and 24d20h31m23s647ms
deadband to cause the alarm to
clear.
IR_LIM REAL The value (in engineering units per 0 True
minute) to which the (PV) input is
compared for the Increasing Rate
of Change alarm.
IR_DB REAL The amount of engineering units 0.5 True
by which (PV) must be within the
limit for the Increasing Rate of
Change alarm to clear.

APACS+ ES Library User's Guide for V7.1


132 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid Values


IR_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the Increasing 24d20h31m23s647ms
Rate of Change limit to trip an
alarm.
IR_DELAYOUT TIME The amount of time the input must T#0MS False 0 to
be within the Increasing Rate of 24d20h31m23s647ms
Change limit and deadband to
cause the alarm to clear.
DR_LIM REAL The value (in engineering units per 0 True
minute) to which the (PV) input is
compared for the Decreasing Rate
of Change alarm.
DR_DB REAL The amount of engineering units 0.5 True
by which (PV) must be within the
limit for the Decreasing Rate of
Change alarm to clear.
DR_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the Decreasing 24d20h31m23s647ms
Rate of Change limit to trip an
alarm.
DR_DELAYOUT TIME The amount of time the input must T#0MS False 0 to
be within the Decreasing Rate of 24d20h31m23s647ms
Change limit and deadband to
cause the alarm to clear.
AR_LIM REAL The value (in engineering units per 0 True
minute) to which the (PV) input is
compared for the Absolute Rate of
Change alarm.
AR_DB REAL The amount of engineering units 0.5 True
by which (PV) must be within the
limit for the Absolute Rate of
Change alarm to clear.
AR_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the Absolute Rate 24d20h31m23s647ms
of Change limit to trip an alarm.
AR_DELAYOUT TIME The amount of time the input must T#0MS False 0 to
be within the Absolute Rate of 24d20h31m23s647ms
Change limit and deadband to
cause the alarm to clear.
OOR_DELAYIN TIME The amount of time the input must T#0MS False 0 to
be outside the limits EINH, EINL to 24d20h31m23s647ms
trip the Out of Range alarm.
OOR_DELAYOUT TIME The amount of time the input must T#0MS False 0 to
be within the limits EINH, EINL to 24d20h31m23s647ms
cause the Out of Range alarm to
clear.
QUAL_DELAYIN TIME The amount of time the input T#0MS False 0 to
quality must be bad to trip the 24d20h31m23s647ms
Quality Not Good alarm.

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 133
ES Library
1.2 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid Values


QUAL_DELAYOUT TIME The amount of time the input T#0MS False 0 to
quality must be good to cause the 24d20h31m23s647ms
Quality Not Good alarm to clear.
DISABLE_ON_OOS BOOL When set to TRUE, the block is False False
disabled if (OOS) is also TRUE.

See also
SECONDARY: Secondary Controller (Page 124)

1.2.20 SETPNT_AFB

1.2.20.1 SETPNT_AFB: Setpoint

Function Block Name SETPNT_AFB


Function Block Number FB502

Function
The Setpoint Function Block (Setpnt_AFB) manages the setpoint value (process operating
value) which can be derived from two user-specified sources:
● Internal setpoint (ISP)
● External setpoint (ESP)
The setpoint (SP) value is limited by both low and high limits (LOLIM and HILIM) to prevent
the setpoint from being inadvertently driven beyond a process operating limit. The internal
setpoint can be changed via the Computer Setpoint (CSP) or the Setpoint function block
itself (in track or ramp mode).
The Setpoint function block may write either the track variable, (PV) (presumably the control
loop process variable), or the External Setpoint (ESP) to its internal setpoint, depending on
the modes and options selected. The computer setpoint is written to by an operator
command. The SP value is assigned to CSP as well. All values are in engineering units.
The Setpoint function block has a ramping feature to create a ramping setpoint. Ramping is
allowed only when the AUTO input is TRUE and the EXTRNL input is FALSE. The ramp
start-point is the ISP value. The TARGET value is the intended endpoint. Either a ramp time
(RTIME) or a ramp rate (RRATE) controls the ramp slope. The USE_RRATE_SW switch
determines which value is used: FALSE for RTIME, TRUE for RRATE. When the RAMP
value makes a FALSE-to-TRUE transition, the block initializes the ramp mode. As long as
the RAMP and AUTO values are TRUE, and the EXTRNL value is FALSE, ramping is in
effect. The SETPNT_AFB function block does not ramp while in either manual or external
modes. If the block goes into external or manual while it previously had been in automatic
and ramping, the ramping mode is turned off. To re-enable ramping, the block has to be
placed into internal mode (EXTRNL = FALSE) and automatic mode (AUTO =TRUE), and
then placed in the ramp mode (RAMP = TRUE). The SP output value reflects the ramping of
the block and the RTIME output value decrements to show the remaining ramp time. The
RRATE value must always be entered as positive; ramp direction is based on the

APACS+ ES Library User's Guide for V7.1


134 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

relationship of the target and the starting point. The RRATE value is updated if the RTIME
value is used, and the RTIME value is updated if the RRATE value is used. When the
TARGET value has been reached, the RAMP input is reset.
The HOLD mode is in effect if the RAMP input value changes from TRUE to FALSE while
the RTIME value is greater than zero. The HOLD output value = TRUE to indicate this mode.
While in the hold mode, the SP output value is held at its last value. After a FALSE-to-TRUE
transition of the RAMP input while the RTIME value is greater than zero, but less than its
initial value, the ramp mode is continued. The ramp mode can be continued in two different
ways. First, if none of the three ramp values (TARGET, RTIME or RRATE) have changed,
the ramp is continued using the same ramp rate as previous to the HOLD mode, and the
current ISP as the restart value; however, the remaining ramp time (RTIME) value is
recalculated. Secondly, if any of the three ramp values (TARGET, RTIME, or RRATE) have
changed, the new inputs are used just as if the ramp mode was being initialized for the first
time. To cancel a ramp, first place the block in hold mode (RAMP = FALSE), then set the
RTIME value to zero for a time mode ramp, or set the RRATE value to zero for a rate mode
ramp.

Note
When a ramp is finished, the RAMP input/output is reset (RAMP = FALSE).

Calling OBs and Start-up


Calling OBs
This block is called in the watchdog interrupt OB into which the block is installed (for
example, OB32). Additionally, it is called in OB100 and in OB102 (see start-up
characteristics).
Start-up Characteristics
On a warm restart, OB100 is called and parameters retain the values they had immediately
before the restart. On a cold restart, OB102 is called and parameters are initialized with the
last downloaded values.
The warm and cold startup behavior of AUTO and SP is configurable, allowing the user to
override the default PCS 7 behavior above if necessary. As delivered, AUTO will be forced to
"Manual" and EXT will be forced to "Internal" on a CPU restart. SP will be set in accordance
with default PCS 7 behavior.

WARNING
Using "Default" for the RSTRT_AUTO_FLAG could result in your process running in
automatic mode after a restart. Use "Forced" for the restart flags and configure the
associated restart values to ensure a known restart state.

To force the AUTO parameter to a specified value on a restart, set the RSTRT_AUTO_FLAG
to true ("Force AUTO") and configure RSTRT_AUTO_VALUE with the desired forced value
("Auto" or "Manual"). The RSTRT_AUTO_VALUE will be used to initialize AUTO, if and only
if the RSTRT_AUTO_FLAG is true. If RSTRT_AUTO_FLAG is set to false ("Default"), the
AUTO parameter will be set in accordance with default PCS 7 behavior.
To force the SP parameter to a specified value on a restart, set the RSTRT_SP_FLAG to
true ("Force SP") and configure RSTRT_SP_VALUE with the desired forced value. The

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 135
ES Library
1.2 Library Function Blocks

RSTRT_SP_VALUE will be used to initialize SP, if and only if the RSTRT_SP_FLAG is true
and the block restarts in Auto mode (AUTO="Auto"). If RSTRT_SP_FLAG is set to false
("Default"), the SP parameter will be set in accordance with default PCS 7 behavior.
To force the EXT parameter to a specified value on a restart, set the RSTRT_EXT_FLAG to
true ("Force EXT") and configure RSTRT_EXT_VALUE with the desired forced value
("Internal or External"). The RSTRT_EXT_VALUE will be used to initialize EXT, if and only if
the RSTRT_EXT_FLAG is true. If RSTRT_EXT_FLAG is set to false ("Default"), the EXT
parameter will be set in accordance with default PCS 7 behavior. Forcing the EXT parameter
to "External" will cause the SP to be set to the ESP, thereby overriding the SP restart
parameter settings.
If restart parameter values are changed offline, the configuration must be compiled (changes
only) and downloaded (changes only) to the controller in order for the settings to take effect
upon restart. If restart parameter values are changed online (via CFC Test mode), the
configuration must be compiled (entire program) and downloaded (entire program) to the
controller in order for the settings to take effect upon cold restart. This step is not necessary
for the online changes to take effect upon a warm restart.

Operator Control and Monitoring (M&C Relevant)


There is no associated faceplate for this block.

See also
SETPNT_AFB Input Output (Page 136)

1.2.20.2 SETPNT_AFB Input Output

Input

Name Data Type Explanation Initial OC&M Valid


Values
PV REAL Process Variable 0 False
ESP REAL External Setpoint 0 False
TARGET REAL Target value for setpoint ramping 0 True
RSTRT_AUTO_FLAG BOOL Default: Retain on WS, Use load val on CS. True False
Force: Use RSTRT_AUTO_VALUE on
restart
RSTRT_AUTO_VALUE BOOL Init restart vlaue for Auto Mode if False False
RSTART_AUTO_FLAG true
RSTRT_EXT_FLAG BOOL Default: Retain on WS, Use load val on CS. True False
Force: Use RESTRT_EXT_VALUE on restart
RSTRT_EXT_VALUE BOOL Init restart value on restart False False
RSTRT_SP_FLAG BOOL Default: Retain on WS, Use load val on CS. False False
Force: Use RSTRT_SP_VALUE on start
RSTRT_SP_VALUE REAL Init restart value for SP if RSTRT_SP_FLAG 0 False
true and Auto mode

APACS+ ES Library User's Guide for V7.1


136 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

Note
This list differs from the inputs of the SETPNT_AFB block in APACS+ as follows:
• New parameters were added for restart functionality.
• AUTO and RAMP have been moved from input to input/output.

Output

Name Data Type Explanation Initial OC&M Valid Values


SP REAL Calculated setpoint value 0 False
ISP REAL Internal setpoint value 0 False
LL BOOL Low Limit False False
HL BOOL High Limit False False
HOLD BOOL Ramping mode flag False False
(T=ramping, F=held)

Note
This list differs from the outputs of the SETPNT_AFB block in APACS+ as follows:
• RTIME has been moved from output to input/output.

Input/output

Name Data Type Explanation Initial OC&M Valid Values


AUTO BOOL Auto/manual mode control False False
EXTRNL BOOL External/internal mode control False False
CSP REAL Computer Setpoint 0 True
RAMP BOOL Setpoint is ranping when True False True
RTIME TIME Ramp Time 0ms True
SLIST_SP REAL Internal setpoint 0 False
LOLIM REAL Lower allowable limit of setpoint 100.0 True
HILIM REAL Upper allowable limit of setpoint 0 True
RRATE REAL Ramp rate (in eng. Units/min) 0 True
USE_RRATE_SW BOOL Selects Ramp Rate or Ramp Time as the False True
basis for computing ramping speed
PVTRK BOOL From APACS+ Help File True True
ESPTRK BOOL From APACS+ Help File True False
AUTO_RSTRT BOOL Loads AUTO Value up on Restart False False

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 137
ES Library
1.2 Library Function Blocks

Note
This list differs from the softlist parameters of the SETPNT_AFB block in APACS+ as follows:
• AUTO and RAMP have been moved from input to input/output.
• RTIME has been moved from output to input/output.

See also
SETPNT_AFB: Setpoint (Page 134)

1.2.21 SINGLE_LOOP_BLK

1.2.21.1 SINGLE_LOOP_BLK

Function Block Name SINGLE_LOOP_BLK


(compiled version of the Chart)
Function Block Number FB611
Chart Name SINGLE_LOOP
See also, Template Chart SINGLE_LOOP_AT
(usage example)

Function
The Single Loop Controller (SINGLE_LOOP_BLK) block is a factory-compiled function block.
It is intended for use as a single-loop PID controller with a tracking setpoint. Both high and
low alarms are provided for the process variable. Another alarm is provided to detect an
absolute deviation between the process variable and setpoint.
SINGLE_LOOP_BLK is a compiled version of the SINGLE_LOOP source chart. Within the
chart, there is a control loop that contains SETPNT_AFB, PID_AFB, and AM_AFB blocks
along with alarming logic.
The SETPOINT block supplies the setpoint [SP] to the CONTROLLER block. The
SETPOINT block has a ramping feature for auto mode. The setpoint tracks the process
variable [PV] in manual mode (AUTO=FALSE). The CONTROLLER block is a PID_AFB
block. It operates in auto mode (AUTO=TRUE) and tracks the downstream output [OUT] in
manual mode (AUTO=FALSE). The AUTO_MANUAL block provides manual control of the
output. In auto mode the CONTROLLER block output becomes the loop output [OUT]. In
manual mode the AUTO_MANUAL block internal output IOUT becomes the loop output.

Calling OBs and Start-up


Calling OBs

APACS+ ES Library User's Guide for V7.1


138 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

This block is called in the watchdog interrupt OB into which the block is installed (for
example, OB32). Additionally, it is called in OB100 and in OB102 (see Start-up
Characteristics).
Start-up Characteristics
On a warm restart, OB100 is called and parameters retain the values they had immediately
before the restart. On a cold restart, OB102 is called and parameters are initialized with the
last downloaded values.
The warm and cold startup behavior of AUTO, SP, and OUT is configurable, allowing the
user to override the default PCS 7 behavior described above if necessary. As delivered,
AUTO will be forced to "Manual" and OUT will be forced to 0.0 on a CPU restart. SP will be
set in accordance with default PCS 7 behavior.
To force the AUTO parameter to a specified value on a restart, set the RSTRT_AUTO_FLAG
to true ("Force AUTO") and configure RSTRT_AUTO_VALUE with the desired forced value
("Auto" or "Manual"). The RSTRT_AUTO_VALUE will be used to initialize AUTO, if and only
if the RSTRT_AUTO_FLAG is true. If RSTRT_AUTO_FLAG is set to false ("Default"), the
AUTO parameter will be set in accordance with default PCS 7 behavior.
To force the SP parameter to a specified value on a restart, set the RSTRT_SP_FLAG to
true ("Force SP") and configure RSTRT_SP_VALUE with the desired forced value. The
RSTRT_SP_VALUE will be used to initialize SP, if and only if the RSTRT_SP_FLAG is true
and the block restarts in Auto mode (AUTO="Auto"). If RSTRT_SP_FLAG is set to false
("Default"), the SP parameter will be set in accordance with default PCS 7 behavior.
To force the OUT parameter to a specified value on a restart, set the RSTRT_OUT_FLAG to
true ("Force OUT") and configure RSTRT_OUT_VALUE with the desired forced value. The
RSTRT_OUT_VALUE will be used to initialize OUT, if and only if the RSTRT_OUT_FLAG is
true and the block restarts in Manual mode (AUTO = "Manual"). If RSTRT_OUT_FLAG is set
to false ("Default"), the OUT parameter will be set in accordance with default PCS 7
behavior.

WARNING
Using "Default" for the RSTRT_OUT_FLAG could result in your output device retaining its
last operating state after a restart. Similarly, using "Default" for the RSTRT_AUTO_FLAG
could result in your process running in automatic mode after a restart. Use "Forced" for the
restart flags and configure the associated restart values to ensure a known restart state.

If restart parameter values are changed offline, the configuration must be compiled (changes
only) and downloaded (changes only) to the controller in order for the settings to take effect
upon restart. If restart parameter values are changed online (via CFC Test mode), the
configuration must be compiled (entire program) and downloaded (entire program) to the
controller in order for the settings to take effect upon cold restart. This step is not necessary
for the online changes to take effect upon a warm restart.

Operator Control and Monitoring (M&C Relevant)


See Faceplate Information

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 139
ES Library
1.2 Library Function Blocks

Message Characteristics

Assignment of message texts and message class to the block parameters

Note
During runtime, the string $$BlockComment$$ will be replaced by the comment for the FB
instance that is in alarm.

ALARM_8P ID Message # Message Class Default Message Text


Message_class
EV_ID 1 Warning - above HIGH - $$BlockComment$$ - Limit = @4%f@
EV_ID 2 Warning - below LOW - $$BlockComment$$ - Limit = @5%f@
EV_ID 3 Alarm - above HIGH_DEV - $$BlockComment$$ - Limit = @6%f@
EV_ID 4 Alarm - below LOW_DEV - $$BlockComment$$ - Limit = @7%f@
EV_ID 5 Alarm - above ABSOLUTE_DEV - $$BlockComment$$ - Limit = @8%f@
EV_ID 6 PLC Process Control OUT_OF_RANGE - $$BlockComment$$
Message - Failure
EV_ID 7 PLC Process Control QUALITY_NOT_GOOD - $$BlockComment$$
Message - Failure
EV_ID2 1 Alarm - above HIGH_ HIGH - $$BlockComment$$ - Limit = @4%f@
EV_ID2 2 Alarm - below LOW_ LOW - $$BlockComment$$ - Limit = @5%f@
EV_ID2 3 Warning - above INC_ROC - $$BlockComment$$ - Limit = @6%f@
EV_ID2 4 Warning - below DEC_ROC - $$BlockComment$$ - Limit = @7%f@
EV_ID2 5 Warning - above ABS_ROC - $$BlockComment$$ - Limit = @8%f@

Assignment of auxiliary process values to the block parameters

ALARM_8P ID Value Block Parameter


EV_ID @1%s@ BA_NA
EV_ID @2%d@ BA_ID
EV_ID @3%d@ STEP_NO
EV_ID @4%f@ H_LIM
EV_ID @5%f@ L_LIM
EV_ID @6%f@ HD_LIM
EV_ID @7%f@ LD_LIM
EV_ID @8%f@ AD_LIM
EV_ID2 @1%s@ BA_NA
EV_ID2 @2%d@ BA_ID
EV_ID2 @3%d@ STEP_NO
EV_ID2 @4%f@ HH_LIM
EV_ID2 @5%f@ LL_LIM
EV_ID2 @6%f@ IR_LIM

APACS+ ES Library User's Guide for V7.1


140 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

ALARM_8P ID Value Block Parameter


EV_ID2 @7%f@ DR_LIM
EV_ID2 @8%f@ AR_LIM

See also
SINGLE_LOOP_BLK Input Output (Page 141)

1.2.21.2 SINGLE_LOOP_BLK Input Output

Input

Name Data Type Explanation Initial OC&M Valid


Values
PV REAL Process Variable 0 True
QC_PV BYTE Quality Code for PV 16#80 True Quality
Codes
(Page 1
1)
INIT BOOL Transitions of the INIT False False
input cause the
initialization equation to be
performed.
TSP REAL SP target value for SP 0 True
ramping
H_EN BOOL Enable High Alarm True True
L_EN BOOL Enable Low Alarm True True
HD_EN BOOL Enable High Deviation False True
Alarm
LD_EN BOOL Enable Low Deviation False True
Alarm
AD_EN BOOL Enable Absolute Deviation True True
Alarm
OOR_EN BOOL Enable Out of Range False True
Alarm
QUAL_EN BOOL Enable Quality Not Good False True
Alarm
HH_EN BOOL Enable High High Alarm False True
LL_EN BOOL Enable Low Low Alarm False True
IR_EN BOOL Enable Increasing Rate of False True
Change Alarm
DR_EN BOOL Enable Decreasing Rate of False True
Change Alarm
AR_EN BOOL Enable Absolute Rate of False True
Change Alarm
OOS BOOL Out of Service indicator False True

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 141
ES Library
1.2 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid


Values
QBAD BOOL Bad quality indicator False False
EV_ID DWORD Event ID Compiler generated for the False
type or N/A if used as chart *
EV_ID2 DWORD Event ID Compiler generated for the False
type or N/A if used as chart*
SAMPLE_T REAL Current scan rate supplied Compiler generated for the False
by OS type or N/A if used as chart*
RSTRT_AUTO_FLAG BOOL Default: Retain on WS, True False
Use load val on CS. Force:
Use
RSTRT_AUTO_VALVE on
restart
RSTRT_AUTO_VALVE BOOL Init restart value for Auto False False
Mode if
RSTRT_AUTO_FLAG
RSTRT_SP_FLAG BOOL Default: Retain on WS, False False
Use load val on CS. Force:
Use RSTRT_SP_VALUE
on restart.
RSTRT_SP_VALUE REAL Init restart value for SP if 0 False
RSTRT_SP_FLAG true
and Auto mode.
RSTRT_OUT_FLAG BOOL Default: Retain on WS, True False
Use load val on CS. Force:
Use RSTRT_OUT_VALUE
on restart
RSTRT_OUT_VALUE REAL Init restart value for OUT if 0 False
RSTRT_OUT_FLAG true
and manual mode.
BA_EN BOOL Batch enabled False True
OCCUPIED BOOL Batch occupied False True
BA_ID DWORD Batch ID number 0 True
BA_NA STRING[32] Batch name '' True
STEP_NO DWORD Batch step number 0 True
DecimalPlacesPV INT Decimal places displayed 2 True
in HMI for PV, SP etc.
DecimalPlacesOUT INT Decimal places displayed 2 True
in HMI for OUT, OUT
Limits
ConfirmChange BOOL If TRUE changes from HMI False True
must be confirmed
LIOP_MAN_SEL BOOL Select AUTO/MANUAL: 0 False
1 = Linking, 0 = Operator
active
AUT_L BOOL Linkable input for 0 False
AUTO/MANUAL mode, 1 =
AUTO

APACS+ ES Library User's Guide for V7.1


142 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid


Values
LIOP_ ISP_SEL BOOL Select internal SP: 1 = 0 False
from Link, 0 = from
Operator
SP_L REAL Linkable input for internal 0.0 False
Setpoint
LIOP_OUT_SEL BOOL Select writing to OUT: 1 = 0 False
from Link, 0 = from
Operator
OUT_L REAL Linkable input to be written 0.0 False
to OUT

Output

Name Data Type Explanation Initial OC&M Valid


Values
SP_OUT REAL Calculated set point value 0 False
OUT REAL Calculated output variable that has been limited 0 False
QC_OUT BYTE Quality Code for output OUT 16#80 True Quality
Codes
(Page 11)
ALARM BOOL Alarm Status False False
H_ALM BOOL When TRUE, the High alarm is detected and False False
enabled.
L_ALM BOOL When TRUE, the Low alarm is detected and False False
enabled.
HD_ALM BOOL When TRUE, the High Deviation alarm is False False
detected and enabled.
LD_ALM BOOL When TRUE, the Low Deviation alarm is False False
detected and enabled.
AD_ALM BOOL When TRUE, the Absolute Deviation alarm is False False
detected and enabled.
OOR_ALM BOOL When TRUE, the Out of Range alarm is False False
detected and enabled.
QUAL_ALM BOOL When TRUE, the Quality Not Good alarm is False False
detected and enabled.
HH_ALM BOOL When TRUE, the High High alarm is detected False False
and enabled.
LL_ALM BOOL When TRUE, the Low Low alarm is detected False False
and enabled.
IR_ALM BOOL When TRUE, the Increasing Rate of Change False False
alarm is detected and enabled.
DR_ALM BOOL When TRUE, the Decreasing Rate of Change False False
alarm is detected and enabled.
AR_ALM BOOL When TRUE, the Absolute Rate of Change False False
alarm is detected and enabled.

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 143
ES Library
1.2 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid


Values
VL_EUMIN_OUT REAL Copy of VL_EUMIN Input 0 True
VL_EUMAX_OUT REAL Copy of VL_EUMAX Input 0 True

Note
The APACS+ output was renamed to SP_OUT to avoid conflict with the newly added SP
In/Out parameter. SP_OUT is used to interconnect the set-point value to other entities on a
chart. The OS interaction is handled by the SP In/Out parameter.

Input/output

Name Data Explanation Initial OC&M Valid Values


Type
AUTO BOOL Auto/manual mode control False True
SP REAL Computer set point value 0 True
RAMP BOOL SP ramping on/off mode control False True
R_TIME TIME Ramp time T#0MS True 0 to
24d20h31m23s647ms
SPL REAL Set point low limit 0 True
SPH REAL Set point high limit 100 True
R_RATE REAL Ramp rate (in engineering units per 0 True
min)
USE_RR BOOL Ramp mode control. Use RTIME or False True
RRATE to control ramp
PV_TRACK BOOL Internal setpoint tracking control. When True True
Track, internal setpoint tracks PV
PG REAL Proportional Gain 0.001 True 0.001 to 100.0
TI REAL Time-Integral Minutes per Reset 4000 True 0.0 to 4000.0
TD REAL Time-Derivative Minutes 0 True 0.00 to 100.0
DG REAL Derivative Gain 10 True 2.00 to 20.00
ADAPTIVE_PG_INIT BOOL Adaptive Gain Init flag True False
DIR BOOL Reverse or Direct action False True
PV_EUMIN REAL Engineering unit: Input, Low 0 True
PV_EUMAX REAL Engineering unit: Input, High 100 True
VL_EUMIN REAL Engineering unit: Output, Low 0 True
VL_EUMAX REAL Engineering unit: Output, High 100 True
VL REAL Computer Output, typically written to by 0 True
an operator command
QC_OUT_IN BYTE Quality Code input for output OUT 16#80 True Quality Codes
(Page 11)
VLL REAL OUT low limit input -3.3 True
VLH REAL OUT high limit input 103.3 True

APACS+ ES Library User's Guide for V7.1


144 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

Name Data Explanation Initial OC&M Valid Values


Type
H_LIM REAL The value (in engineering units) to 100 True
which the (PV) input is compared for
the High alarm.
H_DB REAL The amount of engineering units by 0.5 True
which (PV) must be within the limit for
the High alarm to clear.
H_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the High limit to trip an 24d20h31m23s647ms
alarm.
H_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the High limit and deadband to 24d20h31m23s647ms
cause the alarm to clear.
L_LIM REAL The value (in engineering units) to 0 True
which the (PV) input is compared for
the Low alarm.
L_DB REAL The amount of engineering units by 0.5 True
which (PV) must be within the limit for
the Low alarm to clear.
L_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the Low limit to trip an 24d20h31m23s647ms
alarm.
L_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the Low limit and deadband to 24d20h31m23s647ms
cause the alarm to clear.
HD_LIM REAL The value (in engineering units) to 0 True
which (PV) – (DEV) is compared for the
High Deviation alarm.
HD_DB REAL The amount of engineering units by 0.5 True
which (PV) – (DEV) must be within the
limit for the High Deviation alarm to
clear.
HD_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the High Deviation 24d20h31m23s647ms
limit to trip an alarm.
HD_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the High Deviation limit and 24d20h31m23s647ms
deadband to cause the alarm to clear.
LD_LIM REAL The value (in engineering units) to 0 True
which (DEV) - (PV) is compared for the
Low Deviation alarm.
LD_DB REAL The amount of engineering units by 0.5 True
which (DEV) - (PV) must be within the
limit for the Low Deviation alarm to
clear.
LD_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the Low Deviation limit 24d20h31m23s647ms
to trip an alarm.
LD_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the Low Deviation limit and 24d20h31m23s647ms
deadband to cause the alarm to clear.

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 145
ES Library
1.2 Library Function Blocks

Name Data Explanation Initial OC&M Valid Values


Type
AD_LIM REAL The value (in engineering units) to 100 True
which ABS((PV) – (DEV)) is compared
for the Absolute Deviation alarm.
AD_DB REAL The amount of engineering units by 0.5 True
which ABS((PV) – (DEV)) must be
within the limit for the Absolute
Deviation alarm to clear.
AD_DELAYIN TIME The amount of time the input must T#0MS False 0 to
reach or exceed the Absolute Deviation 24d20h31m23s647ms
limit to trip an alarm.
AD_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the Absolute Deviation limit and 24d20h31m23s647ms
deadband to cause the alarm to clear.
OOR_DELAYIN TIME The amount of time the input must be T#0MS False 0 to
outside the limits EINH, EINL to trip the 24d20h31m23s647ms
Out of Range alarm.
OOR_DELAYOUT TIME The amount of time the input must be T#0MS False 0 to
within the limits EINH, EINL to cause 24d20h31m23s647ms
the Out of Range alarm to clear.
QUAL_DELAYIN TIME The amount of time the input quality T#0MS False 0 to
must be bad to trip the Quality Not 24d20h31m23s647ms
Good alarm.
QUAL_DELAYOUT TIME The amount of time the input quality T#0MS False 0 to
must be good to cause the Quality Not 24d20h31m23s647ms
Good alarm to clear.
DISABLE_ON_OOS BOOL When set to TRUE, the block is False False
disabled if (OOS) is also TRUE.

See also
SINGLE_LOOP_BLK (Page 138)

1.2.22 SINGLE_LP_EM_BLK

1.2.22.1 SINGLE_LP_EM: Single Loop Controller with Emergency Manual

Function Block Name SINGLE_LP_EM_BLK


(compiled version of the Chart)
Function Block Number FB615
Chart Name SINGLE_LP_EM
See also, Template Chart SINGLE_LP_EM_AT
(usage example)

APACS+ ES Library User's Guide for V7.1


146 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

Function
The Single Loop Controller with Emergency Manual (SINGLE_LP_EM_BLK) block is a
factory-compiled function block. It is intended for use as a single-loop PID controller with
tracking setpoint and Emergency Manual functionality. The External Value and Emergency
Manual command inputs allow the controller output to be immediately forced to any desired
value. High and low alarms are provided for the process variable, and an additional alarm is
provided to detect an absolute deviation between the process variable and setpoint.
SINGLE_LP_EM_BLK is a compiled version of the SINGLE_LP_EM source chart. Within the
chart, there is a control loop that contains SETPNT_AFB, PID_AFB, and AM_AFB blocks
along with alarming logic.
The SETPOINT block supplies the setpoint [SP] to the CONTROLLER block. The
SETPOINT block has a ramping feature for auto mode. The setpoint tracks the process
variable [PV] in manual or emergency Manual mode (AUTO=FALSE or EM=TRUE). The
CONTROLLER block is a PID_AFB block; it operates when AUTO=TRUE and EM=FALSE
and tracks the downstream output [OUT] in manual or Emergency Manual mode. The
AUTO_MANUAL block provides Emergency Manual and manual control of the output. In
Emergency Manual mode, the external value [EXTV] becomes the loop output [OUT]. In auto
mode, the CONTROLLER block output becomes the loop output. In manual mode, the
AUTO_MANUAL block internal output (IOUT) becomes the loop output.

Calling OBs and Start-up


Calling OBs
This block is called in the watchdog interrupt OB into which the block is installed (for
example, OB32). Additionally, it is called in OB100 and in OB102 (see Start-up
Characteristics).
Start-up Characteristics
On a warm restart, OB100 is called and parameters retain the values they had immediately
before the restart. On a cold restart, OB102 is called and parameters are initialized with the
last downloaded values.
The warm and cold startup behavior of AUTO, SP, and OUT is configurable, allowing the
user to override the default PCS 7 behavior described above, if necessary. As delivered,
AUTO will be forced to "Manual" and OUT will be forced to 0.0 on a CPU restart. SP will be
set in accordance with default PCS 7 behavior.
To force the AUTO parameter to a specified value on a restart, set the RSTRT_AUTO_FLAG
to true ("Force AUTO") and configure RSTRT_AUTO_VALUE with the desired forced value
("Auto" or "Manual"). The RSTRT_AUTO_VALUE will be used to initialize AUTO, if and only
if the RSTRT_AUTO_FLAG is true. If RSTRT_AUTO_FLAG is set to false ("Default"), the
AUTO parameter will be set in accordance with default PCS 7 behavior.
To force the SP parameter to a specified value on a restart, set the RSTRT_SP_FLAG to
true ("Force SP") and configure RSTRT_SP_VALUE with the desired forced value. The
RSTRT_SP_VALUE will be used to initialize SP, if the RSTRT_SP_FLAG is true and either
● The block is forced to start in Auto mode, or
● AUTO is not forced and the block restarts with Auto mode (AUTO="Auto") and not in
Emergency Manual (EM = "False").
If RSTRT_SP_FLAG is set to false ("Default"), the SP parameter will be set in accordance
with default PCS 7 behavior.

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 147
ES Library
1.2 Library Function Blocks

To force the OUT parameter to a specified value on a restart, set the RSTRT_OUT_FLAG to
true ("Force OUT") and configure RSTRT_OUT_VALUE with the desired forced value. The
RSTRT_OUT_VALUE will be used to initialize OUT, if and only if the RSTRT_OUT_FLAG is
true and the block restarts in Manual mode (AUTO = "Manual"). If RSTRT_OUT_FLAG is set
to false ("Default"), the OUT parameter will be set in accordance with default PCS 7
behavior.

WARNING
Using "Default" for the RSTRT_OUT_FLAG could result in your output device retaining its
last operating state after a restart. Similarly, using "Default" for the RSTRT_AUTO_FLAG
could result in your process running in automatic mode after a restart. Use "Forced" for the
restart flags and configure the associated restart values to ensure a known restart state.

If restart parameter values are changed offline, the configuration must be compiled (changes
only) and downloaded (changes only) to the controller in order for the settings to take effect
upon restart. If restart parameter values are changed online (via CFC Test mode), the
configuration must be compiled (entire program) and downloaded (entire program) to the
controller in order for the settings to take effect upon cold restart. This step is not necessary
for the online changes to take effect upon a warm restart.

Operator Control and Monitoring (M&C Relevant)


See Faceplate Information

Message Characteristics

Assignment of message texts and message class to the block parameters

Note
During runtime, the string $$BlockComment$$ will be replaced by the comment for the FB
instance that is in alarm.

ALARM_8P ID Message # Message Class Default Message Text


Message_class
EV_ID 1 Warning - above HIGH - $$BlockComment$$ - Limit = @4%f@
EV_ID 2 Warning - below LOW - $$BlockComment$$ - Limit = @5%f@
EV_ID 3 Alarm - above HIGH_DEV - $$BlockComment$$ - Limit = @6%f@
EV_ID 4 Alarm - below LOW_DEV - $$BlockComment$$ - Limit = @7%f@
EV_ID 5 Alarm - above ABSOLUTE_DEV - $$BlockComment$$ - Limit =
@8%f@
EV_ID 6 PLC Process Control OUT_OF_RANGE - $$BlockComment$$
Message - Failure
EV_ID 7 PLC Process Control QUALITY_NOT_GOOD - $$BlockComment$$
Message - Failure

APACS+ ES Library User's Guide for V7.1


148 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

ALARM_8P ID Message # Message Class Default Message Text


Message_class
EV_ID2 1 Alarm - above HIGH_ HIGH - $$BlockComment$$ - Limit =
@4%f@
EV_ID2 2 Alarm - below LOW_ LOW - $$BlockComment$$ - Limit = @5%f@
EV_ID2 3 Warning - above INC_ROC - $$BlockComment$$ - Limit = @6%f@
EV_ID2 4 Warning - below DEC_ROC - $$BlockComment$$ - Limit = @7%f@
EV_ID2 5 Warning - above ABS_ROC - $$BlockComment$$ - Limit = @8%f@

Assignment of auxiliary process values to the block parameters

ALARM_8P ID Value Block Parameter


EV_ID @1%s@ BA_NA
EV_ID @2%d@ BA_ID
EV_ID @3%d@ STEP_NO
EV_ID @4%f@ H_LIM
EV_ID @5%f@ L_LIM
EV_ID @6%f@ HD_LIM
EV_ID @7%f@ LD_LIM
EV_ID @8%f@ AD_LIM
EV_ID2 @1%s@ BA_NA
EV_ID2 @2%d@ BA_ID
EV_ID2 @3%d@ STEP_NO
EV_ID2 @4%f@ HH_LIM
EV_ID2 @5%f@ LL_LIM
EV_ID2 @6%f@ IR_LIM
EV_ID2 @7%f@ DR_LIM
EV_ID2 @8%f@ AR_LIM

1.2.22.2 SINGLE_LP_EM_BLK Input Output

Input

Name Data Type Explanation Initial OC&M Valid


Values
PV REAL Process Variable 0 True
QC_PV BYTE Quality Code for PV 16#80 True Quality
Codes
(Page 11
)
EM BOOL Emergency Manual Command False True

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 149
ES Library
1.2 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid


Values
INIT BOOL Transitions of the INIT input False False
cause the initialization equation
to be performed.
TSP REAL SP target value for SP ramping 0 True
H_EN BOOL Enable High Alarm True True
L_EN BOOL Enable Low Alarm True True
HD_EN BOOL Enable High Deviation Alarm False True
LD_EN BOOL Enable Low Deviation Alarm False True
AD_EN BOOL Enable Absolute Deviation True True
Alarm
OOR_EN BOOL Enable Out of Range Alarm False True
QUAL_EN BOOL Enable Quality Not Good Alarm False True
HH_EN BOOL Enable High High Alarm False True
LL_EN BOOL Enable Low Low Alarm False True
IR_EN BOOL Enable Increasing Rate of False True
Change Alarm
DR_EN BOOL Enable Decreasing Rate of False True
Change Alarm
AR_EN BOOL Enable Absolute Rate of False True
Change Alarm
OOS BOOL Out of Service indicator False True
QBAD BOOL Bad quality indicator False False
EV_ID DWORD Event ID Compiler generated for the False
type or N/A if used as chart
*
EV_ID2 DWORD Event ID Compiler generated for the False
type or N/A if used as chart
*
SAMPLE_T REAL Current scan rate supplied by Compiler generated for the False
OS type or N/A if used as chart
*
RSTRT_AUTO_FLAG BOOL Default: Retain on WS, Use True False
load val on CS. Force: Use
RSTRT_AUTO_VALUE
RSTRT_AUTO_VALUE BOOL Init restart value for Auto Mode False False
if RSTRT_AUTO_FLAG true
RSTRT_SP_FLAG BOOL Default: Retain on WS, Use False False
load val on CS. Force: Use
RSTRT_SP_VALUE on restart
RSTRT_SP_VALUE REAL Init restart value for SP if 0 False
RSTRT_SP_FLAG true and
Auto mode
RSTRT_OUT_FLAG BOOL Default: Retain on WS, Use True False
load val on CS. Force: Use
RSTRT_OUT_VALUE on
restart.

APACS+ ES Library User's Guide for V7.1


150 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid


Values
RSTRT_OUT_VALUE REAL Init restart value for OUT if 0 False
RSTRT_OUT_FLAG true and
manual mode
BA_EN BOOL Batch enabled False True
OCCUPIED BOOL Batch occupied False True
BA_ID DWORD Batch ID number 0 True
BA_NA STRING[32] Batch name '' True
STEP_NO DWORD Batch step number 0 True
DecimalPlacesPV INT Decimal places displayed in 2 True
HMI for PV, SP etc.
DecimalPlacesOUT INT Decimal places displayed in 2 True
HMI for OUT, OUT Limits
ConfirmChange BOOL If TRUE changes from HMI False True
must be confirmed
LIOP_MAN_SEL BOOL Select AUTO/MANUAL: 0 False
1 = Linking, 0 = Operator active
AUT_L BOOL Linkable input for 0 False
AUTO/MANUAL mode, 1 =
AUTO
LIOP_ ISP_SEL BOOL Select internal SP: 1 = from 0 False
Link, 0 = from Operator
SP_L REAL Linkable input for internal 0.0 False
Setpoint
LIOP_OUT_SEL BOOL Select writing to OUT: 1 = from 0 False
Link, 0 = from Operator
OUT_L REAL Linkable input to be written to 0.0 False
OUT

Note
This list differs significantly from the inputs of the SINGLE_LP_EM_BLK block in APACS+.
The APACS+ list only includes the PV, EXTV, and EM inputs.
*The Update Sampling Time option must be checked when compiling a chart that contains
the SINGLE_LP_EM_BLK for this value to be automatically generated by the compiler.

Output

Name Data Explanation Initial OC&M Valid


Type Values
SP_OUT REAL Calculated set point value 0 False
OUT REAL Calculated output variable that has 0 False
been limited

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 151
ES Library
1.2 Library Function Blocks

Name Data Explanation Initial OC&M Valid


Type Values
QC_OUT BYTE Quality Code for output OUT 16#80 True Quality
Code
(Page 1
1)
ALARM BOOL Alarm Status False False
H_ALM BOOL When TRUE, the High alarm is False False
detected and enabled.
L_ALM BOOL When TRUE, the Low alarm is False False
detected and enabled.
HD_ALM BOOL When TRUE, the High Deviation alarm False False
is detected and enabled.
LD_ALM BOOL When TRUE, the Low Deviation alarm False False
is detected and enabled.
AD_ALM BOOL When TRUE, the Absolute Deviation False False
alarm is detected and enabled.
OOR_ALM BOOL When TRUE, the Out of Range alarm False False
is detected and enabled.
QUAL_ALM BOOL When TRUE, the Quality Not Good False False
alarm is detected and enabled.
HH_ALM BOOL When TRUE, the High High alarm is False False
detected and enabled.
LL_ALM BOOL When TRUE, the Low Low alarm is False False
detected and enabled.
IR_ALM BOOL When TRUE, the Increasing Rate of False False
Change alarm is detected and
enabled.
DR_ALM BOOL When TRUE, the Decreasing Rate of False False
Change alarm is detected and
enabled.
AR_ALM BOOL When TRUE, the Absolute Rate of False False
Change alarm is detected and
enabled.
VL_EUMIN_OUT REAL Copy of Engineering unit: Output, Low 0 False
VL_EUMAX_OUT REAL Copy of Engineering unit: Output, High 0 False

Note
The APACS+ SP output was renamed to SP_OUT to avoid conflict with the newly added SP
In/Out parameter. SP_OUT is used to interconnect the set-point value to other entities on a
chart. The OS interaction is handled by the SP In/Out parameter.

APACS+ ES Library User's Guide for V7.1


152 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

Input/ouput

Name Data Explanation Initial OC&M Valid Values


Type
AUTO BOOL Auto/manual mode control False True
SP REAL Computer set point value 0 True
RAMP BOOL SP ramping on/off mode control False True
R_TIME TIME Ramp time T#0MS True 0 to
24d20h31m23s647ms
SPL REAL Set point low limit 0 True
SPH REAL Set point high limit 100 True
R_RATE REAL Ramp rate (in engineering units per min) 0 True
USE_RR BOOL Ramp mode control. Use RTIME or RRATE False True
to control ramp
PV_TRACK BOOL Internal setpoint tracking control. When True True
Track, internal setpoint tracks PV
PG REAL Proportional Gain 0.001 True 0.001 to 100.0
TI REAL Time-Integral Minutes per Reset 4000 True 0.0 to 4000.0
TD REAL Time-Derivative Minutes 0 True 0.00 to 100.0
DG REAL Derivative Gain 10 True 2.00 to 20.00
DIR BOOL Reverse or Direct action False True
ADAPTIVE_PG_INIT BOOL Adaptive Gain Init flag True
PV_EUMIN REAL Engineering unit: Input, Low 0 True
PV_EUMAX REAL Engineering unit: Input, High 100 True
VL_EUMIN REAL Engineering unit: Output, Low 0 True
VL_EUMAX REAL Engineering unit: Output, High 100 True
VL REAL Computer Output, typically written to by an 0 True
operator command
QC_OUT_IN BYTE Quality Code input for output OUT 16#80 True Quality Codes
(Page 11)
VLL REAL OUT low limit input -3.3 True
VLH REAL OUT high limit input 103.3 True
H_LIM REAL The value (in engineering units) to which 100 True
the (PV) input is compared for the High
alarm.
H_DB REAL The amount of engineering units by which 0.5 True
(PV) must be within the limit for the High
alarm to clear.
H_DELAYIN TIME The amount of time the input must reach or T#0MS False 0 to
exceed the High limit to trip an alarm. 24d20h31m23s647ms
H_DELAYOUT TIME The amount of time the input must be within T#0MS False 0 to
the High limit and deadband to cause the 24d20h31m23s647ms
alarm to clear.
L_LIM REAL The value (in engineering units) to which 0 True
the (PV) input is compared for the Low
alarm.

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 153
ES Library
1.2 Library Function Blocks

Name Data Explanation Initial OC&M Valid Values


Type
L_DB REAL The amount of engineering units by which 0.5 True
(PV) must be within the limit for the Low
alarm to clear.
L_DELAYIN TIME The amount of time the input must reach or T#0MS False 0 to
exceed the Low limit to trip an alarm. 24d20h31m23s647ms
L_DELAYOUT TIME The amount of time the input must be within T#0MS False 0 to
the Low limit and deadband to cause the 24d20h31m23s647ms
alarm to clear.
HD_LIM REAL The value (in engineering units) to which 0 True
(PV) – (DEV) is compared for the High
Deviation alarm.
HD_DB REAL The amount of engineering units by which 0.5 True
(PV) – (DEV) must be within the limit for the
High Deviation alarm to clear.
HD_DELAYIN TIME The amount of time the input must reach or T#0MS False 0 to
exceed the High Deviation limit to trip an 24d20h31m23s647ms
alarm.
HD_DELAYOUT TIME The amount of time the input must be within T#0MS False 0 to
the High Deviation limit and deadband to 24d20h31m23s647ms
cause the alarm to clear.
LD_LIM REAL The value (in engineering units) to which 0 True
(DEV) - (PV) is compared for the Low
Deviation alarm.
LD_DB REAL The amount of engineering units by which 0.5 True
(DEV) - (PV) must be within the limit for the
Low Deviation alarm to clear.
LD_DELAYIN TIME The amount of time the input must reach or T#0MS False 0 to
exceed the Low Deviation limit to trip an 24d20h31m23s647ms
alarm.
LD_DELAYOUT TIME The amount of time the input must be within T#0MS False 0 to
the Low Deviation limit and deadband to 24d20h31m23s647ms
cause the alarm to clear.
AD_LIM REAL The value (in engineering units) to which 100 True
ABS((PV) – (DEV)) is compared for the
Absolute Deviation alarm.
AD_DB REAL The amount of engineering units by which 0.5 True
ABS((PV) – (DEV)) must be within the limit
for the Absolute Deviation alarm to clear.
AD_DELAYIN TIME The amount of time the input must reach or T#0MS False 0 to
exceed the Absolute Deviation limit to trip 24d20h31m23s647ms
an alarm.
AD_DELAYOUT TIME The amount of time the input must be within T#0MS False 0 to
the Absolute Deviation limit and deadband 24d20h31m23s647ms
to cause the alarm to clear.
HH_LIM REAL The value (in engineering units) to which 0 True
the (PV) input is compared for the High
High alarm.

APACS+ ES Library User's Guide for V7.1


154 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

Name Data Explanation Initial OC&M Valid Values


Type
HH_DB REAL The amount of engineering units by which 0.5 True
(PV) must be within the limit for the High
High alarm to clear.
HH_DELAYIN TIME The amount of time the input must reach or T#0MS False 0 to
exceed the High High limit to trip an alarm. 24d20h31m23s647ms
HH_DELAYOUT TIME The amount of time the input must be within T#0MS False 0 to
the High High limit and deadband to cause 24d20h31m23s647ms
the alarm to clear.
LL_LIM REAL The value (in engineering units) to which 0 True
the (PV) input is compared for the Low Low
alarm.
LL_DB REAL The amount of engineering units by which 0.5 True
(PV) must be within the limit for the Low
Low alarm to clear.
LL_DELAYIN TIME The amount of time the input must reach or T#0MS False 0 to
exceed the Low Low limit to trip an alarm. 24d20h31m23s647ms
LL_DELAYOUT TIME The amount of time the input must be within T#0MS False 0 to
the Low Low limit and deadband to cause 24d20h31m23s647ms
the alarm to clear.
IR_LIM REAL The value (in engineering units per minute) 0 True
to which the (PV) input is compared for the
Increasing Rate of Change alarm.
IR_DB REAL The amount of engineering units by which 0.5 True
(PV) must be within the limit for the
Increasing Rate of Change alarm to clear.
IR_DELAYIN TIME The amount of time the input must reach or T#0MS False 0 to
exceed the Increasing Rate of Change limit 24d20h31m23s647ms
to trip an alarm.
IR_DELAYOUT TIME The amount of time the input must be within T#0MS False 0 to
the Increasing Rate of Change limit and 24d20h31m23s647ms
deadband to cause the alarm to clear.
DR_LIM REAL The value (in engineering units per minute) 0 True
to which the (PV) input is compared for the
Decreasing Rate of Change alarm.
DR_DB REAL The amount of engineering units by which 0.5 True
(PV) must be within the limit for the
Decreasing Rate of Change alarm to clear.
DR_DELAYIN TIME The amount of time the input must reach or T#0MS False 0 to
exceed the Decreasing Rate of Change 24d20h31m23s647ms
limit to trip an alarm.
DR_DELAYOUT TIME The amount of time the input must be within T#0MS False 0 to
the Decreasing Rate of Change limit and 24d20h31m23s647ms
deadband to cause the alarm to clear.
AR_LIM REAL The value (in engineering units per minute) 0 True
to which the (PV) input is compared for the
Absolute Rate of Change alarm.
AR_DB REAL The amount of engineering units by which 0.5 True
(PV) must be within the limit for the
Absolute Rate of Change alarm to clear.

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 155
ES Library
1.2 Library Function Blocks

Name Data Explanation Initial OC&M Valid Values


Type
AR_DELAYIN TIME The amount of time the input must reach or T#0MS False 0 to
exceed the Absolute Rate of Change limit 24d20h31m23s647ms
to trip an alarm.
AR_DELAYOUT TIME The amount of time the input must be within T#0MS False 0 to
the Absolute Rate of Change limit and 24d20h31m23s647ms
deadband to cause the alarm to clear.
OOR_DELAYIN TIME The amount of time the input must be T#0MS False 0 to
outside the limits EINH, EINL to trip the Out 24d20h31m23s647ms
of Range alarm.
OOR_DELAYOUT TIME The amount of time the input must be within T#0MS False 0 to
the limits EINH, EINL to cause the Out of 24d20h31m23s647ms
Range alarm to clear.
QUAL_DELAYIN TIME The amount of time the input quality must T#0MS False 0 to
be bad to trip the Quality Not Good alarm. 24d20h31m23s647ms
QUAL_DELAYOUT TIME The amount of time the input quality must T#0MS False 0 to
be good to cause the Quality Not Good 24d20h31m23s647ms
alarm to clear.
DISABLE_ON_OOS BOOL When set to TRUE, the block is disabled if False False
(OOS) is also TRUE.

1.2.23 SINGLE_LP_SS_BLK

1.2.23.1 SINGLE_LP_SS: Single Loop Controller with Standby Sync

Function Block Name SINGLE_LP_SS_BLK


(compiled version of the Chart)
Function Block Number FB612
Chart Name SINGLE_LP_SS
See also, Template Chart SINGLE_LP_SS_AT
(usage example)

Function
The Single Loop Controller with Standby Sync (SINGLE_LP_SS_BLK) block is a factory-
compiled function block. It is intended for use as a single-loop PID controller with tracking
setpoint and standby sync functionality. The External Value and Standby Sync command
inputs allow the controller output to be immediately forced to any desired value. High and low
alarms are provided for the process variable, and an additional alarm is provided to detect an
absolute deviation between the process variable and setpoint.
SINGLE_LP_SS_BLK is a compiled version of the SINGLE_LP_SS source chart. Within the
chart, there is a control loop that contains SETPNT_AFB, PID_AFB, and AM_AFB blocks
along with alarming logic.
The SETPOINT block supplies the setpoint [SP] to the CONTROLLER block. The
SETPOINT block has a ramping feature for auto mode. The setpoint tracks the process

APACS+ ES Library User's Guide for V7.1


156 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

variable [PV] in manual or standby sync mode (AUTO=FALSE or SS=TRUE). The


CONTROLLER block is a PID_AFB block; it operates when AUTO=TRUE and SS=FALSE
and tracks the downstream output [OUT] in manual or standby sync mode. The
AUTO_MANUAL block provides standby sync and manual control of the output. In standby
sync mode, the external value [EXTV] becomes the loop output [OUT]. In auto mode, the
CONTROLLER block output becomes the loop output. In manual mode, the
AUTO_MANUAL block internal output (IOUT) becomes the loop output.

Calling OBs and Start-up


Calling OBs
This block is called in the watchdog interrupt OB into which the block is installed (for
example, OB32). Additionally, it is called in OB100 and in OB102 (see Start-up
Characteristics).
Start-up Characteristics
On a warm restart, OB100 is called and parameters retain the values they had immediately
before the restart. On a cold restart, OB102 is called and parameters are initialized with the
last downloaded values.
The warm and cold startup behavior of AUTO, SP, and OUT is configurable, allowing the
user to override the default PCS 7 behavior described above, if necessary. As delivered,
AUTO will be forced to "Manual" and OUT will be forced to 0.0 on a CPU restart. SP will be
set in accordance with default PCS 7 behavior.
To force the AUTO parameter to a specified value on a restart, set the RSTRT_AUTO_FLAG
to true ("Force AUTO") and configure RSTRT_AUTO_VALUE with the desired forced value
("Auto" or "Manual"). The RSTRT_AUTO_VALUE will be used to initialize AUTO, if and only
if the RSTRT_AUTO_FLAG is true. If RSTRT_AUTO_FLAG is set to false ("Default"), the
AUTO parameter will be set in accordance with default PCS 7 behavior.
To force the SP parameter to a specified value on a restart, set the RSTRT_SP_FLAG to
true ("Force SP") and configure RSTRT_SP_VALUE with the desired forced value. The
RSTRT_SP_VALUE will be used to initialize SP, if the RSTRT_SP_FLAG is true and either
● The block is forced to start in Auto mode, or
● AUTO is not forced and the block restarts with Auto mode (AUTO="Auto") and not in
standby sync (SS = "False").
If RSTRT_SP_FLAG is set to false ("Default"), the SP parameter will be set in accordance
with default PCS 7 behavior.
To force the OUT parameter to a specified value on a restart, set the RSTRT_OUT_FLAG to
true ("Force OUT") and configure RSTRT_OUT_VALUE with the desired forced value. The
RSTRT_OUT_VALUE will be used to initialize OUT, if and only if the RSTRT_OUT_FLAG is
true and the block restarts in Manual mode (AUTO = "Manual"). If RSTRT_OUT_FLAG is set
to false ("Default"), the OUT parameter will be set in accordance with default PCS 7
behavior.

WARNING
Using "Default" for the RSTRT_OUT_FLAG could result in your output device retaining its
last operating state after a restart. Similarly, using "Default" for the RSTRT_AUTO_FLAG
could result in your process running in automatic mode after a restart. Use "Forced" for the
restart flags and configure the associated restart values to ensure a known restart state.

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 157
ES Library
1.2 Library Function Blocks

If restart parameter values are changed offline, the configuration must be compiled (changes
only) and downloaded (changes only) to the controller in order for the settings to take effect
upon restart. If restart parameter values are changed online (via CFC Test mode), the
configuration must be compiled (entire program) and downloaded (entire program) to the
controller in order for the settings to take effect upon cold restart. This step is not necessary
for the online changes to take effect upon a warm restart.

Operator Control and Monitoring (M&C Relevant)


See Faceplate Information

Message Characteristics

Assignment of message texts and message class to the block parameters

Note
During runtime, the string $$BlockComment$$ will be replaced by the comment for the FB
instance that is in alarm.

ALARM_8P ID Message # Message Class Default Message Text


Message_class
EV_ID 1 Warning - above HIGH - $$BlockComment$$ - Limit = @4%f@
EV_ID 2 Warning - below LOW - $$BlockComment$$ - Limit = @5%f@
EV_ID 3 Alarm - above HIGH_DEV - $$BlockComment$$ - Limit = @6%f@
EV_ID 4 Alarm - below LOW_DEV - $$BlockComment$$ - Limit = @7%f@
EV_ID 5 Alarm - above ABSOLUTE_DEV - $$BlockComment$$ - Limit =
@8%f@
EV_ID 6 PLC Process Control OUT_OF_RANGE - $$BlockComment$$
Message - Failure
EV_ID 7 PLC Process Control QUALITY_NOT_GOOD - $$BlockComment$$
Message - Failure
EV_ID2 1 Alarm - above HIGH_ HIGH - $$BlockComment$$ - Limit =
@4%f@
EV_ID2 2 Alarm - below LOW_ LOW - $$BlockComment$$ - Limit = @5%f@
EV_ID2 3 Warning - above INC_ROC - $$BlockComment$$ - Limit = @6%f@
EV_ID2 4 Warning - below DEC_ROC - $$BlockComment$$ - Limit = @7%f@
EV_ID2 5 Warning - above ABS_ROC - $$BlockComment$$ - Limit = @8%f@

Assignment of auxiliary process values to the block parameters

ALARM_8P ID Value Block Parameter


EV_ID @1%s@ BA_NA
EV_ID @2%d@ BA_ID

APACS+ ES Library User's Guide for V7.1


158 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

ALARM_8P ID Value Block Parameter


EV_ID @3%d@ STEP_NO
EV_ID @4%f@ H_LIM
EV_ID @5%f@ L_LIM
EV_ID @6%f@ HD_LIM
EV_ID @7%f@ LD_LIM
EV_ID @8%f@ AD_LIM
EV_ID2 @1%s@ BA_NA
EV_ID2 @2%d@ BA_ID
EV_ID2 @3%d@ STEP_NO
EV_ID2 @4%f@ HH_LIM
EV_ID2 @5%f@ LL_LIM
EV_ID2 @6%f@ IR_LIM
EV_ID2 @7%f@ DR_LIM
EV_ID2 @8%f@ AR_LIM

See also
SINGLE_LP_SS_BLK Input Output (Page 159)

1.2.23.2 SINGLE_LP_SS_BLK Input Output

Input

Name Data Type Explanation Initial OC&M Valid


Values
PV REAL Process Variable 0 True
QC_PV BYTE Quality Code for PV 16#80 True Quality
Codes
(Page 11
)
EXTV REAL External Variable input 0 False
SS BOOL Standby Sync Command False True
INIT BOOL Transitions of the INIT input False False
cause the initialization equation
to be performed.
TSP REAL SP target value for SP ramping 0 True
H_EN BOOL Enable High Alarm True True
L_EN BOOL Enable Low Alarm True True
HD_EN BOOL Enable High Deviation Alarm False True
LD_EN BOOL Enable Low Deviation Alarm False True
AD_EN BOOL Enable Absolute Deviation True True
Alarm
OOR_EN BOOL Enable Out of Range Alarm False True

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 159
ES Library
1.2 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid


Values
QUAL_EN BOOL Enable Quality Not Good Alarm False True
HH_EN BOOL Enable High High Alarm False True
LL_EN BOOL Enable Low Low Alarm False True
IR_EN BOOL Enable Increasing Rate of False True
Change Alarm
DR_EN BOOL Enable Decreasing Rate of False True
Change Alarm
AR_EN BOOL Enable Absolute Rate of False True
Change Alarm
OOS BOOL Out of Service indicator False True
QBAD BOOL Bad quality indicator False False
EV_ID DWORD Event ID Compiler generated for the False
type or N/A if used as chart
*
EV_ID2 DWORD Event ID Compiler generated for the False
type or N/A if used as chart
*
SAMPLE_T REAL Current scan rate supplied by Compiler generated for the False
OS type or N/A if used as chart
*
RSTRT_AUTO_FLAG BOOL Default: Retain on WS, Use True False
load val on CS. Force: Use
RSTRT_AUTO_VALUE
RSTRT_AUTO_VALUE BOOL Init restart value for Auto Mode False False
if RSTRT_AUTO_FLAG true
RSTRT_SP_FLAG BOOL Default: Retain on WS, Use False False
load val on CS. Force: Use
RSTRT_SP_VALUE on restart
RSTRT_SP_VALUE REAL Init restart value for SP if 0 False
RSTRT_SP_FLAG true and
Auto mode
RSTRT_OUT_FLAG BOOL Default: Retain on WS, Use True False
load val on CS. Force: Use
RSTRT_OUT_VALUE on
restart.
RSTRT_OUT_VALUE REAL Init restart value for OUT if 0 False
RSTRT_OUT_FLAG true and
manual mode
BA_EN BOOL Batch enabled False True
OCCUPIED BOOL Batch occupied False True
BA_ID DWORD Batch ID number 0 True
BA_NA STRING[32] Batch name '' True
STEP_NO DWORD Batch step number 0 True
DecimalPlacesPV INT Decimal places displayed in 2 True
HMI for PV, SP etc.
DecimalPlacesOUT INT Decimal places displayed in 2 True
HMI for OUT, OUT Limits

APACS+ ES Library User's Guide for V7.1


160 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid


Values
ConfirmChange BOOL If TRUE changes from HMI False True
must be confirmed
LIOP_MAN_SEL BOOL Select AUTO/MANUAL: 0 False
1 = Linking, 0 = Operator active
AUT_L BOOL Linkable input for 0 False
AUTO/MANUAL mode, 1 =
AUTO
LIOP_ ISP_SEL BOOL Select internal SP: 1 = from 0 False
Link, 0 = from Operator
SP_L REAL Linkable input for internal 0.0 False
Setpoint
LIOP_OUT_SEL BOOL Select writing to OUT: 1 = from 0 False
Link, 0 = from Operator
OUT_L REAL Linkable input to be written to 0.0 False
OUT

Note
This list differs significantly from the inputs of the SINGLE_LP_SS_BLK block in APACS+.
The APACS+ list only includes the PV, EXTV, and SS inputs.
*The Update Sampling Time option must be checked when compiling a chart that contains
the SINGLE_LP_SS_BLK for this value to be automatically generated by the compiler.

Output

Name Data Explanation Initial OC&M Valid


Type Values
SP_OUT REAL Calculated set point value 0 False
OUT REAL Calculated output variable that has 0 False
been limited
QC_OUT BYTE Quality Code for output OUT 16#80 True Quality
Codes
(Page 1
1)
ALARM BOOL Alarm Status False False
H_ALM BOOL When TRUE, the High alarm is False False
detected and enabled.
L_ALM BOOL When TRUE, the Low alarm is False False
detected and enabled.
HD_ALM BOOL When TRUE, the High Deviation alarm False False
is detected and enabled.
LD_ALM BOOL When TRUE, the Low Deviation alarm False False
is detected and enabled.
AD_ALM BOOL When TRUE, the Absolute Deviation False False
alarm is detected and enabled.

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 161
ES Library
1.2 Library Function Blocks

Name Data Explanation Initial OC&M Valid


Type Values
OOR_ALM BOOL When TRUE, the Out of Range alarm False False
is detected and enabled.
QUAL_ALM BOOL When TRUE, the Quality Not Good False False
alarm is detected and enabled.
HH_ALM BOOL When TRUE, the High High alarm is False False
detected and enabled.
LL_ALM BOOL When TRUE, the Low Low alarm is False False
detected and enabled.
IR_ALM BOOL When TRUE, the Increasing Rate of False False
Change alarm is detected and
enabled.
DR_ALM BOOL When TRUE, the Decreasing Rate of False False
Change alarm is detected and
enabled.
AR_ALM BOOL When TRUE, the Absolute Rate of False False
Change alarm is detected and
enabled.
VL_EUMIN_OUT REAL Copy of Engineering unit: Output, Low 0 False
VL_EUMAX_OUT REAL Copy of Engineering unit: Output, High 0 False

Note
The APACS+ SP output was renamed to SP_OUT to avoid conflict with the newly added SP
In/Out parameter. SP_OUT is used to interconnect the set-point value to other entities on a
chart. The OS interaction is handled by the SP In/Out parameter.

Input/ouput

Name Data Explanation Initial OC&M Valid Values


Type
AUTO BOOL Auto/manual mode control False True
SP REAL Computer set point value 0 True
RAMP BOOL SP ramping on/off mode control False True
R_TIME TIME Ramp time T#0MS True 0 to
24d20h31m23s647ms
SPL REAL Set point low limit 0 True
SPH REAL Set point high limit 100 True
R_RATE REAL Ramp rate (in engineering units per min) 0 True
USE_RR BOOL Ramp mode control. Use RTIME or RRATE False True
to control ramp
PV_TRACK BOOL Internal setpoint tracking control. When True True
Track, internal setpoint tracks PV
PG REAL Proportional Gain 0.001 True 0.001 to 100.0
TI REAL Time-Integral Minutes per Reset 4000 True 0.0 to 4000.0

APACS+ ES Library User's Guide for V7.1


162 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

Name Data Explanation Initial OC&M Valid Values


Type
TD REAL Time-Derivative Minutes 0 True 0.00 to 100.0
DG REAL Derivative Gain 10 True 2.00 to 20.00
DIR BOOL Reverse or Direct action False True
ADAPTIVE_PG_INIT BOOL Adaptive Gain Init flag True
PV_EUMIN REAL Engineering unit: Input, Low 0 True
PV_EUMAX REAL Engineering unit: Input, High 100 True
VL_EUMIN REAL Engineering unit: Output, Low 0 True
VL_EUMAX REAL Engineering unit: Output, High 100 True
VL REAL Computer Output, typically written to by an 0 True
operator command
QC_OUT_IN BYTE Quality Code input for output OUT 16#80 True Quality Codes
(Page 11)
VLL REAL OUT low limit input -3.3 True
VLH REAL OUT high limit input 103.3 True
H_LIM REAL The value (in engineering units) to which 100 True
the (PV) input is compared for the High
alarm.
H_DB REAL The amount of engineering units by which 0.5 True
(PV) must be within the limit for the High
alarm to clear.
H_DELAYIN TIME The amount of time the input must reach or T#0MS False 0 to
exceed the High limit to trip an alarm. 24d20h31m23s647ms
H_DELAYOUT TIME The amount of time the input must be within T#0MS False 0 to
the High limit and deadband to cause the 24d20h31m23s647ms
alarm to clear.
L_LIM REAL The value (in engineering units) to which 0 True
the (PV) input is compared for the Low
alarm.
L_DB REAL The amount of engineering units by which 0.5 True
(PV) must be within the limit for the Low
alarm to clear.
L_DELAYIN TIME The amount of time the input must reach or T#0MS False 0 to
exceed the Low limit to trip an alarm. 24d20h31m23s647ms
L_DELAYOUT TIME The amount of time the input must be within T#0MS False 0 to
the Low limit and deadband to cause the 24d20h31m23s647ms
alarm to clear.
HD_LIM REAL The value (in engineering units) to which 0 True
(PV) – (DEV) is compared for the High
Deviation alarm.
HD_DB REAL The amount of engineering units by which 0.5 True
(PV) – (DEV) must be within the limit for the
High Deviation alarm to clear.
HD_DELAYIN TIME The amount of time the input must reach or T#0MS False 0 to
exceed the High Deviation limit to trip an 24d20h31m23s647ms
alarm.

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 163
ES Library
1.2 Library Function Blocks

Name Data Explanation Initial OC&M Valid Values


Type
HD_DELAYOUT TIME The amount of time the input must be within T#0MS False 0 to
the High Deviation limit and deadband to 24d20h31m23s647ms
cause the alarm to clear.
LD_LIM REAL The value (in engineering units) to which 0 True
(DEV) - (PV) is compared for the Low
Deviation alarm.
LD_DB REAL The amount of engineering units by which 0.5 True
(DEV) - (PV) must be within the limit for the
Low Deviation alarm to clear.
LD_DELAYIN TIME The amount of time the input must reach or T#0MS False 0 to
exceed the Low Deviation limit to trip an 24d20h31m23s647ms
alarm.
LD_DELAYOUT TIME The amount of time the input must be within T#0MS False 0 to
the Low Deviation limit and deadband to 24d20h31m23s647ms
cause the alarm to clear.
AD_LIM REAL The value (in engineering units) to which 100 True
ABS((PV) – (DEV)) is compared for the
Absolute Deviation alarm.
AD_DB REAL The amount of engineering units by which 0.5 True
ABS((PV) – (DEV)) must be within the limit
for the Absolute Deviation alarm to clear.
AD_DELAYIN TIME The amount of time the input must reach or T#0MS False 0 to
exceed the Absolute Deviation limit to trip 24d20h31m23s647ms
an alarm.
AD_DELAYOUT TIME The amount of time the input must be within T#0MS False 0 to
the Absolute Deviation limit and deadband 24d20h31m23s647ms
to cause the alarm to clear.
HH_LIM REAL The value (in engineering units) to which 0 True
the (PV) input is compared for the High
High alarm.
HH_DB REAL The amount of engineering units by which 0.5 True
(PV) must be within the limit for the High
High alarm to clear.
HH_DELAYIN TIME The amount of time the input must reach or T#0MS False 0 to
exceed the High High limit to trip an alarm. 24d20h31m23s647ms
HH_DELAYOUT TIME The amount of time the input must be within T#0MS False 0 to
the High High limit and deadband to cause 24d20h31m23s647ms
the alarm to clear.
LL_LIM REAL The value (in engineering units) to which 0 True
the (PV) input is compared for the Low Low
alarm.
LL_DB REAL The amount of engineering units by which 0.5 True
(PV) must be within the limit for the Low
Low alarm to clear.
LL_DELAYIN TIME The amount of time the input must reach or T#0MS False 0 to
exceed the Low Low limit to trip an alarm. 24d20h31m23s647ms
LL_DELAYOUT TIME The amount of time the input must be within T#0MS False 0 to
the Low Low limit and deadband to cause 24d20h31m23s647ms
the alarm to clear.

APACS+ ES Library User's Guide for V7.1


164 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

Name Data Explanation Initial OC&M Valid Values


Type
IR_LIM REAL The value (in engineering units per minute) 0 True
to which the (PV) input is compared for the
Increasing Rate of Change alarm.
IR_DB REAL The amount of engineering units by which 0.5 True
(PV) must be within the limit for the
Increasing Rate of Change alarm to clear.
IR_DELAYIN TIME The amount of time the input must reach or T#0MS False 0 to
exceed the Increasing Rate of Change limit 24d20h31m23s647ms
to trip an alarm.
IR_DELAYOUT TIME The amount of time the input must be within T#0MS False 0 to
the Increasing Rate of Change limit and 24d20h31m23s647ms
deadband to cause the alarm to clear.
DR_LIM REAL The value (in engineering units per minute) 0 True
to which the (PV) input is compared for the
Decreasing Rate of Change alarm.
DR_DB REAL The amount of engineering units by which 0.5 True
(PV) must be within the limit for the
Decreasing Rate of Change alarm to clear.
DR_DELAYIN TIME The amount of time the input must reach or T#0MS False 0 to
exceed the Decreasing Rate of Change 24d20h31m23s647ms
limit to trip an alarm.
DR_DELAYOUT TIME The amount of time the input must be within T#0MS False 0 to
the Decreasing Rate of Change limit and 24d20h31m23s647ms
deadband to cause the alarm to clear.
AR_LIM REAL The value (in engineering units per minute) 0 True
to which the (PV) input is compared for the
Absolute Rate of Change alarm.
AR_DB REAL The amount of engineering units by which 0.5 True
(PV) must be within the limit for the
Absolute Rate of Change alarm to clear.
AR_DELAYIN TIME The amount of time the input must reach or T#0MS False 0 to
exceed the Absolute Rate of Change limit 24d20h31m23s647ms
to trip an alarm.
AR_DELAYOUT TIME The amount of time the input must be within T#0MS False 0 to
the Absolute Rate of Change limit and 24d20h31m23s647ms
deadband to cause the alarm to clear.
OOR_DELAYIN TIME The amount of time the input must be T#0MS False 0 to
outside the limits EINH, EINL to trip the Out 24d20h31m23s647ms
of Range alarm.
OOR_DELAYOUT TIME The amount of time the input must be within T#0MS False 0 to
the limits EINH, EINL to cause the Out of 24d20h31m23s647ms
Range alarm to clear.
QUAL_DELAYIN TIME The amount of time the input quality must T#0MS False 0 to
be bad to trip the Quality Not Good alarm. 24d20h31m23s647ms
QUAL_DELAYOUT TIME The amount of time the input quality must T#0MS False 0 to
be good to cause the Quality Not Good 24d20h31m23s647ms
alarm to clear.
DISABLE_ON_OOS BOOL When set to TRUE, the block is disabled if False False
(OOS) is also TRUE.

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 165
ES Library
1.2 Library Function Blocks

See also
SINGLE_LP_SS: Single Loop Controller with Standby Sync (Page 156)

1.2.24 VALVE_A_ALM_BLK

1.2.24.1 VALVE_A_ALM: Valve with Alarm

Function Block Name VALVE_A_ALM_BLK


(compiled version of the Chart)
Function Block Number FB614
Chart Name VALVE_A_ALM
See also, Template Chart VALVE_A_ALM_AT
(usage example)

Function
This block provides standard valve open/close equipment module functions (similar to the
BLK_VLV_1OUT). Device alarming functions are provided by this block.
This factory-compiled block is an encapsulation of the VALVE_A_BLK block with a 4-element
discrete alarm block. To provide thorough alarm reporting, the alarm state value of the
VALVE_A_BLK block is used to create separate alarms for the following conditions:
● Failure to open (or loss of open verify)
● Failure to close (or loss of close verify)
● Uncommanded close/open or rejected command (due to interlock)
● Failed limit switch (Open and close verify inputs are set)
The latched fail state of the VALVE_A_BLK block is unlatched automatically when the alarm
is acknowledged.
The parameters are generally identical to those of the VALVE_A_BLK block. See
VALVE_A_BLK for more details and a complete description of the functionality of this block.

Calling OBs and Start-up


Calling OBs
This block is called in the watchdog interrupt OB into which the block is installed (for
example, OB32). Additionally, it is called in OB100 and in OB102 (see Start-up
Characteristics).
Start-up Characteristics
On a warm restart, OB100 is called and parameters retain the values they had immediately
before the restart. On a cold restart, OB102 is called and parameters are initialized with the
last downloaded values.

APACS+ ES Library User's Guide for V7.1


166 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

The warm and cold startup behavior of AUTO and OUT is configurable, allowing the user to
override the default PCS 7 behavior described above if necessary. As delivered, AUTO will
be forced to "Manual" and OUT will be forced to "False" on a CPU restart.
To force the AUTO parameter to a specified value on a restart, set the RSTRT_AUTO_FLAG
to true ("Force AUTO") and configure RSTRT_AUTO_VALUE with the desired forced value
("Auto" or "Manual"). The RSTRT_AUTO_VALUE will be used to initialize AUTO, if and only
if the RSTRT_AUTO_FLAG is true. If RSTRT_AUTO_FLAG is set to false ("Default"), the
AUTO parameter will be set in accordance with default PCS 7 behavior.
To force the OUT parameter to a specified value on a restart, set the RSTRT_OUT_FLAG to
true ("Force OUT") and configure RSTRT_OUT_VALUE with the desired forced value ("True"
or "False"). The RSTRT_OUT_VALUE will be used to initialize OUT, if and only if the
RSTRT_OUT_FLAG is true. If RSTRT_OUT_FLAG is set to false ("Default"), the OUT
parameter will be set in accordance with default PCS 7 behavior.

WARNING
Using "Default" for the RSTRT_OUT_FLAG could result in your output device retaining its
last operating state after a restart. Similarly, using "Default" for the RSTRT_AUTO_FLAG
could result in your process running in automatic mode after a restart. Use "Forced" for the
restart flags and configure the associated restart values to ensure a known restart state.

If restart parameter values are changed offline, the configuration must be compiled (changes
only) and downloaded (changes only) to the controller in order for the settings to take effect
upon restart. If restart parameter values are changed online (via CFC Test mode), the
configuration must be compiled (entire program) and downloaded (entire program) to the
controller in order for the settings to take effect upon cold restart. This step is not necessary
for the online changes to take effect upon a warm restart.

Interlock Configuration
All of the Interlocks for this block are visible by default. For each required interlock, configure
the following:
● Connect a boolean interlock condition to the Interlock input.
● Configure the description so that it is no longer null ("). If the description is left as a null,
the faceplate will not display the status for this interlock. The faceplate is designed to hide
an interlock condition when the interlock description is null.

Operator Control and Monitoring (M&C Relevant)


See Faceplate Information

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 167
ES Library
1.2 Library Function Blocks

Message Characteristics

Assignment of message texts and message class to the block parameters

Note
During runtime, the string $$BlockComment$$ will be replaced by the comment for the FB
instance that is in alarm.

Message # Message Class Message_class Default Message Text


1 PLC Process Control Message - Failure Failure to open - $$BlockComment$$
2 PLC Process Control Message - Failure Failure to close - $$BlockComment$$
3 PLC Process Control Message - Failure Uncommanded close/open or rejected command (due to
interlock) - $$BlockComment$$
4 PLC Process Control Message - Failure Failed limit switch (open and close verify inputs are set) -
$$BlockComment$$

Assignment of auxiliary process values to the block parameters

Value Block Parameter


@1%s@ BA_NA
@2%d@ BA_ID
@3%d@ STEP_NO

See also
VALVE_A_ALM_BLK Input Output (Page 168)

1.2.24.2 VALVE_A_ALM_BLK Input Output

Input

Name Data Type Explanation Initial OC&M Valid


Values
OP_VER BOOL Open Verification input False True
QC_OP_VER BYTE Quality Code for OP_VER 16#80 True Quality
Codes
(Page 11
)
CL_VER BOOL Closed Verification input False True

APACS+ ES Library User's Guide for V7.1


168 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid


Values
QC_CL_VER BYTE Quality Code for CL_VER 16#80 True Quality
Codes
(Page 11
)
A_OPEN BOOL Automatic Open command False False
input
A_CLSE BOOL Automatic Close command False False
input
PERMIT BOOL Permitted to Open input. True True
MODE BOOL Mode input from a sequential False False
function chart
INT01 BOOL Interlock 1 True True
INT02 BOOL Interlock 2 True True
INT03 BOOL Interlock 3 True True
INT04 BOOL Interlock 4 True True
INT05 BOOL Interlock 5 True True
INT06 BOOL Interlock 6 True True
INT07 BOOL Interlock 7 True True
INT08 BOOL Interlock 8 True True
INT09 BOOL Interlock 9 True True
INT10 BOOL Interlock 10 True True
PERMIT_DESC STRING[32] Permit Description '' True
INT01_DESC STRING[32] Interlock 1 Description '' True
INT02_DESC STRING[32] Interlock 2 Description '' True
INT03_DESC STRING[32] Interlock 3 Description '' True
INT04_DESC STRING[32] Interlock 4 Description '' True
INT05_DESC STRING[32] Interlock 5 Description '' True
INT06_DESC STRING[32] Interlock 6 Description '' True
INT07_DESC STRING[32] Interlock 7 Description '' True
INT08_DESC STRING[32] Interlock 8 Description '' True
INT09_DESC STRING[32] Interlock 9 Description '' True
INT10_DESC STRING[32] Interlock 10 Description '' True
A1EN BOOL Enable Alarm 1 True True
A2EN BOOL Enable Alarm 2 True True
A3EN BOOL Enable Alarm 3 True True
A4EN BOOL Enable Alarm 4 True True
OOS BOOL Out of Service indicator False True
EV_ID DWORD Event ID Compiler generated for the False
type or N/A if used as chart
*
RSTRT_AUTO_FLAG BOOL Default: Retain on WS, Use True False
load val on CS. Force: Use
RSTRT_AUTO_VALUE on
restart

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 169
ES Library
1.2 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid


Values
RSTRT_AUTO_VALUE BOOL Init restart value for Auto False False
Mode if
RSTRT_AUTO_FLAG true
RSTRT_OUT_FLAG BOOL Default: Retain on WS, Use True False
load val on CS. Force: Use
RSTRT_OUT_VALUE on
restart
RSTRT_OUT_VALUE BOOL Init restart value for OUT if False False
RSTRT_OUT_FLAG
BA_EN BOOL Batch enabled False True
OCCUPIED BOOL Batch occupied False True
BA_ID DWORD Batch ID number 0 True
BA_NA STRING[32] Batch name '' True
STEP_NO DWORD Batch step number 0 True
ConfirmChange BOOL If TRUE changes from HMI False True
must be confirmed
LIOP_MAN_SEL BOOL Select AUTO/MANUAL: False False
1 = Linking, 0 = Operator
active
AUT_L BOOL Linkable input for False False
AUTO/MANUAL mode, 1 =
AUTO
QC_OUT_IN BYTE Quality Code input for output 16#80 True Quality
OUT Codes
(Page 11
)

Output

Name Data Type Explanation Initial OC&M Valid Values


OUT BOOL Output used to ultimately control the valve False True
QC_OUT BYTE Quality Code for output OUT 16#80 True Quality Codes
(Page 11)
INTRLK BOOL Interlock OK output False True
READY BOOL Ready output False False
STATE INT State of the valve 0 True
ALARM_STATE INT Alarm state 0 False
ALM1 BOOL Alarm 1 False False
ALM2 BOOL Alarm 2 False False
ALM3 BOOL Alarm 3 False False
ALM4 BOOL Alarm 4 False False

APACS+ ES Library User's Guide for V7.1


170 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

Input/output

Name Data Explanation Initial OC&M Valid Values


Type
FAIL BOOL Indicates whether valve has a fault False True
condition
AUTO BOOL Auto mode output False True
OVERRD BOOL Override output False True
FAIL_OPEN BOOL Indicates fail-safe state of valve False True
OPEN BOOL Open command value for manual mode False True
CLOSE BOOL Close command value for manual mode False True
OPEN_T TIME Maximum time allowed to open the T#10S True
valve
CLOS_T TIME Maximum time allowed to close the T#10S True
valve
AUTO_TRACK BOOL If true, block is set to auto mode when False False
SFC transitions to AUTO
MODE_HOLD_AUTO BOOL Indicates whether block held in auto False False
mod e while SFC is in auto mode
ACCEPT_ANY_AUTO BOOL When true, block is set to auto when False False
A_O PEN or A_CLSE changes state
POS_TRANS_ACLSE BOOL Indicates whether a positive transition is False False
required to close the valve
AUTO_TRANS_REQ BOOL When true, A_OPEN and A_CLSE False False
inputs need to change state to issue
open/close cmd
FAIL_ON_INTRLK BOOL Fail on interlock True False
FAIL_ON_OPEN_CMD BOOL Fail on open command True False
A1LIM BOOL Alarm 1 Limit True True
A1DELAYIN TIME Into Alarm 1 Delay Time T#0MS False 0 to
24d20h31m23s647ms
A1DELAYOUT TIME Out of Alarm 1 Delay Time T#0MS False 0 to
24d20h31m23s647ms
A2LIM BOOL Alarm 2 Limit True True
A2DELAYIN TIME Into Alarm 2 Delay Time T#0MS False 0 to
24d20h31m23s647ms
A2DELAYOUT TIME Out of Alarm 2 Delay Time T#0MS False 0 to
24d20h31m23s647ms
A3LIM BOOL Alarm 3 Limit True True
A3DELAYIN TIME Into Alarm 3 Delay Time T#0MS False 0 to
24d20h31m23s647ms
A3DELAYOUT TIME Out of Alarm 3 Delay Time T#0MS False 0 to
24d20h31m23s647ms
A4LIM BOOL Alarm 4 Limit True True
A4DELAYIN TIME Into Alarm 4 Delay Time T#0MS False 0 to
24d20h31m23s647ms

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 171
ES Library
1.2 Library Function Blocks

Name Data Explanation Initial OC&M Valid Values


Type
A4DELAYOUT TIME Out of Alarm 4 Delay Time T#0MS False 0 to
24d20h31m23s647ms
DISABLE_ON_OOS BOOL Disable on Out of Service False False

See also
VALVE_A_ALM: Valve with Alarm (Page 166)

1.2.25 VALVE_A_AFB

1.2.25.1 VALVE_A_AFB: Standard Valve

Function Block Name VALVE_A_AFB


Function Block Number FB506

Function
The Standard Valve Function Block (VALVE_A_AFB) provides standard motor start/stop
functions that can be easily interfaced to an operator station. This block is based on the
APACS+ VALVE_A function block. This block can receive commands from programmed
logic, such as a sequential function chart (SFC) while in automatic mode, or it can receive
operator-entered commands from an operator interface while in manual mode.
The OP_VER and CL_VER inputs receive the open and close verify signals indicating the
state of the valve. A TRUE indicates that the condition is verified. This block accommodates
fail-open valves, as well as the normal fail-closed valves. The OUT output value establishes
the state of the valve, where TRUE = open and FALSE = close for a fail-close valve, and
TRUE = close and FALSE = open for a fail-open valve.
The AUTO parameter indicates the auto/manual state. This state can be changed external to
the block. It can also be changed by the block itself, depending on In/Out parameters. When
the block is in manual mode (AUTO = FALSE), commands to the block are received via a
write of TRUE to the OPEN or CLOSE In/Out parameters. The block automatically resets
these values after receiving the command. When the block is in auto mode (AUTO = TRUE),
commands to the block are received via the A_OPEN and A_CLSE inputs. Since auto mode
is intended for use with commands sent by an SFC, there are some In/Out settings that
accommodate this use:
● When AUTO_TRACK is TRUE, the AUTO mode tracks the MODE input (intended to be
the mode of the SFC), such that AUTO is set TRUE when MODE becomes TRUE.
● If MODE_HOLD_AUTO is TRUE, AUTO is held TRUE as long as MODE is TRUE. When
FALSE, the AUTO value is set when the MODE input value is TRUE, but can then be
manually changed.
● If ACCEPT_ANY_AUTO is TRUE, AUTO is set TRUE whenever the A_OPEN (Automatic
Open) or A_CLSE (Automatic Close) input changes state.

APACS+ ES Library User's Guide for V7.1


172 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

When in auto mode, the positive transition of the POS_TRANS_ACLSE value determines the
function of the A_OPEN and A_CLSE inputs. If the POS_TRANS_ACLSE value is TRUE, the
commands need to be FALSE-to-TRUE transitions for both the A_OPEN and A_CLSE
inputs. Unlike the OPEN and CLOSE command values, the A_OPEN and A_CLSE input
values must be reset external to the block. If the POS_TRANS_ACLSE value is FALSE, the
same value should be placed on both the A_OPEN and A_CLSE inputs so that a FALSE-to-
TRUE transition sends an open command and a TRUE-to-FALSE transition sends a close
command. To avoid the need to generate such a transition for these commands when the
POS_TRANS_ACLSE is FALSE, the AUTO_TRANS_REQ value can be set FALSE. The
A_OPEN input (with the same value on the A_CLSE input) is used as the desired state of the
valve (TRUE = open, FALSE = closed).
There are many permissive/interlock features built into this block. The PERMIT input, if
configured, must be TRUE to permit any open command (or close command if fail-open) to
take effect. The block has 10 interlock inputs (INT01 ... INT10), but only the first two are
visible by default. All of the configured interlock inputs must be TRUE for the valve to change
to the non-fail-safe state; the INTRLK (Interlock) value indicates whether all configured
interlock inputs are TRUE. The OVERRD (Override) value represents the override status:
when TRUE, any FALSE interlocks (or permit) are overridden, the INTRLK value is set
TRUE, and the valve is allowed to leave the fail-safe state. OVERRD may be enabled by a
tag write from outside the block. For display at an HMI, there are In/Out values that hold
descriptors for the permit (PERMIT) and the interlock (INT01...INT10) inputs.
This block contains failure-checking features that set the FAIL output value to TRUE when a
problem is detected. The detected problems include:
● Failure to open before the OPEN_T has expired
● Failure to close before the CLOS_T has expired
● Loss of verify (=UNAVAILABLE data quality or FALSE)
● Uncommanded close (or open for fail open) due to loss of an interlock (enabled by setting
the FAIL_ON_INTRLK value to TRUE)
● Rejected open command due to missing permissive or interlock (checking for this failure
is always enabled when MODE = TRUE and for all conditions by setting the
FAIL_ON_OPEN_CMD value to TRUE.)
The FAIL value is set TRUE when a fail condition is detected. It remains TRUE until it is
reset by a tag write from outside of the block (by acknowledge logic or an operator
command). The ALARM_STATE value, an integer, is provided to indicate the specific failure
condition that occurred.
The READY output indicates that the valve is ready to receive auto commands, where TRUE
indicates that the valve is in auto mode and the interlocks are not overridden. The STATE
output is an integer value that represents the various states of the valve.
The VALVE_A_AFB supports alarming. An alarm message will be generated if the FAIL
parameter becomes TRUE. In APACS+, this functionality was not part of the VALVE_A
block, but instead handled by ProcessSuite.

Interlock Configuration
The Interlock parameters are not extensible as they were in 4-mation. In the PCS 7
implementation of this block, all of the Interlocks exist with only the first two visible by default.
If more than two interlocks are required, each additional interlock must be made visible.
For each required interlock, configure the following:

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 173
ES Library
1.2 Library Function Blocks

● Connect a boolean interlock condition to the Interlock input.


● Configure the description so that it is no longer null ("). If the description is left as a null,
the faceplate will not display the status for this interlock. The faceplate is designed to hide
an interlock condition when the interlock description is null.

Calling OBs and Start-up


Calling OBs
This block is called in the watchdog interrupt OB into which the block is installed (for
example, OB32). Additionally, it is called in OB100 and in OB102 (see Start-up
Characteristics).
Start-up Characteristics
On a warm restart, OB100 is called and parameters retain the values they had immediately
before the restart. On a cold restart, OB102 is called and parameters are initialized with the
last downloaded values.
The warm and cold startup behavior of AUTO and OUT is configurable, allowing the user to
override the default PCS 7 behavior described above if necessary. As delivered, AUTO will
be forced to "Manual" and OUT will be forced to "False" on a CPU restart.
To force the AUTO parameter to a specified value on a restart, set the RSTRT_AUTO_FLAG
to true ("Force AUTO") and configure RSTRT_AUTO_VALUE with the desired forced value
("Auto" or "Manual"). The RSTRT_AUTO_VALUE will be used to initialize AUTO, if and only
if the RSTRT_AUTO_FLAG is true. If RSTRT_AUTO_FLAG is set to false ("Default"), the
AUTO parameter will be set in accordance with default PCS 7 behavior.
To force the OUT parameter to a specified value on a restart, set the RSTRT_OUT_FLAG to
true ("Force OUT") and configure RSTRT_OUT_VALUE with the desired forced value ("True"
or "False"). The RSTRT_OUT_VALUE will be used to initialize OUT, if and only if the
RSTRT_OUT_FLAG is true. If RSTRT_OUT_FLAG is set to false ("Default"), the OUT
parameter will be set in accordance with default PCS 7 behavior.

WARNING
Using "Default" for the RSTRT_OUT_FLAG could result in your output device retaining its
last operating state after a restart. Similarly, using "Default" for the RSTRT_AUTO_FLAG
could result in your process running in automatic mode after a restart. Use "Forced" for the
restart flags and configure the associated restart values to ensure a known restart state.

If restart parameter values are changed offline, the configuration must be compiled (changes
only) and downloaded (changes only) to the controller in order for the settings to take effect
upon restart. If restart parameter values are changed online (via CFC Test mode), the
configuration must be compiled (entire program) and downloaded (entire program) to the
controller in order for the settings to take effect upon cold restart. This step is not necessary
for the online changes to take effect upon a warm restart.

Operator Control and Monitoring (M&C Relevant)


See Faceplate Information

APACS+ ES Library User's Guide for V7.1


174 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

Message Characteristics

Assignment of message texts and message class to the block parameters

Note
During runtime, the string $$BlockComment$$ will be replaced by the comment for the FB
instance that is in alarm.

Message # Message Class Default Message Text


1 PLC Process Control Message - Failure Valve Feedback Failure - $$BlockComment$$

Assignment of auxiliary process values to the block parameters

Value Block Parameter


@1%s@ BA_NA
@2%d@ BA_ID
@3%d@ STEP_NO

See also
VALVE_A_AFB Input Output (Page 175)

1.2.25.2 VALVE_A_AFB Input Output

Input

Name Data Type Explanation Initial OC&M Valid


Values
OP_VER BOOL Open Verification input False True
QC_OP_VER BYTE Quality Code for Open Verification input 16#80 True See QCs
(http://sup
port.autom
ation.siem
ens.com/U
S/view/en/
24449769)
CL_VER BOOL Closed Verification input False True
QC_CL_VER BYTE Quality Code for Closed Verification input 16#80 True
A_OPEN BOOL Automatic Open command input False False
A_CLSE BOOL Automatic Close command input False False
PERMIT BOOL Permitted to Open input. True True

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 175
ES Library
1.2 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid


Values
MODE BOOL Mode input from a sequential function False False
chart
INT01 BOOL Interlock 1 True True
INT02 BOOL Interlock 2 True True
INT03 BOOL Interlock 3 True True
INT04 BOOL Interlock 4 True True
INT05 BOOL Interlock 5 True True
INT06 BOOL Interlock 6 True True
INT07 BOOL Interlock 7 True True
INT08 BOOL Interlock 8 True True
INT09 BOOL Interlock 9 True True
INT10 BOOL Interlock 10 True True
PERMIT_DESC STRING[32] Permit Description '' True
INT01_DESC STRING[32] Interlock 1 Description '' True
INT02_DESC STRING[32] Interlock 2 Description '' True
INT03_DESC STRING[32] Interlock 3 Description '' True
INT04_DESC STRING[32] Interlock 4 Description '' True
INT05_DESC STRING[32] Interlock 5 Description '' True
INT06_DESC STRING[32] Interlock 6 Description '' True
INT07_DESC STRING[32] Interlock 7 Description '' True
INT08_DESC STRING[32] Interlock 8 Description '' True
INT09_DESC STRING[32] Interlock 9 Description '' True
INT10_DESC STRING[32] Interlock 10 Description '' True
RSTRT_AUTO_FLAG BOOL Default: Retain on WS, Use load val on True False
CS. Force: Use RSTRT_AUTO_VALUE on
restart
RSTRT_AUTO_VALUE BOOL Init restart value for Auto Mode if False False
RSTRT_AUTO_FLAG true
RSTRT_OUT_FLAG BOOL Default: Retain on WS, Use load val on True False
CS. Force: Use RSTRT_OUT_VALUE on
restart
RSTRT_OUT_VALUE BOOL Init restart value for OUT if False False
RSTRT_OUT_FLAG true
EV_ID DWORD Event ID (Compiler False
generated)
LIOP_MAN_SEL BOOL Select AUTO/MANUAL: False False
1 = Linking, 0 = Operator active
AUT_L BOOL Linkable input for AUTO/MANUAL mode, 1 False False
= AUTO
BA_EN BOOL Batch enabled False True
OCCUPIED BOOL Batch occupied False True
BA_ID DWORD Batch ID number 0 True
STEP_NO DWORD Batch step number 0 True
BA_NA STRING[32] Batch name '' True

APACS+ ES Library User's Guide for V7.1


176 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid


Values
ConfirmChange BOOL If TRUE changes from HMI must be False True
confirmed
QC_OUT_IN BYTE Quality Code input for output OUT 16#80 True See QCs

Note
This list differs from the inputs of the VALVE_A_AFB block in APACS+ as follows:
• Each input shown above with datatype STRING was a softlist parameter in APACS+.
• The INT01_DESC through INT09_DESC have slightly different names than their APACS+
counterparts. In APACS+ a leading zero was excluded, making the names INT1_DESC
through INT9_DESC.
• EV_ID parameter is a new input and is required for the PCS 7 version to support
alarming. This parameter did not exist in APACS+.
• Restart parameters (RSTRT_... ) did not exist in APACS+.
• LIOP_MAN_SEL and AUT_L added to provide alternate for SET_VAL function.
• Batch parameters BA_EN, OCCUPIED are added to support future batch faceplate view.
• Batch parameters BA_NA, BA_ID, STEP_NO are added to pass batch values in alarm
messages.
• ConfirmChange added to give APACS+ users expected feel of "one-step" operator entry

Output

Name Data Type Explanation Initial OC&M Valid Values


OUT BOOL Output used to ultimately control the valve False True
QC_OUT BYTE Quality Code for output OUT 16#80 True
ALARM BOOL Indicates when the Valve is in alarm False False
INTRLK BOOL Interlock OK output False True
READY BOOL Ready output False False
STATE INT State of the valve 0 True
ALARM_STATE INT Alarm state 0 False

Note
This list differs from the outputs of the VALVE_A_AFB block in APACS+ as follows:
• FAIL and AUTO and OVERRD have been moved to In/Out in PCS 7.
• ALARM_STATE is a new output. In APACS+, it was a softlist parameter.
• ALARM is a new output and is present to support the alarming functionality. This output
along with the alarm functionality did not exist in APACS+.
• INTRLK nub is named INT_OK in APACS+. The ProcessSuite name "INTRLK" is
preferred.

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 177
ES Library
1.2 Library Function Blocks

Integer Values for Valve State

VALUE STATE FAIL OVERRD OP_VER CL_VER INTRLK & PERMIT


0 Undefined - - - - -
1 Transition False - False False -
2 Closed False False False True True
3 Open False False True False True
4 Closed and Fail True - False True -
5 Open and Fail True - True False -
6 Closed and Override False True False True -
7 Open and Override False True True False -
8 Safe and Interlock not OK False False - - False
9 Limit Switch Fail True - True True -
10 Transition and Fail True - False False -
- means "does not care"

Integer Values for Valve Alarm (Failure) State

VALUE STATE STATUS


0 OK No alarm
1 Failed to Open OP_VER value not reset in time after OUT value was set TRUE (or FALSE for fail-
open).
2 Failed to Close CL_VER value not reset in time after OUT was set FALSE (or TRUE for fail-open).
3 Loss of Open Verify OP_VER value went FALSE while open was commanded.
4 Loss of Closed Verify CL_VER value went FALSE while closed was commanded.
5 Uncommanded Return INTRLK value went FALSE while OUT value was TRUE, causing OUT to be SET
to Fail-safe FALSE.
6 Rejected Command INTRLK or PERMIT value was FALSE when a command to leave fail-safe state was
issued.
7 Failed Limit Switch OP_VER and CL_VER are both TRUE simultaneously.

Input/output

Name Data Explanation Initial OC&M Valid Values


Type
FAIL BOOL Indicates whether valve has a fault False True
condition
AUTO BOOL Auto mode output False True
OVERRD BOOL Override output False True
AUTO_TRACK BOOL If true, block is set to auto mode when False False
SFC transitions to AUTO (MODE
becomes "True")
MODE_HOLD_AUTO BOOL Indicates whether block held in auto False False
mode while SFC is in auto mode

APACS+ ES Library User's Guide for V7.1


178 Manual, 04/2009, A5E02453738-01
ES Library
1.2 Library Function Blocks

Name Data Explanation Initial OC&M Valid Values


Type
ACCEPT_ANY_AUTO BOOL When true, block is set to auto when False False
A_OPEN or A_CLSE changes state
POS_TRANS_ACLSE BOOL Indicates whether a positive transition is True False
required to close the valve
AUTO_TRANS_REQ BOOL When true, A_OPEN and A_CLSE inputs True False
need to change state to issue open/close
cmd
FAIL_ON_INTRLK BOOL Fail on interlock. When TRUE and the False False
loss of an interlock returns the valve to its
fail-safe state (e.g. an uncommanded
close), the FAIL status is set TRUE and
the ALARM_STATE valve is set to its
appropriate value.
FAIL_ON_OPEN_CMD BOOL Fail on open command. When TRUE and False False
an open command (or a close command
for a fail-open valve) is rejected due to
the interlocks or permissive, the FAIL
status is set TRUE, and the
ALARM_STATE value is set to its
appropriate value.
FAIL_OPEN BOOL Indicates fail-safe state of valve False True
OPEN BOOL Open command value for manual mode False True
CLOSE BOOL Close command value for manual mode False True
OPEN_T TIME Maximum time allowed to open the valve T#10S True
CLOS_T TIME Maximum time allowed to close the valve T#10S True
A1EN BOOL Alarm 1 Enable True True
A1LIM BOOL Alarm 1 Limit True False
A1DELAYIN TIME Into Alarm 1 Delay Time T#0MS False 0 to
24d20h31m23s647ms
A1DELAYOUT TIME Out of Alarm 1 Delay Time T#0MS False 0 to
24d20h31m23s647ms
OOS BOOL Out of Service indicator False True
DISABLE_ON_OOS BOOL Disable on Out of Service False False

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 179
ES Library
1.3 Template Charts

Note
This list differs from the softlist parameters of the VALVE_A_AFB block in APACS+ as
follows:
• FAIL, AUTO, and OVERRD which were outputs in APACS+, have been moved to In/Out
in PCS 7. This is necessary to allow writes from the HMI.
• ALARM_STATE was moved to Output.
• The PT_DESC parameter has been eliminated. Instead, the Comment property of the
block has been used to contain the point description information. This is because the
faceplate will automatically display the information provided in the Comment field.
• INT01_DESC through INT10_DESC and PERMIT_DESC have been moved to Inputs.
• FAIL_OPEN is named FAIL_OPEN_VALVE in APACS.
• OPEN_T and CLOS_T are named OPEN_TIME and CLOSE_TIME in APACS+.
• The following alarm parameters are new: A1EN, A1LIM, A1DELAYIN, A1DELAYOUT,
OOS, DISABLE_ON_OOS. These are needed to support the alarming functionality.

See also
VALVE_A_AFB: Standard Valve (Page 172)

1.3 Template Charts

A PCS 7 template is to be used in the creation of the controller configuration. Each template
contains a function block that has a corresponding symbol and faceplate. The templates
provide all the logic required to use the library blocks. All that is necessary on the part of the
user is to replace the logical connections with actual addresses. The template charts can be
modified or expanded to meet user needs.

PCS 7
Continuous Function Chart (CFC) Template
ANALOG_ALM_AT
BLK_VLV_1OUT_AT
BLK_VLV_2OUT_AT
CASCADE_AT
DISCRETE_ALM_AT
EXT_SET_AT
MOTOR_1OUT_AT
MOTOR_2OUT_AT
PRIMARY_SECONDARY_AT
RATIO_SET_AT
SINGLE_LOOP_AT
SINGLE_LP_SS_AT

APACS+ ES Library User's Guide for V7.1


180 Manual, 04/2009, A5E02453738-01
ES Library
1.3 Template Charts

PCS 7
Continuous Function Chart (CFC) Template
MOTOR_A_ALM_AT
VALVE_A_ALM_AT

1.3.1 ANALOG_ALM_AT
This template can be used as an analog indicator with alarms. Both high and low alarms are
provided for the process variable. The PV input accepts the process variable and the
ALARM output provides the alarm status. The template contains an input driver, along with
the ALARM (ANALOG_ALM_AFB) block.

Interconnections
The signal to be monitored must be connected to the VALUE input of the PV_IN block via
symbolic addressing.

Simulation
Measured value monitoring can be tested during the configuring phase. This merely requires
that input SIM_ON of the PV_IN block be switched on, and that the relevant value be preset
at input SIM_V.

Parameter Assignment
To scale the input signal, set the Process Value engineering high via PV_IN's VHRANGE
input and the Process Value engineering low via PV_IN's VLRANGE input. These
engineering limits will be conveyed to the ALARM's PV_EUMAX and PV_EUMIN,
respectively.
By default, the HIGH and LOW alarms are enabled. The various alarms should be
enabled/disabled as needed.
Configure the following parameters (which are marked for IEA) in the ALARM for your
application:
● All high/low alarm limits (H_LIM, L_LIM)

Faults
Channel faults are detected by the input driver and are assigned to the QBAD input of block
ALARM. An alarm message will then be posted if QUAL_EN is enabled.

See also
ANALOG_ALM_BLK (Page 24)

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 181
ES Library
1.3 Template Charts

1.3.2 BLK_VLV_1OUT_AT
This template can be used as a block valve open/close with one output. It is designed for a
normally closed valve with auto/manual operation, pulse commands, and interlocking. An
alarm is provided for failure to reach the desired state. The VALVE block has inputs
OP_VER, CL_VER, A_OPEN, A_CLSE, and INTRLK for the open verify, close verify, auto
open command, auto close command, and interlock; and outputs OUT and FAIL for the
output, and failure status of the valve, respectively. The VALVE circuit contains, apart from
the VALVE block, two digital input drivers and a digital output driver.

Interconnections
The signal for the open feedback must be connected to the VALUE input of block FB_OPEN
via symbolic addressing. The signal for the closed feedback must be connected to the
VALUE input of block FB_CLOSED via symbolic addressing. The VALUE output of the
OUTPUT block must be connected via symbolic addressing to the signal for of the VALVE to
be controlled.

Simulation
If there is no feedback, the simulation can be switched on at driver blocks FB_OPEN and
FB_CLOSED (SIM_ON = 1). A connection is provided from the VALVE output OUT to a
TIMER_P delay block (SIMULATION) IO input. The SIMULATION QO output is connected to
the input SIM_I of block FB_OPEN. It is also connected to input SIM_I of block FB_CLOSED
after being inverted. Simulation of valve limit switches is accomplished by delaying the
VALVE block's OUT signal. Note than the TIME0 parameter should be less than VALVE's
TRAV_T and CLOS_T parameter.

Parameter Assignment
Configure the following parameters for your application:
● To set the VALVE block's maximum allowed time to open and close, set the parameter
TRAV_T of the VALVE block.
● Interlock

Faults
Channel faults are detected by the input and output drivers.

See also
BLK_VLV_1OUT_BLK (Page 32)

1.3.3 BLK_VLV_2OUT_AT
This template can be used as a block valve open/close with an open output and a close
output. It is designed for a valve with auto/manual operation, pulse commands, and
interlocking. An alarm is provided for failure to reach the desired state. The VALVE block has
inputs OP_VER, CL_VER, A_OPEN, A_CLSE, and INTRLK for the open verify, close verify,

APACS+ ES Library User's Guide for V7.1


182 Manual, 04/2009, A5E02453738-01
ES Library
1.3 Template Charts

auto open command, auto close command, and interlock; and outputs OP_OUT, CL_OUT,
and FAIL for the open output, close output, and failure status of the valve, respectively. The
VALVE circuit contains, apart from the VALVE block, two digital input drivers and two digital
output drivers.

Interconnections
The signal for the open feedback must be connected to the VALUE input of block FB_OPEN
via symbolic addressing. The signal for the closed feedback must be connected to the
VALUE input of block FB_CLOSED via symbolic addressing. The VALUE output of the
OPEN_OUTPUT block must be connected via symbolic addressing to the open signal for the
valve to be controlled. The VALUE output of the CLOSE_OUTPUT block must be connected
via symbolic addressing to the close signal for output of the valve to be controlled.

Simulation
If there is no feedback, the simulation can be switched on at driver blocks FB_OPEN and
FB_CLOSED (SIM_ON = 1). An SR_FF block (SIMULATION) is used to implement the
simulation of the feedback.

Parameter Assignment
Configure the following parameters for your application:
● To set the VALVE block's maximum allowed time to open and close, set the parameter
TRAV_T of the VALVE block.
● Interlock

Faults
Channel faults are detected by the input and output drivers.

See also
BLK_VLV_2OUT_BLK (Page 36)

1.3.4 CASCADE_AT
This template can be used as a self-contained cascade PID controller with tracking
setpoints. The output from the primary control loop is the setpoint to a secondary control
loop. High and low alarms are provided for the process variables of both loops. Additional
alarms are provided to detect a deviation between the process variable and setpoint of both
loops. The block has inputs P_PV and S_PV for the primary and secondary process
variables, and outputs P_SP_OUT, S_SP_OUT, OUT, and ALARM for the primary setpoint,
secondary setpoint, output, and alarm status of the loops, respectively. The control loop
contains, apart from the controller, two input drivers (PRIMARY_PV_IN,
SECONDARY_PV_IN), an output driver (SECONDARY_VL_OUT), and delay elements for
simulation.

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 183
ES Library
1.3 Template Charts

Interconnections
The signal for the primary value must be connected to the VALUE input of block
PRIMARY_PV_IN via symbolic addressing. The signal for the secondary actual value must
be connected to the VALUE input of block SECONDARY_PV_IN via symbolic addressing.
The VALUE output of the SECONDARY_VL_OUT block must be connected via symbolic
addressing to the signal for the actuator to be controlled.

Simulation
During the configuring phase, the controller can be tested with the delay element. This
merely requires that input SIM_ON of block PRIMARY_PV_IN and the input SIM_ON of block
SECONDARY_PV_IN be switched on. The Simulate Secondary CFC implements simple
simulation by feeding back a scaled lagged copy of the CONTROLLER OUT signal.
Normally, only the TM_LAG value needs to be adjusted for the application. The Simulate
Primary CFC implements simple simulation by feeding back a scaled lagged copy of the
Simulate Secondary's PV. Normally, only the TM_LAG value needs to be adjusted for the
application.

Parameter Assignment
To scale the primary input signal, set the primary's engineering high via PRIMARY_PV_IN's
VHRANGE input and the Process Value engineering low via PRIMARY_PV_IN's VLRANGE
input.
To scale the secondary input signal, set the secondary's engineering high via
SECONDARY_PV_IN's VHRANGE input and the Process Value engineering low via
SECONDARY_PV_IN's VLRANGE input.
This chart presumes that the CONTROLLER P_VL_EUMIN should equal the CONTROLLER
S_PV_EUMIN and that the CONTROLLER P_VL_EUMAX should equal the CONTROLLER
S_PV_EUMAX.
To scale the output signal, set the Control OUT value engineering high via CONTROLLER's
S_VL_EUMAX input and the Control OUT Engineering Low via S_VL_EUMIN input. These
engineering limits will be conveyed to the S_VL_EUMAX_OUT output and
S_VL_EUMIN_OUT outputs, respectively. As configured, SECONDARY_VL_OUT's upper
limit (UHRANGE) and the SECONDARY_VL_OUT's lower limit (ULRANGE) match the
CONTROLLER's S_VL_EUMAX and S_VL_EUMIN, respectively.
Configure the following parameters (which are marked for IEA) in the CONTROLLER (both
primary and secondary) for your application:
● All tuning parameters (PG, TI, TD and DG)
● All high/low alarm and absolute deviation limits (H_LIM, L_LIM, AD_LIM)
● Valve scaling units (VL_EUMIN, VL_EUMAX)
● Valve "clamping" limits (VLH, VLL). Note that VLH cannot exceed 3% of span above
VL_EUMAX and VLL cannot exceed 3% of span below VL_EUMIN.
● Setpoint limits (SPH, SPL)

Faults
Channel faults are detected by the PRIMARY_PV_IN input and are assigned to input
P_QBAD of the CONTROLLER block. An alarm message will then be posted if P_QUAL_EN

APACS+ ES Library User's Guide for V7.1


184 Manual, 04/2009, A5E02453738-01
ES Library
1.3 Template Charts

is enabled. Channel faults are detected by the SECONDARY_PV_IN input and the
SECONDARY_VL_OUT and are assigned to input S_QBAD of the CONTROLLER block. An
alarm message will then be posted if S_QUAL_EN is enabled.

See also
CASCADE_BLK (Page 41)

1.3.5 DISCRETE_ALM_AT
This template can be used to implement a discrete indicator with alarm. The template
includes a digital input driver. A discrete alarm is provided for the discrete input (DN). The
ALARM output provides the alarm status of the block. The block provides an alarm when the
discrete input is in an undesired state.

Interconnections
The signal to be monitored must be connected to the VALUE input of the SIGNAL block via
symbolic addressing.

Simulation
Discrete value monitoring can be tested during the configuring phase. This merely requires
that input SIM_ON of the SIGNAL block be switched on, and that the value 1 or 0 be preset
at input SIM_I.

Parameter Assignment
Configure the LIMIT parameter (which is marked for IEA) in the ALARM for your application.

Faults
Channel faults are detected by the input driver block.

See also
DISCRETE_ALM_BLK (Page 64)

1.3.6 EXT_SET_AT
This template can be used as an external-set PID controller with tracking setpoint. High and
low alarms are provided for the process variable. Another alarm is provided to detect
deviation between the process variable and setpoint. The CONTROLLER block has PV and
ESP inputs for the process variable and external setpoint. It also has SP_OUT, OUT, and
ALARM outputs for the setpoint, output, and alarm status of the loop, respectively. The
control loop contains, apart from the controller, an input driver, an output driver, and a delay
element for simulation.

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 185
ES Library
1.3 Template Charts

Interconnections
The signal for the process value must be connected to the VALUE input of block PV_IN via
symbolic addressing. The VALUE output of the OUTPUT block must be connected via
symbolic addressing to the signal for the actuator to be controlled.

Simulation
During the configuring phase, the controller can be tested with the delay element. This
merely requires that input SIM_ON of block PV_IN be switched on. The Simulation CFC
implements simple simulation by feeding back a scaled lagged copy of the CONTROLLER's
OUT signal. Normally, only the TM_LAG value needs to be adjusted for the application.

Parameter Assignment
To scale the input signal, set the Process Value engineering high via the input driver PV_IN's
VHRANGE input and the Process Value engineering low via PV_IN's VLRANGE input.
These engineering limits will be conveyed to the CONTROLLER's PV_EUMAX and
PV_EUMIN, respectively.
To scale the output signal, set the Control OUT value engineering high via CONTROLLER's
VL_EUMAX input and the Control OUT Engineering Low via CONTROLLER's VL_EUMIN
input. These engineering limits will be conveyed to the CONTROLLER's VL_EUMAX_OUT
and VL_EUMIN_OUT outputs, respectively. As configured, OUTPUT's upper limit
(UHRANGE) and the OUTPUT's lower limit (ULRANGE) match the CONTROLLER's
VL_EUMAX and VL_EUMIN, respectively.
Configure the following parameters (which are marked for IEA) for your application:
● All tuning parameters (PG, TI, TD and DG)
● All high/low alarm and absolute deviation limits (H_LIM, L_LIM, AD_LIM)
● Valve scaling units (VL_EUMIN, VL_EUMAX)
● Valve "clamping" limits (VLH, VLL). Note that VLH cannot exceed 3% of span above
VL_EUMAX and VLL cannot exceed 3% of span below VL_EUMIN.
● Setpoint limits (SPH, SPL)

Faults
Channel faults are detected by the input and output drivers and are assigned to input QBAD
of the CONTROLLER block. An alarm message will then be posted if QUAL_EN is enabled.

See also
EXT_SET_BLK (Page 66)

1.3.7 MOTOR_A_ALM_AT
This template can be used to implement standard motor start/stop functions. Device
alarming functions are provided. This MOTOR block is an encapsulation of the MOTOR_A
block with a 4-element discrete alarm block. The MOTOR block has inputs PROOF,

APACS+ ES Library User's Guide for V7.1


186 Manual, 04/2009, A5E02453738-01
ES Library
1.3 Template Charts

A_STRT, A_STOP, and INT01-INT11 for the proof, auto start command, auto stop
command, and eleven interlocks, and parameters OUT, and FAIL for the output, and failure
status of the motor, respectively. Alarms are reported for the following conditions:
● Failure to start (or loss of proof)
● Failure to stop (or unexpected proof)
● Uncommanded stop or rejected start command (due to interlock)
The latched fail state is unlatched automatically when the alarm is acknowledged.
The motor circuit contains, apart from the motor block, a digital input driver and digital output
driver.

Interconnections
The signal for the feedback run must be connected to the VALUE input of block FB_RUN via
symbolic addressing. The VALUE output of the OUTPUT block must be connected via
symbolic addressing to the signal for the motor to be controlled.

Simulation
If there is no run feedback, the simulation can be switched on at driver block FB_RUN
(SIM_ON = 1). Simulation of motor proof is accomplished by delaying the MOTOR block's
OUT signal via a TIMER_P block (SIMULATION). Note that the TIME0 parameter should be
less than MOTOR block's STRT_T and STOP_T parameters.

Parameter Assignment
Configure the following parameters for your application:
● To set the MOTOR block's maximum allowed time to start and stop, set the parameter
STRT_T and STOP_T of the MOTOR block (which are marked for IEA) individually.
● Interlocks and Interlock descriptions.
● Permit and Permit description.

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 187
ES Library
1.3 Template Charts

Faults
Channel faults are detected by the input and output drivers.

Note
Compiling Source Charts "as Program"
In the unlikely scenario that MOTOR_A_ALM or VALVE_A_ALM source charts are copied
into a user project as chart or used as chart-in-chart , and then all charts are compiled "as
Program", errors will be flagged by the CFC compiler for the BA_NA chart input connections.
This is not a normal or recommended scenario, since these charts and modifications of them
are designed to be compiled as "Block Type". The errors occur because the current CFC
version does not allow chart input connections of data type STRING to more than one
internal parameter. The workaround would be to add a second chart input parameter, for
example BA_NA_1 and connect these two chart inputs each to its own single destination
parameter inside the chart.

See also
MOTOR_A_ALM_BLK (Page 86)

1.3.8 MOTOR_1OUT_AT
This template can be used to implement a motor start/stop with one output. The block is
designed for a motor with auto/manual operation, pulse commands, and interlocking. An
alarm is provided for failure to reach the desired state. The block has inputs PROOF,
A_STRT, A_STOP, and INTRLK for the proof, auto start command, auto stop command, and
interlock; and outputs OUT, and FAIL for the output, and failure status of the motor,
respectively. The motor circuit contains, apart from the motor block, a digital input driver and
digital output driver.

Interconnections
The signal for the feedback run must be connected to the VALUE input of block FB_RUN via
symbolic addressing. The VALUE output of the OUTPUT block must be connected via
symbolic addressing to the signal for the motor to be controlled.

Simulation
If there is no feedback run, the simulation can be switched on at driver block FB_RUN
(SIM_ON = 1). Simulation of motor proof is accomplished by delaying the MOTOR block's
OUT signal via a TIMER_P block (SIMULATION). Note that the TIME0 parameter should be
less than MOTOR block's STRT_T and STOP_T parameters.

APACS+ ES Library User's Guide for V7.1


188 Manual, 04/2009, A5E02453738-01
ES Library
1.3 Template Charts

Parameter Assignment
Configure the following parameters for your application:
● To set the MOTOR block's maximum allowed time to start and stop, set the parameters
STRT_T and STOP_T of the MOTOR block (which are marked for IEA) individually.
● Interlock

Faults
Channel faults are detected by the input and output drivers.

See also
MOTOR_1OUT_BLK (Page 92)

1.3.9 MOTOR_2OUT_AT
This template can be used to implement a motor start/stop with a start output and a stop
output. The block is designed for a motor with auto/manual operation, pulse commands, and
interlocking. An alarm is provided for failure to reach the desired state. The MOTOR block
has inputs PROOF, A_STRT, A_STOP, and INTRLK for the proof, auto start command, auto
stop command, and interlock; and outputs STRT_O, STOP_O, and FAIL for the start output,
stop output, and failure status of the motor, respectively. The motor circuit contains, apart
from the motor block, a digital input driver and two digital output drivers.

Interconnections
The signal for the feedback run must be connected to the VALUE input of block FB_RUN via
symbolic addressing. The VALUE output of the STRT_OUTPUT block must be connected
via symbolic addressing to the signal for the motor to be controlled. The VALUE output of the
STOP_OUTPUT block must be connected via symbolic addressing to the signal for the
motor to be controlled.

Simulation
If there is no feedback run, the simulation can be switched on at driver block FB_RUN
(SIM_ON = 1). An SR_FF block (Simulate State) and a TIMER_P block (Simulate Delay) is
used to implement the simulation of the feedback. Note that the TIMEO parameter should be
less than MOTOR's STRT_T and STOP_T parameters.

Parameter Assignment
Configure the following parameters for your application:
● To set the MOTOR block's maximum allowed time to start and stop, set the parameter
STRT_T and STOP_T of the MOTOR block (which are marked for IEA) individually.
● Interlock

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 189
ES Library
1.3 Template Charts

Faults
Channel faults are detected by the input and output drivers.

See also
MOTOR_2OUT_BLK (Page 97)

1.3.10 PRIMARY_SECONDARY_AT
This template can be used as a cascade circuit. The output from the primary loop is the
setpoint to the secondary loop, and the cascade status of the secondary loop is fed to the
primary loop. High and low alarms are provided for each process variable, and an alarm is
provided for deviation between process variable and setpoint. The PRIMARY block has
inputs PV, FDBK, and CASC_S for the process variable, feedback, and cascade status, and
outputs SP_OUT, OUT, and ALARM for the setpoint, output, and alarm status of the loop,
respectively. The SECONDARY block has inputs PV and ESP for the process variable and
external setpoint, and outputs SP_OUT, OUT, ALARM, and CASC_S for the setpoint, output,
alarm status, and cascade status of the loop, respectively. The control loop contains, apart
from the controller, two input drivers (PRIMARY_PV_IN, SECONDARY_PV_IN), an output
driver (SECONDARY_VL_OUT) and delay elements for simulation.

Interconnections
The signal for the primary value must be connected to the VALUE input of block
PRIMARY_PV_IN via symbolic addressing. The signal for the secondary value must be
connected to the VALUE input of block SECONDARY_PV_IN via symbolic addressing. The
VALUE output of the SECONDARY_VL_OUT block must be connected via symbolic
addressing to the signal for the actuator to be controlled.

Simulation
During the configuring phase, the controller can be tested with the delay element. This
merely requires that input SIM_ON of block PRIMARY_PV_IN and the input SIM_ON of block
SECONDARY_PV_IN be switched on. The Simulate Secondary CFC implements simple
simulation by feeding back a scaled lagged copy of the SECONDARY's OUT signal.
Normally, only the TM_LAG value needs to be adjusted for the application. The Simulate
Primary CFC implements simple simulation by feeding back a scaled lagged copy of
Simulate Secondary's PV. Normally, only the TM_LAG value needs to be adjusted for the
application.

Parameter Assignment
To scale the primary input signal, set the primary's engineering high via PRIMARY_PV_IN's
VHRANGE input and the Process Value engineering low via PRIMARY_PV_IN's VLRANGE
input.
To scale the secondary input signal, set the secondary's engineering high via
SECONDARY_PV_IN's VHRANGE input and the Process Value engineering low via
SECONDARY_PV_IN's VLRANGE input.

APACS+ ES Library User's Guide for V7.1


190 Manual, 04/2009, A5E02453738-01
ES Library
1.3 Template Charts

This chart presumes that the PRIMARY VL_EUMIN should equal the SECONDARY
PV_EUMIN and that the PRIMARY VL_EUMAX should equal the SECONDARY
PV_EUMAX.
To scale the output signal, set the Control OUT value engineering high via SECONDARY's
VL_EUMAX input and the Control OUT Engineering Low via SECONDARY 's VL_EUMIN
input. These engineering limits will be conveyed to the SECONDARY's VL_EUMAX_OUT
and VL_EUMIN_OUT outputs, respectively. As configured, SECONDARY_VL_OUT's upper
limit (UHRANGE) and the SECONDARY_VL_OUT's lower limit (ULRANGE) match the
SECONDARY's VL_EUMAX and VL_EUMIN, respectively.
Configure the following parameters (which are marked for IEA) in the PRIMARY and
SECONDARY for your application:
● All tuning parameters (PG, TI, TD and DG)
● All high/low alarm and absolute deviation limits (H_LIM, L_LIM, AD_LIM)
● Valve scaling units (VL_EUMIN, VL_EUMAX)
● Valve "clamping" limits (VLH, VLL). Note that VLH cannot exceed 3% of span above
VL_EUMAX and VLL cannot exceed 3% of span below VL_EUMIN.
● Setpoint limits (SPH, SPL)

Faults
Channel faults are detected by the PRIMARY_PV_IN input and are assigned to input QBAD
of the PRIMARY block. An alarm message will then be posted if QUAL_EN is enabled.
Channel faults are detected by the SECONDARY_PV_IN input and the
SECONDARY_VL_OUT and are assigned to input QBAD of the SECONDARY block. An
alarm message will then be posted if QUAL_EN is enabled.

See also
PRIMARY_BLK (Page 104)
SECONDARY_BLK (Page 124)

1.3.11 RATIO_SET_AT
This template can be used use as a ratio-set PID controller with tracking setpoint. An
external ratio input is multiplied by a desired ratio value (i.e. a controlled variable divided by
wild variable) to calculate the external setpoint. The process variable is divided by the
external input for display of the actual ratio. Both high and low alarms are provided for the
process variable, and an additional alarm is provided to detect a deviation between the
process variable and setpoint. The CONTROLLER block has PV and RAT_INP inputs for the
process variable and external input. It also has SP_OUT, OUT, RAT_ACT, DESRAT, and
ALARM outputs for the setpoint, output, actual ratio, desired ratio, and alarm status of the
loop, respectively. The control loop contains, apart from the controller, two input drivers
(PV_IN and RATIO_IN), an output driver (OUTPUT) and a delay element for simulation.

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 191
ES Library
1.3 Template Charts

Interconnections
The signal for the process value must be connected to the VALUE input of block PV_IN via
symbolic addressing. The signal for the external ratio actual value must be connected to the
VALUE input of the block RATIO_IN via symbolic addressing. The VALUE output of the
OUTPUT block must be connected via symbolic addressing to the signal for the actuator to
be controlled.

Simulation
During the configuring phase, the controller can be tested with the delay element. This
merely requires that input SIM_ON of block PV_IN be switched on. The Simulation CFC
implements simple simulation by feeding back a scaled lagged copy of the CONTROLLER's
OUT signal. Normally, only the TM_LAG value needs to be adjusted for the application.

Parameter Assignment
To scale the input signal, set the Process Value engineering high via the input driver PV_IN's
VHRANGE input and the Process Value engineering low via PV_IN's VLRANGE input.
These engineering limits will be conveyed to the CONTROLLER's PV_EUMAX and
PV_EUMIN, respectively.
To scale the output signal, set the Control OUT value engineering high via CONTROLLER's
VL_EUMAX input and the Control OUT Engineering Low via CONTROLLER's VL_EUMIN
input. These engineering limits will be conveyed to the CONTROLLER's VL_EUMAX_OUT
and VL_EUMIN_OUT outputs, respectively. As configured, the OUTPUT's upper limit
(UHRANGE) and the OUTPUT's lower limit (ULRANGE) match the CONTROLLER's
VL_EUMAX and VL_EUMIN, respectively
Configure the following parameters (which are marked for IEA) for your application:
● All tuning parameters (PG, TI, TD and DG)
● All high/low alarm and absolute deviation limits (H_LIM, L_LIM, AD_LIM)
● Valve scaling units (VL_EUMIN, VL_EUMAX)
● Valve "clamping" limits (VLH, VLL). Note that VLH cannot exceed 3% of span above
VL_EUMAX and VLL cannot exceed 3% of span below VL_EUMIN.
● Setpoint limits (SPH, SPL)

Faults
Channel faults are detected by the input and output drivers and are assigned to input QBAD
of the CONTROLLER block. An alarm message will then be posted if QUAL_EN is enabled.

See also
RATIO_SET_BLK (Page 113)

APACS+ ES Library User's Guide for V7.1


192 Manual, 04/2009, A5E02453738-01
ES Library
1.3 Template Charts

1.3.12 SINGLE_LOOP_AT
This template can be used to implement a single-loop PID controller with a tracking setpoint.
Both high and low alarms are provided for the process variable. Another alarm is provided to
detect a deviation between the process variable and setpoint. The controller block has a PV
input for the process variable. It also has SP_OUT, OUT, and ALARM outputs for the
setpoint, output, and alarm status of the loop, respectively. The control loop contains, apart
from the controller, an input driver (PV_IN), an output driver (OUTPUT) and a delay element
for simulation.

Interconnections
The signal for the actual value must be connected to the VALUE input of block PV_IN via
symbolic addressing. The VALUE output of the OUTPUT block must be connected via
symbolic addressing to the signal for the actuator to be controlled.

Simulation
During the configuring phase, the controller can be tested with the delay element. This
merely requires that input SIM_ON of block PV_IN be switched on. The Simulation CFC
implements simple simulation by feeding back a scaled lagged copy of the CONTROLLER's
OUT signal. Normally, only the TM_LAG value needs to be adjusted for the application.

Parameter Assignment
To scale the input signal, set the Process Value engineering high via the input driver PV_IN's
VHRANGE input and the Process Value engineering low via PV_IN's VLRANGE input.
These engineering limits will be conveyed to the CONTROLLER's PV_EUMAX and
PV_EUMIN, respectively.
To scale the output signal, set the Control OUT value engineering high via CONTROLLER's
VL_EUMAX input and the Control OUT Engineering Low via CONTROLLER's VL_EUMIN
input. These engineering limits will be conveyed to the CONTROLLER's VL_EUMAX_OUT
and VL_EUMIN_OUT outputs, respectively. As configured, OUTPUT's upper limit
(UHRANGE) and the OUTPUT's lower limit (ULRANGE) match the CONTROLLER's
VL_EUMAX and VL_EUMIN, respectively.
Configure the following parameters (which are marked for IEA) for your application:
● All tuning parameters (PG, TI, TD and DG)
● All high/low alarm and absolute deviation limits (H_LIM, L_LIM, AD_LIM)
● Valve scaling units (VL_EUMIN, VL_EUMAX)
● Valve "clamping" limits (VLH, VLL). Note that VLH cannot exceed 3% of span above
VL_EUMAX and VLL cannot exceed 3% of span below VL_EUMIN.
● Setpoint limits (SPH, SPL)

Faults
Channel faults are detected by the input and output drivers and are assigned to input QBAD
of the CONTROLLER block. An alarm message will then be posted if QUAL_EN is enabled.

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 193
ES Library
1.3 Template Charts

See also
SINGLE_LOOP_BLK (Page 138)

1.3.13 SINGLE_LP_EM_AT
This template can be used to implement a single-loop PID controller with tracking setpoint
and Emergency Manual functionality. The External Value and Emergency Manual command
inputs allow the controller output to be immediately forced to any desired value. High and low
alarms are provided for the process variable, and an additional alarm is provided to detect a
deviation between the process variable and setpoint. The CONTROLLER block has PV,
EXTV, and EM inputs for process variable, external value, and Emergency Manual
command. It also has SP_OUT, OUT, and ALARM outputs for the setpoint, output, and
alarm status of the loop, respectively. The control loop contains, apart from the controller, an
input driver (PV_IN), an output driver (OUTPUT) and a delay element for simulation.

Interconnections
The signal for the process value must be connected to the VALUE input of block PV_IN via
symbolic addressing. The VALUE output of the OUTPUT block must be connected via
symbolic addressing to the signal for the actuator to be controlled.

Simulation
During the configuring phase, the controller can be tested with the delay element. This
merely requires that input SIM_ON of block PV_IN be switched on. The Simulation CFC
implements simple simulation by feeding back a scaled lagged copy of the CONTROLLER's
OUT signal. Normally, only the TM_LAG value needs to be adjusted for the application.

Parameter Assignment
To scale the input signal, set the Process Value engineering high via the input driver PV_IN's
VHRANGE input and the Process Value engineering low via PV_IN's VLRANGE input.
These engineering limits will be conveyed to the CONTROLLER's PV_EUMAX and
PV_EUMIN, respectively.
To scale the output signal, set the Control OUT value engineering high via CONTROLLER's
VL_EUMAX input and the Control OUT Engineering Low via CONTROLLER's VL_EUMIN
input. These engineering limits will be conveyed to the CONTROLLER's VL_EUMAX_OUT
and VL_EUMIN_OUT outputs, respectively. As configured, OUTPUT's upper limit
(UHRANGE) and the OUTPUT's lower limit (ULRANGE) match the CONTROLLER's
VL_EUMAX and VL_EUMIN, respectively
Configure the following parameters (which are marked for IEA) for your application:
● All tuning parameters (PG, TI, TD and DG)
● All high/low alarm and absolute deviation limits (H_LIM, L_LIM, AD_LIM)
● Valve scaling units (VL_EUMIN, VL_EUMAX)
● Valve "clamping" limits (VLH, VLL). Note that VLH cannot exceed 3% of span above
VL_EUMAX and VLL cannot exceed 3% of span below VL_EUMIN.
● Setpoint limits (SPH, SPL)

APACS+ ES Library User's Guide for V7.1


194 Manual, 04/2009, A5E02453738-01
ES Library
1.3 Template Charts

Faults
Channel faults are detected by the input and output drivers and are assigned to input QBAD
of the CONTROLLER block. An alarm message will then be posted if QUAL_EN is enabled.

1.3.14 SINGLE_LP_SS_AT
This template can be used to implement a single-loop PID controller with tracking setpoint
and standby sync functionality. The External Value and Standby Sync command inputs allow
the controller output to be immediately forced to any desired value. High and low alarms are
provided for the process variable, and an additional alarm is provided to detect a deviation
between the process variable and setpoint. The CONTROLLER block has PV, EXTV, and
SS inputs for process variable, external value, and standby sync command. It also has
SP_OUT, OUT, and ALARM outputs for the setpoint, output, and alarm status of the loop,
respectively. The control loop contains, apart from the controller, an input driver (PV_IN), an
output driver (OUTPUT) and a delay element for simulation.

Interconnections
The signal for the process value must be connected to the VALUE input of block PV_IN via
symbolic addressing. The VALUE output of the OUTPUT block must be connected via
symbolic addressing to the signal for the actuator to be controlled.

Simulation
During the configuring phase, the controller can be tested with the delay element. This
merely requires that input SIM_ON of block PV_IN be switched on. The Simulation CFC
implements simple simulation by feeding back a scaled lagged copy of the CONTROLLER's
OUT signal. Normally, only the TM_LAG value needs to be adjusted for the application.

Parameter Assignment
To scale the input signal, set the Process Value engineering high via the input driver PV_IN's
VHRANGE input and the Process Value engineering low via PV_IN's VLRANGE input.
These engineering limits will be conveyed to the CONTROLLER's PV_EUMAX and
PV_EUMIN, respectively.
To scale the output signal, set the Control OUT value engineering high via CONTROLLER's
VL_EUMAX input and the Control OUT Engineering Low via CONTROLLER's VL_EUMIN
input. These engineering limits will be conveyed to the CONTROLLER's VL_EUMAX_OUT
and VL_EUMIN_OUT outputs, respectively. As configured, OUTPUT's upper limit
(UHRANGE) and the OUTPUT's lower limit (ULRANGE) match the CONTROLLER's
VL_EUMAX and VL_EUMIN, respectively
Configure the following parameters (which are marked for IEA) for your application:
● All tuning parameters (PG, TI, TD and DG)
● All high/low alarm and absolute deviation limits (H_LIM, L_LIM, AD_LIM)
● Valve scaling units (VL_EUMIN, VL_EUMAX)

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 195
ES Library
1.3 Template Charts

● Valve "clamping" limits (VLH, VLL). Note that VLH cannot exceed 3% of span above
VL_EUMAX and VLL cannot exceed 3% of span below VL_EUMIN.
● Setpoint limits (SPH, SPL)

Faults
Channel faults are detected by the input and output drivers and are assigned to input QBAD
of the CONTROLLER block. An alarm message will then be posted if QUAL_EN is enabled.

See also
SINGLE_LP_SS_BLK (Page 156)

1.3.15 VALVE_A_ALM_AT
This template can be used to implement standard valve open/close and device alarming
functions. The VALVE block is an encapsulation of the VALVE_A block with a 4-element
discrete alarm block. The VALVE block has inputs OP_VER, CL_VER, A_OPEN, A_CLSE,
and INT0-INT10 for the open verify, close verify, auto open command, auto close command,
and ten separate interlocks, and parameters OUT and FAIL for the output, and failure status
of the valve, respectively. Alarms are provided for the following conditions:
● Failure to open (or loss of open verify)
● Failure to close (or loss of close verify)
● Uncommanded close/open or rejected command (due to interlock)
● Failed limit switch (Open and close verify inputs are set.)
The latched fail state of the VALVE_A block is unlatched automatically when the alarm is
acknowledged. The valve circuit contains, apart from the valve block, two digital input drivers
and one digital output driver.

Interconnections
The signal for the feedback (open/closed) must be connected to the VALUE inputs of blocks
FB_OPEN and FB_CLOSED via symbolic addressing. The VALUE output of the OUTPUT
block must be connected via symbolic addressing to the signal for the valve to be controlled.

Simulation
If there is no feedback, the simulation can be switched on at driver blocks FB_OPEN and
FB_CLOSED (SIM_ON = 1). A connection is provided from the VALVE output OUT to a
TIMER_P delay block (SIMULATION) IO input. The SIMULATION QO output is connected to
the input SIM_I of block FB_OPEN. It is also connected to input SIM_I of block FB_CLOSED
after being inverted. Simulation of valve limit switches is accomplished by delaying VALVE
block's OUT signal. Note than the TIME0 parameter should be less than VALVE's OPEN_T
and CLOS_T parameters.

APACS+ ES Library User's Guide for V7.1


196 Manual, 04/2009, A5E02453738-01
ES Library
1.4 Message class

Parameter Assignment
Configure the following parameters for your application:
● To set the VALVE block's maximum allowed time to open and close, set the parameters
OPEN_T and CLOS_T of the VALVE block (which are marked for IEA) individually.
● Interlocks and Interlock descriptions
● Permit and Permit description
● Fail-safe state of the valve (FAIL_OPEN)

Faults
Channel faults are detected by the input and output drivers.

Note
Compiling Source Charts "as Program"
In the unlikely scenario that MOTOR_A_ALM or VALVE_A_ALM source charts are copied
into a user project as chart or used as chart-in-chart , and then all charts are compiled "as
Program", errors will be flagged by the CFC compiler for the BA_NA chart input connections.
This is not a normal or recommended scenario, since these charts and modifications of them
are designed to be compiled as "Block Type". The errors occur because the current CFC
version does not allow chart input connections of data type STRING to more than one
internal parameter. The workaround would be to add a second chart input parameter, for
example BA_NA_1 and connect these two chart inputs each to its own single destination
parameter inside the chart.

See also
VALVE_A_ALM_BLK (Page 166)

1.4 Message class

Classification of messages in accordance with their cause. The following message classes
are used in the SIMATIC process control system:
● Process signals which are triggered when process-specific monitoring values (for
example: alarms, interrupts, upper/lower tolerance, general process signals) are reached
or exceeded.
● Control system messages which are output by the control system (system messages),
the I/O units (errors in the field) or for preventive maintenance.
● Requests for operator input which, in the case of certain operation sequences, draw the
operator's attention to the necessity of an operator intervention (for example, request to
acknowledge a stepping operation manually in order to enable transition) or operator
input lists.

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 197
ES Library
1.5 Differences between APACS+ and PCS 7

Table of possible message classes and their meanings:

Message class Meaning


AH Alarm high (high high alarm)
WH Warning high (high alarm)
WL Warning low (low alarm)
AL Alarm low (low low alarm)
TH Tolerance high
TL Tolerance low
F Process error (field)
S Control system message (system)
S* OS control system message (fault)
M Preventive maintenance
PM Process message
- Operation message
OR Operator request
OM*1) Operation message
*1) If the block is used for operation messages, the inputs I_1, ... have to be supplied with pulses.
Assignment of the static value 1 would lead to multiple messages.

1.5 Differences between APACS+ and PCS 7

1.5.1 General Differences

Softlist Parameters
There are no softlist parameters in function blocks created in PCS 7. In general, these
values have become In/Out parameters. In some specific cases, they are inputs.

Time Parameters
Time parameters have a different range of values. The maximum values are as follows:

APACS+ maximum time 49d17h2m47s295ms


PCS 7/APACS+ ES Libraries maximum time 24d20h31m23s647ms

Relationship Between Blocks and Charts


In APACS+, Derived Function Blocks can be opened in 4-mation to give the user access to
the standard function blocks that form the DFB. During runtime, the values of the component
FBs can be viewed and modified. The DFBs also have faceplates to allow the values to be
viewed and modified from an HMI. Source charts created in the CFC editor of the PCS 7 ES

APACS+ ES Library User's Guide for V7.1


198 Manual, 04/2009, A5E02453738-01
ES Library
1.5 Differences between APACS+ and PCS 7

look very similar to DFBs opened in 4-mation. However, the source charts are not open
blocks; they are compiled to create function blocks. Both charts and the FBs created from
them can be placed in CFCs, but only charts can be opened. On the other hand, faceplates
can only be associated with function blocks, not charts.

Restart Logic Explanation


APACS+ uses local variables, Input/output nubs, and softlist parameters to define the
operational state of a control algorithm. In APACS+, the initial value of local variables is used
to automatically force the given state of a control object. For example, the control object
Single_Loop can be forced to Auto on a cold start by setting the initial value of the local
variable AUTO to TRUE. Within APACS+, the only way in which the initial value of AUTO
can be changed is from the engineering console using 4-mation to edit this value.
PCS 7 combines the functions of local variables, Input/output nubs, and softlist parameters
into block parameters. Block parameters can be viewed as physical Input/output nubs on the
block or by selecting to view the block parameters. You might say that all parameters are
now "softlist" parameters that can also be viewed as block nubs on a per instance basis by
the user. Referring back to the example of Single_Loop operating within PCS 7, the user can
define the initial state of the parameter AUTO. This value will be used the first time the
configuration is downloaded to the controller. A feature exists within PCS 7 that allows the
user to read back parameters such as AUTO. Once this is done, the initially configured value
will be overwritten. For example:
1. The original configuration of AUTO was defined as TRUE.
2. The configuration is then downloaded to the controller. This loop starts in Auto.
3. The operator changes the controller to Manual (AUTO=FALSE).
4. The user performs a read back or upload.
5. The user then downloads the configuration to the controller again.
6. This loop will now start in Manual and not Auto.
The addition of Restart Logic in the APACS+ Library blocks allows the user to define a
restart state independent of the user performing a readback or upload of the controller
configuration. See the help for each FB for an explanation of the restart parameters
provided. See the section on Read Back (S7) for additional information on this PCS 7
functionality.

Read Back (S7)


You can save (read back) the parameters of all active CFC charts of the chart folder and
changes to AS data (e.g. limit values or control parameters modified by the operator at an
OS with PCS 7 OS).
You request to read back parameters via the Chart > Read Back... menu command.
When you select the "Online program" option in the "Read Back" dialog box to define the
source file, the program of the CPU (online block folder) will be read back to the chart folder,
including actual parameters.
Another read back method is to set the "Offline program" option in the "Read Back" dialog
box to define the source file, after you have read back those data from the CPU in the online
view via SIMATIC Manager (by means of the PLC > Upload menu command). Data will now
be fetched from the offline block folder and written to the chart folder.

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 199
ES Library
1.5 Differences between APACS+ and PCS 7

In either case, the dialog lets you choose to read back all parameters of the block inputs or
only the parameters assigned the operator control and monitoring (S7_m_c:='true') system
attribute.
In a PCS 7 project, only the "Parameters controllable in WinCC" option is useful and thus set
for read back actions by default.
The following rules apply, irrespective of the scope set for the read back function:
● Only in_out and input parameters can be read back (not output parameters).
● The following data types are ignored when reading back data:
ANY, ARRAY, POINTER, UDT.
● Inputs with write access by SFC chart are not read back.
● Certain blocks can be excluded from the read back operation (e.g. BATCH blocks). In this
case, the block type is assigned the S7_read_back := 'false' attribute. This attribute
cannot be modified in block instances.
● Note on H CPUs:
If the H CPU is operated in stand-alone mode (e.g. due to CPU failure) and a CPU fail-
over has taken place, the user is prompted to select the required CPU after an online
access request. This dialog does not appear if the CPU is operated in redundant mode.
● Note on the download of HW Config data:
Please note that the CPU will write data from load memory to work memory after you
have downloaded HW Config data. Changes effected in debug mode or via operator
control and monitoring only exist in work memory. Due to the transfer of data from load
memory, all data in work memory will be lost, since its initial values will be overwritten by
data from load memory. In this case you can create a backup of operator control data by
means of read back, before you perform a download of HW Config data. You can then
include these backup data in a program download to the CPU (in STOP mode).
The following applies for setting the scope of the "Parameters controllable in WinCC"
function:
● Values of FC inputs will be ignored.
The following applies for setting the scope of "All parameters" function:
● FC inputs interconnected to chart I/Os will be read back. This also applies to chart I/Os
with multiple interconnections to block inputs (FB and FC).
After read back:
● The full program is compiled automatically in order to ensure consistency. This does not,
however require a download of the full program, i.e. you can also perform a delta
download when the CPU is in RUN mode.
● A log file will be generated during read back and displayed after completion. You can
always view this log via the Options > Logs > Tab: Read Back menu command. The log
entries indicate
● I/Os read back and modified
● Where problems occurred

APACS+ ES Library User's Guide for V7.1


200 Manual, 04/2009, A5E02453738-01
ES Library
1.5 Differences between APACS+ and PCS 7

Batch Parameters
The SIMATIC Batch parameters are:

BA_EN Batch enabled


OCCUPIED Occupied by batch
BA_NA Batch name
BA_ID Batch ID number
STEP_NO Batch step number
The batch parameters have been added as inputs to most of the control blocks for support of
batch operations. A future Batch View faceplate or a customized faceplate may display the
values in the HMI corresponding to these parameters.
The current values of BA_NA, BA_ID and STEP_NO are available for transmitting in alarm
messages to the HMI, so that these values may be displayed and logged.

DecimalPlaces
Input parameters DecimalPlacesPV, DecimalPlacesOUT, etc have been added to loop
control blocks to allow specifying the number of decimal places to display on the block's
faceplate in the HMI. The range is 0 to 6, with a default value of 2.

ConfirmChange
The ConfirmChange input flag is added to most of the library blocks, to control operator
changes in the HMI. The default value is FALSE, but this may be re-configured for any
desired block instance.
If ConfirmChange is FALSE (default):
● Operator changes are "one-step", no further confirmation is required.
● all choices that are two-state, such as Auto/Manual, will immediately toggle to the other
state.
● Increase/Decrease buttons will be visible and may be used by operator for quick changes
of analog values, when appropriate (e.g. changing SP when in Auto mode).
If ConfirmChange is TRUE:
● Operator changes are "two-step", further confirmation is required. Usually an "input
panel" will pop up, where operator may select a value and click OK.
● all choices including two-state choices require confirmation.
● Increase/Decrease buttons will be invisible.
Note that in both cases all operator changes are sent to the Operation List log.

Operator or Program control of important loop variables


Often there is a need for a program, for example a Batch program, to take control of one or
more important loop variables such as SP, OUT, Auto/Manual, etc. At these times the
operator in the HMI should not be able to control the variables in order to avoid conflict.

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 201
ES Library
1.5 Differences between APACS+ and PCS 7

In APACS programs, the SET_VAL block could be used by a program to write to a variable
and then return control of the same variable to the operator.
Instead, the New ES Library uses the PCS 7 technique of selecting between "Link" (i.e. a
linked connection to a block in the program) and "Operator", the operator in the HMI. New
parameters beginning with "LIOP_..." can be seen for this purpose. For example, the switch
between Auto and Manual modes of operation can be made either by the Program or by the
Operator, as follows:
● LIOP_MAN_SEL = TRUE: The connected value at the AUT_L ("link ") block input will
determine the Auto/Manual mode. Operator input is ignored.
● LIOP_MAN_SEL = FALSE: The operator input from the HMI will determine the
Auto/Manual mode. The value configured at the AUT_L block input is ignored.
In all cases the correct current value of the variable is shown to the operator in the faceplate.

Process Object View


Many of the configurable parameters of the library have been enabled for viewing and editing
with the SIMATIC Process Object View tool in SIMATIC Manager, accessible under the
"View" menu. This gives a convenient method for bulk programming of selected values in the
program.

1.5.2 Alarm Differences


The philosophy of acknowledgement of alarms that are disabled or out-of-service differs
between APACS+ and PCS 7. In APACS+, when an alarm is disabled or alarms are OOS,
all affected current alarms are set FALSE and automatically acknowledged in the controller,
but are still shown as active in the HMI. In PCS 7, alarms are acknowledged in the HMI and
reported to the controller. When an alarm is disabled or alarms are OOS, all affected current
alarms are set FALSE in the controller, but they are not automatically acknowledged in order
to avoid a difference between the controller state and the state of the HMI. In the HMI, any
affected alarm that was previously acknowledged will be removed from the incoming alarm
list. Any affected alarm that was not previously acknowledged will show a change of status to
indicate that the condition is gone. New alarms will not be posted in either PCS 7 or
APACS+ if they are disabled.

1.5.3 APACS+ versus PCS 7 Controller Algorithm Comparison


The PID controller algorithms used by the APACS+ and the PCS 7 control systems are not
identical. The major differences between the controller algorithms are the following:
● The APACS+ controller is based on the series/interacting transfer function while the PCS
7 controller is based on the parallel/non-interacting transfer function.
● The APACS+ controller implements the integral action using reset feedback whereas the
PCS 7 controller implements the integral action directly to the gain*error.

APACS+ ES Library User's Guide for V7.1


202 Manual, 04/2009, A5E02453738-01
ES Library
1.5 Differences between APACS+ and PCS 7

● Derivative filtering in the APACS+ controller will always vary in direct proportion to the
derivative time whereas the PCS 7 controller contains a separate derivative filter
parameter that must be independently adjusted in relation to the derivative time.
● The time units of the integral and derivative components are in minutes for the APACS+
controller while they are in seconds for the PCS 7 controller.

APACS+ Algorithm
The transfer function used in the APACS+ controller (plus the Model 352 et. al.) is shown
below:

where: PG is proportional gain, TI is integral time, TD is derivative time, and DG is derivative


gain.
In the APACS+ controller, the proportional gain value is always positive with the controller
action determined by the state of the DIR_ACT (Direct Action) softlist parameter. With
DIR_ACT = FALSE (the default), the controller acts as a reverse action controller.
The integral action is implemented using external reset feedback, which provides many
benefits such as:
● the ability to initialize PID for bumpless transfer from Man to Auto without SP tracking
● the capability to implement numerous reset windup prevention strategies in cascade and
override control
● a simple method of implementing deadtime compensation using complementary
feedback
Integral action can be removed by setting TI = 4000.0.
The derivative action is always applied only to the PV, not to the error (PV – SP). Derivative
action can be removed by setting TD = 0.0. Derivative filtering is implemented as a function
of both the derivative time and the derivative gain. The benefit of this is that since derivative
filtering is always directly proportional to the derivative time for a given derivative gain,
satisfactory derivative response is obtained over a wide range of derivative time values
without requiring an adjustment to the derivative gain value. The derivative gain can be
adjusted to provide more or less filtering, if desired, but the default value of 10.0 is usually
sufficient for most applications.

PCS 7 Algorithm
The default transfer function used in the PCS 7 controller is shown below:

where: LMN is the controller output, TN is integral time, TV is derivative time, and TM_LAG
is derivative filter time.
In the PCS 7 controller, the sign of the GAIN parameter determines the controller action.
With a positive GAIN, the controller acts as a reverse action controller. Proportional action

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 203
ES Library
1.6 Customizing the Library

can be removed by setting (Proportional Select) P_SEL = 0. By optionally setting


(Proportional Action in Feedback Path Select) PFDB_SEL = TRUE, the proportional action
can be directly applied to the process variable, PV_IN, instead of the error.
The integral action is always applied to the gain*error and can be removed by setting TN = 0
or can be reversed by setting TN < 0. The controller does have a manipulated variable
feedback signal input, LMNR_IN, however it is used only by the PCS 7 OS, it is not used as
a reset feedback signal for implementing the integral action.
The derivative action can be removed by setting TV =0 or can be reversed by setting TV < 0.
By optionally setting (Derivative Action in Feedback Path Select) DFDB_SEL = TRUE, the
derivative action can be directly applied to the process variable, PV_IN, instead of the error.
In this controller implementation, the derivative filter, TM_LAG, is completely independent of
the derivative time, TV. The significance of this is that the derivative filter component is
essentially a fourth tuning parameter that must be manually set separately and in relation to
the derivative time; otherwise the derivative action will become too aggressive as the
derivative time is increased. Normally, TM_LAG should be set to approximately (TV / 10)
which effectively yields a derivative gain of 10.

Which controller algorithm to use?


The APACS+ controller algorithm is most similar to an analog controller and is reasonably
tuned using the Ziegler-Nichols tuning method. The reset feedback implementation plays a
key role in most of the basic and advanced control strategies. The PCS 7 controller algorithm
is based on the theoretical "ideal" equation and provides many configuration options. This
flexibility, however, requires more effort to set up.
As mentioned above, the implementation of derivative filtering is different. The APACS+
controller essentially makes derivative filtering "transparent" by adjusting the filtering in direct
relation to the derivative time. The PCS 7 controller, however, requires manual intervention
to maintain properly adjusted derivative filtering and someone not familiar with derivative
filtering could become convinced that the PCS 7 derivative action does not work and quickly
abandon its use.
Another distinction between the two algorithms is how the output behaves on changes to
setpoint:
APACS+ has essentially one equation configuration:
● derivative action only on PV, yielding proportional and integral actions on SP changes
However, PCS 7 has a number of ways its equation can be configured, for example:
● derivative action only on PV, yielding proportional and integral actions on SP changes
(same as APACS+)
● proportional action only on PV, yielding integral and derivative actions on SP changes
● proportional and derivative actions on PV, yielding only integral action on SP changes
In summary, there are advantages and disadvantages to both controller algorithm
implementations. The decision of which controller to use is ultimately a matter of familiarity or
personal preference.

1.6 Customizing the Library


These instructions describe customization of the source charts and files, including
compilation to create new block types and modifcation of the graphical elements.

APACS+ ES Library User's Guide for V7.1


204 Manual, 04/2009, A5E02453738-01
ES Library
1.6 Customizing the Library

The following procedures are detailed below:


● Create new block types
● Modify graphical elements
● Test the changes

Create new block types


Procedure Example
1. From SIMATIC Manager, copy the Library. 1. From the SIMATIC Manager main menu, select File > Open. The
Open Project dialog box appears. Click the Libraries tab, and select
APACS Library. From the main menu, select File > Save AsNew
APACS Library.
2. Open the Plant View of the Library. 2. From the main menu, select View > Plant View.
3. Copy the source chart to be modified. 3. In the Source Charts\Control hierarchy folder, copy and paste
SINGLE_LOOP. Rename the copy to NewSINGLE_LOOP.
4. Make the necessary modifications. 4. Add Message Error and Message Status outputs to Type.
a. Double-click NewSINGLE_LOOP to open it.
b. Select the ALARM block on the chart.
c. Right-click to edit the Object Properties.
d. From the Properties dialog box, click the Inputs/Outputs tab.
e. Uncheck the Invisible Check Box for the following Names:
MSG1_ERR
MSG1_STAT
MSG2_ERR
MSG2_STAT
f. Click OK.
g. From the main menu, select View > Chart Inputs/Outputs. The
Chart I/O window for the NewSINGLE_LOOP appears. Click
the OUT folder object. In the right-hand pane, scroll to the
bottom.
h. Click the ALARM block in the chart window. Select each of the
newly visible parameters (MSG1_ERR...), and drag/drop to the
last line of the Chart I/O OUT list window.
i. For each of the newly inserted parameters, right-click the
parameter object in the Chart I/O list. Select Object Properties,
and click the Attributes tab. If not present, add (using the drop-
down box) the attribute S7_m_c. Set the value for S7_m_c to
true. Note that the new attribute will remain red until you select
ok.
j. Click OK.
5. Make the necessary modifications. 5. From the main menu, select Chart > Compile > Chart as block type.
6. Make the necessary modifications. 6. a. On the General tab, change Symbolic Name to NewSLOOP,
change the FB Number to 650.
b. On the Attributes tab, change S7_m_c value to true.
7. Complete the compile. 7. Click OK.
8. Close the window.

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 205
ES Library
1.6 Customizing the Library

Modify Graphical Elements


Note: All changes must be made to files in the siemens\wincc\options\pdl\faceplatedesigner_v6 directory for the changed
files to be automatically copied to subsequent projects. If the changes are made in a project directory, they will only be
effective in that project.
Procedure Example
1. Start Graphics Designer from an existing 1. Double-click on Graphics Designer from PCS 7 OS, WinCC
project in PCS 7 OS. Explorer.
2. Update the block icon for the new type. 2. From Graphics Designer, open
siemens\wincc\options\pdl\faceplatedesigner_v6\@PCS 7
Typicals.pdl
3. Copy desired symbol (block icon). 3. Copy and paste the Single_Loop_AFB symbol to an empty space
on the graphic.
4. Edit properties of the new symbol. a. Right-click to edit properties of the new symbol.
In the Customized Object property, change Object Name to
@NewSloop/1 by double-clicking on Object Name in the
Attribute column.
b. In UserDefined3 property, edit Type to @NewSloop/1, and edit
Servername to @NewSloop/1.
c. Click OK.
d. Close the Object Properties window.
5. Save the file. 5. Save the @PCS 7 Typicals.pdl file.
6. From the 6. From Windows Explorer, change the directory to:
siemens\wincc\options\pdl\faceplatedesigne siemens\wincc\options\pdl\faceplatedesigner_v6
r_v6 directory in Windows Explorer:
a. Copy @PG_originalname.PDL and save a. Copy @PG_Single_Loop_AFB.PDL and save as
as @PG_newname.pdl @PG_NewSloop.pdl
b. Copy @PG_originalname_overview.PDL b. Copy @PG_Single_Loop_AFB_overview.PDL and save as
and save as @PG_NewSloop_overview.pdl
@PG_newname_overview.pdl c. Copy @PG_Single_Loop_AFB_standard.PDL and save as
c. Copy@PG_originalname_standard.PDL @PG_NewSloop_standard.pdl
and save as d. Copy @PG_Single_Loop_AFB_viewlist.PDL and save as
@PG_newname_standard.pdl @PG_NewSloop_viewlist.pdl
d. Copy @PG_originalname_viewlist.PDL e. Copy @PL_Single_Loop_AFB.PDL and save as
and save as @PL_NewSloop.pdl
@PG_newname_viewlist.pdl
e. Copy @PL_originalname_overview.PDL
and save as
@PL_newname_overview.pdl

APACS+ ES Library User's Guide for V7.1


206 Manual, 04/2009, A5E02453738-01
ES Library
1.6 Customizing the Library

Modify Graphical Elements


Note: All changes must be made to files in the siemens\wincc\options\pdl\faceplatedesigner_v6 directory for the changed
files to be automatically copied to subsequent projects. If the changes are made in a project directory, they will only be
effective in that project.
Procedure Example
7. Update Faceplate Overview. 7. a. Double-click @PL_NewSloop.pdl to open it.
b. From the main menu, select View > Properties. The Object
Properties dialog box opens. Use the drop-down menu to
select the Overview Window object. Click the Properties tab, in
Miscellaneous property, change Picture Name to
@PG_NewSloop_Overview.
c. Use the drop-down menu to select the Block Type object. Click
the Properties tab, in Output/Input property, change Output
Value to NewSloop.
d. Use the drop-down menu to select the View1 object.
In Miscellaneous property, change Picture Name to
@PG_NewSloop_Standard.pdl.
e. Save the file.
8. Update Faceplate Header. 8. a. Open @PG_NewSloop.pdl.
b. From the main menu, select View > Properties. The Object
Properties window appears. Use the drop-down menu to
select the @faceplate object, in Texts property, change First
View to @PG_NewSloop_Standard.
c. Save the file.
9. Update the Standard View. 9. a. Open @PG_NewSloop_Standard.pdl.
b. From the Object Palette window, in the Standard Objects
folder, drag a Static Text object to any open space in the
graphic. Draw a text box, and type Error_1 in the new field.
c. From the Object Palette window, in the Smart Objects folder,
drag an I/O Field onto the graphic next to Error1, and draw a
text box. Click OK.
d. Right-click the new I/O Field. The Object Properties dialog
box appears. Choose the Output/Input property, select Output
Value, and change the Dynamic to .MSG_ERR
e. Change Output Format to 99
f. Copy both new fields, and paste them into any open space in
the graphic.
g. Change the text in the copied Static Text object to Status1.
h. Right-click on the new I/O Field. The Object Properties dialog
box appears. Choose the Output/Input property, select Output
Value, and change the Dynamic to .MSG_STAT
Save the file.
i.

Test the changes


Procedure
1. Create a new single project using project wizard. Include a PCS 7 OS. Configure the hardware and SIMATIC PC
station according to your system.
2. From Plant View, open the CFC that was created by default.

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 207
ES Library
1.7 Performance Data

Test the changes


Procedure
3. Drag the new block from the catalog to the CFC editing area.
4. Compile the Chart.
5. Download the program.
6. In Plant View, edit the properties of the picture at the hierarchy level of the chart.
7. On the Block Symbols tab, check the box "Derive the block symbols from the technological hierarchy". Click OK.
8. In SIMATIC Manager, compile the OS. Check the box "Create\update block icons"
9. Open the OS for the project.
10. Start the runtime OS.
11. In the WinCC runtime, navigate to the picture that was updated with the block icons.
12. Verify that your icon appears on the plant picture.
13. Click on the icon to open the faceplate.
14. Verify the new fields are on the faceplate.
15. Open the Loop display.
16. Verify the correct name of the type which appears below the title bar.

1.7 Performance Data


The column headings for the performance data table have the following meanings:

Block (Type Name)


The symbolic identifier in the symbol table of the library for the respective FB or FC.

FB No.
Block number

Typical run time


The time which the CPU needs to process the corresponding block program under normal
circumstances (for example, for a driver this is the execution time in the watchdog interrupt
OB, without message generation in the event of channel errors).
The following table shows the block data for blocks in a CPU S7 416-3 DP 6ES7 416-3XL00-
0AB0. With other CPUs the run time depends on their performance.

Block length
Memory requirements of the program code, once for every block type.

Instance data length


Memory requirement of an instance DB.

APACS+ ES Library User's Guide for V7.1


208 Manual, 04/2009, A5E02453738-01
ES Library
1.7 Performance Data

Temporary memory
The local-data memory required in a priority class when the block is called. This is limited to
the CPU specifically. When it is exceeded, a CPU STOP is caused. You have to check it in
the CPU configuration and, if necessary, distribute it amongst the priority classes (Obs) to
meet the real requirements.

Multiple instance block


The specified blocks are used by the technological block and must exist in the user program.
They can be found in the same library.

Block (Type Name) FB No. Typical run Block Instance data Temporary Multiple Instance block
time (ms)* length length memory
CPU 416-3 (bytes) (bytes) (bytes)

AM_AFB FB 500 0.045 540 90 48


PID_AFB FB 501 0.403 1994 190 94
SETPNT_AFB FB 502 0.075 1854 134 78
AALM_AFB FB 503 0.116 5296 550 146 2xSFB35
DALM_AFB FB 504 0.154 2096 290 26 SFB35
MOTOR_A_AFB FB 505 0.198 1598 746 50 FB504
VALVE_A_AFB FB 506 0.199 1938 712 50 FB504

ANALOG_ALM_AFB FB 600 0.160 1134 758 2 FB503


BLK_VLV_1OUT_AFB FB 601 0.196 856 368 50 2xFB5, FB504
BLK_VLV_2OUT_AFB FB 602 0.197 1104 366 50 2xFB5, FB504
CASCADE_AFB FB 603 1.359 5308 2222 48 FB500, 2xFB501,
2xFB502, 2xFB503
DISCRETE_ALM_AFB FB 604 0.144 526 368 2 FB504
EXT_SET_AFB FB 605 0.732 3116 1180 48 FB500, FB501, FB502,
FB503
MOTOR_1OUT_AFB FB 606 0.199 866 370 54 2xFB5, FB504
MOTOR_2OUT_AFB FB 607 0.199 1068 370 54 2xFB5, FB504
PRIMARY_AFB FB 608 0.755 3208 1166 44 FB500, FB501, FB502,
FB503
RATIO_SET_AFB FB 609 0.843 4268 1360 48 FB500, FB501,
2xFB502, FB503
SECONDARY_AFB FB 610 0.732 3136 1178 48 FB500, FB501, FB502,
FB503
SINGLE_LOOP_AFB FB 611 0.730 3044 1178 48 FB500, FB501, FB502,
FB503
SINGLE_LP_SS_AFB FB 612 0.732 3118 1182 48 FB500, FB501, FB502,
FB503
MOTOR_A_ALM_AFB FB 613 1.067 6442 1530 56 FB504, FB505, FB9

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 209
ES Library
1.8 Hidden Functions

Block (Type Name) FB No. Typical run Block Instance data Temporary Multiple Instance block
time (ms)* length length memory
CPU 416-3 (bytes) (bytes) (bytes)

VALVE_A_ALM_AFB FB 614 1.049 6280 1464 56 FB504, FB506, FB9


*Note: The typical run times shown above were measured when alarms were not occurring. For blocks with alarming
capability, execution time will increase when the block has an unacknowledged alarm. For blocks with analog alarms,
approximately .140 milliseconds will be added to the average time shown in the table for each message containing at least
one unacknowledged alarm. For blocks with discrete alarms, approximately .125 milliseconds will be added to the average
time shown in the table for each message containing at least one unacknowledged alarm.

1.8 Hidden Functions

1.8.1 DINTToInt64

DINTToInt64: Double Integer to 64 Bit Integer

Function Type Name DINTToInt64


Function Type Number FC 501

Function
Routine to convert DINT to Int64 data type.

Note
This is a support function for the APACS+ library. It is not intended for general use.

1.8.2 AddInt64

AddInt64: Add 64 Bit Integer

Function Type Name AddInt64


Function Type Number FC 502

APACS+ ES Library User's Guide for V7.1


210 Manual, 04/2009, A5E02453738-01
ES Library
1.8 Hidden Functions

Function
Routine to add two Int64s and return an Int64 result.

Note
This is a support function for the APACS+ library. It is not intended for general use.

1.8.3 NegateInt64

NegateInt64: Negate 64 Bit integer

Function Type Name NegateInt64


Function Type Number FC 503

Function
Routine to negate an Int64.

Note
This is a support function for the APACS+ library. It is not intended for general use.

1.8.4 SHLInt64

SHLInt64: Shift Left 64 Bit Integer

Function Type Name SHLInt64


Function Type Number FC 504

Function
This is a Routine to shift an Int64 value to the left

Note
This is a support function for the APACS+ library. It is not intended for general use.

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 211
ES Library
1.8 Hidden Functions

1.8.5 SHRInt64

SHRInt64: Shift Right 64 Bit Integer

Function Type Name SHRInt64


Function Type Number FC 505

Function
This is a Routine to shift an Int64 value to the right

Note
This is a support function for the APACS+ library. It is not intended for general use.

1.8.6 REALToDPReal

REALToDPReal: Real to Double Precision Real

Function Type Name REALToDPReal


Function Type Number FC 506

Function
Routine to convert a REAL to a double precision Real

Note
This is a support function for the APACS+ library. It is not intended for general use.

1.8.7 AddDPReal

AddDPReal: Add Double Precision Real

Function Type Name AddDPReal


Function Type Number FC 507

APACS+ ES Library User's Guide for V7.1


212 Manual, 04/2009, A5E02453738-01
ES Library
1.8 Hidden Functions

Function
Routine to add two double precision REAL values.

Note
This is a support function for the APACS+ library. It is not intended for general use.

1.8.8 NegateDPReal

NegateDPReal: Negate Double Precision Real

Function Type Name NegateDPReal


Function Type Number FC 508

Function
Routine to negate a Double Precision Real.

Note
This is a support function for the APACS+ library. It is not intended for general use.

1.8.9 DPRealToReal

DPRealToReal: Double Precision Real to Real

Function Type Name DPREALToReal


Function Type Number FC 509

Function
Routine to convert a Double Precision Real to a REAL.

Note
This is a support function for the APACS+ library. It is not intended for general use.

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 213
ES Library
1.8 Hidden Functions

1.8.10 Int64ToDINT

Int64ToDINT: 64 Bit Integer to Double Integer

Function Type Name Int64ToDINT


Function Type Number FC 510

Function
Routine to convert Int64 data type to DINT.

Note
This is a support function for the APACS+ library. It is not intended for general use.

1.8.11 TIME_DIFF

TIME_DIFF: Time Difference

Function Type Name TIME_DIFF


Function Type Number FC 511

Function
Routine to calculate elapsed time, handling possible internal clock overflow.

Note
This is a support function for the APACS+ library. It is not intended for general use.

1.8.12 ALM_PROC

ALM_PROC: Alarm Processing

Function Type Name ALM_PROC: Alarm Processing


Function Type Number ALM_PROC: Alarm Processing

APACS+ ES Library User's Guide for V7.1


214 Manual, 04/2009, A5E02453738-01
ES Library
1.8 Hidden Functions

Function
Routine to perform generic APACS+ alarm processing functions.

Note
This is a support function for the APACS+ library. It is not intended for general use.

1.8.13 PID_AFB_Calc_Coeff

PID_AFB_Calc_Coeff: Calculate difference equation coefficients for APACS+ PID

Function Type Name PID_AFB_Calc_Coeff


Function Type Number FC 513

Function
Routine to calculate difference equation coefficients for APACS+ PID.

Note
This is a support function for the APACS+ library. It is not intended for general use.

1.8.14 DALM_Test_Alarm

DALM_Test_Alarm

Function Type Name DALM_Test_Alarm


Function Type Number FC 514

Function
Function to support DALM_AFB alarm processing.

Note
This is a support function for the APACS+ library. It is not intended for general use.

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 215
ES Library
1.8 Hidden Functions

1.8.15 MOVE_BOOL

MOVE_BOOL: Move Boolean

Function Type Name MOVE_BOOL


Function Type Number FC 515

Function
Move boolean function.

Note
This is a support function for the APACS+ library. It is not intended for general use.

1.8.16 NON_RETAIN_BOOL

NON_RETAIN_BOOL: Non-retentive Boolean

Function Type Name NON_RETAIN_BOOL


Function Type Number FC 516

Function
Emulate non-retentive Boolean.

Note
This is a support function for the APACS+ library. It is not intended for general use.

APACS+ ES Library User's Guide for V7.1


216 Manual, 04/2009, A5E02453738-01
ES Library
1.8 Hidden Functions

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 217
Symbols and Faceplates 2
2.1 Common HMI Elements

2.1.1 Symbols
Each tag structure and faceplate has an associated symbol. You can place these symbols
on your process graphics to represent a control object. At runtime, when you click on the
symbol, the associated faceplate is displayed and tied to the corresponding instance of the
APACS+ object.
The PCS 7/APACS+ Option symbols are shown in the picture below:

The APACS+ symbols are provided on the picture "@@APACSLibTypicals.pdl".


The SIMATIC Manager compiler uses these symbols as shown to create instances
associated with the type found in the APACS+ controller. The symbols on this picture can be
considered "master" symbols. These symbols use a naming convention of @BlockName/1.
When the SIMATIC Manager compiler creates an instance of this symbol on a picture, the
symbol name is set equal to the tagname of the APACS+ tag. The compiler manages these
symbol names and they should not be edited.

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 219
Symbols and Faceplates
2.1 Common HMI Elements

Most blocks have several symbols, each with differing sizes and amount of information. The
default symbol selected by the SIMATIC Manager compiler is the one named
@BlockName/1. Alternate symbols can be selected by the SIMATIC Manager compiler by
opening the "Object Properties" for the block in the CFC Editor, and entering a value (2, 3,
etc.) in the "Create block icon:" text box for the block. Example: Entering a "2" in the "Create
block icon:" text box will assign the @BlockName/2 symbol to the block during compile.
When a symbol is copied or cut and then pasted onto the same picture or another picture,
the Graphics Designer changes the name of the symbol. For example, @LOOP_A becomes
LOOP_A1; if another instance is pasted, the name becomes LOOP_A2. It is important that
the symbol names of symbol instances created during the compile not be changed. The
compiler manages the creation and deletion of the symbol instances that it creates. If you cut
and paste a symbol instance onto the same picture created by the compiler, the next time
the compiler runs it adds another instance of this symbol to the project. If you need to move
a symbol, drag and drop it to ensure that the name does not change.

2.1.2 Analog Input Dialog Box


This dialog box appears if you click a field that has a floating point value that can be
changed. Clicking the OK button logs the change in the PCS 7 operator's log.

Key Description
① Step controls
② Minimum permissible value
③ Maximum permissible value
④ Analog value
⑤ Slider control of analog value
⑥ Keypad for entering values
⑦ Confirmation button, logs change in operator's log
File: @Common_AnalogInput.PDL

APACS+ ES Library User's Guide for V7.1


220 Manual, 04/2009, A5E02453738-01
Symbols and Faceplates
2.1 Common HMI Elements

2.1.3 Discrete Input Dialog Box


A discrete input dialog box appears if you click a field with a discrete value. The box includes
an OK button for confirmation. Clicking it confirms the selection and records a change in the
PCS 7 operator's Log.
The following discrete input dialog box, used in loop controls, selects Manual or Auto.

File: @Common_DiscreteInput.PDL

2.1.4 Time Input Dialog Box


If you click a field with time values, a time input dialog box appears. Clicking the OK button
records changes in the PCS 7 operator's Log.

File: @Common_TimeInput.PDL

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 221
Symbols and Faceplates
2.1 Common HMI Elements

2.1.5 Confirmation Dialog Box


If you initiate a change that requires confirmation, such as clicking the Open button on a
valve faceplate, a confirmation dialog box appears. Clicking on the OK button records
changes in the PCS 7 operator's Log.

File: @Common_ConfirmationBox.PDL

2.1.6 Operator Change Confirmation


DBA adds a ConfirmChange extended attribute for each APACS+ function block instance
(See the DBA help file for details). This controls whether operator actions require a
confirmation step or not.
If ConfirmChange is FALSE (its default value) then any type of discrete operator change (for
example, Auto/Manual, Start Motor, Open Valve, etc.) is immediately made without further
confirmation requirements.
If ConfirmChange is TRUE, then any type of discrete operator change displays either the
Discrete Input Dialog box or a Confirmation box, and requires the operator to select and/or
confirm the request. Similarly, any floating-point operator change can only be made via the
Analog Input Dialog, and confirmed with its OK button.
In either case, an entry in the operator's log is always made for any operation that involves a
write to the controller.
In addition, if ConfirmChange is FALSE, any faceplate bargraph that is editable by the user
also includes a set of four quick-change buttons to make immediate step changes to the
bargraph value. These make step changes of either -5%, -1%, 1%, or 5% of configured
span. The quick change buttons are not displayed if ConfirmChange is TRUE.

APACS+ ES Library User's Guide for V7.1


222 Manual, 04/2009, A5E02453738-01
Symbols and Faceplates
2.1 Common HMI Elements

2.1.7 Global HMI Elements .PDL Files


The following table lists the PCS 7 OS graphic files (.PDLs) that create the global HMI
elements. These files can be opened and examined with the WinCC Graphics Designer
program: Start > Simatic > WinCC > Windows Control Center 6.0 > (open project) >Graphics
Designer (right click) > Open (select .PDL file) > Open.

View File
Analog Input Dialog Box @Common_AnalogInput.PDL
Discrete Input Dialog Box @Common_DiscreteInput.PDL
Time Input Dialog Box @Common_TimeInput.PDL
Confirmation Dialog Box @Common_ConfirmationBox.PDL

2.1.8 Displayed Decimal Points

The number of decimal points displayed on symbols and faceplates is configurable on a tag
by tag basis in DBA.
The following table shows which decimal point tags affect which HMI tags.

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 223
Symbols and Faceplates
2.1 Common HMI Elements

Block Decimal Places Tag Affected Tags


SINGLE_LOOP .DecimalPlacesPV .PV, .SP, All Alarm Limits, All Alarm
Deadbands, Setpoint Limits, Ramp
Target, Ramp Rate
.DecimalPlacesOUT .OUT, Output Limits
ANALOG_ALARM .DecimalPlacesPV .PV, All Alarm Limits, All Alarm
Deadbands
DISCRETE_ALARM N/A N/A
BLK_VALVE_1OUT N/A N/A
BLK_VALVE_2OUT N/A N/A
VALVE_A N/A N/A
VALVE_A_ALM N/A N/A
MOTOR_1OUT N/A N/A
MOTOR_2OUT N/A N/A
MOTOR_A N/A N/A
MOTOR_A_ALM N/A N/A
SINGLE_LOOP_EM .DecimalPlacesPV .PV, .SP, All Alarm Limits, All Alarm
Deadbands, Setpoint Limits, Ramp
Target, Ramp Rate
.DecimalPlacesOUT .OUT, Output Limits
SINGLE_LOOP_SS .DecimalPlacesPV .PV, .SP, All Alarm Limits, All Alarm
Deadbands, Setpoint Limits, Ramp
Target, Ramp Rate
.DecimalPlacesOUT .OUT, Output Limits
EXT_SET .DecimalPlacesPV .PV, .SP, .ESP, All Alarm Limits, All
Alarm Deadbands, Setpoint Limits,
Ramp Target, Ramp Rate
.DecimalPlacesOUT .OUT, Output Limits
RATIO_SET .DecimalPlacesPV .PV, .SP, .ESP, .RAT_INP, All Alarm
Limits, All Alarm Deadbands, Setpoint
Limits, Ramp Target, Ramp Rate
.DecimalPlacesOUT .OUT, Output Limits
.DecimalPlacesRATIO .RAT_ACT, .RAT_DES
PRIMARY .DecimalPlacesPV .PV, .SP, All Alarm Limits, All Alarm
Deadbands, Setpoint Limits, Ramp
Target, Ramp Rate
.DecimalPlacesOUT .OUT, Output Limits
SECONDARY .DecimalPlacesPV .PV, .SP, .ESP, All Alarm Limits, All
Alarm Deadbands, Setpoint Limits,
Ramp Target, Ramp Rate
.DecimalPlacesOUT .OUT, Output Limits

APACS+ ES Library User's Guide for V7.1


224 Manual, 04/2009, A5E02453738-01
Symbols and Faceplates
2.1 Common HMI Elements

Block Decimal Places Tag Affected Tags


CASCADE .DecimalPlacesP_PV .P_PV, .P_SP, All Primary Alarm
Limits, All Primary Alarm Deadbands,
Primary Setpoint Limits, Primary
Ramp Target, Primary Ramp Rate
.DecimalPlacesS_PV .S_PV, .S_SP, .ESP, All Secondary
Alarm Limits, All Secondary Alarm
Deadbands, Secondary Setpoint
Limits, Secondary Ramp Target,
Secondary Ramp Rate
.DecimalPlacesOUT .OUT, Output Limits

2.1.9 Common Faceplate Elements


The @CommonElements.pdl file contains a generic discrete I/O button and a generic analog
I/O edit field. These objects can be manually copied to any user graphic. If the tag to be
edited is part of a tag structure, then standard PCS 7 user authorization will be enforced. If
the tag to be edited is a single tag (not part of a tag structure), no PCS 7 user authorization
will be enforced since a single tag can not be assigned to a process area for user
authorization enforcement.
At runtime, the discrete I/O button provides the ability to edit any existing BOOL type tag. All
changes to the BOOL tag are recorded in the WinCC operator's log. The tag, along with „On„
and „Off„ messages, and „On„ and „Off„ button text are configured from the object properties
dialog in Graphics Designer.
At runtime, the analog I/O field provides the ability to edit any existing analog tag. All
changes to the analog tag are recorded in the WinCC operator's log. The tag, along with
range limits and display format are configured from the object properties dialog in Graphics
Designer.
The @CommonElements.pdl file also contains an example of a button that allows a trend
group created with the PCS 7 Online Trend Configuration Utility to be opened up directly by
name instead of selecting it from a list.
The trend group name and the monitor to display the trend group on are configurable.
Use the properties dialog box to configure the Mouse Action for the object.

2.1.10 Redundant Server Architecture


In a redundant server architecture, client nodes connect to the appropriate server based on
the health of each server and the health of the network connection between the client and
each server.
The health of any APACS+ controller, and the health of the server's connection to any
APACS+ controller are not factors in determining which server a given client will connect to.
Information about the health of APACS+ controllers is displayed on the Lifebeat monitoring
page.

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 225
Symbols and Faceplates
2.1 Common HMI Elements

2.1.11 Synchronization and Persistence of HMI Tag Values


A feature of the PCS 7 HMI is the ability to synchronize and persist arbitrary internal WinCC
tag values.
The synchronization feature will guarantee that internal tag values remain consistent
between redundant server partners in a redundant OS server architecture.
The persistence feature will preserve tag values through a restart of the WinCC runtime, or a
reboot of the OS server. Without this feature, internal tag values are always initialized to their
configured "start value". This feature can be used on single station nodes, single OS server
nodes, or redundant OS server nodes.
The synchronization and persistence features are not required for external tag values since
those tag values are already persisted in the controller.
The synchronization and persistence configuration is stored in a CSV file
(SyncPersistTags.csv) in the RuntimeFramework directory in the WinCC project directory.

CSV File Format


The CSV file format allows blank lines and comment lines which are designated by a leading
semicolon (;). The CSV file must have a header with a leading ":TAG" (case does not matter)
and at least another column with PERSIST or SYNC (case does not matter). If the option
column is missing, then none of the tags will be processed for that option. For example, if the
PERSIST column exists, but the SYNC column does NOT, then the tags will only be
processed for PERSIST. The TAG column should contain the full WinCC tagname. The
option columns should have the value of "0", "f", or "false" (case does not matter) to NOT
ENABLE this option for that tag. Any other value including a blank will ENABLE the option for
that tag.
Here is an example:

; This is a comment
: Tag , EXTRA, PERSIST, SYNC, EXTRA, EXTRA
Tag1_PS
Tag2_PS , , 1, 10
Tag3_PS , , yes, -1
Tag4_P , , True, 0
Tag5_P,,attr1=55:attr2=100,F
Tag6_P,,t,FALSE,,
Tag7_P , , , False
Tag8_S,,f,,,,
Tag9_S,,f,+
Tag10_S,,f,aaaaa=bbb,,,
Tag11_S , , f
; another comment
; Define columns in different order in same file
: Tag , SYNC, EXTRA, EXTRA
Tag20_S
Tag21_S,+,sss,wwww
Tag22_S , 1

APACS+ ES Library User's Guide for V7.1


226 Manual, 04/2009, A5E02453738-01
Symbols and Faceplates
2.1 Common HMI Elements

In this example, all the tags with a suffix of _P will only be added to the PERSIST list, _S will
only be added to the SYNC list, and _PS will be added to both. This file shows the defaulted
TRUE for blank or missing option columns.
An option column can also contain a name/value series which will be further processed to
add additional attributes to the output XML Node. The format should be as follows:

attrname1=attrvalue1:attrname2=attrvalue2
Notice that an option column value can contain one or more name/value pairs separated by
a colon (:).
The previous example generates the following XML file, assuming the PERSIST and SYNC
configurations were empty to start with:

<AppHost>
<PlugIn Name="CustomSyncPersistInjector" ProgID="CustomSyncPersistPlugIn.PlugIn"
Enabled="-1" File="Test.csv" Status="LOADED"/>
<PlugIn Name="SyncAgent" ProgID="SyncAgent.EventSync" Enabled="0" Status="LOADED">
<Sync Na="DMAdapter.Tag1_PS" ASONa="??"/>
<Sync Na="DMAdapter.Tag2_PS" ASONa="??"/>
<Sync Na="DMAdapter.Tag3_PS" ASONa="??"/>
<Sync Na="DMAdapter.Tag8_S" ASONa="??"/>
<Sync Na="DMAdapter.Tag9_S" ASONa="??"/>
<Sync Na="DMAdapter.Tag10_S" ASONa="??" aaaaa="bbb"/>
<Sync Na="DMAdapter.Tag11_S" ASONa="??"/>
<Sync Na="DMAdapter.Tag20_S" ASONa="??"/>
<Sync Na="DMAdapter.Tag21_S" ASONa="??"/>
<Sync Na="DMAdapter.Tag22_S" ASONa="??"/>
</PlugIn>
<PlugIn Name="PersistAgent" ProgID="PersistAgent.EventPersist" Enabled="0"
Status="LOADED">
<Persist Na="DMAdapter.Tag1_PS" ASONa="??"/>
<Persist Na="DMAdapter.Tag2_PS" ASONa="??"/>
<Persist Na="DMAdapter.Tag3_PS" ASONa="??"/>
<Persist Na="DMAdapter.Tag4_P" ASONa="??"/>
<Persist Na="DMAdapter.Tag5_P" ASONa="??" attr1="55" attr2="100"/>
<Persist Na="DMAdapter.Tag6_P" ASONa="??"/>
<Persist Na="DMAdapter.Tag7_P" ASONa="??"/>
</PlugIn>
</AppHost>
The "ASONa" attribute is "??", which allows for later enhancements that may need to track
which object created the item. It is not currently used.

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 227
Symbols and Faceplates
2.2 SINGLE_LOOP_BLK

2.2 SINGLE_LOOP_BLK

2.2.1 SINGLE_LOOP_BLK Standard View

Key Name Type Description Tag


① IOFieldPV Customized Process Variable PV; PV_EUMAX; PV_EUMIN
Object
② IOFieldSP Customized Obj Setpoint SP;SPH; SPL;
③ IOFieldOUT Customized Obj Output VL;VLH; VLL
④ PVUnits I/O Field PV units PV#unit
⑤ SPUnits I/O Field SP units PV#unit
⑥ OUTUnits I/O Field Output units VL#unit
⑦ ModeControl Customized Obj Mode AUTO
⑧ Description StaticText FB Comment #comment
⑨ BarLimits Customized Alarm limits display PV_EUMAX; PV_EUMIN;
Object HH_LIM; H_LIM; L_LIM; LL_LIM
⑩ PVSPBargraph Customized PV and SP PV; PV_EUMAX; PV_EUMIN;
Object SP;
⑪ OutputBargraph Customized Obj Output display VL; VL_EUMAX; VL_EUMIN;
⑫ Quality Icon Customized Obj Quality Code state QC_PV

APACS+ ES Library User's Guide for V7.1


228 Manual, 04/2009, A5E02453738-01
Symbols and Faceplates
2.2 SINGLE_LOOP_BLK

The mode control Auto selects process automation, while Manual permits operator control of
the output. In Auto mode, clicking the SP (set point) box displays an analog input edit box.
Clicking is not allowed when the mode is set to Manual and PVTracking is enabled. Range
limits are enforced by the SPH and SPL tags.

Note
Added Icons
The Quality Icons shown in the graphic above, appear in a number of other displays
although not all of them were updated in this document.

File: @PG_SINGLE_LOOP_BLK_STANDARD.PDL

2.2.2 SINGLE_LOOP_BLK Tuning View

Key Name Type Description Tag


① CheckBoxPVTrack Customized Object PV Tracking Enabled PV_TRACK
② IOFieldSPH I/O Field SP High Limit SPH
③ IOFieldSPL I/O Field SP Low Limit SPL
④ ActionDirect Static Text Direct Acting DIR
④ ActionReverse Static Text Reverse Acting
⑤ SPHUnits1 Static Text SP Units PV#unit
⑤ SPHUnits2 Static Text SP Units PV#unit
⑥ IOFieldVLH I/O Field VL High Limit VLH
⑦ IOFieldVLL I/O Field VL Low Limit VLL
⑧ IOFieldPG I/O Field Proportional Gain PG, DIR
⑨ IOFieldTI I/O Field Integral Time TI
⑩ IOFieldTD I/O Field Derivative Time TD
⑪ IOFieldDG I/O Field Derivative Gain DG

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 229
Symbols and Faceplates
2.2 SINGLE_LOOP_BLK

● Clicking the PVTrack check box produces a discrete input confirmation box.
● Clicking any of the eight edit boxes produces an analog input edit box. Range limits (if
configured) are enforced by the WinCC Data Manager.
● The controller action (Direct/Reverse) is a read-only field.
File: @PCS7_APACS_TUNING.PDL

2.2.3 SINGLE_LOOP_BLK Alarm View


The alarm view uses a standard WinCC Active X control. No modifications were made to it
for the PCS 7 OS option.

File: @PCS7_ALARM.PDL

APACS+ ES Library User's Guide for V7.1


230 Manual, 04/2009, A5E02453738-01
Symbols and Faceplates
2.2 SINGLE_LOOP_BLK

2.2.4 SINGLE_LOOP_BLK Ramp View

Key Name Type Description Tag


① CheckBoxUseRR Customized Object Use Ramp Rate USE_RR
② RampControl Customized Object Ramp Control RAMP
③ IOFieldTarget I/O Field Target SP TSP
④ TargetUnits Static Text Target SP Units PV#unit
⑤ IOFieldRate I/O Field SP Ramp Rate R_RATE
⑥ RateUnits Static Text SP Ramp Rate Units PV#unit
⑦ IOFieldTime I/O Field SP Ramp Time R_TIME
● Clicking the Use Ramp Rate check box will cause the "Rate" value below to be used to
specify the ramping, and the "Time" value will be ignored. Otherwise, Time is used and
Rate is ignored. A discrete input confirmation dialog will appear if ConfirmChange is
TRUE.
● Clicking the Ramp Status edit box produces a discrete input confirmation box, if
ConfirmChange is TRUE.
● Clicking any of the three edit boxes produces an analog input edit box. Range limits (if
configured) are enforced by the WinCC Data Manager.
File: @PCS7_APACS_RAMP.PDL

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 231
Symbols and Faceplates
2.2 SINGLE_LOOP_BLK

2.2.5 SINGLE_LOOP_BLK Limits View

Key Description
① Alarm Type
② Alarm Enabled or Not
③ Alarm Limits Value
④ Alarm Deadband Value
⑤ Alarm Units

● Clicking any check box produces a discrete input confirmation box, if the ConfirmChange
attribute for this block is TRUE.
● Clicking any of the edit boxes produces an analog input edit box. Range limits (if
configured) are enforced by the WinCC Data Manager.
File: @PCS7_APACS_ALARM_CONFIG.PDL

2.2.6 SINGLE_LOOP_BLK Trend View


The trend view is the standard view for displaying trends for the function block. For the
SINGLE_LOOP_AFB function block the trend view displays the process value (PV), setpoint
(SP), and output value (VL). Only one trend window is needed for each function block type.
A script assigns proper tags to the trend control at runtime.
The standard PCS 7 OS trend view is available for use with APACS+ function blocks through
normal PCS 7 OS procedures and configuration.
The illustration below shows the trend view with rulers enabled.

APACS+ ES Library User's Guide for V7.1


232 Manual, 04/2009, A5E02453738-01
Symbols and Faceplates
2.2 SINGLE_LOOP_BLK

Key Description
① Ruler (see key 12)
② Zoom
③ Original view (return from zoom)
④ Select time range
⑤ Previous trend
⑥ Next trend
⑦ Stop (freeze)/start (continue)
⑧ Moveable cursor, shown when ruler, key 1, is enabled
⑨ SP (blue)
⑩ PV (green)
⑪ VL (orange)
⑫ Detachable window displayed when ruler (see key 1) is enabled. Shows process
values at cursor position, which can be dragged. Color coded with trend curves.
File: @PCS7_APACS_TREND3.PDL

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 233
Symbols and Faceplates
2.2 SINGLE_LOOP_BLK

2.2.7 SINGLE_LOOP_BLK Faceplate Overview Window


The following graphic shows the updated button bar, other pictures in this document still
show previous button bars.

Key Description
① Alarm Group Display
② Lock/unlock messages button
③ Alarm ACK button
④ Go to primary graphic button (display function block's primary graphic)
File: @PG_SINGLE_LOOP_AFB_OVERVIEW.PDL

2.2.8 SINGLE_LOOP_BLK Faceplate Frame


Shown in group display mode:

Key Description
① Current tagname
② Pulldown view-selector list
③ Go to loop display mode (all faceplate views, with the option of selecting a large trend
display)
File: @PG_SINGLE_LOOP_AFB.PDL

APACS+ ES Library User's Guide for V7.1


234 Manual, 04/2009, A5E02453738-01
Symbols and Faceplates
2.2 SINGLE_LOOP_BLK

2.2.9 SINGLE_LOOP_BLK Faceplate View List


The drop-down faceplate view list provides the names of the available faceplate views.
Clicking a name selects a view.

File: @PG_SINGLE_LOOP_AFB_VIEWLIST.PDL

2.2.10 SINGLE_LOOP_BLK Loop Display Mode


The loop display mode provides all six of the available single loop faceplates. It is not the
default mode, and must be invoked from the initial (standard) view faceplate by the loop
display mode button:

From the loop display mode, you can expand the trend display to cover four views by clicking
Display Large Trend. With the loop display expanded, you can shrink it to cover a single view
by clicking Display Small Trend.

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 235
Symbols and Faceplates
2.2 SINGLE_LOOP_BLK

2.2.11 SINGLE_LOOP_BLK View .PDL Files


The following table lists the PCS 7 OS graphic files (.PDLs) that create the OS HMI for the
SINGLE_LOOP_BLK views. These files can be opened and examined with the WinCC
Graphics Designer program: Start > Simatic > WinCC > WinCC> (open project) >Graphics
Designer (right click) > Open (select .PDL file) > Open.

APACS+ ES Library User's Guide for V7.1


236 Manual, 04/2009, A5E02453738-01
Symbols and Faceplates
2.2 SINGLE_LOOP_BLK

View File
Standard @PG_SINGLE_LOOP_BLK_STANDARD.PDL
Tuning @PCS7_APACS_TUNING.PDL
Alarm @PCS7_ALARM.PDL
Ramp @PCS7_APACS_RAMP.PDL
Limits @PCS7_APACS_ALARM_CONFIG.PDL
Trend @PCS7_APACS_TREND3.PDL
Faceplate Overview Window @PG_SINGLE_LOOP_BLK_OVERVIEW.PDL
Faceplace Frame @PG_SINGLE_LOOP_BLK.PDL
Faceplate View List @PG_SINGLE_LOOP_BLK_VIEWLIST.PDL
Faceplate Loop @PL_SINGLE_LOOP_BLK.PDL

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 237
Symbols and Faceplates
2.3 Other Faceplates

2.3 Other Faceplates

2.3.1 ANALOG_ALM_BLK

Standard View
The Standard view is the default view when the faceplate is first displayed in Group Display
mode. It displays the function block description, process variable, and some alarm limits.

The standard view contains a subset of the elements in the


PG_SINGLE_LOOP_BLK_STANDARD.PDL file.
See the SINGLE_LOOP_BLK section for details on the remaining elements.

APACS+ ES Library User's Guide for V7.1


238 Manual, 04/2009, A5E02453738-01
Symbols and Faceplates
2.3 Other Faceplates

Faceplate View List


The drop-down faceplate view list provides the names of the available faceplate views.
Clicking a name selects a view.

Faceplate Loop View


The loop view of the faceplate, displayed by clicking the loop display mode button on the
group faceplate, displays all four faceplate views in one window.

Clicking the Display Large Trend button increases the size of the trend view by four times
and places it on top of two of four smaller views. Clicking the Display Small Trend button
restores the trend view to the original size.

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 239
Symbols and Faceplates
2.3 Other Faceplates

View .PDL Files

View File
Standard @PG_ANALOG_ALM_BLK_STANDARD.PDL
Alarm @PCS7_ALARM.PDL (see the SINGLE_LOOP_BLK)
Limits @PCS7_APACS_ALARM_CONFIG.PDL (see the SINGLE_LOOP_BLK)
Trend View (one pen) @PCS7_APACS_TREND1.PDL (see the SINGLE_LOOP_BLK)
Faceplace Frame @PG_ANALOG_ALM_BLK.PDL (see the SINGLE_LOOP_BLK)
Faceplate Overview Window @PG_ANALOG_ALM_BLK_OVERVIEW.PDL (see the SINGLE_LOOP_BLK)
Faceplate View List @PG_ANALOG_ALM_BLK_VIEWLIST.PDL
Faceplate Loop @PL_ANALOG_ALM_BLK.PDL

APACS+ ES Library User's Guide for V7.1


240 Manual, 04/2009, A5E02453738-01
Symbols and Faceplates
2.3 Other Faceplates

2.3.2 DISCRETE_ALM_BLK

Standard View
The Standard view is the default view when the faceplate is first displayed in Group Display
mode. It displays the function block description, alarm status, and certain alarm configuration
values.

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 241
Symbols and Faceplates
2.3 Other Faceplates

The following table lists all of the significant objects on the view:

Key Name Type Description Tag


① StaticTextOn Static Text On Indicator DIN, DIN#string_1
StaticTextOff Static Text Off Indicator DIN#string_0
② Description Static Text FB comment #comment

APACS+ ES Library User's Guide for V7.1


242 Manual, 04/2009, A5E02453738-01
Symbols and Faceplates
2.3 Other Faceplates

③ CheckBoxEN Customized object Enabled EN


④ AlarmHighText Static Text Alarm Type High LIM
AlarmLowText Static Text Alarm Type Low
Clicking the Enabled check box displays a discrete input confirmation box and asks for
confirmation of changes, if the ConfirmChange attribute of the block is TRUE.

Faceplate View List


The drop-down faceplate view list provides the names of the available faceplate views.
Clicking a name selects a view.

Faceplate Loop View


Clicking the loop display mode button on the group faceplate displays both faceplate views in
one window.

View .PDL Files


Unless otherwise indicated, faceplate views listed in the table below are identical or similar to
corresponding views for the SINGLE_LOOP_BLK. See the SINGLE_LOOP_BLK sections for
more information.

View File
Standard @PG_DISCRETE_ALM_BLK_STANDARD.PDL
Alarm @PCS7_ALARM.PDL (see the SINGLE_LOOP_BLK)
Faceplate Frame @PG_DISCRETE_ALM_BLK.PDL (see the SINGLE_LOOP_BLK)
Faceplate Overview Window @PG_DISCRETE_ALM_BLK_OVERVIEW.PDL (see the SINGLE_LOOP_BLK)

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 243
Symbols and Faceplates
2.3 Other Faceplates

View File
Faceplate View List @PG_DISCRETE_ALM_BLK_VIEWLIST.PDL
Faceplate Loop @PL_DISCRETE_ALM_BLK.PDL

2.3.3 MOTOR_1OUT_BLK

Standard View
The Standard view is the default view when the faceplate is first displayed in Group Display
mode. It displays the function block description, alarm status, and various motor status
values and motor configuration values.

Operation and Controls


● The On/Off indicator displays the current state of the MOTOR.
● The Out indicator displays the output of the function block.
● The Interlock indicator displays the current interlock status of the function block.
● The Start and Stop buttons allow operator control of the MOTOR. These buttons are only
enabled when the function block is in Manual mode. Clicking the Start or Stop buttons
brings up a confirmation box, if the ConfirmChange attribute of the block is TRUE.
● The Mode indicator displays the current mode of the function block (Auto/Manual).
● The Start Time indicator displays the maximum allowable time between the OUT signal
going TRUE and PROOF feedback going TRUE before the FAIL output goes TRUE. A

APACS+ ES Library User's Guide for V7.1


244 Manual, 04/2009, A5E02453738-01
Symbols and Faceplates
2.3 Other Faceplates

time to start MOTOR in excess of this value fires an alarm. Clicking the Start Time or
Stop Time I/O field brings up a time input edit box.
● The Stop Time indicator displays the maximum allowable time between the OUT signal
going FALSE and PROOF feedback going FALSE before the FAIL output goes TRUE. A
time to stop MOTOR in excess of this value fires an alarm. Clicking the Start Time or
Stop Time I/O field brings up a time input edit box.
● The Enabled check box controls the discrete alarm of the function block.

Objects
The following table lists all of the significant objects on the standard view:
Key Name Type Description Tag
① StaticTextOn Static Text Motor on Indicator PROOF
② StaticTextOff Static Text Motor off Indicator PROOF
StaticTextOff1 Static Text Motor off Indicator
③ StaticTextOutStart Static Text Output Start Indicator OUT
StaticTextOutStop Static Text Output Stop Indicator
④ StaticTextInterlockOK Static Text Intorlock OK Indicator INTRLK
StaticTextInterlocked Static Text Intorlocked Indicator
⑤ Description Static Text FB comment #comment
⑥ ButtonStart Customized object Start MOTOR Control START, AUTO
⑦ ButtonStop Customized object Stop MOTOR Control STOP, AUTO
⑧ ModeControl Customized object Mode AUTO
⑨ IOFieldStartTime Customized object Start time limit START_T
⑩ IOFieldStopTime Customized object Stop time limit STOP_T
⑪ CheckBoxEN Customized object Enabled A1EN

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 245
Symbols and Faceplates
2.3 Other Faceplates

Faceplate View List


The drop-down faceplate view list provides the names of the available faceplate views.
Clicking a name selects a view.

Faceplate Loop View


Clicking the loop display mode button on the group faceplate displays both faceplate views in
one window.

View .PDL Files

View File
Standard @PG_MOTOR_1OUT_AFB_STANDARD.PDL
Alarm View @PCS7_ALARM.PDL (see the SINGLE_LOOP_AFB)
Faceplate Frame @PG_MOTOR_1OUT_AFB.PDL (see the SINGLE_LOOP_AFB)
Faceplate Overview Window @PG_MOTOR_1OUT_AFB_OVERVIEW.PDL (see the SINGLE_LOOP_AFB)
Faceplate View List @PG_MOTOR_1OUT_AFB_VIEWLIST.PDL
Faceplate Loop View @PL_MOTOR_1OUT_AFB.PDL

2.3.4 MOTOR_2OUT_BLK
See MOTOR_1OUT_BLK for information about operation and controls.

APACS+ ES Library User's Guide for V7.1


246 Manual, 04/2009, A5E02453738-01
Symbols and Faceplates
2.3 Other Faceplates

View .PDL Files

View File
Standard @PG_MOTOR_2OUT_BLK_STANDARD.PDL
Alarm View @PCS7_ALARM.PDL (see the SINGLE_LOOP_BLK)
Faceplate Frame @PG_MOTOR_2OUT_BLK.PDL (see the SINGLE_LOOP_BLK)
Faceplate Overview Window @PG_MOTOR_2OUT_BLK_OVERVIEW.PDL (see the SINGLE_LOOP_BLK)
Faceplate View List @PG_MOTOR_2OUT_BLK_VIEWLIST.PDL
Faceplate Loop View @PL_MOTOR_2OUT_BLK.PDL

2.3.5 MOTOR_A_BLK

Standard View
The standard view is the default view when the faceplate is first displayed in Group Display
mode. It displays the function block description, alarm status, and various motor status
values and motor configuration values.

Operation and Controls


● The On/Off indicators display the current state of the MOTOR. Only one is visible at a
time. They are controlled by one tag, PROOF.
● The Out indicator displays the output of the function block.
● The Override indicator displays the current override status of the function block.
● The Permit indicator displays the current permit status of the function block.

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 247
Symbols and Faceplates
2.3 Other Faceplates

● The Interlock indicator displays the current interlock status of the function block.
● The Start and Stop buttons allow operator control of the MOTOR. These buttons are only
enabled when the function block is in Manual mode.
● The Mode indicator displays the current mode of the function block (Auto/Manual).
● The FailureReset button lets operator clear the failure output.
● The Start Time indicator displays the maximum allowable time between the OUT signal
going TRUE and PROOF feedback going TRUE before the FAIL output goes TRUE. A
time to start MOTOR in excess of this value fires an alarm.
● The Stop Time indicator displays the maximum allowable time between the OUT signal
going FALSE and PROOF feedback going FALSE before the FAIL output goes TRUE. A
time to stop MOTOR in excess of this value fires an alarm.
● Clicking the Start, Stop or Reset buttons brings up a confirmation box and asks the user
to confirm the change, if the ConfirmChange attribute is TRUE. Start and Stop buttons
are only enabled when the function block is in Manual mode. The FailureReset button is
enabled when the tag FAIL is true.

Objects
The following table lists all of the significant objects on the standard view:

Key Name Type Description Tag


① StaticTextOn Static Text Motor on Indicator PROOF
② StaticTextOff Static Text Motor off Indicator PROOF
③ StaticTextOutStart Static Text Output Start Indicator OUT
StaticTextOutStop Static Text Output Stop Indicator
④ StaticTextOverride Static Text Override Indicator OVERRD
StaticTextPermitOverride Static Text Permit Indicator OVERRD
⑤ StaticTextPermitOK Static Text Permit Indicator PERMIT
StaticTextNotPermitted Static Text Permit Indicator
⑥ StaticTextInterlockOK Static Text Intorlock OK Indicator INTRLK
StaticTextInterlocked Static Text Intorlocked Indicator
⑦ Description Static Text FB comment #comment
⑧ ButtonStart Customized object Start MOTOR Control START, AUTO
⑨ ButtonStop Customized object Stop MOTOR Control STOP, AUTO
⑩ ModeControl Customized object Mode AUTO
⑪ ButtonReset Customized object Reset Failure Output Control FAIL
⑫ IOFieldStartTime Customized object Start time limit STRT_T
⑬ IOFieldStopTime Customized object Stop time limit STOP_T

APACS+ ES Library User's Guide for V7.1


248 Manual, 04/2009, A5E02453738-01
Symbols and Faceplates
2.3 Other Faceplates

Faceplate View List


The drop-down faceplate view list provides the names of the available faceplate views.
Clicking a name selects a view.

Interlocks View
The interlocks view is the same view used by the VALVE_A_BLK faceplate. See the
VALVE_A_BLK section for details.

Faceplate Loop View


Clicking the loop display mode button on the group faceplate displays three faceplate views
in one window.

View .PDL Files

View File
Standard @PG_MOTOR_A_BLK_STANDARD.PDL
Alarm @PCS7_ALARM.PDL (see the SINGLE_LOOP_BLK)
Faceplate Frame @PG_MOTOR_A_BLK.PDL (see the SINGLE_LOOP_BLK)
Interlocks @PCS7_APACS_INTERLOCKS.PDL (see VALVE_A_BLK)
Faceplate Overview Window @PG_MOTOR_A_BLK_OVERVIEW.PDL (see the SINGLE_LOOP_BLK)
Faceplate View List @PG_MOTOR_A_BLK_VIEWLIST.PDL
Faceplate Loop @PL_MOTOR_A_BLK.PDL

2.3.6 MOTOR_A_ALM_BLK
See the MOTOR_A_BLK section.

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 249
Symbols and Faceplates
2.3 Other Faceplates

Operation and Controls


Clicking the Enabled check box invokes a discrete input confirmation box, if the
ConfirmChange attribute is TRUE.

Limits View
The Limits view shows the alarm configuration of the function block. Note that this faceplate
view is not specific to the MOTOR_A_ALM function block. Every function block that
implements discrete alarms references this .PDL file.
The Type indicators display the alarm type. These types are hard coded. For
MOTOR_A_ALM, they are displayed in the illustration that follows.

APACS+ ES Library User's Guide for V7.1


250 Manual, 04/2009, A5E02453738-01
Symbols and Faceplates
2.3 Other Faceplates

Objects
The following table lists all of the significant objects on the view:

Key Name Type Description Tag


① CheckBoxA1EN Customized object A1 Alarm Enabled A1EN
② CheckBoxA2EN Customized object A2 Alarm Enabled A2EN
③ CheckBoxA3EN Customized object A3 Alarm Enabled A3EN
④ CheckBoxA4EN Customized object A4 Alarm Enabled A4EN

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 251
Symbols and Faceplates
2.3 Other Faceplates

Faceplate View List


The drop-down faceplate view list provides the names of the available faceplate views.
Clicking a name selects a view.

Interlocks View
The interlocks view is the same view used by the VALVE_A_BLK faceplate. See the
VALVE_A_BLK section for details.

APACS+ ES Library User's Guide for V7.1


252 Manual, 04/2009, A5E02453738-01
Symbols and Faceplates
2.3 Other Faceplates

Faceplate Loop View


The loop view of the faceplate, displayed by clicking the loop display mode button on the
group faceplate, displays all four faceplate views in one window.

View .PDL Files

View File
Standard @PG_MOTOR_A_ALM_BLK_STANDARD.PDL (see the SINGLE_LOOP_BLK)
Alarm @PCS7_ALARM.PDL (see the SINGLE_LOOP_BLK)
Faceplate Frame @PG_MOTOR_A_ALM_BLK.PDL (see the SINGLE_LOOP_BLK)
Interlocks @PCS7_APACS_INTERLOCKS.PDL (see the VALVE_A_BLK section)
Limits @PCS7_APACS_DISCRETE_ALARM_CONFIG.PDL
Faceplate View List @PG_MOTOR_A_ALM_BLK_VIEWLIST.PDL
Faceplate Overview Window @PG_MOTOR_A_ALM_BLK_OVERVIEW.PDL (see the SINGLE_LOOP_BLK)
Faceplate Loop View @PL_MOTOR_A_ALM_BLK.PDL

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 253
Symbols and Faceplates
2.3 Other Faceplates

2.3.7 BLK_VLV_1OUT_BLK

Standard View
The Standard view is the default view when the faceplate is first displayed in Group Display
mode. It displays the function block description, alarm status, and various valve status
values and valve configuration values.

Operation and Controls


● The Open/Travel/Close indicator displays the current state of the valve.
● The Out indicator displays the output of the function block.
● The Interlock indicator displays the current interlock status of the function block.
● The Open and Close buttons allow operator control of the valve. These buttons are only
enabled when the function block is in Manual mode.
● The Mode indicator displays the current mode of the function block (Auto/Manual), and
allows the user to change the mode.
● The Travel Time indicator displays the configured travel time of the function block. A
valve travel time in excess of this value fires an alarm.
● The Enabled check box controls the 1 discrete alarm of the function block.
● The Alarm Type indicator displays the alarm type. In the case of the
BLK_VLV_1OUT_BLK function block, this is always HIGH.

APACS+ ES Library User's Guide for V7.1


254 Manual, 04/2009, A5E02453738-01
Symbols and Faceplates
2.3 Other Faceplates

● Clicking the Open or Close buttons brings up a confirmation box, if the ConfirmChange
attribute is TRUE. These buttons are only enabled when the function block is in Manual
mode.
● Clicking the ModeControl box displays a discrete input confirmation box, if the
ConfirmChange attribute is TRUE and asks the user to select a choice from the radio
buttons displayed.
● Clicking the Enabled check box brings up a discrete input confirmation box, if the
ConfirmChange attribute is TRUE.
● Clicking the Travel Time I/O field brings up a time input edit box.

Objects
The following table lists all of the significant objects on the view:

Key Name Type Description Tag


① StaticTextOpen Static Text Open Indicator OP_VER
② StaticTextClose Static Text Travel Indicator TRANS
③ StaticTextTravel Static Text Close Indicator CL_VER
④ StaticTextOutOpen Static Text Output Open Indicator OUT
StaticTextOutClose Static Text Output Close Indicator
⑤ StaticTextInterlockOK Static Text Intorlock OK Indicator INTRLK
StaticTextInterlocked Static Text Intorlocked Indicator
⑥ Description Static Text FB comment #comment
⑦ ButtonOpen Customized object Open Valve Control OPEN, AUTO
⑧ ButtonClose Customized object Close Valve Control CLOSE, AUTO
⑨ ModeControl Customized object Mode AUTO
⑩ IOFieldTravelTime Customized object Travel Time Limit TRAV_T
⑪ CheckBoxEN Customized object Enabed A1EN
⑫ AlarmTypeLabel Static Text Alarm Type Label

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 255
Symbols and Faceplates
2.3 Other Faceplates

Faceplate View List


The drop-down faceplate view list provides the names of the available faceplate views.
Clicking a name selects a view.

Faceplate Loop View


The loop view of the faceplate, displayed by clicking the loop display mode button on the
group faceplate, displays all four faceplate views in one window.

View .PDL Files

View File
Standard @PG_BLK_VLV_1OUT_BLK_STANDARD.PDL
Alarm @PCS7_ALARM.PDL (see the SINGLE_LOOP_BLK)
Faceplate Frame @PG_BLK_VLV_1OUT_BLK.PDL (see the SINGLE_LOOP_BLK)
Interlocks @PCS7_APACS_INTERLOCKS.PDL (see the VALVE_A_BLK section)
Faceplate View List @PG_BLK_VLV_1OUT_BLK_VIEWLIST.PDL
Faceplate Overview Window @PG_BLK_VLV_1OUT_BLK_OVERVIEW.PDL (see the SINGLE_LOOP_BLK)
Faceplate Loop View @PL_BLK_VLV_1OUT_BLK.PDL

2.3.8 BLK_VLV_2OUT_BLK
The BLK_VLV_2OUT_BLK faceplate is identical in every respect to the
BLK_VLV_1OUT_BLK except in the names of the PDL files and any associated attribute
values.

APACS+ ES Library User's Guide for V7.1


256 Manual, 04/2009, A5E02453738-01
Symbols and Faceplates
2.3 Other Faceplates

In addition, the .OPEN_LATCH parameter is exposed as the OUT tag in the mapper
template file instead of the .[OUT] for BLK_VLV_1OUT_BLK
See the BLK_VLV_1OUT_BLK section for details.

2.3.9 VALVE_A_BLK

Standard View
The Standard view is the default view when the faceplate is first displayed in Group Display
mode. It displays the function block description, alarm status, and various valve status
values and valve configuration values.

Operation and Controls


● The Open/Travel/Close indicator displays the current state of the valve.
● The Out indicator displays the output of the function block.
● The Override indicator displays the current override status of the function block.
● The Permit indicator displays the current permit status of the function block.
● The Interlock indicator displays the current interlock status of the function block.
● The Open and Close buttons allow operator control of the valve. These buttons are only
enabled when the function block is in Manual mode.
● The Mode indicator displays the current mode of the function block (Auto/Manual), and
allows the user to change the mode.

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 257
Symbols and Faceplates
2.3 Other Faceplates

● The FailureReset button allows the operator to clear the valve's FAIL status. This button
is only enabled when the function block is in a failed state.
● The Open Time indicator displays the configured travel time of the function block. A valve
open time in excess of this value fires an alarm.
● The Close Time indicator displays the configured travel time of the function block. A valve
close time in excess of this value fires an alarm.
● Clicking the Permit or Interlock indicators switches to the Interlock view. If the faceplate is
in loop display mode, this action is ignored since the interlocks view is already being
displayed.
● Clicking the Open or Close buttons brings up a confirmation box, if ConfirmChange is
TRUE. These buttons are only enabled when the function block is in Manual mode.
● Clicking the Reset button brings up a confirmation box, if ConfirmChange is TRUE. This
button is only enabled when the function block is in FAIL mode.
● Clicking the ModeControl box displays a discrete input confirmation box, if
ConfirmChange is TRUE and asks the user to select a choice from the radio buttons
displayed.
● Clicking the Open Time or Close Time I/O fields displays a time input edit box.

Standard View Objects


The following table lists all of the significant objects on the view:

Key Name Type Description Tag


① QC_OP_VER, QC_CL_VER Customized object Quality Code Icons QC_OP_VER , QC_CL_VER
② StaticTextOpen Static Text Open Indicator OP_VER
③ StaticTextClose Static Text Travel Indicator OP_VER,CL_VER
④ StaticTextTravel Static Text Close Indicator CL_VER
⑤ QC_OUT Customized object Quality Code Icon QC_OUT
QC_OUT_IN Customized object Quality Code Icon QC_OUT_IN
⑥ StaticTextOutOpen Static Text Output Open Indicator OUT
StaticTextOutClose Static Text Output Close Indicator
⑦ StaticTextOverride Static Text Override Indicator OVERRD
⑧ StaticTextPermitOK Static Text Permit OK Indicator PERMIT
StaticTextPermitOverrideOK Static Text Permit OK Indicator OVERRD
StaticTextNotPermitted Static Text Not Permitted Indicator
⑨ StaticTextInterlockOK Static Text Intorlock OK Indicator INTRLK
StaticTextInterlocked Static Text Intorlocked Indicator
⑩ Description Static Text FB comment #comment
⑪ ButtonOpen Customized object Open Valve Control OPEN, AUTO
⑫ ButtonClose Customized object Close Valve Control CLOSE, AUTO
⑬ ModeControl Customized object Mode AUTO
⑭ ButtonReset Customized object Valve Reset control FAIL
⑮ IOFieldOpenTime Customized object Open Time Limit OPEN_T
⑯ IOFieldCloseTime Customized object Close Time Limit CLOSE_T

APACS+ ES Library User's Guide for V7.1


258 Manual, 04/2009, A5E02453738-01
Symbols and Faceplates
2.3 Other Faceplates

Interlocks View
The Interlocks view displays permit status and description, and interlock status and
descriptions. It also allows the user to place the block into and out of override mode. Note
that this faceplate view is not specific to the VALVE_A_BLK function block. Every function
block that implements multiple interlock inputs references this .PDL file.
The Interlocks view actually has 11 interlock status indicators. The VALVE_A and
VALVE_A_ALM blocks only have 10 interlock inputs, so the 11th indicator is hidden in these
cases. The MOTOR_A and MOTOR_A_ALM blocks, which have 11 interlock inputs, will
display all 11 indicators.
Interlock indicators are displayed for all interlock inputs that have a non-blank interlock
description. Unused or unconfigured interlocks should be configured with a blank interlock
description in 4-mation. The faceplate will not display indicators for these unused interlocks.

Interlocks Operation and Controls


● The Override button allows the operator to put the block into override. This button is only
enabled when the function block is not in override.
● The ClearOverride button allows the operator to take the block out of override. This
button is only enabled when the function block is in override.
● Status Indicators (12): In each case, the description is displayed for the appropriate input.
If the input is TRUE (1) the text is black on a green background. If the input is FALSE (0)
the text is white on a red background. If the description for an interlock is NULL, its Status
indicator will be blank (same as gray background) regardless of TRUE or FALSE value.
This generally means that this interlock is not in use and has a default value of TRUE.
However, there is the possibility that an interlock is in use but has no description

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 259
Symbols and Faceplates
2.3 Other Faceplates

configured in the block (by oversight) and in the case, the operator will not be able to see
the Status indicator of the interlock that may be preventing valve operation.
● Clicking the Override button brings up a confirmation box, if ConfirmChange is TRUE.
This button is only enabled when the function block is not in override mode.
● Clicking the Clear Override button brings up a confirmation box, if ConfirmChange is
TRUE. This button is only enabled when the function block is in override mode.

Interlock Objects
The following table lists all of the significant objects on the view:

Key Name Type Description Tag


① StaticTextPermit Static Text Permit Indicator PERMIT,
PERMIT_DESC
② StaticTextInterlock1 Static Text Interlock 1 Indicator INT01, INT01_DESC
② StaticTextInterlock2 Static Text Interlock 2 Indicator INT02, INT02_DESC
② StaticTextInterlock3 Static Text Interlock 3 Indicator INT03, INT03_DESC
② StaticTextInterlock4 Static Text Interlock 4 Indicator INT04, INT04_DESC
② StaticTextInterlock5 Static Text Interlock 5 Indicator INT05, INT05_DESC
② StaticTextInterlock6 Static Text Interlock 6 Indicator INT06, INT06_DESC
② StaticTextInterlock7 Static Text Interlock 7 Indicator INT07, INT07_DESC
② StaticTextInterlock8 Static Text Interlock 8 Indicator INT08, INT08_DESC
② StaticTextInterlock9 Static Text Interlock 9 Indicator INT09, INT09_DESC
② StaticTextInterlock10 Static Text Interlock 10 Indicator INT10, INT10_DESC
② StaticTextInterlock11 Static Text Interlock 11 Indicator INT11, INT11_DESC
③ ButtonOverride Customized object Open Valve Control OPEN, AUTO
④ ButtonClearOverride Customized object Close Valve Control CLOSE, AUTO

Faceplate View List


The drop-down faceplate view list provides the names of the available faceplate views.
Clicking a name selects a view.

Faceplate Overview Window


The faceplate frame is the same view used by the SINGLE_LOOP_BLK faceplate, but
renamed. See the SINGLE_LOOP_BLK section for details.

APACS+ ES Library User's Guide for V7.1


260 Manual, 04/2009, A5E02453738-01
Symbols and Faceplates
2.3 Other Faceplates

Faceplate Loop View


The loop display mode displays all three faceplates. It is not the default mode, and must be
invoked from the initial (standard) view faceplate by the loop display mode button:

View .PDL Files

View File
Standard @PG_VALVE_A_BLK_STANDARD.PDL
Interlocks @PCS7_APACS_INTERLOCKS.PDL
Alarm @PCS7_ALARM.PDL (see the SINGLE_LOOP_BLK)
Faceplate Frame @PG_VALVE_A_BLK.PDL (see the SINGLE_LOOP_BLK)
Interlocks @PCS7_APACS_INTERLOCKS.PDL
Faceplate View List @PG_VALVE_A_BLK_VIEWLIST.PDL
Faceplate Overview @PG_VALVE_A_BLK_OVERVIEW.PDL (see the SINGLE_LOOP_BLK)
Window
Faceplate Loop View @PL_VALVE_A_BLK.PDL

2.3.10 VALVE_A_ALM_BLK

Standard View
The standard view is the same view used by the VALVE_A_BLK faceplate, but renamed.
See the VALVE_A_BLK section for details.

Interlocks View
The interlocks view is the same view used by the VALVE_A_BLK faceplate. See the
VALVE_A_BLK section for details.

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 261
Symbols and Faceplates
2.3 Other Faceplates

Limits View
The Limits view is the same view used by the MOTOR_A_ALM_BLK faceplate, but renamed
AS follows For VALVE_A_ALM:
● Failure to close
● Failure to open
● Uncommanded close/open or rejected command (due to interlock)
● Failed limit switch (open and close verify inputs are set)
The Enabled check boxes control the enabled status of the alarms.
See the MOTOR_A_ALM_BLK section for details.

Alarm View
The Alarm view is the same view used by the SINGLE_LOOP_BLK faceplate. See the
SINGLE_LOOP_BLK section for details.

Faceplate Frame
The faceplate frame is the same view used by the SINGLE_LOOP_BLK faceplate, but
renamed. See the SINGLE_LOOP_BLK section for details.

Faceplate View List


The drop-down faceplate view list provides the names of the available faceplate views.
Clicking a name selects a view.

Faceplate Overview Window


The faceplate frame is the same view used by the SINGLE_LOOP_BLK faceplate, but
renamed. See the SINGLE_LOOP_BLK section for detail

APACS+ ES Library User's Guide for V7.1


262 Manual, 04/2009, A5E02453738-01
Symbols and Faceplates
2.3 Other Faceplates

Faceplate Loop View


The loop display mode displays all four faceplates. It is not the default mode, and must be
invoked from the initial (standard) view faceplate by the loop display mode button:

View .PDL Files

View File
Standard @PG_VALVE_A_ALM_BLK_STANDARD.PDL (See the VALVE_A_BLK)
Interlocks @PCS7_APACS_INTERLOCKS.PDL (See the VALVE_A_BLK)
Limits @PCS7_APACS_DISCRETE_ALARM_CONFIG.PDL (See the MOTOR_A_ALM_BLK)
Alarm @PCS7_ALARM.PDL (see the SINGLE_LOOP_BLK)
Faceplate Frame @PG_VALVE_A_ALM_BLK.PDL (see the SINGLE_LOOP_BLK)
Faceplate View List @PG_VALVE_A_ALM_BLK_VIEWLIST.PDL

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 263
Symbols and Faceplates
2.3 Other Faceplates

View File
Faceplate Overview Window @PG_VALVE_A_ALM_BLK_OVERVIEW.PDL (see the SINGLE_LOOP_BLK)
Faceplate Loop View @PL_VALVE_A_ALM_BLK.PDL

2.3.11 EXT_SET_BLK
The EXT_SET_BLK faceplate is identical to the SINGLE_LOOP_BLK faceplate except for
the addition of four tags as follows:

Tag Type Description ACM Source


ESP FLOAT External Setpoint .SETPOINT.[ESP]
EXTRNL BIT External/Internal .SETPOINT.[EXTRNL]
EXT#string_0 TEXTREF Internal string Hardcoded in HMI file
EXT#string_1 TEXTREF External string Hardcoded in HMI file
The Standard view of the faceplate has one additional "ESP" read-only field (1), and one
"E/I" field (2) as shown below:

All other views are identical to the SINGLE_LOOP_BLK faceplate.


See the SINGLE_LOOP_BLK documentation for details on all other features.

APACS+ ES Library User's Guide for V7.1


264 Manual, 04/2009, A5E02453738-01
Symbols and Faceplates
2.3 Other Faceplates

2.3.12 RATIO_SET_BLK
The RATIO_SET_BLK faceplate is identical to the EXT_SET_BLK faceplate except for the
addition of five tags as follows:

Key Tag Type Description ACM Source


① RAT_INP FLOAT External Input .[EXTINP]
② RAT_ACT FLOAT Actual Ratio .[ACTRAT]
③ RAT_DES FLOAT Desired Ratio .RATIO.[CSP]
④ RATIO_MAX FLOAT Ratio Max .RATIO.HILIM
⑤ RATIO_MIN FLOAT Ratio Min .RATIO.LOLIM
The Standard view of the faceplate has two additional bargraphs and three additional I/O
fields for the ratio settings, as shown below:

All other views are identical to the EXT_SET_BLK faceplate.


See the EXT_SET_BLK documentation for details on all other features.

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 265
Symbols and Faceplates
2.3 Other Faceplates

2.3.13 PRIMARY_BLK
The PRIMARY_BLK faceplate is identical to the SINGLE_LP_SS_BLK faceplate in all
respects except filenames.
See the SINGLE_LP_SS_BLK documentation for details on all other features.

2.3.14 SECONDARY_BLK
The SECONDARY_BLK faceplate is identical to the EXT_SET_BLK faceplate in all respects
except filenames.
See the EXT_SET_BLK documentation for details on all other features.

2.3.15 CASCADE_BLK
The CASCADE_BLK faceplate is essentially the PRIMARY_BLK and SECONDARY_BLK
faceplates combined into one faceplate.
The Standard view of the faceplate is shown below:

All other group views are identical to the PRIMARY_BLK and SECONDARY_BLK faceplate
views.
The loop view is different in that there is a button on the title bar to switch between
PRIMARY and SECONDARY loop views:

APACS+ ES Library User's Guide for V7.1


266 Manual, 04/2009, A5E02453738-01
Symbols and Faceplates
2.3 Other Faceplates

See the PRIMARY_BLK and SECONDARY_BLK documentation for details on all other
features.

2.3.16 SINGLE_LP_EM_BLK
The SINGLE_LP_EM_BLK faceplate is identical to the SINGLE_LOOP_BLK faceplate except
for the addition of one binary input (EM).
The tag structure (and HMI file) has one additional tag:

Tag Type Description ACM Source


EM BIT Emergency Manual .[EM]
The standard view of the faceplate has an additional EM annunciator, which is tied to the EM
tag. It is not editable.

2.3.17 SINGLE_LP_SS_BLK
The SINGLE_LP_SS_BLK faceplate is identical to the SINGLE_LOOP_BLK faceplate except
for the addition of one binary input (SS).
The tag structure (and HMI file) has one additional tag:

Tag Type Description ACM Source


SS BIT Standby Sync .[SS]
The standard view of the faceplate has an additional SS annunciator, which is tied to the SS
tag. It is not editable.

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 267
Symbols and Faceplates
2.3 Other Faceplates

APACS+ ES Library User's Guide for V7.1


268 Manual, 04/2009, A5E02453738-01
Glossary

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 269
Glossary

APACS+ ES Library User's Guide for V7.1


270 Manual, 04/2009, A5E02453738-01
Index

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 271
EXT_SET_BLK MERGEFORMAT, 262

A
F
AALM_AFB, 12
AALM_AFB Input Output, 14 Faceplate Frame MERGEFORMAT, 232
Alarming, 202
AM_AFB, 22
AM_AFB_Input_Output, 23 G
Analog Input Dialog Box MERGEFORMAT, 218
general differences, 198
ANALOG_ALM_AFB, 25
Global HMI Elements .PDL Files
ANALOG_ALM_AT, 181
MERGEFORMAT, 221
ANALOG_ALM_BLK Input Output, 27
ANALOG_ALM_BLK MERGEFORMAT, 236
APACS+ versus PCS 7 Controller Algorithm
I
Comparison, 202
Introduction, 9

B
L
BLK_VLV_1OUT_AFB, 32
BLK_VLV_1OUT_AT, 182 Library Blocks, 10
BLK_VLV_1OUT_BLK Input Output, 34 Library Description, 9
BLK_VLV_1OUT_BLK MERGEFORMAT, 252 Library Function Blocks, 10
BLK_VLV_2OUT_AT, 183
BLK_VLV_2OUT_BLK, 36
BLK_VLV_2OUT_BLK MERGEFORMAT, 254 M
Message class, 198
MOTOR_1OUT_AFB, 92
C
MOTOR_1OUT_AFB MERGEFORMAT, 242
CASCADE_AT, 183 MOTOR_1OUT_AT, 188
CASCADE_BLK, 41 MOTOR_1OUT_BLK Input Output, 94
CASCADE_BLK Input Output, 45 MOTOR_2OUT_AT, 189
CASCADE_BLK MERGEFORMAT, 264 MOTOR_2OUT_BLK, 97
Confirmation Dialog Box MERGEFORMAT, 220 MOTOR_2OUT_BLK Input Output, 99
Customizing the Library, 204 MOTOR_2OUT_BLK MERGEFORMAT, 245
MOTOR_A_AFB, 78
MOTOR_A_AFB Input Output, 81
D MOTOR_A_ALM_AT, 187
MOTOR_A_ALM_BLK, 86
DALM_AFB, 58
MOTOR_A_ALM_BLK Input Output, 89
DALM_AFB Input Output, 60
MOTOR_A_ALM_BLK MERGEFORMAT, 248
Discrete Input Dialog Box MERGEFORMAT, 219
MOTOR_A_BLK MERGEFORMAT, 245
DISCRETE_ALM_AT, 185
DISCRETE_ALM_BLK, 64
DISCRETE_ALM_BLK Input Output, 65
P
DISCRETE_ALM_BLK MERGEFORMAT, 239
Performance Data, 208
PID_AFB, 102
E PID_AFB Input Output, 102
PRIMARY_AT, 190
EXT_SET_AT, 185
PRIMARY_BLK, 104
EXT_SET_BLK, 66
PRIMARY_BLK Input Output, 107
EXT_SET_BLK Input Output, 69
PRIMARY_BLK MERGEFORMAT, 264
Index

R
RATIO_SET_AT, 191
RATIO_SET_BLK, 113
RATIO_SET_BLK Input Output, 117
RATIO_SET_BLK MERGEFORMAT, 263

S
SECONDARY_BLK, 124
SECONDARY_BLK Input Output, 127
SECONDARY_BLK MERGEFORMAT, 264
SETPNT_AFB, 134
SETPNT_AFB Input Output, 136
SETPOINT, 134
SINGLE_LOOP_AFB Faceplate View List
MERGEFORMAT, 233
SINGLE_LOOP_AFB MERGEFORMAT, 227
SINGLE_LOOP_AFB Trend View
MERGEFORMAT, 230
SINGLE_LOOP_AFB_ Tuning View
MERGEFORMAT, 228
SINGLE_LOOP_AT, 193
SINGLE_LOOP_BLK, 138
Single_Loop_BLK Loop View MERGEFORMAT, 233
SINGLE_LOOP_BLK View .PDL Files
MERGEFORMAT, 234
SINGLE_LP_BLK Input Output, 141
SINGLE_LP_SS_AT, 194, 195
SINGLE_LP_SS_BLK Input Output, 149, 159
SINGLE_LP_SS_BLK MERGEFORMAT, 265

T
Template Charts, 180
Time Input Dialog Box MERGEFORMAT, 219

V
VALVE_A_AFB, 172
VALVE_A_AFB Input Output, 175
VALVE_A_ALM_AT, 196
VALVE_A_ALM_BLK, 166
VALVE_A_ALM_BLK Input Output, 168
VALVE_A_ALM_BLK MERGEFORMAT, 259
VALVE_A_BLK MERGEFORMAT, 255

APACS+ ES Library User's Guide for V7.1


Manual, 04/2009, A5E02453738-01 273

You might also like