CreateDailySchedule Method

Schedule the Api object's active report to run on a daily interval.

Syntax

public System.string CreateDailySchedule( 
   System.string name,
   System.bool everyWeekday,
   System.int everyNDays,
   System.DateTime rangeStartDate,
   System.bool rangeNoEndDate,
   System.int rangeEndAfterNOccurrences,
   System.Nullable<DateTime> rangeEndDate,
   SchedulerEmailInfo emailInfo,
   System.Nullable<TimeSpan> schedTime
)

Parameters

name: A friendly name that will appear in the Schedule Name column of the Schedule Manager.
everyWeekday: Indicates whether to run the schedule every weekday. If true the everyNDays parameter will be ignored
everyNDays: Indicates the interval at which to run the schedule (e.g. every 10 days). If everyWeekday is true this parameter will be ignored
rangeStartDate: Summary (.NET Xml Comment Files)

The date on which to begin running the schedule.

If the schedTime argument is null, Exago will use the time component of this argument as the schedule time.
rangeNoEndDate: Indicates to the scheduler whether or not to ever cease running this schedule. If true, the rangeEndAfterOccurrences and rangeEndDate parameters are ignored
rangeEndAfterNOccurrences: A finite number of executions this schedule will run for. If greater than zero this value will take precedence over rangeEndDate
rangeEndDate: Indicates to the scheduler to cease running by a specific date. Ignored if either rangeNoEndDate is true or rangeEndAfterNOccurrences is greater than zero
emailInfo: A SchedulerEmailInfo object with Information on email addresses, subject and body. If null, the report output will be instead be saved to the <report_path> in the Scheduler Service's configuration file.
schedTime: The time to run the schedule. If no value is provided or the value is null, the Scheduler Service's will look to the time portion of the rangeStartDate or schedDateTime argument instead.

Return Value

jobId string that uniquely identifies the newly created job

Example

Create a daily schedule that runs 30 times.

//Construct the e-mail destination
SchedulerEmailInfo ei = new SchedulerEmailInfo();
List<string> addresses = new List<string>();
addresses.Add("peter@example.com");
ei.toAddrs = addresses;
ei.subject = "Report";
ei.body = "Here is the report you needed.";

//Build the schedule
ReportScheduler rs = api.ReportScheduler;
rs.CreateDailySchedule(reportName, true, 0, new DateTime(), true, 30, null, ei);

Parameters

Return Value

Reference