ScheduleRequest

The options to schedule a report.

Fields Provided by ScheduleRequest

Field	Description
boolean bookBindingOutputOption	Whether the book binding output is enabled (true) or not (false).
boolean compressDeliveryOutputOption	Whether the compress delivery output is enabled (true) or not (false).
String dataModelUrl	The location of the .xdm file from which to obtain the Data Model definition.
DeliveryChannels deliveryChannels	See DeliveryChannels.
boolean enableConsolidatedJobDiagnostic	Whether the consolidated job diagnostic is enabled (true) or not (false).
boolean enableDataEngineDiagnostic	Whether the data engine diagnostic is enabled (true) or not (false).
boolean enableReportProcessorDiagnostic	Whether the report processing diagnostic is enabled (true) or not (false).
boolean enableSQLExplainPlan	Whether the SQL Explain Plan generation is enabled (true) or not (false).
boolean enableXmlPruning	Whether the XML pruning is enabled (true) or not (false).
String endDate	The end date of the schedule.
String jobLocale	The locale to use for the scheduled requests. Example: fr-FR. Required when parameter values submitted for the scheduled job are not English.
String jobTZ	The time zone to use for the scheduled requests.
boolean mergeOutputOption	Whether the merge output option is enabled (true) or not (false).
String notificationPassword	The HTTP notification server password when scheduling notification through an HTTP server.
String notificationServer	The name of the HTTP server used for notification.
String notificationTo	E-mail addresses to which to send notifications.
String notificationUserName	The user name for the HTTP server used for notification.
boolean notifyHttpWhenFailed	True indicates to send a notification when the job request fails.
boolean notifyHttpWhenSkipped	Optional. Specify true to send an HTTP notification when a job is skipped. Default is false.
boolean notifyHttpWhenSuccess	True indicates to send a notification when the job request succeeds.
boolean notifyHttpWhenWarning	True indicates to send a notification when the job completes with a warning.
boolean notifyWhenFailed	True indicates to send a notification when the job request fails.
boolean notifyWhenSkipped	Optional. Specify true to send an email notification when a job is skipped. Default is false.
boolean notifyWhenSuccess	True indicates to send a notification when the job request succeeds.
boolean notifyWhenWarning	True indicates to send a notification when the job completes with a warning.
String recurrenceExpression	The expression that defines a recurring schedule.
String recurrenceExpressionType	The type of expression defined for a recurring schedule. Valid value is cron.
integer repeatCount	The number of times to repeat the schedule. For the recursive scheduling of a report, startDate must not be null, and repeatCount repeatInterval should be greater than 0 for any meaningful schedule. The endDate can be null.
integer repeatInterval	The interval between two scheduled jobs in seconds.
ReportRequest reportRequest	Information about the request included through the ReportRequest data type. See ReportRequest.
boolean saveDataOption	True indicates that the report data from the scheduled request run will be saved.
boolean saveOutputOption	Optional. Specify true to save the report output generated by the scheduled request to a database. Default is false.
boolean scheduleBurstingOption	Optional. Specify true to enable bursting for the scheduled job. Default is false.
boolean scheduleChunkingOption	Whether the data chunking is enabled (true) or not (false).
boolean schedulePublicOption	True indicates that the scheduled requests are to be made public.
String startDate	The date on which the schedule starts.
boolean useUTF8Option	True indicates that the Use UTF8 option is enabled.
String userJobDesc	The user-entered description for the scheduled job.
String userJobName	The user-entered name for the scheduled job.