EnrichingKpi interface
The enriching KPI definition.
- Extends
Inherited Properties
aliases | The aliases. |
calculation |
The calculation window. |
calculation |
Name of calculation window field. |
description | Localized description for the KPI. |
display |
Localized display name for the KPI. |
entity |
The mapping entity type. |
entity |
The mapping entity name. |
expression | The computation expression for the KPI. |
extracts | The KPI extracts. |
filter | The filter expression for the KPI. |
function | The computation function for the KPI. |
group |
the group by properties for the KPI. |
group |
The KPI GroupByMetadata. NOTE: This property will not be serialized. It can only be populated by the server. |
kpi |
The KPI name. NOTE: This property will not be serialized. It can only be populated by the server. |
participant |
The participant profiles. NOTE: This property will not be serialized. It can only be populated by the server. |
provisioning |
Provisioning state. NOTE: This property will not be serialized. It can only be populated by the server. |
tenant |
The hub name. NOTE: This property will not be serialized. It can only be populated by the server. |
thres |
The KPI thresholds. |
unit | The unit of measurement for the KPI. |
Inherited Property Details
aliases
calculationWindow
The calculation window.
calculationWindow: CalculationWindowTypes
Property Value
Inherited From KpiDefinition.calculationWindow
calculationWindowFieldName
Name of calculation window field.
calculationWindowFieldName?: string
Property Value
string
Inherited From KpiDefinition.calculationWindowFieldName
description
Localized description for the KPI.
description?: {[propertyName: string]: string}
Property Value
{[propertyName: string]: string}
Inherited From KpiDefinition.description
displayName
Localized display name for the KPI.
displayName?: {[propertyName: string]: string}
Property Value
{[propertyName: string]: string}
Inherited From KpiDefinition.displayName
entityType
The mapping entity type.
entityType: EntityTypes
Property Value
Inherited From KpiDefinition.entityType
entityTypeName
The mapping entity name.
entityTypeName: string
Property Value
string
Inherited From KpiDefinition.entityTypeName
expression
The computation expression for the KPI.
expression: string
Property Value
string
Inherited From KpiDefinition.expression
extracts
filter
The filter expression for the KPI.
filter?: string
Property Value
string
Inherited From KpiDefinition.filter
function
The computation function for the KPI.
function: KpiFunctions
Property Value
Inherited From KpiDefinition.function
groupBy
the group by properties for the KPI.
groupBy?: string[]
Property Value
string[]
Inherited From KpiDefinition.groupBy
groupByMetadata
The KPI GroupByMetadata. NOTE: This property will not be serialized. It can only be populated by the server.
groupByMetadata?: KpiGroupByMetadata[]
Property Value
Inherited From KpiDefinition.groupByMetadata
kpiName
The KPI name. NOTE: This property will not be serialized. It can only be populated by the server.
kpiName?: string
Property Value
string
Inherited From KpiDefinition.kpiName
participantProfilesMetadata
The participant profiles. NOTE: This property will not be serialized. It can only be populated by the server.
participantProfilesMetadata?: KpiParticipantProfilesMetadata[]
Property Value
Inherited From KpiDefinition.participantProfilesMetadata
provisioningState
Provisioning state. NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState?: string
Property Value
string
Inherited From KpiDefinition.provisioningState
tenantId
The hub name. NOTE: This property will not be serialized. It can only be populated by the server.
tenantId?: string
Property Value
string
Inherited From KpiDefinition.tenantId
thresHolds
The KPI thresholds.
thresHolds?: KpiThresholds
Property Value
Inherited From KpiDefinition.thresHolds
unit
The unit of measurement for the KPI.
unit?: string
Property Value
string
Inherited From KpiDefinition.unit