docs/clamp/controlloop/system-level-dialogues.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2
   3 .. _system-level-label:
   4
   5 System Level Dialogues
   6 ######################
   7
   8
   9 .. contents::
  10     :depth: 4
  11
  12
  13 The CLAMP Control Loop Runtime Lifecycle Management uses the following system level dialogues.
  14 These dialogues enable the CLAMP runtime capabilities described in :ref:`Section 2 of
  15 TOSCA Defined Control Loops: Architecture and Design <controlloop-capabilities>`.
  16 Design Time dialogues will be described in future releases of the system.
  17
  18
  19 1 Commissioning Dialogues
  20 =========================
  21
  22 Commissioning dialogues are used to commission and decommission Control Loop Type definitions
  23 and to set the values of Common Parameters.
  24
  25 Commissioning a Control Loop Type is a three-step process:
  26
  27 #. The Control Loop Type must be created, that is the Control Loop Type definition must be
  28    loaded and stored in the database. This step may be carried out over the REST interface or
  29    using SDC distribution.
  30
  31 #. The Common Properties of the Control Loop type must be assigned values and those values
  32    must be stored in the database. This step is optional only if all mandatory common properties
  33    have default values. The Common Property values may be set and amended over and over again
  34    in multiple sessions until the Control Loop Type is primed.
  35
  36 #. The Control Loop Type Definition and the Common Property values must be primed, that is
  37    sent to the concerned participants. Once a Control Loop Type is primed, its Common Property
  38    values can no longer be changed. To change Common Properties on a primed Control Loop Type,
  39    all instances of the Control Loop Type must be removed and the Control Loop Type must be
  40    de-primed.
  41
  42 1.1 Commissioning a Control Loop Type Definition using the CLAMP GUI
  43 --------------------------------------------------------------------
  44
  45 This dialogue corresponds to a "File → Import" menu on the CLAMP GUI. The documentation of
  46 future releases of the system will describe how the Design Time functionality interacts
  47 with the Runtime commissioning API.
  48
  49 .. image:: images/system-dialogues/comissioning-clamp-gui.png
  50
  51 1.2 Commissioning a Control Loop Type Definition using SDC
  52 ----------------------------------------------------------
  53
  54 .. image:: images/system-dialogues/comissioning-sdc.png
  55
  56 1.3 Setting Common Properties for a Control Loop Type Definition
  57 ----------------------------------------------------------------
  58
  59 This dialogue sets the values of common properties. The values of the common properties
  60 may be set, updated, or deleted at will, as this dialogue saves the properties to the
  61 database but does not send the definitions or properties to the participants. However,
  62 once a Control Loop Type Definition and its properties are primed (See :ref:`Section 1.4
  63 <_priming-cl-label>`), the properties cannot be changed until the control loop type
  64 definition is de-primed (See :ref:`Section 1.5 <depriming-cl-label>`).
  65
  66 .. image:: images/system-dialogues/common-properties-type-definition.png
  67
  68 .. _priming-cl-label:
  69
  70 1.4 Priming a Control Loop Type Definition on Participants
  71 ----------------------------------------------------------
  72 The Priming operation sends Control Loop Type definitions and common property values
  73 to participants. Once a Control Loop Type definition is primed, its property values
  74 can on longer be changed until it is de-primed.
  75
  76 .. image:: images/system-dialogues/priming-cl-type-definition.png
  77
  78 .. _depriming-cl-label:
  79
  80 1.5 De-Prime a Control Loop Type Definition on Participants
  81 -----------------------------------------------------------
  82
  83 This dialogue allows a Control Loop Type Definition to be de-primed so that it can be
  84 deleted or its common parameter values can be altered.
  85
  86 .. image:: images/system-dialogues/depriming-cl-type-definition.png
  87
  88 1.6 Decommissioning a Control Loop Type Definition in CLAMP
  89 -----------------------------------------------------------
  90
  91 .. image:: images/system-dialogues/decommission-cl-type-definition.png
  92
  93 1.7 Reading Commissioned Control Loop Type Definitions
  94 ------------------------------------------------------
  95
  96 .. image:: images/system-dialogues/read-commision-cl-type-definition.png
  97
  98
  99 2. Instantiation Dialogues
 100 ==========================
 101
 102 Instantiation dialogues are used to create, set parameters on, instantiate, update,
 103 and remove Control Loop instances.
 104
 105 Assume a suitable Control Loop Definition exists in the Commissioned Control Loop Inventory.
 106 To get a Control Loop instance running one would, for example, execute dialogues
 107 :ref:`2.1 <creating-cl-instance>`, :ref:`2.3 <updating-cl-instance-config>`, and
 108 :ref:`2.4 <changing-cl-instance-state>`.
 109
 110 .. _creating-cl-instance:
 111
 112 2.1 Creating a Control Loop Instance
 113 ------------------------------------
 114
 115 .. image:: images/system-dialogues/create-cl-instance.png
 116
 117 .. note::
 118     This dialogue creates the Control Loop Instance in the Instantiated Control Loop Inventory.
 119     The instance is sent to the participants using the process described in the dialogue in
 120     :ref:`Section 2.3 <updating-cl-instance-config>`.
 121
 122 2.2 Updating Instance Specific Parameters on a Control Loop Instance
 123 --------------------------------------------------------------------
 124
 125 .. image:: images/system-dialogues/update-instance-params-cl.png
 126
 127 .. _updating-cl-instance-config:
 128
 129 2.3 Updating a Control Loop Instance with a Configuration on Participants
 130 -------------------------------------------------------------------------
 131
 132 .. image:: images/system-dialogues/update-cl-instance-config-participants.png
 133
 134 .. _changing-cl-instance-state:
 135
 136 2.4 Changing the state of a Control Loop Instance on Participants
 137 -----------------------------------------------------------------
 138
 139 .. image:: images/system-dialogues/change-cl-instance-state-participants.png
 140
 141 2.5 De-instantiating a Control Loop Instance from Participants
 142 --------------------------------------------------------------
 143
 144 .. image:: images/system-dialogues/deinstantiate-cl-from-participants.png
 145
 146 2.6 Deleting a Control Loop Instance
 147 ------------------------------------
 148
 149 .. image:: images/system-dialogues/delete-cl-instance.png
 150
 151 2.7 Reading Control Loop Instances
 152 ----------------------------------
 153
 154 .. image:: images/system-dialogues/read-cl-instance.png
 155
 156
 157 1. Monitoring Dialogues
 158 =======================
 159
 160 Monitoring dialogues are used to monitor and to read statistics on Control Loop Instances.
 161
 162 3.1 Reporting of Monitoring Information and Statistics by Participants
 163 ----------------------------------------------------------------------
 164
 165 .. image:: images/system-dialogues/monitoring-by-participants.png
 166
 167 3.2 Viewing of Monitoring Information
 168 -------------------------------------
 169
 170 .. image:: images/system-dialogues/view-monitoring-info.png
 171
 172 3.2 Viewing of Statistics
 173 -------------------------
 174
 175 .. image:: images/system-dialogues/view-statistics.png
 176
 177 3.3 Statistics Housekeeping
 178 ---------------------------
 179
 180 .. image:: images/system-dialogues/statistics-housekeeping.png
 181
 182
 183 4. Supervision Dialogues
 184 ========================
 185
 186 Supervision dialogues are used to check the state of Control Loop Instances and Participants.
 187
 188 4.1 Supervise Participants
 189 --------------------------
 190
 191 .. image:: images/system-dialogues/supervise-participants.png
 192
 193 4.2 Supervise Control Loops
 194 ---------------------------
 195
 196 .. image:: images/system-dialogues/supervise-controlloops.png
 197
 198 End of Document