Home > Class Reference > ENSLIB namespace > %ZEN.Report.aggregate
Private  Storage   

%ZEN.Report.aggregate


class %ZEN.Report.aggregate extends valueNode

Defines an aggregate element within a ZEN Report.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
13 2


Summary


Properties
accumIf class escape excelFormula
excelName excelNumberFormat expression field
fields filter format ignoreNLS
name postprocessResult preprocessValue runtimeMode
type uniqueId

Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %New
%NormalizeObject %ObjectModified %OriginalNamespace %PackageName
%PostProcessValue %PreProcessValue %RemoveFromSaveSet %SerializeObject
%SetModified %ValidateObject XMLDTD XMLExport
XMLExportToStream XMLExportToString XMLNew XMLSchema
XMLSchemaNamespace XMLSchemaType fieldIsValid nameIsValid

Subclasses
%ZEN.Report.CustomAggregate

Properties


• property class as %ZEN.Datatype.className;
• property escape as %ZEN.Datatype.string(VALUELIST=",xml,none,noneifspace") [ InitialExpression = "xml" ];
escape can be nonspace in which case any text with line-feed or space characters is not XML spaced or none in which case no characters are XML spaced but all are enclosed in CDATA or xml in which case the text is XML escaped this controls elements and attributes in groups
• property excelFormula as %ZEN.Datatype.string;
In Excel mode, have ZEN Reports use this formula to calculate aggregate =formula(cellbeginnings:cellend)
• property excelName as %ZEN.Datatype.string;
• property excelNumberFormat as %ZEN.Datatype.string;
if non-null is display number format of aggregate value, only effective when mode="xlsx"
• property filter as %ZEN.Datatype.integer [ InitialExpression = 1 ];
When filter is 0, element is skipped
• property format as %ZEN.Datatype.string;
• property ignoreNLS as %ZEN.Datatype.boolean;
Don't process NLS concerns in the aggregate (if null we pick up default from report parameter AGGREGATESIGNORENLS)
• property postprocessResult as %ZEN.Datatype.boolean;
• property preprocessValue as %ZEN.Datatype.boolean;
• property runtimeMode as %Integer(XMLPROJECTION="none");
internal property used to communicate with custom aggregates
• property type as %ZEN.Datatype.string(MAXLEN=50,VALUELIST=",COUNT,SUM,AVG,MIN,MAX,CUSTOM,PLACEHOLDER,EXPRESSION");
Type of aggregate to calculate.
• property uniqueId as %ZEN.Datatype.string;
Unique id for aggregate. Doesn't matter what it is as long as it is unique Doesn't need to be set unless one is using EXPRESSION aggregate that refers to other unique aggregates Other unique aggregates have values in %agg(..uniqueId)

Methods


• classmethod %PostProcessValue(result As %String, postprocessResult As %Boolean, runtimeMode As %Integer, ignoreNLS As %Boolean)
• classmethod %PreProcessValue(value As %String, preprocessValue As %Boolean, runtimeMode As %Integer, ignoreNLS As %Boolean)