...
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 @enduml |
1.3 Supervise Participants
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 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.
...
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 loop Every AC Element Instance in Heartbeat Message 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_RuntimeDatabase: MarkSet allParticipant ACM Element Instances\nrunning on Participant State as OfflineOFFLINE ACM_Runtime -> ACM_Runtime: Mark all ACM Element Instances\nrunning on Participant as OFFLINE 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 their states\nand Heartbeat Information @enduml |
...
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 Instancesis 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 == 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 -> Participant: ACM_Database: Read Participants ACM_Runtime -> ACM_Runtime: Set suitable participant ID on each AC Element Type alt Was a sutable participant ID found for each AC Element Type? ACM_Runtime -> Participant: [ASYNC] Send Priming Request to all Participants\nwith Automation Composition Type Definition REST <- ACM_Runtime: -> ACM_Database: Set Automation Composition Type State to PRIMING REST <- ACM_Runtime: Priming of Automation Composition Type Ordered @enduml 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 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] BringPrime AC Element InstancesTypes for this AC Instance intoType Service loop over AC Element InstancesTypes in AC InstanceType alt Does the primed Participant ID on this AC Element InstanceType\nmatch my Participant ID alt IsDoes this AC Element InstanceType already in serviceexist ACM_Runtime <- Participant: [ASYNC] WARN: AC Element isType already in serviceexists else Participant -> Participant: BringCreate AC Element Instance into ServiceType activate Participant deactivate Participant alt AC Element came into service successfullysuccessfully created ACM_Runtime <- Participant: [ASYNC] INFO: AC Element broughtsuccessfully into serviceprimed else ACM_Runtime <- Participant: [ASYNC] ERROR: AC Element was not brought into servicepriming failed end end else note left of participant ignore this AC Element instanceType 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.
The ACM Runtime updates the priming information in the database.
PlantUML Macro |
---|
@startuml participant REST participant ACM_Runtime databaseparticipant Participant database ACM_Database RESTACM_Runtime <-> ACM_Runtime: Get Automation Composition Type Information Participant: [ASYNC] Result of Priming of AC Element Type ACM_Runtime -> ACM_Database: Record Readresult of AutomationAC CompositionElement 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 or Update an Automation Composition Instance
Create on a POST and update on a PUT.
Priming
alt Is AC Element Type Primed?
alt Have all the other AC Element Types in this AC Type been Primed?
ACM_Runtime -> ACM_Runtime: Set AC Type state as PRIMED
end
end
@enduml |
2.5 Deprime an Automation Composition Type on Participants
The Depriming operation removes Automation Composition Types and common property values on participants for each Automation Composition Element Type in the Automation Composition Type.
PlantUML Macro |
---|
@startuml
participant REST
participant ACM_Runtime
participant Participant
database ACM_Database
alt Automation Composition Type has Instances
REST <- ACM_Runtime: Depriming of Automation Composition Type Failed
else AC Type State is PRIMED or PRIMING
REST -> ACM_Runtime: Deprime Automation Composition Type
ACM_Runtime -> ACM_Database: Read Automation Composition Type
ACM_Runtime -> Participant: [ASYNC] Send Depriming Request to all Participants\nwith Automation Composition Type Definition
ACM_Runtime -> ACM_Database: Set Automation Composition Type State to DEPRIMING
REST <- ACM_Runtime: Depriming of Automation Composition Type Ordered
else
REST <- ACM_Runtime: Depriming of Automation Composition Type Failed, invalid state
end
@enduml |
A participant should respond for each Automation Composition Element Type, thus causing the full Automation Composition Type to become deprimed.
PlantUML Macro |
---|
@startuml
participant ACM_Runtime
participant Participant
ACM_Runtime -> Participant: [ASYNC] Deprime AC Element Types for this AC Type
loop over AC Element Types in AC Type
alt Does the deprimed Participant ID on this AC Element Type\nmatch my Participant ID
alt Does this AC Element Type Exist
Participant -> Participant: Delete AC Element Type
activate Participant
deactivate Participant
note left of Participant
Deletion of an AC Element Type always returns success
end note
ACM_Runtime <- Participant: [ASYNC] INFO: AC Element successfully primed
else
ACM_Runtime <- Participant: [ASYNC] WARN: AC Element Type is already deprimed
end
else
note left of Participant
ignore this AC Element Type as its for another participant
end note
end
end
@enduml |
The ACM Runtime updates the priming information in the database.
PlantUML Macro |
---|
@startuml
participant ACM_Runtime
participant Participant
database ACM_Database
ACM_Runtime <- Participant: [ASYNC] Result of Depriming of AC Element Type
ACM_Runtime -> ACM_Database: Record result of AC Element Type Depriming
alt Is AC Element Type Deprimed?
alt Have all the other AC Element Types in this AC Type been Deprimed?
ACM_Runtime -> ACM_Runtime: Set AC Type state as COMMISSIONED
end
end
@enduml |
2.6 Get Automation Composition Types
This dialogue allows an Automation Composition Type to be read.
PlantUML Macro |
---|
@startuml
participant REST
participant ACM_Runtime
database ACM_Database
REST -> ACM_Runtime: Get Automation Composition Type Information
ACM_Runtime -> ACM_Database: Read Automation Composition Type Information
ACM_Runtime -> REST: Respond with Automation Composition Type information\nincluding ACM Element Type information and Priming Status
@enduml |
3. Instantiation Dialogues
Instantiation dialogues are used to create, set parameters on, instantiate, update, and remove Automation Composition instances.
3.1 Create an Automation Composition Instance
PlantUML Macro |
---|
@startuml
participant REST
participant ACM_Runtime
database ACM_Database
REST -> ACM_Runtime: Create Automation Composition Instance for\nspecified Automation Composition Type with\nspecified parameter values
alt Automation Composition Instance exists
alt Automation Composition Instance is not in state UNDEPLOYED
ACM_Runtime -> REST: Automation Composition instance exists and is already deployed
else
note right of REST
Updates on "Not In Service" Automation Composition Instances are allowed
end note
end
end
alt Specified Automation Composition Type Exists
alt Specified Automation Composition Type is in state PRIMED
ACM_Runtime -> ACM_Database: Store Automation Composition Instance
ACM_Runtime -> ACM_Database: Set Automation Composition Instance State to UNDEPLOYED
ACM_Runtime -> REST: Automation Composition Instance Created
else
ACM_Runtime -> REST: Automation Composition Type is not in state PRIMED
end
else
ACM_Runtime -> REST: Automation Composition Type is not found
end
@enduml |
Note that this dialogue creates the Automation Composition Instance in the ACM database. The instance is sent to the participants using the process described in the dialogue in Section 3.3.
3.2 Delete an Automation Composition Instance
PlantUML Macro |
---|
@startuml
participant REST
participant ACM_Runtime
database ACM_Database
REST -> ACM_Runtime: Delete Automation Composition Instance
alt Automation Composition Instance exists
alt Automation Composition Instance is not in state UNDEPLOYED
ACM_Runtime -> REST: Automation Composition instance exists and is deployed
else
ACM_Runtime -> REST: Automation Composition instance does not exist
end
else
ACM_Runtime -> ACM_Database: Delete Automation Composition Instance
ACM_Runtime -> REST: Automation Composition Instance Deleted
end
@enduml |
3.3 Deploy Automation Composition Instance
The user requests the AC Instance to be deployed using a REST endpoint. The ACM Runtime orders the AC Instance to be deployed to Participants.
PlantUML Macro |
---|
@startuml
participant REST
participant ACM_Runtime
participant Participants
database ACM_Database
REST -> ACM_Runtime: Deploy Automation Composition Instance
ACM_Runtime -> ACM_Database: Read Automation Composition Instance Information
alt Automation Composition Instance exists
alt Automation Composition Instance is deployed
ACM_Runtime -> REST: Automation Composition instance is already deployed
else
ACM_Runtime -> Participants: [ASYNC] Deploy AC Element Instances for this AC Instance
ACM_Runtime -> ACM_Database: Set AC Instance and its AC Element Instances to state DEPLOYING
ACM_Runtime -> REST: Deployment of Automation Composition Instance has been requested
end
else
ACM_Runtime -> REST: Automation Composition instance does not exist
end
@enduml |
Each participant deploys its AC Element Instances from the AC Instance.
PlantUML Macro |
---|
@startuml
participant ACM_Runtime
participant Participant
participant Participant_API
ACM_Runtime -> Participant: [ASYNC] Deploy AC Element Instances for this AC Instance
loop over AC Element Instances in AC Instance
alt Does the primed Participant ID on this AC Element Instance\nmatch my Participant ID?
alt Is this AC Element Instance already deployed
ACM_Runtime <- Participant: [ASYNC] WARN: AC Element is already deployed
else
Participant -> Participant_API: Deploy AC Element Instance
activate Participant_API
Participant <- Participant_API: AC Element Instance Deploy Response
deactivate Participant_API
alt AC Element deployed successfully
Participant -> Participant: Set AC Element Instance administrative state to LOCKED
ACM_Runtime <- Participant: [ASYNC] INFO: AC Element has been deployed
else
ACM_Runtime <- Participant: [ASYNC] ERROR: AC Element was not deployed
end
end
else
note left of Participant
Ignore this AC Element instance as its for another participant
end note
end
end
@enduml |
The ACM Runtime receives and stores the responses.
PlantUML Macro |
---|
@startuml
participant ACM_Runtime
participant Participant
database ACM_Database
ACM_Runtime <- Participant: [ASYNC] Deploy Automation Composition Element Instance Response
ACM_Runtime -> ACM_Database: Store Automation Composition Element Instance Response Information
alt Is AC Element Instance Deployed?
ACM_Runtime -> ACM_Database: Set AC Element Instance State as DEPLOYED
alt Are all the other AC Element Instances in this AC Instance in state DEPLOYED?
ACM_Runtime -> ACM_Runtime: Set AC Instance state as DEPLOYED
end
end
@enduml |
3.4 Undeploy Automation Composition Instance
The user requests the AC Instance to be undeployed using a REST endpoint. The ACM Runtime orders the AC Instance to be undeployed.
PlantUML Macro |
---|
@startuml
participant REST
participant ACM_Runtime
participant Participants
database ACM_Database
REST -> ACM_Runtime: Undeploy Automation Composition Instance
ACM_Runtime -> ACM_Database: Read Automation Composition Instance Information
alt Automation Composition Instance exists
alt Automation Composition Instance administrative state is not LOCKED
ACM_Runtime -> REST: Automation Composition instance exists and is not LOCKED
else
ACM_Runtime -> REST: Automation Composition instance does not exist
end
else
ACM_Runtime -> Participants: [ASYNC] Undeploy AC Element Instances for this AC Instance
ACM_Runtime -> ACM_Database: Mark this AC Instance and its AC Element Instances as UNDEPLOYING
ACM_Runtime -> REST: Undeployment of Automation Composition Instance has been requested
end
@enduml |
Each participant undeploys its AC Element Instances from the AC Instance
PlantUML Macro |
---|
@startuml
participant ACM_Runtime
participant Participant
participant Participant_API
ACM_Runtime -> Participant: [ASYNC] Undeploy AC Element Instances for this AC Instance
loop over AC Element Instances in AC Instance
alt Does the primed Participant ID on this AC Element Instance\nmatch my Participant ID?
alt Does this AC Element Instance exist?
ACM_Runtime <- Participant: [ASYNC] WARN: AC Element does not exist
else Is this administrative state of this AC Element Instance LOCKED
Participant -> Participant_API: Undeploy AC Element Instance
activate Participant_API
Participant <- Participant_API: Undeploy AC Element Instance Response
deactivate Participant_API
ACM_Runtime <- Participant: [ASYNC] INFO: AC Element undeployed successfully
note left of Participant
Undeploy always returns success
end note
else
ACM_Runtime <- Participant: [ASYNC] WARN: AC Element is already undeployed
end
else
note left of Participant
Ignore this AC Element instance as its for another participant |
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 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 @enduml |
The ACM Runtime receives and stores the responses.
PlantUML Macro |
---|
@startuml participant ACM_Runtime participant Participant altdatabase Specified Automation Type Composition Exists alt Specified ACM_Database ACM_Runtime <- Participant: [ASYNC] Undeploy Automation Composition TypeElement isInstance PrimedResponse ACM_Runtime -> ACM_Database: Store Automation Composition Element Instance Response Information alt Is AC Element Instance undeployed? ACM_Runtime -> REST: Automation Composition Instance Created else ACM_Runtime -> REST: Automation Composition Type is not primed end else 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 -> RESTACM_Runtime: AutomationSet CompositionAC TypeInstance 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.
...
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: DeleteGet Automation Composition Instance alt Automation Composition Instance exists altInformation ACM_Runtime -> ACM_Database: Read Automation Composition Instance is deployedInformation ACM_Runtime -> REST: Respond with Automation Composition instance exists Composition Instance information\nincluding ACM Element Instance information\nand admin, operational, and is deployed else ACM_Runtime -> REST: Automation Composition instance does not exist end else ACM_Runtimeusage 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_DatabaseRuntime: DeleteUnlock Automation Composition Instance ACM_Runtime -> RESTACM_Database: Read Automation Composition Instance DeletedInformation 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 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: Read Automation Composition Instance Information alt Automation Composition Instance exists alt Mark AC Instance and its AC Element Instances as Unlocking ACM_Runtime -> REST: Unlocking of Automation Composition Instance is deployed has been requested else ACM_Runtime -> REST: Automation Composition instance is alreadynot deployedlocked end else ACM_Runtime -> REST: Automation Composition instance does not exist end end else @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 -> ParticipantsParticipant: [ASYNC] DeployUnlock AC Element Instances for this AC Instance ACM_Runtime -> ACM_Database: Markloop over AC Element Instances in AC Instance and its alt Does the primed Participant ID on this 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 ->Instance\nmatch my Participant ID? alt Is this AC Element Instance administrative state not LOCKED ACM_Runtime <- Participant: [ASYNC] DeployWARN: AC Element Instances for this is not LOCKED else Participant -> Participant_API: Unlock AC Element Instance activate Participant_API loop over ACParticipant Element Instances in<- Participant_API: Unlock AC Element Instance Response alt Does thedeactivate primed Participant_API ID on thisalt AC Element Instance\nmatch my Participant ID? alt Is this unlocked successfully Participant -> Participant: Set AC Element Instance administrative alreadystate to deployedUNLOCKED ACM_Runtime <- Participant: [ASYNC] WARNINFO: AC Element ishas alreadybeen deployedunlocked else Participant ACM_Runtime <-> Participant: Deploy [ASYNC] ERROR: AC Element Instancewas not unlocked end activateend Participantelse note deactivateleft of Participantparticipant Ignore altthis AC Element instance as deployedits successfully for another participant Participant -> Participant: Set state of 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.
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
|
PlantUML Macro |
@startuml participant ACM_Runtime participant ParticipantParticipants database ACM_Database REST -> ACM_Runtime <- Participant: [ASYNC] DeployLock Automation Composition Element Instance Response ACM_Runtime -> ACM_Database: StoreRead Automation Composition Element Instance Response Information alt IsAutomation AC ElementComposition Instance Deployed?exists ACM_Runtime -> ACM_Database: Set AC Elementalt Automation Composition Instance administrative state asis LOCKEDUNLOCKED alt Have all the other ACM_Runtime -> Participants: [ASYNC] Lock AC Element Instances infor this AC Instance been deployed? ACM_Runtime -> ACM_RuntimeDatabase: markMark AC Instance and its AC Element Instances 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.
Locking
ACM_Runtime -> REST: Locking of Automation Composition Instance has been requested
else
ACM_Runtime -> REST: Automation Composition instance is not unlocked
end
else
ACM_Runtime -> REST: Automation Composition instance does not exist
end
@enduml |
Each participant locks its AC Element Instances from the AC Instance.
PlantUML Macro |
---|
@startuml
participant ACM_Runtime
participant Participant
participant Participant_API
|
PlantUML Macro |
@startuml participant REST participant ACM_Runtime participant Participants database ACM_Database REST -> ACM_Runtime: Undeploy Automation Composition Instance out of Service ACM_Runtime -> ACM_Database: Read Automation Composition Instance Information alt Automation Composition Instance exists alt Automation Composition Instance is in state "Out Of Service" ACM_Runtime -> REST: Automation Composition instance exists and is already out of service else ACM_Runtime -> REST: Automation Composition instance does not exist end else ACM_Runtime -> Participants: [ASYNC] Take AC Element Instances for this AC Instance out of Service ACM_Runtime -> ACM_Database: Set status of AC Instance and its AC Element Instances as "Dropping out of Service" ACM_Runtime -> REST: Automation Composition Instance has been requested to drop out of service end @enduml |
Each participant takes its AC Element Instances from the AC Instance out of service.
PlantUML Macro |
---|
@startuml participant ACM_Runtime participant Participant ACM_Runtime -> Participant: [ASYNC] Take AC Element Instances for this AC Instance out of 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 out of service 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] WARNERROR: AC Element iswas already out of service elsenot locked Participantend -> Participant: Bring AC Element Instance out of Serviceend else note left of participant activate Participant deactivate Participant alt AC Element drops out of service successfully 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 INFO:Automation ACComposition Element taken out of service else Instance Response ACM_Runtime -> ACM_Database: Store Automation Composition Element Instance Response Information alt Is AC Element Instance Locked? ACM_Runtime <-> ParticipantACM_Database: [ASYNC] ERROR: AC Element was not taken out of service end end else note left of participant ignore this AC Element instance as its for another participant end note Set AC Element Instance administrative state as LOCKED alt Have all the other AC Element Instances in this AC Instance been LOCKED? ACM_Runtime -> ACM_Runtime: Set AC Instance administrative state as LOCKED end end @enduml |
...
3.8 Update Operational State on Automation Composition Instance
PlantUML Macro |
---|
@startuml participant ACMParticipant_RuntimeAPI participant Participant databaseparticipant ACM_Database Runtime ACMParticipant_RuntimeAPI <-> Participant_API: [ASYNC]Perform AutomationOperation Compositionthat ElementUpdates InstanceOperational out of service Response ACM_RuntimeState activate Participant_API deactivate Participant_API Participant_API -> ACM_Database: Store Automation Composition Element Instance Response Information alt Is AC Element Instance out of service? ACM_RuntimeParticipant: Operational State has been updated Participant -> ACM_Database: Set ACParticipant: Update Operational State in ACM Element Instance == asPeriodically "Notwith InHeartbeat Service" else ACM_Runtime== Participant -> ACM_DatabaseRuntime: Set[ASYNC] Heartbeat message including\nstatus and states of AC Element InstanceInstances ason "In Service" endParticipant @enduml |
3.
...
9 Update Usage State on Automation Composition
...
Instance
PlantUML Macro |
---|
@startuml participant Participant_API participant RESTParticipant participant ACM_Runtime database ACM_Database REST 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 -> ACM_RuntimeParticipant: GetUpdate AutomationUsage CompositionState Instance Informationin ACM_Runtime -> ACM_Database: Read Automation Composition Instance Information ACM_RuntimeElement Instance == Periodically with Heartbeat == Participant -> RESTACM_Runtime: Respond with Automation Composition Instance information\nincluding ACM[ASYNC] Heartbeat message including\nstatus and states of AC Element InstanceInstances informationon andParticipant Status @enduml |