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 Register a Participant 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 Deregister a Participant 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 "Not In Service". 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 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.
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 Decommission an Automation Composition Type 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
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.
ACM_Runtime ACM_Runtime Participant Participant participant participant [ASYNC] Bring AC Element Instances for this AC Instance into Service loop [over AC Element Instances in AC Instance] alt [Does the primed Participant ID on this AC Element Instance match my Participant ID] alt [Is this AC Element Instance already in service] [ASYNC] WARN: AC Element is already in service Bring AC Element Instance into Service alt [AC Element came into service successfully] [ASYNC] INFO: AC Element brought into service [ASYNC] ERROR: AC Element was not brought into service ignore this AC Element instance as its for another participant
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
REST REST ACM_Runtime ACM_Runtime ACM_Database ACM_Database Create Automation Composition Instance for specified Automation Composition Type with specified parameter values alt [Automation Composition Instance exists] alt [Automation Composition Instance is in state "In Service"] Automation Composition instance exists and is in use Updates on "Not In Service" Automation Composition Instances are allowed alt [Specified Automation Type Composition Exists] alt [Specified Automation Composition Type is Primed] Store Automation Composition Instance Automation Composition Instance Created Automation Composition Type is not primed Automation Composition Type is not found
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 REST REST ACM_Runtime ACM_Runtime ACM_Database ACM_Database Delete Automation Composition Instance alt [Automation Composition Instance exists] alt [Automation Composition Instance is in state "In Service"] Automation Composition instance exists and is in use Automation Composition instance does not exist Delete Automation Composition Instance Automation Composition Instance Deleted
3.3 Bring Automation Composition Instance into Service The user requests the AC Instance to come into service using a REST endpoint. The ACM Runtime orders the AC Instance to come into service.
REST REST ACM_Runtime ACM_Runtime Participants Participants ACM_Database ACM_Database Bring Automation Composition Instance into Service Read Automation Composition Instance Information alt [Automation Composition Instance exists] alt [Automation Composition Instance is in state "In Service"] Automation Composition instance exists and is already in service Automation Composition instance does not exist [ASYNC] Bring AC Element Instances for this AC Instance into Service Set status of AC Instance and its AC Element Instances as "Coming into Service" Automation Composition Instance has been requested to come into service
Each participant brings its AC Element Instances from the AC Instance into service.
ACM_Runtime ACM_Runtime Participant Participant participant participant [ASYNC] Bring AC Element Instances for this AC Instance into Service loop [over AC Element Instances in AC Instance] alt [Does the primed Participant ID on this AC Element Instance match my Participant ID?] alt [Is this AC Element Instance already in service] [ASYNC] WARN: AC Element is already in service Bring AC Element Instance into Service alt [AC Element came into service successfully] [ASYNC] INFO: AC Element brought into service [ASYNC] ERROR: AC Element was not brought into service ignore this AC Element instance as its for another participant
ACM_Runtime ACM_Runtime Participant Participant ACM_Database ACM_Database [ASYNC] Automation Composition Element Instance into Service Response Store Automation Composition Element Instance Response Information alt [Is AC Element Instance in service?] Set AC Element Instance as "In Service" Set AC Element Instance as "Not In Service"
Take Automation Composition Instance out of Service The user requests the AC Instance to drop out of service using a REST endpoint. The ACM Runtime orders the AC Instance to drop out of service.
REST REST ACM_Runtime ACM_Runtime Participants Participants ACM_Database ACM_Database Take Automation Composition Instance out of Service Read Automation Composition Instance Information alt [Automation Composition Instance exists] alt [Automation Composition Instance is in state "Out Of Service"] Automation Composition instance exists and is already out of service Automation Composition instance does not exist [ASYNC] Take AC Element Instances for this AC Instance out of Service Set status of AC Instance and its AC Element Instances as "Dropping out of Service" Automation Composition Instance has been requested to drop out of service
ACM_Runtime ACM_Runtime Participant Participant participant participant [ASYNC] Take AC Element Instances for this AC Instance out of Service loop [over AC Element Instances in AC Instance] alt [Does the primed Participant ID on this AC Element Instance match my Participant ID?] alt [Is this AC Element Instance already out of service] [ASYNC] WARN: AC Element is already out of service Bring AC Element Instance out of Service alt [AC Element drops out of service successfully] [ASYNC] INFO: AC Element taken out of service [ASYNC] ERROR: AC Element was not taken out of service ignore this AC Element instance as its for another participant
The ACM Runtime receives and stores the responses.
ACM_Runtime ACM_Runtime Participant Participant ACM_Database ACM_Database [ASYNC] Automation Composition Element Instance out of service Response Store Automation Composition Element Instance Response Information alt [Is AC Element Instance out of service?] Set AC Element Instance as "Not In Service" Set AC Element Instance as "In Service"
3.5 De-instantiating an Automation Composition Instance from Participants 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 3) ] @startuml participant REST participant ACM_Runtime Syntax Error?
3.6 Deleting an Automation Composition Instance 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 3) ] @startuml participant REST participant ACM_Runtime Syntax Error?
3.7 Reading Automation Composition Instances Welcome to PlantUML! You can start with a simple UML Diagram like: Bob->Alice: Hello Or class Example You will find more information about PlantUML syntax on https://plantuml.com (Details by typing license keyword) 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 3) ] @startuml participant REST participant ACM_Runtime Syntax Error?
3. Monitoring Dialogues Monitoring dialogues are used to monitor and read statistics on Automation Composition Instances.
ACM_Runtime ACM_Runtime Participant Participant ACM_Database ACM_Database [DMaaP] Participant and Automation Composition Element Monitoring and Statistics report ACM_Runtime -> ACM_Database: Store Participant and Automation Composition Element Monitoring and Statistics report alt [Fault reported on Participant ACM_Runtime -> ACM_Runtime: log fault on Participant ACM_Runtime -> ACM_Database: Record fault on Participant] alt [Fault reported on Automation Composition Element ACM_Runtime -> ACM_Runtime: log fault on Automation Composition Element and Automation Composition ACM_Runtime -> ACM_Database: Record fault on Automation Composition Element and Automation Composition end]
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 3) ] @startuml participant REST participant ACM_Runtime Syntax Error?
3.2 Viewing of Statistics 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 3) ] @startuml participant REST participant ACM_Runtime Syntax Error?
3.3 Statistics Housekeeping ACM_Runtime ACM_Runtime ACM_Database ACM_Database Automation Composition Instance Statistics loop [forever ACM_Runtime -> ACM_Database: Read Automation Composition Instance Statistics ACM_Runtime -> ACM_Runtime: Summarise Automation Composition Instance Statistics ACM_Runtime -> ACM_Database: Store summarised Automation Composition Instance Statistics ACM_Runtime -> ACM_Database: Delete Automation Composition Instance Statistics on which retention period has expired] Participant Statistics loop [forever ACM_Runtime -> ACM_Database: Read Participant Statistics ACM_Runtime -> ACM_Runtime: Summarise Participant Statistics ACM_Runtime -> ACM_Database: Store summarised Participant Statistics ACM_Runtime -> ACM_Database: 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 ACM_Runtime ACM_Runtime ACM_Database ACM_Database loop [forever ACM_Runtime -> ACM_Database: Read Participants] loop [Over each Participant] alt [Participant has not reported in last reporting window ACM_Runtime -> ACM_Runtime: Log Participant as having missed a report ACM_Runtime -> ACM_Database: Increment missed report counter on Participant] alt [Participant has exceeded alarm threshold on missed report counter ACM_Runtime -> ACM_Runtime: Raise a Participant Offline alarm on participant ACM_Runtime -> ACM_Database: Mark participant as being offline] [Participant has reported in last reporting window ACM_Runtime -> ACM_Database: Clear missed report counter on Participant] alt [Participant marked as being offline ACM_Runtime -> ACM_Runtime: Clear Participant Offline alarm on participant ACM_Runtime -> ACM_Database: Mark participant as being online]
4.2 Supervise Automation Compositions ACM_Runtime ACM_Runtime ACM_Database ACM_Database loop [forever ACM_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 ACM_Runtime -> ACM_Runtime: Log Automation Composition Element as having missed a report ACM_Runtime -> ACM_Database: Increment missed report counter on Automation Composition Element] [Automation Composition Element has reported in last reporting window ACM_Runtime -> ACM_Database: Clear missed report counter on Automation Composition Element] alt [Automation Composition Element in incorrect state in last reporting window ACM_Runtime -> ACM_Runtime: Log Automation Composition Element as being in incorrect state ACM_Runtime -> ACM_Database: 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 ACM_Runtime -> ACM_Runtime: Log Automation Composition Element as being in correct state ACM_Runtime -> ACM_Database: Record Automation Composition Element as being in correct state] alt [Automation Composition Element reported fault in last reporting window ACM_Runtime -> ACM_Runtime: Log Automation Composition Element as being faulty ACM_Runtime -> ACM_Database: 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 ACM_Runtime -> ACM_Runtime: Log Automation Composition Element fault as cleared ACM_Runtime -> ACM_Database: Mark fault Automation Composition Element as being cleared] alt [Automation Composition Element in Automation Composition Instance has exceeded alarm threshold on missed report counter ACM_Runtime -> ACM_Runtime: Raise a Automation Composition Offline alarm on Automation Composition Instance ACM_Runtime -> ACM_Database: 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 ACM_Runtime -> ACM_Runtime: Clear Automation Composition Instance Offline alarm on Automation Composition ACM_Runtime -> ACM_Database: Mark Automation Composition Instance as being online] alt [Automation Composition Element in Automation Composition Instance in incorrect state in last reporting window ACM_Runtime -> ACM_Runtime: Log Automation Composition Instance as being in incorrect state ACM_Runtime -> ACM_Database: 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 ACM_Runtime -> ACM_Runtime: Raise a Automation Composition Instance in Incorrect State alarm on Automation Composition Instance ACM_Runtime -> ACM_Database: 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 ACM_Runtime -> ACM_Runtime: Log Automation Composition Instance as being in correct state ACM_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 ACM_Runtime -> ACM_Runtime: 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 ACM_Runtime -> ACM_Runtime: Log Automation Composition Instance as being faulty ACM_Runtime -> ACM_Database: Record Automation Composition Instance as being faulty] alt [Automation Composition Element in Automation Composition Instance has exceeded alarm threshold on faulty reports ACM_Runtime -> ACM_Runtime: 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 ACM_Runtime -> ACM_Runtime: Log Automation Composition Instance as being fault free ACM_Runtime -> ACM_Database: Record Automation Composition Instance as being fault free] alt [Automation Composition Instance Faulty alarm raised on Automation Composition Instance ACM_Runtime -> ACM_Runtime: Clear Automation Composition Instance Faulty alarm on Automation Composition Instance]
