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

PlantUML Macro

@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
database Database

CLAMP_GUI -> CLAMP_Runtime: [REST] Commission Control Loop Type Definition
CLAMP_Runtime -> Database: Store Control Loop Type Definition
CLAMP_Runtime -> CLAMP_GUI: [REST] Type Definition Commissioned
@enduml

1.2 Commissioning a Control Loop Type Definition using SDC

PlantUML Macro

@startuml
participant SDC
participant Policy_Distribution
participant CLAMP_Runtime
database Database

SDC -> Policy_Distribution: [DMaaP] CSAR containing Control Loop Type Definition
Policy_Distribution -> CLAMP_Runtime: [REST] Commission Control Loop Type Definition
CLAMP_Runtime -> Database: Store Control Loop Type Definition
CLAMP_Runtime -> Policy_Distribution: [REST] Type Definition Commissioned
Policy_Distribution -> SDC: [DMaaP] Deployment Completed
@enduml

...

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
participant Participant
database DatabaseCommissioned_ACM_Inventory

CLAMP_GUI -> CLAMP_Runtime: [REST] Read ControlAutomation LoopComposition Type Definitions
CLAMP_Runtime -> DatabaseCommissioned_ACM_Inventory: Read ControlAutomation LoopComposition 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
 [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
  CLAMP_Runtime -> CLAMPCommissioned_ACM_RuntimeInventory: GenerateRead fieldsAutomation forComposition Common Parameters for GUI
  Type Definitions
CLAMP_Runtime -> CLAMP_GUI: [REST] ReturnType GUI fields Common Parameter Definitions
  Definitions returned
CLAMP_GUI -> CLAMP_GUI: Render UI for Common Parameters
   Select Automation Composition Type Definition to use to create Automation Composition Instance
CLAMP_GUI -> CLAMP_GUI: Get valuesRuntime: [REST] Fetch GUI fields for CommonInstance ParametersSpecific fromParameter userDefinitions
  CLAMP_GUIRuntime -> CLAMPCommissioned_ACM_RuntimeInventory: [REST]Read SetAutomation valuesComposition forType Common ParametersDefinition
  CLAMP_Runtime -> DatabaseCLAMP_Runtime: StoreGenerate valuesfields for CommonInstance Specific Parameters
 for GUI
CLAMP_Runtime -> CLAMP_GUI: [REST] Common Return GUI fields Instance Specific Parameter values stored
else Control Loop Type Definition already Commissioned on Participants
  CLAMP_RuntimeDefinitions
CLAMP_GUI -> CLAMP_GUI: Render UI for Instance Specific Parameters
CLAMP_GUI -> CLAMP_GUI: Get [REST]values Cannotfor setInstance CommonSpecific Parameters on\nControl Loop Type Definition that has\nbeen commissioned on participants
end

@enduml

1.4 Commissioning a Control Loop Type Definition on Participants

PlantUML Macro

@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
participant Participant
database Database

CLAMP_GUI -> CLAMP_Runtime: [REST] Read Control Loop Type Definitionsfrom 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 -> DatabaseCLAMP_GUI: Read[REST] ControlAutomation LoopComposition TypeInstance Definitions
CLAMP_Runtime -> CLAMP_GUI: [REST] Type Definitions returned
CLAMP_GUI -> CLAMP_GUI: Select Control Loop Type Definition for Commissioning on ParticipantsUpdated

@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] CommissionRead ControlAutomation Loop Type Definition on Participants

alt Control Loop Type Definition not Commissioned on Participants
  Composition Instances
CLAMP_Runtime -> Instantiated_ACM_Inventory: Read Automation Composition Instances
CLAMP_Runtime -> DatabaseCLAMP_GUI: Read[REST] ControlAutomation LoopComposition TypeInstances Definitionreturned
  CLAMP_RuntimeGUI -> DatabaseCLAMP_GUI: ReadSelect CommonAutomation ParameterComposition ValuesInstance foron Controlwhich Loopto TypeUpdate DefinitionParameters
CLAMP_GUI  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
    -> CLAMP_GUI: Step version of Automation Composition Instance as Major/Minor/Patch
CLAMP_GUI -> CLAMP_Runtime: [REST] Fetch GUI fields for Instance Specific Parameter Definitions
CLAMP_Runtime -> CLAMPInstantiated_ACM_GUIInventory: [REST]Read ControlAutomation LoopComposition Type Definition commissioning ordered on participants
  else Control Loop Type Definition already Commissioned on Participants
    
CLAMP_Runtime -> CLAMP_Runtime: Generate fields for Instance Specific Parameters for GUI
CLAMP_Runtime -> CLAMP_GUI: [REST] CommonReturn ParametersGUI notfields set\nonInstance ControlSpecific LoopParameter Type Definition
  end
else Control Loop Type Definition already Commissioned on Participants
  CLAMP_RuntimeDefinitions
CLAMP_GUI -> CLAMP_GUI: Render UI for Instance Specific Parameters
CLAMP_GUI -> CLAMP_GUI: Get [REST]values Cannotfor setInstance CommonSpecific Parameters on\nControl Loop Type Definition that has\nbeen commissioned on participants
end

== Participant Responses ==
Participantsfrom user
CLAMP_GUI -> CLAMP_Runtime: [REST] Request Update of Automation Composition Instance
CLAMP_Runtime -> CLAMP_Runtime: [DMaaP]Update ResultAutomation of Update with Control Loop Type Definition and values for Common ParametersComposition Instance
CLAMP_Runtime -> Instantiated_ACM_Inventory: Store New Version of Automation Composition Instance
CLAMP_Runtime -> DatabaseCLAMP_GUI: Store[REST] resultAutomation ofComposition Instance Updated

@enduml

2.3 Updating an Automation Composition Instance with a Configuration on Participants

PlantUML Macro

@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
participant Participant
database Instantiated_ACM_Inventory

CLAMP_GUI -> CLAMP_Runtime: [REST] Read all configuration versions of Automation Composition Instance
CLAMP_Runtime -> Instantiated_ACM_Inventory: Read all configuration versions of Automation Composition Instance
Control Loop Type Definition Update on Participant

== Supervision ==
loop forever
  CLAMP_Runtime -> Database: Read Control Loop Type Definitions
  loop over each Control Loop Type Definition
    alt Control Loop Type Definition Participant Commission underway
	  CLAMP_Runtime -> DatabaseCLAMP_GUI: read[REST] resultAll ofconfiguration Controlversions Loopof TypeAutomation DefinitionComposition UpdatesInstance from participants
      alt Updates completed on all participants
	    CLAMP_Runtime -> Database: set Control Loop Type Definition as Commissionedreturned
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 elseComposition UpdatesInstance not instantiated on completedParticipants
  CLAMP_Runtime -> Instantiated_ACM_Inventory: Read configuration version  alt Commissioning of Control Loop Type Definition on participants timed out
	    of Automation Composition Instance
  CLAMP_Runtime -> Participants: [DMaaP] Update Participants with configuration version of Automation Composition Instance
  CLAMP_Runtime -> DatabaseCLAMP_GUI: set Control Loop Type Definition commissioning as timed out on Participants
	    [REST] Instantiation of configuration version of Automation Composition Instance ordered on participants
else Selected configuration version of Automation Composition Instance instantiated on Participants
  CLAMP_Runtime -> CLAMP_RuntimeGUI: Log error
        else Wait for updates to complete
        end
      end 
    else Control Loop Type Definition Participant Commission not underway
    end
  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
CLAMP_Runtime -> Database: Read Control Loop Type Definitions
[REST] configuration version of Automation Composition Instance already instantiated on participants 
end

== Participant Responses ==
Participants -> CLAMP_Runtime: [DMaaP] Result of update of configuration version of Automation Composition Instance on participant
CLAMP_Runtime -> Instantiated_ACM_Inventory: Store result of update of configuration version of Automation Composition Instance on participant

== Supervision ==
loop forever
  CLAMP_Runtime -> Instantiated_ACM_Inventory: Read Automation Composition Instances
  loop over each Automation Composition Instance
    alt Automation Composition Instance configuration version update underway on participants
	  CLAMP_Runtime -> Instantiated_ACM_Inventory: read result of Automation Composition updates from participants
      alt Updates completed on all participants
	    CLAMP_Runtime -> CLAMPInstantiated_ACM_GUIInventory: [REST]set Typeconfiguration 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
    CLAMP_Runtime -> Participants: [DMaaP] Update Participants, removing Control Loop Type Definition and values for Common Parameters
version of Automation Composition Instance as Instantiated on Participants
	    CLAMP_Runtime -> Instantiated_ACM_Inventory: set overall configuration version of Automation Composition Instance state as Instantiated
      else Updates not completed
        alt Instantiation of Automation Composition Instance on participants timed out
	      CLAMP_Runtime -> CLAMPInstantiated_ACM_GUIInventory: [REST]set Controlconfiguration Loopversion TypeAutomation DefinitionComposition decommissioningInstance orderedInstantiation onas participants
  else Control Loop Instances exist for Control Loop Type Definition
timed out on Participants
	      CLAMP_Runtime -> CLAMP_GUIRuntime: [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 Commissioned on Participants
  CLAMPLog 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
_Runtime -> CLAMP_GUI: [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 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[DMaaP] ControlRequest Loopchange Typeof Definitionstate asof decommissionedAutomation onComposition ParticipantsInstance
  CLAMP_Runtime -> CLAMP_GUI: [REST] elseChange Updatesof not completed
        alt Commissioning state of ControlAutomation LoopComposition TypeInstance Definitionordered on participants timed out
	    
else Selected Automation Composition Instance not instantiated on Participants
  CLAMP_Runtime -> DatabaseCLAMP_GUI: set[REST] ControlAutomation LoopComposition TypeInstance Definitionnot decommissioninginstantiated ason timed out on Participants
	      CLAMP_Runtime participants 
end

== Participant Responses ==
Participants -> 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
 [DMaaP] Result of State Change of Automation Composition Instance on participant
CLAMP_Runtime -> Instantiated_ACM_Inventory: Store result of State Change of Automation Composition Instance on participant

== Supervision ==
loop forever
  CLAMP_Runtime -> Instantiated_ACM_Inventory: Read Automation Composition Instances
  loop over each Automation Composition Instance
    alt Automation Composition Instance State Change underway on participants
	  CLAMP_Runtime -> Instantiated_ACM_Inventory: read result of Automation Composition State Change from participants
      alt Updates completed on all participants
	    CLAMP_Runtime -> CLAMPInstantiated_ACM_GUI: [REST] Type Definitions returned
CLAMP_GUIInventory: set Automation Composition Instance state as changed on Participants
	    CLAMP_Runtime -> CLAMPInstantiated_ACM_GUIInventory: set Selectoverall ControlAutomation LoopComposition TypeInstance Definitionstate foras Decommissioningchanged
CLAMP_GUI  -> CLAMP_Runtime: [REST] Decommission Controlelse LoopUpdates Typenot Definitioncompleted

alt Control Loop Type Definition not Commissioned on Participants
alt Automation CLAMP_Runtime -> Database: Delete Control Loop Type Definition
Composition Instance State Change on participants timed out
	      CLAMP_Runtime -> CLAMPInstantiated_ACM_GUIInventory: [REST]set TypeAutomation DefinitionComposition Decommissioned
else Control Loop Type Definition not CommissionedState Change 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 State Change on participants not underway
    end
  end
end
@enduml

2.5 De-instantiating an Automation Composition Instance from Participants

PlantUML Macro

@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
participant Participant
database DatabaseInstantiated_ACM_Inventory

CLAMP_GUI -> CLAMP_Runtime: [REST] Read all ControlInstantiated LoopAutomation TypeComposition DefinitionsInstances
CLAMP_Runtime -> DatabaseInstantiated_ACM_Inventory: Read all ControlInstantiated LoopAutomation TypeComposition DefinitionsInstances
CLAMP_Runtime -> CLAMP_GUI: [REST] Type DefinitionsAll Instantiated Automation Composition Instances returned
CLAMP_GUI -> CLAMP_GUI: Select ControlAutomation LoopComposition Type DefinitionInstance to use to create Control Loop Instancede-instantiate
CLAMP_GUI -> CLAMP_Runtime: [REST] FetchDe-instantiate GUIselected fieldsAutomation forComposition Instance Specific Parameter Definitions
CLAMP_Runtime -> Database: Read Control Loop Type Definition
on Participants

alt Selected Automation Composition Instance instantiated on Participants
  CLAMP_Runtime -> CLAMP_Runtime: Generate fields for Instance Specific Parameters for GUI
Participants: [DMaaP] Update Participants to remove Automation Composition Instance
  CLAMP_Runtime -> CLAMP_GUI: [REST] Return GUI fieldsDe-instantiation of Automation Composition Instance Specificordered Parameteron Definitionsparticipants
CLAMP_GUI -> CLAMP_GUI: Render UI for Instance Specific Parameters
CLAMP_GUIelse Selected Automation Composition Instance not instantiated on Participants
  CLAMP_Runtime -> CLAMP_GUI: Get[REST] valuesAutomation forComposition Instance Specific Parameters from user
CLAMP_GUI not instantiated on participants 
end

== Participant Responses ==
Participants -> CLAMP_Runtime: [RESTDMaaP] Result Requestof Creationupdate of ControlAutomation LoopComposition Instance on participant
CLAMP_Runtime -> CLAMPInstantiated_ACM_RuntimeInventory: CreateStore Controlresult Loop Instance
CLAMP_Runtime -> Database: Store First Version of Control Loop Instance
of update of Automation Composition Instance on participant

== Supervision ==
loop forever
  CLAMP_Runtime -> CLAMPInstantiated_ACM_GUIInventory: Read [REST]Automation ControlComposition LoopInstances
 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
 loop over each Automation Composition Instance
    alt Automation Composition Instance de-instantiation update underway on participants
	  CLAMP_Runtime -> CLAMPInstantiated_ACM_GUIInventory: [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 Definition
CLAMP_Runtime -> CLAMP_Runtime: Generate fields for Instance Specific Parameters for GUI
CLAMP_Runtime -> CLAMP_GUI: [REST] Return GUI fields Instance Specific Parameter Definitions
CLAMP_GUI -> CLAMP_GUI: Render UI for Instance Specific Parameters
CLAMP_GUI -> CLAMP_GUI: Get values for Instance Specific Parameters from user
CLAMP_GUI -> CLAMP_Runtime: [REST] Request Update of Control Loop Instance
 read result of Automation Composition updates from participants
      alt Updates completed on all participants
	    CLAMP_Runtime -> Instantiated_ACM_Inventory: set Automation Composition Instance as de-instantiated on Participants
	    CLAMP_Runtime -> Instantiated_ACM_Inventory: set overall Automation Composition Instance as de-instantiated
      else Updates not completed
        alt Automation Composition Instance de-instantiation Update timed out on participants
	      CLAMP_Runtime -> Instantiated_ACM_Inventory: set Automation Composition Instance de-instantiation as timed out on Participants
	      CLAMP_Runtime -> CLAMP_Runtime: Update Control Loop Instance
CLAMP_Runtime -> Database: Store New Version of Control Loop Instance
CLAMP_Runtime -> CLAMP_GUI: [REST] Control Loop Instance Updated

@enduml

...

 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
participant Participant
database DatabaseInstantiated_ACM_Inventory

CLAMP_GUI -> CLAMP_Runtime: [REST] Read all versionsAutomation of Control Loop InstanceComposition Instances
CLAMP_Runtime -> DatabaseInstantiated_ACM_Inventory: Read all versionsAutomation of Control Loop InstanceComposition Instances
CLAMP_Runtime -> CLAMP_GUI: [REST] All versionsAutomation ofComposition Control LoopInstances Instance returned
CLAMP_GUI -> CLAMP_GUI: Select versionAutomation ofComposition Control Loop Instance forto Instantiation Participantsdelete
CLAMP_GUI -> CLAMP_Runtime: [REST] InstantiateDelete selected version of Control LoopAutomation Composition Instance on Participants

alt Selected version of Control Loop Instance not instantiated on ParticipantsAutomation Composition Instance exists
  CLAMP_Runtime -> Instantiated_ACM_Inventory: Delete Automation Composition instance
  CLAMP_Runtime -> DatabaseCLAMP_GUI: Read version of Control Loop Instance[REST] Automation Composition Instance deleted
else Selected Automation Composition Instance does not exist
  CLAMP_Runtime -> ParticipantsCLAMP_GUI: [DMaaPREST] UpdateAutomation ParticipantsComposition withInstance versiondoes ofnot Control Loop Instance
  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] InstantiationRead ofall VersionAutomation of Control Loop Instance ordered on participants
else Selected version of Control Loop Instance instantiated on Participants
  Composition Instances
CLAMP_Runtime -> Instantiated_ACM_Inventory: Read all Automation Composition Instances
CLAMP_Runtime -> CLAMP_GUI: [REST] VersionAll ofAutomation ControlComposition Loop Instance already instantiated on participants 
end

== Participant Responses ==
Participants Instances returned

@enduml

3. Monitoring Dialogues

Monitoring dialogues are used to monitor and read statistics on Automation Composition Instances.

3.1 Reporting of Monitoring Information and Statistics by Participants

PlantUML Macro

@startuml
participant CLAMP_Runtime
participant Participant
database Instantiated_ACM_Inventory

Participant -> CLAMP_Runtime: [DMaaP] ResultParticipant ofand updateAutomation ofComposition versionElement ofMonitoring Controland Loop Instance on participant
CLAMP_Runtime -> Database: Store result of update of version of Control Loop Instance on participant

== Supervision ==
loop forever
  Statistics report
CLAMP_Runtime -> DatabaseInstantiated_ACM_Inventory: ReadStore ControlParticipant Loopand Instances
Automation Composition loopElement overMonitoring eachand Control Loop Instance
    alt Control Loop Instance Instantiation update underway on participants
	Statistics report

alt Fault reported on Participant
  CLAMP_Runtime -> CLAMP_Runtime: log fault on Participant
  CLAMP_Runtime -> Database: read result of Control Loop updates from participantsInstantiated_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  alt Updates completed on all participants
	   -> CLAMP_Runtime: log fault on Automation Composition Element and Automation Composition     CLAMP_Runtime -> Instantiated_ACM_Inventory: Record fault on Automation Composition Element and Automation Composition   end
end
@enduml

3.2 Viewing of Monitoring Information

PlantUML Macro

@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
database Instantiated_ACM_Inventory

== Overview of all Automation Composition Instances ==
CLAMP_GUI -> CLAMP_Runtime: [REST] Read all Automation Composition Instances
CLAMP_Runtime -> Instantiated_ACM_Inventory: Read all Automation Composition Instances
CLAMP_Runtime -> CLAMP_GUI: [REST] All Automation Composition Instances returned
CLAMP_GUI -> CLAMP_GUI: Display overview of status of all Automation Composition Instances

== Details of a Automation Composition Instance ==
CLAMP_GUI -> CLAMP_Runtime: [REST] Read Automation Composition Elements for Automation Composition Instance
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_Runtime -> CLAMPInstantiated_ACM_RuntimeInventory: LogRead error
Automation Composition Elements for Automation Composition Instance
CLAMP_Runtime  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

-> 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_RuntimeGUI: [REST] Read all Instantiated Control Loop Instances
CLAMP_RuntimeDisplay overview of status of all participants

== Details of a Participant ==
CLAMP_GUI -> Database:CLAMP_Runtime: [REST] Read allAutomation InstantiatedComposition ControlElements Loopfor InstancesParticipant
CLAMP_Runtime -> CLAMPInstantiated_ACM_GUIInventory: [REST]Read AllAutomation InstantiatedComposition ControlElements Loop Instancesfor returnedParticipant
CLAMP_GUIRuntime -> CLAMP_GUI: Select[REST] ControlAutomation LoopComposition Instance on which to change state and specify new stateElements returned
CLAMP_GUI -> CLAMP_RuntimeGUI: [REST] Change stateDisplay status of selectedAutomation ControlComposition LoopElements Instancein on ParticipantsParticipant

alt== SelectedFiltered Control Loop Instance instantiated on Participants
  CLAMP_RuntimeMonitoring ==
CLAMP_GUI -> ParticipantsCLAMP_GUI: [DMaaP]Set Requestfilter changefor ofAutomation stateComposition ofInstances, ControlAutomation LoopComposition Instance
Elements, and Participants
CLAMP_RuntimeGUI -> CLAMP_GUIRuntime: [REST] ChangeRead ofAutomation stateComposition ofElements Controlthat Loop Instance ordered on participants
else Selected Control Loop Instance not instantiated on Participants
  match filter
CLAMP_Runtime -> CLAMPInstantiated_ACM_GUIInventory: [REST]Read ControlAutomation LoopComposition InstanceElements notthat instantiated on participants 
end

== Participant Responses ==
Participants match filter
CLAMP_Runtime -> CLAMP_RuntimeGUI: [DMaaP] Result of State Change of Control Loop Instance on participant
CLAMP_RuntimeREST] Automation Composition Elements that match filter returned
CLAMP_GUI -> DatabaseCLAMP_GUI: StoreDisplay resultstatus of StateAutomation ChangeComposition ofElements Controlthat match filter

@enduml

3.2 Viewing of Statistics

PlantUML Macro

@startuml
participant CLAMP_GUI
participantLoop Instance on participant

== Supervision ==
loop forever
  CLAMP_Runtime -> Database: Read Control Loop Instances
  loop over each Control Loop Instance
    alt Control Loop Instance State Change underway on participants
	  
database Instantiated_ACM_Inventory

== Statistics of all Automation Composition Instances ==
CLAMP_GUI -> CLAMP_Runtime: [REST] Read summary statistics for all Automation Composition Instances
CLAMP_Runtime -> 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 Automation Composition Instance ==
CLAMP_GUI -> CLAMP_Runtime: [REST] Read statistics for Automation Composition Elements for Automation Composition Instance
CLAMP_Runtime -> Instantiated_ACM_Inventory: Compile statistics for Automation Composition Elements for Automation Composition Instance
CLAMP_Runtime -> CLAMP_GUI: [REST] Statistics for Automation Composition Elements returned
CLAMP_GUI -> CLAMP_GUI: Display statistics for Automation Composition Elements in Automation Composition Instance

== Statistics of all Participants ==
CLAMP_GUI -> CLAMP_Runtime: 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

PlantUML Macro

@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
participant Participant
database Database

[REST] Read summary statistics for all Automation Composition Instances
CLAMP_Runtime -> Instantiated_ACM_Inventory: Compile summary statistics for all Automation Composition Instances
CLAMP_Runtime -> CLAMP_GUI: [REST] Summary statistics for all Automation Composition Instances returned
CLAMP_GUI -> CLAMP_GUI: Display summary statistics for all Automation Composition Instances

== Statistics of a Participant ==
CLAMP_GUI -> CLAMP_Runtime: [REST] Read statistics for allAutomation InstantiatedComposition ControlElements Loopfor InstancesParticipant
CLAMP_Runtime -> DatabaseInstantiated_ACM_Inventory: Read statistics allfor Automation InstantiatedComposition ControlElements Loopfor InstancesParticipant
CLAMP_Runtime -> CLAMP_GUI: [REST] AllStatistics Instantiatedfor ControlAutomation LoopComposition InstancesElements returned
CLAMP_GUI -> CLAMP_GUI: Display statistics for Automation Composition Elements in Participant

== Filtered Statistics ==
CLAMP_GUI -> CLAMP_GUI: Select Control Loop Instance to de-instantiateGUI: Set filter for Automation Composition Instances, Automation Composition Elements, and Participants
CLAMP_GUI -> CLAMP_Runtime: [REST] De-instantiate selected Control Loop Instance on Participants

alt Selected Control Loop Instance instantiated on Participants
  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 -> ParticipantsCLAMP_GUI: [DMaaPREST] UpdateStatistics Participantsfor toAutomation removeComposition ControlElements Loopthat Instance
match filter returned
CLAMP_RuntimeGUI -> CLAMP_GUI: Display [REST] De-instantiation of Control Loop Instance ordered on participants
else Selected Control Loop Instance not instantiated on Participantsstatistics 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 -> CLAMPInstantiated_ACM_GUIInventory: [REST]Read ControlAutomation LoopComposition Instance notStatistics
 instantiated on participants 
end

== Participant Responses ==
Participants ->CLAMP_Runtime -> CLAMP_Runtime: Summarise Automation Composition Instance Statistics
  CLAMP_Runtime: [DMaaP] Result of update of Control Loop Instance on participant
-> Instantiated_ACM_Inventory: Store summarised Automation Composition Instance Statistics
  CLAMP_Runtime -> DatabaseInstantiated_ACM_Inventory: StoreDelete Automation resultComposition ofInstance updateStatistics ofon Controlwhich Loopretention Instanceperiod onhas participantexpired
end

== Participant SupervisionStatistics ==

loop forever
  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
	Participant Statistics
  CLAMP_Runtime -> CLAMP_Runtime: Summarise Participant Statistics
  CLAMP_Runtime -> Instantiated_ACM_Inventory: Store summarised Participant Statistics
  CLAMP_Runtime -> DatabaseInstantiated_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
  read result of Control Loop updates from participants
      alt Updates completed on all participants
	    CLAMP_Runtime -> DatabaseInstantiated_ACM_Inventory: set Control Loop Instance as de-instantiated on Read Participants
	  loop Over CLAMP_Runtime -> Database: set overall Control Loop Instance as de-instantiated
      else Updates not completedeach Participant
    alt Participant has not reported in last reporting window
       CLAMP_Runtime alt Control Loop Instance de-instantiation Update timed out on participants
	-> CLAMP_Runtime: Log Participant as having missed a report
       CLAMP_Runtime -> DatabaseInstantiated_ACM_Inventory: set Control Loop Instance de-instantiation as timed out on Participants
	      CLAMP_Runtime -> CLAMP_Runtime: Log errorIncrement missed report counter on Participant
       alt Participant has exceeded alarm threshold on missed report counter
        else Wait for updates to complete
      CLAMP_Runtime -> CLAMP_Runtime: Raise a Participant Offline alarm on participant
    end
      end 
    else Control Loop Instance de-instantiation update on participants not underwayCLAMP_Runtime -> Instantiated_ACM_Inventory: Mark participant as being offline
       end
    end
else  end
@enduml

2.7 Deleting a Control Loop Instance

PlantUML Macro

@startuml
participant CLAMP_GUI
participant CLAMP_Runtime

database Database

CLAMP_GUI -> CLAMP_Runtime: [REST] Read all Control Loop Instances
Participant has reported in last reporting window
       CLAMP_Runtime -> DatabaseInstantiated_ACM_Inventory: ReadClear missed allreport Controlcounter Loopon Instances
CLAMP_Runtime -> CLAMP_GUI: [REST] All Control Loop Instances returned
CLAMP_GUI -> CLAMP_GUI: Select Control Loop Instance to delete
CLAMP_GUIParticipant
       alt Participant marked as being offline
          CLAMP_Runtime -> CLAMP_Runtime: [REST]Clear DeleteParticipant selectedOffline Controlalarm Loopon Instanceparticipant

alt Selected Control Loop Instance exists
  CLAMP_Runtime -> Database: Delete control loop instance
  CLAMP_Runtime -> CLAMPInstantiated_ACM_GUIInventory: [REST]Mark Controlparticipant Loopas Instancebeing deletedonline
else Selected Control Loop Instance does not existend
  CLAMP_Runtime -> CLAMP_GUI: [REST] Control Loop Instance does not exist  end
  end
end

@enduml

...

4.2 Supervise Automation Compositions

PlantUML Macro

@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
database Database

CLAMP_GUI -> CLAMP_Runtime: [REST] Read all Control Loop Instances
Instantiated_ACM_Inventory

loop forever
  CLAMP_Runtime -> DatabaseInstantiated_ACM_Inventory: 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  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: [DMaaP]Log ParticipantAutomation andComposition ControlElement Loopas Elementhaving Monitoringmissed and Statisticsa report
         CLAMP_Runtime -> Database: Store Participant and Control Loop Element Monitoring and Statistics report

alt Fault reported on Participant
  CLAMP_Runtime -> CLAMP_Runtime: log fault on Participant
  Instantiated_ACM_Inventory: Increment missed report counter on Automation Composition Element
      else Automation Composition Element has reported in last reporting window
         CLAMP_Runtime -> DatabaseInstantiated_ACM_Inventory: Record faultClear missed report counter 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
Automation Composition Element
      end
      alt Automation Composition Element in incorrect state in last reporting window
        CLAMP_Runtime -> DatabaseCLAMP_Runtime: RecordLog faultAutomation onComposition Control Loop Element andas Controlbeing Loop
in incorrect 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_GUIstate
        CLAMP_Runtime -> 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: 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
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 -> DatabaseCLAMP_Runtime: Log ReadAutomation ControlComposition LoopElement Elementsas forbeing Controlin Loopcorrect Instance
CLAMP_Runtime -> CLAMP_GUI: [REST] Control Loop Elements returned
CLAMP_GUIstate
          CLAMP_Runtime -> CLAMPInstantiated_ACM_GUIInventory: DisplayRecord statusAutomation ofComposition ControlElement Loopas Elementsbeing in 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_GUIcorrect state
        end
      end
      alt Automation Composition Element reported fault in last reporting window
        CLAMP_Runtime -> CLAMP_Runtime: [REST]Log ReadAutomation ControlComposition LoopElement Elementsas forbeing Participantfaulty
CLAMP_Runtime -> Database: Read Control Loop Elements for Participant
CLAMP_Runtime -> CLAMPInstantiated_ACM_GUIInventory: [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 -> CLAMP_Runtime: [REST] Read Control Loop Elements that match filter
 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 -> DatabaseCLAMP_Runtime: ReadLog ControlAutomation LoopComposition ElementsElement thatfault matchas filtercleared
CLAMP_Runtime -> CLAMP_GUI: [REST] Control Loop Elements that match filter returned
CLAMP_GUIRuntime -> CLAMPInstantiated_ACM_GUIInventory: DisplayMark statusfault ofAutomation ControlComposition 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_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_GUIElement as being cleared
        end
      end
    end
    alt Automation Composition Element in Automation Composition Instance has exceeded alarm threshold on missed report counter
      CLAMP_Runtime -> CLAMP_GUIRuntime: Raise a DisplayAutomation summaryComposition statisticsOffline foralarm allon ControlAutomation LoopComposition Instances
Instance
== Statistics of a Control Loop Instance ==
CLAMP_GUIRuntime -> CLAMPInstantiated_ACM_RuntimeInventory: [REST] Read statistics for Control Loop Elements for Control Loop Instance
CLAMP_Runtime -> Database: Compile statistics for Control Loop Elements for Control Loop Instance
CLAMP_Runtime -> CLAMP_GUI: [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_GUIMark Automation Composition Instance as being offline
    else No Automation Composition Element in Automation Composition Instance has exceeded alarm threshold on missed report counter
       alt Automation Composition Instance marked as being offline
          CLAMP_Runtime -> CLAMP_Runtime: [REST] Read summary statistics for all Control Loop Instances
 Clear Automation Composition Instance Offline alarm on Automation Composition           CLAMP_Runtime -> DatabaseInstantiated_ACM_Inventory: CompileMark summaryAutomation statisticsComposition forInstance allas Controlbeing 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 Participant ==
CLAMP_GUI -> CLAMP_Runtime: [REST] Read statistics for Control Loop Elements for Participant
online
       end
    end
    alt Automation Composition Element in Automation Composition Instance in incorrect state in last reporting window
      CLAMP_Runtime -> DatabaseCLAMP_Runtime: ReadLog Automation statisticsComposition forInstance Controlas Loopbeing Elementsin forincorrect Participantstate
CLAMP_Runtime -> CLAMP_GUI: [REST] Statistics for Control Loop Elements returned
CLAMP_GUIRuntime -> CLAMPInstantiated_ACM_GUIInventory: DisplayRecord statisticsAutomation forComposition ControlInstance Loopas Elementsbeing in incorrect Participantstate

==  Filtered Statistics ==
CLAMP_GUI -> CLAMP_GUI: Set filter for Control Loop Instances, Control Loop Elements, and Participants
CLAMP_GUI -> CLAMP_Runtime: [REST] Read statistics for Control Loop Elements that match filter
 alt Automation Composition Element in Automation Composition Instance has exceeded alarm threshold on incorrect state reports
        CLAMP_Runtime -> DatabaseCLAMP_Runtime: ReadRaise statisticsa forAutomation ControlComposition LoopInstance Elementsin thatIncorrect match filter
CLAMP_Runtime -> CLAMP_GUI: [REST] Statistics for Control Loop Elements that match filter returned
CLAMP_GUI -> CLAMP_GUI: Display statistics for Control Loop Elements that match filter

@enduml

3.3 Statistics Housekeeping

PlantUML Macro

@startuml
participant CLAMP_Runtime
database Database

== Control Loop Instance Statistics ==

loop forever
  CLAMP_Runtime -> Database: Read Control Loop Instance Statistics
  CLAMP_Runtime -> CLAMP_Runtime: Summarise Control Loop Instance Statistics
  CLAMP_Runtime -> Database: Store summarised Control Loop Instance Statistics
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 -> DatabaseCLAMP_Runtime: DeleteLog ControlAutomation LoopComposition Instance Statisticsas onbeing whichin retentioncorrect periodstate
 has expired
end

== Participant Statistics ==

loop forever
  CLAMP_Runtime -> DatabaseInstantiated_ACM_Inventory: ReadRecord ParticipantAutomation Statistics
Composition  CLAMP_Runtime -> CLAMP_Runtime: Summarise Participant Statistics
  CLAMP_Runtime -> Database: Store summarised Participant Statistics
  CLAMP_Runtime -> Database: Delete Participant Statistics on which retention period has expired
end

@enduml

4. Supervision Dialogues

Supervision dialogues are used to check the state of Control Loop Instances and Participants.

4.1 Supervise Participants

PlantUML Macro

@startuml
participant CLAMP_Runtime
database Database

loop forever
Instance as being in correct state
        alt Automation Composition Instance in Incorrect State alarm raised on Automation Composition Instance
          CLAMP_Runtime -> Database: Read Participant Statistics
  loop Over each ParticipantCLAMP_Runtime: Clear Automation Composition Instance in Incorrect State alarm on Automation Composition Instance
        end
      end
    end
    alt Participant has notAutomation Composition Element in Automation Composition Instance reported a fault in last reporting window
       CLAMP_Runtime -> CLAMP_Runtime: Log ParticipantAutomation asComposition havingInstance missedas abeing reportfaulty
       CLAMP_Runtime -> Database: Increment missed report counter on Participant
       alt ParticipantInstantiated_ACM_Inventory: Record Automation Composition Instance as being faulty
      alt Automation Composition Element in Automation Composition Instance has exceeded alarm threshold on missedfaulty report counterreports
          CLAMP_Runtime -> CLAMP_Runtime: Raise a Participant OfflineAutomation Composition Instance Faulty alarm on Automation Composition participantInstance
      end
    else No CLAMP_Runtime -> Database: Mark participant as being offline
       end
    else Participant has reported in last reporting window
Automation Composition Element faulty in last reporting window
      alt Automation Composition Element in Automation Composition Instance was faulty on previous report
        CLAMP_Runtime -> CLAMP_Runtime: Log Automation Composition Instance as being fault free
        CLAMP_Runtime -> DatabaseInstantiated_ACM_Inventory: Clear missed report counter on Participant
Record Automation Composition Instance as being fault free
        alt Participant marked as being offline Automation Composition Instance Faulty alarm raised on Automation Composition Instance
          CLAMP_Runtime -> CLAMP_Runtime: Clear Automation Composition ParticipantInstance OfflineFaulty alarm on participant
Automation Composition Instance
        CLAMP_Runtime -> Database: Mark participant as being online
 end
      end
    end
  end
end

@enduml

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 20

New Version Current

Key

1 Commissioning Dialogues

1.1 Commissioning a Control Loop Type Definition using the CLAMP GUI

1.2 Commissioning a Control Loop Type Definition using SDC

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.4 Commissioning a Control Loop Type Definition on Participants

2.2 Updating Instance Specific Parameters on an Automation Composition Instance

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

1.7 Reading Commissioned Control Loop Type Definitions

2. Instantiation Dialogues

2.5 De-instantiating an Automation Composition Instance from Participants

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

2.7 Deleting a Control Loop Instance

4.2 Supervise Automation Compositions

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

4. Supervision Dialogues

4.1 Supervise Participants