The CLAMP Control Loop Automation Composition Runtime Lifecycle Management uses the following system-level dialogues. These dialogues enable the CLAMP runtime capabilities described in Section 2 of TOSCA Defined Automation Compositions: Architecture and Design. Design Time dialogues will be described in future releases of the system.
1 Commissioning Dialogues
Commissioning dialogues are used to commission and decommission Control Loop Automation Composition Type definitions and to set the values of Common Parameters.
1.1 Commissioning a Control Loop Type Definition using the CLAMP GUI
Commissioning an Automation Composition Type is a three-step process
- The Automation Composition Type must be created, that is the Automation Composition Type definition must be loaded and stored in the database. This step may be carried out over the REST interface or using SDC distribution.
- The Common Properties of the Automation Composition type must be assigned values and those values must be stored in the database. This step is optional only if all mandatory common properties have default values. The Common Property values may be set and amended over and over again in multiple sessions until the Automation Composition Type is primed.
- The Automation Composition Type Definition and the Common Property values must be primed, which is sent to the concerned participants. Once an Automation Composition Type is primed, its Common Property values can no longer be changed. To change Common Properties on a primed Automation Composition Type, all instances of the Automation Composition Type must be removed and the Automation Composition Type must be de-primed.
1.1 Commissioning an Automation Composition Type Definition using the CLAMP GUI
This dialogue corresponds to a "File→Import" menu on the CLAMP GUI. The documentation of future releases of the system will describe how the Design Time functionality interacts with the Runtime commissioning API.
PlantUML Macro |
---|
@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
database Commissioned_ACM_Inventory
CLAMP_GUI -> CLAMP_Runtime: [REST] Commission Automation Composition Type Definition
CLAMP_Runtime -> Commissioned_ACM_Inventory: Store Automation Composition Type Definition
CLAMP_Runtime -> CLAMP_GUI: [REST] Type Definition Commissioned
@enduml |
1.2 Commissioning an Automation Composition Type Definition using SDC
PlantUML Macro |
---|
@startuml
participant SDC
participant Policy_Distribution
participant CLAMP_Runtime
database Commissioned_ACM_Inventory
SDC -> Policy_Distribution: [DMaaP] CSAR containing Automation Composition Type Definition
Policy_Distribution -> CLAMP_Runtime: [REST] Commission Automation Composition Type Definition
CLAMP_Runtime -> Commissioned_ACM_Inventory: Store Automation Composition Type Definition
CLAMP_Runtime -> Policy_Distribution: [REST] Type Definition Commissioned
Policy_Distribution -> SDC: [DMaaP] Deployment Completed
@enduml |
1.3 Setting Common Properties for an Automation Composition Type Definition
This dialogue sets the values of common properties. The values of the common properties may be set, updated, or deleted at will, as this dialogue saves the properties to the database but does not send the definitions or properties to the participants. However, once an Automation Composition Type Definition and its properties are primed (See Section 1.4), the properties cannot be changed until the Automation Composition type definition is de-primed (See Section 1.5).
PlantUML Macro |
---|
@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
participant Participant
database Commissioned_ACM_Inventory
CLAMP_GUI -> CLAMP_Runtime: [REST] Read Automation Composition Type Definitions
CLAMP_Runtime -> Commissioned_ACM_Inventory: Read Automation Composition Type Definitions
CLAMP_Runtime -> CLAMP_GUI: [REST] Type Definitions returned
CLAMP_GUI -> CLAMP_GUI: Select Automation Composition Type Definition for Parameterization
CLAMP_GUI -> CLAMP_Runtime: [REST] Fetch GUI fields for Common Parameter Definitions
alt Automation Composition Type Definition not Commissioned on Participants
CLAMP_Runtime -> Commissioned_ACM_Inventory: Read Automation Composition Type Definition
CLAMP_Runtime -> CLAMP_Runtime: Generate fields for Common Parameters for GUI
CLAMP_Runtime -> CLAMP_GUI: [REST] Return GUI fields Common Parameter Definitions
CLAMP_GUI -> CLAMP_GUI: Render UI for Common Parameters
CLAMP_GUI -> CLAMP_GUI: Get values for Common Parameters from user
CLAMP_GUI -> CLAMP_Runtime: [REST] Set values for Common Parameters
CLAMP_Runtime -> Commissioned_ACM_Inventory: Store values for Common Parameters
CLAMP_Runtime -> CLAMP_GUI: [REST] Common Parameter values stored
else Automation Composition Type Definition already Commissioned on Participants
CLAMP_Runtime -> CLAMP_GUI: [REST] Cannot set Common Parameters on\nAutomation Composition Type Definition that has\nbeen commissioned on participants
end
@enduml |
1.4 Priming an Automation Composition Type Definition on Participants
The Priming operation sends Automation Composition Type definitions and common property values to participants. Once an Automation Composition Type definition is primed, its property values can on longer be changed until it is de-primed.
PlantUML Macro |
---|
@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
participant Participant
database Commissioned_ACM_Inventory
CLAMP_GUI -> CLAMP_Runtime: [REST] Read Automation Composition Type Definitions
CLAMP_Runtime -> Commissioned_ACM_Inventory: Read Automation Composition Type Definitions
CLAMP_Runtime -> CLAMP_GUI: [REST] Type Definitions returned
CLAMP_GUI -> CLAMP_GUI: Select Automation Composition Type Definition for Priming on Participants
CLAMP_GUI -> CLAMP_Runtime: [REST] Prime Automation Composition Type Definition on Participants
alt Automation Composition Type Definition not Primed on Participants
CLAMP_Runtime -> Commissioned_ACM_Inventory: Read Automation Composition Type Definition
CLAMP_Runtime -> Commissioned_ACM_Inventory: Read Common Parameter Values for Automation Composition Type Definition
alt Common Parameter values set for Automation Composition Type Definition
CLAMP_Runtime -> Participants: [DMaaP] Update Participants with Automation Composition Type Definition and values for Common Parameters
CLAMP_Runtime -> CLAMP_GUI: [REST] Automation Composition Type Definition priming ordered on participants
else Automation Composition Type Definition already primed on Participants
CLAMP_Runtime -> CLAMP_GUI: [REST] Common Parameters not set\non Automation Composition Type Definition
end
else Automation Composition Type Definition already primed on Participants
CLAMP_Runtime -> CLAMP_GUI: [REST] Cannot set Common Parameters on\nAutomation Composition Type Definition that has\nbeen primed on participants
end
== Participant Responses ==
Participants -> CLAMP_Runtime: [DMaaP] Result of Update with Automation Composition Type Definition and values for Common Parameters
CLAMP_Runtime -> Commissioned_ACM_Inventory: Store result of Automation Composition Type Definition Update on Participant
== Supervision ==
loop forever
CLAMP_Runtime -> Commissioned_ACM_Inventory: Read Automation Composition Type Definitions
loop over each Automation Composition Type Definition
alt Automation Composition Type Definition Participant priming underway
CLAMP_Runtime -> Commissioned_ACM_Inventory: read result of Automation Composition Type Definition Updates from participants
alt Updates completed on all participants
CLAMP_Runtime -> Commissioned_ACM_Inventory: set Automation Composition Type Definition as primed on Participants
else Updates not completed
alt Priming of Automation Composition Type Definition on participants timed out
CLAMP_Runtime -> Commissioned_ACM_Inventory: set Automation Composition Type Definition priming as timed out on Participants
CLAMP_Runtime -> CLAMP_Runtime: Log error
else Wait for updates to complete
end
end
else Automation Composition Type Definition Participant priming not underway
end
end
end
@enduml |
1.5 De-Prime an Automation Composition Type Definition on Participants
This dialogue allows an Automation Composition Type Definition to be de-primed so that it can be deleted or its common parameter values can be altered.
PlantUML Macro |
---|
@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
participant Participant
database Commissioned_ACM_Inventory
CLAMP_GUI -> CLAMP_Runtime: [REST] Read Automation Composition Type Definitions
CLAMP_Runtime -> Commissioned_ACM_Inventory: Read Automation Composition Type Definitions
CLAMP_Runtime -> CLAMP_GUI: [REST] Type Definitions returned
CLAMP_GUI -> CLAMP_GUI: Select Automation Composition Type Definition for de-priming on Participants
CLAMP_GUI -> CLAMP_Runtime: [REST] De-prime Automation Composition Type Definition on Participants
alt Automation Composition Type Definition primed on Participants
alt Automation Composition Instances do not exist for Automation Composition Type Definition
CLAMP_Runtime -> Participants: [DMaaP] Update Participants, removing Automation Composition Type Definition and values for Common Parameters
CLAMP_Runtime -> CLAMP_GUI: [REST] Automation Composition Type Definition de-priming ordered on participants
else Automation Composition Instances exist for Automation Composition Type Definition
CLAMP_Runtime -> CLAMP_GUI: [REST] Automation Composition Type Definition cannot be\n de-primed on participants\nit is in use on Automation Compositions
end
else Automation Composition Type Definition not primed on Participants
CLAMP_Runtime -> CLAMP_GUI: [REST] Automation Composition Type Definition has not\nbeen primed on participants
end
== Participant Responses ==
Participants -> CLAMP_Runtime: [DMaaP] Result of Update to remove Automation Composition Type Definition and values for Common Parameters
CLAMP_Runtime -> Commissioned_ACM_Inventory: Store result of Automation Composition Type Definition Update on Participant
== Supervision ==
loop forever
CLAMP_Runtime -> Commissioned_ACM_Inventory: Read Automation Composition Type Definitions
loop over each Automation Composition Type Definition
alt Automation Composition Type Definition Participant de-prime underway
CLAMP_Runtime -> Commissioned_ACM_Inventory: read result of Automation Composition Type Definition Updates from participants
alt Updates completed on all participants
CLAMP_Runtime -> Commissioned_ACM_Inventory: set Automation Composition Type Definition as de-primeed on Participants
else Updates not completed
alt De-priming of Automation Composition Type Definition on participants timed out
CLAMP_Runtime -> Commissioned_ACM_Inventory: set Automation Composition Type Definition de-priming as timed out on Participants
CLAMP_Runtime -> CLAMP_Runtime: Log error
else Wait for updates to complete
end
end
else Automation Composition Type Definition Participant de-prime not underway
end
end
end
@enduml |
1.6 Decommissioning an Automation Composition Type Definition in CLAMP
PlantUML Macro |
---|
@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
database Commissioned_ACM_Inventory
CLAMP_GUI -> CLAMP_Runtime: [REST] Read Automation Composition Type Definitions
CLAMP_Runtime -> Commissioned_ACM_Inventory: Read Automation Composition Type Definitions
CLAMP_Runtime -> CLAMP_GUI: [REST] Type Definitions returned
CLAMP_GUI -> CLAMP_GUI: Select Automation Composition Type Definition for Decommissioning
CLAMP_GUI -> CLAMP_Runtime: [REST] Decommission Automation Composition Type Definition
alt Automation Composition Type Definition not primed on Participants
CLAMP_Runtime -> Commissioned_ACM_Inventory: Delete Automation Composition Type Definition
CLAMP_Runtime -> CLAMP_GUI: [REST] Type Definition Decommissioned
else Automation Composition Type Definition is Commissioned on Participants
CLAMP_Runtime -> CLAMP_GUI: [REST] Automation Composition Type Definition cannot be decommissioned\nit is primed on participants
end
@enduml |
1.7 Reading Commissioned Automation Composition Type Definitions
PlantUML Macro |
---|
@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
database Commissioned_ACM_Inventory
CLAMP_GUI -> CLAMP_Runtime: [REST] Read Automation Composition Type Definitions
CLAMP_Runtime -> Commissioned_ACM_Inventory: Read Automation Composition Type Definitions
CLAMP_Runtime -> CLAMP_GUI: [REST] Type Definitions returned
@enduml |
2. Instantiation Dialogues
Instantiation dialogues are used to create, set parameters on, instantiate, update, and remove Automation Composition instances.
Assume a suitable Automation Composition Definition exists in the Commissioned Automation Composition Inventory. To get an Automation Composition instance running one would, for example, execute dialogues 2.1, 2.3, and 2.4.
2.1 Creating an Automation Composition Instance
PlantUML Macro |
---|
@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
database Commissioned_ACM_Inventory
database Instantiated_ACM_Inventory
CLAMP_GUI -> CLAMP_Runtime: [REST] Read Automation Composition Type Definitions
CLAMP_Runtime -> Commissioned_ACM_Inventory: Read Automation Composition Type Definitions
CLAMP_Runtime -> CLAMP_GUI: [REST] Type Definitions returned
CLAMP_GUI -> CLAMP_GUI: Select Automation Composition Type Definition to use to create Automation Composition Instance
CLAMP_GUI -> CLAMP_Runtime: [REST] Fetch GUI fields for Instance Specific Parameter Definitions
CLAMP_Runtime -> Commissioned_ACM_Inventory: Read Automation Composition Type Definition
CLAMP_Runtime -> CLAMP_Runtime: Generate fields for Instance Specific Parameters for GUI
CLAMP_Runtime -> CLAMP_GUI: [REST] Return GUI fields Instance Specific Parameter Definitions
CLAMP_GUI -> CLAMP_GUI: Render UI for Instance Specific Parameters
CLAMP_GUI -> CLAMP_GUI: Get values for Instance Specific Parameters from user
CLAMP_GUI -> CLAMP_Runtime: [REST] Request Creation of Automation Composition Instance
CLAMP_Runtime -> CLAMP_Runtime: Create Automation Composition Instance
CLAMP_Runtime -> Instantiated_ACM_Inventory: Store First Version of Automation Composition Instance
CLAMP_Runtime -> CLAMP_GUI: [REST] Automation Composition Instance Updated
@enduml |
Note that this dialogue creates the Automation Composition Instance in the Instantiated Automation Composition Inventory. The instance is sent to the participants using the process described in the dialogue in Section 2.3.
2.2 Updating Instance Specific Parameters on an Automation Composition Instance
PlantUML Macro |
---|
@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
database Instantiated_ACM_Inventory
CLAMP_GUI -> CLAMP_Runtime: [REST] Read Automation Composition Instances
CLAMP_Runtime -> Instantiated_ACM_Inventory: Read Automation Composition Instances
CLAMP_Runtime -> CLAMP_GUI: [REST] Automation Composition Instances returned
CLAMP_GUI -> CLAMP_GUI: Select Automation Composition Instance on which to Update Parameters
CLAMP_GUI -> CLAMP_GUI: Step version of Automation Composition Instance as Major/Minor/Patch
CLAMP_GUI -> CLAMP_Runtime: [REST] Fetch GUI fields for Instance Specific Parameter Definitions
CLAMP_Runtime -> Instantiated_ACM_Inventory: Read Automation Composition Type Definition
CLAMP_Runtime -> CLAMP_Runtime: Generate fields for Instance Specific Parameters for GUI
CLAMP_Runtime -> CLAMP_GUI: [REST] Return GUI fields Instance Specific Parameter Definitions
CLAMP_GUI -> CLAMP_GUI: Render UI for Instance Specific Parameters
CLAMP_GUI -> CLAMP_GUI: Get values for Instance Specific Parameters from user
CLAMP_GUI -> CLAMP_Runtime: [REST] Request Update of Automation Composition Instance
CLAMP_Runtime -> CLAMP_Runtime: Update Automation Composition Instance
CLAMP_Runtime -> Instantiated_ACM_Inventory: Store New Version of Automation Composition Instance
CLAMP_Runtime -> CLAMP_GUI: [REST] Automation Composition Instance Updated
@enduml |
2.3 Updating an Automation Composition Instance with a Configuration on Participants
PlantUML Macro |
---|
@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
participant Participant
database Instantiated_ACM_Inventory
CLAMP_GUI -> CLAMP_Runtime: [REST] Read all configuration versions of Automation Composition Instance
CLAMP_Runtime -> Instantiated_ACM_Inventory: Read all configuration versions of Automation Composition Instance
CLAMP_Runtime -> CLAMP_GUI: [REST] All configuration versions of Automation Composition Instance returned
CLAMP_GUI -> CLAMP_GUI: Select configuration version of Automation Composition Instance for Instantiation Participants
CLAMP_GUI -> CLAMP_Runtime: [REST] Instantiate selected configuration version of Automation Composition Instance on Participants
alt Selected configuration version of Automation Composition Instance not instantiated on Participants
CLAMP_Runtime -> Instantiated_ACM_Inventory: Read configuration version of Automation Composition Instance
CLAMP_Runtime -> Participants: [DMaaP] Update Participants with configuration version of Automation Composition Instance
CLAMP_Runtime -> CLAMP_GUI: [REST] Instantiation of configuration version of Automation Composition Instance ordered on participants
else Selected configuration version of Automation Composition Instance instantiated on Participants
CLAMP_Runtime -> CLAMP_GUI: [REST] configuration version of Automation Composition Instance already instantiated on participants
end
== Participant Responses ==
Participants -> CLAMP_Runtime: [DMaaP] Result of update of configuration version of Automation Composition Instance on participant
CLAMP_Runtime -> Instantiated_ACM_Inventory: Store result of update of configuration version of Automation Composition Instance on participant
== Supervision ==
loop forever
CLAMP_Runtime -> Instantiated_ACM_Inventory: Read Automation Composition Instances
loop over each Automation Composition Instance
alt Automation Composition Instance configuration version update underway on participants
CLAMP_Runtime -> Instantiated_ACM_Inventory: read result of Automation Composition updates from participants
alt Updates completed on all participants
CLAMP_Runtime -> Instantiated_ACM_Inventory: set configuration version of Automation Composition Instance as Instantiated on Participants
CLAMP_Runtime -> Instantiated_ACM_Inventory: set overall configuration version of Automation Composition Instance state as Instantiated
else Updates not completed
alt Instantiation of Automation Composition Instance on participants timed out
CLAMP_Runtime -> Instantiated_ACM_Inventory: set configuration version Automation Composition Instance Instantiation as timed out on Participants
CLAMP_Runtime -> CLAMP_Runtime: Log error
else Wait for updates to complete
end
end
else Automation Composition Instance configuration version update on participants not underway
end
end
end
@enduml |
2.4 Changing the state of an Automation Composition Instance on Participants
PlantUML Macro |
---|
@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
participant Participant
database Instantiated_ACM_Inventory
CLAMP_GUI -> CLAMP_Runtime: [REST] Read all Instantiated Automation Composition Instances
CLAMP_Runtime -> Instantiated_ACM_Inventory: Read all Instantiated Automation Composition Instances
CLAMP_Runtime -> CLAMP_GUI: [REST] All Instantiated Automation Composition Instances returned
CLAMP_GUI -> CLAMP_GUI: Select Automation Composition Instance on which to change state and specify new state
CLAMP_GUI -> CLAMP_Runtime: [REST] Change state of selected Automation Composition Instance on Participants
alt Selected Automation Composition Instance instantiated on Participants
CLAMP_Runtime -> Participants: [DMaaP] Request change of state of Automation Composition Instance
CLAMP_Runtime -> CLAMP_GUI: [REST] Change of state of Automation Composition Instance ordered on participants
else Selected Automation Composition Instance not instantiated on Participants
|
PlantUML Macro |
---|
@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
database Database
CLAMP_GUI -> CLAMP_Runtime: [REST] Commission Control Loop Type Definition
CLAMP_Runtime -> Database: Store Control Loop Type Definition
CLAMP_Runtime -> CLAMP_GUI: [REST] Type Definition Commissioned
@enduml |
1.2 Commissioning a Control Loop Type Definition using SDC
PlantUML Macro |
---|
@startuml
participant SDC
participant Policy_Distribution
participant CLAMP_Runtime
database Database
SDC -> Policy_DistributionAutomation Composition Instance not instantiated on participants
end
== Participant Responses ==
Participants -> CLAMP_Runtime: [DMaaP] CSAR containing Control Loop Type Definition
Policy_Distribution Result of State Change of Automation Composition Instance on participant
CLAMP_Runtime -> CLAMPInstantiated_ACM_RuntimeInventory: Store [REST]result Commissionof ControlState LoopChange Type Definition
CLAMP_Runtime -> Database: Store Control Loop Type Definition
of Automation Composition Instance on participant
== Supervision ==
loop forever
CLAMP_Runtime -> PolicyInstantiated_ACM_DistributionInventory: [REST]Read TypeAutomation DefinitionComposition Commissioned
Policy_Distribution -> SDC: [DMaaP] Deployment Completed
@enduml |
1.3 Setting Common Parameters for a Control Loop Type Definition
PlantUML Macro |
---|
@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
participant Participant
database Database
CLAMP_GUI -> CLAMP_Runtime: [REST] Read Control Loop Type Definitions
Instances
loop over each Automation Composition Instance
alt Automation Composition Instance State Change underway on participants
CLAMP_Runtime -> Database: Read Control Loop Type Definitions
CLAMP_Runtime -> CLAMP_GUI: [REST] Type Definitions returned
CLAMP_GUI -> CLAMP_GUI: Select Control Loop Type Definition for Parameterization
CLAMP_GUI -> CLAMP_Runtime: [REST] Fetch GUI fields for Common Parameter Definitions
alt Control Loop Type Definition not Commissioned on Participants
Instantiated_ACM_Inventory: read result of Automation Composition State Change from participants
alt Updates completed on all participants
CLAMP_Runtime -> Instantiated_ACM_Inventory: set Automation Composition Instance state as changed on Participants
CLAMP_Runtime -> Database: Read Control Loop Type Definition
CLAMP_Runtime -> CLAMP_Runtime: Generate fields for Common Parameters for GUI
CLAMP_Runtime -> CLAMP_GUI: [REST] Return GUI fields Common Parameter Definitions
CLAMP_GUI -> CLAMP_GUI: Render UI for Common Parameters
CLAMP_GUI -> CLAMP_GUI: Get values for Common Parameters from user
CLAMP_GUIInstantiated_ACM_Inventory: set overall Automation Composition Instance state as changed
else Updates not completed
alt Automation Composition Instance State Change on participants timed out
CLAMP_Runtime -> Instantiated_ACM_Inventory: set Automation Composition State Change as timed out on Participants
CLAMP_Runtime -> CLAMP_Runtime: [REST] Set values for Common Parameters
CLAMP_Runtime -> Database: Store values for Common Parameters
CLAMP_Runtime -> CLAMP_GUI: [REST] Common Parameter values stored
else Control Loop Type Definition already Commissioned on Participants
CLAMP_Runtime -> CLAMP_GUI: [REST] Cannot set Common Parameters on\nControl Loop Type Definition that has\nbeen commissioned on participants
end
@enduml |
...
Log error
else Wait for updates to complete
end
end
else Automation Composition Instance State Change on participants not underway
end
end
end
@enduml |
2.5 De-instantiating an Automation Composition Instance from Participants
PlantUML Macro |
---|
@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
participant Participant
database DatabaseInstantiated_ACM_Inventory
CLAMP_GUI -> CLAMP_Runtime: [REST] Read all ControlInstantiated LoopAutomation TypeComposition DefinitionsInstances
CLAMP_Runtime -> DatabaseInstantiated_ACM_Inventory: Read all ControlInstantiated LoopAutomation TypeComposition DefinitionsInstances
CLAMP_Runtime -> CLAMP_GUI: [REST] Type Definitions All Instantiated Automation Composition Instances returned
CLAMP_GUI -> CLAMP_GUI: Select ControlAutomation LoopComposition TypeInstance Definition for Commissioning on Participantsto de-instantiate
CLAMP_GUI -> CLAMP_Runtime: [REST] CommissionDe-instantiate Controlselected LoopAutomation TypeComposition DefinitionInstance on Participants
alt ControlSelected LoopAutomation TypeComposition DefinitionInstance not Commissionedinstantiated on Participants
CLAMP_Runtime -> DatabaseParticipants: Read Control Loop Type Definition [DMaaP] Update Participants to remove Automation Composition Instance
CLAMP_Runtime -> DatabaseCLAMP_GUI: Read Common Parameter Values for Control Loop Type Definition
alt Common Parameter values set for Control Loop Type Definition
[REST] De-instantiation of Automation Composition Instance ordered on participants
else Selected Automation Composition Instance not instantiated on Participants
CLAMP_Runtime -> ParticipantsCLAMP_GUI: [DMaaPREST] UpdateAutomation ParticipantsComposition withInstance Controlnot Loopinstantiated Typeon Definition and values for Common Parameters
CLAMP_Runtime participants
end
== Participant Responses ==
Participants -> CLAMP_GUIRuntime: [RESTDMaaP] ControlResult of Loopupdate Typeof DefinitionAutomation commissioningComposition orderedInstance on participants
else Control Loop Type Definition already Commissioned on Participants
participant
CLAMP_Runtime -> Instantiated_ACM_Inventory: Store result of update of Automation Composition Instance on participant
== Supervision ==
loop forever
CLAMP_Runtime -> CLAMPInstantiated_ACM_GUIInventory: [REST] Common Parameters not set\non Control Loop Type Definition
end
else Control Loop Type Definition already Commissioned on Participants
Read Automation Composition Instances
loop over each Automation Composition Instance
alt Automation Composition Instance de-instantiation update underway on participants
CLAMP_Runtime -> CLAMPInstantiated_ACM_GUI: [REST] Cannot set Common Parameters on\nControl Loop Type Definition that has\nbeen commissioned on participants
end
== Participant Responses ==
Participants -> CLAMP_Runtime: [DMaaP] Result of Update with Control Loop Type Definition and values for Common Parameters
Inventory: read result of Automation Composition updates from participants
alt Updates completed on all participants
CLAMP_Runtime -> Instantiated_ACM_Inventory: set Automation Composition Instance as de-instantiated on Participants
CLAMP_Runtime -> Database: Store result of Control Loop Type Definition Update on Participant
== Supervision ==
loop forever
CLAMP_Runtime -> Database: Read Control Loop Type Definitions
loop over each Control Loop Type Definition
alt Control Loop Type Definition Participant Commission underway
Instantiated_ACM_Inventory: set overall Automation Composition Instance as de-instantiated
else Updates not completed
alt Automation Composition Instance de-instantiation Update timed out on participants
CLAMP_Runtime -> Instantiated_ACM_Inventory: set Automation Composition Instance de-instantiation as timed out on Participants
CLAMP_Runtime -> DatabaseCLAMP_Runtime: readLog resulterror
of Control Loop Type Definition Updates from participants
else Wait for updates to complete
alt Updates completed on all participants
end
CLAMP_Runtime -> Database: set Controlend Loop
Type Definition as Commissioned on Participants
else Updates not completed else Automation Composition Instance de-instantiation update on participants not underway
end
end
@enduml |
2.6 Deleting an Automation Composition Instance
PlantUML Macro |
---|
@startuml
participant alt Commissioning of Control Loop Type Definition on participants timed out
CLAMP_GUI
participant CLAMP_Runtime
database Instantiated_ACM_Inventory
CLAMP_GUI -> CLAMP_Runtime: [REST] Read all Automation Composition Instances
CLAMP_Runtime -> Instantiated_ACM_Inventory: Read all Automation Composition Instances
CLAMP_Runtime -> DatabaseCLAMP_GUI: set[REST] ControlAll LoopAutomation TypeComposition Definition commissioning as timed out on Participants
CLAMP_RuntimeInstances returned
CLAMP_GUI -> CLAMP_GUI: Select Automation Composition Instance to delete
CLAMP_GUI -> CLAMP_Runtime: Log error
else Wait for updates to complete
end
end
else Control Loop Type Definition Participant Commission not underway
end
end
@enduml |
1.5 Decommissioning a Control Loop Type Definition on Participants
...
[REST] Delete selected Automation Composition Instance
alt Selected Automation Composition Instance exists
CLAMP_Runtime -> Instantiated_ACM_Inventory: Delete Automation Composition instance
CLAMP_Runtime -> CLAMP_GUI: [REST] Automation Composition Instance deleted
else Selected Automation Composition Instance does not exist
CLAMP_Runtime -> CLAMP_GUI: [REST] Automation Composition Instance does not exist
end
@enduml |
2.7 Reading Automation Composition Instances
PlantUML Macro |
---|
@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
participant Participant
database DatabaseInstantiated_ACM_Inventory
CLAMP_GUI -> CLAMP_Runtime: [REST] Read Controlall LoopAutomation TypeComposition DefinitionsInstances
CLAMP_Runtime -> DatabaseInstantiated_ACM_Inventory: Read Controlall LoopAutomation TypeComposition DefinitionsInstances
CLAMP_Runtime -> CLAMP_GUI: [REST] All TypeAutomation Composition DefinitionsInstances returned
CLAMP_GUI -> CLAMP_GUI: Select Control Loop Type Definition for Decommissioning on Participants
CLAMP_GUI
@enduml |
3. Monitoring Dialogues
Monitoring dialogues are used to monitor and read statistics on Automation Composition Instances.
3.1 Reporting of Monitoring Information and Statistics by Participants
PlantUML Macro |
---|
@startuml
participant CLAMP_Runtime
participant Participant
database Instantiated_ACM_Inventory
Participant -> CLAMP_Runtime: [RESTDMaaP] DecommissionParticipant Controland LoopAutomation TypeComposition DefinitionElement on Participants
alt Control Loop Type Definition Commissioned on Participants
alt Control Loop Instances do not exist for Control Loop Type Definition
Monitoring and Statistics report
CLAMP_Runtime -> Instantiated_ACM_Inventory: Store Participant and Automation Composition Element Monitoring and Statistics report
alt Fault reported on Participant
CLAMP_Runtime -> ParticipantsCLAMP_Runtime: [DMaaP]log Updatefault Participants, removing Control Loop Type Definition and values for Common Parameters
on Participant
CLAMP_Runtime -> CLAMPInstantiated_ACM_GUIInventory: [REST]Record Controlfault Loop Type Definition decommissioning ordered on participants
else Control Loop Instances exist for Control Loop Type Definitionon Participant
end
loop Over all Automation Composition Elements in Participant Report
alt Fault reported on Automation Composition Element
CLAMP_Runtime -> CLAMP_GUIRuntime: [REST]log Controlfault Loopon TypeAutomation DefinitionComposition cannotElement be\nand decommissionedAutomation onComposition participants\nit is in use onCLAMP_Runtime -> Instantiated_ACM_Inventory: Record fault on Automation Composition Element and Automation Composition end
end
@enduml |
3.2 Viewing of Monitoring Information
PlantUML Macro |
---|
@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
database Instantiated_ACM_Inventory
== Overview of all Automation Composition Instances ==
CLAMP_GUI control loops
end
else Control Loop Type Definition not Commissioned on Participants
CLAMP_Runtime -> CLAMP_GUI: [REST] Control Loop Type Definition has not\nbeen commissioned on participants
end
== Participant Responses ==
Participants -> CLAMP_Runtime: [DMaaPREST] ResultRead ofall UpdateAutomation to remove Control Loop Type Definition and values for Common ParametersComposition Instances
CLAMP_Runtime -> Instantiated_ACM_Inventory: Read all Automation Composition Instances
CLAMP_Runtime -> DatabaseCLAMP_GUI: Store[REST] resultAll ofAutomation ControlComposition Loop Type Definition Update on Participant
== Supervision ==
loop forever
CLAMP_RuntimeInstances returned
CLAMP_GUI -> DatabaseCLAMP_GUI: ReadDisplay Controloverview Loopof Typestatus Definitions
of all loopAutomation over each Control Loop Type Definition
alt Control Loop Type Definition Participant decommission underway
CLAMP_Runtime -> Database: read result of Control Loop Type Definition Updates from participants
alt Updates completed on all participants
Composition Instances
== Details of a Automation Composition Instance ==
CLAMP_GUI -> CLAMP_Runtime: [REST] Read Automation Composition Elements for Automation Composition Instance
CLAMP_Runtime -> Instantiated_ACM_Inventory: Read Automation Composition Elements for Automation Composition Instance
CLAMP_Runtime -> DatabaseCLAMP_GUI: set[REST] ControlAutomation LoopComposition Type Definition as decommissioned on Participants
else Updates not completed
alt Commissioning of Control Loop Type Definition on participants timed out
Elements returned
CLAMP_GUI -> CLAMP_GUI: Display status of Automation Composition Elements in Automation Composition Instance
== Overview of all Participants ==
CLAMP_GUI -> CLAMP_Runtime: [REST] Read all participants
CLAMP_Runtime -> Instantiated_ACM_Inventory: Read all participants
CLAMP_Runtime -> DatabaseCLAMP_GUI: set Control Loop Type Definition decommissioning as timed out on Participants
CLAMP_Runtime[REST] All participants returned
CLAMP_GUI -> CLAMP_GUI: Display overview of status of all participants
== Details of a Participant ==
CLAMP_GUI -> CLAMP_Runtime: Log error
else Wait for updates to complete
end
end
else Control Loop Type Definition Participant decommission not underway
end
end
@enduml |
1.6 Decommissioning a Control Loop Type Definition in CLAMP
PlantUML Macro |
---|
@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
database Database
[REST] Read Automation Composition Elements for Participant
CLAMP_Runtime -> Instantiated_ACM_Inventory: Read Automation Composition Elements for Participant
CLAMP_Runtime -> CLAMP_GUI: [REST] Automation Composition Elements returned
CLAMP_GUI -> CLAMP_GUI: Display status of Automation Composition Elements in Participant
== Filtered Monitoring ==
CLAMP_GUI -> CLAMP_GUI: Set filter for Automation Composition Instances, Automation Composition Elements, and Participants
CLAMP_GUI -> CLAMP_Runtime: [REST] Read Automation Composition ControlElements Loopthat Typematch Definitionsfilter
CLAMP_Runtime -> DatabaseInstantiated_ACM_Inventory: Read Automation Composition ControlElements Loopthat Typematch Definitionsfilter
CLAMP_Runtime -> CLAMP_GUI: [REST] Type Definitions Automation Composition Elements that match filter returned
CLAMP_GUI -> CLAMP_GUI: Select Control Loop Type Definition for Decommissioning> CLAMP_GUI: Display status of Automation Composition Elements that match filter
@enduml |
3.2 Viewing of Statistics
PlantUML Macro |
---|
@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
database Instantiated_ACM_Inventory
== Statistics of all Automation Composition Instances ==
CLAMP_GUI -> CLAMP_Runtime: [REST] DecommissionRead Controlsummary Loopstatistics Type Definition
alt Control Loop Type Definition not Commissioned on Participants
for all Automation Composition Instances
CLAMP_Runtime -> Database: Delete Control Loop Type Definition
Instantiated_ACM_Inventory: Compile summary statistics for all Automation Composition Instances
CLAMP_Runtime -> CLAMP_GUI: [REST] TypeSummary Definitionstatistics Decommissioned
else Control Loop Type Definition not Commissioned on Participants
CLAMP_Runtimefor all Automation Composition Instances returned
CLAMP_GUI -> CLAMP_GUI: [REST]Display Controlsummary Loopstatistics Typefor Definitionall cannotAutomation be decommissioned\nit is commissioned on participants
end
@enduml |
1.7 Reading Commissioned Control Loop Type Definitions
PlantUML Macro |
---|
@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
database Database
Composition Instances
== Statistics of a Automation Composition Instance ==
CLAMP_GUI -> CLAMP_Runtime: [REST] Read Control Loop Type Definitions: [REST] Read statistics for Automation Composition Elements for Automation Composition Instance
CLAMP_Runtime -> Database: Read Control Loop Type DefinitionsInstantiated_ACM_Inventory: Compile statistics for Automation Composition Elements for Automation Composition Instance
CLAMP_Runtime -> CLAMP_GUI: [REST] Type Definitions Statistics for Automation Composition Elements returned
@enduml |
2. Instantiation Dialogues
Instantiation dialogues are used to create, set parameters on, instantiate, update, and remove Control Loop instances.
2.1 Creating a Control Loop Instance
PlantUML Macro |
---|
@startuml
participant CLAMP_GUI
participant -> CLAMP_Runtime
participant Participant
database Database
GUI: Display statistics for Automation Composition Elements in Automation Composition Instance
== Statistics of all Participants ==
CLAMP_GUI -> CLAMP_Runtime: [REST] Read Control Loop Type Definitionssummary statistics for all Automation Composition Instances
CLAMP_Runtime -> Database: Read Control Loop Type DefinitionsInstantiated_ACM_Inventory: Compile summary statistics for all Automation Composition Instances
CLAMP_Runtime -> CLAMP_GUI: [REST] Type Definitions [REST] Summary statistics for all Automation Composition Instances returned
CLAMP_GUI -> CLAMP_GUI: Display Selectsummary Controlstatistics Loopfor Typeall DefinitionAutomation to use to create Control Loop InstanceComposition Instances
== Statistics of a Participant ==
CLAMP_GUI -> CLAMP_Runtime: [REST] FetchRead GUIstatistics fieldsfor forAutomation InstanceComposition SpecificElements Parameterfor DefinitionsParticipant
CLAMP_Runtime -> Database: Read Control Loop Type Definition
CLAMP_Runtime -> CLAMP_Runtime: Generate fields for Instance Specific Parameters for GUIInstantiated_ACM_Inventory: Read statistics for Automation Composition Elements for Participant
CLAMP_Runtime -> CLAMP_GUI: [REST] Return GUIStatistics fieldsfor InstanceAutomation SpecificComposition ParameterElements Definitionsreturned
CLAMP_GUI -> CLAMP_GUI: RenderDisplay UIstatistics for Instance Specific Parameters Automation Composition Elements in Participant
== Filtered Statistics ==
CLAMP_GUI -> CLAMP_GUI: GetSet valuesfilter for Instance Specific Parameters from user Automation Composition Instances, Automation Composition Elements, and Participants
CLAMP_GUI -> CLAMP_Runtime: [REST] Request Creation of Control Loop Instance Read statistics for Automation Composition Elements that match filter
CLAMP_Runtime -> CLAMPInstantiated_ACM_RuntimeInventory: Create Control Loop Instance Read statistics for Automation Composition Elements that match filter
CLAMP_Runtime -> Database: Store First Version of Control Loop Instance
CLAMP_RuntimeCLAMP_GUI: [REST] Statistics for Automation Composition Elements that match filter returned
CLAMP_GUI -> CLAMP_GUI: [REST] Control Loop Instance Updated Display statistics for Automation Composition Elements that match filter
@enduml |
2.2 Updating Instance Specific Parameters on a Control Loop Instance
3.3 Statistics Housekeeping
PlantUML Macro |
---|
@startuml
participant CLAMP_Runtime
database Instantiated_ACM_Inventory
== Automation Composition Instance Statistics ==
loop forever
CLAMP_Runtime -> Instantiated_ACM_Inventory: Read Automation Composition Instance Statistics
|
PlantUML Macro |
---|
@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
participant Participant
database Database
CLAMP_GUI -> CLAMP_Runtime: [REST] Read Control Loop Instances
CLAMP_Runtime -> DatabaseCLAMP_Runtime: ReadSummarise Automation ControlComposition LoopInstance InstancesStatistics
CLAMP_Runtime -> CLAMPInstantiated_ACM_GUIInventory: Store [REST]summarised ControlAutomation LoopComposition InstancesInstance returnedStatistics
CLAMP_GUIRuntime -> CLAMPInstantiated_ACM_GUIInventory: SelectDelete ControlAutomation LoopComposition Instance Statistics on which retention toperiod Update Parameters
CLAMP_GUI -> CLAMP_GUI: Step version of Control Loop Instance as Major/Minor/Patch
CLAMP_GUI -> CLAMP_Runtime: [REST] Fetch GUI fields for Instance Specific Parameter Definitions
has expired
end
== Participant Statistics ==
loop forever
CLAMP_Runtime -> Instantiated_ACM_Inventory: Read Participant Statistics
CLAMP_Runtime -> DatabaseCLAMP_Runtime: ReadSummarise ControlParticipant LoopStatistics
Type Definition
CLAMP_Runtime -> CLAMP_Runtime Instantiated_ACM_Inventory: GenerateStore fieldssummarised for Instance Specific Parameters for GUI
Participant Statistics
CLAMP_Runtime -> CLAMPInstantiated_ACM_GUIInventory: Delete [REST]Participant ReturnStatistics GUIon fieldswhich Instanceretention Specificperiod Parameter Definitions
CLAMP_GUI -> CLAMP_GUI: Render UI for Instance Specific Parameters
CLAMP_GUI -> CLAMP_GUI: Get values for Instance Specific Parameters from user
CLAMP_GUI -> CLAMP_Runtime: [REST] Request Update of Control Loop Instance
CLAMP_Runtime -> CLAMP_Runtime: Update Control Loop Instance
CLAMP_Runtime -> Database: Store New Version of Control Loop Instance
has expired
end
@enduml |
4. Supervision Dialogues
Supervision dialogues are used to check the state of Automation Composition Instances and Participants.
4.1 Supervise Participants
PlantUML Macro |
---|
@startuml
participant CLAMP_Runtime
database Instantiated_ACM_Inventory
loop forever
CLAMP_Runtime -> Instantiated_ACM_Inventory: Read Participants
loop Over each Participant
alt Participant has not reported in last reporting window
CLAMP_Runtime -> CLAMP_GUIRuntime: Log [REST]Participant Controlas Loophaving Instance Updated
@enduml |
2.3 Updating a Control Loop Instance Version on Participants
PlantUML Macro |
---|
@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
participant Participant
database Database
CLAMP_GUImissed a report
CLAMP_Runtime -> CLAMPInstantiated_ACM_RuntimeInventory: [REST]Increment Readmissed all versions of Control Loop Instance
CLAMP_Runtime -> Database: Read all versions of Control Loop Instance
CLAMP_Runtime -> CLAMP_GUI: [REST] All versions of Control Loop Instance returned
CLAMP_GUI -> CLAMP_GUI: Select version of Control Loop Instance for Instantiation Participants
CLAMP_GUIreport counter on Participant
alt Participant has exceeded alarm threshold on missed report counter
CLAMP_Runtime -> CLAMP_Runtime: [REST]Raise Instantiatea selectedParticipant version of Control Loop Instance on Participants
alt Selected version of Control Loop Instance not instantiated on Participants
Offline alarm on participant
CLAMP_Runtime -> Database: Read version of Control Loop Instance
CLAMP_Runtime -> Participants: [DMaaP] Update Participants with version of Control Loop Instance
Instantiated_ACM_Inventory: Mark participant as being offline
end
else Participant has reported in last reporting window
CLAMP_Runtime -> CLAMPInstantiated_ACM_GUIInventory: [REST] Instantiation of Version of Control Loop Instance ordered on participants
else Selected version of Control Loop Instance instantiated on Participants
Clear missed report counter on Participant
alt Participant marked as being offline
CLAMP_Runtime -> CLAMP_GUIRuntime: [REST]Clear VersionParticipant ofOffline Controlalarm Loopon Instanceparticipant
already instantiated on participants
end
== Participant Responses ==
Participants -> CLAMP_Runtime: [DMaaP] Result of update of version of Control Loop Instance on participant
CLAMP_Runtime -> Database: Store result of update of version of Control Loop Instance on participant
== Supervision ==-> Instantiated_ACM_Inventory: Mark participant as being online
end
end
end
end
@enduml |
4.2 Supervise Automation Compositions
PlantUML Macro |
---|
@startuml
participant CLAMP_Runtime
database Instantiated_ACM_Inventory
loop forever
CLAMP_Runtime -> DatabaseInstantiated_ACM_Inventory: Read ControlAutomation LoopComposition Instances
loop overOver each ControlAutomation LoopComposition Instance
altloop ControlOver Loopeach InstanceAutomation Instantiation update underway on participants
CLAMP_Runtime -> Database: read result of Control Loop updates from participants
alt Updates completed on all participants
Composition Element
alt Automation Composition Element has not reported in last reporting window
CLAMP_Runtime -> Database: set version of Control Loop Instance as Instantiated on Participants
CLAMP_Runtime: Log Automation Composition Element as having missed a report
CLAMP_Runtime -> DatabaseInstantiated_ACM_Inventory: setIncrement overallmissed versionreport ofcounter Controlon LoopAutomation Instance state as Instantiated
else Updates not completed
Composition Element
else Automation Composition altElement Instantiationhas ofreported Controlin Looplast Instancereporting onwindow
participants timed out
CLAMP_Runtime -> DatabaseInstantiated_ACM_Inventory: setClear versionmissed Controlreport Loopcounter Instanceon InstantiationAutomation asComposition timedElement
out on Participants
end
CLAMP_Runtime -> CLAMP_Runtime: Logalt error
Automation Composition Element in incorrect state in last elsereporting Waitwindow
for updates to complete
CLAMP_Runtime -> CLAMP_Runtime: Log end
Automation Composition Element as being in endincorrect state
else Control Loop Instance Instantiation update on participants not underway
end
end
@enduml |
2.5 Changing the state of a Control Loop Instance on Participants
PlantUML Macro |
---|
@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
participant Participant
database Database
CLAMP_GUI -> CLAMP_Runtime: [REST] Read all Instantiated Control Loop Instances
CLAMP_Runtime -> Database: Read all Instantiated Control Loop Instances
CLAMP_Runtime -> CLAMP_GUI: [REST] All Instantiated Control Loop Instances returned
CLAMP_GUI -> CLAMP_GUI: Select Control Loop Instance on which to change state and specify new state
CLAMP_GUICLAMP_Runtime -> Instantiated_ACM_Inventory: Record Automation Composition Element as being in incorrect state
else Automation Composition Element not in incorrect state in last reporting window
alt Automation Composition Element was in incorrect state on previous report
CLAMP_Runtime -> CLAMP_Runtime: [REST] ChangeLog stateAutomation ofComposition selectedElement Controlas Loopbeing Instancein oncorrect Participantsstate
alt Selected Control Loop Instance instantiated on Participants
CLAMP_Runtime -> Participants: [DMaaP] Request change of state of Control Loop Instance
CLAMP_Runtime -> CLAMP_GUI: [REST] Change of state of Control Loop Instance ordered on participants
else Selected Control Loop Instance not instantiated on Participants
Instantiated_ACM_Inventory: Record Automation Composition Element as being in correct state
end
end
alt Automation Composition Element reported fault in last reporting window
CLAMP_Runtime -> CLAMP_GUIRuntime: Log [REST]Automation ControlComposition LoopElement Instanceas notbeing instantiatedfaulty
on participants
end
== Participant Responses ==
Participants -> CLAMP_Runtime: [DMaaP] Result of State Change of Control Loop Instance on participant
CLAMP_Runtime -> Database: Store result of State Change of Control Loop Instance on participant
== Supervision ==
loop forever
CLAMP_Runtime -> Database: Read Control Loop Instances
loop over each Control Loop Instance
alt Control Loop Instance State Change underway on participants
-> Instantiated_ACM_Inventory: Record Automation Composition Element as being faulty
else Automation Composition Element did not report fault in last reporting window
alt Automation Composition Element reported fault on previous report
CLAMP_Runtime -> Database: read result of Control Loop State Change from participants
alt Updates completed on all participants
CLAMP_Runtime -> Database: set Control Loop Instance state as changed on Participants
CLAMP_Runtime -> Database: set overall Control Loop Instance state as changed
else Updates not completed CLAMP_Runtime: Log Automation Composition Element fault as cleared
CLAMP_Runtime -> Instantiated_ACM_Inventory: Mark fault Automation Composition Element as being cleared
end
end
end
alt Automation Composition Element in Automation Composition Instance has exceeded alarm threshold on missed report counter
CLAMP_Runtime -> CLAMP_Runtime: altRaise Controla LoopAutomation InstanceComposition StateOffline Changealarm on participantsAutomation timedComposition outInstance
CLAMP_Runtime -> Database: set Control Loop State Change as timed out on Participants
CLAMP_Runtime -> CLAMP_Runtime: Log error
Instantiated_ACM_Inventory: Mark Automation Composition Instance as being offline
else No Automation Composition Element in Automation Composition Instance has exceeded alarm threshold on missed report counter
alt Automation elseComposition WaitInstance formarked updatesas tobeing completeoffline
end
end
else Control Loop Instance State Change on participants not underway
end
end
@enduml |
2.6 De-instantiating a Control Loop Instance from Participants
PlantUML Macro |
---|
@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
participant Participant
database Database
CLAMP_GUI -> CLAMP_Runtime: [REST] Read all Instantiated Control Loop Instances
CLAMP_Runtime -> Database: Read all Instantiated Control Loop Instances
CLAMP_Runtime -> CLAMP_Runtime: Clear Automation Composition Instance Offline alarm on Automation Composition CLAMP_Runtime -> Instantiated_ACM_Inventory: Mark Automation Composition Instance as being online
end
end
alt Automation Composition Element in Automation Composition Instance in incorrect state in last reporting window
CLAMP_Runtime -> CLAMP_GUI: [REST] All Instantiated Control Loop Instances returned
CLAMP_GUIRuntime: Log Automation Composition Instance as being in incorrect state
CLAMP_Runtime -> CLAMPInstantiated_ACM_GUIInventory: SelectRecord ControlAutomation LoopComposition Instance to de-instantiate
CLAMP_GUI -> CLAMP_Runtime: [REST] De-instantiate selected Control Loop Instance on Participants
alt Selected Control Loop Instance instantiated on Participants
CLAMP_Runtime -> Participants: [DMaaP] Update Participants to remove Control Loop Instance
as being in incorrect state
alt Automation Composition Element in Automation Composition Instance has exceeded alarm threshold on incorrect state reports
CLAMP_Runtime -> CLAMP_GUIRuntime: [REST] De-instantiation of Control Loop Instance ordered on participants
else Selected Control Loop Instance not instantiated on Participants
Raise a Automation Composition Instance in Incorrect State alarm on Automation Composition Instance
CLAMP_Runtime -> CLAMPInstantiated_ACM_GUIInventory: [REST]Mark ControlAutomation LoopComposition Instance as notbeing instantiatedin onan participantsincorrect state
end
== Participant Responses ==
Participants -> CLAMP_Runtime: [DMaaP] Result of update of Control Loop Instance on participant
CLAMP_Runtime -> Database: Store result of update of Control Loop Instance on participant
== Supervision ==
loop forever
end
else No Automation Composition Element in incorrect state in last reporting window
alt Automation Composition Element in Automation Composition Instance was in incorrect state on previous report
CLAMP_Runtime -> Database: Read Control Loop Instances
loop over each Control Loop Instance
alt Control Loop Instance de-instantiation update underway on participants
CLAMP_Runtime: Log Automation Composition Instance as being in correct state
CLAMP_Runtime -> Database: read result of Control Loop updates from participants
Instantiated_ACM_Inventory: Record Automation Composition Instance as being in correct state
alt UpdatesAutomation completedComposition onInstance allin participants
Incorrect State alarm raised CLAMP_Runtime -> Database: set Control Loop Instance as de-instantiated on Participants
on Automation Composition Instance
CLAMP_Runtime -> DatabaseCLAMP_Runtime: setClear overallAutomation Control LoopComposition Instance as de-instantiated
else Updates not completed
in Incorrect State alarm on Automation Composition Instance
end
alt Control Loop Instance de-instantiationend
Update timed out on participantsend
alt Automation CLAMP_Runtime -> Database: set Control Loop Instance de-instantiation as timed out on Participants
Composition Element in Automation Composition Instance reported a fault in last reporting window
CLAMP_Runtime -> CLAMP_Runtime: Log error
Automation Composition Instance as being faulty
else Wait for updates to complete
endCLAMP_Runtime -> Instantiated_ACM_Inventory: Record Automation Composition Instance as being faulty
alt endAutomation
Composition Element in Automation elseComposition ControlInstance Loophas Instanceexceeded de-instantiationalarm updatethreshold on participantsfaulty not underwayreports
end
end
@enduml |
2.7 Deleting a Control Loop Instance
PlantUML Macro |
---|
@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
participant Participant
database Database
CLAMP_GUI CLAMP_Runtime -> CLAMP_Runtime: [REST] Read all Control Loop Instances
CLAMP_Runtime -> Database: Read all Control Loop Instances
CLAMP_Runtime -> CLAMP_GUI: [REST] All Control Loop Instances returned
CLAMP_GUI -> CLAMP_GUI: Select Control Loop Instance to delete
CLAMP_GUI Raise a Automation Composition Instance Faulty alarm on Automation Composition Instance
end
else No Automation Composition Element faulty in last reporting window
alt Automation Composition Element in Automation Composition Instance was faulty on previous report
CLAMP_Runtime -> CLAMP_Runtime: [REST] Delete selected Control Loop Instance
alt Selected Control Loop Instance exists
Log Automation Composition Instance as being fault free
CLAMP_Runtime -> Database: Delete control loop instance
CLAMP_Runtime -> CLAMP_GUI: [REST] Control Loop Instance deleted
else Selected Control Loop Instance does not exist
CLAMP_Runtime -> CLAMP_GUI: [REST] Control Loop Instance does not exist
end
@enduml |
2.7 Reading Control Loop Instances
PlantUML Macro |
---|
@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
participant Participant
database Database
CLAMP_GUIInstantiated_ACM_Inventory: Record Automation Composition Instance as being fault free
alt Automation Composition Instance Faulty alarm raised on Automation Composition Instance
CLAMP_Runtime -> CLAMP_Runtime: [REST] Read all Control Loop Instances
CLAMP_Runtime -> Database: Read all Control Loop Instances
CLAMP_Runtime -> CLAMP_GUI: [REST] All Control Loop Instances returned
@enduml |
3. Monitoring Dialogues
Monitoring dialogues are used to monitor and to read statistics on Control Loop Instances.
3.1 Reporting of Monitoring Information and Statistics by Participants
3.2 Viewing of Monitoring Information
3.2 Viewing of Statistics
...
Clear Automation Composition Instance Faulty alarm on Automation Composition Instance
end
end
end
end
end
@enduml |