2.3 Object Types

This section describes the JSON representation of the various objects types that are used in the service model storage.

In order to run KPI Management, you must first provision a service model that includes all the required objects that are listed in the schema below.

The following JSON schema describes the data format of a complete service model:

Click here to expand...

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "/",
  "type": "object",
  "properties": {
    "aggregated-output": { "type": "boolean" },
    "dimension": { "$ref": "model_dimension_schema.json" },
    "tree": { "$ref": "model_tree_schema.json" },
    "metric": { "$ref": "model_metric_schema.json" },
    "threshold": { "$ref": "model_threshold_schema.json" },
    "kpi": { "$ref": "model_kpi_schema.json" }
  },

  "additionalProperties": false,
  "required": [
    "dimension",
    "tree",
    "metric",
    "kpi",
  ]
}

Note!

The aggregated-output object type is optional and contains a boolean value that determines if the KPI output for each dimension will be grouped in the same KPIAggregatedOutput UDR. When the value of this object is set to true, multiple KPIOutput UDRs are grouped by dimension in the same KPIAggregatedOutput UDR. When the value is false (default), each KPIAggregatedOutput will contain one KPIOutput UDR.

Example - Aggregated output

"aggregated-output": true,

...

When the value of aggregated-output is true, all kpi objects in the model must have the same window size.

Other object types in the JSON schema are described in the following subsections.

Note!

When a service model contains objects of the same type and with identical names, only one of them will be used. Duplicate object definitions are not detected automatically when you validate the KPI profile or use the mzsh command kpimodel validate.