...
| Message | Source | Target | Purpose | Important Fields | Field Descriptions |
|---|---|---|---|---|---|
| ParticipantRegister | Participant | CLAMP Runtime | Participant registers with the CLAMP runtime | ParticipantId | The ID of this participant |
| ParticipantType | The type of the participant; maps to the capabilities of the participant in Automation Composition Type Definitions | ||||
| ParticipantRegisterAck | CLAMP Runtime | Participant | Acknowledgment of Participant Registration | ParticipantId | The ID of this participant |
| ParticipantType | The type of the participant; maps to the capabilities of the participant in Automation Composition Type Definitions | ||||
| Result | Success/Fail | ||||
| Message | A message indicating the reason for failure | ||||
| ParticipantUpdate | CLAMP Runtime | Participant | CLAMP Runtime sends Automation Composition Element Definitions and Common Parameter Values to Participants | ParticipantDefinitionUpdateMap | Map with Participant ID as its key, each value on the map is an ACMElementDefintionMap |
| ACMElementDefintionMap | List of ACMElementDefinition values for a particular participant, keyed by its Automation Composition Element Definition ID | ||||
| ACMElementDefinition | An ACMElementToscaServiceTemplate containing the definition of the Automation Composition Element and a CommonPropertiesMap with the values of the common property values for Automation Composition Elements of this type | ||||
| ACMElementToscaServiceTemplate | The definition of the Automation Composition Element in TOSCA | ||||
| CommonPropertiesMap | A <String, String> map indexed by the property name. Each map entry is the serialized value of the property, which can be deserialized into an instance of the type of the property. | ||||
| ParticipantUpdateAck | Participant | CLAMP Runtime | Acknowledgment of Participant Update | ParticipantId | The ID of this participant |
| ParticipantType | The type of the participant; maps to the capabilities of the participant in Automation Composition Type Definitions | ||||
| Result | Success/Fail | ||||
| Message | A message indicating the reason for failure | ||||
| ParticipantDeregister | Participant | CLAMP Runtime | Participant deregisters with the CLAMP runtime | ParticipantId | The ID of this participant |
| ParticipantType | The type of the participant; maps to the capabilities of the participant in Automation Composition Type Definitions | ||||
| ParticipantDeregisterAck | CLAMP Runtime | Participant | Acknowledgment of Participant Deregistration | ParticipantId | The ID of this participant |
| ParticipantType | The type of the participant; maps to the capabilities of the participant in Automation Composition Type Definitions | ||||
| Result | Success/Fail | ||||
| Message | A message indicating the reason for failure | ||||
| ACMUpdate | CLAMP Runtime | Participant | CLAMP Runtime sends Automation Composition Element instances and Instance Specific Parameter Values for an Automation Composition Instance to Participants | ACMId | The name and version of the Automation Composition |
| ParticipantUpdateMap | Map with Participant ID as its key, each value on the map is an ACMElementList | ||||
| ACMElementList | List of ACMElement values for the Automation Composition | ||||
| ACMElement | An ACMElement, which contains among other things a PropertiesMap with the values of property values for this Automation Composition Element instance and a ToscaServiceTemplateFragment with extra concept definitions and instances that a participant may need. | ||||
| PropertiesMap | A <String, String> map indexed by the property name. Each map entry is the serialized value of the property, which can be deserialized into an instance of the type of the property. | ||||
| ToscaServiceTemplateFragment | A well-formed TOSCA service template containing extra concept definitions and instances that a participant may need. For example, the Policy Participant may need policy type definitions or policy instances to be provided if they are not already stored in the Policy Framework. | ||||
| ACMUpdateAck | Participant | CLAMP Runtime | Acknowledgment of Automation Composition Update | ParticipantId | The ID of this participant |
| ParticipantType | The type of the participant; maps to the capabilities of the participant in Automation Composition Type Definitions | ||||
| ACMId | The name and version of the Automation Composition | ||||
| ACMResult | Holds a Result and Message for the overall operation on the participant and a map of Result and Message fields for each Automation Composition Element of the Automation Composition on this participant | ||||
| Result | Success/Fail | ||||
| Message | A message indicating the reason for failure | ||||
| ACMStateChange | CLAMP Runtime | Participant | CLAMP Runtime asks Participants to change the state of an Automation Composition | ACMId | The name and version of the Automation Composition |
| currentState | The current state of the Automation Composition | ||||
| orderedState | The state that the Automation Composition should transition to | ||||
| startPhase | The start phase to which this ControLoopStateChange ACMStateChange message applies | ||||
| ACMStateChangeAck | Participant | CLAMP Runtime | Acknowledgment of Automation Composition State Change | ParticipantId | The ID of this participant |
| ParticipantType | The type of the participant; maps to the capabilities of the participant in Automation Composition Type Definitions | ||||
| ACMId | The name and version of the Automation Composition | ||||
| startPhase | The start phase to which this ControLoopStateChangeAck ACMStateChangeAck message applies | ||||
| ACMResult | Holds a Result and Message for the overall operation on the participant and a map of Result and Message fields for each Automation Composition Element of the Automation Composition on this participant | ||||
| Result | Success/Fail | ||||
| Message | A message indicating the reason for failure | ||||
| ParticipantStatusReq | CLAMP Runtime | Participant | Request that the specified participants return a ParticipantStatus message immediately | ParticipantId | The ID of this participant, if not specified, all participants respond. |
| ParticipantStatus | Participant | CLAMP Runtime | Periodic or on-demand report for heartbeat, Participant Status, Automation Composition Status, and Automation Composition Statistics | ParticipantId | The ID of this participant |
| ParticipantType | The type of the participant; maps to the capabilities of the participant in Automation Composition Type Definitions | ||||
| ParticipantDefinitionUpdateMap (returned in repsonse to ParticipantStatusReq only) | See ParticipantUpdate message above for the definition of this field | ||||
| ParticipantStatus | The current status of the participant for monitoring | ||||
| ParticipantStatistics | Statistics on the participant such as uptime, or messages processed. Can include participant specific data in a string blob that is opaque to CLAMP | ||||
| ACMInfoMap | A map of ACMInfo types indexed by ACMId, one entry for each Automation Composition running on the participant | ||||
| ACMInfo | The ACMStatus and ACMStatistics for a given Automation Composition | ||||
| ACMStatus | The current status of the Automation Composition for monitoring | ||||
| ACMStatistics | Statistics on the Automation Composition such as uptime, or messages processed. Can include participant specific data in a string blob that is opaque to CLAMP | ||||
...