Das Hilfesystem ist in einer Webarchivdatei (WAR-Datei) gepackt, die auf Ihrem Anwendungsserver implementiert wird.
Es startet und stoppt, wenn Ihr Produkt gestartet bzw. gestoppt wird. Das Hilfesystem enthält Inhalt, der manuell aktualisiert werden kann. Sie können das Hilfesystem auch so konfigurieren, dass es den Inhalt der Hilfe von der Website 'ibm.com' bereitstellt und der Inhalt somit jeweils auf dem neuesten Stand ist. Als dritte Option kann der Inhalt der Hilfe von einem Intranet-Server bereitgestellt werden.
Definitionen
Die folgenden Definitionen werden bei der Bereitstellung des Inhalts der Hilfe verwendet:
- Lokale Hilfe
- Hilfeinhalt, der sich auf einem lokalen Server befindet, der als Host für das Produkt oder für einen Intranet-Server dient. Sie können auch von Ihrem Computer aus auf die Hilfe zugreifen.
- Ferne Hilfe
- Hilfeinhalt, der sich auf der ibm.com-Website oder einem anderen offiziellen Information Center-Standort wie beispielsweise jazz.net befindet.
- Intranet-Hilfe
- Hilfeinhalt, der sich auf einem Intranet-Server befindet. Der Inhalt wird zuerst aus dem World Wide Web auf den Intranet-Server heruntergeladen.
- Aktualisierungskomponente für lokale Hilfe
- Wenn Ihr Produkt für die Verwendung der lokalen Hilfe oder der Intranet-Hilfe konfiguriert ist, unterstützt Sie dieses Dienstprogramm beim Herunterladen des Anfangsinhalts oder des aktualisierten Inhalts von der Aktualisierungskomponente für Hilfe oder aus einer heruntergeladenen komprimierten Datei der Aktualisierungskomponente (siehe nachfolgende Definitionen).
- Site der Aktualisierungskomponente für die Hilfe
- Die ibm.com-Site, auf der das Information Center für Ihr Produkt per Hosting zur Verfügung gestellt wird. Auf diese Site kann mit einem Browser oder, falls Ihr Produkt für die Verwendung ferner Hilfe konfiguriert ist, über ein Produkthilfesystem zugegriffen werden. Diese Site kann auch als Quelle für die Aktualisierungskomponente für die lokale Hilfe dienen.
- Download-Site für die Hilfe
- Auf der Website http://download.boulder.ibm.com/ibmdl/pub/software/rationalsdp/documentation/updatesites/ sind komprimierte Dateien des Hilfeinhalts für Ihr Produkt enthalten, die Sie optional zum Aktualisieren der lokalen Hilfe oder der Intranet-Hilfe verwenden können. Die Datei weist das folgende Format auf:
produktcoden.n_updateSite.zip, wobei
produktcode für den Produktcode steht und n.n die Versionsnummer ist.
Einführung
Dieses Produkt bietet Hilfeinhalt, der unabhängig von den Produktaktualisierungen aktualisiert werden kann. Ihr Produkt ist standardmäßig so konfiguriert, dass auf den Inhalt der lokalen Hilfe zugegriffen wird. Dies bedeutet, dass die Webarchivdatei (WAR-Datei) Ihren gesamten Hilfeinhalt enthält und bei der Installation Ihres Produkts installiert wird.
Einschließlich des lokalen Zugriffs stehen drei Optionen für den Zugriff auf den Inhalt der Hilfe bereit:
- Sie können auf den Inhalt zugreifen, der sich auf dem Server befindet, der als Host für das Produkt dient.
- Sie können auf Hilfeinhalt zugreifen, der sich im World Wide Web befindet.
- Sie können auf Hilfeinhalt zugreifen, der sich auf einem Intranet-Server befindet.
Auf Hilfeinhalt auf dem Produktserver zugreifen
Wenn Ihr Administrator diese Option konfiguriert hat oder diese Option bei Ihrem Produkt zum Zeitpunkt seiner Auslieferung bereits festgelegt war, befindet sich der Hilfeinhalt auf dem Server, von dem Ihr Produkt per Hosting bereitgestellt wird.
Administrator:
Installieren und Konfigurieren: Installieren Sie das Produkt. Es sind keine weiteren Schritte erforderlich, wenn die Hilfe den gesamten Inhalt lokal enthält oder aber wenn die Hilfe für die ferne Hilfe konfiguriert ist.
Administrator:
Aktualisieren des Inhalts: Wenn keine ferne Hilfe konfiguriert ist, erfolgt die Aktualisierung des Inhalts entweder anhand der Site der Aktualisierungskomponente für die Hilfe oder aber anhand der Download-Site für die Hilfe.
Benutzer: Zugriff auf die Hilfe: Suchen Sie nach dem Produkt und beginnen Sie mit der Verwendung. Wenn Sie Hilfe benötigen, klicken Sie auf , um die Hilfe in einem Fenster zu öffnen. Weiter ist nichts erforderlich.
Auf Hilfeinhalt im World Wide Web zugreifen
Wenn Ihr Administrator diese Option konfiguriert hat oder Ihr Produkt zum Zeitpunkt seiner Auslieferung bereits entsprechend konfiguriert war, wird die Verbindung zum Information Center Ihres Produkts über eine ibm.com-Website hergestellt.
Sie können auf die webbasierte Hilfe für das Produkt nur zugreifen, wenn eine Internetverbindung besteht. Ist die Verbindung getrennt, haben Sie lediglich Zugriff auf eine begrenzte Anzahl von Hilfethemen. **Weitere Informationen hierzu finden Sie im Thema für den Hilfeinhalt unter 'Verweis' ('Reference').
Anmerkung: Sie müssen über eine Internetverbindung verfügen, um diese Option verwenden zu können.
Administrator:
Installieren und Konfigurieren:- Installieren Sie das Produkt.
- Starten Sie das Produkt und die Hilfe.
- Löschen Sie den vorhandenen Inhalt der Hilfe in der WAR-Datei für die Hilfe mit der Aktualisierungskomponente für lokale Hilfe.
- Konfigurieren Sie die ferne Hilfe, sodass sie auf das öffentlich zugängliche Information Center des Produkts verweist.
Administrator: Aktualisieren des Inhalts: Es sind keine Maßnahmen erforderlich. Der Inhalt besteht stets aus den neuesten Informationen, die verfügbar sind.
Benutzer: Zugriff auf die Hilfe: Suchen Sie nach dem Produkt und beginnen Sie mit der Verwendung. Wenn Sie Hilfe benötigen, klicken Sie auf , um die Hilfe in einem Fenster zu öffnen.
Auf Hilfeinhalt auf einem Internet-Server (Unternehmenslösung) zugreifen
Abhängig von der Unterstützung des jeweiligen Unternehmens kann ein Zugriff auf Hilfeinhalt möglich sein, der sich auf internen Intranet-Servern befindet. Bei dieser Methode wird vorausgesetzt, dass Ihr Intranet-Administrator
einen Link zu einem Server eingerichtet hat, der sich hinter einer Firewall befindet. Auf diesem
Server werden dann die Hilfeinhalte installiert. Wenn Sie diese Option auswählen, müssen Sie den Link
zu Ihrem Intranet-Server angeben. Administratoren müssen regelmäßig geplante Änderungen
am Hilfeinhalt vornehmen.
Administrator:
Installieren und Konfigurieren:- Installieren Sie das Produkt auf dem Produktserver.
- Installieren und konfigurieren Sie die Intranethilfe wie in dem Artikel Hilfeinhalt von einem Intranet-Server bereitstellen erläutert.
- Starten Sie das Produkt.
- Löschen Sie mit der Aktualisierungskomponente für lokale Hilfe den vorhandenen Inhalt aus der Hilfe.
- Konfigurieren Sie mit den bereits in Schritt 2 verwendeten Informationen die ferne Hilfe, sodass der Intranet-Server verwendet wird.
Administrator: Aktualisieren des Inhalts: Der Inhalt wird auf dem Intranet-Server manuell aktualisiert (unter Verwendung der
Site der Aktualisierungskomponente für die Hilfe oder der Download-Site für die Hilfe).
Benutzer: Zugriff auf die Hilfe: Suchen Sie nach dem Produkt und beginnen Sie mit der Verwendung. Wenn Sie Hilfe benötigen, klicken Sie auf , um die Hilfe in einem Fenster zu öffnen. Weiter ist nichts erforderlich.