Sie sind auf Seite 1von 122

Advanced Process Control Library V2.

EIO0000001811 02/2014

Advanced Process
Control Library V2.0
PCR Library
PES Control and Supervision Services
Offer User Manual
02/2014
EIO0000001810.00

www.schneider-electric.com
The information provided in this documentation contains general descriptions and/or technical
characteristics of the performance of the products contained herein. This documentation is not
intended as a substitute for and is not to be used for determining suitability or reliability of these
products for specific user applications. It is the duty of any such user or integrator to perform the
appropriate and complete risk analysis, evaluation and testing of the products with respect to the
relevant specific application or use thereof. Neither Schneider Electric nor any of its affiliates or
subsidiaries shall be responsible or liable for misuse of the information contained herein. If you
have any suggestions for improvements or amendments or have found errors in this publication,
please notify us.
No part of this document may be reproduced in any form or by any means, electronic or
mechanical, including photocopying, without express written permission of Schneider Electric.
All pertinent state, regional, and local safety regulations must be observed when installing and
using this product. For reasons of safety and to help ensure compliance with documented system
data, only the manufacturer should perform repairs to components.
When devices are used for applications with technical safety requirements, the relevant
instructions must be followed.
Failure to use Schneider Electric software or approved software with our hardware products may
result in injury, harm, or improper operating results.
Failure to observe this information can result in injury or equipment damage.
© 2014 Schneider Electric. All rights reserved.

2 EIO0000001810 02/2014
Table of Contents

Safety Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
About the Book. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Part I General Information . . . . . . . . . . . . . . . . . . . . . . . . 9
Chapter 1 Using the PCR Library . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Basic Features of the Library. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Genie and Faceplate Representation of Symbol Objects . . . . . . . . . . 14
Generic Information on Faceplates . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Chapter 2 PCR Library Application Features . . . . . . . . . . . . . . . . 23
Sequence of Events (SOE) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Multimonitor Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Multilanguage Support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Part II PCR Library Objects. . . . . . . . . . . . . . . . . . . . . . . . 31
Chapter 3 AP_PSF1: Simple Predictive Controller Function
Block . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
DFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Public Variable Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Derived Data Type (DDT) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Genie Representation and Features . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Faceplate Components and Features . . . . . . . . . . . . . . . . . . . . . . . . . 46
Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Chapter 4 AP_PIF1: Predictive Controller Function for
Integrative First Order Process. . . . . . . . . . . . . . . . . . . 69
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
DFB Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Public Variable Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Derived Data Type (DDT) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Genie Representation and Features . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Faceplate Components and Features . . . . . . . . . . . . . . . . . . . . . . . . . 82

EIO0000001810 02/2014 3
Chapter 5 AP_PZTR: Zone Control with Non-Linear Time
Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
DFB Representation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
Public Variable Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
Genie Representation and Features . . . . . . . . . . . . . . . . . . . . . . . . . . 110
Faceplate Components and Features . . . . . . . . . . . . . . . . . . . . . . . . . 111
Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
Chapter 6 Use Case Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Use Case Example 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Use Case Example 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121

4 EIO0000001810 02/2014
Safety Information

Important Information

NOTICE
Read these instructions carefully, and look at the equipment to become familiar with the device
before trying to install, operate, or maintain it. The following special messages may appear
throughout this documentation or on the equipment to warn of potential hazards or to call attention
to information that clarifies or simplifies a procedure.

EIO0000001810 02/2014 5
PLEASE NOTE
Electrical equipment should be installed, operated, serviced, and maintained only by qualified
personnel. No responsibility is assumed by Schneider Electric for any consequences arising out of
the use of this material.
A qualified person is one who has skills and knowledge related to the construction and operation
of electrical equipment and its installation, and has received safety training to recognize and avoid
the hazards involved.

6 EIO0000001810 02/2014
About the Book

At a Glance

Document Scope
This document provides information on Advanced Process Control Library V2.0 function blocks.
The Advanced Process Control (APC) Library components are for end users and system
integrators.
Users of the Advanced Process Control Library components are supposed to have a very good
knowledge in the employment of:
 Unity Pro V7.0
 Vijeo Citect V7.3 SP1 (Hotfix)

Supported PLC platform:


 Quantum PLC
 M340 PLC

NOTE: This document does not cover any development procedures and internal functionality
details.

Validity Note
This manual is valid for Process Expert V3.1 SP1.

Related Documents

Title of Documentation Reference Number


Advanced Process Control Library V2.0, PCR Library Templates, EIO0000001811
Offer User Manual
Process Expert, Process Template Control Services User Guide EIO0000000988
Process Expert, Process Templates User Guide EIO0000000987

You can download these technical publications and other technical information from our website
at www.schneider-electric.com.

EIO0000001810 02/2014 7
Product Related Information

WARNING
LOSS OF CONTROL
Review potential failure modes of the control paths for critical control functions.
Provide a means to achieve a safe state during and after a path failure.
Provide separate or redundant control paths for critical control functions.
Review the implications of transmission delays or failure of communication links.
Apply local accident prevention and safety regulations and guidelines. 1
Test each implementation of this library for proper operation before placing it into service.
Failure to follow these instructions can result in death, serious injury, or equipment
damage.

1For additional information, refer to NEMA ICS 1.1 (latest edition), Safety Guidelines for the
Application, Installation, and Maintenance of Solid State Control and to NEMA ICS 7.1 (latest
edition), Safety Standards for Construction and Guide for Selection, Installation and Operation of
Adjustable-Speed Drive Systems or their equivalent governing your particular location.
The application of this product requires expertise in the design and operation of control systems.

WARNING
UNINTENDED EQUIPMENT OPERATION
Allow only authorized personnel with such expertise to program, install, alter, and apply this
product.
Follow local and national safety codes and standards.
Failure to follow these instructions can result in death, serious injury, or equipment
damage.

Examples in this manual are given for information only.

WARNING
UNINTENDED EQUIPMENT OPERATION
Adapt examples that are given in this manual to the specific functions and safety requirements of
your industrial application when you implement them.
Failure to follow these instructions can result in death, serious injury, or equipment
damage.

8 EIO0000001810 02/2014
Advanced Process Control Library V2.0
General Information
EIO0000001811 02/2014

Part I
General Information

General Information

Overview
This part explains about:
 using the PCR library
 the application features of the PCR library

What Is in This Part?


This part contains the following chapters:
Chapter Chapter Name Page
1 Using the PCR Library 11
2 PCR Library Application Features 23

EIO0000001810 02/2014 9
General Information

10 EIO0000001810 02/2014
Advanced Process Control Library V2.0
Using the PCR Library
EIO0000001811 02/2014

Chapter 1
Using the PCR Library

Using the PCR Library

What Is in This Chapter?


This chapter contains the following topics:
Topic Page
Basic Features of the Library 12
Genie and Faceplate Representation of Symbol Objects 14
Generic Information on Faceplates 21

EIO0000001810 02/2014 11
Using the PCR Library

Basic Features of the Library

Introduction
The PCR library objects are designed to perform closed loop control in complex and sluggish first
order normal and integrative process. The PCR library algorithms/functions are based on the
model based predictive control technology and is dedicated to SISO (Single Input Single Output)
processes.
You can use this library objects with APC Standard library function blocks, PES system library
objects and any of the available segment-specific libraries. For example, Liquid Food Library,
Water Library, and so on.
The library object design is divided into three major parts:
Unity Pro Derived Function Block (DFB): Contains the data structure and functional logic for
the operation of the library block.
Vijeo Citect Genie Element: Provides the simplest visual representation of various aspects of the
device on HMI graphic page.
Vijeo Citect Faceplates: Enables you to operate the device with the help of faceplates to take
decisions on device operation, simulation, alarm management, device data, and so on.
The PCR library blocks perform the following functions:
 Control and Supervision:
 Management of owner (Program and Operator).
 Management of operating modes (Auto, Manual, and Cascade).
 Graphic and colored view of objects in runtime with status display (genies).

 Alarms:
 Enable/disable of the detected alarms.
NOTE: When the detected alarms are disabled, this information is listed in Alarm Summary
tab/alarm line that is available in the PES template.

 Acknowledgement of the detected alarms and alerts.


 Closed loop control in complex and sluggish first order normal and integrative process:
 Parameterizable loops and logging of the data for example, process value (PV), setpoint
(SP), and output (OP).
 Bar graph shows the SP, PV, and controller output.
 Loop trends (process analyst).
 Modes of operation through the Auto/Manual/Cascade.

 Trend:
 Process analyst for the measurements, loops, and actor status.
 Customizable trend pens (at both design time and runtime).
 Real time/historic mode.

 Operator log:
 Operator actions are logged.

12 EIO0000001810 02/2014
Using the PCR Library

 User management:
 Appropriate privilege levels are assigned in buttons and numeric entries.
 Management of the users with rights and passwords.
 Default roles and users.

This table shows the default roles:

Role Name Global Privilege


Oper 1, 2
Process Engineer 1, 2, 3
Maintenance 1, 2, 3, 4, 5
Administrator 1, 2, 3, 4, 5, 6, 7, 8

NOTE: In this library, the labels are used to define the privilege level. The global privilege
philosophy is same as used in General Purpose Library.

This table shows the default users with assigned roles:

User Name Password Assigned Role


Operator1 Operator1 Operator1
Process Engineer Process Engineer Process Engineer
Maintenance Maintenance Maintenance
Administrator Administrator Administrator

EIO0000001810 02/2014 13
Using the PCR Library

Genie and Faceplate Representation of Symbol Objects

Genie Symbols and Icons


This section defines the common icons used by the library components to represent dynamic
information in genies.
This table explains the symbols and icons of the genie:

Function Icon Color Animation Meaning Examples of Use


Numeric display Not applicable – –

Tracking mode – Displays the Tracking –


indication mode indication as text at
the top-left corner of the
numeric display.
Instance name – – –

Very high alarm Red/yellow flashing Indicates active and not –


alarm bell symbols acknowledged.

Steady red alarm bell Indicates active and –


symbol acknowledged.

Yellow/black flashing Indicates inactive and not –


alarm bell symbols acknowledged.

– Alarm bell symbol Indicates inactive and –


disappears acknowledged.
High alarm Red/yellow flashing Indicates active and not –
alarm bell symbols acknowledged.

Steady red alarm bell Indicates active and –


symbol acknowledged.

Yellow/black flashing Indicates inactive and not –


alarm bell symbols acknowledged.

– Alarm bell symbol Indicates inactive and –


disappears acknowledged.

14 EIO0000001810 02/2014
Using the PCR Library

Function Icon Color Animation Meaning Examples of Use


Low alarm Red/yellow flashing Indicates active and not –
alarm bell symbols acknowledged.

Steady red alarm bell Indicates active and –


symbol acknowledged.

Yellow/black flashing Indicates inactive and not –


alarm bell symbols acknowledged.

– Alarm bell symbol Indicates inactive and –


disappears acknowledged.
Very low alarm Red/yellow flashing Indicates active and not –
alarm bell symbols acknowledged.

Steady red alarm bell Indicates active and –


symbol acknowledged.

Yellow/black flashing Indicates inactive and not –


alarm bell symbols acknowledged.

– Alarm bell symbol Indicates inactive and –


disappears acknowledged.
Deviation (DEV) Not applicable Detected deviation alarm. The DEV symbol
alarm flashes in red/yellow
when the difference
between the PV and SP
becomes more than set
PV/SP high or low
deviation threshold.
The symbol becomes
steady red on
acknowledgment of
DEV.
Internal Red/yellow flashing Indicates active and not –
component fault alarm icons acknowledged.

Steady red alarm icon Indicates active and –


acknowledged.

Yellow/black flashing Indicates inactive and not –


alarm icons acknowledged.

– Alarm icon symbol Indicates inactive and –


disappears acknowledged.

EIO0000001810 02/2014 15
Using the PCR Library

Function Icon Color Animation Meaning Examples of Use


Operating mode Not applicable Automatic Closed-loop PID
controller.

Manual Open-loop PID


controller.

Cascade Closed-loop PID


controller with an
externally set setpoint.
The value is controlled
remotely according to
an externally set
setpoint.
Initialization The PID changes to
Initialization mode if the
upstream objects are in
Manual/Initialization
mode.
Operator mode Not applicable Operator mode When owner is selected
as Operator, this
symbol appears in the
genie.
Out of Service Not applicable Out of Service When the incorrect
configuration is
detected in the block,
this symbol appears.

Faceplates Symbol and Action Buttons


The dynamic objects (genies) enable you to access the corresponding faceplate by clicking the
main symbol that represents the control module.
This faceplate enables you to interact with the module. The faceplate includes the tabs that
encompass the functionalities provided by the module, as per the categories of the faceplate.

16 EIO0000001810 02/2014
Using the PCR Library

This table lists the categories and functions of the faceplate:

Category Tab Symbol Meaning Functions


Control Tab The tab is selected. This tab:
 Displays the trend.
The tab is not  Displays the bar graphs.
selected.  Displays the current mode.
 Displays the current value.

Mode/Detail Tab The tab is selected. This tab enables you to:
 select the operating mode.
The tab is not
 enter the numeric value for the modes,
selected. such as Override, Simulation, and so on.
 bypass and/or reset of interlocks.

Adjustment Tab The tab is selected. This tab enables you to change the parameter
settings.
The tab is not
selected.

Alarm Configuration The tab is selected. This tab:


Tab  Displays detected Component Internal
The tab is not Alarms.
selected.  Allows you to enable/disable the buttons of
detected Component Internal Alarms.

About Tab The tab is selected. This tab displays information about the library,
versions, component name, and so on.
The tab is not
selected.

EIO0000001810 02/2014 17
Using the PCR Library

This table describes the display fields and action buttons of the faceplates that allows you to
interact with corresponding control module:

Function Button/Symbol Description


Numeric value display Displays the numeric value. The color of the
rectangle background is gray.
 For PV, font color is cyan.
 For SP, font color is green.
 For CV/output, font color is yellow.

Numeric value entry and Displays the numeric value. The color of the
display rectangle background is black.
 For PV value, font color is cyan.
 For SP value, font color is green.
 For CV/output value, font color is yellow.

Numeric entry and Used to enter the numeric entry and display in HH,
display for limit values H, L, and LL threshold limits.
The color of the rectangle background is black and
the value of the font color is white.
For high and low output range of the numeric entry,
the value of the font color is yellow.
Auto mode selection –
button

Override mode selection –


button

Cascade mode selection –


button

Value decrement by 5% –
of the span

Value decrement by 1% –
of the span

Value increment by 5% of –
the span

Value increment by 1% of –
the span

18 EIO0000001810 02/2014
Using the PCR Library

Function Button/Symbol Description


Alarm disable button –

Alarm enable button –

Internal component –
fault alarm display

Tracking mode-selected –
display

Bar graph  For PV, fill color is cyan in the bar graph.
 For SP, fill color is green in the bar graph.
 For CV/output, fill color is yellow in the bar graph.

Trend display in the Displays the real-time trend in the faceplate.


faceplate

EIO0000001810 02/2014 19
Using the PCR Library

Function Button/Symbol Description


Simulation Simulation button
Simulation mode is activated on clicking this button.
Indicates that the Simulation mode is deactivated.

Indicates that the Simulation mode is activated.

Normal mode button


Normal (Auto) mode is activated on clicking this
button.
Indicates that normal (Auto) mode is deactivated.

Indicates that normal (Auto) mode is activated.

Trend button Opens the Process Analyst window.

Close faceplate Exit

Owner Operator mode button.


This symbol indicates that the Operator mode is
deactivated.
Click this button to activate the Operator mode.
Indicates that the Operator mode is activated.

Program mode button.


This symbol indicates that the Program mode is
deactivated.
Click this button to activate the Program mode.
Indicates that the Program mode is activated.

20 EIO0000001810 02/2014
Using the PCR Library

Generic Information on Faceplates

About Tab
This About tab displays information about the library name, library version, library supervision file
name, component details, and Process Expert library logo.

Trend Button
To operate this button on the top bar of the faceplate, you must be the Operator or above (privilege
level ≥ 2). If you do not have the proper privilege level, the button is disabled.

EIO0000001810 02/2014 21
Using the PCR Library

22 EIO0000001810 02/2014
Advanced Process Control Library V2.0
Library Application Features
EIO0000001811 02/2014

Chapter 2
PCR Library Application Features

PCR Library Application Features

Overview
This chapter describes the application features of the PCR library.

What Is in This Chapter?


This chapter contains the following topics:
Topic Page
Sequence of Events (SOE) 24
Multimonitor Support 26
Multilanguage Support 30

EIO0000001810 02/2014 23
Library Application Features

Sequence of Events (SOE)

Introduction
The operator actions (such as operating mode selection, entering numeric values,
disabling/enabling detected alarms, incrementing/decrementing a numeric value through buttons,
and so on) are logged in a Sequence of Events (SOE) template available in the normal template
in tab style.
The following information is available in the SOE template:

Item Description
Date Date value on value change.
Time Time value on value change.
Tag Name of the Tag.
Name This field is blank for the operator actions.
Message Log message about the action.
State Off.
Classification Operator actions are classified as action.
User Name Name of the user logged who has changed the value.
User Location IP address of the machine on which an action is made.

The old value and the new value are displayed only when there is a change in the analog
parameters.
For the command operations, such as operating mode changed from Manual to Auto, the message
is logged as Mode control changed; the new value is Auto, and the old value is Manual.

24 EIO0000001810 02/2014
Library Application Features

This figure shows the SOE logging in runtime:

EIO0000001810 02/2014 25
Library Application Features

Multimonitor Support

Overview
You can implement multimonitor by:
 using the extended monitor property available on the inserted graphic card in the system
(desktop PC), or
 adding an additional monitor with the notebook monitor

Default cicodes are defined in the library, which enables you to use the process library for the
double monitor feature.

Implementing the Multimonitor Feature


The following steps explain how to implement the Multimonitor feature:

Step Action
1 Insert a graphic card in the desktop PC or connect the additional monitor to the notebook.
2 Right-click on the desktop.
Result: A shortcut menu appears.
3 Select the Graphic Output →Output To →Extended Desktop display.

26 EIO0000001810 02/2014
Library Application Features

Step Action
4 In Vijeo Citect Computer Setup Editor, define the number of monitors as 2 in the Value field to
set the multiple monitor parameters and the resolution of each monitor.

NOTE: You can configure a maximum of six monitors.

EIO0000001810 02/2014 27
Library Application Features

Step Action
5 Run the Vijeo Citect application.
Result: Two runtime Start Windows appear.

28 EIO0000001810 02/2014
Library Application Features

Step Action
6 Right-click the Start Windows.
Result: A shortcut menu appears.

7 Select the Cascade Windows to display both the runtime windows.


NOTE: You can also define different start pictures for various monitors.

EIO0000001810 02/2014 29
Library Application Features

Multilanguage Support

Description
The HMI elements of the blocks are defined to support language localization. Language-based
DBF files are present in the library for successful localization. Standard localization languages,
such as English, French, Spanish, and German are supported.
Procedure for changing the Language:

Step Action
1 Set the language in the computer setup editor.
The language-based DBF files are located in the APC library project folder.
2 Before Vijeo Citect is put into Run mode, enter the translated meaning for the information
present in the NATIVE column into the LOCAL column present inside the DBF.

Use the following language files:


 English.dbf
 French.dbf
 Spanish.dbf
 German.dbf

Make an entry in the LOCAL column with the reference from NATIVE column in the DBF as shown
in this figure:

30 EIO0000001810 02/2014
Advanced Process Control Library V2.0
PCR Library
EIO0000001811 02/2014

Part II
PCR Library Objects

PCR Library Objects

Overview
This part explains the objects of the PCR Library.
These modules do not reflect any specific installation.

WARNING
MISAPPLICATION OF MODULES
Before adopting these modules for use in a specific application, you must:
 Conduct a safety analysis for the application and equipment installed.
 Verify that the modules are appropriate for the equipment or function in the installation.
 Supply appropriate parameters particularly for limits.
 Check that sensors and actuators are compatible with the modules selected.
 Verify that the functions of the selected modules work properly during verification and
commissioning.
 Provide independent and/or redundant paths for critical control functions according to the
safety analysis and applicable codes, and regulations.
Failure to follow these instructions can result in death, serious injury, or equipment
damage.

What Is in This Part?


This part contains the following chapters:
Chapter Chapter Name Page
3 AP_PSF1: Simple Predictive Controller Function Block 33
4 AP_PIF1: Predictive Controller Function for Integrative First Order Process 69
5 AP_PZTR: Zone Control with Non-Linear Time Response 105
6 Use Case Examples 117

EIO0000001810 02/2014 31
PCR Library

32 EIO0000001810 02/2014
Advanced Process Control Library V2.0
AP_PSF1
EIO0000001811 02/2014

Chapter 3
AP_PSF1: Simple Predictive Controller Function Block

AP_PSF1: Simple Predictive Controller Function Block

Overview
This chapter describes the AP_PSF1 block.

What Is in This Chapter?


This chapter contains the following topics:
Topic Page
Introduction 34
DFB Representation 36
Public Variable Description 38
Derived Data Type (DDT) 40
Genie Representation and Features 43
Faceplate Components and Features 46
Detailed Description 68

EIO0000001810 02/2014 33
AP_PSF1

Introduction

General
The AP_PSF1 block is used for simple control of first order process with time delay.
The AP_PSF1 algorithm is based on predictive control principles:
 An internal model of process is used to predict the future behavior of the system. The model is
composed of 3 parameters (see figure below):
 WKM: static gain
 WTM: time constant
 WDM: time delay

The continuous transfer function of the internal model is:

 The following constraints on the manipulated variable (Y) can be considered:


 WOUTLIM.min: minimum value for Y
 WOUTLIM.max: maximum value for Y
 WYRATE: maximum variation for Y

Function Description
This table summarizes the main functions of the AP_PSF1 block:

Function Description
Mode control You can control the block in Auto, Manual, and Cascade modes.
There are two modes attributes:
 Program
 Operator

Measurements, setpoints The faceplate of the block displays the process value, setpoints, and
and controls in physical units manipulated value with the respective physical unit.
High/low control limits The block supports the high/low output limits configuration.
High/low setpoint limits The block supports the high/low setpoint limits configuration.
Setpoint-progression control The block supports setpoint-progression control using a ramp and/or a first-
using a ramp and/or a first- order filter.
order filter
Setpoint -measurement The block checks for setpoint-measurement deviation and indicates a detected
deviation checks alarm in case of setpoint/measurement deviation.
Bumpless transfer The block supports the bumpless transfer feature.

34 EIO0000001810 02/2014
AP_PSF1

Function Description
Tracking mode The block supports the tracking mode feature.
Alarm management The block displays detected process alarms (in case of high/low peak limiting
and SP/PV deviation) and detected internal component fault alarms (in case
block detects internal error). You can enable/disable these detected alarms
from the faceplate. These detected alarms are displayed both in the genie and
faceplate.

EIO0000001810 02/2014 35
AP_PSF1

DFB Representation

Overview
The DFB for AP_PSF1 is designed as a function block with the input pins connected to the input
data sources and the output pins provide DFB function results to the output destinations.
This figure shows the DFB representation of the AP_PSF1 block:

NOTE:
 XCASIN is the setpoint of an upstream object.
 XPV is the process variable.
 XCLRT is the 95% close loop response time.
 XBCKIN is the process variable of a downstream object.
 XRCPY and XRCPYENA are used to activate the object external integral object.
 ZOUT is the output value and status.
 ZBCKOUT is the value and status of the output sent to an upstream object.

Parameter Description
Input Pin Details
The table below describes the input pins of the AP_PSF1 block:

Input Type Description


WCOMRAT RATE_PARAM SP switching ramp
WSAMPTIM TIME Object sampling period
WSPFTIM TIME Time constant for first-order filter on SP input
WSPRAT RATE_PARAM Internal-SP filter constant
XINIT BOOL Initialization input
XCASIN PV_VC Upstream object setpoint

36 EIO0000001810 02/2014
AP_PSF1

Input Type Description


XPV PV_VC Process variable
XCLRT TIME 95% close loop response time
XTRKIN PV_VC Tracking value
XTRKENA BOOL Tracking option
XBCKIN PV_VC Downstream-object return signal
XRCPY PV_VC Copy of the current manipulated variable

Output Pin Details


This table describes the output pins of the AP_PSF1 block:

Output Type Description


YSTAT BYTE Block status:
Bit Function
0 Ok
1 Not Ok, the block is not working.
3 Detected Configuration Fault.
YTRKIN REAL Copy of XTRKIN value.
YSTAT2 DWORD Detected error code:
Bit Function
0 Sampling time (WSAMPTIM) = 0
1 ABS (Static Gain) < 1.0 e-6
2 Delay time (DM) < 0
3 Delay time (DM) > 127 x WSAMPTIM
4 YRATE < 0
5 YMAX < YMIN
6 Close loop response time < 0
7 WH < WSAMPTIM
ZOUT PV_VC PID PV output.
ZBCKOUT PV_VC Object return signal to downstream block.
ZSPOUT REAL Actual setpoint output.

Input/Output Pin Details


No input/output pins.

EIO0000001810 02/2014 37
AP_PSF1

Public Variable Description

These Public variables are used to communicate with SCADA.


This table describes the public variables of the AP_PSF1 block:

Input Type Description


WMODE BYTE Selection of the control operator:
Bit Function
3 Normal single
4 Manual
7 Out of service
WMODEOPT BYTE Mode options:
Bit Function
0 Setpoint selection:
 0: remote
 1:local

2 SP follows PV:
 0: disabled
 1:enabled

3 1 = enable internal setpoint


4 1 = enable external setpoint
5 CLRT input selection:
 0: remote
 1:local

WALRPOT BYTE Options for detected alarms:


Bit Function
0 To mask the detected high limit alarm
1 To mask the detected low limit alarm
4 To mask the detected SP deviation measurement
alarm
5 To mask the Invalid Signal alarm
6 To mask the detected tracking alarm
7 To mask the detected control-module alarm
WSP PV_VC Internal setpoint (XPV scale)
WSPLIM THRESHOLD SP limiting
WOUT REAL Output value in Manual mode
WOUTSCAL SCALE High/low scale for output

38 EIO0000001810 02/2014
AP_PSF1

Input Type Description


WOUTLIM THRESHOLD Output limiting
WDIVPAR DIV_PARAM Setting parameter for SP/PV Deviation alarm calculation:
 You must enter a positive value for the DivHigh parameter.
 You must enter a negative value for the DivLow parameter.

WKM REAL Static gain


WTM TIME Time constant
WDM TIME Delay time
WH TIME Coincidance point
WCLRT TIME 95% close loop response time
WYRATE REAL Maximum variation for Y (in unit per second)
WINIT BOOL Initialization input from the HMI
YMODE Modb_VC Indication of mode at output
YALRCPT WORD Detected alarms in block:
Bit Function
4 Detected high limit alarm
5 Detected low limit alarm
7 Detected control-module alarm
9 Detected Invalid Signal alarm
10 Detected SP deviation measurement alarm
12 Detected tracking alarm
15 Detected Internal Component Fault alarm
(combination of bits 7 and 9)
YCASIN PV_VC Copy of the XCASIN input
YPV PV_VC Copy of the XPV input
YOUT REAL Copy of the ZOUT value
SC SC_APPSF1_DDT Sequential control structure

EIO0000001810 02/2014 39
AP_PSF1

Derived Data Type (DDT)

Structure Description
The AP_PSF1 block consists of the following DDTs:
 RATE_PARAM
 DIV_PARAM
 SCALE
 THRESHOLD
 PV_VC
 Modb_VC
 SC_APPSF1_DDT

RATE_PARAM
Provides the rate parameters.
This table describes the structure of RATE_PARAM DDT:

Variable Type Description


RatInc REAL Positive slope rate
RatDec REAL Negative slope rate

DIV_PARAM
Provides the divergence parameters.
This table describes the structure of DIV_PARAM DDT:

Variable Type Description


DivHigh REAL High divergence
DivLow REAL Low divergence
DivTime TIME Time before indicating a divergence

SCALE
Provides the high/low scale.
This table describes the structure of SCALE DDT:

Variable Type Description


U100 REAL Maximum scale
U0 REAL Minimum scale

40 EIO0000001810 02/2014
AP_PSF1

THRESHOLD
Provides high/low threshold.
This table describes the structure of THRESHOLD DDT:

Variable Type Description


Min REAL Minimum value
Max REAL Maximum value

PV_VC
Provides the process variable value with status.
This table describes the structure of PV_VC DDT:

Variable Type Description


Value REAL Analogic value
U100 REAL Maximum range
U0 REAL Minimum range
Status BYTE Value status
Res01 BYTE Reserve byte 01
Res02 BYTE Reserve byte 02
Res03 BYTE Reserve byte 03

Modb_VC
Provides the mode of component details.
This table describes the structure of Modb_VC DDT:

Variable Type Description


Actual BYTE Actual mode of component
Res01 BYTE Reserve byte 01
Allowed BYTE Allowed mode of component
Res02 BYTE Reserve byte 02

EIO0000001810 02/2014 41
AP_PSF1

SC_APPSF1_DDT
Provides the frequently needed data to monitor and control the regulator status from the sequential
control.
This table describes the structure of SC_APPSF1_DDT:

Variable Type Description


WSP REAL Read/write access.
Enables to assign the local set-point for the sequential control if the owner is
the Program (owner is 0), the selected mode is Auto, and the selected set-
point is Local (SC.REM is 0). Otherwise, the current set-point is continuously
copied to this variable.
WPV REAL Read Only access.
Measurement of present value.
WREM BOOL Read-only access.
Allows the DFB to be configured for a remote set-point (1) or local set-point (0)
if the owner is the Program and the mode is Auto.
WPVTRK BOOL Read/write access.
To establish PV tracking, enable (1) or disable (0).
WCLRT BOOL Read/write access.
To establish external CLRT, enable (1) or disable (0).

42 EIO0000001810 02/2014
AP_PSF1

Genie Representation and Features

AP_PSF1 - Graphical Representation


This table shows the graphical representation (genie) of the AP_PSF1 block:

Graphic Symbol HMI Symbol Name Description


apc_psf1_circle PSF1 controller (circle symbol)

apc_psf1_pvsp PSF1 controller (PV and SP)

apc_psf1_pvspop PSF1 controller (PV, SP, and OP)

apc_psf1_sp PSF1 controller (SP)

apc_psf1_spop PSF1 controller (SP and OP)

The necessary data for the animation of the genie and the interaction between HMI and function
block are transferred through the public variables.

EIO0000001810 02/2014 43
AP_PSF1

Genie Elements
The AP_PSF1 genie contains various elements to animate the PSF1 functionality.
This table shows the representation of the icons in the AP_PSF1 genie:

Graphic Symbol Description


Instance name display

 PV indicates the process value with units in cyan color.


 SP indicates the setpoint value with units in green color.
 OP indicates the PSF1 output value with units in yellow color.
 A Process Analyst window opens showing the real-time trend
of PV, SP, and OP when you click anywhere on this genie.
Manual mode indication

Auto mode indication

Cascade mode indication

Tracking mode indication

Setpoint deviation. When the deviation between the SP and PV


becomes more than the set deviation, this DEV text flashes in
red/yellow color.

44 EIO0000001810 02/2014
AP_PSF1

Graphic Symbol Description


Indicates the detected High Peak Limiting alarm

Indicates the detected Low Peak Limiting alarm

Indicates the detected Internal Component Fault alarm

Indicates the initialization mode

NOTE: In the genie, the priority of displaying the detected alarm is:
Detected Internal Component fault alarm > detected High Peak Limiting alarm > detected Low
Peak Limiting alarm.
It means that, if detected High Peak Limiting alarm and detected Low Peak Limiting alarm
appear, it displays only detected High Peak Limiting alarm bell symbol in the genie.
When the detected Internal Component Fault alarm appears along with detected High Peak
Limiting and detected Low Peak Limiting alarms, it displays only detected Internal Component
Fault alarm indication symbol.
You can click the alarm bell symbols or detected fault indication symbol to acknowledge the above
mentioned detected alarms in the genie.

To acknowledge the detected alarms, you must be the Operator or above (privilege ≥ 1).

EIO0000001810 02/2014 45
AP_PSF1

Faceplate Components and Features

Introduction
Click the bottom rectangle (where detected deviation alarm and current operating mode are
displayed) of AP_PSF1 genie to open the AP_PSF1 faceplate. By default, the Control tab of the
faceplate is shown.
The AP_PSF1 faceplate:
 opens at the bottom-right corner of the genie
 contains the following tabs:
 Mode
 Adjustment
 Alarm Configuration
 About (Information)

 shows the instance name on the top bar


 contains the Process Analyst button and Close button on the top bar
 opens a Process Analyst window with the PV, SP, and OP value configured as TrendPens
variable by clicking the Trend button.

46 EIO0000001810 02/2014
AP_PSF1

Faceplate
The faceplate of the AP_PSF1 has the following tabs:
 Control
 Adjustment
 Alarm Configuration
 About

Control Tab
The Control tab is the default tab of the AP_PSF1 faceplate.
The following figure displays the Control tab of AP_PSF1 faceplate (when the owner is Program):

EIO0000001810 02/2014 47
AP_PSF1

The following figure displays the Control tab of AP_PSF1 faceplate when owner is Operator and
Auto mode is selected:

48 EIO0000001810 02/2014
AP_PSF1

The following figure displays the Control tab of AP_PSF1 faceplate when owner is Operator and
Manual mode is selected:

EIO0000001810 02/2014 49
AP_PSF1

The following figure displays the Control tab of AP_PSF1 faceplate when owner is Operator and
Cascade mode is selected:

This tab has the following eight sections:


 Trend/Process Analyst
 Bar graph
 Owner
 PSF1 Operation
 Modes
 Setpoints
 Current Mode
 Manual Control

50 EIO0000001810 02/2014
AP_PSF1

This table describes the sections of the Control tab:

Subsection Description
Trend display An instant trend window displays the real-time value of the output PV, SP and OP.
Click anywhere inside the Trend window to open the Process Analyst window, which
displays the trend of process value, setpoint, and PSF1 output value.
Bar graph The first and second bar graphs indicate the PV (filled with cyan color) and SP (filled with
green color).
Displays the value of the variable input maximum range on the top of these two bar graphs.
Displays the value of the variable input minimum range at the bottom of these two bar
graphs.
The PV bar graph also contains four level indicators for detected Very High Threshold
alarm, detected High Threshold alarm, detected Low Threshold alarm, and detected
Very Low Threshold alarm (the detected alarm level indicator is not visible when AP_AA
block of APC libraries is not linked).The colors of these indicators change according to the
state of the respective detected alarm. When any of these detected threshold alarms are
disabled, the alarm bell symbols and level indicator of that particular threshold disappear.
The third bar graph indicates the PSF1 controller output (filled with yellow color) is scaled
from WOUTSCAL.U0 to WOUTSCAL.U100.
Owner The DFB manages control system level, which is the owner (Operator or Program). As a
result, it is responsible for setting the setpoint to the desired position (in the Auto mode of
the PSF1 controller) or the manual output (in the Manual mode of the PSF1 controller).
Two mode attributes are:
 Program: When owner is Program, the control/action of PSF1 controller is controlled by
sequential control (SC (see page 42) public variable for more details) and in this case,
the objects on the faceplate are disabled.
 Operator: When owner is Operator, the control/action of PSF1 controller is controlled
by faceplate.
To operate these buttons, you must be the Operator or above (privilege level ≥ 2).
If you do not have the proper privilege level, these buttons are disabled.
PSF1 Operation Displays the numeric measure value PV, SP, and OP of the block with units.
Modes Allows you to select the PSF1 controller operating modes (for example, Auto, Manual, and
Cascade modes).
NOTE: Cascade button is activated only if external SP is selected in the parameters of
the instance while instantiating the object in PES. Otherwise, it is disabled.

To operate these buttons, you must be the Operator or above (privilege level ≥ 2).
If you do not have the proper privilege level, these buttons are disabled.

EIO0000001810 02/2014 51
AP_PSF1

Subsection Description
Setpoints The internal and external setpoint values with units are displayed as numeric display.
When Auto mode is selected, the numeric display of Int. SP changes to numeric entry
and you can enter the internal setpoint value. In this case, this internal setpoint becomes
the final setpoint of the PSF1 controller.
To enter the internal setpoint value, you must be the Operator or above (privilege level ≥ 2).
If you do not have the proper privilege level, the numeric entry is disabled.
If you enter an invalid value (that is, value out of the variable input maximum and minimum
range), a message appears displaying Value out of range.
The external setpoint numeric display is just below the internal setpoint. It displays the
value from XCASIN pin of the DFB (that is, externally coming from other block). When
Cascade mode is selected, this external setpoint becomes the final setpoint (SP) of the
PSF1 controller.
Current Mode This section is displayed only when Auto and Cascade modes are selected. This section
displays the current active mode of the PSF1 block.
Manual Control Appears only when the Manual mode is selected.
 allows you to enter the PSF1 controller output value manually
 displays the current manual output value, maximum output scale value, and minimum
output scale value.
You can enter the manual value from the numeric entry and from the increment/decrement
buttons (in 1% and 5% of the span).
When you enter any wrong value or any value outside the range of maximum and minimum
output scale value, a message appears displaying the text Value out of range.
2 buttons in Manual control section are as follows:
 Max
 Min

Max: Click the Max button; it assigns the PSF1 output value with the maximum output
scale value.
Min: Click the Min button; it assigns the PSF1 output value with the minimum output scale
value.
To operate these Min/Max and increment/decrement buttons and to enter the manual
value in numeric entry field, you must be the Operator or above (privilege level ≥ 2).
If you do not have the proper privilege level, these buttons and numeric entries are
disabled.

52 EIO0000001810 02/2014
AP_PSF1

Adjustment Tab
The following figure displays the Adjustment tab of the AP_PSF1 faceplate:

The Adjustment tab displays the following sections:


 The numeric measure value PV, SP, and OP of the block with units
 An Instant Trend window displays the real-time value PV, SP, and OP
 Bar graphs indicate PV and SP value scaled from YPV.U0 to YPV.U100

EIO0000001810 02/2014 53
AP_PSF1

 The PV bar graph also contains 4 level indicators for detected Very High Threshold alarm,
detected High Threshold alarm, detected Low Threshold alarm, and detected Very Low
Threshold alarm (the detected alarm level indicator is not visible when AP_AA block of APC
libraries are not linked)
 Bar graphs indicate OP value scaled from WOUTSCAL.U0 to WOUTSCAL.U100
 PSF1 parameters: Gain, Delay Time, Time Constant, Coincidance Point, Closed Loop
Response Time, and Maximum Variation of Output
 Access to Detailed Adjustment window
 Current mode
You cannot edit these values from this tab. The Adjust Window button opens the Detailed
Adjustment window, where you can edit the PSF1 parameters. To access this Detailed Adjustment
window, you must be the Process Engineer or above (privilege level ≥ 3). If you do not have the
proper privilege level, it disables this Adjust Window button.

54 EIO0000001810 02/2014
AP_PSF1

The following figure displays the Detailed Adjustment window of the AP_PSF1 faceplate:

EIO0000001810 02/2014 55
AP_PSF1

The following figure displays the Detailed Adjustment window with PV Alarm Threshold sub-
popup:

56 EIO0000001810 02/2014
AP_PSF1

The following figure displays the Detailed Adjustment window with Setpoint sub-popup:

EIO0000001810 02/2014 57
AP_PSF1

The following figure displays the Detailed Adjustment window with Output sub-popup:

58 EIO0000001810 02/2014
AP_PSF1

The following figure displays the Detailed Adjustment window with PSF1 parameters sub-popup:

EIO0000001810 02/2014 59
AP_PSF1

The following figure displays the Detailed Adjustment window when AP_AA block of APC libraries
are not linked:

NOTE: If you enter incorrect tuning parameter (Gain, Delay Time, Time Constant, Coincidance
Point, Closed Loop Response Time, and Maximum Variation of Output) values, the PSF1 controller
block gives unexpected output and response.

60 EIO0000001810 02/2014
AP_PSF1

WARNING
UNINTENDED EQUIPMENT OPERATION
Enter correct tuning parameter (Gain, Delay Time, Time Constant, Coincidance Point, Closed
Loop Response Time, and Maximum Variation of Output) values.
Failure to follow these instructions can result in death, serious injury, or equipment
damage.

This table describes the sections of the Adjustment tab:

Section Description
PSF1 Genie A PSF1 symbol is displayed showing PV, SP and OP values and a status bar (where
owner, detected deviation alarm, current operating modes are displayed on the top-left
section of the Detailed Adjustment window).
Process Value This section displays the parameters of Process value of the variable. The Low Scale
and High Scale displays the maximum and minimum scaled value of the process value.
PV Alarm Displays the low threshold, very low threshold, high threshold, very high threshold, and
Threshold hysteresis of process value (This section is not visible when AP_AA block of APC
libraries is not linked). You can enter the values of high threshold and low threshold, if
you are the Process Engineer or above (privilege level ≥ 3). You can also enter the
hysteresis value only if you are a Maintenance Engineer or above (privilege level ≥ 5).
To enter the values of Very High Threshold and Very Low Threshold, you must be the
Maintenance Engineer or above (privilege level ≥ 5). If you do not have the proper
privilege level, these numeric entries are disabled. If you enter wrong/invalid values, a
message appears displaying Value out of limits.
Setpoint Mode Displays the Internal setpoint, the External setpoint, and the Real setpoint value.
The current setpoint mode is also displayed. When you click on this section, a sub pop-
up Setpoint opens at the bottom-right corner of the Detailed Adjustment window.
Output Displays the parameters from the associated AP_AP (positioner) block, which is linked
with the AP_PSF1 block.
Clicking on this section, a sub pop-up Output opens at the bottom-right corner of the
Detailed Adjustment window.
PSF1 Parameters This section:
 shows the PSF1 High Limit and PSF1 Low Limit.
 displays the PSF1 tuning parameters such as Gain, Delay Time, Time Constant,
Coincidance Point, Closed Loop Response Time, and Maximum Variation of Output
 displays the High Threshold, Low Threshold and Filtering Time for SP/PV Deviation
in PSF1 block.
 displays the PV tracking mode Enable/Disable state of PSF1 controller
 displays the enable/disable state of external close loop response time state for the
AP_PSF1 controller.
Click anywhere in this section to open a sub pop-up PSF1 Parameters containing the
variables explained above with user accessibility.

EIO0000001810 02/2014 61
AP_PSF1

Section Description
Process Analyst This process analyst plots the real-time value of output value, setpoint, and process
value.
Sub Pop-ups There are four sub pop-ups:
 PV Alarm Threshold
 Setpoint
 Output
 PSF1 Parameters
PV Alarm Threshold
To enter the values of Very High Threshold and Very Low Threshold, you must be the
Maintenance Engineer or above (privilege level ≥ 5).
To enter the values of High Threshold and Low Threshold, you must be the Process
Engineer or above (privilege level ≥ 3).
You can also enter the hysteresis value only if you are a Maintenance Engineer or above
(privilege level ≥ 5).
If you do not have the proper privilege level, these numeric entries are disabled.
If you enter wrong/invalid values, a message appears displaying the text Value out of
limits.
Setpoints
In the Internal setpoint section, to enter the internal setpoint value, you must be the
Process Engineer or above (privilege level ≥ 3). You can also enter the maximum and
minimum limit of the internal setpoint. You must be the Process Engineer or above
(privilege level ≥ 3) to enter the maximum and minimum limits.
If you do not have proper privilege level, these buttons and numeric entries are disabled.
If you enter wrong/invalid values, a message appears displaying the text Value out of
limits.
It also displays the external setpoint and current setpoint values.

62 EIO0000001810 02/2014
AP_PSF1

Section Description
Sub Pop-ups Output
In this sub-popup, there are six sections:
 Owner
 Modes
 Input
 Manual Mode
 Output
 Current Mode

In the first section, the owner (Program/Operator)is selected.To operate these buttons,
you must be the Process Engineer or above (privilege level ≥ 3).
In second section, the following mode selection buttons are there:
 Auto
 Manual
 Cascade

NOTE: Cascade button is activated only if External SP is selected in the parameters of


the instance while instantiating the object in PES. Otherwise, it is disabled.

To operate these buttons, you must be the Process Engineer or above (privilege level
≥ 3).
In the third section, you can enter the input high and low peak limiting values of the
associated AP_AP block. To enter these values, you must be the Process Engineer or
above (privilege level ≥ 3).
In the fourth section, you can enter the output value manually. To enter this output value,
you must be the Process Engineer or above (privilege level ≥ 3).
In the fifth section, you can enter the output high/low scale value of associated AP_AP
block. To enter these values, you must be the Maintenance Engineer or above (privilege
level ≥ 5).
In sixth section, the Current mode is displayed.
If you do not have proper privilege level, these buttons and numeric entries are disabled.
If you enter wrong/invalid values, a message appears displaying the text Value out of
limits.

EIO0000001810 02/2014 63
AP_PSF1

Section Description
Sub Pop-ups PSF1 Parameters:
This has six sections:
 PV Tracking
 External CLRT
 MSF1 Limits
 MSF1 Parameters
 SP/PV Deviation Parameters
 Initialization

In the first section, you can select the PV tracking through Enable/Disable buttons. To
operate these buttons, you must be the Process Engineer or above (privilege level ≥ 3).
In the second section, you can activate option of the external close loop response time
through Enable/Disable buttons. To operate these buttons, you must be the Process
Engineer or above (privilege level ≥ 3).
In the third section, you can enter the PSF1 High Limit/Low Limit. To enter these values,
you must be the Process Engineer or above (privilege level ≥ 3).
In the fourth section, user can enter the PSF1 tuning parameters such as Gain, Delay
Time, Time Constant, Coincidance Point, Closed Loop Response Time, and Maximum
Variation of Output. To enter these values, you must be the Process Engineer or above
(privilege level ≥ 3).
In the fifth section, user can enter the High Threshold, Low Threshold and Filtering Time
values for SP/PV Deviation. To enter these values, you must be the Process Engineer
or above (privilege level ≥ 3).
The sixth section is for Initialization. The INIT button is available for the user to Initialize
the controller. To operate this button, you must be the Maintenance Engineer or above
(privilege level ≥ 5).
If you do not have proper privilege level, these buttons and numeric entries are disabled.
If you enter wrong/invalid values, then a message appears displaying the text Value out
of limits.
In time parameters, if you enter the hour value > 24 or < 0, a message displaying the
text Invalid value appears.
In time parameters, if you enter the minute value > 59 or < 0, a message displaying the
text Invalid value appears.
In time parameters, if you enter the second value > 59 or < 0, a message displaying the
text Invalid value appears.

64 EIO0000001810 02/2014
AP_PSF1

Alarm Configuration Tab


The following figure displays the Alarm Configuration tab of the AP_PSF1 block.

This tab has the following three sections:


 Process Alarms
 Component Internal Alarms
 Modes

EIO0000001810 02/2014 65
AP_PSF1

This table explains the sections of the Alarm Configuration tab:

Subsection Description
Process Alarms Displays the detected High Peak Limiting alarm, detected Low Peak Limiting alarm,
and detected SP/PV Deviation alarm text and alarm state with red/yellow flashing bell
in front of the respective text.
Click the respective alarm bell symbols only to acknowledge these detected alarms if
you are the Operator or above (privilege level ≥ 1).
You can enable or disable the detected High Peak Limiting alarm, detected High
Peak Limiting alarm, and detected SP/PV Deviation alarm.
To enable or disable these detected alarms, you must be the Process Engineer or
above (privilege level ≥ 3). If you do not have the proper privilege level, the
Enable/Disable buttons of the detected alarms are disabled.
Component Displays the detected Internal Component Fault alarm, detected Invalid Signal, and
Internal Alarms detected Configuration Fault alarm text and detected alarm state.
Displays the detected Internal Component Fault alarm with red/yellow flashing bell in
front of the respective text.
Displays the detected Configuration Fault alarm and detected Invalid Signal alarm
with red bell in front of the text.
Click the alarm bell symbol to acknowledge the detected Internal Component Fault
alarm if you are the Operator or above (privilege level ≥ 1).
You can enable or disable the detected Component Fault alarm and detected Invalid
Signal alarm.
To enable or disable these detected alarms, you must be the Maintenance Engineer or
above (privilege level ≥ 5).
If you do not have the proper privilege level, the Enable/Disable buttons of the detected
alarms are disabled.
Modes Displays the current active mode (Tracking mode) by displaying a green color check
mark in front of the text.
You can enable or disable the detected Tracking mode alarms. To enable or disable
these detected alarms, you must be the Process Engineer or above (privilege level ≥ 3).
If you do not have the proper privilege level, the Enable/Disable buttons of the detected
alarms are disabled.

66 EIO0000001810 02/2014
AP_PSF1

About Tab
The following figure displays the About tab of the AP_PSF1 block:

For detailed description, refer to About Tab .

EIO0000001810 02/2014 67
AP_PSF1

Detailed Description

Initialization Mode
The XINIT flag is used to initialize the current and past states of the internal model. is needed
when the controller inputs (PV, actuator) are not representative of the process.
For instance, temperature measurement of an empty reactor or opened valve without real action
on the process.
Depending on the type of process on which the controller is applied (continuous or batch), the
initialization has to be performed once or at the beginning of each production.
XINIT has to be done when the process is stabilized, as follows:

Tracking Mode
The Tracking mode is applied if the input XTRKENA is TRUE.
Then, the output of the control block (ZOUT) takes the value of manual manipulated variable
XTRKIN.

68 EIO0000001810 02/2014
Advanced Process Control Library V2.0
AP_PIF1
EIO0000001811 02/2014

Chapter 4
AP_PIF1: Predictive Controller Function for Integrative First Order Process

AP_PIF1: Predictive Controller Function for Integrative


First Order Process

Overview
This chapter describes the AP_PIF1 block.

What Is in This Chapter?


This chapter contains the following topics:
Topic Page
Introduction 70
DFB Representation 72
Public Variable Description 74
Derived Data Type (DDT) 76
Genie Representation and Features 79
Faceplate Components and Features 82

EIO0000001810 02/2014 69
AP_PIF1

Introduction

General
The AP_PIF1 block is used for control of integrative first order process with time delay.
The AP_PIF1 algorithm is based on predictive control principles:
 An internal model of process is used to predict the future behavior of the integrative system with
delay. The model is composed of 3 parameters (see figure below):
 WKM: static gain
 WTM: time constant
 WDM: time delay

The continuous transfer function of the internal model is:

 The integrative part is decomposed. This is tuned by WDECOMP variable. For stability sake, it is
better to set this input at the maximum value among:
 30 x Sampling time
 3 x Time constant
 Close loop response time

 The following constraints on the manipulated variable (Y) can be considered:


 WOUTLIM.min: minimum value for Y
 WOUTLIM.max: maximum value for Y
 WYRATE: maximum variation for Y

Function Description
This table summarizes the main functions of the AP_PIF1 block:

Function Description
Mode control You can control the block in Auto, Manual, and Cascade modes.
There are two modes attributes:
 Program
 Operator

Measurements, The faceplate of the block displays the process value, setpoints, and manipulated value
setpoints and with the respective physical unit.
controls in
physical units
High/low control The block supports the high/low output limits configuration.
limits
High/low setpoint The block supports the high/low setpoint limits configuration.
limits

70 EIO0000001810 02/2014
AP_PIF1

Function Description
Setpoint- The block supports setpoint-progression control using a ramp and/or a first-order filter.
progression
control using a
ramp and/or a
first-order filter
Setpoint - The block checks for setpoint-measurement deviation and indicates a detected alarm in
measurement case of setpoint/measurement deviation.
deviation checks
Bumpless The block supports the bumpless transfer feature.
transfer
Tracking mode The block supports the tracking mode feature.
Alarm The block displays detected Process Alarms (in case of high/low peak limiting and
management SP/PV deviation) and detected Internal Component Fault alarms (in case block detects
internal error). You can enable/disable these detected alarms from the faceplate. These
detected alarms are displayed both in the genie and faceplate.

NOTE: When the process variable XPV varies as a ramp before switching on the controller, it is
necessary to estimate the slope of this process variable XPV to initialize correctly the model. This
estimation is performed during the initialization phase, as long as INIT (either from DFB or from the
faceplate) equals TRUE. The duration of this phase is long enough to perform an estimation not
biased by the noise. In case of heavy noise, more than 10 periods may be required.

EIO0000001810 02/2014 71
AP_PIF1

DFB Representation

Overview
The DFB for AP_PIF1 is designed as a function block with the input pins connected to the input
data sources and the output pins provide DFB function results to the output destinations.
This figure shows the DFB representation of the AP_PIF1 block:

NOTE:
 XCASIN is the setpoint of an upstream object.
 XPV is the process variable.
 XCLRT is the 95% close loop response time.
 XBCKIN is the process variable of a downstream object.
 XRCPY and XRCPYENA are used to activate the object external integral object.
 ZOUT is the output value and status.
 ZBCKOUT is the value and status of the output sent to an upstream object.

Parameter Description
Input Pin Details
This table describes the input pins of the AP_PIF1 block:

Input Type Description


WCOMRAT RATE_PARAM SP switching ramp
WSAMPTIM TIME Object sampling period
WSPFTIM TIME Time constant for first-order filter on SP input
WSPRAT RATE_PARAM Internal-SP filter constant
XINIT BOOL Initialization Input
XCASIN PV_VC Upstream object setpoint

72 EIO0000001810 02/2014
AP_PIF1

Input Type Description


XPV PV_VC Process variable
XCLRT TIME 95% close loop response time
XRCPY PV_VC Copy of the current manipulated variable
XTRKIN PV_VC Tracking value
XTRKENA BOOL Tracking option
XBCKIN PV_VC Downstream-object return signal

Output Pin Details


This table describes the output pins of the AP_PIF1 block:

Output Type Description


YSTAT BYTE Block status:
Bit Function
0 Ok
1 Not Ok, the block is not working.
3 Detected Configuration Fault.
YTRKIN REAL Copy of XTRKIN value.
YSTAT2 DWORD Detected error code:
Bit Function
0 Sampling time(WSAMPTIM) = 0
1 ABS (Static Gain) < 1.0 e-6
2 Delay time (DM) < 0
3 Delay time (DM) > 127 x WSAMPTIM
4 YRATE < 0
5 WOUTLIM.max < WOUTLIM.min
6 Close loop response rime < 0
7 WH < WSAMPTIM
8 WDECOMP < 0
ZOUT PV_VC PID PV output.
ZBCKOUT PV_VC Object return signal to downstream block.
ZSPOUT REAL Actual setpoint output.

Input/Output Pin Details


No input/output pins.

EIO0000001810 02/2014 73
AP_PIF1

Public Variable Description

These Public variables are used to communicate with SCADA.


This table describes the public variables of the AP_PIF1 block:

Input Type Description


WMODE BYTE Selection of the control operator:
Bit Function
3 Normal single
4 Manual
7 Out of service
WMODEOPT BYTE Mode options:
Bit Function
0 Setpoint selection:
 0: remote
 1:local

2 PV tracking that is, SP follows PV:


 0: disabled
 1:enabled

3 1 = enable internal setpoint


4 1 = enable external setpoint
5 CLRT input selection:
 0: remote
 1:local

WALRPOT BYTE Options for detected alarms:


Bit Function
0 To mask the detected high limit alarm
1 To mask the detected low limit alarm
4 To mask the detected SP deviation measurement alarm
5 To mask the detected Invalid Signal alarm
6 To mask the detected tracking alarm
7 To mask the detected control-module alarm
WSP PV_VC Internal setpoint (XPV scale)
WSPLIM THRESHOLD SP limiting
WOUT REAL Output value in Manual mode
WOUTSCAL SCALE High/low scale for output
WOUTLIM THRESHOLD Output limiting

74 EIO0000001810 02/2014
AP_PIF1

Input Type Description


WDIVPAR DIV_PARAM Setting parameter for SP/PV Deviation alarm calculation:
 You must enter a positive value for the DivHigh parameter.
 You must enter a negative value for the DivLow parameter.

WKM REAL Static gain


WTM TIME Time constant
WDM TIME Delay time
WH TIME Coincidance point
WCLRT TIME 95% close loop response time
WYRATE REAL Maximum variation for Y (in unit per second)
WINIT BOOL Initialization input from the HMI
YMODE Modb_VC Indication of mode at output
YALRCPT WORD Detected alarms in block:
Bit Function
4 Detected high limit alarm
5 Detected low limit alarm
7 Detected control-module alarm
9 Detected Invalid Signal alarm
10 Detected SP deviation measurement alarm
12 Detected tracking alarm
15 Detected Internal Component Fault alarm (combination
of bits 7 and 9)
YCASIN PV_VC Copy of the XCASIN input
YPV PV_VC Copy of the XPV input
YOUT REAL Copy of the ZOUT value
SC SC_APPIF1_DDT Sequential control structure

EIO0000001810 02/2014 75
AP_PIF1

Derived Data Type (DDT)

Structure Description
The AP_PIF1 block consists of the following DDTs:
 RATE_PARAM
 DIV_PARAM
 SCALE
 THRESHOLD
 PV_VC
 Modb_VC
 SC_APPIF1_DDT

RATE_PARAM
Provides the rate parameters.
This table describes the structure of RATE_PARAM DDT:

Variable Type Description


RatInc REAL Positive slope rate
RatDec REAL Negative slope rate

DIV_PARAM
Provides the divergence parameters.
This table describes the structure of DIV_PARAM DDT:

Variable Type Description


DivHigh REAL High divergence
DivLow REAL Low divergence
DivTime TIME Time before indicating a divergence

SCALE
Provides the high/low scale.
This table describes the structure of SCALE DDT:

Variable Type Description


U100 REAL Maximum scale
U0 REAL Minimum scale

76 EIO0000001810 02/2014
AP_PIF1

THRESHOLD
Provides high/low threshold.
This table describes the structure of THRESHOLD DDT:

Variable Type Description


Min REAL Minimum value
Max REAL Maximum value

PV_VC
Provides the process variable value with status.
This table describes the structure of PV_VC DDT:

Variable Type Description


Value REAL Analogic value
U100 REAL Maximum range
U0 REAL Minimum range
Status BYTE Value status
Res01 BYTE Reserve byte 01
Res02 BYTE Reserve byte 02
Res03 BYTE Reserve byte 03

Modb_VC
Provides the mode of component details.
This table describes the structure of Modb_VC DDT:

Variable Type Description


Actual BYTE Actual mode of component
Res01 BYTE Reserve byte 01
Allowed BYTE Allowed mode of component
Res02 BYTE Reserve byte 02

EIO0000001810 02/2014 77
AP_PIF1

SC_APPIF1_DDT
Provides the frequently needed data to monitor and control the regulator status from the sequential
control.
This table describes the structure of SC_APPIF1_DDT:

Variable Type Description


WSP REAL Read/write access.
Enables to assign the local set-point for the sequential control if the
owner is the Program (owner is 0), the selected mode is Auto, and the
selected set-point is Local (SC.REM is 0). Otherwise, the current set-point
is continuously copied to this variable.
WPV REAL Read Only access.
Measurement of present value.
WREM BOOL Read-only access.
Allows the DFB to be configured for a remote set-point (1) or local set-
point (0) if the owner is the Program and the mode is Auto.
WPVTRK BOOL Read/write access.
To establish PV tracking, enable (1) or disable (0).
WCLRT BOOL Read/write access.
To establish external CLRT, enable (1) or disable (0).
WDECOMP BOOL Read/write access.
To establish external DECOMP, enable (1) or disable (0).

78 EIO0000001810 02/2014
AP_PIF1

Genie Representation and Features

AP_PIF1 - Graphical Representation


This table shows the graphical representation (genie) of the AP_PIF1 block:

Graphic Symbol HMI Symbol Name Description


apc_pif1_circle PIF1 controller (circle symbol)

apc_pif1_pvsp PIF1 controller (PV and SP)

apc_pif1_pvspop PIF1 controller (PV, SP, and OP)

apc_pif1_sp PIF1 controller (SP)

apc_pif1_spop PIF1 controller (SP and OP)

The necessary data for the animation of the genie and the interaction between HMI and function
block are transferred through the public variables.

EIO0000001810 02/2014 79
AP_PIF1

Genie Elements
The AP_PIF1 genie contains various elements to animate the PIF1 functionality.
This table shows the representation of the icons in the AP_PIF1 genie:

Graphic Symbol Description


Instance name display

 PV indicates the process value with units in cyan color.


 SP indicates the setpoint value with units in green color.
 OP indicates the PIF1 output value with units in yellow color.
 A Process Analyst window opens showing the real-time trend
of PV, SP, and OP when you click anywhere on this genie.
Manual mode indication

Auto mode indication

Cascade mode indication

Tracking mode indication

Setpoint deviation. When the deviation between the SP and PV


becomes more than the set deviation, this DEV text flashes in
red/yellow color.

80 EIO0000001810 02/2014
AP_PIF1

Graphic Symbol Description


Indicates the detected High Peak Limiting alarm

Indicates the detected Low Peak Limiting alarm

Indicates the detected Internal Component Fault alarm

Indicates the initialization mode

NOTE: In the genie, the priority of displaying the detected alarm is:
Detected Internal Component fault alarm > detected High Peak Limiting alarm > detected Low
Peak Limiting alarm
It means that, if detected High Peak Limiting alarm and detected Low Peak Limiting alarm
appear, it displays only detected High Peak Limiting alarm bell symbol in the genie.
When the detected Internal Component Fault alarm appears along with detected High Peak
Limiting and detected Low Peak Limiting alarms, it displays only detected Internal Component
Fault alarm indication symbol.
You can click the alarm bell symbol or detected fault indication symbol to acknowledge the above
mentioned detected alarms in the genie.

To acknowledge the detected alarms, you must be the Operator or above (privilege ≥ 1).

EIO0000001810 02/2014 81
AP_PIF1

Faceplate Components and Features

Introduction
Click the bottom rectangle (where detected Deviation alarm and Current operating mode are
displayed) of AP_PIF1 genie to open the AP_PIF1 faceplate. By default, the Control tab of the
faceplate is shown.
The AP_PIF1 faceplate:
 opens at the bottom-right corner of the genie
 contains the following tabs:
 Mode
 Adjustment
 Alarm Configuration
 About (Information)

 shows the instance name on the top bar


 contains the Process Analyst button and Close button on the top bar
 opens a Process Analyst window with the PV, SP, and OP value configured as TrendPens
variable by clicking the Trend button.

82 EIO0000001810 02/2014
AP_PIF1

Faceplate
The faceplate of the AP_PIF1 has the following tabs:
 Control
 Adjustment
 Alarm Configuration
 About

Control Tab
The Control tab is the default tab of the AP_PIF1.
The following figure displays the Control tab of AP_PIF1 faceplate when the owner is Program:

EIO0000001810 02/2014 83
AP_PIF1

The following figure displays the Control tab when owner is Operator and Auto mode is selected:

84 EIO0000001810 02/2014
AP_PIF1

The following figure displays the Control tab when owner is Operator and Manual mode is
selected:

EIO0000001810 02/2014 85
AP_PIF1

The following figure displays the Control tab when owner is Operator and Cascade mode is
selected:

This tab has the following eight subsections:


 Trend/Process Analyst
 Bar graph
 Owner
 PIF1 Operation
 Modes
 Setpoints
 Current Mode
 Manual Control

86 EIO0000001810 02/2014
AP_PIF1

This table describes the sections of the Control tab:

Subsection Description
Trend display An instant trend window displays the real-time value of the output PV, SP, and OP.
Click anywhere inside the Trend window to open the Process Analyst window,
which displays the trend of process value, setpoint, and PIF1 output.
Bar graph The first and second bar graphs indicate the PV (filled with cyan color) and SP (filled
with green color).
Displays the value of the variable input maximum range on the top of these two bar
graphs. Displays the value of the variable input minimum range at the bottom of these
two bar graphs.
The PV bar graph also contains four level indicators for detected very high
threshold alarm, detected high threshold alarm, detected low threshold alarm,
and detected very low threshold alarm (the detected alarm level indicator is not
visible when AP_AA block of APC libraries is not linked).The colors of these indicators
change according to the state of the respective detected alarm. When any of these
detected threshold alarms are disabled, the alarm bell symbol and level indicator of
that particular threshold disappear.
The third bar graph indicates the PIF1 controller output (filled with yellow color) is
scaled from WOUTSCAL.U0 to WOUTSCAL.U100.
Owner The DFB manages control system level, which is the owner (Operator or Program).
As a result, it is responsible for setting the setpoint to the desired position (in the Auto
mode of the PIF1 controller) or the manual output (in the Manual mode of the PIF1
controller).
2 mode attributes are:
 Program: When owner is Program, the control/action of PIF1 controller is
controlled by sequential control (SC (see page 78) public variable for more details)
and in this case, the objects on the faceplate are disabled.
 Operator: When owner is Operator, the control/action of PIF1 controller is
controlled by faceplate.
To operate these buttons, you must be the Operator or above (privilege level ≥ 2).
If you do not have the proper privilege level, the buttons are disabled.
PIF1 Operation Displays the numeric measure value PV, SP, and OP of the block with units.
Modes Allows you to select the PIF1 controller operating modes (for example, Auto, Manual,
and Cascade modes).
NOTE: Cascade button is activated only if external SP is selected in the parameters
of the instance while instantiating the object in PES. Otherwise, it is disabled.

To operate these buttons, you must be the Operator or above (privilege level ≥ 2).
If you do not have the proper privilege level, the buttons are disabled.

EIO0000001810 02/2014 87
AP_PIF1

Subsection Description
Setpoints The internal and external setpoint values with units are displayed as numeric display.
When Auto mode is selected, the numeric display of Int. SP changes to numeric
entry and you can enter the internal setpoint value. In this case, this internal setpoint
becomes the final setpoint of the PIF1 controller.
To enter the internal setpoint value, you must be the Operator or above (privilege
level ≥ 2). If you do not have the proper privilege level, this numeric entry is disabled.
If you enter an invalid value (that is, value out of the variable input maximum and
minimum range), a message appears displaying the text Value out of range.
The external setpoint numeric display is just below the internal setpoint. It displays
the value from XCASIN pin of the DFB (that is, externally coming from other block).
When Cascade mode is selected, this external setpoint becomes the final setpoint
(SP) of the PIF1 controller.
Current Mode This section will be displayed only when Auto and Cascade mode are selected. This
section displays the current active mode of the PIF1 block.
Manual Control Appears only when the Manual mode is selected.
 allows you to enter the PIF1 controller output value manually
 displays the current manual output value, maximum output scale value, and
minimum output scale value.
You can enter the manual value from the numeric entry and from the
increment/decrement buttons (in 1% and 5% of the span).
When you enter any wrong value or any value outside the range of maximum and
minimum output scale value, a message box appears displaying the text Value out
of range.
Two buttons in Manual control section are as follows:
 Max
 Min

Max: Click the Max button; it assigns the PIF1 output value with the maximum output
scale value.
Min: Click the Min button; it assigns the PIF1 output value with the minimum output
scale value.
To operate these Min/Max and increment/decrement buttons and to enter the
manual value in numeric entry field, you must be the Operator or above (privilege
level ≥ 2).
If you do not have the proper privilege level, these buttons and numeric entries are
disabled.

88 EIO0000001810 02/2014
AP_PIF1

Adjustment Tab
The following figure displays the Adjustment tab of the AP_PIF1 faceplate:

The Adjustment tab displays the following sections:


 The numeric measure value PV, SP, and OP of the block with units
 An Instant Trend window displays the real-time value PV, SP, and OP
 Bar graphs indicate PV and SP value scaled from YPV.U0 to YPV.U100

EIO0000001810 02/2014 89
AP_PIF1

 The PV bar graph also contains 4 level indicators for detected Very High Threshold alarm,
detected High Threshold alarm, detected Low Threshold alarm, and detected Very Low
Threshold alarm (the detected alarm level indicator is not visible when AP_AA block of APC
libraries is not linked)
 Bar graphs indicate OP value scaled from WOUTSCAL.U0 to WOUTSCAL.U100
 PIF1 parameters: Gain, Delay Time, Time Constant, Coincidance Point, Closed Loop Response
Time, Maximum Variation of Output, and Decomposition Time
 Access to Detailed Adjustment window
 Current mode
You cannot edit these values from this tab. The Adjust Window button opens the Detailed
Adjustment window, where you can edit the PIF1 parameters. To access this Detailed Adjustment
window, you must be the Process Engineer or above (privilege level ≥ 3). If you do not have the
proper privilege level, it disables this Adjust Window button.

90 EIO0000001810 02/2014
AP_PIF1

The following figure displays the Detailed Adjustment Window of the AP_PIF1 faceplate:

EIO0000001810 02/2014 91
AP_PIF1

The following figure shows the Detailed Adjustment window with PV Alarm Threshold sub-popup:

92 EIO0000001810 02/2014
AP_PIF1

The following figure shows the Detailed Adjustment window with Setpoint sub-popup:

EIO0000001810 02/2014 93
AP_PIF1

The following figure shows the Detailed Adjustment window with Output sub-popup:

94 EIO0000001810 02/2014
AP_PIF1

The following figure shows the Detailed Adjustment window with PIF1 Parameters sub-popup:

EIO0000001810 02/2014 95
AP_PIF1

The following figure shows the Detailed Adjustment window when AP_AA block of APC libraries is
not linked:

96 EIO0000001810 02/2014
AP_PIF1

NOTE: If you enter incorrect tuning parameter (Gain, Delay Time,Time Constant, Coincidance
Point, Closed Loop Response Time, and Maximum Variation of Output, Decomposition Time
Constant) values, the PIF1 controller block gives unexpected output and response.

WARNING
UNINTENDED EQUIPMENT OPERATION
Enter correct tuning parameter (Gain, Delay Time,Time Constant, Coincidance Point, Closed
Loop Response Time, and Maximum Variation of Output, Decomposition Time Constant) values.
Failure to follow these instructions can result in death, serious injury, or equipment
damage.

This table describes the subsections of the Adjustment tab:

Subsection Description
PIF1 Genie A PIF1 symbol is displayed showing PV, SP and OP values and a status bar (where
owner, detected deviation alarm, current operating modes are displayed on the top-left
section of the Detailed Adjustment window).
Process Value This section displays the parameters of Process value of the variable. The Low Scale and
High Scale displays the maximum and minimum scaled value of the process value.
PV Alarm Displays the Low threshold, very Low threshold, High threshold, very High threshold, and
Threshold Hysteresis of process value (This section is not visible when AP_AA block of APC libraries
is not linked). You can enter the values of high threshold and low threshold, if you are the
Process Engineer or above (privilege level ≥ 3). You can also enter the hysteresis value
only if you are a Maintenance Engineer or above (privilege level ≥ 5). To enter the values
of Very High Threshold and Very Low Threshold, you must be the Maintenance Engineer
or above (privilege level ≥ 5). If you do not have the proper privilege level, these numeric
entries are disabled. If you enter wrong/invalid values, a message appears displaying
Value out of limits.
Setpoint Mode Displays the Internal setpoint, the External setpoint, and the Real setpoint value.
The current setpoint mode is also displayed. When you click on this section, a sub pop-up
Setpoint opens at the bottom-right corner of the Detailed Adjustment window.
Output Displays the parameters from the associated AP_AP (positioner) block, which is linked
with the AP_PIF1 block.
Clicking on this section, a sub pop-up Output opens at the bottom-right corner of the
Detailed Adjustment window.

EIO0000001810 02/2014 97
AP_PIF1

Subsection Description
PIF1 Parameters This section:
 shows the PIF1 High Limit and PIF1 Low Limit.
 displays the PIF1 tuning parameters such as Gain, Delay Time, Time Constant,
Coincidance Point, Closed Loop Response Time, and Maximum Variation of Output
 displays the High Threshold, Low Threshold and Filtering Time for SP/PV Deviation in
PIF1 block.
 displays the PV tracking mode Enable/Disable state of PIF1 controller
 displays the enable/disable state of external close loop response time state for the
AP_PIF1 controller.
Click anywhere in this section to open a sub pop-up PIF1 Parameters containing the
variables explained above with user accessibility.
Process Analyst This process analyst plots the real-time value of output value, setpoint, and process value.
Sub Pop-ups There are 4 sub pop-ups:
 PV Alarm Threshold
 Setpoint
 Output
 PIF1 Parameters

PV Alarm Threshold
To enter the values of Very High Threshold and Very Low Threshold, you must be the
Maintenance Engineer or above (privilege level ≥ 5).
To enter the values of High Threshold and Low Threshold, you must be the Process
Engineer or above (privilege level ≥ 3).
You can also enter the hysteresis value only if you are a Maintenance Engineer or above
(privilege level ≥ 5).
If you do not have the proper privilege level, these numeric entries are disabled.
If you enter wrong/invalid values, a message appears displaying the text Value out of
limits.
Setpoints
In the Internal setpoint section, to enter the internal setpoint value, you must be the
Process Engineer or above (privilege level ≥ 3). You can also enter the maximum and
minimum limit of the internal setpoint. You must be the Process Engineer or above
(privilege level ≥ 3) to enter the maximum and minimum limits.
If you do not have proper privilege level, these buttons and numeric entries are disabled.
If you enter wrong/invalid values, a message appears displaying the text Value out of
limits
It also displays the external setpoint and current setpoint values.

98 EIO0000001810 02/2014
AP_PIF1

Subsection Description
Sub Pop-ups Output:
In this sub-popup, there are 6 sections:
 Owner
 Modes
 Input
 Manual Mode
 Output
 Current Mode

In the first section, the owner (Program/Operator)is selected.To operate these buttons,
you must be the Process Engineer or above (privilege level ≥ 3).
In second section, the following mode selection buttons are there:
 Auto
 Manual
 Cascade

NOTE: Cascade button is activated only if External SP is selected in the parameters of


the instance while instantiating the object in PES. Otherwise, it is disabled.

To operate these buttons, you must be the Process Engineer or above (privilege level ≥ 3).
In the third section, you can enter the input high and low peak limiting values of the
associated Analog positioner block. To enter these values, you must be the Process
Engineer or above (privilege level ≥ 3).
In the fourth section, you can enter the output value manually. To enter this output value,
you must be the Process Engineer or above (privilege level ≥ 3).
In the fifth section, you can enter the output high/low scale value of associated Analog
positioner. To enter these values, you must be the Maintenance Engineer or above
(privilege level ≥ 5).
In sixth section, the Current mode is displayed.
If you do not have proper privilege level, then these buttons and numeric entries are
disabled.
If you enter wrong/invalid values, a message appears displaying the text Value out of
limits.

EIO0000001810 02/2014 99
AP_PIF1

Subsection Description
Sub Pop-ups PIF1 Parameters:
This has 7 sections:
 PV Tracking
 External CLRT
 External DECOMP
 MSF1 Limits
 MSF1 Parameters
 SP/PV Deviation Parameters
 Initialization

In the first section, you can select the PV tracking through Enable/Disable buttons. To
operate these buttons, you must be the Process Engineer or above (privilege level ≥ 3).
In the second section, you can activate option of the external close loop response time
through Enable/Disable buttons. To operate these buttons, you must be the Process
Engineer or above (privilege level ≥ 3).
In the third section, you can activate option of the external decomposition time through
Enable/Disable buttons. To operate these buttons, you must be the Process Engineer or
above (privilege level ≥ 3).
In the fourth section, you can enter the PIF1 High Limit/Low Limit. To enter these values,
you must be the Process Engineer or above (privilege level ≥ 3).
In the fifth section, user can enter the PIF1 tuning parameters such as Gain, Delay Time,
Time Constant, Coincidance Point, Closed Loop Response Time, Maximum Variation,
and Decomposition Time Constant. of Output. To enter these values, you must be the
Process Engineer or above (privilege level ≥ 3).
In the sixth section, user can enter the High Threshold, Low Threshold and Filtering Time
values for SP/PV Deviation. To enter these values, you must be the Process Engineer or
above (privilege level ≥ 3).
The seventh section is for Initialization. The INIT button is available for the user to Initialize
the controller. To operate this button, you must be the Maintenance Engineer or above
(privilege level ≥ 5).
If you do not have proper privilege level, these buttons and numeric entries are disabled.
If you enter wrong/invalid values, then a message appears displaying the text Value out
of limits.
In time parameters, if you enter the hour value > 24 or < 0, a message displaying the text
Invalid value appears.
In time parameters, if you enter the minute value > 59 or < 0, a message displaying the
text Invalid value appears.
In time parameters, if you enter the second value > 59 or < 0, a message displaying the
text Invalid value appears.

100 EIO0000001810 02/2014


AP_PIF1

Alarm Configuration Tab


The following figure displays the Alarm Configuration tab of the AP_PIF1 block:

This tab has the following 3 subsections:


 Process Alarms
 Component Internal Alarms
 Modes

EIO0000001810 02/2014 101


AP_PIF1

This table explains the subsections of the Alarm Configuration tab:

Subsection Description
Process Alarms Displays the detected High Peak Limiting alarm, detected Low Peak Limiting alarm,
and detected SP/PV Deviation alarm text and alarm state with red/yellow flashing bell
in front of the respective text.
Click the respective alarm bell symbols only to acknowledge these detected alarms if
you are the Operator or above (privilege level ≥ 1).
You can enable or disable the detected High Peak Limiting alarm, detected Low Peak
Limiting alarm, and detected SP/PV Deviation alarm.
To enable or disable these detected alarms, you must be the Process Engineer or
above (privilege level ≥ 3). If you do not have the proper privilege level, these
Enable/Disable buttons for detected alarms are disabled.
Component Displays the detected Internal Component Fault, detected Invalid Signal, and
Internal Alarms detected Configuration Fault alarms text and alarm state.
Displays the detected Internal Component Fault alarm with red/yellow flashing bell in
front of the respective text.
Displays the detected Configuration Fault and Invalid Signal alarms with red bell in
front of the text.
Click the alarm bell symbol to acknowledge the detected Internal Component Fault
alarm if you are the Operator or above (privilege level ≥ 1).
You can enable or disable the detected Configuration Fault and detected Invalid
Signal alarms.
To enable or disable these detected alarms, you must be the Maintenance Engineer or
above (privilege level ≥ 5).
If you do not have the proper privilege level, these Enable/Disable buttons for detected
alarms are disabled.
Modes Displays the current active mode (Tracking mode) by displaying a green color check
mark in front of the text.
You can enable or disable the detected Tracking Mode alarms. To enable or disable
these detected alarms, you must be the Process Engineer or above (privilege level ≥ 3).
If you do not have the proper privilege level, these Enable/Disable buttons for detected
alarms are disabled.

102 EIO0000001810 02/2014


AP_PIF1

About Tab
The following figure displays the About tab of the AP_PIF1 block:

For detailed description, refer to About Tab .

EIO0000001810 02/2014 103


AP_PIF1

104 EIO0000001810 02/2014


Advanced Process Control Library V2.0
AP_PZTR
EIO0000001811 02/2014

Chapter 5
AP_PZTR: Zone Control with Non-Linear Time Response

AP_PZTR: Zone Control with Non-Linear Time Response

Overview
This chapter describes the AP_PZTR block.

What Is in This Chapter?


This chapter contains the following topics:
Topic Page
Introduction 106
DFB Representation 107
Public Variable Description 109
Genie Representation and Features 110
Faceplate Components and Features 111
Detailed Description 115

EIO0000001810 02/2014 105


AP_PZTR

Introduction

General
The AP_PZTR block is used for changing automatically the closed-loop time-response (CLRT)
when the process variable (XPV) is inside or outside a zone.
The AP_PZTR algorithm is based on basic principles:
 When the Process value is outside the zone, YCLRT is set to WCLRTLO. The controller puts the
PV back inside the zone.
 When the Process value is inside the zone, YCLRT varies linearly between WCLRTLO and
WCLRTHI as a function of the (PV-SP) deviation.

106 EIO0000001810 02/2014


AP_PZTR

DFB Representation

Overview
The DFB for AP_PZTR is designed as a function block with the input pins connected to the input
data sources and the output pins provide DFB function results to the output destinations.
The following figure shows the DFB representation of the AP_PZTR block:

NOTE:
 XCASIN is the setpoint of an upstream object
 XPV is the input parameter from a process variable.
 ZCLRT is the 95% close loop response time.

Parameter Description
Input Pin Details
This table describes the input pins of the AP_PZTR block:

Input Type Description


XCASIN PV_VC Upstream object setpoint
XPV PV_VC Process variable

Output Pin Details


This table describes the output pins of the AP_PZTR block:

Output Type Description


YSTAT BYTE Block status:
Bit Function
0 Ok.
1 Not Ok, the block is not working.
3 Detected Configuration Fault.
YSTAT2 DWORD Detected error code:
Bit Function
0 WCLRTHI < WCLRTLO
1 WZONE < 0
ZCLRT TIME 95% closed-loop response time

EIO0000001810 02/2014 107


AP_PZTR

Input/Output Pin Details


No input/output pins.

108 EIO0000001810 02/2014


AP_PZTR

Public Variable Description

This table describes the public variables of the AP_PZTR block:

Input Type Description


WALRPOT BYTE Options for detected alarms:
Bit Function
7 To mask the detected control-module alarm
WZONE REAL Zone value (XPV scale)
WCLRTLO TIME Closed loop response time low value
WCLRTHI TIME Closed loop response time high value
YALRCPT WORD Detected alarms in block:
Bit Function
7 Detected control-module alarm
9 Detected Invalid Signal alarm
15 Detected Internal Component Fault alarm (combination
of bits 7 and 9)
YCLRT TIME 95% closed loop response time

EIO0000001810 02/2014 109


AP_PZTR

Genie Representation and Features

AP_PZTR - Graphical Representation


This table shows the graphical representation (genie) of the AP_PZTR block:

Graphic Symbol HMI Symbol Name Description


apc_pztr_circle MIF1 Controller (circle symbol)

The necessary data for the animation of the genie and the interaction between HMI and function
block are transferred through the public variables.

Genie Elements
The AP_PZTR genie contains various elements to animate the PZTR functionality.
This table shows the representation of the icons in the AP_PZTR genie:

Graphic Symbol Description


Instance name display

Indicates the closed loop response time

Indicates the detected Internal Component Fault alarm

NOTE: You can click the detected fault indication symbol to acknowledge the above mentioned
detected alarms in the genie.
To acknowledge the detected alarms, you must be the Operator or above (privilege ≥ 1).

110 EIO0000001810 02/2014


AP_PZTR

Faceplate Components and Features

Introduction
Click the bottom rectangle (where detected Deviation alarm and Current operating mode are
displayed) of AP_PZTR genie to open the AP_PZTR faceplate. By default, the Control tab of the
faceplate is shown.
The AP_PIF1 faceplate:
 opens at the bottom-right corner of the genie
 contains the following tabs:
 Mode
 Alarm Configuration
 About (Information)

 shows the instance name on the top bar


 contains the Close button on the top bar

Faceplate
The faceplate of the AP_PZTR has the following tabs:
 Control
 Alarm Configuration
 About

Control Tab
The Control tab is the default tab of the AP_PZTR faceplate. The Control tab displays the
evolution of close loop response time.

EIO0000001810 02/2014 111


AP_PZTR

The following figure displays the Control tab of AP_PZTR faceplate:

This tab displays the zone details, minimum, and maximum values of closed loop response time
on the graph. The value of closed loop response time is displayed in yellow on the top of the graph.

112 EIO0000001810 02/2014


AP_PZTR

Alarm Configuration Tab


The following figure displays the Alarm Configuration tab of the AP_PZTR block:

This tab has Component Internal Alarms section.


This table explains the Component Internal Alarms section of the Alarm Configuration tab:

Section Description
Component Displays the detected Internal Component Fault, detected Invalid Signal, and
Internal Alarms detected Configuration Fault alarm text and detected alarm state.
Displays the detected Internal Component Fault alarm with red/yellow flashing bell in
front of the respective text.
Displays the detected Configuration Fault alarm and detected Invalid Signal alarm
with red bell in front of the text.
Click the alarm bell symbol to acknowledge the detected Internal Component Fault
alarm if you are the Operator or above (privilege level ≥ 1).
You can enable or disable the detected Configuration Fault alarm and detected
Invalid Signal alarm.
To enable or disable these detected alarms, you must be the Maintenance Engineer or
above (privilege level ≥ 5).
If you do not have the proper privilege level, these Enable/Disable buttons of the
detected alarms are disabled.

EIO0000001810 02/2014 113


AP_PZTR

About Tab
The following figure displays the About tab of the AP_PZTR block:

For detailed description, refer to About Tab .

114 EIO0000001810 02/2014


AP_PZTR

Detailed Description

Principles
The zone control is a way to obtain a smoother controller when the Process Value (XPV)is rather
close to its set point (XCASIN) in order to avoid active control actions produced by noisy
measurements.
The controller is thus less active than when the Process Value is far from the set point. This
technique is not equivalent to a dead zone, which does not act, as long as the Process Value is
within the dead zone.
The zone control does not leave any constant deviation. It will make the Process Value move back
slowly to the set point value.
 When XPV is outside the zone, the YCLRT is set to WCLRTLO (fastest response).
 When XPV is inside the zone, YCLRT is computed as follows:
YCLRT = WCLRTHI − (WCLRTHI − WCLRTLO) x |EPS|/WZONE
where EPS = XCASIN − XPV
This continuous variation of YCLRT with EPS avoids bumps when crossing the zone borders and
makes the controller strength proportional to the deviation.
This block will be used with Predictive controllers, as and when required.

EIO0000001810 02/2014 115


AP_PZTR

116 EIO0000001810 02/2014


Advanced Process Control Library V2.0
Use Case Examples
EIO0000001811 02/2014

Chapter 6
Use Case Examples

Use Case Examples

Overview
This section describes the various loops that can be made using PCR library blocks in various
scenarios.

What Is in This Chapter?


This chapter contains the following topics:
Topic Page
Use Case Example 1 118
Use Case Example 2 119

EIO0000001810 02/2014 117


Use Case Examples

Use Case Example 1

Basic PIF1/PSF1 Loop

118 EIO0000001810 02/2014


Use Case Examples

Use Case Example 2

PIF1/PSF1 Loop with Non Liner Time Response Control Block

EIO0000001810 02/2014 119


Use Case Examples

120 EIO0000001810 02/2014


Advanced Process Control Library V2.0
Index
EIO0000001811 02/2014

Index

A block, 69
AP_PSF1: simple predictive controller
AP_PIF1
function block, 33
derived data types, 76
AP_PZTR: zone control with non-linear
faceplate components and features, 82
time response, 105
genie representation and features, 79
introduction, 70
public variable description, 74 U
AP_PSF1
using the PCR library
derived data types, 40
basic features of the library, 12
detailed description, 68
generic information on faceplates, 21
DFB representation, 36
genie and faceplate representation sym-
faceplate components and features, 46
bol objects, 14
genie representation and features, 43
introduction, 34
public variable description, 38
AP_PZTR
detailed description, 115
DFB representation, 107
faceplate components and features, 111
genie representation and features, 110
introduction, 106
public variable description, 109

G
general information
PCR library application features, 9
general Information
PCR library application features, 23
general information
using the PCR library, 9, 11

P
PCR library application features
multilanguage support, 30
Multimonitor support, 26
sequence of events (SOE), 24
PCR library objects
AP_PIF1: Predictive Controller Function

EIO0000001810 02/2014 121


Index

122 EIO0000001810 02/2014