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 ,,,,messageType,Enum indicating the type of message PARTICIPANT_REGISTER
   5 ParticipantRegisterAck,ACM Runtime,Participant,Acknowledgment of Participant Registration,participantId,The ID of this participant – in UUID format
   6 ,,,,messageType,Enum indicating the type of message PARTICIPANT_REGISTER_ACK
   7 ParticipantDeregister,Participant,ACM Runtime,Participant deregisters with the ACM runtime,participantId,The ID of this participant – in UUID format
   8 ,,,,messageType,Enum indicating the type of message PARTICIPANT_DEREGISTER
   9 ParticipantDeregisterAck,ACM Runtime,Participant,Acknowledgment of Participant Deegistration,participantId,The ID of this participant – in UUID format
  10 ,,,,messageType,Enum indicating the type of message PARTICIPANT_DEREGISTER_ACK
  11 ParticipantPrime,ACM Runtime,Participant,Trigger priming/depriming in the participant,participantId,The ID of this participant – in UUID format
  12 ,,,,compositionId,The id of the AC Definition related to this message
  13 ,,,,participantDefinitionUpdates,Contains AC element definition values for a particular participant
  14 ,,,,messageType,Enum indicating the type of message PARTICIPANT_PRIME
  15 ParticipantPrimeAck,Participant,ACM Runtime,Message to confirm participant has been primed/deprimed,participantId,The ID of this participant – in UUID format
  16 ,,,,compositionId,The id of the AC Definition related to this message
  17 ,,,,stateChangeResult,NO_ERROR/FAILED
  18 ,,,,message,A message indicating the result
  19 ,,,,messageType,Enum indicating the type of message PARTICIPANT_PRIME_ACK
  20 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
  21 ,,,,messageType,Enum indicating the type of message PARTICIPANT_STATUS_REQ
  22 ParticipantStatus,Participant,ACM Runtime,Status update message,state,Enum indicating the current state of the participant
  23 ,,,,participantDefinitionUpdates,"A list of ParticipantDefinition updates, returned in response to ParticipantStatusReq only"
  24 ,,,,automationCompositionInfoList,List of AutomationCompositionInfo types with AutomationCompositionId and its state
  25 ,,,,participantSupportedElementTypes,Ac element types that this participant is capable for deployinh/supporting
  26 ,,,,messageType,Enum indicating the type of message PARTICIPANT_STATUS
  27 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.
  28 ,,,,compositionId,The id of the AC Definition related to this message
  29 ,,,,automationCompositionId,The id of the automation composition related to this message
  30 ,,,,startPhase,Integer indicating the start up order of the elements
  31 ,,,,participantId,UUID indicating the participant the message is intended for
  32 ,,,,messageType,Enum indicating the type of message AUTOMATION_COMPOSITION_DEPLOY
  33 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"
  34 ,,,,compositionId,The id of the AC Definition related to this message
  35 ,,,,automationCompositionId,The id of the automation composition related to this message
  36 ,,,,message,A message indicating the result
  37 ,,,,stateChangeResult,NO_ERROR/FAILED
  38 ,,,,messageType,Enum indicating the type of message AUTOMATION_COMPOSITION_DEPLOY_ACK
  39 AutomationCompositionStateChange,ACM Runtime,Participant,Message to request change state of composition to states other than DEPLOY,deployOrderedState,Enum indicating the deployment state being requested
  40 ,,,,lockOrderedState,Enum indicating the lock state being requested
  41 ,,,,compositionId,The id of the AC Definition related to this message
  42 ,,,,automationCompositionId,The id of the automation composition related to this message
  43 ,,,,startPhase,Integer indicating the start up order of the elements
  44 ,,,,participantId,UUID indicating the participant the message is intended for
  45 ,,,,messageType,Enum indicating the type of message AUTOMATION_COMPOSITION_STATECHANGE_ACK
  46 PropertiesUpdate,ACM Runtime,Participant,Message to request update,participantUpdatesList,A list of ParticipantUpdates instances which carries details of an updated participant.
  47 ,,,,compositionId,The id of the AC Definition related to this message
  48 ,,,,automationCompositionId,The id of the automation composition related to this message
  49 ,,,,participantId,UUID indicating the participant the message is intended for
  50 ,,,,messageType,Enum indicating the type of message PROPERTIES_UPDATE
  51 ParticipantRestart,ACM Runtime,Participant,Message to request update,participantId,The ID of this participant – in UUID format
  52 ,,,,automationcompositionList,A list of ParticipantRestartAc instances which carries details of an updated participant.
  53 ,,,,compositionId,The id of the AC Definition related to this message
  54 ,,,,participantDefinitionUpdates,Contains AC element definition values for a particular participant
  55 ,,,,messageType,Enum indicating the type of message PARTICIPANT_RESTART
  56 AutomationCompositionMigration,ACM Runtime,Participant,Message to request update,participantUpdatesList,A list of ParticipantUpdates instances which carries details of an updated participant.
  57 ,,,,compositionId,The id of the AC Definition related to this message
  58 ,,,,compositionTargetId,The id of the AC Definition target
  59 ,,,,automationCompositionId,The id of the automation composition related to this message
  60 ,,,,participantId,UUID indicating the participant the message is intended for
  61 ,,,,messageType,Enum indicating the type of message PROPERTIES_UPDATE