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.
2 Commissioning Dialogues
2.1 REST REST ACM_Runtime ACM_Runtime Commissioned_ACM_Inventory Commissioned_ACM_Inventory Commission Automation Composition Type Definition alt [Automation Composition Type exists and has Instances] Type Definition Commissioning Failed Store Automation Composition Type Definition Trigger Priming of Automation Composition Type Definition Type Definition Commissioned
2.2 SDC SDC Policy_Distribution Policy_Distribution ACM_Runtime ACM_Runtime [DMaaP] CSAR containing Automation Composition Type Definition Commission Automation Composition Type Definition (See Commissioning Sequence Diagram) Result of commissioning [DMaaP] Return result of Deployment
2.3 Deleting an Automation Composition Type Definition CLAMP_GUI CLAMP_GUI CLAMP_Runtime CLAMP_Runtime Participant Participant Commissioned_ACM_Inventory Commissioned_ACM_Inventory [REST] Read Automation Composition Type Definitions Read Automation Composition Type Definitions [REST] Type Definitions returned Select Automation Composition Type Definition for Parameterization [REST] Fetch GUI fields for Common Parameter Definitions alt [Automation Composition Type Definition not Commissioned on Participants] Read Automation Composition Type Definition Generate fields for Common Parameters for GUI [REST] Return GUI fields Common Parameter Definitions Render UI for Common Parameters Get values for Common Parameters from user [REST] Set values for Common Parameters Store values for Common Parameters [REST] Common Parameter values stored [Automation Composition Type Definition already Commissioned on Participants] [REST] Cannot set Common Parameters on Automation Composition Type Definition that has been commissioned on participants
2.4 CLAMP_GUI CLAMP_GUI CLAMP_Runtime CLAMP_Runtime Participant Participant Commissioned_ACM_Inventory Commissioned_ACM_Inventory Participants Participants [REST] Read Automation Composition Type Definitions Read Automation Composition Type Definitions [REST] Type Definitions returned Select Automation Composition Type Definition for Priming on Participants [REST] Prime Automation Composition Type Definition on Participants alt [Automation Composition Type Definition not Primed on Participants] Read Automation Composition Type Definition Read Common Parameter Values for Automation Composition Type Definition alt [Common Parameter values set for Automation Composition Type Definition] [DMaaP] Update Participants with Automation Composition Type Definition and values for Common Parameters [REST] Automation Composition Type Definition priming ordered on participants [Automation Composition Type Definition already primed on Participants] [REST] Common Parameters not set on Automation Composition Type Definition [Automation Composition Type Definition already primed on Participants] [REST] Cannot set Common Parameters on Automation Composition Type Definition that has been primed on participants Participant Responses [DMaaP] Result of Update with Automation Composition Type Definition and values for Common Parameters Store result of Automation Composition Type Definition Update on Participant Supervision loop [forever] Read Automation Composition Type Definitions loop [over each Automation Composition Type Definition] alt [Automation Composition Type Definition Participant priming underway] read result of Automation Composition Type Definition Updates from participants alt [Updates completed on all participants] set Automation Composition Type Definition as primed on Participants [Updates not completed] alt [Priming of Automation Composition Type Definition on participants timed out] set Automation Composition Type Definition priming as timed out on Participants Log error [Wait for updates to complete] [Automation Composition Type Definition Participant priming not underway]
2.5 This dialogue allows an Automation Composition Type Definition to be de-primed so that it can be deleted or its common parameter values can be altered.
CLAMP_GUI CLAMP_GUI CLAMP_Runtime CLAMP_Runtime Participant Participant Commissioned_ACM_Inventory Commissioned_ACM_Inventory Participants Participants [REST] Read Automation Composition Type Definitions Read Automation Composition Type Definitions [REST] Type Definitions returned Select Automation Composition Type Definition for de-priming on Participants [REST] De-prime Automation Composition Type Definition on Participants alt [Automation Composition Type Definition primed on Participants] alt [Automation Composition Instances do not exist for Automation Composition Type Definition] [DMaaP] Update Participants, removing Automation Composition Type Definition and values for Common Parameters [REST] Automation Composition Type Definition de-priming ordered on participants [Automation Composition Instances exist for Automation Composition Type Definition] [REST] Automation Composition Type Definition cannot be de-primed on participants it is in use on Automation Compositions [Automation Composition Type Definition not primed on Participants] [REST] Automation Composition Type Definition has not been primed on participants Participant Responses [DMaaP] Result of Update to remove Automation Composition Type Definition and values for Common Parameters Store result of Automation Composition Type Definition Update on Participant Supervision loop [forever] Read Automation Composition Type Definitions loop [over each Automation Composition Type Definition] alt [Automation Composition Type Definition Participant de-prime underway] read result of Automation Composition Type Definition Updates from participants alt [Updates completed on all participants] set Automation Composition Type Definition as de-primeed on Participants [Updates not completed] alt [De-priming of Automation Composition Type Definition on participants timed out] set Automation Composition Type Definition de-priming as timed out on Participants Log error [Wait for updates to complete] [Automation Composition Type Definition Participant de-prime not underway]
2.6 CLAMP_GUI CLAMP_GUI CLAMP_Runtime CLAMP_Runtime Commissioned_ACM_Inventory Commissioned_ACM_Inventory [REST] Read Automation Composition Type Definitions Read Automation Composition Type Definitions [REST] Type Definitions returned Select Automation Composition Type Definition for Decommissioning [REST] Decommission Automation Composition Type Definition alt [Automation Composition Type Definition not primed on Participants] Delete Automation Composition Type Definition [REST] Type Definition Decommissioned [Automation Composition Type Definition is Commissioned on Participants] [REST] Automation Composition Type Definition cannot be decommissioned it is primed on participants
2.7 Reading Commissioned Automation Composition Type Definitions CLAMP_GUI CLAMP_GUI CLAMP_Runtime CLAMP_Runtime Commissioned_ACM_Inventory Commissioned_ACM_Inventory [REST] Read Automation Composition Type Definitions Read Automation Composition Type Definitions [REST] Type Definitions returned
3. Instantiation Dialogues
3.1 CLAMP_GUI CLAMP_GUI CLAMP_Runtime CLAMP_Runtime Commissioned_ACM_Inventory Commissioned_ACM_Inventory Instantiated_ACM_Inventory Instantiated_ACM_Inventory [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 Instantiated_ACM_Inventory Instantiated_ACM_Inventory [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 Instantiated_ACM_Inventory Instantiated_ACM_Inventory 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 Instantiated_ACM_Inventory Instantiated_ACM_Inventory 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 Instantiated_ACM_Inventory Instantiated_ACM_Inventory 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 Instantiated_ACM_Inventory Instantiated_ACM_Inventory [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 Instantiated_ACM_Inventory Instantiated_ACM_Inventory [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 Instantiated_ACM_Inventory Instantiated_ACM_Inventory [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 -> Instantiated_ACM_Inventory: Record fault on Automation Composition Element and Automation Composition end
CLAMP_GUI CLAMP_GUI CLAMP_Runtime CLAMP_Runtime Instantiated_ACM_Inventory Instantiated_ACM_Inventory 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 Instantiated_ACM_Inventory Instantiated_ACM_Inventory 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 Instantiated_ACM_Inventory Instantiated_ACM_Inventory 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 Instantiated_ACM_Inventory Instantiated_ACM_Inventory 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 CLAMP_Runtime CLAMP_Runtime Instantiated_ACM_Inventory Instantiated_ACM_Inventory loop [forever] 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] Log Automation Composition Element as having missed a report Increment missed report counter on Automation Composition Element [Automation Composition Element has reported in last reporting window] Clear missed report counter on Automation Composition Element alt [Automation Composition Element in incorrect state in last reporting window] Log Automation Composition Element as being in incorrect state Record Automation Composition Element as being in incorrect state [Automation Composition Element not in incorrect state in last reporting window] alt [Automation Composition Element was in incorrect state on previous report] Log Automation Composition Element as being in correct state Record Automation Composition Element as being in correct state alt [Automation Composition Element reported fault in last reporting window] Log Automation Composition Element as being faulty Record Automation Composition Element as being faulty [Automation Composition Element did not report fault in last reporting window] alt [Automation Composition Element reported fault on previous report] Log Automation Composition Element fault as cleared Mark fault Automation Composition Element as being cleared alt [Automation Composition Element in Automation Composition Instance has exceeded alarm threshold on missed report counter] Raise a Automation Composition Offline alarm on Automation Composition Instance Mark Automation Composition Instance as being offline [No Automation Composition Element in Automation Composition Instance has exceeded alarm threshold on missed report counter] alt [Automation Composition Instance marked as being offline] Clear Automation Composition Instance Offline alarm on Automation Composition CLAMP_Runtime -> Instantiated_ACM_Inventory: Mark Automation Composition Instance as being online alt [Automation Composition Element in Automation Composition Instance in incorrect state in last reporting window] Log Automation Composition Instance as being in incorrect state Record Automation Composition Instance as being in incorrect state alt [Automation Composition Element in Automation Composition Instance has exceeded alarm threshold on incorrect state reports] Raise a Automation Composition Instance in Incorrect State alarm on Automation Composition Instance Mark Automation Composition Instance as being in an incorrect state [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] Log Automation Composition Instance as being in correct state Record Automation Composition Instance as being in correct state alt [Automation Composition Instance in Incorrect State alarm raised on Automation Composition Instance] Clear Automation Composition Instance in Incorrect State alarm on Automation Composition Instance alt [Automation Composition Element in Automation Composition Instance reported a fault in last reporting window] Log Automation Composition Instance as being faulty Record Automation Composition Instance as being faulty alt [Automation Composition Element in Automation Composition Instance has exceeded alarm threshold on faulty reports] Raise a Automation Composition Instance Faulty alarm on Automation Composition Instance [No Automation Composition Element faulty in last reporting window] alt [Automation Composition Element in Automation Composition Instance was faulty on previous report] Log Automation Composition Instance as being fault free Record Automation Composition Instance as being fault free alt [Automation Composition Instance Faulty alarm raised on Automation Composition Instance] Clear Automation Composition Instance Faulty alarm on Automation Composition Instance