Report |
A ReportSchedule defines a schedule on a ReportOutput. Schedules are using Tasks of the Windows Task Scheduler.
Inheritance HierarchySystemObject
Seal.ModelRootEditor
Seal.ModelRootComponent
Seal.ModelReportComponent
Seal.ModelReportSchedule
Seal.ModelRootEditor
Seal.ModelRootComponent
Seal.ModelReportComponent
Seal.ModelReportSchedule
Namespace: Seal.Model
Assembly: SealLibrary (in SealLibrary.dll) Version: 8.1.0.0+4fe7975a95558d7cdf0d4c425e2c3a22827d67dd
SyntaxC#
public class ReportSchedule : ReportComponent
The ReportSchedule type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ReportSchedule | Initializes a new instance of the ReportSchedule class |
Properties| Name | Description | |
|---|---|---|
 | ErrorEmailFrom | The sender (From) email address used to send the email in case of error. If empty the default address configured in the device is used. Make sure that the SMTP or SendGrid server allows the new address. |
| ErrorEmailSendMode | Specify if the email is sent for the first, the last or for each failure |
| ErrorEmailSubject | The subject of the email sent in case of error. If empty, the report name is used. |
| ErrorEmailTo | The destination (To) email addresses used for the email in case of error. One per line or separated by semi-column. |
| ErrorMinutesBetweenRetries | The number of minutes elapsed between a retry |
| ErrorNumberOfRetries | The maximum number of retries in case of error |
| GUID |
The unique identifier
(Inherited from RootComponent) |
| HelperRunTaskScheduler | Editor Helper: Edit the Schedule with the MMC Task Scheduler |
| IsEnabled | Indicates if the task is enabled. Tasks can be enabled or disabled using the Task Scheduler Microsoft Management Console. |
| IsTasksSchedule | If true, the schedule is executed without output definition. It may be used to schedule reports having only tasks. The default view of the report is used for the execution. |
| LastRunTime | Last time the task was executed |
| Name |
The name
(Inherited from RootComponent) |
| NextRunTime | Next time the task will be executed |
| NotificationEmailBody | The body of the email sent in case of success. If empty, a default text is used. |
| NotificationEmailFrom | The sender (From) email address used to send the email in case of success. If empty the default address configured in the device is used. Make sure that the SMTP or SendGrid server allows the new address. |
| NotificationEmailSubject | The subject of the email sent in case of success. If empty, the report name is used. |
| NotificationEmailTo | The destination (To) email addresses used for the email notification in case of success. One per line or separated by semi-column. |
| Output | ReportOutput of the schedule |
| OutputGUID | Identifier of the output |
| OutputName | The report output name of this schedule |
| Report |
The current report
(Inherited from ReportComponent) |
| SealDays | Days of the month to execute the schedule |
| SealDaysInterval | Number of days |
| SealDaysString | Days of the Seal Schedule in a text |
| SealEnabled | True if the schedule is enabled |
| SealEnd | End date and time of the schedule |
| SealMonths | Months to execute the schedule |
| SealMonthsString | Months of the Seal Schedule a text |
| SealNextExecution | Next execution planned for the schedule |
| SealRepeatDuration | Duration of the schedule repetition |
| SealRepeatInterval | Interval of the schedule repetition |
| SealSchedule | |
| SealStart | Start date and time of the schedule |
| SealType | Type of schedule trigger |
| SealWeekdays | Days of the week to execute the schedule |
| SealWeekdaysString | Weekdays of the Seal Schedule a text |
| SealWeeksInterval | Number of weeks |
| Task | The current Windows Task |
| TaskName | Task name as used in the Windows Task Scheduler or for the Seal Schedule file name. |
| TaskSource | Task source name |
Methods| Name | Description | |
|---|---|---|
 | Create | Create a basic ReportSchedule |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| FindTask | Find the Task from the Windows Task Scheduler |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetTaskSourceDetail | Returns a given line from the Task Source Detail |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| Init |
Init the editor objects
(Inherited from RootEditor) |
| InitDefaultValues |
Init the default values
(Inherited from RootEditor) |
| InitEditor |
Init the editor objects and the default values
(Inherited from RootEditor) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| RegisterTaskDefinition | |
| SetReadOnly |
Set all properties to readonly
(Inherited from RootEditor) |
| SynchronizeTask | Synchronize the task with the Windows Task Scheduler |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| UpdateEditor |
Update editor attributes
(Inherited from RootEditor) |
| UpdateEditorAttributes |
Refresh properties attrivutes
(Inherited from RootEditor) |
Fields| Name | Description | |
|---|---|---|
 | _dctd | (Inherited from RootEditor) |
| _GUID | (Inherited from RootComponent) |
| _name | (Inherited from RootComponent) |
| _report | (Inherited from ReportComponent) |
 | Tag | Object that can be used at run-time for any purpose |
See Also