search report page

Searches a report document based on criteria that the user specifies in the search form, obtains search results, and presents the results to the user in the browser.

Name

<context root>\iportal\activePortal\viewer\searchreport.jsp

Parameters

Table 5-39 lists and describes the parameters for the search report page. The search report page also uses the common URI parameters.

Table 5-39  Parameters for search report URI

URI parameter	Description
connectionHandle	An identifier for temporary report documents only.
enableColumnHeaders	Determines whether the search results include an initial record containing the names of the selected columns. Values are True to include the column headers in the search results, False to omit the headers. The default is True. This option applies only if format is CSV.
format	The format of the search data: XMLDisplay, CSV, and TAB. The report document encoding is used for the results file. If the report document encoding is UCS2, the CSV or TAB results file uses UTF8 encoding.
hits	The end value for the range for the search results.
ID	The ID of the report document to search.
name	The name of the report document to search. This parameter is ignored if objectID is also specified.
searchList	The search criteria. The format is: <class>[.<variable>][:include | :exclude]=[value] or <SearchTag>[:include | :exclude]=[value] Do not type the searchList parameter name. Type only search criteria value pairs. The search criteria components are: n   <class> is the fully qualified name of a component class, such as the control component class. If you are creating a searchReport URI to embed in a report document or web page, examine the report document’s ROD file in Actuate e.Report Designer Professional to determine the fully qualified name of the component class you wish to search on. n   <SearchTag> is the value of the SearchTag property, if specified in the component. To create a searchReport URI to embed in a report document or web page, examine the report document’s ROD file in Actuate e.Report Designer Professional to determine the SearchTag property of the component on which to search. If the component has a SearchTag, use the SearchTag not the component name. For more information about searching and SearchTags, see Developing Reports using e.Report Designer Professional.
	n   <value> is the value or value expression for which to search. If not specified, the search uses the empty string, "". Value expressions can include relational operators, logical operators, and metacharacters, such as <,>,!, *. If the value expression contains special characters (>, <, &, ;, @, #) or has one or more spaces at the beginning or end of the expression, enclose the expression in quotation marks. For example, the value expression, C3=">10" specifies a search for a string containing the characters ">10" not a search for all C3 values greater than 10. ContentField="6*" specifies a search for a string containing the characters "6*" not a search for all ContentField values beginning with the character 6. n   :include|:exclude are optional selection modifiers. These modifiers determine whether a specified select criterion, or component instance, is included in the search results. Specify :include to include the component instance in the search result. Specify :exclude to use the search criteria for the component class, but do not display the found instances. For example, if you build a URI with the select modifier EmpSal:exclude=>0, the search uses the value EmpSal > 0 as a select criterion, but does not return values for EmpSal in the search results. The modifier :include is the default.
startingPoint	The start value of the range for the search results.
type	The type of the object in which to search, such as ROI.
useQuoteDelimiter	Determines whether to enclose the search results in double quotes. True encloses each data item with double quotes in the search results, False does not. The default is True. Actuate ignores this option if format is not CSV.
version	The report document’s version number. If you do not specify a version, Actuate uses the latest version of the report document.

Used by

Not applicable.

(c) Copyright Actuate Corporation 2011