Raport użytkownika umożliwia tworzenie własnych raportów z wykorzystaniem szablonów dokumentów programu MS Word.
Wykonanie raportu
Raport wykonywany jest z okna Pracownicy. Parametrami wejściowymi raportu są:
•identyfikator pracownika określany niejawnie przez wykonującego raport w oknie Raporty,
•data wykonania raportu określana przez użytkownika w oknie Raport Użytkownika,
•tytuł raportu określany przez użytkownika w oknie Raport Użytkownika.
Dodatkowo użytkownik po wybraniu przycisku Ustawienia wydruku w oknie Raport Użytkownika ma możliwość określenia:
•szablonu, z którego będzie korzystał podczas wykonania raportu (wybrany szablon jest ustalany, jako domyślny dla następnego wywołania raportu),
•miejsca zapisu utworzonych przez raport dokumentów programu MS Word. Wybranie opcji Zapis domyślny spowoduje zapisanie dokumentu pod nazwą „Tytuł raportu + nazwisko i imię pracownika” w katalogu ...Raporty\Wyniki\Tytuł raportu lub w przypadku niewypełnionego pola Tytuł Raportu pod nazwą „Raport Użytkownika + nazwisko i imię pracownika” w katalogu ...Raporty\Wyniki\Raport Użytkownika. Wybranie opcji Zapisz w nowym pliku umożliwia określenia nazwy i miejsca gdzie dokument ma zostać zapisany.
Tworzenie szablonu dla potrzeb raportu
Po zainstalowaniu programu w katalogu ...Raporty\Template\Raport Użytkownika znajduje się szablon dokumentu programu MS Word o nazwie Główny.dot. Jest to przykładowy szablon, z którego korzysta raport Raport Użytkownika. Użytkownik może utworzyć nowy szablon kopiując istniejący szablon Główny.dot lub tworząc nowy szablon dokumentu programu MS Word i umieszczając go w katalogu ...Raporty\Template\Raport Użytkownika. Raport komunikuje się z szablonem za pomocą odpowiednio sformatowanych ciągów znaków zwanych znacznikami. Wyróżniamy dwa rodzaje znaczników rozpoznawane przez raport:
•znaczniki kadrowe, interpretowane przez raport, jako nazwy elementów kadrowych - to pojedynczo przekreślone ciągi znaków zakończone znakiem „|” lub w przypadku elementów kadrowych zgrupowanych znakiem „|” oddzielona jest nazwa elementu od nazwy atrybutu.
•znaczniki procedur, interpretowane przez raport, jako nazwy procedur utworzonych przez użytkownika – to podwójnie przekreślone ciągi znaków.
Jako znacznik rozpoznawany jest każdy nieprzerwany ciąg znaków spełniający kryterium przekreślenia. Może to powodować powstawanie błędnych szablonów, w których jako znaczniki lub dalszy ciąg znaczników rozpoznawane są puste znaki (spacje, tabulatory) będące przekreślone. W celu uniknięcia takich błędów zalecane jest przy tworzeniu znaczników korzystanie z narzędzi i „K” i „P” dostarczonych wraz z szablonem „Główny.dot”.
Każdy szablon musi spełniać następujące wymagania raportu:
•musi być umieszczony w katalogu ...Raporty\Template\Raport Użytkownika,
•wymagane są znaczniki:
•przekreślony wyraz „koniec” i podwójnie przekreślony wyraz „koniec” kończący nagłówek szablonu,
•przekreślony wyraz „koniec” i podwójnie przekreślony wyraz „koniec” kończący główną część dokumentu szablonu,
•przekreślony wyraz „koniec” i podwójnie przekreślony wyraz „koniec” kończący stopkę szablonu.
Użycie narzędzi „K” i „P”
Aby wstawić znacznik kadrowy, należy ustawić kursor w wybranym miejscu szablonu i wybrać przycisk oznaczony literą „K”.
Po wybraniu przycisku „K” w szablonie dokumentu programu MS Word pojawia się okno dialogowe, w które należy wpisać nazwę elementu kadrowego zakończonego znakiem „|” lub nazwę elementu kadrowego z atrybutem, gdzie nazwa elementu oddzielona jest znakiem „|” od nazwy atrybutu.
Wybranie przycisku Koniec powoduje wstawienie znacznika „koniec” w miejscu kursora w szablonie dokumentu. Wybranie przycisku Wstaw powoduje wstawienie znacznika kadrowego dla wartości wprowadzonej do pola edit. Np. „Dane osobowe|imię” , „koniec”
Aby wstawić znacznik procedury, należy ustawić kursor w wybranym miejscu szablonu i wybrać przycisk oznaczony literą „P”. Po wybraniu przycisku „P” w szablonie dokumentu programu MS Word pojawia się okno dialogowe, w które należy wpisać nazwę procedury zdefiniowanej przez użytkownika. Wybranie przycisku Koniec powoduje wstawienie znacznika „koniec” w miejscu kursora w szablonie dokumentu. Wybranie przycisku Wstaw powoduje wstawienie znacznika procedur dla wartości wprowadzonej do pola edit. Np. pracownik koniec
Procedury zdefiniowane przez użytkownika znajdują się w raporcie UserProc.sci. Sposób definiowania procedur zostanie objaśniony w dalszej części opisu.
Działanie raportu
Po wybraniu przycisku Wykonaj w oknie Raport Użytkownika lub w oknie Ustawienia wydruku nastąpi utworzenie Obiektu Aplikacji Word. Następnie w aplikacji utworzony zostanie dokument programu MS Word na podstawie szablonu wybranego w oknie Ustawienia wydruku. Raport dokona sprawdzenia poprawności szablonu pod względem spełniania kryterium istnienia znaczników „koniec” w wymaganych miejscach szablonu (mechanizm opisany jest w punkcie Tworzenie szablonu dla potrzeb raportu). Jeżeli szablon jest poprawny raport dokonuje odczytania nagłówka dokumentu w celu odnalezienia znaczników kadrowych. Po napotkaniu znacznika „koniec” raport usunie znacznik „koniec” i przystąpi do poszukiwania znaczników procedur aż do napotkania znacznika „koniec”. Następnie raport dokonuje przeszukania w analogiczny sposób stopki dokumentu i głównej części dokumentu. Po odczytaniu znaczników raport przystępuje do ich interpretacji, sygnalizując użytkownikowi każdy przypadek nie rozpoznania znacznika. Następnie zastępuje w treści dokumentu znaczniki odpowiednimi wartościami i pomija przekreślenie pojedyncze lub podwójne. Znaczniki kadrowe zostają zastąpione wartościami elementów kadrowych lub odpowiednio atrybutów, które zostały odczytane dla danego pracownika w dniu wprowadzonym w polu Data wykonania. Znaczniki procedur zostają zastąpione wartościami procedur predefiniowanych lub utworzonych przez użytkownika. W przypadku nierozpoznanych znaczników zostaje pominięte przekreślenie lub podwójne przekreślenie. Po zakończeniu wykonywania raportu zapisany dokument pozostaje otwarty i gotowy do wydruku za pomocą narządzi programu MS Word.
Sposób definiowania procedur użytkownika
W raporcie Proc.sci znajdują się predefiniowane procedury wykonujące dla pracowników zamiany następujących znaczników procedur:
•Pan na wartości w zależności od płci Pan lub Pani,
•pracownik na wartość w zależności od płci pracownik pracownica,
•TytułRaportu na wartość wprowadzoną w polu Tytuł raportu,
•DataRaportu na wartość wprowadzoną w polu Data wykonania.
W raporcie UserProc.sci znajdują się przykładowe procedury INNY, inny, Inny, które jako wartość zwracają daną typu string o wartości “Inna osoba”. Raport UserProc jest miejscem gdzie użytkownik może dopisywać swoje procedury, które będą w odpowiedni sposób interpretowane podczas wykonania raportu.
Zasady tworzenia procedur:
•Procedura rozpoczyna się instrukcją case, po której następuje nazwa procedury w cudzysłowie. W pliku UserProc.sci mogą się znajdować wyłącznie procedury po instrukcji case. Jako zakończenie procedury interpretowany jest koniec raportu lub następna instrukcja case,
•Zwrócenie wartości procedury następuje przez przypisanie wartości typu string do zmiennej WartosciProcedury.
•W ciele procedury tzn. od instrukcji case do następnej instrukcji case lub do końca raportu można wywoływać dowolne funkcje języka raportów a także dołączać pliki pomocnicze z rozszerzeniem .sci procedurą #include. W ciele procedury dostępne są zmienne z raportu:
•Rekord z informacjami o danym pracowniku typu InfoPrac o nazwie CurPrac,
•Identyfikator danego pracownika typu long o nazwie idprac,
•Data wykonania raportu typu string o nazwie dataOd.