Interface IDataMapping

The system entity for a Data Mapping, which belongs to a IDataMapping holding the design for a data maping

See https://web.lemonedge.com/help/data-mappings/ 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.DataMapping, "dbo.LT_DataMappings", "DataMapping", LabelColumn = "Name", IsStandingDataEntity = true, HelpURL = "data-mappings")]
[DefaultEntityIcon(ImageType.Translate)]
public interface IDataMapping : IDataMappingBase, IBaseEntityWithPermissions, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties, ISetCopier

Properties

Description

A user friendly description of this data mapping

Declaration
[EntityProperty(SQLType.NVarChar, (short)2000, true)]
[EntityDescription("A user friendly description of the use of this data mapping.")]
string Description { get; set; }
Property Value
Type Description
System.String

EntityTypeID

The entity type this data mapping strictly applies to.

Can be blank for all data types if just specifying file formatting and no property mappings.

Declaration
[EntityProperty(SQLType.UniqueIdentifier, true, IsEntityTypeLink = true)]
[EntityDescription("Indicates the type of entity this data mapping is valid against - null indicates all.")]
Guid? EntityTypeID { get; set; }
Property Value
Type Description
System.Nullable<System.Guid>

IsDefault

Indicates if you have more than one data mapping for a specific Entity Type that this is the default one to use

Declaration
[EntityProperty(SQLType.Bit, false, "0")]
[EntityDescription("Indicates this should be the default mapping for imports of this specified entity type.")]
bool IsDefault { get; set; }
Property Value
Type Description
System.Boolean

Name

The unique user friendly name for this data mapping

Declaration
[EntityProperty(SQLType.NVarChar, (short)500, false)]
[EntityDescription("The unique name of this data mapping.")]
[Required]
string Name { get; set; }
Property Value
Type Description
System.String

SourceSQLWrapperID

Indicates this data mapping is used for parsing data from the specified sql wrapper in ImportDefinitions. Allows selection of the sql wrapper columns in the property mappings, and ensures correct use in Import Definitions.

Declaration
[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityRelationship(EntityID.SQLWrapper, "ID", SingleJoinType.ZeroToOne, "SQL Wrapper", "Mappings", DeleteWithRelationship = false, PartOfParentSet = false, LinkToItemInSet = false, InheritPermissions = false)]
[EntityDescription("Indicates this data mapping is used for parsing data from the specified sql wrapper in ImportDefinitions. Allows selection of the sql wrapper columns in the property mappings, and ensures correct use in Import Definitions.")]
Guid? SourceSQLWrapperID { get; set; }
Property Value
Type Description
System.Nullable<System.Guid>

Extension Methods

See Also