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. |