Projektowanie szablonów z produktem Rational Quality Manager 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 Quality Manager i różnymi adresami URL, które są potrzebne, aby wyodrębnić dane z produktu Rational Quality Manager przy użyciu produktu Rational Publishing Engine. Patrz Rational Quality Managerdokumentacja interfejsu API usług REST.

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 kolekcji (takie jak szczegóły instrukcji testowania lub skrypty testowe) z projektu produktu Rational Quality Manager lub uzyskać dostęp do pojedynczego zasobu o znanym adresie URL, należy utworzyć adres URL, który korzysta z argumentu feed. Należy zawsze używać tego schematu i dynamicznie go skonfigurować na potrzeby określonych elementów danych w szablonie z projektu produktu Rational Quality Manager.
      • Przykład: https://serwer:port/qm/service/com.ibm.rqm.integration.service.IIntegrationService/schema/feed.xsd
    • Aby dodać określone elementy danych z pojedynczego zasobu (takie jak szczegóły instrukcji testowania lub skrypty testowe) z projektu produktu Rational Quality Manager lub uzyskać dostęp do pojedynczego zasobu o znanym adresie URL, należy utworzyć adres URL, który korzysta z argumentu qm.
      • Przykład: https://serwer:port/qm/service/com.ibm.rqm.integration.service.IIntegrationService/schema/qm.xsd
    • W przypadku używania interfejsów API REST 2 do generowania dokumentu konieczne jest udostępnienie adresu URL schematu źródła danych wskazującego dostawcę usług, a nie główny wpis. Przykład:
      • Niepoprawnie: https://serwer:port/qm/oslc_qm/catalog
      • Poprawnie: https://serwer:port/qm/oslc_qm/catalog/repozytorium/db/repozytorium_schematów/
  4. Dodaj schemat źródła danych do szablonu dokumentu. W przypadku produktu Rational Quality Manager, można wykonać następujące kroki:
    1. W programie Document Studio kliknij opcję Dane > Dodaj schemat źródła danych.
    2. W polu Predefiniowane wybierz jeden ze schematów produktu RQM.
    3. W polu Typ wybierz typ schematu z listy. Dla produktu Rational Quality Manager należy wybrać opcję Ogólny XML.
    4. Edytuj pole Schemat, jeśli jest to konieczne, lub kliknij przycisk Przeglądaj, aby wybrać ścieżkę dla pliku schematu.
    5. Dopisz ?abbreviate=false na końcu adresu URL.
      • Przykład: https://serwer:port/qm/service/com.ibm.rqm.integration.service.IIntegrationService/resources/JKE Banking (Quality Management)/testcase?abbreviate=false
    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 Quality Manager można używać typów uwierzytelniania Formularz, Podstawowe lub OAuth.
  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. Więcej informacji na ten temat zawiera sekcja Interfejs API usług REST możliwości raportowania produktu Rational Quality Manager.
  9. Utwórz sortowania, aby uporządkować dane w raporcie.

Opinia