...
1 Dialogues on Participants
1.1 Register a Participant
...
Participant Registration is performed by a Participant when it starts up. It registers its ID and type the ACM Element Types it supports with the ACM runtime.
PlantUML Macro |
---|
@startuml
participant Participant
participant ACM_Runtime
database ACM_Database
Participant -> ACM_Runtime: [ASYNC] Register
ACM_Runtime -> ACM_Database: [ASYNC] Create or Update Participant Registration
Participant <-\nand store supported ACM element types
ACM_Runtime -> ACM_RuntimeDatabase: Registration Accepted
loop over all Automation Composition Types
alt This Automation Composition Type has the Participant Type of this Participant
Set Participant State as ONLINE
Participant <- ACM_Runtime: Registration Accepted
ACM_Runtime -> ACM_Runtime: TriggerMark Primingall ofACM this Automation Composition Type
end
endElement Instances\nrunning on Participant as ONLINE
activate ACM_Runtime
deactivate ACM_Runtime
@enduml |
1.2 Deregister a Participant
...
Participant Registration Deregistration is performed by a Participant when it shuts down. It deregisters its ID and type with the ACM runtime. The ACM runtime reprimes any Automation Composition Types that use the participant type of the removed participant because the participants available to the Automation Composition Type have changed. It also triggers supervision of any AC instances using this particular participant so that the instance can be moved to another participant or can be marked as errored.
The participant should already have cleared down all its ACM Element instances and set their states to "Not In Service".
PlantUML Macroplantuml |
---|
@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
Participantloop over all Automation Composition Type Definitions
alt This Automation Composition Type has the Participant Type of this Participant
ACM_Runtime -> ACM_Runtime: Trigger Priming of this Automation Composition Type
end
end
loop over all Automation Composition Instances
alt This Automation Composition Instance uses this Participant
ACM_Runtime -> ACM_Runtime: Trigger[ASYNC] supervisionHeartbeat ofmessage this Automation Composition Instance
end
end
@enduml |
2 Dialogues on Automation Composition Types
Commissioning dialogues are used to commission and decommission Automation Composition Types and to set the values of Common Parameters. The values of common parameters are included in the TOSCA YAML file that defines the full Automation Composition Type.
2.1 Commissioning an Automation Composition Type
Create on a POST and update on a PUT.
PlantUML Macro |
---|
@startuml
participant REST
participant ACM_Runtime
database ACM_Database
REST -> ACM_Runtime: Commission Automation Composition Type
alt Automation Composition Type exists and has Instances
ACM_Runtime -> REST: Automation Composition Type Commissioning Failed
else
ACM_Runtime -> ACM_Database: Create and Store Automation Composition Type
ACM_Runtime -> REST: Automation Composition Type Commissioned
ACM_Runtime -> ACM_Runtime: Trigger Priming of Automation Composition Type
activate ACM_Runtime
deactivate ACM_Runtime
end
@enduml |
2.2 Commissioning an Automation Composition Type using SDC
PlantUML Macro |
---|
@startuml
participant SDC
participant Policy_Distribution
participant ACM_Runtime
SDC -> Policy_Distribution: [ASYNC] CSAR containing Automation Composition Type Definition
Policy_Distribution -> ACM_Runtime: Commission Automation Composition Type\n(See Commissioning Sequence Diagram)
Policy_Distribution <- ACM_Runtime: Result of Commissioning
Policy_Distribution -> SDC: [ASYNC] Return result of Deployment
@enduml |
2.3 Decommissioning an Automation Composition Type Definition
PlantUML Macro |
---|
@startuml
participant REST
participant ACM_Runtime
database ACM_Database
REST -> ACM_Runtime: Decommission Automation Composition Type
alt Automation Composition Type has Instances
ACM_Runtime -> REST: Automation Composition Type Decommissioning Failed
else
ACM_Runtime -> REST: Automation Composition Type Definition Decommissioning Ordered
ACM_Runtime -> ACM_Runtime: Trigger Depriming of Automation Composition Type Definition
activate ACM_Runtime
deactivate ACM_Runtime
ACM_Runtime -> ACM_Database: Delete Automation Composition Type
end
@enduml |
2.4 Priming an Automation Composition Type Definition on Participants
The Priming operation sends Automation Composition Types and common property values to participants.
PlantUML Macro |
---|
@startuml
participant ACM_Runtime
participant Participant
database ACM_Database
ACM_Runtime -> ACM_Database: Read Automation Composition Type
ACM_Runtime -> Participant: [ASYNC] Send Priming Request to all Participants\nwith Automation Composition Type Definition
== Each Participant ==
ACM_Runtime -> Participant: [ASYNC] Receive Priming Request with Automation Composition Type Definition
alt Automation Composition Type uses this type of Participant
Participant -> Participant: Save Automation Composition Type details on this Participant
ACM_Runtime <- Participant: [ASYNC] Send Priming Response
else
note right of Participant
Ignore Priming Request
end note
end
@enduml |
2.5 De-Prime an Automation Composition Type Definition on Participants
This dialogue allows an Automation Composition Type to be de-primed.
PlantUML Macro |
---|
@startuml
participant ACM_Runtime
participant Participant
database ACM_Database
ACM_Runtime -> ACM_Database: Read Automation Composition Type
ACM_Runtime -> Participant: [ASYNC] Send Depriming Request to all Participants
== Each Participant ==
ACM_Runtime -> Participant: [ASYNC] Receive Depriming Request
alt Automation Composition Type uses this type of Participant
Participant -> Participant: Delete Automation Composition Type details on this Participant
ACM_Runtime <- Participant: [ASYNC] Send Depriming Response
else
note right of Participant
Ignore Depriming Request
end note
end
@enduml |
Warning |
---|
PAGE UPDATED TO HERE. |
3. Instantiation Dialogues
Instantiation dialogues are used to create, set parameters on, instantiate, update, and remove Automation Composition instances.
3.1 Creating an Automation Composition Instance
PlantUML Macro |
---|
@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
database ACM_Database database ACM_Database CLAMP_GUI -> CLAMP_Runtime: [REST] Read Automation Composition Type Definitions
CLAMP_Runtime -> ACM_Database: Read Automation Composition Type Definitions
CLAMP_Runtime -> CLAMP_GUI: [REST] Type Definitions returned
CLAMP_GUI -> CLAMP_GUI: Select Automation Composition Type Definition to use to create Automation Composition Instance
CLAMP_GUI -> CLAMP_Runtime: [REST] Fetch GUI fields for Instance Specific Parameter Definitions
CLAMP_Runtime -> ACM_Database: Read Automation Composition Type Definition
CLAMP_Runtime -> CLAMP_Runtime: Generate fields for Instance Specific Parameters for GUI
CLAMP_Runtime -> CLAMP_GUI: [REST] Return GUI fields Instance Specific Parameter Definitions
CLAMP_GUI -> CLAMP_GUI: Render UI for Instance Specific Parameters
CLAMP_GUI -> CLAMP_GUI: Get values for Instance Specific Parameters from user
CLAMP_GUI -> CLAMP_Runtime: [REST] Request Creation of Automation Composition Instance
CLAMP_Runtime -> CLAMP_Runtime: Create Automation Composition Instance
CLAMP_Runtime -> ACM_Database: Store First Version of Automation Composition Instance
CLAMP_Runtime -> CLAMP_GUI: [REST] Automation Composition Instance Updated
@enduml |
Note that this dialogue creates the Automation Composition Instance in the Instantiated Automation Composition Inventory. The instance is sent to the participants using the process described in the dialogue in Section 2.3.
3.2 Updating Instance Specific Parameters on an Automation Composition Instance
PlantUML Macro |
---|
@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
database ACM_Database CLAMP_GUI -> CLAMP_Runtime: [REST] Read Automation Composition Instances
CLAMP_Runtime -> ACM_Database: Read Automation Composition Instances
CLAMP_Runtime -> CLAMP_GUI: [REST] Automation Composition Instances returned
CLAMP_GUI -> CLAMP_GUI: Select Automation Composition Instance on which to Update Parameters
CLAMP_GUI -> CLAMP_GUI: Step version of Automation Composition Instance as Major/Minor/Patch
CLAMP_GUI -> CLAMP_Runtime: [REST] Fetch GUI fields for Instance Specific Parameter Definitions
CLAMP_Runtime -> ACM_Database: Read Automation Composition Type Definition
CLAMP_Runtime -> CLAMP_Runtime: Generate fields for Instance Specific Parameters for GUI
CLAMP_Runtime -> CLAMP_GUI: [REST] Return GUI fields Instance Specific Parameter Definitions
CLAMP_GUI -> CLAMP_GUI: Render UI for Instance Specific Parameters
CLAMP_GUI -> CLAMP_GUI: Get values for Instance Specific Parameters from user
CLAMP_GUI -> CLAMP_Runtime: [REST] Request Update of Automation Composition Instance
CLAMP_Runtime -> CLAMP_Runtime: Update Automation Composition Instance
CLAMP_Runtime -> ACM_Database: Store New Version of Automation Composition Instance
CLAMP_Runtime -> CLAMP_GUI: [REST] Automation Composition Instance Updated
@enduml |
3.3 Updating an Automation Composition Instance with a Configuration on Participants
PlantUML Macro |
---|
@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
participant Participant
database ACM_Database CLAMP_GUI -> CLAMP_Runtime: [REST] Read all configuration versions of Automation Composition Instance
CLAMP_Runtime -> ACM_Database: Read all configuration versions of Automation Composition Instance
CLAMP_Runtime -> CLAMP_GUI: [REST] All configuration versions of Automation Composition Instance returned
CLAMP_GUI -> CLAMP_GUI: Select configuration version of Automation Composition Instance for Instantiation Participants
CLAMP_GUI -> CLAMP_Runtime: [REST] Instantiate selected configuration version of Automation Composition Instance on Participants
alt Selected configuration version of Automation Composition Instance not instantiated on Participants
CLAMP_Runtime -> ACM_Database: Read configuration version of Automation Composition Instance
CLAMP_Runtime -> Participants: [DMaaP] Update Participants with configuration version of Automation Composition Instance
CLAMP_Runtime -> CLAMP_GUI: [REST] Instantiation of configuration version of Automation Composition Instance ordered on participants
else Selected configuration version of Automation Composition Instance instantiated on Participants
CLAMP_Runtime -> CLAMP_GUI: [REST] configuration version of Automation Composition Instance already instantiated on participants
end
== Participant Responses ==
Participants -> CLAMP_Runtime: [DMaaP] Result of update of configuration version of Automation Composition Instance on participant
CLAMP_Runtime -> ACM_Database: Store result of update of configuration version of Automation Composition Instance on participant
== Supervision ==
loop forever
CLAMPincluding\nstatus and states of AC Element Instances on Participant
ACM_Runtime -> ACM_Database: ReadUpdate AutomationParticipant CompositionHeartbeat Instancesdata
loop over each Automation Composition Instance
alt Automation Composition Instance configuration version update underway on participants
CLAMP_Runtime -> ACM_Database: read result of Automation Composition updates from participants
alt Updates completed on all participants
CLAMPACM_Runtime -> ACM_Database: Set Participant State as ONLINE
loop Every AC Element Instance in Heartbeat Message
ACM_Runtime -> ACM_Database: Mark AC Element Instance as ONLINE\nand Update AC Element Instance status
end
end
@enduml |
The ACM runtime regularly checks the heartbeat reports from participants and takes action if participants time out. If a heartbeat message is not received for a participant in the Timeout Interval, the participant is marked as timed out and its ACM element instances are informed.
PlantUML Macro |
---|
@startuml
participant ACM_Runtime
database ACM_Database
loop Every ACM_Runtime Supervision Interval
loop Over all Participants
ACM_Runtime -> ACM_Database: set configuration version of Automation Composition Instance as Instantiated on Participants
Read Participant Heartbeat Information
alt Participant Heartbeat not received in Timeout Interval
CLAMPACM_Runtime -> ACM_Database: setSet overall configuration version of Automation Composition Instance state as InstantiatedParticipant State as OFFLINE
else Updates not completed
alt Instantiation of Automation Composition Instance on participants timed out
ACM_Runtime -> ACM_Runtime: Mark all ACM Element Instances\nrunning on Participant as OFFLINE
CLAMPactivate ACM_Runtime
-> ACM_Database: set configuration version Automation Composition Instance Instantiation as timed out on Participants
CLAMP_Runtime -> CLAMP_Runtime: Log error
else Wait for updates to complete
end
end
else Automation Composition Instance configuration version update on participants not underway
end
end
end
@enduml |
3.4 Changing the state of an Automation Composition Instance on Participants
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 |
PlantUML Macro |
---|
@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
participant Participant
database ACM_Database CLAMP_GUI -> CLAMP_Runtime: [REST] Read all Instantiated Automation Composition Instances
CLAMP_Runtime -> ACM_Database: Read all Instantiated Automation Composition Instances
CLAMP_Runtime -> CLAMP_GUI: [REST] All Instantiated Automation Composition Instances returned
CLAMP_GUI -> CLAMP_GUI: Select Automation Composition Instance on which to change state and specify new state
CLAMP_GUI -> CLAMP_Runtime: [REST] Change state of selected Automation Composition Instance on Participants
alt Selected Automation Composition Instance instantiated on Participants
CLAMP_Runtime -> Participants: [DMaaP] Request change of state of Automation Composition Instance
CLAMP_Runtime -> CLAMP_GUI: [REST] Change of state of Automation Composition Instance ordered on participants
else Selected Automation Composition Instance not instantiated on Participants
CLAMP_Runtime -> CLAMP_GUI: [REST] Automation Composition Instance not instantiated on participants
end
== Participant Responses ==
Participants -> CLAMP_Runtime: [DMaaP] Result of State Change of Automation Composition Instance on participant
CLAMP_Runtime -> ACM_Database: Store result of State Change of Automation Composition Instance on participant
== Supervision ==
loop forever
CLAMP_Runtime -> ACM_Database: Read Automation Composition Instances
loop over each Automation Composition Instance
alt Automation Composition Instance State Change underway on participants
CLAMP_Runtime -> ACM_Database: read result of Automation Composition State Change from participants
alt Updates completed on all participants
CLAMP_Runtime -> ACM_Database: set Automation Composition Instance state as changed on Participants
CLAMP_Runtime -> ACM_Database: set overall Automation Composition Instance state as changed
else Updates not completed
alt Automation Composition Instance State Change on participants timed out
CLAMP_Runtime -> ACM_Database: setRead Automation Composition State Change as timed out onType
ACM_Runtime -> ACM_Database: Read Participants
CLAMP ACM_Runtime -> CLAMPACM_Runtime: LogSet error
suitable participant ID on each AC else Wait for updates to complete
end
end
elseElement 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 InstanceType StateDefinition
Change on participants not underway
end
end
end
@enduml |
3.5 De-instantiating an Automation Composition Instance from Participants
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 |
PlantUML Macro |
---|
@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
participant Participant
database ACM_Database CLAMP_GUI -> CLAMP_Runtime: [REST] Read all Instantiated Automation Composition Instances
CLAMP_Runtime -> ACM_Database: Read all Instantiated Automation Composition Instances
CLAMP_Runtime -> CLAMP_GUI: [REST] All Instantiated Automation Composition Instances returned
CLAMP_GUI -> CLAMP_GUI: Select Automation Composition Instance to de-instantiate
CLAMP_GUI -> CLAMP_Runtime: [REST] De-instantiate selected Automation Composition Instance on Participants
alt Selected Automation Composition Instance instantiated on Participants
CLAMP_Runtime -> Participants: [DMaaP] Update Participants to remove Automation Composition Instance
CLAMP_Runtime -> CLAMP_GUI: [REST] De-instantiation of Automation Composition Instance ordered on participants
else Selected Automation Composition Instance not instantiated on Participants
CLAMP_Runtime -> CLAMP_GUI: [REST] Automation Composition Instance not instantiated on participants
end
== Participant Responses ==
Participants -> CLAMP_Runtime: [DMaaP] Result of update of Automation Composition Instance on participant
CLAMP_Runtime -> ACM_Database: Store result of update of Automation Composition Instance on participant
== Supervision ==
loop forever
CLAMP_Runtime -> ACM_Database: Read Automation Composition Instances
loop over each Automation Composition Instance
alt Automation Composition Instance de-instantiation update underway on participants
CLAMP_Runtime -> ACM_Database: read result of Automation Composition updates from participants
alt Updates completed on all participants
CLAMP_Runtime -> ACM_Database: set Automation Composition Instance as de-instantiated on Participants
CLAMP_Runtime -> ACM_Database: setRecord overallresult Automationof CompositionAC InstanceElement as de-instantiated
else Updates not completed
alt Automation Composition Instance de-instantiation Update timed out on participants
CLAMP_Runtime -> ACM_Database: set Automation Composition Instance de-instantiation as timed out on Participants
CLAMP_Runtime -> CLAMP_Runtime: Log error
else Wait for updates to complete
end
end
else Automation Composition Instance de-instantiation update on participants not underway
end
end
@enduml |
3.6 Deleting an Automation Composition Instance
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 |
PlantUML Macro |
---|
@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
database ACM_Database CLAMP_GUI -> CLAMP_Runtime: [REST] Read all Automation Composition Instances
CLAMP_Runtime -> ACM_Database: Read allSet Automation Composition Instances
CLAMP_Runtime -> CLAMP_GUI: [REST] All Type State to DEPRIMING
REST <- ACM_Runtime: Depriming of Automation Composition Type InstancesOrdered
else returned
CLAMP_GUI REST <-> CLAMPACM_GUIRuntime: Depriming Selectof Automation Composition Instance to delete
CLAMP_GUI 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 -> CLAMP_RuntimeParticipant: [REST] Delete selected Automation Composition Instance
alt Selected Automation Composition Instance exists
CLAMP_Runtime -> ACM_Database: Delete Automation Composition instance
CLAMP_Runtime -> CLAMP_GUI: [REST] Automation Composition Instance deleted
else Selected Automation Composition Instance does not exist
CLAMP_Runtime -> CLAMP_GUI: [REST] Automation Composition Instance does not exist
end
@enduml |
3.7 Reading Automation Composition Instances
PlantUML Macro |
---|
@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
database ACM_Database CLAMP_GUI -> CLAMP_Runtime: [REST] Read all Automation Composition Instances
CLAMP_Runtime -> ACM_Database: Read all Automation Composition Instances
CLAMP_Runtime -> CLAMP_GUI: [REST] All Automation Composition Instances returned
@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
ASYNC] Deprime AC Element Types for this AC Type
loop over AC Element Types in AC Type
alt Does the deprimed Participant ID on this AC Element Type\nmatch my Participant ID
alt Does this AC Element Type Exist
Participant -> Participant: Delete AC Element Type
activate Participant
deactivate Participant
note left of Participant
Deletion of an AC Element Type always returns success
end note
ACM_Runtime <- Participant: [ASYNC] INFO: AC Element successfully primed
else
ACM_Runtime <- Participant: [ASYNC] WARN: AC Element Type is already deprimed
end
else
note left of Participant
ignore this AC Element Type as its for another participant
end note
end
end
@enduml |
The ACM Runtime updates the priming information in the database.
PlantUML Macro |
---|
@startuml
participant ACM_Runtime
participant Participant
database ACM_Database
ACM_Runtime <- Participant: [ASYNC] Result of Depriming of AC Element Type
ACM |
PlantUML Macro |
---|
@startuml
participant CLAMP_Runtime
participant Participant
database ACM_Database Participant -> CLAMP_Runtime: [DMaaP] Participant and Automation Composition Element Monitoring and Statistics report
CLAMP_Runtime -> ACM_Database: Store Participant and Automation Composition Element Monitoring and Statistics report
alt Fault reported on Participant
CLAMP_Runtime -> CLAMP_Runtime: log fault on Participant
CLAMP_Runtime -> ACM_Database: Record faultresult on Participant
end
loop Over all Automation Composition Elements in Participant Report
alt Fault reported on Automation Composition Element
CLAMP_Runtime -> CLAMP_Runtime: log fault on Automation Composition Element and Automation Composition CLAMPof 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_Database: Record fault on Automation Composition Element and Automation Composition 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 CLAMP_GUIREST
participant CLAMPACM_Runtime
database ACM_Database == Overview of all
REST -> ACM_Runtime: Get Automation Composition Type InstancesInformation ==
CLAMPACM_GUIRuntime -> CLAMPACM_RuntimeDatabase: [REST] Read all Automation Composition Type InstancesInformation
CLAMPACM_Runtime -> ACM_DatabaseREST: ReadRespond allwith Automation Composition Instances
CLAMP_Runtime -> CLAMP_GUI: [REST] All Automation Composition Instances returned
CLAMP_GUI -> CLAMP_GUI: Display overview of status of all Automation Composition Instances
== Details of a 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
CLAMP_GUI -> CLAMP_Runtime: [REST] Read Automation Composition Elements for Automation Composition Instance
CLAMPalt Automation Composition Instance is not in state UNDEPLOYED
ACM_Runtime -> ACM_DatabaseREST: Read Automation Composition instance Elementsexists forand Automationis Compositionalready Instance
CLAMP_Runtime -> CLAMP_GUI: [REST] Automation Composition Elements returned
CLAMP_GUI -> CLAMP_GUI: Display status ofdeployed
else
note right of REST
Updates on "Not In Service" Automation Composition Elements in Automation Composition Instance
== Overview of all Participants ==
CLAMP_GUI -> CLAMP_Runtime: [REST] Read all participants
CLAMPInstances 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 ReadAutomation allComposition participantsInstance
CLAMP_Runtime -> CLAMP_GUI: [REST] All participants returned
CLAMP_GUI ACM_Runtime -> CLAMPACM_GUIDatabase: DisplaySet overviewAutomation ofComposition statusInstance ofState allto participants
UNDEPLOYED
== Details of a Participant ==
CLAMP_GUI ACM_Runtime -> CLAMP_RuntimeREST: [REST]Automation ReadComposition AutomationInstance CompositionCreated
Elementselse
for Participant
CLAMPACM_Runtime -> ACM_DatabaseREST: Read Automation Composition Elements for Participant
CLAMP Type is not in state PRIMED
end
else
ACM_Runtime -> CLAMP_GUIREST: [REST] Automation Composition Elements returned
CLAMP_GUI -> CLAMP_GUI: Display status of Automation Composition Elements in Participant
== Filtered Monitoring ==
CLAMP_GUI -> CLAMP_GUI: Set filter for Automation Composition Instances, Automation Composition Elements, and Participants
CLAMP_GUI -> CLAMP_Runtime: [REST] Read Automation Composition Elements that match filter
CLAMP_Runtime -> ACM_Database: Read Automation Composition Elements that match filter
CLAMP_Runtime -> CLAMP_GUI: [REST] Automation Composition Elements that match filter returned
CLAMP_GUI -> CLAMP_GUI: Display status of Automation Composition Elements that match filter
@enduml |
3.2 Viewing of Statistics
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 |
PlantUML Macro |
---|
@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
database ACM_Database == Statistics of all Automation Composition Instances ==
CLAMP_GUI -> CLAMP_Runtime: [REST] Read summary statistics for all Automation Composition Instances
CLAMP_Runtime -> ACM_Database: Compile summary statistics for all Automation Composition Instances
CLAMP_Runtime -> CLAMP_GUI: [REST] Summary statistics for all Automation Composition Instances returned
CLAMP_GUI -> CLAMP_GUI: Display summary statistics for all Automation Composition Instances
== Statistics of a Automation Composition Instance ==
CLAMP_GUI -> CLAMP_Runtime: [REST] Read statistics for Automation Composition Elements for Automation Composition Instance
CLAMP_Runtime -> ACM_Database: CompileSet AC statisticsInstance forand Automationits CompositionAC ElementsElement forInstances Automationto Compositionstate InstanceDEPLOYING
CLAMP ACM_Runtime -> CLAMP_GUIREST: [REST] Statistics forDeployment of Automation Composition Elements returned
CLAMP_GUI Instance has been requested
end
else
ACM_Runtime -> CLAMP_GUIREST: Display statistics for Automation Composition Elementsinstance indoes Automation Composition Instance
== Statistics of all Participants ==
CLAMP_GUI -> CLAMP_Runtime: [REST] Read summary statistics for all Automation Composition Instances
CLAMP_Runtime -> ACM_Database: Compile summary statistics for all Automation Composition Instances
CLAMP_Runtime -> CLAMP_GUI: [REST] Summary statistics for all Automation Composition Instances returned
CLAMP_GUI -> CLAMP_GUI: Display summary statistics for all Automation Composition Instances
== Statistics of a Participant ==
CLAMP_GUI -> CLAMP_Runtime: [REST] Read statistics for Automation Composition Elements for Participant
CLAMP_Runtime -> ACM_Database: Read statistics for Automation Composition Elements for Participant
CLAMP_Runtime -> CLAMP_GUI: [REST] Statistics for Automation Composition Elements returned
CLAMP_GUI -> CLAMP_GUI: Display statistics for Automation Composition Elements in Participant
== Filtered Statistics ==
CLAMP_GUI -> CLAMP_GUI: Set filter for Automation Composition Instances, Automation Composition Elements, and Participants
CLAMP_GUI -> CLAMP_Runtime: [REST] Read statistics for Automation Composition Elements that match filter
CLAMP_Runtime -> ACM_Database: Read statistics for Automation Composition Elements that match filter
CLAMP_Runtime -> CLAMP_GUI: [REST] Statistics for Automation Composition Elements that match filter returned
CLAMP_GUI -> CLAMP_GUI: Display statistics for Automation Composition Elements that match filter
@enduml |
3.3 Statistics Housekeeping
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 |
PlantUML Macro |
---|
@startuml
participant CLAMP_Runtime
database ACM_Database == Automation Composition Instance Statistics ==
loop forever
CLAMP_Runtime -> ACM_Database: ReadStore Automation Composition Element Instance Response Statistics
CLAMPInformation
alt Is AC Element Instance Deployed?
ACM_Runtime -> CLAMPACM_RuntimeDatabase: SummariseSet AutomationAC CompositionElement Instance State Statisticsas DEPLOYED
CLAMP_Runtime -> ACM_Database: Store summarised Automation Composition Instance Statistics
CLAMPalt Are all the other AC Element Instances in this AC Instance in state DEPLOYED?
ACM_Runtime -> ACM_DatabaseRuntime: DeleteSet AutomationAC Composition Instance Statistics on which retention period has expired
end
== Participant Statistics ==
loop forever
CLAMP_Runtime -> ACM_Database: Read Participant Statistics
CLAMP_Runtime -> CLAMP_Runtime: Summarise Participant Statistics
CLAMPstate 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 StoreAutomation summarisedComposition ParticipantInstance StatisticsInformation
alt Automation CLAMP_Runtime -> ACM_Database: Delete Participant Statistics on which retention period has expired
end
@enduml |
4. Supervision Dialogues
Supervision dialogues are used to check the state of Automation Composition Instances and Participants.
4.1 Supervise Participants
PlantUML Macro |
---|
@startuml
participant CLAMP_Runtime
database ACM_Database loop forever
CLAMPComposition 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 -> ACM_DatabaseParticipants: Read Participants
loop Over each Participant
alt Participant has not reported in last reporting window
CLAMP[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 -> CLAMP_RuntimeREST: Undeployment Logof ParticipantAutomation asComposition havingInstance missedhas 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
ACMa report
CLAMP_Runtime -> ACM_Database: Increment missed report counter on Participant
alt Participant has exceeded alarm threshold on missed report counter
CLAMP_Runtime -> CLAMP_Runtime: Raise a Participant Offline alarm on participant
CLAMP_Runtime -> ACM_Database: Mark participant as being offline
end
else Participant has reported in last reporting window
CLAMP_Runtime -> ACM_Database: Clear missed report counter on Participant
alt Participant marked as being offline
CLAMP_Runtime -> CLAMP_Runtime: Clear Participant Offline alarm on participant
CLAMP_Runtime -> ACM_Database: Mark participant as being online
end
end
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
participant CLAMPACM_Runtime
database ACM_Database loop forever
CLAMP
participant Participant
database ACM_Database
ACM_Runtime <- Participant: [ASYNC] Undeploy Automation Composition Element Instance Response
ACM_Runtime -> ACM_Database: ReadStore Automation Composition Instances
Element Instance loop Over each Automation Composition Instance
loop Over each Automation Composition Element
alt Automation Composition Element has not reported in last reporting window
CLAMPResponse Information
alt Is AC Element Instance undeployed?
ACM_Runtime -> ACM_Database: Mark AC Element Instance as UNDEPLOYED
alt Are all the other AC Element Instances in this AC Instance in state UNDEPLOYED?
ACM_Runtime -> CLAMPACM_Runtime: LogSet AutomationAC CompositionInstance Elementstate as UNDEPLOYED
having missed a report
CLAMP 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: Increment missed report counter on 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
ACMelse Automation Composition Element has reported in last reporting window
CLAMP_Runtime -> ACM_Database: ClearRead missedAutomation reportComposition counter onInstance Information
alt Automation Composition Element
end
Instance exists
alt Automation Composition ElementInstance in incorrectadministrative state in last reporting windowis LOCKED
CLAMPACM_Runtime -> CLAMP_RuntimeParticipants: Log[ASYNC] AutomationUnlock CompositionAC Element as being in incorrect state
CLAMPInstances for this AC Instance
ACM_Runtime -> ACM_Database: Mark RecordAC AutomationInstance Compositionand Elementits asAC beingElement inInstances incorrectas stateUnlocking
ACM_Runtime -> REST: Unlocking elseof Automation Composition ElementInstance nothas inbeen incorrect state in last reporting windowrequested
else
ACM_Runtime alt-> REST: Automation Composition Elementinstance wasis innot incorrect state on previous report
CLAMPlocked
end
else
ACM_Runtime -> REST: Automation Composition instance does not exist
end
@enduml |
Each participant unlocks its AC Element Instances from the AC Instance.
PlantUML Macro |
---|
@startuml
participant ACM_Runtime
participant Participant
participant Participant_API
ACM_Runtime -> CLAMP_RuntimeParticipant: Log[ASYNC] AutomationUnlock CompositionAC Element Instances asfor beingthis inAC correctInstance state
loop over AC Element Instances in CLAMP_Runtime -> ACM_Database: Record Automation Composition Element as being in correct state
end
end
alt Automation Composition Element reported fault in last reporting window
CLAMP_Runtime -> CLAMP_Runtime: Log Automation Composition Element as being faulty
CLAMP_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
CLAMP_Runtime -> CLAMP_Runtime: Log Automation Composition Element fault as cleared
CLAMP_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
CLAMP_Runtime -> CLAMP_Runtime: Raise a Automation Composition Offline alarm on Automation Composition Instance
CLAMPAC 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: MarkSet AutomationAC CompositionElement Instance administrative state as being offlineUNLOCKED
alt Have all elsethe Noother AutomationAC CompositionElement ElementInstances in Automationthis CompositionAC Instance hasbeen exceededUNLOCKED?
alarm 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
ACMthreshold on missed report counter
alt Automation Composition Instance marked as being offline
CLAMP_Runtime -> CLAMP_Runtime: Clear Automation Composition Instance Offline alarm on Automation Composition CLAMP_Runtime -> ACM_Database: MarkRead Automation Composition Instance as being online
end
end
Composition Instance Information
alt Automation Composition Instance Elementexists
inalt Automation Composition Instance in incorrectadministrative state in last reporting windowis UNLOCKED
CLAMPACM_Runtime -> CLAMP_RuntimeParticipants: Log[ASYNC] AutomationLock CompositionAC InstanceElement asInstances beingfor inthis incorrectAC stateInstance
CLAMPACM_Runtime -> ACM_Database: Record Automation Composition Instance as being in incorrect state
alt Automation Composition Element in Mark AC Instance and its AC Element Instances as Locking
ACM_Runtime -> REST: Locking of Automation Composition Instance has been requested
else
ACM_Runtime -> REST: Automation Composition Instanceinstance is hasnot exceeded alarm threshold on incorrect state reports
CLAMPunlocked
end
else
ACM_Runtime -> REST: Automation Composition instance does not exist
end
@enduml |
Each participant locks its AC Element Instances from the AC Instance.
PlantUML Macro |
---|
@startuml
participant ACM_Runtime
participant Participant
participant Participant_API
ACM_Runtime -> CLAMP_RuntimeParticipant: Raise[ASYNC] aLock AutomationAC CompositionElement InstanceInstances infor Incorrectthis StateAC alarm on Automation Composition Instance
CLAMP_Runtime -> ACM_Database: Mark Automation Composition Instance as being in an incorrect state
end
else No Automation Composition Element in incorrect state in last reporting window
alt Automation Composition Element in Automation Composition Instance was in incorrect state on previous report
CLAMP_Runtime -> CLAMP_Runtime: Log Automation Composition Instance as being in correct state
CLAMP_Runtime -> ACM_Database: Record Automation Composition Instance as being in correct state
alt Automation Composition Instance in Incorrect State alarm raised on Automation Composition Instance
CLAMP_Runtime -> CLAMP_Runtime: Clear Automation Composition Instance in Incorrect State alarm on Automation Composition Instance
end
end
end
alt Automation Composition Element in Automation Composition Instance reported a fault in last reporting window
CLAMP_Runtime -> CLAMP_Runtime: Log Automation Composition Instance as being faulty
CLAMPInstance
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_Database: RecordStore Automation Composition Element Instance as being faulty
alt Automation Composition Element in Automation Composition Instance has exceeded alarm threshold on faulty reports
CLAMPResponse Information
alt Is AC Element Instance Locked?
ACM_Runtime -> CLAMPACM_RuntimeDatabase: RaiseSet aAC Automation CompositionElement Instance Faultyadministrative alarmstate onas AutomationLOCKED
Compositionalt Instance
Have all the other AC Element end
Instances in this AC elseInstance Nobeen AutomationLOCKED?
Composition Element faulty in last reporting window
alt Automation Composition Element in Automation Composition Instance was faulty on previous report
CLAMP_Runtime -> CLAMP_Runtime: Log Automation Composition Instance as being fault free
CLAMP_RuntimeACM_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 Participant_API
participant Participant
participant ACM_Runtime
Participant_API -> Participant_API: Perform Operation that Updates Operational State
activate Participant_API
deactivate Participant_API
Participant_API -> Participant: Operational State has been updated
Participant -> Participant: Update Operational State in ACM Element Instance
== Periodically with Heartbeat ==
Participant -> ACM_DatabaseRuntime: Record[ASYNC] AutomationHeartbeat Compositionmessage Instanceincluding\nstatus asand beingstates faultof free
AC Element Instances on Participant
@enduml |
3.9 Update Usage State on Automation Composition Instance
PlantUML Macro |
---|
@startuml
participant Participant_API
participant alt Automation Composition Instance Faulty alarm raised on Automation Composition Instance
CLAMP_Runtime -> CLAMP_Runtime: Clear Automation Composition Instance Faulty alarm on Automation Composition Instance
end
end
end
end
endParticipant
participant ACM_Runtime
Participant_API -> Participant_API: Perform Operation that Updates Usage State
activate Participant_API
deactivate Participant_API
Participant_API -> Participant: Usage State has been updated
Participant -> Participant: Update Usage State in ACM Element Instance
== Periodically with Heartbeat ==
Participant -> ACM_Runtime: [ASYNC] Heartbeat message including\nstatus and states of AC Element Instances on Participant
@enduml |