MEF W143 version 3

Author: Dominik Ogrodnik

documentation/serviceApi/pm/MEF W143 - LSO Allegro, LSO Interlude and LSO Legato Performance Monitoring API - Developer Guide.md

@@ -3,7 +3,7 @@
 class CancelPerformanceJob {
 
 cancellationDeniedReason: string
-creationDate: date-time
+creationDate*: date-time
 href: string
 id*: string
 state*: PerformanceJobProcessStateType
@@ -17,20 +17,20 @@ class CancelPerformanceJob_Common {
 cancellationReason: string
 }
 
-CancelPerformanceJob_Common *-->"1" PerformanceJobRef : performanceJob
+CancelPerformanceJob *-->"1" PerformanceJobRef : performanceJob
 
 
 class CancelPerformanceJob_Create {
-
+performanceJobId*: string
 }
 CancelPerformanceJob_Common <|-- CancelPerformanceJob_Create
 
 enum PerformanceJobProcessStateType {
 
-accepted
 acknowledged
 completed
-declined
+inProgress
+rejected
 }
 
 @enduml

documentation/serviceApi/pm/performance/media/cancelPerformanceJobModel.png

@@ -17,13 +17,13 @@ state request_accepted <<choice>>
 
 acknowledged -d-> request_accepted
 
-request_accepted -l-> declined: No
+request_accepted -l-> rejected: No
 
-request_accepted -r-> accepted: Yes
+request_accepted -r-> inProgress: Yes
 
-accepted -d-> completed
+inProgress -d-> completed
 
-declined -d-> [*]
+rejected -d-> [*]
 completed -d-> [*]
 
 @enduml

documentation/serviceApi/pm/performance/media/cancelPerformanceJobStates.png

@@ -40,16 +40,15 @@ class PerformanceReport {
 <<... attributes are skipped ...>>
 }
 
-class ReportContent {
+class ReportContentItem {
 
 }
-
 class ResultPayload {
 @type*: string <<discriminator>>
 }
 
-PerformanceReport *-->"0..1" ReportContent : reportContent
-ReportContent *-->"*" ResultPayload : measurementDataPoints
+PerformanceReport *-->"0..*" ReportContentItem : reportContent
+ReportContentItem -->"*" ResultPayload : measurementDataPoints
 
 class urn:mef:lso:spec:legato:ip-performance-monitoring-results:v0.0.1:all <<ResultPayload>> {
 

documentation/serviceApi/pm/performance/media/extensionPattern.png

@@ -2,7 +2,7 @@
 
 class ModifyPerformanceJob {
 
-creationDate: date-time
+creationDate*: date-time
 href: string
 id*: string
 modificationDeniedReason: string
@@ -19,18 +19,19 @@ class ModifyPerformanceJob_Common {
 producingApplicationId: string
 }
 
-ModifyPerformanceJob_Common *--> FileTransferData : fileTransferData
-ModifyPerformanceJob_Common *-->"1" PerformanceJobRef : performanceJob
-ModifyPerformanceJob_Common *--> ModifyPerformanceJob_ProfileValue : performanceProfile
-ModifyPerformanceJob_Common *--> ScheduleDefinition : scheduleDefinition
-ModifyPerformanceJob_Common *-r-> ServicePayloadSpecificAttributes : servicePayloadSpecificAttributes
+ModifyPerformanceJob_Common *-->"0..1" ModifyPerformanceJob_PerformanceProfileValue : performanceProfile
+ModifyPerformanceJob_Common *-u->"0..1" ScheduleDefinition : scheduleDefinition
+ModifyPerformanceJob_Common *-u->"0..1" ServicePayloadSpecificAttributes : servicePayloadSpecificAttributes
+
+ModifyPerformanceJob *-d->"1" PerformanceJobRef : performanceJob
 
 class ModifyPerformanceJob_Create {
+performanceJobId*: string
 
 }
 ModifyPerformanceJob_Common <|-l- ModifyPerformanceJob_Create
 
-class ModifyPerformanceJob_ProfileValue {
+class ModifyPerformanceJob_PerformanceProfileValue {
 
 granularity: Interval
 jobPriority: integer

documentation/serviceApi/pm/performance/media/modifyPerformanceJobModel.png

@@ -17,13 +17,13 @@ state request_accepted <<choice>>
 
 acknowledged -d-> request_accepted
 
-request_accepted -l-> declined: No
+request_accepted -l-> rejected: No
 
-request_accepted -r-> accepted: Yes
+request_accepted -r-> inProgress: Yes
 
-accepted -d-> completed
+inProgress -d-> completed
 
-declined -d-> [*]
+rejected -d-> [*]
 completed -d-> [*]
 
 @enduml

documentation/serviceApi/pm/performance/media/modifyPerformanceJobStates.png

@@ -19,48 +19,48 @@ alt succesful inquiry
 ...
 
 note over B, SOF : PerformanceJob moves to `scheduled`
-SOF -> B: {{callbackUrl}}/listener/performanceJobStateChangeEvent {{id}}
-B --> SOF : 204 confirmation
+SOF -> B: {{callbackUrl}}/listener/performanceJobStateChangeEvent {{id}}, state=`scheduled`
+B --> SOF : 204 confirmation
 ...
 
-note over B, SOF : Schedule start time is reached\n PerformanceJob moves to `in-progress`
-SOF -> B: {{callbackUrl}}/listener/performanceJobStateChangeEvent {{id}}
+note over B, SOF : Schedule start time is reached\nPerformanceJob moves to `inProgress`
+SOF -> B: {{callbackUrl}}/listener/performanceJobStateChangeEvent {{id}}, state=`inProgress`
 B --> SOF : 204 confirmation
 ...
 
 note over B, SOF : PerformanceReport is generated
-SOF -> B: {{callbackUrl}}/listener/performanceJobReportReadyEvent {{id}}
+SOF -> B: {{callbackUrl}}/listener/performanceJobReportReadyEvent {{id}}, {{reportId}}
 B --> SOF : 204 confirmation
 ...
 
-note over B, SOF : SuspendPerformanceJob request is completed
-SOF -> B: {{callbackUrl}}/listener/performanceJobStateChangeEvent {{id}}
+note over B, SOF : PerformanceJob is suspended
+SOF -> B: {{callbackUrl}}/listener/performanceJobStateChangeEvent {{id}}, state=`suspended`
 B --> SOF : 204 confirmation
 ...
 
 note over B, SOF : ModifyPerformanceJob request is accepted
-SOF -> B: {{callbackUrl}}/listener/performanceJobStateChangeEvent {{id}}
+SOF -> B: {{callbackUrl}}/listener/performanceJobStateChangeEvent {{id}}, state=`pending`
 B --> SOF : 204 confirmation
 ...
 
 note over B, SOF : ModifyPerformanceJob request is completed
 SOF -> B: {{callbackUrl}}/listener/performanceJobAttributeValueChangeEvent {{id}}
 B --> SOF : 204 confirmation
 
-SOF -> B: {{callbackUrl}}/listener/performanceJobStateChangeEvent {{id}}
+SOF -> B: {{callbackUrl}}/listener/performanceJobStateChangeEvent {{id}}, state=`inProgress`
 B --> SOF : 204 confirmation
 
-note over B, SOF : PerformanceReport generation failed\n
-SOF -> B: {{callbackUrl}}/listener/performanceJobReportPreparationErrorEvent {{id}}
+note over B, SOF : PerformanceReport generation failed
+SOF -> B: {{callbackUrl}}/listener/performanceJobReportPreparationErrorEvent {{id}}, failureReason
 B --> SOF : 204 confirmation
 
 note over B, SOF : PerformanceJob is not recurring
-SOF -> B: {{callbackUrl}}/listener/performanceJobStateChangeEvent {{id}}
+SOF -> B: {{callbackUrl}}/listener/performanceJobStateChangeEvent {{id}}, state=`completed`
 B --> SOF : 204 confirmation
 
 
 else validation or internal problem
-SOF --> B : 4xx or 5xx errorresponse
+SOF --> B : 4xx or 5xx error response
 end
 
 ...

documentation/serviceApi/pm/performance/media/notificationsForPerformanceJob.png

@@ -4,20 +4,18 @@ class PerformanceJobComplexQuery {
 
 buyerJobId: string
 consumingApplicationId: string
-creationDate: date-time
+creationDate*: date-time
 description: string
-granularity: Interval
-jobPriority: integer
-jobType: JobType
+lastModifiedDate: date-time
 producingApplicationId: string
-reportingPeriod: Interval
-state: PerformanceJobStateType
+state*: PerformanceJobStateType
 }
 
-PerformanceJobComplexQuery *--> PerformanceJobRef : performanceJob
-PerformanceJobComplexQuery *--> PerformanceProfileRef : performanceProfile
-PerformanceJobComplexQuery *--> ScheduleDefinition : scheduleDefinition
-PerformanceJobComplexQuery *--> ServicePayloadSpecificAttributes : servicePayloadSpecificAttributes
+PerformanceJobComplexQuery *-->"1" MonitoredObjectId : monitoredObjectId
+PerformanceJobComplexQuery *-->"1" PerformanceJobRef : performanceJob
+PerformanceJobComplexQuery *-->"1" PerformanceProfileRefOrValue : performanceProfile
+PerformanceJobComplexQuery *-u->"1" ScheduleDefinition : scheduleDefinition
+PerformanceJobComplexQuery *-u->"1" ServicePayloadSpecificAttributes : servicePayloadSpecificAttributes
 
 
 class PerformanceJobComplexQuery_Create {
@@ -26,27 +24,34 @@ class PerformanceJobComplexQuery_Create {
 consumingApplicationId: string
 creationDate.gt: date-time
 creationDate.lt: date-time
+description: string
 granularity: Interval
 jobPriority: integer
 jobType: JobType
+lastModifiedDate.gt: date-time
+lastModifiedDate.lt: date-time
+outputFormat: OutputFormat
+performanceProfileId: string
 producingApplicationId: string
 reportingPeriod: Interval
+resultFormat: ResultFormat
 state: PerformanceJobStateType
 }
 
-PerformanceJobComplexQuery_Create *--> PerformanceProfileRef : performanceProfile
-PerformanceJobComplexQuery_Create *--> ScheduleDefinition : scheduleDefinition
-PerformanceJobComplexQuery_Create *--> ServicePayloadSpecificAttributes : servicePayloadSpecificAttributes
+PerformanceJobComplexQuery_Create *-->"0..1" MonitoredObjectId : monitoredObjectId
+PerformanceJobComplexQuery_Create *-->"0..1" ScheduleDefinition : scheduleDefinition
+PerformanceJobComplexQuery_Create *-->"0..1" ServicePayloadSpecificAttributes : servicePayloadSpecificAttributes
 
 enum PerformanceJobStateType {
 
 acknowledged
 cancelled
 completed
-in-progress
+inProgress
 pending
+pendingCancel
 rejected
-resource-unavailable
+resourcesUnavailable
 scheduled
 suspended
 }
@@ -56,7 +61,7 @@ enum Interval {
 10 milliseconds
 100 milliseconds
 1 second
-10 second
+10 seconds
 1 minute
 5 minutes
 15 minutes
@@ -74,4 +79,16 @@ enum JobType {
 passive
 }
 
+enum OutputFormat {
+json
+xml
+avro
+csv
+}
+
+enum ResultFormat {
+attachment
+payload
+}
+
 @enduml

documentation/serviceApi/pm/performance/media/performanceJobComplexQueryModel.png

@@ -18,12 +18,13 @@ enum PerformanceJobStateType {
 acknowledged
 cancelled
 completed
-in-progress
+inProgress
 pending
+pendingCancel
 rejected
-resource-unavailable
+resourcesUnavailable
 scheduled
-suspended
+suspended
 }
 class PerformanceJob_Common {
 
@@ -39,9 +40,9 @@ class PerformanceJob_Create {
 PerformanceJob_Common <|-- PerformanceJob_Create
 
 
-PerformanceJob_Common *-l-> FileTransferData : fileTransferData
+PerformanceJob_Common *-u->"1" MonitoredObjectId : monitoredObjectId
 PerformanceJob_Common *-->"1" PerformanceProfileRefOrValue : performanceProfile
-PerformanceJob_Common *-l-> ScheduleDefinition : scheduleDefinition
+PerformanceJob_Common *-u->"1" ScheduleDefinition : scheduleDefinition
 PerformanceJob_Common *-->"1" ServicePayloadSpecificAttributes : servicePayloadSpecificAttributes
 
 class ServicePayloadSpecificAttributes {

documentation/serviceApi/pm/performance/media/performanceJobModel.png

@@ -6,19 +6,22 @@ class PerformanceJobRefOrValue {
 
 class PerformanceJobRef {
 
-href: string
-id*: string
+performanceJobHref: string
+performanceJobId*: string
 }
 PerformanceJobRefOrValue <|-- PerformanceJobRef
 
 class PerformanceJobValue {
 
 consumingApplicationId: string
-granularity: Interval
+granularity*: Interval
 outputFormat*: OutputFormat
 producingApplicationId: string
 resultFormat*: ResultFormat
 }
 PerformanceJobRefOrValue <|-- PerformanceJobValue
 
+PerformanceJobValue *-->"1" MonitoredObjectId : monitoredObjectId
+PerformanceJobValue *-->"1" ServicePayloadSpecificAttributes : servicePayloadSpecificAttributes
+
 @enduml

documentation/serviceApi/pm/performance/media/performanceJobRefOrValue.png

@@ -24,8 +24,10 @@ state resources <<choice>>
 state recurring <<choice>>
 note left of recurring : Recurring job?
 
-state "in-progress" as in_progress
-state "resource-unavailable" as resource_unavailable
+state "inProgress" as in_progress
+state "resourcesUnavailable" as resource_unavailable
+
+state "pendingCancel" as pending_cancel
 
 ''' diagram'''
 [*] -d-> acknowledged
@@ -37,7 +39,7 @@ validation_successful -d-> rejected: No
 validation_successful -r-> immediate: Yes
 
 immediate -r-> scheduled: No
-scheduled -d-> cancelled: Cancel
+scheduled -d-> pending_cancel: Cancel
 scheduled -d-> resources: schedule start time
 resources -d-> resource_unavailable: No
 resources -l-> in_progress: Yes
@@ -47,9 +49,12 @@ in_progress -d-> recurring
 recurring -d-> completed: No
 recurring -u-> immediate: Yes
 
-in_progress -d-> cancelled: Cancel
+in_progress -d-> pending_cancel: Cancel
 in_progress -u-> suspended: Suspend
 suspended -r-> in_progress: Resume
+suspended -r-> pending_cancel: Cancel
+
+pending_cancel -> cancelled
 
 suspended -u-> modification: Modify
 modification -d-> suspended: No