Exago .NET API Documentation
CreateYearlySchedule Method
WebReports.Api.Scheduler Namespace > ReportScheduler Class : CreateYearlySchedule Method
A friendly name that will appear in the Schedule Name column of the  Schedule Manager.
The numeric month (1-12) on which to run the schedule. Always used.
The numeric day of each month (e.g. 17) on which to run the schedule. If greater than zero, weekOfMonth and dayOfWeek will be ignored.
Taken in context with dayOfWeek, describes when during the month to run the schedule (e.g. "second" or "third"). Use one of the ReportScheduleInfo.WeekOfMonthType Enumeration members.
The day or days of each week on which the schedule runs, used in conjunction with ordinal. Use one of the ReportScheduleInfo.DayOfWeekType Enumeration members.
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.
Indicates to the scheduler whether or not to ever cease running this schedule. If true, the rangeEndAfterOccurrences and rangeEndDate parameters are ignored
A finite number of executions this schedule will run for. If greater than zero this value will take precedence over rangeEndDate
Indicates to the scheduler to cease running by a specific date. Ignored if either rangeNoEndDate is true or rangeEndAfterNOccurrences is greater than zero
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.
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.
Schedule a report to be run on a yearly interval. Report will be executed until the recurrence completion conditions have been met
Syntax
public System.string CreateYearlySchedule( 
   System.string name,
   System.int numericMonth,
   System.int numericDay,
   ReportScheduleInfo.WeekOfMonthType ordinal,
   ReportScheduleInfo.DayOfWeekType dayOfWeek,
   System.DateTime rangeStartDate,
   System.bool rangeNoEndDate,
   System.int rangeEndAfterNOccurrences,
   System.Nullable<DateTime> rangeEndDate,
   System.Nullable<TimeSpan> schedTime,
   SchedulerEmailInfo emailInfo
)

Parameters

name
A friendly name that will appear in the Schedule Name column of the  Schedule Manager.
numericMonth
The numeric month (1-12) on which to run the schedule. Always used.
numericDay
The numeric day of each month (e.g. 17) on which to run the schedule. If greater than zero, weekOfMonth and dayOfWeek will be ignored.
ordinal
Taken in context with dayOfWeek, describes when during the month to run the schedule (e.g. "second" or "third"). Use one of the ReportScheduleInfo.WeekOfMonthType Enumeration members.
dayOfWeek
The day or days of each week on which the schedule runs, used in conjunction with ordinal. Use one of the ReportScheduleInfo.DayOfWeekType Enumeration members.
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
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.
emailInfo
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.

Return Value

jobId String that represents that unique job
See Also

Reference

ReportScheduler Class
ReportScheduler Members