Priming The CLAMP 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.
1
...
Dialogues
...
on Participants
1.1 Register a Participant
Participant Registration is performed by a Participant when it starts up. It registers its ID and the ACM Element Types it supports with the ACM runtime.
| PlantUML Macro |
|---|
@startuml
participant Participant
participant ACM_Runtime
database ACM_Database
Participant -> ACM_Runtime: [ASYNC] Register
ACM_Runtime -> ACM_Database: Create or Update Participant Registration\nand store supported ACM element types
ACM_Runtime -> ACM_Database: Set Participant State as ONLINE
Participant <- ACM_Runtime: Registration Accepted
ACM_Runtime -> ACM_Runtime: Mark all ACM Element Instances\nrunning on Participant as ONLINE
activate ACM_Runtime
deactivate ACM_Runtime
@enduml |
1.2 Deregister a Participant
Participant Deregistration is performed by a Participant when it shuts down. It deregisters its ID and type with the ACM runtime.
The participant should already have cleared down all its ACM Element instances and set their states to "Not In Service".
| PlantUML Macro |
|---|
@startuml
participant Participant
participant ACM_Runtime
database ACM_Database
Participant -> Participant: Uninitialize all ACM Element Instances running on Participant\n(See Instantiation Dialogues)
activate Participant
deactivate Participant
Participant -> ACM_Runtime: [ASYNC] Deregister
ACM_Runtime -> ACM_Database: Delete Participant Registration
ACM_Runtime -> ACM_Database: Set Participant State as OFFLINE
Participant <- ACM_Runtime: [ASYNC] Deregistration Accepted
ACM_Runtime -> ACM_Runtime: Mark all ACM Element Instances\nrunning on Participant as OFFLINE
activate ACM_Runtime
deactivate ACM_Runtime
@enduml |
1.3 Supervise Participants
Participant Supervision is performed periodically between participants and the ACM runtime server to ensure that registered participants are available over time. Participants send a heartbeat message to the ACM runtime at a configured interval.
The heartbeat message contains updated status information for each AC Element Instance that has changed status since the last Heartbeat message sent by the participant
| PlantUML Macro |
|---|
@startuml
participant Participant
participant ACM_Runtime
database ACM_Database
loop Every Participant Supervision Interval
Participant -> ACM_Runtime: [ASYNC] Heartbeat message including\nstatus and states of AC Element Instances on Participant
ACM_Runtime -> ACM_Database: Update Participant Heartbeat data
ACM_Runtime -> ACM_Database: Set Participant State as ONLINE
loop Every AC Element Instance in Heartbeat Message
ACM_Runtime -> ACM_Database: Mark AC Element Instance as ONLINE\nand Update AC Element Instance status
end
end
@enduml |
The ACM runtime regularly checks the heartbeat reports from participants and takes action if participants time out. If a heartbeat message is not received for a participant in the Timeout Interval, the participant is marked as timed out and its ACM element instances are informed.
| PlantUML Macro |
|---|
@startuml
participant ACM_Runtime
database ACM_Database
loop Every ACM_Runtime Supervision Interval
loop Over all Participants
ACM_Runtime -> Database: Read Participant Heartbeat Information
alt Participant Heartbeat not received in Timeout Interval
ACM_Runtime -> ACM_Database: Set Participant State as OFFLINE
ACM_Runtime -> ACM_Runtime: Mark all ACM Element Instances\nrunning on Participant as OFFLINE
activate ACM_Runtime
deactivate ACM_Runtime
end
end
end
@enduml |
1.4 Get Participant Information
The information on participants is available over a REST endpoint.
| PlantUML Macro |
|---|
@startuml
participant REST
participant ACM_Runtime
database ACM_Database
REST -> ACM_Runtime: Get Participant Information
ACM_Runtime -> ACM_Database: Read Participant Data
REST <- ACM_Runtime: Return Participant Information including\nsupported AC Element Types,\nAC Element Instances and their states\nand Heartbeat Information
@enduml |
1.5 Order Full Participant Report
A user can order a full participant report. Each participant responds with a heartbeat report immediately. This preempts the normal heartbeat period reporting and refreshes the status of AC Element Instances immediately.
| PlantUML Macro |
|---|
@startuml
participant REST
participant ACM_Runtime
participant Participants
REST -> ACM_Runtime: Order Participant Information
ACM_Runtime -> Participants: Issue immediate Heartbeat Report\n(See §1.3)
REST <- ACM_Runtime: Participant Information Ordered
@enduml |
2 Dialogues on Automation Composition Types
Commissioning dialogues are used to commission and decommission Automation Composition Types and to set the values of Common Parameters. The values of common parameters are included in the TOSCA YAML file that defines the full Automation Composition Type.
2.1 Commission or Update an Automation Composition Type
Create on a POST and update on a PUT.
| PlantUML Macro |
|---|
@startuml
participant REST
participant ACM_Runtime
database ACM_Database
REST -> ACM_Runtime: Commission Automation Composition Type
alt Automation Composition Type exists and has Instances
ACM_Runtime -> REST: Automation Composition Type Commissioning Failed
else
ACM_Runtime -> ACM_Database: Create and Store Automation Composition Type
ACM_Runtime -> ACM_Database: Set Automation Composition Type State to COMMISSIONED
ACM_Runtime -> REST: Automation Composition Type Commissioned
end
@enduml |
2.2 Commission an Automation Composition Type using SDC
| PlantUML Macro |
|---|
@startuml
participant SDC
participant Policy_Distribution
participant ACM_Runtime
SDC -> Policy_Distribution: [ASYNC] CSAR containing Automation Composition Type Definition
Policy_Distribution -> ACM_Runtime: Commission Automation Composition Type\n(See Commissioning Sequence Diagram)
Policy_Distribution <- ACM_Runtime: Result of Commissioning
Policy_Distribution -> SDC: [ASYNC] Return result of Deployment
@enduml |
2.3 Decommission an Automation Composition Type
| PlantUML Macro |
|---|
@startuml
participant REST
participant ACM_Runtime
database ACM_Database
REST -> ACM_Runtime: Decommission Automation Composition Type
alt Automation Composition Type is not in state COMMISSIONED
ACM_Runtime -> REST: Automation Composition Type Decommissioning Failed
else
ACM_Runtime -> ACM_Database: Delete Automation Composition Type
ACM_Runtime -> REST: Automation Composition Type Decommissioned
end
@enduml |
2.4 Prime an Automation Composition Type on Participants
The Priming operation sends Automation Composition Types and common property values to participants for each Automation Composition Element Type in the Automation Composition Type.
| PlantUML Macro |
|---|
@startuml
participant REST
participant ACM_Runtime
participant Participant
database ACM_Database
alt Automation Composition Type has Deployed Instances
REST <- ACM_Runtime: Priming of Automation Composition Type Failed, instances deployed
else Automation Composition Type is in state COMMISSIONED or PRIMED
REST -> ACM_Runtime: Prime Automation Composition Type
ACM_Runtime -> ACM_Database: Read Automation Composition Type
ACM_Runtime -> ACM_Database: Read Participants
ACM_Runtime -> ACM_Runtime: Set suitable participant ID on each AC Element Type
alt Was a sutable participant ID found for each AC Element Type?
ACM_Runtime -> Participant: [ASYNC] Send Priming Request to all Participants\nwith Automation Composition Type Definition
ACM_Runtime -> ACM_Database: Set Automation Composition Type State to PRIMING
REST <- ACM_Runtime: Priming of Automation Composition Type Ordered
else
REST <- ACM_Runtime: Priming of Automation Composition Type Faield, no sutiable participant found
end
else
REST <- ACM_Runtime: Priming of Automation Composition Type Failed, invalid state
end
@enduml |
A participant should respond for each Automation Composition Element Type, thus causing the full Automation Composition Type to become primed. Note that if more than one participant can support an Automation Composition Element Type the ACM Runtime uses the participant in the first response it receives for that Automation Composition Element Type.
| PlantUML Macro |
|---|
@startuml
participant ACM_Runtime
participant Participant
ACM_Runtime -> Participant: [ASYNC] Prime AC Element Types for this AC Type
loop over AC Element Types in AC Type
alt Does the primed Participant ID on this AC Element Type\nmatch my Participant ID
alt Does this AC Element Type already exist
ACM_Runtime <- Participant: [ASYNC] WARN: AC Element Type already exists
else
Participant -> Participant: Create AC Element Type
activate Participant
deactivate Participant
alt AC Element successfully created
ACM_Runtime <- Participant: [ASYNC] INFO: AC Element successfully primed
else
ACM_Runtime <- Participant: [ASYNC] ERROR: AC Element priming failed
end
end
else
note left of participant
ignore this AC Element Type as its for another participant
end note
end
end
@enduml |
The ACM Runtime updates the priming information in the database.
| PlantUML Macro |
|---|
@startuml
participant ACM_Runtime
participant Participant
database ACM_Database
ACM_Runtime <- Participant: [ASYNC] Result of Priming of AC Element Type
ACM_Runtime -> ACM_Database: Record result of AC Element Type Priming
alt Is AC Element Type Primed?
alt Have all the other AC Element Types in this AC Type been Primed?
ACM_Runtime -> ACM_Runtime: Set AC Type state as PRIMED
end
end
@enduml |
2.5 Deprime an Automation Composition Type on Participants
The Depriming operation removes Automation Composition Types and common property values on participants for each Automation Composition Element Type in the Automation Composition Type.
| PlantUML Macro |
|---|
@startuml
participant REST
participant ACM_Runtime
participant Participant
database ACM_Database
alt Automation Composition Type has Instances
REST <- ACM_Runtime: Depriming of Automation Composition Type Failed
else AC Type State is PRIMED or PRIMING
REST -> ACM_Runtime: Deprime Automation Composition Type
ACM_Runtime -> ACM_Database: Read Automation Composition Type
ACM_Runtime -> Participant: [ASYNC] Send Depriming Request to all Participants\nwith Automation Composition Type Definition
ACM_Runtime -> ACM_Database: Set Automation Composition Type State to DEPRIMING
REST <- ACM_Runtime: Depriming of Automation Composition Type Ordered
else
REST <- ACM_Runtime: Depriming of Automation Composition Type Failed, invalid state
end
@enduml |
A participant should respond for each Automation Composition Element Type, thus causing the full Automation Composition Type to become deprimed.
| PlantUML Macro |
|---|
@startuml
participant ACM_Runtime
participant Participant
ACM_Runtime -> Participant: [ASYNC] Deprime AC Element Types for this AC Type
loop over AC Element Types in AC Type
alt Does the deprimed Participant ID on this AC Element Type\nmatch my Participant ID
alt Does this AC Element Type Exist
Participant -> Participant: Delete AC Element Type
activate Participant
deactivate Participant
note left of Participant
Deletion of an AC Element Type always returns success
end note
ACM_Runtime <- Participant: [ASYNC] INFO: AC Element successfully primed
else
ACM_Runtime <- Participant: [ASYNC] WARN: AC Element Type is already deprimed
end
else
note left of Participant
ignore this AC Element Type as its for another participant
end note
end
end
@enduml |
The ACM Runtime updates the priming information in the database.
| PlantUML Macro |
|---|
@startuml
participant ACM_Runtime
participant Participant
database ACM_Database
ACM_Runtime <- Participant: [ASYNC] Result of Depriming of AC Element Type
ACM_Runtime -> ACM_Database: Record result of AC Element Type Depriming
alt Is AC Element Type Deprimed?
alt Have all the other AC Element Types in this AC Type been Deprimed?
ACM_Runtime -> ACM_Runtime: Set AC Type state as COMMISSIONED
end
end
@enduml |
2.6 Get Automation Composition Types
This dialogue allows an Automation Composition Type to be read.
| PlantUML Macro |
|---|
@startuml
participant REST
participant ACM_Runtime
database ACM_Database
REST -> ACM_Runtime: Get Automation Composition Type Information
ACM_Runtime -> ACM_Database: Read Automation Composition Type Information
ACM_Runtime -> REST: Respond with Automation Composition Type information\nincluding ACM Element Type information and Priming Status
@enduml |
3. Instantiation Dialogues
Instantiation dialogues are used to create, set parameters on, instantiate, update, and remove Automation Composition instances.
3.1 Create an Automation Composition Instance
| PlantUML Macro |
|---|
@startuml
participant REST
participant ACM_Runtime
database ACM_Database
REST -> ACM_Runtime: Create Automation Composition Instance for\nspecified Automation Composition Type with\nspecified parameter values
alt Automation Composition Instance exists
alt Automation Composition Instance is not in state UNDEPLOYED
ACM_Runtime -> REST: Automation Composition instance exists and is already deployed
else
note right of REST
Updates on "Not In Service" Automation Composition Instances are allowed
end note
end
end
alt Specified Automation Composition Type Exists
alt Specified Automation Composition Type is in state PRIMED
ACM_Runtime -> ACM_Database: Store Automation Composition Instance
ACM_Runtime -> ACM_Database: Set Automation Composition Instance State to UNDEPLOYED
ACM_Runtime -> REST: Automation Composition Instance Created
else
ACM_Runtime -> REST: Automation Composition Type is not in state PRIMED
end
else
ACM_Runtime -> REST: Automation Composition Type is not found
end
@enduml |
Note that this dialogue creates the Automation Composition Instance in the ACM database. The instance is sent to the participants using the process described in the dialogue in Section 3.3.
3.2 Delete an Automation Composition Instance
| PlantUML Macro |
|---|
@startuml
participant REST
participant ACM_Runtime
database ACM_Database
REST -> ACM_Runtime: Delete Automation Composition Instance
alt Automation Composition Instance exists
alt Automation Composition Instance is not in state UNDEPLOYED
ACM_Runtime -> REST: Automation Composition instance exists and is deployed
else
ACM_Runtime -> REST: Automation Composition instance does not exist
end
else
ACM_Runtime -> ACM_Database: Delete Automation Composition Instance
ACM_Runtime -> REST: Automation Composition Instance Deleted
end
@enduml |
3.3 Deploy Automation Composition Instance
The user requests the AC Instance to be deployed using a REST endpoint. The ACM Runtime orders the AC Instance to be deployed to Participants.
| PlantUML Macro |
|---|
@startuml
participant REST
participant ACM_Runtime
participant Participants
database ACM_Database
REST -> ACM_Runtime: Deploy Automation Composition Instance
ACM_Runtime -> ACM_Database: Read Automation Composition Instance Information
alt Automation Composition Instance exists
alt Automation Composition Instance is deployed
ACM_Runtime -> REST: Automation Composition instance is already deployed
else
ACM_Runtime -> Participants: [ASYNC] Deploy AC Element Instances for this AC Instance
ACM_Runtime -> ACM_Database: Set AC Instance and its AC Element Instances to state DEPLOYING
ACM_Runtime -> REST: Deployment of Automation Composition Instance has been requested
end
else
ACM_Runtime -> REST: Automation Composition instance does not exist
end
@enduml |
Each participant deploys its AC Element Instances from the AC Instance.
| PlantUML Macro |
|---|
@startuml
participant ACM_Runtime
participant Participant
participant Participant_API
ACM_Runtime -> Participant: [ASYNC] Deploy AC Element Instances for this AC Instance
loop over AC Element Instances in AC Instance
alt Does the primed Participant ID on this AC Element Instance\nmatch my Participant ID?
alt Is this AC Element Instance already deployed
ACM_Runtime <- Participant: [ASYNC] WARN: AC Element is already deployed
else
Participant -> Participant_API: Deploy AC Element Instance
activate Participant_API
Participant <- Participant_API: AC Element Instance Deploy Response
deactivate Participant_API
alt AC Element deployed successfully
Participant -> Participant: Set AC Element Instance administrative state to LOCKED
ACM_Runtime <- Participant: [ASYNC] INFO: AC Element has been deployed
else
ACM_Runtime <- Participant: [ASYNC] ERROR: AC Element was not deployed
end
end
else
note left of Participant
Ignore this AC Element instance as its for another participant
end note
end
end
@enduml |
The ACM Runtime receives and stores the responses.
| PlantUML Macro |
|---|
@startuml
participant ACM_Runtime
participant Participant
database ACM_Database
ACM_Runtime <- Participant: [ASYNC] Deploy Automation Composition Element Instance Response
ACM_Runtime -> ACM_Database: Store Automation Composition Element Instance Response Information
alt Is AC Element Instance Deployed?
ACM_Runtime -> ACM_Database: Set AC Element Instance State as DEPLOYED
alt Are all the other AC Element Instances in this AC Instance in state DEPLOYED?
ACM_Runtime -> ACM_Runtime: Set AC Instance state as DEPLOYED
end
end
@enduml |
3.4 Undeploy Automation Composition Instance
The user requests the AC Instance to be undeployed using a REST endpoint. The ACM Runtime orders the AC Instance to be undeployed.
| PlantUML Macro |
|---|
@startuml
participant REST
participant ACM_Runtime
participant Participants
database ACM_Database
REST -> ACM_Runtime: Undeploy Automation Composition Instance
ACM_Runtime -> ACM_Database: Read Automation Composition Instance Information
alt Automation Composition Instance exists
alt Automation Composition Instance administrative state is not LOCKED
ACM_Runtime -> REST: Automation Composition instance exists and is not LOCKED
else
ACM_Runtime -> REST: Automation Composition instance does not exist
end
else
ACM_Runtime -> Participants: [ASYNC] Undeploy AC Element Instances for this AC Instance
ACM_Runtime -> ACM_Database: Mark this AC Instance and its AC Element Instances as UNDEPLOYING
ACM_Runtime -> REST: Undeployment of Automation Composition Instance has been requested
end
@enduml |
Each participant undeploys its AC Element Instances from the AC Instance
| PlantUML Macro |
|---|
@startuml
participant ACM_Runtime
participant Participant
participant Participant_API
ACM_Runtime -> Participant: [ASYNC] Undeploy AC Element Instances for this AC Instance
loop over AC Element Instances in AC Instance
alt Does the primed Participant ID on this AC Element Instance\nmatch my Participant ID?
alt Does this AC Element Instance exist?
ACM_Runtime <- Participant: [ASYNC] WARN: AC Element does not exist
else Is this administrative state of this AC Element Instance LOCKED
Participant -> Participant_API: Undeploy AC Element Instance
activate Participant_API
Participant <- Participant_API: Undeploy AC Element Instance Response
deactivate Participant_API
ACM_Runtime <- Participant: [ASYNC] INFO: AC Element undeployed successfully
note left of Participant
Undeploy always returns success
end note
else
ACM_Runtime <- Participant: [ASYNC] WARN: AC Element is already undeployed
end
else
note left of Participant
Ignore this AC Element instance as its for another participant
end note
end
end
@enduml |
The ACM Runtime receives and stores the responses.
| PlantUML Macro |
|---|
@startuml
participant ACM_Runtime
participant Participant
database ACM_Database
ACM_Runtime <- Participant: [ASYNC] Undeploy Automation Composition Element Instance Response
ACM_Runtime -> ACM_Database: Store Automation Composition Element Instance Response Information
alt Is AC Element Instance undeployed?
ACM_Runtime -> ACM_Database: Mark AC Element Instance as UNDEPLOYED
alt Are all the other AC Element Instances in this AC Instance in state UNDEPLOYED?
ACM_Runtime -> ACM_Runtime: Set AC Instance state as UNDEPLOYED
end
end
@enduml |
3.5 Read Automation Composition Instances
| PlantUML Macro |
|---|
@startuml
participant REST
participant ACM_Runtime
database ACM_Database
REST -> ACM_Runtime: Get Automation Composition Instance Information
ACM_Runtime -> ACM_Database: Read Automation Composition Instance Information
ACM_Runtime -> REST: Respond with Automation Composition Instance information\nincluding ACM Element Instance information\nand admin, operational, and usage state
@enduml |
3.6 Unlock Automation Composition Instance
The user requests the AC Instance to be unlocked using a REST endpoint. The ACM Runtime orders the AC Instance to be unlocked on Participants.
| PlantUML Macro |
|---|
@startuml
participant REST
participant ACM_Runtime
participant Participants
database ACM_Database
REST -> ACM_Runtime: Unlock Automation Composition Instance
ACM_Runtime -> ACM_Database: Read Automation Composition Instance Information
alt Automation Composition Instance exists
alt Automation Composition Instance administrative state is LOCKED
ACM_Runtime -> Participants: [ASYNC] Unlock AC Element Instances for this AC Instance
ACM_Runtime -> ACM_Database: Mark AC Instance and its AC Element Instances as Unlocking
ACM_Runtime -> REST: Unlocking of Automation Composition Instance has been requested
else
ACM_Runtime -> REST: Automation Composition instance is not locked
end
else
ACM_Runtime -> REST: Automation Composition instance does not exist
end
@enduml |
Each participant unlocks its AC Element Instances from the AC Instance.
| PlantUML Macro |
|---|
@startuml
participant ACM_Runtime
participant Participant
participant Participant_API
ACM_Runtime -> Participant: [ASYNC] Unlock AC Element Instances for this AC Instance
loop over AC Element Instances in AC Instance
alt Does the primed Participant ID on this AC Element Instance\nmatch my Participant ID?
alt Is this AC Element Instance administrative state not LOCKED
ACM_Runtime <- Participant: [ASYNC] WARN: AC Element is not LOCKED
else
Participant -> Participant_API: Unlock AC Element Instance
activate Participant_API
Participant <- Participant_API: Unlock AC Element Instance Response
deactivate Participant_API
alt AC Element unlocked successfully
Participant -> Participant: Set AC Element Instance administrative state to UNLOCKED
ACM_Runtime <- Participant: [ASYNC] INFO: AC Element has been unlocked
else
ACM_Runtime <- Participant: [ASYNC] ERROR: AC Element was not unlocked
end
end
else
note left of participant
Ignore this AC Element instance as its for another participant
end note
end
end
@enduml |
The ACM Runtime receives and stores the responses.
| PlantUML Macro |
|---|
@startuml
participant ACM_Runtime
participant Participant
database ACM_Database
ACM_Runtime <- Participant: [ASYNC] Unlock Automation Composition Element Instance Response
ACM_Runtime -> ACM_Database: Store Automation Composition Element Instance Response Information
alt Is AC Element Instance Unlocked?
ACM_Runtime -> ACM_Database: Set AC Element Instance administrative state as UNLOCKED
alt Have all the other AC Element Instances in this AC Instance been UNLOCKED?
ACM_Runtime -> ACM_Runtime: Set AC Instance administrative state as UNLOCKED
end
end
@enduml |
3.7 Lock Automation Composition Instance
The user requests the AC Instance to be locked using a REST endpoint. The ACM Runtime orders the AC Instance to be locked on Participants.
| PlantUML Macro |
|---|
@startuml
participant REST
participant ACM_Runtime
participant Participants
database ACM_Database
REST -> ACM_Runtime: Lock Automation Composition Instance
ACM_Runtime -> ACM_Database: Read Automation Composition Instance Information
alt Automation Composition Instance exists
alt Automation Composition Instance administrative state is UNLOCKED
ACM_Runtime -> Participants: [ASYNC] Lock AC Element Instances for this AC Instance
ACM_Runtime -> ACM_Database: Mark AC Instance and its AC Element Instances as Locking
ACM_Runtime -> REST: Locking of Automation Composition Instance has been requested
else
ACM_Runtime -> REST: Automation Composition instance is not unlocked
end
else
ACM_Runtime -> REST: Automation Composition instance does not exist
end
@enduml |
Each participant locks its AC Element Instances from the AC Instance.
| PlantUML Macro |
|---|
@startuml
participant ACM_Runtime
participant Participant
participant Participant_API
ACM_Runtime -> Participant: [ASYNC] Lock AC Element Instances for this AC Instance
loop over AC Element Instances in AC Instance
alt Does the primed Participant ID on this AC Element Instance\nmatch my Participant ID?
alt Is this AC Element Instance administrative state not UNLOCKED
ACM_Runtime <- Participant: [ASYNC] WARN: AC Element is not UNLOCKED
else
Participant -> Participant: Set AC Element Instance administrative state to SHUTTING_DOWN
Participant -> Participant_API: Lock AC Element Instance
activate Participant_API
Participant <- Participant_API: Lock AC Element Instance Response
deactivate Participant_API
alt AC Element locked successfully
Participant -> Participant: Set AC Element Instance administrative state to LOCKED
ACM_Runtime <- Participant: [ASYNC] INFO: AC Element has been locked
else
ACM_Runtime <- Participant: [ASYNC] ERROR: AC Element was not locked
end
end
else
note left of participant
Ignore this AC Element instance as its for another participant
end note
end
end
@enduml |
The ACM Runtime receives and stores the responses.
| PlantUML Macro |
|---|
@startuml
participant ACM_Runtime
participant Participant
database ACM_Database
ACM_Runtime <- Participant: [ASYNC] Lock Automation Composition Element Instance Response
ACM_Runtime -> ACM_Database: Store Automation Composition Element Instance Response Information
alt Is AC Element Instance Locked?
ACM_Runtime -> ACM_Database: Set AC Element Instance administrative state as LOCKED
alt Have all the other AC Element Instances in this AC Instance been LOCKED?
ACM_Runtime -> ACM_Runtime: Set AC Instance administrative state as LOCKED
end
end
@enduml |
3.8 Update Operational State on Automation Composition Instance
| PlantUML Macro |
|---|
@startuml
participant Participant_API
participant Participant
participant ACM_Runtime
Participant_API -> Participant_API: Perform Operation that Updates Operational State
activate Participant_API
deactivate Participant_API
Participant_API -> Participant: Operational State has been updated
Participant -> Participant: Update Operational State in ACM Element Instance
== Periodically with Heartbeat ==
Participant -> ACM_Runtime: [ASYNC] Heartbeat message including\nstatus and states of AC Element Instances on Participant
@enduml |
3.9 Update Usage State on Automation Composition Instance
| PlantUML Macro |
|---|
@startuml
participant Participant_API
participant Participant
participant ACM_Runtime
Participant_API -> Participant_API: Perform Operation that Updates Usage State
activate Participant_API
deactivate Participant_API
Participant_API -> Participant: Usage State has been updated
Participant -> Participant: Update Usage State in ACM Element Instance
== Periodically with Heartbeat ==
Participant -> ACM_Runtime: [ASYNC] Heartbeat message including\nstatus and states of AC Element Instances on Participant |
Commissioning dialogues are used to commission and decommission Automation Composition Type definitions and to set the values of Common Parameters.
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 ACM REST Interface
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 REST
participant CLAMP_Runtime
database Commissioned_ACM_Inventory
CLAMP_GUI -> CLAMP_Runtime: Commission Automation Composition Type Definition
ACM_Runtime -> Commissioned_ACM_Inventory: Store Automation Composition Type Definition
ACM_Runtime -> 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 -> 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 to de-instantiate
CLAMP_GUI -> CLAMP_Runtime: [REST] De-instantiate selected Automation Composition Instance on Participants
alt Selected Automation Composition Instance instantiated on Participants
CLAMP_Runtime -> Participants: [DMaaP] Update Participants to remove Automation Composition Instance
CLAMP_Runtime -> CLAMP_GUI: [REST] De-instantiation of Automation Composition Instance ordered on participants
else Selected Automation Composition Instance not instantiated on Participants
CLAMP_Runtime -> CLAMP_GUI: [REST] Automation Composition Instance not instantiated on participants
end
== Participant Responses ==
Participants -> CLAMP_Runtime: [DMaaP] Result of update of Automation Composition Instance on participant
CLAMP_Runtime -> Instantiated_ACM_Inventory: Store result of update 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 de-instantiation update underway on participants
CLAMP_Runtime -> Instantiated_ACM_Inventory: read result of Automation Composition updates from participants
alt Updates completed on all participants
CLAMP_Runtime -> Instantiated_ACM_Inventory: set Automation Composition Instance as de-instantiated on Participants
CLAMP_Runtime -> 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: 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 -> Instantiated_ACM_Inventory: Read all Automation Composition Instances
CLAMP_Runtime -> CLAMP_GUI: [REST] All Automation Composition Instances returned
CLAMP_GUI -> CLAMP_GUI: Select Automation Composition Instance to delete
CLAMP_GUI -> CLAMP_Runtime: [REST] Delete selected Automation Composition Instance
alt Selected Automation Composition Instance exists
CLAMP_Runtime -> Instantiated_ACM_Inventory: Delete Automation Composition instance
CLAMP_Runtime -> CLAMP_GUI: [REST] Automation Composition Instance deleted
else Selected Automation Composition Instance does not exist
CLAMP_Runtime -> CLAMP_GUI: [REST] Automation Composition Instance does not 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
CLAMP_Runtime -> Instantiated_ACM_Inventory: Read all Automation Composition 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 -> Instantiated_ACM_Inventory: Store Participant and Automation Composition Element Monitoring and Statistics report
alt Fault reported on Participant
CLAMP_Runtime -> CLAMP_Runtime: log fault on Participant
CLAMP_Runtime -> Instantiated_ACM_Inventory: Record fault on Participant
end
loop Over all Automation Composition Elements in Participant Report
alt Fault reported on Automation Composition Element
CLAMP_Runtime -> CLAMP_Runtime: log fault on Automation Composition Element and Automation Composition CLAMP_Runtime -> Instantiated_ACM_Inventory: Record fault on Automation Composition Element and Automation Composition end
end
@enduml |
3.2 Viewing of Monitoring Information
| PlantUML Macro |
|---|
@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
database Instantiated_ACM_Inventory
== Overview of all Automation Composition Instances ==
CLAMP_GUI -> CLAMP_Runtime: [REST] Read all Automation Composition Instances
CLAMP_Runtime -> Instantiated_ACM_Inventory: Read all Automation Composition Instances
CLAMP_Runtime -> CLAMP_GUI: [REST] All Automation Composition Instances returned
CLAMP_GUI -> CLAMP_GUI: Display overview of status of all Automation Composition Instances
== Details of a Automation Composition Instance ==
CLAMP_GUI -> CLAMP_Runtime: [REST] Read Automation Composition Elements for Automation Composition Instance
CLAMP_Runtime -> Instantiated_ACM_Inventory: Read Automation Composition Elements for Automation Composition Instance
CLAMP_Runtime -> CLAMP_GUI: [REST] Automation Composition Elements returned
CLAMP_GUI -> CLAMP_GUI: Display status of Automation Composition Elements in Automation Composition Instance
== Overview of all Participants ==
CLAMP_GUI -> CLAMP_Runtime: [REST] Read all participants
CLAMP_Runtime -> Instantiated_ACM_Inventory: Read all participants
CLAMP_Runtime -> CLAMP_GUI: [REST] All participants returned
CLAMP_GUI -> CLAMP_GUI: Display overview of status of all participants
== Details of a Participant ==
CLAMP_GUI -> CLAMP_Runtime: [REST] Read Automation Composition Elements for Participant
CLAMP_Runtime -> Instantiated_ACM_Inventory: Read Automation Composition Elements for Participant
CLAMP_Runtime -> CLAMP_GUI: [REST] Automation Composition Elements returned
CLAMP_GUI -> CLAMP_GUI: Display status of Automation Composition Elements in Participant
== Filtered Monitoring ==
CLAMP_GUI -> CLAMP_GUI: Set filter for Automation Composition Instances, Automation Composition Elements, and Participants
CLAMP_GUI -> CLAMP_Runtime: [REST] Read Automation Composition Elements that match filter
CLAMP_Runtime -> Instantiated_ACM_Inventory: Read Automation Composition Elements that match filter
CLAMP_Runtime -> CLAMP_GUI: [REST] Automation Composition Elements that match filter returned
CLAMP_GUI -> CLAMP_GUI: Display status of Automation Composition Elements that match filter
@enduml |
3.2 Viewing of Statistics
| PlantUML Macro |
|---|
@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
database Instantiated_ACM_Inventory
== Statistics of all Automation Composition Instances ==
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_GUI: [REST] Summary statistics for all Automation Composition Instances returned
CLAMP_GUI -> CLAMP_GUI: Display summary statistics for all Automation Composition Instances
== Statistics of a Automation Composition Instance ==
CLAMP_GUI -> CLAMP_Runtime: [REST] Read statistics for Automation Composition Elements for Automation Composition Instance
CLAMP_Runtime -> Instantiated_ACM_Inventory: Compile statistics for Automation Composition Elements for Automation Composition Instance
CLAMP_Runtime -> CLAMP_GUI: [REST] Statistics for Automation Composition Elements returned
CLAMP_GUI -> CLAMP_GUI: Display statistics for Automation Composition Elements in Automation Composition Instance
== Statistics of all Participants ==
CLAMP_GUI -> CLAMP_Runtime: [REST] Read summary statistics for all Automation Composition Instances
CLAMP_Runtime -> Instantiated_ACM_Inventory: Compile summary statistics for all Automation Composition Instances
CLAMP_Runtime -> CLAMP_GUI: [REST] Summary statistics for all Automation Composition Instances returned
CLAMP_GUI -> CLAMP_GUI: Display summary statistics for all Automation Composition Instances
== Statistics of a Participant ==
CLAMP_GUI -> CLAMP_Runtime: [REST] Read statistics for Automation Composition Elements for Participant
CLAMP_Runtime -> Instantiated_ACM_Inventory: Read statistics for Automation Composition Elements for Participant
CLAMP_Runtime -> CLAMP_GUI: [REST] Statistics for Automation Composition Elements returned
CLAMP_GUI -> CLAMP_GUI: Display statistics for Automation Composition Elements in Participant
== Filtered Statistics ==
CLAMP_GUI -> CLAMP_GUI: Set filter for Automation Composition Instances, Automation Composition Elements, and Participants
CLAMP_GUI -> CLAMP_Runtime: [REST] Read statistics for Automation Composition Elements that match filter
CLAMP_Runtime -> Instantiated_ACM_Inventory: Read statistics for Automation Composition Elements that match filter
CLAMP_Runtime -> CLAMP_GUI: [REST] Statistics for Automation Composition Elements that match filter returned
CLAMP_GUI -> CLAMP_GUI: Display statistics for Automation Composition Elements that match filter
@enduml |
3.3 Statistics Housekeeping
| PlantUML Macro |
|---|
@startuml
participant CLAMP_Runtime
database Instantiated_ACM_Inventory
== Automation Composition Instance Statistics ==
loop forever
CLAMP_Runtime -> Instantiated_ACM_Inventory: Read Automation Composition Instance Statistics
CLAMP_Runtime -> CLAMP_Runtime: Summarise Automation Composition Instance Statistics
CLAMP_Runtime -> Instantiated_ACM_Inventory: Store summarised Automation Composition Instance Statistics
CLAMP_Runtime -> Instantiated_ACM_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 -> Instantiated_ACM_Inventory: Store summarised Participant Statistics
CLAMP_Runtime -> Instantiated_ACM_Inventory: Delete Participant Statistics on which retention period has expired
end
@enduml |
4. Supervision Dialogues
Supervision dialogues are used to check the state of Automation Composition Instances and Participants.
4.1 Supervise Participants
| PlantUML Macro |
|---|
@startuml
participant CLAMP_Runtime
database Instantiated_ACM_Inventory
loop forever
CLAMP_Runtime -> Instantiated_ACM_Inventory: Read Participants
loop Over each Participant
alt Participant has not reported in last reporting window
CLAMP_Runtime -> CLAMP_Runtime: Log Participant as having missed a report
CLAMP_Runtime -> Instantiated_ACM_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_ACM_Inventory: Mark participant as being offline
end
else Participant has reported in last reporting window
CLAMP_Runtime -> Instantiated_ACM_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_ACM_Inventory: Mark participant as being online
end
end
end
end
@enduml |
4.2 Supervise Automation Compositions
| PlantUML Macro |
|---|
@startuml
participant CLAMP_Runtime
database Instantiated_ACM_Inventory
loop forever
CLAMP_Runtime -> Instantiated_ACM_Inventory: 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: Log Automation Composition Element as having missed a report
CLAMP_Runtime -> Instantiated_ACM_Inventory: Increment missed report counter on Automation Composition Element
else Automation Composition Element has reported in last reporting window
CLAMP_Runtime -> Instantiated_ACM_Inventory: Clear missed report counter on Automation Composition Element
end
alt Automation Composition Element in incorrect state in last reporting window
CLAMP_Runtime -> CLAMP_Runtime: Log Automation Composition Element as being in incorrect state
CLAMP_Runtime -> 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 -> CLAMP_Runtime: Log Automation Composition Element as being in correct state
CLAMP_Runtime -> Instantiated_ACM_Inventory: Record Automation Composition Element as being in correct state
end
end
alt Automation Composition Element reported fault in last reporting window
CLAMP_Runtime -> CLAMP_Runtime: Log Automation Composition Element as being faulty
CLAMP_Runtime -> Instantiated_ACM_Inventory: Record Automation Composition Element as being faulty
else Automation Composition Element did not report fault in last reporting window
alt Automation Composition Element reported fault on previous report
CLAMP_Runtime -> CLAMP_Runtime: Log Automation Composition Element fault as cleared
CLAMP_Runtime -> Instantiated_ACM_Inventory: Mark fault Automation Composition Element as being cleared
end
end
end
alt Automation Composition Element in Automation Composition Instance has exceeded alarm threshold on missed report counter
CLAMP_Runtime -> CLAMP_Runtime: Raise a Automation Composition Offline alarm on Automation Composition Instance
CLAMP_Runtime -> Instantiated_ACM_Inventory: Mark Automation Composition Instance as being offline
else No Automation Composition Element in Automation Composition Instance has exceeded alarm threshold on missed report counter
alt Automation Composition Instance marked as being offline
CLAMP_Runtime -> CLAMP_Runtime: Clear Automation Composition Instance Offline alarm on Automation Composition CLAMP_Runtime -> Instantiated_ACM_Inventory: Mark Automation Composition Instance as being online
end
end
alt Automation Composition Element in Automation Composition Instance in incorrect state in last reporting window
CLAMP_Runtime -> CLAMP_Runtime: Log Automation Composition Instance as being in incorrect state
CLAMP_Runtime -> Instantiated_ACM_Inventory: Record Automation Composition Instance as being in incorrect state
alt Automation Composition Element in Automation Composition Instance has exceeded alarm threshold on incorrect state reports
CLAMP_Runtime -> CLAMP_Runtime: Raise a Automation Composition Instance in Incorrect State alarm on Automation Composition Instance
CLAMP_Runtime -> Instantiated_ACM_Inventory: Mark Automation Composition Instance as being in an incorrect state
end
else No Automation Composition Element in incorrect state in last reporting window
alt Automation Composition Element in Automation Composition Instance was in incorrect state on previous report
CLAMP_Runtime -> CLAMP_Runtime: Log Automation Composition Instance as being in correct state
CLAMP_Runtime -> Instantiated_ACM_Inventory: Record Automation Composition Instance as being in correct state
alt Automation Composition Instance in Incorrect State alarm raised on Automation Composition Instance
CLAMP_Runtime -> CLAMP_Runtime: Clear 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 -> CLAMP_Runtime: Log Automation Composition Instance as being faulty
CLAMP_Runtime -> Instantiated_ACM_Inventory: Record Automation Composition Instance as being faulty
alt Automation Composition Element in Automation Composition Instance has exceeded alarm threshold on faulty reports
CLAMP_Runtime -> CLAMP_Runtime: Raise a Automation Composition Instance Faulty alarm on Automation Composition Instance
end
else No Automation Composition Element faulty in last reporting window
alt Automation Composition Element in Automation Composition Instance was faulty on previous report
CLAMP_Runtime -> CLAMP_Runtime: Log Automation Composition Instance as being fault free
CLAMP_Runtime -> Instantiated_ACM_Inventory: Record Automation Composition Instance as being fault free
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
end
end
end
end
end
@enduml |
