summaryrefslogtreecommitdiffstats
path: root/docs/clamp/acm/files/ACM-Message-Table.csv
diff options
context:
space:
mode:
authorFrancescoFioraEst <francesco.fiora@est.tech>2024-07-04 13:22:07 +0100
committerFrancesco Fiora <francesco.fiora@est.tech>2024-07-04 16:20:37 +0000
commit11fadc0b343792387e5e85a785122af9a019857c (patch)
tree9185e42f7a8bc58ef23464ea563b760b9342fe92 /docs/clamp/acm/files/ACM-Message-Table.csv
parent709ac10c7a846557e8c9d5d9d5a3e07e71efb023 (diff)
Update Replica support in docs
Update Replica support in Messages and participant configuration. Add how States are saved in DB. Issue-ID: POLICY-5038 Change-Id: I27d5ae70c49c9640e1fc05c4af01f11293f8812d Signed-off-by: FrancescoFioraEst <francesco.fiora@est.tech>
Diffstat (limited to 'docs/clamp/acm/files/ACM-Message-Table.csv')
-rwxr-xr-xdocs/clamp/acm/files/ACM-Message-Table.csv20
1 files changed, 16 insertions, 4 deletions
diff --git a/docs/clamp/acm/files/ACM-Message-Table.csv b/docs/clamp/acm/files/ACM-Message-Table.csv
index b706fe60..da17374a 100755
--- a/docs/clamp/acm/files/ACM-Message-Table.csv
+++ b/docs/clamp/acm/files/ACM-Message-Table.csv
@@ -1,18 +1,23 @@
Message,Source,Target,Purpose,Important Fields,Field Descriptions
ParticipantRegister,Participant,ACM Runtime,Participant registers with the ACM runtime,participantId,The ID of this participant – in UUID format
+,,,,replicaId,The replica ID of this participant – in UUID format
,,,,participantSupportedElementTypes,A list of element types that this participant supports
,,,,messageType,Enum indicating the type of message PARTICIPANT_REGISTER
ParticipantRegisterAck,ACM Runtime,Participant,Acknowledgment of Participant Registration,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_REGISTER_ACK
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
+,,,,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
,,,,compositionId,The id of the AC Definition related to this message
,,,,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
+,,,,replicaId,The replica ID of this participant – in UUID format
,,,,compositionId,The id of the AC Definition related to this message
,,,,stateChangeResult,NO_ERROR/FAILED
,,,,message,A message indicating the result
@@ -20,17 +25,20 @@ ParticipantPrimeAck,Participant,ACM Runtime,Message to confirm participant has b
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
,,,,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
,,,,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
,,,,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"
+,,,,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
,,,,message,A message indicating the result
@@ -48,11 +56,15 @@ PropertiesUpdate,ACM Runtime,Participant,Message to request update,participantUp
,,,,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
-ParticipantRestart,ACM Runtime,Participant,Message to request update,participantId,The ID of this participant – in UUID format
-,,,,automationcompositionList,A list of ParticipantRestartAc instances which carries details of an updated participant.
+ParticipantSync,ACM Runtime,Participant,Message to request sync,participantId,The ID of this participant – in UUID format
+,,,,replicaId,The replica ID of this participant – in UUID format
+,,,,excludeReplicas,The list of replica ID that can ignore the message – List of UUID
+,,,,automationcompositionList,A list of ParticipantRestartAc instances which carries details of an updated instances for the participant.
,,,,compositionId,The id of the AC Definition related to this message
-,,,,participantDefinitionUpdates,Contains AC element definition values for a particular participant
-,,,,messageType,Enum indicating the type of message PARTICIPANT_RESTART
+,,,,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
+,,,,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.
,,,,compositionId,The id of the AC Definition related to this message
,,,,compositionTargetId,The id of the AC Definition target