Page Comparison

...

Excerpt

The threshold objects contain a set of level objects that define limits for the KPIs. When a limit is exceeded within a defined period, a threshold object and a level object are referenced in the KPIOutput UDRs. You can define the limit values for a threshold object in ascending or descending order.

The following JSON schema describes the data format of the threshold object type:

Scroll ignore

scroll-viewport	false
scroll-pdf	false
scroll-office	false
scroll-chm	true
scroll-docbook	true
scroll-eclipsehelp	true
scroll-epub	true
scroll-html	true

falsetruefalsetruetruetruetruefalse

textEclipse

Page Properties

hidden	true

Code Block

language	text
theme	Eclipse

{ 
   "$schema": "http://json-schema.org/draft-04/schema#", 
   "title": "KpiMgmt Threshold Schema", 
   "type": "object", 
   "additionalProperties": { 
     "$ref": "#/definitions/threshold" 
   }, 
   "definitions": { 
     "threshold": { 
       "type": "object", 
       "properties": { 
         "orderDescending": { 
           "type": "boolean" 
         }, 
         "levels": { 
           "type": "object", 
           "minProperties": 1, 
           "additionalProperties": { 
             "$ref": "#/definitions/level" 
           } 
         } 
       }, 
       "additionalProperties": false, 
       "required": [ 
         "orderDescending", 
         "levels" 
       ] 
     }, 
     "level": { 
       "type": "object", 
       "properties": { 
         "alarmDescription": { 
           "type": "string" 
         }, 
         "value": { 
           "type": "integer" 
         } 
       }, 
       "additionalProperties": false, 
       "required": [ 
         "value" 
       ] 
     } 
   } 
 }

The threshold object type has the following properties:

Property	Description
orderDescending	`orderDescending` controls in which order thresholds are evaluated and if alarms should be triggered when levels are exceeded from below or from above. Set this property to `true` for descending order and `false` for ascending order.
levels	`levels` must contain a set of `level` sub-objects, which describe the alert levels that are associated with a `threshold` object.

The level object type contains the following properties:

Property	Description
alarmDescription	`alarmDescription` may contain an arbitrary string.
value	`value` must contain a numerical threshold value.

A level object must have at least one level.

Info

title	Example - JSON Representation

Code Block

language	text
theme	Eclipse

 
"threshold": { 
      "Region.AD": { 
        "orderDescending": true, 
        "levels": { 
          "1": { 
            "alarmDescription": "", 
            "value": 500 
          }, 
          "2": { 
            "alarmDescription": "", 
            "value": 400 
          }, 
          "3": { 
            "alarmDescription": "", 
            "value": 300 
          }, 
          "4": { 
            "alarmDescription": "", 
            "value": 200 
          }, 
          "5": { 
            "alarmDescription": "", 
            "value": 100 
          } 
        } 
      } 
  }

Scroll ignore

scroll-viewport	false
scroll-pdf	true
scroll-office	false
scroll-chm	true
scroll-docbook	true
scroll-eclipsehelp	true
scroll-epub	true
scroll-html	false

Versions Compared

Old Version 1

New Version Current

Key

Break