Projektowanie szablonów z produktem IBM Rational Team Concert 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 Team Concert i różnymi adresami URL, które są potrzebne, aby wyodrębnić dane z produktu Rational Team Concert podczas używania produktu Rational Publishing Engine. Patrz sekcja Obszar wiki interfejsu API usług REST możliwości raportowania: zasoby udostępniane przez produkt Rational Team Concert.
Umożliwiający raportowanie interfejs API usług REST produktu Rational Team Concert różni się od wielu tradycyjnych interfejsów API domen. Zamiast udostępniać adresy URL zasobów wskazujące konkretne elementy, takie jak pojedynczy element pracy lub pojedynczy wynik budowania, interfejs API usług REST zapewnia dostęp do monolitycznych zasobów. Każdy monolityczny zasób jest zasobem kontenera, który reprezentuje wynik zapytania dla jednego lub większej liczby elementów.
  • platforma podstawowa: wspólne artefakty, takie jak obszary projektu, obszary zespołu, kontrybutory, iteracje i powiązania.
  • element pracy: artefakty elementu pracy, takie jak elementy pracy, kategorie, istotności i priorytety.
  • apt: artefakty narzędzia Agile Planning, takie jak możliwy czas pracy zespołu oraz harmonogramy zasobów i nieobecności.
  • generic: artefakty ogólne.
  • budowanie: artefakty budowania, takie jak wyniki budowania, udziały wyniku budowania, definicje budowania oraz mechanizmy budowania.
  • scm: artefakty kontroli kodu źródłowego, takie jak strumienie i komponenty, a także delty zmiany wielkości strumieni.
Zasoby te umożliwiają elastyczne filtrowanie i odpytywanie podczas gromadzenia danych na potrzeby raportu. Na przykład zasób elementu pracy może zawierać jeden lub większą liczbę elementów powiązanych z elementami pracy w zależności od zapytania lub filtru przekazanego do 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. Dodaj schemat źródła danych do szablonu dokumentu. W przypadku produktu Rational Team Concert schemat źródła danych można wykryć przez wprowadzenie podstawowego adresu URL do aplikacji.
    1. W programie Document Studio kliknij opcję Dane > Dodaj schemat źródła danych.
    2. W polu Typ schematu wybierz z listy typ schematu. W przypadku produktu Rational Team Concert należy wybrać opcję REST.
    3. W polu Plik schematu wklej adres URL określony jako schemat źródła danych.
      • https://serwer:port/ccm/rpt/repository/foundation
      • https://serwer:port/ccm/rpt/repository/workitem
      • https://serwer:port/ccm/rpt/repository/apt
      • https://serwer:port/ccm/rpt/repository/generic
      • https://serwer:port/ccm/rpt/repository/scm
      • https://serwer:port/ccm/rpt/repository/build
    4. Dołącz łańcuch ?metadata=schema na końcu adresu URL.
      • Przykład: https://serwer:port/ccm/rpt/repository/workitem?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 Team Concert 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.
    9. 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. Rational Team Concert obsługuje źródła danych usług REST możliwości raportowania w wersji 1 w celu użycia w filtrach rodzimych. Więcej informacji na ten temat zawiera sekcja Interfejs API usług REST możliwości raportowania w serwisie Jazz.net. Przykład:
    projectArea/name="Rational Publishing
    Engine"  and target/name="1.2.1"
    Rozstrzygnięte żądanie:
    fields=workitem/workItem[projectArea/name="Rational Publishing Engine" and target.name="1.2.1"]/(@href|summary)
    Uwaga: Do filtrowania rodzimego nie można używać wszystkich pól.
  8. Utwórz sortowania, aby uporządkować dane w raporcie.

Opinia