Konfiguration und Wartung

Konfigurationsordner

Der Konfigurationsordner befindet sich jeweils im Installationsverzeichnis der Anwendung (Client oder Server). Der Name des Ordners lautet Config.

Konfigurationsdateien

Im Konfigurationsordner finden Sie Dateien zum Einstellen von SmartTaxBalance. Die Dateien haben die Endung .config und können mit einem Texteditor bearbeitet werden. Beachten Sie, dass in den meisten Fällen administrative Rechte vorhanden sein müssen, da ansonsten kein Schreibzugriff möglich ist. Die Dateien sind für den CLIENT und/oder für den SERVER relevant.

Client/Server Betrieb CLIENT

Die Betriebsart wird in der Datei appSettings.config eingestellt. Passen Sie dazu folgenden Schlüssel entsprechend an:

<add key="UseServer" value="false"/>

Ist die der Wert für den Schlüssel UseServer mit true belegt ist die Angabe der folgenden Einstellungen obligatorisch.

<add key="ServerAddress" value="localhost" />
<add key="ServerPort" value="55555" />

Netzwerksocket CLIENTSERVER

Diese Einstellung ist ab Version 2019.1.1 möglich.

Für die Netzwerkverbindung zwischen dem Client und Server, kann das zugrunde liegende Socket eingestellt werden.

 <add key="Socket.NoDelay" value="true" />
 <add key="Socket.Blocking" value="true" />
 <add key="Socket.ReceiveBufferSize" value="8192" />
 <add key="Socket.SendBufferSize" value="8192" />
 <add key="Socket.ReceiveTimeout" value="10000" />
 <add key="Socket.SendTimeout" value="10000" />
 <add key="Socket.Ttl" value="24" />
 <add key="Socket.DontFragment" value="true" />

Die gezeigten Werte entsprechen den bisher verwendeten Einstellungen.

Die Angabe von ReceiveBufferSize und SendBufferSize erfolgt in Bytes.

Die Angabe von ReceiveTimeout und SendTimeout erfolgt in Millisekunden.

Request Timeout

Diese Einstellung ist ab Version 2019.1.2 möglich.

Für die Netzwerkverbindung zwischen dem Client und dem GTC, kann der request Timeout eingestellt werden.

 <add key="HttpRequestTimeout" value="100" />

Der gezeigten Wert entsprechen der bisher verwendeten Einstellung.

Die Angabe von HttpRequestTimeout erfolgt in Milisekunden

Datenbankverbindung CLIENTSERVER

Die Datenbankverbindung wird in der Datei connections.config konfiguriert. Passen Sie den Eintrag SmartTaxEntities entsprechend an. Weitere Informationen zum Umgang mit der Verbindungszeichenfolge erhalten Sie hier.

Im Client/Server-Betrieb ist die Konfiguration der Datenbankverbindung in der Client-Anwendung wirkungslos.

Logging CLIENTSERVER

Die Konfiguration des Loggings wird in der Datei logging.config vorgenommen.

Um die Ausgabedatei zu ändern, muss das Attribut fileName der Knoten target geändert werden. Weitere Informationen unter https://github.com/nlog/NLog/wiki/Configuration-file#targets

Im Standard wird das Roaming-Verzeichnis des Anwenders verwendet. Dies wird durch eine besondere Syntax erreicht: ${specialfolder:folder=ApplicationData}

Sie können den Pfad dieses Verzeichnisses bestimmen, indem Sie im Explorer in der Adresszeile %appdata% eingeben und mit der Eingabetaste bestätigen.

Beachten Sie die Besonderheit für das lokale System Konto (NT AUTHORITY\SYSTEM): In diesem Fall lautet der Pfad C:\Windows\System32\config\systemprofile\AppData\Roaming. Dieses Konto wird im Standard verwendet, wenn Sie die Server Anwendung als Dienst installieren.

ERiC CLIENT

Die Übermittlung der E-Bilanz über den ELSTER-Rich-Client (ERiC) kann über unterschiedliche Wege erfolgen. Zum einen ist eine Versendung über einen lokalen, in SmartTaxBalance integrierten ERiC, möglich oder über einen Webservice zu dem AMANA TransferClient.

In der Datei appSettings.config kann der Versendeweg festgelegt werden. Im Standard erfolgt die Versendung über den lokalen/integrierten ERiC. Der entsprechende Eintrag lautet:

<add key="EricSendType" value="Local" />

Die möglichen Werte (Attribute value) sind:

value	Beschreibung
Local	Versendung vom lokalen Rechner aus
WebService	Versendung über das AMANA Versendetool
LocalValidationOnly bzw. WebServiceValidationOnly	Nur Versendung als Testfall
NoERiC	Es erfolgt nur eine Instanzerzeugung. Eine Versendung ist nicht möglich.

Wird der WebService benutzt, so muss eine Angabe der WebService-Adresse erfolgen. Verwenden Sie dazu den folgenden Schlüssel:

<add key="EricEndpointAddress" value="<URI>" />

Verschlüsselung CLIENTSERVER

In der Konfigurationsdatei appSettings.config kann das Hashingverfahren, welches für das sichere Ablegen von sensiblen Informationen verwendet wird, eingestellt werden. Passen Sie dazu folgende Einstellung an:

<add key="HashingAlgorithm" value="SHA512" />

Schnittstellen CLIENT

Informationen dazu erhalten Sie im Kapitel Schnittstellen.

Einrichten der Authentifizierung über Kerberos CLIENTSERVER

Server

Stellen Sie in der Datei appSettings.config folgende Konfigurationsparameter ein:

<add key="useSingleSignOn" value="True" />
<add key="SingleSignOnMethod" value="Kerberos" />

Ein ServicePrincipalName (SPN) muss auf der Maschine eingerichtet werden, auf dem der SmartTaxBalance-Server läuft.

Benutzen Sie dazu die folgenden Befehle in der Kommandozeile:

setspn -A SmartTaxBalanceService/<host>:<port> <account>
setspn -A SmartTaxBalanceService/<fqdn>:<port> <account>

Ersetzen Sie <host> durch den Hostnamen der Maschine und <Port> mit dem Port unter dem der SmartTaxBalance-Server konfiguriert ist. Für <fqdn> geben Sie bitte den vollqualifizierten Namen der Maschine innerhalb ihrer Domäne an. Für den Platzhalter verwenden Sie den Account unter dem der SmartTaxBalance Dienst läuft.

Sollte der Dienst unter dem Konto "Lokaler Dienst" oder "Netzwerkdienst" laufen, reicht es aus für <account> den Hostnamen anzugeben.

Weitere Information zum Befehl setspn erhalten Sie unter SetSPN-Syntax (Setspn.exe).

Client

Stellen Sie in der Datei appSettings.config folgende Konfigurationsparameter ein:

<add key="useSingleSignOn" value="True" />
<add key="SingleSignOnMethod" value="Kerberos" />
<add key="ServicePrincipalName" value="SmartTaxBalanceService/<host>:<port>" />

Verwenden Sie die Angaben für <host> und <port> aus der Server-Konfiguration.

Konfiguration innerhalb der Anwendung

XBRL-Einstellungen CLIENT

Die XBRL-Einstellungen können für alle Anwender unter Einstellungen | Globale Einstellungen im Reiter XBRL vorgenommen werden.

Die XBRL-Einstellungen können auch für jeden Anwender individuell unter Einstellungen | Benutzereinstellungen im Reiter XBRL vorgenommen werden.

XBRL Daten cachen

Für das schnellere Abrufen von benötigten Schemadateien der Taxonomie aus dem Internet kann ein Cache verwendet werden. Dabei handelt es sich um einen Ordner, in dem die abgefragten Schemadateien vorgehalten werden. Nach der Installation der Anwendung liegt im Installationsverzeichnis im Ordner "XBRLCache" ein bereits gefüllter Cache.

Wird der Cache erzwungen, finden keine Anfragen in das Internet statt, um Taxonomien aufzulösen. Für den fehlerfreien Betrieb, muss das Cache-Verzeichnis dann alle benötigten Schemadateien enthalten.

Wir empfehlen das Erzwingen des Caches nur in Ausnahmefällen zu verwenden, da wir nicht sicherstellen können, dass das Cache Verzeichnis vollständig ist.

Leistungsanalyse

Es kann Vorkommen, dass die Leistung von SmartTaxBalance nicht den Erwartungen entspricht. Ein möglicher Flaschenhals kann die Kommunikation mit der Datenbank sein.

Um uns in Supportfällen detaillierte Informationen bereitstellen zu können, führen Sie die folgenden Schritte aus:

Aktivieren Sie in der Konfigurationsdatei appSettings.config die Einstellung UseEFCommandInterceptorTracing, indem Sie den Wert auf true setzen.
Führen Sie die Änderung im Stand-Alone-Betrieb im Client aus. Im Client-Server-Betrieb ist die Änderung in der Serverkonfiguration vorzunehmen.

Aktivieren Sie in der Konfigurationsdatei logging.config einen Trace-Logger:

<target xsi:type="File" name="fileTrace" encoding="utf-8" fileName="${specialfolder:folder=ApplicationData}/AMANAconsulting/SmartTaxBalance/Log/SmartTaxBalanceTrace.log" layout="${longdate} ${uppercase:${level}} ${message}" />

<logger name="*" level="Trace" writeTo="fileTrace,consoleTrace" />

Im Client-Server-Betrieb muss die Serverkomponente (Dienst) neugestartet werden.
Im Stand-Alone-Betrieb muss der Client neugestartet werden.
Führen Sie anschließend die Aktionen mit unerwartet langer Laufzeit in der Client-Anwendung aus.
Stellen Sie uns die Trace-Log-Datei zur Analyse bereit. Weitere Informationen dazu erhalten Sie im Abschnitt Logging auf dieser Seite.