DownloadSearchResult servlet

Download search results from an Actuate e.report file in a specified format.

Name

com.actuate.reportcast.servlets.DownloadSearchResultServlet

Invoke the DownloadSearchResult servlet as:

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

URI parameters

Table 7-3 lists and describes the URI parameters for the DownloadSearchResult servlet.

Table 7-3  Parameters for DownloadSearchResult URI

URI parameter	Description
enableColumnHeaders	If True, the first row of the output includes the column headers and the subsequent rows hold the data. If enableColumnHeaders is False, the output has no header row.
format	The format in which to download the search results. Values are: n   Excel n   CSV n   TSV n   ANALYSIS The default value is CSV.
hits	The point at which downloading of results ends.
id	The unique identifier of an object, usually retrieved with the selectFilesFolders JSP tag.
name	The name of the object the contents of which to search. If you provide a value for id, this parameter has no effect.
outputName	The name of the output file. The extension of the file name depends on the value of format. The following list shows the extensions for the format values: n   Excel. File extension is .xls. n   CSV. File extension is .csv. n   TSV. File extension is .txt. If you provide a value for name, the name of the output file is the same as name and this parameter has no effect. If you provide a value for id, the default value for this parameter is output.

To define the values to include in the output, you provide additional parameters to the servlet. The parameters are the fully scoped names of the controls to download, in one of the following formats:

n	scope::controlName=* to select all values of a control.

n	scope::controlName=value to select only the specified value for a control. This format supports the range of operators and wildcard characters that search criteria in the Search window of the DHTML viewer support.

n	scope::controlName:select=true to download all values of a control when another control is filtered with a value or wildcard string.

Example

The following example downloads the data from two controls from a report. The search criteria filter the control ProductCodeControl in the OrderLineFrame frame to select only the values that begin with MR1 or MR3. All values for the control ProductDescControl in the same frame as a matching ProductCodeControl are also downloaded.

DownloadSearchResult?name=/eRDPro%20reports/SubReport.roi&format=csv&SubReportEx::OrderLineFrame::ProductCodeControl=MR1*,MR3*&SubReportEx::OrderLineFrame::ProductDescControl:select=true

(c) Copyright Actuate Corporation 2011