ActiveUI

ActiveUI

  • User Guide
  • Developer Documentation

Home > @activeviam/activeui-sdk > DiscoveryKpi

DiscoveryKpi interface

KPI object provided by a discovery REST call This describes a KPI from an MDX point of view.

Signature:

export interface DiscoveryKpi 

Properties

PropertyTypeDescription
captionstringKPI caption
descriptionstringDescription of the KPI purpose.
folderstringFolder containing the defined KPI.
goalstringunique name of a measure representing a KPI goal (numeric measure)
measureGroupstringGroup to which the defined KPI belongs
namestringKPI name.
parentstringName of a parent KPI
statusstringunique name of a measure representing a KPI status (numeric measure)
statusPresenterstringKeyword indicating how to represent a KPI status. Mandatory if a status is defined.
trendstringunique name of a measure representing a KPI trend (numeric measure)
trendPresenterstringKeyword indicating haw to represent a KPI trend. Mandatory if a trend is defined
valuestringunique name of a measure representing a KPI value (numeric measure)
weightnumberweight given to the defined KPI. This matters when the KPI has a parent.
  • DiscoveryKpi interface
  • Properties
Copyright © 2019 ActiveViam