Navrhování šablon s produktem Rational ClearQuest jako zdrojem dat

Návrháři sestav mohou používat produkt Document Studio k importování schémat zdrojů dat a k vytváření šablon sestav.

Než začnete

Tip: Instalace produktu Rational Publishing Engine zahrnuje sadu ukázkových sestav. Než začnete s publikováním dokumentů, můžete prozkoumat tento ukázkový scénář generování dokumentů. Viz Vytváření ukázkové šablony REST.
Obeznamte se se službou REST Rational ClearQuest a s různými adresami URL, jež jsou zapotřebí pro extrahování dat z produktu Rational ClearQuest při použití produktu Rational Publishing Engine. Viz text Informačního centra O produktu Rational ClearQuest.

Informace o této úloze

Data jsou extrahována pomocí rozhraní REST API. Toto rozhraní je instalováno a implementováno pomocí aplikace zdroje dat a pracuje nezávisle na produktu Rational Publishing Engine. Chcete-li získat další informace o rozhraní REST API zdroje dat, viz dokumentace tohoto zdroje dat.

Postup

  1. V tématu Návrh šablon dokumentu vyhledáte přehled procesu vývoje šablon. Spusťte plánování struktury vašeho dokumentu a dat, která mohou být zahrnuta. Rozhodněte se například, zda bude konečný dokument generován z jedné šablony nebo z více souborů šablon obsahujících znovu použitelné části obsahu.
  2. V aplikaci Document Studio vytvořte šablonu dokumentu.
  3. Přidejte schéma zdroje dat do šablony dokumentu. Pro produkt Rational ClearQuest můžete zjistit schéma zdroje dat zadáním základní adresy URL do aplikace.
    1. Otevřete průvodce zjišťováním schématu, který se používá pro vaši verzi produktu Rational ClearQuest
      • Pro dřívější verze produktu Rational ClearQuest používající REST v1 klepněte na volbu Data > Zjišťování schématu > Zjišťování schématu REST.
      • Pro novější verze produktu Rational ClearQuest používající REST v2 klepněte na volbu Data > Zjišťování schématu > Zjišťování schématu REST v2.
    2. Zadejte Základní adresu URL prostředku.
      • Pro verze REST v1 produktu Rational ClearQuest platí, že produkt Rational Publishing Engine používá datové služby Rational ke zjištění schématu a k dotazování dat. Základní adresa URL pro datové služby je: https://server:port/DataServices/ClearQuest
      • Pro verze REST v2 produktu Rational ClearQuest platí, že jsou spuštěny z adresy URL ServiceProvider. Uživatelé mohou získat adresu URL ServiceProvider na adrese URL komponenty ServiceCatalog nástroje Rational ClearQuest REST v2, např. https://server:port/context/oslc. Nastavte záhlaví HTTP OSLC-Core-Version na hodnotu 2.0 a přijměte hodnotu application/rdf+xml. Ve vráceném výsledku naleznete adresu URL ServiceProvider rdf:about.
        Pokud používáte rozhraní API REST v2 ke generování dokumentu, musíte poskytnout adresu URL schématu zdroje dat poskytovateli služeb spíše než kořenovému záznamu. Příklad:
        • Nesprávně: https://server:port/cqweb/oslc
        • Správně: https://server:port/cqweb/oslc/repo/úložiště/db/úložiště_schématu/
    3. Ze seznamu vyberte Typ ověřování. Pokud nevyberete typ, je testován každý typ, dokud není nalezen správný typ, což může prodloužit dobu generování dokumentu.
    4. Pokud je prostředek na zabezpečeném serveru, zadejte Jméno uživatele.
    5. Pokud je prostředek na zabezpečeném serveru, zadejte Heslo.
    6. Klepněte na tlačítko Další. K vámi zadané základní adrese URL je automaticky připojen text ?metadata=schema. Příklad: https://server:port/service/cq/records/defects?metadata=schema
    7. Klepněte na tlačítko Dokončit. Vámi vybrané schéma zdroje dat se zobrazí v pohledu Schéma zdroje dat.
  4. Přidejte prvky do šablony. Produkt Rational Publishing Engine je vybaven rozsáhlou sadou prvků šablon, jež můžete použít k vytvoření struktury svého dokumentu. Prvky můžete přetahovat myší do editoru obsahu šablony. Například, můžete přidat prvek Kontejner, abyste uchovali některé odstavce. Každý odstavec může být řízen testovací podmínkou, která mu přidružuje pouze specifická data. Další informace viz Prvky šablony v pohledu Paleta a Přidání prvků do šablony.
  5. Použijte dotazy, atributy a proměnné, abyste přidali data do šablony. Tyto položky určují, které části informací budou generovány v sestavě.
  6. Přidejte formátování a stylizaci do prvků pro kontrolu zobrazení ve výstupu.
  7. Vytvořte filtry, abyste zúžili data stažená do sestavy. Můžete používat filtry, které jsou podrobné verze obecného identifikátoru URI zdroje dat, k odkazování na specifické podmnožiny dat tak, aby se při generování sestavy produkt Rational Publishing Engine nepokoušel o načítání více informací ze zdroje dat, než je nezbytné. Tyto filtry musejí být dostatečně široké, aby došlo k načtení všech nezbytných dat, na něž odkazuje šablona, jinak vygenerovaná sestava nebude obsahovat kompletní data.

    Adaptér produktu Rational ClearQuest podporuje nativní filtrování ze zdrojů dat typu Reportable Rest v1. V nativních filtrech typu Reportable REST v1 je třeba pouze zadat text do hranatých závorek []. Zbytek filtru vygeneruje produkt Rational Publishing Engine. Další informace viz téma Rozhraní typu Reportable Rest v1.

    Produkt Rational ClearQuest verze 8 bez adaptéru podporuje nativní filtrování ze zdrojů dat typu Reportable REST v2. Chcete-li získat další informace, viz Rational ClearQuest OSLC CM REST API .

    Ukázka filtru s proměnnou:
    cq:Product{cq:Product="${název_produktu}") 
    Ukázka vyřešeného filtru, kde název_produktu je Rational Publishing Engine:
    cq:Product{cq:Product="Rational Publishing Engine")
    Poznámka:
    • Požadavky na zdroj dat jsou vznášeny pouze podle potřeby. Pomocí podmínek například můžete zobrazit prvek ve výstupu pouze, pokud obsahuje data. Podmínka na kontejnerovém prvku může vypadat takto: proměnná == "true". Není-li tato podmínka splněna a podmínku proměnné nesplňují žádná data, na zdroj dat nejsou vzneseny žádné požadavky.
    • Před provedením požadavku můžete vypočítat nativní filtry. Nativní filtr se počítá v okamžiku, kdy je rozpoznán dotaz a používá hodnoty proměnných v tomto okamžiku. To znamená, že výpočty můžete provádět v šabloně, což má dopad na nativní filtry.
  8. Vytvořte řazení, abyste organizovali data v sestavě.

Zpětná vazba