The CLAMP Control Loop 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.
| Table of Contents |
|---|
1 Commissioning Dialogues
Commissioning dialogues are used to commission and decommission Control Loop Automation Composition Type definitions and to set the values of Common Parameters.
Commissioning an Automation Composition Type is a three-step process
- The Automation Composition Type must be created, that is the Automation Composition Type definition must be loaded and stored in the database. This step may be carried out over the REST interface or using SDC distribution.
- The Common Properties of the Automation Composition type must be assigned values and those values must be stored in the database. This step is optional only if all mandatory common properties have default values. The Common Property values may be set and amended over and over again in multiple sessions until the Automation Composition Type is primed.
- The Automation Composition Type Definition and the Common Property values must be primed, which is sent to the concerned participants. Once an Automation Composition Type is primed, its Common Property values can no longer be changed. To change Common Properties on a primed Automation Composition Type, all instances of the Automation Composition Type must be removed and the Automation Composition Type must be de-primed.
1.1 Commissioning
...
an Automation Composition Type Definition using the CLAMP GUI
This dialogue corresponds to a "File→Import" menu on the CLAMP GUI. The documentation of future releases of the system will describe how the Design Time functionality interacts with the Runtime commissioning API.
1.2 Commissioning
...
an Automation Composition Type Definition using SDC
1.3 Setting Common
...
1.4 Commissioning a Control Loop Type Definition on Participants
...
Properties for an Automation Composition Type Definition
This dialogue sets the values of common properties. The values of the common properties may be set, updated, or deleted at will, as this dialogue saves the properties to the database but does not send the definitions or properties to the participants. However, once an Automation Composition Type Definition and its properties are primed (See Section 1.4), the properties cannot be changed until the Automation Composition type definition is de-primed (See Section 1.5).
1.4 Priming an Automation Composition Type Definition on Participants
The Priming operation sends Automation Composition Type definitions and common property values to participants. Once an Automation Composition Type definition is primed, its property values can on longer be changed until it is de-primed.
1.5 De-Prime an Automation Composition Type Definition on Participants
This dialogue allows a Control Loop an Automation Composition Type Definition to be decomissioned de-primed so that it can be deleted or its common parameter values can be altered.
1.6 Decommissioning
...
an Automation Composition Type Definition in CLAMP
1.7 Reading Commissioned
...
Automation Composition Type Definitions
2. Instantiation Dialogues
Instantiation dialogues are used to create, set parameters on, instantiate, update, and remove Control Loop instances.Automation Composition instances.
Assume a suitable Automation Composition Definition exists in the Commissioned Automation Composition Inventory. To get an Automation Composition instance running one would, for example, execute dialogues 2.1, 2.3, and 2.4.
2.1 Creating
...
an Automation Composition Instance
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.
2.2 Updating Instance Specific Parameters on
...
an Automation Composition Instance
2.3 Updating
...
an Automation Composition Instance with a Configuration on Participants
2.
...
4 Changing the state of
...
an Automation Composition Instance on Participants
2.
...
5 De-instantiating
...
an Automation Composition Instance from Participants
2.
...
6 Deleting an Automation Composition Instance
2.
...
7 Reading
...
Automation Composition Instances
3. Monitoring Dialogues
Monitoring dialogues are used to monitor and to read statistics on Control Loop Automation Composition Instances.
3.1 Reporting of Monitoring Information and Statistics by Participants
...
Supervision dialogues are used to check the state of Control Loop Automation Composition Instances and Participants.