Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

PlantUML Macro
@startuml
participant REST
participant ACM_Runtime
database ACM_Database

REST -> ACM_Runtime: Commission Automation Composition Type
alt Automation Composition Type exists and has Instances
  ACM_Runtime -> REST: Automation Composition Type Definition Commissioning Failed
else
  ACM_Runtime -> ACM_Database: Create and Store Automation Composition Type
 ACM_Runtime -> REST: Automation Composition Type Commissioned
 ACM_Runtime -> ACM_Runtime: Trigger Priming of Automation Composition Type Definition
 activate ACM_Runtime
 -> REST: Type Definition Commissioneddeactivate ACM_Runtime
end

@enduml

2.2 Commissioning an Automation Composition Type

...

using SDC

PlantUML Macro
@startuml
participant SDC
participant Policy_Distribution
participant ACM_Runtime

SDC -> Policy_Distribution: [DMaaP] CSAR containing Automation Composition Type Definition
Policy_Distribution -> ACM_Runtime: Commission Automation Composition Type Definition\n(See Commissioning Sequence Diagram)
Policy_Distribution <- ACM_Runtime: Result of commissioningCommissioning
Policy_Distribution -> SDC: [DMaaP] Return result of Deployment

@enduml

2.3

...

Decommissioning an Automation Composition Type Definition

PlantUML Macro
@startuml
participant CLAMP_GUIREST
participant CLAMPACM_Runtime
participant Participant
database ACM_Database

CLAMP_GUIREST -> CLAMPACM_Runtime: [REST] ReadDecommission Automation Composition Type
alt Automation Composition Type has DefinitionsInstances
CLAMP  ACM_Runtime -> ACM_DatabaseREST: Read Automation Composition Type Decommissioning Definitions
CLAMPFailed
else
 ACM_Runtime -> CLAMP_GUIREST: [REST] Type Definitions returned
CLAMP_GUI -> CLAMP_GUI: Select Automation Composition Type Definition for Parameterization
CLAMP_GUI -> CLAMP_Runtime: [REST] Fetch GUI fields for Common Parameter Definitions

alt Automation Composition Type Definition not Commissioned on Participants
  CLAMP_Runtime -> ACM_Database: Read Automation Composition Type Definition
  CLAMP_Runtime -> CLAMP_Runtime: Generate fields for Common Parameters for GUI
  CLAMP_Runtime -> CLAMP_GUI: [REST] Return GUI fields Common Parameter Definitions
  CLAMP_GUI -> CLAMP_GUI: Render UI for Common Parameters
  CLAMP_GUI -> CLAMP_GUI: Get values for Common Parameters from user
  CLAMP_GUI -> CLAMP_Runtime: [REST] Set values for Common Parameters
  CLAMP_Runtime -> ACM_Database: Store values for Common Parameters
  CLAMPAutomation Composition Type Definition Decommissioning Ordered
 ACM_Runtime -> CLAMPACM_GUIRuntime: [REST]Trigger Common Parameter values stored
elseDepriming of Automation Composition Type Definition
 already Commissioned on Participants
  CLAMPactivate ACM_Runtime
 deactivate ACM_Runtime
 ACM_Runtime -> CLAMPACM_GUIDatabase: [REST] Cannot set Common Parameters on\nAutomation Composition Type Definition that has\nbeen commissioned on participantsDelete Automation Composition Type
end

@enduml

2.4 Priming an Automation Composition Type Definition on Participants

The Priming operation sends Automation Composition Type definitions Types 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.

PlantUML Macro
@startuml
participant CLAMP_GUI
participant CLAMP_Runtime
participant Participant
database ACM_Database

CLAMP_GUI -> CLAMP_Runtime: [REST] Read Automation Composition Type Definitions
CLAMP_Runtime -> ACM_Database: Read Automation Composition Type Definitions
CLAMP_Runtime -> CLAMP_GUI: [REST] Type Definitions returned
CLAMP_GUI -> CLAMP_GUI: Select Automation Composition Type Definition for Priming on Participants
CLAMP_GUI -> CLAMP_Runtime: [REST] Prime Automation Composition Type Definition on Participants

alt Automation Composition Type Definition not Primed on Participants
  CLAMP_Runtime -> ACM_Database: Read Automation Composition Type Definition
  CLAMP_Runtime -> ACM_Database: Read Common Parameter Values for Automation Composition Type Definition
  alt Common Parameter values set for Automation Composition Type Definition
    CLAMP_Runtime -> Participants: [DMaaP] Update Participants with Automation Composition Type Definition and values for Common Parameters
    CLAMP_Runtime -> CLAMP_GUI: [REST] Automation Composition Type Definition priming ordered on participants
  else Automation Composition Type Definition already primed on Participants
    CLAMP_Runtime -> CLAMP_GUI: [REST] Common Parameters not set\non Automation Composition Type Definition
  end
else Automation Composition Type Definition already primed on Participants
  CLAMP_Runtime -> CLAMP_GUI: [REST] Cannot set Common Parameters on\nAutomation Composition Type Definition that has\nbeen primed on participants
end

== Participant Responses ==
Participants -> CLAMP_Runtime: [DMaaP] Result of Update with Automation Composition Type Definition and values for Common Parameters
CLAMP_Runtime -> ACM_Database: Store result of Automation Composition Type Definition Update on Participant

== Supervision ==
loop forever
  CLAMP_Runtime -> ACM_Database: Read Automation Composition Type Definitions
  loop over each Automation Composition Type Definition
    alt Automation Composition Type Definition Participant priming underway
	  CLAMP_Runtime -> ACM_Database: read result of Automation Composition Type Definition Updates from participants
      alt Updates completed on all participants
	    CLAMP_Runtime -> ACM_Database: set Automation Composition Type Definition as primed on Participants
      else Updates not completed
        alt Priming of Automation Composition Type Definition on participants timed out
	      CLAMP_Runtime -> ACM_Database: set Automation Composition Type Definition priming as timed out on Participants
	      CLAMP_Runtime -> CLAMP_Runtime: Log error
        else Wait for updates to complete
        end
      end 
    else Automation Composition Type Definition Participant priming not underway
    end
  end
end
@enduml

...