Navrhování šablon s produktem IBM Rational Team Concert 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 Team Concert a s různými adresami URL, jež jsou zapotřebí pro extrahování dat z produktu Rational Team Concert při použití produktu Rational Publishing Engine. Viz Wikiweb rozhraní API typu Reportable REST: Prostředky poskytované produktem Rational Team Concert.
Rozhraní API typu Reportable REST produktu Rational Team Concert se odlišuje od řady tradičních doménových rozhraní API. Místo poskytnutí adres URL prostředků, které odkazují na specifické položky, tj. například na jedinou pracovní položku nebo na jeden výsledek sestavení, rozhraní API typu Reportable REST poskytuje přístup k monolitickým prostředkům. Každý monolitický prostředek je kontejnerem, který představuje výsledek dotazu pro jeden či více prvků.
  • foundation: Společné artefakty, tj. například oblasti projektu, oblasti týmu, přispěvatelé, iterace a odkazy.
  • workitem: Artefakty pracovní položky, tj. například souhrny, kategorie, závažnosti a priority.
  • apt: Artefakty agilního plánování, tj. například kapacita týmu, plány prostředků a absence.
  • generic: Generické artefakty.
  • build: Artefakty sestavení, tj. například výsledky sestavení, příspěvky do výsledku sestavení, definice sestavení a sestavovací stroje.
  • scm: Artefakty řízení zdrojů, tj. například proudy a komponenty, jakož i rozdílová data velikosti proudu.
Tyto prostředky poskytují flexibilitu při filtrování a dotazování během získávání dat pro sestavu. Určitý prostředek pracovní položky může například obsahovat jeden nebo více prvků souvisejících s pracovními položkami v závislosti na dotazu nebo filtru odeslaném do rozhraní API REST.

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 Team Concert můžete zjistit schéma zdroje dat zadáním základní adresy URL do aplikace.
    1. V aplikaci Document Studio klepněte na volbu Data > Přidat schéma zdroje dat.
    2. V poli Typ schématu vyberte typ schématu v seznamu. Pro produkt Rational Team Concert vyberte hodnotu REST.
    3. Do pole Soubor schématu vložte adresu URL, kterou jste identifikovali jako schéma zdroje dat.
      • https://server:port/ccm/rpt/repository/foundation
      • https://server:port/ccm/rpt/repository/workitem
      • https://server:port/ccm/rpt/repository/apt
      • https://server:port/ccm/rpt/repository/generic
      • https://server:port/ccm/rpt/repository/scm
      • https://server:port/ccm/rpt/repository/build
    4. Připojte text ?metadata=schema na konec adresy URL.
      • Příklad: https://server:port/ccm/rpt/repository/workitem?metadata=schema
    5. Do pole ID zdroje dat zadejte název zdroje dat v šabloně. Klepněte na tlačítko Další.
    6. Pokud je prostředek na zabezpečeném serveru, zadejte Jméno uživatele.
    7. Pokud je prostředek na zabezpečeném serveru, zadejte Heslo.
    8. Ze seznamu vyberte Typ ověřování. Pro produkt Rational Team Concert je typ ověřování OAuth. Pokud nevyberete OAuth, je testován každý typ ověřování, dokud není nalezen správný typ, což může prodloužit dobu generování dokumentů.
    9. 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. Rational Team Concert podporuje použití zdrojů dat typu Reportable REST v1 v nativních filtrech. Další informace viz téma Vykazovatelné rozhraní API REST na Jazz.net. Příklad:
    [projectArea/name="JKESample"]/*
    Vyřešený požadavek:
    https://server:port/ccm/rpt/repository/workitem?fields=workitem/workItem[projectArea/name="JKESample"]/(@href|summary)
    Poznámka: K nativnímu filtrování nezle použít všechna pole.
  8. Vytvořte řazení, abyste organizovali data v sestavě.

Zpětná vazba