ReportTask Class

A ReportTask defines the exection of a task: SQL statement or Razor script

Inheritance Hierarchy

SystemObject
  Seal.ModelRootEditor
    Seal.ModelRootComponent
      Seal.ModelReportComponent
        Seal.ModelReportTask

Namespace: Seal.Model
Assembly: SealLibrary (in SealLibrary.dll) Version: 8.1.0.0+4fe7975a95558d7cdf0d4c425e2c3a22827d67dd

Syntax

Copy

public class ReportTask : ReportComponent

The ReportTask type exposes the following members.

Constructors

	Name	Description
	ReportTask	Initializes a new instance of the ReportTask class

Top

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
	TemplateName	The Razor Script used to execute the task

Top

Methods

	Name	Description
	AfterSerialization	Operations performed after the serialization
	BeforeSerialization	Operations performed before the serialization
	Cancel	Cancel the task
	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
	ExecuteSQL
	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
	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)
	ShouldSerializeEnabled
	ShouldSerializeParameters
	ShouldSerializeReferenceTaskGUID
	ShouldSerializeViews
	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)

Top

Fields

	Name	Description
	_connectionGUID
	_dctd	(Inherited from RootEditor)
	_GUID	(Inherited from RootComponent)
	_name	(Inherited from RootComponent)
	_report	(Inherited from ReportComponent)
	BodyScriptTemplate
	DbInfoMessage	Information message for database
	ExecInput	Optional input object for the task
	ExecInputKeyword
	ExecProcessChildren	Exec flag to disable children processing
	ExecResult	The result of the task, if any
	Execution	The current report execution executing the task
	NoChildrenBodyScriptTemplate
	ParentExecResultKeyword
	ParentTaskConnectionGUID
	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
	TranslatedParameterDescriptionFull

Top

Reference

Seal.Model Namespace