Sablonok tervezése Rational Focal Point 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 Focal Point REST szolgáltatást és a különféle URL címeket, amelyek szükségesek az adatok kinyeréséhez a Rational Focal Point termékből a Rational Publishing Engine használatakor. A használt Rational Focal Point változathoz tartozó információs központ megkereséséhez nézze meg az alábbi részt: Rational Focal Point információs központok 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. Azonosítson be egy adatforrássémát az adatforrásból. Ha bizonyos adatrészeket kíván a Rational Focal Point projektből hozzáadni vagy egyetlen, ismert URL című erőforrást kíván elérni, akkor hozzon létre resources argumentumot használó URL címet. Nyissa meg az adatforrássémát, és az XML fájlból vegye az adott erőforrás URI-ját.
    • Példa: http://server:port/fp/resources
    Megjegyzés: A Rational Focal Point sémák az alkalmazás egyes telepítéseire jellemzőek. Ez azt jelenti, hogy egy Rational Focal Point kiszolgálóhoz létrehozott sablon nem használható fel újra egy másik Rational Focal Point kiszolgálón.
    Ha a Rational Requirements Composer Reportable REST API.-t használja, akkor az URL címet a következő formátumban adja meg:
    • https://kiszolgáló:port/rm/publish/artifact
  4. Adjon hozzá egy adatforrássémát a dokumentumsablonhoz. Rational Focal Point esetén tegye a következőket:
    1. A Document Studio alkalmazásban kattintson az Adatok > Adatforrásséma felvétele menüpontra.
    2. A Típus részben válassza ki a séma típusát a listából. Rational Focal Point esetén válassza ki az Általános XML elemet.
    3. A Sémafájl mezőbe illessze be az adatforrássémaként azonosított URL címet.
    4. Fűzze hozzá a ?metadata=schema utótagot az URL cím végéhez.
      • Példa: http://kiszolgáló:port/fp/resources?metadata=schema
      Ha a Rational Requirements Composer Reportable REST API.-t használja, akkor az URL címet a következő formátumban adja meg:
      • Például: https://kiszolgáló:port/rm/publish/artifact?metadata=schema
    5. Ha az erőforrás biztonságos kiszolgáló, akkor adja meg a Felhasználónevet.
    6. Ha az erőforrás biztonságos kiszolgáló, akkor adja meg a Jelszót.
    7. Válassza ki a Hitelesítéstípust a listából. Rational Focal Point 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.
  5. 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.
  6. 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.
  7. Az elemek megjelenését a kimenetben formázás és stílus hozzáadásával állíthatja be.
  8. 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.
  9. Rendezések létrehozásával rendszerezze a jelentésben szereplő adatokat.

Visszajelzés