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

Compare with Current View Page History

« Previous Version 20 Next »

The CLAMP Control Loop Lifecycle Management uses the following system level dialogues.

1 Commissioning Dialogues

Commissioning dialogues are used to commission and decommission Control Loop Type definitions and to set the values of Common Parameters.

1.1 Commissioning a Control Loop Type Definition using the CLAMP GUI

CLAMP_GUI CLAMP_GUI CLAMP_Runtime CLAMP_RuntimeDatabase Database [REST] Commission Control Loop Type Definition Store Control Loop Type Definition [REST] Type Definition Commissioned

1.2 Commissioning a Control Loop Type Definition using SDC

SDC SDC Policy_Distribution Policy_Distribution CLAMP_Runtime CLAMP_RuntimeDatabase Database [DMaaP] CSAR containing Control Loop Type Definition [REST] Commission Control Loop Type Definition Store Control Loop Type Definition [REST] Type Definition Commissioned [DMaaP] Deployment Completed

1.3 Setting Common Parameters for a Control Loop Type Definition

CLAMP_GUI CLAMP_GUI CLAMP_Runtime CLAMP_Runtime Participant ParticipantDatabase Database [REST] Read Control Loop Type Definitions Read Control Loop Type Definitions [REST] Type Definitions returned Select Control Loop Type Definition for Parameterization [REST] Fetch GUI fields for Common Parameter Definitions alt[Control Loop Type Definition not Commissioned on Participants] Read Control Loop Type Definition Generate fields for Common Parameters for GUI [REST] Return GUI fields Common Parameter Definitions Render UI for Common Parameters Get values for Common Parameters from user [REST] Set values for Common Parameters Store values for Common Parameters [REST] Common Parameter values stored [Control Loop Type Definition already Commissioned on Participants] [REST] Cannot set Common Parameters onControl Loop Type Definition that hasbeen commissioned on participants

1.4 Commissioning a Control Loop Type Definition on Participants

CLAMP_GUI CLAMP_GUI CLAMP_Runtime CLAMP_Runtime Participant ParticipantDatabase Database Participants Participants [REST] Read Control Loop Type Definitions Read Control Loop Type Definitions [REST] Type Definitions returned Select Control Loop Type Definition for Commissioning on Participants [REST] Commission Control Loop Type Definition on Participants alt[Control Loop Type Definition not Commissioned on Participants] Read Control Loop Type Definition Read Common Parameter Values for Control Loop Type Definition alt[Common Parameter values set for Control Loop Type Definition] [DMaaP] Update Participants with Control Loop Type Definition and values for Common Parameters [REST] Control Loop Type Definition commissioning ordered on participants [Control Loop Type Definition already Commissioned on Participants] [REST] Common Parameters not seton Control Loop Type Definition [Control Loop Type Definition already Commissioned on Participants] [REST] Cannot set Common Parameters onControl Loop Type Definition that hasbeen commissioned on participants Participant Responses [DMaaP] Result of Update with Control Loop Type Definition and values for Common Parameters Store result of Control Loop Type Definition Update on Participant Supervision loop[forever] Read Control Loop Type Definitions loop[over each Control Loop Type Definition] alt[Control Loop Type Definition Participant Commission underway] read result of Control Loop Type Definition Updates from participants alt[Updates completed on all participants] set Control Loop Type Definition as Commissioned on Participants [Updates not completed] alt[Commissioning of Control Loop Type Definition on participants timed out] set Control Loop Type Definition commissioning as timed out on Participants Log error [Wait for updates to complete] [Control Loop Type Definition Participant Commission not underway]

1.5 Decommissioning a Control Loop Type Definition on Participants

This dialogue allows a Control Loop Type Definition to be decomissioned so that it can be deleted or its common parameter values can be altered.


CLAMP_GUI CLAMP_GUI CLAMP_Runtime CLAMP_Runtime Participant ParticipantDatabase Database Participants Participants [REST] Read Control Loop Type Definitions Read Control Loop Type Definitions [REST] Type Definitions returned Select Control Loop Type Definition for Decommissioning on Participants [REST] Decommission Control Loop Type Definition on Participants alt[Control Loop Type Definition Commissioned on Participants] alt[Control Loop Instances do not exist for Control Loop Type Definition] [DMaaP] Update Participants, removing Control Loop Type Definition and values for Common Parameters [REST] Control Loop Type Definition decommissioning ordered on participants [Control Loop Instances exist for Control Loop Type Definition] [REST] Control Loop Type Definition cannot bedecommissioned on participantsit is in use on control loops [Control Loop Type Definition not Commissioned on Participants] [REST] Control Loop Type Definition has notbeen commissioned on participants Participant Responses [DMaaP] Result of Update to remove Control Loop Type Definition and values for Common Parameters Store result of Control Loop Type Definition Update on Participant Supervision loop[forever] Read Control Loop Type Definitions loop[over each Control Loop Type Definition] alt[Control Loop Type Definition Participant decommission underway] read result of Control Loop Type Definition Updates from participants alt[Updates completed on all participants] set Control Loop Type Definition as decommissioned on Participants [Updates not completed] alt[Commissioning of Control Loop Type Definition on participants timed out] set Control Loop Type Definition decommissioning as timed out on Participants Log error [Wait for updates to complete] [Control Loop Type Definition Participant decommission not underway]

1.6 Decommissioning a Control Loop Type Definition in CLAMP

CLAMP_GUI CLAMP_GUI CLAMP_Runtime CLAMP_RuntimeDatabase Database [REST] Read Control Loop Type Definitions Read Control Loop Type Definitions [REST] Type Definitions returned Select Control Loop Type Definition for Decommissioning [REST] Decommission Control Loop Type Definition alt[Control Loop Type Definition not Commissioned on Participants] Delete Control Loop Type Definition [REST] Type Definition Decommissioned [Control Loop Type Definition not Commissioned on Participants] [REST] Control Loop Type Definition cannot be decommissionedit is commissioned on participants

1.7 Reading Commissioned Control Loop Type Definitions

CLAMP_GUI CLAMP_GUI CLAMP_Runtime CLAMP_RuntimeDatabase Database [REST] Read Control Loop Type Definitions Read Control Loop Type Definitions [REST] Type Definitions returned

2. Instantiation Dialogues

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

2.1 Creating a Control Loop Instance

CLAMP_GUI CLAMP_GUI CLAMP_Runtime CLAMP_RuntimeDatabase Database [REST] Read Control Loop Type Definitions Read Control Loop Type Definitions [REST] Type Definitions returned Select Control Loop Type Definition to use to create Control Loop Instance [REST] Fetch GUI fields for Instance Specific Parameter Definitions Read Control Loop Type Definition Generate fields for Instance Specific Parameters for GUI [REST] Return GUI fields Instance Specific Parameter Definitions Render UI for Instance Specific Parameters Get values for Instance Specific Parameters from user [REST] Request Creation of Control Loop Instance Create Control Loop Instance Store First Version of Control Loop Instance [REST] Control Loop Instance Updated

2.2 Updating Instance Specific Parameters on a Control Loop Instance

CLAMP_GUI CLAMP_GUI CLAMP_Runtime CLAMP_RuntimeDatabase Database [REST] Read Control Loop Instances Read Control Loop Instances [REST] Control Loop Instances returned Select Control Loop Instance on which to Update Parameters Step version of Control Loop Instance as Major/Minor/Patch [REST] Fetch GUI fields for Instance Specific Parameter Definitions Read Control Loop Type Definition Generate fields for Instance Specific Parameters for GUI [REST] Return GUI fields Instance Specific Parameter Definitions Render UI for Instance Specific Parameters Get values for Instance Specific Parameters from user [REST] Request Update of Control Loop Instance Update Control Loop Instance Store New Version of Control Loop Instance [REST] Control Loop Instance Updated

2.3 Updating a Control Loop Instance Version on Participants

CLAMP_GUI CLAMP_GUI CLAMP_Runtime CLAMP_Runtime Participant ParticipantDatabase Database Participants Participants [REST] Read all versions of Control Loop Instance Read all versions of Control Loop Instance [REST] All versions of Control Loop Instance returned Select version of Control Loop Instance for Instantiation Participants [REST] Instantiate selected version of Control Loop Instance on Participants alt[Selected version of Control Loop Instance not instantiated on Participants] Read version of Control Loop Instance [DMaaP] Update Participants with version of Control Loop Instance [REST] Instantiation of Version of Control Loop Instance ordered on participants [Selected version of Control Loop Instance instantiated on Participants] [REST] Version of Control Loop Instance already instantiated on participants Participant Responses [DMaaP] Result of update of version of Control Loop Instance on participant Store result of update of version of Control Loop Instance on participant Supervision loop[forever] Read Control Loop Instances loop[over each Control Loop Instance] alt[Control Loop Instance Instantiation update underway on participants] read result of Control Loop updates from participants alt[Updates completed on all participants] set version of Control Loop Instance as Instantiated on Participants set overall version of Control Loop Instance state as Instantiated [Updates not completed] alt[Instantiation of Control Loop Instance on participants timed out] set version Control Loop Instance Instantiation as timed out on Participants Log error [Wait for updates to complete] [Control Loop Instance Instantiation update on participants not underway]

2.5 Changing the state of a Control Loop Instance on Participants

CLAMP_GUI CLAMP_GUI CLAMP_Runtime CLAMP_Runtime Participant ParticipantDatabase Database Participants Participants [REST] Read all Instantiated Control Loop Instances Read all Instantiated Control Loop Instances [REST] All Instantiated Control Loop Instances returned Select Control Loop Instance on which to change state and specify new state [REST] Change state of selected Control Loop Instance on Participants alt[Selected Control Loop Instance instantiated on Participants] [DMaaP] Request change of state of Control Loop Instance [REST] Change of state of Control Loop Instance ordered on participants [Selected Control Loop Instance not instantiated on Participants] [REST] Control Loop Instance not instantiated on participants Participant Responses [DMaaP] Result of State Change of Control Loop Instance on participant Store result of State Change of Control Loop Instance on participant Supervision loop[forever] Read Control Loop Instances loop[over each Control Loop Instance] alt[Control Loop Instance State Change underway on participants] read result of Control Loop State Change from participants alt[Updates completed on all participants] set Control Loop Instance state as changed on Participants set overall Control Loop Instance state as changed [Updates not completed] alt[Control Loop Instance State Change on participants timed out] set Control Loop State Change as timed out on Participants Log error [Wait for updates to complete] [Control Loop Instance State Change on participants not underway]

2.6 De-instantiating a Control Loop Instance from Participants

CLAMP_GUI CLAMP_GUI CLAMP_Runtime CLAMP_Runtime Participant ParticipantDatabase Database Participants Participants [REST] Read all Instantiated Control Loop Instances Read all Instantiated Control Loop Instances [REST] All Instantiated Control Loop Instances returned Select Control Loop Instance to de-instantiate [REST] De-instantiate selected Control Loop Instance on Participants alt[Selected Control Loop Instance instantiated on Participants] [DMaaP] Update Participants to remove Control Loop Instance [REST] De-instantiation of Control Loop Instance ordered on participants [Selected Control Loop Instance not instantiated on Participants] [REST] Control Loop Instance not instantiated on participants Participant Responses [DMaaP] Result of update of Control Loop Instance on participant Store result of update of Control Loop Instance on participant Supervision Read Control Loop Instances loop[over each Control Loop Instance] alt[Control Loop Instance de-instantiation update underway on participants] read result of Control Loop updates from participants alt[Updates completed on all participants] set Control Loop Instance as de-instantiated on Participants set overall Control Loop Instance as de-instantiated [Updates not completed] alt[Control Loop Instance de-instantiation Update timed out on participants] set Control Loop Instance de-instantiation as timed out on Participants Log error [Wait for updates to complete] [Control Loop Instance de-instantiation update on participants not underway]

2.7 Deleting a Control Loop Instance

CLAMP_GUI CLAMP_GUI CLAMP_Runtime CLAMP_RuntimeDatabase Database [REST] Read all Control Loop Instances Read all Control Loop Instances [REST] All Control Loop Instances returned Select Control Loop Instance to delete [REST] Delete selected Control Loop Instance alt[Selected Control Loop Instance exists] Delete control loop instance [REST] Control Loop Instance deleted [Selected Control Loop Instance does not exist] [REST] Control Loop Instance does not exist

2.8 Reading Control Loop Instances

CLAMP_GUI CLAMP_GUI CLAMP_Runtime CLAMP_RuntimeDatabase Database [REST] Read all Control Loop Instances Read all Control Loop Instances [REST] All Control Loop Instances returned

3. Monitoring Dialogues

Monitoring dialogues are used to monitor and to read statistics on Control Loop Instances.

3.1 Reporting of Monitoring Information and Statistics by Participants

CLAMP_Runtime CLAMP_Runtime Participant ParticipantDatabase Database [DMaaP] Participant and Control Loop Element Monitoring and Statistics report Store Participant and Control Loop Element Monitoring and Statistics report alt[Fault reported on Participant] log fault on Participant Record fault on Participant loop[Over all Control Loop Elements in Participant Report] alt[Fault reported on Control Loop Element] log fault on Control Loop Element and Control Loop Record fault on Control Loop Element and Control Loop

3.2 Viewing of Monitoring Information

CLAMP_GUI CLAMP_GUI CLAMP_Runtime CLAMP_RuntimeDatabase Database Overview of all Control Loop Instances [REST] Read all Control Loop Instances Read all Control Loop Instances [REST] All Control Loop Instances returned Display overview of status of all Control Loop Instances Details of a Control Loop Instance [REST] Read Control Loop Elements for Control Loop Instance Read Control Loop Elements for Control Loop Instance [REST] Control Loop Elements returned Display status of Control Loop Elements in Control Loop Instance Overview of all Participants [REST] Read all participants Read all participants [REST] All participants returned Display overview of status of all participants Details of a Participant [REST] Read Control Loop Elements for Participant Read Control Loop Elements for Participant [REST] Control Loop Elements returned Display status of Control Loop Elements in Participant Filtered Monitoring Set filter for Control Loop Instances, Control Loop Elements, and Participants [REST] Read Control Loop Elements that match filter Read Control Loop Elements that match filter [REST] Control Loop Elements that match filter returned Display status of Control Loop Elements that match filter

3.2 Viewing of Statistics

CLAMP_GUI CLAMP_GUI CLAMP_Runtime CLAMP_RuntimeDatabase Database Statistics of all Control Loop Instances [REST] Read summary statistics for all Control Loop Instances Compile summary statistics for all Control Loop Instances [REST] Summary statistics for all Control Loop Instances returned Display summary statistics for all Control Loop Instances Statistics of a Control Loop Instance [REST] Read statistics for Control Loop Elements for Control Loop Instance Compile statistics for Control Loop Elements for Control Loop Instance [REST] Statistics for Control Loop Elements returned Display statistics for Control Loop Elements in Control Loop Instance Statistics of all Participants [REST] Read summary statistics for all Control Loop Instances Compile summary statistics for all Control Loop Instances [REST] Summary statistics for all Control Loop Instances returned Display summary statistics for all Control Loop Instances Statistics of a Participant [REST] Read statistics for Control Loop Elements for Participant Read statistics for Control Loop Elements for Participant [REST] Statistics for Control Loop Elements returned Display statistics for Control Loop Elements in Participant Filtered Statistics Set filter for Control Loop Instances, Control Loop Elements, and Participants [REST] Read statistics for Control Loop Elements that match filter Read statistics for Control Loop Elements that match filter [REST] Statistics for Control Loop Elements that match filter returned Display statistics for Control Loop Elements that match filter

3.3 Statistics Housekeeping

CLAMP_Runtime CLAMP_RuntimeDatabase Database Control Loop Instance Statistics loop[forever] Read Control Loop Instance Statistics Summarise Control Loop Instance Statistics Store summarised Control Loop Instance Statistics Delete Control Loop Instance Statistics on which retention period has expired Participant Statistics loop[forever] Read Participant Statistics Summarise Participant Statistics Store summarised Participant Statistics Delete Participant Statistics on which retention period has expired

4. Supervision Dialogues

Supervision dialogues are used to check the state of Control Loop Instances and Participants.

4.1 Supervise Participants

CLAMP_Runtime CLAMP_RuntimeDatabase Database loop[forever] Read Participant Statistics loop[Over each Participant] alt[Participant has not reported in last reporting window] Log Participant as having missed a report Increment missed report counter on Participant alt[Participant has exceeded alarm threshold on missed report counter] Raise a Participant Offline alarm on participant Mark participant as being offline [Participant has reported in last reporting window] Clear missed report counter on Participant alt[Participant marked as being offline] Clear Participant Offline alarm on participant Mark participant as being online

  • No labels