Dokumentacja. Modułu Agenta Systemu Printoscope Cost Control

Transkrypt

1 Dokumentacja Modułu Agenta Systemu Printoscope Cost Control ver 1.1 Zielona Góra, wrzesień /19

2 Metryka dokumentu - Historia zmian Data Wersja Opis zmiany Autor Agnieszka Baranowska Mariusz Zawadzki Drobne zmiany w punkcie 4 (krok 7). Wstawiony nowy pkt 3.11 Komunikacja TCP/IP. Dodano opis do opcji IP suffix w pkt Marcin Sasin Mariusz Zawadzki 2/19

3 Spis treści 1 Wstęp Architektura systemu Printoscope Cost Control Moduł agenta Instalowanie agenta Sprawdzanie stanu aktywności agenta Ustawienia drukarek Elementy składowe agenta Sposób działania agenta Plik APSys.ini - konfiguracja agenta Zmiana konfiguracji agenta Generowanie nowego instalatora agenta Automatyczny update Agenta Logi agenta Komunikacja TCP/IP Formaty wydruków Odinstalowanie agenta Moduł agenta w systemie Windows NT /19

4 1 Wstęp Niniejszy dokument zawiera opis modułu agenta systemu Printoscope Cost Control, pracujących pod kontrolą systemów operacyjnych Windows firmy Microsoft. Dokumentacja nie opisuje szczegółów instalacji i obsługi agentów dla systemów Novell NetWare. 2 Architektura systemu Printoscope Cost Control System Printoscope Cost Controle (PCC) składa się z następujących elementów: program agenta umieszczony na stacjach roboczych i serwerach wydruków; serwer zbierający dane od agentów; moduł administratora; moduł raportów. Współpraca agenta z serwerem PCC przebiega następująco: Użytkownik wykonując wydruk na stacji roboczej uruchamia procedury systemowe, które informują program agenta o rozpoczęciu drukowania. Agent zbiera wszystkie dostępne dane z systemu Windows oraz Novell NetWare dotyczące wydruku oraz analizuje plik wydruku pozyskując informacje o nazwie użytkownika, nazwie serwera wydruku, sterownika, ilości stron, formacie wydruku, ilości zastosowanych kolorów, użycia trybu duplex, zastosowanym podajniku i rozdzielczości wydruku. W przypadku braku określonych parametrów przyjmuje wartości domyślne. W przypadku braku komunikacji dane są przechowywane stale w buforze lokalnym i agent, co określony czas próbuje je wysłać. Po wysłaniu danych, dane są kasowane z bufora. 4/19

5 Rysunek 1 Sposób działania Printoscope Cost Control 3 Moduł agenta Jak już wcześniej zostało powiedziane zadaniem modułu agenta jest zbieranie informacji o wykonywanych wydrukach i przesyłanie ich do serwera Printoscope. W przypadku systemu Windows, agent instalowany jest na każdej stacji, która ma zostać poddana monitorowaniu wykonywanych wydruków. W przypadku systemu Novell, agent instalowany jest na serwerze i monitoruje wszystkie kolejki będące obiektami bazy NDS Instalowanie agenta W końcowej fazie instalacji Serwera systemu Printoscope generowany i konfigurowany jest program instalacyjny agenta: agent_setup_host.exe, gdzie host jest adresem IP komputera, na którym wykonano instalację. Program instalacyjny należy po zakończeniu instalacji serwera pobrać z katalogu, do którego został wygenerowany (typowo: Program Files\Printoscope Cost Control\). Jest on przygotowany do pracy z serwerem umieszczonym na komputerze, na którym przeprowadzono instalację modułu Serwer. W celu zainstalowania agenta należy na stacji roboczej (może nią być też serwer wydruków) uruchomić plik instalacyjny agenta (w sposób lokalny lub zdalny). Proces instalacji agenta przebiega automatycznie, w tzw. trybie cichym. Użytkownik musi tylko uruchomić program instalacyjny agenta na swoim komputerze. Agent jest instalowany w katalogu %windir%\system32\apsys (gdzie %windir% oznacza katalog główny systemu Windows). 5/19

6 UWAGA: do zainstalowania agenta na stacjach roboczych działających pod systemem operacyjnym Windows NT, 2000, XP, 2003 potrzebne są uprawnienia administratora stacji roboczej. UWAGA: jeżeli komputer pełni rolę serwera wydruków (print server), należy na nim także zainstalować program agenta, w przeciwnym wypadku wydruki kierowane na serwer wydruków nie będą zliczane pomimo instalacji agentów na stacjach roboczych użytkowników. Program agenta pracuje pod następującymi systemami operacyjnymi (warunkiem koniecznym jest obsługa stosu TCP/IP): MS Windows NT 4 SP6; MS Windows 2000 SP4; MS Windows 2003; MS Windows XP SP1; MS Windows XP SP2; MS Windows 95 (z IE 5.5 lub wyższym o ile kompatybilny); MS Windows 98 (z IE 5.5 lub wyższym o ile kompatybilny); MS Windows 98 SE (z IE 5.5 lub wyższym o ile kompatybilny); MS Windows Me (z IE 5.5 lub wyższym o ile kompatybilny). Instalacja zdalna Istnieje możliwość zainstalowania agentów zdalnie (np. z poziomu administratora domeny) wykorzystując m. in. narzędzie zdalnej linii komend xcmd lub innych pozwalających na zdalnie wykonywanie zadań np. MS SMS). Przykład instalacji zdalnej z użyciem xcmd: xcmd \\computername /USER:username /PWD:* /C agent_setup_ip_address.exe gdzie użytkownik username jest administratorem komputera computername. Zaraz po wywołaniu polecenia zostaniemy poproszeni o podanie hasła użytkownika username. 3.2 Sprawdzanie stanu aktywności agenta Zainstalowany na stacji roboczej agent uruchamiany jest automatycznie wraz z uruchomieniem 6/19

7 stacji roboczej. Jednym ze sposobów sprawdzenia czy agent został poprawnie zainstalowany oraz jego stanu, jest sprawdzenie na lokalnym komputerze czy uruchomiona jest usługa APServ (Start -> Ustawienia -> Panel sterowania -> Narzędzia administracyjne -> Usługi), co pokazuje rys. 2. Rysunek 2 Weryfikacja pracy agenta z poziomu usług systemu Windows Możliwe jest również sprawdzenie stanu aktywności agenta z poziomu modułu administratora systemu PCC. Moduł ten nazywa sie: Printoscope Management Console (zakładka Administracja, podzakładka Agenci, patrz rysunek 2). Rysunek 3 Monitorowanie pracy agentów z poziomu PMC 7/19

8 UWAGA Aby dane gromadzone przez Printoscope Cost Control były wiarygodne, nie jest zalecane wyłączanie agenta. 3.3 Ustawienia drukarek Dla poprawności analizy wydruków przez moduł agenta należy odpowiednio skonfigurować właściwości drukarki zainstalowanej na danej stacji roboczej. W tym celu należy wybrać: Start->Ustawienia->Drukarki i faksy -> nazwa drukarki -> prawy klawisz myszy i wybrać Właściwości -> zakładka Zaawansowane - włączyć opcję: Buforuj dokumenty tak, aby program szybciej skończył drukowanie - wyłączyć opcję: Włącz zaawansowane funkcje drukowania Przykładowa konfiguracja drukarki widoczna jest na rysunku 4. 8/19

9 Rysunek 4 Konfiguracja drukarki Dodatkowo Printoscope wymaga, aby w katalogu bufora wydruku nazwy plików.spl posiadały format: jobid.spl, np spl. Jeśli nazwy plików.spl rozpoczynają się od przedrostka fp, to należy wykonać pewne czynności, aby doprowadzić do wymaganego formatu. Taka sytuacja może wystąpić w systemach Windows XP i Windows Server W przypadku systemu Windows XP należy w kluczu: HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Print\Printers odnaleźć DefaultSpoolDirectory i jego wartość przypisać do SpoolDirectory w kluczach HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Print\Printers\printerName gdzie printername jest nazwą drukarki zainstalowanej w systemie. W przypadku systemu Windows Server 2003 należy w kluczu: 9/19

10 HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Print odnaleźć (jeśli nie istnieje, to stworzyć) DisableServerFilePooling (typu DWORD) i przypisać jemu wartość 1. Zmiany można wykonać ręcznie za pomocą regedit.exe lub można wykorzystać specjalnie przygotowany w tym celu program - SpoolConfig.exe, który jest częścią Printoscope. 3.4 Elementy składowe agenta Agent PCC pracujący w systemie Windows składa się z następujących plików: apsys.exe moduł agenta monitorujący wydruki (obowiązkowy) apsys.ini plik konfiguracyjny agenta (obowiązkowy) apserv.exe moduł, dzięki któremu agent działa jako usługa (obowiązkowy) atool.exe moduł odpowiedzialny za deinstalację i update agenta (obowiązkowy) op.exe moduł do obsługi projektów (opcjonalny) aw.exe moduł nasłuchujący zdarzenie anulowania wydruków NetWare (opcjonalny) netuse.exe moduł wykrywający mapowanie kolejek NetWare na port LPT (opcjonalny) table_tsp01.dll, table_trdir.dll, saprfc.ini moduły konieczne do monitorowania wydruków z SAPa (opcjonalny) start_log_n.txt startowy log agenta agent_log.txt szczegółowy log agenta 3.5 Sposób działania agenta W chwili powstania wydruku w spoolerze systemu Windows (zlokalizowanego w: %windir%\system32\spool\printers), agent wstrzymuje pracę w kolejce drukarki, pobiera informacje o wydruku z systemu, dokonuje analizy pliku w spoolerze odpowiadającego wydrukowi, po czym wznawia pracę w kolejce drukarki. Dane o zmonitorowanych wydrukach agent Windows przesyła do serwera Printoscope (w postaci zaszyfrowanej). 10/19

11 Komunikacja z serwerem Printoscope odbywa się poprzez sockety TCP/IP. Port jak i adres IP serwera PCC konfiguruje się w pliku konfiguracyjnym agenta (domyślnie jest to port 4443). Agent Windows buforuje dane o monitorowanych wydrukach, co gwarantuje pracę offline. Dane są buforowane w katalogu %windir%\system32\spool\printers\cache. Dla każdego wydruku powstaje osobny plik (z rozszerzeniem.agn). Rozmiar pliku jest stały i wynosi 620 bajtów. Zawartość pliku jest zaszyfrowana. Plik jest usuwany w chwili przesłania przez serwer Printoscope odpowiedniego rozkazu. 3.6 Plik APSys.ini - konfiguracja agenta Konfiguracja agenta jest realizowana poprzez dokonanie odpowiednich wpisów w pliku APSys.ini (znajdującego się w katalogu,w którym agent został zainstalowany, czyli %windir%system32\apsys). Poniżej opis najważniejszych parametrów konfiguracyjnych. #Adres IP lub nazwa komputera z serwerem Printoscope Host = " " #Numer portu wykorzystywany w połączeniu z serwerem Printoscope DB Port = 4443 #Czas kolejnej próby podłączenia się do serwera Printoscope (w sekundach) Reconnect time = 31 #Czas przeglądania katalogu Cache i ponownego wysyłania jobów (w sekundach) Resend time = 60 #Tworzy szczegółowy log apsys_log.txt Save log = 0 #Określa katalog spoolera, jeśli jest inny niż domyślny %windir%\system32\spool\printers Spool dir = "d:\spool" #1 - Jako właściciela wydruku ustawia nazwe komputera #0 Jako właściciela wydruku ustawia login użytkownika No user name = 0 #Jako właściciela wydruku ustawia użytkownika, którego zwróci funkcja GetUserName Job login name = 0 #1 - Kopiuje do katalogu Cache\Subcache źle zliczone wydruki Save printout = 0 #Maksymalny rozmiar plików (wydruków źle policzonych przez agenta), które #agent zachowuje w specjalnym katalogu Subcache; parametr może przyjmować #wartości od 100 do 1000 MB; domyślna wartość to 100 MB 11/19

12 Max save size = 100 #Fraza doklejana po dwukropku do nazwy agenta Department = "MaxElektronik" #Wyklucza spod monitorowania wybrane drukarki; każde wykluczenie należy umieścić w osobnym wierszu Exc printer = "HP LaserJet 5Si PCL 5e" #Wyklucza spod monitorowania wybrane porty; każde wykluczenie należy umieścić w osobnym wierszu Exc port = "LPT1:" #Zapisuje każdego joba do pliku tekstowego Save job = 0 #Reguluje miejsce, w którym powstanie katalog Cache (0 - %windir%\system32\spool\printers; 1 - %windir%\system32\apsys) No hide cache = 0 #domyślna wartość 0; #jeśli 1 - do nazwy agenta doklejany jest adres IP IP suffix = 1 # PROJEKTY #Adres IP komputera z serwerem projektów OP Host = #Numer portu wykorzystywany w połączeniu z serwerem projektów OP DB Port = 4442 #Czas kolejnej próby podłączenia się do serwera projektów (w sekundach) OP Reconnect time = 20 #Tworzy szczegółowy log op_log.txt OP Save log = 0 #Wersja językowa (EN, PL, DE) OP Lang = EN 3.7 Zmiana konfiguracji agenta W przypadku konieczności wykonania zmian w konfiguracji zainstalowanego agenta, należy przejść do katalogu, w którym został zainstalowany agent. Agent jest zawsze instalowany do katalogu system32\apsys katalogu, w którym zainstalowany został system Windows. Plik konfiguracyjny agenta to APSys.ini. Należy go poddać edycji i wprowadzić wymagane zmiany. Po zapisaniu zmian w pliku konfiguracyjnym agenta, należy wykonać restart agenta, z poziomu menadżera usług (Start -> Ustawienia -> Panel sterowania -> Narzędzia administracyjne -> Usługi), bądź z linii komend za pomocą następujących poleceń: 12/19

13 Apserv /stop a następnie: Apserv /start będąc w katalogu domowym agenta %windir%\system32\apsys, bądź z dowolnego miejsca, w przypadku gdy ścieżka ta dodana jest do zmiennej systemowej PATH. 3.8 Generowanie nowego instalatora agenta Wygenerowanie nowego instalatora agenta jest przydatne, kiedy wymagana jest zmiana domyślnej konfiguracji agenta w nim umieszczonego. Aby wygenerować nowy instalator agenta, należy przejść do katalogu, w którym został zainstalowany serwer Printoscope. Plik zawierający domyślną konfigurację dla tworzonego agenta to setupbuilder.ini. Należy go poddać edycji i wprowadzić wymagane zmiany. Jeżeli zostanie zmieniona wartość parametru Host na adres IP różny od adresu IP komputera, na którym przeprowadzane są zmiany, konieczne jest również zmodyfikowanie pliku agent.bat: należy zaremować w nim polecenie MyHost.exe. Instalator agenta może być uruchomiony w jednym z dwóch trybów: silent lub verysilent. W przypadku ustawienia trybu silent, po uruchomieniu instalatora agenta zostanie wyświetlone okno instalatora, w przypadku ustawienia trybu verysilent uruchomiony instalator agenta będzie działał w tle i nie zostanie wyświetlone żadne okno obrazujące pracę instalatora. Tryby te można ustawić edytując linię: setupbuilder.exe /verysilent pliku agent.bat: po nazwie programu setupbuilder.exe należy po ukośniku napisać pożądany tryb pracy mającego powstać instalatora agenta. Wprowadzone w plikach zmiany należy zapisać. Aby utworzyć nowy plik instalacyjny agenta, należy z katalogu, w którym został zainstalowany serwer Printoscope uruchomić plik agent.bat. Spowoduje to powstanie nowego pliku instalacyjnego agenta. Agent zainstalowany za pomocą tego pliku, będzie posiadał plik konfiguracyjny (APSys.ini) równoważny zmodyfikowanemu plikowi setupbuilder.ini. 13/19

14 3.9 Automatyczny update Agenta W przypadku konieczności podniesienia wersji agenta na stacjach roboczych, możliwe jest wykonanie tego w sposób automatyczny. Realizujemy to w następujący sposób: na serwerze PCC zainstalować należy nową wersję agenta (po otrzymaniu jej od producenta), podłączeni agenci otrzymują informacje o zmianie aktualnej wersji i dodawani są do listy agentów wymagających zmiany wersji update agentów odbywa sią automatycznie w kolejności wg listy zgłoszeń. UWAGA Procedura automatycznego update'u odbywa się poprzez TCP/IP port Logi agenta Log agenta zapisywany jest w podkatalogu system32\apsys katalogu, w którym zainstalowany został system Windows. Nazwa pliku logu agenta to start_log_xx.txt, gdzie xx jest kolejnym numerem poczynając od numeru 00. W pliku tym zapisywane są wybrane informacje o przebiegu startu agenta. Jeżeli w pliku Apsys.ini opcja Save log będzia miała wartość 1, powstanie również plik apsys_log.txt, w którym zawarte będą informacje o przechwyconych wydrukach, statusie połączenia z bazą danych, wynikach komunikacji z bazą danych oraz o przebiegu pracy agenta Komunikacja TCP/IP Komunikacja pomiędzy modułem agenta a serwerem PCC odbywa się z wykorzystaniem protokołu TCP/IP. Poniżej przedstawiano parametry komunikacji TCP/IP po stronie serwera PCC: Port Opis usługi Plik konfig nasłuch na połączenia modułu Agenta Apsys.ini 5553 automatyczny update modułu Agenta Apsys.ini 4442 obsługa projektów (usługa PCCPRJ) Apsys.ini Podane numery portów są ustawieniami domyślnymi systemu. Istnieje możliwość ich zmiany w 14/19

15 plikach konfiguracyjnych agenta Apsys.ini (patrz pkt. 3.6). W celu zapewnienia poprawnej pracy modułu Agenta z serwerem PCC komunikacja TCP/IP na wskazanych portach musi być udostępniona (szczególnie ważne w przypadku stosowania zapory systemowej w Windows XP lub istnienia list dostępowych pomiędzy sieciami IP) 3.12 Formaty wydruków Poniżej przedstawiono formaty wydruków w trybie RAW obsługiwane przez agenta systemu PCC : PCL 3 PCL 4 PCL 5 PCL 5C PCL 5E PCL 6 (XL) Postscript IBM Proprinter OKI Microline Epson ESC2 Canon BubbleJet Canon ir Series ZIMF ZJSTREAM GDIJ Canon IUTu Panasonic format tekstowy Wydruki realizowane przy użyciu innych formatów mogą być niepoprawnie interpretowane lub ignorowane. 15/19

16 3.13 Odinstalowanie agenta Aby odinstalować agenta na wybranej stacji roboczej, należy przejść do katalogu, w którym został zainstalowany agent agent jest zawsze instalowany do katalogu system32\apsys katalogu, w którym zainstalowany został system Windows. Następnie należy wykonać polecenie ATool /deinstall, co spowoduje rozpoczęcie procesu deinstalacji agenta. Po deinstalacji agenta z katalogu system32\apsys powinny zostać usunięte pliki: o o o o APSys.ini APSys.exe APServ.exe ATool.exe a z menadżera usług powinna zostać usunięta usługa APServ. Deinstalacja zdalna agenta: xcmd \\computername /USER:username /PWD:* /D:%windir%\system32\apsys "ATool /deinstall" gdzie użytkownik username jest administratorem komputera computername. Zaraz po wywołaniu polecenia zostaniemy poproszeni o podanie hasła użytkownika username. 4 Moduł agenta w systemie Windows NT Do monitorowania wydruków w systemie Windows NT wymagana jest instalacja PortMonitora oraz dedykowanego agenta. Poniżej przedstawiona jest opis instalacji i konfiguracji PortMonitora i agenta dla systemu Windows NT. 1. PortMonitor wraz z dedykowaną wersją Agenta pozwala monitorować wydruki w systemie Windows NT. 2. PortMonitor jest przykładem jednego z podstawowych elementów w procesie drukowania, który jest odpowiedzialny za kanał komunikacji pomiędzy katalogiem bufora wydruku a drukarką. 3. Wykonanie wydruku na drukarce z portem typu PortMonitor spowoduje, że na dysku powstaną dwa pliki: - dfajobidjobtime.agn - tzw. plik danych (zawiera zrenderowany wydruk) - cfajobidjobtime.agn - tzw. plik konfiguracyjny 16/19

17 4. Plik konfiguracyjny zawiera następujące informacje: user_name = "właściciel wydruku" doc_name = "nazwa wydruku" pc_name = "serwer wydruku" drv_name="sterownik drukarki" prn_name="drukarka" Przykład: user_name = "Administrator" doc_name = "Test Page" pc_name = "\\PCCLAB01" drv_name = "HP LaserJet 5Si PCL 5e" prn_name = "HP LaserJet 5Si PCL 5e" 5. Aby zainstalować PortMonitor'a, należy użyć programu ManageMonitor.exe, któremu w linii poleceń należy podać pięć parametrów: 6. PortMonitor jest biblioteką dynamiczną o nazwie PortMonitor.dll. -i biblioteka_port_monitora nazwa_port_monitora opis_portu katalog_w_którym_będą_powstawać_pliki_danych_i_konfiguracyjne Katalog podany w ostatnim parametrze powinien istnieć przed uruchomieniem polecenia. Przykład: ManageMonitor.exe -i PortMonitor.dll PCCMonitor PCCPort c:\wydruki 7. Po instalacji PortMonitor'a należy wykonać restart bufora wydruku. Można tego dokonać z poziomu Menadżera Usług lub z linii komend. Przykład z linii komend: net stop spooler net start spooler 8. W wyniku instalacji PortMonitor'a w rejestrze powstanie nowy klucz HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Print\Monitors\nazwa_port_mo 17/19

18 nitora z wartościami: Driver = "biblioteka_port_monitora" Cache = "katalog_w_którym_będą_powstawać_pliki_danych_i_konfiguracyjne" Description = "opis_portu" Przykład: klucz: HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Print\Monitors\PCCMonitor wartości: Driver = "PortMonitor.dll" Cache = "c:\wydruki" Description = "PCCPort" 9. Aby odinstalować PortMonitor'a, należy użyć programu ManageMonitor.exe, któremu w linii poleceń należy podać trzy parametry: -d biblioteka_port_monitora nazwa_port_monitora Przykład: ManageMonitor.exe -d PortMonitor.dll PCCMonitor 10. PortMonitor wymaga instalacji dedykowanego Agenta. 11. Instalacja dedykowanego Agenta jest identyczna jak instalacja zwykłego Agenta. Uwaga! Na jednej stacji nie mogą działać obaj Agenci. 12. Dedykowany Agent wymaga wskazania w parametrze PSP Folder w pliku konfiguracyjnym APSys.ini katalogu podanego podczas instalacji PortMonitor'a w ostatnim parametrze. Przykład: PSP Folder = "c:\wydruki" 13. W parametrze Print mode w pliku konfiguracyjnym APSys.ini należy określić sposób, w jaki dedykowany Agent będzie wysyłał wydruki do fizycznych drukarek (z właściwym portem). Jeśli dedykowany Agent będzie używał programu print_new.exe, to parametr Print mode powinien 18/19

19 mieć wartość 0 (plik print_new.exe powstaje po uruchomieniu pliku Print_Patch.exe; plik print_new.exe powinien zostać skopiowany do katalogu podanego w parametrze PSP Folder). Jeśli dedykowany Agent będzie używał pewne funkcje API (sposób preferowany), to parametr Print mode powinien mieć wartość Działanie PortMonitora i dedykowanego Agenta wymaga rekonfiguracji drukarek. Istniejąca drukarka powinna zostać zmodyfikowana przez dodanie do nazwy drukarki na końcu znaku apostrofu (') - podobnie z nazwą udostępioną drukarki. Jednocześnie powinna zostać stworzona nowa drukarka o nazwie identycznie z nazwą istniejącej drukarki sprzed modyfikacji - podobnie z nazwą udostepnianą drukarki - oraz o tym samym sterowniku co istniejąca drukarka. Obie drukarki odróżnia, oprócz drobnych różnic w nazwach, typ portu - nowa drukarka posiada port typu PortMonitor. 15. Jeśli parametr Print mode posiada wartość 1, to tylko drukarki z portem typu PortMonitor powinny być udostępnione. 16. Pliki ManageMonitor.exe, PortMonitor.dll, Print_Patch.exe oraz program instalacyjny dedykowanego Agenta znajdują się w podkatalogu PortMonitor w katalogu instalacyjnym Printoscope. 19/19