[EntityDefinition(EntityID.DataMapping, "dbo.LT_DataMappings", "DataMapping", LabelColumn = "Name", IsStandingDataEntity = true, HelpURL = "help/open-architecture/data-integration/data-mappings/intro.html")]
[DefaultEntityIcon(ImageType.Translate)]
public interface IDataMapping : IDataMappingBase, IBaseEntityWithPermissions, ISetCopier, IHasFolderStructure, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties

Properties

Description

A user friendly description of this data mapping

Declaration

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

Property Value

Type	Description
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
Guid?

IncludeWhenImportingType

Indicates when a user imports data of this entity type that this mapper should be provided to optionally be used by the user

Declaration

[EntityProperty(SQLType.Bit, false, "0")]
[EntityDescription("Indicates when a user imports data of this entity type that this mapper should be provided to optionally be used by the user")]
bool IncludeWhenImportingType { get; set; }

Property Value

Type	Description
bool

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
bool

Name

The unique user friendly name for this data mapping

Declaration

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

Property Value

Type	Description
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", "Data Mappings", DeleteWithRelationship = false, PartOfParentSet = false, LinkToItemInSet = true, 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; }