Interface IDataTemplate

The system entity for data templates which can be used when exporting data into excel

See https://help.lemonedge.com/help/enterprise-data-tools/reporting/data-templates/intro.html for more information

Inherited Members
Namespace: LemonEdge.API.Entities.Reporting
Assembly: LemonEdge.API.dll
Syntax
[EntityDefinition(EntityID.DataTemplate, "dbo.LT_DataTemplates", "DataTemplate", IsStandingDataEntity = true, HelpURL = "help/enterprise-data-tools/reporting/data-templates/intro.html", LabelColumn = "Name")]
[DefaultEntityIcon(ImageType.ExcelTemplate)]
[EntityLinkToAnyParentRelationshipModifier(EntityID.SQLWrapper, "OwnerEntityID", "ID", ExcludeFromRelationship = true)]
[EntityIndex(Name = "Name", ColumnNames = new string[] { "UserID", "Name" }, IndexOrder = new IndexOrder[] { IndexOrder.Ascending, IndexOrder.Ascending }, IncludeColumns = new string[] { "SafeID", "Version", "Type", "AlgorithmStepID" }, IsClustered = false, IsUnique = false)]
public interface IDataTemplate : IBaseEntityWithPermissions, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties, ISetCopier, IUserSpecific, IHasVersion

Properties

Description

The user friendly description for this template

Declaration
[EntityProperty(SQLType.NVarChar, 2500, true)]
[EntityDescription("The user friendly description for this template.")]
string Description { get; set; }
Property Value
Type Description
string

EntityTypeID

Indicates this is a template for data exported straight from this specified entity type.

Declaration
[EntityProperty(SQLType.UniqueIdentifier, true, IsEntityTypeLink = true)]
[EntityDescription("Indicates this is a template for data exported straight from this specified entity type.")]
Guid? EntityTypeID { get; set; }
Property Value
Type Description
Guid?

FileName

Declaration
[EntityProperty(SQLType.NVarChar, 500, false, "Name+'.xlsx'")]
[EntityDescription("The actual file name of this document.")]
[Required]
string FileName { get; set; }
Property Value
Type Description
string

Name

The unique user friendly name of this template

Declaration
[EntityProperty(SQLType.NVarChar, 500, false)]
[EntityDescription("The unique user friendly name of this template.")]
[EntityKeyProperty]
[Unique]
[Required]
string Name { get; set; }
Property Value
Type Description
string

QueryRunnerID

Indicates this is a template for data exported straight from this specified IQueryRunner.

Declaration
[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityRelationship(EntityID.QueryRunner, "ID", SingleJoinType.ZeroToOne, "Query Runner", "Templates", DeleteWithRelationship = true, PartOfParentSet = true, LinkToItemInSet = true, InheritPermissions = false)]
[EntityDescription("Indicates this is a template for data exported straight from this specified Query Runner.")]
Guid? QueryRunnerID { get; set; }
Property Value
Type Description
Guid?

SQLWrapperID

Indicates this is a template for data exported straight from this specified ISQLWrapper.

Declaration
[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityRelationship(EntityID.SQLWrapper, "ID", SingleJoinType.ZeroToOne, "SQL Wrapper", "Templates", DeleteWithRelationship = true, PartOfParentSet = true, LinkToItemInSet = true, InheritPermissions = false)]
[EntityDescription("Indicates this is a template for data exported straight from this specified SQL Wrapper.")]
Guid? SQLWrapperID { get; set; }
Property Value
Type Description
Guid?

Type

The type of document template this data is exported into

Declaration
[EntityProperty(SQLType.SmallInt, false)]
[EntityDescription("The type of document template this data is exported into.")]
DataTemplateType Type { get; set; }
Property Value
Type Description
DataTemplateType

Extension Methods