Represents a Report within a ZEN application. More...
Public Member Functions | |
_.Library.Status | AsynchGenerateReport (_.Library.String renderServer, _.Library.String xmlfile, _.Library.String xsltfile, _.Library.String pdffile, _.Library.String lockfile) |
Queue the report for rendering to the Queuing Hot JVM server. More... | |
_.Library.Status | GenerateReport (_.Library.String outputfile, _.Library.Integer mode, _.Library.Boolean log, _.Library.String renderServer, _.Library.String ExcelMode, _.Library.String pStr, _.Library.Integer RenderDirect) |
Generate the report and save it to outputfile. More... | |
_.Library.Status | GenerateReportToStream (_.Stream.Object stream, _.Library.Integer mode, _.Library.Boolean log) |
Generate the report and save it to stream. More... | |
![]() | |
_.Library.Status | OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount) |
This callback method is invoked when the current object is added to the SaveSet,. More... | |
_.Library.Status | OnClose () |
This callback method is invoked by the <METHOD>Close</METHOD> method to. More... | |
_.Library.Status | OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned) |
This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More... | |
_.Library.Status | OnNew () |
This callback method is invoked by the <METHOD>New</METHOD> method to. More... | |
_.Library.Status | OnValidateObject () |
This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More... | |
Static Public Member Functions | |
_.Library.Status | GenerateToFile (_.Library.String outputfile, _.Library.Integer mode, _.Library.Boolean log) |
Generate the report and save it to outputfile. More... | |
_.Library.Status | OnPage () |
Render the contents of this ZEN report. | |
_.Library.Boolean | OnPreHTTP () |
PreHTTP handler. More... | |
ToExcelDate (horlog) | |
convenience method for converting an horlog to an Excel date | |
![]() | |
_.Library.Status | ConvertParameter (_.Library.String url, _.Library.String name, _.Library.String value) |
You pass this the <parameter>url</parameter> of the page you are going to and a. More... | |
_.Library.Binary | Decrypt (_.Library.String data) |
Decrypts the input string using the session.Key value that is unique to. More... | |
_.Library.String | Encrypt (_.Library.Binary data) |
Encrypts the input string using the session.Key value that is unique to this. More... | |
_.Library.String | EscapeHTML (in) |
This method converts input HTML text into Escaped HTML text. | |
_.Library.String | EscapeURL (_.Library.String in, _.Library.String charset) |
This method converts the in input URL string into Escaped URL string. More... | |
_.Library.String | HyperEventCall (_.Library.String methodName, _.Library.String args, _.Library.Integer type, _.Library.Boolean mobile) |
This method returns the string that needs to be written to the current. More... | |
_.Library.String | HyperEventHead (_.Library.Boolean iframeOnly, _.Library.Boolean strict, _.Library.Boolean optionalBroker) |
This method returns the string that needs to be written to the current. More... | |
Include (_.Library.String url) | |
Include another csp page or file in the output at this point. More... | |
_.Library.String | InsertHiddenField (_.Library.String url, _.Library.String name, _.Library.String value, _.Library.String extra) |
Inserts a '<input type="hidden" name="Name" value="Value">' tag into the current document. More... | |
_.Library.String | InsertHiddenFields (_.Library.String url, _.Library.String query) |
Return the string containing the hidden form tags. More... | |
_.Library.Boolean | IsPrivate () |
Returns 1 if this page is in fact a private page (see <parameter>PRIVATE</parameter>). | |
_.Library.String | Link (_.Library.String link, _.Library.String query, _.Library.Boolean addQ) |
Tranforms the link specified by link into a URL and returns it as a string. More... | |
_.Library.Status | OnHTTPHeader (_.Library.Boolean OutputBody) |
Event handler for PAGE event: this is invoked in order to More... | |
OnPageError (_.Library.Status sc) | |
Event handler for any error that occurs on the page. More... | |
OnPostHTTP () | |
Event handler for POSTPAGE event: this is invoked after the data. More... | |
_.Library.Status | OnPostHyperEvent (_.Library.String class, _.Library.String method) |
Event handler which is invoked after a hyperevent method is called on this page. | |
_.Library.Status | OnPreHyperEvent (_.Library.String class, _.Library.String method) |
Event handler which is invoked before a hyperevent method is called on this page. More... | |
_.Library.Status | Page (_.Library.Boolean skipheader) |
Process a request to serve a CSPPage. More... | |
_.Library.String | QuoteJS (in) |
This method converts input string into quoted JavaScript literal. | |
_.Library.String | RewriteURL (_.Library.String url) |
This method will rewrite a URL to use #url()# if needed. | |
ShowError (_.Library.Status sc) | |
Display a <class>Status</class> error code to the CSP Page. | |
StartTimer (_.Library.String name) | |
Used to get performance information on your CSP pages. More... | |
StopTimer (_.Library.String name) | |
Used to time performance information on your CSP pages. More... | |
ThrowError (_.Library.Status sc) | |
Passed a <class>Status</class> code this goes to the error page passing this status code. | |
_.Library.String | UnescapeHTML (in) |
This method converts Escaped HTML text into normal HTML text. | |
_.Library.String | UnescapeURL (_.Library.String in, _.Library.String charset) |
This method converts the in Escaped URL string back to its original form. More... | |
Public Attributes | |
AggregatesIgnoreNLS | |
Aggregates Ignore NLS if this is true. More... | |
CheckPDFNotZeroLength | |
More... | |
ConnectTimeOut | |
-1 for RenderConnectTimeOut means never timeout. More... | |
CountRepeatingElement | |
More... | |
Datasource | |
See the DATASOURCE parameter for details. More... | |
DefaultFontFaceCopyHTML | |
Used on item when copyhtml="true" to specify a default font face. More... | |
DefaultFontSizeCopyHTML | |
Used on item when copyhtml="true" to specify a default font size. More... | |
ExcelServer | |
specifies ExcelServer port of ExcelServer which renders Excel spreadsheets More... | |
ExcelServerTimeOut | |
-1 for ExcelServerTimeOut means never timeout. More... | |
FileLifeTime | |
Specify file life time, when life time exceeded, purge task will delete it. More... | |
MainReport | |
More... | |
Mode | |
Specify report mode. More... | |
NamespaceDeclarations | |
If provided, this is a string of XML namespace declarations. More... | |
OldBehaviorLineFeedOnBreak | |
Old behavior of linefeedOnBreak, where for PDF we issue <fo:block/> not a line feed. More... | |
OptionCachePath | |
For Fop only, specifies a file/directory path location for the font cache file with value in OptionCachePath More... | |
OptionConserve | |
For Fop only, enable memory-conservation policy (trades memory-consumption for disk I/O) when true or 1 More... | |
OptionDPI | |
For Fop only, target resolution in dots per inch (dpi) where xxx is a number with value in OptionDPI More... | |
OptionEnableAccessibility | |
For Fop only, enables accessibility features (Tagged PDF etc., default off) when true or 1 More... | |
OptionFlush | |
For Fop only, flushes the current font cache file when true or 1 More... | |
OptionLang | |
For Fop only, the language to use for user information with value in OptionLang More... | |
OptionNoAccessContent | |
For Fop only, PDF file will be encrypted without extract text and graphics permission when true or 1 More... | |
OptionNoAnnotations | |
For Fop only, PDF file will be encrypted without edit annotation permission when true or 1 More... | |
OptionNoAssembleDoc | |
For Fop only, PDF file will be encrypted without assemble the document permission when true or 1 More... | |
OptionNoComplexScript | |
For Fop only, disable complex script features when true or 1 More... | |
OptionNoCopy | |
For Fop only, PDF file will be encrypted without copy content permission when true or 1 More... | |
OptionNoEdit | |
For Fop only, PDF file will be encrypted without edit content permission when true or 1 More... | |
OptionNoFillInForms | |
For Fop only, PDF file will be encrypted without fill in interactive form fields when true or 1 More... | |
OptionNoPrint | |
For Fop only, PDF file will be encrypted without printing permission when true or 1 More... | |
OptionNoPrintHq | |
For Fop only, PDF file will be encrypted without print high quality permission when true or 1 More... | |
OptionOwnerPassword | |
For Fop only, PDF file will be encrypted with value in OptionOwnerPassword More... | |
OptionPDFProfile | |
For Fop only, PDF file will be generated with the specified profile with value in OptionPDFProfile More... | |
OptionRelaxed | |
For Fop only, relaxed/less strict validation (where available) when true or 1 More... | |
OptionUserPassword | |
For Fop only, PDF file will be encrypted with value in OptionUserPassword More... | |
PDFMergeMemSize | |
Specify amount of memory used by SAXON processing (especially used when XSLTVERSION=2.0), defaults to 512m. More... | |
PS | |
Postscript Printer or Printer used by pdfprint/PrintServer. More... | |
PrintServer | |
specifies PrintServer port of PrintServer which prints PDFs More... | |
PrintTimeOut | |
-1 for PrintTimeOut means never timeout. More... | |
RenderDirectlyOnTimeout | |
if we do not render directly to Render Server in RENDERTIMEOUT, Zen Reports renders directly, spawing new JVM More... | |
RenderTimeOut | |
-1 for RenderTimeOut means never timeout. More... | |
RepeatingElement | |
More... | |
ReportDir | |
More... | |
ReportXMLNameSpace | |
More... | |
ReportXMLNameSpacePrefix | |
More... | |
SaxMemSize | |
Specify amount of memory used by SAXON processing (especially used when XSLTVERSION=2.0), defaults to 512m. More... | |
SetProcessWideRunTimeMode | |
Process wide runtime mode. More... | |
SplitAndMerge | |
More... | |
SplitDir | |
This is directory where PDF files produced by split will go. More... | |
SplitOnly | |
If SPLITANDMERGE set, split only, don't merge at end. More... | |
SplitRootName | |
Instead of generating temporary names for split PDF files, use this as a root name, and add an integer suffix to file. More... | |
StripPI | |
More... | |
SubReport | |
This property is used on toxslfo and tohtml to indicate they are being fetched as sub-reports. More... | |
SuppressExcelHeaders | |
More... | |
TableAltColor | |
More... | |
TimeOut | |
More... | |
TooLongText | |
More... | |
UseHTML5 | |
Set to true in order to generate HTML5 regardless of browser support. More... | |
UseRawIOForXML | |
UseRawIOForXML - set to 1 to use RawIO in XML output, otherwise use translation tables. More... | |
UseSemaphore | |
Set to true to cause ZEN Report to control going to RenderServer with Semaphore. More... | |
XsltVersion | |
More... | |
getxmlstylesheet | |
More... | |
isHTML5 | |
More... | |
isServer | |
More... | |
toexcelstream | |
More... | |
tohtmlstream | |
More... | |
toxslfostream | |
More... | |
xmlfile | |
xmlfile generated by ZEN Report More... | |
xmlstream | |
More... | |
xmlstylesheet | |
More... | |
xmlstylesheetarg | |
More... | |
Static Public Attributes | |
APPLICATION = None | |
This is the class name of this application this report belongs to. More... | |
REPORTNAME = None | |
This is the logical name of this report. More... | |
![]() | |
CAPTION = None | |
Optional name used by the Form Wizard for a class when generating forms. More... | |
JAVATYPE = None | |
The Java type to be used when exported. | |
PROPERTYVALIDATION = None | |
This parameter controls the default validation behavior for the object. More... | |
![]() | |
CHARSET = None | |
The <CLASS>CSP.Page</CLASS> object serves as an event handler for CSP requests. More... | |
CONTENTTYPE = None | |
Specifies the default content type for the page. More... | |
CONVERTINPUTSTREAM = None | |
Specifies if input request.Content or request.MimeData values are converted from their. More... | |
CSPFILE = None | |
If this page was compiled from a .csp file, then this parameter contains the. More... | |
CSPSTRICT = None | |
The CSPSTRICT parameter is set to 1, if the DOCTYPE indicates that this. More... | |
CSPURL = None | |
This parameter is used to make sure that if multiple. More... | |
CSPXHTML = None | |
The CSPXHTML parameter is set to 1, if the DOCTYPE indicates that this. More... | |
DOMAIN = None | |
The default domain for csp:text, span and div tags. More... | |
ENCODED = None | |
Controls how the query parameters for this page are passed, it can. More... | |
ERRORPAGE = None | |
Specify a custom error page to call if there are any problems with generating this page. More... | |
EXPIRES = None | |
Specified the default value for the response.Expires. More... | |
NOCHARSETCONVERT = None | |
Specifies if we wish to turn off charset conversion for this page. More... | |
PAGETIMING = None | |
If this parameter is true then we automatically record timing statistics of how long it takes to. More... | |
PRIVATE = None | |
Controls the access to the page, it can be set to one of the following: More... | |
SECURITYRESOURCE = None | |
This is a comma-delimited list of system Resources and associated. More... | |
TIMINGSLOTS = None | |
Used by the timing to decide how many slots a day should be divided up into. More... | |
UseSession = None | |
This parameter controls the CSP session support. More... | |
![]() | |
DYNAMICPROPERTIES = None | |
This is class is used to add support for the DataModel interface to a persistent class. More... | |
![]() | |
DOMAIN = None | |
This class is used to implement the Model portion of the Zen Model-View-Controller mechanism. More... | |
DYNAMICPROPERTIES = None | |
If true (the default), then this dataModel class supports dynamic properties: More... | |
![]() | |
READONLYMODEL = None | |
This is the abstract base class used by all model classes within the Zen Model-View-Controller mechanism. More... | |
Private Member Functions | |
_.Library.Status | OnAfterReport () |
This callback is invoked after this report is run. More... | |
_.Library.Status | OnBeforeReport () |
This callback is invoked after this report is instantiated. More... | |
OnReportTag () | |
Notification that we are writing out the attributes for the opening tag. | |
_.Library.Status | OnSubmit (_.ZEN.Submit pSubmit) |
If defined, this callback is called when a form connected to this. More... | |
Static Private Member Functions | |
_.ZEN.Component.object | GetComponentById (_.Library.String id) |
Server-only method for finding a ZEN Report Display node within this. More... | |
_.Library.Boolean | OnPreHTTP () |
Event handler for PreHTTP event: this is invoked before. More... | |
_.Library.String | ResolveText (_.Library.String pText, context) |
Resolve a localized text string at run time. More... | |
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.
|
staticprivate |
|
private |
This callback is invoked after this report is run.
and before it is closed.
|
private |
This callback is invoked after this report is instantiated.
and before it is run.
|
staticprivate |
Event handler for PreHTTP event: this is invoked before.
the HTTP headers for a CSP page have been sent. All changes to the <class>CSP.Response</class> class, such as adding cookies, HTTP headers, setting the content type etc. must be made from within the OnPreHTTP() method. Also changes to the state of the CSP application such as changing session.EndSession or session.AppTimeout must be made within the OnPreHTTP() method. It is prefered that changes to session.Preserve are also made in the OnPreHTTP() method as this is more efficient, although it is supported in any section of the page. Return 0 to prevent <method>OnPage</method> from being called.
Reimplemented from Page.
Reimplemented in WorksheetPDF, MDXPDF, and ChartPDF.
|
private |
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.
Reimplemented from ObjectDataModel.
|
staticprivate |
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")
_.Library.Status AsynchGenerateReport | ( | _.Library.String | renderServer, |
_.Library.String | xmlfile, | ||
_.Library.String | xsltfile, | ||
_.Library.String | pdffile, | ||
_.Library.String | lockfile | ||
) |
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
when the lockfile exists theQueuing Hot JVM Server has created the pdf file
_.Library.Status GenerateReport | ( | _.Library.String | outputfile, |
_.Library.Integer | mode, | ||
_.Library.Boolean | log, | ||
_.Library.String | renderServer, | ||
_.Library.String | ExcelMode, | ||
_.Library.String | pStr, | ||
_.Library.Integer | RenderDirect | ||
) |
Generate the report and save it to outputfile.
Choices for mode are:
If log is true, the log file is returned instead of the report
Reimplemented in dataPresenter.
_.Library.Status GenerateReportToStream | ( | _.Stream.Object | stream, |
_.Library.Integer | mode, | ||
_.Library.Boolean | log | ||
) |
Generate the report and save it to stream.
Choices for mode are:
If log is true, the log file is returned instead of the report
|
static |
Generate the report and save it to outputfile.
Choices for mode are:
If log is true, the log file is returned instead of the report This is a class method wrapper for the <method>GenerateReport</method> method provided for convenience.
|
static |
PreHTTP handler.
Sets content-type and content-dispositon depending on $MODE and $LOG
Reimplemented from Page.
Reimplemented in WorksheetPDF, MDXPDF, and ChartPDF.
|
static |
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 <class>ZEN.Report.defaultApplication</class> is the source of ZEN Report parameters.
|
static |
This is the logical name of this report.
If not provided, class name is used.
AggregatesIgnoreNLS |
Aggregates Ignore NLS if this is true.
CheckPDFNotZeroLength |
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)
CountRepeatingElement |
Datasource |
See the DATASOURCE parameter for details.
DefaultFontFaceCopyHTML |
Used on item when copyhtml="true" to specify a default font face.
DefaultFontSizeCopyHTML |
Used on item when copyhtml="true" to specify a default font size.
specifies ExcelServer port of ExcelServer which renders Excel spreadsheets
Can be overriden by $EXCELSERVER on URL
ExcelServerTimeOut |
-1 for ExcelServerTimeOut means never timeout.
The units are seconds.
FileLifeTime |
Specify file life time, when life time exceeded, purge task will delete it.
MainReport |
Mode |
Specify report mode.
NamespaceDeclarations |
OldBehaviorLineFeedOnBreak |
Old behavior of linefeedOnBreak, where for PDF we issue <fo:block/> not a line feed.
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
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.)
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
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)
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
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
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
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
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
OptionNoComplexScript |
For Fop only, disable complex script features when true or 1
Here is FOP option
-nocs disable complex script features
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
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
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
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
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
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
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
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
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
PDFMergeMemSize |
Specify amount of memory used by SAXON processing (especially used when XSLTVERSION=2.0), defaults to 512m.
PS |
Postscript Printer or Printer used by pdfprint/PrintServer.
specifies PrintServer port of PrintServer which prints PDFs
Can be overriden by $PRINTSERVER on URL
PrintTimeOut |
-1 for PrintTimeOut means never timeout.
The units are seconds.
RenderDirectlyOnTimeout |
if we do not render directly to Render Server in RENDERTIMEOUT, Zen Reports renders directly, spawing new JVM
RenderTimeOut |
-1 for RenderTimeOut means never timeout.
The units are seconds.
RepeatingElement |
ReportDir |
ReportXMLNameSpace |
ReportXMLNameSpacePrefix |
SaxMemSize |
Specify amount of memory used by SAXON processing (especially used when XSLTVERSION=2.0), defaults to 512m.
SetProcessWideRunTimeMode |
SplitDir |
This is directory where PDF files produced by split will go.
SplitOnly |
If SPLITANDMERGE set, split only, don't merge at end.
SplitRootName |
Instead of generating temporary names for split PDF files, use this as a root name, and add an integer suffix to file.
StripPI |
SubReport |
This property is used on toxslfo and tohtml to indicate they are being fetched as sub-reports.
SuppressExcelHeaders |
TableAltColor |
TimeOut |
TooLongText |
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
UseRawIOForXML |
UseRawIOForXML - set to 1 to use RawIO in XML output, otherwise use translation tables.
UseSemaphore |
Set to true to cause ZEN Report to control going to RenderServer with Semaphore.
XsltVersion |
getxmlstylesheet |
isHTML5 |
isServer |
toexcelstream |
tohtmlstream |
toxslfostream |
xmlstream |
xmlstylesheet |
xmlstylesheetarg |