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

Commissioning an Automation Composition Type is a three-step process

The Automation Composition Type must be created, that is the Automation Composition Type definition must be loaded and stored in the database. This step may be carried out over the REST interface or using SDC distribution.
The Common Properties of the Automation Composition type must be assigned values and those values must be stored in the database. This step is optional only if all mandatory common properties have default values. The Common Property values may be set and amended over and over again in multiple sessions until the Automation Composition Type is primed.
The Automation Composition Type Definition and the Common Property values must be primed, which is sent to the concerned participants. Once an Automation Composition Type is primed, its Common Property values can no longer be changed. To change Common Properties on a primed Automation Composition Type, all instances of the Automation Composition Type must be removed and the Automation Composition Type must be de-primed.

1.1 Commissioning an Automation Composition Type Definition using the CLAMP GUI

This dialogue corresponds to a "File→Import" menu on the CLAMP GUI. The documentation of future releases of the system will describe how the Design Time functionality interacts with the Runtime commissioning API.

PlantUML Macro

@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
database Commissioned_ACM_Inventory

CLAMP_GUI -> CLAMP_Runtime: [REST] Commission Automation Composition Type Definition
CLAMP_Runtime -> Commissioned_ACM_Inventory: Store Automation Composition Type Definition
CLAMP_Runtime -> CLAMP_GUI: [REST] Type Definition Commissioned
@enduml

1.2 Commissioning an Automation Composition Type Definition using SDC

PlantUML Macro

@startuml
participant SDC
participant Policy_Distribution
participant CLAMP_Runtime
database Commissioned_ACM_Inventory

SDC -> Policy_Distribution: [DMaaP] CSAR containing Automation Composition Type Definition
Policy_Distribution -> CLAMP_Runtime: [REST] Commission Automation Composition Type Definition
CLAMP_Runtime -> Commissioned_ACM_Inventory: Store Automation Composition Type Definition
CLAMP_Runtime -> Policy_Distribution: [REST] Type Definition Commissioned
Policy_Distribution -> SDC: [DMaaP] Deployment Completed
@enduml

1.3 Setting Common Properties for an Automation Composition Type Definition

This dialogue sets the values of common properties. The values of the common properties may be set, updated, or deleted at will, as this dialogue saves the properties to the database but does not send the definitions or properties to the participants. However, once an Automation Composition Type Definition and its properties are primed (See Section 1.4), the properties cannot be changed until the Automation Composition type definition is de-primed (See Section 1.5).

PlantUML Macro

@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
participant Participant
database Commissioned_ACM_Inventory

CLAMP_GUI -> CLAMP_Runtime: [REST] Read Automation Composition Type Definitions
CLAMP_Runtime -> Commissioned_ACM_Inventory: Read Automation Composition Type Definitions
CLAMP_Runtime -> CLAMP_GUI: [REST] Type Definitions returned
CLAMP_GUI -> CLAMP_GUI: Select Automation Composition Type Definition for Parameterization
CLAMP_GUI -> CLAMP_Runtime: [REST] Fetch GUI fields for Common Parameter Definitions

alt Automation Composition Type Definition not Commissioned on Participants
  CLAMP_Runtime -> Commissioned_ACM_Inventory: Read Automation Composition Type Definition
  CLAMP_Runtime -> CLAMP_Runtime: Generate fields for Common Parameters for GUI
  CLAMP_Runtime -> CLAMP_GUI: [REST] Return GUI fields Common Parameter Definitions
  CLAMP_GUI -> CLAMP_GUI: Render UI for Common Parameters
  CLAMP_GUI -> CLAMP_GUI: Get values for Common Parameters from user
  CLAMP_GUI -> CLAMP_Runtime: [REST] Set values for Common Parameters
  CLAMP_Runtime -> Commissioned_ACM_Inventory: Store values for Common Parameters
  CLAMP_Runtime -> CLAMP_GUI: [REST] Common Parameter values stored
else Automation Composition Type Definition already Commissioned on Participants
  CLAMP_Runtime -> CLAMP_GUI: [REST] Cannot set Common Parameters on\nAutomation Composition Type Definition that has\nbeen commissioned on participants
end

@enduml

1.4 Priming an Automation Composition Type Definition on Participants

The Priming operation sends Automation Composition Type definitions and common property values to participants. Once an Automation Composition Type definition is primed, its property values can on longer be changed until it is de-primed.

PlantUML Macro

@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
participant Participant
database Commissioned_ACM_Inventory

CLAMP_GUI -> CLAMP_Runtime: [REST] Read Automation Composition Type Definitions
CLAMP_Runtime -> Commissioned_ACM_Inventory: Read Automation Composition Type Definitions
CLAMP_Runtime -> CLAMP_GUI: [REST] Type Definitions returned
CLAMP_GUI -> CLAMP_GUI: Select Automation Composition Type Definition for Priming on Participants
CLAMP_GUI -> CLAMP_Runtime: [REST] Prime Automation Composition Type Definition on Participants

alt Automation Composition Type Definition not Primed on Participants
  CLAMP_Runtime -> Commissioned_ACM_Inventory: Read Automation Composition Type Definition
  CLAMP_Runtime -> Commissioned_ACM_Inventory: Read Common Parameter Values for Automation Composition Type Definition
  alt Common Parameter values set for Automation Composition Type Definition
    CLAMP_Runtime -> Participants: [DMaaP] Update Participants with Automation Composition Type Definition and values for Common Parameters
    CLAMP_Runtime -> CLAMP_GUI: [REST] Automation Composition Type Definition priming ordered on participants
  else Automation Composition Type Definition already primed on Participants
    CLAMP_Runtime -> CLAMP_GUI: [REST] Common Parameters not set\non Automation Composition Type Definition
  end
else Automation Composition Type Definition already primed on Participants
  CLAMP_Runtime -> CLAMP_GUI: [REST] Cannot set Common Parameters on\nAutomation Composition Type Definition that has\nbeen primed on participants
end

== Participant Responses ==
Participants -> CLAMP_Runtime: [DMaaP] Result of Update with Automation Composition Type Definition and values for Common Parameters
CLAMP_Runtime -> Commissioned_ACM_Inventory: Store result of Automation Composition Type Definition Update on Participant

== Supervision ==
loop forever
  CLAMP_Runtime -> Commissioned_ACM_Inventory: Read Automation Composition Type Definitions
  loop over each Automation Composition Type Definition
    alt Automation Composition Type Definition Participant priming underway
	  CLAMP_Runtime -> Commissioned_ACM_Inventory: read result of Automation Composition Type Definition Updates from participants
      alt Updates completed on all participants
	    CLAMP_Runtime -> Commissioned_ACM_Inventory: set Automation Composition Type Definition as primed on Participants
      else Updates not completed
        alt Priming of Automation Composition Type Definition on participants timed out
	      CLAMP_Runtime -> Commissioned_ACM_Inventory: set Automation Composition Type Definition priming as timed out on Participants
	      CLAMP_Runtime -> CLAMP_Runtime: Log error
        else Wait for updates to complete
        end
      end 
    else Automation Composition Type Definition Participant priming not underway
    end
  end
end
@enduml

1.5 De-Prime an Automation Composition Type Definition on Participants

This dialogue allows an Automation Composition Type Definition to be de-primed so that it can be deleted or its common parameter values can be altered.

PlantUML Macro

@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
participant Participant
database Commissioned_ACM_Inventory

CLAMP_GUI -> CLAMP_Runtime: [REST] Read Automation Composition Type Definitions
CLAMP_Runtime -> Commissioned_ACM_Inventory: Read Automation Composition Type Definitions
CLAMP_Runtime -> CLAMP_GUI: [REST] Type Definitions returned
CLAMP_GUI -> CLAMP_GUI: Select Automation Composition Type Definition for de-priming on Participants
CLAMP_GUI -> CLAMP_Runtime: [REST] De-prime Automation Composition Type Definition on Participants

alt Automation Composition Type Definition primed on Participants
  alt Automation Composition Instances do not exist for Automation Composition Type Definition
    CLAMP_Runtime -> Participants: [DMaaP] Update Participants, removing Automation Composition Type Definition and values for Common Parameters
    CLAMP_Runtime -> CLAMP_GUI: [REST] Automation Composition Type Definition de-priming ordered on participants
  else Automation Composition Instances exist for Automation Composition Type Definition
    CLAMP_Runtime -> CLAMP_GUI: [REST] Automation Composition Type Definition cannot be\n de-primed on participants\nit is in use on Automation Compositions
  end
else Automation Composition Type Definition not primed on Participants
  CLAMP_Runtime -> CLAMP_GUI: [REST] Automation Composition Type Definition has not\nbeen primed on participants
end

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

== Supervision ==
loop forever
  CLAMP_Runtime -> Commissioned_ACM_Inventory: Read Automation Composition Type Definitions
  loop over each Automation Composition Type Definition
    alt Automation Composition Type Definition Participant de-prime underway
	  CLAMP_Runtime -> Commissioned_ACM_Inventory: read result of Automation Composition Type Definition Updates from participants
      alt Updates completed on all participants
	    CLAMP_Runtime -> Commissioned_ACM_Inventory: set Automation Composition Type Definition as de-primeed on Participants
      else Updates not completed
        alt De-priming of Automation Composition Type Definition on participants timed out
	      CLAMP_Runtime -> Commissioned_ACM_Inventory: set Automation Composition Type Definition de-priming as timed out on Participants
	      CLAMP_Runtime -> CLAMP_Runtime: Log error
        else Wait for updates to complete
        end
      end 
    else Automation Composition Type Definition Participant de-prime not underway
    end
  end
end
@enduml

1.6 Decommissioning an Automation Composition Type Definition in CLAMP

PlantUML Macro

@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
database Commissioned_ACM_Inventory

CLAMP_GUI -> CLAMP_Runtime: [REST] Read Automation Composition Type Definitions
CLAMP_Runtime -> Commissioned_ACM_Inventory: Read Automation Composition Type Definitions
CLAMP_Runtime -> CLAMP_GUI: [REST] Type Definitions returned
CLAMP_GUI -> CLAMP_GUI: Select Automation Composition Type Definition for Decommissioning
CLAMP_GUI -> CLAMP_Runtime: [REST] Decommission Automation Composition Type Definition

alt Automation Composition Type Definition not primed on Participants
  CLAMP_Runtime -> Commissioned_ACM_Inventory: Delete Automation Composition Type Definition
  CLAMP_Runtime -> CLAMP_GUI: [REST] Type Definition Decommissioned
else Automation Composition Type Definition is Commissioned on Participants
  CLAMP_Runtime -> CLAMP_GUI: [REST] Automation Composition Type Definition cannot be decommissioned\nit is primed on participants
end

@enduml

1.7 Reading Commissioned Automation Composition Type Definitions

PlantUML Macro

@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
database Commissioned_ACM_Inventory

CLAMP_GUI -> CLAMP_Runtime: [REST] Read Automation Composition Type Definitions
CLAMP_Runtime -> Commissioned_ACM_Inventory: Read Automation Composition Type Definitions
CLAMP_Runtime -> CLAMP_GUI: [REST] Type Definitions returned

@enduml

2. Instantiation Dialogues

Instantiation dialogues are used to create, set parameters on, instantiate, update, and remove Automation Composition instances.

Assume a suitable Automation Composition Definition exists in the Commissioned Automation Composition Inventory. To get an Automation Composition instance running one would, for example, execute dialogues 2.1, 2.3, and 2.4.

2.1 Creating an Automation Composition Instance

PlantUML Macro

@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
database Commissioned_ACM_Inventory
database Instantiated_ACM_Inventory

CLAMP_GUI -> CLAMP_Runtime: [REST] Read Automation Composition Type Definitions
CLAMP_Runtime -> Commissioned_ACM_Inventory: Read Automation Composition Type Definitions
CLAMP_Runtime -> CLAMP_GUI: [REST] Type Definitions returned
CLAMP_GUI -> CLAMP_GUI: Select Automation Composition Type Definition to use to create Automation Composition Instance
CLAMP_GUI -> CLAMP_Runtime: [REST] Fetch GUI fields for Instance Specific Parameter Definitions
CLAMP_Runtime -> Commissioned_ACM_Inventory: Read Automation Composition Type Definition
CLAMP_Runtime -> CLAMP_Runtime: Generate fields for Instance Specific Parameters for GUI
CLAMP_Runtime -> CLAMP_GUI: [REST] Return GUI fields Instance Specific Parameter Definitions
CLAMP_GUI -> CLAMP_GUI: Render UI for Instance Specific Parameters
CLAMP_GUI -> CLAMP_GUI: Get values for Instance Specific Parameters from user
CLAMP_GUI -> CLAMP_Runtime: [REST] Request Creation of Automation Composition Instance
CLAMP_Runtime -> CLAMP_Runtime: Create Automation Composition Instance
CLAMP_Runtime -> Instantiated_ACM_Inventory: Store First Version of Automation Composition Instance
CLAMP_Runtime -> CLAMP_GUI: [REST] Automation Composition Instance Updated

@enduml

Note that this dialogue creates the Automation Composition Instance in the Instantiated Automation Composition Inventory. The instance is sent to the participants using the process described in the dialogue in Section 2.3.

2.2 Updating Instance Specific Parameters on an Automation Composition Instance

PlantUML Macro

@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
database Instantiated_ACM_Inventory

CLAMP_GUI -> CLAMP_Runtime: [REST] Read Automation Composition Instances
CLAMP_Runtime -> Instantiated_ACM_Inventory: Read Automation Composition Instances
CLAMP_Runtime -> CLAMP_GUI: [REST] Automation Composition Instances returned
CLAMP_GUI -> CLAMP_GUI: Select Automation Composition Instance on which to Update Parameters
CLAMP_GUI -> CLAMP_GUI: Step version of Automation Composition Instance as Major/Minor/Patch
CLAMP_GUI -> CLAMP_Runtime: [REST] Fetch GUI fields for Instance Specific Parameter Definitions
CLAMP_Runtime -> Instantiated_ACM_Inventory: Read Automation Composition Type Definition
CLAMP_Runtime -> CLAMP_Runtime: Generate fields for Instance Specific Parameters for GUI
CLAMP_Runtime -> CLAMP_GUI: [REST] Return GUI fields Instance Specific Parameter Definitions
CLAMP_GUI -> CLAMP_GUI: Render UI for Instance Specific Parameters
CLAMP_GUI -> CLAMP_GUI: Get values for Instance Specific Parameters from user
CLAMP_GUI -> CLAMP_Runtime: [REST] Request Update of Automation Composition Instance
CLAMP_Runtime -> CLAMP_Runtime: Update Automation Composition Instance
CLAMP_Runtime -> Instantiated_ACM_Inventory: Store New Version of Automation Composition Instance
CLAMP_Runtime -> CLAMP_GUI: [REST] Automation Composition Instance Updated

@enduml

2.3 Updating an Automation Composition Instance with a Configuration on Participants

PlantUML Macro

@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
participant Participant
database Instantiated_ACM_Inventory

CLAMP_GUI -> CLAMP_Runtime: [REST] Read all configuration versions of Automation Composition Instance
CLAMP_Runtime -> Instantiated_ACM_Inventory: Read all configuration versions of Automation Composition Instance
CLAMP_Runtime -> CLAMP_GUI: [REST] All configuration versions of Automation Composition Instance returned
CLAMP_GUI -> CLAMP_GUI: Select configuration version of Automation Composition Instance for Instantiation Participants
CLAMP_GUI -> CLAMP_Runtime: [REST] Instantiate selected configuration version of Automation Composition Instance on Participants

alt Selected configuration version of Automation Composition Instance not instantiated on Participants
  CLAMP_Runtime -> Instantiated_ACM_Inventory: Read configuration version of Automation Composition Instance
  CLAMP_Runtime -> Participants: [DMaaP] Update Participants with configuration version of Automation Composition Instance
  CLAMP_Runtime -> CLAMP_GUI: [REST] Instantiation of configuration version of Automation Composition Instance ordered on participants
else Selected configuration version of Automation Composition Instance instantiated on Participants
  CLAMP_Runtime -> CLAMP_GUI: [REST] configuration version of Automation Composition Instance already instantiated on participants 
end

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

== Supervision ==
loop forever
  CLAMP_Runtime -> Instantiated_ACM_Inventory: Read Automation Composition Instances
  loop over each Automation Composition Instance
    alt Automation Composition Instance configuration version update underway on participants
	  CLAMP_Runtime -> Instantiated_ACM_Inventory: read result of Automation Composition updates from participants
      alt Updates completed on all participants
	    CLAMP_Runtime -> Instantiated_ACM_Inventory: set configuration version of Automation Composition Instance as Instantiated on Participants
	    CLAMP_Runtime -> Instantiated_ACM_Inventory: set overall configuration version of Automation Composition Instance state as Instantiated
      else Updates not completed
        alt Instantiation of Automation Composition Instance on participants timed out
	      CLAMP_Runtime -> Instantiated_ACM_Inventory: set configuration version Automation Composition Instance Instantiation as timed out on Participants
	      CLAMP_Runtime -> CLAMP_Runtime: Log error
        else Wait for updates to complete
        end
      end 
    else Automation Composition Instance configuration version update on participants not underway
    end
  end
end
@enduml

2.4 Changing the state of an Automation Composition Instance on Participants

PlantUML Macro

@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
participant Participant
database Instantiated_ACM_Inventory

CLAMP_GUI -> CLAMP_Runtime: [REST] Read all Instantiated Automation Composition Instances
CLAMP_Runtime -> Instantiated_ACM_Inventory: Read all Instantiated Automation Composition Instances
CLAMP_Runtime -> CLAMP_GUI: [REST] All Instantiated Automation Composition Instances returned
CLAMP_GUI -> CLAMP_GUI: Select Automation Composition Instance on which to change state and specify new state
CLAMP_GUI -> CLAMP_Runtime: [REST] Change state of selected Automation Composition Instance on Participants

alt Selected Automation Composition Instance instantiated on Participants
  CLAMP_Runtime -> Participants: [DMaaP] Request change of state of Automation Composition Instance
  CLAMP_Runtime -> CLAMP_GUI: [REST] Change of state of Automation Composition Instance ordered on participants
else Selected Automation Composition Instance not instantiated on Participants
  CLAMP_Runtime -> CLAMP_GUI: [REST] Automation Composition Instance not instantiated on participants 
end

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

== Supervision ==
loop forever
  CLAMP_Runtime -> Instantiated_ACM_Inventory: Read Automation Composition Instances
  loop over each Automation Composition Instance
    alt Automation Composition Instance State Change underway on participants
	  CLAMP_Runtime -> Instantiated_ACM_Inventory: read result of Automation Composition State Change from participants
      alt Updates completed on all participants
	    CLAMP_Runtime -> Instantiated_ACM_Inventory: set Automation Composition Instance state as changed on Participants
	    CLAMP_Runtime -> Instantiated_ACM_Inventory: set overall Automation Composition Instance state as changed
      else Updates not completed
        alt Automation Composition Instance State Change on participants timed out
	      CLAMP_Runtime -> Instantiated_ACM_Inventory: set Automation Composition State Change as timed out on Participants
	      CLAMP_Runtime -> CLAMP_Runtime: Log error
        else Wait for updates to complete
        end
      end 
    else Automation Composition Instance State Change on participants not underway
    end
  end
end
@enduml

2.5 De-instantiating an Automation Composition Instance from Participants

PlantUML Macro

@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
participant Participant
database Instantiated_ACM_Inventory

CLAMP_GUI

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] Read Commissionall ControlInstantiated LoopAutomation TypeComposition DefinitionInstances
CLAMP_Runtime -> Database: Store Control Loop Type DefinitionInstantiated_ACM_Inventory: Read all Instantiated Automation Composition Instances
CLAMP_Runtime -> PolicyCLAMP_DistributionGUI: [REST] Type Definition Commissioned
Policy_Distribution All Instantiated Automation Composition Instances returned
CLAMP_GUI -> SDCCLAMP_GUI: [DMaaP]Select 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
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
CLAMP_GUI -> CLAMP_GUI: Select Control Loop Type Definition for Parameterization
CLAMP_GUIParticipants to remove Automation Composition Instance
  CLAMP_Runtime -> CLAMP_RuntimeGUI: [REST] FetchDe-instantiation GUIof fieldsAutomation forComposition Common Parameter Definitions

alt Control Loop Type Definition not Commissioned on Participants
  CLAMP_Runtime -> Database: Read Control Loop Type DefinitionInstance ordered on participants
else Selected Automation Composition Instance not instantiated on Participants
  CLAMP_Runtime -> CLAMP_Runtime: Generate fields for Common Parameters for GUI
  CLAMP_RuntimeGUI: [REST] Automation Composition Instance not instantiated on participants 
end

== Participant Responses ==
Participants -> CLAMP_GUIRuntime: [RESTDMaaP] Result Returnof GUIupdate fieldsof CommonAutomation ParameterComposition Definitions
Instance on participant
CLAMP_GUIRuntime -> CLAMPInstantiated_ACM_GUI: Render UI for Common ParametersInventory: Store result of update of Automation Composition Instance on participant

== Supervision ==
loop forever
  CLAMP_GUIRuntime -> CLAMPInstantiated_ACM_GUIInventory: GetRead valuesAutomation forComposition CommonInstances
 Parameters fromloop user
over each CLAMP_GUI -> CLAMP_Runtime: [REST] Set values for Common Parameters
  CLAMP_Runtime -> Database: Store values for Common Parameters
Automation Composition Instance
    alt Automation Composition Instance de-instantiation update underway on participants
	  CLAMP_Runtime -> CLAMPInstantiated_ACM_GUI: [REST] Common Parameter values stored
else Control Loop Type Definition already Commissioned on Participants
Inventory: read result of Automation Composition updates from participants
      alt Updates completed on all participants
	    CLAMP_Runtime -> CLAMPInstantiated_ACM_GUIInventory: [REST] Cannot set CommonAutomation ParametersComposition on\nControlInstance 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 Definitions
CLAMP_Runtime -> Database: Read Control Loop Type Definitions
CLAMP_Runtime -> CLAMP_GUI: [REST] Type Definitions returned
CLAMP_GUI -> CLAMP_GUI: Select Control Loop Type Definition for Commissioning on Participants
CLAMP_GUIas 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: [REST] Commission Control Loop Type Definition on Participants

alt Control Loop Type Definition not Commissioned on Participants
  CLAMP_Runtime -> Database: Read Control Loop Type Definition
  CLAMP_Runtime -> Database: Read Common Parameter Values for Control Loop Type Definition
  alt Common Parameter values set for Control Loop Type Definition
     Log error
        else Wait for updates to complete
        end
      end 
    else Automation Composition Instance de-instantiation update on participants not underway
    end
  end
@enduml

2.6 Deleting an Automation Composition Instance

PlantUML Macro

@startuml
participant CLAMP_GUI
participant CLAMP_Runtime

database Instantiated_ACM_Inventory

CLAMP_GUI -> CLAMP_Runtime: [REST] Read all Automation Composition Instances
CLAMP_Runtime -> ParticipantsInstantiated_ACM_Inventory: [DMaaP]Read Updateall ParticipantsAutomation with Control Loop Type Definition and values for Common Parameters
    Composition Instances
CLAMP_Runtime -> CLAMP_GUI: [REST] ControlAll LoopAutomation TypeComposition Definition commissioning ordered on participants
  else Control Loop Type Definition already Commissioned on Participants
    CLAMP_RuntimeInstances returned
CLAMP_GUI -> CLAMP_GUI: Select Automation Composition Instance to delete
CLAMP_GUI -> CLAMP_GUIRuntime: [REST] CommonDelete Parametersselected notAutomation set\non Control Loop Type Definition
  end
else Control Loop Type Definition already Commissioned on ParticipantsComposition Instance

alt Selected Automation Composition Instance exists
  CLAMP_Runtime -> Instantiated_ACM_Inventory: Delete Automation Composition instance
  CLAMP_Runtime -> CLAMP_GUI: [REST] CannotAutomation setComposition CommonInstance Parameters on\nControl Loop Type Definition that has\nbeen commissioned on participants
end

== Participant Responses ==
Participantsdeleted
else Selected Automation Composition Instance does not exist
  CLAMP_Runtime -> CLAMP_RuntimeGUI: [DMaaPREST] ResultAutomation ofComposition UpdateInstance withdoes Controlnot Loop Type Definition and values for Common Parameters
CLAMP_Runtime -> Database: Store result of Control Loop Type Definition Update on Participant

== Supervision exist 
end

@enduml

2.7 Reading Automation Composition Instances

PlantUML Macro

@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
database Instantiated_ACM_Inventory

CLAMP_GUI -> CLAMP_Runtime: [REST] Read all Automation Composition Instances
==
loop forever
  CLAMP_Runtime -> DatabaseInstantiated_ACM_Inventory: Read Controlall LoopAutomation TypeComposition Definitions
  loop over each Control Loop Type Definition
    alt Control Loop Type Definition Participant Commission underway
	  Instances
CLAMP_Runtime -> CLAMP_GUI: [REST] All Automation Composition Instances returned

@enduml

3. Monitoring Dialogues

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

3.1 Reporting of Monitoring Information and Statistics by Participants

PlantUML Macro

@startuml
participant CLAMP_Runtime
participant Participant
database Instantiated_ACM_Inventory

Participant -> CLAMP_Runtime: [DMaaP] Participant and Automation Composition Element Monitoring and Statistics report
CLAMP_Runtime -> DatabaseInstantiated_ACM_Inventory: readStore resultParticipant ofand ControlAutomation LoopComposition TypeElement DefinitionMonitoring Updatesand fromStatistics participantsreport

alt Fault reported on Participant
  alt Updates completed on all participants
	  CLAMP_Runtime -> CLAMP_Runtime: log fault on Participant
  CLAMP_Runtime -> DatabaseInstantiated_ACM_Inventory: set Control Loop Type Definition as Commissioned on Participants
      else Updates not completed
        alt Commissioning of Control Loop Type Definition on participants timed out
	      Record fault on Participant
end

loop Over all Automation Composition Elements in Participant Report
  alt Fault reported on Automation Composition Element
    CLAMP_Runtime -> DatabaseCLAMP_Runtime: setlog Controlfault Loopon Type Definition commissioning as timed out on Participants
	     Automation Composition Element and Automation Composition     CLAMP_Runtime -> CLAMPInstantiated_ACM_RuntimeInventory: LogRecord error
fault on Automation Composition Element and Automation Composition else Wait for updates to complete
        end
      end 
    else Control Loop Type Definition Participant Commission not underway
    end
  end
@enduml

1.5 Decommissioning a Control Loop Type Definition on Participants

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.

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

PlantUML Macro

@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
participant Participant
database Database

CLAMP_GUI -> CLAMP_Runtime: [REST] Read Control Loop Type Definitions Automation Composition Elements for Automation Composition Instance
CLAMP_Runtime -> DatabaseInstantiated_ACM_Inventory: Read Control Loop Type DefinitionsAutomation Composition Elements for Automation Composition Instance
CLAMP_Runtime -> CLAMP_GUI: [REST] Automation TypeComposition DefinitionsElements returned
CLAMP_GUI -> CLAMP_GUI: Select Control Loop Type Definition for Decommissioning on Participants Display status of Automation Composition Elements in Automation Composition Instance

== Overview of all 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
    Read all participants
CLAMP_Runtime -> Instantiated_ACM_Inventory: Read all participants
CLAMP_Runtime -> ParticipantsCLAMP_GUI: [DMaaPREST] UpdateAll Participants, removing Control Loop Type Definition and values for Common Parameters
    CLAMP_Runtimeparticipants returned
CLAMP_GUI -> CLAMP_GUI: Display overview of status of all participants

== Details of a Participant ==
CLAMP_GUI -> CLAMP_GUI: [REST] Control Loop Type Definition decommissioning ordered on participants
  else Control Loop Instances exist for Control Loop Type Definition
    Runtime: [REST] Read Automation Composition Elements for Participant
CLAMP_Runtime -> Instantiated_ACM_Inventory: Read Automation Composition Elements for Participant
CLAMP_Runtime -> CLAMP_GUI: [REST] ControlAutomation LoopComposition 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
  CLAMP_RuntimeElements returned
CLAMP_GUI -> CLAMP_GUI: Display status of Automation Composition Elements in Participant

== Filtered Monitoring ==
CLAMP_GUI -> CLAMP_GUI: [REST]Set Controlfilter Loopfor TypeAutomation DefinitionComposition has not\nbeen commissioned on participants
end

== Participant Responses ==
ParticipantsInstances, Automation Composition Elements, and Participants
CLAMP_GUI -> CLAMP_Runtime: [DMaaPREST] Read Automation ResultComposition ofElements Updatethat to remove Control Loop Type Definition and values for Common Parametersmatch filter
CLAMP_Runtime -> Instantiated_ACM_Inventory: Read Automation Composition Elements that match filter
CLAMP_Runtime -> DatabaseCLAMP_GUI: Store[REST] resultAutomation ofComposition ControlElements Loopthat Typematch Definition Update on Participant

== Supervision ==
loop forever
  CLAMP_Runtimefilter returned
CLAMP_GUI -> DatabaseCLAMP_GUI: ReadDisplay Controlstatus Loopof TypeAutomation Definitions
Composition Elements loopthat 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
	    match filter

@enduml

3.2 Viewing of Statistics

PlantUML Macro

@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
database Instantiated_ACM_Inventory

== Statistics of all Automation Composition Instances ==
CLAMP_GUI -> CLAMP_Runtime: [REST] Read summary statistics for all Automation Composition Instances
CLAMP_Runtime -> Instantiated_ACM_Inventory: Compile summary statistics for all Automation Composition Instances
CLAMP_Runtime -> DatabaseCLAMP_GUI: set[REST] ControlSummary Loopstatistics Typefor Definitionall asAutomation decommissionedComposition onInstances Participantsreturned
CLAMP_GUI -> CLAMP_GUI: Display summary statistics for elseall UpdatesAutomation notComposition completedInstances

== Statistics of a Automation Composition Instance  alt Commissioning of Control Loop Type Definition on participants timed out
	      ==
CLAMP_GUI -> CLAMP_Runtime: [REST] Read statistics for Automation Composition Elements for Automation Composition Instance
CLAMP_Runtime -> DatabaseInstantiated_ACM_Inventory: setCompile Controlstatistics Loopfor TypeAutomation DefinitionComposition decommissioningElements asfor timedAutomation outComposition on Participants
	      Instance
CLAMP_Runtime -> CLAMP_RuntimeGUI: Log error
        else Wait for updates to complete
        end
      end 
    else Control Loop Type Definition Participant decommission not underway
    end
  end
@enduml

1.6 Decommissioning a Control Loop Type Definition in CLAMP

PlantUML Macro

@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
database Database

CLAMP_GUI[REST] Statistics for Automation Composition Elements returned
CLAMP_GUI -> CLAMP_GUI: Display statistics for Automation Composition Elements in Automation Composition Instance

== Statistics of all Participants ==
CLAMP_GUI -> CLAMP_Runtime: [REST] Read summary statistics for all Automation Composition Instances
CLAMP_Runtime -> Instantiated_ACM_Inventory: Compile summary statistics for all Automation Composition Instances
CLAMP_Runtime -> CLAMP_RuntimeGUI: [REST] Read Control Loop Type Definitions Summary statistics for all Automation Composition Instances returned
CLAMP_RuntimeGUI -> Database: Read Control Loop Type Definitions
CLAMP_RuntimeCLAMP_GUI: Display summary statistics for all Automation Composition Instances

== Statistics of a Participant ==
CLAMP_GUI -> CLAMP_GUIRuntime: [REST] Type Definitions returned Read statistics for Automation Composition Elements for Participant
CLAMP_GUIRuntime -> CLAMPInstantiated_ACM_GUIInventory: SelectRead statistics Controlfor LoopAutomation TypeComposition DefinitionElements for DecommissioningParticipant
CLAMP_GUIRuntime -> CLAMP_RuntimeGUI: [REST] DecommissionStatistics Controlfor LoopAutomation Type Definition

alt Control Loop Type Definition not Commissioned on Participants
  CLAMP_RuntimeComposition Elements returned
CLAMP_GUI -> Database: Delete Control Loop Type Definition
  CLAMP_RuntimeCLAMP_GUI: Display statistics for Automation Composition Elements in Participant

== Filtered Statistics ==
CLAMP_GUI -> CLAMP_GUI: [REST]Set Typefilter Definitionfor Decommissioned
elseAutomation Control Loop Type Definition not Commissioned onComposition Instances, Automation Composition Elements, and Participants
  CLAMP_RuntimeGUI -> CLAMP_GUIRuntime: [REST] ControlRead Loopstatistics Typefor DefinitionAutomation cannotComposition beElements decommissioned\nitthat 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_GUImatch filter
CLAMP_Runtime -> Instantiated_ACM_Inventory: Read statistics for Automation Composition Elements that match filter
CLAMP_Runtime -> CLAMP_RuntimeGUI: [REST] ReadStatistics Controlfor LoopAutomation Type Definitions
CLAMP_Runtime -> Database: Read Control Loop Type DefinitionsComposition Elements that match filter returned
CLAMP_RuntimeGUI -> CLAMP_GUI: [REST] Type Definitions returned Display statistics for Automation Composition Elements that match filter

@enduml

2. Instantiation Dialogues

Instantiation dialogues are used to create, set parameters on, instantiate, update, and remove Control Loop instances.

...

3.3 Statistics Housekeeping

PlantUML Macro

@startuml
participant CLAMP_GUIRuntime
participantdatabase CLAMP_Runtime
participant Participant
database Database

CLAMP_GUIInstantiated_ACM_Inventory

== Automation Composition Instance Statistics ==

loop forever
  CLAMP_Runtime -> CLAMPInstantiated_ACM_RuntimeInventory: [REST] Read ControlAutomation LoopComposition TypeInstance DefinitionsStatistics
  CLAMP_Runtime -> DatabaseCLAMP_Runtime: ReadSummarise ControlAutomation LoopComposition TypeInstance DefinitionsStatistics
  CLAMP_Runtime -> CLAMPInstantiated_ACM_GUIInventory: [REST] Type Definitions returned
CLAMP_GUI Store summarised Automation Composition Instance Statistics
  CLAMP_Runtime -> CLAMPInstantiated_ACM_GUI: Select Control Loop Type Definition to use to create Control Loop Instance
CLAMP_GUI -> CLAMP_Runtime: [REST] Fetch GUI fields for Instance Specific Parameter Definitions
Inventory: Delete Automation Composition Instance Statistics on which retention period has expired
end

== Participant Statistics ==

loop forever
  CLAMP_Runtime -> Instantiated_ACM_Inventory: Read Participant Statistics
  CLAMP_Runtime -> CLAMP_Runtime: Summarise Participant Statistics
  CLAMP_Runtime -> Database: Read Control Loop Type Definition
Instantiated_ACM_Inventory: Store summarised Participant Statistics
  CLAMP_Runtime -> CLAMPInstantiated_ACM_RuntimeInventory: Delete GenerateParticipant fieldsStatistics foron Instancewhich Specificretention Parametersperiod for GUI
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 -> CLAMP_GUI: [REST] Return GUI fields Instance Specific Parameter Definitions
CLAMP_GUI
database Instantiated_ACM_Inventory

loop forever
  CLAMP_Runtime -> CLAMPInstantiated_ACM_GUIInventory: Read RenderParticipants
 UI forloop InstanceOver Specificeach ParametersParticipant
CLAMP_GUI -> CLAMP_GUI: Get valuesalt forParticipant Instancehas Specificnot Parametersreported from user
CLAMP_GUI -> CLAMP_Runtime: [REST] Request Creation of Control Loop Instance
in last reporting window
       CLAMP_Runtime -> CLAMP_Runtime: CreateLog Participant Controlas Loop Instance
CLAMP_Runtime -> Database: Store First Version of Control Loop Instance
having missed a report
       CLAMP_Runtime -> CLAMPInstantiated_ACM_GUIInventory: [REST]Increment Controlmissed Loopreport Instance Updated

@enduml

2.2 Updating Instance Specific Parameters on a Control Loop Instance

PlantUML Macro

@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
participant Participant
database Database

CLAMP_GUI -> CLAMP_Runtime: [REST] Read Control Loop Instances
CLAMP_Runtime -> Database: Read Control Loop Instances
CLAMP_Runtime -> CLAMP_GUI: [REST] Control Loop Instances returned
CLAMP_GUIcounter on Participant
       alt Participant has exceeded alarm threshold on missed report counter
          CLAMP_Runtime -> CLAMP_GUIRuntime: SelectRaise a ControlParticipant LoopOffline Instancealarm 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
participant
          CLAMP_Runtime -> Instantiated_ACM_Inventory: Mark participant as being offline
       end
    else Participant has reported in last reporting window
       CLAMP_Runtime -> CLAMPInstantiated_ACM_GUIInventory: Clear [REST]missed Returnreport GUIcounter fieldson InstanceParticipant
 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   alt Participant marked as being offline
          CLAMP_Runtime -> CLAMP_Runtime: [REST] Request Update of Control Loop Instance
CLAMP_Runtime -> CLAMP_Runtime: Update Control Loop Instance
Clear Participant Offline alarm on participant
          CLAMP_Runtime -> Database: Store New Version of Control Loop Instance
CLAMP_Runtime -> CLAMP_GUI: [REST] Control Loop Instance Updated

@enduml

...

Instantiated_ACM_Inventory: Mark participant as being online
       end
    end
  end
end

@enduml

4.2 Supervise Automation Compositions

PlantUML Macro

@startuml
participant CLAMP_GUIRuntime
participantdatabase CLAMP_Runtime
participant Participant
database Database

CLAMP_GUIInstantiated_ACM_Inventory

loop forever
  CLAMP_Runtime -> CLAMPInstantiated_ACM_Runtime: [REST] Read all versions of Control Loop Instance
CLAMP_Runtime -> Database: Read all versions of Control Loop Instance
CLAMP_Runtime -> CLAMP_GUI: [REST] All versions of Control Loop Instance returned
CLAMP_GUI -> CLAMP_GUI: Select version of Control Loop Instance for Instantiation Participants
CLAMP_GUIInventory: Read Automation Composition Instances
  loop Over each Automation Composition Instance
    loop Over each Automation Composition Element
      alt Automation Composition Element has not reported in last reporting window
         CLAMP_Runtime -> CLAMP_Runtime: [REST]Log InstantiateAutomation selectedComposition version of Control Loop Instance on Participants

alt Selected version of Control Loop Instance not instantiated on Participants
Element as having missed a report
         CLAMP_Runtime -> Database: Read version of Control Loop Instance
  CLAMP_Runtime -> Participants: [DMaaP] Update Participants with version of Control Loop Instance
  Instantiated_ACM_Inventory: Increment missed report counter on Automation Composition Element
      else Automation Composition Element has reported in last reporting window
         CLAMP_Runtime -> CLAMPInstantiated_ACM_GUIInventory: [REST]Clear Instantiationmissed ofreport Versioncounter ofon ControlAutomation LoopComposition InstanceElement
 ordered on participants
else Selected version ofend
 Control Loop Instance instantiated on Participants
alt Automation CLAMP_Runtime -> CLAMP_GUI: [REST] Version of Control Loop Instance already instantiated on participants 
end

== Participant Responses ==
ParticipantsComposition Element in incorrect state in last reporting window
        CLAMP_Runtime -> CLAMP_Runtime: [DMaaP] Result of update of version of Control Loop Instance on participant
 Log Automation Composition Element as being in incorrect state
        CLAMP_Runtime -> Database: Store result of update of version of Control Loop Instance on participant

== Supervision ==
loop forever
  CLAMP_Runtime -> Database: Read Control Loop Instances
  loop over each Control Loop Instance
    alt Control Loop Instance Instantiation update underway on participants
	Instantiated_ACM_Inventory: Record Automation Composition Element as being in incorrect state
      else Automation Composition Element not in incorrect state in last reporting window
        alt Automation Composition Element was in incorrect state on previous report
          CLAMP_Runtime -> DatabaseCLAMP_Runtime: readLog Automation resultComposition ofElement Controlas Loopbeing updatesin fromcorrect participantsstate
      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 completedInstantiated_ACM_Inventory: Record Automation Composition Element as being in correct state
        end
      end
      alt Automation Composition Element reported fault in last reporting window
        alt Instantiation of Control Loop Instance on participants timed out
	CLAMP_Runtime -> CLAMP_Runtime: Log Automation Composition Element as being faulty
        CLAMP_Runtime -> DatabaseInstantiated_ACM_Inventory: setRecord versionAutomation ControlComposition LoopElement Instance Instantiation as timedbeing outfaulty
 on Participants
	    else Automation CLAMP_Runtime -> CLAMP_Runtime: Log error
        else Wait for updates to complete
        endComposition Element did not report fault in last reporting window
        alt Automation Composition Element reported fault on previous report
      end 
   CLAMP_Runtime else Control Loop Instance Instantiation update on participants not underway-> CLAMP_Runtime: Log Automation Composition Element fault as cleared
    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_GUIRuntime -> CLAMPInstantiated_ACM_RuntimeInventory: Mark [REST]fault ReadAutomation allComposition InstantiatedElement Controlas Loopbeing Instancescleared
CLAMP_Runtime -> Database: Read all Instantiated Control Loop Instancesend
CLAMP_Runtime  -> CLAMP_GUI: [REST] All Instantiatedend
 Control Loop Instances returned
CLAMP_GUI -> CLAMP_GUI: Select Control Loop Instance on which to change state and specify new state
CLAMP_GUIend
    alt Automation Composition Element in Automation Composition Instance has exceeded alarm threshold on missed report counter
      CLAMP_Runtime -> CLAMP_Runtime: [REST]Raise Changea stateAutomation ofComposition selectedOffline Controlalarm Loopon InstanceAutomation onComposition Participants

alt Selected Control Loop Instance instantiated on Participants
Instance
      CLAMP_Runtime -> ParticipantsInstantiated_ACM_Inventory: [DMaaP]Mark Request change of state of Control Loop Instance
  CLAMP_Runtime -> CLAMP_GUI: [REST] Change of state of Control Loop Instance ordered on participants
else Selected Control Loop Instance not instantiated on Participants
  CLAMP_Runtime -> CLAMP_GUI: [REST] Control Loop Instance not instantiated on participants 
end

== Participant Responses ==
Participants -> CLAMP_Runtime: [DMaaP] Result of State Change of Control Loop Instance on participant
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 -> DatabaseCLAMP_Runtime: StoreClear resultAutomation ofComposition StateInstance ChangeOffline ofalarm Controlon LoopAutomation InstanceComposition on participant

== Supervision ==
loop forever
           CLAMP_Runtime -> DatabaseInstantiated_ACM_Inventory: ReadMark ControlAutomation LoopComposition Instances
Instance as loop over each Control Loop Instance
    alt Control Loop Instance State Change underway on participants
	  CLAMP_Runtime -> Database: read result of Control Loop State Change from participants
      alt Updates completed on all participants
	being online
       end
    end
    alt Automation Composition Element in Automation Composition Instance in incorrect state in last reporting window
      CLAMP_Runtime -> DatabaseCLAMP_Runtime: setLog ControlAutomation LoopComposition Instance stateas asbeing changedin onincorrect Participantsstate
	      CLAMP_Runtime -> DatabaseInstantiated_ACM_Inventory: setRecord overallAutomation Control LoopComposition Instance state as changed
  being in incorrect state
 else Updates not completed
  alt Automation Composition Element in Automation altComposition ControlInstance Loophas Instanceexceeded Statealarm Changethreshold on participantsincorrect timedstate outreports
	        CLAMP_Runtime -> DatabaseCLAMP_Runtime: setRaise a ControlAutomation LoopComposition StateInstance Changein asIncorrect timedState outalarm on Automation Composition ParticipantsInstance
	        CLAMP_Runtime -> CLAMPInstantiated_ACM_RuntimeInventory: Log error
        else Wait for updates to complete
        endMark Automation Composition Instance as being in an incorrect state
      end 
    else No Automation ControlComposition LoopElement Instancein Stateincorrect Changestate onin participantslast notreporting underwaywindow
    end
   end
@enduml

2.6 De-instantiating a Control Loop Instance from Participants

PlantUML Macro

@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
participant Participant
database Database

CLAMP_GUI -> CLAMP_Runtime: [REST] Read all Instantiated Control Loop Instances
CLAMP_Runtime -> Database: Read all Instantiated Control Loop Instances
alt Automation Composition Element in Automation Composition Instance was in incorrect state on previous report
        CLAMP_Runtime -> CLAMP_GUIRuntime: [REST] All Instantiated Control Loop Instances returned
CLAMP_GUI Log Automation Composition Instance as being in correct state
        CLAMP_Runtime -> CLAMPInstantiated_ACM_GUIInventory: SelectRecord ControlAutomation LoopComposition Instance as to de-instantiate
CLAMP_GUI -> CLAMP_Runtime: [REST] De-instantiate selected Control Loop Instance on Participants

alt Selected Control Loop Instance instantiated on Participants
  CLAMP_Runtime -> Participants: [DMaaP] Update Participants to remove Control Loop Instance
being in correct state
        alt Automation Composition Instance in Incorrect State alarm raised on Automation Composition Instance
          CLAMP_Runtime -> CLAMP_GUIRuntime: Clear [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
Automation Composition Instance in Incorrect State alarm on Automation Composition Instance
        end
      end
    end
    alt Automation Composition Element in Automation Composition Instance reported a fault in last reporting window
      CLAMP_Runtime -> DatabaseCLAMP_Runtime: StoreLog resultAutomation ofComposition update of Control Loop Instance on participant

== Supervision ==
loop forever
Instance as being faulty
      CLAMP_Runtime -> DatabaseInstantiated_ACM_Inventory: Read Control Loop InstancesRecord 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 Loop updates from participants
      alt Updates completed on all participants
	Instance Faulty alarm on Automation Composition Instance
      end
    CLAMP_Runtime -> Database: set Control Loop Instance as de-instantiated on Participants
	    CLAMP_Runtime -> Database: set overall Control Loop Instance as de-instantiated
      else Updates not completed
else No Automation Composition Element faulty in last reporting window
      alt Automation Composition Element in Automation Composition Instance was faulty on previous report
        CLAMP_Runtime -> CLAMP_Runtime: altLog ControlAutomation 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

2.7 Deleting a Control Loop Instance

2.7 Reading Control Loop Instances

3. Monitoring Dialogues

Monitoring dialogues are used to monitor and to read statistics on Control Loop Instances.

3.1 Reporting of Monitoring Information and Statistics by Participants

3.2 Viewing of Monitoring Information

3.2 Viewing of Statistics

...


@enduml

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 11

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

2.2 Updating Instance Specific Parameters on an Automation Composition Instance

2.3 Updating an Automation Composition Instance with a Configuration on Participants

2.4 Changing the state of an Automation Composition Instance on Participants

2.5 De-instantiating an Automation Composition Instance from Participants

1.3 Setting Common Parameters for a Control Loop Type Definition

1.4 Commissioning a Control Loop Type Definition on Participants

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

1.5 Decommissioning a Control Loop Type Definition on Participants

3.2 Viewing of Monitoring Information

3.2 Viewing of Statistics

1.6 Decommissioning a Control Loop Type Definition in CLAMP

1.7 Reading Commissioned Control Loop Type Definitions

2. Instantiation Dialogues

3.3 Statistics Housekeeping

4. Supervision Dialogues

4.1 Supervise Participants

2.2 Updating Instance Specific Parameters on a Control Loop Instance

4.2 Supervise Automation Compositions

2.5 Changing the state of a Control Loop Instance on Participants

2.6 De-instantiating a Control Loop Instance from Participants

2.7 Deleting a Control Loop Instance

2.7 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