ViewPage servlet

Displays the contents of a specified report page or range of pages in a web browser for paginated reports or all viewable contents if the report is unpaginated.

The ViewPage servlet also manages the display of embedded objects. Embedded objects include:

n	Cascading style sheet (.css) files

n	Static objects, such as images

n	Dynamic objects, such as charts

The ViewPage servlet retrieves all the data for the report, including links to the view embedded objects servlet, which retrieves any embedded objects.

Name

com.actuate.reportcast.servlets.ViewPageServlet

Invoke the ViewPage servlet as follows:

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

URI parameters

Table 7-10 lists and describes the URI parameters for the ViewPage servlet.

Table 7-10 Parameters for ViewPage 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 the 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 viewPage 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

The character encoding specified by the user and required by the view service.

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.

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 appears as much like an Actuate report on an Excel spreadsheet 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	Reportlet—the report is extracted as a part of the an HTML page. This means that the customary <Head> and <body> tags are not present.

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.

locale

The client’s locale in which to generate the report.

mode

The page to which to navigate. Values are first, last, previous, and next. If mode is specified, page is ignored.

name

The name of the object the contents of which to view.

objectID

The ID of an object, usually retrieved with the selectFilesFolders JSP tag.

operation

The type of operation for the Actuate BIRT iServer to perform. Values are view or print. Default is view.

page

The object’s page to display. If mode is specified, page is ignored.

pageHeight

The printed page height in twips. Used only when format=PDF and splitOversizePages=1. This page height overrides the report’s page height and any page splitting rules in the report.

pageWidth

The printed page width in twips. Used only when format=PDF and splitOversizePages=1. This page width overrides the report’s page width and any page splitting rules in the report.

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.

range

The range of pages to retrieve from the object and display in a specified output file format. Separate pages and page ranges with commas, such as 1-3, 15, 21-25.

reportletMaxHeight

Specifies the maximum height for Reportlets, measured in points.

scalingFactor

The scale at which to view an object, such as scalingFactor=100.

searchList

The list of name-value pairs that uniquely identify a page or pages containing components on which to search. The format is:

&<component name>=<value>
[&<component name> = <value>] …

where <component name> is the fully qualified name of the component on which the search condition is based. Do not enter the searchList parameter name. Enter only the component/value pairs. For example, titleframe::txtname:include=*.

searchList finds the first matching component in the report because it is a component-based search and not page-based. This means that it does not always return the page containing both the name and value, but the first section or component that matches the search criteria.

splitOversizePages

Split report pages to print on multiple sheets. Values are 0, the default, to not split and 1 to split. SplitOversizePages is ignored unless format=PDF. Use if the report’s page size is larger than the printer’s sheet size. For information about setting the output page size, see pageHeight and pageWidth in this section.

type

If the name option is specified, this value is the type of the object to view, such as ROI.

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.

Example

The following example displays page 1 of the report Msbargph.roi in DHTML format.

http://mycorp:8700/iportal/servlet/ViewPage?name=msbargph&type=ROI&format=DHTML&page=1