Versions Compared

Key

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

...

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

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







Page Properties
hiddentrue


Code Block
{
  "$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
titleNote!

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.

Info
titleExample - 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.

...

Page Properties
hiddentrue

This section includes the following subsections:

2.3.1 dimension

2.3.2 tree

2.3.3 metric

2.3.4 threshold

2.3.5 kpi