Sablonok tervezése IBM Rational Team Concert adatforrással

A jelentéstervezők a Document Studio alkalmazással importálhatnak adatforrássémákat és összeállíthatnak jelentéssablonokat.

Mielőtt elkezdené

Tipp: A Rational Publishing Engine telepítés minta jelentések készletét tartalmazza. Mielőtt megkezdené a dokumentumok közzétételét, tekintse át ezt a példa dokumentumelőállítási példahelyzetet. Tekintse meg a REST mintasablon létrehozása témakört.
Ismerje meg a Rational Team Concert REST szolgáltatást és a különféle URL címeket, amelyek szükségesek az adatok kinyeréséhez a Rational Team Concert termékből a Rational Publishing Engine használatakor. Lásd: Jelenthető REST API wiki: Rational Team Concert által biztosított erőforrások.
A Rational Team Concert jelenthető REST API eltér a számos hagyományos tartomány API felülettől. Ahelyett, hogy adott elemekre (például egyetlen munkaelemre vagy egyetlen összeépítési eredményre) mutató erőforrás URL címeket biztosítana, a jelenthető REST API egynemű erőforrásokhoz nyújt hozzáférést. Minden egyes egynemű erőforrás egy-egy tároló, amely egy vagy több elem lekérdezésének eredményeit ábrázolja.
  • foundation: Általános műtermékek, mint például projektterületek, csapatterületek, közreműködők, iterációk és hivatkozások.
  • workitem: Munkaelem műtermékek, mint például összegzések, kategóriák, súlyosságok és prioritások.
  • apt: Agilis tervezési műtermékek, mint például csapat kapacitás és erőforrás ütemezések, valamint távollétek.
  • generic: Általános műtermékek.
  • build: Összeépítési műtermékek, mint például összeépítési eredmények, összeépítési eredmény hozzájárulások, összeépítés-meghatározások és összeépítési alrendszerek.
  • scm: Forrásvezérlő műtermékek, mint például folyamok és komponensek, valamint folyamméret különbözetek.
Ezek az erőforrások rugalmasságot szűrési és lekérdezési biztosítanak a jelentés adatainak összegyűjtésekor. Például egy munkaelem erőforrás tartalmazhat a munkaelemekhez kapcsolódó elem(ek)et, a REST API számára átadott lekérdezéstől/szűrőtől függően.

Erről a feladatról

Az adatok kinyerése a REST API használatával történik. Ezt a felületet az alkalmazás telepíti és valósítja meg, és a Rational Publishing Engine terméktől függetlenül működik. Az adatforrások REST alkalmazásprogramozási felületével kapcsolatos további információkért tekintse meg az adatforrás dokumentációját.

Eljárás

  1. A sablonfejlesztési folyamat áttekintéséről itt olvashat: Dokumentumsablonok tervezése. Kezdje meg a dokumentum és az esetleg tartalmazott adatok szerkezetének megtervezését. Döntse el például, hogy a végleges dokumentum egyetlen sablonból kerül előállításra vagy több olyan sablonfájlból, amelyek mindegyike újrafelhasználható tartalomrészeket tartalmaz.
  2. A Document Studio alkalmazásban hozzon létre egy dokumentumsablont.
  3. Adjon hozzá egy adatforrássémát a dokumentumsablonhoz. A Rational Team Concert esetében az adatforrássémát az alkalmazás alap URL címét beírva térképezheti fel.
    1. A Document Studio alkalmazásban kattintson az Adatok > Adatforrásséma felvétele menüpontra.
    2. A Séma típusa elemnél válassza ki a séma típusát a listából. Rational Team Concert esetén válassza ki a REST elemet.
    3. A Sémafájl mezőbe illessze be az adatforrássémaként azonosított URL címet.
      • https://kiszolgáló:port/ccm/rpt/repository/foundation
      • https://kiszolgáló:port/ccm/rpt/repository/workitem
      • https://kiszolgáló:port/ccm/rpt/repository/apt
      • https://kiszolgáló:port/ccm/rpt/repository/generic
      • https://kiszolgáló:port/ccm/rpt/repository/scm
      • https://kiszolgáló:port/ccm/rpt/repository/build
    4. Fűzze hozzá a ?metadata=schema utótagot az URL cím végéhez.
      • Példa: https://kiszolgáló:port/ccm/rpt/repository/workitem?metadata=schema
    5. Az Adatforrás azonosítója mezőbe írja be az adatforrásnak a sablonban szereplő nevét. Kattintson a Tovább gombra.
    6. Ha az erőforrás biztonságos kiszolgáló, akkor adja meg a Felhasználónevet.
    7. Ha az erőforrás biztonságos kiszolgáló, akkor adja meg a Jelszót.
    8. Válassza ki a Hitelesítéstípust a listából. Rational Team Concert esetén a hitelesítési típus OAuth. Ha nem választja ki az OAuth típust, akkor minden egyes hitelesítési típus tesztelésre kerül, amíg a rendszer meg nem találja a helyes típust, ami megnövelheti a dokumentumok előállítási idejét.
    9. Kattintson a Befejezés gombra. A kiválasztott adatforrásséma megjelenik az Adatforrásséma nézetben.
  4. Vegyen fel elemeket a sablonba. A Rational Publishing Engine a sablonelemek átfogó készletével rendelkezik a dokumentum szerkezetének kialakításához. Az elemeket húzással viheti a sablontartalom-szerkesztőbe. Felvehet például egy Tároló elemet, amely több bekezdést tárol. Minden egyes bekezdést egy-egy tesztfeltétel vezérelhet, amely csak bizonyos adatokhoz társítja azt. További információkért lásd: Sablonelemek a Paletta nézetben és Elemek hozzáadása sablonhoz.
  5. lekérdezések, attribútumok és változók használatával vehet fel adatokat a sablonokba. Ezek az elemek határozzák meg. milyen információk kerülnek a jelentésben előállításra.
  6. Az elemek megjelenését a kimenetben formázás és stílus hozzáadásával állíthatja be.
  7. Szűrők létrehozásával szűkítse le a jelentésbe bekerülő adatokat. Használhat az általános adatforrás URI azonosítóknál részletesebb szűrőket az adatok egy adott részhalmazának megjelöléséhez, hogy a jelentés előállítása során a Rational Publishing Engine ne kíséreljen meg a szükségesnél több információt lekérni az adatforrásból. Ezeknek a szűrőknek elég tágaknak kell lenniük ahhoz, hogy a sablon által hivatkozott valamennyi szükséges adat lekérhető legyen, máskülönben nem tud teljes adatokat befoglalni az előállított jelentésbe. Rational Team Concert támogatja a Jelenthető Rest v1 adatforrások használatát a natív szűrőkben. További információkért lásd: Jelenthető REST API a Jazz.net oldalon. Például:
    [projectArea/name="JKESample"]/*
    Feloldott kérés:
    https://server:port/ccm/rpt/repository/workitem?fields=workitem/workItem[projectArea/name="JKESample"]/(@href|summary)
    Megjegyzés: Nem minden mező használható natív szűréshez.
  8. Rendezések létrehozásával rendszerezze a jelentésben szereplő adatokat.

Visszajelzés