Projektowanie szablonów z produktem Rational Focal Point jako źródłem danych

Projektanci raportów mogą za pomocą aplikacji Document Studio importować schematy źródła danych i budować szablony raportów.

Zanim rozpoczniesz

Wskazówka: Instalacja produktu Rational Publishing Engine obejmuje zestaw przykładowych raportów. Przed przystąpieniem do publikowania dokumentów można przećwiczyć ten przykładowy scenariusz generowania dokumentów. Więcej informacji na ten temat zawiera sekcja Tworzenie przykładowego szablonu REST.
Zapoznaj się z usługą REST produktu Rational Focal Point i różnymi adresami URL, które są potrzebne, aby wyodrębnić dane z produktu Rational Focal Point podczas używania produktu Rational Publishing Engine. Aby znaleźć Centrum informacyjne danej wersji produktu Rational Focal Point, należy zapoznać się z sekcją Informacje o Centrach informacyjnych produktu Rational Focal Point.

O tym zadaniu

Dane są wyodrębniane przy użyciu interfejsu REST API. Ten interfejs jest instalowany i implementowany przy użyciu aplikacji źródła danych i działa niezależnie od produktu Rational Publishing Engine. Więcej informacji na temat interfejsu REST API dla źródła danych zawiera dokumentacja tego źródła danych.

Procedura

  1. Zapoznaj się z procesem projektowania szablonu w sekcji Projektowanie szablonów dokumentów. Rozpoczęcie planowania struktury dokumentu i danych, które może on zawierać. Określ na przykład, czy dokument końcowy ma być generowany na podstawie jednego szablonu, czy wielu plików szablonów zawierających fragmenty treści wielokrotnego użytku.
  2. W aplikacji Document Studio utwórz szablon dokumentu.
  3. Zidentyfikuj schemat źródła danych w źródle danych. Aby dodać określone elementy danych z projektu produktu Rational Focal Point lub uzyskać dostęp do pojedynczego zasobu o znanym adresie URL, należy utworzyć adres URL, który korzysta z argumentu resources. Otwórz schemat źródła danych i pobierz z pliku XML identyfikator URI określonego zasobu.
    • Przykład: http://serwer:port/fp/resources
    Uwaga: Schematy produktu Rational Focal Point są specyficzne dla poszczególnych instalacji aplikacji. Oznacza to, że szablonu utworzonego dla jednego serwera Rational Focal Point nie można wykorzystywać ponownie na innym serwerze Rational Focal Point.
    W przypadku korzystania z interfejsu REST API umożliwiającego raportowanie produktu Rational Requirements Composer należy wprowadzić adres URL w następującym formacie:
    • https://serwer:port/rm/publish/artefakt
  4. Dodaj schemat źródła danych do szablonu dokumentu. W przypadku produktu Rational Focal Point, można wykonać następujące kroki:
    1. W programie Document Studio kliknij opcję Dane > Dodaj schemat źródła danych.
    2. W polu Typ schematu wybierz z listy typ schematu. Dla produktu Rational Focal Point należy wybrać opcję Ogólny XML.
    3. W polu Plik schematu wklej adres URL określony jako schemat źródła danych.
    4. Dołącz łańcuch ?metadata=schema na końcu adresu URL.
      • Przykład: http://serwer:port/fp/resources?metadata=schema
      W przypadku korzystania z interfejsu REST API umożliwiającego raportowanie produktu Rational Requirements Composer należy wprowadzić adres URL w następującym formacie:
      • Przykład: https://serwer:port/rm/publish/artefakt?metadata=schema
    5. W polu Identyfikator źródła danych wpisz nazwę źródła danych w szablonie. Kliknij przycisk Dalej.
    6. Jeśli zasób znajduje się na zabezpieczonym serwerze, podaj nazwę użytkownika w polu Użytkownik.
    7. Jeśli zasób znajduje się na zabezpieczonym serwerze, podaj hasło w polu Hasło.
    8. Z listy Typ uwierzytelniania wybierz odpowiedni typ. W przypadku produktu Rational Focal Point typ uwierzytelniania to OAuth. Jeśli typ OAuth nie zostanie wybrany, będą testowane wszystkie typy uwierzytelniania do czasu znalezienia poprawnego. Może to wydłużyć czas generowania dokumentu.
  5. Dodaj elementy do szablonu. Produkt Rational Publishing Engine zawiera obszerny zestaw elementów szablonów, których można używać przy określaniu struktury dokumentu. Elementy te można przeciągać do edytora treści szablonu. Na przykład można dodać element kontenera do przechowywania kilku akapitów. Każdy akapit może być sterowany przez warunek testowy, który wiąże go tylko z konkretnymi danymi. Więcej informacji na ten temat zawierają sekcje Elementy szablonu w widoku Paleta i Dodawanie elementów do szablonu.
  6. Użyj zapytań, atrybutów i zmiennych, aby dodać dane do szablonu. Te elementy określają, które fragmenty informacji są generowane w raporcie.
  7. Dodaj formatowanie i style do elementów, aby umożliwić sterowanie sposobem ich wyświetlania w danych wyjściowych.
  8. Utwórz filtry, aby zawęzić dane, które są pobierane do raportu. Istnieje możliwość używania filtrów, które są szczegółowymi wersjami ogólnego identyfikatora URI źródła danych. Pozwalają one wskazywać konkretne podzbiory danych, tak aby produkt Rational Publishing Engine nie próbował podczas generowania raportu pobierać informacji ze źródła danych w ilości większej niż konieczna. Te filtry muszą być na tyle ogólne, aby pobrać wszystkie niezbędne dane, do których odwołuje się szablon. W przeciwnym razie wygenerowany raport może nie zawierać kompletnego zbioru danych.
  9. Utwórz sortowania, aby uporządkować dane w raporcie.

Opinia