Java servlets reference
Table 3‑11 lists and describes the Information Console Java servlets.
Table 3‑11 Actuate Information Console servlets
Information Console servlet
Description
DownloadFile servlet
Downloads a file from the volume
Interactive Viewer servlet
Displays a BIRT report document
IDP User Password servlet
Displays a shibboleth-compliant login form
This section provides the detailed reference for Information Console servlets.
DownloadFile servlet
Downloads a file from the volume.
Name
com.actuate.reportcast.servlets.FileDownloadServlet
Invoke the DownloadFile servlet as:
http://<web server>:<port>/<context root>/servlet/DownloadFile
URI parameters
Table 3‑12 lists and describes the URI parameters for the DownloadFile servlet.
Table 3‑12 Parameters for DownloadFile URI 
URI parameter
Description
fileId
The unique identifier of an object, usually retrieved with the selectFilesFolders JSP tag.
name
The name of the object to download.
showDownloadDialog
If true, a download prompt appears before moving a copy of the file. Otherwise, the servlet displays the file in the browser.
version
If name is specified, the version number of the object to view. If version is not specified, the latest version is retrieved.
Interactive Viewer servlet
Displays an Actuate BIRT report document with tools to affect the document and design files. The viewer has two modes, standard and interactive.
The Standard Viewer displays the report with toolbar options to save, print, show the TOC, and launch interactive mode, as shown in Figure 3‑4.
Figure 3‑4 Standard Viewer
The Interactive Viewer displays the report with toolbar options to navigate the report and provides context menus to edit and format report elements, as shown in Figure 3‑5.
Figure 3‑5 Interactive Viewer
Name
com.actuate.iv.servlet.IVServlet
Invoke the Interactive Viewer servlet as:
http://<web server>:<port>/<context root>/iv
URI parameters
Table 3‑13 lists and describes the URI parameters for the Interactive Viewer servlet.
Table 3‑13 Parameters for IV URI
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: MS Excel
*doc: MS Word
*ppt: MS PowerPoint
*ps: PostScript
*html: HTML
*flashchartsxml, flashgadgetsxml: used to display a fusion chart
*reportlet: 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.
*actuateSize: Change the page size to fit the content.
*fitToWholePage: Change the content size to fit the page size.
Used with the __format parameter
__imageid
Name of the report file to display
__instanceid
Name of the report file to display
__launchiv
Boolean value that enables interactivity
__locale
Code for a locale
__page
A number for a page to render
__report
Name of the report file to display
__rtl
Name of the report file to display
repositoryType
The name of the object to download
serverURL
Contains the URL that accesses iHub, such as http://ESL02835:8000
userid
The user’s identifier, required to log in to BIRT iHub
volume
Contains a string value specifying the volume for this report
IDP User Password servlet
Displays a Shibboleth compliant login form used to log in to iHub 3, as shown in Figure 3‑6.
Figure 3‑6 IDP Login form
Name
edu.internet2.middleware.shibboleth.idp.authn.provider.UsernamePasswordLoginServlet
Invoke the IDP User Password servlet as:
http://<web server>:<port>/idp/Authn/UserPassword
URI parameters
Table 3‑13 lists and describes the URI parameters for the Interactive Viewer servlet.
Table 3‑14 Parameters for IDP Login URI 
URI parameter
Description
j_password
Name of the element of a report to display instead of the whole report file
j_username
The user’s identifier, required to log in to BIRT iHub