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

Compare with Current View Page History

« Previous Version 67 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 Register a Participant

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 Deregister a Participant

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 "Not In Service". 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 Supervise Participants

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.

The heartbeat message contains updated status information for each AC Element Instance that has changed status since the last Heartbeat message sent by the participant


Participant Participant ACM_Runtime ACM_RuntimeACM_Database ACM_Database loop[Every Participant Supervision Interval] [ASYNC] Heartbeat message includingstatus of AC Element Instances on Participant Update Participant Heartbeat data loop[Every AC Element Instance in Heartbeat Message] Update AC Element Instance status

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] Mark all ACM Element Instancesrunning on Participant as Offline

1.4 Get 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

1.5 Order Full Participant Report

A user can order a full participant report. Each participant responds with a heartbeat report immediately. This preempts the normal heartbeat period reporting and refreshes the status of AC Element Instances immediately.


REST REST ACM_Runtime ACM_Runtime Participants Participants Order Participant Information Issue immediate Heartbeat Report(See §1.3) Participant Information Ordered

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 Commission or Update 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 Commission 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 Decommission an Automation Composition Type

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 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.


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

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.


ACM_Runtime ACM_Runtime Participant Participant participant participant [ASYNC] Bring AC Element Instances for this AC Instance into Service loop[over AC Element Instances in AC Instance] alt[Does the primed Participant ID on this AC Element Instancematch my Participant ID] alt[Is this AC Element Instance already in service] [ASYNC] WARN: AC Element is already in service Bring AC Element Instance into Service alt[AC Element came into service successfully] [ASYNC] INFO: AC Element brought into service [ASYNC] ERROR: AC Element was not brought into service ignore this AC Element instance as its for another participant

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 Type informationincluding ACM Element Type information and Priming Status

3. Instantiation Dialogues

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

3.1 Create or Update an Automation Composition Instance

Create on a POST and update on a PUT.


REST REST ACM_Runtime ACM_RuntimeACM_Database ACM_Database Create Automation Composition Instance forspecified Automation Composition Type withspecified parameter values alt[Automation Composition Instance exists] alt[Automation Composition Instance is already deployed] Automation Composition instance exists and is already deployed Updates on "Not In Service" Automation Composition Instances are allowed alt[Specified Automation Type Composition Exists] alt[Specified Automation Composition Type is Primed] Store Automation Composition Instance Automation Composition Instance Created Automation Composition Type is not primed Automation Composition Type is not found

Note that this dialogue creates the Automation Composition Instance in the ACM database. The instance is sent to the participants using the process described in the dialogue in Section 3.3.

3.2 Delete an Automation Composition Instance

REST REST ACM_Runtime ACM_RuntimeACM_Database ACM_Database Delete Automation Composition Instance alt[Automation Composition Instance exists] alt[Automation Composition Instance is deployed] Automation Composition instance exists and is deployed Automation Composition instance does not exist Delete Automation Composition Instance Automation Composition Instance Deleted

3.3 Deploy Automation Composition Instance

The user requests the AC Instance to be deployed using a REST endpoint. The ACM Runtime orders the AC Instance to be deployed to Participants.


REST REST ACM_Runtime ACM_Runtime Participants ParticipantsACM_Database ACM_Database Deploy Automation Composition Instance Read Automation Composition Instance Information alt[Automation Composition Instance exists] alt[Automation Composition Instance is deployed] Automation Composition instance is already deployed Automation Composition instance does not exist [ASYNC] Deploy AC Element Instances for this AC Instance Mark AC Instance and its AC Element Instances as Deploying Deployment of Automation Composition Instance has been requested

Each participant deploys its AC Element Instances from the AC Instance.


ACM_Runtime ACM_Runtime Participant Participant participant participant [ASYNC] Deploy AC Element Instances for this AC Instance loop[over AC Element Instances in AC Instance] alt[Does the primed Participant ID on this AC Element Instancematch my Participant ID?] alt[Is this AC Element Instance already deployed] [ASYNC] WARN: AC Element is already deployed Deploy AC Element Instance alt[AC Element deployed successfully] Set state of AC Element Instance administrative state to LOCKED [ASYNC] INFO: AC Element has been deployed [ASYNC] ERROR: AC Element was not deployed ignore this AC Element instance as its for another participant

The ACM Runtime receives and stores the responses.


ACM_Runtime ACM_Runtime Participant ParticipantACM_Database ACM_Database [ASYNC] Deploy Automation Composition Element Instance Response Store Automation Composition Element Instance Response Information alt[Is AC Element Instance Deployed?] Set AC Element Instance administrative state as LOCKED alt[Have all the other AC Element Instances in this AC Instance been deployed?] mark AC Instance as Deployed

3.4 Undeploy Automation Composition Instance

The user requests the AC Instance to be undeployed using a REST endpoint. The ACM Runtime orders the AC Instance to be undeployed.


REST REST ACM_Runtime ACM_Runtime Participants ParticipantsACM_Database ACM_Database Undeploy Automation Composition Instance out of Service Read Automation Composition Instance Information alt[Automation Composition Instance exists] alt[Automation Composition Instance is in state "Out Of Service"] Automation Composition instance exists and is already out of service Automation Composition instance does not exist [ASYNC] Take AC Element Instances for this AC Instance out of Service Set status of AC Instance and its AC Element Instances as "Dropping out of Service" Automation Composition Instance has been requested to drop out of service

Each participant takes its AC Element Instances from the AC Instance out of service.


ACM_Runtime ACM_Runtime Participant Participant participant participant [ASYNC] Take AC Element Instances for this AC Instance out of Service loop[over AC Element Instances in AC Instance] alt[Does the primed Participant ID on this AC Element Instancematch my Participant ID?] alt[Is this AC Element Instance already out of service] [ASYNC] WARN: AC Element is already out of service Bring AC Element Instance out of Service alt[AC Element drops out of service successfully] [ASYNC] INFO: AC Element taken out of service [ASYNC] ERROR: AC Element was not taken out of service ignore this AC Element instance as its for another participant

The ACM Runtime receives and stores the responses.


ACM_Runtime ACM_Runtime Participant ParticipantACM_Database ACM_Database [ASYNC] Automation Composition Element Instance out of service Response Store Automation Composition Element Instance Response Information alt[Is AC Element Instance out of service?] Set AC Element Instance as "Not In Service" Set AC Element Instance as "In Service"

3.5 Read Automation Composition Instances

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

  • No labels