Dokumentacja techniczna

Rozdział 1

Wymagania funkcjonalne przedstawione w tabeli

Numer funkcji	Nazwa funkcji	Nazwa procesu biznesowego	Specyfikacja funkcji	Źródło danych	Zawartość danych wejściowych	Przeznaczenie danych wyjściowych	Zawartość danych wyjściowych
1	Operacja na obiekcie		Złożona	Klient FTP, Baza uprawnień, System Plików	Plik (LBIN), Ścieżka (TXT), Rodzaj operacji (TXT), Uprawnienia (TXT)	Klient FTP, Kontrola błędów	Lista zawartości katalogu (TXT). Plik (LBIN), Rezultat (TXT)
1.1	Kontrola poprawności		Złożona	Klient FTP, Wszystkie podprocesy procesu 1, Baza uprawnień	Rodzaj operacji (TXT), Ścieżka (TXT). Rezultat operacji (TXT)	Wszystkie podprocesy procesu 1, Obsługa błędów	Ścieżka (TXT). Rezultat (TXT)
1.1.1	Kontrola rezultatu polecenia		Prosta	Wszystkie podprocesy 1	Rezultat operacji (TXT)	Generowanie rezultatu	Rezultat (TXT)
1.1.2	Generowanie rezultatu		Prosta	Kontrola uprawnień, Kontrola rezultatu polecenia	Rezultat (TXT)	Obsługa błędów	Rezultat (TXT)
1.1.3	Kontrola uprawnień		Prosta	Klient FTP, Baza uprawnień	Ścieżka (TXT), Rodzaj operacji (TXT), Uprawnienia (TXT)	Wszystkie podprocesy 1	Ścieżka (TXT)
1.2	Tworzenie katalogu	Tworzenie katalogu	Prosta	Kontrola poprawności, Obsługa plików	Ścieżka (TXT), Rezultat (TXT)	Kontrola poprawności, Obsługa plików	Rezultat operacji (TXT), Ścieżka (TXT)
1.3	Przeglądanie katalogu	Przeglądanie katalogu	Prosta	Kontrola poprawności, Obsługa plików	Ścieżka (TXT), Rezultat (TXT)	Kontrola poprawności, Klient FTP	Rezultat operacji (TXT). Lista zawartości katalogu (TXT), Ścieżka (TXT)
1.4	Przeniesienie obiektu	Przeniesienie obiektu	Prosta	Kontrola poprawności, Obsługa plików	Ścieżka (TXT), Rezultat (TXT)	Kontrola poprawności, Obsługa plików	Rezultat operacji (TXT), Ścieżka (TXT)
1.5	Usunięcie obiektu	Usunięcie obiektu	Prosta	Kontrola poprawności, Obsługa plików	Ścieżka (TXT), Rezultat (TXT)	Kontrola poprawności, Obsługa plików	Rezultat operacji (TXT), Ścieżka (TXT)
1.6	Wysłanie pliku	Wysłanie pliku	Prosta	Kontrola poprawności, Klient FTP, Obsługa plików	Ścieżka (TXT). Plik (LBIN), Rezultat (TXT)	Kontrola poprawności, Obsługa plików	Rezultat operacji (TXT), Plik (LBIN)
1.7	Pobranie pliku	Pobranie pliku	Prosta	Kontrola poprawności, Obsługa plików	Ścieżka (TXT), Plik (LBIN)	Kontrola poprawności, Klient FTP	Rezultat operacji (TXT). Plik (LBIN)
1.8	Obsługa plików		Prosta	Wszystkie podprocesy procesu 1 za wyjątkiem 1.1, System plików	Ścieżka (TXT), Plik (LBIN)	Wszystkie podprocesy procesu 1 za wyjątkiem 1.1, System plików	Dane (TXT), Plik (LBIN), Rezultat (TXT)
2	Obsługa błędów		Elementarna	Logowanie, Operacje na obiekcie	Rezultat (TXT)	Klient FTP	Komunikat o stanie operacji (TXT)
3	Logowanie	Logowanie z hasłem	Złożona	Klient FTP	Login (TXT), Hasło (TXT)	Kontrola błędów, Baza użytkowników	Rezultat (TXT), Dane użytkownika (TXT)
3.1	Pobranie danych użytkownika		Prosta	Baza użytkowników	Dane użytkownika (TXT)	Kontrola poprawności danych użytkownika	Dane użytkownika (TXT)
3.2	Kontrola poprawności danych użytkownika		Prosta	Klient ftp, Pobranie danych użytkownika	Login (TXT), Hasło (TXT), Dane użytkownika (TXT)	Obsługa błędów	Rezultat (TXT)
4	Zarządzanie użytkownikami i uprawnieniami	Dodanie użytkownika, Usunięcie użytkownika, Zmiana hasła Klient użytkownika, Przeglądanie listy Klient użytkowników, Zmiana praw dostępu do katalogu, Wyświetlenie praw dostępu do katalogu	Elementarna. Informacje gromadzone w bazie danych. Komunikacja realizowana przez linię komend systemu zarządzania bazą (osobny system)	Administrator, Baza użytkowników, Baza uprawnień	Uprawnienie (TXT), Dane użytkownika (TXT), Polecenie (TXT)	Administrator, Baza użytkowników, Baza uprawnień	Nazwa użytkownika (TXT), Hasło (TXT), Dane użytkownika (TXT), Wynik (TXT), Uprawnienie (TXT)

Model realizowanego systemu (wyróżnić implementowane funkcje)

Drzewo procesów:

Serwer FTP [0]
Obsluga bledow [2]
Logowanie [3]
Kontrola poprawnosci danych uzytkownika [3.2]
Pobranie danych użytkownika [3.1]
Operacja na obiekcie [1]
Kontrola poprawności [1.1]
Generowanie rezultatu [1.1.2]
Kontrola rezultatu polecenia [1.1.1]
Kontrola uprawnień [1.1.3]
Pobranie pliku [1.7]
Przeglądanie katalogu [1.3]
Przeniesienie obiektu [1.4]
Tworzenie katalogu [1.2]
Usunięcie obiektu [1.5]
Wysłanie pliku [1.6]
Zarządzanie użytkownikami i uprawnieniami [4]

Funkcje w systemie informatycznym

1. Operacja na obiekcie (plik/katalog)

1. Kontrola poprawności operacji

1. Kontrola rezultatu polecenia

2. Generowanie rezultatu operacji

3. Kontrola uprawnień

2. Tworzenie katalogu

3. Przeglądanie katalogu

4. Przeniesienie obiektu (plik/katalog)

5. Usunięcie obiektu (plik/katalog)

6. Wysłanie pliku

7. Pobranie pliku

2. Obsługa błędów

3. Logowanie

1. Kontrola poprawności danych użytkownika

2. Generowanie zapytania dla danych użytkownika

4. Zarządzanie użytkownikami i uprawnieniami

Aktorzy w systemie informatycznym

Aktorami w systemie informatycznym są administrator, Klient FTP (oprogramowanie klienta) i system plików. System plików to wybrany przez korporację sposób przechowywania danych na platformie Windows.

Lista zdarzeń w systemie informatycznym

Oprogramowanie klienta

1. Wysłanie pliku

2. Pobranie pliku

3. Przeniesienie obiektu

4. Usunięcie obiektu

5. Przeglądanie katalogu

6. Tworzenie katalogu

7. Logowanie z hasłem

Administrator

1. Dodanie użytkownika

2. Usunięcie użytkownika

3. Zmiana hasła użytkownika

4. Przeglądanie listy użytkowników

5. Zmiana praw dostępu do katalogu

6. Wyświetlenie praw dostępu do katalog

Diagram USE CASE

Scenariusze

Use Case Dodawanie użytkownika

Action steps of use case Dodawanie użytkownika

Administrator wpisuje polecenie dodania użytkownika. Serwer wprowadza nowy rekord do tabeli użytkowników.

Use Case Logowanie z hasłem

Action steps of use case Logowanie z hasłem

Klient FTP przesyła nazwę użytkownika i hasło. System sprawdza poprawność danych.

Exceptions of use case Logowanie z hasłem

W przypadku błędnych danych następuje ponowne zapytanie o poprawne dane.

Use Case Nadawanie uprawnień do katalogów

Action steps of use case Nadawanie uprawnień do katalogów

Administrator wpisuje polecenie nadania uprawnień do wybranego katalogu. Serwer wprowadza nowy rekord do tabeli uprawnień.

Use Case Pobranie pliku

Action steps of use case Pobranie pliku

Klient FTP wysyła polecenie pobrania pliku. Po sprawdzeniu uprawnień serwer wysyła plik do Klienta FTP.

Exceptions of use case Pobranie pliku

W przypadku braku uprawnień lub nieistniejącego pliku serwer zwraca komunikat o błędzie.

Use Case Przeglądanie katalogu

Action steps of use case Przeglądanie katalogu

Klient FTP wysyła polecenie wylistowania katalogu. Po sprawdzeniu uprawnień serwer wyświetla rezultat.

Exceptions of use case Przeglądanie katalogu

W przypadku braku uprawnień lub nieistniejącego katalogu serwer zwraca komunikat o błędzie.

Use Case Przeglądanie listy użytkowników

Action steps of use case Przeglądanie listy użytkowników

Administrator wpisuje polecenie wyświetlenia listy użytkowników. Serwer wyświetla wszystkie dane z tabeli użytkowników.

Use Case Przeniesienie obiektu

Action steps of use case Przeniesienie obiektu

Klient FTP wysyła polecenie przeniesienia obiektu. Po sprawdzeniu uprawnień serwer przenosi obiekt.

Exceptions of use case Przeniesienie obiektu

W przypadku braku uprawnień lub nieistniejącego pliku/katalogu serwer zwraca komunikat o błędzie.

Use Case Sprawdzenie uprawnień

Action steps of use case Sprawdzenie uprawnień

Serwer sprawdza w tabeli uprawnień czy Klient FTP może wykonać daną operację.

Exceptions of use case Sprawdzenie uprawnień

W przypadku braku uprawnień zwracany jest komunikat o błędzie.

Use Case Tworzenie katalogu

Action steps of use case Tworzenie katalogu

Klient FTP wysyła polecenie utworzenia katalogu. Po sprawdzeniu uprawnień serwer tworzy katalog i przypisuje do niego uprawnienia z katalogu nadrzędnego.

Exceptions of use case Tworzenie katalogu

W przypadku braku uprawnień serwer zwraca komunikat o błędzie.

Use Case Usunięcie obiektu

Action steps of use case Usunięcie obiektu

Klient FTP wysyła polecenie usunięcia obiektu. Po sprawdzeniu uprawnień serwer usuwa obiekt.

Exceptions of use case Usunięcie obiektu

W przypadku braku uprawnień lub nieistniejącego pliku/katalogu serwer zwraca komunikat o błędzie.

Use Case Usuwanie użytkownika

Action steps of use case Usuwanie użytkownika

Administrator wpisuje polecenie usunięcia użytkownika. Serwer usuwa rekord z tabeli użytkowników.

Exceptions of use case Usuwanie użytkownika

W przypadku braku podanego użytkownika serwer nie wprowadza żadnych modyfikacji.

Use Case Wysłanie pliku

Action steps of use case Wysłanie pliku

Klient FTP wysyła plik do serwera. Po sprawdzeniu uprawnień serwer zapisuje plik w odpowiednim miejscu.

Exceptions of use case Wysłanie pliku

W przypadku braku uprawnień lub nieistniejącego katalogu serwer zwraca komunikat o błędzie.

Use Case Wyświetlanie uprawnień do katalogów

Action steps of use case Wyświetlanie uprawnień do katalogów

Administrator wpisuje polecenie wyświetlenia uprawnień. Serwer wyświetla rekordy z tabeli uprawnień.

Use Case Zmiana hasła użytkownika

Action steps of use case Wyświetlanie uprawnień do katalogów

Administrator wysyła polecenie zmiany hasła wybranego użytkownika. Serwer wprowadza zmiany w odpowiednim rekordzie tabeli użytkowników.

Exceptions of use case Zmiana hasła użytkownika

W przypadku braku podanego użytkownika serwer nie wprowadza żadnych modyfikacji.

Rozdział 2 Struktura danych dla systemu informatycznego

Diagram CDM

Wygenerowany model fizyczny

Rozdział 3 Diagram klas

Wygenerowane modele CDM i PDM

Diagram stanów

Rozdział 4 Powiązanie modelu fizycznego z modelem logicznym w tabeli

Procesy z DFD (przypadki użycia z USE CASE)	Stany systemu z STD	Moduły programowe
	Stan i-ty	Funkcja w programie

Rozdział 5

Wymagania sprzętowo-środowiskowe

System operacyjny Windows XP. Komputer podłączony do sieci lokalnej, o konfiguracji pozwalającej uruchomić bazę danych MySQL. Baza danych MySQL jest udostępniona na licencji GNU. Ilość miejsca na dysku 5MB do uruchomienia programu, plus dodatkowe miejsce dla użytkowników serwera.

Słownik terminów informatycznych:

Serwer - jest to program świadczący usługi na rzecz innych programów, zazwyczaj znajdujących się na innych komputerach połączonych w sieć.

Klient FTP - (oprogramowanie kliencie) to program komputerowy, który ma za zadanie łączenie się z serwerem oraz umożliwia przesyłanie plików. Istnieje wiele klientów ftp, wykorzystujących ten sam protokół.

Plik (ang. file) - jest to zbiór danych o skończonej długości. Danymi tymi mogą być dokumenty, obrazy, muzyka itp.

System plików - metoda przechowywania plików, zarządzania plikami, informacjami o tych plikach, tak by dostęp do plików i danych w nich zgromadzonych był łatwy dla użytkownika systemu.

Katalogi (stosuje się też nazwy foldery lub kartoteki) - (ang. directory) są to struktury umożliwiające grupowanie plików. Można się po nich poruszać w celu odnalezienia określonego pliku. Katalogi oprócz plików mogą zawierać także inne katalogi.

Logowanie - jest to operacja polegająca na podaniu nazwy użytkownika oraz hasła w celu zweryfikowania uprawnień do korzystania z zasobów serwera FTP.

Obiekt - w zależności od operacji, jaką wykonujemy jest to plik lub katalog.

Słownik terminów dziedzinowych:

Użytkownik - osoba, która korzysta z zasobów serwera FTP. Aby połączyć się z serwerem musi użyć programu służącego do tego. Programem tym jest klient FTP.

11

---