Search Results for

    Show / Hide Table of Contents

    Class ImportDefinitionStep

    Inheritance
    object
    BaseEntity
    ImportDefinitionStep
    Implements
    IImportDefinitionStep
    IBaseEntity
    IEquatable<IBaseEntity>
    INotifyPropertyChanged
    INotifyPropertyChanging
    ICloneableAsync
    ICanTrackProperties
    ICloneableAsync<IImportDefinitionStep>
    Inherited Members
    BaseEntity.HISTORY_ENDROWUPDATE_COLNAME
    BaseEntity.HasTrackedPropertyChanged(string)
    BaseEntity.OriginalTrackedPropertyValue(string)
    BaseEntity.OriginalTrackedPropertyValue<T>(string)
    BaseEntity.ClearTrackedOriginalValues()
    BaseEntity.GetAllOriginalTrackedPropertyValues()
    BaseEntity.GetLabel(string)
    BaseEntity.SetLabel(string, string)
    BaseEntity.SetSilentLabel(string, string)
    BaseEntity.ResetChangedTrackedPropertiesToOriginalValues()
    BaseEntity.AddTrackedOriginalValue(string, object)
    BaseEntity.SnapshotProperties()
    BaseEntity.RestoreFromSnapshot(Dictionary<string, object>)
    BaseEntity.IsBasePropertyName(string)
    BaseEntity.IsBaseRelationshipID(string)
    BaseEntity.OnPropertyChanging(string)
    BaseEntity.OnPropertyChanged(string)
    BaseEntity.Equals(IBaseEntity)
    BaseEntity.GetHashCode()
    BaseEntity.Equals(object)
    BaseEntity.Clone(object)
    BaseEntity.CopyFromSource(object)
    BaseEntity.TrackChanges
    BaseEntity.ModifiedByUserID_Label
    BaseEntity.ModifiedByUserID_Label_Silent
    BaseEntity.CanvasID_Label
    BaseEntity.CanvasID_Label_Silent
    BaseEntity.AlgorithmStepID_Label
    BaseEntity.AlgorithmStepID_Label_Silent
    BaseEntity.SafeID_Label
    BaseEntity.SafeID_Label_Silent
    BaseEntity.AccountID
    BaseEntity.ID
    BaseEntity.LastUpdated
    BaseEntity.ModifiedByUserID
    BaseEntity.CanvasID
    BaseEntity.AlgorithmStepID
    BaseEntity.SafeID
    BaseEntity.PropertyChanged
    BaseEntity.PropertyChanging
    object.GetType()
    object.MemberwiseClone()
    object.Equals(object, object)
    object.ReferenceEquals(object, object)
    Namespace: LemonEdge.API.Entities.DataIntegration
    Assembly: LemonEdge.API.Entities.Auto.dll
    Syntax
    [DataContract]
    public class ImportDefinitionStep : BaseEntity, IImportDefinitionStep, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties, ICloneableAsync<IImportDefinitionStep>

    Constructors

    ImportDefinitionStep()

    Declaration
    public ImportDefinitionStep()

    Properties

    ByPassProcessors

    Indicates when importing the data the system should by pass creating processors to process set data. 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 transaction code processing - use with caution.

    Declaration
    public bool ByPassProcessors { get; set; }
    Property Value
    Type Description
    bool

    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
    public bool ByPassValidation { get; set; }
    Property Value
    Type Description
    bool

    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
    [Required]
    [EnumDataType(typeof(ImportDefinitionStepContext))]
    public ImportDefinitionStepContext Context { get; set; }
    Property Value
    Type Description
    ImportDefinitionStepContext

    Context_Tooltip

    Declaration
    [NotMapped]
    public string Context_Tooltip { get; set; }
    Property Value
    Type Description
    string

    DataMappingID

    Links to IDataMapping. Holds any data mapping that should be applied to the import file in order to translate it for processing.

    Declaration
    public Guid? DataMappingID { get; set; }
    Property Value
    Type Description
    Guid?

    DataMappingID_Label

    Declaration
    public string DataMappingID_Label { get; set; }
    Property Value
    Type Description
    string

    DataMappingID_Label_Silent

    Declaration
    [NotMapped]
    public string DataMappingID_Label_Silent { get; set; }
    Property Value
    Type Description
    string

    Enabled

    Indicates if this step should be processed when running the import definition

    Declaration
    public bool Enabled { get; set; }
    Property Value
    Type Description
    bool

    FormulaForImportStorageRelativeFilePath

    This is the formula to use to get the path/name of a file on the Import Definition Storage Type to poll for

    Declaration
    public string FormulaForImportStorageRelativeFilePath { get; set; }
    Property Value
    Type Description
    string

    ImportDefinitionID

    [Key] Links to IImportDefinition. The parent import defintion this step belongs to

    Declaration
    [RequiredNoDefaultIDValidation]
    public Guid ImportDefinitionID { get; set; }
    Property Value
    Type Description
    Guid

    ImportDefinitionID_Label

    Declaration
    public string ImportDefinitionID_Label { get; set; }
    Property Value
    Type Description
    string

    ImportDefinitionID_Label_Silent

    Declaration
    [NotMapped]
    public string ImportDefinitionID_Label_Silent { get; set; }
    Property Value
    Type Description
    string

    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
    public string ImportEmbeddedFile { get; set; }
    Property Value
    Type Description
    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
    [EnumDataType(typeof(ImportDefinitionEmbededTextImportType))]
    public ImportDefinitionEmbededTextImportType ImportEmbeddedFileType { get; set; }
    Property Value
    Type Description
    ImportDefinitionEmbededTextImportType

    ImportEmbeddedFileType_Tooltip

    Declaration
    [NotMapped]
    public string ImportEmbeddedFileType_Tooltip { get; set; }
    Property Value
    Type Description
    string

    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
    public Guid? ImportSQLWrapperID { get; set; }
    Property Value
    Type Description
    Guid?

    ImportSQLWrapperID_Label

    Declaration
    public string ImportSQLWrapperID_Label { get; set; }
    Property Value
    Type Description
    string

    ImportSQLWrapperID_Label_Silent

    Declaration
    [NotMapped]
    public string ImportSQLWrapperID_Label_Silent { get; set; }
    Property Value
    Type Description
    string

    ImportSQLWrapperParams

    The parameters to use when running the specified sql query for importing.

    Declaration
    public string ImportSQLWrapperParams { get; set; }
    Property Value
    Type Description
    string

    ImportStorageRelativeFilePath

    Indicates the path/name of a file on the Import Definition Storage Type to poll for

    Declaration
    [StringLength(500)]
    public string ImportStorageRelativeFilePath { get; set; }
    Property Value
    Type Description
    string

    LastImported

    Indicates the last time this step was run. Can be used in formulas to do incremental dated imports.

    Declaration
    public DateTimeOffset? LastImported { get; set; }
    Property Value
    Type Description
    DateTimeOffset?

    Name

    The unique user friendly name for this step

    Declaration
    [Required]
    [StringLength(500)]
    public string Name { get; set; }
    Property Value
    Type Description
    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
    public int? PollingTimeoutInSecs { get; set; }
    Property Value
    Type Description
    int?

    Sequence

    [Key] The sequence specifies which order this step should appear in the grid.

    Declaration
    public short Sequence { get; set; }
    Property Value
    Type Description
    short

    Methods

    CopyFromEntity(IBaseEntity)

    Declaration
    protected override void CopyFromEntity(IBaseEntity src)
    Parameters
    Type Name Description
    IBaseEntity src
    Overrides
    BaseEntity.CopyFromEntity(IBaseEntity)

    CopyFromSource(IImportDefinitionStep)

    Updates all properties in this item to have the same properties as the source object.

    Declaration
    public void CopyFromSource(IImportDefinitionStep source)
    Parameters
    Type Name Description
    IImportDefinitionStep source

    The source object to copy all values from.

    ToString()

    Declaration
    public override string ToString()
    Returns
    Type Description
    string
    Overrides
    object.ToString()

    Implements

    IImportDefinitionStep
    IBaseEntity
    IEquatable<T>
    INotifyPropertyChanged
    INotifyPropertyChanging
    ICloneableAsync
    ICanTrackProperties
    ICloneableAsync<T>

    Extension Methods

    LinqExtensions.AsArray<T>(T)
    LinqExtensions.ToArrayOfOne<T>(T)
    LinqExtensions.ToListOfOne<T>(T)
    MiscExtensions.SetIfNotEqual<T, TP>(T, Expression<Func<T, TP>>, TP)
    WeakReferenceExtensions.WeakReference(object)
    SQLExtensions.ToSQLValue(object, bool)
    ReflectionExtensions.ClearEventInvocations(object, string)
    StringExtensions.ToCSVFormatString(object, Type)
    In this article
    Back to top © LemonEdge Technologies. All rights reserved.