System magazynowy małego sklepu.

Transkrypt

1 System magazynowy małego sklepu. dokumentacja użytkownika. Mariusz Grabowski Jabber ID:

2 Spis treści 1 Wstęp. 2 2 Przed uruchomieniem. 3 3 Korzystanie z programu Okno logowania Zakładka Sprzedaż Zakładka Przyjęcie towaru Zakładka Magazyn Zakładka Statystyki Diagram ERD. 10 1

3 1 Wstęp. Niniejszy dokument stanowi w głównej mierze dokumentację użytkownika, opisuje on jak powinno się korzystać z programu. Dokumentację programistów stanowią komentarze w plikach: skryptsql/script.sql (pełny opis struktury bazy danych wliczając poszczególne pola jak i opis wyzwalaczy) oraz src/grabowskimariuszdbp02/mainwindow.java (opis poszczególnych funkcji stanowiących podstawę działania programu wraz z wyszczególnieniem listy TO- DO oraz sugerowanych popraw kodu). 2

4 2 Przed uruchomieniem. System magazynowy może zostać uruchomiony na dowolnym serwerze zawierającym bazę PostgreSQL przy użyciu pliku script.sql można stworzyć strukturę całej bazy. Zalecanym rozwiązaniem jest jednak połączenie się z bazą danych mariosh na fatcat.ftj.agh.edu.pl jest ona bowiem wypełniona przykładowymi danymi, na których dokonywać można testów działania systemu. W przypadku drugiego rozwiązania jesteśmy jednak zmuszeni do utworzenia tunelu do serwera fatcat.ftj.agh.edu.pl w przypadku gdy uruchamiamy program znajdując się w innej sieci niż wspomniany serwer. Poniżej przedstawiony jest jeden ze sposobów utworzenia tunelu, dotyczy on jednego z najbardziej rozpowszechnionych windowsowych klientów ssh PuTTY. Utworzenie tunelu odbywa się w sekcji Tunels, należy tam wpisać nazwę portu źródłowego oraz docelowego serwera i portu tak jak pokazano to na poniższym rysunku: Rysunek 1: Konfigurowanie tunelu w PuTTY. Po takim wpisaniu danych należy dodać tunel używając do tego celu przycisku Add. 3

5 Ostatnim krokiem jest zalogowanie na serwer fatcat, należy jednak pamiętać, że jeżeli mieliśmy zapisaną sesję dwukrotne kliknięcie na nazwie sesji spowoduje usunięcie zapisanego tunelu. Należy więc wpisać nazwę serwera lub przed stworzeniem tunelu skorzystać z opcji Load zapisanej sesji. Szczegółowy opis tworzenia tunelów znaleźć można pod adresem: 3 Korzystanie z programu. Program może zostać uruchomiony zarówno w środowisku Windows jak i Linux. Pliki uruchamiające program znajdują się w podkatalogu bin w przypadku pierwszego środowiska należy użyć pliku Run win do uruchomienia w środowiska Linux owych należy użyć pliku linux run. 3.1 Okno logowania. Po uruchomieniu programu konieczne jest zalogowanie się do bazy danych. Domyślne ustawienia umożliwiają połączenie się do bazy danych mariosh na serwerze fatcat.ftj.agh.edu.pl. Stworzenie okna głównego aplikacji poprzedzone Rysunek 2: Okno dialogowe logowania do bazy danych. 4

6 jest sprawdzeniem czy dostępny jest sterownik jdbc, jest to plik pg74jdbc3.jar z podkatalogu lib. W chwili nie odnalezienia sterownika użytkownik informowany jest o tym fakcie. Podobnie po nieudanej próbie zalogowania się do bazy danych użytkownik informowany jest o konieczności sprawdzenia adresu serwera i innych danych. 3.2 Zakładka Sprzedaż. Zakładka ta umożliwia obsługę trybu sprzedaży w celu rozpoczęcia wprowadzania danych do pierwszego paragonu po uruchomieniu programu, a także rozpoczęcia kolejnego paragonu konieczne jest użycie przycisku Nowy dokument. Powoduje on wstawienie domyślnych informacji do tabeli DOWODY SPRZE- DAZY. Rysunek 3: Pierwsza zakładka programu. Kliknięcie wywołuję również operację przekształcenia tabeli w ten sposób aby został w niej jeden wiersz bez zbędnych danych z poprzedniego paragonu (w przypadku pierwszego paragonu po uruchomieniu programu tabela jest aktywowana). Wspomniana tabela odpowiada wierszom tabeli SZCZEGOLY SPRZE- DAZY wobec czego konieczne jest wypełnienie pól nazwa produktu (powodującego zapisanie odpowiedniego ID produktu), ilość, oraz rabat, pozostałe pola wypełniane są automatycznie. 5

7 Wybór produktu dokonany może być za pomocą kodu kreskowego lub nazwy produktu. W pierwszym przypadku możliwe jest zarówno wybranie z listy jak i wpisanie kodu kreskowego (umożliwia to obsługę czytników kodów kreskowych, podłączony do portu ps2 czytnik działa jak zwykła klawiatura). Drugi sposób pozwala jedynie na dokonanie wyboru z listy rozwijanej. Po zakończeniu wprowadzania danych odnośnie sprzedania danego artykułu należy kliknąć przycisk Potwierdź zakup, który powoduje wstawienie do tabeli SZCZEGO- LY SPRZEDAZY. Pole Suma stanowi podsumowanie wszystkich komórek kolumny razem. Natomiast data w prawym górnym rogu obrazuje datę wstawioną do tabeli DOWODY SPRZEDAZY czyli obecną datę. Ograniczenia związane z obsługą błędów zawarte są w dokumentacji programu. W chwili obecnej program sprawdza czy wypełnione są odpowiednie komórki wymagane do wstawienia do tabeli bazy danych. Dodatkowo za pomocą wyrażeń regularnych sprawdzany jest format pól ilość oraz rabat. Pełna obsługa sytuacji wyjątkowych wymaga jednak dłuższego testowania programu. 3.3 Zakładka Przyjęcie towaru. Druga zakładka obsługuje największą ilość tabel bazy danych. Rysunek 4: Druga zakładka programu. 6

8 Umożliwia ona dodawanie nowych produktów, aktualizowanie informacji o produktach, dodawanie nowych kategorii oraz dystrybutorów, dodawanie nowych kodów kreskowych dla wybranych produktów, a także przyjęcie towaru odpowiadające wstawieniu do tabeli PARTIE TOWAROW. W celu przyjęcia nowego towaru należy zaznaczyć znajdujący się w lewym górnym rogu checkbox - Nowy produkt. Uaktywniają się wówczas: możliwość edycji listy rozwijanej Nazwa produktu (gdzie należy wpisać nazwę nowego produktu) oraz przycisk Dodaj nowy produkt. Po wpisaniu nazwy produktu należy wypełnić odpowiednimi informacjami dział Szczegółowe informacje o produkcie. W przypadku gdy na liście kategorii czy też dystrybutorów nie ma wymaganej przez nas pozycji należy kliknąć przycisk znajdujący się po prawej stronie danej listy. Spowoduje to pojawienie się okna dialogowego, w którym wpisujemy nazwę kategorii lub dystrybutora. Po wpisaniu wszystkich danych klikamy przycisk Dodaj nowy produkt. Dodanie kodu kreskowego danego produktu odbywa się następująco: Wybieramy z listy rozwijanej produkt, dla którego chcemy dodać kod kreskowy. W polu Kod kreskowy wpisujemy odpowiedni kod. Zatwierdzamy informacje przyciskiem Dodaj kod kreskowy. W celu uaktualnienia danych o produkcie dokonujemy wymaganych zmian oraz zatwierdzamy je przyciskiem Uaktualnij Produkt. Pobierane są wówczas wszystkie dane z działu Szczegółowe informacje o produkcie. Po wybraniu odpowiedniego produktu należy wpisać dane dotyczące danej partii towaru (sekcja Szczegóły dotyczące zamówienia ) a następnie przy użyciu przycisku Zatwierdź informacje potwierdzić przyjęcie towaru. Pola numeryczne oraz data sprawdzane są przy użyciu wyrażeń regularnych czy są odpowiedniego formatu. 3.4 Zakładka Magazyn. Trzecia zakładka umożliwia przeglądanie wszystkich produktów oraz generowanie listy zakupów. Możliwe jest sortowanie produktów względem kategorii i dystrybutorów. Do tego celu należy użyć list rozwijanych zawierających spis wszystkich kategorii, dystrybutorów uzupełnionych o pola Wszystkie oraz Wszyscy. Dodatkową opcją jest możliwość generowania listy zakupów po zaznaczeniu cechckboxa - generuj listę zakupów. Porównywana jest wówczas ilość artykułów danego produktu z ilością minimalną ustawioną przez użytkownika bazy danych. W celu wygenerowania odpowiedniej listy należy użyć przycisku Pokaż produkty, który przygotowuje tabelę w analogiczny sposób jak przycisk Nowy dokument z pierwszej zakładki programu i oczywiście wypełnia wiersze tabeli odpowiednimi danymi. Jeśli nie zostaną znalezione produkty użytkownik informowany jest o tym przez odpowiednie okno informacyjne. Najczęściej zdarza się to gdy wybierzemy pewnego dystrybutora, który nie dostarcza 7

9 artykułów w wybranej kategorii. Rysunek 5: Trzecia zakładka programu. 8

10 3.5 Zakładka Statystyki. Ostatnia zakładka umożliwia uzyskanie informacji na temat kosztów, obrotu i zarobków na poszczególnych artykułach w dowolnym zakresie czasowym. Produtkty sortowane są począwszy od najbardziej dochodowego artykułu do najmniej. W zależności od wpisanych przez użytkownika danych w pola od i do dokonywane jest zapytanie do bazy danych. Sprawdzany jest format daty, który odpowiadać musi SQL owemu typowi Date (YYYY-MM-DD). Dzięki wyrażeniom regularnym sprawdzane są wartości tych pól. Jeżeli nie zostaną wpisane daty lub pola zostaną błędnie wypełnione generowane są statystyki na przełomie całego użytkowania sklepu. Rysunek 6: Czwarta zakładka programu. 9

11 4 Diagram ERD. 10