Wersja 1.0 Projekt współfinansowany przez Unię Europejską ze środków Europejskiego Funduszu Społecznego w ramach Programu Operacyjnego Kapitał Ludzki
Tytuł dokumentu: Dokumentacja dla administratora strony internetowej Wersja: 1.0 Data wydania: 2013-06-12 Projekt współfinansowany przez Unię Europejską ze środków Europejskiego Funduszu Społecznego w ramach Programu Operacyjnego Kapitał Ludzki
Spis treści SPIS TREŚCI... 3 1. WSTĘP... 5 2. PODSTAWOWE POJĘCIA... 6 3. MENU ADMINISTRATORA... 7 4. DODANIE WZORCA FORMULARZA ZGŁOSZENIOWEGO... 9 5. PRZEGLĄDANIE ZGŁOSZEŃ NA WYDARZENIE... 15 6. DODANIE NOWEGO UŻYTKOWNIKA... 18 7. EDYCJA DANYCH UŻYTKOWNIKA... 21 8. ZMIANA STATUSU UŻYTKOWNIKA... 23 9. ZMIANA HASŁA UŻYTKOWNIKA... 24 10. WYKONANIE KOPII ZAPASOWEJ NA ŻĄDANIE... 25 11. WYKONANIE KOPII ZAPASOWEJ WEDŁUG HARMONOGRAMU... 27 12. ODTWORZENIE KOPII ZAPASOWEJ... 28 13. WŁĄCZENIE WERSJI ŻAŁOBNEJ... 30 14. DODANIE POZYCJI W MENU NAWIGACJI... 32 15. EDYCJA POZYCJI W MENU NAWIGACJI... 35 16. WYŁĄCZENIE POZYCJI MENU NAWIGACJI... 37 17. ZMIANA KOLEJNOŚCI W MENU NAWIGACJI... 38 3/47
18. ZAMIESZCZENIE WIADOMOŚCI DLA UŻYTKOWNIKÓW... 39 19. ZARZĄDZANIE PLIKAMI NA SERWERZE... 41 20. RAPORT O STANIE WITRYNY... 43 21. DZIENNIK ZDARZEŃ... 45 4/47
1. Wstęp W związku z realizacją serwisu dla Urzędu Marszałkowskiego Województwa Mazowieckiego w Warszawie, Departamentu Rozwoju Regionalnego i Funduszy Europejskich, Wydziału Innowacyjności została opracowana dokumentacja dla administratora strony internetowej. Przedstawiona dostępność funkcji wynika z uprawnień, jakie posiada administrator serwisu. W niniejszej instrukcji przedstawiono najważniejsze funkcje administracyjne pozwalające na zarządzanie i monitorowanie serwisu. 5/47
2. Podstawowe pojęcia Poniższa tabela przedstawia charakterystykę podstawowych pojęć związanych z powstałym serwisem. Pojęcie Administrator Klucz pola Rola Waga Komunikat modalny Definicja Użytkownik z uprawnieniami umożliwiającymi administrowanie stroną internetową. Wewnętrzny identyfikator pola w systemie. Nazwana grupa uprawnień, do której można przypisać użytkowników. Liczba określająca kolejność na liście pozycji. Czym wyższa waga (liczba), tym niższa pozycja. Komunikat wyświetlany na pierwszym planie. Tabela 1. Podstawowe pojęcia. 6/47
3. Menu administratora Użytkownik posiadający uprawnienia do administrowania stroną po zalogowaniu uzyskuje dostęp do dedykowanego menu (rys. 1 i 2). Rys. 1. Umiejscowienie menu administratora. Użytkownik z uprawnieniami administratora ma dostęp do szerokiego wachlarza funkcji umożliwiających zarządzanie serwisem. Rys. 2. Menu administratora. 7/47
Kluczowym elementem menu administratora jest Blok administracyjny dostępny z poziomu kokpitu, zawierający najważniejsze funkcje z punktu widzenia administratora (rys. 3). Rys. 3. Umiejscowienie Bloku administracyjnego w kokpicie. Administrator z poziomu bloku administracyjnego ma dostęp do funkcji wskazanych na rys 4. Rys.4. Blok administracyjny. Szczegółowy opis tych funkcji znajduje się na następnych stronach niniejszej instrukcji. 8/47
4. Dodanie wzorca formularza zgłoszeniowego Administrator serwisu posiada możliwość dodawania wzorców formularzy zgłoszeniowych, które mogą zostać wykorzystane podczas dodawania informacji o nowym wydarzeniu, na które istnieje możliwość rejestracji. Rys. 5. Umiejscowienie funkcji dodawania treści. Dzięki wzorcom formularzy dodawanie informacji o nowych wydarzeniach z możliwością rejestracji jest łatwe i szybkie dla użytkownika. Rys. 6. Funkcja dodawania treści w menu administratora. 9/47
Po wybraniu funkcji dodawania treści (rys. 5 i 6) administrator przenoszony jest do strony z listą dostępnych typów treści (rys. 7). Rys. 7. Lista dostępnych typów treści z zaznaczoną funkcją dodawania formularza. Aby utworzyć nowy wzorzec formularza zgłoszeniowego należy wybrać typ treści Webform (rys. 7 i 8). Następnie administrator zostanie przeniesiony na funkcję zarządzania polami nowego formularza (rys. 9). Rys. 8. Funkcja dodawania formularza. 10/47
Rys. 9. Funkcja dodawania i edycji pól formularza. Korzystając z tej funkcji administrator może dodać nowe pole, edytować pola istniejące, usunąć pole oraz je skopiować (funkcja klonuj). Dodatkowo istnieje możliwość zmiany kolejności pól na formularzu oraz przełączenia obligatoryjności. Po wybraniu funkcji dodawania nowego pola administrator przenoszony jest na stronę edycji dodawanego pola (rys. 10). 11/47
Rys. 10. Funkcja edycji dodawanego pola. Na funkcji edycji dodawanego pola administrator może uzupełnić jego atrybuty. Musi określić m.in. etykietę i klucz pola. Ponadto administrator może określić: domyślną wartość pola; treść znajdującą się w dymku podpowiedzi (opis pola); obligatoryjność; unikalność; maksymalną długość; parametry związane z wyświetlaniem. 12/47
Rys. 11. Ekran konfiguracji działań serwisu po wysłaniu formularza (potwierdzenie mailem). Istnieje możliwość ustawienia wysłania potwierdzenia zgłoszenia pod wybrany adres e-mail (rys. 11). Może to być adres zarówno ustawiony przez administratora (stały adres), bądź też adres wypełniony przez użytkownika w trakcie uzupełniania formularza zgłoszeniowego. 13/47
Rys. 12. Funkcja konfiguracji formularza. Funkcja konfiguracji formularza pozwala m.in. na ustawienie komunikatu, który ukaże się użytkownikowi po wysłaniu formularza zgłoszeniowego, zamknięcie rejestracji oraz ustalenie limitu liczby zgłoszeń (rys. 12). 14/47
5. Przeglądanie zgłoszeń na wydarzenie Administrator serwisu posiada uprawnienia do przeglądania nadesłanych zgłoszeń na wydarzenie. Rys. 13. Umiejscowienie funkcji przeglądania nadesłanych zgłoszeń. 15/47
Funkcja Wyniki dostępna jest z poziomu podglądu informacji o danym wydarzeniu, na które można dokonać rejestracji (rys. 13 i 14). Rys. 14. Funkcja przeglądania nadesłanych zgłoszeń. Po uruchomieniu funkcji Wyniki administrator przenoszony jest na stronę z listą nadesłanych zgłoszeń (rys. 15). Rys. 15. Lista nadesłanych zgłoszeń. Z poziomu listy dostępne są funkcje: podglądu zgłoszenia (wszystkich informacji znajdujących się w formularzu, rys. 16), edycji oraz usunięcia. 16/47
Rys. 16. Podgląd wszystkich danych nadesłanego zgłoszenia. 17/47
6. Dodanie nowego użytkownika Jedną z dostępnych funkcji administratora jest funkcja zarządzania użytkownikami. Rys. 17. Umiejscowienie funkcji zarządzania użytkownikami. Uruchomienie tej funkcji może nastąpić w dwojaki sposób. Zarówno poprzez Blok administracyjny dostępny w kokpicie, jak też poprzez funkcję Ludzie dostępną z poziomu menu administratora (rys. 17,18 i 19, 20). Rys. 18. Zarządzanie użytkownikami 18/47
Rys. 19. Ekran z menu administracyjnym Po wyborze funkcji Ludzie administrator uzyska dostęp do funkcji zarządzania użytkownikami, grupami użytkowników i ich uprawnieniami (rys. 21). Rys. 20. Menu administracyjne z wyszczególnioną funkcją Ludzie 19/47
Rys. 21. Lista użytkowników z wyróżnioną funkcją Dodaj użytkownika. Po wywołaniu funkcji Dodaj użytkownika (rys. 21 i 22) administrator zostanie przeniesiony do edycji danych nowotworzonego użytkownika (rys. 25). Rys. 22. Funkcja dodawania nowego użytkownika. 20/47
7. Edycja danych użytkownika Administrator posiada możliwość edycji danych użytkownika znajdującego się w systemie. Funkcję edycji można uruchomić bezpośrednio z listy użytkowników (rys. 23 i 24). Rys. 23. Lista użytkowników z zaznaczoną funkcją edycji danych użytkownika. Po uruchomieniu funkcji Edytuj administrator ma możliwość dokonywania zmiany danych użytkownika (rys. 25). Rys. 24. Funkcja edycji danych użytkownika serwisu. 21/47
Rys. 25. Funkcja edycja danych użytkownika. Powyższa funkcja pozwala na uzupełnienie danych użytkownika, przy czym pola login oraz adres e-mail są polami wymaganymi. Ponadto administrator może określić status użytkownika, jego rolę w systemie, język oraz umieścić ewentualne zdjęcie. 22/47
8. Zmiana statusu użytkownika Administrator systemu posiada możliwość zmiany statusu użytkownika systemu. Rys. 26. Umiejscowienie funkcji zmiany statusu. Istnieje możliwość wyboru jednego z dwóch statusów: Zablokowany lub Aktywne (rys. 26 i 27). Rys. 27. Opcje statusu użytkownika. Użytkownik o statusie Zablokowany nie ma możliwości zalogowania się do serwisu. 23/47
9. Zmiana hasła użytkownika W razie konieczności administrator może dokonać zmiany hasła użytkownika np. w wypadku, gdy użytkownik zapomni swojego hasła. Rys. 28. Umiejscowienie funkcji zmiany hasła. Podczas zmiany hasła należy je wprowadzić dwukrotnie, co pozwala na wyeliminowanie błędu przy wpisywaniu. Dodatkowo system określi siłę hasła, co pozwoli ocenić, w jakim stopniu wprowadzone hasło jest bezpieczne (rys. 28 i 29). Rys. 29. Pola dla hasła użytkownika 24/47
10. Wykonanie kopii zapasowej na żądanie System umożliwia administratorowi wykonanie kopii bezpieczeństwa w dowolnym momencie według potrzeb oraz przyjętych założeń. Rys. 30. Umiejscowienie funkcji zarządzania kopią zapasową. Funkcja zarządzania kopią zapasową dostępna jest z poziomu Bloku administracyjnego znajdującego się w kokpicie (rys 30 i 31). Rys. 31. Funkcja zarządzania kopią zapasową. 25/47
Rys. 32. Funkcja wykonania kopii zapasowej. Powyższa funkcja pozwala na wykonanie tzw. szybkiej kopii zapasowej na żądanie. Po jej użyciu serwis automatycznie wykona kopię zgodnie z wybranymi opcjami źródła i celu kopii (rys 32 i 33). Rys. 33. Panel tworzenia szybkiej kopii zapasowej. Gdy isnieje konieczność dostosowania paremetrów kopii zapasowej do własnych potrzeb, należy skorzystać z zaawansowanych ustawień kopii zapasowej. Kopie zapasowe wykonywane są osobno dla plików użytkownika, plików serwisu i bazy danych. Na potrzeby serwisu zostały predefiniowane optymalne ustawienia wykonywania kopii zapasowej. 26/47
11. Wykonanie kopii zapasowej według harmonogramu Szczególnym sposobem wykonania kopii zapasowej jest jej wykonanie według ustalonego harmonogramu (rys. 34). Rys. 34. Strona z listą harmonogramów wykonywania kopii zapasowej. Podczas dodawania lub edycji istniejącego harmonogramu należy określić jego parametry (rys. 35). Rys. 35. Konfiguracja harmonogramu wykonania kopii zapasowej. W parametrach harmonogramu określa się źródło, cel kopii oraz częstotliwość wykonywania. O terminowe wykonywanie kopii dba mechanizm cron, który może być wywoływany bezpośrednio przez serwis, bądź skonfigurowany w systemie operacyjnym (linux) serwera wg preferencji administratora. 27/47
12. Odtworzenie kopii zapasowej W serwisie znajduje się również funkcja pozwalająca na odtworzenie wykonanej wcześniej kopii zapasowej. Rys. 36. Lista lokalizacji docelowych kopii zapasowych. W określonej lokalizacji na serwerze zapisywane są wykonywane ręcznie lub według harmonogramu kopie zapasowe. Lista lokalizacji widoczna jest na rys. 36. W każdej lokalizacji znajdują się konkretne pliki kopii, które można przejrzeć przy pomocy funkcji lista plików (rys. 36 i 37). Rys. 37. Funkcja wyświetlania listy plików kopii z danej lokalizacji. Po wybraniu tej funkcji zostanie wyświetlona lista dostępnych wykonanych wcześniej kopii zapasowych. Przykładowa lista kopii jest przedstawiona na rys. 38. 28/47
Rys. 38. Lista plików kopii zapasowych z wybranej wcześniej lokalizacji. Po wybraniu funkcji przywróć administrator ma możliwość przywrócenia serwisu do stanu z wybranej przez siebie kopii (rys. 38 i 39). Rys. 39. Funkcja przywracania kopii zapasowej. Przywrócenie kopii jest operacją nieodwracalną, dlatego wymaga dodatkowego potwierdzenia (rys. 40). Rys. 40. Strona potwierdzenia odtworzenia kopii zapasowej. 29/47
13. Włączenie wersji żałobnej Serwis został wyposażony w mechanizm zmieniający jego wygląd z wersji standardowej na wersję żałobną. Rys. 41. Umiejscowienie funkcji ustawień wyglądu. Funkcja ustawień wyglądu dostępna jest z poziomu Bloku administracyjnego znajdującego się w kokpicie (rys. 41 i 42). Rys. 42. Funkcja ustawień wyglądu. 30/47
Rys. 43. Ekran ustawień wyglądu serwisu z wyróżnioną opcją ustawień żałobnych. Włączenie wersji żałobnej serwisu odbywa się poprzez włączenie odpowiedniej opcji i zapis konfiguracji (rys. 43 i 44). Rys. 44. Ustawienia żałobne. 31/47
14. Dodanie pozycji w menu nawigacji Serwis pozwala na elastyczne zarządzanie pozycjami menu nawigacji. Rys. 45. Umiejscowienie funkcji nawigacji w menu administratora. Po wybraniu funkcji Nawigacja znajdującej się w menu administratora (rys. 45 i 46) zostanie on przeniesiony do listy dostępnych linków nawigacyjnych (rys. 47). Rys. 46. Funkcja nawigacji w menu administratora 32/47
Na wyświetlonej liście linków nawigacyjnych (rys. 47) nawigacyjnych dostępne są funkcje zarządzania nimi tj. edycja, wyłączanie, usunięcie, dodanie, zmiana pozycji odnośnika. Rys. 47. Lista dostępnych linków nawigacyjnych. 33/47
Rys. 48. Funkcja dodawania nowego odnośnika. Po wybraniu funkcji Dodaj odnośnik (rys. 47 i 48) administrator zostanie przeniesiony do edycji danych nowego linka nawigacyjnego (rys. 49). Rys. 49. Edycja danych linka nawigacyjnego. Korzystając z powyższej funkcji administrator ma możliwość ustawienia linka nadrzędnego, wagi, opisu (dymek podpowiedzi pojawiający się po najechaniu kursorem myszki) oraz obrazka wyświetlanego przy linku. 34/47
15. Edycja pozycji w menu nawigacji Administrator ma również możliwość edycji wcześniej dodanych linków nawigacyjnych. Funkcja edycji dostępna jest z poziomu listy linków nawigacyjnych (rys. 50). Rys. 50. Lista dostępnych linków nawigacyjnych z wyróżnioną funkcją edycji. 35/47
Rys. 51. Funkcja edycji linka nawigacyjnego. Po uruchomieniu funkcji edycji (rys. 50 i 51), administrator ma możliwość modyfikacji parametrów linka nawigacyjnego (rys 52). Rys. 52. Edycja linka nawigacyjnego. Korzystając z powyższej funkcji administrator ma możliwość modyfikacji wagi, opisu (dymek podpowiedzi pojawiający się po najechaniu kursorem myszki) oraz obrazka wyświetlanego przy linku. 36/47
16. Wyłączenie pozycji menu nawigacji W razie konieczności administrator ma możliwość wyłączenia nieużywanej pozycji menu nawigacji (rys. 53 i 54). Pozycja menu nadal będzie się znajdowała w systemie, lecz będzie niewidoczna dla użytkowników serwisu. Rys. 53. Lista dostępnych linków nawigacyjnych z wyróżnioną funkcją wyłączenia. Aby zmiana stała się widoczna administrator musi zapisać konfigurację. Rys. 54. Funkcja wyłączenia linka nawigacyjnego. 37/47
17. Zmiana kolejności w menu nawigacji System daje możliwość zarządzania kolejnością pozycji w menu nawigacji. Rys. 55. Lista dostępnych linków nawigacyjnych z wyróżnioną funkcją zmiany kolejności wyświetlania. Funkcja zmiany kolejności została wyróżniona na rys. 55 i 56. Zmiany dokonuje się poprzez przeciągnięcie wybranej pozycji w nowe miejsce. Aby zmiana była widoczna należy zapisać konfigurację. Rys. 56. Funkcja zmiany kolejności wyświetlania linków nawigacyjnych. 38/47
18. Zamieszczenie wiadomości dla użytkowników Administrator posiada możliwość zamieszczenia wiadomości dla użytkowników, która będzie widoczna po wejściu na główną stronę serwisu. Rys. 57. Umiejscowienie funkcji wiadomości dla użytkowników. Funkcja zamieszczania informacji dla użytkowników dostępna jest z poziomu Bloku administracyjnego znajdującego się w kokpicie (rys. 57 i 58). Rys. 58. Funkcja zamieszczania wiadomości dla użytkowników. 39/47
Rys. 59. Edycja treści wiadomości dla użytkownika Po wybraniu funkcji Wiadomość dla użytkowników administrator zostaje przeniesiony na funkcję edycji wiadomości (rys. 59) gdzie ma możliwość włączenia i edycji treści modalnego komunikatu, który zostanie wyświetlony użytkownikom po wejściu na stronę główną serwisu. Oprócz tytułu i treści komunikatu istnieje możliwość zmiany wielkości okna oraz włączenia mechanizmu sprawdzającego poprzednie wyświetlenie komunikatu. 40/47
19. Zarządzanie plikami na serwerze Serwis posiada zintegrowany mechanizm zarządzania plikami znajdującymi się w określonej lokalizacji na serwerze. Rys. 60. Umiejscowienie funkcji zarządzania plikami. Dostęp do funkcji Zarządzanie plikami znajduje się w Bloku administracyjnym w kokpicie (rys. 60 i 61). Rys. 61. Funkcja zarządzania plikami. 41/47
Po uruchomieniu funkcji zarządzania plikami administrator zostanie przeniesiony do podglądu systemu plików na serwerze dostępnych dla użytkownika (rys. 62). Rys. 62. Podgląd plików dostępnych dla użytkownika. Powyższa funkcja umożliwia podgląd plików graficznych z podstawowymi funkcjami ich modyfikacji oraz podgląd zawartości katalogów dostępnych dla użytkownika. Do najważniejszych funkcji należą przesyłanie nowych plików na serwer oraz usuwanie plików już znajdujących się na serwerze. 42/47
20. Raport o stanie witryny W systemie wbudowana jest funkcja raportowania o stanie witryny. Rys. 63. Umiejscowienie funkcji raportu o stanie witryny. Funkcja dostępna jest z poziomu modułu Raporty znajdującego się w kokpicie (rys. 63 i 64). Rys. 64. Funkcja raportu o stanie witryny Po uruchomieniu funkcji raportu o stanie witryny administrator zostanie przeniesiony do podglądu parametrów witryny, informacji o ewentualnych błędach oraz dostępnych aktualizacjach (rys. 65). 43/47
Rys. 65. Raport o stanie witryny. Pozycje wyróżnione innym kolorem oraz oznaczone znakiem z wykrzyknikiem wymagają szczególnej uwagi administratora. Do decyzji administratora należy podjęcie stosownych kroków. 44/47
21. Dziennik zdarzeń Ważną funkcjonalnością z punktu widzenia administrowania serwisem jest Dziennik zdarzeń. Rys. 66. Umiejscowienie funkcji Ostatnie wpisy dziennika. Funkcja Ostatnie wpisy dziennika dostępna jest z poziomu modułu Raporty znajdującego się w kokpicie (rys. 66 i 67). Rys. 67. Funkcja Ostatnie wpisy dziennika. Po uruchomieniu funkcji Ostatnie wpisy dziennika administrator zostanie przeniesiony do podglądu logów serwisu (rys. 68). 45/47
Rys. 68. Podgląd ostatnich wpisów dziennika. Na podstawie logów można wysuwać wnioski o niestandardowym zachowaniu użytkowników serwisu, ewentualnych atakach lub awarii serwera. Każdy wpis dziennika jest określonego typu i posiada informację o czasie wystąpienia, użytkowniku (jeżeli użytkownik był zalogowany) i wykonywanej operacji, w trakcie której wystąpił logowany problem (rys. 68). Aby ułatwić pracę administratorowi system umożliwia filtrowanie wpisów według określonych kryteriów (rys. 69 i 70). Rys. 69. Funkcja filtrowania wpisów dziennika. 46/47
Rys. 70. Filtr wpisów dziennika Wspomniana wcześniej funkcja filtrowania pozwala na zawężenie wyświetlanych wpisów dziennika tylko do określonych konkretnym typem i priorytetem (rys. 69 i 70). Rys. 71. Funkcja usuwania wpisów dziennika. Administrator ma również dostęp do funkcji usuwającej wpisy znajdujące się w dzienniku (rys. 71). Wykonanie tej funkcji jest operacją nieodwracalną. 47/47