This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see the InterSystems IRIS Migration Guide and Migrating to InterSystems IRIS, both available on the WRC Distributions page (login required).

%DeepSee.Model.KPI.kpi

class %DeepSee.Model.KPI.kpi extends %DeepSee.Model.KPI.node

Meta-data object for a DeepSee KPI.

Property Inventory (Including Private)

Method Inventory (Including Private)

Properties

property actionClass as %DeepSee.Datatype.className (XMLPROJECTION = "attribute");
Optional. Name of an additional DeepSee KPI class that provides additional Dashboard Actions for this kpi.
Property methods: actionClassDisplayToLogical(), actionClassGet(), actionClassIsValid(), actionClassLogicalToDisplay(), actionClassLogicalToOdbc(), actionClassNormalize(), actionClassSet()
relationship actions as array of %DeepSee.Model.KPI.action (XMLELEMENTREF = 1, XMLPROJECTION = "ELEMENT", XMLTYPECONSTRAINT = "CHOICE") [ InitialExpression = $listbuild("%DeepSee.Model.KPI.action","kpi",+$this,"many",0,0) , Transient , Inverse = kpi , Cardinality = many ];
Actions defined for this KPI.
Property methods: actionsGet(), actionsGetObject(), actionsGetObjectId(), actionsGetSwizzled(), actionsIsEmpty(), actionsIsValid(), actionsNewObject(), actionsRClose(), actionsRExec(), actionsRFetch(), actionsRelate(), actionsSQLCompute(), actionsSet(), actionsUnRelate()
property caption as %DeepSee.Datatype.string (MAXLEN = 250, XMLPROJECTION = "attribute");
This is used as the caption text for this KPI.
Property methods: captionDisplayToLogical(), captionGet(), captionIsValid(), captionLogicalToDisplay(), captionLogicalToOdbc(), captionNormalize(), captionSet()
relationship filters as array of %DeepSee.Model.KPI.filter (XMLELEMENTREF = 1, XMLPROJECTION = "ELEMENT", XMLTYPECONSTRAINT = "CHOICE") [ InitialExpression = $listbuild("%DeepSee.Model.KPI.filter","kpi",+$this,"many",0,0) , Transient , Inverse = kpi , Cardinality = many ];
Filters defined for this KPI.
Property methods: filtersGet(), filtersGetObject(), filtersGetObjectId(), filtersGetSwizzled(), filtersIsEmpty(), filtersIsValid(), filtersNewObject(), filtersRClose(), filtersRExec(), filtersRFetch(), filtersRelate(), filtersSQLCompute(), filtersSet(), filtersUnRelate()
property mdx as %DeepSee.Datatype.string (MAXLEN = 4000, XMLPROJECTION = "attribute");
MDX statement used if sourceType is "mdx"
Property methods: mdxDisplayToLogical(), mdxGet(), mdxIsValid(), mdxLogicalToDisplay(), mdxLogicalToOdbc(), mdxNormalize(), mdxSet()
relationship properties as array of %DeepSee.Model.KPI.property (XMLELEMENTREF = 1, XMLPROJECTION = "ELEMENT", XMLTYPECONSTRAINT = "CHOICE") [ InitialExpression = $listbuild("%DeepSee.Model.KPI.property","kpi",+$this,"many",0,0) , Transient , Inverse = kpi , Cardinality = many ];
Properties defined for this KPI.
Property methods: propertiesGet(), propertiesGetObject(), propertiesGetObjectId(), propertiesGetSwizzled(), propertiesIsEmpty(), propertiesIsValid(), propertiesNewObject(), propertiesRClose(), propertiesRExec(), propertiesRFetch(), propertiesRelate(), propertiesSQLCompute(), propertiesSet(), propertiesUnRelate()
property rangeLower as %ZEN.Datatype.float;
Represents the lower value for meters connected to this KPI.
Property methods: rangeLowerDisplayToLogical(), rangeLowerGet(), rangeLowerIsValid(), rangeLowerLogicalToDisplay(), rangeLowerLogicalToOdbc(), rangeLowerNormalize(), rangeLowerSet()
property rangeUpper as %ZEN.Datatype.float;
Represents the upper value for meters connected to this KPI.
Property methods: rangeUpperDisplayToLogical(), rangeUpperGet(), rangeUpperIsValid(), rangeUpperLogicalToDisplay(), rangeUpperLogicalToOdbc(), rangeUpperNormalize(), rangeUpperSet()
property sourceType as %DeepSee.Datatype.string (VALUELIST = ",mdx,sql,manual", XMLPROJECTION = "attribute");
Specify how the data for this KPI is provided.
Property methods: sourceTypeDisplayToLogical(), sourceTypeGet(), sourceTypeIsValid(), sourceTypeLogicalToDisplay(), sourceTypeLogicalToOdbc(), sourceTypeNormalize(), sourceTypeSet()
property sql as %DeepSee.Datatype.string (MAXLEN = 4000, XMLPROJECTION = "attribute");
SQL statement used if sourceType is "sql"
Property methods: sqlDisplayToLogical(), sqlGet(), sqlIsValid(), sqlLogicalToDisplay(), sqlLogicalToOdbc(), sqlNormalize(), sqlSet()
property thresholdLower as %ZEN.Datatype.float;
Represents the lower threshold level for meters connected to this KPI.
Property methods: thresholdLowerDisplayToLogical(), thresholdLowerGet(), thresholdLowerIsValid(), thresholdLowerLogicalToDisplay(), thresholdLowerLogicalToOdbc(), thresholdLowerNormalize(), thresholdLowerSet()
property thresholdUpper as %ZEN.Datatype.float;
Represents the upper threshold level for meters connected to this KPI.
Property methods: thresholdUpperDisplayToLogical(), thresholdUpperGet(), thresholdUpperIsValid(), thresholdUpperLogicalToDisplay(), thresholdUpperLogicalToOdbc(), thresholdUpperNormalize(), thresholdUpperSet()

Methods

method %Validate() as %Status
Validate this model for logical errors.

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

Feedback