Hilfeinhalt für webbasierte Produkte konfigurieren

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, auf den Sie von einem lokalen Server aus zugreifen, der Host für das Produkt oder einen Intranet-Server ist. Sie können auch von Ihrem Computer aus auf die Hilfe zugreifen.
Ferne Hilfe
Hilfeinhalt, auf den Sie von der Website 'ibm.com' zugreifen bzw. ihn von dort herunterladen.
Intranet-Hilfe
Hilfeinhalt, auf den Sie von einem Intranet-Server aus zugreifen. Der Inhalt wird zuerst aus dem World Wide Web auf den Intranet-Server heruntergeladen.
Aktualisierungskomponente für lokale Hilfe
Wenn Sie die lokale Hilfe oder die Intranet-Hilfe verwenden, unterstützt Sie dieses Dienstprogramm beim Herunterladen des Anfangsinhalts oder des aktualisierten Inhalts aus dem World Wide Web.
Site der Aktualisierungskomponente für die Hilfe
Die Site ibm.com, auf der das Information Center für Ihr Produkt per Hosting zur Verfügung gestellt wird. Auf diese Seite kann mit einem Browser oder über ein Produkthilfesystem zugegriffen werden. Diese Site ist auch die Quelle für die Aktualisierungskomponente für die lokale Hilfe.
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 zum Füllen der lokalen Hilfe oder der Intranet-Hilfe konzipiert sind. 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 von dem Server aus zugreifen, auf dem sich das Produkt befindet.
  • Sie können auf Hilfeinhalt im World Wide Web zugreifen.
  • Sie können über einen Intranet-Server auf den Hilfeinhalt zugreifen.

Die drei Optionen für den Hilfeinhalt.

Auf Hilfeinhalt auf dem Produktserver zugreifen

Mit der Standardoption wird der Hilfeinhalt auf dem Server installiert, auf dem sich Ihr Produkt befindet.

Administrator: Installieren und Konfigurieren: Installieren Sie das Produkt. Weiter ist nichts erforderlich.

Administrator: Aktualisieren des Inhalts: Der Inhalt wird 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 Hilfe (?), um die Hilfe in einem Fenster zu öffnen. Weiter ist nichts erforderlich.

Auf Hilfeinhalt im Web zugreifen

Wenn diese Option von Ihrem Administrator konfiguriert wurde, wird die Verbindung zum Information Center Ihres Produkts über die Website 'ibm.com' 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:
  1. Installieren Sie das Produkt.
  2. Starten Sie das Produkt und die Hilfe.
  3. Löschen Sie den vorhandenen Hilfeinhalt in der WAR-Hilfedatei.
  4. Konfigurieren Sie die ferne Hilfe, sodass sie auf das öffentlich zugängliche Information Center des Produkts verweist.

Administrator: Aktualisieren des Inhalts: 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 Hilfe (?), 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:
  1. Installieren Sie das Produkt auf dem Produktserver.
  2. Installieren und konfigurieren Sie die Intranet-Hilfe.
  3. Starten Sie das Produkt.
  4. Löschen Sie den vorhandenen Inhalt aus der Hilfe.
  5. 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 Hilfe (?), um die Hilfe in einem Fenster zu öffnen. Weiter ist nichts erforderlich.


Feedback