docs/clamp/acm/allowed-operations.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.\r
   2 \r
   3 .. _allowed-operations-label:\r
   4 \r
   5 Allowed operations in ACM\r
   6 #########################\r
   7 \r
   8 .. contents::\r
   9     :depth: 4\r
  10 \r
  11 CRUD Automation Composition Definition\r
  12 --------------------------------------\r
  13 \r
  14 +------------+--------------+----------------------------------+\r
  15 | **Action** | **state**    | **Description**                  |\r
  16 +------------+--------------+----------------------------------+\r
  17 |   Create   |              |  Create new AC Definition        |\r
  18 +------------+--------------+----------------------------------+\r
  19 |   Update   | COMMISSIONED |  Update the AC Definition        |\r
  20 +------------+--------------+----------------------------------+\r
  21 |   Delete   | COMMISSIONED |  Delete the AC Definition        |\r
  22 +------------+--------------+----------------------------------+\r
  23 \r
  24 Change status of Automation Composition Definition\r
  25 --------------------------------------------------\r
  26 \r
  27 +------------+--------------+---------------------+-------------------------------------------------------+\r
  28 | **Action** | **state**    |   **stChResult**    | **Description**                                       |\r
  29 +------------+--------------+---------------------+-------------------------------------------------------+\r
  30 |            | COMMISSIONED |                     | Start Priming transition                              |\r
  31 +            +--------------+---------------------+-------------------------------------------------------+\r
  32 |            | PRIMING      |   FAILED            | Start Priming transition after PRIMING is failed      |\r
  33 +   Prime    +--------------+---------------------+-------------------------------------------------------+\r
  34 |            | PRIMING      |   TIMEOUT           | Start Priming transition after PRIMING got timeout    |\r
  35 +            +--------------+---------------------+-------------------------------------------------------+\r
  36 |            | DEPRIMING    |   FAILED            | Start Priming transition after DEPRIMING is failed    |\r
  37 +            +--------------+---------------------+-------------------------------------------------------+\r
  38 |            | DEPRIMING    |   TIMEOUT           | Start Priming transition after DEPRIMING got timeout  |\r
  39 +------------+--------------+---------------------+-------------------------------------------------------+\r
  40 |            | PRIMED       |   NO_ERROR          | Start Depriming the AC Definition.                    |\r
  41 |            |              |                     | No instances connected to this AC Definition.         |\r
  42 +            +--------------+---------------------+-------------------------------------------------------+\r
  43 |            | DEPRIMING    |   FAILED            | Start Depriming after DEPRIMING is failed             |\r
  44 +  Deprime   +--------------+---------------------+-------------------------------------------------------+\r
  45 |            | DEPRIMING    |   TIMEOUT           | Start Depriming after DEPRIMING got timeout           |\r
  46 +            +--------------+---------------------+-------------------------------------------------------+\r
  47 |            | PRIMING      |   FAILED            | Start Depriming after PRIMING is failed               |\r
  48 +            +--------------+---------------------+-------------------------------------------------------+\r
  49 |            | PRIMING      |   TIMEOUT           | Start Depriming after PRIMING got timeout             |\r
  50 +------------+--------------+---------------------+-------------------------------------------------------+\r
  51 \r
  52 **Note**: "stChResult" = stateChangeResult.\r
  53 \r
  54 CRUD Automation Composition Instance\r
  55 ------------------------------------\r
  56 AC Definition is PRIMED with NO_ERROR.\r
  57 \r
  58 +------------+-----------------+---------------+----------------+--------------------------------------------------------------------------------------+\r
  59 | **Action** | **deployState** | **lockState** | **stChResult** | **Description**                                                                      |\r
  60 +------------+-----------------+---------------+----------------+--------------------------------------------------------------------------------------+\r
  61 | Create     |                 |               |                | Create a new AC instance                                                             |\r
  62 +------------+-----------------+---------------+----------------+--------------------------------------------------------------------------------------+\r
  63 | Update     | UNDEPLOYED      |               |                | Update the AC Instance                                                               |\r
  64 +            +-----------------+---------------+----------------+--------------------------------------------------------------------------------------+\r
  65 |            | DEPLOYED        |  LOCKED       |                | Update the AC Instance and send update to participants                               |\r
  66 +            +-----------------+---------------+----------------+--------------------------------------------------------------------------------------+\r
  67 |            | UPDATING        |  LOCKED       |  FAILED        | Start Updating transition and send update to participants after UPDATING is failed   |\r
  68 +            +-----------------+---------------+----------------+--------------------------------------------------------------------------------------+\r
  69 |            | UPDATING        |  LOCKED       |  TIMEOUT       | Start Updating transition and send update to participants after UPDATING got timeout |\r
  70 +------------+-----------------+---------------+----------------+--------------------------------------------------------------------------------------+\r
  71 | Migrate    | DEPLOYED        |  LOCKED       |                | Start Migrating transition and send migrate to participants                          |\r
  72 +------------+-----------------+---------------+----------------+--------------------------------------------------------------------------------------+\r
  73 |            | UNDEPLOYED      |               |                | Start Deleting transition and send delete to participants                            |\r
  74 +            +-----------------+---------------+----------------+--------------------------------------------------------------------------------------+\r
  75 | Delete     | DELETING        |  NONE         |  FAILED        | Start Deleting transition and send delete to participants after DELETING is failed   |\r
  76 +            +-----------------+---------------+----------------+--------------------------------------------------------------------------------------+\r
  77 |            | DELETING        |  NONE         |  TIMEOUT       | Start Deleting transition and send delete to participants after DELETING got timeout |\r
  78 +------------+-----------------+---------------+----------------+--------------------------------------------------------------------------------------+\r
  79 \r
  80 Change status of Automation Composition Instance\r
  81 ------------------------------------------------\r
  82 \r
  83 +------------+-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+\r
  84 | **Action** | **deployState** | **lockState** | **stChResult** | **Description**                                                                             |\r
  85 +------------+-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+\r
  86 |            | UNDEPLOYED      |               |                | Start Deploying transition and send deploy to participants                                  |\r
  87 +            +-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+\r
  88 |            | DEPLOYING       |  NONE         |  FAILED        | Start Deploying transition and send deploy to participants after DEPLOYING is failed        |\r
  89 +            +-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+\r
  90 |  Deploy    | DEPLOYING       |  NONE         |  TIMEOUT       | Start Deploying transition and send deploy to participants after DEPLOYING got timeout      |\r
  91 +            +-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+\r
  92 |            | UNDEPLOYING     |  NONE         |  FAILED        | Start Deploying transition and send deploy to participants after UNDEPLOYING is failed      |\r
  93 +            +-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+\r
  94 |            | UNDEPLOYING     |  NONE         |  TIMEOUT       | Start Deploying transition and send deploy to participants after UNDEPLOYING got timeout    |\r
  95 +------------+-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+\r
  96 |            | DEPLOYED        |  LOCKED       |                | Start Undeploying transition and send undeploy to participants                              |\r
  97 +            +-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+\r
  98 |            | DEPLOYING       |  NONE         |  FAILED        | Start Undeploying transition and send undeploy to participants after DEPLOYING is failed    |\r
  99 +            +-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+\r
 100 |            | UNDEPLOYING     |  NONE         |  FAILED        | Start Undeploying transition and send undeploy to participants after UNDEPLOYING is failed  |\r
 101 +  Undeploy  +-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+\r
 102 |            | UNDEPLOYING     |  NONE         |  TIMEOUT       | Start Undeploying transition and send undeploy to participants after UNDEPLOYING got timeout|\r
 103 +            +-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+\r
 104 |            | UPDATING        |  LOCKED       |  FAILED        | Start Undeploying transition and send update to participants after UPDATING is failed       |\r
 105 +            +-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+\r
 106 |            | UPDATING        |  LOCKED       |  TIMEOUT       | Start Undeploying transition and send update to participants after UPDATING got timeout     |\r
 107 +            +-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+\r
 108 |            | MIGRATING       |  LOCKED       |  FAILED        | Start Undeploying transition and send update to participants after MIGRATING is failed      |\r
 109 +            +-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+\r
 110 |            | MIGRATING       |  LOCKED       |  TIMEOUT       | Start Undeploying transition and send update to participants after MIGRATING got timeout    |\r
 111 +------------+-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+\r
 112 |            | DEPLOYED        |  UNLOCKED     |                | Start Locking transition and send lock to participants                                      |\r
 113 +            +-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+\r
 114 |            | DEPLOYED        |  UNLOCKING    |  FAILED        | Start Locking transition and send lock to participants after UNLOCKING is failed            |\r
 115 +            +-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+\r
 116 |   Lock     | DEPLOYED        |  UNLOCKING    |  TIMEOUT       | Start Locking transition and send lock to participants after UNLOCKING got timeout          |\r
 117 +            +-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+\r
 118 |            | DEPLOYED        |  LOCKING      |  FAILED        | Start Locking transition and send lock to participants after LOCKING is failed              |\r
 119 +            +-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+\r
 120 |            | DEPLOYED        |  LOCKING      |  TIMEOUT       | Start Locking transition and send lock to participants after LOCKING got timeout            |\r
 121 +------------+-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+\r
 122 |            | DEPLOYED        | LOCKED        |                | Start Unlocking transition and send unlock to participants                                  |\r
 123 +            +-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+\r
 124 |            | DEPLOYED        | UNLOCKING     |  FAILED        | Start Unlocking transition and send unlock to participants after UNLOCKING is failed        |\r
 125 +            +-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+\r
 126 |  Unlock    | DEPLOYED        | UNLOCKING     |  TIMEOUT       | Start Unlocking transition and send unlock to participants after UNLOCKING got timeout      |\r
 127 +            +-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+\r
 128 |            | DEPLOYED        | LOCKING       |  FAILED        | Start Unlocking transition and send unlock to participants after LOCKING is failed          |\r
 129 +            +-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+\r
 130 |            | DEPLOYED        | LOCKING       |  TIMEOUT       | Start Unlocking transition and send unlock to participants after LOCKING got timeout        |\r
 131 +------------+-----------------+---------------+----------------+---------------------------------------------------------------------------------------------+\r