TSM App

Configuration File HAKOM.Config

In Addition to settings relating to databases or general behavour, specific application apperance and behavour such as language, activating plug-ins, etc. are available.  The following describes those settings in detail.

The file is found in the installation directory of the Time Series Manager.

In order for TSM to find and store time series data, either a database connection or a connection to a webservice instance must be configured.

Database Connections

When connecting directly to a database (such as Oracle, PostgreSQL or Microsoft SQL Server) the minimum requirement for using the Time Series Manager is at least one database connection holding actual time series data (HAKOM_TSM).

There must also be exactly one connection configured, which holds authentication and authorization settings (HAKOM_ACL).

You may, of course, configure multiple HAKOM_TSM schemas. These will then be listed in the "Repository" drop-down list in the Time Series plug-in after selecting "PowerTSM Database" as a data source (assuming that the logged in user has the necessary rights configured in the HAKOM_ACL schema)

More detailed information is available here: Configuration

HTTP Connections

Starting with version 3.10.0 of the TSM App, it's also possible to connect to a webservice for accessing time series data. Details on how to configure HTTP connections for use with the TSM App can be found here: Configuration

Each configured HTTP connection will then show up in the "Data source" drop-down list. Note that you may be required to enter credentials before being able to access the list of repositories available from any particular HTTP connection.

TSM App Settings

In the following table all available general settings for the HAKOM TSM App are descripted.

They are located under following base path in the XML structure of HAKOM.config: //HAKOMConfiguration/products/TSM/settings

Tag	Description	Default Value	Possible Values
<LanguageKey>	Controls the language of the user interface for the TSM.	Display language of the operating system	de-DE en-US ru-RU
<LanguageSpecific lang="xx-XX">	See Language Specific Settings
<TemplateValidation>	Used for language independent validation of Excel templates. Cells to validate can be configured as tags with their valid values. Example: XML <TemplateValidation> <A17> <Value>von</Value> <Value>from</Value> <Value>от</Value> </A17> <B17> <Value>bis</Value> <Value>to</Value> <Value>в</Value> </B17> </TemplateValidation> If the tag TemplateValidation does not exist, templates will be validated depending on the configured language. If the tag TemplateValidation is empty, no validation is done. This setting supports the attribute "Extend" . For more information, please refer to the chapter "Advanced Settings"	A17: von from B17: bis to	String
<ShowInformationDialog>	Control if the task progress window stays opened after processing is finished. If an error occurs during processing the window stays openend anyway.	false	Boolean
<AllSheetsChecked>	Controls the default value of checkboxes "all sheets" ("Update" and "Save" sections).	false	Boolean
<AllSheetsRead>	Controls the visibility of the checkbox "all sheets" ("Update" section).	true	Boolean
<AllSheetsReadChecked>	Controls the default value of the checkbox "all sheets" ("Update" section).	false	Boolean
<AllSheetsSave>	Controls the visibility of the checkbox "all sheets" ("Save" section).	true	Boolean
<AllSheetsSaveChecked>	Controls the default value of the checkbox "all sheets" ("Save" section).	false	Boolean
<DatesAndRasterFromTemplate>	Controls the visibility of the checkbox "period from template".	true	Boolean
<DatesAndRasterFromTemplateChecked>	Controls the default value of the checkbox "period from template".	false	Boolean
<WithTime>	Controls the default value of the time-checkbox at "Update" section.	false	Boolean
<DayStart>	Controls the default value of time if the time-checkbox is unchecked.	00:00:00	ISO 8601 time format: [hh]:[mm]:[ss]
<DayStartActive>	Controls the default value of time if the time-checkbox is checked.	Value of <DayStart>	ISO 8601 time format: [hh]:[mm]:[ss]
<AdaptFactor>	Adapt factor for roll out.	100	Double
<DescendingChecked>	Controls the default value of the checkbox "descending".	false	Boolean
<MissingEmptyChecked>	Controls the default value of the checkbox "missing as null".	false	Boolean
<ContinueDays>	Controls the visibility of the checkbox "roll out" and the corresponding button.	true	Boolean
<ContinueDaysChecked>	Controls the default value of the checkbox "roll out".	false	Boolean
<StateValid>	Controls the visibility of the checkbox "all values valid".	true	Boolean
<StateValidChecked>	Controls the default value of the checkbox "all values valid".	false	Boolean
<UseSpreadsheetGearFormulas>	Controls if SpreadsheetGear will be used for calculations of Excel formulas. This setting applies to the TSM SOAP Service for reading and calculating saved templates.	true	Boolean
<Plugins>	Defines the available plug-ins, which will be loaded at start-up of TSM. Further it can be configured, under which drop-down button the plug-in will be added. To achieve this, the plug-in-tag has to be added to one of the following tags: <Automation> - The plug-in will be available under "Automation". <Administration> - The plug-in will be available under "Administration". <Extension> - The plug-in will be available under "Extensions". If the plug-in won't be added to one of those tags, then the plug-in will be available under "Extensions". This setting supports the attribute "Extend" . For more information, please refer to the chapter "Advanced Settings"	see <Plugin> see <PluginRedirects>	<Plugin> <PluginRedirects>
<Plugin>	A plug-in has to be defined according to the following format: XML <Plugin File="Name_of_the_DLL.dll" />	Time Series Plugin Under "Administration": Master Data Administration Master Data Import/Export	<Plugin File="HAKOM.TSM.CalendarCreatorPlugin.dll" /> activates the Calendar Plug-in <Plugin File="HAKOM.TSM.UserManagementPlugin.dll" /> activates the User Management Plug-in <Plugin File="HAKOM.TSM.esales.dll"> activates the esales Plug-in <Plugin File="HAKOM.TSM.LogMonitor.dll" /> activates the Log Monitor <Plugin File="HAKOM.TSM.Batch.dll" /> activates the Automation Plug-in
<PluginRedirects>	For language independent allocation of plug-ins, it is possible to configure a redirection. These redirections have to be listed here. This setting supports the attribute "Extend" . For more information, please refer to the chapter "Advanced Settings"	see <PluginRedirect>	<PluginRedirect>
<PluginRedirect>	A redirect has to be defined according to the following format: XML <PluginRedirect Source="KalendarCreator" Target="Calendar" /> A source may not map to two different targets.	Source Target Zeitreihe TimeSeries KalendarCreator Calendar ZREAGGREGAT TSCAGGREGATE TSCAGGREGAT TSCAGGREGATE	String
<ParallelSavingToDB>	Controls if saving to database will be done in parallel threads.	false	Boolean
<CommentAreaInfo>	Controls if additional information in the comment area (row 2 till row 8) will be set.	false	Boolean
<KISSAImportPlugIn>	Name of the plug-in to be used for processing a KISS-A template.		String
<KISSAImportConnection>	Database connection to be used for processing a KISS-A template.		String
<VisploreTraceLevel>	Defines which processing information during view of TSM Visuals diagrams will be logged. In verbose mode in addition to all messages the input and ouput data will be logged as well.	0	0 till 4 https://docs.microsoft.com/en-us/dotnet/api/system.diagnostics.tracelevel?view=netframework-4.7.2
<VisploreTracePath>	Defines the path, where processing information during view of TSM Visuals diagrams will be saved.	.\VisploreTrace	String
<VisploreAlwaysIncludeSourceData>	Controls if source data, e.g. of formula time series, will be always transfered to TSM Visuals.	false	Boolean
<VisPloreLightStartWithConsole>	Determines whether the console window should be opened when starting the visuals.	false	Boolean
<VisploreCanHandleDataEdits>	Defines, if the button to apply changes to time series data is visible in the TSM Visuals.	false	Boolean
<MaxDegreeOfParallelism>	Defines the maximum number of parallel threads when reading and saving data as well as importing and exporting master data.	10	Integer
<ShowOnlyTSMVisuals>	Controls if only TSM Visuals will be displayed in the ribbon menu and all other controls will be hidden.	false	Boolean
<ImageResourceAssembly>	A custom resource DLL file can be configured to change the icon, graphic and splash screen of TSM.		String
<FlagNames>	List of settings on how flags should be displayed in the context menu Example: XML <HAKOMConfiguration> <products> <TSM> <settings> <LanguageSpecific> <FlagNames> <FlagName Flag="5">5 manually replaced</FlagName> <FlagName Flag="7">7 faulty</FlagName> <FlagName Flag="9">9 valid</FlagName> <FlagName Flag="19">19 missing</FlagName> <FlagName Flag="20">20 accounted</FlagName> <FlagName Flag="21">21 estimated</FlagName> <FlagName Flag="12">12 schedule</FlagName> </FlagNames> </LanguageSpecific> </settings> </TSM> </products> </HAKOMConfiguration>	If these are not set in the HAKOM.Config, the default values for the TSM's set language are used.
<FlagVisibility>	Determins if flags are shown  always (2) only when the sheet is recognized as a valid TSM template (1) never (0)	1	Integer, 0-2
<ValidControlInstructions>	Configures which values can be used to control if a column in the sheet should be written to the data base, updated from the data base or ignored. Example: XML <HAKOMConfiguration> <products> <TSM> <settings> <ValidControlInstructions> <ValidControlInstructionsForNotReading> <Value>nicht lesen</Value> <Value>don't read</Value> </ValidControlInstructionsForNotReading> <ValidControlInstructionsForNotSaving> <Value>nicht speichern</Value> <Value>don't save</Value> </ValidControlInstructionsForNotSaving> <ValidControlInstructionsForIgnore> <Value>ignorieren</Value> <Value>ignore</Value> </ValidControlInstructionsForIgnore> </ValidControlInstructions> </settings> </TSM> </products> </HAKOMConfiguration> This setting supports the attribute "Extend" . For more information, please refer to the chapter "Advanced Settings"	Not reading: nicht lesen don't read Not saving: nicht speichern don't save Ignore: ignorieren ignore	String
<SetCellEmptyIfValueIsNaN>	Controls wether values read which do not evaluate to a valid number (i.e division by zero, etc.) should result in an empty cell	false	Boolean
<AskBeforeSaving>	Determines whether an additional confirmation is required to save data	false	Boolean
<VisploreDiagrams>	Contains the diagrams of the TSM Visuals, which shall be displayed by the Visuals ribbon. XML <Diagram Name="Unique_Name" DisplayName="Display name" />	see <Diagram>	<Diagram>-Tags
<Diagram>	Defines a diagram that shall be displayed by the Visuals ribbon. A diagram has to be defined according to the following format: XML <Diagram Name="Unique_Name" Icon="Path_to_icon_file" File="diagram identifier" IncludeSourceData="true/false" Available="true/false" />	Name File InteractiveTSDashboard Interactive TS Dashboard StructureAnalysis Structure Analysis CorrelationAnalysis Correlation Analysis ConditionOverview Condition Overview PivotSummary Pivot Summary PatternSearchAndComparison Pattern Search and Comparison TimeSeriesDiversity Time Series Diversity DependencyAnalysis Dependency Analysis MultivariateRegression Multivariate Regression DeviationMonitor Deviation Monitor ForecastComparison Forecast Comparison The Available attribute of all diagrams is set to "true" by default. The IncludeSourceData attribute of all diagrams is set to "false" by default. The DisplayName of the diagrams can be found in the table under Tag <LanguageSpecific>
<ShowErrorsOnWorksheetRightClick>	Controls whether error messages that may occur when right-clicking in Excel should be displayed or suppressed.	false	Boolean
<VisploreSenderPortRange>	Defines the range of ports that can be used to transmit data from TSM to Visuals.	51101-51500	Integer Range
<VisploreReceiverPortRange>	Defines the range of ports that can be used to transmit data from Visuals to TSM.	52101-52500	Integer Range
<UpdateSheetFormulasOnTemplateUpdate>	Controls whether or not formulas contained in a template will be updated if the time period in the template is changed. If the setting is true, changes to the time period are automatically taken into account in all corresponding Excel formulas. With the setting as false, affected formulas are not automatically adjusted. When adding rows, this can lead to existing contents in the template being overwritten. It is possible to overwrite the setting defined in the HAKOM.Config by creating a Defined Name with the name of the setting and the desired value true/false. The hierarchy of application is as follows: Defined Names in worksheet Defined Names in workbook HAKOM.Config	false	Boolean

Language Specific Settings

In the follwing table descripted language specific settings are located under following base path in the XML structure of HAKOM.config: //HAKOMConfiguration/products/TSM/settings/LanguageSpecific

The attribute "lang" specifies the language for which these settings apply. Possible values are: "de-DE", "en-US" and "ru-RU". 

<Template Name="Default template">..\Data\en\Data.xlsx</Template>

<Unit Work="kWh" Power="kW" />

<Raster Name="1sec" ID="1" />

<Raster Name="5 Minutes" ID="300" />

<Raster Name="5 Minutes" ID="300000" />

..\Data\en\MasterDataExamples.xlsx

<Diagram Name="Unique_name" DisplayName="Displayname" />

Advanced Settings

Configuration of List Entries

(Extend="true"/"false")

For the settings of the TSM App, default values are provided. Default values can be overridden by simply entering the respective tag with the desired value in the HAKOM.config.

To make it more comfortable with list entries, you can specify if you want to replace or extend the default list by means of an optional attribute "Extend".

For following settings the attribute "Extend" is available:

• Units
• Rasters
• Plugins
• PluginRedirects
• TemplateValidation
• Templates
• ValidControllInsructions

Example

The usage of the "Extend" attribute is shown below using the example of the "Unit" drop-down list of the TSM app.

The selection list has the following units for selection by default:

This drop-down list can be edited via the setting <Units> (the units "template", "DB" and "none" are implemented separately).

If this list is to be replaced, the following entry must be made in the HAKOM.Config:

<HAKOMConfiguration>
	<products>
		<TSM>
			<settings>
				<LanguageSpecific lang="en">
					<Units Extend="false"> <!-- Extend="false" specifies that the default values of the list should be replaced by the following ones. -->
						<Unit Work="NewUnit" Power="NewPower" />
					</Units>
				</LanguageSpecific>
			</settings>
		</TSM>
	</products>
</HAKOMConfiguration>

After a restart the drop-down list looks like this:

As you can see, the default values are no longer included.

If the list is to be extended, the following entry must be made in HAKOM.Config:

<Units Extend="true"> <!-- Extend="true" specifies that the drop-down list should be expanded by the following values. -->
	<Unit Work="NeueUnit" Power="NeuePower" />
</Units>

After a restart the drop-down list looks like this:

As you can see, the default values and the specified values are included in the list.

Support of Milliseconds

To activate time series with intervals less than one second, the setting "InternalTimeUnit" must be added or adjusted. More Information regarding this you find here: Configuration

Raster Adjustment

In order to display the raster correctly in the user interface of the TSM App, the settings under <Rasters> must also be adjusted:

<HAKOMConfiguration>
  <products>
    <TSM>
      <settings>   
        <LanguageSpecific lang="de-DE">
          <Rasters>
            <Raster Name="1ms" ID="1" />
            <Raster Name="10ms" ID="10" />
            <Raster Name="100ms" ID="100" />
            <Raster Name="1sec" ID="1000" />
            <Raster Name="1min" ID="60000" />
          </Rasters>
      </settings>
    </TSM>
  </products>
</HAKOMConfiguration>

This setting must be made explicitly for each language to be supported (e.g. "en-GB", "ru-RU").

Plug-in specific Configuration