Vorbereitung

Informieren Sie die Anwender über die bevorstehende Aktualisierung und weisen Sie diese an, sich aus dem VAT@GTC auszuloggen bzw. dieses nicht zu benutzen.

Laden Sie das Aktualisierungspaket über den Link aus der Ihnen zugesendeten E-Mail herunter und entpacken Sie die Zip-Datei (ggf. Passwort beachten).

In Ihrer Auslieferung sollten Sie nach dem Entpacken der bereitgestellten ZIP-Datei folgende Ordnerstruktur vorfinden:

databasescript → alle notwendigen Update-Skripte für die Datenbank
deployment → war-Datei mit der aktuellen Applikation

Aktualisierung VAT@GTC (Apache Tomcat)

1. Web-Applikationsserver stoppen

   1. Stoppen Sie den Web-Applikationsserver (z.B. Tomcat) wie gewohnt über die Kommandozeile oder den Dienstemanager.

   2. Löschen Sie den Inhalt des Verzeichnisses „work“ der Tomcat Installation. 
      
      
2. Altes Deployment sichern

   1. Im Unterverzeichnis \webapps des Web-Applikationsservers finden Sie das bisherige Deployment (i.d.R. mit dem Namen \vat)

   2. Sichern Sie den Ordner oder die Datei *.war außerhalb des \webapps Ordners, bevor Sie Ordner und war-Datei der vorherigen Version entfernen.
      
      

3. Deployment aktualisieren
   1. Entfernen Sie die alte *.war Datei
   2. Kopieren sie die neue *.war Datei in das Unterverzeichnis /webapps
      
      
4. Datenbank aktualisieren
   Wenn Ihrer Auslieferung SQL-Skripte beiliegen, führen Sie bitte folgende Schritte aus:
   1. Automatisiertes Durchführen der Datenbank-Updates (empfohlen) 
      1. Wenn Sie die Datenbank automatisiert aktualisieren lassen, müssen Sie lediglich einen Nutzer zum Starten des VAT@GTC benutzen, der alle benötigten Rechte für die Datenbank hat. 
      2. Zum Serverstart werden die Updates automatisiert eingespielt
      3. Falls es zu Fehlern bei der Migration gekommen ist, erhalten Sie nach dem Login eine Rückmeldung. Kontaktieren Sie bitte unseren Support und schicken uns die Log-Dateien zu.
   2. Manuelles Durchführen der Datenbank-Updates
      1. Speichern Sie die SQL-Update-Skripte. Ab Version 22.07 des VAT@GTC können diese nach dem ersten Serverstart in der Anwendung heruntergeladen werden. Gehen Sie dazu über einen Browser auf die Startseite des VAT@GTC. Dort können Sie die benötigte Datei herunterladen, falls eine Migration erforderlich ist.
      2. Erstellen Sie eine Sicherung der Datenbank, um bei einem eventuellen Skriptfehler
      Inkosistenzen
      1. Inkonsistenzen zu vermeiden. Stellen Sie sicher, dass eine aktuelle wiederherstellbare Sicherung vorliegt.
      2. Starten sie bei einem MSSQL Server das SQL Management Studio oder bei Oracle den SQLDeveloper ihres DB-Servers und wählen sie das DB-Schema aus, das zur VAT@GTC Applikation gehört.
      3. Führen Sie die mitgelieferten SQL-Update-Skripte in Sortierreihenfolge der Dateinamen bzw. Versionen auf diesem Schema aus. Nutzen Sie einen Benutzer, der die erforderlichen Rechte auf der Datenbank hat.
         Beispiel:
         
         • 01_MSSQL_11.00.00_11.00.04.sql
         • 02_Insert_Reporting_MSSQL.sql
         • usw.
      4. Sollte es zu Fehlermeldung bei der Ausführung der Skripte kommen, kontaktieren Sie bitte unseren Support und schicken Sie uns das Ausführungsprotokoll zu.
          
   1. Web-Applikationsserver starten
      1. Starten Sie den Web-Applikationsserver (z.B. Tomcat) wie gewohnt über die Kommandozeile oder den Dienstemanager.
         Beachten Sie bitte, dass der erste Start nach einem Update länger (mehrere Minuten) dauern kann, da evtl. Aktualisierungs-Jobs oder Formular-Updates den Start verzögern.

   Aktualisierung TransferClient

   Beachten Sie hierzu die Installationsanleitung des TC: Installation und Aktualisierung

   Test der Aktualisierung

   1. Testen des Zugriffs auf das VAT@GTC. Loggen Sie sich bitte hierzu mit Ihrem Benutzer ein und kontrollieren auf den Stammdaten → Home, Dialog, Applikations- und Datenbankversion.
      
      
   2. Testen Sie die Verbindung zum TransferClient: Einstellungen → Verbindungsparameter → ElsterWebservice → Verbindungstest
      
      
      

   3. Informieren Sie Ihre zuständige Fachabteilung, um die notwendigen fachlichen Testfälle durchzuführen.

   Abschließende Bemerkungen

   Zum Abschluss noch einige Anmerkungen:

   1. Falls nach der Aktualisierung Fehler in der Webapplikation auftreten, kontaktieren Sie bitte unseren Support und schicken Sie uns die Logdateien aus dem Unterordner „/logs“ der Tomcatinstallation zu.

   2. Wir möchten empfehlen, eine regelmäßige Sicherung der Datenbank durchzuführen, da diese die Daten der Applikation enthält.
   3. Das Deployment muss nicht kontinuierlich gesichert werden. Hier reicht aus, den Stand bei Auslieferung einer Version bereitzuhalten.
   4. Die durchgeführte Konfiguration sollten Sie dokumentieren, damit Anpassungen im Falle von Aktualisierungen des Systems oder einer Wiederherstellung nachvollzogen werden können. Insbesondere Anpassungen, die abweichend von diesem Dokument vorgenommen wurden, sind zu beachten.

Preperation

Inform users about the upcoming update and instruct them to log out of VAT@GTC and not to use it.

Download the update package via the link from the e-mail sent to you and extract the zip file (note the password if necessary).

In your distribution you should find the following folder structure after unpacking the provided ZIP file:

databasescript → all necessary update scripts for the database
deployment → war-file with the current application

Updating the VAT@GTC (Apache Tomcat)

1. Stop the web application server
   1. Stop the web application server (e.g. Tomcat) as usual via the command line or the service manager.
   2. Delete the contents of the "work" directory of the Tomcat installation.
      
      
2. Save old deployment
   1. In the \webapps subdirectory of the Web application server, you can find the previous deployment (usually with the name \vat).
   2. Backup the folder or file *.war outside the \webapps folder before removing the folder and the war file from the previous version.
      
      
3. Update deployment
   1. Remove the old * .war file
   2. Copy the new * .war file to the subdirectory /webapps
      
      
4. Update Database
   If SQL scripts are included with your delivery, please perform the following steps:database
   1. Automated database updates (recommended) 
      
      1. If you execute the database updated automatically, you only need to use a user to start the VAT@GTC who has all the necessary rights for the database. 
      2. The updates are applied automatically when the server is started.
      3. If errors occurred during the migration, you will receive a feedback after logging in. Please contact our support and send us the log files. 
   2. Performing the database updates manually
      1. Save the SQL update scripts. Since version 22.07 of the VAT@GTC, these can be downloaded after the first server start in the application. To do this, go to the VAT@GTC start page via a browser. There you can download the required file if migration is necessary.
      2. Create a backup of the database to avoid inconsistencies in the event of a script error. Make sure you have a current recoverable backup.
      3. Start SQL Management Studio on a MSSQL server or SQLDeveloper on your DB server on Oracle and select the DB schema that belongs to the VAT@GTC application.
      4. Execute the supplied SQL update scripts in the sorted order of the file names or versions on this schema. Use a user who has the required rights on the database.
         Beispiel:
         
         • 01_MSSQL_11.00.00_11.00.04.sql
         • 02_Insert_Reporting_MSSQL.sql
         • usw.
      5. If you get an error message while executing the scripts, please contact our support and send us the execution log.
          
5. Start the web application server
   1. Start the web application server (e.g. Tomcat) as usual via the command line or the service manager.
      Please note that the first start after an update may take longer (several minutes), as possible update jobs or form updates may delay the start.

Updating the TransferClient

Please follow the installation instructions of the TC: Installation and Update

Testing the update

1. Test the access to the VAT@GTC. Please log in with your user and check the master data → Home, Dialog, application and database version.
2. Test the connection to the TransferClient: Settings → Connection information→ ElsterWebservice → Connection test
   
3. Inform your responsible department in order to carry out the necessary specialist test cases.

Final remarks

Finally, a few remarks:

1. If after the update errors occur in the web application, please contact our support and send us the log files from the subdirectory "/logs" of the Tomcat installation.
2. We recommend that you back up the database regularly, as this contains the application data.
3. The deployment does not have to be backed up continuously. Here it is sufficient to keep the status ready when a version is delivered.
4. You should document the configuration you have carried out so that adjustments can be made in the event of system updates or a recovery. In particular, adaptations that deviate from this document should be noted.