Priming The CLAMP Automation Composition Runtime Lifecycle Management uses the following system-level dialogues. These dialogues enable the CLAMP runtime capabilities described in Section 2 of TOSCA Defined Automation Compositions: Architecture and Design . Design Time dialogues will be described in future releases of the system.
1 Dialogues on Participants 1.1 Participant Registration Participant Registration is performed by a Participant when it starts up. It registers its ID and the ACM Element Types it supports with the ACM runtime. Participant Participant ACM_Runtime ACM_Runtime ACM_Database ACM_Database [ASYNC] Register [ASYNC] Create or Update Participant Registration and store supported ACM element types Registration Accepted
1.2 Participant Deregistration Participant Deregistration is performed by a Participant when it shuts down. It deregisters its ID and type with the ACM runtime.
The participant should already have cleared down all its ACM Element instances and set their states to UNINITIALIZED. Participant Participant ACM_Runtime ACM_Runtime ACM_Database ACM_Database Uninitialize all ACM Element Instances running on Participant (See Instantiation Dialogues) Delete Participant Registration [ASYNC] Deregistration Accepted
1.3 Participant Supervision 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.
Participant Participant ACM_Runtime ACM_Runtime ACM_Database ACM_Database loop [Every Participant Supervision Interval] Heartbeat message Update Participant Heartbeat data
The ACM runtime regularly checks the heartbeat reports from participants and takes action of participants time out. If a heartbeat message is not received for a participant in the Timeout Interval, the participant is marked as timed out and its ACM element instances are informed.
ACM_Runtime ACM_Runtime ACM_Database ACM_Database Database Database loop [Every ACM_Runtime Supervision Interval] loop [Over all Participants] Read Participant Heartbeat Information alt [Participant Heartbeat not received in Timeout Interval] Inform all ACM Element Instances running on Participant of Timeout (See Instantiation Dialogues)
The information on participants is available over a REST endpoint.
REST REST ACM_Runtime ACM_Runtime ACM_Database ACM_Database Get Participant Information Read Participant Data Return Participant Information including supported ACM Element Types and Heartbeat Information
2 Dialogues on Automation Composition Types
2.1
REST REST ACM_Runtime ACM_Runtime ACM_Database ACM_Database Commission Automation Composition Type alt [Automation Composition Type exists and has Instances] Automation Composition Type Commissioning Failed Create and Store Automation Composition Type Automation Composition Type Commissioned
2.2 SDC SDC Policy_Distribution Policy_Distribution ACM_Runtime ACM_Runtime [ASYNC] CSAR containing Automation Composition Type Definition Commission Automation Composition Type (See Commissioning Sequence Diagram) Result of Commissioning [ASYNC] Return result of Deployment
2.3 Decommissioning an Automation Composition Type Definition REST REST ACM_Runtime ACM_Runtime ACM_Database ACM_Database Decommission Automation Composition Type alt [Automation Composition Type has Instances] Automation Composition Type Decommissioning Failed Delete Automation Composition Type Automation Composition Type Decommissioned
2.4
REST REST ACM_Runtime ACM_Runtime Participant Participant ACM_Database ACM_Database Priming REST Request Prime Automation Composition Type Read Automation Composition Type [ASYNC] Send Priming Request to all Participants with Automation Composition Type Definition Priming of Automation Composition Type Ordered Each Participant [ASYNC] Receive Priming Request with Automation Composition Type Definition loop [Over all Automation Composition Element Type Definitions in Automation Composition Type Definition] alt [Automation Composition Element Type supported by Participant] Save Automation Composition Element Type details on this Participant [ASYNC] Send Priming Response claiming Automation Composition Element Type alt [Automation Composition Element Type already Primed] Ignore Priming Response Record Participant for Automation Composition Element Type and set Element Type as Primed Ignore Priming Request
2.5 This dialogue allows an Automation Composition Type to be read.
REST REST ACM_Runtime ACM_Runtime ACM_Database ACM_Database Get Automation Composition Type Information Read Automation Composition Type Information Respond with Automation Composition information including ACM Element Type information and Priming Status
3. Instantiation Dialogues
3.1 CLAMP_GUI CLAMP_GUI CLAMP_Runtime CLAMP_Runtime ACM_Database ACM_Database [REST] Read Automation Composition Type Definitions Read Automation Composition Type Definitions [REST] Type Definitions returned Select Automation Composition Type Definition to use to create Automation Composition Instance [REST] Fetch GUI fields for Instance Specific Parameter Definitions Read Automation Composition Type Definition Generate fields for Instance Specific Parameters for GUI [REST] Return GUI fields Instance Specific Parameter Definitions Render UI for Instance Specific Parameters Get values for Instance Specific Parameters from user [REST] Request Creation of Automation Composition Instance Create Automation Composition Instance Store First Version of Automation Composition Instance [REST] Automation Composition Instance Updated
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 CLAMP_GUI CLAMP_GUI CLAMP_Runtime CLAMP_Runtime ACM_Database ACM_Database [REST] Read Automation Composition Instances Read Automation Composition Instances [REST] Automation Composition Instances returned Select Automation Composition Instance on which to Update Parameters Step version of Automation Composition Instance as Major/Minor/Patch [REST] Fetch GUI fields for Instance Specific Parameter Definitions Read Automation Composition Type Definition Generate fields for Instance Specific Parameters for GUI [REST] Return GUI fields Instance Specific Parameter Definitions Render UI for Instance Specific Parameters Get values for Instance Specific Parameters from user [REST] Request Update of Automation Composition Instance Update Automation Composition Instance Store New Version of Automation Composition Instance [REST] Automation Composition Instance Updated
3.3 Updating an on Participants CLAMP_GUI CLAMP_GUI CLAMP_Runtime CLAMP_Runtime Participant Participant ACM_Database ACM_Database Participants Participants [REST] Read all configuration versions of Automation Composition Instance Read all configuration versions of Automation Composition Instance [REST] All configuration versions of Automation Composition Instance returned Select configuration version of Automation Composition Instance for Instantiation Participants [REST] Instantiate selected configuration version of Automation Composition Instance on Participants alt [Selected configuration version of Automation Composition Instance not instantiated on Participants] Read configuration version of Automation Composition Instance [DMaaP] Update Participants with configuration version of Automation Composition Instance [REST] Instantiation of configuration version of Automation Composition Instance ordered on participants [Selected configuration version of Automation Composition Instance instantiated on Participants] [REST] configuration version of Automation Composition Instance already instantiated on participants Participant Responses [DMaaP] Result of update of configuration version of Automation Composition Instance on participant Store result of update of configuration version of Automation Composition Instance on participant Supervision loop [forever] Read Automation Composition Instances loop [over each Automation Composition Instance] alt [Automation Composition Instance configuration version update underway on participants] read result of Automation Composition updates from participants alt [Updates completed on all participants] set configuration version of Automation Composition Instance as Instantiated on Participants set overall configuration version of Automation Composition Instance state as Instantiated [Updates not completed] alt [Instantiation of Automation Composition Instance on participants timed out] set configuration version Automation Composition Instance Instantiation as timed out on Participants Log error [Wait for updates to complete] [Automation Composition Instance configuration version update on participants not underway]
Changing the state of an Automation Composition Instance on Participants CLAMP_GUI CLAMP_GUI CLAMP_Runtime CLAMP_Runtime Participant Participant ACM_Database ACM_Database Participants Participants [REST] Read all Instantiated Automation Composition Instances Read all Instantiated Automation Composition Instances [REST] All Instantiated Automation Composition Instances returned Select Automation Composition Instance on which to change state and specify new state [REST] Change state of selected Automation Composition Instance on Participants alt [Selected Automation Composition Instance instantiated on Participants] [DMaaP] Request change of state of Automation Composition Instance [REST] Change of state of Automation Composition Instance ordered on participants [Selected Automation Composition Instance not instantiated on Participants] [REST] Automation Composition Instance not instantiated on participants Participant Responses [DMaaP] Result of State Change of Automation Composition Instance on participant Store result of State Change of Automation Composition Instance on participant Supervision loop [forever] Read Automation Composition Instances loop [over each Automation Composition Instance] alt [Automation Composition Instance State Change underway on participants] read result of Automation Composition State Change from participants alt [Updates completed on all participants] set Automation Composition Instance state as changed on Participants set overall Automation Composition Instance state as changed [Updates not completed] alt [Automation Composition Instance State Change on participants timed out] set Automation Composition State Change as timed out on Participants Log error [Wait for updates to complete] [Automation Composition Instance State Change on participants not underway]
3.5 De-instantiating an Automation Composition Instance from Participants CLAMP_GUI CLAMP_GUI CLAMP_Runtime CLAMP_Runtime Participant Participant ACM_Database ACM_Database Participants Participants [REST] Read all Instantiated Automation Composition Instances Read all Instantiated Automation Composition Instances [REST] All Instantiated Automation Composition Instances returned Select Automation Composition Instance to de-instantiate [REST] De-instantiate selected Automation Composition Instance on Participants alt [Selected Automation Composition Instance instantiated on Participants] [DMaaP] Update Participants to remove Automation Composition Instance [REST] De-instantiation of Automation Composition Instance ordered on participants [Selected Automation Composition Instance not instantiated on Participants] [REST] Automation Composition Instance not instantiated on participants Participant Responses [DMaaP] Result of update of Automation Composition Instance on participant Store result of update of Automation Composition Instance on participant Supervision Read Automation Composition Instances loop [over each Automation Composition Instance] alt [Automation Composition Instance de-instantiation update underway on participants] read result of Automation Composition updates from participants alt [Updates completed on all participants] set Automation Composition Instance as de-instantiated on Participants set overall Automation Composition Instance as de-instantiated [Updates not completed] alt [Automation Composition Instance de-instantiation Update timed out on participants] set Automation Composition Instance de-instantiation as timed out on Participants Log error [Wait for updates to complete] [Automation Composition Instance de-instantiation update on participants not underway]
3.6 Deleting an Automation Composition Instance CLAMP_GUI CLAMP_GUI CLAMP_Runtime CLAMP_Runtime ACM_Database ACM_Database [REST] Read all Automation Composition Instances Read all Automation Composition Instances [REST] All Automation Composition Instances returned Select Automation Composition Instance to delete [REST] Delete selected Automation Composition Instance alt [Selected Automation Composition Instance exists] Delete Automation Composition instance [REST] Automation Composition Instance deleted [Selected Automation Composition Instance does not exist] [REST] Automation Composition Instance does not exist
3.7 Reading Automation Composition Instances CLAMP_GUI CLAMP_GUI CLAMP_Runtime CLAMP_Runtime ACM_Database ACM_Database [REST] Read all Automation Composition Instances Read all Automation Composition Instances [REST] All Automation Composition Instances returned
3. Monitoring Dialogues Monitoring dialogues are used to monitor and read statistics on Automation Composition Instances.
CLAMP_Runtime CLAMP_Runtime Participant Participant ACM_Database ACM_Database [DMaaP] Participant and Automation Composition Element Monitoring and Statistics report Store Participant and Automation Composition Element Monitoring and Statistics report alt [Fault reported on Participant] log fault on Participant Record fault on Participant alt [Fault reported on Automation Composition Element] log fault on Automation Composition Element and Automation Composition CLAMP_Runtime -> ACM_Database: Record fault on Automation Composition Element and Automation Composition end
CLAMP_GUI CLAMP_GUI CLAMP_Runtime CLAMP_Runtime ACM_Database ACM_Database Overview of all Automation Composition Instances [REST] Read all Automation Composition Instances Read all Automation Composition Instances [REST] All Automation Composition Instances returned Display overview of status of all Automation Composition Instances Details of a Automation Composition Instance [REST] Read Automation Composition Elements for Automation Composition Instance Read Automation Composition Elements for Automation Composition Instance [REST] Automation Composition Elements returned Display status of Automation Composition Elements in Automation Composition Instance Overview of all Participants [REST] Read all participants Read all participants [REST] All participants returned Display overview of status of all participants Details of a Participant [REST] Read Automation Composition Elements for Participant Read Automation Composition Elements for Participant [REST] Automation Composition Elements returned Display status of Automation Composition Elements in Participant Filtered Monitoring Set filter for Automation Composition Instances, Automation Composition Elements, and Participants [REST] Read Automation Composition Elements that match filter Read Automation Composition Elements that match filter [REST] Automation Composition Elements that match filter returned Display status of Automation Composition Elements that match filter
3.2 Viewing of Statistics CLAMP_GUI CLAMP_GUI CLAMP_Runtime CLAMP_Runtime ACM_Database ACM_Database Statistics of all Automation Composition Instances [REST] Read summary statistics for all Automation Composition Instances Compile summary statistics for all Automation Composition Instances [REST] Summary statistics for all Automation Composition Instances returned Display summary statistics for all Automation Composition Instances Statistics of a Automation Composition Instance [REST] Read statistics for Automation Composition Elements for Automation Composition Instance Compile statistics for Automation Composition Elements for Automation Composition Instance [REST] Statistics for Automation Composition Elements returned Display statistics for Automation Composition Elements in Automation Composition Instance Statistics of all Participants [REST] Read summary statistics for all Automation Composition Instances Compile summary statistics for all Automation Composition Instances [REST] Summary statistics for all Automation Composition Instances returned Display summary statistics for all Automation Composition Instances Statistics of a Participant [REST] Read statistics for Automation Composition Elements for Participant Read statistics for Automation Composition Elements for Participant [REST] Statistics for Automation Composition Elements returned Display statistics for Automation Composition Elements in Participant Filtered Statistics Set filter for Automation Composition Instances, Automation Composition Elements, and Participants [REST] Read statistics for Automation Composition Elements that match filter Read statistics for Automation Composition Elements that match filter [REST] Statistics for Automation Composition Elements that match filter returned Display statistics for Automation Composition Elements that match filter
3.3 Statistics Housekeeping CLAMP_Runtime CLAMP_Runtime ACM_Database ACM_Database Automation Composition Instance Statistics loop [forever] Read Automation Composition Instance Statistics Summarise Automation Composition Instance Statistics Store summarised Automation Composition Instance Statistics Delete Automation Composition Instance Statistics on which retention period has expired Participant Statistics loop [forever] Read Participant Statistics Summarise Participant Statistics Store summarised Participant Statistics Delete Participant Statistics on which retention period has expired
4. Supervision Dialogues Supervision dialogues are used to check the state of Automation Composition Instances and Participants.
4.1 Supervise Participants CLAMP_Runtime CLAMP_Runtime ACM_Database ACM_Database loop [forever] Read Participants loop [Over each Participant] alt [Participant has not reported in last reporting window] Log Participant as having missed a report Increment missed report counter on Participant alt [Participant has exceeded alarm threshold on missed report counter] Raise a Participant Offline alarm on participant Mark participant as being offline [Participant has reported in last reporting window] Clear missed report counter on Participant alt [Participant marked as being offline] Clear Participant Offline alarm on participant Mark participant as being online
4.2 Supervise Automation Compositions PlantUML 1.2023.12 <b>This version of PlantUML is 301 days old, so you should <b>consider upgrading from https://plantuml.com/download [From string (line 40) ] @startuml participant CLAMP_Runtime database ACM_Database loop forever CLAMP_Runtime -> ACM_Database: Read Automation Composition Instances loop Over each Automation Composition Instance loop Over each Automation Composition Element alt Automation Composition Element has not reported in last reporting window CLAMP_Runtime -> CLAMP_Runtime: Log Automation Composition Element as having missed a report CLAMP_Runtime -> ACM_Database: Increment missed report counter on Automation Composition Element else Automation Composition Element has reported in last reporting window CLAMP_Runtime -> ACM_Database: Clear missed report counter on Automation Composition Element end alt Automation Composition Element in incorrect state in last reporting window CLAMP_Runtime -> CLAMP_Runtime: Log Automation Composition Element as being in incorrect state CLAMP_Runtime -> ACM_Database: Record Automation Composition Element as being in incorrect state else Automation Composition Element not in incorrect state in last reporting window alt Automation Composition Element was in incorrect state on previous report CLAMP_Runtime -> CLAMP_Runtime: Log Automation Composition Element as being in correct state 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 coun ... CLAMP_Runtime -> CLAMP_Runtime: Raise a Automation Composition Offline alarm on Automation Composition Instance CLAMP_Runtime -> ACM_Database: Mark Automation Composition Instance as being offline else No Automation Composition Element in Automation Composition Instance has exceeded alarm threshold on missed report ... 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: Mark Automation Composition Instance as being online Syntax Error?