Report |
A ReportTask defines the exection of a task: SQL statement or Razor script
Inheritance HierarchySystemObject
Seal.ModelRootEditor
Seal.ModelRootComponent
Seal.ModelReportComponent
Seal.ModelReportTask
Seal.ModelRootEditor
Seal.ModelRootComponent
Seal.ModelReportComponent
Seal.ModelReportTask
Namespace: Seal.Model
Assembly: SealLibrary (in SealLibrary.dll) Version: 10.0.1.0+a44cd3a7f03c2bf3cdbd971a878c679e40bed08a
SyntaxC#
public class ReportTask : ReportComponent
The ReportTask type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ReportTask | Initializes a new instance of the ReportTask class |
Properties| Name | Description | |
|---|---|---|
 | BodyScript | Body Razor script executed for the Task. |
| Connection | Current MetaConnection |
| ConnectionGUID | The connection identifier used by the task |
| DefaultBodyScript | Default body script coming from the template |
| DefaultScript | Default script coming from the template |
| Description | Description coming from the template |
| Enabled | If false, the task is ignored and not executed |
| Error | Last error message |
| ExecuteForEachConnection | If true, the task will be executed for each connection defined in the Data Source. If false, only the current connection is used. |
| GUID |
The unique identifier
(Inherited from RootComponent) |
| IgnoreError | If true, errors occuring during the task execution are ignored and the report execution continues |
| Information | Last information message |
| Name |
The name
(Inherited from RootComponent) |
| Parameters | List of Table Parameters |
| ParentTask | Current parent task if any |
| ReferenceTask | Current reference task if any |
| ReferenceTaskGUID | If set, the values of the properties of the task may be taken from the reference task. This applies to Script, SQL and Parameters having their default value. This enables the sharing of property values among different tasks. |
| Report |
The current report
(Inherited from ReportComponent) |
| Repository | Current Repository |
| Retries | Number of retries in case of error |
| RetryDuration | Duration in seconds to wait between each retry |
| Script | Razor script executed for the Task. It may be empty if the SQL Script is defined. |
| SortOrder | Order of the task amongst the tasks of the report |
| Source | Current ReportSource |
| SourceGUID | Identifier of the current report source |
| SQL | SQL Statement executed for the task. It may be empty if a Razor Script is defined. The statement may contain Razor script if it starts with '@'. If the SQL result returns 0, the report is cancelled and the next tasks are not executed. |
| SQLSeparator | Separator used in the SQL Statement to split the script in several sub-scripts and executions (e.g. GO or ;). The SQL statement must contain the separator plus a line feed to be detected. |
| SQLStatements | List of SQL statements to execute |
| Step | The Report Execution Step to execute the task. By default, tasks are executed before the models generation. |
| TaskTemplate | Current task template |
| TemplateName | The Razor Script used to execute the task |
Methods| Name | Description | |
|---|---|---|
| AfterSerialization | Operations performed after the serialization |
| BeforeSerialization | Operations performed before the serialization |
| Cancel | Cancel the task |
| Copy | Copy a ReportTask with its children |
 | Create | Creates a basic ReportTask |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Execute | Executes the task |
| ExecuteScript | Execute the Razor script of the task (or the default script of the template) |
| ExecuteSQL | Execute the SQL statements of the task |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| GetBoolValue | Returns a parameter boolean value with a default if it does not exist |
| GetDbCommand | Returns a DbCommand from a MetaConnection |
| GetDoubleValue | Returns a parameter double value |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetNumericValue | Returns a parameter integer value |
| GetSort | Returns the order of the task |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| GetValue | Returns the parameter value |
| GetValueTranslated | Returns the parameter value replacing Exec and Repository keywords |
| HandleException | Handle an exception got during the task execution: log the error and cancel the report if IgnoreError is false |
| 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) |
| InitFromReferenceTask | Initializes the task properties from its reference task |
| InitParameters | Init the parameters from the template |
| InitReferences | Init all references of the task |
| LogMessage | Log Interface implementation |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| SetReadOnly |
Set all properties to readonly
(Inherited from RootEditor) |
| 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 | |
|---|---|---|
 | _connectionGUID | GUID of the connection used by the task |
| _dctd |
Type descriptor used to edit the properties in the PropertyGrid, null if the editor is not initialized
(Inherited from RootEditor) |
| _GUID |
Field of the GUID property
(Inherited from RootComponent) |
| _name |
Field of the Name property
(Inherited from RootComponent) |
| _report |
Field of the Report property
(Inherited from ReportComponent) |
 | BodyScriptTemplate | Default body script template: executes the SQL, the script, then the children tasks |
| DbInfoMessage | Information message for database |
| ExecInput | Optional input object for the task |
| ExecInputKeyword | Keyword replaced by the execution input of the task in the task parameters |
| ExecProcessChildren | Exec flag to disable children processing |
| ExecResult | The result of the task, if any |
| Execution | The current report execution executing the task |
| NoChildrenBodyScriptTemplate | Body script template that executes the SQL and the script without the children tasks |
| ParentExecResultKeyword | Keyword replaced by the execution result of the parent task in the task parameters |
| ParentTaskConnectionGUID | Special connection GUID value meaning that the connection of the parent task is used |
| Progression | Current progression of the task in percentage |
| Tag | Custom Tag the can be used at execution time to store any object |
| Tasks | Children of the task |
| TemplateDescription | Description coming from the template |
| TranslatedParameterDescription | Description of the keywords supported in a task parameter |
| TranslatedParameterDescriptionFull | Description of the keywords supported in a task parameter, including the repository path keyword |
See Also