Class DataTemplateFileReader

Namespace

MES.MQC.DataSourceLibrary.Adapters.Files

Assembly

MES.MQC.DataSourceLibrary.dll

public class DataTemplateFileReader : FileReader

Inheritance

object

AdapterBase

FileReader

DataTemplateFileReader

Inherited Members

FileReader.HumanReadableFileCount

FileReader.HumanReadableFileExtensions

FileReader.HumanReadableStartFileNames

FileReader.ReportDateTimeExpected

FileReader.ReadWithHumanReadableFiles(FileReaderContext, AdapterReadResult, IEnumerable<string>)

FileReader.GetHumanReadableFilePath(FileReaderContext)

FileReader.GetHumanReadableFilePaths(FileReaderContext)

FileReader.Validate(FileReaderContext)

FileReader.Execute(FileReaderContext, bool)

AdapterBase.Options

AdapterBase.TransformStringToValue(string)

AdapterBase.TransformStringToDateTime(string)

AdapterBase.TransformStringToDateTime(AdapterContext, string)

AdapterBase.ThrowWarningForEmptyDataProperty(AdapterDataBase, AdapterContextBase, string, string)

AdapterBase.ReadFilePathsInZipFile(string)

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Properties

DataSource

The Data Source of the Adapter. If a report file contains data from multiple data sources, this property has to be to "Unknown" and the DataSource of each AdapterData object has to be defined.

public override string DataSource { get; }

Property Value

string

Description

Description of the Adapter that is visible in the Adapter Dialog as a popover. If the adapter is an API Connector, the description is also shown in the Add/Edit DataSource dialog, when the API Connector is selected. Absolute links get transformed into HTML Link Tags, line breaks (\n) get transformed into HTML line breaks (<br>), HTML tags are not allowed.

public override string Description { get; }

Property Value

string

FileExtensions

File Extensions of the Adapter. This property has to be defined and must have at least one file extension. The Adapter is only used for FilePaths with the defined file extensions. The IsValid method is not called unless the file extension matches.

public override List<string> FileExtensions { get; }

Property Value

List<string>

Name

Unique Name of the Adapter. Defaults to the ClassName (without Adapter / FileReader / ApiConnector suffix), can be overridden with a user defined Name.

public override string Name { get; }

Property Value

string

Priority

Lower priority than base adapters, the default is 100, for the manual import template

public override int Priority { get; }

Property Value

int

Methods

IsValid(FileReaderContext)

Check if the file name does not contain "Configuration"

protected override bool IsValid(FileReaderContext context)

Parameters

context FileReaderContext

Context of file

Returns

bool

true if file is a valid manual import file

Read(FileReaderContext)

There are 2 excel formats that can be imported by this Adapter : First format has this headers (naming and order of columns is important): Artifact|ReportDateTime|DataSource|Measure|Variable|Value autopilot|20.12.2017|MXAM|FindingCount|Aborted|3 Second format has this headers (naming and order of the first two columns is important): Artifact|ReportDateTime|DataSource.Measurement.Measure.Variable|... autopilot|20.12.2017|3|... means that number of columns is in range 3...n and columns format 2 onwards is like "DataSource.Measurement.Measure.Variable", number and order of items is important. Each Excel file can contain more than one sheet, each sheet may have different format

protected override AdapterReadResult Read(FileReaderContext context)

Parameters

context FileReaderContext

Context of file

Returns

AdapterReadResult

All Data is stored in an AdapterData Model object

Examples

example of header for excel in format 2 : Artifact|ReportDateTime|MTest.ModelTest.Assessment Work Progress.Reached|MXAM.GuidelineAnalysis.FindingCount.Aborted