This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRISOpens in a new window, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions pageOpens in a new window (login required).

Caché & Ensemble 2018.1.5Opens in a new window > Class Reference > %SYS namespace > %ZEN.Report.Models.Group.Report


class %ZEN.Report.Models.Group.Report extends %Library.RegisteredObject, %XML.Adaptor

Property Inventory (Including Private)

Method Inventory (Including Private)


parameter XMLNAME = report;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.

Properties (Including Private)

property className as %String (XMLNAME = "class-name", XMLPROJECTION = "attribute");
name of ZEN Report class
Property methods: classNameDisplayToLogical(), classNameGet(), classNameIsValid(), classNameLogicalToDisplay(), classNameLogicalToOdbc(), classNameNormalize(), classNameSet()
property description as %String (MAXLEN = 5000, XMLPROJECTION = "attribute");
Optional description for this report.
Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()
property document as Document (XMLPROJECTION = "element");
document element
Property methods: documentGet(), documentGetSwizzled(), documentIsValid(), documentNewObject(), documentSet()
Set of groups within this report.
Property methods: groupsBuildValueArray(), groupsCollectionToDisplay(), groupsCollectionToOdbc(), groupsDisplayToCollection(), groupsGet(), groupsGetObject(), groupsGetObjectId(), groupsGetSwizzled(), groupsIsValid(), groupsOdbcToCollection(), groupsSet(), groupsSetObject(), groupsSetObjectId()
property name as %String (XMLNAME = "name", XMLPROJECTION = "attribute");
name of ZEN Report
Property methods: nameDisplayToLogical(), nameGet(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()
property queryClass as %ZEN.Datatype.className;
(optional) Name of the class containing the class query that will be used to create a %ResultSet object.
This property is only used if queryName is defined. If this property is not defined, then it is assumed that the current report class contains the specified query.
Property methods: queryClassDisplayToLogical(), queryClassGet(), queryClassIsValid(), queryClassLogicalToDisplay(), queryClassLogicalToOdbc(), queryClassNormalize(), queryClassSet()
property queryName as %ZEN.Datatype.classMember (MEMBERTYPE = "QUERY");
(optional) Name of the class query that will be used to create a %ResultSet object.
Property methods: queryNameDisplayToLogical(), queryNameGet(), queryNameIsValid(), queryNameLogicalToDisplay(), queryNameLogicalToOdbc(), queryNameNormalize(), queryNameSet()
property sql as %ZEN.Datatype.sql;
(optional) SQL statement that, if present, will be used to create a %ResultSet object.
If defined, this takes precedence over queryClass and queryName.
Property methods: sqlDisplayToLogical(), sqlGet(), sqlIsValid(), sqlLogicalToDisplay(), sqlLogicalToOdbc(), sqlNormalize(), sqlSet()

Methods (Including Private)

classmethod ImportFile(filename As %String) as Report

Inherited Members

Inherited Methods (Including Private)

FeedbackOpens in a new window