Dokumentationsserver

Konfiguration

Folgende Schritte sind zur Verwendung des Dokumentationsservers notwendig:

• Laden der Dokumentationsserverkomponente
• Konfigurierung der Dokumentationsserverkomponente
• Veröffentlichung der Lösung auf dem Dokumentationsserver

Laden

Zum Laden dieser Komponente klicken Sie auf Hinzufügen im Menü Dokumentationsserver.

Weitere Informationen zur Dialogbox Laden einer Komponente finden Sie in der Dokumentation Parametererfassungskomponente.

Die Konsole beschafft sich die verschiedenen Parameter der Dokumentationsserverkomponente.

Der Wert des Status der Komponente Dokumentation ist Nicht konfiguriert. Einmal konfiguriert, ändert sich dieser Wert nach In Betrieb.

Konfiguration

Dokumentationsformat

Es gibt zwei verschiedene Dokumentationsformate, die sich nach dem verwendeten Client und nach dem Betriebssystem richten:

• Komprimiertes Format (CHM)
  • Nur für einen CS-Client, wenn der Dokumentationsserver auf einer Windows-Maschine installiert ist.
  
  
• HTML-Format
  • Für einen CS-Client, wenn der Dokumentationsserver auf einer Windows-Maschine installiert ist
  • Für einen CS-Client, wenn der Dokumentationsserver auf einer Unix-Maschine installiert ist
  • Erforderlich für Web-Clients unabhängig vom Betriebssystem (Windows oder Unix)

Für die Konfiguration der Dokumentationsserverkomponente müssen Sie den folgenden erforderlichen Parameter angeben:

• Zugriffsroot zur Dokumentation: Pfad für den Zugriff über den Client auf den SAFE-X3-C/S (im Falle eines UNC-Pfads muss der Zugriff auf das Dokumentationsverzeichnis auf dem Server manuell geteilt werden).
• Verwendungsformat der Clients: Gibt dem SAFE-X3-Client an, dass er für die Verwendung der komprimierten Dokumentation oder der HTML-Dokumentation konfiguriert werden muss.

Soll die Dokumentation über einen auf derselben Maschine wie der Dokumentationsserver installierten Apache-Server veröffentlicht werden, geben Sie den Parameter Apache-Installationspfad an. Wird dieser Parameter vorgegeben, fügt die Konsole der http.conf des Apache-Servers einen Alias (/AdxDoc_[NomComposantDoc]) hinzu.
Liegt die Dokumentationsserverkomponente auf einem Unix-Server, muss der Apache-Server manuell neu gestartet werden, damit der neue Alias berücksichtigt wird.

Damit der SAFE-X3-CS-Client über den Apache-Server auf die Dokumentation zugreifen kann, muss der Parameter Zugriff auf die Root der Dokumentation folgenden Wert annehmen: http://[ManschinenName]:[PortHTTP]/AdxDoc_[KomponentenNameDoc]

Nach der Erfassung dieses oder dieser Parameter, klicken Sie auf die Schaltfläche Konfigurieren.

Der Zugriff auf die Dokumentation kann per Klick auf die Schaltflächen Test doc., Client, Test doc. und Web geprüft werden.

Soll die Anwendung über die Web-Schnittstelle laufen, muss das Dokumentationsformat HTML sein. Um das Format zu ändern, klicken Sie auf die Schaltfläche "HTML detkomprimieren. Nach der Dekomprimierung der Dokumentation nimmt der Parameter 'HTML-Dokumentation' den Wert 'Ja' an.

Auf Unix-Servern installierte Dokumentation wird immer im HTML-Format geliefert. In diesem Fall ist keine Komprimierung / Dekomprimierung notwendig.

Wichtiger Hinweis:Der Installationspfad des Dokumentationsservers darf keine Leerzeichen enthalten.

Dokumentationsformat

Dokumentationsformat

Soll die Anwendung über die Web-Schnittstelle laufen, muss das Dokumentationsformat HTML sein. Um das Format zu ändern, klicken Sie auf die Schaltfläche "HTML detkomprimieren. Nach der Dekomprimierung der Dokumentation nimmt der Parameter HTML-Dokumentation den Wert Ja an.

Auf diese Art kann die gesamte HTML-Dokumentation aus einer CHM-Datei ausgegeben werden. Nachdem der Parameter HTML-Dokumentation auf Ja gesetzt und die HTML-Dateien erzeugt wurden, kann nicht mehr zur komprimierten Dokumentation zurückgekehrt werden.

Die Dokumentation kann zu jedem beliebigen Zeitpunkt per Klick auf die Schaltfläche Detkomprimieren (HTML) dekomprimiert werden. Wenn die Dokumentation bereits zuvor dekomprimiert wurde, so werden durch diesen Vorgang jedoch die alten HTML-Dateien überschrieben.

Es ist ebenfalls möglich, die Dokumentation zu "komprimieren", um aus den vorhandenen HTML-Dateien eine CHM-Datei zu erzeugen. Durch diesen Vorgang wird die ursprüngliche CHM-Datei überschrieben und durch die neue, aus den vorhandenen HTML-Dateien erzeugte CHM-Datei ersetzt. Eine komprimierte Dokumentation kann nicht erneut komprimiert werden. Zum Komprimieren einer Dokumentation klicken Sie auf die Schaltfläche Komprimieren (CHM). Damit bei der CHM-Generierung die neuen HTML-Dokumentationsdateien berücksichtigt werden können, müssen Letztere in der aktuellen Dokumentation indiziert sein. Der CHM-Generator arbeitet als "Spider" und erkennt neue Dokumentationsdateien, indem er den HTML-Links der aktuellen Dokumentation folgt. Am einfachsten ist es, Links in HTML-Dokumente des Allgemeinen Index einzufügen.

Hinweis: Bei mehrsprachiger Dokumentation können diese Vorgänge eine lange Laufzeit aufweisen. Die Komprimierung bzw. Dekomprimierung von Dokumentationen wird auf sämtliche installierte Dokumentationssprachen angewendet.

Veröffentlichung

Veröffentlichung der Lösung

Zur Veröffentlichung der Lösung auf dem Dokumentationsserver klicken Sie zunächst auf die Schaltfläche Dokumentationsserver, dann auf die Schaltfläche Veröffentlichungen.

Klicken Sie in der Werkzeugleiste auf Hinzufügen, und wählen Sie die zu veröffentlichende Lösung aus der Liste der von der Konsole verwalteten Lösungen aus.

Nach der Veröffentlichung steht die Dokumentation automatisch im Hilfemenü des SAFE-X3-Clients zur Verfügung.

Aktualisierung

Zur Aktualisierung des Dokumentationsservers sind folgende Schritte zu befolgen:

• Installation der Aktualisierung (für weitere Informationen siehe Installationsprozeduren), um die alte Version durch die neue zu ersetzen
• Auswahl des zu konfigurierenden Dokumentationsservers aus dem Menü Dokumentationsserver
• Bei Windows ggf. Dekomprimierung des CHM per Klick auf die Schaltfläche Dekomprimieren (HTML)
• Zur Aktualisierung der Konfiguration der Komponente und der vorhandenen Veröffentlichungen klicken Sie auf die Schaltfläche Konfigurieren.

Hinweis: Während der Konfiguration müssen sämtliche veröffentlichten Lösungen für die Aktualisierung der Dokumentationsdaten im Zugriff sein. Auf gesperrte oder unzugängliche Komponenten wird während der Konfiguration der Dokumentationsserverkomponente mit Warnungen verwiesen.

Dekonfiguration

Zum Dekonfigurieren der Dokumentationsserverkomponente sind folgende Schritte zu befolgen:

• Die Veröffentlichung sämtlicher auf dem Dokumentationsserver veröffentlichten Lösungen kann in der Maske Veröffentlichung zurückgenommen werden.
• Klicken Sie in der Konfigurationsmaske der Dokumentationsserverkomponente auf die Schaltfläche Dekonfigurieren. Der Komponentenstatus wird dann von In Betrieb auf Nicht konfiguriert gesetzt. 
• Deinstallieren Sie dann die Komponente auf dem Host.