...
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 type 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: [ASYNC] 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 Registration Deregistration is performed by a Participant when it shuts down. It deregisters its ID and type with the ACM runtime. The ACM runtime reprimes any Automation Composition Types that use the participant type of the removed participant because the participants available to the Automation Composition Type have changed. It also triggers supervision of any AC instances using this particular participant so that the instance can be moved to another participant or can be marked as errored
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 -> ACM_RuntimeParticipant: Uninitialize [ASYNC]all Deregister
ACM_Runtime -> ACM_Database: Delete Participant RegistrationElement Instances running on Participant\n(See Instantiation Dialogues)
activate Participant
deactivate Participant
Participant <-> ACM_Runtime: [ASYNC] Deregistration Accepted
loop over all Automation Composition Type Definitions
alt This Automation Composition Type has the Participant Type of this Participant
ACM_Runtime ->Deregister
ACM_Runtime -> ACM_Database: Delete Participant Registration
ACM_Runtime -> ACM_Database: Set Participant State as OFFLINE
Participant <- ACM_Runtime: Trigger[ASYNC] Priming of this Automation Composition Type
end
end
loop over all Automation Composition Instances
alt This Automation Composition Instance uses this Participant
ACM_Runtime -> ACM_Runtime: Trigger supervision of this Automation Composition Instance
end
end
@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 Commissioning 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 -> REST: Automation Composition Type Commissioned
ACM_Runtime -> ACM_Runtime: Trigger Priming of Automation Composition Type
activate ACM_Runtime
deactivate ACM_Runtime
end
@enduml |
2.2 Commissioning 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 Decommissioning an Automation Composition Type Definition
PlantUML Macro |
---|
@startuml
participant REST
participant ACM_Runtime
database ACM_Database
REST -> ACM_Runtime: Decommission Automation Composition Type
alt Automation Composition Type has Instances
ACM_Runtime -> REST: Automation Composition Type Decommissioning Failed
else
ACM_Runtime -> REST: Automation Composition Type Definition Decommissioning Ordered
ACM_Runtime -> ACM_Runtime: Trigger Depriming of Automation Composition Type Definition
activate ACM_Runtime
deactivate ACM_Runtime
ACM_Runtime -> ACM_Database: Delete Automation Composition Type
end
@enduml |
2.4 Priming an Automation Composition Type Definition on Participants
The Priming operation sends Automation Composition Types and common property values to participants.
PlantUML Macro |
---|
@startuml
participant ACM_Runtime
participant Participant
database ACM_Database
ACM_Runtime -> ACM_Database: Read Automation Composition Type
ACM_Runtime -> Participant: [ASYNC] Send Priming Request to all Participants\nwith Automation Composition Type Definition
== Each Participant ==
ACM_Runtime -> Participant: [ASYNC] Receive Priming Request with Automation Composition Type Definition
alt Automation Composition Type uses this type of Participant
Participant -> Participant: Save Automation Composition Type details on this Participant
ACM_Runtime <- Participant: [ASYNC] Send Priming Response
else
note right of Participant
Ignore Priming Request
end note
end
@enduml |
2.5 De-Prime an Automation Composition Type Definition on Participants
This dialogue allows an Automation Composition Type to be de-primed.
PlantUML Macro |
---|
@startuml
participant ACM_Runtime
participant Participant
database ACM_Database
ACM_Runtime -> ACM_Database: Read Automation Composition Type
ACM_Runtime -> Participant: [ASYNC] Send Depriming Request to all Participants
== Each Participant ==
ACM_Runtime -> Participant: [ASYNC] Receive Depriming Request
alt Automation Composition Type uses this type of Participant
Participant -> Participant: Delete Automation Composition Type details on this Participant
ACM_Runtime <- Participant: [ASYNC] Send Depriming Response
else
note right of Participant
Ignore Depriming Request
end note
end
@enduml |
Warning |
---|
PAGE UPDATED TO HERE. |
3. Instantiation Dialogues
Instantiation dialogues are used to create, set parameters on, instantiate, update, and remove Automation Composition instances.
3.1 Creating an Automation Composition Instance
PlantUML Macro |
---|
@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
database ACM_Database database ACM_Database CLAMP_GUI -> CLAMP_Runtime: [REST] Read Automation Composition Type Definitions
CLAMP_Runtime -> ACM_Database: 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 -> ACM_Database: 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 -> ACM_Database: 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.
3.2 Updating Instance Specific Parameters on an Automation Composition Instance
PlantUML Macro |
---|
@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
database ACM_Database CLAMP_GUI -> CLAMP_Runtime: [REST] Read Automation Composition Instances
CLAMP_Runtime -> ACM_Database: 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 -> ACM_Database: 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 -> ACM_Database: Store New Version of Automation Composition Instance
CLAMP_Runtime -> CLAMP_GUI: [REST] Automation Composition Instance Updated
@enduml |
3.3 Updating an Automation Composition Instance with a Configuration on Participants
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 |
PlantUML Macro |
---|
@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
participant Participant
database ACM_Database CLAMP_GUI -> CLAMP_Runtime: [REST] Read all configuration versions of Automation Composition Instance
CLAMP_Runtime -> ACM_Database: 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 -> ACM_Database: 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 -> ACM_Database: StoreRead resultParticipant of update of configuration version of Automation Composition Instance on participant
== Supervision ==
loop forever
CLAMP_Runtime -> ACM_Database: Read Automation Composition Instances
loop over each Automation Composition Instance
alt Automation Composition Instance configuration version update underway on participants
CLAMP_Runtime -> ACM_Database: read result of Automation Composition updates from participants
alt Updates completed on all participants
CLAMP_Runtime -> ACM_Database: set configuration version of Automation Composition Instance as Instantiated on Participants
CLAMP_Runtime -> ACM_Database: 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
CLAMPData
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: setCreate configurationand versionStore Automation Composition Instance Instantiation as timed out on Participants
CLAMPType
ACM_Runtime -> CLAMPACM_RuntimeDatabase: LogSet error
Automation Composition Type State to COMMISSIONED
ACM_Runtime else Wait for updates to complete
end
end
else Automation Composition Instance configuration version update on participants not underway
end
end
end
@enduml |
...
-> 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 CLAMP_GUIREST
participant CLAMPACM_Runtime
participant Participant
database ACM_Database CLAMP_GUI -> CLAMP_Runtime: [REST] Read all Instantiated Automation Composition Instances
CLAMP_Runtime -> ACM_Database: Read all Instantiated Automation Composition Instances
CLAMP_Runtime
REST -> CLAMPACM_GUIRuntime: [REST] All InstantiatedDecommission Automation Composition Instances returned
CLAMP_GUI -> CLAMP_GUI: Select Type
alt Automation Composition InstanceType onis whichnot to changein state andCOMMISSIONED
specify new state
CLAMP_GUIACM_Runtime -> CLAMP_RuntimeREST: [REST] Change state of selected Automation Composition InstanceType onDecommissioning ParticipantsFailed
else
alt Selected Automation Composition Instance instantiated on Participants
CLAMP ACM_Runtime -> ParticipantsACM_Database: [DMaaP] Request change of state ofDelete Automation Composition InstanceType
CLAMPACM_Runtime -> CLAMP_GUIREST: [REST]Automation ChangeComposition ofType state of Automation Composition Instance ordered on participants
else Selected Automation Composition Instance not instantiated on Participants
CLAMP_Runtime -> CLAMP_GUI: [REST]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 InstanceType nothas instantiated on participants
end
== Participant Responses ==
Participants -> CLAMP_Runtime: [DMaaP] Result of State Change of Automation Composition Instance on participant
CLAMP_Runtime -> ACM_Database: Store result of State Change of Automation Composition Instance on participant
== Supervision ==
loop forever
CLAMP_Runtime -> ACM_Database: Read Automation Composition Instances
loop over each Automation Composition Instance
alt Automation Composition Instance State Change underway on participants
CLAMPDeployed 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_DatabaseRuntime: readSet resultsuitable ofparticipant AutomationID Compositionon Stateeach ChangeAC fromElement participantsType
alt Was a sutable participant ID altfound Updatesfor completedeach onAC allElement participantsType?
CLAMPACM_Runtime -> ACM_DatabaseParticipant: set[ASYNC] AutomationSend CompositionPriming InstanceRequest stateto asall changedParticipants\nwith onAutomation Participants
Composition Type Definition
CLAMPACM_Runtime -> ACM_Database: set overallSet Automation Composition InstanceType stateState asto changedPRIMING
REST <- ACM_Runtime: Priming of elseAutomation UpdatesComposition notType completedOrdered
else
REST <- ACM_Runtime: Priming altof Automation Composition InstanceType StateFaield, Changeno onsutiable participantsparticipant timedfound
outend
else
CLAMP_Runtime ->REST <- ACM_DatabaseRuntime: 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 |
3.5 De-instantiating an Automation Composition Instance from Participants
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 |
PlantUML Macro |
---|
@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
participant Participant
database ACM_Database CLAMP_GUI -> CLAMP_Runtime: [REST] Read all Instantiated Automation Composition Instances
CLAMP_Runtime -> ACM_Database: 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 -> ACM_Database: StoreRecord result of update of Automation Composition Instance on participant
== Supervision ==
loop forever
CLAMP 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_DatabaseRuntime: ReadSet AutomationAC CompositionType Instances
state as loopPRIMED
over each Automation Composition Instance
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 InstanceType de-instantiation update underway on participants
CLAMP_Runtime ->has Instances
REST <- ACM_DatabaseRuntime: readDepriming result of Automation Composition updatesType from participantsFailed
else AC Type State is PRIMED alt Updates completed on all participants
CLAMP_Runtime -> ACM_Database: set Automation Composition Instance as de-instantiated on Participants
CLAMPor PRIMING
REST -> ACM_Runtime: Deprime Automation Composition Type
ACM_Runtime -> ACM_Database: setRead overall Automation Composition Instance as de-instantiated
else Updates not completed
altType
ACM_Runtime -> Participant: [ASYNC] Send Depriming Request to all Participants\nwith Automation Composition Type Definition
ACM_Runtime -> ACM_Database: Set Automation Composition InstanceType de-instantiationState Update timed out on participants
CLAMP_Runtime ->to DEPRIMING
REST <- ACM_DatabaseRuntime: Depriming setof 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 |
3.6 Deleting an Automation Composition Instance
PlantUML Macro |
---|
@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
database ACM_Database CLAMP_GUI -> CLAMP_Runtime: [REST] Read all Automation Composition Instances
CLAMP_Runtime -> ACM_Database: 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 -> ACM_Database: 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 |
3.7 Reading Automation Composition Instances
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 |
PlantUML Macro |
---|
@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
database ACM_Database CLAMP_GUI -> CLAMP_Runtime: [REST] Read all Automation Composition Instances
CLAMP_Runtime -> ACM_Database: Read all Automation Composition Instances
CLAMP 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 -> CLAMPACM_GUIRuntime: Set [REST]AC AllType Automationstate Compositionas Instances returnedCOMMISSIONED
end
end
@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
2.6 Get Automation Composition Types
This dialogue allows an Automation Composition Type to be read.
PlantUML Macro |
---|
@startuml
participant CLAMP_RuntimeREST
participant ParticipantACM_Runtime
database ACM_Database Participant
REST -> ACM_Runtime: Get Automation Composition Type Information
ACM_Runtime -> CLAMPACM_RuntimeDatabase: [DMaaP] Participant andRead Automation Composition Element Monitoring and Statistics report
CLAMPType Information
ACM_Runtime -> ACM_DatabaseREST: StoreRespond Participant andwith Automation Composition Type information\nincluding ACM Element MonitoringType information and StatisticsPriming report
alt Fault reported on Participant
CLAMP_Runtime -> CLAMP_Runtime: logStatus
@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 fault on Participant
CLAMP_Runtime -> ACM_DatabaseRuntime: RecordCreate faultAutomation on Participant
end
loop Over all Composition Instance for\nspecified Automation Composition ElementsType inwith\nspecified Participantparameter Reportvalues
alt Fault reported on Automation Composition Element
CLAMP_Runtime -> CLAMP_Runtime: log fault on Composition Instance exists
alt Automation Composition Instance Elementis andnot Automationin Compositionstate UNDEPLOYED
CLAMPACM_Runtime -> ACM_DatabaseREST: Record fault on Automation Composition instance Elementexists and Automationis Composition end
end
@enduml |
3.2 Viewing of Monitoring Information
PlantUML Macro |
---|
@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
database ACM_Database == Overview of all Automation Composition Instances ==
CLAMP_GUI -> CLAMP_Runtime: [REST] Read allalready deployed
else
note right of REST
Updates on "Not In Service" Automation Composition Instances
CLAMP_Runtime -> ACM_Database: Read all are allowed
end note
end
end
alt Specified Automation Composition Type InstancesExists
CLAMP_Runtime -> CLAMP_GUI: [REST] Allalt Specified Automation Composition Instances returned
CLAMP_GUI -> CLAMP_GUI: Display overview of status of allType is in state PRIMED
ACM_Runtime -> ACM_Database: Store Automation Composition Instances
== Details of aInstance
ACM_Runtime -> ACM_Database: Set Automation Composition Instance ==
CLAMP_GUIState to UNDEPLOYED
ACM_Runtime -> CLAMP_Runtime: [REST] ReadREST: Automation Composition ElementsInstance forCreated
Automationelse
Composition Instance
CLAMPACM_Runtime -> ACM_DatabaseREST: Read Automation Composition Elements for Automation Composition Instance
CLAMP Type is not in state PRIMED
end
else
ACM_Runtime -> CLAMP_GUI: [REST] Automation Composition Elements returned
CLAMP_GUI -> CLAMP_GUI: Display status of Automation Composition Elements inREST: 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
== Overviewis ofnot allin Participantsstate ==
CLAMP_GUIUNDEPLOYED
ACM_Runtime -> CLAMP_Runtime: [REST] Read all participants
CLAMPREST: Automation Composition instance exists and is deployed
else
ACM_Runtime -> ACM_Database: Read all participants
CLAMPREST: Automation Composition instance does not exist
end
else
ACM_Runtime -> CLAMPACM_GUIDatabase: [REST]Delete AllAutomation participantsComposition returnedInstance
CLAMP ACM_GUIRuntime -> CLAMP_GUIREST: DisplayAutomation overviewComposition 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
ACMof status of all participants
== Details of a Participant ==
CLAMP_GUI -> CLAMP_Runtime: [REST] Read Automation Composition Elements for Participant
CLAMP_Runtime -> ACM_Database: Read Automation Composition Elements for Participant
CLAMP_Runtime -> CLAMP_GUI: [REST] Instance Information
alt Automation Composition ElementsInstance returnedexists
CLAMP_GUI -> CLAMP_GUI: Display status of alt Automation Composition ElementsInstance in Participant
== Filtered Monitoring ==
CLAMP_GUIis deployed
ACM_Runtime -> CLAMP_GUI: Set filter forREST: Automation Composition instance Instances,is Automationalready Composition Elements, and Participants
CLAMP_GUIdeployed
else
ACM_Runtime -> CLAMP_RuntimeParticipants: [RESTASYNC] ReadDeploy AC AutomationElement CompositionInstances Elementsfor thatthis matchAC filterInstance
CLAMP ACM_Runtime -> ACM_Database: Read Automation Composition Elements that match filter
CLAMP Set AC Instance and its AC Element Instances to state DEPLOYING
ACM_Runtime -> CLAMP_GUIREST: Deployment [REST]of Automation Composition ElementsInstance thathas matchbeen filter returned
CLAMP_GUIrequested
end
else
ACM_Runtime -> CLAMP_GUIREST: Display status of Automation Composition Elementsinstance thatdoes matchnot filterexist
end
@enduml |
...
Each participant deploys its AC Element Instances from the AC Instance.
PlantUML Macro |
---|
@startuml
participant CLAMPACM_GUIRuntime
participant CLAMP_RuntimeParticipant
databaseparticipant ACM_Database == Statistics of all Automation Composition Instances ==
CLAMP_GUIParticipant_API
ACM_Runtime -> CLAMP_RuntimeParticipant: [RESTASYNC] Deploy ReadAC summaryElement statisticsInstances for all Automation Composition Instances
CLAMP_Runtime -> ACM_Database: 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 -> ACM_Database: 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 -> ACM_Database: 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
CLAMPthis 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: Read statistics for Automation Composition Elements for Participant
CLAMPStore Automation Composition Element Instance Response Information
alt Is AC Element Instance Deployed?
ACM_Runtime -> CLAMPACM_GUIDatabase: [REST]Set StatisticsAC forElement AutomationInstance CompositionState Elementsas 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
ACMreturned
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 -> ACM_Database: 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 ACM_Database == Automation Composition Instance Statistics ==
loop forever
CLAMPInstance 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 -> ACM_DatabaseREST: Read Automation Composition instance Instancedoes not Statisticsexist
end
else
CLAMPACM_Runtime -> CLAMP_Runtime: Summarise Automation Composition Instance Statistics
CLAMPParticipants: [ASYNC] Undeploy AC Element Instances for this AC Instance
ACM_Runtime -> ACM_Database: Store summarised Automation Composition Instance Statistics
CLAMP Mark this AC Instance and its AC Element Instances as UNDEPLOYING
ACM_Runtime -> ACM_DatabaseREST: Undeployment Deleteof Automation Composition Instance Statisticshas on which retention period has expired
end
== Participant Statistics ==
loop forever
CLAMPbeen 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 -> ACM_DatabaseParticipant: Read[ASYNC] ParticipantUndeploy Statistics
AC Element CLAMP_Runtime -> CLAMP_Runtime: Summarise Participant Statistics
CLAMP_Runtime -> ACM_Database: Store summarised Participant Statistics
CLAMP_Runtime -> ACM_Database: 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
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 |
PlantUML Macro |
---|
@startuml
participant CLAMP_Runtime
database ACM_Database loop forever
CLAMP_Runtime -> ACM_Database: 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 -> ACM_Database: 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 -> ACM_Database: Mark participant as being offline
end
else Participant has reported in last reporting window
CLAMP_Runtime -> ACM_Database: Clear missed report counter on Participant
alt Participant marked as being offline
CLAMP_Runtime -> CLAMP_Runtime: Clear Participant Offline alarm on participant
CLAMP_Runtime -> ACM_Database: Mark participant as being online
end
end
end
end
@enduml |
...
3.
...
5 Read Automation Composition Instances
PlantUML Macro |
---|
@startuml
participant REST
participant CLAMPACM_Runtime
database ACM_Database loop forever
CLAMP_Runtime
REST -> ACM_DatabaseRuntime: ReadGet 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 Information
ACM_Runtime -> ACM_Database: Read Automation Composition Instance Information
ACM_Runtime -> CLAMP_RuntimeREST: LogRespond with Automation Composition Instance information\nincluding ACM Element as having missed a report
CLAMP_Runtime -> ACM_Database: Increment missed report counter on Automation Composition Element
else Automation Composition Element has reported in last reporting window
CLAMPInstance 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: Clear missed report counter onRead Automation Composition Instance ElementInformation
alt Automation Composition Instance end
exists
alt Automation Composition ElementInstance inadministrative incorrect state in last reporting windowis LOCKED
CLAMPACM_Runtime -> CLAMP_RuntimeParticipants: Log[ASYNC] AutomationUnlock CompositionAC Element asInstances beingfor inthis incorrectAC stateInstance
CLAMPACM_Runtime -> ACM_Database: Mark RecordAC AutomationInstance Compositionand Elementits asAC beingElement inInstances incorrectas stateUnlocking
ACM_Runtime -> REST: Unlocking elseof Automation Composition ElementInstance nothas inbeen incorrect state in last reporting windowrequested
else
ACM_Runtime -> alt REST: Automation Composition Elementinstance wasis innot incorrect state on previous report
CLAMPlocked
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 -> CLAMP_RuntimeParticipant: Log[ASYNC] AutomationUnlock CompositionAC Element Instances asfor beingthis inAC correctInstance state
loop over CLAMP_Runtime -> ACM_Database: Record Automation Composition Element as beingAC Element Instances in correctAC stateInstance
alt Does the primed Participant ID on end
this end
AC Element Instance\nmatch my Participant ID?
alt Is Automationthis CompositionAC Element reportedInstance faultadministrative instate lastnot reporting windowLOCKED
CLAMPACM_Runtime <-> CLAMP_RuntimeParticipant: Log Automation Composition[ASYNC] WARN: AC Element asis beingnot faultyLOCKED
else
Participant CLAMP_Runtime -> ACMParticipant_DatabaseAPI: RecordUnlock AC AutomationElement CompositionInstance
Element as beingactivate faultyParticipant_API
Participant <- Participant_API: Unlock AC Element Instance elseResponse
Automation Composition Element did not report fault in last reporting windowdeactivate Participant_API
alt AC Element unlocked successfully
Participant -> Participant: Set alt AutomationAC Composition Element reportedInstance faultadministrative onstate previousto reportUNLOCKED
CLAMPACM_Runtime <-> CLAMP_RuntimeParticipant: Log Automation Composition[ASYNC] INFO: AC Element faulthas asbeen clearedunlocked
else
CLAMPACM_Runtime -> ACM_Database<- Participant: Mark fault Automation Composition[ASYNC] ERROR: AC Element aswas beingnot clearedunlocked
end
end
else
note left of endparticipant
Ignore this end
AC Element instance as altits Automationfor Compositionanother Elementparticipant in
Automation Compositionend Instance has exceeded alarm threshold on missed report counter
CLAMPnote
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 -> CLAMPACM_RuntimeDatabase: RaiseStore a Automation Composition OfflineElement alarmInstance on Automation Composition Instance
CLAMPResponse Information
alt Is AC Element Instance Unlocked?
ACM_Runtime -> ACM_Database: MarkSet AutomationAC CompositionElement Instance administrative state as being offlineUNLOCKED
alt elseHave 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 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 -> ACM_Database: MarkRead Automation Composition Instance as being online
end
end
Information
alt Automation Composition Element in Automation Composition Instance in incorrect state in last reporting window
CLAMPexists
alt Automation Composition Instance administrative state is UNLOCKED
ACM_Runtime -> CLAMP_RuntimeParticipants: Log[ASYNC] AutomationLock CompositionAC InstanceElement asInstances beingfor inthis incorrectAC stateInstance
CLAMPACM_Runtime -> ACM_Database: RecordMark AC AutomationInstance Compositionand Instanceits asAC beingElement inInstances incorrectas stateLocking
ACM_Runtime -> REST: Locking altof Automation Composition Element in Instance has been requested
else
ACM_Runtime -> REST: Automation Composition Instanceinstance hasis exceedednot alarm threshold on incorrect state reports
CLAMPunlocked
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 -> CLAMP_RuntimeParticipant: Raise a Automation Composition[ASYNC] Lock AC Element Instances for this AC Instance in
loop Incorrectover StateAC alarmElement onInstances Automationin CompositionAC Instance
alt Does the primed Participant ID on CLAMP_Runtime -> ACM_Database: 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 -> ACM_Database: 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
CLAMPthis 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: RecordSet AutomationAC CompositionElement Instance administrative state as being faultyLOCKED
alt Have all the other alt Automation Composition Element in Automation Composition Instance has exceeded alarm threshold on faulty reports
CLAMPAC Element Instances in this AC Instance been LOCKED?
ACM_Runtime -> CLAMPACM_Runtime: RaiseSet a AutomationAC Composition Instance Faultyadministrative alarmstate onas AutomationLOCKED
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_Runtimeend
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_DatabaseRuntime: Record[ASYNC] AutomationHeartbeat Compositionmessage Instanceincluding\nstatus asand beingstates faultof free
AC Element Instances on Participant
@enduml |
3.9 Update Usage State on Automation Composition Instance
PlantUML Macro |
---|
@startuml
participant Participant_API
participant 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
endParticipant
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
@enduml |