...
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
...
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 Participant Registration[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
...
PlantUML Macro |
---|
@startuml participant Participant participant ACM_Runtime database ACM_Database loop Every Participant Supervision Interval Participant -> ACM_Runtime: [ASYNC] Heartbeat message including\nstatus ofand states of AC Element Instances on Participant ACM_Runtime -> ACM_Database: Update Participant Heartbeat data ACM_Runtime -> ACM_Database: Set Participant State as ONLINE loop Every AC Element Instance in Heartbeat Message ACM_Runtime -> ACM_Database: Mark AC Element Instance as ONLINE\nand Update AC Element Instance status end end @enduml |
...
The ACM runtime regularly checks the heartbeat reports from participants and takes action 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: Mark all ACM Element Instances\nrunning on Participant as OfflineOFFLINE activate ACM_Runtime deactivate ACM_Runtime end end end @enduml |
...
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 Heartbeat their states\nand Heartbeat Information @enduml |
1.5 Order Full Participant Report
...
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 |
...
PlantUML Macro |
---|
@startuml participant REST participant ACM_Runtime database ACM_Database REST -> ACM_Runtime: Decommission Automation Composition Type alt Automation Composition Type has Instances 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 |
...
PlantUML Macro |
---|
@startuml participant REST participant ACM_Runtime participant Participant database ACM_Database == Priming REST Request == REST ->alt Automation Composition Type has Deployed Instances REST <- ACM_Runtime: Priming Primeof Automation Composition Type ACM_Runtime -> ACM_Database: Read Failed, instances deployed else Automation Composition Type ACM_Runtime is in state COMMISSIONED or PRIMED REST -> ParticipantACM_Runtime: Prime [ASYNC]Automation SendComposition Priming Request to all Participants\nwithType ACM_Runtime -> ACM_Database: Read Automation Composition Type Definition REST <- ACM_Runtime -> ACM_Database: Read Participants ACM_Runtime -> ACM_Runtime: PrimingSet ofsuitable Automationparticipant 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
...
ID on each AC Element Type
alt Was a sutable participant ID found for each AC Element Type?
ACM_Runtime -> Participant: [ASYNC] Send Priming Request to all Participants\nwith Automation Composition Type Definition
ACM_Runtime -> ACM_Database: Set Automation Composition Type State to PRIMING
REST <- ACM_Runtime: Priming of Automation Composition Type Ordered
else
REST <- ACM_Runtime: Priming of Automation Composition Type Faield, no sutiable participant found
end
else
REST <- ACM_Runtime: Priming of Automation Composition Type Failed, invalid state
end
@enduml |
A participant should respond for each Automation Composition Element Type, thus causing the full Automation Composition Type to become primed. Note that if more than one participant can support an Automation Composition Element Type the ACM Runtime uses the participant in the first response it receives for that Automation Composition Element Type.
PlantUML Macro |
---|
@startuml
participant ACM_Runtime
participant Participant
ACM_Runtime -> Participant: [ASYNC] Prime AC Element Types for this AC Type
loop over AC Element Types in AC Type
alt Does the primed Participant ID on this AC Element Type\nmatch my Participant ID
alt Does this AC Element Type already exist
ACM_Runtime <- Participant: [ASYNC] WARN: AC Element Type already exists
else
Participant -> Participant: Create AC Element Type
activate Participant
deactivate Participant
alt AC Element successfully created
ACM_Runtime <- Participant: [ASYNC] INFO: AC Element successfully primed
else
ACM_Runtime <- Participant: [ASYNC] ERROR: AC Element priming failed
end
end
else
note left of participant
ignore this AC Element Type as its for another participant
end note
end
end
@enduml |
The ACM Runtime updates the priming information in the database.
PlantUML Macro |
---|
@startuml
participant ACM_Runtime
participant Participant
database ACM_Database
ACM_Runtime <- Participant: [ASYNC] Result of Priming of AC Element Type
ACM_Runtime -> ACM_Database: Record result of AC Element Type Priming
alt Is AC Element Type Primed?
alt Have all the other AC Element Types in this AC Type been Primed?
ACM_Runtime -> ACM_Runtime: Set AC Type state as PRIMED
end
end
@enduml |
2.5 Deprime an Automation Composition Type on Participants
The Depriming operation removes Automation Composition Types and common property values on participants for each Automation Composition Element Type in the Automation Composition Type.
PlantUML Macro |
---|
@startuml
participant REST
participant ACM_Runtime
participant Participant
database ACM_Database
alt Automation Composition Type has Instances
REST <- ACM_Runtime: Depriming of Automation Composition Type Failed
else AC Type State is PRIMED or PRIMING
REST -> ACM_Runtime: Deprime Automation Composition Type
ACM_Runtime -> ACM_Database: Read Automation Composition Type
ACM_Runtime -> Participant: [ASYNC] Send Depriming Request to all Participants\nwith Automation Composition Type Definition
ACM_Runtime -> ACM_Database: Set Automation Composition Type State to DEPRIMING
REST <- ACM_Runtime: Depriming of Automation Composition Type Ordered
else
REST <- ACM_Runtime: Depriming of Automation Composition Type Failed, invalid state
end
@enduml |
A participant should respond for each Automation Composition Element Type, thus causing the full Automation Composition Type to become deprimed.
PlantUML Macro |
---|
@startuml
participant ACM_Runtime
participant Participant
ACM_Runtime -> Participant: [ASYNC] Deprime AC Element Types for this AC Type
loop over AC Element Types in AC Type
alt Does the deprimed Participant ID on this AC Element Type\nmatch my Participant ID
alt Does this AC Element Type Exist
Participant -> Participant: Delete AC Element Type
activate Participant
deactivate Participant
note left of Participant
Deletion of an AC Element Type always returns success
end note
ACM_Runtime <- Participant: [ASYNC] INFO: AC Element successfully primed
else
ACM_Runtime <- Participant: [ASYNC] WARN: AC Element Type is already deprimed
end
else
note left of Participant
ignore this AC Element Type as its for another participant
end note
end
end
@enduml |
The ACM Runtime updates the priming information in the database.
PlantUML Macro |
---|
@startuml
participant ACM_Runtime
participant Participant
database ACM_Database
ACM_Runtime <- Participant: [ASYNC] Result of Depriming of AC Element Type
ACM_Runtime -> ACM_Database: Record result of AC Element Type Depriming
alt Is AC Element Type Deprimed?
alt Have all the other AC Element Types in this AC Type been Deprimed?
ACM_Runtime -> ACM_Runtime: Set AC Type state as COMMISSIONED
end
end
@enduml |
2.6 Get Automation Composition Types
This dialogue allows an Automation Composition Type to be read.
PlantUML Macro |
---|
@startuml
participant REST
participant ACM_Runtime
database ACM_Database
REST -> ACM_Runtime: Get Automation Composition Type Information
ACM_Runtime -> ACM_Database: Read Automation Composition Type Information
ACM_Runtime -> REST: Respond with Automation Composition Type information\nincluding ACM Element Type information and Priming Status
@enduml |
3. Instantiation Dialogues
Instantiation dialogues are used to create, set parameters on, instantiate, update, and remove Automation Composition instances.
3.1 Create an Automation Composition Instance
PlantUML Macro |
---|
@startuml
participant REST
participant ACM_Runtime
database ACM_Database
REST -> ACM_Runtime: Create Automation Composition Instance for\nspecified Automation Composition Type with\nspecified parameter values
alt Automation Composition Instance exists
alt Automation Composition Instance is not in state UNDEPLOYED
ACM_Runtime -> REST: Automation Composition instance exists and is already deployed
else
note right of REST
Updates on "Not In Service" Automation Composition Instances are allowed
end note
end
end
alt Specified Automation Composition Type Exists
alt Specified Automation Composition Type is in state PRIMED
ACM_Runtime -> ACM_Database: Store Automation Composition Instance
ACM_Runtime -> ACM_Database: Set Automation Composition Instance State to UNDEPLOYED
ACM_Runtime -> REST: Automation Composition Instance Created
else
ACM_Runtime -> REST: Automation Composition Type is not in state PRIMED
end
else
ACM_Runtime -> REST: Automation Composition Type is not found
end
@enduml |
Note that this dialogue creates the Automation Composition Instance in the ACM database. The instance is sent to the participants using the process described in the dialogue in Section 3.3.
3.2 Delete an Automation Composition Instance
PlantUML Macro |
---|
@startuml participant REST participant ACM_Runtime database ACM_Database REST -> ACM_Runtime: GetDelete Automation Composition Type Information ACM_Runtime -> ACM_Database: ReadInstance alt Automation Composition Instance exists alt Automation Composition Type Information Instance is not in state UNDEPLOYED ACM_Runtime -> REST: Respond with: Automation Composition Typeinstance information\nincludingexists ACMand Elementis Typedeployed informationelse 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 RESTACM_Runtime -> REST: Automation Composition instance does not exist end else ACM_Runtime -> ACM_RuntimeDatabase: CreateDelete Automation Composition Instance for\nspecified ACM_Runtime -> REST: Automation Composition Instance Deleted end @enduml |
3.3 Deploy Automation Composition Instance
The user requests the AC Instance to be deployed using a REST endpoint. The ACM Runtime orders the AC Instance to be deployed to Participants.
PlantUML Macro |
---|
@startuml participant REST participant ACM_Runtime participant Participants database ACM_Database REST -> ACM_Runtime: Deploy Automation Composition Instance ACM_Runtime -> ACM_Database: Read Automation Composition Instance Information alt Automation Composition Instance exists alt Automation Composition Instance is deployedType with\nspecified parameter values alt Automation Composition Instance exists alt Automation Composition Instance is already deployed ACM_Runtime -> REST: Automation Composition instance exists and is already deployed else note right of REST Updates on "Not In Service" Automation Composition Instances are allowed end note end end alt Specified Automation Type Composition Exists alt Specified Automation Composition Type is Primed ACM_Runtime -> ACM_DatabaseREST: Store Automation Composition Instanceinstance is already deployed else ACM_Runtime -> RESTParticipants: Automation Composition Instance Created else [ASYNC] Deploy AC Element Instances for this AC Instance ACM_Runtime -> RESTACM_Database: Automation Composition Type is not primed end else Set AC Instance and its AC Element Instances to state DEPLOYING ACM_Runtime -> REST: Deployment of Automation Composition TypeInstance ishas notbeen foundrequested 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.
...
else
ACM_Runtime -> REST: Automation Composition instance does not exist
end
@enduml |
Each participant deploys its AC Element Instances from the AC Instance.
PlantUML Macro |
---|
@startuml participant RESTACM_Runtime participant ACM_RuntimeParticipant databaseparticipant ACMParticipant_DatabaseAPI RESTACM_Runtime -> ACM_RuntimeParticipant: Delete[ASYNC] AutomationDeploy Composition Instance alt Automation Composition Instance exists alt Automation Composition Instance is deployed ACM_Runtime -> REST: Automation Composition instance exists and is deployed else ACM_Runtime -> REST: Automation Composition instance does not exist end else ACM_Runtime -> ACM_Database: Delete Automation Composition Instance ACM_Runtime -> REST: Automation Composition Instance Deleted end @enduml |
3.3 Deploy Automation Composition Instance
The user requests the AC Instance to be deployed using a REST endpoint. The ACM Runtime orders the AC Instance to be deployed to Participants.
PlantUML Macro |
---|
@startuml
participant REST
participant ACM_Runtime
participant Participants
database ACM_Database
REST -> ACM_Runtime: Deploy Automation Composition Instance
ACM_Runtime -> ACM_Database: Read Automation Composition Instance Information
alt Automation Composition Instance exists
alt Automation Composition Instance is deployed
ACM_Runtime -> REST: Automation Composition instance is already deployed
else
ACM_Runtime -> REST: Automation Composition instance does not exist
end
else
ACM_Runtime -> Participants: [ASYNC] Deploy AC Element Instances for this AC Instance
ACM_Runtime -> ACM_Database: Mark AC Instance and its AC Element Instances as Deploying
ACM_Runtime -> REST: Deployment of Automation Composition Instance has been requested
end
@enduml |
Each participant deploys its AC Element Instances from the AC Instance.
PlantUML Macro |
---|
@startuml
participant ACM_Runtime
participant Participant
ACM_Runtime -> Participant: [ASYNC] Deploy AC Element Instances for this AC Instance
loop over AC Element Instances in AC Instance
alt Does the primed Participant ID on this AC Element Instance\nmatch my Participant ID?
alt Is this AC Element Instance already deployed
ACM_Runtime <- Participant: [ASYNC] WARN: AC Element is already deployed
else
Participant -> Participant: Deploy AC Element Instance
activate Participant
deactivate Participant
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 administrative state as LOCKED
alt Have all the other AC Element Instances in this AC Instance been deployed?
ACM_Runtime -> ACM_Runtime: Set AC Instance administrative state as LOCKED
end
end
@enduml |
3.4 Undeploy Automation Composition Instance
The user requests the AC Instance to be undeployed using a REST endpoint. The ACM Runtime orders the AC Instance to be undeployed.
PlantUML Macro |
---|
@startuml
participant REST
participant ACM_Runtime
participant Participants
database ACM_Database
REST -> ACM_Runtime: Undeploy Automation Composition Instance
ACM_Runtime -> ACM_Database: Read Automation Composition Instance Information
alt Automation Composition Instance exists
alt Automation Composition Instance administrative state is not LOCKED
ACM_Runtime -> REST: Automation Composition instance exists and is not LOCKED
else
ACM_Runtime -> REST: Automation Composition instance does not exist
end
else
ACM_Runtime -> Participants: [ASYNC] Undeploy AC Element Instances for this AC Instance
ACM_Runtime -> ACM_Database: Mark this AC Instance and its AC Element Instances as Undeploying
ACM_Runtime -> REST: Undeployment of Automation Composition Instance has been requested
end
@enduml |
Each participant undeploys its AC Element Instances from the AC Instance
AC Element Instances for this AC Instance
loop over AC Element Instances in AC Instance
alt Does the primed Participant ID on this AC Element Instance\nmatch my Participant ID?
alt Is this AC Element Instance already deployed
ACM_Runtime <- Participant: [ASYNC] WARN: AC Element is already deployed
else
Participant -> Participant_API: Deploy AC Element Instance
activate Participant_API
Participant <- Participant_API: AC Element Instance Deploy Response
deactivate Participant_API
alt AC Element deployed successfully
Participant -> Participant: Set AC Element Instance administrative state to LOCKED
ACM_Runtime <- Participant: [ASYNC] INFO: AC Element has been deployed
else
ACM_Runtime <- Participant: [ASYNC] ERROR: AC Element was not deployed
end
end
else
note left of Participant
Ignore this AC Element instance as its for another participant
end note
end
end
@enduml |
The ACM Runtime receives and stores the responses.
PlantUML Macro |
---|
@startuml
participant ACM_Runtime
participant Participant
database ACM_Database
ACM_Runtime <- Participant: [ASYNC] Deploy Automation Composition Element Instance Response
ACM_Runtime -> ACM_Database: Store Automation Composition Element Instance Response Information
alt Is AC Element Instance Deployed?
ACM_Runtime -> ACM_Database: Set AC Element Instance State as DEPLOYED
alt Are all the other AC Element Instances in this AC Instance in state DEPLOYED?
ACM_Runtime -> ACM_Runtime: Set AC Instance state as DEPLOYED
end
end
@enduml |
3.4 Undeploy Automation Composition Instance
The user requests the AC Instance to be undeployed using a REST endpoint. The ACM Runtime orders the AC Instance to be undeployed.
PlantUML Macro |
---|
@startuml
participant REST
participant ACM_Runtime
participant Participants
database ACM_Database
REST -> ACM_Runtime: Undeploy Automation Composition Instance
ACM_Runtime -> ACM_Database: Read Automation Composition Instance Information
alt Automation Composition Instance exists
alt Automation Composition Instance administrative state is not LOCKED
ACM_Runtime -> REST: Automation Composition instance exists and is not LOCKED
else
ACM_Runtime -> REST: Automation Composition instance does not exist
end
else
ACM_Runtime -> Participants: [ASYNC] Undeploy AC Element Instances for this AC Instance
ACM_Runtime -> ACM_Database: Mark this AC Instance and its AC Element Instances as UNDEPLOYING
ACM_Runtime -> REST: Undeployment of Automation Composition Instance has been requested
end
@enduml |
Each participant undeploys its AC Element Instances from the AC Instance
PlantUML Macro |
---|
@startuml
participant ACM_Runtime
participant Participant
participant Participant_API
ACM_Runtime -> Participant: [ASYNC] Undeploy AC Element Instances for this AC Instance
loop over AC Element Instances in AC Instance
alt Does the primed Participant ID on this AC Element Instance\nmatch my Participant ID?
alt Does this AC Element Instance exist?
ACM_Runtime <- Participant: [ASYNC] WARN: AC Element does not exist
else Is this administrative state of this AC Element Instance LOCKED
Participant -> Participant_API: Undeploy AC Element Instance
activate Participant_API
Participant <- Participant_API: Undeploy AC Element Instance Response
deactivate Participant_API
ACM_Runtime <- Participant: [ASYNC] INFO: AC Element undeployed successfully
note left of Participant
Undeploy always returns success
end note
else
ACM_Runtime <- Participant: [ASYNC] WARN: AC Element is already undeployed
end
else
note left of Participant
Ignore this AC Element instance as its for another participant
end note
end
end
@enduml |
The ACM Runtime receives and stores the responses.
PlantUML Macro |
---|
@startuml
|
PlantUML Macro |
@startuml participant ACM_Runtime participant Participant database ACM_Database ACM_Runtime <-> Participant: [ASYNC] Undeploy ACAutomation Composition Element Instances for this AC Instance loop over Instance Response ACM_Runtime -> ACM_Database: Store Automation Composition Element Instance Response Information alt Is AC Element InstancesInstance in AC Instance alt Does the primed Participant ID on this AC Element Instance\nmatch my Participant ID? alt Does this AC Element Instance existundeployed? ACM_Runtime -> ACM_Database: Mark AC Element Instance as UNDEPLOYED alt Are all the other AC Element Instances in this AC Instance in state UNDEPLOYED? ACM_Runtime <-> ParticipantACM_Runtime: [ASYNC] WARN: Set AC ElementInstance doesstate notas exist else Is this administrative state of this AC Element Instance LOCKED Participant -> Participant: Undeploy AC Element Instance activate Participant deactivate Participant alt AC Element undeployed successfully ACM_Runtime <- Participant: [ASYNC] INFO: AC Element undeployed successfully else ACM_Runtime <- Participant: [ASYNC] ERROR: AC Element was not undeployed end else ACM_Runtime <- Participant: [ASYNC] WARN: AC Element is already undeployed end else note left of participant ignore this AC Element instance as its for another participant end note end end @enduml |
The ACM Runtime receives and stores the responses.
PlantUML Macro |
---|
@startuml
participant ACM_Runtime
participant Participant
database ACM_Database
ACM_Runtime <- Participant: [ASYNC] Undeploy Automation Composition Element Instance Response
ACM_Runtime -> ACM_Database: Store Automation Composition Element Instance Response Information
alt Is AC Element Instance undeployed?
ACM_Runtime -> ACM_Database: Mark AC Element Instance as Undeployed
end
@enduml |
3.5 Read Automation Composition Instances
PlantUML Macro |
---|
@startuml
participant REST
participant ACM_Runtime
database ACM_Database
REST -> ACM_Runtime: Get Automation Composition Instance Information
ACM_Runtime -> ACM_Database: Read Automation Composition Instance Information
ACM_Runtime -> REST: Respond with Automation Composition Instance information\nincluding ACM Element Instance information\nand admin, operational, and usage state
@enduml |
3.6 Unlock Automation Composition Instance
The user requests the AC Instance to be unlocked using a REST endpoint. The ACM Runtime orders the AC Instance to be unlocked on Participants.
PlantUML Macro |
---|
@startuml
participant REST
participant ACM_Runtime
participant Participants
database ACM_Database
REST -> ACM_Runtime: Unlock Automation Composition Instance
ACM_Runtime -> ACM_Database: Read Automation Composition Instance Information
alt Automation Composition Instance exists
alt Automation Composition Instance administrative state is LOCKED
ACM_Runtime -> Participants: [ASYNC] Unlock AC Element Instances for this AC Instance
ACM_Runtime -> ACM_Database: Mark AC Instance and its AC Element Instances as Unlocking
ACM_Runtime -> REST: Unlocking of Automation Composition Instance has been requested
else
ACM_Runtime -> REST: Automation Composition instance is not locked
end
else
ACM_Runtime -> REST: Automation Composition instance does not exist
end
@enduml |
Each participant unlocks its AC Element Instances from the AC Instance.
PlantUML Macro |
---|
@startuml
participant ACM_Runtime
participant Participant
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: Unlock AC Element Instance
activate Participant
deactivate Participant
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.
UNDEPLOYED
end
end
@enduml |
3.5 Read Automation Composition Instances
PlantUML Macro |
---|
@startuml
participant REST
participant ACM_Runtime
database ACM_Database
REST -> ACM_Runtime: Get Automation Composition Instance Information
ACM_Runtime -> ACM_Database: Read Automation Composition Instance Information
ACM_Runtime -> REST: Respond with Automation Composition Instance information\nincluding ACM Element Instance information\nand admin, operational, and usage state
@enduml |
3.6 Unlock Automation Composition Instance
The user requests the AC Instance to be unlocked using a REST endpoint. The ACM Runtime orders the AC Instance to be unlocked on Participants.
PlantUML Macro |
---|
@startuml
participant REST
participant ACM_Runtime
participant Participants
database ACM_Database
REST -> ACM_Runtime: Unlock Automation Composition Instance
ACM_Runtime -> ACM_Database: Read Automation Composition Instance Information
alt Automation Composition Instance exists
alt Automation Composition Instance administrative state is LOCKED
ACM_Runtime -> Participants: [ASYNC] Unlock AC Element Instances for this AC Instance
ACM_Runtime -> ACM_Database: Mark AC Instance and its AC Element Instances as Unlocking
ACM_Runtime -> REST: Unlocking of Automation Composition Instance has been requested
else
ACM_Runtime -> REST: Automation Composition instance is not locked
end
else
ACM_Runtime -> REST: Automation Composition instance does not exist
end
@enduml |
Each participant unlocks its AC Element Instances from the AC Instance.
PlantUML Macro |
---|
@startuml
participant ACM_Runtime
participant Participant
participant Participant_API
ACM_Runtime -> Participant: [ASYNC] Unlock AC Element Instances for this AC Instance
loop over AC Element Instances in AC Instance
alt Does the primed Participant ID on this AC Element Instance\nmatch my Participant ID?
alt Is this AC Element Instance administrative state not LOCKED
ACM_Runtime <- Participant: [ASYNC] WARN: AC Element is not LOCKED
else
Participant -> Participant_API: Unlock AC Element Instance
activate Participant_API
Participant <- Participant_API: Unlock AC Element Instance Response
deactivate Participant_API
alt AC Element unlocked successfully
Participant -> Participant: Set AC Element Instance administrative state to UNLOCKED
ACM_Runtime <- Participant: [ASYNC] INFO: AC Element has been unlocked
else
ACM_Runtime <- Participant: [ASYNC] ERROR: AC Element was not unlocked
end
end
else
note left of participant
Ignore this AC Element instance as its for another participant
end note
end
end
@enduml |
The ACM Runtime receives and stores the responses.
PlantUML Macro |
---|
@startuml
participant ACM_Runtime
participant Participant
database ACM_Database
ACM_Runtime <- Participant: [ASYNC] Unlock Automation Composition Element Instance Response
ACM_Runtime -> ACM_Database: Store Automation Composition Element Instance Response Information
alt Is AC Element Instance Unlocked?
ACM_Runtime -> ACM_Database: Set AC Element Instance administrative state as UNLOCKED
alt Have all the other AC Element Instances in this AC Instance been UNLOCKED?
ACM_Runtime -> ACM_Runtime: Set AC Instance administrative state as UNLOCKED
end
end
@enduml |
3.7 Lock Automation Composition Instance
The user requests the AC Instance to be locked using a REST endpoint. The ACM Runtime orders the AC Instance to be locked on Participants.
PlantUML Macro |
---|
@startuml
participant REST
participant ACM_Runtime
participant Participants
database ACM_Database
REST -> ACM_Runtime: Lock Automation Composition Instance
ACM_Runtime -> ACM_Database: Read Automation Composition Instance Information
alt Automation Composition Instance exists
alt Automation Composition Instance administrative state is UNLOCKED
ACM_Runtime -> Participants: [ASYNC] Lock AC Element Instances for this AC Instance
|
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: StoreMark AutomationAC Composition Element Instance Response Information alt Isand its AC Element Instance Unlocked? Instances as Locking ACM_Runtime -> ACM_DatabaseREST: SetLocking of ACAutomation ElementComposition Instance administrativehas statebeen asrequested UNLOCKEDelse alt Have all the other AC Element Instances in this AC Instance been UNLOCKED?ACM_Runtime -> REST: Automation Composition instance is not unlocked end else ACM_Runtime -> ACM_RuntimeREST: SetAutomation ACComposition Instanceinstance administrativedoes state as UNLOCKED endnot exist 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 ParticipantsEach participant locks its AC Element Instances from the AC Instance.
PlantUML Macro |
---|
@startuml participant REST participant ACM_Runtime participant ParticipantsParticipant databaseparticipant ACMParticipant_Database API RESTACM_Runtime -> ACM_Runtime: Lock Automation Composition Instance ACM_Runtime -> ACM_Database: Read Automation Composition Instance Information alt Automation Composition Instance exists alt Automation CompositionParticipant: [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 isnot UNLOCKED ACM_Runtime <-> ParticipantsParticipant: [ASYNC] LockWARN: AC Element Instancesis fornot thisUNLOCKED AC Instanceelse ACM_Runtime Participant -> ACM_DatabaseParticipant: MarkSet AC Element Instance and its administrative state to SHUTTING_DOWN Participant -> Participant_API: Lock AC Element Instances as LockingInstance activate Participant_API ACM_Runtime Participant <-> RESTParticipant_API: LockingLock ofAC AutomationElement Composition Instance hasResponse been requested else deactivate ACMParticipant_RuntimeAPI -> REST: Automationalt CompositionAC instanceElement islocked notsuccessfully unlocked end else ACM_RuntimeParticipant -> RESTParticipant: AutomationSet CompositionAC instanceElement does not exist end @enduml |
Each participant locks its AC Element Instances from the AC Instance.
PlantUML Macro |
---|
@startuml participant ACM_Runtime participant Participant Instance administrative state to LOCKED ACM_Runtime <-> Participant: [ASYNC] LockINFO: AC Element Instanceshas forbeen thislocked AC Instance else 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 ACM_Runtime <- Participant: [ASYNC] ERROR: AC Element was not locked end end else note left of participant Ignore this AC Element Instance administrative state not UNLOCKED 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: [ASYNC] WARN: AC Element is not UNLOCKED else Participant -> database ACM_Database ACM_Runtime <- Participant: Set AC[ASYNC] Lock Automation Composition Element Instance administrative state to SHUTTING_DOWN Participant Response ACM_Runtime -> ParticipantACM_Database: OrderStore lockAutomation ACComposition Element Instance Response activate Participant deactivate Participant alt Information alt Is AC Element lockedInstance successfullyLocked? Participant ACM_Runtime -> ParticipantACM_Database: Set AC Element Instance administrative state toas LOCKED ACM_Runtime <- Participant: [ASYNC] INFO:alt Have all the other AC Element Instances hasin beenthis locked AC Instance been elseLOCKED? ACM_Runtime <-> ParticipantACM_Runtime: [ASYNC] ERROR: AC Element was not lockedSet AC Instance administrative state as 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.
@enduml |
3.8 Update Operational State on Automation Composition Instance
PlantUML Macro |
---|
@startuml
participant Participant_API
participant Participant
participant ACM_Runtime
Participant_API -> Participant_API: Perform Operation that Updates Operational State
activate Participant_API
deactivate Participant_API
Participant_API -> Participant: Operational State has been updated
Participant -> Participant: Update Operational State in ACM Element Instance
== Periodically with Heartbeat ==
Participant -> ACM_Runtime: [ASYNC] Heartbeat message including\nstatus and states of AC Element Instances on Participant
@enduml |
3.9 Update Usage State on Automation Composition Instance
PlantUML Macro |
---|
@startuml
participant Participant_API
participant Participant
participant ACM_Runtime
Participant_API -> Participant_API: Perform Operation that Updates Usage State
activate Participant_API
deactivate Participant_API
Participant_API -> Participant: Usage State has been updated
Participant -> Participant: Update Usage State in ACM Element Instance
== Periodically with Heartbeat ==
Participant |
PlantUML Macro |
@startuml participant ACM_Runtime participant Participant database ACM_Database ACM_Runtime <- Participant: [ASYNC] Lock Automation Composition Element Instance Response ACM_Runtime -> ACM_Database: Store Automation Composition Element Instance Response Information alt Is AC Element Instance Locked? ACM_Runtime -> ACM_Database: Set AC Element Instance administrative state as LOCKED alt Have all the other AC Element Instances in this AC Instance been LOCKED? ACM_Runtime -> ACM_Runtime: Set AC Instance administrative state as LOCKED end end [ASYNC] Heartbeat message including\nstatus and states of AC Element Instances on Participant @enduml |