...
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: [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 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 UNINITIALIZED"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 ACM_RuntimeParticipant -> ACM_DatabaseRuntime: Delete [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 |
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 end @enduml 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 The ACM runtime regularly checks the heartbeat reports from participants and takes action of 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: InformMark all ACM Element Instances\nrunning on Participant of Timeout\n(See Instantiation Dialogues)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 ACMAC Element Types,\nAC Element Instances and their states\nand Heartbeat Information @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.
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
|
PlantUML Macro |
@startuml participant REST participant ACM_Runtime databaseparticipant ACM_DatabaseParticipants REST -> ACM_Runtime: CommissionOrder Automation Composition Type alt Automation Composition Type exists and has Instances Participant Information ACM_Runtime -> Participants: Issue immediate Heartbeat Report\n(See §1.3) REST <- ACM_Runtime: ->Participant REST: Automation Composition Type Commissioning Failed else ACM_Runtime -> ACM_Database: Create and Store Automation Composition Type ACM_Runtime -> REST: Automation Composition Type Commissioned 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 -> ACM_Database: Delete Automation Composition Type
ACM_Runtime -> REST: Automation Composition Type Decommissioned
end
@enduml |
2.4 Prime an Automation Composition Type Definition 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. 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 REST
participant ACM_Runtime
participant Participant
database ACM_Database
== Priming REST Request ==
REST -> ACM_Runtime: Prime Automation Composition Type
ACM_Runtime -> ACM_Database: Read Automation Composition Type
ACM_Runtime -> Participant: [ASYNC] Send Priming Request to all Participants\nwith Automation Composition Type Definition
REST <- ACM_Runtime: Priming of Automation Composition Type Ordered
== Each Participant ==
ACM_Runtime -> Participant: [ASYNC] Receive Priming Request with Automation Composition Type Definition
loop Over all Automation Composition Element Type Definitions\nin Automation Composition Type Definition
alt Automation Composition Element Type supported by Participant
Participant -> Participant: Save Automation Composition Element Type details on this Participant
ACM_Runtime <- Participant: [ASYNC] Send Priming Response claiming Automation Composition Element Type
alt Automation Composition Element Type already Primed
note right of Participant
Ignore Priming Response
end note
else
ACM_Runtime -> ACM_Database: Record Participant for Automation Composition Element Type\nand set Element Type as Primed
end
else
note right of Participant
Ignore Priming Request
end note
end
end |
2.5 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 information\nincluding ACM Element Type information and Priming Status
@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 REST
participant ACM_Runtime
database ACM_Database
REST -> ACM_Runtime: Create Automation Composition Instance for\nspecified Automation Composition Type with\nspecified parameter values
alt Specified Automation Composition Exists
alt Specified Automation Composition is Primed
ACM_Runtime -> ACM_Database: Store Automation Composition Instance
ACM_Runtime -> REST: [REST] Automation Composition Instance Created
else
ACM_Runtime -> REST: [REST] Automation Composition Type is not primed
end
else
ACM_Runtime -> REST: [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 Updating Instance Specific Parameters on an Automation Composition Instance
PlantUML Macro |
---|
@startuml
participant REST participant ACM_Runtime
database ACM_Database REST -> ACM_Runtime: [REST] Read Automation Composition Instances ACM_Runtime -> ACM_Database: Read Automation Composition Instances ACM_Runtime -> REST: [REST] Automation Composition Instances returned REST -> REST: Select Automation Composition Instance on which to Update Parameters REST -> REST: Step version of Automation Composition Instance as Major/Minor/Patch REST -> ACM_Runtime: [REST] Fetch GUI fields for Instance Specific Parameter Definitions ACM_Runtime -> ACM_Database: Read Automation Composition Type Definition ACM_Runtime -> ACM_Runtime: Generate fields for Instance Specific Parameters for GUI ACM_Runtime -> REST: [REST] Return GUI fields Instance Specific Parameter Definitions REST -> REST: Render UI for Instance Specific Parameters REST -> REST: Get values for Instance Specific Parameters from user REST -> ACM_Runtime: [REST] Request Update of Automation Composition Instance ACM_Runtime -> ACM_Runtime: Update Automation Composition Instance ACM_Runtime -> ACM_Database: Store New Version of Automation Composition Instance ACM_Runtime -> REST: [REST] Automation Composition Instance Updated
@enduml |
3.3 Updating an Automation Composition Instance with a Configuration on Participants
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 |
PlantUML Macro |
@startuml participant REST participant ACM_Runtime participant Participant database ACM_Database REST -> ACM_Runtime: [REST] Read all configuration versions of Automation Composition Instance ACM_Runtime -> ACM_Database: Read all configuration versions of Automation Composition Instance ACM_Runtime -> REST: [REST] All configuration versions of Automation Composition Instance returned REST -> REST: Select configuration version of Automation Composition Instance for Instantiation Participants REST -> ACM_Runtime: [REST] Instantiate selected configuration version of Automation Composition Instance on Participants alt Selected configuration version of Automation Composition Instance not instantiated on Participants ACM_Runtime -> ACM_Database: Read configuration version of Automation Composition Instance ACM_Runtime -> Participants: [DMaaP] Update Participants with configuration version of Automation Composition Instance ACM_Runtime -> REST: [REST] Instantiation of configuration version of Automation Composition Instance ordered on participants else Selected configuration version of Automation Composition Instance instantiated on Participants ACM_Runtime -> REST: [REST] configuration version of Automation Composition Instance already instantiated on participants end == Participant Responses == Participants -> ACM_Runtime: [DMaaP] Result of update of configuration version of Automation Composition Instance on participant ACM_Runtime -> ACM_Database: Store result of update of configuration version of Automation Composition Instance on participant == Supervision == loop forever ACM_Runtime -> ACM_Database: Read Automation Composition Instances loop over each Automation Composition Instance alt Automation Composition Instance configuration version update underway on participants ACM_Runtime -> ACM_Database: read result of Automation Composition updates from participants alt Updates completed on all participants ACM_Runtime -> ACM_Database: set configuration version of Automation Composition Instance as Instantiated on Participants ACM_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 ACM_Runtime -> ACM_Database: Set setAutomation configurationComposition versionType AutomationState Compositionto Instance Instantiation as timed out on Participants ACM_Runtime -> ACM_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 |
...
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 participant Participant database ACM_Database REST REST -> ACM_Runtime: [REST] Read all Instantiated Automation Composition Instances 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: Read all InstantiatedDelete Automation Composition InstancesType 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 [REST] All Instantiated Automation Composition Instances returned REST -> REST: Select Automation Composition InstanceType onFailed, whichinstances todeployed else changeAutomation stateComposition andType specifyis newin state COMMISSIONED or PRIMED REST -> ACM_Runtime: [REST] Change state of selected Prime Automation Composition Type ACM_Runtime -> ACM_Database: Read Automation Composition Instance on Participants alt Selected Automation Composition Instance instantiated on Participants ACM_Runtime -> Participants: [DMaaP] Request change of state of Automation Composition Instance 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 -> RESTParticipant: [RESTASYNC] Send Priming ChangeRequest ofto stateall ofParticipants\nwith Automation Composition Type Instance ordered on participants else SelectedDefinition ACM_Runtime -> ACM_Database: Set Automation Composition Type InstanceState notto instantiatedPRIMING on ParticipantsREST <- ACM_Runtime: ->Priming REST: [REST] of Automation Composition InstanceType not instantiated on participants end == Participant Responses == Participants ->Ordered else REST <- ACM_Runtime: [DMaaP] Result of State Change of Automation Composition Instance on participant ACM_Runtime -> ACM_Database: Store result of State ChangePriming of Automation Composition Type Faield, no sutiable participant found end else REST <- ACM_Runtime: Priming of Automation Composition Type InstanceFailed, on participant == Supervision == loop forever 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 -> ACM_DatabaseParticipant: Read[ASYNC] AutomationPrime CompositionAC Instances Element Types loopfor overthis eachAC AutomationType Composition Instance loop alt Automation Composition Instance State Change underway on participants ACM_Runtime -> ACM_Database: read result of Automation Composition State Change from participants alt Updates completed on all participants ACM_Runtime -> ACM_Database: set Automation Composition Instance state as changed on Participants ACM_Runtime -> ACM_Database: set overall Automation Composition Instance state as changed else Updates not completed alt Automation Composition Instance State Change on participants timed out ACM_Runtime -> ACM_Database: set Automation Composition State Change as timed out on Participants ACM_Runtime -> ACM_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
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 |
PlantUML Macro |
@startuml participant REST participant ACM_Runtime participant Participant database ACM_Database REST -> ACM_Runtime ACM_Runtime <- Participant: [RESTASYNC] ReadResult allof InstantiatedPriming Automationof CompositionAC InstancesElement Type ACM_Runtime -> ACM_Database: Record Readresult of allAC InstantiatedElement Automation Composition Instances ACM_Runtime -> REST: [REST] All Instantiated Automation Composition Instances returned REST -> REST: Select Automation Composition Instance to de-instantiate RESTType 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: [REST] De-instantiate selected Automation Composition Instance on Participants alt Selected Automation Composition Instance instantiated on Participants ACM_Runtime -> Participants: [DMaaP] Update Participants to remove Automation Composition Instance ACM_Runtime -> REST: [REST] De-instantiationSet 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 Instance ordered on participantsType Failed else SelectedAC AutomationType CompositionState Instanceis notPRIMED instantiatedor onPRIMING ParticipantsREST -> ACM_Runtime -> REST: [REST]Deprime Automation Composition Instance not instantiated on participants end == Participant Responses == ParticipantsType ACM_Runtime -> ACM_RuntimeDatabase: [DMaaP] Result of update ofRead Automation Composition Instance on participant Type ACM_Runtime -> ACM_Database: Store result of update ofParticipant: [ASYNC] Send Depriming Request to all Participants\nwith Automation Composition Instance on participant == Supervision == loop forever Type Definition ACM_Runtime -> ACM_Database: ReadSet Automation Composition Instances Type State loopto overDEPRIMING eachREST Automation Composition Instance alt<- ACM_Runtime: Depriming of Automation Composition Instance de-instantiation update underway on participants ACM_Runtime ->Type Ordered else REST <- ACM_DatabaseRuntime: read resultDepriming of Automation Composition updates from participants alt Updates completed on all participants ACM_Runtime -> ACM_Database: set Automation Composition Instance as de-instantiated on Participants ACM_Runtime -> ACM_Database: set overall Automation Composition Instance as de-instantiated else Updates not completed alt Automation Composition Instance de-instantiation Update timed out on participants ACM_Runtime -> ACM_Database: set Automation Composition Instance de-instantiation as timed out on Participants ACM_Runtime -> ACM_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
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
|
PlantUML Macro |
@startuml participant REST participant ACM_Runtime database ACM_Database REST -> ACM_Runtime: [REST] Read all Automation Composition Instances ACM_Runtime -> ACM_Database: Read all Automation Composition InstancesRecord 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 -> RESTACM_Runtime: [REST]Set AllAC AutomationType Compositionstate Instancesas returned REST -> REST: Select Automation Composition Instance to delete REST ->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: [REST] Delete selected Automation Composition Instance alt Selected database ACM_Database REST -> ACM_Runtime: Get Automation Composition InstanceType existsInformation ACM_Runtime -> ACM_Database: DeleteRead Automation Composition instanceType Information ACM_Runtime -> REST: [REST]Respond Automation Composition Instance deleted else Selected with Automation Composition InstanceType doesinformation\nincluding notACM existElement Type ACM_Runtime -> REST: [REST] Automation Composition Instance does not exist end @enduml |
...
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 REST -> ACM_Runtime: [REST] Read allCreate Automation Composition Instance for\nspecified Automation Composition Instances ACM_Runtime -> ACM_Database: Read all Automation Composition Instances Type with\nspecified parameter values alt Automation Composition Instance exists alt Automation Composition Instance is not in state UNDEPLOYED ACM_Runtime -> REST: [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 ACM_Runtime participant Participant database ACM_Database Participant -> ACM_Runtime: [DMaaP] Participant and Automation Composition instance exists and is already deployed else note right of REST Updates on "Not In Service" Automation Composition ElementInstances Monitoringare andallowed Statistics report ACM_Runtime -> ACM_Database: Store Participant and Automation Composition Element Monitoring and Statistics report alt Fault reported on Participant end note end end alt Specified Automation Composition Type Exists alt Specified Automation Composition Type is in state PRIMED ACM_Runtime -> ACM_RuntimeDatabase: logStore faultAutomation onComposition ParticipantInstance ACM_Runtime -> ACM_Database: Record fault on Participant end loop Over all -> ACM_Database: Set Automation Composition ElementsInstance inState Participantto ReportUNDEPLOYED alt Fault reported onACM_Runtime -> REST: Automation Composition Element Instance Created else ACM_Runtime -> ACM_RuntimeREST: logAutomation faultComposition onType Automationis Compositionnot Elementin andstate Automation Composition PRIMED end else ACM_Runtime -> ACM_Database: Record fault on REST: Automation Composition ElementType and Automation Composition is not found end 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 == Overview of all Automation Composition Instances == REST -> ACM_Runtime: [REST] Read all Automation Composition Instances ACM_RuntimeREST -> ACM_DatabaseRuntime: Read allDelete Automation Composition Instances ACM_Runtime -> REST: [REST] AllInstance alt Automation Composition Instance exists alt Automation Composition Instances returned REST Instance is not in state UNDEPLOYED ACM_Runtime -> REST: DisplayAutomation overviewComposition ofinstance statusexists ofand allis Automationdeployed Composition Instances == Details of aelse ACM_Runtime -> REST: Automation Composition Instance == RESTinstance does not exist end else ACM_Runtime -> ACM_RuntimeDatabase: [REST] Read Automation Composition Elements forDelete Automation Composition Instance ACM_Runtime -> ACM_DatabaseREST: Read Automation Composition Elements for Automation Composition Instance ACM_Runtime -> REST: [REST]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 Elements returned REST Instance ACM_Runtime -> RESTACM_Database: Display statusRead of Automation Composition Elements inInstance Information alt Automation Composition Instance exists == Overviewalt ofAutomation allComposition ParticipantsInstance ==is RESTdeployed -> ACM_Runtime: -> [REST]: ReadAutomation allComposition participantsinstance ACM_Runtime -> ACM_Database: Read all participantsis already deployed else ACM_Runtime -> RESTParticipants: [REST] All participants returned RESTASYNC] Deploy AC Element Instances for this AC Instance ACM_Runtime -> RESTACM_Database: DisplaySet overviewAC ofInstance statusand ofits all participants == Details of a Participant == RESTAC Element Instances to state DEPLOYING ACM_Runtime -> ACM_RuntimeREST: [REST]Deployment Readof Automation Composition Elements for Participant Instance has been requested end else ACM_Runtime -> ACM_DatabaseREST: Read Automation Composition Elements for Participant 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 -> RESTParticipant: [RESTASYNC] AutomationDeploy CompositionAC ElementsElement returnedInstances RESTfor ->this REST:AC DisplayInstance status loop ofover AutomationAC CompositionElement ElementsInstances in Participant == Filtered Monitoring == REST -> REST: Set filter for Automation Composition Instances, Automation Composition Elements, and Participants REST -> ACM_Runtime: [REST] Read Automation Composition Elements that match filterAC 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 -> ACM_Database: Read Automation Composition Elements that match filter ACM_Runtime<- Participant: [ASYNC] WARN: AC Element is already deployed else Participant -> REST: [REST] Automation Composition Elements that match filter returned REST -> REST: Display status of Automation Composition Elements that match filter @enduml |
3.2 Viewing of Statistics
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?
|
PlantUML Macro |
@startuml participant REST participant ACM_Runtime database ACM_Database == Statistics of all Automation Composition Instances == REST -> ACM_Runtime: [REST] Read summary statistics for all Automation Composition Instances ACM_Runtime -> ACM_Database: Compile summary statistics for all Automation Composition Instances ACM_Runtime -> REST: [REST] Summary statistics for all Automation Composition Instances returned REST -> REST: Display summary statistics for all Automation Composition Instances == Statistics of a Automation Composition Instance == REST -> ACM_Runtime: [REST] Read statistics for Automation Composition Elements for Automation Composition Instance ACM_Runtime -> ACM_Database: Compile statistics for Automation Composition Elements for Automation Composition Instance ACM_Runtime -> REST: [REST] Statistics for Automation Composition Elements returned REST -> REST: Display statistics for Automation Composition Elements in Automation Composition Instance == Statistics of all Participants == REST -> ACM_Runtime: [REST] Read summary statistics for all Automation Composition Instances ACM_Runtime -> ACM_Database: Compile summary statistics forSet AC Element Instance State as DEPLOYED alt Are all Automationthe Compositionother InstancesAC ACM_Runtime -> REST: [REST] Summary statistics for all Automation Composition Instances returned RESTElement Instances in this AC Instance in state DEPLOYED? ACM_Runtime -> RESTACM_Runtime: Set DisplayAC summaryInstance statisticsstate foras all Automation Composition Instances == Statistics of a Participant == 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: [REST] Read statistics forUndeploy Automation Composition Elements for Participant Instance ACM_Runtime -> ACM_Database: Read statistics for Automation Composition Elements for Participant ACM_Runtime -> REST: [REST] Statistics forInstance Information alt Automation Composition Instance exists alt Automation Composition ElementsInstance returnedadministrative RESTstate ->is REST: Display statistics for Automation Composition Elements in Participant == Filtered Statistics == RESTnot LOCKED ACM_Runtime -> REST: Set filter for Automation Composition Instances,instance Automationexists Compositionand Elements,is andnot ParticipantsLOCKED RESTelse -> ACM_Runtime: -> [REST] Read statistics for : Automation Composition Elementsinstance does thatnot match filterexist end else ACM_Runtime -> ACM_DatabaseParticipants: Read[ASYNC] statisticsUndeploy forAC AutomationElement CompositionInstances Elementsfor thatthis matchAC filterInstance ACM_Runtime -> RESTACM_Database: Mark [REST]this StatisticsAC forInstance Automationand Compositionits ElementsAC thatElement matchInstances filteras returned RESTUNDEPLOYING ACM_Runtime -> REST: DisplayUndeployment statisticsof for Automation Composition ElementsInstance thathas matchbeen filterrequested end @enduml |
...
Each participant undeploys its AC Element Instances from the AC Instance
PlantUML Macro |
---|
@startuml participant ACM_Runtime participant Participant databaseparticipant ACMParticipant_Database == Automation Composition Instance Statistics ==API ACM_Runtime -> Participant: [ASYNC] Undeploy AC Element Instances for this AC Instance loop foreverover AC ACM_Runtime -> ACM_Database: Read Automation Composition Instance Statistics ACM_Runtime -> ACM_Runtime: Summarise Automation Composition Instance Statistics ACM_Runtime -> ACM_Database: Store summarised Automation Composition Instance Statistics 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 <-> ACM_DatabaseParticipant: Delete Automation Composition Instance Statistics on which retention period has expired end == Participant Statistics == loop forever ACM_Runtime -> ACM_Database: Read Participant Statistics ACM_Runtime -> ACM_Runtime: Summarise Participant Statistics ACM_Runtime -> ACM_Database: Store summarised Participant Statistics ACM_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
[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
|
PlantUML Macro |
@startuml participant ACM_Runtime database ACM_Database loop forever ACM_Runtime -> ACM_Database: Read Participants loop Over each Participant alt Participant has not reported in last reporting window ACM_Runtime -> ACM_Runtime: Log Participant as having missed a report ACM_Runtime -> ACM_Database: Increment missed report counter on Participant alt Participant has exceeded alarm threshold on missed report counter ACM_Runtime -> ACM_RuntimeDatabase: RaiseStore aAutomation ParticipantComposition OfflineElement alarmInstance on participant Response Information alt Is AC Element Instance undeployed? ACM_Runtime -> ACM_Database: Mark AC Element participantInstance as being offlineUNDEPLOYED alt Are all the other end AC Element Instances in elsethis ParticipantAC has reportedInstance in last reporting window ACMstate UNDEPLOYED? ACM_Runtime -> ACM_Database: Clear missed report counter on Participant alt Participant marked as being offline ACM_Runtime 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 ClearAutomation ParticipantComposition OfflineInstance alarm on participant Information ACM_Runtime -> ACM_Database: Read Automation Composition Instance Information ACM_Runtime -> ACM_Database: Mark participant as being online end end end endREST: 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 database ACM_Database loop forever : Unlock Automation Composition Instance ACM_Runtime -> ACM_Database: 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 ACM_Runtime -> ACM_Runtime: LogInstance Information alt Automation Composition Instance Elementexists asalt havingAutomation missedComposition aInstance reportadministrative state is LOCKED ACMACM_Runtime -> ACM_DatabaseParticipants: Increment missed report counter on Automation Composition Element else Automation Composition Element has reported in last reporting window ACM[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 -> ACM_DatabaseREST: Clear missed report counter onUnlocking of Automation Composition Element Instance has been requested endelse ACM_Runtime alt-> REST: Automation Composition Elementinstance inis incorrectnot state in last reporting window locked end else ACM_Runtime -> ACM_RuntimeREST: Log Automation Composition Elementinstance asdoes being in incorrect state 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 -> ACM_DatabaseParticipant: Record[ASYNC] AutomationUnlock CompositionAC Element asInstances for beingthis inAC incorrectInstance state loop over AC Element Instances in elseAC AutomationInstance Compositionalt ElementDoes notthe inprimed incorrectParticipant stateID inon lastthis reportingAC window Element Instance\nmatch my Participant ID? alt Is Automationthis CompositionAC Element wasInstance in incorrectadministrative state on previous report not LOCKED ACM_Runtime <-> ACM_RuntimeParticipant: Log Automation Composition[ASYNC] WARN: AC Element asis beingnot inLOCKED correct stateelse ACM_Runtime Participant -> ACMParticipant_DatabaseAPI: RecordUnlock Automation CompositionAC Element asInstance being in correctactivate state Participant_API Participant end end <- Participant_API: Unlock AC Element Instance Response deactivate Participant_API alt AutomationAC Composition Element reportedunlocked faultsuccessfully in last reporting window ACM_Runtime Participant -> ACM_RuntimeParticipant: LogSet AutomationAC CompositionElement ElementInstance asadministrative beingstate faultyto UNLOCKED ACM_Runtime <-> ACM_DatabaseParticipant: Record Automation Composition Element as being faulty[ASYNC] INFO: AC Element has been unlocked else ACM_Runtime <- Participant: else Automation Composition[ASYNC] ERROR: AC Element didwas not reportunlocked fault inend last reportingend windowelse note left of participant altIgnore Automationthis CompositionAC Element reported fault on previous report 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 <-> ACM_RuntimeParticipant: Log[ASYNC] Unlock Automation Composition Element fault as cleared Instance Response ACM_Runtime -> ACM_Database: MarkStore fault Automation Composition Element asInstance beingResponse clearedInformation alt Is AC Element Instance Unlocked? ACM_Runtime end end end alt Automation Composition Element in -> 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 RESTAutomation Composition Instance has exceeded alarm threshold on missed report counter ACM_Runtime -> ACM_Runtime: Raise a Automation Composition Offline alarm on Automation Composition Instance ACM_Runtime -> ACM_Database: Mark Automation Composition Instance as being offline else No Automation Composition Element in Automation Composition Instance has exceeded alarm threshold on missed report counter Runtime: Lock Automation Composition Instance ACM_Runtime -> ACM_Database: Read Automation Composition Instance Information alt Automation Composition Instance marked as being offline exists alt Automation Composition Instance administrative state is UNLOCKED ACM_Runtime -> ACM_RuntimeParticipants: Clear[ASYNC] AutomationLock CompositionAC InstanceElement OfflineInstances alarmfor onthis Automation Composition AC Instance ACM_Runtime -> ACM_Database: Mark Automation CompositionAC Instance asand beingits online AC Element Instances as endLocking ACM_Runtime -> end REST: Locking of Automation altComposition AutomationInstance Compositionhas Elementbeen inrequested Automationelse Composition Instance in incorrect state in last reporting window ACM_Runtime -> REST: Automation Composition instance is not unlocked end else ACM_Runtime -> ACM_RuntimeREST: Log Automation Composition Instanceinstance asdoes 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 being in incorrect state ACM_Runtime -> ACM_Database: 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 ACM_Runtime -> ACM_Runtime: Raise a Automation Composition Instance in Incorrect State alarm on Automation Composition Instance ACM_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 ACM_Runtime -> ACM_Runtime: Log Automation Composition Instance as being in correct state ACM_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 ACM_Runtime -> ACM_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 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_RuntimeDatabase: LogStore Automation Composition Element Instance as being faulty 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 altAC AutomationElement Composition ElementInstances in Automationthis CompositionAC Instance has exceeded alarm threshold on faulty reports been LOCKED? ACM_Runtime -> ACM_Runtime: Raise a Automation CompositionSet AC 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 ACM_Runtime -> ACM_Runtime: Log Automation Composition Instance as being fault free ACM_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 ACM_Runtime -> ACM_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 |