MEF W146 CfC#1 v0.1

Author: btrinajs

documentation/serviceApi/alarm/MEF W146 - LSO Allegro, LSO Interlude and LSO Legato Threshold Crossing Alerts (Alarms) API and Developer Guide - Developer Guide.md

@@ -0,0 +1,241 @@
+@startuml alarmDataModel
+skinparam {
+ClassBackgroundColor White
+ClassBorderColor Black
+}
+
+class Alarm {
+
+alarmRaisedTime: date-time
+externalAlarmId: string
+isRootCause: boolean
+probableCause: ProbableCause
+sourceSystemId: string
+specificProblem: string
+}
+Alarm_Common <|-- Alarm
+
+Alarm *-->"*" AlarmedObjectRef : alarmedObject
+Alarm *-->"*" Comment : comment
+Alarm *--> AlarmRef : parentAlarm
+Alarm *--> AlarmSpecificAttributes : alarmSpecificAttributes
+
+
+class AlarmRef {
+
+id*: string
+href: string
+}
+
+
+
+class AlarmSpecificAttributes {
+
+@type*: string
+}
+
+
+
+class AlarmSubscription {
+
+id: string
+}
+AlarmSubscriptionInput <|-- AlarmSubscription
+
+
+
+class AlarmSubscriptionInput {
+
+callback*: string
+query: string
+}
+
+
+
+enum AlarmType {
+
+communicationsAlarm
+processingErrorAlarm
+environmentalAlarm
+qualityOfServiceAlarm
+equipmentAlarm
+integrityViolation
+operationalViolation
+physicalViolation
+securityService
+mechanismViolation
+timeDomainViolation
+}
+class Alarm_Common {
+
+id*: string
+href: uri
+alarmChangedTime: date-time
+alarmClearedTime: date-time
+alarmDetails*: string
+alarmedObjectType: string
+alarmReportingTime*: date-time
+alarmType*: AlarmType
+perceivedSeverity*: PerceivedSeverity
+plannedOutageIndicator: PlannedOutageIndicator
+reportingSystemId: string
+serviceAffecting: boolean
+state*: State
+}
+
+Alarm_Common *-->"*" ServiceRef : affectedService
+Alarm_Common *-->"*" AlarmRef : correlatedAlarm
+
+
+class Alarm_Find {
+
+}
+Alarm_Common <|-- Alarm_Find
+
+
+
+class AlarmedObjectRef {
+
+id*: string
+href: string
+@referredType: string
+}
+
+
+
+class Comment {
+
+description: string
+systemIdentifier: string
+time: date-time
+userIdentifier: string
+}
+
+
+
+
+enum PerceivedSeverity {
+
+cleared
+critical
+indeterminate
+major
+minor
+warning
+}
+enum PlannedOutageIndicator {
+
+inPlannedMaintenance
+outOfService
+}
+enum ProbableCause {
+
+adapterError
+applicationSubsystemFailure
+bandwidthReduced
+callEstablishmentError
+communicationsProtocolError
+communicationsSubsystemFailure
+configurationOrCustomizationError
+congestion
+corruptData
+cpuCyclesLimitExceeded
+datasetOrModemError
+degradedSignal
+dteDceInterfaceError
+enclosureDoorOpen
+equipmentMalfunction
+excessiveVibration
+fileError
+fireDetected
+floodDetected
+framingError
+heatingVentilationCoolingSystemProblem
+humidityUnacceptable
+ioDeviceError
+inputDeviceError
+lanError
+Detected
+localNodeTransmissionError
+lossOfFrame
+lossOfSignal
+materialSupplyExhausted
+multiplexerProblem
+outOfMemory
+outputDeviceError
+performanceDegraded
+powerProblem
+pressureUnacceptable
+processorProblem
+pumpFailure
+queueSizeExceeded
+receiveFailure
+receiverFailure
+remoteNodeTransmissionError
+resourceNearingCapacity
+responseTimeExcessive
+retransmissionRateExcessive
+softwareError
+softwareProgramTerminated
+softwareProgramError
+storageCapacityProblem
+temperatureUnacceptable
+thresholdCrossed
+timingProblem
+toxicDetected
+transmitFailure
+transmitterFailure
+underlyingResourceUnavailable
+versionMismatch
+}
+class ServiceRef {
+
+id*: string
+href: string
+}
+
+
+
+enum State {
+
+acknowledged
+cleared
+un-acknowledged
+}
+class TcaStatefulClearAlarm {
+
+performanceMetricName: string
+performanceMetricValue: number
+tcaPerformanceThresholdValue: number
+tcaWindowThresholdValue: number
+tcaWindowSize: number
+}
+AlarmSpecificAttributes <|-- TcaStatefulClearAlarm
+
+
+
+class TcaStatefulSetAlarm {
+
+performanceMetricName: string
+performanceMetricValue: number
+tcaPerformanceThresholdValue: number
+tcaWindowThresholdValue: number
+tcaWindowSize: number
+}
+AlarmSpecificAttributes <|-- TcaStatefulSetAlarm
+
+
+
+class TcaStatelessAlarm {
+
+performanceMetricName: string
+performanceMetricValue: number
+tcaPerformanceThresholdValue: number
+dampingFactor: number
+numberOfPmMetricCalculationIntervals: number
+}
+AlarmSpecificAttributes <|-- TcaStatelessAlarm
+
+
+
+@enduml

documentation/serviceApi/alarm/media/alarmDataModel.png

@@ -0,0 +1,18 @@
+@startuml alarmNotificationModel
+
+class AlarmSubscription {
+
+id: string
+}
+AlarmSubscriptionInput <|-- AlarmSubscription
+
+
+
+class AlarmSubscriptionInput {
+
+callback*: string
+query: string
+}
+
+
+@enduml

documentation/serviceApi/alarm/media/alarmNotificationModel.png

@@ -0,0 +1,22 @@
+@startuml alarmProvisioning
+autonumber
+
+participant Buyer as B
+participant Seller as S
+collections "SOF:Alarm" as SOF
+
+opt
+B -> S: POST {{baseUrl}}/hub with {{callbackUrl, eventType}}
+S --> B: 201 confirmation with{{id}}
+end
+
+SOF -> S: <<createAlarm>>
+
+opt
+S -> B: POST {{callbackUrl}}/listener/createAlarm{{Alarm}}
+end
+
+B -> S: GET {{baseUrl}}/alarm{{id}}
+S --> B: 200 OK with {{Alarm}}
+
+@enduml

documentation/serviceApi/alarm/media/alarmProvisioning.png

@@ -0,0 +1,55 @@
+<mxfile host="Electron" modified="2024-12-06T12:18:22.991Z" agent="Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/22.1.21 Chrome/120.0.6099.109 Electron/28.1.0 Safari/537.36" etag="Ch0a8jQoqBZc0mkET7Zp" version="22.1.21" type="device">
+<diagram id="xbJyrwv9yIP62h8_PHgp" name="Page-1">
+<mxGraphModel dx="1434" dy="844" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="1169" pageHeight="827" math="0" shadow="0">
+<root>
+<mxCell id="0" />
+<mxCell id="1" parent="0" />
+<mxCell id="ltWMZJDPjPNoV4Ph2O7P-1" value="&lt;b&gt;Alarm Envelope&lt;/b&gt;" style="rounded=0;whiteSpace=wrap;html=1;verticalAlign=top;" parent="1" vertex="1">
+<mxGeometry x="70" y="20" width="530" height="240" as="geometry" />
+</mxCell>
+<mxCell id="ltWMZJDPjPNoV4Ph2O7P-2" value="Alarm" style="rounded=1;whiteSpace=wrap;html=1;" parent="1" vertex="1">
+<mxGeometry x="250.25" y="70" width="165" height="60" as="geometry" />
+</mxCell>
+<mxCell id="ltWMZJDPjPNoV4Ph2O7P-4" value="AlarmSpecificAttributes" style="rounded=1;html=1;whiteSpace=wrap;fillColor=#f5f5f5;strokeColor=#666666;fontColor=#333333;" parent="1" vertex="1">
+<mxGeometry x="250.25" y="170" width="165" height="60" as="geometry" />
+</mxCell>
+<mxCell id="ltWMZJDPjPNoV4Ph2O7P-5" value="" style="endArrow=classic;html=1;startArrow=diamond;startFill=1;exitX=0.5;exitY=1;exitDx=0;exitDy=0;entryX=0.5;entryY=0;entryDx=0;entryDy=0;" parent="1" source="ltWMZJDPjPNoV4Ph2O7P-2" target="ltWMZJDPjPNoV4Ph2O7P-4" edge="1">
+<mxGeometry width="50" height="50" relative="1" as="geometry">
+<mxPoint x="230" y="310" as="sourcePoint" />
+<mxPoint x="280" y="260" as="targetPoint" />
+</mxGeometry>
+</mxCell>
+<mxCell id="ltWMZJDPjPNoV4Ph2O7P-9" value="&lt;b&gt;Alarm Payload&lt;/b&gt;" style="rounded=0;whiteSpace=wrap;html=1;verticalAlign=top;" parent="1" vertex="1">
+<mxGeometry x="70" y="270" width="530" height="140" as="geometry" />
+</mxCell>
+<mxCell id="ltWMZJDPjPNoV4Ph2O7P-13" value="TCA Stateles" style="rounded=1;whiteSpace=wrap;html=1;dashed=1;strokeColor=#007FFF;fontSize=11;" parent="1" vertex="1">
+<mxGeometry x="90" y="330" width="145.5" height="40" as="geometry" />
+</mxCell>
+<mxCell id="ltWMZJDPjPNoV4Ph2O7P-25" value="" style="endArrow=block;html=1;fontSize=11;endFill=0;exitX=0.5;exitY=0;exitDx=0;exitDy=0;entryX=0.5;entryY=1;entryDx=0;entryDy=0;endSize=8;" parent="1" source="ltWMZJDPjPNoV4Ph2O7P-13" target="ltWMZJDPjPNoV4Ph2O7P-4" edge="1">
+<mxGeometry width="50" height="50" relative="1" as="geometry">
+<mxPoint x="70" y="530" as="sourcePoint" />
+<mxPoint x="120" y="480" as="targetPoint" />
+</mxGeometry>
+</mxCell>
+<mxCell id="pdeO6exJO5Pcnp_OLP6e-1" value="TCA Stateful Clear" style="rounded=1;whiteSpace=wrap;html=1;dashed=1;strokeColor=#007FFF;fontSize=11;" vertex="1" parent="1">
+<mxGeometry x="430" y="330" width="145.5" height="40" as="geometry" />
+</mxCell>
+<mxCell id="pdeO6exJO5Pcnp_OLP6e-2" value="TCA Stateful Set" style="rounded=1;whiteSpace=wrap;html=1;dashed=1;strokeColor=#007FFF;fontSize=11;" vertex="1" parent="1">
+<mxGeometry x="260" y="330" width="145.5" height="40" as="geometry" />
+</mxCell>
+<mxCell id="pdeO6exJO5Pcnp_OLP6e-3" value="" style="endArrow=block;html=1;fontSize=11;endFill=0;endSize=8;" edge="1" parent="1" source="pdeO6exJO5Pcnp_OLP6e-2">
+<mxGeometry width="50" height="50" relative="1" as="geometry">
+<mxPoint x="173" y="340" as="sourcePoint" />
+<mxPoint x="333" y="230" as="targetPoint" />
+</mxGeometry>
+</mxCell>
+<mxCell id="pdeO6exJO5Pcnp_OLP6e-4" value="" style="endArrow=block;html=1;fontSize=11;endFill=0;exitX=0.5;exitY=0;exitDx=0;exitDy=0;endSize=8;" edge="1" parent="1" source="pdeO6exJO5Pcnp_OLP6e-1">
+<mxGeometry width="50" height="50" relative="1" as="geometry">
+<mxPoint x="183" y="350" as="sourcePoint" />
+<mxPoint x="330" y="230" as="targetPoint" />
+</mxGeometry>
+</mxCell>
+</root>
+</mxGraphModel>
+</diagram>
+</mxfile>

documentation/serviceApi/alarm/media/alarmSpecSchema.png

@@ -0,0 +1,25 @@
+@startuml alarmUsecases
+
+left to right direction
+
+actor "Buyer/Client" as B
+actor "Seller/Server" as S
+
+rectangle {
+Usecase UC1 as "1. Retrieve Alarm List"
+Usecase UC2 as "2. Retrieve Alarm by Alarm Identifier"
+Usecase UC3 as "3. Subscribe for Alarm Notifications"
+Usecase UC4 as "4. Create Alarm"
+Usecase UC5 as "4a. Stateful TCA Alarm"
+Usecase UC6 as "4b. Stateless TCA Alarm"
+Usecase UC7 as "5. Unsubscribe for Alarm Notification"
+}
+
+UC4 <-- S
+UC5 <-- S
+UC6 <-- S
+B --> UC2
+B --> UC3
+B --> UC1
+B --> UC7
+@enduml