1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
3 .. _system-level-label:
5 ACM System Level Dialogues
6 ##########################
7 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.
14 1 Dialogues on Participants
15 ===========================
16 1.1 Register a Participant
17 --------------------------
19 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.
21 .. image:: ../images/system-dialogues/RegisterParticipant.png
23 1.2 Deregister a Participant
24 ----------------------------
25 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".
27 .. image:: ../images/system-dialogues/DeregisterParticipant.png
29 1.3 Supervise Participants
30 --------------------------
31 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.
33 .. image:: ../images/system-dialogues/SuperviseParticipantsStatusUpdate.png
35 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.
37 .. image:: ../images/system-dialogues/SuperviseParticipantsTimeout.png
39 1.4 Get Participant Information
40 -------------------------------
41 The information on participants is available over a REST endpoint.
43 .. image:: ../images/system-dialogues/GetParticipantInformation.png
45 1.5 Order Full Participant Report
46 ---------------------------------
48 .. image:: ../images/system-dialogues/FullParticipantReport.png
50 2 Dialogues on Automation Composition Types
51 ===========================================
52 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.
54 2.1 Commission or Update an Automation Composition Type
55 -------------------------------------------------------
56 Create on a POST and update on a PUT.
58 .. image:: ../images/system-dialogues/CommissionUpdateAcType.png
60 2.2 Commission an Automation Composition Type using SDC
61 -------------------------------------------------------
63 .. image:: ../images/system-dialogues/CommissionAcTypeSDC.png
65 2.3 Decommission an Automation Composition Type
66 -----------------------------------------------
68 .. image:: ../images/system-dialogues/DecommissionAcType.png
70 2.4 Prime an Automation Composition Type on Participants
71 --------------------------------------------------------
72 The Priming operation sends Automation Composition Types and common property values to participants for each Automation Composition Element Type in the Automation Composition Type.
74 .. image:: ../images/system-dialogues/PrimeAcTypeOnPpnts.png
76 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.
78 .. image:: ../images/system-dialogues/PrimeAcTypeMultiplePpnts.png
80 The ACM Runtime updates the priming information in the database.
82 .. image:: ../images/system-dialogues/PrimeInfoUpdatedInDb.png
84 2.5 Deprime an Automation Composition Type on Participants
85 ----------------------------------------------------------
86 The Depriming operation removes Automation Composition Types and common property values on participants for each Automation Composition Element Type in the Automation Composition Type.
88 .. image:: ../images/system-dialogues/DeprimeOnParticipants.png
90 A participant should respond for each Automation Composition Element Type, thus causing the full Automation Composition Type to become deprimed.
92 .. image:: ../images/system-dialogues/DeprimeElements.png
94 The ACM Runtime updates the priming information in the database.
96 .. image:: ../images/system-dialogues/UpdateDeprimeInDb.png
98 2.6 Get Automation Composition Types
99 ------------------------------------
100 This dialogue allows an Automation Composition Type to be read.
102 .. image:: ../images/system-dialogues/GetAcTypes.png
104 3. Instantiation Dialogues
105 ==========================
106 Instantiation dialogues are used to create, set parameters on, instantiate, update, and remove Automation Composition instances.
108 3.1 Create an Automation Composition Instance
109 ---------------------------------------------
111 .. image:: ../images/system-dialogues/CreateAcInstance.png
113 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.
115 3.2 Delete an Automation Composition Instance
116 ---------------------------------------------
118 .. image:: ../images/system-dialogues/DeleteAcInstance.png
120 3.3 Deploy Automation Composition Instance
121 ------------------------------------------
122 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.
124 .. image:: ../images/system-dialogues/DeployAcInstance.png
126 Each participant deploys its AC Element Instances from the AC Instance.
128 .. image:: ../images/system-dialogues/DeployAcInstanceElements.png
130 The ACM Runtime receives and stores the responses.
132 .. image:: ../images/system-dialogues/DeployResponseStored.png
134 3.4 Undeploy Automation Composition Instance
135 --------------------------------------------
136 The user requests the AC Instance to be undeployed using a REST endpoint. The ACM Runtime orders the AC Instance to be undeployed.
138 .. image:: ../images/system-dialogues/UndeployInstance.png
140 Each participant undeploys its AC Element Instances from the AC Instance
142 .. image:: ../images/system-dialogues/UndeployInstanceElements.png
144 The ACM Runtime receives and stores the responses.
146 .. image:: ../images/system-dialogues/UndeployResponseStored.png
148 3.5 Read Automation Composition Instances
149 -----------------------------------------
151 .. image:: ../images/system-dialogues/ReadAcInstances.png
153 3.6 Unlock Automation Composition Instance
154 ------------------------------------------
155 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.
157 .. image:: ../images/system-dialogues/OrderInstanceUnlock.png
159 Each participant unlocks its AC Element Instances from the AC Instance.
161 .. image:: ../images/system-dialogues/UnlockInstanceElements.png
163 The ACM Runtime receives and stores the responses.
165 .. image:: ../images/system-dialogues/UnlockResponseStored.png
167 3.7 Lock Automation Composition Instance
168 ----------------------------------------
169 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.
171 .. image:: ../images/system-dialogues/LockAcInstance.png
173 Each participant locks its AC Element Instances from the AC Instance.
175 .. image:: ../images/system-dialogues/LockAcInstanceElements.png
177 The ACM Runtime receives and stores the responses.
179 .. image:: ../images/system-dialogues/LockResponseStored.png
181 3.8 Update Operational State on Automation Composition Instance
182 ---------------------------------------------------------------
184 .. image:: ../images/system-dialogues/UpdateOperationalState.png
186 3.9 Update Usage State on Automation Composition Instance
187 ---------------------------------------------------------
189 .. image:: ../images/system-dialogues/UpdateUsageState.png