Data Interface

Configuration File HAKOM.Config

All settings concerning the Data Interface in general are located in the HAKOM.Config file in the installation directory of the HAKOM Data Interface. 

Data Interface Settings

Settings

Example

<HAKOMConfiguration>
	<products>
		<TimeSeriesDataInterfaceAssistent>
			<settings>
				<trace>0</trace>
				<HAKOMConfigConnectionName>TSM</HAKOMConfigConnectionName>
				<HAKOMConfigConnectionNameProtocol>TSM</HAKOMConfigConnectionNameProtocol>
				<ConfigFilesPath>.</ConfigFilesPath>
			</settings>
		</TimeSeriesDataInterfaceAssistent>
	</products>
</HAKOMConfiguration>

In addition to the settings listed here it is also necessary to configure the processing of import files and the creation of export files in order to use these features. It is possible to keep these import and/or export configurations in the HAKOM.Config file or create separate configuration files that correspond to specific import/export processes. For better clarity it is recommended to create separate configuration files.

If the import and export configuration is to be located in the HAKOM.Config the settings must be included as follows:

<HAKOMConfiguration>
	<products>
		<ConfigName> <!-- Name of the configuration section -->
			<!-- Import/Export settings -->
		</ConfigName>
	</products>
</HAKOMConfiguration>

Dedicated Configuration Files

In case separate configuration files are prepared for specific import or export runs, the HAKOM.Config located in the Data Interface installation directory must contain the location of these configuration files in the setting "ConfigFilesPath" as described above.

These configuration files must be structured as follows:

<HAKOMConfiguration>
	<products>
		<ConfigName> <!-- Name of the configuration file -->
			<!-- Import/Export settings -->
		</ConfigName>
	</products>
</HAKOMConfiguration>

CSV Import Configuration

The import configuration file has to be tailored to the import file it corresponds to. An import configuration file does not have to contain all settings but only settings needed to correctly process the contents of the import file and achieve the desired outcome.

<Trace>0</Trace>

<ImportPath>C:\Program Files (x86)\HAKOM\CSV\Imports</ImportPath>

<ArchivingPath>C:\Program Files (x86)\HAKOM\CSV\Imports\Archive</ArchivingPath>

<ArchiveFileTimeStampFormat>dd_MM_yyyy_HH_mm</ArchiveFileTimeStampFormat>

<ArchiveFolderTimeStampFormat>dd_MM_yyyy_HH_mm</ArchiveFolderTimeStampFormat>

<TimeSeriesNameFromFileName>0,4</TimeSeriesNameFromFileName>

<SuffixTimeSeriesNameFromFileName>4,-2</SuffixTimeSeriesNameFromFileName>

<TimeSeriesNameSeparator>_</TimeSeriesNameSeparator>

<PrefixTimeSeriesName>ABC.</PrefixTimeSeriesName>

<PostfixTimeSeriesName>.XYZ</PostfixTimeSeriesName>

<ColumnIndexTimeSeriesName>1</ColumnIndexTimeSeriesName>

<ColumnIndexTimeSeriesID>2</ColumnIndexTimeSeriesID>

<ColumnIndexFrom>1</ColumnIndexFrom>

<ColumnIndexTo>2</ColumnIndexTo>

<ColumnIndexDate>1</ColumnIndexDate>

<ColumnIndexTime>2</ColumnIndexTime>

<ColumnIndexFlag>3</ColumnIndexFlag>

<ColumnIndexValue>4</ColumnIndexValue>

<ColumnIndexDataSource>5</ColumnIndexDataSource>

<HeadersIndexTimeSeriesName>1</HeadersIndexTimeSeriesName>

<HeadersIndexUnit>2</HeadersIndexUnit>

<MinValue>5</MinValue>

<MaxValue>50</MaxValue>

<DataUnit>MW</DataUnit>

<TimeFormatString>HH:mm:ss</TimeFormatString>

<DateFormatString>dd.MM.yyyy</DateFormatString>

<DataSourceHeaders>1</DataSourceHeaders>

<DataSourceTimeZone>LT</DataSourceTimeZone>

<DataSourceTimeSeriesType>A</DataSourceTimeSeriesType>

<DataSourceTimeSeriesInterval>60</DataSourceTimeSeriesInterval>

<DataSourceTimeOffset>3600</DataSourceTimeOffset>

<CreationTime>2021-01-01T00:00:00Z</CreationTime>

<CreationTimeFromFileName>8,yyyMMdd_HHmm</CreationTimeFromFileName>

<CreationTimeFromFileHeader>2,4,yyyMMdd_HHmm</CreationTimeFromFileHeader>

<CreationTimeAsQuotationTime>true</CreationTimeAsQuotationTime>

<FlagMapping>220,9;67,9;ZZZ,19</FlagMapping>

<DataSeparator>,</DataSeparator>

<FileFilter>*.txt</FileFilter>

<NumberDecimalSeparator>.</NumberDecimalSeparator>

<NumberGroupSeparator>,<NumberGroupSeparator>

<SortCriteria>filedate</SortCriteria>

<SortDirection>ascending</SortDirection>

<Encoding>windows-1250</Encoding>

CSV Export Configuration

<Trace>0</Trace>

<ExportPath>C:\Program Files (x86)\HAKOM\CSV\Exports</ExportPath>

<ExportFilename>##TS-ID## ##DATE##.csv</ExportFilename>

<ExportFileNameDateFormat>yyyyMMdd</ExportFileNameDateFormat>

<ExportFileNameTimeFormat>HHmmss</ExportFileNameTimeFormat>

<CSVHeader>Data from ##FROMDATE## to ##TODATE##</CSVHeader>

<CSVHeaderDateFormat>dd.MM.yyyy</CSVHeaderDateFormat>

<ExportPeriod>month</ExportPeriod>

<ExportPeriodSeparator>15</ExportPeriodSeparator>

<SkipMissingData>true</SkipMissingData>

<Interval>-4</Interval>

<ExportCalculationFormula>[this]+2</ExportCalculationFormula>

<ExportCalculationInterval>-3</ExportCalculationInterval

<CSVSeparator>,</CSVSeparator>

<ExportColumns>
	<Field Name ="FromDate" Format ="yyyyMMdd hh:mm"/>
</ExportColumns>

<ExportColumns>
	<Field Name ="ToDate" Format ="yyyyMMdd hh:mm"/>
</ExportColumns>

<ExportColumns>
	<Field Name ="Flag"/>
</ExportColumns>

<ExportColumns>
	<Field Name ="Value" Format ="0:0.00"/>
</ExportColumns>

<ExportColumns>
	<Field Name ="TimeZoneFrom"/>
</ExportColumns>

<ExportColumns>
	<Field Name ="TimeZoneTo"/>
</ExportColumns>

<ExportColumns>
	<Field Name ="DaylightSavingHourFrom"/>
</ExportColumns>

<ExportColumns>
	<Field Name ="DaylightSavingHourTo"/>
</ExportColumns>

<Unit>MW</Unit>

<UseDayLighSaving>True</UseDayLightSaving>

<MapFlag>
	<Flag HAKOMFlag="19" TargetValue="xyz">
	<Flag HAKOMFlag="9" TargetValue="100">
</MapFlag>

<DayNames>MON;SAT</DayNames>

Encoding

For CSV exports only UTF-8 character encoding is supported.

Export of Multiple Time Series

It is possible to export multiple time series in one export file. The following configuration settings may be extended for this purpose:

Value Format

In the export configuration file multiple formats for values can be defined:

<Field Name="Value" Format="0.0" DecimalSeparator="," GroupSeparator=""/>
<Field Name="Value1" Format="0.000" DecimalSeparator="," GroupSeparator=""/>
<Field Name="Value2" Format="0.0000000" DecimalSeparator="," GroupSeparator=""/>

For all exported time series a value format should be provided, for all additional time series without a specific configuration the format of "Value" will be applied. In case no "Value" entry exists only time series with an applicable format will be exported.

Interval

In the export configuration file multiple intervals can be defined:

<Interval>900</Interval>
<Interval1>3600</Interval1>

For all exported time series an interval should be provided, for all additional time series without a specific configuration the interval of the setting "Interval" will be applied. In case no "Interval" entry exists only time series with an applicable interval will be exported.

Individual Import/Export Parameters

For both import and export configuration files it is also possible to define placeholders for certain configuration settings and provide the values for these settings when starting the import or export process with the console command.

The relevant settings need to be configured as follows in the import or export onfiguration file:

<HAKOMConfiguration>
	<products>
		<ConfigName>
			<Setting>##Placeholder##</Setting>
		</ConfigName>
	</products>
</HAKOMConfiguration>

The string used as a placeholder (in this example "Placeholder") may be freely chosen, the leading and trailing "##" must be present in order to use this functionality.

When starting an import or export run the value for the setting can be provided as shown here using the example of an import command:

HAKOM.Framework.DataInterface.Console.exe import csv -c {Name_of_configuration_file} -p Placeholder=3