Exago .NET API Documentation
CreateMonthlyScheduleByDescriptionDay(String,Int32,WeekOfMonthType,DayOfWeekType,DateTime,Nullable<DateTime>,Nullable<TimeSpan>,SchedulerEmailInfo) Method
WebReports.Api.Scheduler Namespace > ReportScheduler Class > CreateMonthlyScheduleByDescriptionDay Method : CreateMonthlyScheduleByDescriptionDay(String,Int32,WeekOfMonthType,DayOfWeekType,DateTime,Nullable<DateTime>,Nullable<TimeSpan>,SchedulerEmailInfo) Method
A friendly name that will appear in the Schedule Name column of the  Schedule Manager.
Indicates the interval at which to run the schedule (e.g. every 2 months)
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 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 the Api object's active report to run every month with a relative recurrence period (e.g. "on the third Wednesday of the month" or "on the last day of the month"), ending after a certain date.
Syntax
public System.string CreateMonthlyScheduleByDescriptionDay( 
   System.string name,
   System.int everyNMonths,
   ReportScheduleInfo.WeekOfMonthType ordinal,
   ReportScheduleInfo.DayOfWeekType dayOfWeek,
   System.DateTime rangeStartDate,
   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.
everyNMonths
Indicates the interval at which to run the schedule (e.g. every 2 months)
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.
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
Overload List