Projektowanie szablonów z produktem Rational ClearQuest 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. Patrz sekcja Tworzenie przykładowego szablonu REST.
Zapoznaj się z usługą REST produktu Rational ClearQuest i różnymi adresami URL, które są potrzebne, aby wyodrębnić dane z produktu Rational ClearQuest przy użyciu produktu Rational Publishing Engine. Patrz temat Informacje o Centrum informacyjnym produktu Rational ClearQuest.

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. Dodaj schemat źródła danych do szablonu dokumentu. W przypadku produktu Rational ClearQuest schemat źródła danych można wykryć przez wprowadzenie podstawowego adresu URL do aplikacji.
    1. Otwórz kreator wykrywania schematów odpowiedni dla używanej wersji produktu Rational ClearQuest.
      • Dla wczesnych wersji produktu Rational ClearQuest korzystających z usług REST 1 należy kliknąć opcję Dane > Wykrywanie schematu > Wykrywanie schematu REST.
      • Dla nowszych wersji produktu Rational ClearQuest korzystających z usługi REST 2 należy kliknąć opcję Dane > Wykrywanie schematu > Wykrywanie schematu REST 2.
    2. W polu Podstawowy adres URL określ podstawowy adres URL zasobu.
      • W przypadku usług REST 1 produktu Rational ClearQuest produkt Rational Publishing Engine używa produktu Rational Data Services do wykrywania schematu i odpytywania danych. Podstawowy adres URL do usług Data Services to: https://serwer:port/DataServices/ClearQuest
      • W przypadku usług REST 2 produktu Rational ClearQuest należy użyć adresu URL elementu ServiceProvider. Użytkownicy mogą uzyskać adres URL elementu ServiceProvider, odwiedzając adres URL Rational ClearQuest REST 2 elementu ServiceCatalog, na przykład https://serwer:port/context/oslc. Należy ustawić nagłówki HTTP OSLC-Core-Version na wartość 2.0 i zaakceptować application/rdf+xml. W zwróconym wyniku można znaleźć adres URL elementu ServiceProvider - rdf:about.
        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:
        • Niepoprawny: https://serwer:port/cqweb/oslc
        • Poprawny: https://serwer:port/cqweb/oslc/repo/repozytorium/db/repozytorium_schematów/
    3. Z listy Typ uwierzytelniania wybierz odpowiedni typ. Jeśli żaden typ nie zostanie wybrany, będą testowane wszystkie typy do czasu znalezienia typu poprawnego. Może to wydłużyć czas generowania dokumentu.
    4. Jeśli zasób znajduje się na zabezpieczonym serwerze, podaj nazwę użytkownika w polu Użytkownik.
    5. Jeśli zasób znajduje się na zabezpieczonym serwerze, podaj hasło w polu Hasło.
    6. Kliknij przycisk Dalej. Do wprowadzonego podstawowego adresu URL automatycznie dołączany jest łańcuch ?metadata=schema. Przykład: https://serwer:port/service/cq/records/defects?metadata=schema
    7. Kliknij przycisk Zakończ. Wybrany schemat źródła danych zostanie wyświetlony w widoku Schemat źródła danych.
  4. 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.
  5. Użyj zapytań, atrybutów i zmiennych, aby dodać dane do szablonu. Te elementy określają, które fragmenty informacji są generowane w raporcie.
  6. Dodaj formatowanie i style do elementów, aby umożliwić sterowanie sposobem ich wyświetlania w danych wyjściowych.
  7. 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.

    Adapter produktu Rational ClearQuest obsługuje filtrowanie rodzime ze źródeł danych usług REST możliwości raportowania w wersji 1. W filtrach rodzimych usług REST możliwości raportowania w wersji 1 należy tylko wprowadzić tekst w nawiasach kwadratowych []. Pozostała część filtru jest generowana przez produkt Rational Publishing Engine. Więcej informacji na ten temat zawiera sekcja Usługi REST możliwości raportowania - wersja 1.

    Produkt Rational ClearQuest 8 bez adaptera obsługuje filtrowanie rodzime ze źródeł danych usług Rest 2 umożliwiających raportowanie. Więcej informacji zawiera dokument Rational ClearQuest OSLC CM REST API (Interfejs API usług REST OSLC CM).

    Przykładowy filtr zmiennej:
    cq:Product{cq:Product="${productName}") 
    Przykładowy rozstrzygnięty filtr, w którym wartością zmiennej productName jest Rational Publishing Engine:
    cq:Product{cq:Product="Rational Publishing Engine")
    Uwaga:
    • Żądania są wysyłane do źródła danych tylko w razie potrzeby. Na przykład można użyć warunku określającego, że element będzie wyświetlany w danych wyjściowych tylko wtedy, gdy zawiera dane. Warunek w elemencie kontenera może mieć postać: zmienna == "true". Jeśli ten warunek nie zostanie spełniony i żadne dane nie spełniają warunku zmiennej, do źródła danych nie zostaną wysłane żadne żądania.
    • Przed wykonaniem żądania można obliczyć filtry rodzime. Filtr rodzimy jest obliczany w momencie, w którym napotkano zapytanie, i używane są wartości zmiennych z tego momentu. Oznacza to, że można wykonywać obliczenia w szablonie, co ma wpływ na filtry rodzime.
  8. Utwórz sortowania, aby uporządkować dane w raporcie.

Opinia