Produkt Rational Quality Manager można zdefiniować jako źródło danych w produkcie Rational Publishing Engine.
Dane są wyodrębniane przy użyciu interfejsu API REST produktu Rational Quality Manager. Ten interfejs jest instalowany i implementowany przez aplikację i działa niezależnie od produktu Rational Publishing Engine.
Wskazówka: Produkt
Rational Publishing Engine jest dostarczany z zestawem przykładowych raportów. Przed przystąpieniem do publikowania dokumentów można przećwiczyć ten przykładowy scenariusz generowania dokumentów. Patrz:
Tworzenie przykładowego szablonu REST.
Zanim rozpoczniesz
- 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.
- Nawiąż połączenie ze schematem źródła danych. Patrz sekcja Dodawanie schematu źródła danych.
- Schemat może znajdować się w lokalnym systemie plików. Na przykład: https://serwer:port/jazz/service/com.ibm.rqm.integration.service.IntegrationService/schema/feed.xsd jest plikiem schematu, w którym używany jest argument feed. Można użyć tego schematu, aby dodać konkretne elementy danych, takie jak szczegóły instrukcji testowania lub skrypty testowe, z projektu produktu Rational Quality Manager lub aby uzyskać dostęp do pojedynczego zasobu o znanym adresie URL.
- 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/qm/oslc_qm/catalog
- Poprawny: https://serwer:port/qm/oslc_qm/catalog/repozytorium/db/repozytorium_schematów/
Za pomocą elementów znajdujących się w schemacie źródła danych można dodawać zapytania do szablonu. Te zapytania określają, które elementy informacji są generowane w raporcie.Aby upewnić się, że otrzymywana jest kompletna lista zwracanych wartości
ze źródła danych kanału informacyjnego produktu
Rational Quality Manager,
należy ustawić typ schematu jako Ogólny XML i dodać łańcuch
?abbreviate=false na końcu identyfikatora URI. Przykład:
https://serwer_RQM:9443/qm/service/com.ibm.rqm.integration.service.IIntegrationService/resources/JKE
Banking (Quality Management)/testcase?abbreviate=false
- Po nawiązaniu połączenia ze schematem źródła danych można utworzyć lub zaimportować projekt szablonu. Za pomocą produktu Rational Publishing Engine Document Studio można zbudować projekt szablonu raportu. Ten projekt określa układ raportu. Patrz:
Tworzenie szablonów za pomocą aplikacji Document Studio.
- Zaplanuj strukturę dokumentu i zdefiniuj treść do wyodrębniania danych. Przegląd procesu projektowania szablonu jest zawarty w sekcji Projektowanie szablonów dokumentów. W przypadku dużych dokumentów można tworzyć osobne szablony dla każdego bloku dokumentu.
- 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.
Więcej szczegółów zawiera sekcja Elementy szablonu w widoku Paleta.
- Używaj zapytań, atrybutów i zmiennych w celu dodawania danych do szablonu.
- Za pomocą elementu Konfiguracja źródła danych można zdefiniować niektóre właściwości, które nie są znane w czasie wykonywania. Patrz sekcja Dodawanie elementu konfiguracji źródła danych. Na przykład schemat danych qm jest ustawiany dynamicznie na podstawie schematu danych 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.
- Istnieje możliwość używania filtrów, które są konkretnymi 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ć większej niż konieczna ilości informacji z repozytorium produktu Rational Quality Manager. 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 nie będzie zawierać kompletnych danych. Patrz sekcja Wyodrębnianie danych za pomocą filtru produktu Rational Publishing Engine.
- Po utworzeniu szablonu raportu i zapełnieniu go punktami danych produktu Rational Quality Manager można generować raporty w różnych formatach. Podczas generowania raportu konieczne jest nawiązanie połączenia ze źródłem danych zawierającym informacje, których ma dotyczyć raport. Należy określić identyfikator URI wskazujący repozytorium produktu Rational Quality Manager, które zawiera dane istotne. Informacje na temat wskazywania odpowiednich danych zawiera sekcja Nawiązywanie połączenia ze źródłem danych.
Uwaga: W
przypadku interfejsu API usług OSLC produktu
IBM Rational Quality Manager:
jeśli w specyfikacji dokumentu nie określono nagłówka Accept, domyślnie produkt
Rational Quality Manager
zwraca reprezentację HTML zasobów. Aby uzyskać dane XML, należy ustawić
wartość application/xml nagłówka Accept.
- Jeśli schematy źródła danych zostają dodane do szablonu po przypisaniu tego szablonu do specyfikacji dokumentu, specyfikacja dokumentu staje się niezsynchronizowana. Można zsynchronizować specyfikację dokumentu ręcznie lub wybrać opcję preferencji zapewniającą automatyczną synchronizację specyfikacji dokumentu z bieżącym szablonem. Informacje na temat ustawiania preferencji Czy utrzymać synchronizację specyfikacji dokumentu z bieżącym szablonem? zawiera sekcja Ustawianie preferencji projektowania dokumentów.
- Przed opublikowaniem dokumentu należy zapoznać się z tematem Określanie właściwości danych wyjściowych, aby uzyskać więcej informacji o dostępnych opcjach wyjściowych oraz o tym, które z nich są najlepsze w przypadku elementów używanych w szablonie.
- Można w tej chwili opublikować dokument. Patrz sekcja Generowanie dokumentu.