Wenn Sie das Produkt nicht auf dem Server
installiert haben, auf dem Sie die Hilfe implementieren, können Sie
Apache Tomcat als einfache Anwendungsserverlösung für die Implementierung
Ihres Hilfesystems verwenden.
Vorbereitende Schritte
- Der Server, auf dem Sie den Hilfeinhalt konfigurieren,
muss für Ihre Benutzer hinter der Firewall verfügbar sein.
- Stellen Sie sicher, dass auf Ihrem Server die
Datei help.war verfügbar ist.
- Wenn Sie das Produkt, für das Sie die Hilfe konfigurieren,
auf dem Server installiert haben, kann es sein, dass die Datei
help.war bereits installiert ist.
- Suchen Sie im Verzeichnis
installationsverzeichnis/help
die Datei help.war.
- Suchen Sie eine Version der Datei, die die Abkürzung des Produkts
enthält, wie clmhelp.war oder
ramhelp.war.
- Suchen Sie in Ihrem Installationsverzeichnis die Datei
*help.war.
- Wenn Sie das Produkt nicht auf dem Server installiert haben oder
zu Ihrem Produkt keine Datei help.war gehört,
laden Sie eine Version der Datei
help.war
herunter.
- Installieren und konfigurieren Sie Apache Tomcat.
- Installieren Sie eine Java™ Runtime
Environment (JRE) oder ein Java Development
Kit (JDK). Sie können sich außerdem für die Installation
eines der
IBM® developer kits
entscheiden.
- Setzen Sie eine Umgebungsvariable mit dem Pfad zur JRE oder zum JDK:
- Wenn Sie eine JRE installiert haben, erstellen Sie die
Umgebungsvariable JRE_HOME und setzen Sie deren Wert
auf den Pfad des Verzeichnisses, in dem Sie die JRE installiert haben. Beispiele:
- Windows: C:\Programme\Java70\jre
- Linux: /usr/local/java70/jre
- Wenn Sie ein JDK installiert haben, erstellen Sie die
Umgebungsvariable JAVA_HOME und setzen Sie deren Wert
auf den Pfad des Verzeichnisses, in dem Sie das JDK installiert haben. Beispiele:
- Windows: C:\Programme\Java70
- Linux: /usr/local/java70/
- Laden Sie die
Apache Tomcat-Serveranwendung
herunter.
- Extrahieren Sie das Apache Tomcat-Archiv.
- Verschieben Sie den extrahierten Ordner an eine dauerhafte Position. Diese Position hat den Namen CATALINA_HOME.
Beispiel: C:\apache-tomcat-version
- Erstellen Sie die Umgebungsvariable CATALINA_HOME
und setzen Sie deren Wert auf das Verzeichnis
CATALINA_HOME. Beispiel: C:\apache-tomcat-version
- Fügen Sie der Datei CATALINA_HOME/conf/tomcat-users.xml
einen Serveradministrator hinzu und speichern Sie die Änderungen. Beispiel:
<role rolename="manager-gui"/>
<user username="admin" password="admin" roles="manager-gui"/>
- Öffnen Sie das Verzeichnis CATALINA_HOME/bin
und führen Sie die Startdatei aus, um den Apache Tomcat-Server zu starten.
- Windows: startup.bat
- Linux: startup.sh
Apache Tomcat
wird ausgeführt, wenn die Informationsnachricht Server
Startup in anzahl ms in einem
Befehlszeilendienstprogramm angezeigt wird.
Vorgehensweise
Gehen Sie wie folgt vor, um die
Datei help.war zu implementieren:
- Geben Sie in einem Browser die folgende URL ein, um Tomcat
Manager Application zu öffnen: http://localhost:8080/manager/html
- Geben Sie den Benutzernamen und das Kennwort ein.
- Klicken Sie im Abschnitt auf Choose
file.
- Wählen Sie die Datei help.war aus.
- Klicken Sie auf Deploy. Die Datei help.war wird implementiert,
gestartet und im Abschnitt Applications angezeigt.
Außerdem wird die Datei help.war auch
in das Verzeichnis CATALINA_HOME/webapps
kopiert.
- Stellen Sie sicher, dass Sie auf das Hilfesystem zugreifen
können, indem Sie an das Ende der Serveranwendungs-URL die Angabe
hilfe/index.jsp
anfügen, wobei hilfe der Name Ihrer
.war-Datei ist. Beispiel: http://localhost:8080/help/index.jsp.
Anmerkung: - Es kann sein, dass im Hilfesystem noch
kein Hilfeinhalt enthalten ist. Unter Umständen müssen Sie im nächsten Schritt die Dokumentation
im Hilfesystem installieren.
- Wenn Ihr Hilfesystem auf demselben Apache Tomcat-Server wie
das Produkt installiert ist, wird es gestartet und gestoppt,
wenn die Produktanwendung gestartet und gestoppt wird.
Nächste Schritte
- Installieren Sie die Dokumentation auf dem Server:
- Geben Sie für Benutzer die Angaben für Server, Port und Pfad
zum Hilfesystem an, die auf der Seite Konfiguration des Hilfesystems
in IBM Installation Manager
eingegeben werden müssen.
Stellen Sie sicher, dass
Sie nicht den Server localhost angeben.
Beispiel: Für
http://server.ibm.com:8080/hilfe/index.jsp
lauten die Werte wie folgt:
- Server: server.ibm.com
- Port: 8080
- Pfad: /hilfe