Interface IImportDefinitionStep
The system entity for an import defintion step, which belongs to an import definition
See https://web.lemonedge.com/help/import-definitions/ for more information
Inherited Members
Namespace: LemonEdge.API.Entities
Assembly: API.dll
Syntax
[EntityDefinition(EntityID.ImportDefinitionStep, "dbo.LT_ImportDefinitionSteps", "ImportDefinitionStep", LabelColumn = "Name", IsStandingDataEntity = false)]
[DefaultEntityIcon(ImageType.Sequential)]
public interface IImportDefinitionStep : IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties
Properties
ByPassValidation
Indicates when importing the data the system should by pass all validation. Improves performance for large datasets, and also can be used where you want the data (such as gl postings) to be precisely what the source system was without additional validation.
Declaration
[EntityProperty(SQLType.Bit, false)]
[EntityDescription("Indicates whether when saving this item the system should bypass the validation. Warning: This can save time if you are confident about the data state, but can leave data in an inconsistent state if there are integrity issues.")]
bool ByPassValidation { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Context
Indicates how the import lines will be processed. Isolated - The context is new and only exists for this import step. Shared - the context is shared across multiple steps so saves aren't committed untill the end.
Declaration
[EntityProperty(SQLType.SmallInt, false)]
[EntityDescription("Indicates how the import lines will be processed. Isolated - The context is new and only exists for this import step. Shared - the context is shared across multiple steps so saves aren't committed untill the end.")]
[Required]
ImportDefinitionStepContext Context { get; set; }
Property Value
Type | Description |
---|---|
ImportDefinitionStepContext |
DataMappingID
Links to IDataMapping. Holds any data mapping that should be applied to the import file in order to translate it for processing.
Declaration
[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityRelationship(EntityID.DataMapping, "ID", SingleJoinType.ZeroToOne, "DataMapping", "ImportDefinitionStep", DeleteWithRelationship = false, PartOfParentSet = false, InheritPermissions = false, LinkToItemInSet = true)]
[EntityDescription("Holds any data mapping that should be applied to the import file in order to translate it for processing.")]
Guid? DataMappingID { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Guid> |
Enabled
Indicates if this step should be processed when running the import definition
Declaration
[EntityProperty(SQLType.Bit, false)]
[EntityDescription("Indicates whether this step is enabled or not.")]
bool Enabled { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
ImportDefinitionID
[Key] Links to IImportDefinition. The parent import defintion this step belongs to
Declaration
[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityRelationship(EntityID.ImportDefinition, "ID", SingleJoinType.One, "ImportDefinition", "ImportDefinitionStep", DeleteWithRelationship = true, PartOfParentSet = true, InheritPermissions = true)]
Guid ImportDefinitionID { get; set; }
Property Value
Type | Description |
---|---|
System.Guid |
ImportEmbeddedFile
If the data to import is hardcoded into the step itself (such as for creating test imports) this holds the file to import.
Declaration
[EntityProperty(SQLType.NVarChar, true)]
[EntityDescription("Embedded Static Import File.")]
string ImportEmbeddedFile { get; set; }
Property Value
Type | Description |
---|---|
System.String |
ImportEmbeddedFileType
If the data to import is hardcoded into the step itself (such as for creating test imports) this indicates what type of import file it is.
Declaration
[EntityProperty(SQLType.SmallInt, false)]
[EntityDescription("The type of file to import from the embedded text.")]
ImportDefinitionEmbededTextImportType ImportEmbeddedFileType { get; set; }
Property Value
Type | Description |
---|---|
ImportDefinitionEmbededTextImportType |
ImportSQLWrapperID
Links to ISQLWrapper. Indicates the sql wrapper [more info] to run to retrieve the results to import. These can be custom sql stored procedures that call 3rd party databases, and can be called from LemonEdge using ISQLWrapper.
Declaration
[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityRelationship(EntityID.SQLWrapper, "ID", SingleJoinType.ZeroToOne, "SQLWrapper", "ImportDefinitionStep", DeleteWithRelationship = false, PartOfParentSet = false, InheritPermissions = false, LinkToItemInSet = true)]
[EntityDescription("Retrieves the results of a sql query and uses them as the basis for importing.")]
Guid? ImportSQLWrapperID { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Guid> |
ImportSQLWrapperParams
The parameters to use when running the specified sql query for importing.
Declaration
[EntityProperty(SQLType.NVarChar, true)]
[EntityDescription("The parameters to use when running the specified sql query for importing.")]
string ImportSQLWrapperParams { get; set; }
Property Value
Type | Description |
---|---|
System.String |
ImportStorageRelativeFilePath
Indicates the path/name of a file on the Import Definition Storage Type to poll for
Declaration
[EntityProperty(SQLType.NVarChar, (short)500, true)]
[EntityDescription("The file to import located relative to the specified storage details.")]
string ImportStorageRelativeFilePath { get; set; }
Property Value
Type | Description |
---|---|
System.String |
LastImported
Indicates the last time this step was run. Can be used in formulas to do incremental dated imports.
Declaration
[EntityProperty(SQLType.DateTimeOffset, true)]
[EntityDescription("Indicates the last time this step was run. Can be used in formulas to do incremental dated imports.")]
DateTimeOffset? LastImported { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.DateTimeOffset> |
Name
The unique user friendly name for this step
Declaration
[EntityProperty(SQLType.NVarChar, (short)500, false)]
[EntityDescription("The name of this step in the import definition.")]
[Required]
string Name { get; set; }
Property Value
Type | Description |
---|---|
System.String |
PollingTimeoutInSecs
If the step is using an Import Storage Relative File, this number indicates how long the system should wait to see if the file exists. After this period (in seconds) the system will log an error.
Declaration
[EntityProperty(SQLType.Int, true)]
[EntityDescription("If the import type is a file in storage, this indicates whether or not to poll for the file, and if so how long to timeout (in seconds) when polling for the file.")]
int? PollingTimeoutInSecs { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Int32> |
Sequence
[Key] The sequence specifies which order this step should appear in the grid.
Declaration
[EntityProperty(SQLType.SmallInt, false)]
[EntityDescription("Holds the order of this step within the import definition.")]
[EntitySequence]
short Sequence { get; set; }
Property Value
Type | Description |
---|---|
System.Int16 |