[EntityDefinition(EntityID.QueryRunnerStep, "dbo.LT_QueryRunnerSteps", "QueryRunnerStep", LabelColumn = "Name", IsStandingDataEntity = false, HelpURL = "help/enterprise-data-tools/reporting/query-runners/step-view.html")]
[DefaultEntityIcon(ImageType.Broadcast)]
public interface IQueryRunnerStep : IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties

Properties

Description

A user friendly description for this query runner step

Declaration

[EntityProperty(SQLType.NVarChar, 2000, true)]
[EntityDescription("A user friendly description of this query runner step.")]
string Description { get; set; }

Property Value

Type	Description
string

DocumentGeneratedStep

Write generated step as document

Declaration

[EntityProperty(SQLType.SmallInt, false, "0")]
[EntityDescription("Write generated step as document.")]
QueryRunnerStepDocument DocumentGeneratedStep { get; set; }

Property Value

Type	Description
QueryRunnerStepDocument

DocumentType

The type of entity to save the document against

Declaration

[EntityProperty(SQLType.UniqueIdentifier, true, IsEntityTypeLink = true)]
[EntityDescription("The type of entity to save the document against")]
Guid? DocumentType { get; set; }

Property Value

Type	Description
Guid?

DocumentTypeIDFormula

A formula holding the id of the item to save the generated document against

Declaration

[EntityProperty(SQLType.NVarChar, true)]
[EntityDescription("A formula holding the id of the item to save the generated document against.")]
string DocumentTypeIDFormula { get; set; }

Property Value

Type	Description
string

GeneratedStepNameFormula

A formula holding the name to be used for the result of executing this step against the current result of the query runner sql wrapper

Declaration

[EntityProperty(SQLType.NVarChar, true)]
[EntityDescription("A formula holding the name to be used for the result of executing this step against the current result of the query runner sql wrapper.")]
[HardCodedDefaultValueOnNew("QueryRunnerStep.Name + \"_\" + RunnerExecutionRowNumber.ToString()")]
string GeneratedStepNameFormula { get; set; }

Property Value

Type	Description
string

Index

The order this step will be processed in by the Query Runner. This can be moved up and down using the standard grid commands.

Declaration

[EntityProperty(SQLType.SmallInt, false)]
[EntityDescription("The order this step will be processed in by the Query Runner.")]
[EntitySequence]
short Index { get; set; }

Property Value

Type	Description
short

Name

The name for this query runner step

Declaration

[EntityProperty(SQLType.NVarChar, 500, false)]
[EntityKeyProperty]
[EntityDescription("The unique name of this query runner step.")]
[Required(AllowEmptyStrings = false)]
string Name { get; set; }

Property Value

Type	Description
string

ParentQueryRunnerID

The parent query runner this step belongs to

Declaration

[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityKeyProperty]
[EntityRelationship(EntityID.QueryRunner, "ID", SingleJoinType.One, "Parent Query Runner", "Steps", DeleteWithRelationship = true, PartOfParentSet = true, LinkToItemInSet = false, InheritPermissions = true)]
[Required]
[EntityDescription("The parent query runner this step belongs to")]
Guid ParentQueryRunnerID { get; set; }

Property Value

Type	Description
Guid

RunnerHandlerID

The ID of the QueryRunnerHandler to use

Declaration

[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityDescription("The ID of the QueryRunnerHandler to use.")]
[Required]
Guid? RunnerHandlerID { get; set; }

Property Value

Type	Description
Guid?

RunnerHandlerSettings

Optional settings for the runner handler

Declaration

[EntityProperty(SQLType.NVarChar, true)]
[EntityDescription("Optional settings for the runner handler")]
string RunnerHandlerSettings { get; set; }

Property Value

Type	Description
string

RunnerHandlerTypeID

The type of QueryRunnerHandler

Declaration

[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityDescription("The type of QueryRunnerHandler.")]
[Required]
Guid RunnerHandlerTypeID { get; set; }

Property Value

Type	Description
Guid

StepGuardFormula

A formula that returns true to indicate if this step should be executed. If no formula the step by default will always be executed.

Declaration

[EntityProperty(SQLType.NVarChar, true)]
[EntityDescription("A formula that returns true to indicate if this step should be executed. If no formula the step by default will always be executed.")]
string StepGuardFormula { get; set; }

Property Value

Type	Description
string

StorageBasePath

Optional: the base path of the storage location to write to.

Declaration

[EntityProperty(SQLType.NVarChar, true)]
[EntityDescription("Optional: the base path of the storage location to write to.")]
string StorageBasePath { get; set; }

Property Value

Type	Description
string

StorageConnectionString

Optional: the connection string, including credentials, of the storage device to connect to.

Declaration

[EntityProperty(SQLType.NVarChar, true)]
[EntityDescription("Optional: the connection string, including credentials, of the storage device to connect to.")]
string StorageConnectionString { get; set; }

Property Value

Type	Description
string

StorageFilename

Optional: the filename by which the data will be saved in storage. If blank and set to store the Generated Step Name will be used.

Declaration

[EntityProperty(SQLType.NVarChar, true)]
[EntityDescription("Optional: the filename by which the data will be saved in storage. If blank and set to store the Generated Step Name will be used.")]
string StorageFilename { get; set; }

Property Value

Type	Description
string

StorageType

Optional: the type of storage to write to.

Declaration

[EntityProperty(SQLType.NVarChar, true)]
[EntityDescription("Optional: the type of storage to write to. ")]
string StorageType { get; set; }

Property Value

Type	Description
string

StoreDocumentStep

Write generated step to the storage location defined in the step parameters.

Declaration

[EntityProperty(SQLType.SmallInt, false, "0")]
[EntityDescription("Write generated step to the storage location defined in the step parameters.")]
QueryRunnerStepStorage StoreDocumentStep { get; set; }

Property Value

Type	Description
QueryRunnerStepStorage

Extension Methods

LinqExtensions.AsArray<T>(T)

LinqExtensions.ToArrayOfOne<T>(T)

LinqExtensions.ToListOfOne<T>(T)

MiscExtensions.SetIfNotEqual<T, TP>(T, Expression<Func<T, TP>>, TP)

WeakReferenceExtensions.WeakReference(object)

SQLExtensions.ToSQLValue(object, bool)

ReflectionExtensions.ClearEventInvocations(object, string)

StringExtensions.ToCSVFormatString(object, Type)