deprecatedclass %iKnow.Model.metric
extends %iKnow.Model.node
The %iKnow.Metrics infrastructure is deprecated in favour of the
more SQL-oriented approach offered through %iKnow.Tables.Utils, where you
can add computed fields at different levels and choose whether they need to be persisted or not.
• property builderClass
as %String(MAXLEN=250,XMLPROJECTION="attribute");
The subclass of %iKnow.Metrics.MetricBuilder this metric will be build by.
• property description
as %String(MAXLEN=2000,XMLPROJECTION="attribute");
Description of the metric
• property disabled
as %Boolean(XMLPROJECTION="attribute");
If set to 1, this element is ignored when compiling, validating and building
• property groupField
as %String(XMLPROJECTION="attribute");
If the context type (type) is $$$IKMTRTYPEGROUP ("group"), this specifies
the metadata field on which the grouping is based.
• property maintainIndex
as %Boolean(XMLPROJECTION="attribute") [ InitialExpression = 0 ];
Defines whether indices on this metric should be built and maintained automatically when
metric values change as the result of a Build() or SetValue() invocation.
• property name
as %String(MAXLEN=250,XMLPROJECTION="attribute");
Name of the metric.
WARNING: Changing the name of a <metric> element will create a new metric
definition and not change the name of an existing one.
• property targets
as %String(MAXLEN=250,XMLPROJECTION="attribute");
Comma-separated list of the target elements this metric applies to. Any combination of
$$$IKMTRENTITY, $$$IKMTRCRC, $$$IKMTRCC, $$$IKMTRPATH, $$$IKMTRSENTENCE and $$$IKMTRSOURCE
• property type
as %String(VALUELIST=",domain,source,group",XMLPROJECTION="attribute") [ InitialExpression = "domain" ];
Context type to which the metric applies, either $$$IKMTRTYPEDOMAIN, $$$IKMTRTYPESOURCE or $$$IKMTRTYPEGROUP
