Exago .NET API Documentation
WebReports.Api.Scheduler Namespace
Inheritance Hierarchy
The Scheduler namespace contains classes used to schedule reports and for interacting with Scheduler Services.
Classes
 ClassDescription
Class Object for the user that contains jobId as well as schedule info. This class specific to the getters that the new api interface provides it provides the jobId as well as the ReportScheduleInfo to the user so the other important methods (like update) can be used.
Class

A JobInfo object contains basic information about a scheduled job. The JobInfo is referenced in the Scheduler Queue extensibility feature, otherwise it is used internally by Exago.

JobInfo objects represent both the "master" schedule and each individual execution of that schedule's recurrence pattern. For example, a scheduled report set to execute on the first of every month for a full year will have a total of 13 JobInfo objects associated with it — one for the schedule itself and then one for each execution on the first of the month. A JobInfo object is only available for those executions that have not been flushed from the Scheduler Service's working directory.

JobInfo objects are also created for Execution Cache jobs.

ClassA series of string constants used with the JobInfo Class
Class

A ReportScheduleInfo object describes a specific Scheduler Service schedule job. It is a base class for the more specific classes:

Class

An extension of the ReportScheduleInfo base class, a ReportScheduleInfoDaily object describes a schedule with a daily recurrence pattern.

When creating a new schedule, set the Api object's active report first, since that is the report that will be scheduled.
Class

An extension of the ReportScheduleInfo base class, a ReportScheduleInfoMonthly object describes a schedule with a monthly recurrence pattern.

When creating a new schedule, set the Api object's active report first, since that is the report that will be scheduled.
Class

An extension of the ReportScheduleInfo base class, a ReportScheduleInfoOnce object describes a schedule with no recurrence pattern.

When creating a new schedule, set the Api object's active report first, since that is the report that will be scheduled.
ClassAn extension of the ReportScheduleInfo base class, a ReportScheduleInfoWeekly object describes a schedule with a weekly recurrence pattern.
ClassAn extension of the ReportScheduleInfo base class, a ReportScheduleInfoYearly object describes a schedule with a yearly recurrence pattern.
ClassA ReportScheduler object provides access to the Scheduler Service's in the configuration. Access this object through the Api object's ReportScheduler Property.
ClassThe SchedulerEmailInfo class contains the information for e-mailing a scheduled job to its recipients for non-batch reports.
ClassA SchedulerHost object describes an individual Scheduler Service installation.
Enumerations
 EnumerationDescription
Enumeration

A read-only property showing the current status of a schedule. Used in REST — SchedulesV2 and by the ReportScheduler Class

 

EnumerationIndicates the type of recurrence a daily schedule has.
EnumerationWorks in conjunction with an ordinal (e.g. first, second, first). For example, the first Friday of the month.
EnumerationIndicates the type of recurrence a monthly schedule has.
EnumerationIndicates when a schedule that occurs once will execute.
EnumerationDescribes the type of recurrence pattern of a schedule.
EnumerationDescribes the how a schedules recurrence pattern ends.
EnumerationIndicates which day of the month the execution occurs on for monthly recurring schedules whose MonthlyPattern Property is RelativeDayOfMonth.
EnumerationIndicates the type of recurrence a yearly schedule has.
See Also

Reference

WebReportsApi Assembly