Page History

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 Control LoopsAutomation Compositions: Architecture and Design. Design Time dialogues will be described in future releases of the system.

...

Commissioning dialogues are used to commission and decommission Control Loop Automation Composition Type definitions and to set the values of Common Parameters.

Commissioning a Control Loop an Automation Composition Type is a three-step process

The Control Loop Automation Composition Type must be created, that is the Control Loop 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 Control Loop 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 Control Loop Automation Composition Type is primed.
The Control Loop Automation Composition Type Definition and the Common Property values must be primed, that which is sent to the concerned participants. Once a Control Loop an Automation Composition Type is primed, its Common Property values can no longer be changed. To change Common Properties on a primed Control Loop Automation Composition Type, all instances of the Control Loop Automation Composition Type must be removed and the Control Loop 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_CLACM_Inventory

CLAMP_GUI -> CLAMP_Runtime: [REST] Commission ControlAutomation LoopComposition Type Definition
CLAMP_Runtime -> Commissioned_CLACM_Inventory: Store ControlAutomation LoopComposition 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_CLACM_Inventory

SDC -> Policy_Distribution: [DMaaP] CSAR containing ControlAutomation LoopComposition Type Definition
Policy_Distribution -> CLAMP_Runtime: [REST] Commission ControlAutomation LoopComposition Type Definition
CLAMP_Runtime -> Commissioned_CLACM_Inventory: Store ControlAutomation LoopComposition 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 a Control Loop an Automation Composition Type Definition and its properties are primed (See Section 1.4), the properties cannot be changed until the control loop Automation Composition type definition is de-primed (See Section 1.5).

PlantUML Macro

@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
participant Participant
database Commissioned_CLACM_Inventory

CLAMP_GUI -> CLAMP_Runtime: [REST] Read ControlAutomation LoopComposition Type Definitions
CLAMP_Runtime -> Commissioned_CLACM_Inventory: Read ControlAutomation LoopComposition Type Definitions
CLAMP_Runtime -> CLAMP_GUI: [REST] Type Definitions returned
CLAMP_GUI -> CLAMP_GUI: Select ControlAutomation LoopComposition Type Definition for Parameterization
CLAMP_GUI -> CLAMP_Runtime: [REST] Fetch GUI fields for Common Parameter Definitions

alt ControlAutomation LoopComposition Type Definition not Commissioned on Participants
  CLAMP_Runtime -> Commissioned_CLACM_Inventory: Read ControlAutomation LoopComposition 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_CLACM_Inventory: Store values for Common Parameters
  CLAMP_Runtime -> CLAMP_GUI: [REST] Common Parameter values stored
else ControlAutomation LoopComposition Type Definition already Commissioned on Participants
  CLAMP_Runtime -> CLAMP_GUI: [REST] Cannot set Common Parameters on\nControlnAutomation LoopComposition Type Definition that has\nbeen commissioned on participants
end

@enduml

1.4 Priming

...

an Automation Composition Type Definition on Participants

The Priming operation sends Control Loop Automation Composition Type definitions and common property values to participants. Once a Control Loop 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_CLACM_Inventory

CLAMP_GUI -> CLAMP_Runtime: [REST] Read ControlAutomation LoopComposition Type Definitions
CLAMP_Runtime -> Commissioned_CLACM_Inventory: Read ControlAutomation LoopComposition Type Definitions
CLAMP_Runtime -> CLAMP_GUI: [REST] Type Definitions returned
CLAMP_GUI -> CLAMP_GUI: Select ControlAutomation LoopComposition Type Definition for Priming on Participants
CLAMP_GUI -> CLAMP_Runtime: [REST] Prime ControlAutomation LoopComposition Type Definition on Participants

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

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

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

1.5 De-Prime

...

an Automation Composition Type Definition on Participants

This dialogue allows a Control Loop 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_CLACM_Inventory

CLAMP_GUI -> CLAMP_Runtime: [REST] Read ControlAutomation LoopComposition Type Definitions
CLAMP_Runtime -> Commissioned_CLACM_Inventory: Read ControlAutomation LoopComposition Type Definitions
CLAMP_Runtime -> CLAMP_GUI: [REST] Type Definitions returned
CLAMP_GUI -> CLAMP_GUI: Select ControlAutomation LoopComposition Type Definition for de-priming on Participants
CLAMP_GUI -> CLAMP_Runtime: [REST] De-prime ControlAutomation LoopComposition Type Definition on Participants

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

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

== Supervision ==
loop forever
  CLAMP_Runtime -> Commissioned_CLACM_Inventory: Read ControlAutomation LoopComposition Type Definitions
  loop over each ControlAutomation LoopComposition Type Definition
    alt ControlAutomation LoopComposition Type Definition Participant de-prime underway
	  CLAMP_Runtime -> Commissioned_CLACM_Inventory: read result of ControlAutomation LoopComposition Type Definition Updates from participants
      alt Updates completed on all participants
	    CLAMP_Runtime -> Commissioned_CLACM_Inventory: set ControlAutomation LoopComposition Type Definition as de-primeed on Participants
      else Updates not completed
        alt De-priming of ControlAutomation LoopComposition Type Definition on participants timed out
	      CLAMP_Runtime -> Commissioned_CLACM_Inventory: set ControlAutomation LoopComposition Type Definition de-priming as timed out on Participants
	      CLAMP_Runtime -> CLAMP_Runtime: Log error
        else Wait for updates to complete
        end
      end 
    else ControlAutomation LoopComposition 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_CLACM_Inventory

CLAMP_GUI -> CLAMP_Runtime: [REST] Read ControlAutomation LoopComposition Type Definitions
CLAMP_Runtime -> Commissioned_CLACM_Inventory: Read ControlAutomation LoopComposition Type Definitions
CLAMP_Runtime -> CLAMP_GUI: [REST] Type Definitions returned
CLAMP_GUI -> CLAMP_GUI: Select ControlAutomation LoopComposition Type Definition for Decommissioning
CLAMP_GUI -> CLAMP_Runtime: [REST] Decommission ControlAutomation LoopComposition Type Definition

alt ControlAutomation LoopComposition Type Definition not primed on Participants
  CLAMP_Runtime -> Commissioned_CLACM_Inventory: Delete ControlAutomation LoopComposition Type Definition
  CLAMP_Runtime -> CLAMP_GUI: [REST] Type Definition Decommissioned
else ControlAutomation LoopComposition Type Definition is Commissioned on Participants
  CLAMP_Runtime -> CLAMP_GUI: [REST] ControlAutomation LoopComposition 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_CLACM_Inventory

CLAMP_GUI -> CLAMP_Runtime: [REST] Read ControlAutomation LoopComposition Type Definitions
CLAMP_Runtime -> Commissioned_CLACM_Inventory: Read ControlAutomation LoopComposition Type Definitions
CLAMP_Runtime -> CLAMP_GUI: [REST] Type Definitions returned

@enduml

...

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

Assume a suitable Control Loop Automation Composition Definition exists in the Commissioned Control Loop Automation Composition Inventory. To get a Control Loop 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_CLACM_Inventory
database Instantiated_CLACM_Inventory

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

@enduml

Note that this dialogue creates the Control Loop Automation Composition Instance in the Instantiated Control Loop 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_CLACM_Inventory

CLAMP_GUI -> CLAMP_Runtime: [REST] Read ControlAutomation LoopComposition Instances
CLAMP_Runtime -> Instantiated_CLACM_Inventory: Read ControlAutomation LoopComposition Instances
CLAMP_Runtime -> CLAMP_GUI: [REST] ControlAutomation LoopComposition Instances returned
CLAMP_GUI -> CLAMP_GUI: Select ControlAutomation LoopComposition Instance on which to Update Parameters
CLAMP_GUI -> CLAMP_GUI: Step version of ControlAutomation LoopComposition Instance as Major/Minor/Patch
CLAMP_GUI -> CLAMP_Runtime: [REST] Fetch GUI fields for Instance Specific Parameter Definitions
CLAMP_Runtime -> Instantiated_CLACM_Inventory: Read ControlAutomation LoopComposition Type Definition
CLAMP_Runtime -> CLAMP_Runtime: Generate fields for Instance Specific Parameters for GUI
CLAMP_Runtime -> CLAMP_GUI: [REST] Return GUI fields Instance Specific Parameter Definitions
CLAMP_GUI -> CLAMP_GUI: Render UI for Instance Specific Parameters
CLAMP_GUI -> CLAMP_GUI: Get values for Instance Specific Parameters from user
CLAMP_GUI -> CLAMP_Runtime: [REST] Request Update of ControlAutomation LoopComposition Instance
CLAMP_Runtime -> CLAMP_Runtime: Update ControlAutomation LoopComposition Instance
CLAMP_Runtime -> Instantiated_CLACM_Inventory: Store New Version of ControlAutomation LoopComposition Instance
CLAMP_Runtime -> CLAMP_GUI: [REST] ControlAutomation LoopComposition 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_CLACM_Inventory

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

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

== Participant Responses ==
Participants -> CLAMP_Runtime: [DMaaP] Result of update of configuration version of ControlAutomation LoopComposition Instance on participant
CLAMP_Runtime -> Instantiated_CLACM_Inventory: Store result of update of configuration version of ControlAutomation LoopComposition Instance on participant

== Supervision ==
loop forever
  CLAMP_Runtime -> Instantiated_CLACM_Inventory: Read ControlAutomation LoopComposition Instances
  loop over each ControlAutomation LoopComposition Instance
    alt ControlAutomation LoopComposition Instance configuration version update underway on participants
	  CLAMP_Runtime -> Instantiated_CLACM_Inventory: read result of ControlAutomation LoopComposition updates from participants
      alt Updates completed on all participants
	    CLAMP_Runtime -> Instantiated_CLACM_Inventory: set configuration version of ControlAutomation LoopComposition Instance as Instantiated on Participants
	    CLAMP_Runtime -> Instantiated_CLACM_Inventory: set overall configuration version of ControlAutomation LoopComposition Instance state as Instantiated
      else Updates not completed
        alt Instantiation of ControlAutomation LoopComposition Instance on participants timed out
	      CLAMP_Runtime -> Instantiated_CLACM_Inventory: set configuration version ControlAutomation LoopComposition Instance Instantiation as timed out on Participants
	      CLAMP_Runtime -> CLAMP_Runtime: Log error
        else Wait for updates to complete
        end
      end 
    else ControlAutomation LoopComposition 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_CLACM_Inventory

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

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

== Participant Responses ==
Participants -> CLAMP_Runtime: [DMaaP] Result of State Change of ControlAutomation LoopComposition Instance on participant
CLAMP_Runtime -> Instantiated_CLACM_Inventory: Store result of State Change of ControlAutomation LoopComposition Instance on participant

== Supervision ==
loop forever
  CLAMP_Runtime -> Instantiated_CLACM_Inventory: Read ControlAutomation LoopComposition Instances
  loop over each ControlAutomation LoopComposition Instance
    alt ControlAutomation LoopComposition Instance State Change underway on participants
	  CLAMP_Runtime -> Instantiated_CLACM_Inventory: read result of ControlAutomation LoopComposition State Change from participants
      alt Updates completed on all participants
	    CLAMP_Runtime -> Instantiated_CLACM_Inventory: set ControlAutomation LoopComposition Instance state as changed on Participants
	    CLAMP_Runtime -> Instantiated_CLACM_Inventory: set overall ControlAutomation LoopComposition Instance state as changed
      else Updates not completed
        alt ControlAutomation LoopComposition Instance State Change on participants timed out
	      CLAMP_Runtime -> Instantiated_CLACM_Inventory: set ControlAutomation LoopComposition State Change as timed out on Participants
	      CLAMP_Runtime -> CLAMP_Runtime: Log error
        else Wait for updates to complete
        end
      end 
    else ControlAutomation LoopComposition 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_CLACM_Inventory

CLAMP_GUI -> CLAMP_Runtime: [REST] Read all Instantiated ControlAutomation LoopComposition Instances
CLAMP_Runtime -> Instantiated_CLACM_Inventory: Read all Instantiated ControlAutomation LoopComposition Instances
CLAMP_Runtime -> CLAMP_GUI: [REST] All Instantiated ControlAutomation LoopComposition Instances returned
CLAMP_GUI -> CLAMP_GUI: Select ControlAutomation LoopComposition Instance to de-instantiate
CLAMP_GUI -> CLAMP_Runtime: [REST] De-instantiate selected ControlAutomation LoopComposition Instance on Participants

alt Selected ControlAutomation LoopComposition Instance instantiated on Participants
  CLAMP_Runtime -> Participants: [DMaaP] Update Participants to remove ControlAutomation LoopComposition Instance
  CLAMP_Runtime -> CLAMP_GUI: [REST] De-instantiation of ControlAutomation LoopComposition Instance ordered on participants
else Selected ControlAutomation LoopComposition Instance not instantiated on Participants
  CLAMP_Runtime -> CLAMP_GUI: [REST] ControlAutomation LoopComposition Instance not instantiated on participants 
end

== Participant Responses ==
Participants -> CLAMP_Runtime: [DMaaP] Result of update of ControlAutomation LoopComposition Instance on participant
CLAMP_Runtime -> Instantiated_CLACM_Inventory: Store result of update of ControlAutomation LoopComposition Instance on participant

== Supervision ==
loop forever
  CLAMP_Runtime -> Instantiated_CLACM_Inventory: Read ControlAutomation LoopComposition Instances
  loop over each ControlAutomation LoopComposition Instance
    alt ControlAutomation LoopComposition Instance de-instantiation update underway on participants
	  CLAMP_Runtime -> Instantiated_CLACM_Inventory: read result of ControlAutomation LoopComposition updates from participants
      alt Updates completed on all participants
	    CLAMP_Runtime -> Instantiated_CLACM_Inventory: set ControlAutomation LoopComposition Instance as de-instantiated on Participants
	    CLAMP_Runtime -> Instantiated_CLACM_Inventory: set overall ControlAutomation LoopComposition Instance as de-instantiated
      else Updates not completed
        alt ControlAutomation LoopComposition Instance de-instantiation Update timed out on participants
	      CLAMP_Runtime -> Instantiated_CLACM_Inventory: set ControlAutomation LoopComposition Instance de-instantiation as timed out on Participants
	      CLAMP_Runtime -> CLAMP_Runtime: Log error
        else Wait for updates to complete
        end
      end 
    else ControlAutomation LoopComposition 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_CLACM_Inventory

CLAMP_GUI -> CLAMP_Runtime: [REST] Read all ControlAutomation LoopComposition Instances
CLAMP_Runtime -> Instantiated_CLACM_Inventory: Read all ControlAutomation LoopComposition Instances
CLAMP_Runtime -> CLAMP_GUI: [REST] All ControlAutomation LoopComposition Instances returned
CLAMP_GUI -> CLAMP_GUI: Select ControlAutomation LoopComposition Instance to delete
CLAMP_GUI -> CLAMP_Runtime: [REST] Delete selected ControlAutomation LoopComposition Instance

alt Selected ControlAutomation LoopComposition Instance exists
  CLAMP_Runtime -> Instantiated_CLACM_Inventory: Delete controlAutomation loopComposition instance
  CLAMP_Runtime -> CLAMP_GUI: [REST] ControlAutomation LoopComposition Instance deleted
else Selected ControlAutomation LoopComposition Instance does not exist
  CLAMP_Runtime -> CLAMP_GUI: [REST] ControlAutomation LoopComposition Instance does not exist 
end

@enduml

2.7 Reading

...

Automation Composition Instances

PlantUML Macro

@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
database Instantiated_CLACM_Inventory

CLAMP_GUI -> CLAMP_Runtime: [REST] Read all ControlAutomation LoopComposition Instances
CLAMP_Runtime -> Instantiated_CLACM_Inventory: Read all ControlAutomation LoopComposition Instances
CLAMP_Runtime -> CLAMP_GUI: [REST] All ControlAutomation LoopComposition Instances returned

@enduml

...

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

3.1 Reporting of Monitoring Information and Statistics by Participants

PlantUML Macro

@startuml
participant CLAMP_Runtime
participant Participant
database Instantiated_CLACM_Inventory

Participant -> CLAMP_Runtime: [DMaaP] Participant and ControlAutomation LoopComposition Element Monitoring and Statistics report
CLAMP_Runtime -> Instantiated_CLACM_Inventory: Store Participant and ControlAutomation LoopComposition Element Monitoring and Statistics report

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

loop Over all ControlAutomation LoopComposition Elements in Participant Report
  alt Fault reported on ControlAutomation LoopComposition Element
    CLAMP_Runtime -> CLAMP_Runtime: log fault on ControlAutomation LoopComposition Element and ControlAutomation Loop
Composition      CLAMP_Runtime -> Instantiated_CLACM_Inventory: Record fault on ControlAutomation LoopComposition Element and ControlAutomation Loop
Composition   end
end
@enduml

3.2 Viewing of Monitoring Information

PlantUML Macro

@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
database Instantiated_CLACM_Inventory

== Overview of all ControlAutomation LoopComposition Instances ==
CLAMP_GUI -> CLAMP_Runtime: [REST] Read all ControlAutomation LoopComposition Instances
CLAMP_Runtime -> Instantiated_CLACM_Inventory: Read all ControlAutomation LoopComposition Instances
CLAMP_Runtime -> CLAMP_GUI: [REST] All ControlAutomation LoopComposition Instances returned
CLAMP_GUI -> CLAMP_GUI: Display overview of status of all ControlAutomation LoopComposition Instances

== Details of a ControlAutomation LoopComposition Instance ==
CLAMP_GUI -> CLAMP_Runtime: [REST] Read ControlAutomation LoopComposition Elements for ControlAutomation LoopComposition Instance
CLAMP_Runtime -> Instantiated_CLACM_Inventory: Read ControlAutomation LoopComposition Elements for ControlAutomation LoopComposition Instance
CLAMP_Runtime -> CLAMP_GUI: [REST] ControlAutomation LoopComposition Elements returned
CLAMP_GUI -> CLAMP_GUI: Display status of ControlAutomation LoopComposition Elements in ControlAutomation LoopComposition Instance

== Overview of all Participants ==
CLAMP_GUI -> CLAMP_Runtime: [REST] Read all participants
CLAMP_Runtime -> Instantiated_CLACM_Inventory: Read all participants
CLAMP_Runtime -> CLAMP_GUI: [REST] All participants returned
CLAMP_GUI -> CLAMP_GUI: Display overview of status of all participants

== Details of a Participant ==
CLAMP_GUI -> CLAMP_Runtime: [REST] Read ControlAutomation LoopComposition Elements for Participant
CLAMP_Runtime -> Instantiated_CLACM_Inventory: Read ControlAutomation LoopComposition Elements for Participant
CLAMP_Runtime -> CLAMP_GUI: [REST] ControlAutomation LoopComposition Elements returned
CLAMP_GUI -> CLAMP_GUI: Display status of ControlAutomation LoopComposition Elements in Participant

== Filtered Monitoring ==
CLAMP_GUI -> CLAMP_GUI: Set filter for ControlAutomation LoopComposition Instances, ControlAutomation LoopComposition Elements, and Participants
CLAMP_GUI -> CLAMP_Runtime: [REST] Read ControlAutomation LoopComposition Elements that match filter
CLAMP_Runtime -> Instantiated_CLACM_Inventory: Read ControlAutomation LoopComposition Elements that match filter
CLAMP_Runtime -> CLAMP_GUI: [REST] ControlAutomation LoopComposition Elements that match filter returned
CLAMP_GUI -> CLAMP_GUI: Display status of ControlAutomation LoopComposition Elements that match filter

@enduml

...

PlantUML Macro

@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
database Instantiated_CLACM_Inventory

== Statistics of all ControlAutomation LoopComposition Instances ==
CLAMP_GUI -> CLAMP_Runtime: [REST] Read summary statistics for all ControlAutomation LoopComposition Instances
CLAMP_Runtime -> Instantiated_CLACM_Inventory: Compile summary statistics for all ControlAutomation LoopComposition Instances
CLAMP_Runtime -> CLAMP_GUI: [REST] Summary statistics for all ControlAutomation LoopComposition Instances returned
CLAMP_GUI -> CLAMP_GUI: Display summary statistics for all ControlAutomation LoopComposition Instances

== Statistics of a ControlAutomation LoopComposition Instance ==
CLAMP_GUI -> CLAMP_Runtime: [REST] Read statistics for ControlAutomation LoopComposition Elements for ControlAutomation LoopComposition Instance
CLAMP_Runtime -> Instantiated_CLACM_Inventory: Compile statistics for ControlAutomation LoopComposition Elements for ControlAutomation LoopComposition Instance
CLAMP_Runtime -> CLAMP_GUI: [REST] Statistics for ControlAutomation LoopComposition Elements returned
CLAMP_GUI -> CLAMP_GUI: Display statistics for ControlAutomation LoopComposition Elements in ControlAutomation LoopComposition Instance

== Statistics of all Participants ==
CLAMP_GUI -> CLAMP_Runtime: [REST] Read summary statistics for all ControlAutomation LoopComposition Instances
CLAMP_Runtime -> Instantiated_CLACM_Inventory: Compile summary statistics for all ControlAutomation LoopComposition Instances
CLAMP_Runtime -> CLAMP_GUI: [REST] Summary statistics for all ControlAutomation LoopComposition Instances returned
CLAMP_GUI -> CLAMP_GUI: Display summary statistics for all ControlAutomation LoopComposition Instances

== Statistics of a Participant ==
CLAMP_GUI -> CLAMP_Runtime: [REST] Read statistics for ControlAutomation LoopComposition Elements for Participant
CLAMP_Runtime -> Instantiated_CLACM_Inventory: Read statistics for ControlAutomation LoopComposition Elements for Participant
CLAMP_Runtime -> CLAMP_GUI: [REST] Statistics for ControlAutomation LoopComposition Elements returned
CLAMP_GUI -> CLAMP_GUI: Display statistics for ControlAutomation LoopComposition Elements in Participant

== Filtered Statistics ==
CLAMP_GUI -> CLAMP_GUI: Set filter for ControlAutomation LoopComposition Instances, ControlAutomation LoopComposition Elements, and Participants
CLAMP_GUI -> CLAMP_Runtime: [REST] Read statistics for ControlAutomation LoopComposition Elements that match filter
CLAMP_Runtime -> Instantiated_CLACM_Inventory: Read statistics for ControlAutomation LoopComposition Elements that match filter
CLAMP_Runtime -> CLAMP_GUI: [REST] Statistics for ControlAutomation LoopComposition Elements that match filter returned
CLAMP_GUI -> CLAMP_GUI: Display statistics for ControlAutomation LoopComposition Elements that match filter

@enduml

...

PlantUML Macro

@startuml
participant CLAMP_Runtime
database Instantiated_CLACM_Inventory

== ControlAutomation LoopComposition Instance Statistics ==

loop forever
  CLAMP_Runtime -> Instantiated_CLACM_Inventory: Read ControlAutomation LoopComposition Instance Statistics
  CLAMP_Runtime -> CLAMP_Runtime: Summarise ControlAutomation LoopComposition Instance Statistics
  CLAMP_Runtime -> Instantiated_CLACM_Inventory: Store summarised ControlAutomation LoopComposition Instance Statistics
  CLAMP_Runtime -> Instantiated_CLACM_Inventory: Delete ControlAutomation LoopComposition Instance Statistics on which retention period has expired
end

== Participant Statistics ==

loop forever
  CLAMP_Runtime -> Instantiated_CLACM_Inventory: Read Participant Statistics
  CLAMP_Runtime -> CLAMP_Runtime: Summarise Participant Statistics
  CLAMP_Runtime -> Instantiated_CLACM_Inventory: Store summarised Participant Statistics
  CLAMP_Runtime -> Instantiated_CLACM_Inventory: Delete Participant Statistics on which retention period has expired
end

@enduml

...

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

...

PlantUML Macro

@startuml
participant CLAMP_Runtime
database Instantiated_CLACM_Inventory

loop forever
  CLAMP_Runtime -> Instantiated_CLACM_Inventory: Read Participants
  loop Over each Participant
    alt Participant has not reported in last reporting window
       CLAMP_Runtime -> CLAMP_Runtime: Log Participant as having missed a report
       CLAMP_Runtime -> Instantiated_CLACM_Inventory: Increment missed report counter on Participant
       alt Participant has exceeded alarm threshold on missed report counter
          CLAMP_Runtime -> CLAMP_Runtime: Raise a Participant Offline alarm on participant
          CLAMP_Runtime -> Instantiated_CLACM_Inventory: Mark participant as being offline
       end
    else Participant has reported in last reporting window
       CLAMP_Runtime -> Instantiated_CLACM_Inventory: Clear missed report counter on Participant
       alt Participant marked as being offline
          CLAMP_Runtime -> CLAMP_Runtime: Clear Participant Offline alarm on participant
          CLAMP_Runtime -> Instantiated_CLACM_Inventory: Mark participant as being online
       end
    end
  end
end

@enduml

4.2 Supervise

...

Automation Compositions

PlantUML Macro

@startuml
participant CLAMP_Runtime
database Instantiated_CLACM_Inventory

loop forever
  CLAMP_Runtime -> Instantiated_CLACM_Inventory: Read ControlAutomation LoopComposition Instances
  loop Over each ControlAutomation LoopComposition Instance
    loop Over each ControlAutomation LoopComposition Element
      alt ControlAutomation LoopComposition Element has not reported in last reporting window
         CLAMP_Runtime -> CLAMP_Runtime: Log ControlAutomation LoopComposition Element as having missed a report
         CLAMP_Runtime -> Instantiated_CLACM_Inventory: Increment missed report counter on ControlAutomation LoopComposition Element
      else ControlAutomation LoopComposition Element has reported in last reporting window
         CLAMP_Runtime -> Instantiated_CLACM_Inventory: Clear missed report counter on ControlAutomation LoopComposition Element
      end
      alt ControlAutomation LoopComposition Element in incorrect state in last reporting window
        CLAMP_Runtime -> CLAMP_Runtime: Log ControlAutomation LoopComposition Element as being in incorrect state
        CLAMP_Runtime -> Instantiated_CLACM_Inventory: Record ControlAutomation LoopComposition Element as being in incorrect state
      else ControlAutomation LoopComposition Element not in incorrect state in last reporting window
        alt ControlAutomation LoopComposition Element was in incorrect state on previous report
          CLAMP_Runtime -> CLAMP_Runtime: Log ControlAutomation LoopComposition Element as being in correct state
          CLAMP_Runtime -> Instantiated_CLACM_Inventory: Record ControlAutomation LoopComposition Element as being in correct state
        end
      end
      alt ControlAutomation LoopComposition Element reported fault in last reporting window
        CLAMP_Runtime -> CLAMP_Runtime: Log ControlAutomation LoopComposition Element as being faulty
        CLAMP_Runtime -> Instantiated_CLACM_Inventory: Record ControlAutomation LoopComposition Element as being faulty
      else ControlAutomation LoopComposition Element did not report fault in last reporting window
        alt ControlAutomation LoopComposition Element reported fault on previous report
          CLAMP_Runtime -> CLAMP_Runtime: Log ControlAutomation LoopComposition Element fault as cleared
          CLAMP_Runtime -> Instantiated_CLACM_Inventory: Mark fault ControlAutomation LoopComposition Element as being cleared
        end
      end
    end
    alt ControlAutomation LoopComposition Element in ControlAutomation LoopComposition Instance has exceeded alarm threshold on missed report counter
      CLAMP_Runtime -> CLAMP_Runtime: Raise a ControlAutomation LoopComposition Offline alarm on ControlAutomation LoopComposition Instance
      CLAMP_Runtime -> Instantiated_CLACM_Inventory: Mark ControlAutomation LoopComposition Instance as being offline
    else No ControlAutomation LoopComposition Element in ControlAutomation LoopComposition Instance has exceeded alarm threshold on missed report counter
       alt ControlAutomation LoopComposition Instance marked as being offline
          CLAMP_Runtime -> CLAMP_Runtime: Clear ControlAutomation LoopComposition Instance Offline alarm on ControlAutomation Loop
Composition               CLAMP_Runtime -> Instantiated_CLACM_Inventory: Mark ControlAutomation LoopComposition Instance as being online
       end
    end
    alt ControlAutomation LoopComposition Element in ControlAutomation LoopComposition Instance in incorrect state in last reporting window
      CLAMP_Runtime -> CLAMP_Runtime: Log ControlAutomation LoopComposition Instance as being in incorrect state
      CLAMP_Runtime -> Instantiated_CLACM_Inventory: Record ControlAutomation LoopComposition Instance as being in incorrect state
      alt ControlAutomation LoopComposition Element in ControlAutomation LoopComposition Instance has exceeded alarm threshold on incorrect state reports
        CLAMP_Runtime -> CLAMP_Runtime: Raise a ControlAutomation LoopComposition Instance in Incorrect State alarm on ControlAutomation LoopComposition Instance
        CLAMP_Runtime -> Instantiated_CLACM_Inventory: Mark ControlAutomation LoopComposition Instance as being in an incorrect state
      end
    else No ControlAutomation LoopComposition Element in incorrect state in last reporting window
      alt ControlAutomation LoopComposition Element in ControlAutomation LoopComposition Instance was in incorrect state on previous report
        CLAMP_Runtime -> CLAMP_Runtime: Log ControlAutomation LoopComposition Instance as being in correct state
        CLAMP_Runtime -> Instantiated_CLACM_Inventory: Record ControlAutomation LoopComposition Instance as being in correct state
        alt ControlAutomation LoopComposition Instance in Incorrect State alarm raised on ControlAutomation LoopComposition Instance
          CLAMP_Runtime -> CLAMP_Runtime: Clear ControlAutomation LoopComposition Instance in Incorrect State alarm on ControlAutomation LoopComposition Instance
        end
      end
    end
    alt ControlAutomation LoopComposition Element in ControlAutomation LoopComposition Instance reported a fault in last reporting window
      CLAMP_Runtime -> CLAMP_Runtime: Log ControlAutomation LoopComposition Instance as being faulty
      CLAMP_Runtime -> Instantiated_CLACM_Inventory: Record ControlAutomation LoopComposition Instance as being faulty
      alt ControlAutomation LoopComposition Element in ControlAutomation LoopComposition Instance has exceeded alarm threshold on faulty reports
        CLAMP_Runtime -> CLAMP_Runtime: Raise a ControlAutomation LoopComposition Instance Faulty alarm on ControlAutomation LoopComposition Instance
      end
    else No ControlAutomation LoopComposition Element faulty in last reporting window
      alt ControlAutomation LoopComposition Element in ControlAutomation LoopComposition Instance was faulty on previous report
        CLAMP_Runtime -> CLAMP_Runtime: Log ControlAutomation LoopComposition Instance as being fault free
        CLAMP_Runtime -> Instantiated_CLACM_Inventory: Record ControlAutomation LoopComposition Instance as being fault free
        alt ControlAutomation LoopComposition Instance Faulty alarm raised on ControlAutomation LoopComposition Instance
          CLAMP_Runtime -> CLAMP_Runtime: Clear ControlAutomation LoopComposition Instance Faulty alarm on ControlAutomation LoopComposition Instance
        end
      end
    end
  end
end

@enduml

...

Space shortcuts

Page tree

Versions Compared

Old Version 30

New Version Current

Key

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

2.6 Deleting

an Automation Composition Instance

2.7 Reading

Automation Composition Instances

3.1 Reporting of Monitoring Information and Statistics by Participants

3.2 Viewing of Monitoring Information

4.2 Supervise

Automation Compositions