Update documentation for Stage in migration

Add add Stage where missing and fix small errors.

Issue-ID: POLICY-5121
Change-Id: I4c8239debbdd1a0b7edcf58d182110a998549f08
Signed-off-by: FrancescoFioraEst <francesco.fiora@est.tech>

6 files changed, 18 insertions, 18 deletions

diff --git a/docs/clamp/acm/acm-participant-guide.rst b/docs/clamp/acm/acm-participant-guide.rst
index d46c5611..56710a4c 100644
--- a/docs/clamp/acm/acm-participant-guide.rst
+++ b/docs/clamp/acm/acm-participant-guide.rst
@@ -91,7 +91,7 @@ AutomationCompositionElementListener:
   Every participant should implement a handler class that implements the AutomationCompositionElementListener interface
   from the Participant Intermediary. The intermediary listener class listens for the incoming events from the ACM-runtime
   and invoke the handler class implementations for various operations. This class implements the methods for deploying,
-  undeploying, locking, unlocking , deleting, updating, preparing, reviewing, migrating, migrationPrechecking, priming, depriming requests that are coming from the ACM-runtime.
+  undeploying, locking, unlocking, deleting, updating, preparing, reviewing, migrating, migrationPrechecking, priming, depriming requests that are coming from the ACM-runtime.
   The methods are as follows.
 
 .. code-block:: java
@@ -524,6 +524,7 @@ This following methods are invoked to update the AC element state or AC element
 
   1.  void updateAutomationCompositionElementState(UUID instanceId, UUID elementId, DeployState deployState, LockState lockState, StateChangeResult stateChangeResult, String message);
   2.  void updateCompositionState(UUID compositionId, AcTypeState state, StateChangeResult stateChangeResult, String message);
+  3.  void updateAutomationCompositionElementStage(UUID instance, UUID elementId, StateChangeResult stateChangeResult, int stage, String message);
 
 In/Out composition Properties
 -----------------------------
@@ -729,7 +730,7 @@ The following example shows the Handler implementation and how could be the impl
 .. code-block:: java
 
   @Component
-  public class AutomationCompositionElementHandler extends AcElementListenerV2 {
+  public class AutomationCompositionElementHandler extends AcElementListenerV3 {
 
     @Override
     public void deploy(CompositionElementDto compositionElement, InstanceElementDto instanceElement)
diff --git a/docs/clamp/acm/api-protocol/acm-participant-protocol.rst b/docs/clamp/acm/api-protocol/acm-participant-protocol.rst
index 2a8e05a0..d384633a 100644
--- a/docs/clamp/acm/api-protocol/acm-participant-protocol.rst
+++ b/docs/clamp/acm/api-protocol/acm-participant-protocol.rst
@@ -36,7 +36,7 @@ Participant Deregistration is performed by a Participant when it shuts down. It
 Automation Composition Priming and De-Priming
 ---------------------------------------------
 
-The Priming operation sends Automation Composition Types and common property values to participants for each Automation Composition Element Type in the Automation Composition Type. The ParticipantPrime message type is sent to trigger priming and depriming in participants in participants
+The Priming operation sends Automation Composition Types and common property values to participants for each Automation Composition Element Type in the Automation Composition Type. The ParticipantPrime message type is sent to trigger priming and depriming in participants.
 
 .. image:: ../images/system-dialogues/PrimeAcTypeOnPpnts.png
 
@@ -65,7 +65,7 @@ Automation Composition Update
 
 Automation Composition Update handles creation, change, and deletion of Automation Compositions on
 participants. Change of Automation Compositions uses a semantic versioning approach and follows the
-semantics described on the page :ref:`4.1 Management of Automation Composition Instance
+semantics described on the page :ref:`5.1 Management of Automation Composition Instance
 Configurations <management-acm-instance-configs>`.
 
 .. image:: ../images/acm-participants-protocol/acm-update.png
diff --git a/docs/clamp/acm/design-impl/participants/participant-intermediary.rst b/docs/clamp/acm/design-impl/participants/participant-intermediary.rst
index 909ad263..92ab6d42 100644
--- a/docs/clamp/acm/design-impl/participants/participant-intermediary.rst
+++ b/docs/clamp/acm/design-impl/participants/participant-intermediary.rst
@@ -43,7 +43,7 @@ Outbound messages
 Design of a PARTICIPANT_REGISTER message
 ----------------------------------------
 - A participant starts and send a PARTICIPANT_REGISTER message with participantId, replicaId and Supported Element Definition Types
-- in AC-runtime ParticipantRegisterListener collects the message from Message Broker
+- in ACM-runtime ParticipantRegisterListener collects the message from Message Broker
 - if participant is not present in DB, it saves participant reference with status ON_LINE to DB
 - It triggers the execution to send a PARTICIPANT_REGISTER_ACK message to the participant registered
 - if participant is present in DB and there are AC Definitions related to the Participant, 
@@ -52,14 +52,14 @@ Design of a PARTICIPANT_REGISTER message
 Design of a PARTICIPANT_DEREGISTER message
 ------------------------------------------
 - A participant is going to close and undeploys all AC-elements and send a PARTICIPANT_DEREGISTER message
-- in AC-runtime, ParticipantDeregisterListener collects the message from Message Broker
+- in ACM-runtime, ParticipantDeregisterListener collects the message from Message Broker
 - It saves participant reference with status OFF_LINE to DB
 - It triggers the execution to send a PARTICIPANT_DEREGISTER_ACK message to the participant deregistered
 - Participant is not monitored.
 
 Prime of an Automation Composition Definition Type
 --------------------------------------------------
-- AC-runtime assigns the AC Definition to the participants based of Supported Element Definition Type by participant
+- ACM-runtime assigns the AC Definition to the participants based of Supported Element Definition Type by participant
 - it triggers the execution to send a broadcast PARTICIPANT_PRIME message
 - the message is built by ParticipantPrimePublisher using Tosca Service Template data (to fill the list of ParticipantDefinition)
 - Participant-intermediary will receive a PARTICIPANT_PRIME message and stores the Tosca Service Template data on CacheProvider
@@ -67,7 +67,7 @@ Prime of an Automation Composition Definition Type
 
 DePrime of an Automation Composition Definition Type
 ----------------------------------------------------
-- AC-runtime triggers the execution to send a broadcast PARTICIPANT_PRIME message
+- ACM-runtime triggers the execution to send a broadcast PARTICIPANT_PRIME message
 - the message is built by ParticipantPrimePublisher with an empty list of ParticipantDefinition
 - Participant-intermediary will receive a PARTICIPANT_PRIME message and deletes the Tosca Service Template data on CacheProvider
 - Each participant performs its designated job of deprime
@@ -100,7 +100,7 @@ Design of "issues automation composition commands to automation compositions" -
 
 Update of an Automation Composition Instance
 --------------------------------------------
-- AC-runtime updates the instance properties of the deployed Ac instances
+- ACM-runtime updates the instance properties of the deployed Ac instances
 - it triggers the execution to send a broadcast PROPERTIES_UPDATE message
 - the message is built by AcElementPropertiesPublisher using the REST request payload (to fill the list of elements with the updated property values)
 - Participant-intermediary will receive a PROPERTIES_UPDATE message and stores the updated values of the elements on CacheProvider
@@ -115,7 +115,7 @@ Migrate-precheck of an Automation Composition Instance
 
 Migrate of an Automation Composition Instance
 ---------------------------------------------
-- AC-runtime saves the compositionTargetId and updates the instance properties of the deployed Ac instances
+- ACM-runtime saves the compositionTargetId and updates the instance properties of the deployed Ac instances
 - it triggers the execution to send a broadcast AUTOMATION_COMPOSITION_MIGRATION message with precheck set to false
 - the message is built by AutomationCompositionMigrationPublisher using the REST request payload (to fill the compositionTargetId and list of elements with the updated property values)
 - Participant-intermediary will receive a AUTOMATION_COMPOSITION_MIGRATION message and stores the compositionTargetId and the updated values of the elements on CacheProvider
@@ -132,6 +132,7 @@ Design of "issues automation composition commands to automation compositions" -
 -------------------------------------------------------------------------------------------------------
 - AUTOMATION_COMPOSITION_STATE_CHANGE message with instantiation details and LOCK order state is sent to participants
 - Participant-intermediary validates the current lockState change
+- Participant-intermediary will receive AUTOMATION_COMPOSITION_STATE_CHANGE message
 - Each participant performs its designated job of lock
 
 Design of Delete - case UNDEPLOYED to DELETED
@@ -141,11 +142,10 @@ Design of Delete - case UNDEPLOYED to DELETED
 - Participant-intermediary will receive AUTOMATION_COMPOSITION_STATE_CHANGE message and sends AC-element details to participants
 - Each participant performs its designated job of removing instantiation data if not done in undeployment
 - Participant-intermediary will remove instantiation data
-- Each participant performs its designated job of delete
 
 Design of a PARTICIPANT_STATUS_REQ message
 ------------------------------------------
-- AC-runtime triggers the execution to send a broadcast PARTICIPANT_STATUS_REQ message or to send it to a specific participant
+- ACM-runtime triggers the execution to send a broadcast PARTICIPANT_STATUS_REQ message or to send it to a specific participant
 - the message is built by ParticipantStatusReqPublisher
 - Participant-intermediary will receive a PARTICIPANT_STATUS_REQ message
 
@@ -159,7 +159,7 @@ Design of a AUTOMATION_COMPOSITION_DEPLOY_ACK message
 -----------------------------------------------------
 - A participant sends AUTOMATION_COMPOSITION_DEPLOY_ACK message in response to a AUTOMATION_COMPOSITION_DEPLOY message.
 - For each AC-elements moved to the ordered state as indicated by the AUTOMATION_COMPOSITION_DEPLOY
-- AutomationCompositionUpdateAckListener in AC-runtime collects the messages from Message Broker
+- AutomationCompositionUpdateAckListener in ACM-runtime collects the messages from Message Broker
 - It checks the deployStatus of all automation composition elements
 - It updates the AC-instance in DB accordingly
 
@@ -167,6 +167,6 @@ Design of a AUTOMATIONCOMPOSITION_STATECHANGE_ACK message
 ---------------------------------------------------------
 - A participant sends AUTOMATIONCOMPOSITION_STATECHANGE_ACK message in response to a AUTOMATIONCOMPOSITION_STATECHANGE message.
 - For each AC-elements moved to the ordered state as indicated by the AUTOMATIONCOMPOSITION_STATECHANGE
-- AutomationCompositionStateChangeAckListener in AC-runtime collects the messages from Message Broker
+- AutomationCompositionStateChangeAckListener in ACM-runtime collects the messages from Message Broker
 - It checks the deployStatus/lockStatus of all automation composition elements
 - It updates the AC-instance in DB accordingly
diff --git a/docs/clamp/acm/files/ACM-Message-Table.csv b/docs/clamp/acm/files/ACM-Message-Table.csv
index 0ade0b81..b3f09a7a 100755
--- a/docs/clamp/acm/files/ACM-Message-Table.csv
+++ b/docs/clamp/acm/files/ACM-Message-Table.csv
@@ -31,7 +31,6 @@ ParticipantStatus,Participant,ACM Runtime,Status update message,state,Enum indic
 ,,,,participantSupportedElementTypes,Ac element types that this participant is capable for deployinh/supporting
 ,,,,messageType,Enum indicating the type of message PARTICIPANT_STATUS
 AutomationCompositionDeploy,ACM Runtime,Participant,Message to request change state of composition to DEPLOY,participantUpdatesList,A list of ParticipantUpdates instances which carries details of an updated participant.
-,,,,replicaId,The replica ID of this participant – in UUID format
 ,,,,compositionId,The id of the AC Definition related to this message
 ,,,,automationCompositionId,The id of the automation composition related to this message
 ,,,,startPhase,Integer indicating the start up order of the elements
@@ -72,7 +71,7 @@ AutomationCompositionMigration,ACM Runtime,Participant,Message to request update
 ,,,,compositionTargetId,The id of the AC Definition target
 ,,,,automationCompositionId,The id of the automation composition related to this message
 ,,,,participantId,UUID indicating the participant the message is intended for
-,,,,messageType,Enum indicating the type of message PROPERTIES_UPDATE
+,,,,messageType,Enum indicating the type of message AUTOMATION_COMPOSITION_MIGRATION
 AutomationCompositionPrepare,ACM Runtime,Participant,Message to request prepare/review,participantList,A list of ParticipantUpdates instances which carries details of an updated participant.
 ,,,,preDeploy,Flag - if true the instance is Undeployed and the action is a Prepare - otherwise (false) the instance is Deployed and the action is a Review
 ,,,,compositionId,The id of the AC Definition related to this message
diff --git a/docs/drools/pdpdApps.rst b/docs/drools/pdpdApps.rst
index 5ef0a3fc..dfb67515 100644
--- a/docs/drools/pdpdApps.rst
+++ b/docs/drools/pdpdApps.rst
@@ -878,7 +878,7 @@ The reader can also look at the `policy/docker repository <https://github.com/on
 More specifically, these directories have examples of other PDP-D Control Loop configurations:
 
 * `plans <https://github.com/onap/policy-docker/tree/master/compose>`__: startup & teardown scripts.
-* `scripts <https://github.com/onap/policy-docker/blob/master/compose/docker-compose.yml>`__: docker-compose file.
+* `scripts <https://github.com/onap/policy-docker/blob/master/compose>`__: docker-compose files.
 * `tests <https://github.com/onap/policy-docker/blob/master/csit/resources/tests/drools-applications-test.robot>`__: test plan.
 
 Additional information
diff --git a/docs/drools/pdpdEngine.rst b/docs/drools/pdpdEngine.rst
index 084eb6d7..6ad4790c 100644
--- a/docs/drools/pdpdEngine.rst
+++ b/docs/drools/pdpdEngine.rst
@@ -1381,7 +1381,7 @@ The reader can also look at the `policy/docker repository <https://github.com/on
 More specifically, these directories have examples of other PDP-D configurations:
 
 * `plans <https://github.com/onap/policy-docker/tree/master/compose>`__: startup & teardown scripts.
-* `scripts <https://github.com/onap/policy-docker/blob/master/compose/docker-compose.yml>`__: docker-compose file.
+* `scripts <https://github.com/onap/policy-docker/blob/master/compose>`__: docker-compose files.
 * `tests <https://github.com/onap/policy-docker/blob/master/csit/resources/tests/drools-pdp-test.robot>`__: test plan.
 
 Configuring the PDP-D in an OOM Kubernetes installation