Interface IServerTaskStatus

The system entity for a server task, which can be offloaded and run on the task services rather than locally

See https://help.lemonedge.com/server-tasks/ for more information

Inherited Members
Namespace: LemonEdge.API.Entities.Tasks
Assembly: LemonEdge.API.dll
Syntax
[EntityDefinition(EntityID.ServerTaskStatus, "dbo.LT_ServerTaskStatuses", "ServerTaskStatus", SelectWithNoLock = true)]
[DefaultEntityIcon(ImageType.History)]
[EntityIndex(Name = "TaskStatus", ColumnNames = new string[] { "ServerTaskID" }, IndexOrder = new IndexOrder[] { IndexOrder.Ascending }, IsClustered = false, IsUnique = false)]
[EntityIndex(Name = "ServerTask", ColumnNames = new string[] { "ProgressIndex", "ServerTaskID", "ModifiedByUserID" }, IndexOrder = new IndexOrder[] { IndexOrder.Ascending, IndexOrder.Ascending, IndexOrder.Ascending }, IncludeColumns = new string[] { "AlgorithmStepID", "Message", "Progress", "SafeID", "Type" }, IsClustered = false, IsUnique = false)]
public interface IServerTaskStatus : IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties, ITaskMessage

Properties

Message

The message from the task for this status

Declaration
[EntityProperty(SQLType.NVarChar, false)]
[EntityDescription("Current server task status message.")]
string Message { get; set; }
Property Value
Type Description
string

Progress

The current progress of the task when these message is recorded

Declaration
[EntityProperty(SQLType.Decimal, 18, 12, false)]
[EntityDescription("The current progress index this progress percent is for (0 is overall progress).")]
decimal Progress { get; set; }
Property Value
Type Description
decimal

ProgressIndex

All main progress task statuses have a default index of 0. However Tasks can process multiple stages each with their own progress. The individual progress of those sub-stages is held with an incremented index for each stage.

For instance when an IImportDefinition processes a stage, the progress of that stage being processed is held with a Progress Index of 1. The main progress of each step increments along using the default index of 0.

Declaration
[EntityProperty(SQLType.SmallInt, false)]
[EntityDescription("The current progress index this progress percent is for (0 is overall progress).")]
short ProgressIndex { get; set; }
Property Value
Type Description
short

ServerTaskID

[Key] Links to IServerTask. The parent server task this progress status belongs to

Declaration
[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityKeyProperty]
[EntityRelationship(EntityID.ServerTask, "ID", SingleJoinType.One, "Server Task", "Statuses", DeleteWithRelationship = true, PartOfParentSet = false, LinkToItemInSet = false, InheritPermissions = true)]
[Required]
[RequiredNoDefaultIDValidation]
Guid ServerTaskID { get; set; }
Property Value
Type Description
Guid

Type

Indicates the type of message for this server task status.

Declaration
[EntityProperty(SQLType.SmallInt, false)]
[EntityDescription("Indicates the type of message for this server task status.")]
TaskMessageType Type { get; set; }
Property Value
Type Description
TaskMessageType

Extension Methods