execute report page
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.
Name
<context root>\executereport.do
Parameters
Table 25‑14 lists and describes the parameters for the execute report page. The execute report page also uses the common URI parameters.
Table 25‑14 Parameters for execute report URI
URI parameter
Description
_ _ageDays
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.
_ _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 Encyclopedia 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 Encyclopedia volume. True saves the output in the Encyclopedia 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:
&parameterA=&ParameterB=
The following parameter names are reserved for internal use only by the execute report page:
*doframe
*inputfile
*jobType
*name
*selectTab
Used by
Not applicable.