16) Wprowadzenie do raportowania Rave Tematyka rozdziału: Przegląd wszystkich komponentów Rave Tworzenie nowego raportu przy użyciu formatki w środowisku Delphi Aktywacja środowiska Report Authoring Visual Environment Korzystanie z kreatorów środowiska Report Authoring Visual Environment Dodawanie danych do raportu Korzystanie z połączeń Rave Wyświetlanie podglądu definicji raportu Generowanie raportu Rave w środowisku Delphi Wprowadzenie do raportowania Rave - Delphi. Copyright 2007 BSC Polska. 16-1
Komponenty raportowania Rave System raportowania Rave umożliwia programistom dołączanie raportów do plików wykonywalnych. Dzięki obiektom raportowania Rave i odpowiadającym im komponentom interfejsu, programiści mogą tworzyć raporty przeznaczone do wyświetlania lub wydruku, zarówno dla biblioteki CLX jak i VCL, bezpośrednio w programie Delphi. Poniżej przedstawiono wygląd palety komponentów Delphi z wybraną zakładką Rave: Rysunek 1 Komponenty Rave Pierwszy komponent na palecie to TRvProject ( ). Klasa ta odpowiada za wygląd i wydruk raportów utworzonych w formatkach środowiska Delphi. Zwykle w aplikacji wystarcza jeden komponent TRvProject, ale jeśli to konieczne, można ich użyć więcej. Komponent TRvSystem ( ) jest rozbudowanym narzędziem integrującym podgląd wydruku, przenośny interfejs drukarki oraz tworzenie raportów. TRvSystem może wysłać raport do drukarki lub wyświetlić go na ekranie. TRvSystem może również wyświetlać ekran konfiguracji i stanu. Komponent TRvSystem jest rozbudowanym narzędziem, integrującym możliwości komponentów TRvNDRPreview, TRvNDRPrinter oraz TRvNDRWriter w jeden, łatwy w użyciu system. Komponent TRvNDRWriter ( ) w połączeniu z TRvNDRPrinter i TRvNDRPreview jest używany do przechowywania raportu w specjalnym formacie binarnym do czasu, aż zostanie on wydrukowany lub wyświetlony. Połączenie z danymi: Cztery kolejne komponenty ( ) są odpowiedzialne za dodawanie danych do raportu. Za pomocą zdarzeń w tych komponentach połączenia z danymi, można dostosować sposób przesyłania danych do raportów Rave. Komponenty połączenia z danymi to: TrvCustomConnection: Komponent TRvCustomConnection umożliwia raportowi dostęp do danych, które nie są przechowywane w tradycyjnej bazie danych. Procedury obsługi zdarzeń w tym komponencie umożliwiają pełny dostęp do danych. TRvDataSetConnection: TRvDataSetConnection zapewnia dostęp do zestawów danych. TRvTableConnection: TRvTableConnection wprowadza połączenie pomiędzy danymi w tabelach. TRvQueryConnection: TRvQueryConnection łączy z wynikami kwerend bazy danych. Następne dwie ikony ( ) wskazują na funkcje ich komponentów w sposób znacznie bardziej wyraźny niż poprzednie cztery: 16-2 Wprowadzenie do raportowania Rave - Delphi. Copyright 2007 BSC Polska.
TRvRenderPreview: Komponent Preview odpowiada za możliwość wyświetlania podglądu niezależnie od platformy. TRvRenderPrinter: Komponent Printer zarządza interfejsem wydruku niezależnym od platformy. Cztery ostatnie komponenty ( nazwą (i ikonami) oznaczają: ) kontrolują wyniki raportowania. Zgodnie z TRvRenderPDF: Generuje raport w formacie PDF. TRvRenderHTML: Tworzy raporty HTML. TRvRenderRTF: Daje w wyniku raporty w formacie RTF firmy Microsoft. TRvRenderTEXT: Tworzy raporty w postaci zwykłego tekstu ASCII. Projektant wizualny Rave Rave umożliwia tworzenie graficznych raportów przy użyciu narzędzia projektowania Rave. Znane jest ono również jako Report Authoring Visual Environment. Kontrolki umieszczane na formatce w środowisku Delphi służą do graficznego połączenia danych z projektantem RAVE. Najlepszym sposobem funkcjonalności Rave jest praca z nim, więc na początek utwórzmy prosty raport: Z głównego menu Delphi wybierz File New Application (Plik Nowy Aplikacja). Następnie wybierz zakładkę Data Access (Dostęp do danych) i przeciągnij ClientDataSet na formatkę. Instancji ClientDataSet nadaj nazwę clntdatalocal. Nadaj właściwości FileName wartość customer.xml, a następnie ustaw wartość właściwości Active obiektu clntdatalocal na True. Znajdź komponent RvDataSetConnection na zakładce Rave palety narzędzi. Umieść jeden komponent na formatce i nazwij go rvdatasetlocal. Nadaj właściwości DataSet dla rvdatasetlocal wartość naszego zbioru danych klienta: clntdatalocal. Rysunek 2 Komponenty wymagane przez raport. Na zakończenie, aby umożliwić uaktywnienie projektanta wizualnego (oraz zapewnić miejsce na określenie nazwy pliku definicji raportu), na formatce należy umieścić komponent TRvProject, kliknąć prawym przyciskiem myszy, aby uaktywnić właściwości komponentu i wybrać Rave Visual Designer... (Projektant wizualny Rave). Wprowadzenie do raportowania Rave - Delphi. Copyright 2007 BSC Polska. 16-3
Rysunek 3 Uruchamianie narzędzia Rave Visual Designer. Ponieważ Rave jest samodzielną aplikacją, do jej aktywacji nie jest konieczny TrvProject: Narzędzie Rave można również uaktywnić wybierając z głównego menu Delphi Tools Rave Designer (Narzędzia Projektant Rave) lub uruchamiając Rave.exe spoza środowiska Delphi. Po załadowaniu projektanta wizualnego, będzie on wyglądał następująco: Rysunek 4 Środowisko Report Authoring Visual Environment (RAVE). Na początku Rave może wydawać się narzędziem skomplikowanym. Jednak ponieważ określiliśmy nasz zestaw danych przed aktywacją projektanta Rave, utworzenie raportu jest teraz bardzo łatwe. 16-4 Wprowadzenie do raportowania Rave - Delphi. Copyright 2007 BSC Polska.
Po załadowaniu Rave, pierwszą czynnością, którą należy wykonać, jest utworzenie nowego widoku danych dla raportu. Wybierz File New Data Object (Plik Nowy obiekt danych) z głównego menu Rave. Ponieważ Rave obsługuje wiele skomplikowanych powiązań danych, konieczne jest określenie jaki typ widoku danych chcemy utworzyć: Rysunek 5 okno dialogowe Data Connections (Połączenia danych). Wybierz pozycję Direct Data View (Bezpośredni podgląd danych) i kliknij przycisk Next (Dalej). Po przekazaniu do środowiska Rave informacji o żądanym typie połączenia, Rave może przeanalizować naszą formatkę i wyświetlić listę możliwych wyborów: Rysunek 6 Wyświetlanie listy dostępnych połączeń danych. Jeśli do tej pory nie popełniono żadnego błędu, nazwa połączenia zestawu danych Rave powinna pojawić się na liście. Ponieważ chcemy oglądać raport zarówno w trakcie działania aplikacji, jak i w fazie projektowania, zaznaczmy odpowiednie pola wyboru. Kliknij przycisk Finish (Zakończ). Wprowadzenie do raportowania Rave - Delphi. Copyright 2007 BSC Polska. 16-5
Po odnalezieniu danych przez środowisko Rave, dodane zostaną nazwy wszystkich znalezionych pól. Aby zobaczyć listę znalezionych pól, kliknij widok drzewa projektu i rozwiń definicje Data Dictionary: Rysunek 7 Wyświetlanie Data Dictionary. Ostatni krok: Po zdefiniowaniu zestawu pól do umieszczenia w raporcie przez narzędzie Rave, można zaprojektować sam raport. Aby wygenerować pierwszy raport, wybierz kolejno Tools Report Wizards Simple Table (Narzędzia Kreatory raportów Prosta tabela). Po aktywacji projektanta raportów, Rave zapyta dla jakiego widoku danych ma być wygenerowany widok: Rysunek 8 Wybór widoku danych. Ponieważ zdefiniowaliśmy pojedynczy widok, wybór jest prosty: Wybierz DataView1 i kliknij przycisk Next (Dalej). 16-6 Wprowadzenie do raportowania Rave - Delphi. Copyright 2007 BSC Polska.
Następnie należy określić pola mające się pojawić w raporcie: Rysunek 9 Wybór pola. Można wybrać dowolne pole do uwzględnienia w raporcie, na razie pozostańmy jednak przy prostym rozwiązaniu wybierając pola zaznaczone powyżej. Kliknij przycisk Next (Dalej). Kreator poprosi o ułożenie pól w kolejności, w jakiej mają być umieszczone w raporcie. Rysunek 10 Określanie kolejności wybranych pól. To co widzimy najzupełniej wystarcza dla potrzeb krótkiego raportu, możemy więc kliknąć przycisk Next (Dalej). Wprowadzenie do raportowania Rave - Delphi. Copyright 2007 BSC Polska. 16-7
Mamy teraz możliwość zmiany domyślnych właściwości raportu. Rysunek 11 Opcje układu raportu. Chociaż możliwe jest określenie dowolnego tytułu i ustawień, możemy zaakceptować ustawienia domyślne klikając przycisk Next (Dalej). Dochodzimy do ostatniego kroku przed wygenerowaniem raportów przez Kreatora: Wybór czcionki umożliwia nadpisanie domyślnych ustawień czcionki, która będzie użyta w raporcie. Rysunek 12 Wybór czcionki. 16-8 Wprowadzenie do raportowania Rave - Delphi. Copyright 2007 BSC Polska.
Ponownie możemy zaakceptować ustawienia domyślne, klikając przycisk Generate (Utwórz). Właśnie utworzyliśmy pierwszą definicję raportu! Rysunek 13 Nasza pierwsza definicja raportu. Po utworzeniu definicji raportu można go swobodnie korzystać z funkcji Rave. W panelu właściwości Rave można sprawdzić właściwości obiektów automatycznie umieszczonych w pierwszym raporcie przez kreatora Rave. Wprowadzenie do raportowania Rave - Delphi. Copyright 2007 BSC Polska. 16-9
Kontrola wyników Po utworzeniu raportu należy go przetestować, aby upewnić się, że raport wygląda i generuje się poprawnie. Ponieważ w większości klas nie każdy student ma dostęp do drukarki sieciowej (a nawet jeśli tak jest, jednoczesne jej używanie przez wiele osób zwykle zajmuje zbyt dużo czasu), skorzystamy z funkcji podglądu wydruku projektanta Rave do zbadania pierwszego raportu. Aby aktywować funkcję podglądu wydruku, należy wykonać raport. Aby uruchomić raport domyślny, wybierz File Execute Report (Plik Wykonaj raport) z głównego menu projektanta Rave: Rysunek 14 Wykonywanie raportu. Generując raport w Rave, wybór pomiędzy plikiem zewnętrznym, drukarką lub podglądem wydruku (na ekranie) urządzenia drukującego polega na wybraniu odpowiedniego przycisku opcji. Przed kliknięciem przycisku OK należy się upewnić, że wybrano opcję Preview (Podgląd). Rysunek 15 Raport końcowy (podgląd wydruku). 16-10 Wprowadzenie do raportowania Rave - Delphi. Copyright 2007 BSC Polska.
Wyjście z projektanta Rave Podczas pracy w Rave, zdefiniowaliśmy wiele obiektów i ustawiliśmy wiele właściwości dla naszego raportu. Aby zachować te wartości, należy zapisać wyniki pracy w projektancie Rave. Wszystkie projekty Rave mają domyślne rozszerzenie.rav. Do wydrukowania lub edycji raportu konieczne jest zapisanie i rozprowadzanie plików definicji raportu.rav razem z gotową aplikacją. Generowanie raportu w programie Delphi Po zaprojektowaniu raportu i zapisaniu jego definicji, jego zastosowanie jest stosunkowo łatwe. Zakładając nazwę instancji rvproject dla interfejsu TRvProject na naszej formatce, konieczne jest określenie jedynie nazwy definicji raportu.rav poprzez użycie właściwości ProjectFile, a następnie wykonanie raportu: procedure TForm1.btnGenerateClick(Sender: TObject); begin rvproject.projectfile := 'myreport.rav'; rvproject.execute; end; Dzięki przypisaniu zawartości ProjectFile w czasie działania aplikacji, jeden komponent TRvProject może obsługiwać wiele raportów. Po wykonaniu raportu. Użytkownik będzie mógł skorzystać z interfejsu TRvProject do zarządzania wydrukiem definicji raportu (w tym przypadku, myreport.rav). Właściwość ProjectFile może być również przypisana podczas projektowania przy użyciu inspektora obiektów. Wprowadzenie do raportowania Rave - Delphi. Copyright 2007 BSC Polska. 16-11
Podsumowanie Zagadnienia omówione w rozdziale: Przegląd komponentów Rave Użycie komponentu ClientDataset w celu przesłania danych do środowiska Rave Uzyskanie połączenia z projektantem Rave Sposób aktywacji narzędzia Rave z formatki Delphi Użycie Kreatora Rave do utworzenia prostego raportu Sposób wykonania definicji raportu Rave w Delphi. Drukowanie na drukarce, do pliku oraz na ekranie 16-12 Wprowadzenie do raportowania Rave - Delphi. Copyright 2007 BSC Polska.