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
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
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 |
PlantUML Macro |
---|
@startuml
participant SDC
participant Policy_Distribution
participant CLAMP_Runtime
database DatabaseCommissioned_ACM_Inventory
SDCCLAMP_GUI -> PolicyCLAMP_DistributionRuntime: [DMaaPREST] CSARCommission containingAutomation Control LoopComposition Type Definition
PolicyCLAMP_DistributionRuntime -> CLAMPCommissioned_ACM_RuntimeInventory: [REST]Store CommissionAutomation ControlComposition Loop Type Definition
CLAMP_Runtime -> Database: Store Control Loop Type Definition
CLAMP_Runtime -> Policy_DistributionCLAMP_GUI: [REST] Type Definition Commissioned
Policy_Distribution -> SDC: [DMaaP] Deployment Completed
@enduml |
1.
...
2 Commissioning an Automation Composition Type Definition using SDC
PlantUML Macro |
---|
@startuml
participant SDC
participant CLAMPPolicy_GUIDistribution
participant CLAMP_Runtime
participant Participant
database DatabaseCommissioned_ACM_Inventory
CLAMP_GUISDC -> CLAMPPolicy_RuntimeDistribution: [RESTDMaaP] ReadCSAR containing ControlAutomation LoopComposition Type DefinitionsDefinition
CLAMPPolicy_RuntimeDistribution -> DatabaseCLAMP_Runtime: Read Control Loop[REST] Commission Automation Composition Type Definition
CLAMP_Runtime -> CLAMPCommissioned_ACM_GUIInventory: [REST]Store Automation Composition Type Definitions returnedDefinition
CLAMP_GUIRuntime -> CLAMPPolicy_GUIDistribution: Select Control Loop[REST] Type Definition for ParameterizationCommissioned
CLAMPPolicy_GUIDistribution -> CLAMP_RuntimeSDC: [RESTDMaaP] 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_GUIFetch GUI fields Common Parameter Definitions
alt Control Loop Type Definition not Commissioned on Participants
CLAMP_Runtime -> Database: Read Control Loop Type Definition
CLAMP_Runtime -> CLAMP_Runtime: Generate[REST] fieldsRead forAutomation CommonComposition ParametersType for GUIDefinitions
CLAMP_Runtime -> CLAMPCommissioned_ACM_GUIInventory: [REST]Read ReturnAutomation GUIComposition fieldsType Common Parameter Definitions
CLAMP_GUIRuntime -> CLAMP_GUI: Render[REST] UIType forDefinitions Common Parametersreturned
CLAMP_GUI -> CLAMP_GUI: GetSelect valuesAutomation forComposition CommonType ParametersDefinition fromfor userParameterization
CLAMP_GUI -> CLAMP_Runtime: [REST] Fetch SetGUI valuesfields for Common ParametersParameter Definitions
alt Automation CLAMP_Runtime -> Database: Store values for Common ParametersComposition Type Definition not Commissioned on Participants
CLAMP_Runtime -> CLAMPCommissioned_ACM_GUIInventory: [REST]Read CommonAutomation ParameterComposition valuesType stored
else Control Loop Type Definition already Commissioned on ParticipantsDefinition
CLAMP_Runtime -> CLAMP_Runtime: Generate fields for Common Parameters for GUI
CLAMP_Runtime -> CLAMP_GUI: [REST] Return CannotGUI setfields Common Parameters on\nControl Loop Type Definition that has\nbeen commissioned on participants
end
@enduml |
1.4 Commissioning a Control Loop Type Definition on Participants
PlantUML Macro |
---|
@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
participant Participant
database Database
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] ReadSet Controlvalues Loopfor TypeCommon DefinitionsParameters
CLAMP_Runtime -> DatabaseCommissioned_ACM_Inventory: ReadStore Controlvalues Loopfor TypeCommon DefinitionParameters
CLAMP_Runtime -> CLAMP_GUI: [REST] Common TypeParameter Definitionsvalues returnedstored
CLAMP_GUI -> CLAMP_GUI: Select Control Loop else Automation Composition Type Definition foralready CommissioningCommissioned on Participants
CLAMP_GUIRuntime -> CLAMP_RuntimeGUI: [REST] CommissionCannot Controlset LoopCommon TypeParameters Definition on Participants
alt Control Loop\nAutomation Composition Type Definition that nothas\nbeen Commissionedcommissioned 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
Participants
CLAMP_Runtime -> Database: Read Control Loop Type Definition
CLAMP_Runtime -> Database: Read Common Parameter Values for Control Loop Type Definition
alt Common Parameter values set for Control Loop Type Definition
CLAMP_Runtime -> ParticipantsCLAMP_GUI: [DMaaPREST] UpdateType Participants with Control Loop Type Definition and values for Common Parameters
CLAMP_RuntimeDefinitions returned
CLAMP_GUI -> CLAMP_GUI: Select Automation Composition Type Definition for Priming on Participants
CLAMP_GUI -> CLAMP_GUIRuntime: [REST] Prime ControlAutomation LoopComposition Type Definition commissioning ordered on participantsParticipants
alt Automation elseComposition Control Loop Type Definition alreadynot CommissionedPrimed on Participants
CLAMP_Runtime -> CLAMPCommissioned_ACM_GUIInventory: [REST]Read CommonAutomation Parameters not set\non Control Loop Composition Type Definition
end
else Control LoopCLAMP_Runtime -> Commissioned_ACM_Inventory: Read Common Parameter Values for Automation Composition Type Definition already Commissioned on Participants
alt Common Parameter values set for Automation Composition Type Definition
CLAMP_Runtime -> CLAMP_GUIParticipants: [RESTDMaaP] CannotUpdate setParticipants Commonwith Parameters on\nControl LoopAutomation Composition Type Definition thatand has\nbeenvalues commissionedfor onCommon participants
end
== Participant Responses ==
ParticipantsParameters
CLAMP_Runtime -> CLAMP_RuntimeGUI: [DMaaPREST] ResultAutomation of Update with Control Loop Composition Type Definition andpriming valuesordered foron Common Parameters
CLAMP_Runtime -> Database: Store result of Control Loop participants
else Automation Composition Type Definition Updatealready primed on ParticipantParticipants
== Supervision ==
loop forever
CLAMP_Runtime -> DatabaseCLAMP_GUI: Read[REST] ControlCommon LoopParameters Type Definitions
loop over each Control Loopnot set\non Automation Composition Type Definition
end
else Automation altComposition Control Loop Type Definition already Participantprimed Commissionon underwayParticipants
CLAMP_Runtime -> Database: read result of Control LoopCLAMP_GUI: [REST] Cannot set Common Parameters on\nAutomation Composition Type Definition Updatesthat from Participant
alt Updates completed on all participants
CLAMP_Runtime -> Database: set Control Loop Type Definition as Commissioned on Participants
else Updates not completed
alt Commissioning of Control Loop Type Definition on participants timed out
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 -> Database: set Control LoopCommissioned_ACM_Inventory: Read Automation Composition Type Definitions
loop over each Automation Composition Type Definition
commissioning as timedalt outAutomation onComposition Participants
Type Definition Participant priming underway
CLAMP_Runtime -> CLAMPCommissioned_ACM_RuntimeInventory: Logread error
result of Automation Composition Type Definition Updates from elseparticipants
Wait for updates to complete
alt Updates completed on all participants
CLAMP_Runtime -> end
Commissioned_ACM_Inventory: set Automation Composition Type Definition as primed on Participants
else Updates endnot completed
else Control Loop alt Priming of Automation Composition Type Definition Participanton Commissionparticipants nottimed underwayout
end
end
@enduml |
1.5 Decommissioning a Control Loop Type Definition on Participants
This dialogue allows a Control Loop Type Definition to be decomissioned 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 Database
CLAMP_GUI CLAMP_Runtime -> Commissioned_ACM_Inventory: set Automation Composition Type Definition priming as timed out on Participants
CLAMP_Runtime -> CLAMP_Runtime: [REST] Read Control Loop Type Definitions
CLAMP_Runtime -> Database: Read Control Loop Type Definition
CLAMP_Runtime -> CLAMP_GUI: [REST] Type Definitions returned
CLAMP_GUI -> CLAMP_GUI: Select Control LoopLog error
else Wait for updates to complete
end
end
else Automation Composition Type Definition forParticipant Decommissioningpriming onnot Participantsunderway
CLAMP_GUI -> 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: [REST] Decommission Control Loop Type Definition on Participants
alt Control Loop Type Definition Commissioned on Participants
alt Control Loop Instances do not exist for Control Loop Type Definition
CLAMP_Runtime -> ParticipantsCommissioned_ACM_Inventory: [DMaaP]Read Update Participants, removing Control LoopAutomation Composition Type Definition and values for Common Parameters
Definitions
CLAMP_Runtime -> CLAMP_GUI: [REST] ControlType Loop Type Definition decommissioning ordered on participants
else Control Loop Instances exist for Control Loop Type Definition
CLAMP_RuntimeDefinitions returned
CLAMP_GUI -> CLAMP_GUI: Select Automation Composition Type Definition for de-priming on Participants
CLAMP_GUI -> CLAMP_GUIRuntime: [REST] Control LoopDe-prime Automation Composition Type Definition cannot be\n decommissioned on participants\nit is in use on control loops
end
else Control Loop Type Definition not Commissioned on Participants
on Participants
alt Automation Composition Type Definition primed on Participants
alt Automation Composition Instances do not exist for Automation Composition Type Definition
CLAMP_Runtime -> CLAMP_GUIParticipants: [RESTDMaaP] Control LoopUpdate Participants, removing Automation Composition Type Definition hasand not\nbeenvalues commissionedfor onCommon participants
end
== Participant Responses ==
ParticipantsParameters
CLAMP_Runtime -> CLAMP_RuntimeGUI: [DMaaPREST] ResultAutomation ofComposition UpdateType toDefinition removede-priming Controlordered Loopon Typeparticipants
Definition andelse valuesAutomation forComposition Common Parameters
CLAMP_Runtime -> Database: Store result of Control Loop Type Definition Update on Participant
== Supervision ==
loop forever
Instances exist for Automation Composition Type Definition
CLAMP_Runtime -> DatabaseCLAMP_GUI: Read[REST] ControlAutomation LoopComposition Type Definitions
Definition cannot loop over each Control Loop Type Definition
alt Control Loopbe\n de-primed on participants\nit is in use on Automation Compositions
end
else Automation Composition Type Definition Participantnot primed decommissionon underwayParticipants
CLAMP_Runtime -> DatabaseCLAMP_GUI: read[REST] resultAutomation ofComposition Control Loop Type Definition Updateshas from Participant
alt Updates completed on all participants
not\nbeen primed on participants
end
== Participant Responses ==
Participants -> CLAMP_Runtime: -> Database: set Control Loop Type Definition as decommissioned on Participants
else Updates not completed
alt Commissioning of Control Loop Type Definition on participants timed out
[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 -> DatabaseCommissioned_ACM_Inventory: setRead ControlAutomation LoopComposition Type Definitions
Definition loop decommissioningover aseach timedAutomation outComposition onType Participants
Definition
alt Automation Composition Type Definition Participant de-prime underway
CLAMP_Runtime -> CLAMPCommissioned_ACM_RuntimeInventory: Logread error
result of Automation Composition Type Definition Updates from elseparticipants
Wait for updates to complete
alt Updates completed on all endparticipants
CLAMP_Runtime end
else Control Loop -> Commissioned_ACM_Inventory: set Automation Composition Type Definition Participantas decommissionde-primeed noton underwayParticipants
end
end
@enduml |
1.6 Decommissioning a Control Loop Type Definition in CLAMP
PlantUML Macro |
---|
@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
database Database
CLAMP_GUI -> CLAMP_Runtime: [REST] Read Control Loop Type Definitions
CLAMP_Runtime -> Database: Read Control Loop Type Definition
CLAMP_Runtime -> CLAMP_GUI: [REST] Type Definitions returned
CLAMP_GUI -> CLAMP_GUI: Select Control Loop Type Definition for Decommissioning
CLAMP_GUIelse 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: [REST] Decommission Control Loop Type Definition
alt Control Loop Type Definition not Commissioned on Participants
CLAMP_Runtime -> Database: Delete Control Loop Type Definition
CLAMP_Runtime -> CLAMP_GUI: [REST] Type Definition Decommissioned
else Control LoopLog error
else Wait for updates to complete
end
end
else Automation Composition Type Definition notParticipant Commissionedde-prime onnot Participantsunderway
CLAMP_Runtime -> CLAMP_GUI: [REST] Control Loop Type Definition cannot be decommissioned\nit is commissioned on participants end
end
end
@enduml |
1.
...
6 Decommissioning an Automation Composition Type Definition in CLAMP
PlantUML Macro |
---|
@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
database DatabaseCommissioned_ACM_Inventory
CLAMP_GUI -> CLAMP_Runtime: [REST] Read ControlAutomation LoopComposition Type Definitions
CLAMP_Runtime -> DatabaseCommissioned_ACM_Inventory: Read ControlAutomation LoopComposition Type DefinitionDefinitions
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 Control Loop instances.
2.1 Creating a Control Loop Instance
2.2 Setting Instance Specific Parameters on a Control Loop Instance
2.3 Instantiating a Control Loop Instance on Participants
2.4 Updating the Parameters on a Control Loop Instance on Participants
2.5 Changing the state of a Control Loop Instance on Participants
2.6 De-instantiating a Control Loop Instance from Participants
2.7 Deleting a Control Loop Instance
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
...
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
CLAMP_Runtime -> CLAMP_GUI: [REST] Automation Composition Instance not instantiated on participants
end
== Participant Responses ==
Participants -> CLAMP_Runtime: [DMaaP] Result of State Change of Automation Composition Instance on participant
CLAMP_Runtime -> Instantiated_ACM_Inventory: Store result of State Change 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 State Change underway on participants
CLAMP_Runtime -> 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 -> Instantiated_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: 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 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 to de-instantiate
CLAMP_GUI -> CLAMP_Runtime: [REST] De-instantiate selected Automation Composition Instance on Participants
alt Selected Automation Composition Instance instantiated on Participants
CLAMP_Runtime -> Participants: [DMaaP] Update Participants to remove Automation Composition Instance
CLAMP_Runtime -> CLAMP_GUI: [REST] De-instantiation of Automation Composition Instance ordered on participants
else Selected Automation Composition Instance not instantiated on Participants
CLAMP_Runtime -> CLAMP_GUI: [REST] Automation Composition Instance not instantiated on participants
end
== Participant Responses ==
Participants -> CLAMP_Runtime: [DMaaP] Result of update of Automation Composition Instance on participant
CLAMP_Runtime -> Instantiated_ACM_Inventory: Store result of update 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 de-instantiation 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 Automation Composition Instance as de-instantiated on Participants
CLAMP_Runtime -> 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 -> CLAMP_Runtime: Log error
else Wait for updates to complete
end
end
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 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 -> CLAMP_GUI: [REST] All Automation Composition Instances returned
CLAMP_GUI -> CLAMP_GUI: Select Automation Composition Instance to delete
CLAMP_GUI -> CLAMP_Runtime: [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
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 -> CLAMP_GUI: [REST] All Automation Composition Instances returned
@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: [DMaaP] Participant and Automation Composition Element 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 -> CLAMP_Runtime: log fault on Participant
CLAMP_Runtime -> Instantiated_ACM_Inventory: Record fault on Participant
end
loop Over all Automation Composition Elements in Participant Report
alt Fault reported on Automation Composition Element
CLAMP_Runtime -> CLAMP_Runtime: log fault on Automation Composition Element and Automation Composition CLAMP_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 -> CLAMP_Runtime: [REST] Read all Automation Composition Instances
CLAMP_Runtime -> Instantiated_ACM_Inventory: Read all Automation Composition Instances
CLAMP_Runtime -> CLAMP_GUI: [REST] All Automation Composition Instances returned
CLAMP_GUI -> CLAMP_GUI: Display overview of status of all Automation 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 -> CLAMP_GUI: [REST] Automation Composition 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 -> CLAMP_GUI: [REST] All participants returned
CLAMP_GUI -> CLAMP_GUI: Display overview of status of all participants
== Details of a Participant ==
CLAMP_GUI -> CLAMP_Runtime: [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 Elements that match filter
CLAMP_Runtime -> Instantiated_ACM_Inventory: Read Automation Composition Elements that match filter
CLAMP_Runtime -> CLAMP_GUI: [REST] Automation Composition Elements that match filter returned
CLAMP_GUI -> 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] Read summary statistics for all Automation Composition Instances
CLAMP_Runtime -> Instantiated_ACM_Inventory: Compile summary statistics for all Automation Composition Instances
CLAMP_Runtime -> CLAMP_GUI: [REST] Summary statistics for all Automation Composition Instances returned
CLAMP_GUI -> CLAMP_GUI: Display summary statistics for all Automation Composition Instances
== Statistics of a Automation Composition Instance ==
CLAMP_GUI -> CLAMP_Runtime: [REST] Read statistics for Automation Composition Elements for Automation Composition Instance
CLAMP_Runtime -> Instantiated_ACM_Inventory: Compile statistics for Automation Composition Elements for Automation Composition Instance
CLAMP_Runtime -> CLAMP_GUI: [REST] Statistics for Automation Composition Elements returned
CLAMP_GUI -> CLAMP_GUI: Display statistics for Automation Composition Elements in Automation Composition Instance
== Statistics of all Participants ==
CLAMP_GUI -> CLAMP_Runtime: [REST] Read summary statistics for all Automation Composition Instances
CLAMP_Runtime -> Instantiated_ACM_Inventory: Compile summary statistics for all Automation Composition Instances
CLAMP_Runtime -> CLAMP_GUI: [REST] Summary statistics for all Automation Composition Instances returned
CLAMP_GUI -> CLAMP_GUI: Display summary statistics for all Automation Composition Instances
== Statistics of a Participant ==
CLAMP_GUI -> CLAMP_Runtime: [REST] Read statistics for Automation Composition Elements for Participant
CLAMP_Runtime -> Instantiated_ACM_Inventory: Read statistics for Automation Composition Elements for Participant
CLAMP_Runtime -> CLAMP_GUI: [REST] Statistics for Automation Composition Elements returned
CLAMP_GUI -> CLAMP_GUI: Display statistics for Automation Composition Elements in Participant
== Filtered Statistics ==
CLAMP_GUI -> CLAMP_GUI: Set filter for Automation Composition Instances, Automation Composition Elements, and Participants
CLAMP_GUI -> CLAMP_Runtime: [REST] Read statistics for Automation Composition Elements that match filter
CLAMP_Runtime -> Instantiated_ACM_Inventory: Read statistics for Automation Composition Elements that match filter
CLAMP_Runtime -> CLAMP_GUI: [REST] Statistics for Automation Composition Elements that match filter returned
CLAMP_GUI -> CLAMP_GUI: Display statistics for Automation Composition Elements that match filter
@enduml |
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
CLAMP_Runtime -> CLAMP_Runtime: Summarise Automation Composition Instance Statistics
CLAMP_Runtime -> Instantiated_ACM_Inventory: Store summarised Automation Composition Instance Statistics
CLAMP_Runtime -> Instantiated_ACM_Inventory: Delete Automation Composition Instance Statistics on which retention period has expired
end
== Participant Statistics ==
loop forever
CLAMP_Runtime -> Instantiated_ACM_Inventory: Read Participant Statistics
CLAMP_Runtime -> CLAMP_Runtime: Summarise Participant Statistics
CLAMP_Runtime -> Instantiated_ACM_Inventory: Store summarised Participant Statistics
CLAMP_Runtime -> Instantiated_ACM_Inventory: Delete Participant Statistics on which retention period 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_Runtime: Log Participant as having missed a report
CLAMP_Runtime -> Instantiated_ACM_Inventory: Increment missed report counter on Participant
alt Participant has exceeded alarm threshold on missed report counter
CLAMP_Runtime -> CLAMP_Runtime: Raise a Participant Offline alarm on participant
CLAMP_Runtime -> Instantiated_ACM_Inventory: Mark participant as being offline
end
else Participant has reported in last reporting window
CLAMP_Runtime -> Instantiated_ACM_Inventory: Clear missed report counter on Participant
alt Participant marked as being offline
CLAMP_Runtime -> CLAMP_Runtime: Clear Participant Offline alarm on participant
CLAMP_Runtime -> 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 -> Instantiated_ACM_Inventory: Read Automation Composition Instances
loop Over each Automation Composition Instance
loop Over each Automation Composition Element
alt Automation Composition Element has not reported in last reporting window
CLAMP_Runtime -> CLAMP_Runtime: Log Automation Composition Element as having missed a report
CLAMP_Runtime -> Instantiated_ACM_Inventory: Increment missed report counter on Automation Composition Element
else Automation Composition Element has reported in last reporting window
CLAMP_Runtime -> Instantiated_ACM_Inventory: Clear missed report counter on Automation Composition Element
end
alt Automation Composition Element in incorrect state in last reporting window
CLAMP_Runtime -> CLAMP_Runtime: Log Automation Composition Element as being in incorrect state
CLAMP_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: Log Automation Composition Element as being in correct state
CLAMP_Runtime -> 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_Runtime: Log Automation Composition Element as being faulty
CLAMP_Runtime -> 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 -> 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: Raise a Automation Composition Offline alarm on Automation Composition Instance
CLAMP_Runtime -> 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 Composition Instance marked as being offline
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_Runtime: Log Automation Composition Instance as being in incorrect state
CLAMP_Runtime -> Instantiated_ACM_Inventory: Record Automation Composition 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_Runtime: Raise a Automation Composition Instance in Incorrect State alarm on Automation Composition Instance
CLAMP_Runtime -> Instantiated_ACM_Inventory: Mark Automation Composition Instance as being in an incorrect state
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 -> CLAMP_Runtime: Log Automation Composition Instance as being in correct state
CLAMP_Runtime -> Instantiated_ACM_Inventory: Record Automation Composition Instance as being in correct state
alt Automation Composition Instance in Incorrect State alarm raised on Automation Composition Instance
CLAMP_Runtime -> CLAMP_Runtime: Clear Automation Composition Instance in Incorrect State alarm on Automation Composition Instance
end
end
end
alt Automation Composition Element in Automation Composition Instance reported a fault in last reporting window
CLAMP_Runtime -> CLAMP_Runtime: Log Automation Composition Instance as being faulty
CLAMP_Runtime -> Instantiated_ACM_Inventory: Record Automation Composition Instance as being faulty
alt Automation Composition Element in Automation Composition Instance has exceeded alarm threshold on faulty reports
CLAMP_Runtime -> CLAMP_Runtime: 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: Log Automation Composition Instance as being fault free
CLAMP_Runtime -> Instantiated_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: Clear Automation Composition Instance Faulty alarm on Automation Composition Instance
end
end
end
end
end
@enduml |