Interface IQueryRunnerStep
The system entity for a Query Runner Step, which takes the result of a IQueryRunner and processes it
See https://help.lemonedge.com/query-runners/ for more information
Inherited Members
System.IEquatable<LemonEdge.API.Core.IBaseEntity>.Equals(LemonEdge.API.Core.IBaseEntity)
System.ComponentModel.INotifyPropertyChanged.PropertyChanged
System.ComponentModel.INotifyPropertyChanging.PropertyChanging
Namespace: LemonEdge.API.Entities
Assembly: API.dll
Syntax
[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, (short)2000, true)]
[EntityDescription("A user friendly description of this query runner step.")]
string Description { get; set; }
Property Value
Type | Description |
---|---|
System.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 |
---|---|
System.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 |
---|---|
System.Int16 |
Name
The name for this query runner step
Declaration
[EntityProperty(SQLType.NVarChar, (short)500, false)]
[EntityDescription("The unique name of this query runner step.")]
[Required(AllowEmptyStrings = false)]
string Name { get; set; }
Property Value
Type | Description |
---|---|
System.String |
ParentQueryRunnerID
The parent query runner this step belongs to
Declaration
[EntityProperty(SQLType.UniqueIdentifier, false)]
[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 |
---|---|
System.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 |
---|---|
System.Nullable<System.Guid> |
RunnerHandlerTypeID
The type of QueryRunnerHandler
Declaration
[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityDescription("The type of QueryRunnerHandler.")]
[Required]
Guid RunnerHandlerTypeID { get; set; }
Property Value
Type | Description |
---|---|
System.Guid |