Interface IImportDefinition

The system entity for an import defintion, which describes steps of imports to process

See https://web.lemonedge.com/help/import-definitions/ 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.ImportDefinition, "dbo.LT_ImportDefinitions", "ImportDefinition", LabelColumn = "Name", IsStandingDataEntity = false, HelpURL = "import-definitions")]
[DefaultEntityIcon(ImageType.UploadSteps)]
public interface IImportDefinition : IBaseEntityWithPermissions, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties, ISetCopier

Properties

Description

User friendly description of what this import definition does

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

Name

[Key] Unique user friendly name for this import definition

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

StorageBasePath

The base path to use for the Storage Type. For example using Local may be LemonEdgeFiles

Declaration
[EntityProperty(SQLType.NVarChar, (short)500, true)]
[EntityDescription("The base folder path to use when accessing any files within the storage medium.")]
string StorageBasePath { get; set; }
Property Value
Type Description
System.String

StorageConnectionString

The connection string for the storage type. For Azure this would be a connection string, for Local it can just be the drive, or network, name: C:\

Declaration
[EntityProperty(SQLType.NVarChar, (short)500, true)]
[EntityDescription("The connection string, including any credentials, used to connect to the specified sotrage type.")]
string StorageConnectionString { get; set; }
Property Value
Type Description
System.String

StorageType

Indicates the storage type to use for the import definition to access and poll for files.

System comes with:

Local, Azure

But you can add more by implementing the IStorageManager interface.

Declaration
[EntityProperty(SQLType.NVarChar, (short)20, true)]
[EntityDescription("The type of storage used to access specified import files.")]
string StorageType { get; set; }
Property Value
Type Description
System.String

Extension Methods

See Also