This section provides the detailed reference for Actuate application URIs. In the definitions, <context root> represents the name of your Actuate application context root, initially iportal. Table 19‑6 lists the general topics this chapter covers and the file names discussed in each topic. All pages are under the Actuate application context root.

Table 19‑7 lists the detail page topics and the file names discussed in each topic. All pages are under the Actuate application context root.

Table 19‑8 lists the drop page topics and the file names discussed in each topic. All pages are under the Actuate application context root.

Table 19‑9 lists the index page topics and the file names discussed in each topic. All pages are under the Actuate application context root.

Contains file and folder browsing functionality used by submit request pages.

workingFolder is the name of the folder for which to display contents in the folder browser window. The browse file page also uses the common URI parameters.

Creates a folder in the current volume. Createfolder.do uses <context root>
\iportal\activePortal\private\filesfolders\createfolder.jsp to create the folder.

Table 19‑10 lists and describes the parameters for the create folder page. The create folder page also uses the common URI parameters.

Provides the dashboard interface servlet for Information Console.

Table 19‑11 lists and describes the parameters for the dashboard interface servlet. This page also uses the common URI parameters.

For example, the following URL opens the dashboard with the title dashboard_1 that is located in the /Home/administrator folder. The parameter __launchDesigner is set to true and opens the dashboard for editing:

If no parameters are given, the URI opens the default dashboard of the user. For example:

A default dashboard is available when the dashboard URL is set in the user profile or a default dashboard is set for all users in the root folder of the volume.

Deletes the specified job, then redirects the page to a completion status page. Specify the name or the ID of the job to delete.

The default redirection JSP is
<context root>\iportal\activePortal\private\jobs\joboperationstatus.jsp.

Table 19‑12 lists and describes the parameters for the delete job page. The delete job page also uses the common URI parameters.

Deletes a job notice corresponding to a request. Specify the job notice by name or by ID.

The default redirection action forwards to
<context root>\iportal\activePortal\private\jobs\joboperationstatus.jsp.

Table 19‑13 lists and describes the parameters for the delete status page. The delete status page also uses the common URI parameters.

Displays detailed information about volume objects. There are three detail pages:

Provides a template error page that can be embedded in another page.

Displays detailed information about the selected viewable folder or file. Users request file or folder details by choosing the magnifying glass icon to the right of files or folders listed on the folder page or breadcrumb. Users can request another 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 file detail page lists information for a specified file, as shown in Figure 19‑1.

Table 19‑14 lists and describes the parameters for the file or folder detail page. The file or folder detail page also uses the common URI parameters.

Lists detailed request information for a specified job, as shown in Figure 19‑2.

getjobdetails.jsp uses the HTML code in <context root>\iportal\activePortal
\private\jobs\getjobdetailscontent.jsp to display the information.

The request detail page uses the common URI parameters, as shown in Table 19‑15.

Deletes one or more files or folders, or cancels a running job.

Deletes the specified file or folder.

Table 19‑16 lists and describes the parameters for the file or folder drop page. The file or folder drop page also uses the common URI parameters.

Cancels a running job.

Table 19‑17 lists and describes the parameters for the request drop page. The request drop page also uses the common URI parameters.

Displays the specified error message. Information Console uses two pages. All Information Console code uses <context root>\iportal\activePortal\private
\common\errors\error.jsp.

Submits a run report job request to the iHub. When executing a report job, a Cancel button appears after a specified wait time passes. Change the time by setting the EXECUTE_REPORT_WAIT_TIME configuration parameter in the appropriate Information Console 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.

Table 19‑18 lists and describes the parameters for the execute report page. The execute report page also uses the common URI parameters.

For example, the following URL executes the Sales By Territory.rptdesign report immediately with the Territory run-time parameter set to EMEA:

Set string parameters to an empty string by adding the parameter to the executereport.do URI with no value following the equal (=) sign. For example, the following line sets parameterA and parameterB to empty strings:

Dynamic filter parameters support a number of operators in the execute report URL. The syntax of a dynamic filter parameter is the same as other parameters, but the value is a function rather than a string value. Table 19‑19 lists the valid filter operators and example of their syntax.

The following parameter names are reserved for internal use only by the execute report page:

Provides the entry point and structure for the parts of Information Console generated from multiple files.

The default entry point to the Information Console 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 Information Console uses to format and present files and folders data. Page content varies depending on the Information Console directive.

The file and folder index page uses the browse file 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.

Table 19‑20 lists and describes the parameters for file and folder index page. The file and folder index page also uses the common URI parameters.

Provides the entry point and structure to support the submit job functionality.

Table 19‑21 describes the parameter for the new request index page. The new request index page also uses the common URI parameters.

Provides the outermost structure for the active request functionality. The
requests index page displays the side menu and banner elements, and the tabbed property sheets defined by tabs. selectjobs.jsp uses the HTML code in <context root>\iportal\activePortal\private\jobs\selectjobscontent.jsp to display request data.

Table 19‑22 lists and describes the parameters for the requests index page. The requests index page also uses the common URI parameters.

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. For example, users select check boxes to indicate whether they want to view only the last version of a report document or to see report executable files and report documents.

When users access a repository for the first time, Information Console 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 Information Console listing page. Users can specify a filter to choose the types of files to view.

Table 19‑23 lists and describes the session attribute variables.

Table 19‑24 lists and describes the parameters for the file and folder list page. The file and folder list page also uses the common URI parameters.

Displays the Information Console login page for logging in to the Information Console web application.

Table 19‑25 lists and describes the parameters for the login page. The login page also uses the common URI parameters.

Ends the user’s Information Console session. The logout page gathers the user’s session information, clears it, and returns the user to the login page.

Table 19‑26 lists and describes the parameters for the logout page. The logout page also uses the common parameters.

Provides a container for the default dashboard and Information Console banner.

Specifies report executable output data, such as the report headline and output file name. The output page appears only for scheduled report job and Run and Save report job submissions. Users access Output by choosing Save As. An output page looks like Figure 19‑3.

Table 19‑27 lists and describes the parameters for the output page. The output page also uses the common URI parameters.

Lists all jobs that are currently awaiting execution.

The pending page uses the common URI parameters.

If a component is not operational, iHub returns an error message. If a component is operational, the response depends on the ping page parameters. For example, you can request a simple time stamp that shows the time elapsed between the time that a component receives the request and the time that it returns a reply, as shown with the following URI:

which generates the following response:

You also can request more detailed information. A ping request to the MDS has no security restrictions. For all other components, the request is subject to volume authentication. The user must be a volume administrator or a user with the Operator security role.

Table 19‑28 lists and describes the parameters for the ping page. The ping page also uses the common URI parameters.

Assigns privileges to a file or folder. Filefoldersprivilege.do uses the HTML code in <context root>\iportal\activePortal\private\filesfolders\filefolderlist.jsp to set the privileges. The following URI displays the privilege page for the hotgraph report executable in the Training folder:

Table 19‑29 lists and describes the parameter for the privileges page. The privileges page also uses the common URI parameters.

Lists all jobs that were executing when the running page was last refreshed. The list is not live. To view the current list, the user must refresh the browser. Users access the running jobs list by choosing Running.

The running page looks like Figure 19‑4.

The running page uses the common URI parameters.

Lists all jobs that activate at a specified date and time but are not yet active.

The scheduled job page uses the common URI parameters.

Recursively searches from the current folder for files and folders whose names match the search string.

Table 19‑30 lists and describes the parameters for the search folders page. The search folders page also uses the common URI parameters.

For example, the following Information Console URL searches the current folder and all subfolders for files or folders whose names begin with the string Cust:

Submits a scheduled report job for a report executable to the server. There is no user interface to the submit job page. submitjobstatus.jsp uses the HTML code in <context root>\iportal\activePortal\private\newrequest
\submitjobstatuspage.jsp to display the new request information.

For reports that accept run-time parameters, set the parameter in the URL by adding an ampersand (&), the parameter name, and an equal (=) sign, followed by the parameter value in quotation marks.

Table 19‑31 lists and describes the parameters for the submit job page. The submit job page also uses the common URI parameters. All other parameters are passed to the report executable as report parameters. Report parameters are case‑sensitive. Specify them exactly as defined in the report design.

The submit job page also accepts dynamic filter parameters for BIRT Reports in the URL. The value of the parameter must form a complete expression, such as &Territory=([Territory] = "EMEA"). For a complete list of supported operators, refer to Table 19‑19.

For example, the following URL schedules the Sales By Territory.rptdesign report to run once on September 16, 2015 with the Territory run-time parameter set to Japan: