Exago .NET API Documentation
CreateYearlyScheduleByDescriptionDay(String,Int32,WeekOfMonthType,DayOfWeekType,DateTime,Int32,Nullable<TimeSpan>,SchedulerEmailInfo) Method
WebReports.Api.Scheduler Namespace > ReportScheduler Class > CreateYearlyScheduleByDescriptionDay Method : CreateYearlyScheduleByDescriptionDay(String,Int32,WeekOfMonthType,DayOfWeekType,DateTime,Int32,Nullable<TimeSpan>,SchedulerEmailInfo) 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.
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.
A finite number of executions this schedule will run for. If greater than zero this value will take precedence over rangeEndDate
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 the Api object's active report to run every year with a relative repetition pattern (e.g. "the second Sunday of June"). The schedule will repeat until it has executed a finite number of times.
Syntax
public void CreateYearlyScheduleByDescriptionDay( 
   System.string name,
   System.int numericMonth,
   ReportScheduleInfo.WeekOfMonthType ordinal,
   ReportScheduleInfo.DayOfWeekType dayOfWeek,
   System.DateTime rangeStartDate,
   System.int rangeEndAfterNOccurrences,
   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.
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.
rangeEndAfterNOccurrences
A finite number of executions this schedule will run for. If greater than zero this value will take precedence over rangeEndDate
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
Overload List