Navrhování šablon s produktem Rational Quality Manager 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 produktu Rational Quality Manager a s různými adresami URL, jež jsou zapotřebí pro extrahování dat z produktu Rational Quality Manager při použití produktu Rational Publishing Engine. Viz dokumentaci rozhraní API REST Rational Quality Manager.

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. Identifikujte schéma zdroje dat ze zdroje dat.
    • Chcete-li přidat specifické části dat z kolekce z projektu produktu Rational Quality Manager, jako jsou například podrobnosti testovacího případu nebo testovací skripty, nebo přistoupit k jedinému prostředku pomocí známé adresy URL, vytvořte adresu URL používající argument feed. Vždy použijete toto schéma a dynamicky je nakonfigurujete pro specifické části dat ve své šabloně z projektu Rational Quality Manager.
      • Příklad: https://server:port/qm/service/com.ibm.rqm.integration.service.IIntegrationService/schema/feed.xsd
    • Chcete-li přidat specifické části dat z individuálního prostředku z projektu produktu Rational Quality Manager, jako jsou například podrobnosti testovacího případu nebo testovací skripty, nebo přistoupit k jedinému prostředku pomocí známé adresy URL, vytvořte adresu URL používající argument qm.
      • Příklad: https://server:port/qm/service/com.ibm.rqm.integration.service.IIntegrationService/schema/qm.xsd
    • Pokud používáte rozhraní API REST v2 ke generování dokumentů, musíte poskytnout adresu URL schématu zdroje dat poskytovateli služeb spíše než kořenovému záznamu. Příklad:
      • Chybná: https://server:port/qm/oslc_qm/catalog
      • Správná: https://server:port/qm/oslc_qm/catalog/repository/db/schema_repository/
  4. Přidejte schéma zdroje dat do šablony dokumentu. Pro produkt Rational Quality Manager můžete postupovat následujícím způsobem:
    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 Quality Manager vyberte hodnotu Generické XML.
    3. Do pole Soubor schématu vložte adresu URL, kterou jste identifikovali jako schéma zdroje dat.
    4. Připojte text ?abbreviate=false na konec adresy URL.
      • Příklad: https://server:port/qm/service/com.ibm.rqm.integration.service.IIntegrationService/resources/JKE Banking (Quality Management)/testcase?abbreviate=false
    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 Quality Manager 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ů.
  5. 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.
  6. 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ě.
  7. Přidejte formátování a stylizaci do prvků pro kontrolu zobrazení ve výstupu.
  8. 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. Další informace viz Rational Quality Manager Přiznatelné rozhraní API REST .
  9. Vytvořte řazení, abyste organizovali data v sestavě.

Zpětná vazba