Update docs for automatic sync up support in ACM 98/141598/1
authorFrancescoFioraEst <francesco.fiora@est.tech>
Tue, 29 Jul 2025 14:39:47 +0000 (15:39 +0100)
committerFrancesco Fiora <francesco.fiora@est.tech>
Tue, 29 Jul 2025 14:44:24 +0000 (14:44 +0000)
Issue-ID: POLICY-5428
Change-Id: Ida99d96f77296d9a83ad4e3a8c9bd3d144de3992
Signed-off-by: FrancescoFioraEst <francesco.fiora@est.tech>
docs/clamp/acm/api-protocol/acm-participant-protocol.rst
docs/clamp/acm/api-protocol/puml/ParticipantMonitoring.puml
docs/clamp/acm/api-protocol/puml/ParticipantSyncUp.plum [new file with mode: 0644]
docs/clamp/acm/clamp-csit.rst
docs/clamp/acm/design-impl/participants/participant-intermediary.rst
docs/clamp/acm/files/ACM-Message-Table.csv
docs/clamp/acm/images/acm-participants-protocol/acm-monitoring.png
docs/clamp/acm/images/acm-participants-protocol/acm-sync-up.png [new file with mode: 0644]

index d384633..1e77891 100644 (file)
@@ -63,7 +63,7 @@ The ACM Runtime updates the priming information in the database.
 Automation Composition Update
 -----------------------------
 
-Automation Composition Update handles creation, change, and deletion of Automation Compositions on
+Automation Composition Update handles creation, change properties, migration, 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:`5.1 Management of Automation Composition Instance
 Configurations <management-acm-instance-configs>`.
@@ -112,13 +112,27 @@ The flow of the DEPLOY/UNDEPLOY state change messages are shown below. But the s
 
 .. image:: ../images/acm-participants-protocol/acm-state-change-msg.png
 
+
+Participant Sync Up
+-------------------
+
+This dialogue is used to Sync Up the participant replicas with the ACM-r database.
+Acm-r stores a revision for each instance and composition which will be updated for every update (state change or outProperties change).
+This value will be sent to the participants along with the sync message.
+When ACM-r sends an operation message (as undeploy/delete), it will insert the revision of the instance and the revision of the composition,
+so the participants can compare this value with what is in the memory.
+If the instance/composition is missing or outdated, participant caches the operation, sends a sync request to ACM-r
+and the cached operation will be resumed after the sync message is received.
+
+.. image:: ../images/acm-participants-protocol/acm-sync-up.png
+
+
 Automation Composition Monitoring and Reporting
 -----------------------------------------------
 
 This dialogue is used as a heartbeat mechanism for participants, to monitor the status of
-Automation Composition Elements, and to gather statistics on Automation Compositions. The
-*ParticipantStatus* message is sent periodically by each participant. The reporting interval for
-sending the message is configurable.
+the replica of the participant. The *ParticipantStatus* message is sent periodically by each participant.
+The reporting interval for sending the message is configurable.
 
 .. image:: ../images/acm-participants-protocol/acm-monitoring.png
 
index 24f25d7..9117f9f 100644 (file)
@@ -1,3 +1,3 @@
 @startuml
-Participant -> CLAMP_Runtime: Participant Status [periodically from each Participant in all Automation Compositions]
+Participant -> CLAMP_Runtime: Participant Status [periodically from each Participant replica]
 @enduml
diff --git a/docs/clamp/acm/api-protocol/puml/ParticipantSyncUp.plum b/docs/clamp/acm/api-protocol/puml/ParticipantSyncUp.plum
new file mode 100644 (file)
index 0000000..6abe844
--- /dev/null
@@ -0,0 +1,11 @@
+@startuml
+
+"CLAMP Runtime" -> Participant: Process Update Message
+Participant -> Participant: Check if data are missing or outdated
+alt missing data or outdated?
+       Participant -> "CLAMP Runtime": request sync up
+       "CLAMP Runtime" -> Participant: send sync up
+end alt
+Participant -> Participant: Process Update Message
+Participant -> "CLAMP Runtime": Update Ack
+@enduml
index e6a3f3c..e997f45 100644 (file)
@@ -33,6 +33,18 @@ ACM Integration Tests
 +--------------------------------------------------+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
 | RegisterParticipants                             | Sends a PUT request to ACM-R to request the participants for registration                              | Should receive a 202 Accepted response from ACM-R                                                                      |
 +--------------------------------------------------+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
+| InsertDataIntoDatabase                           | Insert restored data into the Database                                                                 | Should receive a 0 response from the script                                                                            |
++--------------------------------------------------+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
+| AcMigrationRestored                              | Migration of an automation composition restored                                                        | Should receive a 200 response and the AC instance should be migrated to to the target AC definition                    |
++--------------------------------------------------+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
+| UpdateDataDatabase                               | Update restored data into the Database                                                                 | Should receive a 0 response from the script                                                                            |
++--------------------------------------------------+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
+| ReviewAutomationCompositionRestored              | Review automation composition restored                                                                 | Should receive a 202 Accepted response and the substate should be present in the AC instance data                      |
++--------------------------------------------------+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
+| AcDeleteRestored                                 | Undeploy and delete of an automation composition restored                                              | Should receive a 202 Accepted response and the restored AC instance should have been deleted in ACM-R                  |
++--------------------------------------------------+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
+| DeleteACDefinitionsRestored                      | Deprime and delete of the compositions definition restored                                             | Should receive a 200 response and the AC definition should be removed in ACM-R db                                      |
++--------------------------------------------------+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
 | CommissionAcDefinitionTimeout                    | Commissions a service template for testing Prime Timeout                                               | Should receive a 201 created response from ACM_R                                                                       |
 +--------------------------------------------------+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
 | TimeoutPrimeACDefinition                         | Verify the priming timeout from participant sim by updating the participant sim behavior               | Should receive a 202 Accepted response from ACM-R and the stateChangeResult of AC definition should be TIMEOUT         |
@@ -51,9 +63,7 @@ ACM Integration Tests
 +--------------------------------------------------+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
 | UnInstantiateAutomationCompositionSimple         | Uninstantiate the simple AC instance                                                                   | Should receive a 202 Accepted response and the simple AC instance should have been deleted in ACM-R                    |
 +--------------------------------------------------+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
-| DePrimeACDefinitionSimple                        | Deprime the simple AC definition from the participants                                                 | Should receive a 202 Accepted response and the simple AC definition in ACM-R should be moved to COMMISSIONED state     |
-+--------------------------------------------------+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
-| DeleteACDefinitionSimple                         | Delete the simple automation composition definition                                                    | Should receive a 200 response and the simple AC definition should be removed in ACM-R db                               |
+| DeleteACDefinitionSimple                         | Deprime and Delete the simple automation composition definition                                        | Should receive a 200 response and the simple AC definition should be removed in ACM-R db                               |
 +--------------------------------------------------+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
 | CommissionAutomationComposition                  | Commissions a Tosca service template to ACM-R                                                          | Should receive a 201 created response from ACM_R                                                                       |
 +--------------------------------------------------+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
@@ -115,29 +125,35 @@ ACM Integration Tests
 +--------------------------------------------------+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
 | FailAutomationCompositionMigration               | Verify the Migration failure for AC instance by updating the participant sim behavior                  | Should receive a 202 Accepted response from ACM-R and the stateChangeResult of AC instance should be FAILED            |
 +--------------------------------------------------+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
-| FailDePrimeACDefinitionsFrom                     | Verify the failure of deprime in migration AC definition by updating the participant sim to fail       | Should receive a 202 Accepted response and the migration AC definition in ACM-R should have stateChangeResult FAILED   |
-+--------------------------------------------------+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
-| DePrimeACDefinitionsFrom                         | Deprime the migration AC definition from the participants                                              | Should receive a 202 Accepted response and the migration AC definition in ACM-R should be moved to COMMISSIONED state  |
-+--------------------------------------------------+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
-| UnDeployAutomationComposition                    | Undeploy the AC instance                                                                               | Should receive a 202 Accepted response and the AC instance in ACM-R should have the UNDEPLOYED status                  |
+| UnInstantiateAutomationComposition               | Undeploy and Uninstantiate the AC instance                                                             | Should receive a 202 Accepted response and the AC instance should have been deleted in ACM-R                           |
 +--------------------------------------------------+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
 | FailUnDeployAutomationCompositionMigrationTo     | Verify the failure of undeploy in migration AC instance by updating the participant sim to fail        | Should receive a 202 Accepted response and the stateChangeResult of the instance in ACM-R should be FAILED             |
 +--------------------------------------------------+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
 | UnDeployAutomationCompositionMigrationTo         | Undeploy the migration AC instance by updating the participant sim to success                          | Should receive a 202 Accepted response and the deploy state of the migration AC instance should be UNDEPLOYED          |
 +--------------------------------------------------+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
-| UnInstantiateAutomationComposition               | Uninstantiate the AC instance                                                                          | Should receive a 202 Accepted response and the AC instance should have been deleted in ACM-R                           |
-+--------------------------------------------------+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
 | FailUnInstantiateACMigrationTo                   | Verify the uninstantiate failure in migration AC instance after updating the participant sim to fail   | Should receive a 202 Accepted response, and the AC instance stateChangeResult should be FAILED in ACM-R                |
 +--------------------------------------------------+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
 | UnInstantiateAutomationCompositionMigrationTo    | Uninstantiate the migration AC instance                                                                | Should receive a 202 Accepted response and the migration AC instance should have been deleted in ACM-R                 |
 +--------------------------------------------------+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
-| DePrimeACDefinitions                             | Deprime the AC definition                                                                              | Should receive a 202 Accepted response and the the AC definition in ACM-R should be moved to COMMISSIONED state        |
+| InstantiateAutomationCompositionRollback         | Instantiate the Automation Composition for rollback test                                               | Should receive a 201 Accepted response from ACM-R                                                                      |
++--------------------------------------------------+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
+| DeployAutomationCompositionRollback              | Deploy the AC instance for rollback test                                                               | Should receive a 202 Accepted status and the deploy state should be DEPLOYED in ACM-R                                  |
++--------------------------------------------------+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
+| FailAutomationCompositionMigrationRollback       | Verify the Migration failure for AC instance by updating the participant sim behavior                  | Should receive a 202 Accepted response from ACM-R and the stateChangeResult of AC instance should be FAILED            |
++--------------------------------------------------+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
+| RollbackAutomationComposition                    | Rollback the AC instance                                                                               | Should receive a 200 response and the AC instance should be Rolled back to to the original AC definition               |
 +--------------------------------------------------+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
-| DePrimeACDefinitionsTo                           | Deprime the migration target AC definition from the participants                                       | Should receive a 202 Accepted response and the target AC definition in ACM-R should be moved to COMMISSIONED state     |
+| FailAutomationCompositionMigrationRollback2      | Verify the Migration failure for AC instance by updating the participant sim behavior                  | Should receive a 202 Accepted response from ACM-R and the stateChangeResult of AC instance should be FAILED            |
++--------------------------------------------------+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
+| FailRollbackAutomationComposition                | Verify the Rollback failure for AC instance by updating the participant sim behavior                   | Should receive a 202 Accepted response from ACM-R and the stateChangeResult of AC instance should be FAILED            |
++--------------------------------------------------+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
+| UnInstantiateAutomationCompositionRollback       | Uninstantiate the AC instance                                                                          | Should receive a 202 Accepted response and the AC instance should have been deleted in ACM-R                           |
++--------------------------------------------------+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
+| FailDePrimeACDefinitionsFrom                     | Verify the failure of deprime in migration AC definition by updating the participant sim to fail       | Should receive a 202 Accepted response and the migration AC definition in ACM-R should have stateChangeResult FAILED   |
 +--------------------------------------------------+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
-| DeleteACDefinition                               | Delete automation composition definition                                                               | Should receive a 200 response and the AC definition should be removed in ACM-R db                                      |
+| DeleteACDefinitionFrom                           | Deprime and Delete the migration automation composition definition                                     | Should receive a 200 response and the migration AC definition should be removed in ACM-R db                            |
 +--------------------------------------------------+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
-| DeleteACDefinitionFrom                           | Delete the migration automation composition definition                                                 | Should receive a 200 response and the migration AC definition should be removed in ACM-R db                            |
+| DeleteACDefinitions                              | Deprime and Delete automation composition definition                                                   | Should receive a 200 response and the AC definition should be removed in ACM-R db                                      |
 +--------------------------------------------------+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
-| DeleteACDefinitionTo                             | Delete the target automation composition definition                                                    | Should receive a 200 response and the target AC definition should be removed in ACM-R db                               |
+| DeleteACDefinitionTo                             | Deprime and Delete the target automation composition definition                                        | Should receive a 200 response and the target AC definition should be removed in ACM-R db                               |
 +--------------------------------------------------+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
index 92ab6d4..64635f0 100644 (file)
@@ -39,6 +39,7 @@ Outbound messages
 - AUTOMATIONCOMPOSITION_STATECHANGE_ACK: is an acknowledgement sent by a participant as a response to AutomationCompositionStateChange
 - AUTOMATION_COMPOSITION_DEPLOY_ACK: is an acknowledgement sent by a participant as a response to AutomationCompositionDeploy
 - PARTICIPANT_PRIME_ACK: is an acknowledgement sent by a participant as a response to ParticipantPrime
+- PARTICIPANT_REQ_SYNC_MSG: A sync up request sent by a participant
 
 Design of a PARTICIPANT_REGISTER message
 ----------------------------------------
@@ -170,3 +171,12 @@ Design of a AUTOMATIONCOMPOSITION_STATECHANGE_ACK message
 - 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
+
+Design of a PARTICIPANT_REQ_SYNC_MSG message
+--------------------------------------------
+- ACM-runtime triggers the execution to send an update message
+- Participant-intermediary validate the message
+- If there is missing or outdated instance/composition it saves in memory the operation on hold, and sends a PARTICIPANT_REQ_SYNC_MSG to ACM-runtime
+- ACM-runtime receives the PARTICIPANT_REQ_SYNC_MSG and send back a PARTICIPANT_SYNC_MSG message with updated data
+- Participant-intermediary receives the PARTICIPANT_SYNC_MSG and recheck the operations in memory
+- If all data in memory are updated Participant performs its designated job
index 540b043..978ad03 100755 (executable)
@@ -9,11 +9,13 @@ ParticipantRegisterAck,ACM Runtime,Participant,Acknowledgment of Participant Reg
 ParticipantDeregister,Participant,ACM Runtime,Participant deregisters with the ACM runtime,participantId,The ID of this participant – in UUID format
 ,,,,replicaId,The replica ID of this participant – in UUID format
 ,,,,messageType,Enum indicating the type of message PARTICIPANT_DEREGISTER
-ParticipantDeregisterAck,ACM Runtime,Participant,Acknowledgment of Participant Deegistration,participantId,The ID of this participant – in UUID format
+ParticipantDeregisterAck,ACM Runtime,Participant,Acknowledgment of Participant Deregistration,participantId,The ID of this participant – in UUID format
 ,,,,replicaId,The replica ID of this participant – in UUID format
 ,,,,messageType,Enum indicating the type of message PARTICIPANT_DEREGISTER_ACK
 ParticipantPrime,ACM Runtime,Participant,Trigger priming/depriming in the participant,participantId,The ID of this participant – in UUID format
+,,,,participantIdList, The list of all participants involved in this message
 ,,,,compositionId,The id of the AC Definition related to this message
+,,,,revisionIdComposition,The last revision of the AC Definition – in UUID format
 ,,,,participantDefinitionUpdates,Contains AC element definition values for a particular participant
 ,,,,messageType,Enum indicating the type of message PARTICIPANT_PRIME
 ParticipantPrimeAck,Participant,ACM Runtime,Message to confirm participant has been primed/deprimed,participantId,The ID of this participant – in UUID format
@@ -22,18 +24,21 @@ ParticipantPrimeAck,Participant,ACM Runtime,Message to confirm participant has b
 ,,,,stateChangeResult,NO_ERROR/FAILED
 ,,,,message,A message indicating the result
 ,,,,messageType,Enum indicating the type of message PARTICIPANT_PRIME_ACK
-ParticipantStatusReq,ACM Runtime,Participant,Message sent to reques a status update from the participant,participantId,The ID of the participant to request update from – in UUID format
+ParticipantStatusReq,ACM Runtime,Participant,Message sent to request a status update from the participant,participantId,The ID of the participant to request update from – in UUID format
 ,,,,messageType,Enum indicating the type of message PARTICIPANT_STATUS_REQ
 ParticipantStatus,Participant,ACM Runtime,Status update message,state,Enum indicating the current state of the participant
 ,,,,replicaId,The replica ID of this participant – in UUID format
 ,,,,participantDefinitionUpdates,"A list of ParticipantDefinition updates, returned in response to ParticipantStatusReq only"
 ,,,,automationCompositionInfoList,List of AutomationCompositionInfo types with AutomationCompositionId and its state
-,,,,participantSupportedElementTypes,Ac element types that this participant is capable for deployinh/supporting
+,,,,participantSupportedElementTypes,Ac element types that this participant is capable for deploying/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.
+,,,,participantIdList, The list of all participants involved in this message
 ,,,,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
+,,,,revisionIdComposition,The last revision of the AC Definition – in UUID format
+,,,,revisionIdInstance,The last revision of the automation composition – in UUID format
 ,,,,participantId,UUID indicating the participant the message is intended for
 ,,,,messageType,Enum indicating the type of message AUTOMATION_COMPOSITION_DEPLOY
 AutomationCompositionDeployAck,Participant,ACM Runtime,Message to acknowledge that deploy or state change message has been received by participant,automationCompositionResultMap,"A map with AutomationCompositionElementID as its key, and a pair of result and message as value per AutomationCompositionElement"
@@ -45,15 +50,21 @@ AutomationCompositionDeployAck,Participant,ACM Runtime,Message to acknowledge th
 ,,,,stateChangeResult,NO_ERROR/FAILED
 ,,,,messageType,Enum indicating the type of message AUTOMATION_COMPOSITION_DEPLOY_ACK
 AutomationCompositionStateChange,ACM Runtime,Participant,Message to request change state of composition to states other than DEPLOY,deployOrderedState,Enum indicating the deployment state being requested
+,,,,participantIdList, The list of all participants involved in this message
 ,,,,lockOrderedState,Enum indicating the lock state being requested
 ,,,,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
+,,,,revisionIdComposition,The last revision of the AC Definition – in UUID format
+,,,,revisionIdInstance,The last revision of the automation composition – in UUID format
 ,,,,participantId,UUID indicating the participant the message is intended for
 ,,,,messageType,Enum indicating the type of message AUTOMATION_COMPOSITION_STATECHANGE_ACK
 PropertiesUpdate,ACM Runtime,Participant,Message to request update,participantUpdatesList,A list of ParticipantUpdates instances which carries details of an updated participant.
+,,,,participantIdList, The list of all participants involved in this message
 ,,,,compositionId,The id of the AC Definition related to this message
 ,,,,automationCompositionId,The id of the automation composition related to this message
+,,,,revisionIdComposition,The last revision of the AC Definition – in UUID format
+,,,,revisionIdInstance,The last revision of the automation composition – in UUID format
 ,,,,participantId,UUID indicating the participant the message is intended for
 ,,,,messageType,Enum indicating the type of message PROPERTIES_UPDATE
 ParticipantSync,ACM Runtime,Participant,Message to request sync,participantId,The ID of this participant – in UUID format
@@ -64,17 +75,31 @@ ParticipantSync,ACM Runtime,Participant,Message to request sync,participantId,Th
 ,,,,participantDefinitionUpdates,Contains AC element definition values for the participant
 ,,,,delete,Flag - if true it is a delete operation
 ,,,,restarting,Flag - if true it is a restarting scenario
+,,,,revisionIdComposition,The last revision of the AC Definition – in UUID format
+,,,,revisionIdInstance,The last revision of the automation composition – in UUID format
 ,,,,messageType,Enum indicating the type of message PARTICIPANT_SYNC_MSG
 AutomationCompositionMigration,ACM Runtime,Participant,Message to request update,participantUpdatesList,A list of ParticipantUpdates instances which carries details of an updated participant.
+,,,,participantIdList, The list of all participants involved in this message
 ,,,,precheck,Flag - if true it is a Migration Precheck
+,,,,rollback,Flag - if true it is a Rollback of the Migration failed
 ,,,,compositionId,The id of the AC Definition related to this message
 ,,,,compositionTargetId,The id of the AC Definition target
 ,,,,automationCompositionId,The id of the automation composition related to this message
+,,,,revisionIdComposition,The last revision of the AC Definition – in UUID format
+,,,,revisionIdCompositionTarget,The last revision of the AC Definition Target – in UUID format
 ,,,,participantId,UUID indicating the participant the message is intended for
 ,,,,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.
+,,,,participantIdList, The list of all participants involved in this message
 ,,,,stage,The next stage that participant is supposed to receiving
 ,,,,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
 ,,,,automationCompositionId,The id of the automation composition related to this message
+,,,,revisionIdComposition,The last revision of the AC Definition – in UUID format
+,,,,revisionIdInstance,The last revision of the automation composition – in UUID format
 ,,,,messageType,Enum indicating the type of message AUTOMATION_COMPOSITION_PREPARE
+ParticipantReqSync,Participant,ACM Runtime,Message sent to request a sync up,participantId,The ID of this participant – in UUID format
+,,,,replicaId,The replica ID of this participant – in UUID format
+,,,,compositionId,The id of the AC Definition outdated
+,,,,compositionTargetId,The id of the AC Definition target outdated
+,,,,automationCompositionId,The id of the automation composition outdated
index ec9ba5e..673e427 100644 (file)
Binary files a/docs/clamp/acm/images/acm-participants-protocol/acm-monitoring.png and b/docs/clamp/acm/images/acm-participants-protocol/acm-monitoring.png differ
diff --git a/docs/clamp/acm/images/acm-participants-protocol/acm-sync-up.png b/docs/clamp/acm/images/acm-participants-protocol/acm-sync-up.png
new file mode 100644 (file)
index 0000000..6e034c9
Binary files /dev/null and b/docs/clamp/acm/images/acm-participants-protocol/acm-sync-up.png differ