view frame set page

Displays the e.report document along with the navigation bar in the browser. The following example displays the report document Msbargph.roi.

http://phish:8700/iportal/viewer/viewframeset.jsp

?name=/msbargph.roi;1&VolumeProfile=Seamore

Name

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

Parameters

Table 5-41 lists and describes the parameters for the view frame set page. The view frame set page also uses the common URI parameters.

Table 5-41  Parameters for view frame set URI

URI parameter	Description
;# - version	The report document’s version number is indicated by a semicolon and an integer immediately following the file name. For example, msbargph.roi;1 indicates version 1 of msbargph.roi. If version is not specified, the latest version of the report document is used.
connectionHandle	An identifier for temporary report documents only.
closeX	Determines whether the parent window that generated the viewframeset request is closed when viewframeset.jsp is closed. The default value is False, which does not close the parent window when this window is closed.
embSrvRequester	The prefix for an embedded object to retrieve the object from the report document. Embedded objects include hyperlinks, cascading style sheets, dynamic objects such as charts, and static objects such as images.
ID	The ID of the report document being searched.
mode	The page navigation mode. Values are First, Last, Previous, or Next.
name	The name of the report document to be viewed. This parameter is ignored if ID is also specified.
page	The page to view.
scalingFactor	The size of the report document in the browser, such as 100 (full size) or 50 (half size).
searchCriteria	The list of name-value pairs that uniquely identify a page or pages containing components on which to search. The format is: &<component name>=<value> [&<component name>=<value>] … where <component name> is the fully qualified name of the component on which the search condition is based. The & and = must be encoded to %26 and %3d. Do not enter the searchList parameter name; enter only the component/value pairs. For example, %26titleframe::txtname:include%3d*. searchCriteria finds the first matching component in the report document. Because the search is component-based search and not page-based, it returns the start of the section or component that matches the search criteria rather than the page showing those matching values.
showSearch	If True, shows the search frame the first time the page is accessed. The default is False.
showTOC	If True, shows the TOC the first time the URL is accessed. The default is False.
userAgent	The user’s browser, such as Mozilla/4.0.

Used by

iportal\activePortal\private\filesfolders\filefolderlistcontent.jsp

iportal\activePortal\viewer\viewdefault.jsp

iportal\activePortal\viewer\viewreport.jsp

(c) Copyright Actuate Corporation 2011