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

PlantUML Macro

@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
database Database

CLAMP_GUI -> CLAMP_Runtime: [REST] Commission Control Loop Type DefinitionFetch GUI fields for Instance Specific Parameter Definitions
CLAMP_Runtime -> DatabaseCommissioned_ACM_Inventory: StoreRead ControlAutomation LoopComposition Type Definition
CLAMP_Runtime -> 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 Generate fields for Instance Specific Parameters for GUI
CLAMP_Runtime -> CLAMP_GUI: [REST] Return GUI fields Instance Specific Parameter Definitions
CLAMP_GUI -> CLAMP_RuntimeGUI: [REST]Render CommissionUI Controlfor LoopInstance TypeSpecific DefinitionParameters
CLAMP_RuntimeGUI -> Database: Store Control Loop Type DefinitionCLAMP_GUI: Get values for Instance Specific Parameters from user
CLAMP_RuntimeGUI -> PolicyCLAMP_DistributionRuntime: [REST] TypeRequest Definition Commissioned
Policy_Distribution -> SDC: [DMaaP] Deployment Completed
@enduml

1.3 Setting Common Parameters for a Control Loop Type Definition

PlantUML Macro

@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
participant Participant
database Database

CLAMP_GUI -> CLAMP_Runtime: [REST] Read Control Loop Type DefinitionsCreation 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 -> DatabaseCLAMP_GUI: Read[REST] ControlAutomation LoopComposition TypeInstance 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
Definitions
CLAMP_Runtime -> CLAMP_GUI: [REST] Type Definitions returned
CLAMP_GUI -> CLAMP_GUI: Select Control Loop Type Definition for Parameterization
CLAMP_GUI -> CLAMP_Runtime: [REST] Fetch GUI fields for Common Parameter Definitions

alt Control Loop Type Definition not Commissioned on Participants
  CLAMP_Runtime -> Database: Read Control Loop Type Definition
  Read Automation Composition Instances
CLAMP_Runtime -> CLAMPInstantiated_ACM_RuntimeInventory: GenerateRead fieldsAutomation for Common Parameters for GUI
  Composition Instances
CLAMP_Runtime -> CLAMP_GUI: [REST] ReturnAutomation GUIComposition fields Common Parameter Definitions
  Instances returned
CLAMP_GUI -> CLAMP_GUI: Render UI for Common Select Automation Composition Instance on which to Update Parameters
  CLAMP_GUI -> CLAMP_GUI: Step Getversion valuesof forAutomation CommonComposition ParametersInstance from user
  as Major/Minor/Patch
CLAMP_GUI -> CLAMP_Runtime: [REST] SetFetch GUI valuesfields for CommonInstance Parameters
Specific Parameter Definitions
CLAMP_Runtime -> DatabaseInstantiated_ACM_Inventory: StoreRead valuesAutomation forComposition CommonType ParametersDefinition
  CLAMP_Runtime -> CLAMP_GUIRuntime: [REST]Generate Commonfields Parameterfor valuesInstance stored
elseSpecific ControlParameters Loop Type Definition already Commissioned on Participants
  for GUI
CLAMP_Runtime -> CLAMP_GUI: [REST] CannotReturn setGUI Commonfields ParametersInstance on\nControlSpecific 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 Instance Specific Parameters
CLAMP_GUI -> CLAMP_GUI: Get values for Instance Specific Parameters from user
CLAMP_GUI -> CLAMP_Runtime: [REST] Read Control Loop Type Definitions Request Update of Automation Composition Instance
CLAMP_Runtime -> CLAMP_Runtime: Update Automation Composition Instance
CLAMP_Runtime -> DatabaseInstantiated_ACM_Inventory: Read Control Loop Type DefinitionsStore 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 CLAMP_GUI
participant CLAMP_Runtime
participant Participant
database Instantiated_ACM_Inventory
Definitions returned
CLAMP_GUI -> CLAMP_GUI: Select Control Loop Type Definition for Commissioning on Participants
CLAMP_GUI -> CLAMP_Runtime: [REST] CommissionRead Controlall Loopconfiguration Typeversions Definitionof on Participants

alt Control Loop Type Definition not Commissioned on Participants
  Automation Composition Instance
CLAMP_Runtime -> DatabaseInstantiated_ACM_Inventory: Read all Controlconfiguration Loopversions Typeof Definition
Automation Composition Instance
CLAMP_Runtime -> DatabaseCLAMP_GUI: Read[REST] CommonAll Parameterconfiguration Valuesversions forof ControlAutomation LoopComposition TypeInstance Definition
  alt Common Parameter values set for Control Loop Type Definition
    CLAMP_Runtime -> Participants: [DMaaP] Update Participants with Control Loop Type Definition and values for Common Parameters
    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 -> CLAMPInstantiated_ACM_GUIInventory: [REST]Read Controlconfiguration Loopversion Typeof DefinitionAutomation commissioningComposition orderedInstance
 on participants
  else Control Loop Type Definition already Commissioned on Participants
  CLAMP_Runtime -> Participants: [DMaaP] Update Participants with configuration version of Automation Composition Instance
  CLAMP_Runtime -> CLAMP_GUI: [REST] Common Parameters not set\non Control Loop Type Definition
  end
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

== Participant Responses ==
Participants -> CLAMP_Runtime: [DMaaP] Result of Updateupdate withof Controlconfiguration Loopversion Typeof DefinitionAutomation andComposition valuesInstance foron Common Parametersparticipant
CLAMP_Runtime -> DatabaseInstantiated_ACM_Inventory: Store result of update of configuration version of ControlAutomation LoopComposition TypeInstance Definition Update on Participantparticipant

== Supervision ==
loop forever
  CLAMP_Runtime -> DatabaseInstantiated_ACM_Inventory: Read ControlAutomation LoopComposition Type DefinitionsInstances
  loop over each ControlAutomation LoopComposition Type DefinitionInstance
    alt ControlAutomation LoopComposition TypeInstance Definitionconfiguration Participantversion Commissionupdate underway on participants
	  CLAMP_Runtime -> DatabaseInstantiated_ACM_Inventory: read result of Control Loop Type Definition Updates from participants
      alt Updates completed on all participantsAutomation 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 -> DatabaseInstantiated_ACM_Inventory: set overall configuration Controlversion Loopof TypeAutomation DefinitionComposition asInstance Commissionedstate onas ParticipantsInstantiated
      else Updates not completed
        alt CommissioningInstantiation of ControlAutomation LoopComposition Type DefinitionInstance on participants timed out
	      CLAMP_Runtime -> DatabaseInstantiated_ACM_Inventory: set configuration Controlversion LoopAutomation TypeComposition DefinitionInstance commissioningInstantiation as timed out on Participants
	      CLAMP_Runtime -> CLAMP_Runtime: Log error
        else Wait for updates to complete
        end
      end 
    else Automation Composition ControlInstance Loopconfiguration Typeversion Definitionupdate Participanton Commissionparticipants not underway
    end
  end
end
@enduml

1.5 Decommissioning a Control Loop Type Definition on Participants

...

2.4 Changing the state of an Automation Composition Instance on Participants

PlantUML Macro

@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
participant Participant
database DatabaseInstantiated_ACM_Inventory

CLAMP_GUI -> CLAMP_Runtime: [REST] Read Controlall LoopInstantiated Type Definitions
CLAMP_Runtime -> Database: Read Control Loop Type DefinitionsAutomation Composition Instances
CLAMP_Runtime -> CLAMP_GUI: [REST] Type Definitions returned
CLAMP_GUI -> CLAMP_GUI: Select Control Loop Type Definition for Decommissioning on Participants
CLAMP_GUIInstantiated_ACM_Inventory: Read all Instantiated Automation Composition Instances
CLAMP_Runtime -> CLAMP_RuntimeGUI: [REST] DecommissionAll ControlInstantiated 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_RuntimeAutomation Composition Instances returned
CLAMP_GUI -> ParticipantsCLAMP_GUI: [DMaaP]Select UpdateAutomation Participants,Composition removing Control Loop Type Definition and values for Common Parameters
    CLAMP_RuntimeInstance on which to change state and specify new state
CLAMP_GUI -> CLAMP_GUIRuntime: [REST] Control Loop Type Definition decommissioning ordered on participants
  else Control Loop Instances exist for Control Loop Type Definition
   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] Control Loop Type Definition cannot be\n decommissioned on participants\nit is in use on control loops
  end
else Control Loop Type Definition not CommissionedChange of state of Automation Composition Instance ordered on participants
else Selected Automation Composition Instance not instantiated on Participants
  CLAMP_Runtime -> CLAMP_GUI: [REST] ControlAutomation LoopComposition Type DefinitionInstance has not\nbeen commissionedinstantiated on participants 
end

== Participant Responses ==
Participants -> CLAMP_Runtime: [DMaaP] Result of UpdateState toChange removeof ControlAutomation LoopComposition TypeInstance Definition and values for Common Parameterson participant
CLAMP_Runtime -> DatabaseInstantiated_ACM_Inventory: Store result of State ControlChange Loopof TypeAutomation DefinitionComposition UpdateInstance on Participantparticipant

== Supervision ==
loop forever
  CLAMP_Runtime -> DatabaseInstantiated_ACM_Inventory: Read ControlAutomation Loop TypeComposition DefinitionsInstances
  loop over each ControlAutomation LoopComposition Type DefinitionInstance
    alt Automation ControlComposition LoopInstance TypeState DefinitionChange Participantunderway decommissionon underwayparticipants
	  CLAMP_Runtime -> DatabaseInstantiated_ACM_Inventory: read result of ControlAutomation LoopComposition TypeState Definition UpdatesChange from participants
      alt Updates completed on all participants
	    CLAMP_Runtime -> DatabaseInstantiated_ACM_Inventory: set ControlAutomation LoopComposition TypeInstance Definitionstate as decommissionedchanged on Participants
	    CLAMP_Runtime -> Instantiated_ACM_Inventory: set overall Automation Composition Instance state as changed
      else Updates not completed
        alt CommissioningAutomation ofComposition Control LoopInstance TypeState DefinitionChange on participants timed out
	      CLAMP_Runtime -> DatabaseInstantiated_ACM_Inventory: set ControlAutomation LoopComposition TypeState Definition decommissioningChange as timed out on Participants
	      CLAMP_Runtime -> CLAMP_Runtime: Log error
        else Wait for updates to complete
        end
      end 
    else Control Loop Type Definition Participant decommission not underway
    end
  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 Definitions
CLAMP_Runtime -> CLAMP_GUI: [REST] Type Definitions returned
CLAMP_GUI -> CLAMP_GUI:  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
Select Control Loop Type Definition for Decommissioning
CLAMP_GUI -> CLAMP_Runtime: [REST] DecommissionRead Controlall LoopInstantiated Type Definition

alt Control Loop Type Definition not Commissioned on Participants
  Automation Composition Instances
CLAMP_Runtime -> Database: Delete Control Loop Type Definition
  CLAMP_Runtime -> CLAMP_GUI: [REST] Type Definition Decommissioned
else Control Loop Type Definition not Commissioned on Participants
  Instantiated_ACM_Inventory: Read all Instantiated Automation Composition Instances
CLAMP_Runtime -> CLAMP_GUI: [REST] ControlAll LoopInstantiated TypeAutomation DefinitionComposition 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

Instances returned
CLAMP_GUI -> CLAMP_GUI: Select Automation Composition Instance to de-instantiate
CLAMP_GUI -> CLAMP_Runtime: [REST] Read Control Loop Type Definitions
CLAMP_Runtime -> Database: Read Control Loop Type Definitions
De-instantiate selected Automation Composition Instance on Participants

alt Selected Automation Composition Instance instantiated on Participants
  CLAMP_Runtime -> CLAMP_GUIParticipants: [RESTDMaaP] TypeUpdate 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

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
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] Type Definitions returned
CLAMP_GUI Automation Composition Instance not instantiated on participants 
end

== Participant Responses ==
Participants -> CLAMP_GUIRuntime: Select[DMaaP] ControlResult Loopof Typeupdate Definitionof toAutomation useComposition toInstance create Control Loop Instanceon participant
CLAMP_GUIRuntime -> CLAMPInstantiated_ACM_RuntimeInventory: [REST] Fetch GUI fields for Instance Specific Parameter Definitions
 Store result of update of Automation Composition Instance on participant

== Supervision ==
loop forever
  CLAMP_Runtime -> DatabaseInstantiated_ACM_Inventory: Read ControlAutomation LoopComposition 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 Control Loop Instance
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 -> CLAMPInstantiated_ACM_RuntimeInventory: Createset overall ControlAutomation LoopComposition Instance
CLAMP_Runtime -> Database: Store First Version of Control 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
CLAMP_Runtime -> Database: Read Control Loop Instances
 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_GUI: [REST] Control Loop Instances returned
CLAMP_GUI -> CLAMP_GUI: 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
CLAMP_Runtime -> Database: Read Control Loop Type 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_GUIDefinition
CLAMP_Runtime -> CLAMP_Runtime: Generate[REST] fieldsRead forall InstanceAutomation Specific Parameters for GUIComposition Instances
CLAMP_Runtime -> CLAMPInstantiated_ACM_GUIInventory: [REST]Read Returnall GUIAutomation fields Instance Specific Parameter DefinitionsComposition Instances
CLAMP_GUIRuntime -> CLAMP_GUI: Render[REST] UIAll forAutomation InstanceComposition SpecificInstances Parametersreturned
CLAMP_GUI -> CLAMP_GUI: GetSelect valuesAutomation forComposition Instance Specific Parameters from userto delete
CLAMP_GUI -> CLAMP_Runtime: [REST] Request Update of Control Loop Instance
 Delete selected Automation Composition Instance

alt Selected Automation Composition Instance exists
  CLAMP_Runtime -> CLAMPInstantiated_ACM_RuntimeInventory: UpdateDelete ControlAutomation LoopComposition Instanceinstance
  CLAMP_Runtime -> DatabaseCLAMP_GUI: Store New Version of Control Loop Instance
[REST] Automation Composition Instance deleted
else Selected Automation Composition Instance does not exist
  CLAMP_Runtime -> CLAMP_GUI: [REST] ControlAutomation LoopComposition Instance Updated does not exist 
end

@enduml

2.

...

7 Reading Automation Composition Instances

PlantUML Macro

@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
participant Participant
database DatabaseInstantiated_ACM_Inventory

CLAMP_GUI -> CLAMP_Runtime: [REST] Read all versions of Control Loop InstanceAutomation Composition Instances
CLAMP_Runtime -> DatabaseInstantiated_ACM_Inventory: Read all versionsAutomation of Control Loop InstanceComposition Instances
CLAMP_Runtime -> CLAMP_GUI: [REST] All versionsAutomation of Control Loop Instance returned
CLAMP_GUI -> CLAMP_GUI: Select version of Control Loop Instance for Instantiation Participants
CLAMP_GUIComposition 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: [RESTDMaaP] InstantiateParticipant selectedand versionAutomation ofComposition ControlElement LoopMonitoring Instanceand on Participants

alt Selected version of Control Loop Instance not instantiated on Participants
  Statistics report
CLAMP_Runtime -> DatabaseInstantiated_ACM_Inventory: ReadStore versionParticipant ofand ControlAutomation LoopComposition Instance
Element Monitoring CLAMP_Runtime -> Participants: [DMaaP] Update Participants with version of Control Loop Instanceand Statistics report

alt Fault reported on Participant
  CLAMP_Runtime -> CLAMP_GUIRuntime: [REST] Instantiation of Version of Control Loop Instance orderedlog fault on participantsParticipant
else Selected version of Control Loop Instance instantiated on Participants
  CLAMP_Runtime -> CLAMP_GUI: [REST] Version of Control Loop Instance already instantiated on participants 
end

== Participant Responses ==
ParticipantsCLAMP_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: [DMaaP]log Resultfault ofon updateAutomation ofComposition versionElement ofand ControlAutomation LoopComposition Instance  on  participant
CLAMP_Runtime -> Database: StoreInstantiated_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
 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
	    CLAMP_Runtime -> Database: set version of Control Loop Instance as Instantiated on Participants
	    CLAMP_Runtime -> Database: set overall version of Control Loop Instance state as Instantiated
      else Updates not completed
        alt Instantiation of Control Loop Instance on participants timed out
	      CLAMP_Runtime -> Database: set version Control Loop Instance Instantiation as timed out on Participants
	      CLAMP_RuntimeInstantiated_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: Log error
        else Wait for updates to complete
        end
      end 
    else Control Loop Instance Instantiation update on participants not underway
    end
  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
[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 allComposition InstantiatedElements Controlthat Loopmatch Instancesfilter
CLAMP_Runtime -> DatabaseInstantiated_ACM_Inventory: Read Automation allComposition InstantiatedElements Controlthat Loopmatch Instancesfilter
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 == All Instantiated Control Loop Instances returned
CLAMP_GUI -> CLAMP_GUI: Select Control Loop Instance on which to change state and specify new state
CLAMP_GUI -> CLAMP_Runtime: [REST] ChangeRead statesummary ofstatistics selectedfor Controlall LoopAutomation Instance on Participants

alt Selected Control Loop Instance instantiated on Participants
  Composition Instances
CLAMP_Runtime -> Participants Instantiated_ACM_Inventory: [DMaaP]Compile Requestsummary changestatistics offor stateall ofAutomation ControlComposition Loop InstanceInstances
  CLAMP_Runtime -> CLAMP_GUI: [REST] ChangeSummary ofstatistics statefor ofall ControlAutomation LoopComposition Instance ordered on participants
else Selected Control Loop Instance not instantiated on Participants
  CLAMP_RuntimeInstances returned
CLAMP_GUI -> CLAMP_GUI: [REST]Display Controlsummary Loopstatistics Instancefor notall instantiatedAutomation onComposition participants Instances
end

== Participant ResponsesStatistics of a Automation Composition Instance ==
ParticipantsCLAMP_GUI -> CLAMP_Runtime: [DMaaPREST] ResultRead ofstatistics Statefor ChangeAutomation ofComposition ControlElements Loopfor InstanceAutomation onComposition participantInstance
CLAMP_Runtime -> DatabaseInstantiated_ACM_Inventory: StoreCompile statistics resultfor ofAutomation StateComposition ChangeElements offor ControlAutomation LoopComposition Instance on participant

== Supervision ==
loop forever
  CLAMP_Runtime
CLAMP_Runtime -> CLAMP_GUI: [REST] Statistics for Automation Composition Elements returned
CLAMP_GUI -> DatabaseCLAMP_GUI: ReadDisplay Control Loop Instances
  loop over each Control Loop Instance
    alt Control Loop Instance State Change underway on participants
	  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 -> DatabaseInstantiated_ACM_Inventory: readCompile resultsummary ofstatistics Controlfor Loopall StateAutomation ChangeComposition from participants
      alt Updates completed on all participants
	    CLAMP_Runtime -> Database: set Control Loop Instance state as changed on Participants
	    CLAMP_Runtime -> Database: set overall Control Loop Instance state as changed
      else Updates not completed
        alt Control Loop Instance State Change on participants timed out
	      CLAMP_Runtime -> Database: set Control Loop State Change as timed out on Participants
	      CLAMP_RuntimeInstances
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: Log error
        else Wait for updates to complete
        end
      end 
    else Control Loop Instance State Change on participants not underway
    end
  end
end
@enduml

2.6 De-instantiating a Control Loop Instance from Participants

 [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

PlantUML Macro

@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
participant Participant
database DatabaseInstantiated_ACM_Inventory

CLAMP_GUI -> CLAMP_Runtime: [REST] Read all Instantiated Control Loop Instances
== Automation Composition Instance Statistics ==

loop forever
  CLAMP_Runtime -> DatabaseInstantiated_ACM_Inventory: Read Automation allComposition InstantiatedInstance ControlStatistics
 Loop Instances
CLAMP_Runtime -> CLAMP_GUIRuntime: [REST]Summarise AllAutomation InstantiatedComposition ControlInstance LoopStatistics
 Instances returned
CLAMP_GUIRuntime -> CLAMPInstantiated_ACM_GUIInventory: SelectStore summarised ControlAutomation LoopComposition Instance Statistics
 to de-instantiate
CLAMP_GUIRuntime -> CLAMPInstantiated_ACM_RuntimeInventory: [REST] De-instantiate selected Control Loop Instance on Participants

alt Selected Control Loop Instance instantiated on ParticipantsDelete Automation Composition Instance Statistics on which retention period has expired
end

== Participant Statistics ==

loop forever
  CLAMP_Runtime -> Participants: [DMaaP] Update Participants to remove Control Loop InstanceInstantiated_ACM_Inventory: Read Participant Statistics
  CLAMP_Runtime -> CLAMP_Runtime: Summarise Participant Statistics
  CLAMP_Runtime -> CLAMPInstantiated_ACM_GUIInventory: 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
     [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
CLAMP_Runtime -> Database: Store result of update of Control Loop Instance on participant

== Supervision ==
loop forever
  CLAMP_Runtime -> DatabaseCLAMP_Runtime: ReadLog ControlParticipant Loopas Instances
having missed loopa overreport
 each Control Loop Instance
   CLAMP_Runtime alt Control Loop Instance de-instantiation update underway-> Instantiated_ACM_Inventory: Increment missed report counter on participantsParticipant
	  CLAMP_Runtime -> Database: read result of Controlalt LoopParticipant updateshas fromexceeded participants
alarm threshold on missed report counter
 alt Updates completed on all participants
	    CLAMP_Runtime -> DatabaseCLAMP_Runtime: setRaise Controla LoopParticipant Instance as de-instantiatedOffline alarm on Participants
	participant
          CLAMP_Runtime -> DatabaseInstantiated_ACM_Inventory: set overall Control Loop Instance as de-instantiated
  Mark participant as being offline
       end
    else UpdatesParticipant nothas completed
reported in last reporting window
    alt Control Loop InstanceCLAMP_Runtime de-instantiation Update timed out-> Instantiated_ACM_Inventory: Clear missed report counter on participantsParticipant
	      CLAMP_Runtime -> Database:alt setParticipant Controlmarked Loopas Instance de-instantiation as timed out on Participants
	being offline
          CLAMP_Runtime -> CLAMP_Runtime: LogClear error
Participant Offline alarm on participant
    else Wait for updates to complete
 CLAMP_Runtime -> Instantiated_ACM_Inventory: Mark participant as being endonline
       end 
    else Control Loop Instance de-instantiation update on participants not underwayend
    end
  end

@enduml

...

4.2 Supervise Automation Compositions

PlantUML Macro

@startuml
participant CLAMP_GUIRuntime
participantdatabase CLAMPInstantiated_ACM_RuntimeInventory

databaseloop Databaseforever

  CLAMP_GUIRuntime -> CLAMPInstantiated_ACM_RuntimeInventory: [REST] Read all Control Loop Instances
CLAMP_Runtime -> Database: Read all Control Loop Instances
CLAMP_Runtime -> CLAMP_GUI: [REST] All Control Loop Instances returned
CLAMP_GUI -> CLAMP_GUI: Select Control Loop Instance to delete
CLAMP_GUIRead 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: [REST]Log DeleteAutomation selectedComposition ControlElement Loop Instance

alt Selected Control Loop Instance existsas having missed a report
  CLAMP_Runtime -> Database: Delete control loop instance
  CLAMP_Runtime -> CLAMPInstantiated_ACM_GUIInventory: [REST] Control Loop Instance deleted
else Selected Control Loop Instance does not exist
  CLAMP_Runtime -> CLAMP_GUI: [REST] Control Loop Instance does not exist 
end

@enduml

2.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
 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 -> DatabaseCLAMP_Runtime: StoreLog Automation ParticipantComposition andElement Controlas Loopbeing Elementin Monitoringincorrect andstate
 Statistics report

alt Fault reported on Participant
  CLAMP_Runtime -> CLAMPInstantiated_ACM_Runtime: log fault on Participant
  CLAMP_Runtime -> Database: Record fault on Participant
end

loop Over all Control Loop Elements in Participant Report
  alt Fault reported on Control Loop Element
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: logLog faultAutomation onComposition ControlElement Loopas Elementbeing andin Controlcorrect Loopstate
          CLAMP_Runtime -> DatabaseInstantiated_ACM_Inventory: Record fault on Control LoopAutomation Composition Element andas Controlbeing Loop
in  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
correct state
        end
      end
      alt Automation Composition Element reported fault in last reporting window
        CLAMP_Runtime -> CLAMP_GUI: [REST] All Control Loop Instances returned
CLAMP_GUIRuntime: Log Automation Composition Element as being faulty
        CLAMP_Runtime -> CLAMPInstantiated_ACM_GUI: Display overview of status of all Control Loop Instances

== Details of a Control Loop Instance ==
CLAMP_GUI -> CLAMP_Runtime: [REST] Read Control Loop Elements for Control Loop Instance
CLAMP_Runtime -> Database: Read Control Loop Elements for Control Loop Instance
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_GUIRuntime: [REST] Control Loop Elements returned
CLAMP_GUI Log Automation Composition Element fault as cleared
          CLAMP_Runtime -> CLAMPInstantiated_ACM_GUIInventory: Mark Displayfault statusAutomation ofComposition ControlElement Loopas Elementsbeing incleared
 Control Loop Instance

== Overview of all Participants ==
CLAMP_GUI -> CLAMP_Runtime: [REST] Read all participants
CLAMP_Runtime -> Database: 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_GUIend
      end
    end
    alt Automation Composition Element in Automation Composition Instance has exceeded alarm threshold on missed report counter
      CLAMP_Runtime -> CLAMP_Runtime: [REST] Read Control Loop Elements for Participant
 Raise a Automation Composition Offline alarm on Automation Composition Instance
      CLAMP_Runtime -> DatabaseInstantiated_ACM_Inventory: ReadMark Automation ControlComposition LoopInstance Elementsas forbeing 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_GUIoffline
    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: [REST] Read Control Loop Elements that match filter
Clear Automation Composition Instance Offline alarm on Automation Composition           CLAMP_Runtime -> DatabaseInstantiated_ACM_Inventory: ReadMark ControlAutomation LoopComposition ElementsInstance thatas matchbeing 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

3.2 Viewing of Statistics

PlantUML Macro

@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
database Database

== Statistics of all Control Loop Instances ==
CLAMP_GUIonline
       end
    end
    alt Automation Composition Element in Automation Composition Instance in incorrect state in last reporting window
      CLAMP_Runtime -> CLAMP_Runtime: [REST] Read summary statistics for all Control Loop Instances
Log Automation Composition Instance as being in incorrect state
      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_GUIInstantiated_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: [REST] Read statistics for Control Loop Elements for Control Loop Instance
CLAMP_Runtime -> Database: Compile statistics for Control Loop Elements for Control Loop Instance
 Raise a Automation Composition Instance in Incorrect State alarm on Automation Composition Instance
        CLAMP_Runtime -> CLAMPInstantiated_ACM_GUIInventory: [REST] Statistics for Control Loop Elements returned
CLAMP_GUI -> CLAMP_GUI: Display statistics for Control Loop Elements in Control Loop Instance

== Statistics of all Participants ==
CLAMP_GUI -> CLAMP_Runtime: [REST] Read summary statistics for all Control 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_GUIMark 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_GUIRuntime: DisplayLog Automation summaryComposition statisticsInstance foras allbeing Controlin Loopcorrect Instances

== Statistics of a Participant ==
CLAMP_GUIstate
        CLAMP_Runtime -> CLAMPInstantiated_ACM_RuntimeInventory: [REST]Record ReadAutomation statisticsComposition forInstance Controlas Loopbeing Elementsin forcorrect Participant
CLAMP_Runtime -> Database: Read statistics for Control Loop Elements for Participant
CLAMP_Runtime -> CLAMP_GUI: [REST] Statistics for Control Loop Elements returned
CLAMP_GUI -> CLAMP_GUI: Display statistics for Control Loop Elements in Participant

== Filtered Statistics ==
CLAMP_GUIstate
        alt Automation Composition Instance in Incorrect State alarm raised on Automation Composition Instance
          CLAMP_Runtime -> CLAMP_GUIRuntime: Clear SetAutomation filterComposition forInstance Controlin LoopIncorrect Instances,State Controlalarm Loopon Elements,Automation andComposition Participants
CLAMP_GUI -> CLAMP_Runtime: [REST] Read statistics for Control Loop Elements that match filter
CLAMP_Runtime -> Database: Read statistics for Control Loop Elements that match filter
CLAMP_Runtime -> CLAMP_GUI: [REST] Statistics for Control Loop Elements that match filter returned
CLAMP_GUIInstance
        end
      end
    end
    alt Automation Composition Element in Automation Composition Instance reported a fault in last reporting window
      CLAMP_Runtime -> CLAMP_GUIRuntime: DisplayLog statisticsAutomation forComposition ControlInstance Loopas Elements that match filter

@enduml

3.3 Statistics Housekeeping

PlantUML Macro

@startuml
participant CLAMP_Runtime
database Database

loop forever
being faulty
      CLAMP_Runtime -> Database: Read Control Loop InstancesInstantiated_ACM_Inventory: Record Automation Composition Instance as being faulty
  loop over each Control Loopalt Instance
Automation Composition Element in altAutomation ControlComposition LoopInstance Instancehas de-instantiationexceeded updatealarm underwaythreshold on faulty participants
	reports
        CLAMP_Runtime -> DatabaseCLAMP_Runtime: readRaise resulta ofAutomation ControlComposition LoopInstance updatesFaulty fromalarm participants
on Automation Composition   Instance
 alt Updates completed on all participantsend
	    CLAMP_Runtime -> Database: set Control Loop Instance as de-instantiated on Participants
	else No Automation Composition Element faulty in last reporting window
    CLAMP_Runtime -> Database:alt setAutomation overallComposition ControlElement Loopin InstanceAutomation as de-instantiated
      else Updates not completed
Composition Instance was faulty on previous report
        CLAMP_Runtime -> CLAMP_Runtime: Log altAutomation Control LoopComposition Instance de-instantiationas Updatebeing timedfault outfree
 on participants
	      CLAMP_Runtime -> DatabaseInstantiated_ACM_Inventory: setRecord ControlAutomation LoopComposition Instance de-instantiationas asbeing timedfault outfree
 on Participants
	      CLAMP_Runtime -> CLAMP_Runtime: Log error
        else Wait for updates to complete
        end
      end 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
    else  Control Loop Instanceend
 de-instantiation update on participants not underwayend
    end
  end
end

@enduml

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 17

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

1.2 Commissioning a Control Loop Type Definition using SDC

1.3 Setting Common Parameters for a Control Loop Type Definition

2.2 Updating Instance Specific Parameters on an Automation Composition Instance

1.4 Commissioning a Control Loop Type Definition on Participants

2.3 Updating an Automation Composition Instance with a Configuration on Participants

1.5 Decommissioning a Control Loop Type Definition on Participants

2.4 Changing the state of an Automation Composition Instance on Participants

1.6 Decommissioning a Control Loop Type Definition in CLAMP

2.5 De-instantiating an Automation Composition Instance from Participants

1.7 Reading Commissioned Control Loop Type Definitions

2. Instantiation Dialogues

2.1 Creating a Control Loop Instance

2.2 Updating Instance Specific Parameters on a Control Loop Instance

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

3.2 Viewing of Monitoring Information

2.5 Changing the state of a Control Loop Instance on Participants

3.2 Viewing of Statistics

2.6 De-instantiating a Control Loop Instance from Participants

3.3 Statistics Housekeeping

4. Supervision Dialogues

4.1 Supervise Participants

4.2 Supervise Automation Compositions

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

3.3 Statistics Housekeeping