CreateMonthlyScheduleByNumericDay(String,Int32,Int32,DateTime,Nullable<TimeSpan>,SchedulerEmailInfo) Method

Schedule the Api object's active report to run every month on a specific day of that month (e.g. when numericDay is 30, the schedule will run on the 30th of every month.

If the month does not have that day (e.g. February does not have 30 days) then the schedule will be adjusted back to the closest day to insure the schedule is executed (e.g. the schedule will run on February 28 instead).

The schedule will repeat until it is removed from the system.

Syntax

public System.string CreateMonthlyScheduleByNumericDay( 
   System.string name,
   System.int everyNMonths,
   System.int numericDay,
   System.DateTime rangeStartDate,
   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)
numericDay: The numeric day of each month (e.g. 17) on which to run the schedule.
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.
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: 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.

Return Value

jobId String that represents that unique job

Parameters

Return Value

Reference