Im Folgenden erhalten Sie einen kurzen Überblick, wie Sie beim Update des GlobalTaxCenter (GTC) vorgehen sollten.
Das Auslieferungspaket für die GTC-Anwendung besteht in der Regel aus einem Deployment (Verzeichnis mit Dateien, war-Datei, o.ä.) und einem Verzeichnis mit einem oder mehreren Datenbankskripten.
Nachdem das Auslieferungspaket heruntergeladen wurde, können Sie mit der Installation beginnen.
Genauere Informationen zu den einzelnen Schritten erhalten Sie in den nachfolgenden Abschnitten.
1) Vorbereitende Maßnahmen
1.1) Web Application Server stoppen
- Stoppen Sie den Web Application Server (z.B. Tomcat) wie gewohnt über die Kommandozeile oder den Dienste-Manager.
- Löschen Sie den Inhalt des Verzeichnisses „work“ der Tomcat-Installation.
1.2) Datenbank-Backup durchführen
Sie sollten zuerst ein Datenbank-Backup erstellen, welches wiederhergestellt (Rollback) werden kann, falls das Update fehlschlagen sollte. Informationen, wie dies durchgeführt werden kann, entnehmen Sie bitte dem Benutzerhandbuch Ihres Datenbank-Management-Systems.
1.3) Altes Deployment sichern
- Im Unterverzeichnis "\webapps" des Web Application Server finden Sie das bisher installierte Deployment (i.d.R. mit dem Namen "\gtc").
- Benennen Sie dieses Verzeichnis bzw. die "war"-Datei um (z.B. in "\gtc_alt") und verschieben es anschließend in ein Verzeichnis außerhalb des "\webapps"-Verzeichnisses. Das gesicherte Deployment darf auf keinem Fall im "\webapps"-Verzeichnis verbleiben. Dies würde im späteren Verlauf der Aktualisierung zu schwerwiegenden Fehlern führen.
Nachdem die Vorbereitungen abgeschlossen wurden, können Sie die Datenbank und anschließend das Deployment aktualisieren.
1.4) SAPJCO aktualisieren
Das GTC arbeitet mit einer neuen SAPJCO-Version. Sofern RFC-Verbindungen mit dem GTC angesprochen werden, müssen Sie die folgenden Schritte durchführen, sobald Sie auf die GTC-Version 20.11.03 oder neuer aktualisieren:
- Entfernen Sie die Datei "sapjco3{*}.jar" aus dem Deployment-Verzeichnis "<gtc-root>/lib".
Die nachfolgenden Schritt sind einmalig durchzuführen: - Entfernen Sie ggf. die Datei "sapjco3{*}.jar" aus dem Verzeichnis "<Tomcat-root>/lib".
- Aus lizenzrechtlichen Gründen dürfen wir Ihnen diese Dateien nicht zum Download anbieten oder im Paket verteilen. Laden Sie von das SAP-Support-Seite die Dateien "sapjco3*.dll" bzw. "libsapjco3.so" sowie "sapjco3{*}.jar" herunter.
- Tauschen Sie die dll- bzw. so-Datei aus. (Die Windows-dll wird meistens im system32-Ordner abgelegt.)
Legen Sie die heruntergeladene "sapjco3{*}.jar"-Datei im Verzeichnis "<Tomcat-root>/lib" ab. Die Datei darf nicht umbenannt werden.
2) Datenbank aktualisieren
Es stehen zwei Varianten für die Aktualisierung der Datenbank zur Verfügung. Neben der manuellen Aktualisierung, die im Folgenden beschrieben wird, gibt es nun auch die Möglichkeit, die Aktualisierung der Datenbank automatisch beim Serverstart durchführen zu lassen. Im Abschnitt 4 wird darauf näher eingegangen.
Wenn der Auslieferung SQL-Skripte beiliegen, führen Sie bitte folgende Schritte aus:
- Starten Sie das SQL Server Management Studio ihres Datenbank-Servers und wählen sie das Datenbank-Schema aus, das zur GTC-Applikation gehört.
- Führen Sie die mitgelieferten SQL-Update-Skripte in Sortierreihenfolge der Dateinamen bzw. Versionen auf diesem Schema aus. Nutzen Sie einen Benutzer, der volle Rechte auf der Datenbank hat.
Beispiel:
- 01_MSSQL_8.3.02_8.4.04.sql
- 02_Insert_Reporting_MSSQL.sql
- usw.
Datenbank-Rechte
Nutzen Sie für das Einspielen der Datenbank-Skripte einen Benutzer, der volle Rechte auf dem Datenbank-Schema besitzt. Sonst kann es passieren, dass Tabellen nicht korrekt angelegt oder aktualisiert werden können oder das GTC zur Laufzeit nicht ordnungsgemäß auf die Tabellen zugreifen kann.
Prüfen Sie in jedem Fall die Ergebnisse im Protokoll, ob Auffälligkeiten gegeben sind. Bei Fehlern wenden Sie sich bitte an die Hotline GlobalTaxCenter.
3) Deployment aktualisieren
Automatische Aktualisierung
Kopieren Sie das neue Deployment in das Unterverzeichnis "\webapps", also "<Installationsverzeichnis Tomcat>\webapps\gtc\". Gegebenenfalls müssen Sie das WAR-Archiv mit 7-zip entpacken. Alternativ benennen Sie die Datei gtc.war zu gtc.zip um, dann können Sie den Windows-Explorer dafür verwenden.
Analog zur bisher installierten GTC-Version, muss dem neuen Deployment bekannt gemacht werden, mit welcher Art von Datenbank es sich verbinden soll. Dazu wird in der zentralen "<gtc-root>\WEB_INF\classes\repository.xml"-Datei ein Verweis auf die richtige Datenbank (MySql, Oracle, MS SQL) angelegt. Danach müssen die Verbindungsparameter in der jeweiligen repository_<xyz>.xml aktualisiert werden.
Hinweis zum Kopieren von Konfigurationsdateien
Kopieren Sie nicht einfach die repository.xml-Dateien aus dem alten GTC-Deployment in das neue Deployment. Dies kann zu Fehlern führen, da sich der Inhalt der repository-Dateien mit der Zeit leicht verändern kann.
- Anpassen der Datei "<gtc-root>\WEB_INF\classes\repository.xml":
Hier teilen Sie dem GTC mit, mit welcher Art von Datenbank es sich verbinden soll. Suchen Sie die Zeile: <!ENTITY datasource SYSTEM "repository_mysql.xml"> und ersetzen Sie den Begriff "mysql" ggf. entsprechend Ihrer Datenbankart. Haben Sie Oracle im Einsatz verwenden Sie „oracle“. Verwenden Sie eine MS SQL-Datenbank schreiben Sie „mssql“ (z.B. <!ENTITY datasource SYSTEM "repository_mssql.xml">). - Übertragen Sie die Verbindungseinstellungen aus der "repository_mysql.xml", "repository_oracle.xml" oder "repository_mssql.xml" aus der vorherigen Sicherung in das Verzeichnis "<gtc-root>\WEB-INF\classes\" in die gleichnamige Datei des neuen Deployments.
Falls weitere Anpassungen am Deployment bekannt sind (z.B. in der Datei "web.xml"), übertragen Sie diese bitte auch durch Editieren der jeweiligen Datei.
4) Automatisches Update der Datenbank einrichten (optional)
Bevor das automatische Update eingeschaltet wird, muss die Applikation prüfen, ob die Vorbedingungen für das Update erfüllt sind. Öffnen Sie die Datei <Tomcat>/<GTC>/WEB-INF/web.xml. Suchen Sie den Parameter check-db-migration-state und ändern Sie den Wert auf true. Wenn der Tomcat nun mit der neu ausgelieferten WAR-Datei gestartet wird, überprüft eine interne Routine die Datenbank.
Anschließend öffnen Sie die Logdatei "gtc_dbMigration.log" und überprüfen diese auf Meldungen. Sofern die Vorbedingungen erfüllt sind, können Sie im Prozess fortfahren, ansonsten führen Sie das Datenbank-Update manuell durch.
Stoppen Sie danach den Tomcat und stellen Sie in der Datei "web.xml" die Einstellung use-db-migrations auf "true", damit das GTC die Datenbank beim nächsten Start selbstständig aktualisiert.
Achtung: Die Applikation aktualisiert ohne weitere Abfrage die Datenbank. Bitte prüfen Sie danach unbedingt die Logdatei "gtc_dbMigration.log" auf Fehler.
5) Finale Schritte
- Starten Sie den Web Application Server wie gewohnt über die Kommandozeile oder den Dienste-Manager. Beim Server-Start werden nun u.U. Autorun-Jobs durchgeführt. Diese sind Teil der Aktualisierung und müssen erfolgreich ausgeführt werden. Brechen Sie den Server-Start also nicht ab, auch wenn das Starten länger als gewöhnlich dauert.
- Nach dem Start des WAS-Servers testen Sie den Zugriff auf das GlobalTaxCenter oder informieren Sie Ihre zuständige Fachabteilung, um den Zugriff testen zu lassen, falls Sie selbst keine Zugangsdaten für das GTC haben.
- Wechseln Sie (oder ein berechtigter Vertreter) im Bereich Stammdaten in den Dialog Administration und dort in den Reiter Log und öffnen Sie die Datei "gtc_autorun.log". Prüfen Sie, ob die Autorun-Jobs erfolgreich durchgelaufen sind oder ob Fehlermeldungen angezeigt werden. Im Fehlerfall wenden Sie sich bitte an die Hotline GlobalTaxCenter und schicken die Log-Dateien "gtc_autorun.log" und „gtc_system.log“ mit.
- Falls nach der Aktualisierung Fehler in der Webapplikation auftreten, kontaktieren Sie bitte ebenfalls die Hotline GlobalTaxCenter und senden die Log-Dateien mit.
6) Transfer in andere Instanzen
Wenn Sie mit mehreren Instanzen (Entwicklung, Test, Integration, Produktion, ...) arbeiten, beachten Sie bitte, dass in jeder Instanz die oben genannten Schritte in der gleichen Art und Weise durchgeführt werden müssen.
Beispiel:
- In der Test- und Produktivumgebung ist das GTC in der Version 20.00.01 installiert.
- Sie aktualisieren nun die Testumgebung mit der Version 20.00.03.
- Ein paar Wochen später bekommen Sie ein neues Auslieferungspaket bereitgestellt und aktualisieren die Testumgebung. Diese hat nun die Version 20.00.07.
- Die Produktivumgebung läuft immer noch mit der Version 20.00.01.
- Sie erhalten von der Fachabteilung die Freigabe, das Produktivsystem auf Version 20.00.07 zu aktualisieren.
- Sie müssen in jedem Fall im ersten Schritt die Skripte der Version 20.00.03 einspielen, bevor Sie mit der Installation der Version 20.00.07 fortfahren. Nur so können Sie verhindern, dass ein Schiefstand in der Datenbank entsteht.
7) TransferClient-Installation und Einbindung ins GTC (optional)
Sofern mit dem GTC (Modul Tax Return) auch elektronische Versendungen an die Finanzverwaltung durchgeführt werden, muss in regelmäßigen Abständen das Modul TransferClient (TC) aktualisiert werden, da hierüber die Versendungen durchgeführt werden.
Haben Sie das GTC-Modul Tax Return erworben, beinhaltet die Auslieferungsmail auch immer das Installationspaket für das Modul TransferClient. Jedoch ändert sich nicht zwangsläufig mit jeder GTC-Bereitstellung auch die TC-Version. Um unnötige Aufwände auf Ihrer Seite zu vermeiden, prüfen Sie daher bitte vor dem Update, ob sich die bereits installierte TC-Version und die in der Mail bereitgestellte Version unterscheiden. Die Versionsnummer (=Dateiversion) der installierten TC-Version können Sie in den Eigenschaften der Datei TransferClient.exe einsehen:
Unterscheiden sich die beiden TC-Versionen, installieren Sie neue TC-Version bitte mit Hilfe der hier verlinkten Anleitung. Bei der Installation notieren Sie bitte die Web-Service-URL, da diese später im GTC-Administrationsbereich hinterlegt bzw. aktualisiert werden muss.
Aufgrund technischer Vorgaben durch die Finanzverwaltung, ist ab circa Mitte April eines jeden Jahres die aktuellste ERiC-Version der Finanzverwaltung zu verwenden (Mindestversionserhöhung). Anderenfalls wird ab diesem Zeitpunkt die Annahme der Steuererklärung seitens der Finanzverwaltung verweigert.
Damit weiterhin Steuererklärungen (auch für ältere Veranlagungszeiträume relevant) mit dem GTC versendet werden können, müssen rechtzeitig vor der Mindestversionserhöhung das GTC und das dazugehörige Versendungs-Modul TransferClient aktualisiert werden.
Für die Konfiguration der TC-Verbindung im GTC müssen die nachfolgend genannten Schritte durchgeführt werden. Für die Konfiguration sind Editier-Berechtigungen für die Bereich Stammdaten / Administration notwendig.
- Web Service zum TransferClient aktivieren
- Einrichten des Proxys zwischen GTC und TransferClient (optional)
- Testen der Verbindung zum TransferClient
- Einrichten des Proxys zwischen TransferClient und Finanzverwaltung (optional)
7.1) Web Service zum TransferClient aktivieren
Damit der Elster-Versand als Web Service verfügbar ist, muss folgende Konfiguration vorgenommen werden. Auf der Administrations-Seite wird die Verbindung zum TC ergänzt. (Der TC muss als Web Service gestartet sein.)
Es wird eine neue Verbindung der Kategorie "WebService" eingerichtet. Der Name muss "eric" heißen (auf Groß- und Kleinschreibung achten).
"Host" und "Port" müssen passend zur durchgeführten TC-Installation eingegeben werden. Sofern die Web Service URL des TC nicht auf "eric" endet, muss der letzte Teil der URL (z.B. eric29) in der Verbindung in das Feld Parameter 1 eingegeben werden.
Kategorie | WebService |
Name | eric |
Host | <http://ipOderDns> |
Port | <Port> |
Parameter 1 | <"eric..."> |
7.2) Proxy zwischen GTC und TransferClient (optional)
Der Proxy wird als separater Verbindungsparameter auf der Administrationsseite gepflegt.
Kategorie | Externes System |
Name | atcProxy |
Host | <http://ipOderDns> |
Port | <Port> |
Benutzer | <UserName> |
Passwort | <Password> |
7.3) Verbindungstest zum TransferClient
Nun kann die Verbindung zum TC durch Klick auf das Zahnrad-Symbol (vorne in der Zeile) getestet werden. Es wird anschließend eine Meldung ausgegeben, ob der Test erfolgreich war oder nicht.
Mit diesem Test wird nur die Verbindung zum TC getestet. Es kann immer noch passieren, dass der TC selbst keine Verbindung zur Finanzverwaltung aufbauen kann. Dafür sind ggf. ein Proxy zu konfigurieren oder Ports freizugeben (siehe TC-Anleitung).
Bekannte Fehlermeldungen und deren Lösung sind in einem gesonderten Kapitel dokumentiert.
7.4) Proxy zwischen TransferClient und Finanzverwaltung (optional)
Der Proxy wird als separater Verbindungsparameter auf der Administrationsseite gepflegt.
Kategorie | Externes System |
Name | ericProxy |
Host | <http://ipOderDns> |
Port | <Port> |
Benutzer | <UserName> |
Passwort | <Password> |
Parameter 1 | <"Any"/"Basic"/"Digest"/"DigestIE"/"GSS"/"NTLM"> |