|
|
|
|
|
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.
|
|
|
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.
|
|
|
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.
|
|
|
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.
|
|
|
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.
|
|
|
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.
|
|
|
|
|
|
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.
|
|
|
Output file format. The ROI format of an e.report is always created first, and then converted to the specified format if that format is not ROI.
|
|
|
Output file format. The ROI format of an e.report is always created first, and then converted to the specified format if that format is not ROI. Optionally specify keeping the ROI output with the _ _keepROIIfSucceeded and _ _keepROIIfFailed options. Format values are:
|
n
|
ExcelData—an Excel spreadsheet format to use for basic tabular or listing report documents. The appearance can differ from the original report document. Do not use this format for a complicated report document. Potential issues in this format include images and graphs that do not appear, missing background colors for frames and flows, and imprecise component positioning.
|
Actuate Information Console truncates report documents in the ExcelData and ExcelDisplay formats if they exceed the Maximum Number of Pages Convertible To Excel parameter value.
|
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
Used with the _ _format parameter. Specifies whether to keep the ROI after successfully generating a non-ROI format. The default value is False, which deletes the ROI.
|
|
|
Used with the _ _format parameter. Specifies whether to keep the ROI if a non-ROI format is selected for report generation and the conversion step fails. The default value is False, which deletes ROI.
|
|
|
|
|
|
Specifies whether to notify users who have notification disabled. True sends notification and disregards user preferences. Default value is False.
|
|
|
|
|
|
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.
|
|
|
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.
|
|
|
|
|
|
|
|
|
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.
|
|
|
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.
|
|
|
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.
|
|
|
|
|
|
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.
|
|
|
|
|
|
|
|
|
|
|
|
_ _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 case-sensitive.
|
|
|
|
|
|
|
|
|
|
|
|
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.
|
|
|
|
