BM - AppProcedure For EAE 1
BM - AppProcedure For EAE 1
User Manual
EIO0000004853.02
04/2023
www.se.com
Legal Information
The Schneider Electric brand and any trademarks of Schneider Electric SE and its
subsidiaries referred to in this guide are the property of Schneider Electric SE or its
subsidiaries. All other brands may be trademarks of their respective owners.
This guide and its content are protected under applicable copyright laws and
furnished for informational use only. No part of this guide may be reproduced or
transmitted in any form or by any means (electronic, mechanical, photocopying,
recording, or otherwise), for any purpose, without the prior written permission of
Schneider Electric.
Schneider Electric does not grant any right or license for commercial use of the guide
or its content, except for a non-exclusive and personal license to consult it on an "as
is" basis. Schneider Electric products and equipment should be installed, operated,
serviced, and maintained only by qualified personnel.
As standards, specifications, and designs change from time to time, information
contained in this guide may be subject to change without notice.
To the extent permitted by applicable law, no responsibility or liability is assumed by
Schneider Electric and its subsidiaries for any errors or omissions in the informational
content of this material or consequences arising out of or resulting from the use of the
information contained herein.
Table of Contents
Safety Information ......................................................................................5
Before You Begin ..................................................................................5
Start-up and Test ..................................................................................6
Operation and Adjustments ...................................................................7
About the Book...........................................................................................8
Introduction ..................................................................................................9
Overview .................................................................................................10
List of Components .............................................................................10
Function Description ................................................................................. 11
Status and Commands..............................................................................12
Flow Diagram...........................................................................................14
Operating Modes......................................................................................16
Normal Phase.....................................................................................16
Exception Phase.................................................................................17
Exception Handling...................................................................................18
Strategy and Parameter Configuration .......................................................19
Initialization of Application .........................................................................20
HMI Compatibility .....................................................................................21
Phase Object .............................................................................................22
PhaseManager.........................................................................................23
Control ...............................................................................................23
Interface Representation ...............................................................23
Inputs...........................................................................................24
Outputs ........................................................................................24
Sequence .....................................................................................26
Offline Parametrization ..................................................................27
OPCUA ........................................................................................27
Supervision (EcoStruxure Automation Expert).......................................30
Symbols .......................................................................................30
Faceplate .....................................................................................33
Alarms..........................................................................................38
Supervision (Aveva System Platform)...................................................39
Supervision Functions ...................................................................39
Control/Supervision Relationship....................................................39
Parameters...................................................................................42
Symbols .......................................................................................47
Faceplate .....................................................................................48
Example of Use - PhaseManager...............................................................53
Configuration with Sequence Objects ...................................................54
Integration with AVEVA Batch Management ..........................................57
Customization ..........................................................................................64
Supporting Objects ...................................................................................69
Basics .....................................................................................................70
decodePhaseState .............................................................................70
Interface Representation ...............................................................70
Inputs...........................................................................................71
Outputs ........................................................................................71
encodePhasePara ..............................................................................72
EIO0000004853.02 3
Interface Representation ...............................................................73
Inputs...........................................................................................73
Outputs ........................................................................................74
encodeProcedureState .......................................................................74
Interface Representation ...............................................................74
Inputs...........................................................................................75
Outputs ........................................................................................76
phaseExceptionHandling.....................................................................77
Interface Representation ...............................................................77
Inputs...........................................................................................78
Outputs ........................................................................................79
S88StateControl .................................................................................80
Interface Representation ...............................................................80
Inputs...........................................................................................81
Outputs ........................................................................................82
Composites..............................................................................................84
phaseCommandSel ............................................................................84
Interface Representation ...............................................................84
Inputs...........................................................................................85
Outputs ........................................................................................87
seqConnect........................................................................................88
Interface Representation ...............................................................88
Outputs ........................................................................................88
stateManager .....................................................................................88
Interface Representation ...............................................................89
Inputs...........................................................................................89
Outputs ........................................................................................90
Adapters ..................................................................................................92
IPhase ...............................................................................................92
Interface Representation ...............................................................92
Inputs...........................................................................................92
Outputs ........................................................................................93
Composite Automation Types ....................................................................95
PhaseInterface ...................................................................................95
Interface Representation ...............................................................95
Outputs ........................................................................................95
Offline Parametrization ..................................................................96
OPCUA ........................................................................................96
PhaseRealParam ...............................................................................98
Interface Representation ...............................................................99
Inputs...........................................................................................99
Outputs ...................................................................................... 100
Offline Parametrization ................................................................ 100
OPCUA ...................................................................................... 100
4 EIO0000004853.02
Safety Information
Safety Information
Important Information
Read these instructions carefully, and look at the equipment to become familiar
with the device before trying to install, operate, service, 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.
The addition of this symbol to a “Danger” or “Warning” safety label indicates that an
electrical hazard exists which will result in personal injury if the instructions are not
followed.
This is the safety alert symbol. It is used to alert you to potential personal injury
hazards. Obey all safety messages that follow this symbol to avoid possible injury or
death.
! DANGER
DANGER indicates a hazardous situation which, if not avoided, will result in death or serious
injury.
! WARNING
WARNING indicates a hazardous situation which, if not avoided, could result in death or
serious injury.
! CAUTION
CAUTION indicates a hazardous situation which, if not avoided, could result in minor or
moderate injury.
NOTICE
NOTICE is used to address practices not related to physical injury.
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.
EIO0000004853.02 5
Safety Information
WARNING
UNGUARDED EQUIPMENT
• Do not use this software and related automation equipment on equipment
which does not have point-of-operation protection.
• Do not reach into machinery during operation.
Failure to follow these instructions can result in death, serious injury, or
equipment damage.
WARNING
EQUIPMENT OPERATION HAZARD
• Verify that all installation and set up procedures have been completed.
• Before operational tests are performed, remove all blocks or other temporary
holding means used for shipment from all component devices.
• Remove tools, meters, and debris from equipment.
Failure to follow these instructions can result in death, serious injury, or
equipment damage.
6 EIO0000004853.02
Safety Information
Follow all start-up tests recommended in the equipment documentation. Store all
equipment documentation for future references.
Software testing must be done in both simulated and real environments.
Verify that the completed system is free from all short circuits and temporary
grounds that are not installed according to local regulations (according to the
National Electrical Code in the U.S.A, for instance). If high-potential voltage
testing is necessary, follow recommendations in equipment documentation to
prevent accidental equipment damage.
Before energizing equipment:
• Remove tools, meters, and debris from equipment.
• Close the equipment enclosure door.
• Remove all temporary grounds from incoming power lines.
• Perform all start-up tests recommended by the manufacturer.
EIO0000004853.02 7
About the Book
Validity Note
This document has been updated with the release of the EcoStruxure Automation
Expert V23.1.
WARNING
UNINTENDED EQUIPMENT OPERATION
• Allow only authorized personnel with expertise in the design and operation of
control systems 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.
WARNING
UNINTENDED EQUIPMENT OPERATION
Adapt examples that are given in this manual to the specific functions and
requirements of your industrial application before you implement them.
Failure to follow these instructions can result in death, serious injury, or
equipment damage.
8 EIO0000004853.02
Introduction
What’s in This Part
Overview .......................................................................................................10
Function Description....................................................................................... 11
Status and Commands ...................................................................................12
Flow Diagram.................................................................................................14
Operating Modes ...........................................................................................16
Exception Handling ........................................................................................18
Strategy and Parameter Configuration .............................................................19
Initialization of Application...............................................................................20
HMI Compatibility ...........................................................................................21
EIO0000004853.02 9
Overview
Overview
What’s in This Chapter
List of Components .......................................................................................10
This document describes the operation of the function blocks that are available for
procedure control. These function blocks are included in the SE.AppProcedure
library and is used to monitor and manage control sequences.
List of Components
List of Functional Module
The following functional module object is described in this document:
10 EIO0000004853.02
Function Description
Function Description
The PhaseManager and related function blocks are used to monitor and manage
phases and their associated sequences that are available in a process. This
library works in coordination with sequence control blocks from SE.AppSequence
library, thus the operation here is based on the ISA-S88 Standard, Part 1 (S88.01i)
and implements the status controller defined in this standard for controlling
procedure model components (phases, operations, and so on).
As per the process requirements, user can configure different process phases
with their sequences applicable as mentioned in ISA-S88 Standard, Part 1
(S88.01i) such as, Running, Holding & Restarting, Stopping, and Aborting.
The following table explains the functions that are available in SE.AppProcedure
library:
S.No. Function
1 Designed to control different states in a phase such as Idle, Running, Holding,
Held, Restarting, Pausing, Paused, Stopping, Stopped, Aborting, Aborted,
and Complete.
10 15 input and 15 output user defined parameters (real data type) are available as a
default configuration. More parameters can be configured by customizing the
PhaseManager. Refer Customization, page 64.
EIO0000004853.02 11
Status and Commands
12 EIO0000004853.02
Status and Commands
Commands
The following table describes the possible sequence status:
EIO0000004853.02 13
Flow Diagram
Flow Diagram
State Diagram
The following diagram describes the possible phase statuses and phase
commands that the PhaseManager component manages according to the ISA-
S88 standard:
Next to the transition arrows, the phase commands that the component receives
(from the Supervision system or another higher-level phase) are shown in bold
uppercase fonts and status/commands that phase obtains from other blocks (for
example, use logic) are shown in parenthesis.
Transition Matrix
The following table describes the state transitions of the PhaseManager:
Initial No
state Com-
State Transition Matrix
mand
End State
Idle Running
Run-
Complete Stopping Holding Aborting Pausing
ning
Com-
plete Idle
Paus-
Paused Stopping Holding Aborting Running
ing
Hold-
Held Stopping Aborting
ing
Re-
start- Running Stopping Holding Aborting
ing
Stop-
Stopped Aborting
ping
Stop-
Aborting Idle
ped
14 EIO0000004853.02
Flow Diagram
Initial No
state Com-
State Transition Matrix
mand
End State
Abort-
ing Aborted
Abor-
Idle
ted
EIO0000004853.02 15
Operating Modes
Operating Modes
What’s in This Chapter
Normal Phase ...............................................................................................16
Exception Phase ...........................................................................................17
The user can select the required mode for Running sequence as well as for the
exception sequences via supervision systems.
Normal Phase
The following table provides the description of the operating modes for Running
sequence in PhaseManager:
16 EIO0000004853.02
Operating Modes
Exception Phase
The following table provides the description of the operating modes for exception
sequences such as Holding, Stopping, or Aborting in PhaseManager:
NOTE: Mode changes are not allowed for exceptions while any one of the
exception sequences is activated.
EIO0000004853.02 17
Exception Handling
Exception Handling
An event which occurs outside the normal or desired behavior of the procedure
control is commonly called an exception. Handling of these exceptions can occur
at all levels in the control activity model and can be a part of procedural, basic, and
coordination control.
Exception handling is an essential function of batch manufacturing. Exception
handling is an integral part of all controls and typically constitutes a very large
portion of the control definition.
Examples of events that indicates the need for exception handling are as follows:
• Unavailability of raw materials, utilities, or plant equipment when needed
• Product or process problems
• Control equipment malfunction
• Hazardous conditions such as fire or chemical spills
From the standpoint of control, exception handling is not different from desired
control strategies in which an event is detected, evaluated, and a response
generated.
Exception response functions can affect the modes and states of equipment
entities and procedural elements. For example, high pressure in a reactor could
lead to the exception response function which transfers the process to a Stopped
state, or an operator could detect some unusual condition and initiate similar
action.
Hence the user can configure the exception sequence (via Offline
Parameterization) to be executed once an exception (Failure) is detected.
Thus, once an exception (Failure) is detected in the PhaseManager, it
automatically executes the user configured sequence along with an alarm
indication.
Following table describes the Offline Parameter configuration values for
exception handling in PhaseManager:
1 Holding 0
2 Stopping 1
3 Aborting 2
NOTE: The exceptions are executed as per the exception mode defined by
the user. Refer Operating Modes, page 16 for more information.
18 EIO0000004853.02
Strategy and Parameter Configuration
EIO0000004853.02 19
Initialization of Application
Initialization of Application
SIFBs and IThis blocks are used in library objects, the initialization of which
required for normal operation. Libraries such as application, hardware, and
sequence have unique IDs that are responsible for identifying the library
application to be initialized. The different ids are APP_INIT for application
libraries, HW_INIT for hardware libraries, and SEQ_INIT for sequence libraries.
In the following example, the DPAC_FULLINIT block will initialize both the
hardware and application objects. The sequence object is initialized while the
block EVENTCHAINHEAD is running.
Since the initialization process is visible to the user, the DPAC_FULLINIT and
EVENTCHAINHEAD blocks must be triggered whenever the device is powered
on or after any on-line change for any application to function normally.
These initialization are mandatory for the user before developing any application.
20 EIO0000004853.02
HMI Compatibility
HMI Compatibility
HMI Compatibility allows the user to select respective operating system HMI. The
following are the two different HMI Compatibility options.
• Windows HMI - It supports in Windows platform only.
• Multi-OS HMI - It supports Multi OS platforms.
The user can be able to configure the Multi-OS HMI Compatibility by right clicking
the Solution (EAEApplicationLibraries) →Select HMI Compatibility →Multi-OS
HMI (as shown in the below image) for Multi-OS Compatibility. The case is similar
to convert from Multi-OS to Windows HMI. Where it will be in Multi-OS HMI before
conversion and you have to select Windows HMI.
EIO0000004853.02 21
Phase Object
What’s in This Part
PhaseManager ..............................................................................................23
Example of Use - PhaseManager ....................................................................53
Customization ................................................................................................64
22 EIO0000004853.02
PhaseManager
PhaseManager
What’s in This Chapter
Control .........................................................................................................23
Supervision (EcoStruxure Automation Expert) .................................................30
Supervision (Aveva System Platform) .............................................................39
General Description
This chapter describes the components that provide the functionality, control
services, and Supervision functions of the PhaseManager.
Overview
The PhaseManager functional module is used to monitor and manage the phase
control operation by accepting statuses and delivering appropriate commands to
the sequence blocks of SE.AppSequence library. Hence this module is based on
the ISA-S88 Standard, Part 1 (S88.01i) and implements the status controller
defined in this standard for controlling procedure model components (phases,
operations, and so on).
Control
This section describes the interface of PhaseManager.
Interface Representation
The following image represents the PhaseManager interface:
EIO0000004853.02 23
PhaseManager
Inputs
Input Event Interface
The following table describes the input event interface:
Sockets
The following table describes the sockets:
Adapter Inputs
The following table describes the adapters:
Outputs
Output Event Interface
The following table describes the output event interface:
24 EIO0000004853.02
PhaseManager
0 = Undefined
1 = IdleState
2 = RunningState
3 = HeldState
4 = StoppedState
5 = PausedState
6 = AbortedState
7 = CompleteState
8 = HoldingState
9 = RestartingState
10 = PausingState
11 = StoppingState
12 = AbortingState
13 = InterlockedState
Strategy UINT Phase strategy
Adapter Outputs
The following table describes the adapter outputs:
EIO0000004853.02 25
PhaseManager
Sequence
The sequence variables are defined in the table below:
0 = Auto
1 = Semi-Auto
2 = Manual
InstanceName. VTQ UINT Current strategy selection
currentStrategy (user-defined)
1 = Idle State
2 = Running State
3 = Held State
4 = Stopped State
5= Paused State
6 = Aborted State
7 = Complete State
8 = Holding State
9 = Restarting State
10 = Pausing State
11 = Stopping State
12 = Aborting State
13 = Interlocked State
InstanceName. VTQ BOOL 1 = Step exceeded
stepExceeded acknowledgement from
connected phases
0 = Auto
1 = Semi-Auto
2 = Manual
InstanceName. VTQ UINT Strategy selection for phase
strategy operation (user defined)
2 = Hold
4 = Restart
8 = Stop
16 = Reset
32 = Pause
64 = Resume
26 EIO0000004853.02
PhaseManager
128 = Abort
InstanceName. VTQ BOOL Semi Start command to the
semiStart phases in Semi-Auto mode
Offline Parametrization
The following table describes the offline parametrization:
1 = Semi-Auto
OPCUA
The following table describes the OPCUA:
EIO0000004853.02 27
PhaseManager
0=
Configuration
Error
1 = Idle State
2 = Running
State
3 = Held State
4 = Stopped
State
5= Paused
State
6 = Aborted
State
7 = Complete
State
8 = Holding
State
9 = Restarting
State
10 = Pausing
State
11 = Stopping
State
12 = Aborting
State
13 = Interlocked
State
IThis. UInt16 Current- 0 Current mode
CurrentMode Mode of running
phase:
0 = Auto
1 = Semi-Auto
2 = Manual
IThis. UInt16 Current- 0 Current
CurrentStrat- Strategy strategy
egy selection (user-
defined)
28 EIO0000004853.02
PhaseManager
0 = Undefined
1 = Start
2 = Hold
4 = Restart
8 = Stop
16 = Reset
32 = Pause
64 = Resume
128 = Abort
IThis.Mode UInt16 Mode 0 Mode of
running phase:
0 = Auto
1 = Semi-Auto
2 = Manual
IThis. Boolean SemiStart 0 Semi Start
SemiStart command to
the phases in
Semi-Auto
mode
IThis. UInt16 ManStepId 0 Manual step id
ManStepId for running
phase
0 = Holding
1 = Stopping
2 = Aborting
0 = Auto
1 = Semi-Auto
EIO0000004853.02 29
PhaseManager
Symbols
Symbol Representation
For more information, see the Supervision - EcoStruxure Automation Expert HMI
→ Graphics → Symbols section of the EcoStruxure Automation Expert - Common
Process Reference Manualdocument.
Icons
For more information, see the Supervision - EcoStruxure Automation Expert HMI
→ Graphics → Icons section of the EcoStruxure Automation Expert - Common
Process Reference Manual.
Symbols
The table describes the symbols of the PhaseManager control module:
30 EIO0000004853.02
PhaseManager
Symbol Properties
The symbol properties available for the user to configure the PhaseManager in
EcoStruxure Automation Expert are explained in this section.
The user can define a maximum of 16 Strategies with respective
ApplicableInputParameters. 15 InputParameters and 15 OutputParameters
are provided as default configuration of the library. Refer to Customization, page
64 for configuring more parameters.
The PhaseManager symbol attributes are shown in the image below:
EIO0000004853.02 31
PhaseManager
CommandButtonsWithPanel – Displays
PhaseManager symbol with State, Mode,
Strategy and Running Time along with
command buttons.
HideTagDisplayName • True: Hides the instance name on symbol.
• False: Shows the instance name on symbol.
32 EIO0000004853.02
PhaseManager
Faceplate
Representation of Supervision Data
Refer SE.AppCommonProcess library for general description of the graphic
elements and element styles that are used in faceplates.
Available Tabs
During operation, clicking the symbol displays a faceplate with the following tabs:
• Operation
• Output Parameter
NOTE:
The Output Parameter faceplate can be accessed by clicking the output
parameter symbol ( ) in the operator faceplate.
• Owner
NOTE: The Owner faceplate can be accessed by clicking the owner
EIO0000004853.02 33
PhaseManager
Operation Tab
The following image shows the Operator tab:
34 EIO0000004853.02
PhaseManager
Current Owner Current owner selected for operation. For more details,
refer to the AppBaseLibrary Owner CAT Online Help
document.
Owner Owner command (Program /Operator) Owner
Command Buttons
— START/OPEN
STRATEGY SELECTION FACEPLATE, HOLD,
PAUSE, RESUME, STOP, ABORT, RESET commands
for phase control operation.
EIO0000004853.02 35
PhaseManager
This tab shows the list of user defined output parameters and their process values
configured at Symbol Properties, page 31 section.
36 EIO0000004853.02
PhaseManager
Parameter Tab
The following image shows the Parameter tab:
NOTE: Exception mode change is not allowed when any of the exception
sequence is active.
EIO0000004853.02 37
PhaseManager
Alarms
The alarms available in this block are listed in the following table:
38 EIO0000004853.02
PhaseManager
Supervision Functions
Function Description
The main functions of $SEPhaseManager template are described in the following
table:
Function Description
Owner The object can be switched to different modes of operation like Program
and Operator. It allows to configure the allowed owner and the normal
owner.
Failure Allows to monitor the detected failure status. It also provides an option to
bypass and rearm individual conditions from Failure tab.
Process Parameter The user can configure the required number InputParameter,
OutputParameter, Strategyand applicable IP param for the strategy.
Control/Supervision Relationship
Control Resources
Supervision function is used to communicate with the control module function
PhaseManager in the SE.AppProcedure library.
Below are the attributes for which the data is exchanged through supervision:
EIO0000004853.02 39
PhaseManager
40 EIO0000004853.02
PhaseManager
EIO0000004853.02 41
PhaseManager
Parameters
Configuration Parameter
The below table describes the configuration parameters:
42 EIO0000004853.02
PhaseManager
EIO0000004853.02 43
PhaseManager
44 EIO0000004853.02
PhaseManager
EIO0000004853.02 45
PhaseManager
46 EIO0000004853.02
PhaseManager
Symbols
Representation of Supervision Data
You can find a brief description of the graphic elements and element styles used in
faceplates. For more information, see the Supervision - EcoStruxure Automation
Expert HMI→ Graphics → Icons section of the EcoStruxure Automation Expert -
Common Process Reference Manual.
Symbol Description
The embedded and link symbols that are included in the $SEPhaseManager
master template for different objects choices are described below.
Embedded Symbol
Embedded symbols have a fixed shape and help users directly drag and drop the
symbol on their respective pages:
EIO0000004853.02 47
PhaseManager
Link Symbol
Symbol Name: Link_PhaseManager
These symbols provide a wizard for the user to select while dragging and
dropping. The wizard option below provides the user with the option to select their
required symbol:
LabelType Defines how the label of the • Static Text - Static String
symbol is specified set by substitute string
function
• CustomPropertyLabel -
Define as dynamic name in
label custom property
• ObjectTagname - Display
tagname of the object
Faceplate
Representation of Supervision Data
You can find a brief description of the graphic elements and element styles used in
faceplates. For more information, see the Supervision - EcoStruxure Automation
Expert HMI→ Graphics → Icons section of the EcoStruxure Automation Expert -
Common Process Reference Manual.
Available Tabs
During operation, clicking the symbol displays a faceplate with the following tabs:
• Operation
• Input
• Output
• Failure(Optional)
• Permissive(Optional)
• Engineering
• Alarm
48 EIO0000004853.02
PhaseManager
Operation Tab
The following image shows the Operator tab:
Current Owner Current owner selected for operation. For more details,
refer to the AppBaseLibrary Owner CAT Online Help
document.
Owner Owner command (Program /Operator) Operator
EIO0000004853.02 49
PhaseManager
This tab shows the list of user defined output parameters and their process values
configured at Configuration Parameter, page 42 section.
50 EIO0000004853.02
PhaseManager
Parameter Tab
The following image shows the Parameter tab:
NOTE: Exception mode change is not allowed when any of the exception
sequence is active.
EIO0000004853.02 51
PhaseManager
Command Button
52 EIO0000004853.02
Example of Use - PhaseManager
EIO0000004853.02 53
Example of Use - PhaseManager
1 Create a new application (For example, ProcedureEm) under System tab as shown in the
image below:
2 Double-click the ProcedureEm to open it. Drag and drop the PhaseManager module from
SE.AppPreocedure library into the ProcedureEm and define the instance name in the
dialog box (for example, PhaseManager1). Click OK as shown in the image below:
3 To handle the output parameters, drag and drop the encodePhasePara basic block and
configure it with PhaseManager as shown in the image below . This basic block helps the
user to configure the process parameter feedbacks with the PhaseManager functional
block. As discussed earlier, by default 15 OutputParameters can be assigned to the
PhaseManager with a single instance of encodePhasePara.
54 EIO0000004853.02
Example of Use - PhaseManager
4 Input parameter data for Phase Management can be extracted from InputParameters
output variable of the PhaseManager. The user can utilize the SPLIT block functionality on
the variable to convert the structured formats of parameter data. Right click on
InputParameters and select create SPLIT functional block as shown below:
EIO0000004853.02 55
Example of Use - PhaseManager
5 Drag and drop the required sequence objects from SE.AppSequence library such as
SeqStep, SeqTransition, SeqTerminate along with seqParallelAlloc and
seqTransJumpBack composites and sequence action blocks etc. as per the process
requirements.
NOTE: The SeqHead block configurations are not required for phase management
since, its functionally is already handled internally by Procedure Manager functional
block.
For more information on sequence objects, refer SE.AppSequence library.
For the current example, a simple process sequence with two steps configured for each of
the phases is shown in the image below:
6 Map all the functional blocks to their respective controllers as per the requirement.
56 EIO0000004853.02
Example of Use - PhaseManager
10 Check and confirm that the instances are created under the control module Instances in the
Application, as shown in the below image:
11 Create the Canvas screen for the PhaseManager with related sequence objects to operate
the PhaseManager in the visualization run time. Configure the symbol properties as per the
process requirement.
EIO0000004853.02 57
Example of Use - PhaseManager
This section explains the integration procedure with Aveva Batch Management
System.
The states and commands that can be accessed from Aveva Batch Management
Systems are as follows:
• Batch States – READY, RUN, HELD, ABORTED, INTERLOCKED, DONE
• Batch Commands – START, HOLD, RESTART, ABORT
The figure given below shows the categorization of S88 state machine diagram
and Batch phase states.
58 EIO0000004853.02
Example of Use - PhaseManager
One batch consists of many phases. The user can create batch phase application
based on the process requirement.
To integrate the Batch Management system with EcoStruxure Automation Expert,
the user needs to use PhaseInterface, in which the interfacing attributes (States/
Commands) are exposed on OPCUA. The below figure shows the generic block
diagram representation:
EIO0000004853.02 59
Example of Use - PhaseManager
The below table shows the steps to configure Aveva Batch Management to
communicate EcoStruxure Automation Expert over OPCUA protocol.
Step Action
1 Go to System Platform Management Console, and add the OPCUA device connection as
shown below:
Configure the OPCUA server node. The server node can be the IP address of the machine
from where the OPCUA attributes of the EcoStruxure Automation Expert is to be accessed.
In this case EcoStruxure Automation Expert is available in the same machine. Follow the
below steps to configure the OPCUA server node:
• Configure the OPCUA Server URL with its port number.
• Make sure the OPCUA Namespace appears in the bottom table.
• Define the name of alias. In this case it is configured as ‘EAE’.
2 Add OPCUA device group connection under OPCUA device connection as shown in the
image below:
60 EIO0000004853.02
Example of Use - PhaseManager
The user can see the device group name path, by clicking on the group as shown in the
image below:
3 Go to the Aveva Batch Management, Environment Display. Open the TagLinker >> Edit
>> Access. The Access Editor window is opened. Add a new access name, for example
OPCUA . Provide the computer path location where the OI Gateway is configured. In this
case OI Gateway is on the local host. The service name for the OI.GATEWAY.2 is
GATEWAY as shown in the image below:
Provide the topic name same as Device Group Name Path mentioned in the OI Gateway
server. Refer to figure 2 of step 2, page 60. Close the Access Editor window.
4 In TagLinker, go to View >> Filter and select the Units and Connections, with necessary
type of attribute as shown below:
EIO0000004853.02 61
Example of Use - PhaseManager
5 In the below figure, the Tag Name column shows the tags created by the Batch
Management system and Item column shows the GUID variables from PhaseInterface.
The user has to configure every tag with the respective GUID of phase state and phase
command as shown in the below figure. The user has to change the access to the
GATEWAY which is created in step 3, page 61.
Prefix to the GUID is alias name of OPCUA Namespace, which is configured in step 1, page
60.
6 Link all the tags of each phase. After linking all the required tags, close the TagLinker.
62 EIO0000004853.02
Example of Use - PhaseManager
10 Start all the services from Runtime in Environment Display. Now the user can
communicate Batch management system with PhaseManager.
EIO0000004853.02 63
Customization
Customization
Customization of PhaseManager for expanding the input and output parameters
are explained in this chapter. Since input and output parameters are handled
through PhaseRealParam functional block, such parameters can be configured
by instantiating more PhaseRealParam blocks as per the requirement.
NOTE: One PhaseRealParam block supports 15 input and 15 output
Parameters. Customization of PhaseManager with more PhaseRealParam
blocks expands the parameters with an index value of 15.
For example, two PhaseRealParam blocks can introduce up to 30 input and
30 output parameters.
For current example, the process requirement is with 20 input parameters and 10
output parameters. Hence as discussed, the number of PhaseRealParam blocks
required are two. The procedure for configuring two PhaseRealParam blocks are
explained below:
Step Action
64 EIO0000004853.02
Customization
EIO0000004853.02 65
Customization
4 Navigate to the Composite tab of the MyPhaseManager equipment module and identify
the PhaseRealParam objects configured in the right-bottom corner. Instantiate the
required number of PhaseRealParam objects (two as per current process example) as
shown in the image below:
NOTE: It is required to maintain the consistency of naming philosophy for all
PhaseRealParam objects instances (Parameterx, where x = 01 to Required No.s
of PhaseRealParam objects in ascending order), as implemented in the
PhaseManager functional module.
For example, as per current process requirement two PhaseRealParam instances are
required. Thus the instance names should be configured as Parameter01 and
Parameter02 as shown in the image below.
66 EIO0000004853.02
Customization
The below image shows the final model of customized PhaseManager composite layer:
6 Click Save. As shown in the image below, ensure that the MyPhaseManager interface is
updated with new asset connections:
EIO0000004853.02 67
Customization
7 The MyPhaseManager CAT is now ready for operation. For more information on how to
configure PhaseManager blocks and their functional modules, see the Example of Use,
page 53.
68 EIO0000004853.02
Supporting Objects
What’s in This Part
Basics ...........................................................................................................70
Composites ...................................................................................................84
Adapters........................................................................................................92
Composite Automation Types..........................................................................95
EIO0000004853.02 69
Basics
Basics
What’s in This Chapter
decodePhaseState ........................................................................................70
encodePhasePara.........................................................................................72
encodeProcedureState ..................................................................................74
phaseExceptionHandling ...............................................................................77
S88StateControl............................................................................................80
decodePhaseState
General Description
The decodePhaseState block allows to decode structured Phase State
information to boolean data. It can be interfaced with the PhaseManager as
shown in the below image:
Interface Representation
The following image represents the decodePhaseState interface:
70 EIO0000004853.02
Basics
Inputs
Input Event Interface
The following table describes the input event interface:
Outputs
Output Event Interface
The following table describes the output event interface:
EIO0000004853.02 71
Basics
encodePhasePara
General Description
The encodePhasePara block is used to encode the parameters for phase
management (Real data type) to a structured format. The encodePhasePara
block can encode a maximum of 15 parameters . An example of configuring
OutputParameters with PhaseManager is shown in the below image:
72 EIO0000004853.02
Basics
Interface Representation
The following image represents the encodePhasePara interface:
Inputs
Input Event Interface
The following table describes the input event interface:
EIO0000004853.02 73
Basics
Outputs
Output Event Interface
The following table describes the output event interface:
encodeProcedureState
General Description
The encodeProcedureState block is used to encode the connected sequence
state of Phase management to a structured format. This block is used along with
phaseStateControl basic block for Phase state management.
Interface Representation
The following image represents the encodeProcedureState interface:
74 EIO0000004853.02
Basics
Inputs
Input Event Interface
The following table describes the input event interface:
0 = Not Connected
1 = Stopped State
2 = Running State
4 = Held State
8 = Finished State
16 = Pausing State
32 = Paused State
HoldingState Holding procedure state:
0 = Not Connected
1 = Stopped State
2 = Running State
4 = Held State
8 = Finished State
16 = Pausing State
32 = Paused State
RestartingState Restarting procedure state:
0 = Not Connected
1 = Stopped State
2 = Running State
4 = Held State
8 = Finished State
16 = Pausing State
32 = Paused State
EIO0000004853.02 75
Basics
0 = Not Connected
1 = Stopped State
2 = Running State
4 = Held State
8 = Finished State
16 = Pausing State
32 = Paused State
StoppingState Stopping procedure state:
0 = Not Connected
1 = Stopped State
2 = Running State
4 = Held State
8 = Finished State
16 = Pausing State
32 = Paused State
Outputs
Output Event Interface
The following table describes the output event interface:
76 EIO0000004853.02
Basics
0 = Not Connected
1 = Stopped State
2 = Running State
4 = Held State
8 = Finished State
16 = Pausing State
32 = Paused State
ProceduresConnected WORD Bitwise procedure
connected status (1 =
Connected, 0 = Not
connected) (Bit0 =
Running procedure, Bit1 =
Holding procedure, Bit2 =
Restarting procedure, Bit3
= Aborting procedure, Bit4
= Stopping procedure)
phaseExceptionHandling
General Description
The phaseExceptionHandling basic functional block manages the key role of
automated exception sequence management for PhaseManager if a failure is
detected. It commands the PhaseManager to automatically execute the exception
sequences such as, Holding , Stopping or Aborting ( user definition) if a failure
is detected.
Interface Representation
The following image represents the phaseExceptionHandling interface:
EIO0000004853.02 77
Basics
Inputs
Input Event Interface
The following table describes the input event interface:
78 EIO0000004853.02
Basics
0 = Holding
1 = Stopping
2 = Aborting
1 = IdleState
2 = RunningState
3 = HeldState
4 = StoppedState
5 = PausedState
6 = AbortedState
7 = CompleteState
8 = HoldingState
9 = RestartingState
10 = PausingState
11 = StoppingState
12 = AbortingState
13 = InterlockedState
PhaseCommand SE.AppProcedure. Phase command:
PhaseCommands
0 = Undefined
1 = Start
2 = Hold
4 = Restart
8 = Stop
16 = Reset
32 = Pause
64 = Resume
128 = Abort
Outputs
Output Event Interface
The following table describes the output event interface:
EIO0000004853.02 79
Basics
0 = Undefined
1 = Start
2 = Hold
4 = Restart
8 = Stop
16 = Reset
32 = Pause
64 = Resume
128 = Abort
S88StateControl
General Description
The S88StateControl basic function block is a state machine block of
PhaseManager functional module. This block makes transitions from one state to
another. When a new command with mode and a strategy (if available) is
provided, the process moves to Running state and performs its sequence
operations. Further a state transitions is made with respect to other commands
such as HOLD, PAUSE, STOP, ABORT etc. It executes the exception sequences
such as Holding, Stopping or Aborting (user defined) when a failure is detected.
For the above mentioned sequence operations, the S88StateControl block
converts all the commands received from PhaseManager to the operational
commands for the sequence library. Once the Running sequence is completed,
the state is confirmed as completed. When the user initiates a RESET command,
the phase is moved to Ready i.e, the PhaseManager is ready for the next
operation.
Interface Representation
The following image represents the S88StateControl interface:
80 EIO0000004853.02
Basics
Inputs
Input Event Interface
The following table describes the input event interface:
EIO0000004853.02 81
Basics
0 = Not Connected
1 = Stopped State
2 = Running State
4 = Held State
8 = Finished State
16 = Pausing State
32 = Paused State
PhaseCmd SE.AppProcedure. Phase command:
PhaseCommands
0 = Undefined
1 = Start
2 = Hold
4 = Restart
8 = Stop
16 = Reset
32 = Pause
64 = Resume
128 = Abort
Outputs
Output Event Interface
The following table describes the output event interface:
82 EIO0000004853.02
Basics
0 = Undefined,
1 = IdleState
2 = RunningState
3 = HeldState
4 = StoppedState
5 = PausedState
6 = AbortedState
7 = CompleteState
8 = HoldingState,
9 = RestartingState
10 = PausingState
11 = StoppingState
12 = AbortingState,
13 = InterlockedState
ProcedureName STRING[40] Procedure name to be
executed
ProcedureCmd UINT Command to the
procedure:
1 = Start
2 = Stop
4 = Hold
8 = Resume
16 = Pause
EIO0000004853.02 83
Composites
Composites
What’s in This Chapter
phaseCommandSel.......................................................................................84
seqConnect ..................................................................................................88
stateManager................................................................................................88
phaseCommandSel
General Description
The phaseCommandSel composite block manages the command, mode, and
strategy selections for the PhaseManager CAT, since the PhaseManager can
receive commands from both Operator owner as well as Program owners
(Program Local).
Interface Representation
The following image represents the phaseCommandSel interface:
84 EIO0000004853.02
Composites
Inputs
Input Event Interface
The following table describes the input event interface:
0 = Auto
1 = Semi-Auto
2 = Manual
Strategy1 Strategy selection from
source 1
EIO0000004853.02 85
Composites
0 = Undefined
1 = Start
2 = Hold
4 = Restart
8 = Stop
16 = Reset
32 = Pause
64 = Resume
128 = Abort
ManStepId1 Manual step id selection
from source 1
SemiStart1 BOOL Semi start command from
source 1
Sel2 1 = Source 2 is selected
Mode2 VTQUINT Mode selection from source
2:
0 = Auto
1 = Semi-Auto
2 = Manual
Strategy2 Strategy selection from
source 2
PhaseCmd2 SE.AppProcedure. Phase command from
PhaseCommands source 2:
0 = Undefined
1 = Start
2 = Hold
4 = Restart
8 = Stop
16 = Reset
32 = Pause
64 = Resume
128 = Abort
ManStepId2 VTQUINT Manual step id selection
from source 2
SemiStart2 VTQBOOL Semi start command from
source 2
ProcedureName STRING[40] Procedure name to be
executed
AutoReset BOOL 1 = Auto reset enabled,
State change from final
transient states to Idle
happens automatically
0 = Auto
1 = Semi-Auto
86 EIO0000004853.02
Composites
Outputs
Output Event Interface
The following table describes the output event interface:
0 = Auto
1 = Semi-Auto
2 = Manual
Strategy Phase strategy selection
0 = Undefined
1 = Start
2 = Hold
4 = Restart
8 = Stop
16 = Reset
32 = Pause
64 = Resume
128 = Abort
ManualStepId UINT Manual step id selection
EIO0000004853.02 87
Composites
seqConnect
General Description
The seqConnect composite block connects with the objects in the SE.
AppSequence library, that accepts the status informations such as Sequence
States, Step Id, and Running Time information and in return it sends Sequence
Commands, Mode, and Manual Step Id . The seqConnect composite block is
the wrapper of basic SeqHead composite block.
Interface Representation
The following image represents the seqConnect interface:
Outputs
Adapter Outputs
The following table describes the adapter outputs:
stateManager
General Description
The stateManager composite block acts a wrapper for phaseStateControl and
phaseExceptionHandling basic blocks. It receives commands from the
PhaseManager CAT and preforms sequence operations and state management.
It also provides the operational commands for the sequences configured with the
PhaseManager.
88 EIO0000004853.02
Composites
Interface Representation
The following image represents the stateManager interface:
Inputs
Input Event Interface
The following table describes the input event interface:
EIO0000004853.02 89
Composites
1 = Start
2 = Hold
4 = Restart
8 = Stop
16 = Reset
32 = Pause
64 = Resume
128 = Abort
ExceptionProcedure UINT Procedure to execute while
exception active:
0 = Holding
1 = Stopping
2 = Aborting
Outputs
Output Event Interface
The following table describes the output event interface:
90 EIO0000004853.02
Composites
0 = Undefined
1 = IdleState
2 = RunningState
3 = HeldState
4 = StoppedState
5 = PausedState
6 = AbortedState
7 = CompleteState
8 = HoldingState
9 = RestartingState
10 = PausingState
11 = StoppingState
12 = AbortingState
13 = InterlockedState
ProcedureName STRING[40] Procedure name to be
executed
ConfigError BOOL 1 = Configuration error
detected (Running
sequence is not
connected)
EIO0000004853.02 91
Adapters
Adapters
What’s in This Chapter
IPhase..........................................................................................................92
IPhase
General Description
The IPhase object enables the bidirectional transfer of phase mode, strategy,
command, and parameter informations from PhaseManager to upstream
functional bock PLI. This results in establishing a seamless communication
between them.
Interface Representation
The following image represents the IPhase interface:
Inputs
Input Event Interface
The following table describes the input event interface:
92 EIO0000004853.02
Adapters
1 = IdleState
2 = RunningState
3 = HeldState
4 = StoppedState
5 = PausedState
6 = AbortedState
7 = CompleteState
8 = HoldingState
9 = RestartingState
10 = PausingState
11 = StoppingState
12 = AbortingState
13 = InterlockedState
StepExceeded VTQBOOL Step exceed information
Outputs
Output Event Interface
The following table describes the output event interface:
EIO0000004853.02 93
Adapters
0 = Auto
1 = Semi-Auto
2 = Manual
Strategy Phase strategy selection
0 = Undefined
1 = Start
2 = Hold
4 = Restart
8 = Stop
16 = Reset
32 = Pause
64 = Resume
128 = Abort
SemiStart VTQBOOL Semi start command
ManStepId VTQUINT Manual step id selection
94 EIO0000004853.02
Composite Automation Types
PhaseInterface
General Description
This chapter describes the components that provide the functionality, control
services, and Supervision functions of the PhaseInterface functional block.
Overview
The PhaseInterface functional module is used to interface the PhaseManager
CAT with external batching interfaces such as AVEVATM Batch Management.
The PhaseInterface accepts commands from external interfaces and transfer it to
the PhaseManager and in return it updates statuses from the PhaseManager to
external batching interfaces.
Interface Representation
The following image represents the PhaseInterface interface:
Outputs
Output Event Interface
No output event interface.
EIO0000004853.02 95
Composite Automation Types
Plugs
The following table describes the plugs:
Offline Parametrization
No offline parametrization.
OPCUA
The following table describes the OPCUA:
0 = Auto
1 = Semi-Auto
2 = Manual
IThis. UInt16 Current- 0 Current phase
CurrentStart- Startegy strategy
egy selection
96 EIO0000004853.02
Composite Automation Types
EIO0000004853.02 97
Composite Automation Types
0 = Auto
1 = Semi-Auto
2 = Manual
IThis. UInt16 ManualSte- 0 Step ID for
ManualStepId pId manual
operation
PhaseRealParam
General Description
This chapter describes the components that provide the functionality, control
services, and Supervision functions of the PhaseRealParam functional block.
Overview
The PhaseRealParam functional block handles the parameter management
functionalities for PhaseManager CAT. It accepts the input parameter setpoints
from Strategy Selection faceplates and expose at PhaseManager CAT. The
98 EIO0000004853.02
Composite Automation Types
users can utilize these data for the phase management operations. In return,
PhaseRealParam reads the output parameter process values for the data
management at the supervision levels as well as external interfaces.
Interface Representation
The following image represents the PhaseRealParam interface:
Inputs
Input Event Interface
The following table describes the input event interface:
EIO0000004853.02 99
Composite Automation Types
Outputs
Output Event Interface
The following table describes the output event interface:
Offline Parametrization
The following table describes the offline parametrization:
OPCUA
The following table describes the OPCUA:
100 EIO0000004853.02
Composite Automation Types
EIO0000004853.02 101
Composite Automation Types
102 EIO0000004853.02
Printed in:
Schneider Electric
35 rue Joseph Monier
92500 Rueil Malmaison - France
+ 33 (0) 1 41 29 70 00
Schneider Electric
35 rue Joseph Monier
92500 Rueil Malmaison
France
+ 33 (0) 1 41 29 70 00
www.se.com