Interface ISource

Namespace

Dynamicweb.DataIntegration.Integration.Interfaces

Assembly

Dynamicweb.DataIntegration.dll

Add this interface if you are inheriting from a provider that is a source

public interface ISource

Properties

FilesFolderName

The Name of the files folder in the current installation of Dynamicweb. Empty if used for test.

string FilesFolderName { get; set; }

Property Value

string

Logger

Logger

ILogger Logger { get; set; }

Property Value

ILogger

WorkingDirectory

Gets or sets the working directory. When used for testing, all paths for standard providers are relative to this path.

string WorkingDirectory { get; set; }

Property Value

string

The working directory.

Methods

CheckCondition(MappingConditional, Dictionary<string, object>)

Checks the condition.

bool CheckCondition(MappingConditional mc, Dictionary<string, object> row)

Parameters

mc MappingConditional

The mapping Conditional Collection

row Dictionary<string, object>

The row.

Returns

bool

True if the condition is met, false otherwise

CheckMapping(Mapping)

List<SchemaComparerResult> CheckMapping(Mapping map)

Parameters

map Mapping

Returns

List<SchemaComparerResult>

Close()

Closes this instance.

void Close()

GetOriginalSourceSchema()

Get recent Source Tables Schema from source.

Schema GetOriginalSourceSchema()

Returns

Schema

GetReader(Mapping)

Gets the reader.

ISourceReader GetReader(Mapping mapping)

Parameters

mapping Mapping

The mapping.

Returns

ISourceReader

GetSchema()

Gets the schema.

Schema GetSchema()

Returns

Schema

Initialize()

Initializes this instance.

void Initialize()

LoadSettings(Job)

Loads from the input when the job is run.

This method is run when a job is run, before the actual data transfer takes place. The purpose is to allow settings for source and destination providers to be changed at runtime.

void LoadSettings(Job job)

Parameters

job Job

The job.

OverwriteSourceSchemaToOriginal()

Update current tables schema with most recent schema. Needed for updation of possible old schema loaded from the xml job settings.

void OverwriteSourceSchemaToOriginal()

SaveAsXml(XmlTextWriter)

Saves as XML.

void SaveAsXml(XmlTextWriter textWriter)

Parameters

textWriter XmlTextWriter

The XmlTextWriter.

Serialize()

Serializes this instance for use in AddinSelectors. Output must be of the format yyy, where xxx is the name of AddinParamter, as defined in the decoration, and yyy is the value assigned to the paramter

string Serialize()

Returns

string

Serialized XML output describing addin paramters

UpdateSourceSettings(ISource)

Updates the source settings of the current instance to match the settings of the "destination" paramter.

void UpdateSourceSettings(ISource source)

Parameters

source ISource

The source.

ValidateSourceSettings()

Validates the source settings. Used to validate properties when created by the AddinSelector.

string ValidateSourceSettings()

Returns

string

Tuple of message text and message type