13.3.2.1. Dostęp do informacji o parametrach

Przechowywana przez program informacja o parametrach ma postać drzewa. Dostęp do niego uzyskuje się przez specyfikowanie ścieżki dostępu podobnie jak do zasobów WWW. Dokładne informacje o postaci ścieżki (lokatora - URI) znajdują się niżej. Lokator musi być zakodowany w UTF-8, przy czym obsługiwane jest kodowanie za pomocą sekwencji %kod. Są one obowiązkowe np. dla spacji. Alternatywnie, w lokatorze można używać zamiast polskich liter ich angielskich odpowiedników, a zamiast spacji i ukośnika występującego w nazwie parametru znaku podkreślenia (szczegóły w następnym rozdziale). Dokumenty serwowane są z nagłówkiem "Expires:" zgodnym z częstotliwością odświeżania wartości parametrów.

Dostęp do informacji udostępnianych przez serwer wymaga podania, np. w oknie przeglądarki internetowej, odpowiedniego adresu zasobu. Adres ten ma postać:

protokół://adres_serwera:port/ścieżka?opcje

Protokół może przyjmować wartość http dla połączeń zwykłych, lub https dla szyfrowanych (o ile ich obsługa została włączona w konfiguracji serwera).

Adres serwera specyfikuje adres internetowy komputera, na którym działa program.

Port (po dwukropku) jest numerem portu, podanym w pliku konfiguracyjnym programu.

Ścieżka jest to ścieżka dostępu do żądanego zasobu. Może być pusta, co oznacza dostęp do korzenia drzewa parametrów. Jeśli jest niepusta, to zawiera listę kolejnych węzłów drzewa, począwszy od korzenia, oddzielonych ukośnikami. Przykład:

http://localhost:8081/Kocioł 1/Sterownik/temperatura zadana

Ścieżka w tej postaci zostanie poprawnie zinterpretowana tylko jeśli przeglądarka potrafi odpowiednio zakodować występujące w niej polskie litery i spacje. To także jednak nie wystarczy, jeżeli w nazwie węzła znajdzie się np. ukośnik. W związku z tym polskie litery można zastąpić ich angielskimi odpowiednikami (zamiast "ą" - a, "Ą" - "A", "ń" - "n", "ż" i "ź" - "z" itp.). Zamiast spacji i ukośnika w nazwie parametru można stosować znak podkreślenia. Tak więc cała ścieżka zapisana w ten sposób może wyglądać tak

http://localhost:8081/Kociol_1/Sterownik/temperatura_zadana

Węzły takie jak np. "Kocioł 1" są rodzajem katalogów, zawierają tylko inne węzły. Natomiast węzeł "temperatura zadana" odpowiada parametrowi. Każdy parametr posiada atrybuty, dostęp do nich jest możliwy przez dodanie na końcu ścieżki znaku "@" i nazwy atrybutu. Na przykład:

http://localhost:8081/Kociol_1/Sterownik/temperatura_zadana@value

Dostępne są następujące atrybuty:

• name - nazwa parametru.

• full_name - pełna nazwa parametru , w postaci nazw węzłów oddzielonych dwukropkami (notacja używana w systemie SZARP).

• short_name - skrócona nazwa parametru.

• unit - nazwa jednostki parametru.

• ipc_ind - indeks parametru w pamięci dzielonej.

• prec - precyzja parametru - liczby do 5 włącznie oznaczają ilość cyfr po przecinku, powyżej są to wartości specjalne. Atrybut ten jest używany wewnętrznie przez serwer do interpretowania wartości parametru odczytanej z pamięci dzielonej.

• value - wartość parametru. Napis "unknown" oznacza brak dostępności tej informacji (np. niedziałający serwer SZARP, brak komunikacji ze sterownikami itp.).

• v_u - wartość parametru wraz z jednostką.

Po znaku zapytania można podać opcje do zapytania. Opcje mają postać "nazwa=wartość" i są oddzielane od siebie znakiem "&". Na przykład:

http://localhost:8081/Kociol_1/Sterownik?_opcja1=wart1&_opcja2=wart2

Obecnie dostępna jest jedna opcja o nazwie "output". Określa ona, co ma pojawić się na wyjściu serwera (zostać wysłane do przeglądarki). Może ona przyjmować następujące wartości:

• html - wartość domyślna, określa że wygenerowana ma zostać strona HTML. Dla parametrów strona zawiera informacje o wartościach atrybutów oraz link do węzła nadrzędnego. Dla pozostałych węzłów zawiera listę węzłów potomnych (jeśli są to parametry, to także ich wartości i nazwę skróconą), oraz link do węzła nadrzędnego. Elementy listy są także linkami, po ich kliknięciu następuje przejście do odpowiedniego węzła.

• xml - serwer wysyła zawartość danego węzła wraz z węzłami potomnymi w postaci XML. Zawsze serwowany jest kompletny dokument XML. Dokument ten ma ustawioną domyślną przestrzeń nazw XML (XML namespace) na identyfikator http://www.praterm.com.pl/ISL/params.

• text - wartość przyjmowana także dla innych, nieznanych wartości opcji. Produkuje wyjście takie jak opcja "xml", ale generowany jest inny nagłówek HTTP, z typem zawartości "text/plain". Pozwala to na wyświetlenie dokumentu XML w postaci czystego tekstu także w przeglądarkach nie obsługujących XML.

Wszystkie generowane dokumenty XML zgodne są z DTD, które można znaleźć w pliku params.dtd.

13.3.2.2. Dostęp do informacji o raportach

Paramd udostępnia informacje o parametrach umieszczonych w raportach w sposób analogiczny do opisanego w rozdziale Sekcja 13.3.2.1. Dodatkowe funkcjonalności są realizowane za pośrednictwem odpowiednio przygotowanej ścieżki dostępu do zasobu zasobu (URI). Paramd obsługuje następujące ścieżki:

• protokół://adres_serwera:port/xreports - udostępnia w postaci dokumentu XML listę raportów zdefiniowanych w IPK.

• protokół://adres_serwera:port/xreports?title=nazwa raportu - udostępnia w postaci dokumentu XML listę parametrów raportu wraz z wartościami.

• protokół://adres_serwera:port/custom?title=klucz identyfikacyjny - udostępnia w postaci dokumentu XML listę parametrów raportu definiowalnego wraz z wartościami (tworzenie parametrów definiowalnych w paramd w rozdziale Sekcja 13.3.4).