Page Comparison

Aktualisierung von SmartTaxBalance 4.0.x und 4.1.x

Benutzer- und Rollenverwaltung

Geänderte Einstellungen

appSettings.config

• Umbennenung: ERiCSendType → EricSendType
• Neuer Einstellungsschlüssel EricEndpointAddress (Adresse des TransferClient-WebService, wurde zuvor in enpoint.config hinterlegt)
• Umbennung: BehaviorForSmartTaxBalanceImportInterface → EndpointBehaviorForWebServices (siehe Schnittstellen)

endpoint.config

• Die Datei endpoint.config ist entfallen

SmartTax.exe.config

• Umbenennung: ERiCService in EricService in binding-Element
• Wegfall der binding-Elemente: GTCMasterDataExportBinding, GTC_MasterData_Export_Binding, GtbBalanceSheetExportBinding, GtcWebServiceExport
• Neues binding-Element: GlobalTaxCenter (ersetzt alle oben genannten Bindungen)

Automatische Aktualisierung des Clients

SmartTaxBalance unterstützt in dieser Version die automatische Aktualisierung der Client-Anwendung. Voraussetzung ist die Verwendung des SmartTaxBalance Servers.

Funktionsweise

Die Aktualisierung wird von der Client-Anwendung angestoßen. Beim Start der Client-Anwendung wird eine Anfrage an den SmartTaxBalance-Server gestellt. Die Anfrage beinhaltet die aktuelle Versionsnummer der Client-Anwendung. Unterscheidet sich diese von der Version des Servers, liefert der Server ein Paket zur Aktualisierung aus. Der Client führt die Aktualisierung aus und startet im Anschluss die Anwendung.

Einrichtung

Die folgenden Schritte sind für Einrichtung eines automatischen Aktualisierungsprozesses notwendig.

Server

Diese Einstellungen müssen in der Konfigurationsdatei des Servers gesetzt werden.

<add key="AutoUpdaterEnabled" value="True" />
<add key="AutoUpdaterFilename" value="C:\Program Files (x86)\AMANA consulting\SmartTaxBalanceServer\AutoUpdate\Client.zip" />

Die Einstellung AutoUpdaterFilename gibt das Paket an, welches dem Client zur Aktualisierung bereitgestellt wird. Weitere Informationen finden Sie unter "Aufbau und Inhalt des Pakets".

Aufbau und Inhalt des Pakets

Das Paket wird in Form eines ZIP-Archives bereitgestellt. Legen Sie mit einem Texteditor eine Datei update.yml an. Diese Datei beschreibt den Aktualisierungsvorgang der auf dem Client ausgeführt wird. Der Inhalt der Datei ist in der Auszeichnungssprache YAML zu formulieren.

Die update.yml sieht auf oberster Ebene zwei Schlüssel vor. 

preserverConfigFor

Dieser Schlüssel gibt an das Konfigurationsdateien vor der Aktualisierung gesichert und nach dem Aktualisieren wieder eingespielt werden. Es werden nur Einstellungen der Form <add key="Setting" value="Value" /> berücksichtigt. Geben Sie eine Liste von ausführbaren Dateien an.

preserveConfigFor:
 - Update.exe
 - SmartTax.exe

steps

Hinter diesem Schlüssel werden die Schritte zur Aktualisierung aufgeführt. Es stehen mehrere Werte zur Verfügung, die im einzelnen erläutert werden. Die Schritte werden als Auflistung definiert und in der Reihenfolge abgearbeitet. Sollte ein Schritt zu einem Fehler führen, werden die folgenden Schritte nicht mehr ausgeführt.

msiexec

Dieser Wert kann verwendet werden um den Windows Installer auszuführen. Hier erhalten Sie weitere Informationen zu den möglichen Parametern.

step:
 - msiexec: /i Installer.msi /q

start

Startet einen Prozess.

kill

...

step:
 - kill: SmartTax
# any other update steps
 - start: SmartTax.exe

Client

Diese Einstellungen müssen in der Konfigurationsdatei der Clients-Anwendung gesetzt werden:

<add key="UseUpdater" value="True"/>
<add key="AutoInstallUpdates" value="True" />

Diese Einstellungen müssen in der Konfigurationsdatei des Updaters gesetzt werden:

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

Tragen Sie dort die IP oder den DNS-Namen des SmartTaxBalance-Servers ein. Geben Sie zusätzlich den Port an, über den der Server erreichbar ist.

Hinweis

Es wird empfohlen die Aktualisierung über den MSI-Installer durchzuführen. Nutzen Sie dazu den entsprechenden Schritt in der update.yml Konfiguration. Die Installation kann ohne Benutzeroberfläche (silent) erfolgen. Entsprechende Parameter sind zu setzen.

Initial sollte die Anwendung pro Benutzer auf einer Maschine installiert werden. Das hat zur Folge, dass die Anwendung unter %AppDataLocal%\Apps\ installiert wird und der Anwender somit folgende Aktualisierungen eigenständig durchführen kann. Dazu muss bei der Ausführung von msiexec die Parameter ALLUSERS=2 MSIINSTALLPERUSER=1 angeführt werden.

Zusätzlich sollte der Schalter \norestart verwendet werden. Da zum Installationszeitpunkt die Update.exe ausgeführt wird und der MSI-Installer auch diese Datei ersetzt, meldet die Installationsroutine, dass ein Neustart notwendig ist. In unserem Fall kann dies aber mit dem o.g. Schalter unterbunden werden.

Probleme bei der Aktualisierung über den Windows Installer

Es kann zu Problemen bei einer Aktualisierung der Programmbibliotheken kommen. In einigen Fällen ändert sich lediglich der öffentliche Schlüssel einer Bibliothek und nicht die Versionsnummer. In diesem Fall aktualisiert der Windows Installer die Bibliothek nicht während der Aktualisierung, da die Datei bereits vorhanden ist. In Folge kommt es zu einem Fehler beim Start der Anwendung.

Wir empfehlen daher in der Datei update.yml vor der Installation mittels

                - msiexec: SmartTaxBalance-Client.msi \i \q

eine Deinstallation auszuführen mittels folgender Anweisung

                - msiexec: \x {product GUID} \q

Die Produkt GUID lässt sich Anhand dieser Anleitung bestimmen.

Es kann auch eine manuelle Aktualisierung erfolgen um dieses Problem zu umgehen.

Manuelle Aktualisierung

Alternativ kann auch eine Aktualisierung per xcopy erfolgen. In diesem Fall muss manuell das alte Installationverteichnis geleert werden (beachten Sie evtl. den Schritt preserveConfigFor einzurichten) und anschließend die neuen Installationsdateien kopiert werden. Um an die Installationsdateien zu gelangen, muss das MSI-Paket entpackt werden und der Inhalt in das „Client.zip“-Archiv gelegt werden.Einige Hinweise gelten nur für den 

Änderungen von 5.0.2 zu 5.0.3

Installation

Die Installationsroutine prüft nun ob das Visual C++ Redistributable 2017 installiert ist. Dies ist eine Anforderung der ERiC-Komponente, welche zur Versendung der E-Bilanz verwendet wird.

Rufen Sie die Seite https://www.visualstudio.com/de/downloads/ auf und laden Sie in der Tabelle unten die korrekte Version des Pakets herunter.

Änderung von 5.0.1 zu 5.0.2

Geänderte Einstellungen

cryptography.config

• Die Datei cryptography.config ist entfallen 

Änderungen von 4.0.8/4.1.2 zu 5.0.1

Migration der Berechtigungen

Mit der Version SmartTaxBalance 5.0 werden die direkt an Benutzer- und Benutzergruppen vergebenen Berechtigungen deaktiviert. Die Dialoge zur Pflege der Berechtigungen sind nicht mehr verfügbar und die bisher vergebenen Berechtigungen haben keinen Einfluss mehr. Stattdessen muss das Rollenkonzept verwendet werden. Um SmartTaxBalance weiterhin nutzen zu können, muss eine Migration der Berichtigungen erfolgen.

Option 1 - Migration per Datenbankskript

Die Migration per Skript ermöglicht es, mit SmartTaxBalance weiter zu arbeiten, ohne sich um die Berechtigungen kümmern zu müssen.

Bei der Migration per Skript wird für jede Berechtigung eine Rolle angelegt. Dadurch gehen die Vorteile des Rollenkonzepts verloren. Der Pflegeaufwand ist relativ hoch, wenn das Berechtigungskonzept geändert werden muss.

Laden Sie dieses Skript herunter und führen Sie es auf der entsprechenden SmartTaxBalance-Datenbank aus.

Führen Sie das Skript nach der Aktualisierung der Anwendung aus.

Option 2 - Manuelle Migration in der Anwendung

Die Migration durch den Anwender ermöglicht es, ein genau abgestimmtes Berechtigungskonzept umzusetzen.

Diese Vorgehensweise ist mit einem erhöhten Aufwand verbunden, führt aber zu einem besseren Berechtigungskonzept. Wir empfehlen daher, diese Option zu wählen.

Führen Sie die folgenden Schritte vor der Aktualisierung der Anwendung durch.

1. Verschaffen Sie sich eine Übersicht über die vergebenen Berechtigungen. Öffnen Sie dazu aus dem Startbildschirm den "Benutzer- und Rechtereport" indem Sie auf Reports | Benutzer | Benutzer- und Rechtereport klicken
2. Erstellen Sie gemäß der vergebenen Berechtigungen geeignete Rollen, in denen die Berechtigungen zusammengefasst werden. Weitere Informationen zur Pflege der Rollen erhalten Sie hier.
3. Ordnen Sie die zuvor erstellten Rollen den Benutzern bzw. Benutzergruppen zu. Beachten Sie, dass Sie die Zuordnung auf eine, mehrere Gesellschaften oder alle Gesellschaften (global) vornehmen können.
4. Prüfen Sie die Berechtigungen, indem Sie den Benutzer- und Rechtereport erneut ausführen. Stellen Sie für jeden Benutzer sicher, dass die direkten Benutzer- und Benutzergruppen-Berechtigungen durch die neu erstellten Rollen abgedeckt sind.

Nutzen Sie dieses Fallbeispiel als Hilfestellung.

Geänderte Einstellungen

Es wurden folgende Änderungen an den Konfigurationsdateien vorgenommen. Wenn Sie die Konfigurationsdateien von einer alten Version übernehmen, müssen diese Änderungen manuell durchgeführt werden.

Weitere Informationen zu den Konfigurationsdateien erhalten sie hier.

appSettings.config 

Status
subtle true colour Green title Client

• Entfall des Schlüssels: ClientAgent bzw. ClientAgent__ 
• Neuer Schlüssel: UseServer (mögliche Werte: True oder False)
  Verwenden sie den Wert True im Client/Server-Betrieb oder False im Standalone-Betrieb
• Neuer Schlüssel: HashingAlgorithm
• Umbennenung: ERiCSendType → EricSendType
• Neuer Schlüssel EricEndpointAddress (Adresse des TransferClient-WebService, wurde zuvor in enpoint.config hinterlegt)
• Umbennung: BehaviorForSmartTaxBalanceImportInterface → EndpointBehaviorForWebServices (siehe Schnittstellen)
• Neuer Schlüssel: DocumentationBaseUrl (Standardwert: https://docs.amana.de/)

endpoint.config 

Status
subtle true colour Green title Client

• Die Datei endpoint.config ist entfallen

SmartTax.exe.config 

Status
subtle true colour Green title Client

• Umbenennung: ERiCService in EricService in binding-Element
• Wegfall der binding-Elemente: GTCMasterDataExportBinding, GTC_MasterData_Export_Binding, GtbBalanceSheetExportBinding, GtcWebServiceExport
• Neues binding-Element: GlobalTaxCenter (ersetzt alle oben genannten Bindungen)