Podręcznik WebIssues. Wersja 1.1-beta1. Michał Męciński

Transkrypt

1 Wersja 1.1-beta1 Michał Męciński

2 : Wersja 1.1-beta1 Michał Męciński Copyright Zespół WebIssues Udziela się zezwolenia na kopiowanie, rozpowszechnianie i modyfikację tego dokumentu zgodnie z zasadami Licencji Wolnej Dokumentacji GNU w wersji 1.3 lub dowolnej późniejszej wersji opublikowanej przez Fundację Wolnego Oprogramowania; bez Części Stałych, bez Treści Przedniej Okładki oraz bez Treści Tylnej Okładki. Kopia licencji załączona jest w części zatytułowanej Licencja Wolnej Dokumentacji GNU.

3 Spis treści Przedmowa... 5 O podręczniku... 5 Jak czytać podręcznik... 5 Stosowane konwencje... 5 Organizacja podręcznika Wprowadzenie... 7 Śledzenie spraw i praca zespołowa... 7 Logiczna organizacja danych... 8 Cykl życia sprawy... 9 Proste forum... 9 Zgłoszenia serwisowe Przepływ pracy Przygotowanie systemu Wymagania Instalacja Kopiowanie plików Konfiguracja systemu Konfiguracja początkowa Konta użytkowników Projekty i foldery Powiadomienia mailowe Wysyłanie poczty Zadania cykliczne Praca ze sprawami Programy klienckie Logowanie do systemu Tworzenie i edycja spraw Komentarze i opisy Odnośniki do elementów Edycja atrybutów Dodawanie załączników Filtrowanie spraw Zaawansowana edycja Drukowanie i eksportowanie Personalizacja Ustawienia użytkownika Ustawienia programu Desktop Client Śledzenie spraw Nieprzeczytane sprawy Zarządzanie alertami Administrowanie systemem Panel administracyjny Informacje o serwerze Dziennik zdarzeń Zarządzanie użytkownikami Konta użytkowników Członkowie projektu Zgłoszenia rejestracji Zarządzanie projektami Aktualizacja systemu Dostosowywanie systemu Zarządzanie typami spraw Ustawienia widoków Ustawienia regionalne Ustawienia zaawansowane A. Zasoby

4 B. Licencja

5 Przedmowa O podręczniku Niniejszy podręcznik przeznaczony jest dla użytkowników i administratorów systemu wspomagającego pracę zespołową WebIssues. Został on napisany zarówno z myślą o osobach, które nigdy nie korzystały z oprogramowania do śledzenia spraw i systemów wspomagających pracę zespołową, jak i tych, które mają już doświadczenie z podobnym oprogramowaniem. Podręcznik ten został napisany przez twórcę systemu WebIssues, z uwzględnieniem pytań i uwag zgłaszanych przez użytkowników w ciągu kilku lat rozwoju tego systemu. Moim celem było stworzenie jak najbardziej użytecznej i pomocnej dokumentacji. Dlatego, w odróżnieniu od poprzedniej wersji, podręcznik ten koncentruje się bardziej na najczęściej wykonywanych zadaniach, a nie na opisie poszczególnych okien i funkcji. Podobnie jak cały system WebIssues, niniejszy podręcznik jest oparty na wolnej licencji, co oznacza, że może on być swobodnie modyfikowany i rozpowszechniany. Zachęcam zatem do przesyłania uwag oraz propozycji ulepszeń. Jak czytać podręcznik Jeśli jesteś odpowiedzialny za administrację i wdrożenie systemu, powinieneś generalnie przeczytać ten podręcznik po kolei, od początku do końca, gdyż przeprowadzi cię przez cały proces przygotowania systemu do pracy i kolejno wprowadzi w różne zagadnienia związane z użytkowaniem i administrowaniem systemem. Użytkownicy końcowi powinni przeczytać przede wszystkim Rozdział 1, Wprowadzenie oraz Rozdział 3, Praca ze sprawami i Rozdział 4, Śledzenie spraw, które omawiają podstawy pracy z systemem WebIssues. Jeśli jesteś zaawansowanym użytkownikiem i chcesz od razu przystąpić do pracy, możesz czytać ten podręcznik w dowolnej kolejności. Aby uzyskać informacje na interesujący cię temat, skorzystaj z zamieszczonego na początku spisu treści. Stosowane konwencje Aby ułatwić czytanie tego podręcznika, zostały w nim zastosowane następujące konwencje typograficzne: Pojęcie Pierwszy raz użyte pojęcie wraz z jego definicją. Nazwa Nazwa elementu interfejsu użytkownika okna, przycisku, etykiety, itp. Plik Nazwa pliku lub katalogu. Niektóre informacje zostały umieszczone w specjalnych ramkach: Wskazówka Przydatna informacja, podpowiedź lub zalecana praktyka. Uwaga Ważna informacja, na którą należy zwrócić szczególną uwagę. 5

6 Przedmowa Notatka Dodatkowa informacja przeznaczona głównie dla zaawansowanych użytkowników. Organizacja podręcznika Poniżej przedstawiona została lista rozdziałów tego podręcznika oraz ich zawartość: Rozdział 1, Wprowadzenie Wyjaśnia podstawowe zagadnienia związane ze śledzeniem spraw i wspomaganiem pracy zespołowej. Opisuje organizację danych w systemie WebIssues oraz przedstawia cykl życia przykładowych spraw. Rozdział 2, Przygotowanie systemu Opisuje krok po kroku proces instalowania nowego systemu i przygotowania go do pracy. Rozdział 3, Praca ze sprawami Wprowadza w podstawy indywidualnej pracy z systemem tworzenie i edycję spraw oraz wyszukiwanie informacji. Rozdział 4, Śledzenie spraw Prezentuje sposób współpracy wielu użytkowników systemu i efektywnej komunikacji w zespole. Rozdział 5, Administrowanie systemem Opisuje zagadnienia związane z administrowaniem projektami i użytkownikami oraz konserwacją systemu. Rozdział 6, Dostosowywanie systemu Opisuje sposoby konfigurowania i dostosowywania systemu do własnych potrzeb dla zaawansowanych administratorów. Dodatek A, Zasoby Prezentuje listę dodatkowych źródeł informacji na temat systemu WebIssues. Dodatek B, Licencja Zawiera kopię licencji niniejszego podręcznika. 6

7 Rozdział 1. Wprowadzenie W tym rozdziale zostały przedstawione podstawowe zagadnienia związane ze śledzeniem spraw i wspomaganiem pracy zespołowej. Została również opisana organizacja danych w systemie WebIssues oraz cykl życia przykładowych spraw. Powinni go przeczytać zarówno początkujący, jak i zaawansowani użytkownicy. Śledzenie spraw i praca zespołowa W dzisiejszych czasach zarządzanie informacją i komunikacja jest kluczem do sukcesu w wielu dziedzinach. Komputery zapewniają duże usprawnienie w gromadzeniu informacji, jej wyszukiwaniu i przekazywaniu. Istnieje bardzo duża liczba programów ułatwiających komunikację, pracę zespołową i przechowywanie danych. Ich różnorodność powoduje jednocześnie, że skuteczne zarządzanie informacją i pracą zespołów nie jest łatwym zadaniem. Podstawowa forma komunikacji, czyli poczta elektroniczna, jest najbardziej elastyczna i ma najwięcej zastosowań, ale jest ona trudna do skatalogowania i przeszukiwania. Gdzie znajduje się faktura przesłana w zeszłym miesiącu? Która wersja umowy została ostatecznie zatwierdzona? Również śledzenie statusu spraw wymaga dodatkowej pracy. Czy zadanie, które zleciłem pracownikowi wczoraj, zostało już wykonane? Czy problem zgłoszony w zeszłym tygodniu przez klienta został rozwiązany? Jednym z rozwiązań powyższych problemów jest stworzenie listy spraw do załatwienia i przypisanie im różnych atrybutów termin wykonania, priorytet, status. Możesz w tym celu wykorzystać prosty arkusz kalkulacyjny, ale jeśli będzie musiało go modyfikować wiele osób jednocześnie, praca będzie utrudniona. Nie dość, że nie będzie wiadomo, kto co zmodyfikował, to jeszcze istnieje ryzyko, że poszczególne osoby będą nawzajem nadpisywać swoje wcześniej dokonane zmiany. Co więcej, aby dyskutować na temat poszczególnych spraw albo przesłać związany z daną sprawą plik, i tak będziesz musiał skorzystać z innej formy komunikacji, na przykład poczty elektronicznej. Istnieje również szereg programów przystosowanych do konkretnych zastosowań. Istnieją na przykład programy ułatwiające śledzenie błędów (ang. bug tracking) w oprogramowaniu. Umożliwiają one rejestrację błędów, przypisywanie im atrybutów, a także dyskusję i dodawanie załączników. Oferują również spore możliwości wyszukiwania i przeglądania historii poszczególnych błędów. Jednak rozwiązania takie są zwykle mało uniwersalne. Jedne systemy wspierają śledzenie błędów, inne zarządzanie zadaniami, a jeszcze inne obsługę zgłoszeń serwisowych. Zatem musiałbyś korzystać z kilku takich systemów, a ponadto musiałbyś dostosować sposób pracy do możliwości danego systemu, podczas gdy powinno być odwrotnie. System WebIssues oferuje dużo większe możliwości dostosowywania do potrzeb użytkowników niż inne podobne programy. Umożliwia on śledzenie spraw, błędów, zadań, zgłoszeń i dowolnych innych informacji z taką samą elastycznością, jak np. arkusz kalkulacyjny, w którym możesz swobodnie dodawać i zmieniać kolumny. Jednocześnie system umożliwia pracę wielu osób jednocześnie, zapamiętuje i udostępnia pełną historię zmian, kontroluje uprawnienia poszczególnych osób do różnych obszarów informacji, a także umożliwia swobodne dyskutowanie i wymianę informacji o poszczególnych sprawach oraz dołączanie do nich dowolnych plików. W najprostszym przypadku możesz używać systemu WebIssues podobnie jak forum dyskusyjne lub listę mailową, gdzie poszczególne osoby wymieniają się informacjami na różne tematy. Z drugiej strony możesz go wykorzystywać jako współdzieloną bazę danych, w której poszczególne elementy (wiersze) mogą posiadać wiele atrybutów (kolumn) różnego typu, mogą być wyszukiwane według różnych kryteriów, czy drukowane w formie raportów. Możesz w końcu połączyć wszystkie jego zalety, aby uzyskać jednolite środowisko umożliwiające przechowywanie informacji i komunikację w zespole. Innym ograniczeniem tradycyjnego oprogramowania do śledzenia spraw jest to, że jest ono często dostępne tylko za pośrednictwem przeglądarki internetowej. Korzystając z poczty elektronicznej, masz możliwość dostępu zarówno przez interfejsy WWW (dzięki czemu masz dostęp do poczty z dowolnego miejsca na świecie), jak również przez program zainstalowany na swoim komputerze 7

8 Wprowadzenie (co zapewnia wygodę pracy, szybkie wyszukiwanie oraz wygodną edycję). Jeśli system śledzenia spraw jest ważnym elementem twojego codziennego środowiska pracy, również powinien oferować taką swobodę. Dlatego system WebIssues oferuje dostęp zarówno przez przeglądarkę, jak i poprzez aplikację desktopową (tzn. uruchamianą bezpośrednio na twoim komputerze). Logiczna organizacja danych W poprzednim rozdziale kilkukrotnie użyte zostało sformułowanie sprawa. Jest to najmniejsza samodzielna jednostka informacji występująca w systemie WebIssues. Jest to zarazem bardzo ogólne pojęcie pojedyncza sprawa może reprezentować błąd w oprogramowaniu, zgłoszenie serwisowe, zadanie do wykonania, wątek w dyskusji, zasób będący własnością firmy, itp. Każda sprawa w systemie posiada swój unikalny i niezmienny identyfikator, dzięki czemu możesz ją jednoznacznie zidentyfikować w całym cyklu życia. Sprawa posiada również nazwę, a także dowolną liczbę atrybutów różnych typów, analogicznie do tabeli w arkuszu kalkulacyjnym, w którym pojedynczy wiersz reprezentuje sprawę, a kolumna atrybut. W systemie WebIssues mogą istnieć niezależnie od siebie sprawy różnych typów, posiadających odmienne zestawy atrybutów podobnie jak arkusz kalkulacyjny może zawierać tabele o różnym układzie kolumn. Rysunek 1.1. Tabela zawierająca sprawy i atrybuty Począwszy od wersji 1.1 systemu WebIssues, sprawy mogą również mieć opis, który jest dłuższym tekstem wyjaśniającym szczegóły sprawy. Zwykle jest on wprowadzany przy tworzeniu sprawy, ale może również być dodany lub zmieniony później. Każda sprawa zarejestrowana w systemie posiada swoją historię, uszeregowaną chronologicznie począwszy od momentu utworzenia. Składają się na nią zmiany wartości poszczególnych atrybutów, a także komentarze oraz załączone pliki. Umożliwia to prześledzenie całego cyklu życia danej sprawy, odtworzenie jej stanu w dowolnym momencie, a także sprawdzenie, kto, kiedy i w jaki sposób zmodyfikował daną sprawę. Rysunek 1.2. Historia sprawy ze zmianami, komentarzami i załącznikami Aby zmaksymalizować produktywność i elastyczność, system WebIssues nie ma złożonego systemu uprawnień i opiera się na idei otwartej współpracy. Dlatego najlepiej nadaje się on do wewnętrznego użytku w zaufanej grupie pracowników lub członków organizacji. Każdy może tworzyć i dowolnie modyfikować wszystkie sprawy, do których ma dostęp. Każda zmiana jest jednak jawna i pozostaje trwale zarejestrowana przez system. Dodatkowo usuwanie spraw i inne potencjalne niebezpieczne lub nieodwracalne operacje wymagają specjalnych uprawnień. Aby ułatwić zarządzanie sprawami, są one logicznie podzielone na foldery. Możesz utworzyć dowolną liczbę folderów różnych typów, przy czym pojedynczy folder musi zawierać sprawy tego samego 8

9 Wprowadzenie typu. Kontynuując naszą analogię, folder jest więc odpowiednikiem tabeli w arkuszu. Korzystanie z folderów ułatwia wyszukiwanie informacji możesz np. podzielić błędy według modułów, których dotyczą, albo wersji oprogramowania, listy dyskusyjne możesz podzielić według tematu, a zgłoszenia serwisowe według miesięcy, w których zostały zarejestrowane. Foldery są z kolei pogrupowane w projekty. Dla każdego projektu możesz określić zbiór osób, które mają do niego dostęp, oraz ich uprawnienia w ramach tego projektu. Możesz zatem podzielić system na obszary, do których dostęp mają różne grupy użytkowników. Każdy projekt może również mieć swojego administratora (lub kilku administratorów). Administrator projektu ma większe uprawnienia niż zwykły użytkownik, np. ma możliwość usuwania spraw lub przenoszenia ich między folderami. Rysunek 1.3. Drzewo projektów i folderów Nie ma możliwości definiowania uprawnień na niższym poziomie szczegółowości niż pojedynczy projekt. Wszyscy członkowie projektu mają zatem równoprawny dostęp do wszystkich informacji zawartych w tym projekcie i możliwość ich modyfikowania. System WebIssues zapewnia natomiast bezpieczeństwo przed niepowołanym dostępem do danych przez nieuprawnione osoby. Cykl życia sprawy Na początek załóżmy, że system WebIssues jest używany do wewnętrznej komunikacji między członkami zespołu, zastępując fora dyskusyjne bądź listy mailowe. Folder reprezentuje forum lub listę związaną z określonym tematem, a sprawa wątek dyskusji. Proste forum Jan Kowalski jest nowym pracownikiem w twojej firmie i dopiero uczy się używać różnych programów, które są mu potrzebne do pracy. Jeden z programów księgowych, Big Finances, nie chce się uruchomić i zamiast tego wyświetlił niezrozumiały komunikat błędu. Kowalski loguje się do systemu WebIssues i otwiera folder Pomoc. Następnie dodaje nową sprawę i nadaje jej nazwę Problem z Big Finances. W opisie sprawy wyjaśnia, co robił kiedy wystąpił problem. Dołącza również zrzut ekranu z komunikatem błędu w postaci pliku graficznego. Ponieważ starasz się pomagać nowym pracownikom, regularnie w ciągu dnia zaglądasz do folderu Pomoc. Wszystkie wątki (sprawy) są domyślnie posortowane według daty ostatniej modyfikacji. Co więcej, nowe wątki, których jeszcze nie czytałeś, są oznaczone żółtym symbolem zamkniętej koperty i dodatkowo pogrubione podobnie jak w wielu programach pocztowych czy forach dyskusyjnych. Otwierasz sprawę, czytasz opis problemu i otwierasz załącznik. 9

10 Wprowadzenie To dość częsty problem wystarczy skasować jeden błędny plik i program Big Finances znowu powinien działać. Dodajesz do sprawy komentarz, w którym opisujesz sposób postępowania. Niedługo potem Kowalski zagląda znowu do katalogu Pomoc i zauważa, że jego sprawa jest oznaczona zieloną, zamkniętą kopertą i pogrubiona. Oznacza to, że ktoś inny zmodyfikował sprawę od czasu, kiedy ją ostatnio otwierał. Kowalski czyta twój komentarz, wykonuje opisane kroki i uruchamia program. Następnie odpisuje, że zaproponowane przez ciebie rozwiązanie pomogło rozwiązać problem. Przeglądając ponownie folder Pomoc szybko zauważasz zieloną kopertę kolejny raz pomogłeś komuś nawet nie ruszając się z miejsca. Zgłoszenia serwisowe Pół roku później firma rozrosła się tak, że nie jesteś w stanie już pomagać wszystkim pracownikom, nie zaniedbując własnych obowiązków. Co gorsza pojawiło się nowe oprogramowanie Great Finances, którego nie znasz tak dobrze i nie potrafisz samodzielnie rozwiązać wszystkich problemów. Zwykłe forum dyskusyjne przestało już wystarczać i konieczne było wprowadzenie wirtualnego punktu serwisowego. Kowalski od niedawna używa nowego programu Great Finances i radzi sobie dobrze, ale właśnie pojawił się problem przy rozliczaniu faktur. Kowalski loguje się do systemu WebIssues i otwiera folder Great Finances ze względu na dużą liczbę zgłoszeń, trzeba je było podzielić na osobne foldery związane z poszczególnymi programami. Dodając nową sprawę, oprócz nazwy musi teraz także wypełnić kilka dodatkowych pól (atrybutów) rodzaj problemu, nazwa modułu oraz wersja używanego programu. Załącza również dokładny opis problemu. W dalszym ciągu regularnie zaglądasz do systemu serwisowego, ale zajmujesz się głównie przypisywaniem nowych zgłoszeń innym osobom, a samodzielnie rozwiązujesz jedynie sprawy związane z programem Big Finances. Ponieważ zgłoszeń w systemie jest bardzo dużo, korzystasz z widoku Nowe zgłoszenia, który wyświetla jedynie te zgłoszenia, które nie są jeszcze przypisane do żadnej osoby. W widoku tym pojawia się nowe zgłoszenie utworzone przez Kowalskiego. Nie czytając nawet opisu problemu, spoglądasz tylko na typ problemu i nazwę modułu, a następnie przechodzisz do trybu edycji sprawy. W polu Przypisany do wybierasz z listy użytkowników Adama Nowaka, który specjalizuje się w rozliczaniu faktur. Po zapisaniu sprawa znika z widoku Nowe zgłoszenie, ponieważ zostało ono już przypisane. Adam Nowak korzysta z widoku Aktywne zgłoszenia, w którym widzi tylko sprawy przypisane do niego i posiadające status Aktywny (który jest domyślny dla nowo utworzonych zgłoszeń). Ponieważ nie zawsze ma czas na bieżąco do niego zaglądać, włączył sobie dodatkowe powiadomienie, które informuje go o em o nowych sprawach w tym widoku. Nowak potrzebuje więcej informacji od Kowalskiego, zatem dodaje komentarz z prośbą o ich dostarczenie. Kowalski widzi sprawę w widoku Moje zgłoszenia, zawierającym wszystkie aktywne sprawy, które zostały przez niego utworzone, a zielona ikonka, tak jak poprzednio, informuje go o wszystkich zmianach atrybutów i nowych komentarzach. Przepływ pracy W wielu sytuacjach cykl życia sprawy może być jeszcze bardziej złożony, a w proces jego przetwarzania może być zaangażowanych wiele osób. Powszechnym przykładem jest cykl życia błędu w oprogramowaniu. Jest on tworzony przez testera, a następnie jest weryfikowany i przypisywany przez kierownika projektu do odpowiedniego programisty. Programista rozwiązuje (naprawia) błąd, a tester może albo zaakceptować rozwiązanie i zamknąć błąd albo je odrzucić i przypisać z powrotem do programisty. 10

11 Wprowadzenie Rysunek 1.4. Przykładowy cykl życia błędu Taki proces, w którego poszczególne kroki są zaangażowane różne osoby, nazywa się często przepływem pracy (ang. workflow). W niektórych systemach przepływ pracy jest zdefiniowany w sztywny sposób i nie może być zmieniany lub może być modyfikowany jedynie w niewielkim stopniu. Inne systemy posiadają skomplikowane narzędzia służące do projektowania przepływu pracy. W systemie WebIssues przepływ pracy nie jest w żaden sposób wymuszony, ale można go w bardzo łatwy sposób modelować, wykorzystując w odpowiedni sposób atrybuty (określające aktualny stan sprawy, a także przypisaną do niej osobę), widoki (ograniczające zbiór spraw do znajdujących się w określonym stanie i przypisane do odpowiedniej osoby) oraz śledzenie stanu spraw (wskazujące nowe i zmodyfikowane sprawy). Osoby uczestniczące w różnych etapach przepływu pracy mogą korzystać z różnych widoków, aby skoncentrować się tylko na tych sprawach, które wymagają ich interwencji. Przykładowo, programistę na ogół interesują tylko aktywne i przypisane do niego błędy, ale w razie potrzeby ma dostęp do wszystkich błędów niezależnie od ich stanu na przykład aby odnaleźć inne błędy, które mogą być potencjalnie związane z aktualnie przetwarzanym. Również osoby nadzorujące cały proces mogą w odpowiedni sposób korzystać z widoków, aby kontrolować liczbę aktywnych spraw lub podejmować odpowiednie kroki w sytuacji, gdy jakiś błąd przez dłuższy czas pozostaje nierozwiązany. Dodatkowo mają do dyspozycji narzędzia umożliwiające tworzenie raportów czy eksport danych do innego programu (np. arkusza kalkulacyjnego) w celu dalszej analizy. 11

12 Rozdział 2. Przygotowanie systemu Aby korzystać z systemu WebIssues, niezbędne jest skonfigurowanie serwera, który jest jego centralną i najważniejszą częścią. Niniejszy rozdział opisuje krok po kroku proces instalowania serwera WebIssues i przygotowania go do pracy. Jeśli korzystasz z już istniejącego serwera, możesz pominąć ten rozdział. Informacje na temat aktualizowania systemu do nowej wersji znajdziesz w sekcji Aktualizacja systemu. Wymagania Możesz zainstalować oprogramowanie serwera WebIssues na komputerze z systemem Unix/Linux, OS X lub Windows. Przed przystąpieniem do instalacji potrzebujesz następujących komponentów: Serwer WWW Serwer bazy danych PHP Możesz użyć serwera Apache, który działa na niemal wszystkich systemach operacyjnych (zalecana jest wersja 2.0 lub nowsza). Możesz również użyć serwera Microsoft IIS, który jest częścią systemu Windows (zalecana jest wersja 7.0 lub nowsza). Niezbędny jest jeden z następujących serwerów baz danych: MySQL (w wersji lub nowszej) PostgreSQL (w wersji 8.0 lub nowszej) Microsoft SQL Server (w wersji 2005 lub nowszej) Aby zainstalować system, musisz utworzyć bazę danych na jednym z powyższych serwerów oraz konto użytkownika posiadające uprawnienia wystarczające do tworzenia tabel i indeksów w tej bazie danych. W przypadku bazy MySQL wymagana jest obsługa silnika InnoDB. Baza danych PostgreSQL powinna być utworzona z kodowaniem znaków w standardzie Unicode. Baza SQL Server może być użyta tylko, jeśli serwer WebIssues jest zainstalowany na komputerze z systemem Windows. Serwer WebIssues wymaga również PHP w wersji lub nowszej, zintegrowanego z serwerem WWW. W przypadku serwera IIS, dla uzyskania najlepszej wydajności zalecane jest użycie modułu fastcgi oraz rozszerzenia wincache. PHP musi mieć zainstalowane i włączone w pliku php.ini rozszerzenie mbstring, a jeśli korzystasz z bazy danych MySQL lub PostrgreSQL, również odpowiednio rozszerzenie mysqli lub pgsql. W przypadku bazy danych SQL Server, począwszy od w wersji lub PHP musi być włączone rozszerzenie com_dotnet. Jeśli instalujesz serwer WebIssues korzystając z zewnętrznej usługi hostingowej, upewnij się, że spełnia ona wszystkie powyższe wymagania. Aby utworzyć bazę danych i skonfigurować serwer WWW, skorzystaj z narzędzi dostarczonych przez dostawcę usług hostingowych i zapoznaj się z dostępną dokumentacją. Uwaga Niektóre usługi hostingowe mogą mieć specyficzną konfigurację lub inne ograniczenia utrudniające lub nawet uniemożliwiające poprawne zainstalowanie serwera WebIssues. Mogą one na przykład ograniczać ilość dostępnej pamięci, rozmiar bazy danych albo wielkość przesyłanych do serwera plików. Instalacja WebIssues na serwerze z włączonym modułem mod_security może powodować problemy. W zależności od konfiguracji, może on uniemożliwić dostęp do systemu za pośrednictwem programu Desktop Client lub blokować poprawne żądania zawierające określone słowa. Zalecane jest całkowite wyłączenie modułu mod_security lub wyłącze- 12

13 Przygotowanie systemu nie tych reguł, które powodują problemy. Więcej informacji możesz uzyskać na stronie Przed zainstalowaniem serwera WebIssues, zainstaluj i skonfiguruj niezbędne komponenty, a następnie utwórz bazę danych, korzystając z odpowiednich narzędzi administracyjnych. Zapoznaj się z dokumentacją tych narzędzi, aby uzyskać więcej informacji na ich temat. Więcej informacji temat tworzenia bazy danych i konfigurowania serwera WWW znajdziesz na stronie wiki/webissues/installation. Instalacja Po upewnieniu się, że wymagane komponenty są zainstalowane i skonfigurowane, oraz utworzeniu bazy danych, możesz przystąpić do właściwej instalacji serwera WebIssues. Kopiowanie plików Ściągnij i rozpakuj pakiet serwera WebIssues zawiera on katalog o nazwie webissues-x.y (gdzie x.y to wersja pakietu). Następnie przenieś wszystkie pliki i podkatalogi z tego katalogu do katalogu głównego serwera WWW. Jeśli korzystasz z zewnętrznego hostingu, na ogół do kopiowania plików na serwer używa się protokołu FTP, a więc będziesz potrzebował do tego celu klienta FTP. Notatka Istnieje możliwość zainstalowania serwera WebIssues wraz z innymi stronami i aplikacjami WWW działającymi na tym samym komputerze. Możesz zainstalować serwer w podkatalogu umieszczonym w katalogu głównym serwera WWW, a także na wirtualnym hoście lub w wirtualnym katalogu. Zapoznaj się z dokumentacją twojego serwera WWW lub usługi hostingowej, aby uzyskać więcej informacji na ten temat. Możesz także utworzyć wiele odrębnych instancji serwera WebIssues w ramach jednej instalacji. Poszczególne instancje mogą być dostępne poprzez różne nazwy domen lub subdomen albo w różnych wirtualnych podkatalogach. Więcej informacji na ten temat znajdziesz na stronie Następnie nadaj prawo zapisu do podkatalogu data/sites użytkownikowi, w kontekście którego działa usługa WWW. Skorzystaj w tym celu z menedżera plików lub klienta FTP albo uruchom polecenie chmod z linii poleceń. W katalogu tym, podczas instalacji, zostanie utworzony plik konfiguracyjny. Będą w nim również przechowywane dołączone do spraw załączniki. Uwaga Upewnij się, że katalogi data oraz common/data są zabezpieczone przed niepowołanym dostępem przez serwer WWW. W przeciwnym wypadku będzie możliwe pobieranie przechowywanych w systemie załączników bez odpowiedniej autoryzacji. Jeśli korzystasz z serwera Apache, możesz w tym celu wykorzystać załączone w pakiecie pliki.htaccess. Więcej informacji na ten temat znajdziesz na stronie Po zakończeniu instalacji upewnij się również, że plik konfiguracyjny systemu WebIssues jest chroniony przed niepowołanym dostępem, ponieważ zawiera on między innymi login i hasło do bazy danych. Jest to szczególnie istotne w przypadku korzystania z publicznych usług hostingowych. Dla zapewnienia największego bezpieczeństwa zaleca się, aby pliki konfiguracyjne i załączniki nie były przechowywane w katalogu data, ale w innej lokalizacji położonej poza katalogiem głównym serwera WWW. Więcej informacji na temat zmiany lokalizacji katalogu zawierającego te pliki znajdziesz na stronie 13

14 Przygotowanie systemu Konfiguracja systemu Teraz możesz już otworzyć stronę główną systemu WebIssues. Uruchom swoją ulubioną przeglądarkę internetową i wpisz adres URL serwera, na przykład Powinieneś zobaczyć następujący komunikat: Rysunek 2.1. Komunikat powitalny Nie przejmuj się, że komunikat jest po angielsku. Jeśli postąpisz zgodnie z instrukcją i klikniesz odnośnik, zostaniesz zapytany o język, który będzie używany w czasie instalacji. Będzie to również domyślny język, w jakim system WebIssues będzie wyświetlał wszystkie komunikaty. W następnym kroku instalacji wyświetlone zostaną podstawowe informacje na temat twojego serwera: nazwa instancji (zwykle będzie to default, chyba że tworzysz wiele instancji serwera w ramach jednej instalacji), bazowy adres URL serwera oraz ścieżka katalogu, w którym zostanie utworzony plik konfiguracyjny. Zostanie również wyświetlona wersja PHP, serwera WWW i systemu operacyjnego oraz nazwa komputera, na którym instalujesz system WebIssues. Po zweryfikowaniu tych informacji, przejdź do następnego kroku. Rysunek 2.2. Konfiguracja połączenia z bazą danych 14

15 Przygotowanie systemu Zostaniesz poproszony o wprowadzenie informacji niezbędnych do połączenia z wcześniej utworzoną bazą danych. Wybierz rodzaj bazy danych, a następnie podaj nazwę hosta serwera bazy danych, jeśli znajduje się on na innym komputerze niż serwer WWW, nazwę bazy danych oraz login i hasło użytkownika posiadającego prawo tworzenia tabel w tej bazie danych. W przypadku bazy SQL Server możesz pozostawić login i hasło puste, aby użyć zintegrowanej autentykacji Windows. Pozostaw opcję Zainstaluj nowy serwer zaznaczoną jeśli tworzysz nowy serwer. Jeśli natomiast chesz utworzyć nowy plik konfiguracyjny dla wcześniej utworzonego serwera, wybierz opcję Użyj istniejącego serwera. W tym przypadku strona służąca do wprowadzania parametrów nowego serwera zostanie pominięta, a baza danych nie zostanie w żaden sposób zmodyfikowana, chyba że musi ona być zaktualizowana do nowszej wersji. Notatka Możesz również określić prefiks, który zostanie dodany przed nazwami wszystkich tabel i innych obiektów w bazie danych. Jeśli na przykład wybierzesz prefiks wi_, zostaną utworzone tabele o nazwach wi_server, wi_users, itd. Wybierając unikalny prefiks, możesz zainstalować wiele różnych aplikacji korzystających z jednej bazy danych. Możesz również utworzyć kilka oddzielnych instancji serwera WebIssues w ramach jednej bazy danych. Podaj niezbędne informacje i przejdź do następnego kroku. System WebIssues spróbuje połączyć się z serwerem bazy danych, a w przypadku błędu wyświetli odpowiedni komunikat. Jeśli połączenie się powiedzie, zostanie wyświetlona następująca strona: Rysunek 2.3. Parametry nowego serwera Podaj nazwę serwera, która będzie widoczna dla wszystkich użytkowników w pasku tytułowym. Wprowadź również hasło dla konta administratora, którego będziesz mógł później użyć, aby zalogować się do serwera i zmieniać jego ustawienia. Domyślnie instalator utworzy kilka predefiniowanych typów spraw i widoków. Najlepiej pozostaw to ustawienie, aby szybko rozpocząć pracę z systemem. Będziesz miał później możliwość swobodnego 15

16 Przygotowanie systemu dostosowania, a nawet usunięcia tych wbudowanych typów. Jeśli jednak chcesz samodzielnie utworzyć wszystkie typy spraw od podstaw, wybierz opcję Nie instaluj żadnych typów spraw. Przejdź do kolejnej strony, która zawiera krótkie podsumowanie czynności, które zostaną wykonane. Kliknij przycisk Instaluj, aby rozpocząć instalację. Może to potrwać jakiś czas. Jeśli instalacja zakończy się sukcesem, zostanie wyświetlony odpowiedni komunikat. Wskazówka Aby w przyszłości utworzyć nowy plik konfiguracyjny, na przykład po przeniesieniu bazy danych na inny serwer, po prostu skasuj istniejący plik konfiguracyjny. Zostaniesz wtedy poproszony o uruchomienie instalatora, który utworzy nowy plik konfiguracyjny z odpowiednimi parametrami. Konfiguracja początkowa Po zainstalowaniu nowego serwera WebIssues, zawiera on początkową konfigurację i ustawienia, ale zanim będzie można z niego korzystać, musisz wykonać jeszcze kilka kroków. Po pierwsze, musisz utworzyć konta użytkowników, którzy będą używać systemu. Po drugie, musisz utworzyć projekty i foldery, w których będą przechowywane sprawy. Konta użytkowników Zacznijmy od stworzenia kont użytkowników. Kliknij odnośnik Panel administracyjny w prawym górnym rogu okna, a następnie wybierz opcję Konta użytkowników. Powinieneś zobaczyć jednego użytkownika o nazwie Administrator, którego utworzył instalator. Utwórz swoje osobiste konto, żebyś nie musiał się logować jako administrator. W tym celu kliknij Dodaj użytkownika, a następnie podaj swoje imię i nazwisko oraz login i hasło, których będziesz używał do logowania się do systemu. Następnie naciśnij OK. Rysunek 2.4. Tworzenie konta użytkownika Powtórz powyższe kroki, tworząc konta dla pozostałych osób, które będą korzystać z systemu. Dla każdego z nich musisz podać początkowe hasło, ale dla większego bezpieczeństwa możesz zaznaczyć opcję Użytkownik musi zmienić hasło przy następnym logowaniu, jeśli chcesz, aby każdy ustawił swoje własne hasło w momencie logowania do systemu. W systemie WebIssues może istnieć więcej użytkowników o uprawnieniach administratora. Aby zmienić uprawnienia użytkownika, wybierz go klikając jego nazwę na liście, a następnie kliknij Zmień dostęp. Możesz wybrać prawo administratora systemu lub zwykłego użytkownika, a także wyłączyć dostęp do systemu dla danego użytkownika. Naciśnij OK, aby zatwierdzić zmiany. 16

17 Przygotowanie systemu Wskazówka Administrator systemu ma dostęp do Panelu administracyjnego, a także jest administratorem wszystkich istniejących w systemie projektów, nawet jeśli nie jest ich członkiem. Nadawaj więc to uprawnienie tylko zaufanym osobom. Skonfigurowana lista kont użytkowników może wyglądać jak na poniższym rysunku: Rysunek 2.5. Lista kont użytkowników Aby znaleźć więcej informacji na temat administrowania kontami użytkowników, przeczytaj sekcję Zarządzanie użytkownikami. Projekty i foldery Kliknij odnośnik Klient WWW w prawym górnym rogu okna, aby przejść do głównej części systemu WebIssues. Po lewej stronie zobaczysz puste drzewo projektów i folderów. Kliknij Zarządzaj projektami, a następnie użyj polecenia Dodaj projekt, aby utworzyć pierwszy projekt. Nadaj mu nazwę Mój pierwszy projekt i naciśnij OK. Rysunek 2.6. Tworzenie projektu Nowy projekt pojawi się w drzewie. Kliknij na tym projekcie, aby go zaznaczyć, a w pasku narzędzi pojawi się szereg operacji, które możesz na nim wykonać. Zacznijmy od utworzenia folderów. Kliknij Dodaj folder i utwórz folder o nazwie Błędy, wybierając typ spraw o tej samej nazwie. 17

18 Przygotowanie systemu Rysunek 2.7. Tworzenie folderu Po utworzeniu folderu, zostanie on wyświetlony w drzewie poniżej projektu. Wybierz ponownie projekt i dodaj kolejny folder typu Zadania. Następnie powtórz tą samą czynność, aby utworzyć folder typu Forum. Drzewo projektów będzie wyglądać następująco: Rysunek 2.8. Drzewo projektów Na razie nowo utworzony projekt jest dostępny tylko dla administratorów systemu. Aby udzielić dostępu do niego pozostałym użytkownikom, wybierz projekt i kliknij Członkowie projektu. Zostanie wyświetlona pusta lista. Teraz kliknij Dodaj członków, a następnie wybierz wszystkich użytkowników oprócz konta o nazwie Administrator. Kliknij OK. Możesz również nadać wybranym członkom prawo administratora projektu. Wybierz użytkownika i kliknij Zmień dostęp, a następnie wybierz poziom uprawnień w podobny sposób, jak w przypadku zmiany dostępu użytkownika do systemu. Wskazówka Administrator projektu może tworzyć i modyfikować foldery, zmieniać opis projektu, a także nadawać i odbierać uprawnienia innym użytkownikom w ramach tego projektu. Może również usuwać sprawy, a także usuwać i modyfikować komentarze innych użytkowników. Skonfigurowana lista członków projektu może wyglądać tak jak poniżej: Rysunek 2.9. Lista członków projektu 18

19 Przygotowanie systemu Kliknij OK, aby wrócić do głównego okna programu. Projekt wraz z folderami pojawi się w drzewie po lewej stronie okna. Wskazówka Jeśli używasz programu Desktop Client, polecenia służące do zarządzania projektami i folderami są dostępne bezpośrednio w głównym oknie programu. Uaktywnij drzewo projektów, klikając na nim, aby uzyskać do nich dostęp (pod warunkiem, że masz odpowiednie uprawnienia). Przeczytaj sekcję Zarządzanie projektami w dalszej części tego podręcznika, aby dowiedzieć się więcej na temat administrowania projektami i folderami. Powiadomienia mailowe System WebIssues ma możliwość wysyłania i informujących o nowych i zmienionych sprawach w wybranych widokach. Jest to opcjonalne, ponieważ nie zawsze pozwala na to konfiguracja komputera lub usługi hostingowej i nie w każdym przypadku jest to potrzebne. Jeśli chcesz włączyć wysyłanie powiadomień mailowych, musisz wykonać dwa dodatkowe kroki konfiguracyjne. Wysyłanie poczty Najpierw przejdź do Panelu administracyjnego i kliknij Ustawienia i, aby skonfigurować wysyłanie poczty. Rysunek Ustawienia i Jeśli PHP na twoim serwerze jest tak skonfigurowane, że ma możliwość wysyłania i poprzez program sendmail lub lokalny serwer SMTP, wybierz opcję Standardowy mailer PHP i wpisz adres, z którego będą wysyłane wiadomości. 19

20 Przygotowanie systemu Notatka Więcej informacji na temat konfigurowania standardowego mechanizmu wysyłania i wbudowanego w PHP znajdziesz na stronie mail.configuration.php. Istnieje również możliwość wysyłania i za pośrednictwem zewnętrznego serwera SMTP. Możesz w tym celu wykorzystać serwer pocztowy twojej firmy lub organizacji albo dowolną publiczną usługę pocztową (np. gmail). Wybierz opcję Własny serwer SMTP i wpisz adres nadawcy wiadomości. Następnie w ramce Serwer SMTP wpisz adres serwera i numer portu usługi pocztowej (zwykle 25 lub 465 dla połączeń szyfrowanych). Wybierz tryb szyfrowania, jeśli serwer SMTP obsługuje szyfrowanie komunikacji. Podaj także nazwę użytkownika i hasło dostępu do serwera SMTP. Kliknij Testuj połączenie aby sprawdzić, czy konfiguracja SMTP jest poprawna. System WebIssues wyśle testową wiadomość na swój własny adres. Jeśli ją otrzymasz, oznacza to, że konfiguracja jest poprawna. Nie zapomnij również zapisać konfigurację klikając OK. Ponieważ e są wysyłane w formacie HTML, możliwe jest umieszczenie w nich odnośników do folderu, którego dotyczy powiadomienie, a także do poszczególnych spraw. Aby włączyć odnośniki, musisz wpisać bazowy adres URL, pod jakim zainstalowany jest serwer WebIssues. Adres powinien zawierać protokół oraz końcowy znak /, na przykład Kliknij Wykryj, aby automatycznie wprowadzić adres bieżącej strony. Pamiętaj, że adres powinien zawierać pełną, jednoznaczną nazwę domenową serwera, aby był on dostępny dla wszystkich użytkowników. Jeśli adres URL będzie pozostawiony pusty, e będą wysyłane bez odnośników. Rysunek Odnośniki Zadania cykliczne Drugim krokiem jest skonfigurowanie cyklicznego zadania, które będzie wysyłać powiadomienia. Zadanie to powinno być wykonywane przynajmniej raz na godzinę, ale żeby szybciej otrzymywać powiadomienia natychmiastowe, zaleca się, żeby zadanie to było wykonywane w odstępach od 5 do 15 minut. W przypadku systemów Unix/Linux możesz wykorzystać mechanizm zadań cron. Aby dodać zadanie, zmodyfikuj plik /etc/crontab lub użyj graficznego narzędzia do zarządzania zadaniami. Jeśli używasz systemu Windows, otwórz Harmonogram zadań i utwórz nowe zadanie. Więcej informacji znajdziesz na stronie Notatka Niektóre usługi hostingowe udostępniają możliwość definiowania zadań cyklicznych poprzez dostęp do powłoki lub przez panel administracyjny. Zapoznaj się z dokumentacją usługi, aby uzyskać więcej informacji na ten temat. Jeśli twoja usługa hostingowa nie oferuje możliwości uruchamiania zadań cyklicznych, możesz zainstalować takie zadanie na innym komputerze. Możesz na przykład skorzystać z jednej z dostępnych usług cron online niektóre z nich są dostępne za darmo. Jeśli zadanie cyklicznie jest wykonywane lokalnie, powinno ono uruchamiać skrypt cron/job.php przy użyciu interpretera PHP. Więcej informacji na temat uruchamiania PHP z wiersza poleceń znajdziesz na stronie 20