Dokumentacja

⌘K
  1. Home
  2. Docs
  3. Dokumentacja
  4. Dokumentacja użytkownika
  5. Report Designer – podstawowa konfiguracja i generowanie raportu

Report Designer – podstawowa konfiguracja i generowanie raportu

Narzędzie Report Designer jest dostępne w Ustawieniach → Szablony raportów

Aby stworzyć nowy szablon, naciskamy przycisk Dodaj w prawym, górnym rogu ekranu.

W widoku dodawania nowego Szablonu raportu musimy uzupełnić Nazwę, ewentualną notatkę oraz wybrać miejsce wyświetlania. Możliwe jest również zaimportowanie szablonu z pliku xml.

Do edycji szablonu przechodzimy naciskając “Dodaj i przejdź do kreatora”

W istniejącym już szablonie, możemy przejść do kreatora wybierając myszką trzy kropki w prawej części wiersza i wybierając Kreator.

Pusty szablon kreatora nie zawiera podpiętych baz danych oraz nie posiada żadnej początkowej konfiguracji.

report designer by optimes

Pierwszym krokiem, który należy wykonać jest wybranie trzech poziomych kresek w lewym górnym rogu a następnie “Add Data Source”

Kreator przeniesie nas do menu dodawania źródła danych do raportu. Za pomocą checkboxów wybieramy interesujące nas źródła, z których chcemy skorzystać podczas tworzenia Raportu. Wybór potwierdzamy przyciskiem Finish.

Kolejnym krokiem jest skonfigurowanie odpowiedniego parametru, który pozwoli nam poprawnie generować raport dla encji. Jeżeli chcemy wyświetlić raport z Zamówień, naszym parametrem będzie OrderIds. Analogicznie, w przypadku Zleceń produkcyjnych – ProductionOrderIds. (nazwa encji + Ids) Jeśli nie będzie tak nazwanego parametru w raporcie to żadne wartości się nie podstawią.  W celu dodania parametru, po prawej stronie wybieramy ikonę bazy danych. W polu Parameters wybieramy ikonę +.

Kreator przeniesie nas do widoku dodawania parametru. Nadajemy mu odpowiednią nazwę, typ oraz odpowiednio zaznaczamy Checkboxy.

Gdy parametr jest dodany, możemy przejść do ustawienia połączenia tabel. Pozwoli nam to wyświetlić pożądane informacje, np. gdy chcemy wyświetlić ID produktów w zamówieniu, tabelę produktów musimy połączyć z zamówieniami.

Ustawienia połączeń zmieniamy najeżdżając myszką na interesująca nas tabelę i wybierając ikonę ołówka.

Następnie przechodzimy do ustawień poprzez naciśnięcie “Run Query Builder”.

W poniższym przykładzie pokazane jest połączenie tabeli zamówień z tabelą produktów w zamówieniach. Z wyboru tabel po prawej stronie (Available tables and views), przeciągamy wybraną do okna głównego.

Często Report Designer podpowiada nam, które wartości z tabel pasują do siebie i możemy je połączyć. Łączenia konfigurujemy przeciągając myszką z jednej wartości do drugiej.

W tej części, konieczne jest ponowne skonfigurowanie parametru. W zakładce Parameters, dodajemy nowy. Odpowiednio go nazywamy, wybieramy Type oraz Result Type. W polu Value, za pomocą dwukrotnego kliknięcia myszą, wybieramy nasz wcześniej dodany parametr.

Ostatnim krokiem jest przejście do zakładki Query Properties i ustawienie odpowiedniego filtra. W omawianym przypadku, naszym filtrem będzie id zamówienia.

Aby skonfigurować filtr w ten sposób, naciskamy + przy AND i wybieramy Add Condition. W niebieskim polu mamy do wyboru wartości tabeli Orders. Wybieramy Orders.ID, następnie w zielonym polu mamy do wyboru warunek, w omawianym przypadku będzie to Is any of i podpinamy wcześniej skonfigurowany parametr OrderIds.

Gdy zakończymy konfiguracje powiązań tabel, relacje musimy skonfigurować ponownie w ustawieniach bazy danych. Po najechaniu myszką na nazwę naszej bazy danych, ponownie pojawi się przycisk ołówka.

W ten sposób możemy przejść do tworzenia powiązań między tabelami. To powiązanie pozwoli nam stworzyć nowe tabele np. OrdersOrdersItems, z której będziemy mogli uzyskać ID produktu w konkretnym zamówieniu

Gdy odpowiednio skonfigurujemy powiązania, relacje, parametry i filtry, możemy rozpocząć proces tworzenia naszego raportu.

Układ raportu składa się z pasm, które zawierają kontrolki raportu i definiują ich lokalizację na stronach dokumentu. Pusty raport zawiera następujące pasma:

  • Pasmo szczegółów wyświetla cykliczną zawartość ze źródła danych raportu. To pasmo jest drukowane tyle razy, ile jest dostępnych rekordów w źródle danych, chyba że dane zostały przefiltrowane.
  • Każdy raport musi mieć pasek szczegółów i nie można go usunąć.
  • Górna i dolna strona to Marginesy. Te pasma są powtarzane raz na każdej stronie dokumentu.

Możesz również dodać następujące pasma:

  • Nagłówek raportu to pierwsza część raportu (marginesy to strefy „poza stroną”). Można użyć tego pasma, aby wyświetlić nazwę raportu, logo firmy, datę utworzenia, nazwę użytkownika itp.
  • Stopka raportu jest umieszczana przed stopką strony i dolnym marginesem na ostatniej stronie raportu. Stopki raportu można użyć do podsumowania raportów lub wniosków.
  • Pionowe pasma – można zastąpić pasmo szczegółów pasmami Vertical Header, Vertical Detail i Vertical Total, aby wyświetlać pola rekordów w pionie i drukować rekordy danych w poziomie — od lewej do prawej

Aby dodać tabelę, wybieramy z przybornika po lewej stronie ikonę tabeli i przeciągamy ją na raport

Następnie, interesujące nas dane z tabel po prawej stronie, przeciągamy do kolumn tabeli.

Aby zaznaczyć tabelę, klikamy w puste miejsce i trzymając lewy przycisk myszy zaznaczamy tabelę.

Każdą kolumną w tabeli możemy edytować. Zaznaczając kolumnę bądź całą tabelę, przechodzimy do ikony koła zębatego.

Znajdują się tam wszystkie ustawienia naszej tabeli, np. Font, wielkość czy podkreślenie.

Aby wyświetlić nasz raport, przyciskamy ikonę podglądu PREVIEW.

W zakładce Preview parameters wpisujemy wartość naszego parametru. W omawianym przypadku, naszym parametrem było ID Zamówienia.  Potwierdzamy wybór.

Report Designer wygenerował podgląd raportu z zamówienia o ID 11697. Znajduje się w nim informacja o ID Zamówienia, Numerze zamówienia oraz czy zamówienie jest Aktywne.

Dodatkowo wyświetliła się informacja o ID produktów w zamówieniu, ilości oraz cenie

Analogicznie, dodatkowe informacje możemy przeciągać na wydruk lub umieszczać w tabeli.  Kolejny przykład – poukładane i podpisane tabele.

W ten sposób możemy stworzyć rozbudowany raport z wieloma informacjami. Np. z zamówienia można pobrać informacje o Kliencie, o produktach w zamówieniu i atrybutach tego produktu.

Zasada łączenia tabel i relacji między nimi jest taka sama dla każdych z tabel. Konfiguracja jest zależna od informacji jaką chcemy uzyskać łącząc je.

Dodatkowe informacje i przykłady:

1) Przegląd parametrów zapytania

Parametr zapytania zawiera wartość zewnętrzną, która jest wstawiana do instrukcji SQL przed wykonaniem zapytania. Ta wartość może być statyczna lub dynamicznie generowana przez skojarzone wyrażenie.

Wartość parametru zapytania jest wstawiana do wynikowego ciągu zapytania SQL w pozycji symbolu zastępczego „@QueryParameterName”.

Parametry zapytania są używane w następujących scenariuszach:

  • Podczas filtrowania danych raportu na poziomie źródła danych za pomocą Konstruktora zapytań.
  • Konstruktor zapytań pomaga konstruować zapytania SQL podczas tworzenia nowego raportu związanego z danymi lub wiązania istniejącego raportu ze źródłem danych SQL

lub podczas dodawania zapytań do istniejącego źródła danych SQL lub edytowania istniejących zapytań.

Skonstruowane zapytania można filtrować za pomocą parametrów zapytania. Rozwiń sekcję Parametry w Konstruktorze zapytań, aby dodać nowy parametr zapytania.

2) Design a Report in Report Wizard

Utwórz nowy raport lub otwórz istniejący.

Otwórz menu i wybierz Design in Report Wizard. W wywołanym Kreatorze raportów wybierz Raport pionowy i kliknij Dalej.

Wybierz źródło danych dla raportu. Wybierz zapytania i pola danych, które chcesz uwzględnić w raporcie. Dodaj pola podsumowania

Określ ustawienia strony (orientacja pozioma)

Kliknij przycisk Zakończ, aby otworzyć wygenerowany raport.

Kreator dodaje kontrolki raportów do następujących pasm:

  • Pionowy pasek nagłówka
    Zawiera tabelę z pojedynczą kolumną wyświetlającą nagłówki pól danych.
  • Pionowy zespół szczegółów Details
    Zawiera tabelę z jedną kolumną, która jest drukowana tyle razy, ile jest rekordów w źródle danych raportu.
  • Pionowe całkowite pasmo
    Zawiera tabelę z pojedynczą kolumną, która ma tyle etykiet w komórkach, ile jest funkcji podsumowujących określonych dla każdego pola w Kreatorze raportów.

Przełącz się w tryb podglądu, aby zobaczyć wynik.

3) Przenieś i zmień rozmiar elementów raportu

Możesz użyć myszy lub klawiatury, aby przenieść kontrolkę raportu do nowej lokalizacji.

Możesz także wybrać wiele kontrolek i przenieść je w taki sam sposób, jak poszczególne kontrolki raportu.

Wybierz kontrolkę, a następnie przeciągnij prostokąt narysowany na jego krawędzi lub rogu, aby zmienić jego rozmiar.

4) Tabele

Tabela wyświetla informacje w formacie tabelarycznym i umożliwia tworzenie raportów tabel.

Kontrolkę tabeli można dodać, przeciągając element Tabela z przybornika do obszaru raportu.

Formant tabeli zawiera co najmniej jeden wiersz. Każdy wiersz zawiera co najmniej jedną komórkę.

Możesz dwukrotnie kliknąć komórkę, aby wywołać jej edytor lokalny i wpisać żądany tekst statyczny

Możesz dostosować rozmiar czcionki tekstu statycznego komórki, aby pasował do granic komórki. Użyj polecenia Fit Text to Bounds w kategorii Actions .

Komórka tabeli jest jak kontrolka Label — zapewnia te same opcje formatowania tekstu, wyrównania, wyglądu, interaktywności itp.

Komórkę tabeli można również ustawić jako kontener dla innych kontrolek raportu, upuszczając wymaganą kontrolkę z przybornika w tej komórce.

5) Powiąż komórki tabeli z danymi

Poszczególne komórki tabeli można powiązać z danymi w taki sam sposób, jak kontrolki Label. Upuść pole danych na istniejącą komórkę, aby powiązać tę komórkę z odpowiednim polem.

Użyj Expression Editor, aby skonstruować złożone wyrażenie powiązania z co najmniej dwoma polami danych. Kliknij znacznik właściwości Text i wybierz Text Expression z menu podręcznego, aby wywołać Edytor wyrażeń.

6) Dodaj kody kreskowe do raportu

Aby wstawić kod kreskowy do raportu, przeciągnij element Kod kreskowy z Przybornika do obszaru raportu. 

Po utworzeniu kodu kreskowego rozwiń kategorię Actions i wybierz typ kodu kreskowego (symbologię) z listy rozwijanej właściwości Symbology.

  • Powiązanie z danymi:

Właściwość Tekst kodu kreskowego można powiązać z polem danych uzyskanym ze źródła danych raportu. Kliknij przycisk wielokropka Text w panelu Expressions.

Wywołany Edytor wyrażeń umożliwia wybranie pola danych lub skonstruowanie złożonego wyrażenia powiązania z co najmniej dwoma polami danych.

7) Dodawanie numeru strony:

Utwórz PageFooterBand w swoim raporcie.

Upuść kontrolkę PageInfo z Przybornika do pasma Stopka strony.

Aby zmienić format wyświetlania kontrolki, określ właściwość Text Format String (np. Strona {0} z {1}, aby wyświetlić bieżący numer strony z całkowitej liczby stron) w kategorii Actions.

8) Opis przycisków z Menu

9) Opis głównego paska narzędzi

10) Narzędzia

Gauge -Kontrolka Miernik umożliwia osadzenie wskaźników graficznych w raporcie

Character Comb – wyświetla tekst, gdzie każdy znak jest drukowany w osobnej komórce.

Rich Text –  wyświetla sformatowany tekst (statyczny, dynamiczny lub mieszany) w raporcie

Chart – Możesz użyć kontrolki Wykres, aby dodać wykres do raportu. Zapewnia widoki 2D lub 3D w celu wizualizacji serii danych (na przykład słupka, punktu, linii, koła i pierścienia, obszaru itp.).

Sparkline – wyświetla kompaktowy wykres, który jest często używany do zilustrowania przepływu danych dla każdego wiersza w raporcie. 

Cross-Band Box, Line – umożliwiają rysowanie linii i prostokątów przez kilka pasm raportu.

Line – rysuje linię w określonym kierunku, stylu, szerokości i kolorze. Możesz go użyć do dekoracji i wizualnego oddzielenia sekcji raportu.

Page brake – wstawienie ogranicznika strony w dowolnym miejscu raportu. 

Panel –  to kontener, który tworzy ramki oddzielnych kontrolek raportu i umożliwia ich przenoszenie, kopiowanie i wklejanie. Panel również wizualnie łączy kontrolki raportu w podglądzie wydruku (na przykład z ramkami lub jednolitym kolorem tła).

Shape –  umożliwia rysowanie różnych kształtów w raporcie.

Subreport –  służy do osadzania innych raportów w bieżącym raporcie.

10) Filtrowanie

Edytor filtrów zapewnia wizualny interfejs do konstruowania kryteriów filtrowania o różnej złożoności z nieograniczoną liczbą warunków filtrowania połączonych operatorami logicznymi.

Warunek filtra składa się z trzech części:

  • Pole źródła danych, z którym powiązany jest raport.
  • Operator kryteriów, taki jak Równa się, Jest mniejszy niż, Jest pomiędzy itd.
  • Wartość operandu statycznego, inne pole danych lub parametr raportu.

Określone warunki można rozmieścić w grupy za pomocą operatorów And, Or, No And i Not Or.

Edytor filtrów wyświetla kryteria filtrowania w postaci drzewa, w którym poszczególne węzły określają proste warunki filtrowania. Węzeł główny jest operatorem logicznym łączącym wszystkie warunki.

Kliknij przycisk plus obok operatora, aby dodać nowy warunek lub grupę.

Możesz wybrać wymagane pole danych i operator porównania z odpowiednich list rozwijanych i wprowadzić wartość operandu w dedykowanym polu wartości.

Rozwiń menu rozwijane dla symbolu zastępczego wartości i wybierz Właściwość lub Parametr, aby porównać pole danych z innym polem danych lub parametrem raportu. Następnie kliknij przekonwertowany symbol zastępczy i wybierz żądany element.

Operator logiczny można zmienić, klikając go i wybierając żądany typ.

11) Relacje między tabelami

Jeśli źródło danych zawiera co najmniej dwa zapytania, kliknięcie przycisku na liście pól spowoduje wywołanie edytora relacji główny-szczegółowy.

Za pomocą tego edytora możesz zdefiniować relacje główny-szczegółowy między zapytaniami, określając odpowiadające im pola kluczowe.

12) Field list

Lista pól wyświetla schemat źródeł danych raportu. Ten panel umożliwia zarządzanie źródłami i parametrami danych raportu, dodawanie pól obliczeniowych i tworzenie powiązanych kontrolek raportu.

Lista pól przedstawia dostępne źródła danych raportu oraz ich strukturę.

13) Raport zawierający obraz z zakładki “Plik”

Aby raport poprawnie wyświetlił obraz z zakładki Plik, konieczne jest odpowiednie połączenie tabeli UploadedFiles z tabelą zawierającą wartość, z której będziemy wyświetlać obraz.

Poniżej przykład połączenia tabeli UploadedFiles z Wares. (Takie połączenie pozwoli wyświetlić obraz z zakładki Plik w Produkcie)

Po tak skonfigurowanym połączeniu Tabel, możemy przejść do kolejnych kroków:

  1. Na raport, w wybrane miejsce, przeciągamy Picture Box
  1. Klikamy w przeciągnięty przez nas Picture Box i przechodzimy do ustawień Expressions, w szarej belce po prawej stornie

W polu Image URL dodajemy wpisujemy – ‘https://NAZWAAPLIKACJI.syneo.pl/UploadedFiles/ReportDesignerImage?fileName=‘ + [ServerSideName]

Zamiast słowa “NAZWAAPLIKACJI” w linku, wpisujemy nazwę aplikacji na której chcemy wygenerować raport. [ServerSideName] wygeneruje nazwę pliku wraz z odpowiednim rozszerzeniem (np. png).

14) Kilka atrybutów na jednym raporcie

Jednym ze sposobów dodania kilku atrybutów do Raportu jest:

W tabeli, która jest połączona z tabelą RunTimeAttributes, konfigurujemy filtr, który określa ID Atrybutu do wyświetlenia na raporcie. 

Jeżeli atrybutów jest kilka, należy stworzyć tyle takich samych tabel ile jest wymaganych do wyciągnięcia atrybutów i nadać im odpowiednie ID. 

Przykład z tabelami Offers:

Wyciągając wartość Value z tabel RunTimeAttributes, otrzymamy na raporcie odpowiedni atrybut, w docelowym miejscu. 

15) Możliwość wyciągnięcia na raport informacji o osobie generującej

W tym celu, dodajemy nowy parametr CurrentUserId

Parametr dodajemy również w tabeli ApplicationUsers, którą możemy połączyć z tabelą People.

Ustawiamy odpowiednie Filtrowanie:

Więcej informacji znajdziesz:

https://devexpress.github.io/dotnet-eud/interface-elements-for-web/articles/report-designer.html

Napisz do nas.