TSM App

Substantially reduces the time required for database requests.

Specifies the amount of time (in seconds) before an attempt to connect is given up on and an error is thrown by the application

<LanguageKey>

Controls the language of the user interface for the TSM.

Display language of the operating system

<LanguageSpecific lang="xx-XX">

See Tag "LanguageSpecific"

<TemplateValidation>

Used for language independent validation of Excel templates.

Cells to validate can be configured as tags with their valid values.

Example:

<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.

• 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".

Redirections have to be configured as tags with following format:

see <Plugin>

see <PluginRedirects>

<Plugin>

<PluginRedirects>

<Plugin>

A plug-in has to be defined according to the following format:

<Plugin File="Name_of_the_DLL.dll" />

• Master Data Administration

• Master Data Import/Export

Both under "Administration".

String

<PluginRedirects>

For language independent allocation of plug-ins, it is possible to configure a redirection. These redirections have to be listed here.

see <PluginRedirect>

<PluginRedirect>

<PluginRedirect>

A redirect has to be defined according to the following format:

<PluginRedirect Source="KalendarCreator" Target="Calendar" />

A source may not map to two different targets.

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:

<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:

<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>

• 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.

<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:

<Diagram Name="Unique_Name"
         Icon="Path_to_icon_file"
         File="diagram identifier"
         IncludeSourceData="true/false"
         Available="true/false"
/>

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

<Templates>

This tag may contain multiple <Template> tags.

see <Template>

<Template>-Tags

<Template>

Path to templates used for opening new workbooks or new worksheets.

The configuration of several templates is possible.

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

• ..\Data\en\Data.xlsm

• ..\Data\en\Data_Milliseconds.xlsm
  (if milliseconds are activated)

String

<DefaultRaster>

Defines the preselected value of the drop-down list "Interval" of the TSM-mask.

1h

Name of a <Raster> tag

<DefaultPagingRaster>

Controls the default value of the interval drop-down list for back and ahead navigation in the ribbon menu.

Template

Name of a <Raster> tag

<DefaultUnit>

Defines the preselected value of the drop-down list "Unit" of the TSM-mask.

DB

Value of attributes "Work" or "Power" from <Unit> tag.

<Units>

Defines the items of the drop-down list "Unit" of the TSM-mask.

see <Unit>

<Unit>-Tags

<Unit>

Defines an item of the drop-down list "Unit" of the TSM-mask.

A unit has to be defined according to the following format:

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

<Rasters>

Defines the items of the drop-down list "Interval" of the TSM-mask.

see <Raster>

<Raster>-Tags

<Raster>

Defines an item of the drop-down list "Interval" of the TSM-mask.

An interval has to be defined according to the following format:

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

The listed negative IDs are available as options for intervals. If a positive ID is used, then this value is interpreted as seconds and in this manner it is possible to freely define intervals in the HAKOM.Config.

Here is an example of a five-minute interval:

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

When using milliseconds, this functionality is also available. However, please note that the value specified under ID is interpreted as milliseconds.

The above example would look like this if milliseconds were used:

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

If milliseconds are activated, the following intervals are used instead of 1sec and 1min:

<TimeSeriesExportTemplate>

Defines the path of the export-template for master data export.

^{..\Data\en\MasterDataExamples.xlsx}

String

<VisploreDiagrams>

Using the tag <VisploreDiagrams> within <LanguageSpecific>, the display name of the diagrams can be changed specifically for that language.

see <Diagram>

<Diagram>-Tags

<Diagram>

With the following entry the display name of a diagram can be changed:

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