getReportletData

Retrieves data to display in an Actuate eReport Reportlet. This tag sends the request to the Actuate BIRT iServer to get the Reportlet. Then it parses the response and writes the DHTML Reportlet to the JSP output stream. You access the height and width of the Reportlet by calling the getHeight( ) and getWidth( ) methods respectively.

Library

reportlet

Tag class

com.actuate.reportcast.tags.reportlet.GetReportletDataTag

Attributes

Table 8-15 lists and describes the attributes for getReportletData.

**Table 8-15** Attributes for getReportletData
Attribute	Required	Description
authID	Yes	The unique authentication identifier returned by Actuate BIRT iServer on successful login.
componentID	No	The identifier of the report component from which to retrieve Reportlet data. Specify either componentID, or componentName and componentValue.
componentName	No	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	No	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.
connectionHandle	No	The connection handle from the Actuate BIRT iServer.
embeddedObjPath	No	The path name of the servlet which retrieves embedded objects such as images for the Reportlet.
fileId	No	The report’s unique identifier.
hyperlinkRedirectPath	No	The path name of the servlet which handles Reportlet URLs. For example, iportal/servlet/GenericRedirector. The URLs are generated in the DHTML output, and hyperlinkRedirectPath is the base path for the generated URL.
locale	No	The Reportlet locale.
name	No	Reportlet source’s full Encyclopedia path name.
objectID	No	The getReportletData tag’s identifier.
reportletMaxheight	No	The Reportlet’s maximum height in points.
serverURL	Yes	The URL of the server on which the Reportlet’s source resides.
timeZone	Yes	The Reportlet server’s time zone.
useragent	No	The user’s browser, such as IE/5.5.
version	No	The version number for the Reportlet source.
volume	Yes	The Encyclopedia volume on which the Reportlet’s source resides.

Example

The following code retrieves a Reportlet from the Stock Comparison report in the Sample Application’s Customers folder. The Reportlet is retrieved from the ROD component NewReportApp::Frame2.

<reportlet:getReportletData authID="<%= sAuthID %>"

volume="<%= sVolume %>"

serverURL="<%= sServerURL %>"

locale="<%= acLocale %>"

timeZone="<%= tzTimeZone %>"

objectID="123"

name="/Customers/StockComparison.roi"

componentName="NewReportApp::Frame2"

componentValue="1"

reportletMaxheight="300"

version="1"

embeddedObjPath="../servlet/ViewEmbeddedObject?operation=" >

</reportlet:getReportletData>