Home > Class Reference > %SYS namespace > %ZEN.Report.reportPage

%ZEN.Report.reportPage

abstract class %ZEN.Report.reportPage extends %Library.RegisteredObject, %CSP.Page, %ZEN.DataModel.Adaptor

Represents a Report within a ZEN application. This is the base class used for all user reports.
Note that a report is not a ZEN page; all logic for a report is executed on the server. The client is sent the final output for viewing and printing.

Parameters

parameter APPLICATION;
This is the class name of this application this report belongs to.
If not defined, this report does not belong to an application.
The application can be the source of ZEN Report parameters.
If APPLICATION is not defined or if parameter is null in APPLICATION class %ZEN.Report.defaultApplication is the source of ZEN Report parameters.
parameter DOMAIN;
Inherited description: Localization domain. DataModel classes that wish to support localization must provide a value for this within subclasses.
parameter REPORTNAME;
This is the logical name of this report. If not provided, class name is used.

Properties

property %ArrayLogFiles [ MultiDimensional ];
Place to hold temporary logfiles
Property methods: %ArrayLogFilesDisplayToLogical(), %ArrayLogFilesGet(), %ArrayLogFilesIsValid(), %ArrayLogFilesLogicalToDisplay(), %ArrayLogFilesLogicalToOdbc(), %ArrayLogFilesNormalize(), %ArrayLogFilesSet()
property %SplitReturnedPDFs as %ZEN.Datatype.string [ MultiDimensional ];
This property hold returned PDFs
Property methods: %SplitReturnedPDFsDisplayToLogical(), %SplitReturnedPDFsGet(), %SplitReturnedPDFsIsValid(), %SplitReturnedPDFsLogicalToDisplay(), %SplitReturnedPDFsLogicalToOdbc(), %SplitReturnedPDFsNormalize(), %SplitReturnedPDFsSet()
property %display as %ZEN.Report.Display.report;
backpointer to display object that belongs to this report
Property methods: %displayGet(), %displayGetSwizzled(), %displayIsValid(), %displayNewObject(), %displaySet()
property AggregatesIgnoreNLS as %ZEN.Datatype.boolean (ZENURL = "$AGGREGATESIGNORENLS");
Aggregates Ignore NLS if this is true
Property methods: AggregatesIgnoreNLSDisplayToLogical(), AggregatesIgnoreNLSGet(), AggregatesIgnoreNLSIsValid(), AggregatesIgnoreNLSLogicalToDisplay(), AggregatesIgnoreNLSLogicalToOdbc(), AggregatesIgnoreNLSNormalize(), AggregatesIgnoreNLSSet()
property CheckPDFNotZeroLength as %ZEN.Datatype.boolean;
Property methods: CheckPDFNotZeroLengthDisplayToLogical(), CheckPDFNotZeroLengthGet(), CheckPDFNotZeroLengthIsValid(), CheckPDFNotZeroLengthLogicalToDisplay(), CheckPDFNotZeroLengthLogicalToOdbc(), CheckPDFNotZeroLengthNormalize(), CheckPDFNotZeroLengthSet()
property ConnectTimeOut as %ZEN.Datatype.integer (ZENURL = "$CONNECTTIMEOUT");
-1 for RenderConnectTimeOut means never timeout.
The units are seconds.
The Zen Report makes a connection using open to connect to the Render Server. This is the timeout on the open (the connect timeout)
Property methods: ConnectTimeOutDisplayToLogical(), ConnectTimeOutGet(), ConnectTimeOutIsValid(), ConnectTimeOutLogicalToDisplay(), ConnectTimeOutLogicalToOdbc(), ConnectTimeOutNormalize(), ConnectTimeOutSet()
property CountRepeatingElement as %ZEN.Datatype.integer;
Property methods: CountRepeatingElementDisplayToLogical(), CountRepeatingElementGet(), CountRepeatingElementIsValid(), CountRepeatingElementLogicalToDisplay(), CountRepeatingElementLogicalToOdbc(), CountRepeatingElementNormalize(), CountRepeatingElementSet()
property Datasource as %String (ZENHIDDEN = 1);
See the DATASOURCE parameter for details.
Property methods: DatasourceDisplayToLogical(), DatasourceGet(), DatasourceIsValid(), DatasourceLogicalToDisplay(), DatasourceLogicalToOdbc(), DatasourceNormalize(), DatasourceSet()
property DefaultFontFaceCopyHTML as %ZEN.Datatype.string (ZENURL = "$DEFAULTFONTFACECOPYHTML");
Used on item when copyhtml="true" to specify a default font face
Property methods: DefaultFontFaceCopyHTMLDisplayToLogical(), DefaultFontFaceCopyHTMLGet(), DefaultFontFaceCopyHTMLIsValid(), DefaultFontFaceCopyHTMLLogicalToDisplay(), DefaultFontFaceCopyHTMLLogicalToOdbc(), DefaultFontFaceCopyHTMLNormalize(), DefaultFontFaceCopyHTMLSet()
property DefaultFontSizeCopyHTML as %ZEN.Datatype.string (ZENURL = "$DEFAULTFONTSIZECOPYHTML");
Used on item when copyhtml="true" to specify a default font size
Property methods: DefaultFontSizeCopyHTMLDisplayToLogical(), DefaultFontSizeCopyHTMLGet(), DefaultFontSizeCopyHTMLIsValid(), DefaultFontSizeCopyHTMLLogicalToDisplay(), DefaultFontSizeCopyHTMLLogicalToOdbc(), DefaultFontSizeCopyHTMLNormalize(), DefaultFontSizeCopyHTMLSet()
property ExcelServer as %ZEN.Datatype.string (ZENURL = "$EXCELSERVER");
specifies ExcelServer port of ExcelServer which renders Excel spreadsheets
Can be overriden by $EXCELSERVER on URL
Property methods: ExcelServerDisplayToLogical(), ExcelServerGet(), ExcelServerIsValid(), ExcelServerLogicalToDisplay(), ExcelServerLogicalToOdbc(), ExcelServerNormalize(), ExcelServerSet(), ExcelServerTimeOutDisplayToLogical(), ExcelServerTimeOutGet(), ExcelServerTimeOutIsValid(), ExcelServerTimeOutLogicalToDisplay(), ExcelServerTimeOutLogicalToOdbc(), ExcelServerTimeOutNormalize(), ExcelServerTimeOutSet()
property ExcelServerTimeOut as %ZEN.Datatype.integer (ZENURL = "$EXCELSERVERTIMEOUT");
-1 for ExcelServerTimeOut means never timeout.
The units are seconds.
Property methods: ExcelServerTimeOutDisplayToLogical(), ExcelServerTimeOutGet(), ExcelServerTimeOutIsValid(), ExcelServerTimeOutLogicalToDisplay(), ExcelServerTimeOutLogicalToOdbc(), ExcelServerTimeOutNormalize(), ExcelServerTimeOutSet()
property FileLifeTime as %ZEN.Datatype.integer (ZENURL = "$FILELIFETIME");
Specify file life time, when life time exceeded, purge task will delete it
Property methods: FileLifeTimeDisplayToLogical(), FileLifeTimeGet(), FileLifeTimeIsValid(), FileLifeTimeLogicalToDisplay(), FileLifeTimeLogicalToOdbc(), FileLifeTimeNormalize(), FileLifeTimeSet()
property MainReport as %String;
Property methods: MainReportDisplayToLogical(), MainReportGet(), MainReportIsValid(), MainReportLogicalToDisplay(), MainReportLogicalToOdbc(), MainReportNormalize(), MainReportSet()
property Mode as %ZEN.Datatype.string (ZENURL = "$MODE");
Specify report mode
Property methods: ModeDisplayToLogical(), ModeGet(), ModeIsValid(), ModeLogicalToDisplay(), ModeLogicalToOdbc(), ModeNormalize(), ModeSet()
property NamespaceDeclarations as %ZEN.Datatype.string (ZENURL = "$NAMESPACEDECLARATIONS");
If provided, this is a string of XML namespace declarations.
For example, "xmlns='http://mydefault' xmlns:ns1='http://namespace1'".
The namespace declarations will go on the root element of the generated XML and also on the stylesheet element of the generated XSL.
Property methods: NamespaceDeclarationsDisplayToLogical(), NamespaceDeclarationsGet(), NamespaceDeclarationsIsValid(), NamespaceDeclarationsLogicalToDisplay(), NamespaceDeclarationsLogicalToOdbc(), NamespaceDeclarationsNormalize(), NamespaceDeclarationsSet()
property OldBehaviorLineFeedOnBreak as %ZEN.Datatype.boolean (ZENURL = "$OLDBEHAVIORLINEFEED");
Old behavior of linefeedOnBreak, where for PDF we issue not a line feed
Property methods: OldBehaviorLineFeedOnBreakDisplayToLogical(), OldBehaviorLineFeedOnBreakGet(), OldBehaviorLineFeedOnBreakIsValid(), OldBehaviorLineFeedOnBreakLogicalToDisplay(), OldBehaviorLineFeedOnBreakLogicalToOdbc(), OldBehaviorLineFeedOnBreakNormalize(), OldBehaviorLineFeedOnBreakSet()
property OptionCachePath as %ZEN.Datatype.string (ZENURL = "$OptionCachePath");
For Fop only, specifies a file/directory path location for the font cache file with value in OptionCachePath
Here is FOP option
-cache path specifies a file/directory path location for the font cache file
Does not work with HotJVM RenderServer
Property methods: OptionCachePathDisplayToLogical(), OptionCachePathGet(), OptionCachePathIsValid(), OptionCachePathLogicalToDisplay(), OptionCachePathLogicalToOdbc(), OptionCachePathNormalize(), OptionCachePathSet()
property OptionConserve as %ZEN.Datatype.boolean (ZENURL = "$OptionConserve");
For Fop only, enable memory-conservation policy (trades memory-consumption for disk I/O) when true or 1
Here is FOP option
-conserve enable memory-conservation policy (trades memory-consumption for disk I/O)
(Note: currently only influences whether the area tree is serialized.)
Property methods: OptionConserveDisplayToLogical(), OptionConserveGet(), OptionConserveIsValid(), OptionConserveLogicalToDisplay(), OptionConserveLogicalToOdbc(), OptionConserveNormalize(), OptionConserveSet()
property OptionDPI as %ZEN.Datatype.string (ZENURL = "$OptionDPI");
For Fop only, target resolution in dots per inch (dpi) where xxx is a number with value in OptionDPI
Here is FOP option
-dpi xxx target resolution in dots per inch (dpi) where xxx is a number
Property methods: OptionDPIDisplayToLogical(), OptionDPIGet(), OptionDPIIsValid(), OptionDPILogicalToDisplay(), OptionDPILogicalToOdbc(), OptionDPINormalize(), OptionDPISet()
property OptionEnableAccessibility as %ZEN.Datatype.boolean (ZENURL = "$OptionEnableAccessibility");
For Fop only, enables accessibility features (Tagged PDF etc., default off) when true or 1
Here is FOP option
-a enables accessibility features (Tagged PDF etc., default off)
Property methods: OptionEnableAccessibilityDisplayToLogical(), OptionEnableAccessibilityGet(), OptionEnableAccessibilityIsValid(), OptionEnableAccessibilityLogicalToDisplay(), OptionEnableAccessibilityLogicalToOdbc(), OptionEnableAccessibilityNormalize(), OptionEnableAccessibilitySet()
property OptionFlush as %ZEN.Datatype.boolean (ZENURL = "$OptionFlush");
For Fop only, flushes the current font cache file when true or 1
Here is FOP option
-flush flushes the current font cache file
Does not work with HotJVM RenderServer
Property methods: OptionFlushDisplayToLogical(), OptionFlushGet(), OptionFlushIsValid(), OptionFlushLogicalToDisplay(), OptionFlushLogicalToOdbc(), OptionFlushNormalize(), OptionFlushSet()
property OptionLang as %ZEN.Datatype.string (ZENURL = "$OptionLang");
For Fop only, the language to use for user information with value in OptionLang
Here is FOP option
-l lang the language to use for user information
Does not work with HotJVM RenderServer
Property methods: OptionLangDisplayToLogical(), OptionLangGet(), OptionLangIsValid(), OptionLangLogicalToDisplay(), OptionLangLogicalToOdbc(), OptionLangNormalize(), OptionLangSet()
property OptionNoAccessContent as %ZEN.Datatype.boolean (ZENURL = "$OptionNoAccessContent");
For Fop only, PDF file will be encrypted without extract text and graphics permission when true or 1
Here is FOP option
-noaccesscontent PDF file will be encrypted without extract text and graphics permission
Property methods: OptionNoAccessContentDisplayToLogical(), OptionNoAccessContentGet(), OptionNoAccessContentIsValid(), OptionNoAccessContentLogicalToDisplay(), OptionNoAccessContentLogicalToOdbc(), OptionNoAccessContentNormalize(), OptionNoAccessContentSet()
property OptionNoAnnotations as %ZEN.Datatype.boolean (ZENURL = "$OptionNoAnnotations");
For Fop only, PDF file will be encrypted without edit annotation permission when true or 1
Here is FOP option
-noannotations PDF file will be encrypted without edit annotation permission
Property methods: OptionNoAnnotationsDisplayToLogical(), OptionNoAnnotationsGet(), OptionNoAnnotationsIsValid(), OptionNoAnnotationsLogicalToDisplay(), OptionNoAnnotationsLogicalToOdbc(), OptionNoAnnotationsNormalize(), OptionNoAnnotationsSet()
property OptionNoAssembleDoc as %ZEN.Datatype.boolean (ZENURL = "$OptionNoAssembleDoc");
For Fop only, PDF file will be encrypted without assemble the document permission when true or 1
Here is FOP option
-noassembledoc PDF file will be encrypted without assemble the document permission
Property methods: OptionNoAssembleDocDisplayToLogical(), OptionNoAssembleDocGet(), OptionNoAssembleDocIsValid(), OptionNoAssembleDocLogicalToDisplay(), OptionNoAssembleDocLogicalToOdbc(), OptionNoAssembleDocNormalize(), OptionNoAssembleDocSet()
property OptionNoComplexScript as %ZEN.Datatype.boolean (ZENURL = "$OptionNoComplexScript");
For Fop only, disable complex script features when true or 1
Here is FOP option
-nocs disable complex script features
Property methods: OptionNoComplexScriptDisplayToLogical(), OptionNoComplexScriptGet(), OptionNoComplexScriptIsValid(), OptionNoComplexScriptLogicalToDisplay(), OptionNoComplexScriptLogicalToOdbc(), OptionNoComplexScriptNormalize(), OptionNoComplexScriptSet()
property OptionNoCopy as %ZEN.Datatype.boolean (ZENURL = "$OptionNoCopy");
For Fop only, PDF file will be encrypted without copy content permission when true or 1
Here is FOP option
-nocopy PDF file will be encrypted without copy content permission
Property methods: OptionNoCopyDisplayToLogical(), OptionNoCopyGet(), OptionNoCopyIsValid(), OptionNoCopyLogicalToDisplay(), OptionNoCopyLogicalToOdbc(), OptionNoCopyNormalize(), OptionNoCopySet()
property OptionNoEdit as %ZEN.Datatype.boolean (ZENURL = "$OptionNoEdit");
For Fop only, PDF file will be encrypted without edit content permission when true or 1
Here is FOP option
-noedit PDF file will be encrypted without edit content permission
Property methods: OptionNoEditDisplayToLogical(), OptionNoEditGet(), OptionNoEditIsValid(), OptionNoEditLogicalToDisplay(), OptionNoEditLogicalToOdbc(), OptionNoEditNormalize(), OptionNoEditSet()
property OptionNoFillInForms as %ZEN.Datatype.boolean (ZENURL = "$OptionNoFillInForms");
For Fop only, PDF file will be encrypted without fill in interactive form fields when true or 1
Here is FOP option
-nofillinforms PDF file will be encrypted without fill in interactive form fields permission
Property methods: OptionNoFillInFormsDisplayToLogical(), OptionNoFillInFormsGet(), OptionNoFillInFormsIsValid(), OptionNoFillInFormsLogicalToDisplay(), OptionNoFillInFormsLogicalToOdbc(), OptionNoFillInFormsNormalize(), OptionNoFillInFormsSet()
property OptionNoPrint as %ZEN.Datatype.boolean (ZENURL = "$OptionNoPrint");
For Fop only, PDF file will be encrypted without printing permission when true or 1
Here is FOP option
-noprint PDF file will be encrypted without printing permission
Property methods: OptionNoPrintDisplayToLogical(), OptionNoPrintGet(), OptionNoPrintHqDisplayToLogical(), OptionNoPrintHqGet(), OptionNoPrintHqIsValid(), OptionNoPrintHqLogicalToDisplay(), OptionNoPrintHqLogicalToOdbc(), OptionNoPrintHqNormalize(), OptionNoPrintHqSet(), OptionNoPrintIsValid(), OptionNoPrintLogicalToDisplay(), OptionNoPrintLogicalToOdbc(), OptionNoPrintNormalize(), OptionNoPrintSet()
property OptionNoPrintHq as %ZEN.Datatype.boolean (ZENURL = "$OptionNoPrintHq");
For Fop only, PDF file will be encrypted without print high quality permission when true or 1
Here is FOP option
-noprinthq PDF file will be encrypted without print high quality permission
Property methods: OptionNoPrintHqDisplayToLogical(), OptionNoPrintHqGet(), OptionNoPrintHqIsValid(), OptionNoPrintHqLogicalToDisplay(), OptionNoPrintHqLogicalToOdbc(), OptionNoPrintHqNormalize(), OptionNoPrintHqSet()
property OptionOwnerPassword as %ZEN.Datatype.string (ZENURL = "$OptionOwnerPassword");
For Fop only, PDF file will be encrypted with value in OptionOwnerPassword
Here is FOP option
-o [password] PDF file will be encrypted with option owner password
Property methods: OptionOwnerPasswordDisplayToLogical(), OptionOwnerPasswordGet(), OptionOwnerPasswordIsValid(), OptionOwnerPasswordLogicalToDisplay(), OptionOwnerPasswordLogicalToOdbc(), OptionOwnerPasswordNormalize(), OptionOwnerPasswordSet()
property OptionPDFProfile as %ZEN.Datatype.string (ZENURL = "$OptionPDFProfile");
For Fop only, PDF file will be generated with the specified profile with value in OptionPDFProfile
Here is FOP option
-pdfprofile prof PDF file will be generated with the specified profile
(Examples for prof: PDF/A-1b or PDF/X-3:2003)
Does not work with HotJVM RenderServer
Property methods: OptionPDFProfileDisplayToLogical(), OptionPDFProfileGet(), OptionPDFProfileIsValid(), OptionPDFProfileLogicalToDisplay(), OptionPDFProfileLogicalToOdbc(), OptionPDFProfileNormalize(), OptionPDFProfileSet()
property OptionRelaxed as %ZEN.Datatype.boolean (ZENURL = "$OptionRelaxed");
For Fop only, relaxed/less strict validation (where available) when true or 1
Here is FOP option
-r relaxed/less strict validation (where available)
Does not work with HotJVM RenderServer
Property methods: OptionRelaxedDisplayToLogical(), OptionRelaxedGet(), OptionRelaxedIsValid(), OptionRelaxedLogicalToDisplay(), OptionRelaxedLogicalToOdbc(), OptionRelaxedNormalize(), OptionRelaxedSet()
property OptionUserPassword as %ZEN.Datatype.string (ZENURL = "$OptionUserPassword");
For Fop only, PDF file will be encrypted with value in OptionUserPassword
Here is FOP option
-u [password] PDF file will be encrypted with option user password
Property methods: OptionUserPasswordDisplayToLogical(), OptionUserPasswordGet(), OptionUserPasswordIsValid(), OptionUserPasswordLogicalToDisplay(), OptionUserPasswordLogicalToOdbc(), OptionUserPasswordNormalize(), OptionUserPasswordSet()
property PDFMergeMemSize as %ZEN.Datatype.string (ZENURL = "$PDFMERGEMEMSIZE");
Specify amount of memory used by SAXON processing (especially used when XSLTVERSION=2.0), defaults to 512m
Property methods: PDFMergeMemSizeDisplayToLogical(), PDFMergeMemSizeGet(), PDFMergeMemSizeIsValid(), PDFMergeMemSizeLogicalToDisplay(), PDFMergeMemSizeLogicalToOdbc(), PDFMergeMemSizeNormalize(), PDFMergeMemSizeSet()
property PS as %ZEN.Datatype.string (ZENURL = "$PS");
Postscript Printer or Printer used by pdfprint/PrintServer
Property methods: PSDisplayToLogical(), PSGet(), PSIsValid(), PSLogicalToDisplay(), PSLogicalToOdbc(), PSNormalize(), PSSet()
property PrintServer as %ZEN.Datatype.string (ZENURL = "$PRINTSERVER");
specifies PrintServer port of PrintServer which prints PDFs
Can be overriden by $PRINTSERVER on URL
Property methods: PrintServerDisplayToLogical(), PrintServerGet(), PrintServerIsValid(), PrintServerLogicalToDisplay(), PrintServerLogicalToOdbc(), PrintServerNormalize(), PrintServerSet()
property PrintTimeOut as %ZEN.Datatype.integer (ZENURL = "$PRINTTIMEOUT");
-1 for PrintTimeOut means never timeout.
The units are seconds.
Property methods: PrintTimeOutDisplayToLogical(), PrintTimeOutGet(), PrintTimeOutIsValid(), PrintTimeOutLogicalToDisplay(), PrintTimeOutLogicalToOdbc(), PrintTimeOutNormalize(), PrintTimeOutSet()
property RenderDirectlyOnTimeout as %ZEN.Datatype.boolean (ZENURL = "$RENDERDIRECTLYONTIMEOUT");
if we do not render directly to Render Server in RENDERTIMEOUT, Zen Reports renders directly, spawing new JVM
Property methods: RenderDirectlyOnTimeoutDisplayToLogical(), RenderDirectlyOnTimeoutGet(), RenderDirectlyOnTimeoutIsValid(), RenderDirectlyOnTimeoutLogicalToDisplay(), RenderDirectlyOnTimeoutLogicalToOdbc(), RenderDirectlyOnTimeoutNormalize(), RenderDirectlyOnTimeoutSet()
property RenderTimeOut as %ZEN.Datatype.integer (ZENURL = "$RENDERTIMEOUT");
-1 for RenderTimeOut means never timeout.
The units are seconds.
Property methods: RenderTimeOutDisplayToLogical(), RenderTimeOutGet(), RenderTimeOutIsValid(), RenderTimeOutLogicalToDisplay(), RenderTimeOutLogicalToOdbc(), RenderTimeOutNormalize(), RenderTimeOutSet()
property RepeatingElement as %ZEN.Datatype.string;
Property methods: RepeatingElementDisplayToLogical(), RepeatingElementGet(), RepeatingElementIsValid(), RepeatingElementLogicalToDisplay(), RepeatingElementLogicalToOdbc(), RepeatingElementNormalize(), RepeatingElementSet()
property ReportDir as %String;
Property methods: ReportDirDisplayToLogical(), ReportDirGet(), ReportDirIsValid(), ReportDirLogicalToDisplay(), ReportDirLogicalToOdbc(), ReportDirNormalize(), ReportDirSet()
property ReportXMLNameSpace as %ZEN.Datatype.string (ZENHIDDEN = 1);
Property methods: ReportXMLNameSpaceDisplayToLogical(), ReportXMLNameSpaceGet(), ReportXMLNameSpaceIsValid(), ReportXMLNameSpaceLogicalToDisplay(), ReportXMLNameSpaceLogicalToOdbc(), ReportXMLNameSpaceNormalize(), ReportXMLNameSpacePrefixDisplayToLogical(), ReportXMLNameSpacePrefixGet(), ReportXMLNameSpacePrefixIsValid(), ReportXMLNameSpacePrefixLogicalToDisplay(), ReportXMLNameSpacePrefixLogicalToOdbc(), ReportXMLNameSpacePrefixNormalize(), ReportXMLNameSpacePrefixSet(), ReportXMLNameSpaceSet()
property ReportXMLNameSpacePrefix as %ZEN.Datatype.string (ZENHIDDEN = 1);
Property methods: ReportXMLNameSpacePrefixDisplayToLogical(), ReportXMLNameSpacePrefixGet(), ReportXMLNameSpacePrefixIsValid(), ReportXMLNameSpacePrefixLogicalToDisplay(), ReportXMLNameSpacePrefixLogicalToOdbc(), ReportXMLNameSpacePrefixNormalize(), ReportXMLNameSpacePrefixSet()
property SaxMemSize as %ZEN.Datatype.string (ZENURL = "$SAXMEMSIZE");
Specify amount of memory used by SAXON processing (especially used when XSLTVERSION=2.0), defaults to 512m
Property methods: SaxMemSizeDisplayToLogical(), SaxMemSizeGet(), SaxMemSizeIsValid(), SaxMemSizeLogicalToDisplay(), SaxMemSizeLogicalToOdbc(), SaxMemSizeNormalize(), SaxMemSizeSet()
property SetProcessWideRunTimeMode as %ZEN.Datatype.boolean (ZENURL = "$SETPROCESSWIDERUNTIMEMODE");
Process wide runtime mode Set on a sql statement from the runtime mode passed into the ZEN Report if this is 1
Property methods: SetProcessWideRunTimeModeDisplayToLogical(), SetProcessWideRunTimeModeGet(), SetProcessWideRunTimeModeIsValid(), SetProcessWideRunTimeModeLogicalToDisplay(), SetProcessWideRunTimeModeLogicalToOdbc(), SetProcessWideRunTimeModeNormalize(), SetProcessWideRunTimeModeSet()
property SplitAndMerge as %ZEN.Datatype.boolean;
Property methods: SplitAndMergeDisplayToLogical(), SplitAndMergeGet(), SplitAndMergeIsValid(), SplitAndMergeLogicalToDisplay(), SplitAndMergeLogicalToOdbc(), SplitAndMergeNormalize(), SplitAndMergeSet()
property SplitDir as %ZEN.Datatype.string;
This is directory where PDF files produced by split will go
Property methods: SplitDirDisplayToLogical(), SplitDirGet(), SplitDirIsValid(), SplitDirLogicalToDisplay(), SplitDirLogicalToOdbc(), SplitDirNormalize(), SplitDirSet()
property SplitOnly as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If SPLITANDMERGE set, split only, don't merge at end
Property methods: SplitOnlyDisplayToLogical(), SplitOnlyGet(), SplitOnlyIsValid(), SplitOnlyLogicalToDisplay(), SplitOnlyLogicalToOdbc(), SplitOnlyNormalize(), SplitOnlySet()
property SplitRootName as %ZEN.Datatype.string;
Instead of generating temporary names for split PDF files, use this as a root name, and add an integer suffix to file
Property methods: SplitRootNameDisplayToLogical(), SplitRootNameGet(), SplitRootNameIsValid(), SplitRootNameLogicalToDisplay(), SplitRootNameLogicalToOdbc(), SplitRootNameNormalize(), SplitRootNameSet()
property StripPI as %String;
Property methods: StripPIDisplayToLogical(), StripPIGet(), StripPIIsValid(), StripPILogicalToDisplay(), StripPILogicalToOdbc(), StripPINormalize(), StripPISet()
property SubReport as %String;
This property is used on toxslfo and tohtml to indicate they are being fetched as sub-reports
Property methods: SubReportDisplayToLogical(), SubReportGet(), SubReportIsValid(), SubReportLogicalToDisplay(), SubReportLogicalToOdbc(), SubReportNormalize(), SubReportSet()
property SuppressExcelHeaders as %ZEN.Datatype.boolean (ZENHIDDEN = 1);
Property methods: SuppressExcelHeadersDisplayToLogical(), SuppressExcelHeadersGet(), SuppressExcelHeadersIsValid(), SuppressExcelHeadersLogicalToDisplay(), SuppressExcelHeadersLogicalToOdbc(), SuppressExcelHeadersNormalize(), SuppressExcelHeadersSet()
property TableAltColor as %ZEN.Datatype.string;
Property methods: TableAltColorDisplayToLogical(), TableAltColorGet(), TableAltColorIsValid(), TableAltColorLogicalToDisplay(), TableAltColorLogicalToOdbc(), TableAltColorNormalize(), TableAltColorSet()
property TimeOut as %ZEN.Datatype.integer;
Property methods: TimeOutDisplayToLogical(), TimeOutGet(), TimeOutIsValid(), TimeOutLogicalToDisplay(), TimeOutLogicalToOdbc(), TimeOutNormalize(), TimeOutSet()
property TooLongText as %ZEN.Datatype.string;
Property methods: TooLongTextDisplayToLogical(), TooLongTextGet(), TooLongTextIsValid(), TooLongTextLogicalToDisplay(), TooLongTextLogicalToOdbc(), TooLongTextNormalize(), TooLongTextSet()
property UseHTML5 as %ZEN.Datatype.boolean (ZENURL = "$USEHTML5");
Set to true in order to generate HTML5 regardless of browser support Set to false in order to *not* generate HTML5 regardless of browser support
Property methods: UseHTML5DisplayToLogical(), UseHTML5Get(), UseHTML5IsValid(), UseHTML5LogicalToDisplay(), UseHTML5LogicalToOdbc(), UseHTML5Normalize(), UseHTML5Set()
property UseRawIOForXML as %Boolean [ InitialExpression = 0 ];
UseRawIOForXML - set to 1 to use RawIO in XML output, otherwise use translation tables
Property methods: UseRawIOForXMLDisplayToLogical(), UseRawIOForXMLGet(), UseRawIOForXMLIsValid(), UseRawIOForXMLLogicalToDisplay(), UseRawIOForXMLNormalize(), UseRawIOForXMLSet()
property UseSemaphore as %ZEN.Datatype.boolean (ZENURL = "$USESEMAPHORE") [ InitialExpression = 0 ];
Set to true to cause ZEN Report to control going to RenderServer with Semaphore
Property methods: UseSemaphoreDisplayToLogical(), UseSemaphoreGet(), UseSemaphoreIsValid(), UseSemaphoreLogicalToDisplay(), UseSemaphoreLogicalToOdbc(), UseSemaphoreNormalize(), UseSemaphoreSet()
property XsltVersion as %ZEN.Datatype.string (ZENHIDDEN = 1);
Property methods: XsltVersionDisplayToLogical(), XsltVersionGet(), XsltVersionIsValid(), XsltVersionLogicalToDisplay(), XsltVersionLogicalToOdbc(), XsltVersionNormalize(), XsltVersionSet()
property getxmlstylesheet as %String;
Property methods: getxmlstylesheetDisplayToLogical(), getxmlstylesheetGet(), getxmlstylesheetIsValid(), getxmlstylesheetLogicalToDisplay(), getxmlstylesheetLogicalToOdbc(), getxmlstylesheetNormalize(), getxmlstylesheetSet()
property isHTML5 as %Boolean [ InitialExpression = 0 ];
Property methods: isHTML5DisplayToLogical(), isHTML5Get(), isHTML5IsValid(), isHTML5LogicalToDisplay(), isHTML5Normalize(), isHTML5Set()
property isServer as %Boolean [ InitialExpression = 0 ];
Property methods: isServerDisplayToLogical(), isServerGet(), isServerIsValid(), isServerLogicalToDisplay(), isServerNormalize(), isServerSet()
property toexcelstream as %Library.RegisteredObject;
Property methods: toexcelstreamGet(), toexcelstreamGetSwizzled(), toexcelstreamIsValid(), toexcelstreamNewObject(), toexcelstreamSet()
property tohtmlstream as %Library.RegisteredObject (ZENHIDDEN = 1);
Property methods: tohtmlstreamGet(), tohtmlstreamGetSwizzled(), tohtmlstreamIsValid(), tohtmlstreamNewObject(), tohtmlstreamSet()
property toxslfostream as %Library.RegisteredObject (ZENHIDDEN = 1);
Property methods: toxslfostreamGet(), toxslfostreamGetSwizzled(), toxslfostreamIsValid(), toxslfostreamNewObject(), toxslfostreamSet()
property xmlfile as %String;
xmlfile generated by ZEN Report
Property methods: xmlfileDisplayToLogical(), xmlfileGet(), xmlfileIsValid(), xmlfileLogicalToDisplay(), xmlfileLogicalToOdbc(), xmlfileNormalize(), xmlfileSet()
property xmlstream as %Library.RegisteredObject (ZENHIDDEN = 1);
Property methods: xmlstreamGet(), xmlstreamGetSwizzled(), xmlstreamIsValid(), xmlstreamNewObject(), xmlstreamSet()
property xmlstylesheet as %Library.RegisteredObject;
Property methods: xmlstylesheetGet(), xmlstylesheetGetSwizzled(), xmlstylesheetIsValid(), xmlstylesheetNewObject(), xmlstylesheetSet(), xmlstylesheetargDisplayToLogical(), xmlstylesheetargGet(), xmlstylesheetargIsValid(), xmlstylesheetargLogicalToDisplay(), xmlstylesheetargLogicalToOdbc(), xmlstylesheetargNormalize(), xmlstylesheetargSet()
property xmlstylesheetarg as %ZEN.Datatype.string (ZENURL = "$XMLSTYLESHEETARG");
Property methods: xmlstylesheetargDisplayToLogical(), xmlstylesheetargGet(), xmlstylesheetargIsValid(), xmlstylesheetargLogicalToDisplay(), xmlstylesheetargLogicalToOdbc(), xmlstylesheetargNormalize(), xmlstylesheetargSet()

Methods

method %DisplayAnnotatedExcel(DisplayLog As %Boolean = 0, ApplyTransform As %Boolean = 0, UseInternalXSLT As %Boolean = 0, UseTempFiles As %Boolean = 0, embedXSL As %Boolean = 0, ExcelMode As %String) [ Language = objectscript ]
final classmethod %GetComponentById(id As %String) as %ZEN.Component.object [ Language = objectscript ]
Server-only method for finding a ZEN Report Display node within this report display given its id.
method %InitProperties1() [ Language = objectscript ]
method %MakeTransformedXMLFile(ByRef filename, ByRef xmlfile, ByRef xslfile, stripPI=0, embedXSL=0, async=0) [ Language = objectscript ]
method %OnAfterCreateDisplay(pDisplay As %ZEN.Report.Display.report) [ Language = objectscript ]
method %OnAfterReport() as %Status [ Language = objectscript ]
This callback is invoked after this report is run and before it is closed.
method %OnBeforeReport() as %Status [ Language = objectscript ]
This callback is invoked after this report is instantiated and before it is run.
classmethod %OnPreHTTP() as %Boolean [ Language = objectscript ]
method %OnReportTag() [ Language = objectscript ]
Notification that we are writing out the attributes for the opening tag.
method %OnSubmit(pSubmit As %ZEN.Submit) as %Status [ Language = objectscript ]
If defined, this callback is called when a form connected to this DataModel is submitted.
The contents of this DataModel will be filled in from the submitted values before this callback is invoked.
The default implementation is to store the submitted values back to the model.
classmethod %ResolveText(pText As %String, ByRef context) as %String [ Language = objectscript ]
Resolve a localized text string at run time. A localized string can take the following forms:
"String" -- not localized.
"$$$String" -- equivalent to $$$Text("String","DeepSeeUser")
"$$$String/Domain" -- equivalent to $$$Text("String","Domain")
method %getDisplayUniqueExcelSheetName(excelSheetName As %String, ByRef context) as %String [ Language = objectscript ]
method %getUniqueExcelSheetName(excelSheetName As %String) as %String [ Language = objectscript ]
method AsynchGenerateReport(renderServer As %String = "", ByRef xmlfile As %String, ByRef xsltfile As %String, ByRef pdffile As %String, ByRef lockfile As %String) as %Status [ Language = objectscript ]
Queue the report for rendering to the Queuing Hot JVM server input is the port on which the Queuing Hot JVM Server is listening returns by reference xmlfile, xsltfile, pdffile, and lockfile which are names of files either queued or created by queuer Arguments: renderServer
  • xmlfile - returned by reference
  • xsltfile - returned by reference
  • pdffile - returned by reference
  • lockfile - returned by reference
when the lockfile exists theQueuing Hot JVM Server has created the pdf file
method GenerateReport(outputfile As %String, mode As %Integer = 0, log As %Boolean = 0, renderServer As %String = "", ExcelMode As %String = "", pStr As %String, Output RenderDirect As %Integer = 1) as %Status [ Language = objectscript ]
Generate the report and save it to outputfile.
Choices for mode are:
  • 0 = XML
  • 1 = HTML
  • 2 = PDF
  • 3 = ToHTML Stylesheet
  • 4 = ToXSLFO Stylesheet
  • 5 = XSD Schema
  • 6 = PrintPS
  • 7 = Excel
  • 8 = XSLFO
  • 9 = ToEXCEL
  • 10=xlsx
  • 11=TIFF
  • 12=pdfprint
  • 13=displayxlsx
  • 14=fo2pdf
  • 15=foandpdf

If log is true, the log file is returned instead of the report
method GenerateReportToStream(ByRef stream As %Stream.Object, mode As %Integer = 0, log As %Boolean = 0) as %Status [ Language = objectscript ]
Generate the report and save it to stream.
Choices for mode are:
  • 0 = XML
  • 1 = HTML
  • 2 = PDF
  • 3 = ToHTML Stylesheet
  • 4 = ToXSLFO Stylesheet
  • 5 = XSD Schema
  • 6 = PrintPS
  • 7 = Excel
  • 8 = XSLFO
  • 9 = ToEXCEL
  • 10 = xlsx
  • 11=TIFF
  • 12=pdfprint

If log is true, the log file is returned instead of the report
classmethod GenerateToFile(outputfile As %String, mode As %Integer = 0, log As %Boolean = 0) as %Status [ Language = objectscript ]
Generate the report and save it to outputfile.
Choices for mode are:
  • 0 = XML
  • 1 = HTML
  • 2 = PDF
  • 3 = ToHTML Stylesheet
  • 4 = ToXSLFO Stylesheet
  • 5 = XSD Schema
  • 6 = PrintPS
  • 7 = Excel
  • 8 = XSLFO
  • 9 = ToEXCEL
  • 10=xlsx
  • 11=TIFF
  • 12=pdfprint
  • 13=displayxlsx
  • 14=fo2pdf
  • 15=foandpdf

If log is true, the log file is returned instead of the report This is a class method wrapper for the GenerateReport() method provided for convenience.
method GetTempFileName(ext, isFileBeingPrinted, async, suffix="", Here=0, pMode="") [ Language = objectscript ]
classmethod OnAfterCreateDisplay() [ Language = objectscript ]
classmethod OnPage() as %Status [ Language = objectscript ]
Render the contents of this ZEN report.
classmethod OnPreHTTP() as %Boolean [ Language = objectscript ]
PreHTTP handler. Sets content-type and content-dispositon depending on $MODE and $LOG
method Purge(filename) [ Language = objectscript ]
classmethod TestPDFGeneration() as %Status [ Language = objectscript ]
classmethod ToExcelDate(horlog) [ Language = objectscript ]
convenience method for converting an horlog to an Excel date
method UnLock(filename) [ Language = objectscript ]

Inherited Methods

%AddToSaveSet() %OnCopyDataToModel() EscapeURL()
%ClassIsLatestVersion() %OnDeleteModel() HyperEventCall()
%ClassName() %OnDeleteSource() HyperEventHead()
%ConstructClone() %OnGetPropertyInfo() Include()
%CreateModelInstance() %OnInvokeAction() InsertHiddenField()
%DeleteModel() %OnLoadModel() InsertHiddenFields()
%DispatchClassMethod() %OnNewSource() IsPrivate()
%DispatchGetModified() %OnOpenSource() Link()
%DispatchMethod() %OnSaveSource() OnHTTPHeader()
%DispatchSetModified() %OnStoreModel() OnPageError()
%DispatchSetMultidimProperty() %OpenModel() OnPostHTTP()
%Extends() %OriginalNamespace() OnPostHyperEvent()
%GetJSValidationCode() %PackageName() OnPreHyperEvent()
%GetParameter() %RemoveFromSaveSet() Page()
%GetPropertyInfo() %SaveModel() QuoteJS()
%InvokeAction() %SerializeObject() RewriteURL()
%IsA() %SetModified() ShowError()
%IsModified() %SubmitHandler() StartTimer()
%IsReadOnly() %ValidateObject() StopTimer()
%New() ConvertParameter() ThrowError()
%NormalizeObject() Decrypt() UnescapeHTML()
%ObjectModified() Encrypt() UnescapeURL()
%OnCopyDataFromModel() EscapeHTML()

Subclasses

%DeepSee.Report.reportPage %DeepSee.UI.MDXPDF %SQL.Manager.Reports.Messages
%DeepSee.UI.ChartPDF %DeepSee.UI.WorksheetPDF %ZEN.Report.TestReport