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 rezydująca 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
- Treść pomocy rezydująca w witrynie sieci Web
ibm.com
lub w innym oficjalnym serwisie Centrum informacyjnego, takim jak jazz.net.
- Pomoc w intranecie
- Treść pomocy rezydująca na serwerze intranetowym. Początkowo zostaje ona
pobrana na serwer intranetowy z sieci WWW.
- Aktualizator pomocy lokalnej
- Jeśli w produkcie skonfigurowano korzystanie z pomocy lokalnej lub
intranetowej, ten program narzędziowy ułatwia początkowe pobieranie treści lub
zaktualizowanie treści istniejącej na podstawie danych dostępnych w serwisie
aktualizatora pomocy lub pobranego, skompresowanego pliku aktualizatora (patrz
kolejne definicje).
- Serwis aktualizacji pomocy
- Serwis ibm.com udostępniający
Centrum informacyjne używanego produktu. Dostęp do tego serwisu można uzyskać
za pośrednictwem przeglądarki lub z systemu pomocy produktu (jeśli w produkcie
skonfigurowano korzystanie z pomocy zdalnej). Ten serwis może być także źródłem
danych dla aktualizatora pomocy lokalnej.
- Serwis pobierania pomocy
- Serwis WWW
(http://download.boulder.ibm.com/ibmdl/pub/software/rationalsdp/documentation/updatesites/)
zawierający skompresowane pliki treści pomocy do produktu, którymi można
zaktualizować 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
jest instalowany w trakcie instalowania produktu.
Istnieją trzy opcje udostępniania treści pomocy:
- Korzystanie z treści pomocy rezydującej na serwerze udostępniającym produkt.
- Korzystanie z treści pomocy dostępnej w sieci WWW.
- Korzystanie z treści pomocy rezydującej na serwerze intranetowym.
Uzyskiwanie dostępu do treści pomocy na serwerze produktu
Jeśli
taki tryb działania został skonfigurowany przez administratora lub był
oryginalnie ustawiony w produkcie, treść pomocy rezyduje na serwerze
udostępniającym dany produkt.
Administrator:
instalowanie i konfigurowanie: Instalowanie produktu. Dodatkowe
czynności nie są wymagane, jeśli treść pomocy jest w całości zapisana lokalnie
lub jeśli skonfigurowano korzystanie z pomocy zdalnej.
Administrator:
aktualizowanie treści: jeśli nie skonfigurowano korzystania z pomocy
zdalnej, 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. Aby skorzystać z
pomocy, należy kliknąć opcję . Pomoc zostanie otwarta w oknie. Nie trzeba wykonywać żadnych dodatkowych czynności.
Uzyskiwanie dostępu do treści pomocy w sieci
WWW
Jeśli taki tryb działania został skonfigurowany przez
administratora lub był oryginalnie ustawiony w produkcie, produkt łączy się z
centrum informacyjnym za pośrednictwem serwisu WWW
ibm.com.
Dostęp do
treści pomocy z interfejsem WWW wymaga nawiązania połączenia z Internetem. 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 przy użyciu aktualizatora
pomocy lokalnej.
- Skonfigurowanie treści pomocy udostępnianej w publicznym serwisie centrum informacyjnego produktu.
Administrator:
aktualizowanie treści: dodatkowe czynności nie są wymagane - treść pomocy
jest zawsze aktualna.
Użytkownik:
uzyskiwanie dostępu do pomocy: Uruchomienie produktu. Aby skorzystać z
pomocy, należy kliknąć opcję . Pomoc zostanie otwarta w oknie.
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 zgodnie z opisem
przedstawionym w sekcji
Dostarczanie
treści pomocy z serwera intranetowego.
- Uruchomienie produktu.
- Usunięcie istniejącej treści z pomocy przy użyciu aktualizatora pomocy
lokalnej.
- 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. Aby skorzystać z
pomocy, należy kliknąć opcję . Pomoc zostanie otwarta w oknie. Nie trzeba wykonywać żadnych dodatkowych czynności.