The BIRT Viewer is a Java servlet that manages binary content and performs tasks such as uploading and downloading binary files. Invoke the BIRT Viewer servlet using the following syntax:
application server is the name of the machine hosting the application server.
port is the port on which the application server listens for requests.
context root is the Java Components context root.
iv is the name to which the servlet is mapped in the web application’s web.xml file. A typical location for web.xml is <context root>\WEB-INF\web.xml.
Servlet names are case‑sensitive. Do not modify the servlets, their names, or their mapping in web.xml.
Actuate BIRT Viewer fully supports the URIs for the open-source BIRT Viewer. After migrating from open-source BIRT to Actuate BIRT, you can use the same URIs in the Actuate BIRT Viewer that you used in open-source BIRT.
BIRT Viewer
The BIRT Viewer servlet provides tools to display and affect BIRT document and design files. This servlet provides both the BIRT Viewer and the BIRT Interactive Viewer. The Interactive Viewer is licensed separately from the BIRT Viewer. To create a link using the URL provided by the Link to this page menu item in the viewer, the HTML page containing the link must use a strict Document Type Definition (DTD). To use the strict DTD, use the following code at the beginning of the HTML page markup:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
The BIRT Viewer provides navigation toolbar options, as shown in Figure 5‑9.
Figure 5‑9 BIRT Viewer
The Interactive Viewer displays the report with toolbar options to navigate the report, a menu to perform additional tasks, and provides context menus to edit and format report elements, as shown in Figure 5‑10.
Figure 5‑10 BIRT Interactive Viewer
The BIRT Viewer servlet supports rptdocument file formats. When an rptdesign files runs, a rptdocument file is generated and displays in the BIRT Viewer.
Name
com.actuate.iv.servlet.IVServlet
URI parameters
Table 5‑1 lists and describes the URI parameters for the Interactive Viewer servlet.
Table 5‑1 IVServlet URI parameters
URI parameter
Description
_ _bookmark
Name of the element of a report to display instead of the whole report file.
_ _floatingfooter
Boolean value to add a margin under the footer.
_ _format
A format for the displayed report:
pdf: Adobe PDF
xls: Microsoft Excel
doc: Microsoft Word
ppt: Microsoft PowerPoint
ps: PostScript
html: HTML
flashchartsxml: used to display a fusion chart
flashgadgetsxml: used to display Flash gadgets in a fusion chart.
reportlet: This is used together with _ _bookmark to show a particular part/element of the report.
_ _from_page_range
The page range of a report to display.
_ _from_page_style
The page style to use for a report in pdf or ps formats:
auto: The page size and content size remains the same.
actualSize: Change the page size to fit the content.
fitToWholePage: Change the content size to fit the page size.
Used with the _ _format parameter.
_ _imageid
Identifier of the report file image to display.
_ _instanceid
Identifier of the report file to display.
_ _launchiv
A Boolean value that enables interactivity.
_ _locale
Code for a locale. For example FR_fr specifies the French language and the country, France.
_ _page
The number of a page to render.
_ _report
Name of the report file to display.
_ _rtl
Boolean value that specifies right-to-left orientation for the report.
For example, to access the first version of the Top Sales Peformers.rptdocument from the local host, use a URI similar to the following:
application server is the name of the machine hosting the application server.
