Serwer dokumentacji

Konfiguracja

Aby wdrożyć Serwer dokumentacji należy:

• załadować składnik Serwer dokumentacji,
• skonfigurować składnik Serwer dokumentacji,
• opublikować rozwiązanie na Serwerze dokumentacji.

Ładowanie

Aby załadować ten składnik należy kliknąć na przycisk Dodaj w opcjach Serwera dokumentacji.

Więcej informacji na temat okna dialogowego ładowania składnika znajduje się w dokumentacji na temat Składnika wprowadzania parametrów.

Konsola dokonuje przejęcia różnych parametrów składnika Serwera dokumentacji.

Wartość statusu składnika Dokumentacja to Nieskonfigurowany. Po skonfigurowaniu wartość ta zmienia się na W trakcie działania.

Konfiguracja

Format dostępu do dokumentacji

Istnieją dwa typy dostępu do dokumentacji. Wybór typu dostępu zależy od użytego klienta i systemu wykonania:

• Format skompresowany (CHM)
  • Tylko dla klienta CS, jeśli serwer dokumentacji jest zainstalowany na komputerze z systemem Windows.
  
  
• Format rozpakowany (HTML)
  • Dla klienta CS, jeśli serwer dokumentacji jest zainstalowany na komputerze z systemem Windows.
  • Dla klienta CS, jeśli serwer dokumentacji jest zainstalowany na komputerze z systemem Unix.
  • Wymagany dla klienta sieciowego, niezależnie od systemu (Windows lub Unix).

Aby skonfigurować składnik Serwera dokumentacji należy obowiązkowo uzupełnić parametr:

• Ścieżka dostępu do dokumentacji – ścieżka w celu uzyskania dostępu do dokumentacji za pomocą klienta C/S SAFE X3 (w przypadku ścieżki UNC należy ręcznie podzielić katalog dostępu do dokumentacji na serwerze).
• Format użycia stacji roboczych klientów – wskazuje klienta SAFE X3, który musi zostać skonfigurowany, aby można było korzystać z pomocy w skompresowanym (CHM) lub rozpakowanym (HTML) formacie.

Jeśli zdecydowano o publikacji dokumentacji za pomocą serwera Apache zainstalowanego na tym samym urządzeniu, co serwer dokumentacji to można uzupełnić parametr Ścieżka instalacyjna Apache. Jeśli ten parametr został uzupełniony to konsola dodaje alias (/AdxDoc_[NazwaSkładnikaDok]) w httpd.conf serwera Apache.
Jeśli składnik Serwera dokumentacji znajduje się na serwerze Unix należy ponownie uruchomić serwer Apache ręcznie, aby uwzględnić nowy alias.

Aby klient C/S SAFE X3 miał dostęp do dokumentacji za pomocą serwera Apache serwera dokumentacji, wartość parametru Ścieżka dostępu do dokumentacji musi wynosić: http://[NazwaUrządzenia]:[PortHTTP]/AdxDoc_[NazwaSkładnikaDok]

Po uzupełnieniu jednego lub wielu parametrów należy kliknąć na przycisk Konfiguruj.

Można sprawdzić dostęp do dokumentacji – należy kliknąć na przyciski Test dok. klienta lub Test dok. sieciowej.

Jeśli aplikacja ma być używana za pomocą sieci, wymagany format dokumentacji to „rozpakowana”. Aby zmienić ten format należy kliknąć na przycisk „Dekompresuj (HTML)”. Po zdekompresowaniu dokumentacji wartość parametru Dokumentacja rozpakowana zmienia się na Tak.

Dokumentacja zainstalowana na serwerze Unix jest zawsze dostarczana w rozpakowanym formacie. Nie ma konieczności jej dekompresji/kompresji.

Ważna uwaga: w ścieżce instalacyjnej serwera dokumentacji nie ma spacji.

Format dokumentacji

Format dokumentacji

Jeśli aplikacja ma być używana za pomocą sieci, wymagany format dokumentacji to „rozpakowana”. Aby zmienić ten format należy kliknąć na Dekompresuj (HTML). Po zdekompresowaniu dokumentacji wartość parametru Dokumentacja rozpakowana zmienia się na Tak.

Ta operacja pozwala wyodrębnić całą dokumentację w formacie HTML z pliku CHM. Po ustawieniu parametru Dokumentacja rozpakowana na Tak, a więc po otrzymaniu plików HTML, nie można wrócić do dokumentacji nierozpakowanej.

Dokumentację można zdekompresować w dowolnym momencie przy użyciu przycisku Dekompresuj (HTML). Ta operacja nadpisze jednak wszystkie już istniejące pliki HTML, jeśli dokumentacja została już zdekompresowana.

Można również „skompresować” dokumentację, aby utworzyć plik CHM na podstawie istniejących plików HTML. Ta operacja nadpisuje pierwotny plik CHM i zastępuje go nowym plikiem CHM wytworzonym na podstawie istniejących plików HTML. Nie można skompresować dokumentacji, która jest nierozpakowana. Aby skompresować dokumentację należy kliknąć na przycisk Kompresuj (CHM). Aby generowanie CHM uwzględniło nowe pliki HTML dokumentacji muszą one być zaindeksowane w bieżącej dokumentacji. Generator CHM funkcjonuje w trybie „spider” i znajduje nową dokumentację „śledząc” odnośniki HTML w bieżącej dokumentacji. Najprostszą metodą jest dodanie odnośników w dokumentacji HTML indeksu ogólnego.

Uwaga: Te operacje mogą być czasochłonne, jeśli dokumentacja jest zainstalowana w wielu językach. Kompresja lub rozpakowanie dokumentacji ma zastosowanie do wszystkich języków zainstalowanych dla dokumentacji.

Publikacja

Publikacja rozwiązania

Aby opublikować rozwiązanie na serwerze dokumentacji należy kliknąć na przycisk Serwery dokumentacji, a następnie na przycisk Publikacje.

Należy kliknąć na przycisk Dodaj na pasku narzędzi i wybrać rozwiązanie do opublikowania z listy rozwiązań administrowanych przez konsolę.

Po zakończeniu publikacji dokumentacja jest automatycznie dostępna w menu pomocy klienta SAFE X3.

Aktualizacja

Aby zaktualizować serwer dokumentacji należy wykonać następujące etapy:

• Należy zainstalować aktualizację (więcej informacji znajduje się w procedurach instalacyjnych), aby zastąpić bieżącą wersję przez nową wersję.
• Należy wybrać serwer dokumentacji do skonfigurowania w opcjach Serwera dokumentacji.
• W systemie Windows należy rozpakować plik CHM, jeśli jest to konieczne, klikając na przycisk Dekompresuj (HTML).
• Należy kliknąć na przycisk Konfiguruj, aby zaktualizować konfigurację składnika i istniejące publikacje.

Uwaga: Podczas konfiguracji wszystkie opublikowane rozwiązania muszą być dostępne do aktualizacji informacji o dokumentacji. Jeśli rozwiązania nie są dostępne lub są zablokowane, podczas konfiguracji składnika Serwera dokumentacji wyświetlą się ostrzeżenia.

Dekonfiguracja

Aby zdekonfigurować serwer dokumentacji należy wykonać następujące etapy:

• Należy cofnąć publikację rozwiązań opublikowanych na Serwerze dokumentacji na ekranie Publikacja.
• Należy kliknąć na przycisk Dekonfiguruj na ekranie konfiguracji składnika Serwera dokumentacji. Składnik zmienia status z W trakcie działania na Nieskonfigurowano. 
• Należy odinstalować składnik z hosta.