Szablon dokumentu definiuje strukturę, układ i treść raportu. Utworzenie poprawnego szablonu wymaga planowania, programowania, testowania i zapisywania szablonu.
1: Zbierz wymagania
Różne potrzeby wymagają różnych projektów. Przed przystąpieniem do projektowania szablonu określ wymagania biznesowe i wymagania dotyczące dokumentu.
- Elementy danych
- Istnieje wiele różnych elementów szablonu wyświetlających różne typy informacji. Jakich informacji będą potrzebować osoby, które będą przeglądać ten dokument? Po zapoznaniu się z tymi potrzebami można rozpocząć ustalanie elementów danych:
- Które elementy szablonu będą wyświetlały te dane? Jak dane te będą prezentowane w dokumencie wyjściowym?
- Czy istnieje więcej niż jeden sposób prezentacji informacji? Jeśli tak, to który z nich będzie najwłaściwszy w kontekście, w którym dokument będzie przeglądany?
- Jaka ilość danych jest niezbędna? Być może istnieje możliwość odfiltrowania niepotrzebnych danych, dzięki czemu skróci się czas generowania danych wyjściowych raportu.
- Typ danych wyjściowych
- Należy rozważyć, jaki typ danych wyjściowych będzie najlepiej odpowiadał potrzebom osób przeglądających dokument. Projektowany szablon może wyglądać inaczej po
wygenerowaniu do różnych typów danych wyjściowych. Niektóre elementy zostały zoptymalizowane pod kątem wyświetlania w określonym formacie, a niektóre nie są obsługiwane w danych formatach. Należy zapoznać się z informacjami o tym, jak poszczególne elementy szablonu są wyświetlane w różnych formatach wyjściowych. Dzięki temu można będzie wybrać najlepiej współdziałające elementy i typ danych wyjściowych.
- Jeden szablon a wiele szablonów
- Czy szablon będzie używany jednorazowo czy jego części będą ponownie wykorzystywane w innych szablonach?
- Jeden szablon: wszystkie części projektu dokumentu są zawarte w jednym szablonie. Oznacza to, że wszystkie elementy znajdują się w jednym miejscu i nie jest konieczne scalanie.
- Wiele szablonów: można zastosować podejście modułowe, tworząc wiele szablonów i scalając je w celu utworzenia kompletnego dokumentu.
Na przykład możesz utworzyć szablon spisu treści, szablon okładki
przedniej, szablon danych, szablon indeksu i szablon okładki tylnej. Szablony
te mogą być ponownie wykorzystywane podczas generowania różnych dokumentów.
Określ liczbę szablonów potrzebnych przy tych wymaganiach.
Każdy blok szablonu można nazwać i opisać w atrybutach metadanych.
Nazwa jest wyświetlana w szablonie, a opis jest wyświetlany w polu wskazówki
elementu szablonu.
- Kontekst wyświetlania
- W jaki sposób użytkownicy będą przeglądać ten dokument?
- Czy będzie on drukowany? Wyświetlany na ekranie? Czy będą stosowane oba te podejścia?
- Czy będzie on uruchamiany w zintegrowanym produkcie?
2: Zaprojektuj szablon
Podczas projektowania
szablonu można zastosować następujące podejścia, aby zaoszczędzić czas.
- Zaimplementuj całą strukturę szablonu przy użyciu podejścia
zstępującego. Rozpocznij od elementów najbardziej ogólnych, a następnie stopniowo przechodź do bardziej szczegółowych.
- Sprawdź poprawność generowania danych zanim przejdziesz do szczegółów formatowania.
Jeśli użytkownik spędzi dużo czasu na formatowaniu, a następnie odkryje, że dane nie są generowanie poprawnie, prawdopodobnie będzie musiał zmodyfikować formatowanie. Sekcja
3. Testowanie szablonu zawiera szczegółowe informacje.
- Dopracuj szczegóły i kolejno dodawaj bardziej szczegółowe
wymagania.
Pozostaw mniej ważne lub trudniejsze szczegóły do późniejszego
zaimplementowania.
Rozważ istotność wymagań, które są trudne do realizacji,
podobnie jak w analizie kosztów i zysków.
- Rozważ użycie skryptów w celu wyodrębnienia informacji w formacie, z którego produkt Rational Publishing Engine może efektywnie korzystać.
- Szablon można zaprojektować pod kątem udostępnienia konkretnych właściwości
układu strony, takich jak wielkość strony, orientacja, marginesy, liczba
kolumn, i stylów dla typów akapitów, które najprawdopodobniej zostaną użyte w dokumentach.
- Szablon może zawierać:
- Elementy struktury dokumentu, takie jak akapity, tabele, listy i spis
treści.
- Bloki układu dokumentów, takie jak strony wzorcowe, arkusze stylów,
nagłówki i stopki.
- Wewnętrzne i zewnętrzne style zdefiniowane przez użytkownika, takie jak
formatowanie tekstu lub akapitu. Formatowanie tekstu obejmuje pogrubienie,
kursywę, podkreślenie, wielkość czcionki i kolor czcionki. Formatowanie akapitu
obejmuje marginesy, krawędzie, wcięcia i parametry skryptów w formie kodu
JavaScript.
- Osadzoną treść szablonu, taką jak obrazy, tekst statyczny i odwołania do
plików statycznych oraz arkuszy stylów.
- Elementy danych, takie jak atrybuty, warunki i elementy danych
dynamicznych.
- Wyodrębnianie danych w postaci zapytań i filtrów.
- Zmienne zewnętrzne, które otrzymują wartości w czasie wykonywania, i
zmienne wewnętrzne, które są używane do obliczeń. Tworzenie
zmiennych zewnętrznych jest preferowaną metodą zakodowania w szablonie adresów
URL źródeł danych. Jeśli adresy URL zostaną zakodowane i zostanie
zmieniona nazwa serwera, konieczne będzie zaktualizowanie adresów URL w
każdym szablonie. Przy użyciu zmiennych zewnętrznych można nadpisać adresy URL
w czasie wykonywania. Dla szablonów osadzonych w innych produktach należy użyć
zmiennych specjalnych, które są rozpoznawane przez te produkty, gdy odwołują
się one do danych.
- Uruchom aplikację Document Studio.
- Utwórz nowy szablon od początku lub na podstawie istniejącego szablonu.
- Dodaj schemat źródła danych.
- Dodaj elementy.
- Dodaj formatowanie do elementów.
- Zdefiniuj treść dynamiczną.
- Opcjonalnie: Doprecyzuj dane przy użyciu filtrów, operacji sortowania lub warunków.
3: Przetestuj szablon
- Testowanie jest wykonywane przyrostowo podczas projektowania. Często
zapisuj szablon, stosując unikalne nazwy. Często weryfikuj dane wyjściowe,
używając niewielkich zestawów danych testowych. Nie dodawaj więcej elementów,
dopóki obecny szablon nie działa.
- Po zakończeniu projektowania większości dokumentu wykonaj testowanie
obciążenia w celu sprawdzenia wydajności. Użyj narzędzia Podgląd, aby
ograniczyć wielkość używanych danych. Wygenerowany raport jest nadal dokładny,
ale działa szybciej, ponieważ domyślna maksymalna liczba rekordów dla
zapytania, jaką pobiera produkt
Rational Publishing Engine,
wynosi 10. Przy testowaniu warunków możliwe jest, że żaden rekord spośród
pierwszych 10 nie będzie pasował do warunku. W takim przypadku użyj narzędzia
Uruchamianie zamiast narzędzia Podgląd lub zmień wartość maksymalnej liczby
rekordów na zapytanie w sekcji Preferencje.
- Przetestuj szablon w różnych formatach wyjściowych. Może się
okazać, że w jednym typie wyjściowym szablon nie jest wyświetlany tak dobrze
jak w innym.
- Uruchom narzędzie weryfikacji.
- Wygeneruj podgląd.
4: Zapisz szablon
- Zapisz opracowane i przetestowane szablony na centralnym serwerze plików.
Jako miejsca przechowywania można użyć komponentu Centralne
zarządzanie.
- W metadanych szablonu podaj istotne informacje, aby inni użytkownicy
dowiedzieli się, w jaki sposób ponownie wykorzystać ten szablon. Trochę
danych przykładowych z informacjami o specyfikacji dokumentu przykładowego dla
danych projektu będzie pomocne w efektywnym ponownym wykorzystaniu tych
szablonów.
Dalsze kroki
Po utworzeniu i przetestowaniu szablonów: