Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [%ZEN] >  [Report] >  [CustomAggregate]
Private  Storage   

deprecatedabstract class %ZEN.Report.CustomAggregate extends aggregate

Base class for custom aggregates in ZEN report data.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
2 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 GetResult ProcessValue
XMLDTD XMLExport XMLExportToStream XMLExportToString
XMLNew XMLSchema XMLSchemaNamespace XMLSchemaType
fieldIsValid nameIsValid

Subclasses
%ZEN.Report.Aggregate.Correlation %ZEN.Report.Aggregate.CountDistinct %ZEN.Report.Aggregate.Covariance
%ZEN.Report.Aggregate.LinearRegression %ZEN.Report.Aggregate.Median %ZEN.Report.Aggregate.Mode
%ZEN.Report.Aggregate.Percentile %ZEN.Report.Aggregate.PercentileRank %ZEN.Report.Aggregate.StDev
%ZEN.Report.Aggregate.StDevP %ZEN.Report.Aggregate.Var %ZEN.Report.Aggregate.VarP

Properties

• property class as %ZEN.Datatype.className [ InitialExpression = ..%ClassName(1) ];
• property type as %ZEN.Datatype.string [ InitialExpression = "CUSTOM" ];
Type of aggregate to calculate.

Methods

• method GetResult() as %String
GetResult is invoked after every record has been processed to return the final value of the aggregate.
• method ProcessValue() as %Status
ProcessValue is called sequentially on each record returned by the report query or queries.


Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.