System pomocy jest pakowany w postaci pliku archiwum WWW (WAR), który jest wdrożony na serwerze aplikacji.
Zostaje on uruchomiony w momencie uruchomienia produktu i zatrzymany w momencie jego zatrzymania. System pomocy obejmuje treść pomocy, którą można aktualizować ręcznie. Można także skonfigurować system pomocy w taki sposób, aby udostępniana treść pochodziła z serwisu WWW ibm.com. Treść taka jest zawsze aktualna. Trzecią możliwością jest udostępnianie treści pomocy za pośrednictwem serwera intranetowego.
Definicje
W tematyce dostarczania treści pomocy stosowane są następujące definicje:
- Pomoc lokalna
- Treść pomocy udostępniona na serwerze lokalnym, na którym zainstalowano produkt, lub na serwerze intranetowym. Do treści pomocy można uzyskać dostęp także z własnego komputera.
- Pomoc zdalna
- Pomoc dostępna lub pobierana z serwisu WWW ibm.com.
- Pomoc w intranecie
- Pomoc dostępna na serwerze intranetowym. Na samym początku zostaje ona pobrana na serwer intranetowy z serwisu WWW.
- Aktualizator pomocy lokalnej
- Jest to program narzędziowy ułatwiający pobieranie z serwisu WWW początkowej lub zaktualizowanej treści pomocy, kiedy użytkownik korzysta z pomocy lokalnej lub umieszczonej na serwerze intranetowym.
- Serwis aktualizacji pomocy
- Serwis ibm.com udostępniający centrum informacyjne danego produktu. Dostęp do tego serwisu można uzyskać za pośrednictwem przeglądarki lub z systemu pomocy produktu. Serwis ten jest także źródłem danych wykorzystywanym przez aktualizator pomocy lokalnej.
- Serwis pobierania pomocy
- Serwis WWW (http://download.boulder.ibm.com/ibmdl/pub/software/rationalsdp/documentation/updatesites/) zawiera skompresowane pliki treści pomocy do produktu, którymi zapełnia się pomoc lokalną lub dostępną w intranecie. Nazwa pliku ma następujący format: Kod_prodn.n_updateSite.zip, gdzie kod_prod jest kodem produktu, a n.n jest numerem wersji.
Wprowadzenie
Niniejszy produkt udostępnia treść pomocy, którą można aktualizować niezależnie od aktualizowania samego produktu. W domyślnej konfiguracji produktu treść pomocy jest udostępniana lokalnie. Oznacza to, że plik archiwum WWW pomocy (plik WAR) zawiera pełną treść pomocy i zostaje zainstalowany w trakcie instalowania produktu.
Istnieją trzy opcje udostępniania treści pomocy:
- Korzystanie z treści pomocy dostępnej na serwerze z produktem.
- Korzystanie z treści pomocy dostępnej w sieci WWW.
- Korzystanie z treści pomocy dostępnej na serwerze intranetowym.
Uzyskiwanie dostępu do treści pomocy na serwerze produktu
Domyślnie treść pomocy jest instalowana na serwerze, na którym znajduje się produkt.
Administrator:
instalowanie i konfigurowanie: Instalowanie produktu. Nie trzeba wykonywać żadnych innych czynności.
Administrator: aktualizowanie treści: Treść należy aktualizować ręcznie z serwisu aktualizowania (Serwis aktualizacji pomocy) lub serwisu pobierania (Serwis pobierania pomocy).
Użytkownik:
uzyskiwanie dostępu do pomocy: Uruchomienie produktu. Chcąc skorzystać z pomocy, należy kliknąć opcję w celu otwarcia okna pomocy. Nie trzeba wykonywać żadnych dodatkowych czynności.
Uzyskiwanie dostępu do treści pomocy w sieci WWW
Wybranie tej opcji przez administratora powoduje, że produkt łączy się z centrum informacyjnym za pośrednictwem serwisu WWW ibm.com. Dostęp do treści pomocy wymaga nawiązania połączenia z siecią Internet. W sytuacji braku połączenia z Internetem użytkownik ma dostęp do ograniczonej liczby tematów pomocy. Więcej informacji można znaleźć w sekcji pomocy Skorowidz.
Uwaga: Do skorzystania z tej opcji niezbędne jest połączenie Internetem.
Administrator: instalowanie i konfigurowanie:- Zainstalowanie produktu.
- Uruchomienie produktu i pomocy.
- Usunięcie istniejącej treści pomocy w pliku WAR.
- Skonfigurowanie treści pomocy udostępnianej w publicznym serwisie centrum informacyjnego produktu.
Administrator: aktualizowanie treści: Treść pomocy jest zawsze najbardziej aktualna.
Użytkownik:
uzyskiwanie dostępu do pomocy: Uruchomienie produktu. Chcąc skorzystać z pomocy, należy kliknąć opcję w celu otwarcia okna pomocy.
Uzyskiwanie dostępu do treści pomocy dostępnej na serwerze intranetowym (rozwiązanie korporacyjne)
W niektórych przedsiębiorstwach istnieje możliwość uzyskiwania dostępu do treści pomocy zainstalowanej na serwerze intranetowym. W przypadku tej metody przyjmuje się, że administrator intranetu
skonfigurował połączenie z serwerem znajdującym się poza zaporą firewall, na którym
zainstalowana jest treść pomocy. Po wybraniu tej metody należy określić połączenie z serwerem intranetowym. Administratorzy muszą określić harmonogram aktualizowania treści pomocy.
Administrator: instalowanie i konfigurowanie:- Zainstalowanie produktu na serwerze produktu.
- Zainstalowanie i skonfigurowanie pomocy w intranecie.
- Uruchomienie produktu.
- Usunięcie istniejącej treści pomocy.
- Skonfigurowanie pomocy na serwerze intranetowym przy użyciu informacji uzyskanej w kroku 2.
Administrator: aktualizowanie treści: Treść na serwerze intranetowym należy aktualizować ręcznie z serwisu aktualizowania (Serwis aktualizacji pomocy) lub serwisu pobierania (Serwis pobierania pomocy).
Użytkownik:
uzyskiwanie dostępu do pomocy: Uruchomienie produktu. Chcąc skorzystać z pomocy, należy kliknąć opcję w celu otwarcia okna pomocy. Nie trzeba wykonywać żadnych dodatkowych czynności.