[EntityDefinition(EntityID.Canvas, "dbo.LT_Canvases", "Canvas", LabelColumn = "Name", IsStandingDataEntity = false, HelpURL = "help/enterprise-data-tools/workflow/canvases/intro.html", DontPromoteFromCanvas = true)]
[DefaultEntityIcon(ImageType.Canvas)]
[EntityIncludeInIndex(IndexName = "CanvasItem", IncludeColumns = new string[] { "LockAsOfDate" })]
[EntityIndex(Name = "Name", ColumnNames = new string[] { "UserID", "Name" }, IndexOrder = new IndexOrder[] { IndexOrder.Ascending, IndexOrder.Ascending }, IncludeColumns = new string[] { "SafeID", "Description", "AlgorithmStepID" }, IsClustered = false, IsUnique = false)]
public interface ICanvas : IUserSpecific, IBaseEntityWithPermissions, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties

Properties

Color

Hex color value to display for this value in the title bar when in use

Declaration

[EntityProperty(SQLType.NVarChar, 10, true)]
[EntityDescription("Hex color value to display for this value in the title bar when in use.")]
string Color { get; set; }

Property Value

Type	Description
string

Description

A user friendly description of the purpose of this canvas

Declaration

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

Property Value

Type	Description
string

LockAsOfDate

The date/time that the canvas should use to pull data from the main system up to.

By default this is blank meaning a canvas always runs on top of the latest data from the main system.

By having a Lock As Of Date you are saying the canvas is effectively a copy of the entire system as of that point in time that you can apply changes on top of.

Declaration

[EntityProperty(SQLType.DateTimeOffset, true)]
[EntityDescription("The date time you want this 'As Of'. i.e. changes in the Main system made after this date won't be visible in the canvas. \r\nIf this is blank the canvas runs in its default mode of always surfacing changes from the main system and layering canvas changes on top.")]
DateTimeOffset? LockAsOfDate { get; set; }

Property Value

Type	Description
DateTimeOffset?

Name

[Key] The unique user friendly name for this canvas

Declaration

[EntityProperty(SQLType.NVarChar, 500, false)]
[EntityKeyProperty]
[EntityDescription("The unique name of this Canvas.")]
[Unique]
[Required]
string Name { get; set; }

Property Value

Type	Description
string

Status

The status for this canvas - only archived canvases can be deleted, and they are not visible by default in the UI

Declaration

[EntityProperty(SQLType.SmallInt, false, "0")]
[EntityDescription("The status for this canvas - only archived canvases can be deleted, and they are not visible by default in the UI.")]
CanvasStatus Status { get; set; }