Skip to main content

This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.Opens in a new tab

For information on migrating to InterSystems IRISOpens in a new tab, see Why Migrate to InterSystems IRIS?

%ZEN.Report.reportGenerator

class %ZEN.Report.reportGenerator extends %Library.RegisteredObject

Method Inventory

Methods

classmethod Generate(className As %String, reportName As %String, queryClass As %String, queryName As %String, sortandgroup As %Boolean, GroupOption As %String, SortOption As %String, SortBy As %String, UniqueId) as %Status
Generate a ZEN Report
className - name that generated ZEN Report will have, for instance pkgname.GeneratedReport
reportName - name of ZEN Report, root element of generated XML
queryClass - name of class for which report is generated
queryName - name of query for which report is generated
sortandgroup - if 1, we sort and group and next four parameters used, otherwise we don't sort and group
GroupOption - name of option that determines grouping
  • GroupOption's value determines the name of the GroupOption Property in the report. A good name for this is "GroupOption".
  • If the GroupOption property is set to a non-null value this is used in %OnBeforeReport to set the "group".
  • A non-null "group" causes detail records to be placed under a value for the "group" in the report. Each value for "group" will print on its own line. Under "group" will be the other values in the report for which the group has a constant value.
SortOption - name of option that determines sorting of detail records.
  • SortOption's value determines the name of the SortOption property in the report. A good name for this is "SortOption".
  • The value of the property named in SortOption determines is used in %OnBeforeReport to select what field will sort the values that appear in the report.
  • By default UniqueId is used for sorting.
SortBy - name of support internal - set by SortOption, a good value for this is "SortBy" if no column in query named "SortBy"
UniqueId - default sorting field of query, one can set this outside query, will be used to sort report columns if one group in report/columns within group if several groups within report
classmethod GenerateForSQL(className As %String, reportName As %String, sql As %String, sortandgroup As %Boolean, GroupOption As %String, SortOption As %String, SortBy As %String, UniqueId) as %Status
Generate a ZEN Report
className - name that generated ZEN Report will have, for instance pkgname.GeneratedReport
reportName - name of ZEN Report, root element of generated XML
sql - sql used in report generation
sortandgroup - if 1, we sort and group and next four parameters used, otherwise we don't sort and group
GroupOption - name of option that determines grouping
  • GroupOption's value determines the name of the GroupOption Property in the report. A good name for this is "GroupOption".
  • If the GroupOption property is set to a non-null value this is used in %OnBeforeReport to set the "group".
  • A non-null "group" causes detail records to be placed under a value for the "group" in the report. Each value for "group" will print on its own line. Under "group" will be the other values in the report for which the group has a constant value.
SortOption - name of option that determines sorting of detail records.
  • SortOption's value determines the name of the SortOption property in the report. A good name for this is "SortOption".
  • The value of the property named in SortOption determines is used in %OnBeforeReport to select what field will sort the values that appear in the report.
  • By default UniqueId is used for sorting.
SortBy - name of support internal - set by SortOption, a good value for this is "SortBy" if no column in query named "SortBy"
UniqueId - default sorting field of query, one can set this outside query, will be used to sort report columns if one group in report/columns within group if several groups within report

Inherited Members

Inherited Methods

FeedbackOpens in a new tab