This section provides the detailed reference for Actuate Java Components URIs. In the definitions, <context root> represents the name of your Actuate Java Components context root.
Table 5‑5 lists the topics this section covers and the file names discussed in each topic. All pages are under the Java Components context root.
Performs user authentication and maintains the user, cluster, and volume information authentication data during the user’s session. Pages that require validation of user credentials before permitting access to folders or files use the authenticate page. Java Components pages use the Struts framework for authentication.
Provides the banner that appears across the top of all Actuate Java Components web pages. The default banner displays the Actuate logo, user name, cluster name, and volume name, and provides links for Logout, Options, and Help. The banner page obtains the user name, cluster name, and volume name from variables maintained by the authenticate page.
Summarizes the result of a deletion performed by the drop page and indicates whether a file was successfully deleted. The delete file status page includes authenticate to obtain user session data. Java Components perform the deletion as part of an action and then forwards to the delete file status page.
Displays detailed information about the selected viewable folder or file. Users request file details by choosing the magnifying glass icon to the right of files listed on the folder page, or folder details by choosing the magnifying glass icon to the right of the folder name in the breadcrumb. Users can request another viewable document or delete the current file or folder from the file or folder detail page. filedetail.jsp uses the HTML code in <context root>\iportal\activePortal \private\filesfolders\filedetailcontent.jsp to display the information.
The unique identifier of the repository object to delete.
name
The full path name of the repository object to delete. Multiple name parameters, to delete more than one file or folder at a time, are allowed. This parameter is ignored if ID is also specified.
redirect
URI to which to redirect the job deletion page. The default redirect page is processedaction_status.
Used by
Not applicable
error page
Displays the specified error message. Java Components use two pages. All Java Components code uses <context root>\iportal\activePortal\private\common \errors\error.jsp.
When executing a report job or query, a Cancel button appears after a specified wait time passes. To change the time, set the EXECUTE_REPORT_WAIT_TIME configuration parameter in the appropriate Actuate Java Components configuration file.
For reports that accept run-time parameters, you can set the parameter in the URL by adding an ampersand (&), the parameter name, and an equal (=) sign, followed by the parameter value in quotes. The following URL illustrates running a BIRT report immediately with the Territory run-time parameter set to EMEA:
http://localhost:8080/iportal/executereport.do?__requesttype= immediate&__executableName=%2fPublic%2fBIRT and BIRT Studio Examples%2fSales by Territory.rptdesign&userid=Administrator &__saveOutput=false&Territory="EMEA"&invokeSubmit=true
The execute report page also accepts dynamic filter parameters for BIRT Reports in the URL, but the value of the parameter must form a complete expression, such as &Territory=([Territory] = ''EMEA'').
Use with _ _ageHours to determine how long output objects exist before they are automatically deleted. Use only if _ _archivePolicy is set to Age. _ _ageDays can be any positive number.
_ _ageHours
Use with _ _ageDays to determine how long output objects exist before they are automatically deleted. Use only if _ _archivePolicy is set to Age. _ _ageHours can be any positive number.
_ _executableName
The name of the executable file for this request.
invokeSubmit
Controls whether the browser is redirected to the parameter screen or whether the report job is run immediately. If true, the report job is executed without displaying the parameters. If false, the parameters are displayed. False is the default.
_ _outputDocName
The name and path of the resulting BIRT document. This parameter is only usable for BIRT reports when the BIRT_SAVE_REPORT_DOCUMENT_ENABLED parameter is set to true in web.xml.
If the given path is absolute, then executereport saves the report to that path. If the given path is relative, then executereport saves the report to the path set in the BIRT_SAVE_REPORT_DOCUMENT_PATH web.xml parameter.
_ _priority
Specifies the job submission priority. Values are High, Medium, and Low.
_ _priorityValue
Specifies a number ranging from 1 to 1000 and corresponding to the job submission priority. Only specify values allowed by your functionality level.
_ _progressive
Indicates whether to display the report document after it generates. If false, the report document displays after it generates. If true, the report document displays progressively, as it generates.
_ _serverURL
Contains the URI that accesses the JSP engine, such as http://Services:8000.
_ _wait
If "wait", Java Components wait for the report generation to be completed before displaying it. If "nowait", Java Components display the first page right away even if the report job is not completed.
For example, the following URL executes the Sales By Territory.rptdesign report immediately with the Territory run-time parameter set to EMEA:
http://localhost:8080/iportal/executereport.do? __requesttype=immediate&__executableName=%2fPublic%2fBIRT and BIRT Studio Examples%2fSales by Territory.rptdesign& userid=anonymous&__saveOutput=false&Territory="EMEA"& invokeSubmit=true
The following parameter names are reserved for internal use only by the execute report page:
doframe
inputfile
jobType
name
selectTab
Used by
Not applicable
index page
Provides the entry point and structure for the parts of Actuate Java Components generated from multiple files.
file and folder index page
The default entry point to the Deployment Kit web application. The file and folder index page provides the entry point and structure to support the Files and Folders functionality. The structure is a table that Deployment Kit uses to format and present files and folders data. Page content varies depending on the Actuate Java Components directive.
The file and folder index page uses the banner page to provide the reporting web page banner. filefolderlist.jsp uses the HTML code in <context root>\iportal \activePortal\private\filesfolders\filefolderlistcontent.jsp to display files and folders data.
Specifies a message to appear when Actuate Java Components call this page.
subpage
Specifies the content of the page. Possible values are:
_list: include list
_detail: include detail
Specifying any other value for subpage invokes the page not found page.
list page
Lists files in a container, such as a folder.
file and folder list page
Presents a list of objects that reside in the current working repository folder. Users request folder listings by choosing links on the reporting web page. The file and folder list page includes a filter section where users specify criteria for viewing report documents.
When users access a repository for the first time, Deployment Kit displays their home folder, if they have one, or the top folder in the repository. All files and folders in that folder that they have permission to view appear in the Actuate Java Components listing page. Users can specify a filter to choose the types of files to view.
If true, apply filter. If false, filter not applied. To use the showDocument, showExecutables, and showFolder parameters, applyFilter must be true.
filter
The filter specifying the file and folder names to list. Filter is a string. The default is "".
folder
The folder for which to list the contents. Folder name is a string. If no folder is specified, List uses the last working folder known for the session if cookies are enabled. If cookies are not enabled, List uses the user’s home folder as specified in the user settings.
onlyLatest
If true, show only the latest version of a file if multiple versions exist. If false, show all versions of a file if multiple versions exist. The default is false.
resetFilter
Any non-null value for resetFilter causes the filter to return to its original state. Users can reset the filter by choosing the Default button on the listing page.
showDocument
If true, show all viewable documents. If false, do not show viewable documents. The default is true. To use this parameter, applyFilter must be true.
showExecutables
If true, show all report executables. If false, do not show report executables. The default is true. To use this parameter, applyFilter must be true.
showFolders
If true, show all folders. If false, do not show folders. The default is true. To use this parameter, applyFilter must be true.
Used by
Not applicable
login page
Displays the Actuate Java Components login page for logging in to the Actuate Java Components web application. The login page includes the login page to display the Actuate Java Components application banner.
False to display the login page and true to display the destination page instead of the login page if the login is successful.
targetPage
Specify a relative URI to which login redirects the user on successful login. The default is the file and folder list page.
Used by
Not applicable
logout page
Ends the user’s Actuate Java Components session. The logout page gathers the user’s session information, clears it, and returns the user to the login page.
