Sablonok tervezése Rational ClearQuest 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 ClearQuest REST szolgáltatást és a különféle URL címeket, amelyek szükségesek az adatok kinyeréséhez a Rational ClearQuest termékből a Rational Publishing Engine használatakor. További információkat itt talál: Rational ClearQuest információs központ bemutatása.

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 ClearQuest esetében az adatforrássémát az alkalmazás alap URL címét beírva térképezheti fel.
    1. Nyissa meg a Rational ClearQuest változatához tartozó sémafeltérképezési varázslót.
      • A REST v1 változatot használó korai Rational ClearQuest változatok esetében kattintson az Adatok > Sémafeltérképezés > REST sémafeltérképezés lehetőségre.
      • A REST v2 változatot használó későbbi Rational ClearQuest változatok esetében kattintson az Adatok > Sémafeltérképezés > REST v2 sémafeltérképezés lehetőségre.
    2. Adja meg az erőforrás Alap URL címét.
      • A REST v1 Rational ClearQuest változatok esetében a Rational Publishing Engine Rational Data Services segítségével térképezi fel a séma és lekérdezés adatokat. Az adatszolgáltatás alap URL címe a következő: https://kiszolgáló:port/DataServices/ClearQuest
      • A REST v2 Rational ClearQuest változatok esetében kezdje a ServiceProvider URL beszerzésével. A felhasználók a ServiceProvider URL címet a Rational ClearQuest REST v2 ServiceCatalog URL felkeresésével szerezhetik meg; például: https://kiszolgáló:port/context/oslc. Állítsa az OSLC-Core-Version HTTP fejléceket 2.0-ra, és fogadja el a következőt: application/rdf+xml. A visszaadott eredményben megtalálható a ServiceProvider URL: rdf:about.
        Ha a dokumentum előállításához a REST v2 alkalmazásprogramozási felületeket használja, akkor a szolgáltató adatforrásséma URL címét kell megadnia, nem a gyökérbejegyzését. Például:
        • Helytelen: https://kiszolgáló:port/cqweb/oslc
        • Helyes: https://kiszolgáló:port/cqweb/oslc/repo/lerakat/db/séma_lerakat/
    3. Válassza ki a Hitelesítéstípust a listából. Ha nem ad meg típust, akkor minden egyes 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.
    4. Ha az erőforrás biztonságos kiszolgáló, akkor adja meg a Felhasználónevet.
    5. Ha az erőforrás biztonságos kiszolgáló, akkor adja meg a Jelszót.
    6. Kattintson a Tovább gombra. A beírt alap URL címhez a rendszer automatikusan hozzáfűzi a ?metadata=schema utótagot. Például: https://kiszolgáló:port/service/cq/records/defects?metadata=schema
    7. 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.

    A Rational ClearQuest adapter támogatja a natív szűrést a Jelenthető Rest v1 adatforrásokból. A Jelenthető Rest v1 natív szűrőkben csak a szögletes zárójelek [] közötti szöveget kell megadnia. A Rational Publishing Engine előállítja a szűrő többi részét. További információkért lásd: Jelenthető Rest v1.

    A Rational ClearQuest 8-as, illesztő nélküli változata támogatja a natív szűrést a Reportable Rest v2 adatforrásokból. További információkért lásd: Rational ClearQuest OSLC CM REST API .

    Minta változószűrő:
    cq:Product{cq:Product="${productName}") 
    Minta feloldott szűrő, ahol a productName: Rational Publishing Engine:
    cq:Product{cq:Product="Rational Publishing Engine")
    Megjegyzés:
    • A rendszer csak akkor intéz kéréseket az adatforrásokhoz, ha szükséges. Például tegyük fel, hogy feltételekkel beállította, hogy egy elem csak akkor jelenjen meg a kimenetben, ha tartalmaz adatokat. A tároló elemhez tartozó feltétel lehet a következő: változó == "true". Ha nem teljesül a feltétel és nincs a változófeltételnek megfelelő adat, akkor a rendszer nem intéz kéréseket az adatforráshoz.
    • A kérés előtt lehetősége van natív szűrők kiszámítására. A natív szűrők kiszámítására a lekérdezéskor kerül sor, az akkori változóértékek felhasználásával. Így lehetősége van számításokat végezni a sablonban, ami hatással van a natív szűrőkre.
  8. Rendezések létrehozásával rendszerezze a jelentésben szereplő adatokat.

Visszajelzés