docs/clamp/acm/acm-states.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2
   3 .. _acm-states-label:
   4
   5 ACM States
   6 ##########
   7
   8 .. contents::
   9     :depth: 4
  10
  11 Automation Composition Management manages a number of states of various types to manage the lifecycle of compositions. Those states are described here. Please also see the ACM System Level Dialogues page to see the system dialogues that change states and how states interrelate in detail. Please also see ITU Recommendation X.731, which is reflected in the states of AC Element Instances.
  12
  13 Participant State
  14 =================
  15 Participant states are NOT managed by ACM but the state of a participant is recorded and supervised by ACM.
  16
  17 .. image:: images/acm-states/ParticipantStates.png
  18
  19
  20 Automation Composition Type State
  21 =================================
  22 The states that an Automation Composition Type can have, are shown in the diagram below.
  23
  24 .. image:: images/acm-states/AcTypeStates.png
  25
  26 Automation Composition Element Type State
  27 =========================================
  28 The states that an Automation Composition Element Type can have on ACM Runtime are shown in the diagram below.
  29
  30 .. image:: images/acm-states/AcElementTypeStatesOnRuntime.png
  31
  32 The states that an Automation Composition Element Type can have on a Participant are shown in the diagram below.
  33
  34 .. image:: images/acm-states/AcElementTypeStatesOnPpnt.png
  35
  36 The states diagram below, shows the fail and timeout scenario.
  37 In that diagram the state is presented using this combination [ Composition Element Type State : Composition Type State : StateChangeResult ].
  38
  39 .. image:: images/acm-states/AcTypeStatesFail.png
  40
  41 Automation Composition Instance State
  42 =====================================
  43 The states that an Automation Composition Instance can have are shown in the diagram below.
  44
  45 .. image:: images/acm-states/AcInstanceStates.png
  46
  47 Automation Composition Element Instance State
  48 =============================================
  49 The states that an Automation Composition Element Instance can have on ACM Runtime are shown in the diagram below.
  50
  51 .. image:: images/acm-states/AcElementInstanceStatesOnRuntime.png
  52
  53 The states that an Automation Composition Element Instance can have on a Participant are shown in the diagram below.
  54
  55 .. image:: images/acm-states/AcElementInstanceStatesOnPpnt.png
  56
  57 Automation Composition State with fail and timeout
  58 ==================================================
  59 The states that an Automation Composition Element Instance can have for each flow, are shown in the diagrams below.
  60 For each diagram the state is presented using this combination [ Instance Element State : Instance State : StateChangeResult ].
  61
  62 Deploy
  63 ------
  64
  65 .. image:: images/acm-states/AcInstanceStatesDeploy.png
  66
  67 Update
  68 ------
  69
  70 .. image:: images/acm-states/AcInstanceStatesUpdate.png
  71
  72 Migrate
  73 -------
  74
  75 .. image:: images/acm-states/AcInstanceStatesMigrate.png
  76
  77 Delete
  78 ------
  79
  80 .. image:: images/acm-states/AcInstanceStatesDelete.png
  81
  82 End of Document