From: rameshiyer27 <ramesh.murugan.iyer@est.tech>
Date: Mon, 4 Dec 2023 12:32:46 +0000 (+0000)
Subject: Add documentation for error handling in ACM participants
X-Git-Tag: 4.1.0~4
X-Git-Url: https://gerrit.onap.org/r/gitweb?p=policy%2Fparent.git;a=commitdiff_plain;h=8f3d0a054e42027d0f0e2d309a727f270676523d

Add documentation for error handling in ACM participants

Issue-ID: POLICY-4898
Signed-off-by: rameshiyer27 <ramesh.murugan.iyer@est.tech>
Change-Id: Id3dc33ce1cde3a8727e81c5dd9d2d35c0d3095b7
---

diff --git a/docs/clamp/acm/acm-participant-guide.rst b/docs/clamp/acm/acm-participant-guide.rst
index 6102fc72..c5623b29 100755
--- a/docs/clamp/acm/acm-participant-guide.rst
+++ b/docs/clamp/acm/acm-participant-guide.rst
@@ -483,3 +483,42 @@ The following example shows the Handler implementation and how could be the impl
     }
 
 
+AC Element states in failure scenarios
+--------------------------------------
+
+During the execution of any state change order, there is always a possibility of failures or exceptions that can occur in the participant.
+This can be tackled by the followed approaches.
+
+The participant implementation can handle the exception and revert back the appropriate AC element state, by invoking the
+'updateAutomationCompositionElementState' api from the participant intermediary.
+
+Alternatively, the participant can simply throw a PfModelException from its implementation which will be handled by the participant intermediary.
+The intermediary handles this exception and rolls back the AC element to its previous state with the appropriate stateChange Result.
+Please refer the following table for the state change reversion that happens in the participant intermediary for the AC elements.
+
+================== ==================
+**Error Scenario** **State Reverted**
+================== ==================
+Prime fails        Commissoned
+
+Deprime fails      Primed
+
+Deploy fails       Undeployed
+
+Undeploy fails     Deployed
+
+Update fails       Deployed
+
+Delete fails       Undeployed
+
+Lock fails         Unlocked
+
+Unlock fails       Locked
+================== ==================
+
+Considering the above mentioned behavior of the participant Intermediary, it is the responsibility of the developer to tackle the
+error scenarios in the participant with the suitable approach.
+
+Tips:
+If the participant tries to undeploy an element which doesn’t exist in the system any more (due to various other external factors),
+it could update the element state to ‘undeployed’ using the Intermediary api.
\ No newline at end of file