You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 42 Next »

Priming The CLAMP Automation Composition Runtime Lifecycle Management uses the following system-level dialogues. These dialogues enable the CLAMP runtime capabilities described in Section 2 of TOSCA Defined Automation Compositions: Architecture and Design. Design Time dialogues will be described in future releases of the system.

1 Dialogues on Participants

1.1 Participant Registration

Participant Registration is performed by a Participant when it starts up. It registers its ID and the ACM Element Types it supports with the ACM runtime. Participant Participant ACM_Runtime ACM_RuntimeACM_Database ACM_Database [ASYNC] Register [ASYNC] Create or Update Participant Registrationand store supported ACM element types Registration Accepted

1.2 Participant Deregistration

Participant Deregistration is performed by a Participant when it shuts down. It deregisters its ID and type with the ACM runtime.

The participant should already have cleared down all its ACM Element instances and set their states to UNINITIALIZED. Participant Participant ACM_Runtime ACM_RuntimeACM_Database ACM_Database Uninitialize all ACM Element Instances running on Participant(See Instantiation Dialogues) Delete Participant Registration [ASYNC] Deregistration Accepted

1.3 Participant Supervision

Participant Supervision is performed periodically between participants and the ACM runtime server to ensure that registered participants are available over time. Participants send a heartbeat message to the ACM runtime at a configured interval.


Participant Participant ACM_Runtime ACM_RuntimeACM_Database ACM_Database loop[Every Participant Supervision Interval] Heartbeat message Update Participant Heartbeat data

The ACM runtime regularly checks the heartbeat reports from participants and takes action of participants time out. If a heartbeat message is not received for a participant in the Timeout Interval, the participant is marked as timed out and its ACM element instances are informed.


ACM_Runtime ACM_RuntimeACM_Database ACM_Database Database Database loop[Every ACM_Runtime Supervision Interval] loop[Over all Participants] Read Participant Heartbeat Information alt[Participant Heartbeat not received in Timeout Interval] Inform all ACM Element Instancesrunning on Participant of Timeout(See Instantiation Dialogues)

1.4 Participant Information

The information on participants is available over a REST endpoint.


REST REST ACM_Runtime ACM_RuntimeACM_Database ACM_Database Get Participant Information Read Participant Data Return Participant Information includingsupported ACM Element Types and Heartbeat Information

2 Dialogues on Automation Composition Types

Commissioning dialogues are used to commission and decommission Automation Composition Types and to set the values of Common Parameters. The values of common parameters are included in the TOSCA YAML file that defines the full Automation Composition Type.

2.1 Commissioning an Automation Composition Type

Create on a POST and update on a PUT.


REST REST ACM_Runtime ACM_RuntimeACM_Database ACM_Database Commission Automation Composition Type alt[Automation Composition Type exists and has Instances] Automation Composition Type Commissioning Failed Create and Store Automation Composition Type Automation Composition Type Commissioned

2.2 Commissioning an Automation Composition Type using SDC

SDC SDC Policy_Distribution Policy_Distribution ACM_Runtime ACM_Runtime [ASYNC] CSAR containing Automation Composition Type Definition Commission Automation Composition Type(See Commissioning Sequence Diagram) Result of Commissioning [ASYNC] Return result of Deployment

2.3 Decommissioning an Automation Composition Type Definition

REST REST ACM_Runtime ACM_RuntimeACM_Database ACM_Database Decommission Automation Composition Type alt[Automation Composition Type has Instances] Automation Composition Type Decommissioning Failed Delete Automation Composition Type Automation Composition Type Decommissioned

2.4 Prime an Automation Composition Type Definition on Participants

The Priming operation sends Automation Composition Types and common property values to participants for each Automation Composition Element Type in the Automation Composition Type. A participant should respond for each Automation Composition Element Type, thus causing the full Automation Composition Type to become primed. Note that if more than one participant can support an Automation Composition Element Type the ACM Runtime uses the participant in the first response it receives for that Automation Composition Element Type.


REST REST ACM_Runtime ACM_Runtime Participant ParticipantACM_Database ACM_Database Priming REST Request Prime Automation Composition Type Read Automation Composition Type [ASYNC] Send Priming Request to all Participantswith Automation Composition Type Definition Priming of Automation Composition Type Ordered Each Participant [ASYNC] Receive Priming Request with Automation Composition Type Definition loop[Over all Automation Composition Element Type Definitionsin Automation Composition Type Definition] alt[Automation Composition Element Type supported by Participant] Save Automation Composition Element Type details on this Participant [ASYNC] Send Priming Response claiming Automation Composition Element Type alt[Automation Composition Element Type already Primed] Ignore Priming Response Record Participant for Automation Composition Element Typeand set Element Type as Primed Ignore Priming Request

2.5 Get Automation Composition Types

This dialogue allows an Automation Composition Type  to be read.


REST REST ACM_Runtime ACM_RuntimeACM_Database ACM_Database Get Automation Composition Type Information Read Automation Composition Type Information Respond with Automation Composition informationincluding ACM Element Type information and Priming Status

PAGE UPDATED TO HERE.

3. Instantiation Dialogues

Instantiation dialogues are used to create, set parameters on, instantiate, update, and remove Automation Composition instances.

3.1 Creating an Automation Composition Instance

PlantUML 1.2023.12 <b>This version of PlantUML is 301 days old, so you should<b>consider upgrading from https://plantuml.com/download [From string (line 5) ] @startumlparticipant CLAMP_GUIparticipant CLAMP_Runtimedatabase ACM_Database database ACM_Database  CLAMP_GUI -> CLAMP_Runtime: [REST] Read Automation Composition Type Definit ...Syntax Error?

Note that this dialogue creates the Automation Composition Instance in the Instantiated Automation Composition Inventory. The instance is sent to the participants using the process described in the dialogue in Section 2.3.

3.2 Updating Instance Specific Parameters on an Automation Composition Instance

PlantUML 1.2023.12 <b>This version of PlantUML is 301 days old, so you should<b>consider upgrading from https://plantuml.com/download [From string (line 5) ] @startumlparticipant CLAMP_GUIparticipant CLAMP_Runtimedatabase ACM_Database  CLAMP_GUI -> CLAMP_Runtime: [REST] Read Automation Composition InstancesSyntax Error?

3.3 Updating an Automation Composition Instance with a Configuration on Participants

PlantUML 1.2023.12 <b>This version of PlantUML is 301 days old, so you should<b>consider upgrading from https://plantuml.com/download [From string (line 6) ] @startumlparticipant CLAMP_GUIparticipant CLAMP_Runtimeparticipant Participantdatabase ACM_Database  CLAMP_GUI -> CLAMP_Runtime: [REST] Read all configuration versions of Automation Composition Inst ...Syntax Error?

3.4 Changing the state of an Automation Composition Instance on Participants

PlantUML 1.2023.12 <b>This version of PlantUML is 301 days old, so you should<b>consider upgrading from https://plantuml.com/download [From string (line 6) ] @startumlparticipant CLAMP_GUIparticipant CLAMP_Runtimeparticipant Participantdatabase ACM_Database  CLAMP_GUI -> CLAMP_Runtime: [REST] Read all Instantiated Automation Composition InstancesSyntax Error?

3.5 De-instantiating an Automation Composition Instance from Participants

PlantUML 1.2023.12 <b>This version of PlantUML is 301 days old, so you should<b>consider upgrading from https://plantuml.com/download [From string (line 6) ] @startumlparticipant CLAMP_GUIparticipant CLAMP_Runtimeparticipant Participantdatabase ACM_Database  CLAMP_GUI -> CLAMP_Runtime: [REST] Read all Instantiated Automation Composition InstancesSyntax Error?

3.6 Deleting an Automation Composition Instance

PlantUML 1.2023.12 <b>This version of PlantUML is 301 days old, so you should<b>consider upgrading from https://plantuml.com/download [From string (line 5) ] @startumlparticipant CLAMP_GUIparticipant CLAMP_Runtimedatabase ACM_Database  CLAMP_GUI -> CLAMP_Runtime: [REST] Read all Automation Composition InstancesSyntax Error?

3.7 Reading Automation Composition Instances

PlantUML 1.2023.12 <b>This version of PlantUML is 301 days old, so you should<b>consider upgrading from https://plantuml.com/download [From string (line 5) ] @startumlparticipant CLAMP_GUIparticipant CLAMP_Runtimedatabase ACM_Database  CLAMP_GUI -> CLAMP_Runtime: [REST] Read all Automation Composition InstancesSyntax Error?

3. Monitoring Dialogues

Monitoring dialogues are used to monitor and read statistics on Automation Composition Instances.

3.1 Reporting of Monitoring Information and Statistics by Participants

PlantUML 1.2023.12 <b>This version of PlantUML is 301 days old, so you should<b>consider upgrading from https://plantuml.com/download [From string (line 5) ] @startumlparticipant CLAMP_Runtimeparticipant Participantdatabase ACM_Database  Participant -> CLAMP_Runtime: [DMaaP] Participant and Automation Composition Element Monitoring a ...Syntax Error?

3.2 Viewing of Monitoring Information

PlantUML 1.2023.12 <b>This version of PlantUML is 301 days old, so you should<b>consider upgrading from https://plantuml.com/download [From string (line 5) ] @startumlparticipant CLAMP_GUIparticipant CLAMP_Runtimedatabase ACM_Database  == Overview of all Automation Composition Instances ==Syntax Error?

3.2 Viewing of Statistics

PlantUML 1.2023.12 <b>This version of PlantUML is 301 days old, so you should<b>consider upgrading from https://plantuml.com/download [From string (line 5) ] @startumlparticipant CLAMP_GUIparticipant CLAMP_Runtimedatabase ACM_Database  == Statistics of all Automation Composition Instances ==Syntax Error?

3.3 Statistics Housekeeping

PlantUML 1.2023.12 <b>This version of PlantUML is 301 days old, so you should<b>consider upgrading from https://plantuml.com/download [From string (line 4) ] @startumlparticipant CLAMP_Runtimedatabase ACM_Database  == Automation Composition Instance Statistics ==Syntax Error?

4. Supervision Dialogues

Supervision dialogues are used to check the state of Automation Composition Instances and Participants.

4.1 Supervise Participants

PlantUML 1.2023.12 <b>This version of PlantUML is 301 days old, so you should<b>consider upgrading from https://plantuml.com/download [From string (line 4) ] @startumlparticipant CLAMP_Runtimedatabase ACM_Database  loop foreverSyntax Error?

4.2 Supervise Automation Compositions

PlantUML 1.2023.12 <b>This version of PlantUML is 301 days old, so you should<b>consider upgrading from https://plantuml.com/download [From string (line 4) ] @startumlparticipant CLAMP_Runtimedatabase ACM_Database  loop foreverSyntax Error?

  • No labels