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.

Table of Contents

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

PlantUML Macro

@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
database Database

CLAMP_GUI -> CLAMP_RuntimeGUI: [REST] Commission Control Loop Type Definition Select Automation Composition Instance on which to Update Parameters
CLAMP_RuntimeGUI -> DatabaseCLAMP_GUI: Store Control Loop Type DefinitionStep version of Automation Composition Instance as Major/Minor/Patch
CLAMP_RuntimeGUI -> CLAMP_GUIRuntime: [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_Distribution: [DMaaP] CSAR containing Control Loop Type Definition
Policy_Distribution 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_RuntimeGUI: [REST] Return CommissionGUI fields ControlInstance LoopSpecific TypeParameter DefinitionDefinitions
CLAMP_RuntimeGUI -> DatabaseCLAMP_GUI: Render StoreUI Controlfor LoopInstance TypeSpecific DefinitionParameters
CLAMP_RuntimeGUI -> Policy_Distribution: [REST] Type Definition Commissioned
Policy_DistributionCLAMP_GUI: Get values for Instance Specific Parameters from user
CLAMP_GUI -> SDCCLAMP_Runtime: [DMaaPREST] 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_GUIRequest Update of Automation Composition Instance
CLAMP_Runtime -> CLAMP_Runtime: [REST]Update ReadAutomation Control Loop Type DefinitionsComposition Instance
CLAMP_Runtime -> Database: Read Control Loop Type DefinitionsInstantiated_ACM_Inventory: Store New Version of Automation Composition Instance
CLAMP_Runtime -> CLAMP_GUI: [REST] Automation TypeComposition Instance Updated

@enduml

2.3 Updating an Automation Composition Instance with a Configuration on Participants

PlantUML Macro

@startuml
participant Definitions returned
CLAMP_GUI
participant -> CLAMP_GUI: Select Control Loop Type Definition for ParameterizationRuntime
participant Participant
database Instantiated_ACM_Inventory

CLAMP_GUI -> CLAMP_Runtime: [REST] Read Fetchall GUIconfiguration fieldsversions forof CommonAutomation ParameterComposition Definitions

alt Control Loop Type Definition not Commissioned on Participants
  Instance
CLAMP_Runtime -> Instantiated_ACM_Inventory: Read all configuration versions of Automation Composition Instance
CLAMP_Runtime -> Database: Read Control Loop Type Definition
  CLAMP_RuntimeCLAMP_GUI: [REST] All configuration versions of Automation Composition Instance returned
CLAMP_GUI -> CLAMP_RuntimeGUI: Select configuration Generateversion fieldsof forAutomation CommonComposition ParametersInstance for GUIInstantiation Participants
  CLAMP_RuntimeGUI -> CLAMP_GUIRuntime: [REST] Return GUI fields Common Parameter Definitions
  CLAMP_GUI -> CLAMP_GUI: Render UI for Common Parameters Instantiate selected configuration version of Automation Composition Instance on Participants

alt Selected configuration version of Automation Composition Instance not instantiated on Participants
  CLAMP_GUIRuntime -> CLAMPInstantiated_ACM_GUIInventory: GetRead valuesconfiguration forversion Commonof ParametersAutomation fromComposition userInstance
  CLAMP_GUIRuntime -> CLAMP_RuntimeParticipants: [RESTDMaaP] SetUpdate valuesParticipants forwith Commonconfiguration Parameters
version of CLAMP_Runtime -> Database: Store values for Common ParametersAutomation Composition Instance
  CLAMP_Runtime -> CLAMP_GUI: [REST] Common Parameter values stored
else Control Loop Type Definition already Commissioned 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] Cannotconfiguration setversion Commonof ParametersAutomation on\nControlComposition LoopInstance Typealready Definition that has\nbeen commissioned instantiated 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

CLAMP_GUI== Participant Responses ==
Participants -> CLAMP_Runtime: [RESTDMaaP] ReadResult Controlof Loopupdate Type Definitions
CLAMP_Runtime -> Database: Read Control Loop Type Definitionsof configuration version of Automation Composition Instance on participant
CLAMP_Runtime -> CLAMPInstantiated_ACM_GUIInventory: [REST] Type Definitions returned
CLAMP_GUI -> CLAMP_GUI: Select Control Loop Type Definition for Commissioning on Participants
CLAMP_GUI -> CLAMP_Runtime: [REST] Commission Control Loop Type Definition on Participants

alt Control Loop Type Definition not Commissioned on Participants
  CLAMP_Runtime -> Database: Read Control Loop Type Definition
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 -> DatabaseInstantiated_ACM_Inventory: Readread Commonresult Parameterof ValuesAutomation forComposition Controlupdates Loopfrom Type Definitionparticipants
  alt Common Parameter values setalt forUpdates Controlcompleted Loopon Typeall Definitionparticipants
	    CLAMP_Runtime -> Participants: [DMaaP] Update Participants with Control Loop Type Definition and values for Common Parameters
Instantiated_ACM_Inventory: set configuration version of Automation Composition Instance as Instantiated on Participants
	    CLAMP_Runtime -> CLAMPInstantiated_ACM_GUIInventory: [REST] Control Loop Type Definition commissioning ordered on participants
  else Control Loop Type Definition already Commissioned on Participantsset overall configuration version of Automation Composition Instance state as Instantiated
      else Updates not completed
    CLAMP_Runtime -> CLAMP_GUI: [REST] Commonalt ParametersInstantiation notof set\non Control Loop Type Definition
  end
else Control Loop Type Definition already Commissioned on Participants
Automation Composition Instance on participants timed out
	      CLAMP_Runtime -> CLAMPInstantiated_ACM_GUIInventory: [REST] Cannot set Commonconfiguration Parametersversion on\nControlAutomation LoopComposition TypeInstance DefinitionInstantiation thatas has\nbeentimed commissionedout on participants
end

== Participant Responses ==
ParticipantsParticipants
	      CLAMP_Runtime -> CLAMP_Runtime: [DMaaP] Result of Update with Control Loop Type Definition and values for Common Parameters
CLAMP_Runtime -> Database: Store result of Control Loop Type Definition Update on Participant

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
== 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
	  CLAMP_Runtime -> DatabaseInstantiated_ACM_Inventory: readRead resultall ofInstantiated ControlAutomation Loop Type Definition Updates from participants
      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
	      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 -> DatabaseParticipants: set Control Loop Type Definition commissioning as timed out on Participants
	    [DMaaP] Request change of state of Automation Composition Instance
  CLAMP_Runtime -> CLAMP_RuntimeGUI: [REST] LogChange error
of state of Automation Composition Instance ordered on participants
else Wait for updates to completeSelected Automation Composition Instance not instantiated on Participants
  CLAMP_Runtime -> CLAMP_GUI: [REST] Automation Composition end
Instance not instantiated on participants  
end 

== Participant Responses  else Control Loop Type Definition Participant Commission not underway
    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: [REST] Read Control Loop Type Definitions
==
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 -> DatabaseInstantiated_ACM_Inventory: Read ControlAutomation LoopComposition Type Definitions
CLAMP_Runtime -> CLAMP_GUI: [REST] Type Definitions returned
CLAMP_GUI -> CLAMP_GUI: Select Control Loop Type Definition for Decommissioning on Participants
CLAMP_GUI -> 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
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 -> ParticipantsInstantiated_ACM_Inventory: [DMaaP]set UpdateAutomation Participants,Composition removingInstance Controlstate Loopas Typechanged Definition and values for Common Parameters
on Participants
	    CLAMP_Runtime -> CLAMPInstantiated_ACM_GUIInventory: [REST]set Controloverall LoopAutomation TypeComposition DefinitionInstance decommissioningstate orderedas onchanged
 participants
  else Control Loop Instanceselse existUpdates fornot Controlcompleted
 Loop Type Definition
    CLAMP_Runtime -> CLAMP_GUI: [REST] Control Loop Type Definition cannot be\n decommissioned on participants\nit is in use on control loops
  end
else Control Loop Type Definition not Commissionedalt 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_GUIRuntime: 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
 [REST] Control Loop Type Definition has not\nbeen commissioned on participants
end

== Participant Responses ==
Participants -> CLAMP_Runtime: [DMaaP] Result of Update to remove Control Loop Type Definition and values for Common Parameters
CLAMP_Runtime -> Database: Store result of Control Loop Type Definition Update on Participant

== Supervision ==
loop forever
  CLAMP_Runtime -> DatabaseInstantiated_ACM_Inventory: Read Controlall Instantiated LoopAutomation TypeComposition DefinitionsInstances
CLAMP_Runtime  loop 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
	  -> 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 -> DatabaseCLAMP_GUI: set Control Loop Type Definition as decommissioned[REST] De-instantiation of Automation Composition Instance ordered on Participantsparticipants
else Selected Automation Composition Instance not elseinstantiated Updateson not completedParticipants
  CLAMP_Runtime      alt Commissioning of Control Loop Type Definition-> CLAMP_GUI: [REST] Automation Composition Instance not instantiated on participants timed out
	      CLAMP_Runtime -> Database: set Control Loop Type Definition decommissioning as timed out on Participants
	      
end

== Participant Responses ==
Participants -> CLAMP_Runtime: [DMaaP] Result of update of Automation Composition Instance on participant
CLAMP_Runtime -> CLAMPInstantiated_ACM_RuntimeInventory: LogStore error
result of update of Automation Composition Instance on else Wait for updates to completeparticipant

== Supervision ==
loop forever
  CLAMP_Runtime -> Instantiated_ACM_Inventory: Read Automation Composition endInstances
  loop over each Automation endComposition Instance
    elsealt ControlAutomation LoopComposition TypeInstance Definitionde-instantiation Participantupdate decommissionunderway noton underwayparticipants
	  CLAMP_Runtime  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
-> Instantiated_ACM_Inventory: read result of Automation Composition updates from participants
      alt Updates completed on all participants
	    CLAMP_Runtime -> Database: Read Control Loop Type Definitions
Instantiated_ACM_Inventory: set Automation Composition Instance as de-instantiated on Participants
	    CLAMP_Runtime -> CLAMPInstantiated_ACM_GUIInventory: [REST] Type Definitions returned
CLAMP_GUI -> CLAMP_GUI: Select Control Loop Type Definition for Decommissioning
CLAMP_GUI -> 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
  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 -> CLAMPInstantiated_ACM_GUIInventory: [REST]set TypeAutomation DefinitionComposition Decommissioned
else Control Loop Type Definition not CommissionedInstance de-instantiation as timed out on Participants
	      CLAMP_Runtime -> CLAMP_GUIRuntime: [REST] Control Loop Type Definition cannot 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

CLAMP_GUI -> CLAMP_Runtime: [REST] Read Control Loop Type Definitions
CLAMP_Runtime -> Database: Read Control Loop 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 Control Loop instances.

...

 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 DatabaseInstantiated_ACM_Inventory

CLAMP_GUI -> CLAMP_Runtime: [REST] Read Controlall LoopAutomation TypeComposition DefinitionsInstances
CLAMP_Runtime -> Database Instantiated_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 to use to create Control Loop Instance
CLAMP_GUI -> CLAMP_Runtime: [REST] Fetch GUI fields for Instance Specific Parameter Definitions
CLAMP_Runtime -> Database: Read Control Loop Type Definition
 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_RuntimeGUI: Generate[REST] fieldsAutomation forComposition Instance does Specificnot Parameters for GUI
CLAMP_Runtimeexist 
end

@enduml

2.7 Reading Automation Composition Instances

PlantUML Macro

@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
database Instantiated_ACM_Inventory

CLAMP_GUI -> CLAMP_GUIRuntime: [REST] ReturnRead GUI fields Instance Specific Parameter Definitionsall Automation Composition Instances
CLAMP_GUIRuntime -> CLAMPInstantiated_ACM_GUIInventory: RenderRead UIall forAutomation InstanceComposition Specific ParametersInstances
CLAMP_GUIRuntime -> CLAMP_GUI: Get values[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 for Instance Specific Parameters from user
CLAMP_GUI -> CLAMP_Runtime: [RESTDMaaP] RequestParticipant Creationand ofAutomation ControlComposition Loop Instance
CLAMP_Runtime -> CLAMP_Runtime: Create Control Loop InstanceElement Monitoring and Statistics report
CLAMP_Runtime -> DatabaseInstantiated_ACM_Inventory: Store FirstParticipant Versionand ofAutomation ControlComposition Loop Instance
CLAMP_Runtime -> CLAMP_GUI: [REST] Control Loop Instance Updated

@enduml

2.2 Updating Instance Specific Parameters on a Control Loop Instance

PlantUML Macro

@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
database Database

CLAMP_GUI -> CLAMP_Runtime: [REST] Read Control Loop Instances
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 -> DatabaseCLAMP_Runtime: Readlog Controlfault Loop Instances
CLAMP_Runtime -> CLAMP_GUI: [REST] Control Loop Instances returned
CLAMP_GUIon Automation Composition Element and Automation Composition     CLAMP_Runtime -> CLAMPInstantiated_ACM_GUIInventory: 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 ==Select Control Loop Instance on which to 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 Read all Automation Composition Instances
CLAMP_Runtime -> Instantiated_ACM_Inventory: Read all Automation Composition Instances
CLAMP_Runtime -> DatabaseCLAMP_GUI: Read Control Loop Type Definition[REST] All Automation Composition Instances returned
CLAMP_RuntimeGUI -> CLAMP_Runtime: Generate fields for Instance Specific Parameters for GUI
CLAMP_RuntimeGUI: Display overview of status of all Automation Composition Instances

== Details of a Automation Composition Instance ==
CLAMP_GUI -> CLAMP_GUIRuntime: [REST] Read ReturnAutomation GUIComposition fieldsElements Instancefor SpecificAutomation ParameterComposition DefinitionsInstance
CLAMP_GUIRuntime -> CLAMPInstantiated_ACM_GUIInventory: Render UIRead Automation Composition Elements for InstanceAutomation SpecificComposition ParametersInstance
CLAMP_GUIRuntime -> CLAMP_GUI: Get[REST] valuesAutomation forComposition Instance Specific Parameters from userElements returned
CLAMP_GUI -> CLAMP_Runtime: [REST] Request Update of Control Loop Instance
CLAMP_RuntimeGUI: Display status of Automation Composition Elements in Automation Composition Instance

== Overview of all Participants ==
CLAMP_GUI -> CLAMP_Runtime: Update[REST] ControlRead Loopall Instanceparticipants
CLAMP_Runtime -> DatabaseInstantiated_ACM_Inventory: StoreRead New Version of Control Loop Instanceall participants
CLAMP_Runtime -> CLAMP_GUI: [REST] ControlAll Loop 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

participants returned
CLAMP_GUI -> CLAMP_GUI: Display overview of status of all participants

== Details of a Participant ==
CLAMP_GUI -> CLAMP_Runtime: [REST] Read allAutomation versionsComposition ofElements Controlfor Loop InstanceParticipant
CLAMP_Runtime -> DatabaseInstantiated_ACM_Inventory: Read allAutomation versionsComposition ofElements Controlfor Loop InstanceParticipant
CLAMP_Runtime -> CLAMP_GUI: [REST] AllAutomation versions of Control Loop InstanceComposition Elements returned
CLAMP_GUI -> CLAMP_GUI: SelectDisplay versionstatus of Control Loop Instance for Instantiation ParticipantsAutomation Composition Elements in Participant

== Filtered Monitoring ==
CLAMP_GUI -> CLAMP_RuntimeGUI: [REST] Instantiate selected version of Control Loop Instance on Participants

alt Selected version of Control Loop Instance not instantiated on Participants
  CLAMP_Runtime -> Database: Read version of Control Loop Instance
  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 -> ParticipantsInstantiated_ACM_Inventory: [DMaaP]Read UpdateAutomation ParticipantsComposition withElements versionthat of Control Loop Instance
  match filter
CLAMP_Runtime -> CLAMP_GUI: [REST] Instantiation of Version of Control Loop Instance ordered on participants
else Selected version of Control Loop Instance instantiated on Participants
  CLAMP_Runtime Automation Composition Elements that match filter returned
CLAMP_GUI -> CLAMP_GUI: [REST]Display Versionstatus of ControlAutomation LoopComposition InstanceElements alreadythat instantiatedmatch filter

@enduml

3.2 Viewing of Statistics

PlantUML Macro

@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
database Instantiated_ACM_Inventory on participants 
end

== Participant Responses Statistics of all Automation Composition Instances ==
ParticipantsCLAMP_GUI -> CLAMP_Runtime: [DMaaPREST] ResultRead of update of version of Control Loop Instance on participantsummary statistics for all Automation Composition Instances
CLAMP_Runtime -> Database: Store result of update of version 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 Instantiation update underway on participants
	  CLAMP_Runtime -> Database: read result of Control Loop updates from participants
      alt Updates completed on all participants
	    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 -> Database: set version of Control Loop Instance as Instantiated on Participants
	    CLAMP_RuntimeCLAMP_GUI: [REST] Statistics for Automation Composition Elements returned
CLAMP_GUI -> DatabaseCLAMP_GUI: setDisplay overallstatistics versionfor ofAutomation ControlComposition LoopElements Instancein stateAutomation asComposition InstantiatedInstance

== Statistics of all   else Updates not completed
        alt Instantiation of Control Loop Instance on participants timed out
	      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 -> DatabaseCLAMP_GUI: set[REST] versionSummary Controlstatistics Loopfor Instanceall InstantiationAutomation asComposition timed out on Participants
	      CLAMP_RuntimeInstances returned
CLAMP_GUI -> CLAMP_RuntimeGUI: Log error
        else Wait for updates to complete
        end
      end 
    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
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_RuntimeGUI: [REST] Read all Instantiated Control Loop Instances
CLAMP_Runtime Set filter for Automation Composition Instances, Automation Composition Elements, and Participants
CLAMP_GUI -> Database:CLAMP_Runtime: [REST] Read all Instantiated Control Loop Instancesstatistics for Automation Composition Elements that match filter
CLAMP_Runtime -> CLAMPInstantiated_ACM_GUIInventory: [REST] All Instantiated Control Loop Instances returned Read statistics for Automation Composition Elements that match filter
CLAMP_GUIRuntime -> CLAMP_GUI: Select[REST] ControlStatistics Loopfor InstanceAutomation onComposition whichElements tothat changematch state and specify new statefilter returned
CLAMP_GUI -> CLAMP_RuntimeGUI: [REST] Change state of selected Control Loop Instance on Participants

alt Selected Control Loop Instance instantiated on ParticipantsDisplay 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 -> ParticipantsInstantiated_ACM_Inventory: [DMaaP]Read RequestAutomation changeComposition of state of Control Loop InstanceInstance Statistics
  CLAMP_Runtime -> CLAMP_GUIRuntime: [REST]Summarise ChangeAutomation ofComposition stateInstance ofStatistics
 Control Loop Instance ordered on participants
else Selected Control Loop Instance not instantiated on ParticipantsCLAMP_Runtime -> Instantiated_ACM_Inventory: Store summarised Automation Composition Instance Statistics
  CLAMP_Runtime -> CLAMPInstantiated_ACM_GUIInventory: [REST] Control Loop Instance not instantiated on participants  Delete Automation Composition Instance Statistics on which retention period has expired
end

== Participant ResponsesStatistics ==

loop forever
Participants -> CLAMP_Runtime: [DMaaP] Result of State Change of Control Loop Instance on participant
-> Instantiated_ACM_Inventory: Read Participant Statistics
  CLAMP_Runtime -> DatabaseCLAMP_Runtime: StoreSummarise resultParticipant ofStatistics
 State Change of Control Loop Instance on participant

== Supervision ==
loop foreverCLAMP_Runtime -> Instantiated_ACM_Inventory: Store summarised Participant Statistics
  CLAMP_Runtime -> DatabaseInstantiated_ACM_Inventory: ReadDelete ControlParticipant LoopStatistics Instances
on which loopretention overperiod 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
each Control Loop Instance
    alt Control Loop Instance State Change underway on participants
	  CLAMP_Runtime -> DatabaseInstantiated_ACM_Inventory: readRead resultParticipants
 of Controlloop LoopOver State Change from participants
  each Participant
    alt UpdatesParticipant completedhas onnot allreported participants
	in last reporting window
 CLAMP_Runtime -> Database: set Control Loop Instance state as changed on Participants
	    CLAMP_Runtime -> DatabaseCLAMP_Runtime: set overall Control Loop Instance stateLog Participant as changed
having      else Updates not completedmissed a report
       CLAMP_Runtime alt Control Loop Instance State Change-> Instantiated_ACM_Inventory: Increment missed report counter on participantsParticipant
 timed out
	     alt CLAMP_Runtime -> Database: set Control Loop State Change as timed out on Participants
	Participant has exceeded alarm threshold on missed report counter
          CLAMP_Runtime -> CLAMP_Runtime: Log error
    Raise a Participant Offline alarm on participant
    else Wait for updates to complete
 CLAMP_Runtime -> Instantiated_ACM_Inventory: Mark participant as being endoffline
       end 
    else ControlParticipant Loophas Instancereported Statein Changelast onreporting participantswindow
 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 -> Instantiated_ACM_Inventory: Clear missed report counter on Participant
       alt Participant marked as being offline
          CLAMP_Runtime -> CLAMP_GUIRuntime: Clear [REST]Participant AllOffline Instantiatedalarm Controlon Loopparticipant
 Instances returned
CLAMP_GUI -> CLAMP_GUI: Select Control Loop Instance to de-instantiate
CLAMP_GUIRuntime -> CLAMPInstantiated_ACM_RuntimeInventory: [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 InstanceMark 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 -> CLAMPInstantiated_ACM_GUIInventory: [REST] De-instantiation of Control Loop Instance ordered on participants
else Selected Control Loop Instance not instantiated on Participants
  CLAMP_Runtime -> CLAMP_GUI: [REST] Control Loop Instance not instantiated on participants 
end

== Participant Responses ==
Participants -> CLAMP_Runtime: [DMaaP] Result of update of Control Loop Instance on participant
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 -> Database: Store result of update of Control Loop Instance on participant

== Supervision ==
loop forever
CLAMP_Runtime: Log Automation Composition Element as having missed a report
         CLAMP_Runtime -> DatabaseInstantiated_ACM_Inventory: Read Control Loop Instances
  loop over each Control Loop Instance
    alt Control Loop Instance de-instantiation update underway on participants
	Increment missed report counter on Automation Composition Element
      else Automation Composition Element has reported in last reporting window
         CLAMP_Runtime -> Database: read result of Control Loop updates from participants
      alt Updates completed on all participants
	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 -> DatabaseCLAMP_Runtime: setLog ControlAutomation LoopComposition InstanceElement as de-instantiated on Participants
	being in incorrect state
        CLAMP_Runtime -> Database: set overall Control Loop Instance as de-instantiatedInstantiated_ACM_Inventory: Record Automation Composition Element as being in incorrect state
      else Automation UpdatesComposition Element not completed
 in incorrect state in last reporting window
        alt Automation Composition Element was altin Controlincorrect Loopstate Instanceon de-instantiation Update timed out on participants
	previous report
          CLAMP_Runtime -> DatabaseCLAMP_Runtime: setLog ControlAutomation LoopComposition InstanceElement de-instantiation as timedbeing outin oncorrect Participants
	state
          CLAMP_Runtime -> CLAMPInstantiated_ACM_RuntimeInventory: LogRecord error
Automation Composition Element as being in   else Wait for updates to completecorrect state
        end
      end
  
    elsealt ControlAutomation LoopComposition InstanceElement de-instantiationreported updatefault onin participantslast notreporting underwaywindow
    end
  end
@enduml

2.7 Deleting a Control Loop Instance

PlantUML Macro

@startuml
participant CLAMP_GUI
participant CLAMP_Runtime

database Database

CLAMP_GUI -> CLAMP_Runtime: Log [REST]Automation ReadComposition allElement Controlas Loopbeing Instances
faulty
        CLAMP_Runtime -> DatabaseInstantiated_ACM_Inventory: 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 -> CLAMP_Runtime: [REST] Delete selected Control Loop Instance

alt Selected Control Loop Instance exists
  CLAMP_Runtime -> Database: Delete control loop instance
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_GUIRuntime: [REST] Control Loop Instance deleted
else Selected Control Loop Instance does not exist
 Log Automation Composition Element fault as cleared
          CLAMP_Runtime -> CLAMPInstantiated_ACM_GUIInventory: [REST]Mark Controlfault LoopAutomation InstanceComposition doesElement notas existbeing 
end

@enduml

2.8 Reading Control Loop Instances

PlantUML Macro

@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
database Database

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

PlantUML Macro

@startuml
participant CLAMP_Runtime
participant Participant
database Database

Participant -> CLAMP_Runtime: [DMaaP] Participant and Control Loop Element Monitoring and Statistics report
cleared
        end
      end
    end
    alt Automation Composition Element in Automation Composition Instance has exceeded alarm threshold on missed report counter
      CLAMP_Runtime -> DatabaseCLAMP_Runtime: StoreRaise Participanta andAutomation ControlComposition LoopOffline Elementalarm Monitoringon andAutomation StatisticsComposition reportInstance

alt Fault reported on Participant
  CLAMP_Runtime -> CLAMPInstantiated_ACM_RuntimeInventory: log fault on ParticipantMark Automation Composition Instance as being offline
  CLAMP_Runtime -> Database: Record fault on Participant
end

loop Over all Control Loop Elements in Participant Report
  alt Fault reported on Control Loop Element
    CLAMP_Runtime -> CLAMP_Runtime: log fault on Control Loop Element and Control Loop
  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 -> DatabaseCLAMP_Runtime: RecordClear faultAutomation onComposition ControlInstance LoopOffline Element and Control Loop
  end
end
@enduml

3.2 Viewing of Monitoring Information

PlantUML Macro

@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
database Database

== Overview of all Control Loop Instances ==
CLAMP_GUI -> 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: Display overview of status of all Control Loop Instances

== Details of a Control Loop Instance ==
CLAMP_GUIalarm 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: [REST]Log ReadAutomation ControlComposition LoopInstance Elementsas forbeing Controlin Loopincorrect Instancestate
CLAMP_Runtime -> Database: Read Control Loop Elements for Control Loop Instance
CLAMP_Runtime -> CLAMPInstantiated_ACM_GUI: [REST] Control Loop Elements returned
CLAMP_GUI -> CLAMP_GUI: Display status of Control Loop Elements in Control Loop Instance

== Overview of all Participants ==
CLAMP_GUI -> CLAMP_Runtime: [REST] Read all participants
CLAMP_Runtime -> Database: Read all participants
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_GUIRuntime: [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 Control Loop Elements for Participant
CLAMP_Runtime -> Database: Read Control Loop Elements for Participant
CLAMP_Runtime -> CLAMP_GUI: [REST] Control Loop Elements returned
CLAMP_GUI -> CLAMP_GUI: Display status of Control Loop Elements in Participant

== Filtered Monitoring ==
CLAMP_GUI -> CLAMP_GUI: Set filter for Control Loop Instances, Control Loop Elements, and Participants
CLAMP_GUI 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 [REST]Automation ReadComposition ControlInstance Loopas Elementsbeing thatin matchcorrect filter
CLAMP_Runtime -> Database: Read Control Loop Elements that match filter
state
        CLAMP_Runtime -> CLAMPInstantiated_ACM_GUIInventory: Record [REST]Automation ControlComposition LoopInstance Elementsas thatbeing matchin filtercorrect returned
CLAMP_GUI -> CLAMP_GUI: Display status of Control Loop Elements that match filter

@enduml

3.2 Viewing of Statistics

PlantUML Macro

@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
database Database

== Statistics of all Control Loop Instances ==
CLAMP_GUIstate
        alt Automation Composition Instance in Incorrect State alarm raised on Automation Composition Instance
          CLAMP_Runtime -> CLAMP_Runtime: Clear [REST]Automation ReadComposition summaryInstance statisticsin forIncorrect allState Controlalarm Loop Instances
CLAMP_Runtime -> Database: Compile summary statistics for all Control Loop Instances
CLAMP_Runtime -> CLAMP_GUI: [REST] Summary statistics for all Control Loop Instances returned
CLAMP_GUI -> CLAMP_GUI: Display summary statistics for all Control Loop Instances

== Statistics of a Control Loop Instance ==
CLAMP_GUI -> CLAMP_Runtime: [REST] Read statistics for Control Loop Elements for Control Loop Instance
on Automation Composition Instance
        end
      end
    end
    alt Automation Composition Element in Automation Composition Instance reported a fault in last reporting window
      CLAMP_Runtime -> DatabaseCLAMP_Runtime: Compile statistics for Control Loop Elements for Control Loop Instance
 Log Automation Composition Instance as being faulty
      CLAMP_Runtime -> CLAMPInstantiated_ACM_GUIInventory: [REST]Record StatisticsAutomation forComposition ControlInstance Loopas Elementsbeing returnedfaulty
CLAMP_GUI  -> CLAMP_GUI: Display statistics foralt ControlAutomation LoopComposition ElementsElement in ControlAutomation LoopComposition Instance

== Statisticshas ofexceeded allalarm Participants ==
CLAMP_GUI -> CLAMP_Runtime: [REST] Read summary statistics for all Control Loop Instances
threshold on faulty reports
        CLAMP_Runtime -> DatabaseCLAMP_Runtime: Compile summary statistics for all Control Loop Instances
CLAMP_Runtime -> CLAMP_GUI: [REST] Summary statistics for all Control Loop Instances returned
CLAMP_GUI -> CLAMP_GUI: Display summary statistics for all Control Loop Instances

== Details of a Participant ==
CLAMP_GUI -> CLAMP_Runtime: [REST] Read Control Loop Elements for Participant
CLAMP_Runtime -> Database: Read Control Loop Elements for Participant
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_GUIRuntime: [REST] Control Loop Elements returned
CLAMP_GUI Log Automation Composition Instance as being fault free
        CLAMP_Runtime -> CLAMPInstantiated_ACM_GUIInventory: DisplayRecord statusAutomation ofComposition ControlInstance Loopas Elementsbeing infault Participant

== Filtered Monitoring ==
CLAMP_GUI -> CLAMP_GUI: Set filter for Control Loop Instances, Control Loop Elements, and Participants
CLAMP_GUI -> CLAMP_Runtime: [REST] Read Control Loop Elements that match filter
free
        alt Automation Composition Instance Faulty alarm raised on Automation Composition Instance
          CLAMP_Runtime -> DatabaseCLAMP_Runtime: Clear ReadAutomation ControlComposition LoopInstance ElementsFaulty thatalarm match filter
CLAMP_Runtime -> CLAMP_GUI: [REST] Control Loop Elements that match filter returned
CLAMP_GUI -> CLAMP_GUI: Display status of Control Loop Elements that match filter

@enduml

...

on Automation Composition Instance
        end
      end
    end
  end
end

@enduml

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 15

New Version Current

Key

1 Commissioning Dialogues

1.1 Commissioning a Control Loop Type Definition using the CLAMP GUI

1.1 Commissioning an Automation Composition Type Definition using the CLAMP GUI

1.2 Commissioning an Automation Composition Type Definition using SDC

1.3 Setting Common Properties for an Automation Composition Type Definition

1.4 Priming an Automation Composition Type Definition on Participants

1.5 De-Prime an Automation Composition Type Definition on Participants

1.6 Decommissioning an Automation Composition Type Definition in CLAMP

1.7 Reading Commissioned Automation Composition Type Definitions

2. Instantiation Dialogues

2.1 Creating an Automation Composition Instance

2.2 Updating Instance Specific Parameters on an Automation Composition Instance

1.2 Commissioning a Control Loop Type Definition using SDC

1.3 Setting Common Parameters for a Control Loop Type Definition

2.3 Updating an Automation Composition Instance with a Configuration on Participants

1.4 Commissioning a Control Loop Type Definition on Participants

2.4 Changing the state of an Automation Composition Instance on Participants

1.5 Decommissioning a Control Loop Type Definition on Participants

2.5 De-instantiating an Automation Composition Instance from Participants

1.6 Decommissioning a Control Loop Type Definition in CLAMP

1.7 Reading Commissioned Control Loop Type Definitions

2. Instantiation Dialogues

2.6 Deleting an Automation Composition Instance

2.7 Reading Automation Composition Instances

3. Monitoring Dialogues

3.1 Reporting of Monitoring Information and Statistics by Participants

2.2 Updating Instance Specific Parameters on a Control Loop Instance

3.2 Viewing of Monitoring Information

2.3 Updating a Control Loop Instance Version on Participants

3.2 Viewing of Statistics

2.5 Changing the state of a Control Loop Instance on Participants

3.3 Statistics Housekeeping

4. Supervision Dialogues

4.1 Supervise Participants

2.6 De-instantiating a Control Loop Instance from Participants

4.2 Supervise Automation Compositions

2.7 Deleting a Control Loop Instance

2.8 Reading Control Loop Instances

3. Monitoring Dialogues

3.1 Reporting of Monitoring Information and Statistics by Participants

3.2 Viewing of Monitoring Information

3.2 Viewing of Statistics