REST adatforrásséma hozzáadása a sémafeltérképezési varázslóval

Lehetősége van adatforrásséma létrehozására a REST adatforrásokhoz. A séma létrehozása leegyszerűsíti a dokumentumsablonok készítését az olyan modulokhoz, amelyeknek ugyanaz a szerkezetséma és ugyanaz vagy hasonló az attribútumlistája.

Erről a feladatról

Amikor a Sémafeltérképezés varázslóval hoz létre adatforrássémákat, akkor választhat a két jelenthető REST beállítás közül, amelyet az alkalmazás támogathat: REST API 1.0 vagy REST API 2.0. Ha nem tudja, hogy az adott alkalmazás melyik REST API változatot támogatja, akkor egyeztessen a rendszeradminisztrátorral.

Sémafeltérképezés (REST API 1.0)

Erről a feladatról

Megjegyzés: Ez a feladat segíti a séma megkeresését a Rational Team Concert alkalmazásban és az adatforrásokban az Adatszolgáltatás alkalmazás használatával. Egyéb REST alapú alkalmazásoknál a termékdokumentációban talál a sémák előállításával kapcsolatos információkat.

Eljárás

  1. A Document Studio alkalmazásban kattintson az Adatok > Sémafeltérképezés > REST sémafeltérképezés menüpontra.
  2. Adja meg a kapcsolat részleteit:
    1. Név: Adja meg az adatforrás nevét.
    2. Leírás: Adja meg az adatforrás leírását.
    3. Alap URL: Adja meg az erőforrás alap URL címét.
    4. Hitelesítési típus: Válassza ki a hitelesítési típust a listából.
    5. Felhasználó: Ha az erőforrás védett kiszolgálón található, akkor adja meg a felhasználónevet.
    6. Jelszó Ha az erőforrás védett kiszolgálón található, akkor adja meg a jelszót.
  3. Kattintson a Tovább gombra.
  4. Az Erőforrás létrehozása ablakban adja meg az új erőforrás részleteit:
    1. Név: Adja meg az új erőforrás nevét.
    2. Leírás: Adja meg az új erőforrás leírását.
    3. Relatív elérési út: Adja meg az új erőforrás relatív elérési útját.
    Ha a REST adatforrás az Jelentéskészítési adatszolgáltatás illesztők terméken keresztül érhető el, akkor kattintson a Megkeresés adatszolgáltatás használatával lehetőségre az adatforrás megkereséséhez. A href attribútummal rendelkező erőforrásokhoz elérhető erőforrás-navigáció. Bontsa ki a listát és keresse meg az erőforrást.
  5. Az erőforrások kiválasztása:
    1. Válasszon ki egy elemet az XML sémafában.
    2. Válassza ki a href értéket az attribútumok listájából.
    3. Kattintson a Tovább gombra. Megjelenik a kiválasztott erőforráshoz tartozó erőforrás URL cím.
  6. Válassza ki az URL címet, és kattintson a Befejezés gombra, vagy az URL felhasználásával keresse meg az utód erőforrást. Az utód erőforrás megkeresése:
    1. Jelölje ki az erőforrás URL címet, és kattintson a Tovább gombra.
    2. Válasszon ki egy elemet az XML sémafában.
    3. Válassza ki a href értéket az attribútumok listájából.
  7. Kattintson a Befejezés gombra. Befejeződik a varázsló és megjelenik az URL cím a Konfiguráció ablakban. Ha az erőforrás védett kiszolgálón található, akkor a Konfiguráció ablakban adjon meg egy felhasználónevet és jelszót.

Mi a következő lépés?

Vegye fel a sémát a sablonba. Lásd: Adatforrássémák felvétele

Sémafeltérképezés (REST API 2.0)

Erről a feladatról

Megjegyzés: A Rational Publishing Engine csak a rövidített RDF-et támogatja. A szolgáltatóknak el kell fogadniuk és teljesíteniük kell az application/xml kéréseket. Lásd: Open Services for Lifecycle Collaboration Core Specification Version 2.0.
A Rational Publishing Engine csak azokat az OSLC v2 szolgáltatókat támogatja, amelyek követik a Reportable REST v2 specifikációt.
  • Az OSLC szolgáltatásokhoz meg kell határozni a lekérdezési képességeket a szolgáltatás-erőforrásban a jelentéskészítéshez szánt összes erőforrásnál.
  • Minden egyes lekérdezési képességnek a jelentéskészítéshez:
    • Rendelkeznie kell oslc:queryBase elemmel, mely arra az erőforrásra mutat, ahol a jelentéskészítéshez szánt erőforrások listája van. A listában szereplő erőforrásokat oslc:isMemberProperty formában kell azonosítani a lista erőforrás erőforrásalakzat erőforrásában.
    • Rendelkeznie kell oslc:resourceShape elemmel, amely leírja a lista erőforrást.

Eljárás

  1. Kattintson az Adatok > Sémafeltérképezés > REST v2 sémafeltérképezés menüpontra.
  2. Adja meg a kapcsolat részleteit:
    1. Alap URL: Adja meg az erőforrás alap URL címét.
      Ismernie kell az elfogadni kívánt szolgáltató URL címét. Ez az URL a jelenthető REST adatforráshoz tartozó Adatszolgáltatás alkalmazás URL párja. A Rational Publishing Engine lekérdezések listájával hívja le az adatokat az adatforrásból. Ezeket az erőforrásokat az a szolgáltatás tárolja, amelyből lekérdezhetők és értelmezhetők az adatok. A szolgáltatás lekérdezési szolgáltatást is biztosít, melynek használatával szűrheti az adatokat egy beállított feltétel szerint vagy finomíthatja az adatok részhalmazait. Ezek a lekérdezések erőforrástípusra vonatkoznak és lehetővé teszik egy adott típusba tartozó erőforrások elérését. A jelenthető ID2 szolgáltatás számos erőforrástípust tud exponálni, például termék vagy felhasználó általi módosítási kérést. A lekérdezési szolgáltatás segít a felhasználónak az adatok hatékony lekérésében vagy az adatok részhalmazának kinyerésében, de nem kötelező. A lekérdezési szolgáltatás minden erőforráshoz létezik. Minden termék meg tudja határozni az erőforrásait és a lekérdezéseket ezeknek az erőforrásoknak az eléréséhez.
    2. Hitelesítési típus: Válassza ki a hitelesítési típust a listából.
    3. Felhasználó: Ha az erőforrás védett kiszolgálón található, akkor adja meg a felhasználónevet.
    4. Jelszó Ha az erőforrás védett kiszolgálón található, akkor adja meg a jelszót.
  3. Kattintson a Tovább gombra.
  4. Válasszon ki egy REST v2 szolgáltatást és a hozzá tartozó lekérdezést, és kattintson a Tovább gombra. Megjelennek a kiválasztott szolgáltatások tulajdonságai.
  5. Válassza ki a szükséges tulajdonságokat a listából, majd kattintson az oslc.select tesztelése gombra. Az Eredmény megerősítése ablak megjeleníti a kiválasztott szolgáltatásokat. Erősítse meg, hogy a szolgáltatások helyesek. Ha a Helyes gombra kattint, akkor az oslc.select tesztelése mező állapota true lesz. Kattintson a Tovább gombra.

    Az oslc.properties tesztelése mező ritkán használatos.

  6. A lekérdezésnek csak a szűrő vagy rendezés részkifejezését (például cq:Product{cq:Product="Rational Publishing Engine"}) kell beírni a Lekérdezés include oslc.where részkifejezése, illetve Lekérdezés include oslc.orderBy részkifejezése mezőbe.
  7. Kattintson az oslc.where tesztelése, illetve az oslc.orderBy tesztelése gombra a kapcsolat teszteléséhez. A Rational Publishing Engine létrehozza a teljes kérést a meghatározott beállítások felhasználásával.
  8. Kattintson a Tovább gombra. Megjelenik a lekérdezés összegzése. Kattintson a Befejezés gombra. Befejeződik a varázsló és megjelenik az URL cím a Konfiguráció ablakban. Ha az erőforrás egy védett kiszolgálón van, akkor adjon meg egy felhasználónevet és jelszót a Konfiguráció ablakban.

Visszajelzés