...
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
...
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
Participant -> ACM_Runtime: [ASYNC] Deregister
ACM_Runtime -> ACM_Database: Delete Participant Registration
ACM_Runtime -> ACM_Database: Set Participant State as OFFLINE
Participant <- ACM_Runtime: [ASYNC] Deregistration Accepted
ACM_Runtime -> ACM_Runtime: Mark all ACM Element Instances\nrunning on Participant as OFFLINE
activate ACM_Runtime
deactivate ACM_Runtime
@enduml |
1.3 Supervise Participants
Participant Supervision is performed periodically between participants and the ACM runtime server to ensure that registered participants are available over time. Participants send a heartbeat message to the ACM runtime at a configured interval.
The heartbeat message contains updated status information for each AC Element Instance that has changed status since the last Heartbeat message sent by the participant
PlantUML Macro |
---|
@startuml
participant Participant
participant ACM_Runtime
database ACM_Database
loop Every Participant Supervision Interval
Participant -> ACM_Runtime: [ASYNC] Heartbeat message including\nstatus and states of AC Element Instances on Participant
ACM_Runtime -> ACM_Database: Update Participant Heartbeat data
end
@enduml |
The ACM runtime regularly checks the heartbeat reports from participants and takes action of 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: EverySet ACM_RuntimeParticipant SupervisionState Interval
loop Over all Participants
ACM_Runtime -> Database: Read Participant Heartbeat Information
alt Participant Heartbeat not received in Timeout Interval
as ONLINE
loop Every AC Element Instance in Heartbeat Message
ACM_Runtime -> ACM_RuntimeDatabase: InformMark all ACMAC Element Instances\nrunningInstance on Participant of Timeout\n(See Instantiation Dialogues)
activate ACM_Runtime
deactivate ACM_Runtime
end
end
end
@enduml |
1.4 Get Participant Information
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 informedThe information on participants is available over a REST endpoint.
PlantUML Macro |
---|
@startuml
participant REST
participant ACM_Runtime
database ACM_Database
RESTloop ->Every ACM_Runtime: Get Participant Information
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: ReadSet Participant State as Data
REST <-OFFLINE
ACM_Runtime -> ACM_Runtime: ReturnMark Participant Information including\nsupported all ACM Element TypesInstances\nrunning and 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 Commission or Update an Automation Composition Type
Create on a POST and update on a PUT.
PlantUML Macro |
---|
@startuml
participant REST
participant ACM_Runtime
database ACM_Database
REST -> ACM_Runtime: Commission Automation Composition Type
alt Automation Composition Type exists and has Instances
ACM_Runtime -> REST: Automation Composition Type Commissioning Failed
else
ACM_Runtime -> ACM_Database: Create and Store Automation Composition Type
ACM_Runtime -> REST: Automation Composition Type Commissioned
end
@enduml |
2.2 Commission an Automation Composition Type using SDC
PlantUML Macro |
---|
@startuml
participant SDC
participant Policy_Distribution
participant ACM_Runtime
SDC -> Policy_Distribution: [ASYNC] CSAR containing Automation Composition Type Definition
Policy_Distribution -> ACM_Runtime: Commission Automation Composition Type\n(See Commissioning Sequence Diagram)
Policy_Distribution <- ACM_Runtime: Result of Commissioning
Policy_Distribution -> SDC: [ASYNC] Return result of Deployment
@enduml |
2.3 Decommission an Automation Composition Type
PlantUML Macro |
---|
@startuml
participant REST
participant ACM_Runtime
database ACM_Database
REST -> ACM_Runtime: Decommission Automation Composition Type
alt Automation Composition Type 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 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
== 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
@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] Bring AC Element Instances for this AC Instance into Service
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 in service
ACM_Runtime <- Participant: [ASYNC] WARN: AC Element is already in service
else
Participant -> Participant: Bring AC Element Instance into Service
activate Participant
deactivate Participant
alt AC Element came into service successfully
ACM_Runtime <- Participant: [ASYNC] INFO: AC Element brought into service
else
ACM_Runtime <- Participant: [ASYNC] ERROR: AC Element was not brought into service
end
end
else
note left of participant
ignore this AC Element instance as its for another participant
end note
end
end
@enduml |
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 |
3. Instantiation Dialogues
Instantiation dialogues are used to create, set parameters on, instantiate, update, and remove Automation Composition instances.
3.1 Create or Update an Automation Composition Instance
Create on a POST and update on a PUT.
PlantUML Macro |
---|
@startuml
participant REST
participant ACM_Runtime
database ACM_Database
REST -> ACM_Runtime: Create Automation Composition Instance for\nspecified Automation Composition Type with\nspecified parameter values
alt Automation Composition Instance exists
alt Automation Composition Instance is not state UNINITIALIZED
ACM_Runtime -> REST: [REST] Automation Composition instance exists and is in use
else
note right of REST
Updates on uninitialized Automation Composition Instances are allowed
end note
end
end
alt Specified Automation Type Composition Exists
alt Specified Automation Composition Type 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 Delete an Automation Composition Instance
PlantUML Macro |
---|
@startuml
participant REST
participant ACM_Runtime
database ACM_Database
REST -> ACM_Runtime: Delete Automation Composition Instance
alt Automation Composition Instance exists
alt Automation Composition Instance is not state UNINITIALIZED
ACM_Runtime -> REST: [REST] Automation Composition instance exists and is in use
else
ACM_Runtime -> REST: [REST] Automation Composition instance does not exist
end
else
ACM_Runtime -> ACM_Database: Delete Automation Composition Instance
ACM_Runtime -> REST: [REST] Automation Composition Instance Deleted
end
@enduml |
3.3 Bring Automation Composition Instance into Service
The user requests the AC Instance to come into service using a REST endpoint. The ACM Runtime orders the AC Instance to come into service.
PlantUML Macro |
---|
@startuml
participant REST
participant ACM_Runtime
participant Participants
database ACM_Database
REST -> ACM_Runtime: [REST] Bring Automation Composition Instance into Service
ACM_Runtime -> ACM_Database: Read Automation Composition Instance Information
alt Automation Composition Instance exists
alt Automation Composition Instance is not state UNINITIALIZED
ACM_Runtime -> REST: [REST] Automation Composition instance exists and is already in service
else
ACM_Runtime -> REST: [REST] Automation Composition instance does not exist
end
else
ACM_Runtime -> Participants: [ASYNC] Bring AC Element Instances for this AC Instance into Service
ACM_Runtime -> ACM_Database: Set status of AC Instance and its AC Element Instances as "Coming into Service"
ACM_Runtime -> REST: Automation Composition Instance has been requested to come into service
end
@enduml |
Each participant brings its AC Element Instances from the AC Instance into service.
PlantUML Macro |
---|
@startuml
participant ACM_Runtime
participant Participant
ACM_Runtime -> Participant: [ASYNC] Bring AC Element Instances for this AC Instance into Service
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 in service
ACM_Runtime <- Participant: [ASYNC] WARN: AC Element is already in service
else
Participant -> Participant: Bring AC Element Instance into Service
activate Participant
deactivate Participant
alt AC Element came into service successfully
ACM_Runtime <- Participant: [ASYNC] INFO: AC Element brought into service
else
ACM_Runtime <- Participant: [ASYNC] ERROR: AC Element was not brought into service
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 Participants
database ACM_Database
ACM_RUNTIME -> ACM_Runtime: [REST] Bring Automation Composition Instance into Service
ACM_Runtime -> ACM_Database: Read Automation Composition Instance Information
alt Automation Composition Instance exists
alt Automation Composition Instance is not state UNINITIALIZED
ACM_Runtime -> REST: [REST] Automation Composition instance exists and is already in service
else
ACM_Runtime -> REST: [REST] Automation Composition instance does not exist
end
else
ACM_Runtime -> Participants: [ASYNC] Bring AC Element Instances for this AC Instance into Service
ACM_Runtime -> ACM_Database: Set status of AC Instance and its AC Element Instances as "Coming into Service"
ACM_Runtime -> REST: Automation Composition Instance has been requested to come into service
end
@enduml |
Warning |
---|
PAGE UPDATED TO HERE. |
3.4 Take Automation Composition Instance out of Service
on Participant as OFFLINE
activate ACM_Runtime
deactivate ACM_Runtime
end
end
end
@enduml |
1.4 Get Participant Information
The information on participants is available over a REST endpoint.
PlantUML Macro |
---|
@startuml
participant REST
participant ACM_Runtime
database ACM_Database
REST -> ACM_Runtime: Get Participant Information
ACM_Runtime -> ACM_Database: Read Participant Data
REST <- ACM_Runtime: Return Participant Information including\nsupported AC Element Types,\nAC Element Instances and their states\nand Heartbeat Information
@enduml |
1.5 Order Full Participant Report
A user can order a full participant report. Each participant responds with a heartbeat report immediately. This preempts the normal heartbeat period reporting and refreshes the status of AC Element Instances immediately.
PlantUML Macro |
---|
@startuml
participant REST
participant ACM_Runtime
participant Participants
REST -> ACM_Runtime: Order Participant Information
ACM_Runtime -> Participants: Issue immediate Heartbeat Report\n(See §1.3)
REST <- ACM_Runtime: Participant Information Ordered
@enduml |
2 Dialogues on Automation Composition Types
Commissioning dialogues are used to commission and decommission Automation Composition Types and to set the values of Common Parameters. The values of common parameters are included in the TOSCA YAML file that defines the full Automation Composition Type.
2.1 Commission or Update an Automation Composition Type
Create on a POST and update on a PUT.
PlantUML Macro |
---|
@startuml
participant REST
participant ACM_Runtime
database ACM_Database
REST -> ACM_Runtime: Commission Automation Composition Type
alt Automation Composition Type exists and has Instances
ACM_Runtime -> REST: Automation Composition Type Commissioning Failed
else
ACM_Runtime -> ACM_Database: Create and Store Automation Composition Type
ACM_Runtime -> ACM_Database: Set Automation Composition Type State to COMMISSIONED
ACM_Runtime -> REST: Automation Composition Type Commissioned
end
@enduml |
2.2 Commission an Automation Composition Type using SDC
PlantUML Macro |
---|
@startuml
participant SDC
participant Policy_Distribution
participant ACM_Runtime
SDC -> Policy_Distribution: [ASYNC] CSAR containing Automation Composition Type Definition
Policy_Distribution -> ACM_Runtime: Commission Automation Composition Type\n(See Commissioning Sequence Diagram)
Policy_Distribution <- ACM_Runtime: Result of Commissioning
Policy_Distribution -> SDC: [ASYNC] Return result of Deployment
@enduml |
2.3 Decommission an Automation Composition Type
PlantUML Macro |
---|
@startuml
participant REST
participant ACM_Runtime
database ACM_Database
REST -> ACM_Runtime: Decommission Automation Composition Type
alt Automation Composition Type is not in state COMMISSIONED
ACM_Runtime -> REST: Automation Composition Type Decommissioning Failed
else
ACM_Runtime -> ACM_Database: Delete Automation Composition Type
ACM_Runtime -> REST: Automation Composition Type Decommissioned
end
@enduml |
2.4 Prime an Automation Composition Type on Participants
The Priming operation sends Automation Composition Types and common property values to participants for each Automation Composition Element Type in the Automation Composition Type.
PlantUML Macro |
---|
@startuml
participant REST
participant ACM_Runtime
participant Participant
database ACM_Database
alt Automation Composition Type has Deployed Instances
REST <- ACM_Runtime: Priming of Automation Composition Type Failed, instances deployed
else Automation Composition Type is in state COMMISSIONED or PRIMED
REST -> ACM_Runtime: Prime Automation Composition Type
ACM_Runtime -> ACM_Database: Read Automation Composition Type
ACM_Runtime -> ACM_Database: Read Participants
|
PlantUML Macro |
---|
@startuml
participant REST participant ACM_Runtime
participant Participant
database ACM_Database REST -> ACM_Runtime: [REST] Read all Instantiated Automation Composition Instances ACM_Runtime -> ACM_Database: Read all Instantiated Automation Composition Instances ACM_Runtime -> REST: [REST] All Instantiated Automation Composition Instances returned REST -> REST: Select Automation Composition Instance on which to change state and specify new state REST -> ACM_Runtime: [REST] Change state of selected 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 ACM_Runtime -> REST: [REST] Change of state of Automation Composition Instance ordered on participants
else Selected Automation Composition Instance not instantiated on Participants ACM_Runtime -> REST: [REST] Automation Composition Instance not instantiated on participants
end
== Participant Responses ==
Participants -> ACM_Runtime: [DMaaP] Result of State Change of Automation Composition Instance on participant ACM_Runtime -> ACM_DatabaseRuntime: StoreSet resultsuitable ofparticipant StateID Changeon ofeach AutomationAC Composition Instance on participantElement Type
== alt Supervision ==
loop forever ACM_Runtime -> ACM_Database: Read Automation Composition Instances
loop over each Automation Composition Instance
alt Automation Composition Instance State Change underway on participants ACMWas a sutable participant ID found for each AC Element Type?
ACM_Runtime -> Participant: [ASYNC] Send Priming Request to all Participants\nwith Automation Composition Type Definition
ACM_Runtime -> ACM_Database: read result ofSet Automation Composition Type State Change from participantsto PRIMING
alt Updates completed on all participants ACM_Runtime ->REST <- ACM_DatabaseRuntime: Priming setof Automation Composition InstanceType stateOrdered
aselse
changed on Participants ACM_Runtime ->REST <- ACM_DatabaseRuntime: setPriming overallof 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
Type Faield, no sutiable participant found
end
else
REST <- ACM_Runtime: Priming of Automation Composition Type Failed, invalid state
end
@enduml |
A participant should respond for each Automation Composition Element Type, thus causing the full Automation Composition Type to become primed. Note that if more than one participant can support an Automation Composition Element Type the ACM Runtime uses the participant in the first response it receives for that Automation Composition Element Type.
PlantUML Macro |
---|
@startuml
participant ACM_Runtime
participant Participant
ACM_Runtime -> Participant: [ASYNC] Prime AC Element Types for this AC Type
loop over AC Element Types in AC Type
alt Does the primed Participant ID on this AC Element Type\nmatch my Participant ID
alt Does this AC Element Type already exist
ACM_Runtime <- Participant: [ASYNC] WARN: AC Element Type already exists
else
Participant -> Participant: Create AC Element Type
activate Participant
deactivate Participant
alt AC Element successfully created
ACM_Runtime <- Participant: [ASYNC] INFO: AC Element successfully primed
else
ACM_Runtime <- Participant: [ASYNC] ERROR: AC Element priming failed
end
end
else
note left of participant
ignore this AC Element Type as its for another participant
end note
end
end
@enduml |
The ACM Runtime updates the priming information in the database.
PlantUML Macro |
---|
@startuml
participant ACM_Runtime
participant Participant
database ACM_Database
ACM_Runtime <- Participant: [ASYNC] Result of Priming of AC Element Type
ACM_Runtime -> ACM_Database: Record result of AC Element Type Priming
alt Is AC Element Type Primed?
alt Have all the other AC Element Types in this AC Type been Primed?
ACM_Runtime -> ACM_Runtime: Set AC Type state as PRIMED
end
end
@enduml |
2.5 Deprime an Automation Composition Type on Participants
The Depriming operation removes Automation Composition Types and common property values on participants for each Automation Composition Element Type in the Automation Composition Type.
PlantUML Macro |
---|
@startuml
participant REST
participant ACM_Runtime
participant Participant
database ACM_Database
alt Automation Composition Type has Instances
REST <- ACM_Runtime: Depriming of Automation Composition Type Failed
else AC Type State is PRIMED or PRIMING
REST -> ACM_Runtime: Deprime Automation Composition Type
ACM |
PlantUML Macro |
---|
@startuml
participant REST participant ACM_Runtime
participant Participant
database ACM_Database REST -> ACM_Runtime: [REST] Read all Instantiated Automation Composition Instances ACM_Runtime -> ACM_Database: Read all Instantiated Automation Composition Instances ACM_Runtime -> REST: [REST] All Instantiated Automation Composition Instances returned REST -> REST: Select Automation Composition Instance to de-instantiate REST -> 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-instantiation of Automation Composition Instance ordered on participants
else Selected Automation Composition Instance not instantiated on Participants ACM_Runtime -> REST: [REST] Automation Composition Instance not instantiated on participants
end
== Participant Responses ==
Participants -> ACM_Runtime: [DMaaP] Result of update of Automation Composition Instance on participant ACM_Runtime -> ACM_Database: Store result of update 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 de-instantiation update underway on participants ACM_Runtime -> ACM_Database: read result ofRead Automation Composition updates from participants
alt Updates completed on all participants ACMType
ACM_Runtime -> Participant: [ASYNC] Send Depriming Request to all Participants\nwith Automation Composition Type Definition
ACM_Runtime -> ACM_Database: setSet 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 State to DEPRIMING
REST <- ACM_Runtime: Depriming of Automation Composition Type Ordered
else
REST <- ACM_Runtime: Depriming of Automation Composition Type Failed, invalid state
end
@enduml |
A participant should respond for each Automation Composition Element Type, thus causing the full Automation Composition Type to become deprimed.
PlantUML Macro |
---|
@startuml
participant ACM_Runtime
participant Participant
ACM_Runtime -> Participant: [ASYNC] Deprime AC Element Types for this AC Type
loop over AC Element Types in AC Type
alt Does the deprimed Participant ID on this AC Element Type\nmatch my Participant ID
alt Does this AC Element Type Exist
Participant -> Participant: Delete AC Element Type
activate Participant
deactivate Participant
note left of Participant
Deletion of an AC Element Type always returns success
end note
ACM_Runtime <- Participant: [ASYNC] INFO: AC Element successfully primed
else
ACM_Runtime <- Participant: [ASYNC] WARN: AC Element Type is already deprimed
end
else
note left of Participant
ignore this AC Element Type as its for another participant
end note
end
end
@enduml |
The ACM Runtime updates the priming information in the database.
PlantUML Macro |
---|
@startuml
participant ACM_Runtime
participant Participant
database ACM_Database
ACM_Runtime <- Participant: [ASYNC] Result of Depriming of AC Element Type
|
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 Instances ACM_Runtime -> REST: [REST] All Automation Composition Instances returned REST -> REST: Select Automation Composition Instance to delete REST -> ACM_Runtime: [REST] Delete selected Automation Composition Instance
alt Selected Automation Composition Instance exists ACM_Runtime -> ACM_Database: Delete Automation Composition instance ACM_Runtime -> REST: [REST] Automation Composition Instance deleted
else Selected Automation Composition Instance does not exist 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 -> RESTACM_Runtime: [REST]Set AutomationAC CompositionType Instancestate doesas notCOMMISSIONED
exist end
end
@enduml |
...
2.6 Get Automation Composition Types
This dialogue allows an Automation Composition Type to be read.
PlantUML Macro |
---|
@startuml
participant REST participant ACM_Runtime
database ACM_Database REST ->
participant ACM_Runtime: [REST] Read all Automation Composition Instances
database ACM_RuntimeDatabase
REST -> ACM_DatabaseRuntime: Read allGet Automation Composition Type InstancesInformation
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 ACM_Database: Read Automation Composition Type Information
ACM_Runtime -> REST: Respond with Automation Composition ElementType Monitoringinformation\nincluding andACM StatisticsElement reportType ACM_Runtime -> ACM_Database: Store Participant and Automation Composition Element Monitoring and Statistics report
alt Fault reported on Participant ACM_Runtime -> ACM_Runtime: log fault on Participant ACM_Runtimeinformation and Priming Status
@enduml |
3. Instantiation Dialogues
Instantiation dialogues are used to create, set parameters on, instantiate, update, and remove Automation Composition instances.
3.1 Create an Automation Composition Instance
PlantUML Macro |
---|
@startuml
participant REST
participant ACM_Runtime
database ACM_Database
REST -> ACM_Database: Record fault on Participant
end
loop Over all Automation Composition Elements in Participant Report
alt Fault reported onRuntime: Create Automation Composition Instance for\nspecified Automation Composition ElementType with\nspecified ACM_Runtime -> ACM_Runtime: log fault onparameter values
alt Automation Composition Instance exists
alt Automation Composition ElementInstance is andnot Automationin Compositionstate UNDEPLOYED
ACM_Runtime -> ACM_Database: Record fault onREST: Automation Composition instance Elementexists and Automation Composition end
end
@enduml |
3.2 Viewing of Monitoring Information
PlantUML Macro |
---|
@startuml
participant REST participant ACM_Runtime
database ACM_Database
== Overview of all is already deployed
else
note right of REST
Updates on "Not In Service" Automation Composition Instances == REST -> ACM_Runtime: [REST] Read allare allowed
end note
end
end
alt Specified Automation Composition Instances ACM_Runtime -> ACM_Database: Read all Automation Composition Instances Type Exists
alt Specified Automation Composition Type is in state PRIMED
ACM_Runtime -> RESTACM_Database: [REST] AllStore Automation Composition InstancesInstance
returned RESTACM_Runtime -> RESTACM_Database: DisplaySet overviewAutomation ofComposition statusInstance ofState allto AutomationUNDEPLOYED
Composition Instances
== Details of a ACM_Runtime -> REST: Automation Composition Instance == REST ->Created
else
ACM_Runtime: -> [REST] Read: Automation Composition Elements for Automation Composition Instance Type is not in state PRIMED
end
else
ACM_Runtime -> ACM_DatabaseREST: Read Automation Composition Type Elementsis for Automation Composition Instancenot 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 -> REST: [REST] Automation Composition Elements returned
database ACM_Database
REST -> RESTACM_Runtime: Delete DisplayAutomation status ofComposition Instance
alt Automation Composition Instance Elementsexists
inalt Automation Composition Instance
== Overview of all Participants == REST is not in state UNDEPLOYED
ACM_Runtime -> ACM_Runtime: [REST] Read all participantsREST: Automation Composition instance exists and is deployed
else
ACM_Runtime -> ACM_Database: Read all participantsREST: Automation Composition instance does not exist
end
else
ACM_Runtime -> RESTACM_Database: [REST]Delete AllAutomation participantsComposition returned RESTInstance
ACM_Runtime -> REST: DisplayAutomation overviewComposition of status of allInstance 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
participants
== Details of a Participant == REST -> ACM_Runtime: [REST] ReadDeploy Automation Composition Elements for Participant Instance
ACM_Runtime -> ACM_Database: Read Automation Composition Elements for Participant ACM_Runtime -> REST: [REST] Instance Information
alt Automation Composition ElementsInstance returned REST -> REST: Display status ofexists
alt Automation Composition ElementsInstance inis Participantdeployed
== Filtered Monitoring == REST ACM_Runtime -> REST: Set filter for Automation Composition Instances,instance Automationis Compositionalready Elements, and Participants RESTdeployed
else
ACM_Runtime -> ACM_RuntimeParticipants: [RESTASYNC] Deploy ReadAC Element AutomationInstances Compositionfor Elementsthis thatAC matchInstance
filter ACM_Runtime -> ACM_Database: Read Automation Composition Elements that match filter Set AC Instance and its AC Element Instances to state DEPLOYING
ACM_Runtime -> REST: Deployment [REST]of Automation Composition ElementsInstance has thatbeen match filter returned RESTrequested
end
else
ACM_Runtime -> REST: Display status of REST: Automation Composition Elementsinstance thatdoes matchnot filterexist
end
@enduml |
...
Each participant deploys its AC Element Instances from the AC Instance.
PlantUML Macro |
---|
@startuml
participant REST ACM_Runtime
participant Participant
participant Participant_API
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 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 Participant == REST -> ACM_Runtime: [REST] Read statistics for Automation Composition Elements for Participant ACM_Runtime -> ACM_Database: Read statistics for Automation Composition Elements for Participant -> Participant: [ASYNC] Deploy AC Element Instances for this AC Instance
loop over AC Element Instances in AC Instance
alt Does the primed Participant ID on this AC Element Instance\nmatch my Participant ID?
alt Is this AC Element Instance already deployed
ACM_Runtime <- Participant: [ASYNC] WARN: AC Element is already deployed
else
Participant -> Participant_API: Deploy AC Element Instance
activate Participant_API
Participant <- Participant_API: AC Element Instance Deploy Response
deactivate Participant_API
alt AC Element deployed successfully
Participant -> Participant: Set AC Element Instance administrative state to LOCKED
ACM_Runtime <- Participant: [ASYNC] INFO: AC Element has been deployed
else
ACM_Runtime <- Participant: [ASYNC] ERROR: AC Element was not deployed
end
end
else
note left of Participant
Ignore this AC Element instance as its for another participant
end note
end
end
@enduml |
The ACM Runtime receives and stores the responses.
PlantUML Macro |
---|
@startuml
participant ACM_Runtime
participant Participant
database ACM_Database
ACM_Runtime <- Participant: [ASYNC] Deploy Automation Composition Element Instance Response
ACM_Runtime -> ACM_Database: Store Automation Composition Element Instance Response Information
alt Is AC Element Instance Deployed?
ACM_Runtime -> ACM_Database: Set AC Element Instance State as DEPLOYED
alt Are all the other AC Element Instances in this AC Instance in state DEPLOYED?
ACM_Runtime -> RESTACM_Runtime: [REST]Set StatisticsAC forInstance Automationstate Compositionas 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
Elements returned REST -> REST: Display statistics for Automation Composition Elements in Participant
== Filtered Statistics == REST -> RESTACM_Runtime: Set filter forUndeploy Automation Composition Instances, Automation Composition Elements, and Participants RESTInstance
ACM_Runtime -> ACM_RuntimeDatabase: [REST] Read statistics for Automation Composition Elements that match filter ACM_Runtime -> ACM_Database: Read statistics for Automation Composition Elements that match filterInstance Information
alt Automation Composition Instance exists
alt Automation Composition Instance administrative state is not LOCKED
ACM_Runtime -> REST: [REST]Automation StatisticsComposition forinstance Automationexists Compositionand Elementsis thatnot matchLOCKED
filterelse
returned RESTACM_Runtime -> REST: Display statistics for Automation Composition Elementsinstance thatdoes matchnot filterexist
@enduml |
3.3 Statistics Housekeeping
PlantUML Macro |
---|
@startuml
participant end
else
ACM_Runtime
database ACM_Database
== Automation Composition Instance Statistics ==
loop forever -> Participants: [ASYNC] Undeploy AC Element Instances for this AC Instance
ACM_Runtime -> ACM_Database: ReadMark Automationthis CompositionAC Instance Statistics and its AC Element Instances as UNDEPLOYING
ACM_Runtime -> ACM_RuntimeREST: SummariseUndeployment of Automation Composition Instance has Statistics been requested
end
@enduml |
Each participant undeploys its AC Element Instances from the AC Instance
PlantUML Macro |
---|
@startuml
participant ACM_Runtime -> ACM_Database: Store summarised Automation Composition Instance Statistics
participant Participant
participant Participant_API
ACM_Runtime -> ACM_DatabaseParticipant: Delete[ASYNC] AutomationUndeploy CompositionAC InstanceElement StatisticsInstances onfor whichthis 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 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 <-> ACM_DatabaseParticipant: 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
ACM |
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_Runtime: Raise a Participant Offline alarm on participant ACM_Runtime -> ACM_Database: Mark participant as being offline
end
else Participant has reported in last reporting window ACM_Runtime -> ACM_Database: Store ClearAutomation missedComposition reportElement counterInstance onResponse ParticipantInformation
alt Is AC Element Instance undeployed?
ACM_Runtime alt Participant marked as being offline ACM_Runtime -> ACM_Runtime: Clear Participant Offline alarm on participant -> 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_DatabaseRuntime: MarkSet participantAC asInstance beingstate online
end
as UNDEPLOYED
end
end
end
@enduml |
...
3.
...
5 Read Automation Composition Instances
PlantUML Macro |
---|
@startuml
participant REST
participant ACM_Runtime
database ACM_Database
loop forever ACM_RuntimeREST -> ACM_DatabaseRuntime: ReadGet Automation Composition Instance Information Instances
ACM_Runtime loop Over each -> ACM_Database: Read Automation Composition Instance Information
loop Over each Automation Composition Element
alt Automation Composition Element has not reported in last reporting window ACM_RuntimeACM_Runtime -> REST: Respond with Automation Composition Instance information\nincluding ACM Element Instance information\nand admin, operational, and usage state
@enduml |
3.6 Unlock Automation Composition Instance
The user requests the AC Instance to be unlocked using a REST endpoint. The ACM Runtime orders the AC Instance to be unlocked on Participants.
PlantUML Macro |
---|
@startuml
participant REST
participant ACM_Runtime
participant Participants
database ACM_Database
REST -> ACM_Runtime: LogUnlock Automation Composition Element as having missed a report ACMInstance
ACM_Runtime -> ACM_Database: IncrementRead missedAutomation reportComposition counter onInstance Information
alt Automation Composition Instance Element
else Automation Composition Element has reported in last reporting window ACMexists
alt Automation Composition Instance administrative state is LOCKED
ACM_Runtime -> Participants: [ASYNC] Unlock AC Element Instances for this AC Instance
ACM_Runtime -> ACM_Database: ClearMark missedAC reportInstance counterand onits Automation CompositionAC Element
Instances as endUnlocking
ACM_Runtime -> REST: Unlocking altof Automation Composition ElementInstance inhas incorrectbeen state in last reporting window requested
else
ACM_Runtime -> ACM_RuntimeREST: Log Automation Composition Elementinstance asis beingnot in incorrect state locked
end
else
ACM_Runtime -> ACM_DatabaseREST: Record Automation Composition Elementinstance asdoes being in incorrect state
else Automation Composition Element not in incorrect state in last reporting window
alt Automation Composition Element was in incorrect state on previous report ACM_Runtime -> ACM_Runtime: Log Automation Composition Element as being in correct state ACM_Runtime -> ACM_Database: Record Automation Composition Element as being in correct state
end
end
alt Automation Composition Element reported fault in last reporting window ACM_Runtime -> ACM_Runtime: Log Automation Composition Element as being faulty ACM_Runtime -> ACM_Database: Record Automation Composition Element as being faulty
else Automation Composition Element did not report fault in last reporting window
alt Automation Composition Element reported fault on previous report ACM_Runtime -> ACM_Runtime: Log Automation Composition Element fault as cleared ACM_Runtime -> ACM_Database: Mark fault Automation Composition Element as being cleared
end
end
end
alt Automation Composition Element in Automation Composition Instance has exceeded alarm threshold on missed report counter not exist
end
@enduml |
Each participant unlocks its AC Element Instances from the AC Instance.
PlantUML Macro |
---|
@startuml
participant ACM_Runtime
participant Participant
participant Participant_API
ACM_Runtime -> Participant: [ASYNC] Unlock AC Element Instances for this AC Instance
loop over AC Element Instances in AC Instance
alt Does the primed Participant ID on this AC Element Instance\nmatch my Participant ID?
alt Is this AC Element Instance administrative state not LOCKED
ACM_Runtime <- Participant: [ASYNC] WARN: AC Element is not LOCKED
else
Participant -> Participant_API: Unlock AC Element Instance
activate Participant_API
Participant <- Participant_API: Unlock AC Element Instance Response
deactivate Participant_API
alt AC Element unlocked successfully
Participant -> Participant: Set AC Element Instance administrative state to UNLOCKED
ACM_Runtime <- Participant: [ASYNC] INFO: AC Element has been unlocked
else
ACM_Runtime <- Participant: [ASYNC] ERROR: AC Element was not unlocked
end
end
else
note left of participant
Ignore this AC Element instance as its for another participant
end note
end
end
@enduml |
The ACM Runtime receives and stores the responses.
PlantUML Macro |
---|
@startuml
participant ACM_Runtime
participant Participant
database ACM_Database
ACM_Runtime <- Participant: [ASYNC] Unlock Automation Composition Element Instance Response
ACM_Runtime -> ACM_Database: Store Automation Composition Element Instance Response Information
alt Is AC Element Instance Unlocked?
ACM_Runtime -> ACM_Runtime: Raise a Automation Composition Offline alarm on Automation Composition Instance 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_DatabaseRuntime: Set MarkAC AutomationInstance Compositionadministrative Instancestate 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: Lockbeing offline
else No Automation Composition Element in Automation Composition Instance has exceeded alarm threshold on missed report counter
ACM_Runtime -> ACM_Database: Read Automation Composition Instance Information
alt Automation Composition Instance exists
alt Automation Composition Instance markedadministrative asstate being offline 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 altof Automation Composition Element in Automation Composition Instance inhas incorrectbeen state in last reporting window requested
else
ACM_Runtime -> ACM_RuntimeREST: Log Automation Composition Instanceinstance asis beingnot in incorrect state unlocked
end
else
ACM_Runtime -> ACM_DatabaseREST: Record Automation Composition Instanceinstance asdoes 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 not exist
end
@enduml |
Each participant locks its AC Element Instances from the AC Instance.
PlantUML Macro |
---|
@startuml
participant ACM_Runtime
participant Participant
participant Participant_API
ACM_Runtime -> Participant: [ASYNC] Lock AC Element Instances for this AC Instance
loop over AC Element Instances in AC Instance
alt Does the primed Participant ID on this AC Element Instance\nmatch my Participant ID?
alt Is this AC Element Instance administrative state not UNLOCKED
ACM_Runtime <- Participant: [ASYNC] WARN: AC Element is not UNLOCKED
else
Participant -> Participant: Set AC Element Instance administrative state to SHUTTING_DOWN
Participant -> Participant_API: Lock AC Element Instance
activate Participant_API
Participant <- Participant_API: Lock AC Element Instance Response
deactivate Participant_API
alt AC Element locked successfully
Participant -> Participant: Set AC Element Instance administrative state to LOCKED
ACM_Runtime <- Participant: [ASYNC] INFO: AC Element has been locked
else
ACM_Runtime <- Participant: [ASYNC] ERROR: AC Element was not locked
end
end
else
note left of participant
Ignore this AC Element instance as its for another participant
end note
end
end
@enduml |
The ACM Runtime receives and stores the responses.
PlantUML Macro |
---|
@startuml
participant ACM_Runtime
participant Participant
database ACM_Database
ACM_Runtime <- Participant: [ASYNC] Lock Automation Composition Element Instance Response
ACM_Runtime -> ACM_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 Automation Composition Instance has exceeded alarm threshold on faulty reports this AC Instance 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: [ASYNC] RecordHeartbeat Automationmessage Compositionincluding\nstatus Instanceand asstates beingof faultAC free
Element Instances on Participant
@enduml |
3.9 Update Usage State on Automation Composition Instance
PlantUML Macro |
---|
@startuml
participant Participant_API
participant Participant
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
endACM_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 |