getTOC

Obtains the table of contents for a report from the server. It fetches the data in XML form, which is converted for display in the browser. The report is identified by its ID or name. Either the report ID or name attribute must be set.

Library

viewer

Tag class

com.actuate.reportcast.tags.viewer.GetTOCTag

Attributes

Table 8-16 lists and describes the attributes for getTOC.

Table 8-16  Attributes for getTOC

Attribute	Required	Description
authID	Yes	The unique authentication identifier returned by Actuate BIRT iServer on successful login.
connectionHandle	No	The view server connection handle from the Actuate BIRT iServer.
depth	No	The depth of the table of contents.
format	No	The table of contents’ format. XMLDisplay is the supported format.
id	No	The object’s unique identifier.
locale	Yes	The report’s locale, such as en_US, as in <context root>\Web-inf\localemap.xml.
name	No	The name of the object for which a table of contents is being built.
nodeId	No	The identifier specifying the starting point of the table of contents.
serverURL	Yes	The URL of the server on which the report resides, such as http://Services:9000.
timeZone	Yes	The report’s time zone as in <context root>\Web-inf\TimeZone.xml.
type	No	The type of object, such as ROI.
userAgent	No	The user’s browser, such as IE/5.5.
version	No	The report’s version. The latest version is used if no version is given.
volume	Yes	The report’s Encyclopedia volume.

Used in

<context root>\viewer\viewtoc.jsp

Example

The following example creates the table of contents for the Detail report:

<viewer:getToc name="Details.roi" type="roi" format="XMLDisplay"/>

(c) Copyright Actuate Corporation 2011