ReportDefinition

Use the ReportDefinition data type to define a report object. This is the object returned by the getReportDefinition() method.

Fields Provided by ReportDefinition

Field Description

boolean autoRun

True indicates that the report property Auto Run is turned on.

boolean cacheDocument

True indicates that the report property Enable document cache is turned on.

boolean controledByExtApp

Whether the report definition is controlled by an external application (true) or not (false).

String dataModelURL

The .xdm location from where to get the Data Model definition.

String defaultOutputFormat

The default output format.

Valid values include:

  • csv (CSV)

  • data (Data)

  • eText (eText template)

  • excel (Microsoft Excel)

  • excel2000 (Microsoft Excel 2000)

  • flash (Adobe Flash)

  • html (HTML)

  • mhtml (MIME HTML)

  • pdf (Adobe PDF)

  • ppt (Microsoft PowerPoint)

  • rtf (Rich Text Format)

String defaultTemplateId

The default template identified for the report.

boolean diagnostics

True indicates that diagnostics have been turned on for the report.

String ESSJobName

The ESS job name.

String ESSPackageName

The ESS package name. Used in conjunction with ESSJobName.

ArrayOfTemplateFormatsLabelValues listOfTemplateFormatsLabelValues

Passes the list of template format labels through the ArrayOfTemplateFormatsLabelValues data type. See ArrayOfTemplateFormatLabelValues.

boolean onLine

True indicates the property "Run report online" is turned on for the report.

boolean openLinkInNewWindow

True indicates the property "Open Links in New Window" is turned on for the report.

integer parameterColumns

The value of the report property "Parameters per line."

ArrayOfString parameterNames

Passes the parameter names defined for the report through the ArrayOfString data type. See ArrayOfString.

String reportDefnTitle

Inactive. Do not use.

String reportDescription

The user-assigned description of the report.

String reportName

The user-assigned name for the report.

ArrayOfParamNameValue reportParameterNameValues

Passes the report name-value pairs through the ArrayOfParamNameValue data type. See ArrayOfParamNameValue.

String reportType

Inactive. Do not use.

boolean showControls

True indicates the report property "Show controls" has been turned on.

boolean showReportLinks

True indicates the report property "Show report links" has been turned on.

ArrayOfString templateIds

Passes the layout names of the report templates through the ArrayOfString data type. See ArrayOfString.