IRISLIB database
All Classes Namespaces Functions Variables Pages
defaultApplication Class Reference
Inheritance diagram for defaultApplication:
Collaboration diagram for defaultApplication:

Static Public Attributes

 AGGREGATESIGNORENLS = None
 The NLS processing for aggregates is ignored if this is true.
 
 AGGREGATETAG = None
 Used to tag aggregates in EXCEL mode.
 
 CONNECTTIMEOUT = None
 if we do not connect to the render server in the amount of time specified in this parameter
More...
 
 COUNTREPEATINGELEMENT = None
 If SPLITANDMERGE set, along with REPEATINGELEMENT and COUNTREPEATINGELEMENT then the XML file is split on the repeating element called. More...
 
 DATASOURCE = None
 If defined, this provides a reference to the external. More...
 
 DEFAULTFONTFACECOPYHTML = None
 Used on item when copyhtml="true" to specify a default font face.
 
 DEFAULTFONTSIZECOPYHTML = None
 Used on item when copyhtm="true" to specify a default font size.
 
 DEFAULTMODE = None
 Specifies the default display mode used for this report if. More...
 
 EMBEDXSL = None
 Specifies whether XSLT is embedded in XML, if it is we must use explicit namespaces for generated XML.
 
 ENCODING = None
 encoding value
 
 EXCELMULTISHEET = None
 If 1, input XML represents multiple Excel worksheets
More...
 
 EXCELSERVER = None
 specifies ExcelServer port of ExcelServer which renders Excel spreadsheets
More...
 
 EXCELSERVERTIMEOUT = None
 if we do not render to export to Excel through the excel server in the amount of time specified in this parameter
More...
 
 EXCELSTYLESHEET = None
 If defined, this provides a reference to the external. More...
 
 FILELIFETIME = None
 Life time of file, when exceeded Purge task may delete it.
 
 HTMLSTYLESHEET = None
 If defined, this provides a reference to the external. More...
 
 INDENT = None
 value of indent in xsl:output element More...
 
 NAMESPACEDECLARATIONS = None
 If provided, this is a string of XML namespace declarations. More...
 
 NLSIOTABLE = None
 This parameter controls the NLS table to use. More...
 
 OLDLINEFEEDONBREAK = None
 Old behavior of linefeedOnBreak, where for PDF we issue <fo:block/> not a line feed.
 
 OPTIONCACHEPATH = None
 For Fop only, specifies a file/directory path location for the font cache file with value in OptionCachePath
More...
 
 OPTIONCONSERVE = None
 For Fop only, enable memory-conservation policy (trades memory-consumption for disk I/O) when true or 1
More...
 
 OPTIONDPI = None
 For Fop only, target resolution in dots per inch (dpi) where xxx is a number with value in OptionDPI
More...
 
 OPTIONENABLEACCESSIBILITY = None
 For Fop only, enables accessibility features (Tagged PDF etc., default off) when true or 1
More...
 
 OPTIONFLUSH = None
 For Fop only, flushes the current font cache file when true or 1
More...
 
 OPTIONLANG = None
 For Fop only, the language to use for user information with value in OptionLang
More...
 
 OPTIONNOACCESSCONTENT = None
 For Fop only, PDF file will be encrypted without extract text and graphics permission when true or 1
More...
 
 OPTIONNOANNOTATIONS = None
 For Fop only, PDF file will be encrypted without edit annotation permission when true or 1
More...
 
 OPTIONNOASSEMBLEDOC = None
 For Fop only, PDF file will be encrypted without assemble the document permission when true or 1
More...
 
 OPTIONNOCOMPLEXSCRIPT = None
 For Fop only, disable complex script features when true or 1
More...
 
 OPTIONNOCOPY = None
 For Fop only, PDF file will be encrypted without copy content permission when true or 1
More...
 
 OPTIONNOEDIT = None
 For Fop only, PDF file will be encrypted without edit content permission when true or 1
More...
 
 OPTIONNOFILLINFORMS = None
 For Fop only, PDF file will be encrypted without fill in interactive form fields when true or 1
More...
 
 OPTIONNOPRINT = None
 For Fop only, PDF file will be encrypted without printing permission when true or 1
More...
 
 OPTIONNOPRINTHQ = None
 For Fop only, PDF file will be encrypted without print high quality permission when true or 1
More...
 
 OPTIONOWNERPASSWORD = None
 For Fop only, PDF file will be encrypted with value in OptionOwnerPassword
More...
 
 OPTIONPDFPROFILE = None
 For Fop only, PDF file will be generated with the specified profile with value in OptionPDFProfile
More...
 
 OPTIONRELAXED = None
 For Fop only, relaxed/less strict validation (where available) when true or 1
More...
 
 OPTIONUSERPASSWORD = None
 For Fop only, PDF file will be encrypted with value in OptionUserPassword
More...
 
 PDFMERGEMEMSIZE = None
 Specify amount of memory used by PDF Merge processing, defaults to 512m.
 
 PRESERVESPACE = None
 xsl:preserve-space elements value
 
 PRINTSERVER = None
 specifies PrintServer port of PrintServer which prints PDFs
More...
 
 PRINTTIMEOUT = None
 if we do not enqueue to print through the print server in the amount of time specified in this parameter
More...
 
 PS = None
 Postscript Printer or Printer used by pdfprint/PrintServer.
 
 REMOVENULLS = None
 If 1 (set) elements or attributes that contain only NULL are not generated. More...
 
 RENDERDIRECTLYONTIMEOUT = None
 if we do not render directly to Render Server in RENDERTIMEOUT, Zen Reports renders directly, spawing new JVM
 
 RENDERSERVER = None
 specifies whether we communicate with a render server to generate PDFs rather than directly generating them ourself
More...
 
 RENDERTIMEOUT = None
 if we do not render through the render server in the amount of time specified in this parameter
More...
 
 REPEATINGELEMENT = None
 If SPLITANDMERGE set, along with REPEATINGELEMENT and COUNTREPEATINGELEMENT then the XML file is split on the repeating element called. More...
 
 REPORTDIR = None
 This is the output directory when $REPORTNAME specified on URL.
 
 REPORTXMLNAMESPACE = None
 If provided, this is the XML namspace that will be used. More...
 
 REPORTXMLNAMESPACEPREFIX = None
 If provided, this is the XML namspace prefix that will be used. More...
 
 RESOURCE = None
 If defined, this is the name of a system Resource for which the current user must. More...
 
 SAXMEMSIZE = None
 Specify amount of memory used by SAXON processing (especially used when XSLTVERSION=2.0), defaults to 512m.
 
 SETPROCESSWIDERUNTIMEMODE = None
 Process wide runtime mode. More...
 
 SPLITANDMERGE = None
 If SPLITANDMERGE set, along with REPEATINGELEMENT and COUNTREPEATINGELEMENT then the XML file is split on the repeating element called. More...
 
 STRIPPI = None
 strip <?xml version="1.0" ?> processing instruction
 
 STRIPSPACE = None
 xsl:strip-space elements value
 
 STYLESHEETDEFAULTMODE = None
 Specifies the default display mode used for this report in the xml-stylesheet XML processing instruction if. More...
 
 SUPPORTMACROS = None
 If SUPPORTMACROS is 1 we canocalize the ZEN Report Definition and Display. More...
 
 TABLEALTCOLOR = None
 TABLEALTCOLOR provides a report-wide overridable setting for the table altcolor attribute.
 
 TIMEOUT = None
 Timeout on opening files.
 
 TOOLONGTEXT = None
 default value for item too-long-text if default is not none More...
 
 USEHTML5 = None
 Set to true in order to generate HTML5 regardless of browser support. More...
 
 USEINSTALLEDFOP = None
 If USEINSTALLEDFOP is set to 1 and ^SYS("zenreport") nodes have NOT been set. More...
 
 USEINSTANCEHOSTNAMEONRELATIVEURLS = None
 If true use instance host name (CSP Config/Default Parameters) on relative URLs in ZEN Report Display. More...
 
 USESEMAPHORE = None
 Use semaphore to control rendering to Render Server Port.
 
 USETEMPFILES = None
 Specifies whether XSLT stylesheet is written to temp file for HTML generation.
 
 USEURLDATASOURCE = None
 If true, this allows the datasource to be retrieved. More...
 
 XMLEVALUATEHELPER = None
 If defined, name of Helper class used to define evaluate function used in XSLT tranformation when processing XMLSTYLESHEET.
 
 XMLSTYLESHEET = None
 If defined, this provides a reference to the external. More...
 
 XSLFOSTYLESHEET = None
 If defined, this provides a reference to the external. More...
 
 XSLTMODE = None
 Specifies where XSLT processing is done when html generation occurs - on browser or server. More...
 
- Static Public Attributes inherited from RegisteredObject
 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...
 

Additional Inherited Members

- Public Member Functions inherited from RegisteredObject
_.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...
 

Member Data Documentation

◆ CONNECTTIMEOUT

CONNECTTIMEOUT = None
static

if we do not connect to the render server in the amount of time specified in this parameter

then we return an error from rendering
when this parameter is "" the default or -1, then we can potentially wait forever to connect
The units are seconds.

◆ COUNTREPEATINGELEMENT

COUNTREPEATINGELEMENT = None
static

If SPLITANDMERGE set, along with REPEATINGELEMENT and COUNTREPEATINGELEMENT then the XML file is split on the repeating element called.

REPEATINGELEMENT every COUNTREPEATINGELEMENT elements. REPEATINGELEMENT is an element right under root.

◆ DATASOURCE

DATASOURCE = None
static

If defined, this provides a reference to the external.

XML data to use in generating the report. If it is not provided, data will be generated from the ReportDefinition XData block.

◆ DEFAULTMODE

DEFAULTMODE = None
static

Specifies the default display mode used for this report if.

the URL parameter, $MODE, is not present.

◆ EXCELMULTISHEET

EXCELMULTISHEET = None
static

If 1, input XML represents multiple Excel worksheets

If 0, (the default), input XML represents single Excel worksheets

◆ EXCELSERVER

EXCELSERVER = None
static

specifies ExcelServer port of ExcelServer which renders Excel spreadsheets

Can be overriden by $EXCELSERVER on URL

◆ EXCELSERVERTIMEOUT

EXCELSERVERTIMEOUT = None
static

if we do not render to export to Excel through the excel server in the amount of time specified in this parameter

then we return an error from Excel export
when this parameter is "" the default or -1, then we can potentially wait forever to print
The units are seconds.

◆ EXCELSTYLESHEET

EXCELSTYLESHEET = None
static

If defined, this provides a reference to the external.

stylesheet to use in generating the EXCEL spreadsheet. If it is not provided, a stylesheet will be generated from the Excel XData block.

◆ HTMLSTYLESHEET

HTMLSTYLESHEET = None
static

If defined, this provides a reference to the external.

stylesheet to use in generating the HTML report. If it is not provided, a stylesheet will be generated from the ReportDisplay XData block.

◆ INDENT

INDENT = None
static

value of indent in xsl:output element

default is yes

◆ NAMESPACEDECLARATIONS

NAMESPACEDECLARATIONS = None
static

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.

◆ NLSIOTABLE

NLSIOTABLE = None
static

This parameter controls the NLS table to use.

when streaming characters to the browser for HTML display. The default value is "RAW"

◆ OPTIONCACHEPATH

OPTIONCACHEPATH = None
static

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

OPTIONCONSERVE = None
static

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

OPTIONDPI = None
static

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

OPTIONENABLEACCESSIBILITY = None
static

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

OPTIONFLUSH = None
static

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

OPTIONLANG = None
static

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

OPTIONNOACCESSCONTENT = None
static

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

OPTIONNOANNOTATIONS = None
static

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

OPTIONNOASSEMBLEDOC = None
static

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

OPTIONNOCOMPLEXSCRIPT = None
static

For Fop only, disable complex script features when true or 1

Here is FOP option
-nocs disable complex script features

◆ OPTIONNOCOPY

OPTIONNOCOPY = None
static

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

OPTIONNOEDIT = None
static

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

OPTIONNOFILLINFORMS = None
static

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

OPTIONNOPRINT = None
static

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

OPTIONNOPRINTHQ = None
static

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

OPTIONOWNERPASSWORD = None
static

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

OPTIONPDFPROFILE = None
static

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

OPTIONRELAXED = None
static

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

OPTIONUSERPASSWORD = None
static

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

◆ PRINTSERVER

PRINTSERVER = None
static

specifies PrintServer port of PrintServer which prints PDFs

Can be overriden by $PRINTSERVER on URL

◆ PRINTTIMEOUT

PRINTTIMEOUT = None
static

if we do not enqueue to print through the print server in the amount of time specified in this parameter

then we return an error from printing
when this parameter is "" the default or -1, then we can potentially wait forever to print
The units are seconds.

◆ REMOVENULLS

REMOVENULLS = None
static

If 1 (set) elements or attributes that contain only NULL are not generated.

The default is 0 to preserve past ZEN Report identification of null with empty string, so as not to break existing reports

◆ RENDERSERVER

RENDERSERVER = None
static

specifies whether we communicate with a render server to generate PDFs rather than directly generating them ourself

Can be overriden by $RENDERSERVER on URL

◆ RENDERTIMEOUT

RENDERTIMEOUT = None
static

if we do not render through the render server in the amount of time specified in this parameter

then we return an error from rendering
when this parameter is "" the default or -1, then we can potentially wait forever to render
The units are seconds.

◆ REPEATINGELEMENT

REPEATINGELEMENT = None
static

If SPLITANDMERGE set, along with REPEATINGELEMENT and COUNTREPEATINGELEMENT then the XML file is split on the repeating element called.

REPEATINGELEMENT every COUNTREPEATINGELEMENT elements. REPEATINGELEMENT is an element right under root.

◆ REPORTXMLNAMESPACE

REPORTXMLNAMESPACE = None
static

If provided, this is the XML namspace that will be used.

for the generated XML report.

◆ REPORTXMLNAMESPACEPREFIX

REPORTXMLNAMESPACEPREFIX = None
static

If provided, this is the XML namspace prefix that will be used.

for the generated XML report.

◆ RESOURCE

RESOURCE = None
static

If defined, this is the name of a system Resource for which the current user must.

hold the USE privilege in order to view this page or to invoke any of its server-side methods from the client.
Optionally, this can contain a comma-delimited list of several resource names. In this case, the user must hold the USE privilege on at least one of the resources in the list.

◆ SETPROCESSWIDERUNTIMEMODE

SETPROCESSWIDERUNTIMEMODE = None
static

Process wide runtime mode.

Set on a sql statement from the runtime mode passed into the ZEN Report if this is 1

◆ SPLITANDMERGE

SPLITANDMERGE = None
static

If SPLITANDMERGE set, along with REPEATINGELEMENT and COUNTREPEATINGELEMENT then the XML file is split on the repeating element called.

REPEATINGELEMENT every COUNTREPEATINGELEMENT elements. REPEATINGELEMENT is an element right under root element. Let <R>...</R> be the repeating element.
Then to the renderer the XML file looks like <root>(<R>...</R>)*</root>, 0 or more repetitions of the element <R>...</R>.
The XML file can contain other sibling elements to <R> as long as they are NOT mentioned in the Report Display.

◆ STYLESHEETDEFAULTMODE

STYLESHEETDEFAULTMODE = None
static

Specifies the default display mode used for this report in the xml-stylesheet XML processing instruction if.

the URL parameter, $MODE, is not present.

◆ SUPPORTMACROS

SUPPORTMACROS = None
static

If SUPPORTMACROS is 1 we canocalize the ZEN Report Definition and Display.

replacing all single-quoted attributes by double-quoted attributes Also we allow macros through the macrodef element <macrodef class="classname" xdata="xdataname"/>

◆ TOOLONGTEXT

TOOLONGTEXT = None
static

default value for item too-long-text if default is not none

possible values are truncate and wrap

◆ USEHTML5

USEHTML5 = None
static

Set to true in order to generate HTML5 regardless of browser support.

Set to fale in order to not generate HTML5 regardless of browser support

◆ USEINSTALLEDFOP

USEINSTALLEDFOP = None
static

If USEINSTALLEDFOP is set to 1 and ^SYS("zenreport") nodes have NOT been set.

then use the FOP that comes installed with InterSystems IRIS for all XSLT transformations for generating HTML and PDF

◆ USEINSTANCEHOSTNAMEONRELATIVEURLS

USEINSTANCEHOSTNAMEONRELATIVEURLS = None
static

If true use instance host name (CSP Config/Default Parameters) on relative URLs in ZEN Report Display.

when generating PDFs or XSLFO

◆ USEURLDATASOURCE

USEURLDATASOURCE = None
static

If true, this allows the datasource to be retrieved.

from a URL specified at runtime using the $DATASOURCE URL Parameter. If false, the $DATASOURCE URL parameter will be ignored.

◆ XMLSTYLESHEET

XMLSTYLESHEET = None
static

If defined, this provides a reference to the external.

stylesheet to use in generating the XML. If it is not provided, the XML will not first be XSLT transformed.

◆ XSLFOSTYLESHEET

XSLFOSTYLESHEET = None
static

If defined, this provides a reference to the external.

stylesheet to use in generating the XSL-FO (PDF) report. If it is not provided, a stylesheet will be generated from the ReportDisplay XData block.

◆ XSLTMODE

XSLTMODE = None
static

Specifies where XSLT processing is done when html generation occurs - on browser or server.

when the URL parameter, $XSLT, is not present.