docs/clamp/acm/api-protocol/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 Automation Composition Runtime Lifecycle Management uses the following system level
  14 dialogues. These dialogues enable the CLAMP runtime capabilities described in
  15 :ref:`Section 2 of TOSCA Defined Automation Compositions: Architecture and Design <acm-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 Automation Composition Type
  23 definitions and to set the values of Common Parameters.
  24
  25 Commissioning an Automation Composition Type is a three-step process:
  26
  27 #. The Automation Composition Type must be created, that is the Automation Composition Type
  28    definition must be loaded and stored in the database. This step may be carried out over the
  29    REST interface or using SDC distribution.
  30
  31 #. The Common Properties of the Automation Composition type must be assigned values and those
  32    values must be stored in the database. This step is optional only if all mandatory common
  33    properties have default values. The Common Property values may be set and amended over and
  34    over again in multiple sessions until the Automation Composition Type is primed.
  35
  36 #. The Automation Composition Type Definition and the Common Property values must be primed,
  37    which is sent to the concerned participants. Once an Automation Composition Type is primed,
  38    its Common Property values can no longer be changed. To change Common Properties on a primed
  39    Automation Composition Type, all instances of the Automation Composition Type must be removed
  40    and the Automation Composition Type must be de-primed.
  41
  42 1.1 Commissioning an Automation Composition 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 an Automation Composition Type Definition using SDC
  52 ---------------------------------------------------------------------
  53
  54 .. image:: ../images/system-dialogues/comissioning-sdc.png
  55
  56 1.3 Setting Common Properties for an Automation Composition 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 an Automation Composition Type Definition and its properties are primed
  63 (See :ref:`Section 1.4 <priming-acm-label>`), the properties cannot be changed until the
  64 Automation Composition type definition is de-primed (See
  65 :ref:`Section 1.5 <depriming-acm-label>`).
  66
  67 .. image:: ../images/system-dialogues/common-properties-type-definition.png
  68
  69 .. _priming-acm-label:
  70
  71 1.4 Priming an Automation Composition Type Definition on Participants
  72 ---------------------------------------------------------------------
  73 The Priming operation sends Automation Composition Type definitions and common property values
  74 to participants. Once an Automation Composition Type definition is primed, its property values
  75 can on longer be changed until it is de-primed.
  76
  77 .. image:: ../images/system-dialogues/priming-acm-type-definition.png
  78
  79 .. _depriming-acm-label:
  80
  81 1.5 De-Prime an Automation Composition Type Definition on Participants
  82 ----------------------------------------------------------------------
  83
  84 This dialogue allows an Automation Composition Type Definition to be de-primed so that it can be
  85 deleted or its common parameter values can be altered.
  86
  87 .. image:: ../images/system-dialogues/depriming-acm-type-definition.png
  88
  89 1.6 Decommissioning an Automation Composition Type Definition in CLAMP
  90 ----------------------------------------------------------------------
  91
  92 .. image:: ../images/system-dialogues/decommission-acm-type-definition.png
  93
  94 1.7 Reading Commissioned Automation Composition Type Definitions
  95 ----------------------------------------------------------------
  96
  97 .. image:: ../images/system-dialogues/read-commision-acm-type-definition.png
  98
  99
 100 2. Instantiation Dialogues
 101 ==========================
 102
 103 Instantiation dialogues are used to create, set parameters on, instantiate, update,
 104 and remove Automation Composition instances.
 105
 106 Assume a suitable Automation Composition Definition exists in the Commissioned Automation
 107 Composition Inventory.
 108 To get an Automation Composition instance running one would, for example, execute dialogues
 109 :ref:`2.1 <creating-acm-instance>`, :ref:`2.3 <updating-acm-instance-config>`, and
 110 :ref:`2.4 <changing-acm-instance-state>`.
 111
 112 .. _creating-acm-instance:
 113
 114 2.1 Creating an Automation Composition Instance
 115 -----------------------------------------------
 116
 117 .. image:: ../images/system-dialogues/create-acm-instance.png
 118
 119 .. note::
 120     This dialogue creates the Automation Composition Instance in the Instantiated Automation
 121     Composition Inventory. The instance is sent to the participants using the process described
 122     in the dialogue in :ref:`Section 2.3 <updating-acm-instance-config>`.
 123
 124 2.2 Updating Instance Specific Parameters on an Automation Composition Instance
 125 -------------------------------------------------------------------------------
 126
 127 .. image:: ../images/system-dialogues/update-instance-params-acm.png
 128
 129 .. _updating-acm-instance-config:
 130
 131 2.3 Updating an Automation Composition Instance with a Configuration on Participants
 132 ------------------------------------------------------------------------------------
 133
 134 .. image:: ../images/system-dialogues/update-acm-instance-config-participants.png
 135
 136 .. _changing-acm-instance-state:
 137
 138 2.4 Changing the state of an Automation Composition Instance on Participants
 139 ----------------------------------------------------------------------------
 140
 141 .. image:: ../images/system-dialogues/change-acm-instance-state-participants.png
 142
 143 2.5 De-instantiating an Automation Composition Instance from Participants
 144 -------------------------------------------------------------------------
 145
 146 .. image:: ../images/system-dialogues/deinstantiate-acm-from-participants.png
 147
 148 2.6 Deleting an Automation Composition Instance
 149 -----------------------------------------------
 150
 151 .. image:: ../images/system-dialogues/delete-acm-instance.png
 152
 153 2.7 Reading Automation Composition Instances
 154 --------------------------------------------
 155
 156 .. image:: ../images/system-dialogues/read-acm-instance.png
 157
 158
 159 3. Monitoring Dialogues
 160 =======================
 161
 162 Monitoring dialogues are used to monitor and to read statistics on Automation Composition Instances.
 163
 164 3.1 Reporting of Monitoring Information and Statistics by Participants
 165 ----------------------------------------------------------------------
 166
 167 .. image:: ../images/system-dialogues/monitoring-by-participants.png
 168
 169 3.2 Viewing of Monitoring Information
 170 -------------------------------------
 171
 172 .. image:: ../images/system-dialogues/view-monitoring-info.png
 173
 174 3.2 Viewing of Statistics
 175 -------------------------
 176
 177 .. image:: ../images/system-dialogues/view-statistics.png
 178
 179 3.3 Statistics Housekeeping
 180 ---------------------------
 181
 182 .. image:: ../images/system-dialogues/statistics-housekeeping.png
 183
 184
 185 4. Supervision Dialogues
 186 ========================
 187
 188 Supervision dialogues are used to check the state of Automation Composition Instances and
 189 Participants.
 190
 191 4.1 Supervise Participants
 192 --------------------------
 193
 194 .. image:: ../images/system-dialogues/supervise-participants.png
 195
 196 4.2 Supervise Automation Compositions
 197 -------------------------------------
 198
 199 .. image:: ../images/system-dialogues/supervise-acms.png
 200
 201 End of Document