Updated participant protocol docs
[policy/parent.git] / docs / clamp / acm / files / ACM-Message-Table.csv
1 Message,Source,Target,Purpose,Important Fields,Field Descriptions
2 ParticipantRegister,Participant,ACM Runtime,Participant registers with the ACM runtime,participantId,The ID of this participant – in UUID format
3 ,,,,participantSupportedElementTypes,A list of element types that this participant supports
4 ParticipantRegisterAck,ACM Runtime,Participant,Acknowledgment of Participant Registration,participantId,The ID of this participant – in UUID format
5 ,,,,Result,Success/Fail
6 ,,,,Message,A message indicating the reason for failure
7 ParticipantDeregister,Participant,ACM Runtime,Participant deregisters with the ACM runtime,participantId,The ID of this participant – in UUID format
8 ParticipantDeregisterAck,ACM Runtime,Participant,Acknowledgment of Participant Deegistration,participantId,The ID of this participant – in UUID format
9 ,,,,Result,Success/Fail
10 ,,,,Message,A message indicating the reason for failure
11 ParticipantPrime,ACM Runtime,Participant,Trigger priming/depriming in the participant,participantId,The ID of this participant – in UUID format
12 ,,,,participantDefinitionUpdates,Contains AC element definition values for a particular participant
13 ,,,,Result,Success/Fail
14 ,,,,Message,A message indicating the reason for failure
15 ParticipantPrimeAck,Participant,ACM Runtime,Message to confirm participant has been primed/deprimed,participantId,The ID of this participant – in UUID format
16 ,,,,Result,Success/Fail
17 ,,,,Message,A message indicating the reason for failure
18 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
19 ,,,,messageType,Enum indicating the type of message PARTICIPANT_STATUS_REQ
20 ParticipantStatus,Participant,ACM Runtime,Status update message,state,Enum indicating the current state of the participant
21 ,,,,participantDefinitionUpdates,"A list of ParticipantDefinition updates, returned in response to ParticipantStatusReq only"
22 ,,,,automationCompositionInfoList,List of AutomationCompositionInfo types with AutomationCompositionId and its state
23 ,,,,participantSupportedElementTypes,Ac element types that this participant is capable for deployinh/supporting
24 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.
25 ,,,,startPhase,Integer indicating the start up order of the elements
26 ,,,,participantId,UUID indicating the participant the message is intended for
27 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"
28 ,,,,automationCompositionId,The id of the automation composition related to this message
29 AutomationCompositionStateChange,ACM Runtime,Participant,Message to request change state of composition to states other than DEPLOY,deployOrderedState,Enum indicating the deployment state being requested
30 ,,,,lockOrderedState,Enum indicating the lock state being requested
31 ,,,,startPhase,Integer indicating the start up order of the elements
32 ,,,,participantId,UUID indicating the participant the message is intended for