Startseite


Installation von ASYS

Für die Bestandteile von ASYS V7.x gibt es ein Windows-Installationsprogramm, welches alle notwendigen Komponenten von/für ASYS auf einem Zielrechner installiert bzw. aktualisiert.

Die Ausführung des Installationsprogramms ist für eine Installation von ASYS V7.x notwendig, aber in der Regel nicht hinreichend. Bestimmte Einstellungen sind nach einer Installation vorzunehmen bzw. zu ergänzen. Die Installation und Einrichtung einer Datenbank ist kein Bestandteil einer ASYS-Installation.

Die ASYS-7-Installation bringt ihre eigene Java-Laufzeitumgebung (JRE) mit. Diese Laufzeitumgebung wird standardmäßig von allen ASYS-Programmkomponenten (Oberfläche, Administrator, AdminClient, Server-Anwendungen) genutzt, kann aber auf eine andere JRE-Installation umgestellt werden, sofern diese alle von ASYS genutzten Eigenschaften unterstützt1).

Der Java-Rechteinhaber Oracle hat im Jahr 2019 bedeutsame Änderungen vorgenommen bzgl. der Abfolge und Verfügbarkeit von Java-Versionen und ihrer Lizenzierung. Hierzu gehört unter anderem auch das Ende der Bereitstellung von 32-bit-Versionen der Java-Laufzeitumgebung. Aus diesem Grunde können künftig auch nur noch 64-bit-Versionen von ASYS zur Verfügung gestellt werden, die dementsprechend nur noch unter 64-bit-Betriebssystemen lauffähig sind.

Vor der Installation sollte geprüft werden, ob die Anforderungen von ASYS V7.x an die Einsatzumgebung erfüllt werden. Die Informationen auf der Seite Informationen zur Einsatzumgebung sind ebenfalls zu beachten.

Die Kommunikationsbeziehungen von ASYS stellen sich wie folgt dar:

Der AsysComServer sowie die Asys-Web-Server kommunizieren nach außen bzw. werden von außen angesprochen. Darüber hinaus kommunizieren die ASYS-Komponenten auch untereinander. Netzwerktechnisch muss hierbei sichergestellt werden, dass die notwendigen Freigaben, Weiterleitungen etc. eingerichtet sind. Die folgenden Auflistung gibt eine Übersicht über die Kommunikationsbeziehungen und Protokolle.

Komponente(n) Konfigurationsparameter Im Repository zu konfigurieren Standardwert Bemerkungen
Kommunikationsserver OSCI.VPSURI Ja http://vps.zks-abfall.de/osci-manager-entry/externalentry URI unter der die ZKS/VPS bei der KDO zu erreichen ist.
Kommunikationsserver AsysComServerImpl.VerzeichnisdienstHost Ja vzd.zks-abfall.de Einstellungen für den ZKS-Verzeichnisdienst sind vorgegeben - bitte nicht ändern.
Kommunikationsserver AsysComServerImpl.ZKSAuftragServiceHost Ja zad.zks-abfall.de Einstellungen für den synchronen ZKS-Auftragsdienst sind vorgegeben - bitte nicht ändern.
Kommunikationsserver BsaFassade.Host Ja bsa.zks-abfall.de IP-Adresse oder Hostname des BSA-Servers (für alle Bundesländer immer gleich).
GUI/Admin → Kommunikationsserver Kommunikation, Nachrichten → AsysServer → AsysComServer# (Host) Ja kein Standard Angabe für die 'Fernsteuerung' über XML-XPC bzw. REST (ab V7.12); IP-Adresse oder Hostname des Rechners, auf dem der Kommunikationsserver betrieben wird; der Kommunikationsserver muss im Netz erreichbar sein (Firewall etc.).
GUI/Admin → Kommunikationsserver Kommunikation, Nachrichten → AsysServer → AsysComServer# (Port) Ja 8080 (XML-RPC, alt)
8443 (REST, neu)
Angabe für die 'Fernsteuerung' über XML-XPC bzw. REST (ab V7.12); Port unter dem der Kommunikationsserver erreichbar ist; sofern nicht der Standard-Port (siehe Spalte links) verwendet werden kann, muss neben dem Eintrag im Repository auch der Eintrag „<Connector port=„8080“ protocol=„HTTP/1.1“…>„ (für XML-RPC) bzw. “<Connector port=„8443“…scheme=„https…>„ (für REST) in der „\AsysServer\apache-tomcat-9\conf\server.xml“ angepasst werden.
Admin → WebService-Server (alt) Kommunikation, Nachrichten → AsysServer → AsysWebServer (Host) Ja kein Standard der bisherige AsysWebServer entfällt ab der Version 7.12; Angabe für die 'Fernsteuerung' über XML-XPC; IP-Adresse oder Hostname des Rechners, auf dem der WebService-Server betrieben wird; der Web-Service-Server muss im Netz erreichbar sein (Firewall etc.).
Admin → WebService-Server (alt) Kommunikation, Nachrichten → AsysServer → AsysWebServer (Port) Ja 8080 der bisherige AsysWebServer entfällt ab der Version 7.12; Angabe für die 'Fernsteuerung' über XML-XPC; Port unter dem der WebsService-Server erreichbar ist; sofern nicht der Standard-Port (8080) verwendet werden kann, muss neben dem Eintrag im Repository auch der Eintrag “<Connector port=„8080“ protocol=„HTTP/1.1“…>„ in der “…\AsysServer\apache-tomcat-9\conf\server.xml“ angepasst werden.
Admin → Webserviceserver 7 Kommunikation, Nachrichten → AsysServer → AsysWebService7 (Host) Ja kein Standard Angabe für die 'Fernsteuerung' über https; IP-Adresse oder Hostname des Rechners, auf dem der Webserviceserver 7 betrieben wird; der Webserviceserver 7 muss im Netz erreichbar sein (Firewall etc.).
Admin → Webserviceserver 7 Kommunikation, Nachrichten → AsysServer → AsysWebService7 (Port) Ja 8443 Angabe für die 'Fernsteuerung' über https; Port unter dem der Webserviceserver 7 erreichbar ist; sofern nicht der Standard-Port (siehe Spalte links) verwendet werden kann, muss neben dem Eintrag im Repository auch der Eintrag “<Connector port=„8443“…scheme=„https…>„ in der “…\AsysServer\apache-tomcat-9\conf\server.xml“ angepasst werden.
Admin → Funktionsserver Kommunikation, Nachrichten → AsysServer → AsysJobServer (Host) Ja kein Standard Angabe für die 'Fernsteuerung' über XML-XPC bzw. REST (ab V7.12); IP-Adresse oder Hostname des Rechners, auf dem der Funktionsserver betrieben wird; der Funktionsserver muss im Netz erreichbar sein (Firewall etc.).
Admin → Funktionsserver Kommunikation, Nachrichten → AsysServer → AsysJobServer (Port) Ja 8080 (XML-RPC, alt)
8443 (REST, neu)
Angabe für die 'Fernsteuerung' über XML-XPC bzw. REST (ab V7.12); Port unter dem der Funktionsserver erreichbar ist; sofern nicht der Standard-Port (siehe Spalte links) verwendet werden kann, muss neben dem Eintrag im Repository auch der Eintrag „<Connector port=„8080“ protocol=„HTTP/1.1“…>„ (für XML-RPC) bzw. “<Connector port=„8443“…scheme=„https…>„ (für REST) in der “…\AsysServer\apache-tomcat-9\conf\server.xml“ angepasst werden.
Admin → AdminClient Admin.xmlRpcPort Ja 8088 od. 8089 Angabe für die 'Fernsteuerung' über XML-XPC; Port unter dem der AdminClient erreichbar ist.
Nein https://localhost:4434 Feste Adresse und Port für die 'Fernsteuerung' über REST (ab V7.12).
GUI HelpPathURI Ja https://hilfe.gadsys.de/asyshilfe/doku.php?id=awwiki_start Feste Adresse für die Online-Hilfe / das AsysWiki.

Sofern der Kommunikationsserver nur über einen Proxy auf die 'zks-abfall' zugreifen kann, sind die Proxy-Einstellungen ebenfalls im Repository einzutragen (AsysComServerImpl.proxy…).

Hinweis zur Version 7.12: Ab der Version 7.12 wird die interne Kommunikation zwischen den ASYS-Komponenten vollständig von http (XML-RPC) auf https (wie ab der Version 7.11 bereits zwischen Admin → Webserviceserver 7) umgestellt. Beachten Sie, dass dies ggf. weitere Freigaben in Ihren Netzwerken erfordert, damit insbesondere die Kommunikation zwischen GUI → Kommunikationsserver (z.B. für den Versand von BMU-Dokumenten) und zwischen GUI → Funktionsserver (z.B. für die Gruppenprüfung) weiterhin funktionieren.

Ab Version 7.14 wird zu dem jeweiligen ASYS-Installationsprogramm ein Hash-Wert in einer separat bereitgestellten Textdatei - hash.txt - mit ausgeliefert. Mit dieser Information kann die Integrität des Installationsprogramms überprüft werden. Sofern Sie die Integrität prüfen wollen, sollten Sie dies vor der Installation der ASYS-Version durchführen2).

Die Prüfung des Installationsprogramms erfolgt mit dem in Windows enthaltenen Konsolenprogramm CertUtil.

Zur Prüfung können Sie wie folgt vorgehen:

  • Öffnen Sie in dem Verzeichnis, in dem sich das ASYS-Installationsprogramm befindet, ein Konsolenfenster (cmd.exe).
  • Rufen Sie CertUtil mit folgenden Übergabeparametern auf:
certutil -hashfile setupAsys7.###-x64.exe SHA256

oder

certutil -hashfile setupAsys7.###-x64.exe SHA256>meinhash.txt
  • Bei der zweiten Variante wird das Ergebnis der Hashwertermittlung in die Datei meinhash.txt geschrieben.
  • Vergleichen Sie den ausgegebenen Hashwert gegen den Hashwert in hash.txt.
    • Tipp: Der Hashwert ist eine ziemlich lange hexadezimale Zeichenkette. Für einen Vergleich zweier Hashwerte ist es dabei in der Regel nicht erforderlich, die komplette Zeichenkette Zeichen für Zeichen zu vergleichen. Meist genügt es, den Beginn und/oder das Ende der Zeichenketten miteinander zu vergleichen, da sie sich fast immer schon dort unterscheiden, wenn die Werte nicht übereinstimmen.
    • Wenn Sie die Hashwerte Zeichen für Zeichen vergleichen wollen, können Sie sie mit einem einfachen Texteditor (z.B. dem Editor in Windows) so in eine Datei schreiben, dass sie in zwei Zeilen übereinander stehen.

Für ### im Namen des Installationsprogramms ist die jeweilige Versionsnummer einzusetzen! Achten Sie bitte auch darauf, ob in der Datei hash.txt ggf. ein anderes Hashverfahren als SHA256 ausgegeben wird. Dann müssen Sie den letzten Übergabeparameter entsprechend anpassen.

CertUtil gibt Hilfeinformationen zu seinen Übergabenparametern aus mittels

certutil -?

oder

certutil -hashfile -?

In der zweiten Variante werden auch die verfügbaren Hashverfahren mit ihren Abkürzungen ausgegeben.

Mögliche Gründe für unterschiedliche Hashwerte

Wenn die Hashwerte des auf o.g. Weise geprüften ASYS-Installationsprogramms und der Hashwert in hash.txt nicht übereinstimmen, kann dies verschiedene Gründe haben, darunter:

  • Beim Aufruf von CertUtil wurde kein Hashverfahren angegeben3).
  • Beim Aufruf von CertUtil wurde nicht das Hashverfahren angegeben, mit dem der Wert in hash.txt ermittelt wurde.
  • Die von Ihnen geprüfte Version des ASYS-Installationsprogramms ist nicht diejenige, deren Wert in hash.txt enthalten ist4).
  • Bei der Übertragung des ASYS-Installationsprogramms in das Verzeichnis, in dem es geprüft wird, ist ein Fehler aufgetreten - das ist unwahrscheinlich, aber nicht auszuschließen.
  • Das ASYS-Installationsprogramm wurde von dritter Seite verändert - das ist vermutlich noch unwahrscheinlicher, aber ebenfalls nicht auszuschließen.

Wenn die ersten drei Gründe ausgeschlossen werden können, sollten Sie das ASYS-Installationsprogramm erneut herunterladen und prüfen. Bleibt das Problem bestehen, wenden Sie sich bitte an die IKA.

Das Installationsprogramm heißt setupAsys7.xx.yy-x64.exe mit 'xx' für die jeweilige Versionsnummer der Auslieferung und 'yy' für eine Revisions- oder Patch-Nummer.

Details zur jeweiligen Installation finden sich regelmäßig in einem Word-Dokument namens Memo_Auslieferung_R##.#_abc.doc oder Memo_Patch_R##.#_jjmmdd.doc mit '##.#' für die jeweilige Auslieferungsnummer, 'abc' für ein Auslieferungskürzel und 'jjmmdd' für ein Datum.

Nach dem Start des Setup-Programms erscheint folgender Bildschirm (zuvor führt das Setup-Programm ggf. eine Art Selbstprüfung durch):

Willkommensdialog der ASYS 7 Installation

Ein Klick auf den Button Weiter führt zur Auswahl der zu installierenden Komponenten:

Auswahl der Komponenten

Der Baum im zentralen Fenster des Dialog zählt die installierbaren Komponenten auf. Komponenten mit Häkchen werden installiert, Komponenten ohne Häkchen werden bei der Installation ausgelassen. Es sind fünf Installationstypen definiert, die sich über dem zentralen Fenster aus einer Drop-Down-Auswahlbox auswählen lassen. Die Typen sind:

  • Vollständig: (Fast) alle Komponenten werden installiert
  • Administrator: Die Komponenten für einen Administrator-Arbeitsplatz werden installiert
  • Nutzer: Die Komponenten für einen Nutzerarbeitsplatz werden installiert (voreingestellter Installationstyp)
  • Kommunikation: Die Komponenten für einen Kommunikationsserver (Tomcat, AsysComServer7, Batch-Dateien für die Kommunikation) werden installiert
  • Webserviceserver 7: Die Komponenten für einen separaten (standalone) Webserviceserver 7 (Tomcat, AsysWebService7) werden installiert (Hinweis: Auf einem Rechner kann nur ein Tomcat zur gleichen Zeit betrieben werden.)
  • Funktionsserver: Die Komponenten für einen separaten ASYS-Funktionsserver (Tomcat, AsysJobServer) werden installiert (Hinweis wie zuvor).

Darüber hinaus gibt es den Typ Benutzerdefiniert, der immer dann angezeigt wird, wenn die Kombination der zu installierenden Komponenten keinem der anderen Typen entspricht.

Die Typen umfassen aktuell folgende Installationskomponenten:

Installationstypen
Komponente Inhalt Vollständig Administrator Nutzer Kommunikation Webserviceserver 7 Funktionsserver
Administrator (64-bit) Administrator, Tochteranwendung, Katalogdatenbank, Verzeichnisse RepMerged & RepReceived, Batch-Dateien enthalten enthalten nicht enthalten nicht enthalten nicht enthalten nicht enthalten
Oberfläche (64-bit) Oberflächenprogramm, SecSigner, Word-Dateien, interner BMU-Viewer enthalten nicht enthalten enthalten nicht enthalten nicht enthalten nicht enthalten
Kommunikationsserver (64-bit) Tomcat mit AsysComServer-Webapp, Java-JDK, acs-Ordner mit Batch- und Prop-Dateien enthalten nicht enthalten nicht enthalten enthalten nicht enthalten nicht enthalten
Webserviceserver 7 (64-bit) AsysWebService7-Webapp
Die benötigte Tomcat-Umgebung muss mit dem Kommunikationsserver installiert werden!
enthalten nicht enthalten nicht enthalten nicht enthalten nicht enthalten nicht enthalten
Webserviceserver 7 (vollständig) (64-bit) Tomcat mit AsysWebService7-Webapp, Java-JDK
Bitte die Hinweise nach dieser Tabelle beachten!
nicht enthalten nicht enthalten nicht enthalten nicht enthalten enthalten nicht enthalten
Funktionsserver (64-bit) AsysJobServer-Webapp
Die benötigte Tomcat-Umgebung muss mit dem Kommunikationsserver installiert werden!
enthalten nicht enthalten nicht enthalten nicht enthalten nicht enthalten nicht enthalten
Funktionsserver (vollständig) (64-bit) Tomcat mit AsysJobServer-Webapp, Java-JDK
Bitte die Hinweise nach dieser Tabelle beachten!
nicht enthalten nicht enthalten nicht enthalten nicht enthalten nicht enthalten enthalten

Hinweis: Der Tomcat-Anwendungsserver wird immer in ein Unterverzeichnis \AsysServer des ASYS-Installationsverzeichnisses (s.u.) kopiert. Wird im Zuge einer Installation mehr als eine Server-Komponente ausgewählt, bei der ein Tomcat-Anwendungsserver zur Installation gehört, erfolgt trotzdem nur eine Tomcat-Installation in diesem Unterverzeichnis. Die Installation erfolgt so, dass die Server-Komponenten gemeinsam auf einem Tomcat-Anwendungsserver laufen.

Mehrere parallel in verschiedene Verzeichnisse installierte Tomcat-Anwendungsserver können auf einem Rechner nicht gleichzeitig betrieben werden! Sie haben folgende Möglichkeiten:

  1. Sie können für jeden ASYS-Server (Kommunikationsserver, Webserviceserver, Funktionsserver) eine separate Tomcat-Installation vornehmen. Diese müssen auf unterschiedlichen Rechnern/Servern vorgenommen werden.
  2. Sie können innerhalb einer Tomcat-Installation mehrere der genannten ASYS-Server betreiben. Die jeweiligen Deployment-Datei (war-Datei) ist im webapps-Ordner des Tomcat-Installationsordners zu platzieren, bevor der Tomcat-Anwendungsserver gestartet wird.
    1. Wenn Sie mehr als einen Server auf einem Tomcat-Anwendungsserver laufen lassen, müssen dem Tomcat ggf. mehr Speicherressourcen zugewiesen werden.

Über den Button Weiter gelangt man zur Bestimmung des Zielverzeichnisses:

Bestimmung des Zielverzeichnisses für die ASYS 7 Komponenten

Standardmäßig eingestellt ist eine Installation im Verzeichnis C:\Programme\Asys7. Asys kann aber genauso gut in einem beliebig wählbaren anderen Verzeichnis installiert werden (z.B. D:\Asys7) sofern dort ausreichend Rechte für den installierenden Anwender eingerichtet sind. Zusätzlich ist darauf zu achten, dass im Zuge des Ausführung des Programms die individuellen Nutzer temporäre Dateien erzeugen, bearbeiten und löschen können (vgl. hierzu Asys7.ini im Unterverzeichnis \Gui). Da somit das Installationsverzeichnis von ASYS individuell eingestellt sein kann, wird dieses Verzeichnis in dieser Dokumentation auch mit $asys_root bezeichnet. Diese Bezeichnung ist durch den jeweils geltenden Installationspfad zu ersetzen.

Wurde ASYS 7 auf einem Rechner bereits einmal installiert, wird der zuletzt verwendete Installationspfad erneut vorgeschlagen (in der vorhergehenden Abbildung: C:\Asys7).

Durch Auswahl des Buttons Installieren werden die Programmkomponenten im Zielverzeichnis installiert. Der Ablauf der Installation wird in einem Protokollfenster angezeigt, welches nach Abschluss automatisch geschlossen wird.

Installationsprotokoll

Erfolgt die Installation als Update in ein Verzeichnis mit einer vorhandenen ASYS-Installation, so bleiben die landesspezifisch vorgenommene Änderungen im Normalfall erhalten. Sollte dies im Einzelfall nicht möglich sein, ist dies im Versionsmemo erwähnt.

Abschlussdialog

Bitte beachten Sie die Hinweise zu ggf. notwendigen Anpassungen in der Datei $asys_root\system\Asys7.prop.

Mit dem Button Fertig stellen wird das Installationsprogramm beendet.

Hinweise bei einer Installation im Programme-Verzeichnis

Als Standard wird ASYS 7 im Programme-Verzeichnis installiert. Dieses Verzeichnis unterliegt besonderen Restriktionen bzgl. der Schreib- und Änderungsrechte. Bitte beachten Sie, dass der Nutzer des Tomcat für die Verzeichnisse 'apache-tomcat-9\temp\' und 'apache-tomcat-9\logs\' (sofern die Log-Dateien nicht in ein anderes Verzeichnis geschrieben werden) Schreib- und Änderungsrechte erhält.

Bei einer Installation im Programme-Verzeichnis sollten folgende Komponenten in andere Verzeichnisse verschoben werden:

  • das Repository (MbsAsysDEConfig.cob und MbsAsysDEModels.cob): Pfade zum Repository stehen in der system\Asys7.prop
  • die Log-Dateien: Pfade stehen in diversen prop-Dateien, die über den Administrator konfiguriert werden können
  • alle Dokumente zur Texterstellung: Pfade sind im Repository anzupassen (in Allgemeine Konfiguration und bei den Textformulardefinitionen)

Übergabeparameter und 'stille' Installation

Das Installationsprogramm von ASYS V7.x kann mit einer Reihe von Übergabeparametern so eingestellt werden, dass innerhalb der Installation keine der o.g. Auswahlen mehr getroffen werden muss. Die nachfolgende Tabelle dokumentiert die vom Installationsprogramm erkannten Übergabeparameter:

Parameter Auswirkung Anmerkung
/? zeigt nachfolgenden Hilfedialog →

Das Installationsprogramm wird nach diesem Dialog beendet!
/V wählt den Installationstyp 'Vollständig' siehe die Tabelle oben
/A wählt den Installationstyp 'Administrator'
/N wählt den Installationstyp 'Nutzer'
/K wählt den Installationstyp 'Kommunikation'
/W wählt den Webserviceserver 7 (ohne Tomcat) Komponenten: Webserviceserver 7
/F wählt den Webserviceserver 7 (mit Tomcat) Komponenten: Webserviceserver 7 & Tomcat
/J wählt den Funktionsserver (ohne Tomcat) Komponenten: Funktionsserver
/L wählt den Funktionsserver (mit Tomcat) Komponenten: Funktionsserver & Tomcat
/S wählt die 'stille' Installation, d.h. das Installationsprogramm arbeitet ohne weitere Ein- oder Ausgaben die mit den übrigen Parametern ausgewählte (oder per Default eingestellte) Installation ab.
-DIR=[Pfad] wählt ein vom Default (C:\Asys7) abweichendes Zielverzeichnis für die zu installierenden Komponenten.
[Pfad] ist durch einen absoluten Dateipfad - z.B. D:\Asys7_Test - zu ersetzen.
Wenn dieser Parameter verwendet werden soll, so MUSS er als letzter Parameter übergeben werden!

Die Parameter können - mit Ausnahme von /? - kombiniert werden. Eine Kombination führt bei den Auswahlparametern zu einer Addition der Installationskomponenten5).

Nutzerverzeichnis

Im Verzeichnis

C:\Users\%aktueller_Nutzer%\Asys7

werden nutzerspezifische Verzeichnisse und Dateien abgelegt und verwaltet. ASYS benötigt hier Lese- und Schreibrechte auf Betriebssystemebene!

Kollektionen von Vorschlägen für Auswahllisten

In ASYS 6 wurden diverse Auswahllisten über Textdateien (*.txt-Dateien) gefüllt, die in den Ländern individuell angepasst werden konnten. Dieses Prinzip ist auch in ASYS 7 weiterhin vorhanden, nur dass die Kollektionen dort gemeinsam in einer xml-Datei (combobox_items.xml) verwaltet werden. Über den Konfigurationsparameter TextFilePath im Repository kann das Verzeichnis angegeben werden, in dem sich die combobox_items.xml befindet.

Struktur der Einträge in der combobox_items.xml (Beispiel für den „Typ“ beim „Dokument zu Beförderer, Sammler“)

      <ComboBox>
          <comboboxId>Dokumenttypen_BTR_BF</comboboxId>
          <items>
              <item>Nachweis der Fachkunde</item>
              <item>Sonstiges</item>
          </items>
      </ComboBox>

Innerhalb des Tags comboboxId steht der Kollektionsname. Die einzelnen Einträge für die Kollektion werden innerhalb des Tags items als einzelnes item eingetragen. An der Oberfläche werden die Einträge in der Reihenfolge angeboten, in der sie in der xml-Datei stehen. Den Kollektionsnamen für eine Auswahlliste können Sie über das Kontextmenü (rechte Maustaste) Info in der Oberfläche ermitteln.

Kollektionen von Vorschlägen für Textbausteine in Textformularen

Kollektionen für Textbausteine in Textformularen werden gemeinsam in einer xml-Datei (collection_items.xml) verwaltet werden. Über den Konfigurationsparameter TextFilePath im Repository kann das Verzeichnis angegeben werden, in dem sich die collection_items.xml befindet.

Struktur der Einträge in der collection_items.xml (Beispiel für den „Kollektionsnamen“ (zuzuweisen bei den Formularparametern) „TestKollektion“)

      <ComboBox>
          <comboboxId>TestKollektion</comboboxId>
          <items>
              <item>Textbaustein 1</item>
              <item>Textbaustein 2</item>
              <item>Textbaustein 3</item>
          </items>
      </ComboBox>

Innerhalb des Tags comboboxId steht der Kollektionsname. Die einzelnen Einträge für die Kollektion werden innerhalb des Tags items als einzelnes item eingetragen. An der Oberfläche werden die Einträge in der Reihenfolge angeboten, in der sie in der xml-Datei stehen.

Unverbindliche Empfehlung: Ein gutes kostenloses Tool zum Bearbeiten der xml-Einträge ist das Programm Notepad++. Auch zum Bearbeiten beliebiger Textdateien ist das Programm sehr gut geeignet.

Besonderheiten bei einer Update-Installation

Schutz gegen Überschreiben vorhandener Dateien

Damit bei einer Update-Installation lokal vorhandene Dateien nicht einfach durch die Standarddateien einer Auslieferung überschrieben werden - und dabei ggf. vorgenommene Anpassungen an diesen Dateien verloren gehen -, werden einige Dateien durch das Installationsprogramm nicht an den für eine sofortige Nutzung üblichen Ort kopiert, sondern in ein Unterverzeichnis, aus dem sie nach Bedarf (z.B. bei einer Neu- bzw. Erstinstallation) in das eigentlich hierfür vorgesehene Verzeichnis kopiert oder verschoben werden müssen.

  1. Die beiden Repository-Dateien MbsAsysDEConfig.cob und MbsAsysDEModels.cob mit dem ASYS-Repository im Auslieferungszustand werden in das Unterverzeichnis %asys_root%\system\StandardRep geschrieben. Das lokal vorhandene Repository in %asys_root%\system\ bleibt somit erhalten. Es wird durch die Merge-Operation auf den Stand des Auslieferungsrepositorys gebracht.
  2. Die Standard-Textdokumente werden in das Verzeichnis %asys_root%\dokumente\StandardDokumente geschrieben. Die ggf. angepassten Dokumente in %asys_root%\dokumente\ bleiben unverändert erhalten.
  3. Die Word-Makro-Dateien asys_standard_auto.dot und asys_standard_auto_x.dot werden in das Verzeichnis %asys_root%\dokumente\StandardDokumente\steuerdateien kopiert. Eine Unterscheidung in 32- und 64-bit-Varianten gibt es seit der ASYS-Version 6.05.00 nicht mehr!
Mergen der Repositorys

Das lokal vorhandene Repository enthält eine Vielzahl spezifischer Konfigurationseinstellungen, die durch ein ASYS-Update nicht verloren gehen sollen. ASYS-Updates wiederum bedingen häufig Änderungen bzw. Ergänzungen am Repository, die notwendigerweise in die lokalen Repositorys eingepflegt werden müssen. Hierzu werden das lokale und ein Änderungsrepository gemischt (gemerged).

Zum Mergen sind zwei Voraussetzungen notwendig:

  1. Das lokale Repository befindet sich an dem in der Datei %asys_root%\system\Asys#.prop konfigurierten Ort.

    Dieses Repository darf für den Merge-Prozess nicht im Zugriff durch ASYS-Nutzer oder -Programme - wie dem Kommunikationsserver - sein.

  2. Das Änderungsrepository befindet sich im Verzeichnis %asys_root%\RepReceived im ZIP-Archiv sendrep.zip.

Im Verzeichnis %asys_root% befindet sich das Kommandozeilen-Programm mergeRep.bat, welches für den Merge-Prozess aufzurufen ist. Es öffnet sich ein Konsolenfenster und ein Mergen-Dialog.

Aus diesem Dialog heraus werden Funktionen des ASYS-Repository-Administratorprogramms aufgerufen. Damit dies gelingt, muss der Repository-Administrator zuvor mindestens einmal aufgerufen worden sein, um bestimmte interne Dateien anzulegen. Andernfalls erscheint eine Fehlermeldung, weil die Dateien nicht auffindbar sind.

Merge-Konsole und Merge-Dialog

Zuoberst sind die alternative Operationen auswählbar:

Einmergen eines empfangenen Repositories Wählt die Merge-Operation für das lokale Repository und das Änderungsrepository aus. Das Ergebnis der Merge-Operation wird in das Verzeichnis %asys_root%\RepMerged geschrieben, ersetzt also nicht unmittelbar das lokale Repository!
Installation des gemergten Repositories Wählt die Operation zur Ersetzung des bisherigen lokalen Repositories durch das gemergte Repository. Die alten lokalen Repository-Dateien bleiben noch als Kopien im Verzeichnis %asys_root%\RepMerged erhalten (OldConfig.cob und OldModels.cob)
Komprimieren des Repositories Wählt die Komprimierungs-Operation für das Repository. Das lokale Repository wird nicht gemerged, sondern nur komprimiert (bereinigt von nicht mehr genutzten Einträgen). Diese Option stellt eine alternative Aufrufmöglichkeit für die Repositorykomprimierung dar; als Standard wird diese Option auch bei der Beendigung des Administrator-Programms angeboten.

Darunter werden

  • Pfad und Name des lokalen Repositories,
  • der der Status des Repositories (lock-Status: wird das Repository noch von einem Nutzer verwendet und ist es daher gesperrt?) und
  • Pfad und Name des Änderungsrepositories

angezeigt.

Die ausgewählte Operation (per Default nach dem Programmstart: die Merge-Operation) wird über den Button Ausführen gestartet.

Der Ablauf des Merge-Prozesses wird in dem Konsolenfenster protokolliert. Nach Abschluss der Merge-Operation erscheint der Dialog

Abschlussdialog der Merge-Operation

Im Konsolenfenster sollte geprüft werden, ob die Merge-Operation ohne Fehlermeldungen durchgeführt wurde. Wenn Fehlermeldungen aufgetreten sind, sollte das gemergte Repository nicht oder nur nach ausgiebigen Test genutzt werden, das bislang genutzte Repository sollte auf jeden Fall aufbewahrt werden!

Wird der Abschlussdialog mit Ok quittiert, wechselt der Merge-Dialog zur Option der Installation des Repositories. Ist im Konsolenfenster kein Fehler erkennbar, kann das frisch gemergte Repository unmittelbar installiert werden. Hierzu ist erneut der Button Ausführen zu wählen. Nach der Installation erscheint erneut ein Abschlussdialog mit dem Hinweis, dass das neue Repository jetzt genutzt werden kann. Wird der Dialog mit Ok quittiert, werden alle Fenster und Dialoge geschlossen und das Programm beendet. Die Merge-Operation ist damit abgeschlossen.

Asys#.prop

Damit die Programmkomponenten den Speicherort des ASYS-Repositorys erkennen können, greifen sie auf die Datei Asys#.prop im Unterverzeichnis \system des ASYS-Programmverzeichnisses zu. Diese Datei enthält nur zwei Zeilen, z.B.:

Config-Rep=**[PFAD]**\MbsAsysDEConfig.cob
Model-Rep=**[PFAD]**\MbsAsysDEModels.cob

Die Komponenten [PFAD] ist in beiden Zeilen durch den jeweils passenden Dateisystempfad zu ersetzen!

Damit die Installation bei einem Update nicht das vorhandene Repository im \system-Unterverzeichnis mit dem Standard-Auslieferungsrepository überschreibt, wird das Auslieferungsrepository in das Unterverzeichnis \system\StandardRep geschrieben. Bei einer Erstinstallation sollten die beiden Datei in das \system-Unterverzeichnis kopiert werden, um den üblichen Ablageort des Repositorys zu erhalten.

Asys7.ini im Unterverzeichnis \Gui

Über diese Datei lassen sich einige Einstellungen für den Start der ASYS-Benutzeroberfläche vornehmen. Eine Beispielkonfiguration:

-vm
../openjre/bin/javaw.exe
-nl
de
-clean
-clearPersistedState
-data
@none
-vmargs
-Dosgi.framework.extensions=org.eclipse.fx.osgi
-Dosgi.configuration.area=@user.home/.eclipse
-Xms2048m
-Xmx2048m
-Doracle.jdbc.defaultNChar=true
-Doracle.jdbc.convertNcharLiterals=true
-Doracle.jdbc.autoCommitSpecCompliant=false
-Djava.locale.providers=SPI,COMPAT,CLDR
Parameter Bezeichnung Erläuterung
-vm
../openjre/bin/javaw.exe
Pfad zur JavaVM Hier kann ein alternativer absoluter oder relativer Pfad zur einer geeigneten Java-Installation eingetragen werden. In der Standardauslieferung ist ein geeignetes Java-Runtime-Environment (JRE) enthalten, auf das hier verwiesen wird.
Das ausführbare JRE javaw.exe enthält keine Konsole zur Ausgabe von Ereignis- und Fehlermeldungen. Werden diese benötigt, kann die Oberfläche auch mit dem JRE java.exe gestartet werden, welches ein Konsolenfenster öffnet (nicht für den Standardbetrieb gedacht!).

Wird hier auf eine alternative JRE-Installation verwiesen, kann das im ASYS-Installationsverzeichnis enthaltene JAVA-Verzeichnis gelöscht werden. Dabei ist zu beachten, dass ggf. weitere ASYS-Komponenten ebenfalls umgestellt werden müssen!

-nl
de
SWT-Spracheinstellung Einstellung der Spracheinstellung für die SWT-Komponenten der ASYS-7-Oberfläche.
-clean Bereinigung der PlugIns beim Programmstart Sorgt dafür, dass immer die PlugIns aus dem plugins-Verzeichnis - und nicht ggf. gecachte PlugIns - für die Ausführung des Programms verwendet werden.
-clearPersistedState
-data
@none
-vmargs
-Dosgi.framework.extensions=org.eclipse.fx.osgi
-Xms2048m Minimale Stapelspeichereinstellung Die Einstellung der Größe des Stapelspeichers (Heapspace) beim Programmstart. Die Zahl mit dem nachfolgenden Buchstaben gibt die Größe an (hier 2048m = 2 Gigabyte). Erlaubte Größenkennungen sind k=Kilobyte, m=Megabyte und g=Gigabyte.
-Xmx2048m Maximale Stapelspeichereinstellung Die Einstellung der maximalen Größe des Stapelspeichers während der Programmausführung. Zur Bedeutung von Zahl und Buchstaben siehe die Erläuterungen zu Xms.
-Dosgi.configuration.area=@user.home/.eclipse Pfad zu einem Verzeichnis temporärer Dateien des Eclipse-Frameworks Das Eclipse-Framework, auf dem die ASYS-Oberfläche basiert, benötigt ein Verzeichnis für temporäre Dateien, in denen der jeweilige Nutzer von ASYS Lese-, Schreib-, Änderungs- und Löschrechte benötigt. Fehlt ein explizit angegebener Pfad, versucht ASYS diese Dateien in Unterverzeichnisse des ASYS-Installationsverzeichnisses zu schreiben. Das angegebene Beispiel nutzt ein Unterverzeichnis '.eclipse' im Nutzerprofilverzeichnis (@user.home). Das Volumen der temporären Dateien kann - nach bisherigen Erfahrungen - bis zu 100MB umfassen!
-Doracle.jdbc.defaultNChar=true Globalisierungsunterstützung Die Oracle Java Database Connectivity (JDBC) Treiber bieten eine Globalisierungsunterstützung. Globalisierungunterstützung ermöglicht Daten in allen Zeichensätzen zu lesen oder zu schreiben, die Oracle unterstützt. Wenn Client und Datenbankserver unterschiedliche Zeichensätze nutzen, bietet der Treiber Unterstützung bei der Konvertierung zwischen diesen an.
-Doracle.jdbc.convertNcharLiterals=true NChar-Zeichenketten Konvertierung Der Zeichensatz von Datenbankkommandos wird vor der Verarbeitung von Oracle ggf. konvertiert (s. vorherige Zeile). Dies betrifft reine Kommandobestandteile wie auch die eigentlichen Daten. Mit diesem Schalter kann der Konvertierungsverhalten von NChar-Feldinhalten gesteuert werden.
-Doracle.jdbc.autoCommitSpecCompliant=false Auto-Commit Spezifikations Schalter Mit diesem Schalter wird zwischen einer strengen ('true') und einer weniger strengen ('false') Einhaltung der Auto-Commit Spezifikation durch Oracle umgeschaltet.
-Djava.locale.providers=SPI,COMPAT,CLDR Schalter für die Reihenfolge der Provider für landesspezifische Einstellungen Der Schalter muss gesetzt sein, damit das Kalendertool die Woche mit Montag beginnt.

Admin7.ini im Unterverzeichnis \Admin

Über diese Datei lassen sich Einstellungen zum Start des ASYS 7 Administrator-Programms vornehmen. Eine Beispielkonfiguration:

-vm
../openjre/bin/server/jvm.dll
-nl
de
-clean
-clearPersistedState
-data
@none
-vmargs
-Xms256m
-Xmx512m
Parameter Bezeichnung Erläuterung
-vm
../openjre/bin/server/jvm.dll
Pfad zur JavaVM Hier kann ein alternativer absoluter oder relativer Pfad zur einer geeigneten Java-Installation eingetragen werden. In der Standardauslieferung ist ein geeignetes Java-Runtime-Environment (JRE) enthalten, auf das hier verwiesen wird.

Wird hier auf eine alternative JRE-Installation verwiesen, kann das im ASYS-Installationsverzeichnis enthaltene JAVA-Verzeichnis gelöscht werden. Dabei ist zu beachten, dass ggf. weitere ASYS-Komponenten ebenfalls umgestellt werden müssen!

-console Java-Konsole aktivieren Optionaler Parameter, um die JavaVM mit Konsole zu starten. Nur für die Problem- und Fehleranalyse!
-nl
de
SWT-Spracheinstellung Einstellung der Spracheinstellung für die SWT-Komponenten der ASYS-7-Oberfläche.
-clean s. Asys7.ini
-clearPersistedState
-data
@none
-vmargs
-Xms256m Minimale Stapelspeichereinstellung Die Einstellung der Größe des Stapelspeichers (Heapspace) beim Programmstart. Die Zahl mit dem nachfolgenden Buchstaben gibt die Größe an (hier 2048m = 2 Gigabyte). Erlaubte Größenkennungen sind k=Kilobyte, m=Megabyte und g=Gigabyte.
-Xmx512m Maximale Stapelspeichereinstellung Die Einstellung der maximalen Größe des Stapelspeichers während der Programmausführung. Zur Bedeutung von Zahl und Buchstaben siehe die Erläuterungen zu Xms.

AdminClient.ini im Unterverzeichnis \AdminClient

Über diese Datei lassen sich Einstellungen zum Start des ASYS 7 Admin Datenbank- und Test-Tool vornehmen. Eine Beispielkonfiguration:

-vm
../openjre/bin/server/jvm.dll
-nl
de
-clean
-clearPersistedState
-data
@none
-vmargs
-Xms1024m
-Xmx1024m
-Doracle.jdbc.defaultNChar=true
-Doracle.jdbc.convertNcharLiterals=true
-Doracle.jdbc.autoCommitSpecCompliant=false
Parameter Bezeichung Erläuterung
-vm
../openjre/bin/server/jvm.dll
Pfad zur JavaVM Hier kann ein alternativer absoluter oder relativer Pfad zur einer geeigneten Java-Installation eingetragen werden. In der Standardauslieferung ist ein geeignetes Java-Runtime-Environment (JRE) enthalten, auf das hier verwiesen wird.

Wird hier auf eine alternative JRE-Installation verwiesen, kann das im ASYS-Installationsverzeichnis enthaltene JAVA-Verzeichnis gelöscht werden. Dabei ist zu beachten, dass ggf. weitere ASYS-Komponenten ebenfalls umgestellt werden müssen!

-console Java-Konsole aktivieren Optionaler Parameter, um die JavaVM mit Konsole zu starten. Nur für die Problem- und Fehleranalyse!
-nl
de
SWT-Spracheinstellung Einstellung der Spracheinstellung für die SWT-Komponenten der ASYS-7-Oberfläche.
-clean s. Asys7.ini
-clearPersistedState
-data
@none
-vmargs
-Xms1024m Minimale Stapelspeichereinstellung Die Einstellung der Größe des Stapelspeichers (Heapspace) beim Programmstart. Die Zahl mit dem nachfolgenden Buchstaben gibt die Größe an (hier 2048m = 2 Gigabyte). Erlaubte Größenkennungen sind k=Kilobyte, m=Megabyte und g=Gigabyte.
-Xmx1024m Maximale Stapelspeichereinstellung Die Einstellung der maximalen Größe des Stapelspeichers während der Programmausführung. Zur Bedeutung von Zahl und Buchstaben siehe die Erläuterungen zu Xms.
-Doracle.jdbc.defaultNChar=true Globalisierungsunterstützung Die Oracle Java Database Connectivity (JDBC) Treiber bieten eine Globalisierungsunterstützung. Globalisierungunterstützung ermöglicht Daten in allen Zeichensätzen zu lesen oder zu schreiben, die Oracle unterstützt. Wenn Client und Datenbankserver unterschiedliche Zeichensätze nutzen, bietet der Treiber Unterstützung bei der Konvertierung zwischen diesen an.
-Doracle.jdbc.convertNcharLiterals=true NChar-Zeichenketten Konvertierung Der Zeichensatz von Datenbankkommandos wird vor der Verarbeitung von Oracle ggf. konvertiert (s. vorherige Zeile). Dies betrifft reine Kommandobestandteile wie auch die eigentlichen Daten. Mit diesem Schalter kann der Konvertierungsverhalten von NChar-Feldinhalten gesteuert werden.
-Doracle.jdbc.autoCommitSpecCompliant=false Auto-Commit Spezifikations Schalter Mit diesem Schalter wird zwischen einer strengen ('true') und einer weniger strengen ('false') Einhaltung der Auto-Commit Spezifikation durch Oracle umgeschaltet.

setenv.bat im Unterverzeichnis \AsysServer\apache-tomcat...\bin

Über diese Datei kann eingestellt werden, mit welcher Java-Laufzeitumgebung (JRE) die drei ASYS-Serveranwendungen (Kommunikationsserver, WebServer, Funktionsserver) ausgeführt werden sollen. Die Standardauslieferung verweist auf die mitinstallierte JRE-Version im ASYS-Installationsverzeichnis:

@echo off
rem Guess CATALINA_HOME if not defined
[...]

set "CURRENT_DIR=%cd%"
set JH=%JAVA_HOME%
cd..
cd..
cd..
cd jdk13_0_2
set JAVA_HOME=%cd%
[...]

Die Zeilen

cd..
cd..
cd..
cd jdk13_0_2

verweisen aus dem Verzeichnis '…\AsysServer\apache-tomcat…\bin' in das JRE-Verzeichnis (im Beispiel also nach %asys_root%\jdk13_0_2). Bei Nutzung einer alternativen JRE-Installation ist sind hier entsprechende Anpassungen vorzunehmen.

Wird hier auf eine alternative JRE-Installation verwiesen, kann das im ASYS-Installationsverzeichnis enthaltene JAVA-Verzeichnis gelöscht werden. Dabei ist zu beachten, dass ggf. weitere ASYS-Komponenten ebenfalls umgestellt werden müssen!

In der Zeile

set JAVA_OPTS=-Xms2g -Xmx4g -Djava.security.policy="%CATALINA_HOME%\conf\asys.policy" -Doracle.jdbc.defaultNChar=true -Doracle.jdbc.convertNcharLiterals=true -Doracle.jdbc.autoCommitSpecCompliant=false

werden die Speicherparameter für den Tomcat eingestellt (im Beispiel 2 Gigabyte für den 'Initial Memory Pool' (-Xms2g) und 4 Gigbayte für den 'Maximum Memory Pool' (-Xmx4g)). Wird mehr als ein ASYS-Servlet in einer Tomcat-Instanz betrieben, müssen diese Werte ggf. nach oben angepasst werden (z.B. -Xms3g).

Es wird ein Batch-Aufruf ausgeliefert, der den Kommunikationsserver als Dienst einträgt: …\AsysServer\apache-tomcat-x.y.z6)\bin\Install AsysServer service.bat

Der Dienst erhält hierbei den Namen 'Apache Tomcat [VERSION] Tomcat[VERSION]'. Als Standard wird er mit dem Autostarttyp 'Manuell' installiert, d.h. er muss auch als Dienst noch manuell gestartet werden.

Über das Programm …\AsysServer\apache-tomcat-x.y.z\bin\tomcat#w.exe7) können nach der Installation als Dienst bei Bedarf die Parameter des Dienstes eingesehen bzw. geändert werden (z.B. der Autostarttyp, der Dienst-Nutzer (LogOn) oder die Speicherparameter). Über diese '.exe' lässt sich der Dienst auch Starten bzw. Beenden (oder ganz normal über den Windows-Dienst-Manager).

Hinweise zum Nutzer des Dienstes

Der Batch-Aufruf „Install AsysServer service.bat“ enthält einen Befehl zum Setzen des lokalen Systemkontos als Nutzer des Tomcat-Dienstes. Die Ausführung dieses Befehls benötigt Administratorrechte. In Windows 10 wird beim Ausführen einer Windows Batch-Datei im Windows-Explorer mit „Als Administrator ausführen“ nicht das Verzeichnis in dem sich die Datei befindet, sondern das Verzeichnis „c:\Windows\system32“ verwendet. Deshalb wird dann die Tomcat-Batch-Datei für die Installation des Service (service.bat) nicht gefunden. Eine mögliche Lösung ist der Aufruf der Batch-Datei aus einer Eingabeaufforderung mit Administratorrechten (Windows + R → cmd → Ctrl + Shift + Enter → cd [Asys–Root]\AsysServer\apache-tomcat-9\bin → „Install AsysServer service.bat“), alternativ kann der Befehl zum Setzen des Dienstkontos in eine separate Batchdatei ausgelagert werden, die dann aus dem Windows-Explorer via „Als Administrator ausführen“ verwendet werden kann. Am Einfachsten ist es jedoch, den Dienst-Nutzer nach Aufruf der 'tomcat#w.exe' über den Tab-Reiter 'Log On' einzustellen.

Wird der Tomcat ohne Änderung des Dienst-Nutzers gestartet, so läuft er ohne ein persönliches Windows-Nutzerkonto. Das %user_home%-Verzeichnis liegt dann unter „C:\Windows\system32\config\systemprofile“, wo auch Schreibrechte erforderlich sind. Wahrscheinlich wird der Nutzer 'Local Service Account' nicht über die erforderlichen Rechte verfügen, um den Kommunikationsserver vollständig betreiben zu können (z.B. wird wahrscheinlich der Zugriff auf Netzlaufwerke nicht vorhanden sein). Achten Sie daher darauf, dass das ausgewählte Nutzerkonto über ausreichend Rechte verfügt. Detailliertere Vorgaben können hier nicht gemacht werden, da sich die vergebenen Rechte je nach System unterscheiden können.

Werden der Kommunikationsserver, der Funktionsserver und der WebServiceserver gemeinsam unter einem Tomcat betrieben, so sind ggf. die Speicherparamter hochzusetzen. Zur Einstellung ist tomcat#w.exe (gleiches Verzeichnis wie startup.bat) aufzurufen und im sich öffnenden Dialog auf dem Tab-Reiter 'Java' der Initial Memory Pool (Xms) und der Maximum Memory Pool (Xmx) anzupassen:

Einstellungsdialog für Tomcat als Dienst

Im oberen Abschnitt kann die vom Dienst genutzte JavaVM angepasst werden.

Rücknahme der Einrichtung als Dienst

Deinstallieren lässt sich der Dienst über den Batch-Aufruf …\AsysServer\apache-tomcat-x.y.z8)\bin\Remove AsysServer service.bat.

Im ASYS-7-Installationsverzeichnis wird im Zuge der Installation ein Deinstallationsprogramm abgelegt: uninstall.exe. Diese kann direkt aufgerufen werden oder über die Tools der Windows-Systemsteuerung (in Windows 10: Start → Einstellungen → Apps → Apps & Features → Asys7).

Bei der Deinstallation werden der Desktoplink und die Unterverzeichnisse des ASYS-Installationsverzeichnisses, die bei einer Installation neu angelegt werden, samt darin enthaltener Unterverzeichnisse und aller enthaltenen Dateien gelöscht. Der Installationsordner selbst, sowie zusätzlich nach der Erstinstallation darin angelegte Unterverzeichnisse (manuell oder automatisch aus ASYS heraus) und in ihnen enthaltene Dateien bleiben erhalten. Dies gilt auch für die nutzerspezifischen Daten im Nutzerprofil.

Hinweise:

  • Innerhalb der ASYS-Konfiguration eingestellt Ablagepfade (z.B. für Dokumente, Nachrichten, Textdateien, Log-Dateien etc.), bleiben von einer Deinstallation unberührt.
  • Der ASYS-Kommunikationsserver, der ASYS-WebServer und der ASYS-Funktionsserver sind Tomcat-Servletts. Das Tomcat-Verzeichnis, welches diese Komponenten beherbergt (bei einer Standardinstallation im ASYS-Installationsverzeichnis im Unterordner AsysServer), muss manuell gelöscht werden.
    • Ist der ASYS-Kommunikationsserver als Dienst eingerichtet (siehe oben), so kann er über den Batch-Aufruf …\AsysServer\apache-tomcat…\bin\Remove Asys-Comserver service.bat aus den Windows-Diensten wieder entfernt werden. Das sollte natürlich tunlichst geschehen, bevor das Tomcat-Verzeichnis gelöscht wird :-)!

Informationen zur Konfiguration des Zugriffs von ASYS auf eine eingerichtete Datenbank finden sich unter Datenbankzugangsdefinition.

Voraussetzungen prüfen

Bevor eine Datenbank erstellt oder aktualisiert werden kann, muss ein Administratorarbeitsplatz (s.o.) eingerichtet worden sein.

Es müssen folgende Voraussetzungen erfüllt sein, wenn Sie eine Datenbank für ASYS erstellen wollen:

  • In der jeweiligen Datenbank muß genügend freier Platz sein. Das von ASYS benutzte bzw. für ASYS erstellte Datenbankmedium sollte eine Größe von ca. 20 GB haben. Je nach zu erwartenden Datenmengen, kann die Größe nach oben und unten abweichen. Das Datenbankmedium muß aber mindestens eine Größe von 5 GB haben.
  • Es muß ein Nutzer in der Datenbank angelegt werden. Der Name des Nutzers und sein Paßwort sind im Repository abgelegt (Default ist „asys“/“asys“) und können auch dort geändert werden. Dieser Nutzer muß volle Rechte auf der ASYS-Datenbank haben.
  • Die Datenbank muss den Unicode-Zeichensatz UTF-8-codiert unterstützen.

Vollständigkeit des Installationssatzes prüfen

Die Skripte zur Erstellung einer neuen Datenbank können bei der IKA oder Governikus ITU angefordert werden.

Erzeugen einer neuen ASYS-Datenbank

Test-MSAccess-Datenbanken liegen jeder Version bei und ältere Versionen können mit Hilfe von Update-Skripten aktualisiert werden. (s.u.)

Zum Anlegen einer neuen Oracle-, SQLServer- oder MariaDB-Datenbank müssen folgende Skripte mit einem geeigneten Tool ausgeführt werden.

Zum Erstellen der Tabellen:

CreateDB

Zum Erstellen der Views:

CreateVw

Wichtig: ASYS ist sowohl auf das Vorhandensein der Tabellen als auch jeweils dazugehöriger Views zwingend angewiesen! Zu jeder Tabelle (z.B. WBGS UNS) muss es eine passende View (hier: BGS UNS) geben. Mit der View werden alle als gelöscht markierten Datensätze einer Tabelle ausgeblendet. Jegliche Suchen in der Datenbank finden grundsätzlich nur in den Views statt, Änderungen an den Datensätzen immer in den Tabellen.

Zusätzliche Schritte bei einer Oracle-Datenbank

Dieser Schritt muss nur dann ausgeführt werden, wenn ASYS eine Oracle-Datenbank zugrunde liegt.

Zum Erstellen der Sequenzen:

CrSeq

Zum Erstellen der Trigger:

CrTrig
Indizes erstellen

Zum Erstellen der Indizes:

CreatInx
Kataloge importieren

Siehe katpruef und katakt.

Vorgehen beim Update

Da sich das Vorgehen bei jeder Auslieferung ähnelt, wird es nicht immer wieder im jeweiligen Memo zur ASYS-Version9) beschrieben, sondern prinzipiell hier erläutert. Dessen ungeachtet können im Memo spezifische Anweisungen enthalten sein, welche die nachfolgenden Ausführungen ersetzen oder ergänzen!

Mit der Installation des Administrator-Programms werden auch bedarfsweise ein oder mehrere SQL-Skripte zur Aktualisierung der Datenbankstruktur in den Ordner %asys_home%\dbscript kopiert. Diese Dateien sind erkennbar an der Dateiendung *.sql und enthalten im Namen die Nummer der jeweiligen Auslieferung (UpdateXY_ASYS7.#.#.sql mit # für die Versionsnummern der Auslieferung).

Die Skripte mit dem Namen UpdateDB nehmen Änderungen an der Datenbankstruktur vor, also Änderungen an den Tabellen und ihren Feldern. Die Skripte mit dem Namen UpdateDaten korrigieren oder ergänzen Datensätze in der Datenbank. Im Regelfall sollte die Ausführung von Skripten mit dem Namen UpdateDB… vor der Ausführung von Skripten mit dem Namen UpdateDaten… erfolgen, da letztere häufig die Datenbankstrukturänderung voraussetzen. Beachten Sie dessen ungeachtet aber ggf. hiervon abweichende Hinweise in der jeweiligen Memodatei zur Auslieferung.

Oracle, MS-SQL-Server und MariaDB

Das Datenbankupdate kann über das Admin Datenbank- und Test-Tool executesql erfolgen. Für Oracle können auch die Trigger über das Admin Datenbank- und Test-Tool angelegt werden.

Access

Mit der Umstellung von möglichst vielen Bestandteilen von ASYS auf Java 8 oder spätere Java-Versionen muss die bislang genutzte JDBC-ODBC-Bridge aufgegeben werden. Als Ersatz hierfür wird UCanAccess genutzt, mit welchem aber ausschließlich Datenabfragen und -änderungen (Select, Update, Delete) ausführbar sind. Änderungen an der der Datenbankstruktur, wie sie durch die UpdateDB…-Skripte vorgenommen werden (Data Definition Language – DDL-Kommandos – als Untermenge der SQL-Kommandos) lassen sich hierüber aber nicht mehr ausführen. Es ist daher ein alternativer Weg innerhalb der jeweiligen Access-Datenbankdatei erarbeitet worden:

Integration eines VBA-Skriptes in die Datenbankdatei

Für die Access-Datenbankdatei (z.B. Access2003_6_#_#.mdb oder Access_7_#_#.accdb mit # als den jeweiligen Versionsnummern) sind die nachfolgenden Schritte zur Integration des Skriptes nur einmal auszuführen. Das Skript kann danach mit jedem UpdateDB-Skript erneut verwendet werden.

Hinweis: Die nachfolgenden Abbildungen wurden mit MS-Access 2010 erstellt (Version 14 von MS-Office). Die Bedienung oder Beschriftung kann in anderen Versionen von den hier gezeigten in Details abweichen.

  1. Öffnen Sie die Datenbank mit Access (sie benötigen hierzu ein installiertes MS-Access, z.B. aus einem MS-Office-Paket).
  2. Gehen Sie auf den Ribbon Erstellen zum Abschnitt Makros und Code und wählen Sie Visual Basic.
    MS-Access: Erstellen->Visual Basic
  3. Es öffnet sich eine gesonderte Oberfläche für die Entwicklung von VBA-Programmen in Access. Importieren Sie die Datei importAndExecuteSkript.bas, die sich im Verzeichnis %asys_home%\dbskript\access befindet.
    Datei -> Datei importieren
    VBA-Skript wurde importiert
  4. WICHTIG!: Via Extras –> Verweise den Auswahldialog der verfügbaren Verweise (DLLs und ähnliche Funktionsbibliotheken) öffnen und den Eintrag Microsoft Office XX.0 Object Library anhaken und den Auswahldialog über den OK-Button schließen.
    Dialog der Verweise: Microsoft Office XX.0 Object Library ausgewählt
    Der Verweisdialog sollte nach einem erneuten Aufruf in etwa so aussehen:
    Liste der ausgewählten Verweise mit aktivierte Microsoft Office XX.0 Object Library
    Hinweis: Unter Office 16.x trägt der Verweis den Namen Office!
  5. Die Änderungen speichern; es erscheint ein kleiner Dialog, der einfach mit Ok bestätigt wird. Anschließend die VBA-Entwicklungsumgebung schließen.
    Speichern, Modulnamen bestätigen und VBA-Umgebung schließen
  6. In der normalen Access-Anwendungsoberfläche auf dem Ribbon Erstellen im Abschnitt Makros und Code die Funktion Makro wählen. Als neue Makroaktion Ausführen Code auswählen und den Funktionsaufruf executeSkript(true) eintragen.
    Makroaktion 'Ausführen Code' auswählen
    executeSkript(true) als Aufruf eintragen, Datei->Speichern auswählen und Makronamen bestätigen
    Anschließend im Hauptmenübereich Datei den Befehl Speichern auswählen und im erscheinenden Dialog den Makronamen mit Ok bestätigen.
  7. Das Makro ist jetzt dauerhaft in die MS-Access-Datenbankdatei eingefügt und kann jederzeit ausgeführt werden.

Nutzung des VBA-Skriptes mit den UpdateDB-Skripten

  1. Wichtig: Damit die Makroausführung gestartet werden kann, muss die Ausführung von Makros erlaubt werden!
    Makroausführung erlauben
  2. In der Access-Anwendungsoberfläche den Ribbon Datenbanktools auswählen und Makros ausführen wählen. Es erscheint ein Auswahldialog der in der Datenbank bekannten Makros (falls Sie eigene Makros in Ihrer Datenbank haben, müssen Sie ggf. das passende Makro erst auswählen). Das Makro startet über den Ok-Button und öffnet einen Dateiauswahldialog. Wählen Sie das jeweils auszuführende Updateskript aus dem Verzeichnis %asys_home%\dbskript\access und starten Sie die Ausführung über den Ok-Button im Dateiauswahldialog. Die Ausführung des Makros wird durch einen Dialog mit der Meldung Die Skripte wurden ausgeführt abgeschlossen.
    Makro auswählen, Updateskript auswählen und Ausführung starten, Abschlussmeldung
  3. Sie haben bei dieser Art der Aktualisierung leider keine Rückmeldung über die vorgenommenen Änderungen. Eine Kontrolle über die erfolgreiche Durchführung der im jeweiligen Updateskript enthaltenen Anpassungen kann daher nur im Vergleich der im Skript enthaltenen Kommandos mit der Datenbankstruktur nach Ausführung des Makros erfolgen.

Weitere Informationen zu dieser Maske
keine
landesspezifische Zusatzinformationen: SH HH NI HB NW HE RP BW BY SL BE MV ST BB TH SN

Zurück zum Seitenanfang


1)
Die mit ASYS installierte JRE-Version ist entsprechend ausgewählt. Die freigegebenen Java-Versionen finden sich im Gadsys-Confluence!
2)
Das ASYS-Installationsprogramm führt auch eine Selbstprüfung durch.
3)
Ohne Angaben des Hashverfahrens nutzt CertUtil per Default SHA1.
4)
Achten Sie bitte auf den Dateinamen in hash.txt. Prüfen Sie bitte auch, ob das Dateidatum des ASYS-Installationsprogramms zum Dateidatum von hash.txt passt.
5)
Die - nicht sinnvolle - Kombination von /W und /F oder /J und /L entspricht einer doppelten Installation des Web-Service-Servers bzw. Funktionsservers mit und ohne Tomcat. Das Resultat unterscheidet sich aber nicht von einer Installation nur mit dem Parameter /F bzw. /L, da beide Installationen ja in das gleiche Zielverzeichnis erfolgen.
6) , 8)
x.y.z. entsprechend der genutzten Tomcat-Version (die Angabe z ist nicht immer vorhanden)
7)
x.y.z. entsprechend der genutzten Tomcat-Version (die Angabe z ist nicht immer vorhanden); # entsprechend der Hauptversionsnummer x der genutzten Tomcat-Version. Beispiel x.y.z = 9.0 → tomcat9w.exe.
9)
Memo_Auslieferung…doc
  • adm6/thm/installation.txt
  • Zuletzt geändert: 2024/05/02 13:44
  • von eflor