GetReportData servlet

Displays the contents of components in an Actuate e.report. Specify componentid of 0 (zero) to display the whole report. Specify component ID to display the data in a specific component. This servlet maps to the GetContent XML API.

Name

com.actuate.reportcast.servlets.GetReportDataServlet

Invoke the GetReportData servlet as:

http://<web server>:<port>/<context root>/servlet/GetReportData

URI parameters

Table 7-6 lists and describes the URI parameters for the GetReportData servlet.

Table 7-6  Parameters for GetReportData URI 

URI parameter	Description
componentID	The identifier of the report component from which to retrieve Reportlet data. Specify either componentID, or componentName and componentValue.
componentName	The name of the report component from which to retrieve Reportlet data. The componentName is the name of the component assigned in the ROD file, such as NewReport::Frame1. If componentName is not specified, the componentID is used. Use in conjunction with componentValue. Specify either componentName and optionally componentValue, or componentID.
componentValue	A value identifying the specific instance of the report component from which to retrieve Reportlet data. The value is the result of evaluating a search expression. Use componentValue in conjunction with componentName. Specify either componentName and componentValue, or componentID. If unspecified, componentValue defaults to the first report component specified by componentName that the user has access to.
converterParam	Used internally by the converter framework for low-level parameters needed to generate desired output.
embSrvRequester	The embSrvRequester parameter specifies a partial universal resource identifier (URI) to append to the base URI when inserting embedded objects. For example, adding “&embSrvRequester=/test/ViewEmbeddedObject’ to the getReportData URI results in src elements in the generated HTML document with the following path: SRC ="/test/ViewEmbeddedObject?...” Without the parameter, the src element in the generated HTML document is the default: SRC ="ViewEmbeddedObject?...”
encoding	Used by the view service. The character encoding as specified by the user.
format	The file format in which to generate output. Values are: n   DHTML—a compressed DHTML format that uses cascading style sheets (CSS). This is the default format. n   DHTMLLong—an uncompressed DHTML format. Use this format if your browsers do not support CSS. n   DHTMLRaw—an uncompressed DHTML format without external JavaScript references, leaving the bare report.
	n   ExcelData—a format mainly used for tabular or listing reports. The appearance sometimes is not faithful to the original report or does not work well for complicated reports. Potential issues include undisplayed images and graphs, ignored background color of frames and flows, and only rough accuracy for component positioning. n   ExcelDisplay—a format that resembles an Actuate report on an Excel spreadsheet as much as possible. Reports in the ExcelData and ExcelDisplay formats are truncated if they exceed Maximum Number of Pages Convertible To Excel. n   PDF—report output in Adobe Acrobat-readable Portable Document Format. n   RTF—report output in Rich Text Format. The report’s visual layout is similar to the DHTML viewer layout. n   RTFFullyEditable—report output in Rich Text Format, with more flexibility when manipulating output, such as the ability to move and delete several lines from a report at a time. Produces a larger RTF file than the RTF format. n   XMLDisplay—a complete XML representation of the report. It contains information about attributes of controls. n   XMLCompressedDisplay—the same as XML Display. The only difference is that it places all the common properties into a template. n   XMLData—can only be generated if the report design has it specified. It is a property on the controls in the Designer for setting XML properties.
locale	The client’s locale in which to generate the report.
name	The name of the object the contents of which to view. Include a file extension in the name or set the file type using the type parameter.
ID	The unique identifier of an object, either the file id, for scheduled or save jobs, or an object id, for run jobs.
operation	The type of operation for the Actuate BIRT iServer to perform. Values are view or print. Default is view.
PDFQuality	The image quality in a PDF file. Use only if format is set to PDF. The value ranges from 100, for the lowest image quality but the smallest PDF file size, to 300, for the highest image quality but the largest PDF file size. Specify a larger charting heap size before using higher PDFQuality values. The default PDFQuality is an Actuate BIRT iServer advanced configuration value.
reportletMaxHeight	Used by Reportlets. The maximum allowed height of Reportlets, measured in points.
scalingFactor	The scale at which to view the report, such as scalingFactor=100.
type	If the name parameter is specified, indicates the type of the object to view, such as ROI. GetReportData requires a type if the name parameter does not include a file extension.
userAgent	Used by the View service, such as Mozilla/4.0 (compatible; MSIE 5.01; Windows NT).
version	If name is specified, the version number of the object to view. If version is not specified, the latest version is retrieved.

(c) Copyright Actuate Corporation 2011