s

Preface, Contents

Introduction 1

SIMATIC Library Function Blocks 2

Template Charts 3
PCS 7/APACS+ ES
Message Class 4
Library User’s Guide
for V6.1 Differences between 5
APACS+ and PCS 7
Manual
Customizing the Library 6

Peformance Data
7

Edition 04/2006
A5E00595270-01
Safety Guidelines
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 to property damage only have no safety alert symbol. The
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 notice 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 notices 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.

Prescribed Usage
Note the following:

Warning
! This device and its components may only be used for the applications described in the catalog or the
technical description, and only in connection with devices or components from other manufacturers
which have been approved or recommended by Siemens.
Correct, reliable operation of the product requires proper transport, storage, positioning and assembly
as well as careful operation and maintenance.

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 Copyright © Siemens AG 2005

Automation and Drives A5E00595270-01
Postfach 4848
90437 NÜRNBERG Siemens AG 2006
GERMANY Technical data subject to change.
Preface

Purpose of the Manual

This manual provides information necessary to set up PCS 7/APACS+™ ES
Library for V6.1.

Required Basic Knowledge

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

Where is this Manual valid?

This manual is valid for the software package PCS 7/APACS+ OS for V6.1.

Training Centers
Siemens Technical Training Center 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.sea.siemens.com/sitrain
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.
Internet: http://www.sitrain.com

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

AE00595270-01 iii
Preface

A&D Technical Support

Worldwide, available 24 hours a day:

Nürnberg

Johnson City Beijing

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) E-Mail: [email protected] Fax:+86 10 64 74 74 74
Fax:+1 (423) 262 2289 GMT:+1:00 Mail to:[email protected]
Mail to: [email protected] Authorization GMT:+8:00
GMT: -5:00 Local time: Monday to Friday
8:00 AM to 5:00 PM
Phone: +49 (180) 5050-222
Fax: +49 (180) 5050-223
Mail to: [email protected]
GMT: +1:00
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.

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

iv AE00595270-01
1 PCS 7 ES Option for APACS+ 1-1
1.1 Introduction - The PCS 7 ES Option for APACS+™ ....................................... 1-1
1.2 Library Description.......................................................................................... 1-2
2 Library Function Blocks 2-1
2.1 Introduction..................................................................................................... 2-1
2.2 AALM_AFB..................................................................................................... 2-3
2.3 AM_AFB ....................................................................................................... 2-14
2.4 ANALOG_ALM_AFB .................................................................................... 2-17
2.5 BLK_VLV_1OUT_AFB.................................................................................. 2-24
2.5.1 BLK_VLV_1OUT: Block Valve with One ....................................................... 2-24
2.6 BLK_VLV_2OUT_AFB.................................................................................. 2-29
2.7 CASCADE_AFB ........................................................................................... 2-34
2.8 DALM_AFB .................................................................................................. 2-55
2.9 DISCRETE_ALM_AFB ................................................................................. 2-61
2.10 EXT_SET_AFB............................................................................................. 2-64
2.11 MOTOR_A_AFB........................................................................................... 2-76
2.12 MOTOR_A_ALM_AFB.................................................................................. 2-85
2.13 MOTOR_1OUT_AFB.................................................................................... 2-92
2.14 MOTOR_2OUT_AFB.................................................................................... 2-97
2.15 PID_AFB .................................................................................................... 2-102
2.16 PRIMARY_AFB .......................................................................................... 2-105
2.17 RATIO_SET_AFB....................................................................................... 2-117
2.18 SECONDARY_AFB.................................................................................... 2-130
2.19 SETPNT_AFB ............................................................................................ 2-143
2.20 SINGLE_LOOP_AFB ................................................................................. 2-148
2.21 SINGLE_LP_SS_AFB ................................................................................ 2-158
2.22 VALVE_A_ALM_AFB ................................................................................. 2-171
2.23 VALVE_A_AFB........................................................................................... 2-178
3 Template Charts 3-1
3.1 ANALOG_ALM_AT......................................................................................... 3-2
3.2 BLK_VLV_1OUT_AT ...................................................................................... 3-3
3.3 BLK_VLV_2OUT_AT ...................................................................................... 3-4
3.4 CASCADE_AT................................................................................................ 3-5
3.5 DISCRETE_ALM_AT...................................................................................... 3-7
3.6 EXT_SET_AT ................................................................................................. 3-8
3.7 MOTOR_A_ALM_AT .................................................................................... 3-10
3.8 MOTOR_1OUT_AT ...................................................................................... 3-11
3.9 MOTOR_2OUT_AT ...................................................................................... 3-12
3.10 PRIMARY_SECONDARY_AT ...................................................................... 3-13
3.11 RATIO_SET_AT ........................................................................................... 3-15
3.12 SINGLE_LOOP_AT...................................................................................... 3-17
3.13 SINGLE_LP_SS_AT..................................................................................... 3-19
3.14 VALVE_A_ALM_AT...................................................................................... 3-21
4 Message class 4-1

5 Differences between APACS+ and PCS 7 5-1

5.1 General Differences........................................................................................ 5-1
5.2 Alarm Differences ........................................................................................... 5-5
5.3 APACS+ versus PCS 7 Controller Algorithm Comparison .............................. 5-6
6 Customizing the Library 6-1

7 Performance Data 7-1

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

A5E00595270-01 v
 PCS 7/APACS+ ES Library User's Guide for V6.1

vi A5E00595270-01
1 PCS 7 ES Option for APACS+

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).

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

A5E00595270-01 1-1
PCS 7 ES Option for APACS+

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 These charts and files provide the functionality of
Source (SCL) Files APACS+ derived function blocks and give users the
ability to customize the types and create new types.
APACS+ Function Block These function blocks provide the functionality of
Types 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 These pre-configured Human-Machine Interface (HMI)
Symbols 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.

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

1-2 A5E00595270-01
2 Library Function Blocks

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)

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

A5E00595270-01 2-1
Library Function Blocks

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_AFB FB 600 ANALOG_ALARM (Analog Alarm)
* BLK_VLV_1OUT_AFB FB 601 BLK_VLV_1OUT (Block Valve with One
Output)
* BLK_VLV_2OUT_AFB FB 602 BLK_VLV_2OUT (Block Valve with Two
Outputs)
CASCADE_AFB FB 603 CASCADE (Cascade Controller)
DISCRETE_ALM_AFB FB 604 DISCRETE_ALARM (Discrete Alarm)
EXT_SET_AFB FB 605 EXT_SET (External Setpoint
Controller)
* MOTOR_1OUT_AFB FB 606 MOTOR_1OUT (Motor with One
Output)
* MOTOR_2OUT_AFB FB 607 MOTOR_2OUT (Motor with Two
Outputs)
PRIMARY_AFB FB 608 PRIMARY (Primary Controller)
RATIO_SET_AFB FB 609 RATIO_SET (Ratio Setpoint Controller)
SECONDARY_AFB FB 610 SECONDARY (Secondary Controller)
SINGLE_LOOP_AFB FB 611 SINGLE_LOOP (Single Loop
Controller)
SINGLE_LP_SS_AFB FB 612 SINGLE_LOOP_SS (Single Loop
Controller w/ Standby Sync)
MOTOR_A_ALM_AFB FB 613 MOTOR_A_ALM (Motor with Alarm)
VALVE_A_ALM_AFB FB 614 VALVE_A_ALM (Valve with Alarm)

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

2-2 A5E00595270-01
 Library Function Blocks

2.2 AALM_AFB

2.2.1 AALM_AFB: Analog Alarm

Function Block Name AALM_AFB
Function Block Number FB503

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:

x High x Out Of Range

x Low x Quality Not Good
x Absolute Deviation x Absolute Rate Of Change
x High Deviation x Increasing Rate Of Change
x Low Deviation x Decreasing Rate Of Change
x High High
x 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.

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

A5E00595270-01 2-3
Library Function Blocks

ALARM_8P ID Message # 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@
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

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

2-4 A5E00595270-01
 Library Function Blocks

2.2.1.1 AALM_AFB Input Output

Input

Name Data Type Explanation Initial OC&M Valid

Values
PV REAL Process Value – This input is the 0 True
value to be monitored for alarms.
DEV REAL Deviation – The difference 0 False
between this input and the (PV)
input is monitored when a
deviation alarm is selected.
EN_HIGH BOOL When TRUE, the High alarm is False True
enabled.
EN_LOW BOOL When TRUE, the Low alarm is False True
enabled.
EN_H_DEV BOOL When TRUE, the High Deviation False True
alarm is enabled.
EN_L_DEV BOOL When TRUE, the Low Deviation False True
alarm is enabled.
EN_A_DEV BOOL When TRUE, the Absolute False True
Deviation alarm is enabled.
EN_OORANGE BOOL When TRUE, the Out of Range False True
alarm is enabled
EN_QUALITY BOOL When TRUE, the Quality Not False True
Good alarm is enabled.
EN_HH BOOL When TRUE, the High High alarm False True
is enabled.
EN_LL BOOL When TRUE, the Low Low alarm False True
is enabled.
EN_I_ROC BOOL When TRUE, the Increasing Rate False True
of Change alarm is enabled.
EN_D_ROC BOOL When TRUE, the Decreasing False True
Rate of Change alarm is enabled.
EN_A_ROC BOOL When TRUE, the Absolute Rate False True
of Change alarm is enabled.
OOS BOOL Out of Service indicator. False True
QBAD BOOL Bad quality indicator – This value False False
is a 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.

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

A5E00595270-01 2-5
Library Function Blocks

Name Data Type Explanation Initial OC&M Valid

Values
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
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:
x In APACS+, there are only four enables. There is now an enable for every
alarm type.
x The parameter QBAD was added to get quality information from the control
system.
x The parameters EV_ID and EV_ID2 were added to support the message
system.
x 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

Type Values
ALM_HIGH BOOL When TRUE, the High alarm is False False
detected and enabled.
NAK_HIGH BOOL When TRUE, the High alarm is False False
tripped but not acknowledged.
ALM_LOW BOOL When TRUE, the Low alarm is False False
detected and enabled.
NAK_LOW BOOL When TRUE, the Low alarm is False False
tripped but not acknowledged.
ALM_H_DEV BOOL When TRUE, the High Deviation False False
alarm is detected and enabled.
NAK_H_DEV BOOL When TRUE, the High Deviation False False
alarm is tripped but not
acknowledged.
ALM_L_DEV BOOL When TRUE, the Low Deviation False False
alarm is detected and enabled.

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

2-6 A5E00595270-01
 Library Function Blocks

Name Data Explanation Initial OC&M Valid

Type Values
NAK_L_DEV BOOL When TRUE, the Low Deviation False False
alarm is tripped but not
acknowledged.
ALM_A_DEV BOOL When TRUE, the Absolute Deviation False False
alarm is detected and enabled.
NAK_A_DEV BOOL When TRUE, the Absolute Deviation False False
alarm is tripped but not
acknowledged.
ALM_OORANGE BOOL When TRUE, the Out of Range False False
alarm is detected and enabled.
NAK_OORANGE BOOL When TRUE, the Out of Range False False
alarm is tripped but not
acknowledged.
ALM_QUALITY BOOL When TRUE, Quality Not Good False False
alarm is detected and enabled.
NAK_QUALITY BOOL When TRUE, the Quality Not Good False False
alarm is tripped but not
acknowledged.
ALM_HH BOOL When TRUE, High High alarm is False False
detected and enabled.
NAK_HH BOOL When TRUE, the High High alarm is False False
tripped but not acknowledged.
ALM_LL BOOL When TRUE, the Low Low alarm is False False
detected and enabled.
NAK_LL BOOL When TRUE, the Low Low alarm is False False
tripped but not acknowledged.
ALM_I_ROC BOOL When TRUE, the Increasing Rate of False False
Change alarm is detected and
enabled.
NAK_I_ROC BOOL When TRUE, Increasing Rate of False False
Change alarm is tripped but not
acknowledged.
ALM_D_ROC BOOL When TRUE, the Decreasing Rate False False
of change alarm is detected and
enabled.
NAK_D_ROC BOOL When TRUE, the Decreasing Rate False False
of change alarm is tripped but not
acknowledged.
ALM_A_ROC BOOL When TRUE, the Absolute Rate of False False
Change alarm is detected and
enabled.
NAK_A_ROC BOOL When TRUE, Absolute Rate of False False
Change 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

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

A5E00595270-01 2-7
Library Function Blocks

Note

This list differs from the outputs of the AALM_AFB block in APACS+ as follows:
x In APACS+, there are only four alarms and four NAKs. There is now one of
each for every alarm type.
x The STATUS and CMD outputs have been removed.
x 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.

Input/output

Name Data Explanation Initial OC&M Valid

Type Values
HIGH_LIMIT REAL The value (in 0 True
engineering 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 T#0d0h0m0s0ms False
the input must reach
or exceed the High
limit to trip an alarm.
HIGH_DELAYOUT TIME The amount of time T#0d0h0m0s0ms False
the input must be
within the High limit
and deadband to
cause the alarm to
clear.
LOW_LIMIT REAL The value (in 0 True
engineering 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 T#0d0h0m0s0ms False
the input must reach
or exceed the Low
limit to trip an alarm.

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

2-8 A5E00595270-01
 Library Function Blocks

Name Data Explanation Initial OC&M Valid

Type Values
LOW_DELAYOUT TIME The amount of time T#0d0h0m0s0ms False
the input must be
within the Low limit
and deadband to
cause the alarm to
clear.
H_DEV_LIMIT REAL The value (in 0 True
engineering 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.
H_DEV _DELAYIN TIME The amount of time T#0d0h0m0s0ms False
the input must reach
or exceed the High
Deviation limit to trip
an alarm.
H_DEV_DELAYOUT TIME High Deviation T#0d0h0m0s0ms False
Alarm Delay Out
input. It is the
amount of time the
input must be within
the H_DEV_LIMIT
value and
H_DEV_DEADBAN
D value to cause the
alarm to clear.
L_DEV_LIMIT REAL The value (in 0 True
engineering 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 T#0d0h0m0s0ms False
the input must reach
or exceed the Low
Deviation limit to trip
an alarm.

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

A5E00595270-01 2-9
Library Function Blocks

Name Data Explanation Initial OC&M Valid

Type Values
L_DEV_DELAYOUT TIME The amount of time T#0d0h0m0s0ms False
the input must be
within the Low
Deviation limit and
deadband to cause
the alarm to clear.
A_DEV_LIMIT REAL The value (in 0 True
engineering 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 T#0d0h0m0s0ms True
the input must reach
or exceed the
Absolute Deviation
limit to trip an alarm.
A_DEV_DELAYOUT TIME The amount of time T#0d0h0m0s0ms False
the input must be
within the Absolute
Deviation limit and
deadband to cause
the alarm to clear.
OORANGE_DELAYIN TIME The amount of time T#0d0h0m0s0ms False
the input must be
outside the limits
EINH, EINL, to trip
the Out of Range
alarm.
OORANGE_DELAYOUT TIME The amount of time T#0d0h0m0s0ms False
the input must be
within the limits
EINH, EINL to cause
the Out of Range
alarm to clear.
QUALITY_DELAYIN TIME The amount of time T#0d0h0m0s0ms False
the input quality
must be bad to trip
the Quality Not
Good alarm.

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

2-10 A5E00595270-01
 Library Function Blocks

Name Data Explanation Initial OC&M Valid

Type Values
QUALITY_DELAYOUT TIME The amount of time T#0d0h0m0s0ms False
the input quality
must be good to
cause the Quality
Not Good alarm to
clear.
HH_LIMIT REAL The value (in 0 True
engineering 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 T#0d0h0m0s0ms False
the input must reach
or exceed the High
High limit to trip an
alarm.
HH_DELAYOUT TIME The amount of time T#0d0h0m0s0ms False
the input must be
within the High High
limit and deadband
to cause the alarm
to clear.
LL_LIMIT REAL The value (in 0 True
engineering 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.
LL_DELAYIN TIME The amount of time T#0d0h0m0s0ms False
the input must reach
or exceed the Low
Low limit to trip an
alarm.
LL_DELAYOUT TIME The amount of time T#0d0h0m0s0ms False
the input must be
within the Low Low
limit and deadband
to cause the alarm
to clear.

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

A5E00595270-01 2-11
Library Function Blocks

Name Data Explanation Initial OC&M Valid

Type Values
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 T#0d0h0m0s0ms False
the input must reach
or exceed the
Increasing Rate of
Change limit to trip
an alarm.
I_ROC_DELAYOUT TIME The amount of time T#0d0h0m0s0ms False
the 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 0 True
engineering 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 T#0d0h0m0s0ms False
the input must reach
or exceed the
Decreasing Rate of
Change limit to trip
an alarm.
D_ROC_DELAYOUT TIME The amount of time T#0d0h0m0s0ms False
the input must be
within the
Decreasing Rate of
Change limit and
deadband to cause
the alarm to clear.

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

2-12 A5E00595270-01
 Library Function Blocks

Name Data Explanation Initial OC&M Valid

Type Values
A_ROC_LIMIT REAL The value (in 0 True
engineering 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 T#0d0h0m0s0ms False
the input must reach
or exceed the
Absolute Rate of
change limit to trip
an alarm.
A_ROC_DELAYOUT TIME The amount of time T#0d0h0m0s0ms False
the input must be
within the Absolute
Rate of Change limit
and deadband to
cause the alarm to
clear.
EINL REAL The PV low value 0 True
used for the Out of
Range alarm.
EINH REAL The PV high value 100.0 True
used for the Out of
Range alarm.
DISABLE_ON_OOS BOOL When set to TRUE, False False
the 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:
x 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.
x There is now a LIMIT, DEADBAND, DELAYIN, and DELAYOUT parameter for
each alarm type that requires it.
x The PCS 7 OS provides a ringback mechanism. The RINGBACK parameters
have been removed.

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

A5E00595270-01 2-13
Library Function Blocks

2.3 AM_AFB

2.3.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.

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.

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

2-14 A5E00595270-01
 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)

There is no associated faceplate for this block.

2.3.1.1 AM_AFB Input Output

Input

Name Data Explanation Initial OC&M Valid

Type Values
IN REAL Input variable. Generally, this 0 False
input 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 True False
val on 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 0 False
limited
IOUT REAL Internal Output 0 False
LL BOOL True when the algorithm is imposing a low False False
limit on (OUT)
HL BOOL True when the algorithm is imposing a high False False
limit on (OUT)

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

A5E00595270-01 2-15
Library Function Blocks

Note

The list differs from the outputs of the AM block in APACS+ as follows:

x COUT has been moved from Output to Input/Output.

Input/output

Name Data Explanation Initial OC&M Valid Values

Type
COUT REAL Computer Output, typically written to 0 True
by an operator 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 True False
Internal Output to track the (IN)
when EXTTRK=FALSE or when
(STNDBY)=FALSE and
(AUTO)=TRUE.
EXTTRK BOOL Setting EXTTRK=TRUE causes the True False
Internal Output to track the External
Variable when (STNDBY)=TRUE.

Note

This list differs from the softlist parameters of the AM block in APACS+ as follows:

x COUT has been moved from Output to Input/Output.

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

2-16 A5E00595270-01
 Library Function Blocks

2.4 ANALOG_ALM_AFB

2.4.1 ANALOG_ALM_AFB: Analog Alarm

Function Block Name ANALOG_ALM_AFB
(compiled version of the Chart)
Function Block Number FB600
Chart Name ANALOG_ALM
See also, Template Chart ANALOG_ALM_AT
(usage example)

Function
The Analog Alarm Function Block (ANALOG_ALM_AFB) 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.

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

A5E00595270-01 2-17
Library Function Blocks

ALARM_8P ID Message 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@
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@ 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

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

2-18 A5E00595270-01
 Library Function Blocks

2.4.1.1 ANALOG_ALM_AFB Input Output

Input

Name Data Type Explanation Initial OC&M Valid

Values
PV REAL Process Value 0 True
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 False True
Alarm
LD_EN BOOL Enable Low Deviation False True
Alarm
AD_EN BOOL Enable Absolute False True
Deviation Alarm
OOR_EN BOOL Enable Out of Range False True
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 Alarm False True
IR_EN BOOL Enable Increasing Rate False True
of Change Alarm
DR_EN BOOL Enable Decreasing False True
Rate of Change Alarm
AR_EN BOOL Enable Absolute Rate False True
of 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 2 True
displayed in HMI for PV
ConfirmChange BOOL If TRUE changes from False True
HMI must be confirmed

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

A5E00595270-01 2-19
Library Function Blocks

Output

Name Data Explanation Initial OC&M Valid

Type Values
ALARM BOOL Alarm indicator 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.

Input/output

Name Data Explanation Initial OC&M Valid Values

Type
H_LIM REAL The value (in engineering units) 100 True
to which the (PV) input is
compared for the High alarm.
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 T#0MS False 0 to
must reach or exceed the High 24d20h31m2
limit to trip an alarm. 3s647ms
H_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the High limit and 24d20h31m2
deadband to cause the alarm to 3s647ms
clear.
L_LIM REAL The value (in engineering units) 0 True
to which the (PV) input is
compared for the Low alarm.

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

2-20 A5E00595270-01
 Library Function Blocks

Name Data Explanation Initial OC&M Valid Values

Type
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 T#0MS False 0 to
must reach or exceed the Low 24d20h31m2
limit to trip an alarm. 3s647ms
L_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the Low limit and 24d20h31m2
deadband to cause the alarm to 3s647ms
clear.
HD_LIM REAL The value (in engineering units) 0 True
to 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 T#0MS False 0 to
must reach or exceed the High 24d20h31m2
Deviation limit to trip an alarm. 3s647ms
HD_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the High 24d20h31m2
Deviation limit and deadband to 3s647ms
cause the alarm to clear.
LD_LIM REAL The value (in engineering units) 0 True
to 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 T#0MS False 0 to
must reach or exceed the Low 24d20h31m2
Deviation limit to trip an alarm. 3s647ms
LD_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the Low Deviation 24d20h31m2
limit and deadband to cause the 3s647ms
alarm to clear.
AD_LIM REAL The value (in engineering units) 100 True
to 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 T#0MS False 0 to
must reach or exceed the 24d20h31m2
Absolute Deviation limit to trip an 3s647ms
alarm.

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

A5E00595270-01 2-21
Library Function Blocks

Name Data Explanation Initial OC&M Valid Values

Type
AD_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the Absolute 24d20h31m2
Deviation limit and deadband to 3s647ms
cause the alarm to clear.
HH_LIM REAL The value (in engineering units) 0 True
to 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 T#0MS False 0 to
must reach or exceed the High 24d20h31m2
High limit to trip an alarm. 3s647ms
HH_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the High High limit 24d20h31m2
and deadband to cause the 3s647ms
alarm to clear.
LL_LIM REAL The value (in engineering units) 0 True
to 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 T#0MS False 0 to
must reach or exceed the Low 24d20h31m2
Low limit to trip an alarm. 3s647ms
LL_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the Low Low limit 24d20h31m2
and deadband to cause the 3s647ms
alarm to clear.
IR_LIM REAL The value (in engineering units 0 True
per 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.
IR_DELAYIN TIME The amount of time the input T#0MS False 0 to
must reach or exceed the 24d20h31m2
Increasing Rate of Change limit 3s647ms
to trip an alarm.
IR_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the Increasing 24d20h31m2
Rate of Change limit and 3s647ms
deadband to cause the alarm to
clear.

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

2-22 A5E00595270-01
 Library Function Blocks

Name Data Explanation Initial OC&M Valid Values

Type
DR_LIM REAL The value (in engineering units 0 True
per 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 T#0MS False 0 to
must reach or exceed the 24d20h31m2
Decreasing Rate of Change limit 3s647ms
to trip an alarm.
DR_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the Decreasing 24d20h31m2
Rate of Change limit and 3s647ms
deadband to cause the alarm to
clear.
AR_LIM REAL The value (in engineering units 0 True
per 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 T#0MS False 0 to
must reach or exceed the 24d20h31m2
Absolute Rate of Change limit to 3s647ms
trip an alarm.
AR_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the Absolute Rate 24d20h31m2
of Change limit and deadband to 3s647ms
cause the alarm to clear.
OOR_DELAYIN TIME The amount of time the input T#0MS False 0 to
must be outside the limits EINH, 24d20h31m2
EINL to trip the Out of Range 3s647ms
alarm.
OOR_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the limits EINH, 24d20h31m2
EINL to cause the Out of Range 3s647ms
alarm to clear.
QUAL_DELAYIN TIME The amount of time the input T#0MS False 0 to
quality must be bad to trip the 24d20h31m2
Quality Not Good alarm. 3s647ms
QUAL_DELAYOUT TIME The amount of time the input T#0MS False 0 to
quality must be good to cause 24d20h31m2
the Quality Not Good alarm to 3s647ms
clear.
DISABLE_ON_OOS BOOL When set to TRUE, the block is False False
disabled if (OOS) is also TRUE.
PV_EUMIN REAL Engineering Input Low 0 True
PV_EUMAX REAL Engineering Input High 100 True

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

A5E00595270-01 2-23
Library Function Blocks

2.5 BLK_VLV_1OUT_AFB

2.5.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.

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

2-24 A5E00595270-01
 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). 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

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

A5E00595270-01 2-25
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 - Valve Feedback Failure -
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

2.5.1.1 BLK_VLV_1OUT_AFB Input Output

Input

Name Data Type Explanation Initial OC&M Valid

Values
OP_VER BOOL OP_VER feedback to False True
verify that the valve is
open
CL_VER BOOL CL_VER feedback to False True
verify that the valve is
closed
A_OPEN BOOL A false-to-true transition False False
of A_OPEN opens the
valve when in AUTO
mode (AUTO=true).
A_CLSE BOOL A false-to-true transition False False
of A_CLSE closes the
valve when in AUTO
mode (AUTO=true).
INTRLK BOOL INTRLK forbids False True
activation of the valve
SAMPLE_T REAL Sample Time (in Compiler False
seconds) generated

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

2-26 A5E00595270-01
 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid

Values
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 Auto False False
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 OUT False False
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

Note

This list differs from the inputs of the BLK_VLV_1OUT_AFB block in APACS+ as
follows:

x Restart parameters (RSTRT_...) did not exist in APACS+.

x EV_ID and SAMPLE_T did not exist in APACS+.

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

A5E00595270-01 2-27
Library Function Blocks

Output

Name Data Type Explanation Initial OC&M Valid

Values
OUT BOOL OUT is used to actuate the valve False True
ALARM BOOL ALARM is used to signa 1 internal logic False False
when the Valve is in alarm
FAIL BOOL FAIL signals if the valve failed to open or False True
close after an OPEN or CLOSE request
TRANS BOOL TRANS signals that the valve is in False True
transition (i.e. OP_VER, CL_VER both
false)

Input/output

Name Data Explanation Initial OC&M Valid

Type 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 True True
the internal alarm
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
OOS BOOL OOS indicates that the internal False True
alarm is Out of Service
DISABLE_ON_OOS BOOL Disable on Out of Service False False
OPEN BOOL OPEN opens the valve when in False True
Manual mode (AUTO=false)
CLOSE BOOL CLOSE closes the valve when False True
in Manual mode (AUTO=false)
TRAV_T TIME TRAV_T sets time limit for T#10S True
confirmation of open/close
request

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

2-28 A5E00595270-01
 Library Function Blocks

2.6 BLK_VLV_2OUT_AFB

2.6.1 BLK_VLV_2OUT: Block Valve with Two Outputs

Function Block Name BLK_VLV_2OUT_AFB
(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 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).

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

A5E00595270-01 2-29
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, 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 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.

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

2-30 A5E00595270-01
 Library Function Blocks

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

2.6.1.1 BLK_VLV_2OUT_AFB Input Output

Input

Name Data Type Explanation Initial OC&M Valid

Values
OP_VER BOOL OP_VER feedback to False True
verify that the valve is
open
CL_VER BOOL CL_VER feedback to False True
verify that the valve is
closed
A_OPEN BOOL A_OPEN is intended to False False
allow internal logic to
automatically open the
valve
A_CLSE BOOL A_CLSE is intended to False False
allow internal logic to
automatically close the
valve
INTRLK BOOL INTRLK forbids False True
activation of the valve
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 Auto False False
Mode if
RSTRT_AUTO_FLAG
true
EV_ID DWORD Event ID Compiler False
generated

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

A5E00595270-01 2-31
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

Note

This list differs from the inputs of the BLK_VLV_2OUT_AFB block in APACS+ as
follows:

x Restart parameters (RSTRT_...) did not exist in APACS+.

x EV_ID and SAMPLE_T did not exist in APACS+.

Output

Name Data Explanation Initial OC&M Valid Values

Type
OP_OUT BOOL OP_OUT is used to request that the valve T#0MS False 0 to
open 24d20h31m2
3s647ms
CL_OUT BOOL CL_OUT is used to request that the valve False False
close
ALARM BOOL ALARM is used to signal internal logic False False
when the Valve is in alarm
FAIL BOOL FAIL signals if the valve failed to open or False True
close after an OPEN or CLOSE request
TRANS BOOL TRANS signals that the valve is in False True
transition (i.e. OP_VER, CL_VER both
false)
OUT BOOL OUT is used to let the OS 'see' the False True
internal OPEN_LATCH coil

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

2-32 A5E00595270-01
 Library Function Blocks

Input/output

Name Data Explanation Initial OC&M Valid

Type 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 True True
the internal alarm
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
OOS BOOL OOS indicates that the internal False True
alarm is Out of Service
DISABLE_ON_OOS BOOL Indicates that the internal alarm is False False
Out of Service
OPEN BOOL OPEN opens the valve w hen in False True
Manual mode (AUTO=false)
CLOSE BOOL Closes the valve when in Manual False True
mode (AUTO=false)
TRAV_T TIME TRAV_T sets time limit for T#10S True
confirmation of open/close
request

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

A5E00595270-01 2-33
Library Function Blocks

2.7 CASCADE_AFB

2.7.1 CASCADE: Cascade Controller

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

Function
CASCADE_AFB 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).

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

2-34 A5E00595270-01
 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, 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
x the block is forced to start in Auto mode, or
x 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.

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

A5E00595270-01 2-35
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

EV_ID 1 Warning - Pri HIGH - $$BlockComment$$ - Limit = @4%f@
above
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 Pri OUT_OF_RANGE - $$BlockComment$$
Control
Message -
Failure
EV_ID 7 PLC Process Pri QUALITY_NOT_GOOD - $$BlockComment$$
Control
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@

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

2-36 A5E00595270-01
 Library Function Blocks

ALARM_8P ID Message # Message Class Default Message Text

EV_ID2 3 Warning - Pri INC_ROC - $$BlockComment$$ - Limit =
above @6%f@
EV_ID2 4 Warning - below Pri DEC_ROC - $$BlockComment$$ - Limit =
@7%f@
EV_ID2 5 Warning - Pri ABS_ROC - $$BlockComment$$ - Limit =
above @8%f@
EV_ID3 1 Warning - Sec HIGH - $$BlockComment$$ - Limit =
above @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 Sec OUT_OF_RANGE - $$BlockComment$$
Control
Message -
Failure
EV_ID3 7 PLC Process Sec QUALITY_NOT_GOOD -
Control $$BlockComment$$
Message -
Failure
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 - Sec INC_ROC - $$BlockComment$$ - Limit =
above @6%f@
EV_ID4 4 Warning - below Sec DEC_ROC - $$BlockComment$$ - Limit =
@7%f@
EV_ID4 5 Warning - Sec ABS_ROC - $$BlockComment$$ - Limit =
above @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

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

A5E00595270-01 2-37
Library Function Blocks

ALARM_8P ID Value Block Parameter

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

2.7.1.1 CASCADE_AFB Input Output

Input

Name Data Type Explanation Initial OC&M Valid

Values
P_PV REAL Primary Process 0 True
Variable
S_PV REAL Secondary 0 True
Process Variable
P_INIT BOOL Transitions of the False False
INIT input cause
the initialization
equation to be
performed
P_TSP REAL SP target value for 0 True
SP ramping
P_H_EN BOOL Enable primary True True
High Alarm
P_L_EN BOOL Enable primary True True
Low Alarm

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

2-38 A5E00595270-01
 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid

Values
P_HD_EN BOOL Enable primary False True
High Deviation
Alarm
P_LD_EN BOOL Enable primary False True
Low Deviation
Alarm
P_AD_EN BOOL Enable primary True True
Absolute
Deviation Alarm
P_OOR_EN BOOL Enable primary False True
Out of Range
Alarm
P_QUAL_EN BOOL Enable primary False True
Quality Not Good
Alarm
P_HH_EN BOOL Enable primary False True
High High Alarm
P_LL_EN BOOL Enable primary False True
Low Low Alarm
P_IR_EN BOOL Enable primary False True
Increasing Rate of
Change Alarm
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 False True
Service indicator
P_QBAD BOOL Bad quality False False
indicator
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
*
EV_ID3 DWORD Event ID Compiler False
generated for
the type or N/A
if used as chart
*
EV_ID4 DWORD Event ID Compiler False
generated for
the type or N/A
if used as chart
*

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

A5E00595270-01 2-39
Library Function Blocks

Name Data Type Explanation Initial OC&M Valid

Values
S_TSP REAL SP target value for 0 True
SP ramping
S_H_EN BOOL Enable secondary True True
High Alarm
S_L_EN BOOL Enable secondary True True
Low Alarm
S_HD_EN BOOL Enable secondary False True
High Deviation
Alarm
S_LD_EN BOOL Enable secondary False True
Low Deviation
Alarm
S_AD_EN BOOL Enable secondary True True
Absolute
Deviation Alarm
S_OOR_EN BOOL Enable secondary False True
Out 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 False True
Low 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
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 False False
indicator
SAMPLE_T REAL Scan Rate. Use Compiler False
only when generated for
compiling CFC as the type or N/A
block type. if used as chart
*
RSTRT_AUTO_FLAG BOOL Default:Retain on True False
WS, Use load val
on CS. Force:Use
RSTRT_AUTO_V
ALUE on restart
RSTRT_AUTO_VALUE BOOL Init restart value False False
for Auto Mode if
RSTRT_AUTO_F
LAG true

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

2-40 A5E00595270-01
 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid

Values
P_RSTRT_SP_FLAG BOOL Default:Retain on False False
WS, Use load val
on CS. Force:Use
RSTRT_SP_VAL
UE on restart.
P_RSTRT_SP_VALUE REAL Init restart value 0 False
for SP if
RSTRT_SP_FLA
G true and Auto
mode
RSTRT_CASC_FLAG BOOL Default:Retain on True False
WS, Use load val
on CS. Force:Use
RSTRT_EXT_VAL
UE on restart.
RSTRT_CASC_VALUE BOOL Init restart value False False
for EXTernal if
RSTRT_EXT_FLA
G true
S_RSTRT_SP_FLAG BOOL Default:Retain on False False
WS, Use load val
on CS. Force:Use
RSTRT_SP_VAL
UE on restart.
S_RSTRT_SP_VALUE REAL Init restart value 0 False
for SP if
RSTRT_SP_FLA
G true and Auto
mode
RSTRT_OUT_FLAG BOOL Default:Retain on True False
WS, Use load val
on CS. Force:Use
RSTRT_OUT_VA
LUE on restart
RSTRT_OUT_VALUE REAL Init restart value 0 False
for OUT if
RSTRT_OUT_FL
AG 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 0 True
number
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.

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

A5E00595270-01 2-41
Library Function Blocks

Name Data Type Explanation Initial OC&M Valid

Values
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
LIOP_P_ISP_SEL BOOL Select Primary 0 False
internal 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 0 False
select
External/Internal
SP flag, 1=Extrnl
LIOP_OUT_SEL BOOL Select writing to 0 False
OUT: 1 = from
Link, 0 = from
Operator
OUT_L REAL Linkable input to 0.0 False
be written to
Secondary OUT

Note

This list differs significantly from the inputs of the CASCADE_AFB 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).

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

2-42 A5E00595270-01
 Library Function Blocks

Output

Name Data Explanation Initial OC&M Valid

Type 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 0 False
been limited
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 False False
alarm is detected and enabled.
P_L_ALM BOOL When TRUE, the primary Low alarm False False
is detected and enabled.
P_HD_ALM BOOL When TRUE, the primary High False False
Deviation alarm is detected and
enabled.
P_LD_ALM BOOL When TRUE, the primary Low False False
Deviation 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 False False
Range alarm is detected and
enabled.
P_QUAL_ALM BOOL When TRUE, the primary Quality False False
Not Good alarm is detected and
enabled.
P_HH_ALM BOOL When TRUE, the primary High High False False
alarm is detected and enabled.
P_LL_ALM BOOL When TRUE, the primary Low Low False False
alarm is detected and enabled.
P_IR_ALM BOOL When TRUE, the primary Increasing False False
Rate of Change alarm is detected
and enabled.
P_DR_ALM BOOL When TRUE, the primary False False
Decreasing Rate of Change alarm is
detected and enabled.
P_AR_ALM BOOL When TRUE, the primary Absolute False False
Rate of Change alarm is detected
and enabled.
S_H_ALM BOOL When TRUE, the secondary High False False
alarm is detected and enabled.
S_L_ALM BOOL When TRUE, the secondary Low False False
alarm is detected and enabled.
S_HD_ALM BOOL When TRUE, the secondary High False False
Deviation alarm is detected and
enabled.
S_LD_ALM BOOL When TRUE, the secondary Low False False
Deviation alarm is detected and
enabled.

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

A5E00595270-01 2-43
Library Function Blocks

Name Data Explanation Initial OC&M Valid

Type Values
S_AD_ALM BOOL When TRUE, the secondary False False
Absolute Deviation alarm is
detected and enabled.
S_OOR_ALM BOOL When TRUE, the secondary Out of False False
Range alarm is detected and
enabled.
S_QUAL_ALM BOOL When TRUE, the secondary Quality False False
Not Good alarm is detected and
enabled.
S_HH_ALM BOOL When TRUE, the secondary High False False
High alarm is detected and enabled.
S_LL_ALM BOOL When TRUE, the secondary Low False False
Low alarm is detected and enabled.
S_IR_ALM BOOL When TRUE, the secondary False False
Increasing Rate of Change alarm is
detected and enabled.
S_DR_ALM BOOL When TRUE, the secondary False False
Decreasing Rate of Change alarm is
detected and enabled.
S_AR_ALM BOOL When TRUE, the secondary False False
Absolute Rate 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 0 False
Input

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.

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

2-44 A5E00595270-01
 Library Function Blocks

Input/output

Name Data Explanation Initial OC&M Valid

Type 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 False True
control
P_R_TIME TIME Ramp time T#0MS True 0 to
24d20h31m
23s647ms
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 0 True
units per min)
P_USE_RR BOOL Ramp mode control. Use False True
RTIME or RRATE to
control ramp
P_PV_TRACK BOOL Internal setpoint tracking True True
control. 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 4000 True 0.0 to
Reset 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_INIT BOOL Adaptive Gain Init flag True False
P_PV_EUMIN REAL Engineering unit: Input, 0 True
Low
P_PV_EUMAX REAL Engineering unit: Input, 100 True
High
P_VL_EUMIN REAL Engineering unit: Output, 0 True
Low
P_VL_EUMAX REAL Engineering unit: Output, 100 True
High
P_H_LIM REAL The value (in engineering 100 True
units) to which the (P_PV)
input is compared for the
High alarm.
P_H_DB REAL The amount of engineering 0.5 True
units by which (P_PV)
must be within the limit for
the High alarm to clear.

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

A5E00595270-01 2-45
Library Function Blocks

Name Data Explanation Initial OC&M Valid

Type Values
P_H_DELAYIN TIME The amount of time the T#0MS False 0 to
input must reach or exceed 24d20h31m
the High limit to trip an 23s647ms
alarm.
P_H_DELAYOUT TIME The amount of time the T#0MS False 0 to
input must be within the 24d20h31m
High limit and deadband to 23s647ms
cause the alarm to clear.
P_L_LIM REAL The value (in engineering 0 True
units) to which the (P_PV)
input is compared for the
Low alarm.
P_L_DB REAL The amount of engineering 0.5 True
units by which (P_PV)
must be within the limit for
the Low alarm to clear.
P_L_DELAYIN TIME The amount of time the T#0MS False 0 to
input must reach or exceed 24d20h31m
the Low limit to trip an 23s647ms
alarm.
P_L_DELAYOUT TIME The amount of time the T#0MS False 0 to
input must be within the 24d20h31m
Low limit and deadband to 23s647ms
cause the alarm to clear.
P_HD_LIM REAL The value (in engineering 0 True
units) to which (P_PV) –
(DEV) is compared for the
High Deviation alarm.
P_HD_DB REAL The amount of engineering 0.5 True
units by 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 T#0MS False 0 to
input must reach or exceed 24d20h31m
the High Deviation limit to 23s647ms
trip an alarm.
P_HD_DELAYOUT TIME The amount of time the T#0MS False 0 to
input must be within the 24d20h31m
High Deviation limit and 23s647ms
deadband to cause the
alarm to clear.
P_LD_LIM REAL The value (in engineering 0 True
units) to which (DEV) -
(P_PV) is compared for the
Low Deviation alarm.
P_LD_DB REAL The amount of engineering 0.5 True
units by which (DEV) -
(P_PV) must be within the
limit for the Low Deviation
alarm to clear.

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

2-46 A5E00595270-01
 Library Function Blocks

Name Data Explanation Initial OC&M Valid

Type Values
P_LD_DELAYIN TIME The amount of time the T#0MS False 0 to
input must reach or exceed 24d20h31m
the Low Deviation limit to 23s647ms
trip an alarm.
P_LD_DELAYOUT TIME The amount of time the T#0MS False 0 to
input must be within the 24d20h31m
Low Deviation limit and 23s647ms
deadband to cause the
alarm to clear.
P_AD_LIM REAL The value (in engineering 100 True
units) to which
ABS((P_PV) – (DEV)) is
compared for the Absolute
Deviation alarm.
P_AD_DB REAL The amount of engineering 0.5 True
units by 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 T#0MS False 0 to
input must reach or exceed 24d20h31m
the Absolute Deviation limit 23s647ms
to trip an alarm.
P_AD_DELAYOUT TIME The amount of time the T#0MS False 0 to
input must be within the 24d20h31m
Absolute Deviation limit 23s647ms
and deadband to cause
the alarm to clear.
P_HH_LIM REAL The value (in engineering 0 True
units) to which the (P_PV)
input is compared for the
High High alarm.
P_HH_DB REAL The amount of engineering 0.5 True
units by which (P_PV)
must be within the limit for
the High High alarm to
clear.
P_HH_DELAYIN TIME The amount of time the T#0MS False 0 to
input must reach or exceed 24d20h31m
the High High limit to trip 23s647ms
an alarm.
P_HH_DELAYOUT TIME The amount of time the T#0MS False 0 to
input must be within the 24d20h31m
High High limit and 23s647ms
deadband to cause the
alarm to clear.
P_LL_LIM REAL The value (in engineering 0 True
units) to which the (P_PV)
input is compared for the
Low Low alarm.

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

A5E00595270-01 2-47
Library Function Blocks

Name Data Explanation Initial OC&M Valid

Type Values
P_LL_DB REAL The amount of engineering 0.5 True
units by which (P_PV)
must be within the limit for
the Low Low alarm to
clear.
P_LL_DELAYIN TIME The amount of time the T#0MS False 0 to
input must reach or exceed 24d20h31m
the Low Low limit to trip an 23s647ms
alarm.
P_LL_DELAYOUT TIME The amount of time the T#0MS False 0 to
input must be within the 24d20h31m
Low Low limit and 23s647ms
deadband to cause the
alarm to clear.
P_IR_LIM REAL The value (in engineering 0 True
units per minute) to which
the (P_PV) input is
compared for the
Increasing Rate of Change
alarm.
P_IR_DB REAL The amount of engineering 0.5 True
units by 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 T#0MS False 0 to
input must reach or exceed 24d20h31m
the Increasing Rate of 23s647ms
Change limit to trip an
alarm.
P_IR_DELAYOUT TIME The amount of time the T#0MS False 0 to
input must be within the 24d20h31m
Increasing Rate of Change 23s647ms
limit and deadband to
cause the alarm to clear.
P_DR_LIM REAL The value (in engineering 0 True
units per minute) to which
the (P_PV) input is
compared for the
Decreasing Rate of
Change alarm.
P_DR_DB REAL The amount of engineering 0.5 True
units by which (P_PV)
must be within the limit for
the Decreasing Rate of
Change alarm to clear.
P_DR_DELAYIN TIME The amount of time the T#0MS False 0 to
input must reach or exceed 24d20h31m
the Decreasing Rate of 23s647ms
Change limit to trip an
alarm.

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

2-48 A5E00595270-01
 Library Function Blocks

Name Data Explanation Initial OC&M Valid

Type Values
P_DR_DELAYOUT TIME The amount of time the T#0MS False 0 to
input must be within the 24d20h31m
Decreasing Rate of 23s647ms
Change limit and
deadband to cause the
alarm to clear.
P_AR_LIM REAL The value (in engineering 0 True
units per minute) to which
the (P_PV) input is
compared for the Absolute
Rate of Change alarm.
P_AR_DB REAL The amount of engineering 0.5 True
units by 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 T#0MS False 0 to
input must reach or exceed 24d20h31m
the Absolute Rate of 23s647ms
Change limit to trip an
alarm.
P_AR_DELAYOUT TIME The amount of time the T#0MS False 0 to
input must be within the 24d20h31m
Absolute Rate of Change 23s647ms
limit and deadband to
cause the alarm to clear.
P_OOR_DELAYIN TIME The amount of time the T#0MS False 0 to
input must be outside the 24d20h31m
limits EINH, EINL to trip 23s647ms
the Out of Range alarm.
P_OOR_DELAYOUT TIME The amount of time the T#0MS False 0 to
input must be within the 24d20h31m
limits EINH, EINL to cause 23s647ms
the Out of Range alarm to
clear.
P_QUAL_DELAYIN TIME The amount of time the T#0MS False 0 to
input quality must be bad 24d20h31m
to trip the Quality Not 23s647ms
Good alarm.
P_QUAL_DELAYOUT TIME The amount of time the T#0MS False 0 to
input quality must be good 24d20h31m
to cause the Quality Not 23s647ms
Good alarm to clear.
P_DISABLE_ON_OOS BOOL When set to TRUE, the False False
block is disabled if (OOS)
is also TRUE.
S_SP REAL Computer set point value 0 True
S_RAMP BOOL SP ramping on/off mode False True
control
S_R_TIME TIME Ramp time T#0MS True 0 to
24d20h31m
23s647ms
S_SPL REAL Set point low limit 0 True

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

A5E00595270-01 2-49
Library Function Blocks

Name Data Explanation Initial OC&M Valid

Type Values
S_SPH REAL Set point high limit 100 True
S_R_RATE REAL Ramp rate (in engineering 0 True
units per min)
S_USE_RR BOOL Ramp mode control. Use False True
RTIME or RRATE to
control ramp
S_PV_TRACK BOOL Internal setpoint tracking True True
control. When Track,
internal setpoint tracks PV
S_PG REAL Proportional Gain 0.001 True 0.001 to
100.0
S_TI REAL Time-Integral Minutes per 4000 True 0.0 to
Reset 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_INIT BOOL Adaptive Gain Init flag True False
S_PV_EUMIN REAL Engineering unit: Input, 0 True
Low
S_PV_EUMAX REAL Engineering unit: Input, 100 True
High
S_VL_EUMIN REAL Engineering unit: Output, 0 True
Low
S_VL_EUMAX REAL Engineering unit: Output, 100 True
High
S_VL REAL Computer Output, typically 0 True
written to by an operator
command
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 100 True
units) to which the (S_PV)
input is compared for the
High alarm.
S_H_DB REAL The amount of engineering 0.5 True
units by which (S_PV)
must be within the limit for
the High alarm to clear.
S_H_DELAYIN TIME The amount of time the T#0MS False 0 to
input must reach or exceed 24d20h31m
the High limit to trip an 23s647ms
alarm.
S_H_DELAYOUT TIME The amount of time the T#0MS False 0 to
input must be within the 24d20h31m
High limit and deadband to 23s647ms
cause the alarm to clear.

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

2-50 A5E00595270-01
 Library Function Blocks

Name Data Explanation Initial OC&M Valid

Type Values
S_L_LIM REAL The value (in engineering 0 True
units) to which the (S_PV)
input is compared for the
Low alarm.
S_L_DB REAL The amount of engineering 0.5 True
units by which (S_PV)
must be within the limit for
the Low alarm to clear.
S_L_DELAYIN TIME The amount of time the T#0MS False 0 to
input must reach or exceed 24d20h31m
the Low limit to trip an 23s647ms
alarm.
S_L_DELAYOUT TIME The amount of time the T#0MS False 0 to
input must be within the 24d20h31m
Low limit and deadband to 23s647ms
cause the alarm to clear.
S_HD_LIM REAL The value (in engineering 0 True
units) to which (S_PV) –
(DEV) is compared for the
High Deviation alarm.
S_HD_DB REAL The amount of engineering 0.5 True
units by which (S_PV) –
(DEV) must be within the
limit for the High Deviation
alarm to clear.
S_HD_DELAYIN TIME The amount of time the T#0MS False 0 to
input must reach or exceed 24d20h31m
the High Deviation limit to 23s647ms
trip an alarm.
S_HD_DELAYOUT TIME The amount of time the T#0MS False 0 to
input must be within the 24d20h31m
High Deviation limit and 23s647ms
deadband to cause the
alarm to clear.
S_LD_LIM REAL The value (in engineering 0 True
units) to which (DEV) -
(S_PV) is compared for the
Low Deviation alarm.
S_LD_DB REAL The amount of engineering 0.5 True
units by 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 T#0MS False 0 to
input must reach or exceed 24d20h31m
the Low Deviation limit to 23s647ms
trip an alarm.
S_LD_DELAYOUT TIME The amount of time the T#0MS False 0 to
input must be within the 24d20h31m
Low Deviation limit and 23s647ms
deadband to cause the
alarm to clear.

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

A5E00595270-01 2-51
Library Function Blocks

Name Data Explanation Initial OC&M Valid

Type Values
S_AD_LIM REAL The value (in engineering 100 True
units) to which
ABS((S_PV) – (DEV)) is
compared for the Absolute
Deviation alarm.
S_AD_DB REAL The amount of engineering 0.5 True
units by 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 T#0MS False 0 to
input must reach or exceed 24d20h31m
the Absolute Deviation limit 23s647ms
to trip an alarm.
S_AD_DELAYOUT TIME The amount of time the T#0MS False 0 to
input must be within the 24d20h31m
Absolute Deviation limit 23s647ms
and deadband to cause
the alarm to clear.
S_HH_LIM REAL The value (in engineering 0 True
units) to which the (S_PV)
input is compared for the
High High alarm.
S_HH_DB REAL The amount of engineering 0.5 True
units by which (S_PV)
must be within the limit for
the High High alarm to
clear.
S_HH_DELAYIN TIME The amount of time the T#0MS False 0 to
input must reach or exceed 24d20h31m
the High High limit to trip 23s647ms
an alarm.
S_HH_DELAYOUT TIME The amount of time the T#0MS False 0 to
input must be within the 24d20h31m
High High limit and 23s647ms
deadband to cause the
alarm to clear.
S_LL_LIM REAL The value (in engineering 0 True
units) to which the (S_PV)
input is compared for the
Low Low alarm.
S_LL_DB REAL The amount of engineering 0.5 True
units by which (S_PV)
must be within the limit for
the Low Low alarm to
clear.
S_LL_DELAYIN TIME The amount of time the T#0MS False 0 to
input must reach or exceed 24d20h31m
the Low Low limit to trip an 23s647ms
alarm.

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

2-52 A5E00595270-01
 Library Function Blocks

Name Data Explanation Initial OC&M Valid

Type Values
S_LL_DELAYOUT TIME The amount of time the T#0MS False 0 to
input must be within the 24d20h31m
Low Low limit and 23s647ms
deadband to cause the
alarm to clear.
S_IR_LIM REAL The value (in engineering 0 True
units per minute) to which
the (S_PV) input is
compared for the
Increasing Rate of Change
alarm.
S_IR_DB REAL The amount of engineering 0.5 True
units by 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 T#0MS False 0 to
input must reach or exceed 24d20h31m
the Increasing Rate of 23s647ms
Change limit to trip an
alarm.
S_IR_DELAYOUT TIME The amount of time the T#0MS False 0 to
input must be within the 24d20h31m
Increasing Rate of Change 23s647ms
limit and deadband to
cause the alarm to clear.
S_DR_LIM REAL The value (in engineering 0 True
units per minute) to which
the (S_PV) input is
compared for the
Decreasing Rate of
Change alarm.
S_DR_DB REAL The amount of engineering 0.5 True
units by 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 T#0MS False 0 to
input must reach or exceed 24d20h31m
the Decreasing Rate of 23s647ms
Change limit to trip an
alarm.
S_DR_DELAYOUT TIME The amount of time the T#0MS False 0 to
input must be within the 24d20h31m
Decreasing Rate of 23s647ms
Change limit and
deadband to cause the
alarm to clear.
S_AR_LIM REAL The value (in engineering 0 True
units per minute) to which
the (S_PV) input is
compared for the Absolute
Rate of Change alarm.

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

A5E00595270-01 2-53
Library Function Blocks

Name Data Explanation Initial OC&M Valid

Type Values
S_AR_DB REAL The amount of engineering 0.5 True
units by which (S_PV)
must be within the limit for
the Absolute Rate of
Change alarm to clear.
S_AR_DELAYIN TIME The amount of time the T#0MS False 0 to
input must reach or exceed 24d20h31m
the Absolute Rate of 23s647ms
Change limit to trip an
alarm.
S_AR_DELAYOUT TIME The amount of time the T#0MS False 0 to
input must be within the 24d20h31m
Absolute Rate of Change 23s647ms
limit and deadband to
cause the alarm to clear.
S_OOR_DELAYIN TIME The amount of time the T#0MS False 0 to
input must be outside the 24d20h31m
limits EINH, EINL to trip 23s647ms
the Out of Range alarm.
S_OOR_DELAYOUT TIME The amount of time the T#0MS False 0 to
input must be within the 24d20h31m
limits EINH, EINL to cause 23s647ms
the Out of Range alarm to
clear.
S_QUAL_DELAYIN TIME The amount of time the T#0MS False 0 to
input quality must be bad 24d20h31m
to trip the Quality Not 23s647ms
Good alarm.
S_QUAL_DELAYOUT TIME The amount of time the T#0MS False 0 to
input quality must be good 24d20h31m
to cause the Quality Not 23s647ms
Good alarm to clear.
S_DISABLE_ON_OOS BOOL When set to TRUE, the False False
block is disabled if (OOS)
is also TRUE.

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

2-54 A5E00595270-01
 Library Function Blocks

2.8 DALM_AFB

2.8.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.

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.

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

A5E00595270-01 2-55
Library Function Blocks

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

2.8.1.1 DALM_AFB Input Output

Input

Name Data Type Explanation Initial OC&M Valid

Values
IN1 BOOL This is the value to be monitored for False True
alarm1.
EN1 BOOL When TRUE, alarm1 is enabled. False True
IN2 BOOL This is the value to be monitored for False False
alarm2.
EN2 BOOL When TRUE, alarm2 is enabled. False False
IN3 BOOL This is the value to be monitored for False False
alarm3.
EN3 BOOL When TRUE, alarm3 is enabled. False False
IN4 BOOL This is the value to be monitored for False False
alarm4.
EN4 BOOL When TRUE, alarm4 is enabled. False False
IN5 BOOL This is the value to be monitored for False False
alarm5.
EN5 BOOL When TRUE, alarm5 is enabled. False False
IN6 BOOL This is the value to be monitored for False False
alarm6.
EN6 BOOL When TRUE, alarm6 is enabled. False False
IN7 BOOL This is the value to be monitored for False False
alarm7.

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

2-56 A5E00595270-01
 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid

Values
EN7 BOOL When TRUE, alarm7 is enabled False False
IN8 BOOL This is the value to be monitored for False False
alarm8.
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 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
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:
x There are now eight inputs and enables.
x Only the first alarm’s input and enable will be visible, so that the block will look
like the APACS+ HLLDA1 block.
x The parameter EV_ID was added to support the message system.
x 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

Type Values
ALM1 BOOL When TRUE, alarm1 is detected and False False
enabled.
NAK1 BOOL When TRUE, alarm1 alarm is tripped but False False
not acknowledged.
ALM2 BOOL When TRUE, alarm2 is detected and False False
enabled.
NAK2 BOOL When TRUE, alarm2 is tripped but not False False
acknowledged.
ALM3 BOOL When TRUE, alarm3 is detected and False False
enabled.
NAK3 BOOL When TRUE, alarm3 is tripped but not False False
acknowledged.
ALM4 BOOL When TRUE, alarm4 is detected and False False
enabled.
NAK4 BOOL When TRUE, alarm4 is tripped but not False False
acknowledged.
ALM5 BOOL When TRUE, alarm5 is detected and False False
enabled.

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

A5E00595270-01 2-57
Library Function Blocks

Name Data Explanation Initial OC&M Valid

Type Values
NAK5 BOOL When TRUE, alarm5 is tripped but not False False
acknowledged.
ALM6 BOOL When TRUE, alarm6 is detected and False False
enabled.
NAK6 BOOL When TRUE, alarm6 is tripped but not False False
acknowledged.
ALM7 BOOL When TRUE, alarm7 is detected and False False
enabled.
NAK7 BOOL When TRUE, alarm7 is tripped but not False False
acknowledged.
ALM8 BOOL When TRUE, alarm8 is detected and False False
enabled.
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:
x There are now eight alarms and NAKs.
x Only the first alarm’s output and NAK are visible. This makes the block look
similar to the APACS+ HLLDA1 block.
x The STATUS and CMD outputs have been removed.
x 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.

Input/output

Name Data Explanation Initial OC&M Valid

Type Values
ALARM1_LIMIT BOOL The value to which the False True
IN1 value is compared
for alarm1.
ALARM1_DELAYIN TIME The amount of time T#0d0h0m0s0ms False
the input must remain
at the limit to trip
alarm1.
ALARM1_DELAYOUT TIME The amount of time T#0d0h0m0s0ms False
the input must remain
not at the limit to
cause alarm1 to clear.
ALARM2_LIMIT BOOL The value to which IN2 False False
is compared for
alarm2.

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

2-58 A5E00595270-01
 Library Function Blocks

Name Data Explanation Initial OC&M Valid

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

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

A5E00595270-01 2-59
Library Function Blocks

Name Data Explanation Initial OC&M Valid

Type Values
ALARM7_LIMIT BOOL The value to which IN7 False False
is compared for
alarm7.
ALARM7_DELAYIN TIME The amount of time T#0d0h0m0s0ms False
the input must remain
at the limit to trip
alarm7.
ALARM7_DELAYOUT TIME The amount of time T#0d0h0m0s0ms False
the input must remain
not at the limit to
cause alarm7 to clear.
ALARM8_LIMIT BOOL The value to which IN8 False False
is compared for
alarm8.
ALARM8_DELAYIN TIME The amount of time T#0d0h0m0s0ms False
the input must remain
at the limit to trip
alarm8.
ALARM8_DELAYOUT TIME The amount of time T#0d0h0m0s0ms False
the input must remain
not at the limit to
cause alarm8 to clear.
DISABLE_ON_OOS BOOL When set to TRUE, False
the 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:
x The PCS 7 OS provides a ringback mechanism, so the ringback parameters
have been removed.
x There are now eight LIMIT, DELAYIN, and DELAYOUT parameters.

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

2-60 A5E00595270-01
 Library Function Blocks

2.9 DISCRETE_ALM_AFB

2.9.1 DISCRETE_ALM_AFB
Function Block Name DISCRETE_ALM_AFB
(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_AFB) 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

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$$

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

A5E00595270-01 2-61
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

2.9.1.1 DISCRETE_ALM_AFB Input Output

Input

Name Data Type Explanation Initial OC&M Valid

Values
DIN BOOL The discrete False True
parameter being
monitored.
ENABLE BOOL Enable Alarm 1 True True
OOS BOOL Out of Service False True
Indicator
EV_ID DWORD Event ID Compiler generated for False
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_AFB looks like its APACS+
counterpart. The DI input was changed to DIN for compatibility with the HMI.

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

2-62 A5E00595270-01
 Library Function Blocks

Output

Name Data Type Explanation Initial OC&M Valid

Values
ALARM BOOL Alarm 1 False False

Input/output

Name Data Explanation Initial OC&M Valid

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

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

A5E00595270-01 2-63
Library Function Blocks

2.10 EXT_SET_AFB

2.10.1 EXT_SET: External Setpoint Controller

Function Block Name EXT_SET_AFB
(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_AFB) 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_AFB 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 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

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

2-64 A5E00595270-01
 Library Function Blocks

"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

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

A5E00595270-01 2-65
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

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 -
Control Message - $$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

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

2-66 A5E00595270-01
 Library Function Blocks

ALARM_8P ID Value Block Parameter

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

2.10.1.1 EXT_SET_AFB Input Output

Input

Name Data Type Explanation Initial OC&M Valid

Values
PV REAL Process 0 True
Variable
TSP REAL SP target value 0 True
for SP ramping
H_EN BOOL Enable High True True
Alarm
L_EN BOOL Enable Low True True
Alarm
HD_EN BOOL Enable High False True
Deviation Alarm
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 False True
Not Good Alarm
HH_EN BOOL Enable High False True
High Alarm
LL_EN BOOL Enable Low Low False True
Alarm
IR_EN BOOL Enable False True
Increasing Rate
of Change
Alarm
DR_EN BOOL Enable False True
Decreasing
Rate of Change
Alarm

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

A5E00595270-01 2-67
Library Function Blocks

Name Data Type Explanation Initial OC&M Valid

Values
AR_EN BOOL Enable Absolute False True
Rate of Change
Alarm
OOS BOOL Out of Service False True
indicator
QBAD BOOL Bad quality False False
indicator
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 0 True
point
SAMPLE_T REAL Current scan Compiler False
rate supplied by generated for
OS the type or N/A
if used as
chart *
RSTRT_AUTO_FLAG BOOL Default: Retain True False
on WS, Use
load value on
CS. Force: Use
RSTRT_AUTO_
VALUE on
restart
RSTRT_AUTO_VALUE BOOL Init restart value False False
for Auto Mode if
RSTRT_AUTO_
FLAG true
RSTRT_EXT_FLAG BOOL Default: Retain True False
on WS, Use
load value on
CS. Force: Use
RSTRT_EXT_V
ALUE on restart
RSTRT_EXT_VALUE BOOL Init restart value False False
for EXTernal if
RSTRT_EXT_F
LAG true
RSTRT_SP_FLAG BOOL Default: Retain False False
on WS, Use
load value on
CS. Force: Use
RSTRT_SP_VA
LUE on restart.

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

2-68 A5E00595270-01
 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid

Values
RSTRT_SP_VALUE REAL Init restart value 0 False
for SP if
RSTRT_SP_FL
AG true and
Auto mode.
RSTRT_OUT_FLAG BOOL Default: Retain True False
on WS, Use
load value on
CS. Force: Use
RSTRT_OUT_V
ALUE on restart.
RSTRT_OUT_VALUE REAL Init restart value 0 False
for OUT if
RSTRT_OUT_F
LAG true and
manual mode
BA_EN BOOL Batch enabled False True
OCCUPIED BOOL Batch occupied False True
BA_ID DWORD Batch ID 0 True
number
BA_NA STRING[32] Batch name ‘‘ True
STEP_NO DWORD Batch step 0 True
number
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 False True
changes from
HMI must be
confirmed
LIOP_MAN_SEL BOOL Select 0 False
AUTO/MANUAL
:
1 = Linking, 0 =
Operator active
AUT_L BOOL Linkable input 0 False
for
AUTO/MANUAL
mode, 1 =
AUTO
LIOP_EXT_SEL BOOL Select 0 False
External/Internal
SP flag: 1 =
from Link, 0 =
from Operator

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

A5E00595270-01 2-69
Library Function Blocks

Name Data Type Explanation Initial OC&M Valid

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

Note

This list differs significantly from the inputs of the EXT_SET_AFB 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_AFB 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.

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

2-70 A5E00595270-01
 Library Function Blocks

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 been 0 False
limited
ALARM BOOL Alarm Status False False
H_ALM BOOL When TRUE, the High alarm is detected False False
and enabled.
L_ALM BOOL When TRUE, the Low alarm is detected False False
and 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 False False
alarm is 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 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 InOut
parameter.

Input/output

Name Data Explanation Initial OC& Valid Values

Type M
AUTO BOOL Auto/manual mode control False True
EXT BOOL External/internal mode control False True

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

A5E00595270-01 2-71
Library Function Blocks

Name Data Explanation Initial OC& Valid Values

Type M
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
24d20h31m23
s647ms
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_INI BOOL Adaptive Gain Init flag False True
T
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 0 True
written to by an operator
command
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) 100 True
to which the (PV) input is
compared for the High alarm.
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 T#0MS False 0 to
must reach or exceed the High 24d20h31m23
limit to trip an alarm. s647ms
H_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the High limit and 24d20h31m23
deadband to cause the alarm to s647ms
clear.
L_LIM REAL The value (in engineering units) 0 True
to 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.

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

2-72 A5E00595270-01
 Library Function Blocks

Name Data Explanation Initial OC& Valid Values

Type M
L_DELAYIN TIME The amount of time the input T#0MS False 0 to
must reach or exceed the Low 24d20h31m23
limit to trip an alarm. s647ms
L_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the Low limit and 24d20h31m23
deadband to cause the alarm to s647ms
clear.
HD_LIM REAL The value (in engineering units) 0 True
to 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 T#0MS False 0 to
must reach or exceed the High 24d20h31m23
Deviation limit to trip an alarm. s647ms
HD_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the High 24d20h31m23
Deviation limit and deadband to s647ms
cause the alarm to clear.
LD_LIM REAL The value (in engineering units) 0 True
to 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 T#0MS False 0 to
must reach or exceed the Low 24d20h31m23
Deviation limit to trip an alarm. s647ms
LD_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the Low 24d20h31m23
Deviation limit and deadband to s647ms
cause the alarm to clear.
AD_LIM REAL The value (in engineering units) 100 True
to 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 T#0MS False 0 to
must reach or exceed the 24d20h31m23
Absolute Deviation limit to trip s647ms
an alarm.

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

A5E00595270-01 2-73
Library Function Blocks

Name Data Explanation Initial OC& Valid Values

Type M
AD_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the Absolute 24d20h31m23
Deviation limit and deadband to s647ms
cause the alarm to clear.
HH_LIM REAL The value (in engineering units) 0 True
to 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 T#0MS False 0 to
must reach or exceed the High 24d20h31m23
High limit to trip an alarm. s647ms
HH_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the High High 24d20h31m23
limit and deadband to cause the s647ms
alarm to clear.
LL_LIM REAL The value (in engineering units) 0 True
to 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 T#0MS False 0 to
must reach or exceed the Low 24d20h31m23
Low limit to trip an alarm. s647ms
LL_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the Low Low limit 24d20h31m23
and deadband to cause the s647ms
alarm to clear.
IR_LIM REAL The value (in engineering units 0 True
per 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.
IR_DELAYIN TIME The amount of time the input T#0MS False 0 to
must reach or exceed the 24d20h31m23
Increasing Rate of Change limit s647ms
to trip an alarm.
IR_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the Increasing 24d20h31m23
Rate of Change limit and s647ms
deadband to cause the alarm to
clear.

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

2-74 A5E00595270-01
 Library Function Blocks

Name Data Explanation Initial OC& Valid Values

Type M
DR_LIM REAL The value (in engineering units 0 True
per 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 T#0MS False 0 to
must reach or exceed the 24d20h31m23
Decreasing Rate of Change limit s647ms
to trip an alarm.
DR_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the Decreasing 24d20h31m23
Rate of Change limit and s647ms
deadband to cause the alarm to
clear.
AR_LIM REAL The value (in engineering units 0 True
per 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 T#0MS False 0 to
must reach or exceed the 24d20h31m23
Absolute Rate of Change limit to s647ms
trip an alarm.
AR_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the Absolute 24d20h31m23
Rate of Change limit and s647ms
deadband to cause the alarm to
clear.
OOR_DELAYIN TIME The amount of time the input T#0MS False 0 to
must be outside the limits EINH, 24d20h31m23
EINL to trip the Out of Range s647ms
alarm.
OOR_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the limits EINH, 24d20h31m23
EINL to cause the Out of Range s647ms
alarm to clear.
QUAL_DELAYIN TIME The amount of time the input T#0MS False 0 to
quality must be bad to trip the 24d20h31m23
Quality Not Good alarm. s647ms
QUAL_DELAYOUT TIME The amount of time the input T#0MS False 0 to
quality must be good to cause 24d20h31m23
the Quality Not Good alarm to s647ms
clear.
DISABLE_ON_OOS BOOL When set to TRUE, the block is False False
disabled if (OOS) is also TRUE.

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

A5E00595270-01 2-75
Library Function Blocks

2.11 MOTOR_A_AFB

2.11.1 MOTOR_A_AFB: Standard Motor

Function Block Name MOTOR_A_AFB
Function Block Number FB505

Function
The Standard Motor Function Block (MOTOR_A_AFB) 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:
x 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.
x 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.
x 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).

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

2-76 A5E00595270-01
 Library Function Blocks

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 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:
x Failure to start before the STRT_T has expired
x Failure to stop before the STOP_T has expired
x Loss of proof
x Uncommanded stop due to loss of an interlock (enabled by setting the
FAIL_ON_INTRLK value to TRUE)
x 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_AFB 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:
x Connect a boolean interlock condition to the Interlock input.
x 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.

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

A5E00595270-01 2-77
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). 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

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

2-78 A5E00595270-01
 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 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

2.11.1.1 MOTOR_A_AFB Input Output

Input

Name Data Type Explanation Initial OC& Valid

M Values
PROOF BOOL Running status False True
feedback signal from
the motor
A_STRT BOOL Automatic Start False False
command input
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. 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

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

A5E00595270-01 2-79
Library Function Blocks

Name Data Type Explanation Initial OC& Valid

M Values
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, 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
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 BOOL Init restart value for False False
OUT if
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 '' True
Description
INT11_DESC STRING[32] Interlock 11 '' True
Description
EV_ID DWORD Event ID (Compiler False
generated)
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
BA_EN BOOL Batch enabled False True
OCCUPIED BOOL Batch occupied False True
BA_ID DWORD Batch ID number 0 True

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

2-80 A5E00595270-01
 Library Function Blocks

Name Data Type Explanation Initial OC& Valid

M Values
STEP_NO DWORD Batch step number 0 True
BA_NA STRING[32] Batch name ‘‘ True
ConfirmChange BOOL If TRUE changes from False True
HMI must be confirmed

Note

This list differs from the inputs of the MOTOR_A_AFB block in APACS+ as follows:
x Each input shown above with datatype STRING was a softlist parameter in APACS+.
x 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.
x 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+.
x Restart parameters (RSTRT_... ) did not exist in APACS+.
x LIOP_MAN_SEL and AUT_L added to provide alternate for SET_VAL function.
x Batch parameters BA_EN, OCCUPIED are added to support future batch faceplate
view.
x Batch parameters BA_NA, BA_ID, STEP_NO are added to pass batch values in alarm
messages.
x ConfirmChange added to give APACS+ users expected feel of "one-step" operator
entry

Output

Name Data Explanation Initial OC&M Valid Values

Type
OUT BOOL The block’s Output that is used to False True
ultimately control the motor.
ALARM BOOL Indicates when the motor is in False False
alarm.
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:
x FAIL and AUTO and OVERRD have been moved to In/Out in PCS 7.
x ALARM_STATE is a new output. In APACS+, it was a softlist parameter.
x 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+.
x INTRLK nub is named INT_OK in APACS+. The ProcessSuite name "INTRLK" was
preferred.

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

A5E00595270-01 2-81
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 False False False False False
not OK

"<>" 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

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

2-82 A5E00595270-01
 Library Function Blocks

Input/output

Name Data Explanation Initial OC&M Valid

Type Values
FAIL BOOL Indicates whether motor has False True
fault condition
AUTO BOOL Auto mode output False True
OVERRD BOOL Override output False True
AUTO_TRACK BOOL If true, block is set to auto False False
mode when SFC transitions to
AUTO (MODE becomes
"True").
MODE_HOLD_AUTO BOOL Indicates whether block held in False False
auto mode while MODE is
"True"
ACCEPT_ANY_AUTO BOOL When true, block is set to auto False False
when A_STRT or A_STOP
changes state
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 True False
A_STOP inputs need to
change state to issue
start/stop
FAIL_ON_INTRLK BOOL Fail on interlock. When TRUE False False
and 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 False False
TRUE 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 False True
manual mode
STOP BOOL Stop command value for False True
manual mode
STRT_T TIME Maximum time allowed to start T#10S True
the motor
STOP_T TIME Maximum time allowed to stop T#10S True
the motor
A1EN BOOL Alarm 1 Enable True True
A1LIM BOOL Alarm 1 Limit True False

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

A5E00595270-01 2-83
Library Function Blocks

Name Data Explanation Initial OC&M Valid

Type Values
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
OOS BOOL Out of Service indicator False True
DISABLE_ON_OOS BOOL Disable on Out of Service False False

Note

This list differs from the softlist parameters of the MOTOR_A_AFB block in
APACS+ as follows:
x 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.
x ALARM_STATE was moved to Output.
x 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..
x INT01_DESC through INT10_DESC and PERMIT_DESC have been moved to Inputs.
x STRT_T and STOP_T are named START_T and STOP_T in APACS+. The
ProcessSuite names STRT_T and STOP_T are preferred.
x The following alarm parameters are new: A1EN, A1LIM, A1DELAYIN, A1DELAYOUT,
OOS, DISABLE_ON_OOS. These are needed to support the alarming functionality.

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

2-84 A5E00595270-01
 Library Function Blocks

2.12 MOTOR_A_ALM_AFB

2.12.1 MOTOR_A_ALM: Motor with Alarm

Function Block Name MOTOR_A_ALM_AFB
(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_AFB block with
a discrete alarm block. To provide thorough alarm reporting, the alarm state value
of the MOTOR_A_AFB block is used to create separate alarms for the following
conditions:
x Failure to start (or loss of proof)
x Failure to stop (or unexpected proof)
x Uncommanded stop or rejected start command (due to interlock)
The latched fail state of the MOTOR_A_AFB block is unlatched automatically when
the alarm is acknowledged.
The parameters are generally identically to those of the MOTOR_A_AFB block.
See MOTOR_A_AFB 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

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

A5E00595270-01 2-85
Library Function Blocks

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:
x Connect a boolean interlock condition to the Interlock input.
x 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.

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

2-86 A5E00595270-01
 Library Function Blocks

Message # Message Class Default Message Text

1 PLC Process Control Message - Failure to start - $$BlockComment$$
Failure
2 PLC Process Control Message - Failure to stop - $$BlockComment$$
Failure
3 PLC Process Control Message - Uncommanded stop or rejected start command
Failure (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

2.12.1.1 MOTOR_A_ALM_AFB Input Output

Input

Name Data Type Explanation Initial OC&M Valid

Values
PROOF BOOL Running status False True
feedback signal
from the motor
A_STRT BOOL Automatic Start False False
command input
A_STOP BOOL Automatic Stop False False
command input
PERMIT BOOL Permitted to Start True True
input
MODE BOOL Mode input from False False
of a 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

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

A5E00595270-01 2-87
Library Function Blocks

Name Data Type Explanation Initial OC&M Valid

Values
PERMIT_DESC STRING[32] Permit '' True
Description
INT01_DESC STRING[32] Interlock 1 '' True
Description
INT02_DESC STRING[32] Interlock 2 '' True
Description
INT03_DESC STRING[32] Interlock 3 '' True
Description
INT04_DESC STRING[32] Interlock 4 '' True
Description
INT05_DESC STRING[32] Interlock 5 '' True
Description
INT06_DESC STRING[32] Interlock 6 '' True
Description
INT07_DESC STRING[32] Interlock 7 '' True
Description
INT08_DESC STRING[32] Interlock 8 '' True
Description
INT09_DESC STRING[32] Interlock 9 '' True
Description
INT10_DESC STRING[32] Interlock 10 '' True
Description
INT11_DESC STRING[32] Interlock 11 '' True
Description
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 False True
indicator
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 False True
WS, Use load val
on CS. Force:
Use
RSTRT_AUTO_V
ALUE on restart
RSTRT_AUTO_VALUE BOOL Init restart value False False
for Auto Mode if
RSTRT_AUTO_F
LAG true
RSTRT_OUT_FLAG BOOL Default retain on False True
WS, Use load val
on CS. Force:
Use
RSTRT_AUTO_V
ALUE on restart

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

2-88 A5E00595270-01
 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid

Values
RSTRT_OUT_VALUE BOOL Init restart value False False
for OUT if
RSTRT_OUT_FL
AG 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 0 True
number
ConfirmChange BOOL If TRUE changes False True
from 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

Output

Name Data Explanation Initial OC&M Valid

Type Values
OUT BOOL Output used to ultimately control the False True
motor
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
ALM1 BOOL Alarm 1 False False
ALM2 BOOL Alarm 2 False False
ALM3 BOOL Alarm 3 False False
ALM4 BOOL Alarm 4 False False

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

A5E00595270-01 2-89
Library Function Blocks

Input/output

Name Data Explanation Initial OC&M Valid

Type Values
FAIL BOOL Indicates whether motor has False True
fault condition
AUTO BOOL Auto mode output False True
OVERRD BOOL Override output False True
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 required to start T#10S True
the motor
STOP_T TIME Maximum time required to stop T#10S True
the motor
AUTO_TRACK BOOL If true, block is set to auto mode False False
when SFC transitions to AUTO
MODE_HOLD_AUTO BOOL Indicates whether block held in False False
auto mode
ACCEPT_ANY_AUTO BOOL When true, block is set to auto False False
when A_S TRT or A_STOP
changes state
POS_TRANS_ASTOP BOOL Indicates whether a positive False False
transition is required to stop the
motor
AUTO_TRANS_REQ BOOL When true the A_STRT and False False
A_STOP 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
24d20h3
1m23s64
7ms
A1DELAYOUT TIME Out of Alarm 1 Delay Time T#0MS False 0 to
24d20h3
1m23s64
7ms
A2LIM BOOL Alarm 2 Limit True False
A2DELAYIN TIME Into Alarm 2 Del ay Time T#0MS False 0 to
24d20h3
1m23s64
7ms
A2DELAYOUT TIME Out of Alarm 2 Delay Time T#0MS False 0 to
24d20h3
1m23s64
7ms
A3LIM BOOL Alarm 3 Limit True False

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

2-90 A5E00595270-01
 Library Function Blocks

Name Data Explanation Initial OC&M Valid

Type Values
A3DELAYIN TIME Into Alarm 3 Delay Time T#0MS False 0 to
24d20h3
1m23s64
7ms
A3DELAYOUT TIME Out of Alarm 3 Delay Time T#0MS False 0 to
24d20h3
1m23s64
7ms
A4LIM BOOL Alarm 4 Limit True False
A4DELAYIN TIME Into Alarm 4 Delay Time T#0MS False 0 to
24d20h3
1m23s64
7ms
A4DELAYOUT TIME Out of Alarm 4 Delay Time T#0MS False 0 to
24d20h3
1m23s64
7ms
DISABLE_ON_OOS BOOL Disable on Out of Service False False

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

A5E00595270-01 2-91
Library Function Blocks

2.13 MOTOR_1OUT_AFB

2.13.1 MOTOR_1OUT: Motor with One Output

Function Block Name MOTOR_1OUT_AFB

(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, 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

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

2-92 A5E00595270-01
 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 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.

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

A5E00595270-01 2-93
Library Function Blocks

Message # 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

2.13.1.1 MOTOR_1OUT_AFB 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
A_STRT BOOL A_STRT is False False
intended to allow
internal logic to
automatically start
the motor
A_STOP BOOL A_STOP is False False
intended to 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 False True
WS, Use load val
on CS. Force: Use
RSTRT_AUTO_VA
LUE on restart
RSTRT_AUTO_VALUE BOOL Init restart value for False False
Auto Mode if
RSTRT_AUTO_FL
AG true

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

2-94 A5E00595270-01
 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid

Values
RSTRT_OUT_FLAG BOOL Default retain on False True
WS, Use load val
on CS. Force: Use
RSTRT_AUTO_VA
LUE on restart
RSTRT_OUT_VALUE BOOL Init restart value for False False
OUT if
RSTRT_OUT_FLA
G true
EV_ID DWORD Event ID Compiler False
generated
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
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 False True
from HMI must be
confirmed

Note

This list differs from the inputs of the MOTOR_1OUT_AFB block in APACS+ as
follows:

x Restart parameters (RSTRT_...) did not exist in APACS+.

x 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
ALARM BOOL ALARM is used to signal internal False False
logic when the Motor is in alarm
FAIL BOOL FAIL motor failed to start or stop False True
after a start or stop request
START_FAIL BOOL START_FAIL is used to indicate if False False
the motor failed to start

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

A5E00595270-01 2-95
Library Function Blocks

Input/output

Name Data Explanation Initial OC&M Valid Values

Type
AUTO BOOL AUTO set auto mode (use False True
A_STRT, A_STOP) vs manual
mode (use START, STOP)
A1EN BOOL A1EN is used to enable /disable True True
the internal alarm
A1LIM BOOL Alarm 1 limit True False
A1DELAYIN TIME Into alarm 1 delay time T#0M False 0 to
S 24d20h31m2
3s647ms
A1DELAYOUT TIME Out of alarm 1 delay time T#0M False 0 to
S 24d20h31m2
3s647ms
OOS BOOL OOS is used to signal that the False True
internal alarm is Out Of Service
DISABLE_ON_OOS BOOL Disable on Out of Service False False
START BOOL START is used to start the False True
motor when in Manual mode
(AUTO=false)
STOP BOOL STOP is used to stop the motor False True
when 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 T#10S True
PROOF to go false

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

2-96 A5E00595270-01
 Library Function Blocks

2.14 MOTOR_2OUT_AFB

2.14.1 MOTOR_2OUT: Motor with Two Outputs

Function Block Name MOTOR_2OUT_AFB
(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).

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

A5E00595270-01 2-97
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 Default Message Text

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

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

2-98 A5E00595270-01
 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

2.14.1.1 MOTOR_2OUT_AFB 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
A_STRT BOOL A_STRT is False False
intended to allow
internal logic to
automatically start
the motor
A_STOP BOOL A_STOP is False False
intended to 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 False True
WS, Use load val
on CS. Force: Use
RSTRT_AUTO_VA
LUE on restart
RSTRT_AUTO_VALUE BOOL Init restart value for False False
Auto Mode if
RSTRT_AUTO_FL
AG true
EV_ID DWORD Event ID Compiler False
generated
LIOP_MAN_SEL BOOL Select False False
AUTO/MANUAL:
1 = Linking, 0 =
Operator active

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

A5E00595270-01 2-99
Library Function Blocks

Name Data Type Explanation Initial OC&M Valid

Values
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 False True
from HMI must be
confirmed

Note

This list differs from the inputs of the MOTOR_2OUT_AFB block in APACS+ as
follows:

x Restart parameters (RSTRT_...) did not exist in APACS+.

x EV_ID and SAMPLE_T did not exist in APACS+.

Output

Name Data Explanation Initial OC&M Valid

Type Values
STRT_O BOOL STRT_O is used to actuate the motor False False
start
STOP_O BOOL STOP_O is used to actuate the motor False False
stop
ALARM BOOL ALARM is used to signal internal logic False False
when the Motor is in alarm
FAIL BOOL FAIL motor failed to start or stop after a False True
start or stop request
OUT BOOL OUT is used to let the OS 'see' the False True
internal START_LATCH coil
START_FAIL BOOL START_FAIL is used to indicate if the False False
motor failed to start

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

2-100 A5E00595270-01
 Library Function Blocks

Input/output

Name Data Explanation Initial OC&M Valid

Type Values
AUTO BOOL AUTO set auto mode (use False True
A_STRT, A_STOP) vs manual
mode (use START, STOP)
A1EN BOOL A1EN is used to enable /disable True True
the internal alarm
A1LIM BOOL True True
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
OOS BOOL OOS is used to signal that the True False
internal 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 True False
when in Manual mode
(AUTO=false)
STOP BOOL STOP is used to stop the motor True False
when 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 T#10S True
PROOF to go false

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

A5E00595270-01 2-101
Library Function Blocks

2.15 PID_AFB

2.15.1 PID_AFB: Proportional-Integral-Derivative

Function Block Name PID_AFB
Function Block Number FB501

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.

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

2-102 A5E00595270-01
 Library Function Blocks

2.15.1.1 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, False False
the block is in a tracking mode
[OUT=FDBK].
INIT BOOL Transitions of the INIT input cause the False False
initialization equation to be performed.
SAMPLE_T REAL Current scan rate supplied by False
compiler

Note

This list differs from the inputs of the PID_AFB block in APACS+ as follows:
x 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 - 0 False
3.3 to +103.3% of range EOUTL to
EOUTH.
ERR REAL Error output [(PV) – (SP)]. False

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

A5E00595270-01 2-103
Library Function Blocks

Input/output

Name Data Explanation Initial OC&M Valid Values

Type
PG REAL Proportional Gain 0.001 True 0.001 to
100.0
TI REAL Time-Integral Minutes per 4000.0 True 0.0 to 4000.0
Reset
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, 0 True
Low
EOUTH REAL Engineering unit: Output, 100.0 True
High
ADAPTIVE_PG_INT BOOL Adaptive Gain Init flag True False

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

2-104 A5E00595270-01
 Library Function Blocks

2.16 PRIMARY_AFB

2.16.1 PRIMARY: Primary Controller

Function Block Name PRIMARY_AFB
(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_AFB) 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_AFB block is designed to be
used with the SECONDARY_AFB 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

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

A5E00595270-01 2-105
Library Function Blocks

desired forced value. The RSTRT_SP_VALUE will be used to initialize SP, if the
RSTRT_SP_FLAG is true and either
x The block is forced to start in Auto mode, or
x 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.

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

2-106 A5E00595270-01
 Library Function Blocks

ALARM_8P ID Message # 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@
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@ 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

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

A5E00595270-01 2-107
Library Function Blocks

2.16.1.1 PRIMARY_AFB Input Output

Input

Name Data Explanation Initial OC&M Valid

Type Values
PV REAL Process Variable 0 True
FDBK REAL Controller tracks feedback 0 False
when (AUTO=FALSE) or
(CASC_S=FALSE)
CASC_S BOOL Secondary cascade False False
status
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 True True
Deviation 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 False True
of 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 DW#16# False
5
EV_ID2 DWORD Event ID DW#16# False
6
SAMPLE_T REAL Scan Rate. Use only 0.1 False
when compiling CFC as
block type.

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

2-108 A5E00595270-01
 Library Function Blocks

Name Data Explanation Initial OC&M Valid

Type Values
RSTRT_AUTO_FLAG BOOL Default: Retain on WS, True False
Use load value 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
RSTRT_SP_FLAG BOOL Default: Retain on WS, False False
Use load 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, True False
Use load value on CS.
Force: Use
RSTRT_OUT_VALUE on
restart.
RSTRT_OUT_VALUE REAL Init restart value for OUT 0 False
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[ Batch name ‘‘ True
32]
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 False True
HMI 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 = 0 False
from Link, 0 = from
Operator
SP_L REAL Linkable input for internal 0.0 False
Setpoint

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

A5E00595270-01 2-109
Library Function Blocks

Name Data Explanation Initial OC&M Valid

Type Values
LIOP_OUT_SEL BOOL Select writing to OUT: 1 = 0 False
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 PRIMARY_AFB block in
APACS+. In APACS+, only the PV, FDBK and CASC_S inputs are present.

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

2-110 A5E00595270-01
 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
ALARM BOOL Alarm Status False False
SS BOOL Secondary Standby flag True True
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 False False
Deviation alarm is detected and
enabled.
LD_ALM BOOL When TRUE, the Low False False
Deviation 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_AL BOOL When TRUE, the Quality Not False False
M 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 False False
Rate of Change alarm is
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.

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

A5E00595270-01 2-111
Library Function Blocks

Input/output

Name Data Explanation Initial OC&M Valid

Type 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
24d20h31m
23s647ms
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 0 True
written to by an operator
command
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) 100 True
to which the (PV) input is
compared for the High alarm.
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 T#0MS False 0 to
must reach or exceed the High 24d20h31m
limit to trip an alarm. 23s647ms

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

2-112 A5E00595270-01
 Library Function Blocks

Name Data Explanation Initial OC&M Valid

Type Values
H_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the High limit and 24d20h31m
deadband to cause the alarm to 23s647ms
clear.
L_LIM REAL The value (in engineering units) 0 True
to 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 T#0MS False 0 to
must reach or exceed the Low 24d20h31m
limit to trip an alarm. 23s647ms
L_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the Low limit and 24d20h31m
deadband to cause the alarm to 23s647ms
clear.
HD_LIM REAL The value (in engineering units) 0 True
to 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 T#0MS False 0 to
must reach or exceed the High 24d20h31m
Deviation limit to trip an alarm. 23s647ms
HD_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the High 24d20h31m
Deviation limit and deadband to 23s647ms
cause the alarm to clear.
LD_LIM REAL The value (in engineering units) 0 True
to 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 T#0MS False 0 to
must reach or exceed the Low 24d20h31m
Deviation limit to trip an alarm. 23s647ms
LD_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the Low 24d20h31m
Deviation limit and deadband to 23s647ms
cause the alarm to clear.
AD_LIM REAL The value (in engineering units) 100 True
to which ABS((PV) – (DEV)) is
compared for the Absolute
Deviation alarm.

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

A5E00595270-01 2-113
Library Function Blocks

Name Data Explanation Initial OC&M Valid

Type Values
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 T#0MS False 0 to
must reach or exceed the 24d20h31m
Absolute Deviation limit to trip 23s647ms
an alarm.
AD_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the Absolute 24d20h31m
Deviation limit and deadband to 23s647ms
cause the alarm to clear.
HH_LIM REAL The value (in engineering units) 0 True
to 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 T#0MS False 0 to
must reach or exceed the High 24d20h31m
High limit to trip an alarm. 23s647ms
HH_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the High High 24d20h31m
limit and deadband to cause the 23s647ms
alarm to clear.
LL_LIM REAL The value (in engineering units) 0 True
to 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 T#0MS False 0 to
must reach or exceed the Low 24d20h31m
Low limit to trip an alarm. 23s647ms
LL_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the Low Low limit 24d20h31m
and deadband to cause the 23s647ms
alarm to clear.
IR_LIM REAL The value (in engineering units 0 True
per 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.

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

2-114 A5E00595270-01
 Library Function Blocks

Name Data Explanation Initial OC&M Valid

Type Values
IR_DELAYIN TIME The amount of time the input T#0MS False 0 to
must reach or exceed the 24d20h31m
Increasing Rate of Change limit 23s647ms
to trip an alarm.
IR_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the Increasing 24d20h31m
Rate of Change limit and 23s647ms
deadband to cause the alarm to
clear.
DR_LIM REAL The value (in engineering units 0 True
per 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 T#0MS False 0 to
must reach or exceed the 24d20h31m
Decreasing Rate of Change limit 23s647ms
to trip an alarm.
DR_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the Decreasing 24d20h31m
Rate of Change limit and 23s647ms
deadband to cause the alarm to
clear.
AR_LIM REAL The value (in engineering units 0 True
per 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 T#0MS False 0 to
must reach or exceed the 24d20h31m
Absolute Rate of Change limit to 23s647ms
trip an alarm.
AR_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the Absolute 24d20h31m
Rate of Change limit and 23s647ms
deadband to cause the alarm to
clear.
OOR_DELAYIN TIME The amount of time the input T#0MS False 0 to
must be outside the limits EINH, 24d20h31m
EINL to trip the Out of Range 23s647ms
alarm.
OOR_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the limits EINH, 24d20h31m
EINL to cause the Out of Range 23s647ms
alarm to clear.

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

A5E00595270-01 2-115
Library Function Blocks

Name Data Explanation Initial OC&M Valid

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

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

2-116 A5E00595270-01
 Library Function Blocks

2.17 RATIO_SET_AFB

2.17.1 RATIO_SET: Ratio Setpoint Controller

Function Block Name RATIO_SET_AFB
(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_AFB) 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_AFB 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. 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.

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

A5E00595270-01 2-117
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). 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 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.

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

2-118 A5E00595270-01
 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

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 -
Control Message - $$BlockComment$$
Failure
EV_ID2 1 Alarm - above HIGH_ HIGH - $$BlockComment$$ - Limit =
@4%f@

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

A5E00595270-01 2-119
Library Function Blocks

ALARM_8P ID Message # Message Class Default Message Text

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

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

2-120 A5E00595270-01
 Library Function Blocks

2.17.1.1 RATIO_SET_AFB Input Output

Input

Name Data Type Explanation Initial OC&M Valid

Values
PV REAL Process Variable 0 True
RAT_INP REAL External Input. 0 True
Ratio thereof sets
loop's setpoint
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
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 DW#16#5 False
EV_ID2 DWORD Event ID DW#16#6 False
SAMPLE_T REAL Current scan rate 0.1 False
supplied by OS
RSTRT_AUTO_FLAG BOOL Default: Retain on True False
WS, Use load value
on CS. Force: Use
RSTRT_AUTO_VAL
UE on restart

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

A5E00595270-01 2-121
Library Function Blocks

Name Data Type Explanation Initial OC&M Valid

Values
RSTRT_AUTO_VALUE BOOL Init restart value for False False
Auto Mode if
RSTRT_AUTO_FLA
G true
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_RAT_DES_FLAG BOOL Default: Retain on False False
WS, Use load value
on CS. Force: Use
RSTRT_OUT_VALU
E on restart.
RSTRT_RAT_DES_VALUE REAL Init restart value for 0 False
RAT_DES if
RSTRT_ RAT_DES
_FLAG true.
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

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

2-122 A5E00595270-01
 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid

Values
DecimalPlacesRATIO INT Decimal places 2 True
displayed in HMI for
RAT_ACT,
RAT_DES
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
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
LIOP_RATIO_SEL BOOL Select desired ratio: 0 False
1 = from Link, 0 =
from Operator
RAT_DES_L REAL Linkable input for 0.0 False
desired ratio

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

A5E00595270-01 2-123
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
RAT_ACT REAL Actual Ratio Value. Quotient of 0 True
PV and RAT_INP subject to
limits
DESRAT REAL Desired ratio of PV to 0 False
RAT_INP
ALARM BOOL Alarm Status False False
ESP REAL External set point 0 True
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 False False
Deviation alarm is detected
and enabled.
LD_ALM BOOL When TRUE, the Low False False
Deviation 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 False False
Rate of Change alarm is
detected and enabled.
VL_EUMIN_OUT REAL Copy of Engineering unit: 0 False
Output, Low
VL_EUMAX_OUT REAL Copy of Engineering unit: 0 False
Output, High

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

2-124 A5E00595270-01
 Library Function Blocks

Input/output

Name Data Explanation Initial OC&M Valid

Type 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
24d20h31m
23s647ms
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 0 True
written to by an operator
command
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) 100 True
to which the (PV) input is
compared for the High alarm.
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 T#0MS False 0 to
must reach or exceed the High 24d20h31m
limit to trip an alarm. 23s647ms

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

A5E00595270-01 2-125
Library Function Blocks

Name Data Explanation Initial OC&M Valid

Type Values
H_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the High limit and 24d20h31m
deadband to cause the alarm to 23s647ms
clear.
L_LIM REAL The value (in engineering units) 0 True
to 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 T#0MS False 0 to
must reach or exceed the Low 24d20h31m
limit to trip an alarm. 23s647ms
L_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the Low limit and 24d20h31m
deadband to cause the alarm to 23s647ms
clear.
HD_LIM REAL The value (in engineering units) 0 True
to 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 T#0MS False 0 to
must reach or exceed the High 24d20h31m
Deviation limit to trip an alarm. 23s647ms
HD_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the High 24d20h31m
Deviation limit and deadband to 23s647ms
cause the alarm to clear.
LD_LIM REAL The value (in engineering units) 0 True
to 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 T#0MS False 0 to
must reach or exceed the Low 24d20h31m
Deviation limit to trip an alarm. 23s647ms
LD_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the Low Deviation 24d20h31m
limit and deadband to cause the 23s647ms
alarm to clear.
AD_LIM REAL The value (in engineering units) 100 True
to which ABS((PV) – (DEV)) is
compared for the Absolute
Deviation alarm.

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

2-126 A5E00595270-01
 Library Function Blocks

Name Data Explanation Initial OC&M Valid

Type Values
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 T#0MS False 0 to
must reach or exceed the 24d20h31m
Absolute Deviation limit to trip an 23s647ms
alarm.
AD_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the Absolute 24d20h31m
Deviation limit and deadband to 23s647ms
cause the alarm to clear.
HH_LIM REAL The value (in engineering units) 0 True
to 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 T#0MS False 0 to
must reach or exceed the High 24d20h31m
High limit to trip an alarm. 23s647ms
HH_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the High High 24d20h31m
limit and deadband to cause the 23s647ms
alarm to clear.
LL_LIM REAL The value (in engineering units) 0 True
to 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 T#0MS False 0 to
must reach or exceed the Low 24d20h31m
Low limit to trip an alarm. 23s647ms
LL_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the Low Low limit 24d20h31m
and deadband to cause the 23s647ms
alarm to clear.
IR_LIM REAL The value (in engineering units 0 True
per 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.

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

A5E00595270-01 2-127
Library Function Blocks

Name Data Explanation Initial OC&M Valid

Type Values
IR_DELAYIN TIME The amount of time the input T#0MS False 0 to
must reach or exceed the 24d20h31m
Increasing Rate of Change limit 23s647ms
to trip an alarm.
IR_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the Increasing 24d20h31m
Rate of Change limit and 23s647ms
deadband to cause the alarm to
clear.
DR_LIM REAL The value (in engineering units 0 True
per 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 T#0MS False 0 to
must reach or exceed the 24d20h31m
Decreasing Rate of Change limit 23s647ms
to trip an alarm.
DR_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the Decreasing 24d20h31m
Rate of Change limit and 23s647ms
deadband to cause the alarm to
clear.
AR_LIM REAL The value (in engineering units 0 True
per 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 T#0MS False 0 to
must reach or exceed the 24d20h31m
Absolute Rate of Change limit to 23s647ms
trip an alarm.
AR_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the Absolute Rate 24d20h31m
of Change limit and deadband to 23s647ms
cause the alarm to clear.
OOR_DELAYIN TIME The amount of time the input T#0MS False 0 to
must be outside the limits EINH, 24d20h31m
EINL to trip the Out of Range 23s647ms
alarm.
OOR_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the limits EINH, 24d20h31m
EINL to cause the Out of Range 23s647ms
alarm to clear.

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

2-128 A5E00595270-01
 Library Function Blocks

Name Data Explanation Initial OC&M Valid

Type Values
QUAL_DELAYIN TIME The amount of time the input T#0MS False 0 to
quality must be bad to trip the 24d20h31m
Quality Not Good alarm. 23s647ms
QUAL_DELAYOUT TIME The amount of time the input T#0MS False 0 to
quality must be good to cause 24d20h31m
the Quality Not Good alarm to 23s647ms
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

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

A5E00595270-01 2-129
Library Function Blocks

2.18 SECONDARY_AFB

2.18.1 SECONDARY: Secondary Controller

Function Block Name SECONDARY_AFB
(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_AFB) 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_AFB block is designed to
be used with the PRIMARY_AFB 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_AFB 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).

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

2-130 A5E00595270-01
 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, 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.

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

A5E00595270-01 2-131
Library Function Blocks

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

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 -
Control Message - $$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@

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

2-132 A5E00595270-01
 Library Function Blocks

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

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

A5E00595270-01 2-133
Library Function Blocks

2.18.1.1 SECONDARY_AFB Input Output

Input

Name Data Type Explanation Initial OC&M Valid

Values
PV REAL Process Variable 0 True
ESP REAL External Setpoint (output 0 True
from primary controller)
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
QBAD BOOL Bad quality indicator False False
EV_ID DWORD Event ID DW#16 False
#5
EV_ID2 DWORD Event ID DW#16 False
#6
SAMPLE_T REAL Scan Rate. Use only 0.1 False
when compiling CFC as
block type.
RSTRT_AUTO_FLAG BOOL Default: Retain on WS, True False
Use load value 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

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

2-134 A5E00595270-01
 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid

Values
RSTRT_EXT_FLAG BOOL Default: Retain on WS, True False
Use load value on CS.
Force: Use
RSTRT_EXT_VALUE 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 WS, False False
Use load 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_OUT_FLAG BOOL Default: Retain on WS, True False
Use load 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 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 False True
HMI 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 = 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

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

A5E00595270-01 2-135
Library Function Blocks

Name Data Type Explanation Initial OC&M Valid

Values
OUT_L REAL Linkable input to be written 0.0 False
to OUT

Note

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

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

2-136 A5E00595270-01
 Library Function Blocks

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 0 False
has been limited
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 alarm False False
is detected and enabled.
LL_ALM BOOL When TRUE, the Low Low alarm False False
is detected and enabled.
IR_ALM BOOL When TRUE, the Increasing Rate False False
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

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.

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

A5E00595270-01 2-137
Library Function Blocks

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 False True
control
R_TIME TIME Ramp time T#0MS True 0 to
24d20h31m
23s647ms
SPL REAL Set point low limit 0 True
SPH REAL Set point high limit 100 True
R_RATE REAL Ramp rate (in engineering 0 True
units per min)
USE_RR BOOL Ramp mode control. Use False True
RTIME or RRATE to control
ramp
PV_TRACK BOOL Internal setpoint tracking True True
control. When Track, internal
setpoint tracks PV
PG REAL Proportional Gain 0.001 True 0.001 to
100.0
TI REAL Time-Integral Minutes per 4000 True 0.0 to
Reset 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, 100 True
High
VL REAL Computer Output, typically 0 True
written to by an operator
command
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 100 True
units) to which the (PV) input
is compared for the High
alarm.
H_DB REAL The amount of engineering 0.5 True
units by which (PV) must be
within the limit for the High
alarm to clear.

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

2-138 A5E00595270-01
 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid

Values
H_DELAYIN TIME The amount of time the input T#0MS False 0 to
must reach or exceed the 24d20h31m
High limit to trip an alarm. 23s647ms
H_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the High limit 24d20h31m
and deadband to cause the 23s647ms
alarm to clear.
L_LIM REAL The value (in engineering 0 True
units) to which the (PV) input
is compared for the Low
alarm.
L_DB REAL The amount of engineering 0.5 True
units by which (PV) must be
within the limit for the Low
alarm to clear.
L_DELAYIN TIME The amount of time the input T#0MS False 0 to
must reach or exceed the 24d20h31m
Low limit to trip an alarm. 23s647ms
L_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the Low limit 24d20h31m
and deadband to cause the 23s647ms
alarm to clear.
HD_LIM REAL The value (in engineering 0 True
units) to which (PV) – (DEV)
is compared for the High
Deviation alarm.
HD_DB REAL The amount of engineering 0.5 True
units 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 T#0MS False 0 to
must reach or exceed the 24d20h31m
High Deviation limit to trip an 23s647ms
alarm.
HD_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the High 24d20h31m
Deviation limit and deadband 23s647ms
to cause the alarm to clear.
LD_LIM REAL The value (in engineering 0 True
units) to which (DEV) - (PV)
is compared for the Low
Deviation alarm.
LD_DB REAL The amount of engineering 0.5 True
units 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 T#0MS False 0 to
must reach or exceed the 24d20h31m
Low Deviation limit to trip an 23s647ms
alarm.

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

A5E00595270-01 2-139
Library Function Blocks

Name Data Type Explanation Initial OC&M Valid

Values
LD_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the Low 24d20h31m
Deviation limit and deadband 23s647ms
to cause the alarm to clear.
AD_LIM REAL The value (in engineering 100 True
units) to which ABS((PV) –
(DEV)) is compared for the
Absolute Deviation alarm.
AD_DB REAL The amount of engineering 0.5 True
units 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 T#0MS False 0 to
must reach or exceed the 24d20h31m
Absolute Deviation limit to trip 23s647ms
an alarm.
AD_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the Absolute 24d20h31m
Deviation limit and deadband 23s647ms
to cause the alarm to clear.
HH_LIM REAL The value (in engineering 0 True
units) to which the (PV) input
is compared for the High
High alarm.
HH_DB REAL The amount of engineering 0.5 True
units by which (PV) must be
within the limit for the High
High alarm to clear.
HH_DELAYIN TIME The amount of time the input T#0MS False 0 to
must reach or exceed the 24d20h31m
High High limit to trip an 23s647ms
alarm.
HH_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the High High 24d20h31m
limit and deadband to cause 23s647ms
the alarm to clear.
LL_LIM REAL The value (in engineering 0 True
units) to which the (PV) input
is compared for the Low Low
alarm.
LL_DB REAL The amount of engineering 0.5 True
units by which (PV) must be
within the limit for the Low
Low alarm to clear.
LL_DELAYIN TIME The amount of time the input T#0MS False 0 to
must reach or exceed the 24d20h31m
Low Low limit to trip an 23s647ms
alarm.
LL_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the Low Low 24d20h31m
limit and deadband to cause 23s647ms
the alarm to clear.

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

2-140 A5E00595270-01
 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid

Values
IR_LIM REAL The value (in engineering 0 True
units per minute) to which the
(PV) input is compared for
the Increasing Rate of
Change alarm.
IR_DB REAL The amount of engineering 0.5 True
units by 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 T#0MS False 0 to
must reach or exceed the 24d20h31m
Increasing Rate of Change 23s647ms
limit to trip an alarm.
IR_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the Increasing 24d20h31m
Rate of Change limit and 23s647ms
deadband to cause the alarm
to clear.
DR_LIM REAL The value (in engineering 0 True
units per minute) to which the
(PV) input is compared for
the Decreasing Rate of
Change alarm.
DR_DB REAL The amount of engineering 0.5 True
units 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 T#0MS False 0 to
must reach or exceed the 24d20h31m
Decreasing Rate of Change 23s647ms
limit to trip an alarm.
DR_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the 24d20h31m
Decreasing Rate of Change 23s647ms
limit and deadband to cause
the alarm to clear.
AR_LIM REAL The value (in engineering 0 True
units per minute) to which the
(PV) input is compared for
the Absolute Rate of Change
alarm.
AR_DB REAL The amount of engineering 0.5 True
units 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 T#0MS False 0 to
must reach or exceed the 24d20h31m
Absolute Rate of Change 23s647ms
limit to trip an alarm.

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

A5E00595270-01 2-141
Library Function Blocks

Name Data Type Explanation Initial OC&M Valid

Values
AR_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the Absolute 24d20h31m
Rate of Change limit and 23s647ms
deadband to cause the alarm
to clear.
OOR_DELAYIN TIME The amount of time the input T#0MS False 0 to
must be outside the limits 24d20h31m
EINH, EINL to trip the Out of 23s647ms
Range alarm.
OOR_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the limits 24d20h31m
EINH, EINL to cause the Out 23s647ms
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 24d20h31m
Quality Not Good alarm. 23s647ms
QUAL_DELAYOUT TIME The amount of time the input T#0MS False 0 to
quality must be good to 24d20h31m
cause the Quality Not Good 23s647ms
alarm to clear.
DISABLE_ON_OOS BOOL When set to TRUE, the block False False
is disabled if (OOS) is also
TRUE.

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

2-142 A5E00595270-01
 Library Function Blocks

2.19 SETPNT_AFB

2.19.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:
x Internal setpoint (ISP)
x 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 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

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

A5E00595270-01 2-143
Library Function Blocks

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 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

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

2-144 A5E00595270-01
 Library Function Blocks

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.

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

A5E00595270-01 2-145
Library Function Blocks

2.19.1.1 SETPNT_AFB Input Output

Input

Name Data Explanation Initial OC&M Valid

Type Values
PV REAL Process Variable 0 False
ESP REAL External Setpoint 0 False
TARGET REAL Target value for setpoint 0 True
ramping
RSTRT_AUTO_FLAG BOOL Default: Retain on WS, Use load True False
val on CS. 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 True False
val on CS. 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 False False
val on CS. Force: Use
RSTRT_SP_VALUE on start
RSTRT_SP_VALUE REAL Init restart value for SP if 0 False
RSTRT_SP_FLAG true and
Auto mode

Note

This list differs from the inputs of the SETPNT_AFB block in APACS+ as follows:

x New parameters were added for restart functionality.

x 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)

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

2-146 A5E00595270-01
 Library Function Blocks

Note

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

Input/output

Name Data Explanation Initial OC&M Valid

Type 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 False True
as the 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

Note

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

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

A5E00595270-01 2-147
Library Function Blocks

2.20 SINGLE_LOOP_AFB

2.20.1 SINGLE_LOOP_AFB
Function Block Name SINGLE_LOOP_AFB
(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_AFB) 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_AFB 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
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

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

2-148 A5E00595270-01
 Library Function Blocks

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

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.

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

A5E00595270-01 2-149
Library Function Blocks

ALARM_8P ID Message # 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@
EV_ID 6 PLC Process OUT_OF_RANGE - $$BlockComment$$
Control Message -
Failure
EV_ID 7 PLC Process QUALITY_NOT_GOOD -
Control Message - $$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

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

2-150 A5E00595270-01
 Library Function Blocks

2.20.1.1 SINGLE_LOOP_AFB Input Output

Input

Name Data Type Explanation Initial OC&M Valid

Values
PV REAL Process Variable 0 True
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 True True
Deviation Alarm
OOR_EN BOOL Enable Out of Range False True
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 Alarm False True
IR_EN BOOL Enable Increasing Rate False True
of Change Alarm
DR_EN BOOL Enable Decreasing False True
Rate of Change Alarm
AR_EN BOOL Enable Absolute Rate False True
of 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
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*

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

A5E00595270-01 2-151
Library Function Blocks

Name Data Type Explanation Initial OC&M Valid

Values
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 WS, True False
Use load val on CS.
Force: Use
RSTRT_AUTO_VALVE
on restart
RSTRT_AUTO_VALVE BOOL Init restart value for False False
Auto 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 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
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[3 Batch name ‘‘ True
2]
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 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

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

2-152 A5E00595270-01
 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 0.0 False
internal Setpoint
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 OUT

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

A5E00595270-01 2-153
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
ALARM BOOL Alarm Status False False
H_ALM BOOL When TRUE, the High alarm False False
is detected and enabled.
L_ALM BOOL When TRUE, the Low alarm is False False
detected and enabled.
HD_ALM BOOL When TRUE, the High False False
Deviation alarm is detected
and enabled.
LD_ALM BOOL When TRUE, the Low False False
Deviation 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 False False
Range 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 False False
Rate of Change alarm is
detected and enabled.
VL_EUMIN_OUT REAL Copy of VL_EUMIN Input 0 True
VL_EUMAX_OUT REAL Copy of VL_EUMAX Input 0 True

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

2-154 A5E00595270-01
 Library Function Blocks

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

Type Values
AUTO BOOL Auto/manual mode control False True
SP REAL Computer set point value 0 True
RAMP BOOL SP ramping on/off mode False True
control
R_TIME TIME Ramp time T#0MS True 0 to
24d20h31m
23s647ms
SPL REAL Set point low limit 0 True
SPH REAL Set point high limit 100 True
R_RATE REAL Ramp rate (in engineering 0 True
units per min)
USE_RR BOOL Ramp mode control. Use False True
RTIME or RRATE to control
ramp
PV_TRACK BOOL Internal setpoint tracking True True
control. When Track, internal
setpoint tracks PV
PG REAL Proportional Gain 0.001 True 0.001 to
100.0
TI REAL Time-Integral Minutes per 4000 True 0.0 to
Reset 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, 0 True
Low
VL_EUMAX REAL Engineering unit: Output, 100 True
High
VL REAL Computer Output, typically 0 True
written to by an operator
command
VLL REAL OUT low limit input -3.3 True
VLH REAL OUT high limit input 103.3 True

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

A5E00595270-01 2-155
Library Function Blocks

Name Data Explanation Initial OC&M Valid

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

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

2-156 A5E00595270-01
 Library Function Blocks

Name Data Explanation Initial OC&M Valid

Type Values
LD_DB REAL The amount of engineering 0.5 True
units 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 T#0MS False 0 to
must reach or exceed the 24d20h31m
Low Deviation limit to trip an 23s647ms
alarm.
LD_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the Low 24d20h31m
Deviation limit and 23s647ms
deadband to cause the
alarm to clear.
AD_LIM REAL The value (in engineering 100 True
units) to which ABS((PV) –
(DEV)) is compared for the
Absolute Deviation alarm.
AD_DB REAL The amount of engineering 0.5 True
units 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 T#0MS False 0 to
must reach or exceed the 24d20h31m
Absolute Deviation limit to 23s647ms
trip an alarm.
AD_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the Absolute 24d20h31m
Deviation limit and 23s647ms
deadband to cause the
alarm to clear.
OOR_DELAYIN TIME The amount of time the input T#0MS False 0 to
must be outside the limits 24d20h31m
EINH, EINL to trip the Out of 23s647ms
Range alarm.
OOR_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the limits 24d20h31m
EINH, EINL to cause the Out 23s647ms
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 24d20h31m
the Quality Not Good alarm. 23s647ms
QUAL_DELAYOUT TIME The amount of time the input T#0MS False 0 to
quality must be good to 24d20h31m
cause the Quality Not Good 23s647ms
alarm to clear.
DISABLE_ON_OOS BOOL When set to TRUE, the False False
block is disabled if (OOS) is
also TRUE.

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

A5E00595270-01 2-157
Library Function Blocks

2.21 SINGLE_LP_SS_AFB

2.21.1 SINGLE_LP_SS: Single Loop Controller with Standby Sync

Function Block Name SINGLE_LP_SS_AFB
(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_AFB) 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_AFB 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 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

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

2-158 A5E00595270-01
 Library Function Blocks

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
x The block is forced to start in Auto mode, or
x 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.

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

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

A5E00595270-01 2-159
Library Function Blocks

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

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 -
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@ 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

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

2-160 A5E00595270-01
 Library Function Blocks

ALARM_8P ID Value Block Parameter

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

2.21.1.1 SINGLE_LP_SS_AFB Input Output

Input

Name Data Type Explanation Initial OC&M Valid

Values
PV REAL Process 0 True
Variable
EXTV REAL External 0 False
Variable input
SS BOOL Standby Sync False True
Command
INIT BOOL Transitions of False False
the INIT input
cause the
initialization
equation to be
performed.
TSP REAL SP target value 0 True
for SP ramping
H_EN BOOL Enable High True True
Alarm
L_EN BOOL Enable Low True True
Alarm
HD_EN BOOL Enable High False True
Deviation Alarm
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 False True
Not Good Alarm
HH_EN BOOL Enable High False True
High Alarm
LL_EN BOOL Enable Low Low False True
Alarm
IR_EN BOOL Enable False True
Increasing Rate
of Change Alarm

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

A5E00595270-01 2-161
Library Function Blocks

Name Data Type Explanation Initial OC&M Valid

Values
DR_EN BOOL Enable False True
Decreasing 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 False False
indicator
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 *
SAMPLE_T REAL Current scan Compiler False
rate supplied by generated for the
OS type or N/A if
used as chart *
RSTRT_AUTO_FLAG BOOL Default: Retain True False
on WS, Use
load val on CS.
Force: Use
RSTRT_AUTO_
VALUE
RSTRT_AUTO_VALUE BOOL Init restart value False False
for Auto Mode if
RSTRT_AUTO_
FLAG true
RSTRT_SP_FLAG BOOL Default: Retain False False
on WS, Use load
val on CS.
Force: Use
RSTRT_SP_VA
LUE on restart
RSTRT_SP_VALUE REAL Init restart value 0 False
for SP if
RSTRT_SP_FL
AG true and
Auto mode
RSTRT_OUT_FLAG BOOL Default: Retain True False
on WS, Use load
val on CS.
Force: Use
RSTRT_OUT_V
ALUE on restart.

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

2-162 A5E00595270-01
 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid

Values
RSTRT_OUT_VALUE REAL Init restart value 0 False
for OUT if
RSTRT_OUT_F
LAG 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 0 True
number
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 False True
changes from
HMI must be
confirmed
LIOP_MAN_SEL BOOL Select 0 False
AUTO/MANUAL:
1 = Linking, 0 =
Operator active
AUT_L BOOL Linkable input 0 False
for
AUTO/MANUAL
mode, 1 =
AUTO
LIOP_ ISP_SEL BOOL Select internal 0 False
SP: 1 = from
Link, 0 = from
Operator
SP_L REAL Linkable input 0.0 False
for internal
Setpoint
LIOP_OUT_SEL BOOL Select writing to 0 False
OUT: 1 = from
Link, 0 = from
Operator
OUT_L REAL Linkable input to 0.0 False
be written to
OUT

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

A5E00595270-01 2-163
Library Function Blocks

Note

This list differs significantly from the inputs of the SINGLE_LP_SS_AFB 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_AFB for this value to be automatically generated by
the compiler.

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

2-164 A5E00595270-01
 Library Function Blocks

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
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 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 alarm False False
is detected and enabled.
LL_ALM BOOL When TRUE, the Low Low alarm False False
is detected and enabled.
IR_ALM BOOL When TRUE, the Increasing Rate False False
of Change alarm is detected and
enabled.
DR_ALM BOOL When TRUE, the Decreasing Rate False False
of 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, 0 False
Low
VL_EUMAX_OUT REAL Copy of Engineering unit: Output, 0 False
High

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.

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

A5E00595270-01 2-165
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 False True
control
R_TIME TIME Ramp time T#0MS True 0 to
24d20h31m23
s647ms
SPL REAL Set point low limit 0 True
SPH REAL Set point high limit 100 True
R_RATE REAL Ramp rate (in engineering 0 True
units per min)
USE_RR BOOL Ramp mode control. Use False True
RTIME or RRATE to control
ramp
PV_TRACK BOOL Internal setpoint tracking True True
control. When Track, internal
setpoint tracks PV
PG REAL Proportional Gain 0.001 True 0.001 to 100.0
TI REAL Time-Integral Minutes per 4000 True 0.0 to 4000.0
Reset
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 0 True
written to by an operator
command
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 100 True
units) to which the (PV) input
is compared for the High
alarm.
H_DB REAL The amount of engineering 0.5 True
units by which (PV) must be
within the limit for the High
alarm to clear.
H_DELAYIN TIME The amount of time the input T#0MS False 0 to
must reach or exceed the 24d20h31m2
High limit to trip an alarm. 3s647ms

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

2-166 A5E00595270-01
 Library Function Blocks

Name Data Explanation Initial OC&M Valid Values

Type
H_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the High limit 24d20h31m2
and deadband to cause the 3s647ms
alarm to clear.
L_LIM REAL The value (in engineering 0 True
units) to which the (PV) input
is compared for the Low
alarm.
L_DB REAL The amount of engineering 0.5 True
units by which (PV) must be
within the limit for the Low
alarm to clear.
L_DELAYIN TIME The amount of time the input T#0MS False 0 to
must reach or exceed the Low 24d20h31m2
limit to trip an alarm. 3s647ms
L_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the Low limit 24d20h31m2
and deadband to cause the 3s647ms
alarm to clear.
HD_LIM REAL The value (in engineering 0 True
units) to which (PV) – (DEV)
is compared for the High
Deviation alarm.
HD_DB REAL The amount of engineering 0.5 True
units 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 T#0MS False 0 to
must reach or exceed the 24d20h31m2
High Deviation limit to trip an 3s647ms
alarm.
HD_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the High 24d20h31m2
Deviation limit and deadband 3s647ms
to cause the alarm to clear.
LD_LIM REAL The value (in engineering 0 True
units) to which (DEV) - (PV) is
compared for the Low
Deviation alarm.
LD_DB REAL The amount of engineering 0.5 True
units 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 T#0MS False 0 to
must reach or exceed the Low 24d20h31m2
Deviation limit to trip an alarm. 3s647ms
LD_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the Low 24d20h31m2
Deviation limit and deadband 3s647ms
to cause the alarm to clear.

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

A5E00595270-01 2-167
Library Function Blocks

Name Data Explanation Initial OC&M Valid Values

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

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

2-168 A5E00595270-01
 Library Function Blocks

Name Data Explanation Initial OC&M Valid Values

Type
IR_DB REAL The amount of engineering 0.5 True
units by 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 T#0MS False 0 to
must reach or exceed the 24d20h31m2
Increasing Rate of Change 3s647ms
limit to trip an alarm.
IR_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the Increasing 24d20h31m2
Rate of Change limit and 3s647ms
deadband to cause the alarm
to clear.
DR_LIM REAL The value (in engineering 0 True
units per minute) to which the
(PV) input is compared for the
Decreasing Rate of Change
alarm.
DR_DB REAL The amount of engineering 0.5 True
units 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 T#0MS False 0 to
must reach or exceed the 24d20h31m2
Decreasing Rate of Change 3s647ms
limit to trip an alarm.
DR_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the Decreasing 24d20h31m2
Rate of Change limit and 3s647ms
deadband to cause the alarm
to clear.
AR_LIM REAL The value (in engineering 0 True
units per minute) to which the
(PV) input is compared for the
Absolute Rate of Change
alarm.
AR_DB REAL The amount of engineering 0.5 True
units 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 T#0MS False 0 to
must reach or exceed the 24d20h31m2
Absolute Rate of Change limit 3s647ms
to trip an alarm.
AR_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the Absolute 24d20h31m2
Rate of Change limit and 3s647ms
deadband to cause the alarm
to clear.

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

A5E00595270-01 2-169
Library Function Blocks

Name Data Explanation Initial OC&M Valid Values

Type
OOR_DELAYIN TIME The amount of time the input T#0MS False 0 to
must be outside the limits 24d20h31m2
EINH, EINL to trip the Out of 3s647ms
Range alarm.
OOR_DELAYOUT TIME The amount of time the input T#0MS False 0 to
must be within the limits 24d20h31m2
EINH, EINL to cause the Out 3s647ms
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 24d20h31m2
Quality Not Good alarm. 3s647ms
QUAL_DELAYOUT TIME The amount of time the input T#0MS False 0 to
quality must be good to cause 24d20h31m2
the Quality Not Good alarm to 3s647ms
clear.
DISABLE_ON_OOS BOOL When set to TRUE, the block False False
is disabled if (OOS) is also
TRUE.

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

2-170 A5E00595270-01
 Library Function Blocks

2.22 VALVE_A_ALM_AFB

2.22.1 VALVE_A_ALM: Valve with Alarm

Function Block Name VALVE_A_ALM_AFB
(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_AFB block with a
4-element discrete alarm block. To provide thorough alarm reporting, the alarm
state value of the VALVE_A_AFB block is used to create separate alarms for the
following conditions:
x Failure to open (or loss of open verify)
x Failure to close (or loss of close verify)
x Uncommanded close/open or rejected command (due to interlock)
x Failed limit switch (Open and close verify inputs are set)
The latched fail state of the VALVE_A_AFB block is unlatched automatically when
the alarm is acknowledged.
The parameters are generally identical to those of the VALVE_A_AFB block. See
VALVE_A_AFB 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.

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

A5E00595270-01 2-171
Library Function Blocks

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:
x Connect a boolean interlock condition to the Interlock input.
x 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

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

2-172 A5E00595270-01
 Library Function Blocks

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 to open - $$BlockComment$$
Failure
2 PLC Process Control Message - Failure to close - $$BlockComment$$
Failure
3 PLC Process Control Message - Uncommanded close/open or rejected command
Failure (due to interlock) - $$BlockComment$$
4 PLC Process Control Message - Failed limit switch (open and close verify inputs are
Failure 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

2.22.1.1 VALVE_A_ALM_AFB Input Output

Input

Name Data Type Explanation Initial OC&M Valid

Values
OP_VER BOOL Open Verification False True
input
CL_VER BOOL Closed Verification False True
input
A_OPEN BOOL Automatic Open False False
command input
A_CLSE BOOL Automatic Close False False
command input
PERMIT BOOL Permitted to Open True True
input.
MODE BOOL Mode input from 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

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

A5E00595270-01 2-173
Library Function Blocks

Name Data Type Explanation Initial OC&M Valid

Values
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 '' True
Description
INT02_DESC STRING[32] Interlock 2 '' True
Description
INT03_DESC STRING[32] Interlock 3 '' True
Description
INT04_DESC STRING[32] Interlock 4 '' True
Description
INT05_DESC STRING[32] Interlock 5 '' True
Description
INT06_DESC STRING[32] Interlock 6 '' True
Description
INT07_DESC STRING[32] Interlock 7 '' True
Description
INT08_DESC STRING[32] Interlock 8 '' True
Description
INT09_DESC STRING[32] Interlock 9 '' True
Description
INT10_DESC STRING[32] Interlock 10 '' True
Description
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 False True
indicator
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 True False
WS, Use load val
on CS. Force: Use
RSTRT_AUTO_VA
LUE on restart
RSTRT_AUTO_VALUE BOOL Init restart value for False False
Auto Mode if
RSTRT_AUTO_FL
AG true

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

2-174 A5E00595270-01
 Library Function Blocks

Name Data Type Explanation Initial OC&M Valid

Values
RSTRT_OUT_FLAG BOOL Default: Retain on True False
WS, Use load val
on CS. Force: Use
RSTRT_OUT_VAL
UE on restart
RSTRT_OUT_VALUE BOOL Init restart value for False False
OUT if
RSTRT_OUT_FLA
G
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 False True
from 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

Output

Name Data Explanation Initial OC&M Valid

Type Values
OUT BOOL Output used to ultimately control the False True
valve
INTRLK BOOL Interlock OK output False True
READY BOOL Ready output False False
STATE INT State of the valve 0 True
ALARM_STA INT Alarm state 0 False
TE
ALM1 BOOL Alarm 1 False False
ALM2 BOOL Alarm 2 False False
ALM3 BOOL Alarm 3 False False
ALM4 BOOL Alarm 4 False False

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

A5E00595270-01 2-175
Library Function Blocks

Input/output

Name Data Explanation Initial OC&M Valid

Type Values
FAIL BOOL Indicates whether valve has a False True
fault 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 False True
manual mode
CLOSE BOOL Close command value for False True
manual mode
OPEN_T TIME Maximum time allowed to open T#10S True
the valve
CLOS_T TIME Maximum time allowed to close T#10S True
the valve
AUTO_TRACK BOOL If true, block is set to auto False False
mode when SFC transitions to
AUTO
MODE_HOLD_AUTO BOOL Indicates whether block held in False False
auto mod e while SFC is in
auto mode
ACCEPT_ANY_AUTO BOOL When true, block is set to auto False False
when A_O PEN or A_CLSE
changes state
POS_TRANS_ACLSE BOOL Indicates whether a positive False False
transition is required to close
the valve
AUTO_TRANS_REQ BOOL When true, A_OPEN and False False
A_CLSE 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
24d20h31m
23s647ms
A1DELAYOUT TIME Out of Alarm 1 Delay Time T#0MS False 0 to
24d20h31m
23s647ms
A2LIM BOOL Alarm 2 Limit True True
A2DELAYIN TIME Into Alarm 2 Delay Time T#0MS False 0 to
24d20h31m
23s647ms
A2DELAYOUT TIME Out of Alarm 2 Delay Time T#0MS False 0 to
24d20h31m
23s647ms
A3LIM BOOL Alarm 3 Limit True True

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

2-176 A5E00595270-01
 Library Function Blocks

Name Data Explanation Initial OC&M Valid

Type Values
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 True
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

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

A5E00595270-01 2-177
Library Function Blocks

2.23 VALVE_A_AFB

2.23.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:
x 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.
x 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.
x If ACCEPT_ANY_AUTO is TRUE, AUTO is set TRUE whenever the A_OPEN
(Automatic Open) or A_CLSE (Automatic Close) input changes state.
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

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

2-178 A5E00595270-01
 Library Function Blocks

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:
x Failure to open before the OPEN_T has expired
x Failure to close before the CLOS_T has expired
x Loss of verify (=UNAVAILABLE data quality or FALSE)
x Uncommanded close (or open for fail open) due to loss of an interlock (enabled
by setting the FAIL_ON_INTRLK value to TRUE)
x 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:
x Connect a boolean interlock condition to the Interlock input.
x 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.

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

A5E00595270-01 2-179
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). 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

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

2-180 A5E00595270-01
 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 - Valve Feedback Failure -
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

2.23.1.1 VALVE_A_AFB Input Output

Input

Name Data Type Explanation Initial OC&M Valid

Values
OP_VER BOOL Open Verification input False True
CL_VER BOOL Closed Verification input False True
A_OPEN BOOL Automatic Open False False
command input
A_CLSE BOOL Automatic Close False False
command input
PERMIT BOOL Permitted to Open input. True True
MODE BOOL Mode input from 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

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

A5E00595270-01 2-181
Library Function Blocks

Name Data Type Explanation Initial OC&M Valid

Values
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, True False
Use 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
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 BOOL Init restart value for OUT False False
if RSTRT_OUT_FLAG
true
EV_ID DWORD Event ID (Compiler False
generate
d)
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 False True
HMI must be confirmed

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

2-182 A5E00595270-01
 Library Function Blocks

Note

This list differs from the inputs of the VALVE_A_AFB block in APACS+ as follows:
x Each input shown above with datatype STRING was a softlist parameter in
APACS+.
x 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.
x 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+.
x Restart parameters (RSTRT_... ) did not exist in APACS+.
x LIOP_MAN_SEL and AUT_L added to provide alternate for SET_VAL function.
x Batch parameters BA_EN, OCCUPIED are added to support future batch
faceplate view.
x Batch parameters BA_NA, BA_ID, STEP_NO are added to pass batch values
in alarm messages.
x ConfirmChange added to give APACS+ users expected feel of "one-step"
operator entry

Output

Name Data Explanation Initial OC&M Valid

Type Values
OUT BOOL Output used to ultimately control the False True
valve
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:
x FAIL and AUTO and OVERRD have been moved to In/Out in PCS 7.
x ALARM_STATE is a new output. In APACS+, it was a softlist parameter.
x 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+.
x INTRLK nub is named INT_OK in APACS+. The ProcessSuite name "INTRLK"
is preferred.

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

A5E00595270-01 2-183
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 False False - - False
OK
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
to Fail-safe OUT to be SET 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.

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

2-184 A5E00595270-01
 Library Function Blocks

Input/output

Name Data Explanation Initial OC&M Valid Values

Type
FAIL BOOL Indicates whether valve has a False True
fault condition
AUTO BOOL Auto mode output False True
OVERRD BOOL Override output False True
AUTO_TRACK BOOL If true, block is set to auto False False
mode when SFC transitions to
AUTO (MODE becomes
"True")
MODE_HOLD_AUTO BOOL Indicates whether block held in False False
auto mode while SFC is in auto
mode
ACCEPT_ANY_AUTO BOOL When true, block is set to auto False False
when A_OPEN or A_CLSE
changes state
POS_TRANS_ACLSE BOOL Indicates whether a positive True False
transition is required to close
the valve
AUTO_TRANS_REQ BOOL When true, A_OPEN and True False
A_CLSE inputs need to
change state to issue
open/close cmd
FAIL_ON_INTRLK BOOL Fail on interlock. When TRUE False False
and the 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 False False
TRUE and 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 False True
valve
OPEN BOOL Open command value for False True
manual mode
CLOSE BOOL Close command value for False True
manual mode
OPEN_T TIME Maximum time allowed to open T#10S True
the valve
CLOS_T TIME Maximum time allowed to close T#10S True
the valve

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

A5E00595270-01 2-185
Library Function Blocks

Name Data Explanation Initial OC&M Valid Values

Type
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
24d20h31m2
3s647ms
A1DELAYOUT TIME Out of Alarm 1 Delay Time T#0MS False 0 to
24d20h31m2
3s647ms
OOS BOOL Out of Service indicator False True
DISABLE_ON_OOS BOOL Disable on Out of Service False False

Note

This list differs from the softlist parameters of the VALVE_A_AFB block in APACS+
as follows:
x 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.
x ALARM_STATE was moved to Output.
x 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.
x INT01_DESC through INT10_DESC and PERMIT_DESC have been moved to
Inputs.
x FAIL_OPEN is named FAIL_OPEN_VALVE in APACS.
x OPEN_T and CLOS_T are named OPEN_TIME and CLOSE_TIME in
APACS+.
x The following alarm parameters are new: A1EN, A1LIM, A1DELAYIN,
A1DELAYOUT, OOS, DISABLE_ON_OOS. These are needed to support the
alarming functionality.

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

2-186 A5E00595270-01
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
MOTOR_A_ALM_AT
VALVE_A_ALM_AT

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

A5E00595270-01 3-1
Template Charts

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:
x 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_AFB

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

3-2 A5E00595270-01
 Template Charts

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:
x To set the VALVE block’s maximum allowed time to open and close, set the
parameter TRAV_T of the VALVE block.
x Interlock

Faults
Channel faults are detected by the input and output drivers.

See also:
BLK_VLV_1OUT_AFB

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

A5E00595270-01 3-3
Template Charts

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, 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:
x To set the VALVE block’s maximum allowed time to open and close, set the
parameter TRAV_T of the VALVE block.
x Interlock

Faults
Channel faults are detected by the input and output drivers.

See also:
BLK_VLV_2OUT_AFB

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

3-4 A5E00595270-01
 Template Charts

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.

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

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

A5E00595270-01 3-5
Template Charts

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:
x All tuning parameters (PG, TI, TD and DG)
x All high/low alarm and absolute deviation limits (H_LIM, L_LIM, AD_LIM)
x Valve scaling units (VL_EUMIN, VL_EUMAX)
x 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.
x 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 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_AFB

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

3-6 A5E00595270-01
 Template Charts

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_AFB

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

A5E00595270-01 3-7
Template Charts

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.

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:
x All tuning parameters (PG, TI, TD and DG)
x All high/low alarm and absolute deviation limits (H_LIM, L_LIM, AD_LIM)
x Valve scaling units (VL_EUMIN, VL_EUMAX)
x 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.
x Setpoint limits (SPH, SPL)

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

3-8 A5E00595270-01
 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.

See also:
EXT_SET_AFB

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

A5E00595270-01 3-9
Template Charts

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, 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:
x Failure to start (or loss of proof)
x Failure to stop (or unexpected proof)
x 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:
x 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.
x Interlocks and Interlock descriptions.
x Permit and Permit description.

Faults
Channel faults are detected by the input and output drivers.

See also:
MOTOR_A_ALM_AFB

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

3-10 A5E00595270-01
 Template Charts

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.

Parameter Assignment
Configure the following parameters for your application:
x 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.
x Interlock

Faults
Channel faults are detected by the input and output drivers.

See also:
MOTOR_1OUT_AFB

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

A5E00595270-01 3-11
Template Charts

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:
x 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.
x Interlock

Faults
Channel faults are detected by the input and output drivers.

See also:
MOTOR_2OUT_AFB

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

3-12 A5E00595270-01
 Template Charts

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.
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

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

A5E00595270-01 3-13
Template Charts

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:
x All tuning parameters (PG, TI, TD and DG)
x All high/low alarm and absolute deviation limits (H_LIM, L_LIM, AD_LIM)
x Valve scaling units (VL_EUMIN, VL_EUMAX)
x 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.
x 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_AFB
SECONDARY_AFB

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

3-14 A5E00595270-01
 Template Charts

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.

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:
x All tuning parameters (PG, TI, TD and DG)
x All high/low alarm and absolute deviation limits (H_LIM, L_LIM, AD_LIM)
x Valve scaling units (VL_EUMIN, VL_EUMAX)

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

A5E00595270-01 3-15
Template Charts

x 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.
x 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_AFB

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

3-16 A5E00595270-01
 Template Charts

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:
x All tuning parameters (PG, TI, TD and DG)
x All high/low alarm and absolute deviation limits (H_LIM, L_LIM, AD_LIM)
x Valve scaling units (VL_EUMIN, VL_EUMAX)
x 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.
x Setpoint limits (SPH, SPL)

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

A5E00595270-01 3-17
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.

See also:
SINGLE_LOOP_AFB

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

3-18 A5E00595270-01
 Template Charts

3.13 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:
x All tuning parameters (PG, TI, TD and DG)
x All high/low alarm and absolute deviation limits (H_LIM, L_LIM, AD_LIM)
x Valve scaling units (VL_EUMIN, VL_EUMAX)
x 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.
x Setpoint limits (SPH, SPL)

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

A5E00595270-01 3-19
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.

See also:
SINGLE_LP_SS_AFB

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

3-20 A5E00595270-01
 Template Charts

3.14 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:
x Failure to open (or loss of open verify)
x Failure to close (or loss of close verify)
x Uncommanded close/open or rejected command (due to interlock)
x 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.

Parameter Assignment
Configure the following parameters for your application:
x 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.
x Interlocks and Interlock descriptions
x Permit and Permit description
x Fail-safe state of the valve (FAIL_OPEN)

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

A5E00595270-01 3-21
Template Charts

Faults
Channel faults are detected by the input and output drivers.

See also:
VALVE_A_ALM_AFB

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

3-22 A5E00595270-01
4 Message class

Classification of messages in accordance with their cause. The following message

classes are used in the SIMATIC process control system:
x Process signals which are triggered when process-specific monitoring values
(for example: alarms, interrupts, upper/lower tolerance, general process
signals) are reached or exceeded.
x Control system messages which are output by the control system (system
messages), the I/O units (errors in the field) or for preventive maintenance.
x 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.
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.

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

A5E00595270-01 4-1
5 Differences between APACS+ and PCS 7

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 24d20h31m23s647ms
time

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 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/APACS+ ES Library User's Guide for V6.1

A5E00595270-01 5-1
Differences between APACS+ and PCS 7

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.
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.

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

5-2 A5E00595270-01
 Differences between APACS+ and PCS 7

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

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

A5E00595270-01 5-3
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):
x Operator changes are "one-step", no further confirmation is required.
x all choices that are two-state, such as Auto/Manual, will immediately toggle to
the other state.
x 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:
x 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.
x all choices including two-state choices require confirmation.
x Increase/Decrease buttons will be invisible.
Note that in both cases all operator changes are sent to the Operation List log.

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

5-4 A5E00595270-01
 Differences between APACS+ and PCS 7

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.
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:
x LIOP_MAN_SEL = TRUE: The connected value at the AUT_L ("link ") block
input will determine the Auto/Manual mode. Operator input is ignored.
x 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.

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.

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

A5E00595270-01 5-5
Differences between APACS+ and PCS 7

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:
x 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.
x The APACS+ controller implements the integral action using reset feedback
whereas the PCS 7 controller implements the integral action directly to the
gain*error.
x 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.
x 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:

ª§ · º
§ 1 · « ¨ TDs ¸ »
OUT PG¨1  ¸ «¨  1¸ PV  SP »
© TIs ¹ «¨¨ TD s  1 ¸ »
¸
¬«© DG ¹ ¼»

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:
x the ability to initialize PID for bumpless transfer from Man to Auto without SP
tracking
x the capability to implement numerous reset windup prevention strategies in
cascade and override control
x 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

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

5-6 A5E00595270-01
 Differences between APACS+ and PCS 7

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:

§ 1 TVs ·
LMN GAIN ¨¨1   ¸¸SP  PV _ IN 
© TNs 1  TM _ LAGs ¹

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 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.

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

A5E00595270-01 5-7
Differences between APACS+ and PCS 7

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:
x 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:
x derivative action only on PV, yielding proportional and integral actions on SP
changes (same as APACS+)
x proportional action only on PV, yielding integral and derivative actions on SP
changes
x 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.

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

5-8 A5E00595270-01
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.
The following procedures are detailed below:
x Create new block types
x Modify graphical elements
x Test the changes

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

A5E00595270-01 6-1
Customizing the Library

Create new block types

Procedure Example
1. From SIMATIC Manager, copy the 1. From the SIMATIC Manager main menu, select File >
Library. Open. The Open Project dialog box appears. Click
the Libraries tab, and select APACS Library. From
the main menu,
select File > Save As New 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:
x MSG1_ERR
x MSG1_STAT
x MSG2_ERR
x 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. Compile as a block type. 5. From the main menu, select Chart > Compile > Chart
as block type.

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

6-2 A5E00595270-01
 Customizing the Library

6. Assign a new number, name and 6. a. On the General tab, change Symbolic Name to
comment. 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.
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 1. Double-click on Graphics Designer from PCS 7 OS,
existing project in PCS 7 OS. WinCC Explorer.
2. Update the block icon for the new 2. From Graphics Designer, open
type. 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. 4. 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\faceplated siemens\wincc\options\pdl\faceplatedesigner_v6
esigner_v6 directory in Windows
Explorer:

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

A5E00595270-01 6-3
Customizing the Library

a. Copy @PG_originalname.PDL a. Copy @PG_Single_Loop_AFB.PDL and save as

and save as @PG_newname.pdl @PG_NewSloop.pdl
b. Copy b. Copy @PG_Single_Loop_AFB_overview.PDL and
@PG_originalname_overview.PD save as @PG_NewSloop_overview.pdl
L and save as
@PG_newname_overview.pdl
c. Copy @PG_Single_Loop_AFB_standard.PDL and
c.Copy@PG_originalname_standard. save as @PG_NewSloop_standard.pdl
PDL
and save as
d. Copy @PG_Single_Loop_AFB_viewlist.PDL and
@PG_newname_standard.pdl
save as @PG_NewSloop_viewlist.pdl
d. Copy
e. Copy @PL_Single_Loop_AFB.PDL and save as
@PG_originalname_viewlist.PDL
@PL_NewSloop.pdl
and save as
@PG_newname_viewlist.pdl
e. Copy
@PL_originalname_overview.PDL
and save as
@PL_newname_overview.pdl
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.

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

6-4 A5E00595270-01
 Customizing the Library

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
i. Save the file.

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

A5E00595270-01 6-5
Customizing the Library

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.
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.

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

6-6 A5E00595270-01
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.

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.

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

A5E00595270-01 7-1
Performance Data

Block (Type Name) FB Typical Block Instance Temporary Multiple Instance

No. run length data memory block
time (bytes) length (bytes)
(ms)* (bytes)
CPU
416-3
AM_AFB FB 0.045 540 90 48
500
PID_AFB FB 0.403 1994 190 94
501
SETPNT_AFB FB 0.075 1854 134 78
502
AALM_AFB FB 0.116 5296 550 146 2xSFB35
503
DALM_AFB FB 0.154 2096 290 26 SFB35
504
MOTOR_A_AFB FB 0.198 1598 746 50 FB504
505
VALVE_A_AFB FB 0.199 1938 712 50 FB504
506

ANALOG_ALM_AFB FB 0.160 1134 758 2 FB503

600
BLK_VLV_1OUT_AFB FB 0.196 856 368 50 2xFB5, FB504
601
BLK_VLV_2OUT_AFB FB 0.197 1104 366 50 2xFB5, FB504
602
CASCADE_AFB FB 1.359 5308 2222 48 FB500, 2xFB501,
603 2xFB502,
2xFB503
DISCRETE_ALM_AFB FB 0.144 526 368 2 FB504
604
EXT_SET_AFB FB 0.732 3116 1180 48 FB500, FB501,
605 FB502, FB503
MOTOR_1OUT_AFB FB 0.199 866 370 54 2xFB5, FB504
606
MOTOR_2OUT_AFB FB 0.199 1068 370 54 2xFB5, FB504
607
PRIMARY_AFB FB 0.755 3208 1166 44 FB500, FB501,
608 FB502, FB503
RATIO_SET_AFB FB 0.843 4268 1360 48 FB500, FB501,
609 2xFB502, FB503
SECONDARY_AFB FB 0.732 3136 1178 48 FB500, FB501,
610 FB502, FB503
SINGLE_LOOP_AFB FB 0.730 3044 1178 48 FB500, FB501,
611 FB502, FB503
SINGLE_LP_SS_AFB FB 0.732 3118 1182 48 FB500, FB501,
612 FB502, FB503
MOTOR_A_ALM_AFB FB 1.067 6442 1530 56 FB504, FB505,
613 FB9
VALVE_A_ALM_AFB FB 1.049 6280 1464 56 FB504, FB506,
614 FB9

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

7-2 A5E00595270-01
 Performance Data

*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.

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

A5E00595270-01 7-3