Versions Compared

Key

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

...

Object TypeDescription
dimension

The dimension objects represent values that are extracted from KDR UDRs and are used for grouping in KPI calculations. For instance, if the input data contains a field that represents a geographic region, it can be mapped to an object instance named "Region".

Info
titleExample - JSON Representation


Code Block
languagetext
themeEclipse
"dimension": {
     "Region": {
       "kdr_record_type_a": "region_name"
     }
 }


For further information about the dimension object type, see 2.3.1 dimension.

tree

The tree objects contain nodes that describe the hierarchical structure of the dimensions.

The name of a tree object constitutes the root node of a tree. The root node may have one or more child nodes, e g "Region". A child node in turn may have its own child nodes, e g "City" or "Site", and so on.

Info
titleExample - JSON Representation


Code Block
languagetext
themeEclipse
"tree": { 
	"tree1": { 
		"Region": { 
			"Site": {} 
		} 
	} 
} 


For further information about the tree object type, see 2.3.2 tree.

metric

The metric objects represent values that are extracted from KDR UDRs and aggregated according to the tree structure in the model. Expressions are applied on the various fields in the UDRs to calculate a value, e g a sum, average, or min/max value.

Info
titleExample - JSON Representation


Code Block
languagetext
themeEclipse
"metric": { 
	"AvgDuration": { 
		"fun": "avg", 
        "expr": { 
          "kdr_record_type_a": "field2-field1", 
          "kdr_record_type_b": "field3" 
        } 
	}     
}


For further information about the metric object type, see 2.3.3 metric.

threshold

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.

Info
titleExample - JSON Representation


Code Block
languagetext
themeEclipse
 "threshold": { 
	"Region.AD": { 
		"orderDescending": true, 
		"levels": { 
			"1": { 
            "alarmDescription": "", 
            "value": 200 
          }, 
          "2": { 
            "alarmDescription": "", 
            "value": 100 
          } 
        } 
	} 
} 


For further information about the threshold object type, see 2.3.4 threshold.

kpi

The kpi objects describe how metrics are linked to dimensions and threshold levels.
You may configure kpi objects to perform additional calculations based on metrics, e g ratios or sums of ratios.

Info
titleExample - JSON Representation


Code Block
languagetext
themeEclipse
"kpi": {
     "Region.AD": {
       "node": [
         "tree1",
         "Region"
       ],
       "windowSize": 60,
       "threshold": "Region.AD",
       "expr": "AvgDuration"
     }
 }


For further information about the kpi object type, see 2.3.5 kpi.



true
Page Properties
hidden
Scroll ignore
scroll-viewportfalse
scroll-pdftrue
scroll-officefalse
scroll-chmtrue
scroll-docbooktrue
scroll-eclipsehelptrue
scroll-epubtrue
scroll-htmlfalse


Next: