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 26‑6 lists the topics this chapter covers 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.
Name
<context root>\browsefile.do
Parameters
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.
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 26‑1.
Table 26‑12 Parameters for file or folder drop URI
URI parameter
Description
ID
The unique identifier of the object to delete.
name
The full path name of the 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 navigate to upon completion. The default redirect page is processedaction_status.
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 Visualization Platform 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.
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.
_ _archiveBeforeDelete
Indicate whether to archive the output objects of the current request before deleting them, according to _ _archivePolicy’s setting. Set this parameter to True to archive objects before deleting them. The default value is False. This parameter has no effect if _ _archivePolicy is set to Folder.
_ _archivePolicy
The archive policy to implement for the objects created as output for the current request. Values are folder, age, and date. Set to folder to use the archive policy that is already set for the folders to which the output is distributed. Set to age to delete objects older than a specific time period. Set to date to delete objects on a specific date.
_ _dateToDelete
The date on which to delete the output objects of the current request. Use only if _ _archivePolicy is set to Date. Set _ _dateToDelete to a date in a locale-specific format. The default format is mm/dd/yyyy.
_ _executableName
The name of the executable file for this request.
__format
Optional parameter that specifies the output format of the report. Visualization Platform appends a matching file extension to the outputName. Do not use a period in the value of this parameter. A period is inserted automatically before the file extension.
_ _headline
A descriptive tag line for a report document.
Appears on Channel Contents. Use the character string %20 to represent a space in the headline string.
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.
_ _isnull
Sets the value of the named parameter to null. Use a parameter name as input.
_ _jobName
The name of the job to execute.
_ _limit
Indicate whether to limit the number of versions of the output files for the current request. Set _ _limit to Limit to limit the number of versions. Any other value means that the number of versions is unlimited.
_ _limitNumber
The number of versions to which to limit the output files for the current request. Use only if _ _limit is set to Limit. _ _limitNumber can be any positive number.
_ _outputFolderType
Specifies the root of the output file name. Set to Absolute to use the full _ _outputName value starting from the volume’s root. Set to Personal to use the _ _outputName value relative to the user’s home folder.
_ _outputDocName
Specifies a name for the output file.
_ _overwrite
New to create a new version of this report document, or Old to overwrite an existing report document. New is the default.
_ _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.
_ _recurringDay
Specifies the scheduled recurring day on which to run the report job. Applies only to scheduled report jobs.
_ _saveOutput
Indicates whether to write the output document to the volume. True saves the output in the volume, applying the document archiving and file creation parameters. False does not save the output.
_ _serverURL
Contains the URI that accesses the JSP engine, such as http://<iHub machine name>:8700.
_ _timeToDelete
Specifies a time at which to delete an archived report document. Applies only scheduled report jobs.
_ _users
Contains the name of the user to notify of this scheduled request. You can notify more than one user. This parameter is valid only for scheduled jobs.
_ _versionName
Contains a string value for the new version name of this report document. The value can include a date/time expression enclosed in braces, { }, to ensure a unique version name.
_ _volume
Contains a string value specifying the volume for this report.
_ _wait
If "wait", Visualization Platform waits for the report generation to be completed before displaying it. If "nowait", Visualization Platform displays 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://127.0.0.1:8700/iportal/executereport.do? __requesttype=immediate&__executableName=%2fPublic%2fBIRT and BIRT Studio Examples%2fSales by Territory.rptdesign& userid=Administrator&__saveOutput=false&Territory="EMEA"& invokeSubmit=True
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:
¶meterA=&ParameterB=
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 26‑15 lists the valid filter operators and example of their syntax.
Table 26‑15 Filter operators
Operator
Description
Example
BETWEEN
Between an inclusive range
BETWEEN([COUNTRY],"AAA","BBB")
=
Equal to
([COUNTRY] = "AAA")
>
Greater than
([COUNTRY] > "AAA")
>=
Greater than or equal to
([COUNTRY] >= "AAA")
IN
Matches any value in a set of values
IN([COUNTRY],"China","USA")
<
Less than
([COUNTRY] < "AAA")
<=
Less than or equal
([COUNTRY] <= "AAA")
LIKE
Search for a pattern
LIKE([COUNTRY],"AAA")
MATCH
Matches a pattern
MATCH([COUNTRY],"A")
NOT(BETWEEN)
Not between an inclusive range
NOT(BETWEEN([COUNTRY],"AAA","BBB"))
<>
Not equal
([COUNTRY] <> "China")
NOT(IN)
Does not match any value in a set of values
NOT(IN([COUNTRY],"China","USA"))
NOT(LIKE)
Search for values that do not match a pattern
NOT(LIKE([COUNTRY]),"AAA"))
NOT(MATCH)
Does not match a pattern
NOT(MATCH([COUNTRY],"A"))
NOT(ISNULL)
Is not null
NOT(ISNULL([COUNTRY]))
ISNULL
Is null
ISNULL([COUNTRY])
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 Visualization Platform generated from multiple files.
file and folder index page
The default entry point to the Visualization Platform 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 Visualization Platform uses to format and present files and folders data. Page content varies depending on the Visualization Platform 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.
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.
Specifies whether to apply cbFail, cbSuccess, and filter to the current user session. applyFilter applies only to list pages, such as the completed jobs page.
cbFail
Specifies whether to list the failed jobs in the completed jobs page.
cbSuccess
Specifies whether to list the successful jobs in the completed jobs page.
channelName
Specifies the channel to which a job completion notice was sent. channelName applies only to the details page.
clearFilter
Clears the job name filter. clearFilter causes Visualization Platform to retrieve job names from session cookies and to ignore cbFail and cbSuccess. clearFilter applies only to list pages, such as the completed jobs page.
filter
Specifies the job name filter. filter applies only to list pages, such as the completed jobs page.
jobID
Specifies the unique job identifier. jobID applies only to the details page.
resetFilter
Resets all filters to their default values. The default filter values are no filtering for job name, and listing all completed jobs, whether failed or successful. resetFilter applies only to list pages, such as the completed jobs page.
subpage
Determines the content page. Possible values for subpage are:
_completed
_detail
_pending
_running
_scheduled
_completed is the default content page.
userName
Specifies the name of the user who received the completed job notice. userName applies only to the detail page.
Used by
Not applicable.
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. 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, Visualization Platform 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 Visualization Platform listing page. Users can specify a filter to choose the types of files to view.
The following are the sources that the file and folder list page uses to obtain the values for filters and the state of check boxes:
URI parameters. See the following parameters section.
Session attributes. Visualization Platform uses session cookies to store the values that a user specifies. If the user browses the Visualization Platform application, then returns to the listing page, the list page obtains the user’s values from the session cookie if cookies are enabled. If the user chooses another folder, that folder becomes the working folder, and the list page applies the same values that applied to the previous folder.
Table 26‑19 lists and describes the session attribute variables.
Table 26‑19 Session attribute variables
Session attribute
Description
AcFilesFoldersFilter
Contains the string specifying the files and folders viewing filter
AcFilesFoldersTypeFilter
Contains True if the user specified a filter, False otherwise
Table 26‑20 Parameters for file and folder list URI
URI parameter
Description
applyFilter
If True, apply filter. If False, filter not applied.
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.
showExecutables
If True, show all report executables. If False, do not show report executables. The default is True.
showFolders
If True, show all folders. If False, do not show folders. The default is True.
Used by
Not applicable.
login page
Displays the Visualization Platform login page for logging in to the Visualization Platform web application.
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 Visualization Platform session. The logout page gathers the user’s session information, clears it, and returns the user to the login page.
Contains the URI that accesses the Process Management Daemon, such as http://Server:8100.
user
The name of the user to log out. Either user or the common URI parameter authID must be specified. If authID is specified, user is ignored.
Used by
Not applicable.
myfiles page
Provides a container for the default dashboard display and the iHub Visualization Platform banner.
Name
<context root>\dashboard\jsp\myfiles.jsp
Used by
/iportal/activePortal/private/login.jsp
output page
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 26‑3.
Table 26‑23 lists and describes the parameters for the output page. The output page also uses the common URI parameters.
Table 26‑23 Parameters for output URI
URI parameter
Description
headline
Specifies the headline for the report.
ifExists
Specifies the file replacement policy. Values are Create and Replace. If ifExists is Create, Visualization Platform creates a new version. If ifExists is Replace, Visualization Platform replaces the existing version.
outputFolderType
Specifies the report output’s folder type. Values are personal and absolute. If outputFolderType is personal, the output is placed in the user’s personal folder. If outputFolderType is absolute, the user specifies the full path name for the output by either typing the path or using the Browse button.
The ping page tests whether a specific component of the reporting environment is operational, and optionally retrieves other diagnostic information about the component. You can test the following components of the reporting environment:
Visualization Platform itself
The Encyclopedia service
The Factory service
The Integration service
The Message Distribution service (MDS)
The View service
An Actuate open server driver
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:
18:03:23.100: MDS(seamore) forwarding Ping request to node seamore
18:03:23.100: EncycEngine(seamore) received Ping message
EncycEngine(seamore): Echoing 0 bytes of payload data
18:03:23.100: EncycEngine(seamore) replying to Ping message. Elapsed=0 ms
18:03:23.100: MDS(seamore) received Ping reply from node seamore. Roundtrip= 0 ms
18:03:23.100: MDS(seamore) replying to Ping message. Elapsed=0 ms
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.
Name
<context root>\ping.do
Parameters
Table 26‑24 lists and describes the parameters for the ping page. The ping page also uses the common URI parameters.
Table 26‑24 Parameters for ping URI
URI parameter
Description
action
Specifies the action to take at the destination. Valid values are:
Echo—Echoes data specified by the payloadSize parameter. Echo is the default action.
ReadFile—Opens a specified volume file, reads its content, and closes the file. Destination must be EE, FS, or VS.
WriteFile—Creates a temporary file at a storage location, writes a specified number of bytes, closes the file, and deletes it. Destination must be EE or FS.
Connect—Connects to a data source.
If you do not specify a value, the destination component responds to the request without taking any other actions.
destination
The reporting environment component to test. Valid values are:
AP (Visualization Platform)
MDS (Message Distribution service)
EE (Encyclopedia Engine)
FS (Factory service)
VS (View service)
AIS (Actuate Integration service)
AIS only supports the Echo action.
Except when AP is specified as destination, Visualization Platform sends a ping request to the iHub and passes on the destination as the ping request’s destination parameter.
The default value is AP.
filename
When action=ReadFile, this parameter is required to indicate the volume file to read. If you ping an open server driver, filename specifies the executable file to prepare for execution.
mode
Specifies the level of detail in the ping response. Valid values are:
Concise—Returns the elapsed time between a component’s receipt of the request and the time the component sends a reply.
Normal—Returns the names of components in the test path and the time stamps of the request entering and leaving each component. This is the default mode.
Trace—Returns a time stamp at times when the request enters and leaves major subcomponents of the component being tested. For example, a request to a node running the Encyclopedia service can provide a time stamp for times when the request enters and leaves the process queue.
A ping request at the trace level also can return diagnostic information other than timing. For example, a request to test writing a temporary file to a storage location can return the amount of free disk space in the storage location.
partitionName
Specifies the name of the storage location at which to create the temporary file. Used only if the value of action is WriteFile.
payloadSize
Length of payload string in number of characters that Visualization Platform should generate. Used only if the value of action is Echo.
processID
Specifies the process ID of the Factory or View service to test. Used with the server parameter.
server
Specifies which instance of a Factory service or View service to test. Works with the processID parameter. To test all available instance of the Factory or View service, use an asterisk (*).
If you do not specify server, the iHub load balancing mechanism allocates an available instance of the requested service to respond to the ping request.
Used by
Not applicable.
privileges page
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:
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.
Folder name to start the search from. The default is the current location, as shown in the breadcrumb.
searchFilter
The name to search for. Expressions and wildcards are allowed. For more information about search expressions, see Using Report Studio.
For example, the following Visualization Platform 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 26‑27 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.
Table 26‑27 Parameters for submit job URI
URI parameter
Description
_ _accessToGrant
Grants read or secure read privileges to those roles that have permission to view the report document. For users to view only the parts of the document matching an access control list (ACL), grant Secure Read access. Otherwise, grant Read access to enable users to view the whole document.
This parameter requires the _ _channels, _ _exclude, and invokeSubmit=true parameters, even if you use no value for them.
Use the _ _exclude parameter with this parameter to exclude specific users from getting the privilege.
Use the _ _channels parameter to grant read privileges to channels and notify them.
_ _ageDays
Used with _ _ageHours to determine how long output objects exist before they are 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 deleted. Use only if _ _archivePolicy is set to age. _ _ageHours can be any positive number.
_ _archiveBeforeDelete
Indicates whether to archive the output objects of the request before deleting them, according to _ _archivePolicy’s setting. Set this parameter to True to archive objects before deleting them. The default value is False.
This parameter has no effect if _ _archivePolicy is set to folder.
_ _archivePolicy
The archive policy to implement for the objects created as output for the request. Values are folder, age, and date. Set this parameter to folder to use the archive policy already set for the folders to which the output is distributed, to age to delete objects older than a specific time period, or to date to delete objects on a specific date.
_ _dateToDelete
The date on which to delete the output objects of the current request. Use only if _ _archivePolicy is set to date. _ _dateToDelete must be a date in a locale-specific format. The default format is mm/dd/yyyy.
_ _executableName
The name of the executable file for this request.
folderType
Specifies the destination folder type for the report. Absolute indicates the repository root folder, /. Personal indicates the current user’s home folder. Default is Personal.
_ _headline
A descriptive tag line for a report document.
Appears on the Channel Contents page. Use the character string %20 to represent spaces in the headline string.
_ _ifExists
Indicates whether to overwrite an existing or create a new file, up to an optional limit. Values are:
create—creates a new output file.
create[n]—creates a new output file up to n versions. For example, to create no more than seven versions, use create7.
replace—overwrite any existing output.
invokeSubmit
Controls whether the browser is redirected to the parameter screen or whether the report job is scheduled immediately. If True, the report job is scheduled without displaying the parameters. If False, the parameters are displayed. False is the default.
_ _jobName
The name for the job to submit.
notificationSupported
Specifies whether to notify users who have notification disabled. True sends notification and disregards user preferences. Default value is False.
notify
Activates e-mail notification for the job.
_ _onceDate
Required for once schedules.
Specify the date on which to run the report job, for report jobs with _ _scheduleType of once. Must be in the appropriate format for your locale, such as mm/dd/yyyy for the U.S. locale. The current date is the default.
_ _onceTime
Required for once schedules.
Specify the time at which to run the report job, for report jobs with _ _scheduleType of once. Must be in the appropriate format for your locale, such as “hh:mm a” for the U.S. locale. The current time is the default.
_ _outputName
Specifies a name for the report output document.
outputName
Specifies a name for the report output document for the e-mail notification.
outputFormat
Optional parameter that appends a file extension to the outputName. Do not use a period in the value of this parameter, a period is inserted automatically before the file extension.
postback
Forces the browser not to display parameters. Set to False to display parameters. Do not set postback to True with invokeSubmit also set to True.
_ _priority
Specifies the job submission priority. Values are a number from 1 to 1000, High (800), Medium (500), and Low (200). Do not use with _ _priorityValue.
_ _priorityValue
Specifies a number corresponding to the job submission priority. Do not use with _ _priority.
_ _progressive
Indicate 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. Applies only to run report jobs.
_ _recurringDay
Specifies the scheduled recurring day on which to run the report job. Applies only to scheduled report jobs.
_ _recurringTime
Required for recurring schedules.
Specify the time at which to run the report job. Set only if report jobs _ _scheduleType is recurring.
Must be in the appropriate format for your locale, such as hh:mm:ss for the U.S. (enu) locale.
_ _redirect
Specifies a relative or absolute URI to go to after do_executereport submits the report job. The default is Submittedjob_Status.
_ _schedulePeriod
Required for recurring schedules.
Specify how often to run the report job, and on which days. Choose a day of the week.
_ _schedulePeriod values are Every Day, Weekdays, Mondays, Tuesdays, Wednesdays, Thursdays, Fridays, Saturdays, Sundays, First Day of the Month, Last Day of the Month. All values are case‑sensitive.
Every Day or Weekdays. Set only if _ _scheduleType is recurring.
_ _scheduleType
Specify the type of schedule: immediate, once, or recurring. Immediate is the default.
_ _serverURL
Contains the URI that accesses the JSP engine, such as http://Services:8700.
_ _timeToDelete
Specifies a time at which to delete an archived report document. Applies only to scheduled report jobs.
_ _versionName
Contains a string value for the new version name of the job’s report document output. The value can include a date/time expression enclosed in braces, { }, to ensure a unique version name.
_ _volume
Contains a string value specifying the volume for the job’s report document output.
The submit job 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”). For a complete list of supported operators, refer to Table 26‑15.
For example, the following URL schedules the Sales By Territory.rptdesign report to run once on September 16, 2010 with the Territory run-time parameter set to Japan:
