Přidání schématu zdroje dat REST průvodcem zjišťování schématu

Schéma zdroje dat lze vytvořit i pro zdroj dat REST. Vytvoření schématu zjednodušuje tvorbu obsahu šablon dokumentů pro moduly se stejnou strukturou a se stejným nebo podobným seznamem atributů.

Informace o této úloze

Pokud k vytváření schémat zdrojů dat používáte průvodce Zjišťování schématu, můžete si vybrat ze dvou voleb typu Reportable REST, které by mohla vaše aplikace podporovat, a to buď rozhraní REST API 1.0, nebo rozhraní REST API 2.0. Obraťte se na svého administrátora systému, pokud nevíte, kterou verzi rozhraní REST API vaše aplikace podporuje.

Zjišťování schématu (REST API 1.0)

Informace o této úloze

Poznámka: Dokončení této úlohy vám pomůže vyhledat schéma v produktu Rational Team Concert a zdroje dat pomocí modulu Aplikace datových služeb. U dalších aplikacích založených na technologii REST se podívejte do dokumentace produktu a najděte v ní informace o generování schémat.

Postup

  1. V aplikaci Document Studio klepněte na volbu Data > Zjišťování schématu > Zjišťování schématu REST.
  2. Zadejte podrobnosti o připojení:
    1. Název: Zadejte název zdroje dat.
    2. Popis: Zadejte popis zdroje dat.
    3. Základní adresa URL: Zadejte základní adresu URL prostředku.
    4. Typ ověřování: Vyberte ze seznamu typ ověřování.
    5. Uživatel: Pokud je prostředek na zabezpečeném serveru, zadejte jméno uživatele.
    6. Heslo: Pokud je prostředek na zabezpečeném serveru, zadejte heslo.
  3. Klepněte na tlačítko Další.
  4. V okně Vytvořit prostředek zadejte podrobnosti pro nový prostředek:
    1. Název: Zadejte název nového prostředku.
    2. Popis: Zadejte popis nového prostředku.
    3. Relativní cesta: Zadejte relativní cestu k novému prostředku.
    Pokud je zdroj dat REST dostupný prostřednictvím modulu Adaptéry služby Reporting Data Services, vyberte k vyhledání prostředku volbu Vyhledat pomocí datové služby. Navigace prostředků je k dispozici pro prostředky, které mají atribut href. Prostředek najdete rozbalením seznamu.
  5. Výběr prostředků:
    1. Vyberte prvek ve stromu schématu XML.
    2. Ze seznamu atributů vyberte hodnotu href.
    3. Klepněte na tlačítko Další. Zobrazí se adresa URL vybraného prostředku.
  6. Vyberte adresu URL a klepněte na tlačítko Dokončit nebo pomocí adresy URL vyhledejte podřízený prostředek. Vyhledání podřízeného prostředku:
    1. Vyberte adresu URL a klepněte na tlačítko Další.
    2. Vyberte prvek ve stromu schématu XML.
    3. Ze seznamu atributů vyberte hodnotu href.
  7. Klepněte na tlačítko Dokončit. Průvodce se dokončí a zobrazí adresu URL v okně Konfigurace. Pokud je prostředek na zabezpečeném serveru, zadejte do konfiguračního okna jméno a heslo uživatele.

Jak pokračovat dále

Přidejte toto schéma do šablony. Viz téma Přidání schémat zdrojů dat.

Zjišťování schématu (REST API 2.0)

Informace o této úloze

Poznámka: Produkt Rational Publishing Engine podporuje pouze zkrácený formát RDF. Poskytovatelé musí přijmout a dodržovat požadavky application/xml. Viz téma Základní specifikace Open Services for Lifecycle Collaboration verze 2.0.
Produkt Rational Publishing Engine podporuje pouze poskytovatele OSLC v2, kteří postupují podle specifikace Reportable REST v2 Specification.
  • Služba OSLC musí mít schopnosti dotazování definované v prostředku služby pro všechny prostředky, které jsou určené pro tvorbu sestav.
  • Každá schopnost dotazování pro tvorbu sestav:
    • Musí mít odkaz oslc:queryBase, který ukazuje na prostředek se seznamem prostředků určených pro tvorbu sestav. Prostředky v seznamu musí být označeny jako oslc:isMemberProperty v prostředku tvaru prostředku (Resource Shape Resource) prostředku seznamu.
    • Musí mít specifikaci oslc:resourceShape, která popisuje prostředek seznamu.

Postup

  1. Klepněte na volbu Data > Zjišťování schématu > Zjišťování schématu REST v2.
  2. Zadejte podrobnosti o připojení:
    1. Základní adresa URL: Zadejte základní adresu URL prostředku.
      Musíte znát adresu URL poskytovatele služby, kterého chcete akceptovat. Tato adresa URL je protějškem adresy URL modulu Aplikace datových služeb pro zdroj dat REST schopný tvorby sestav. Produkt Rational Publishing Engine načítá data ze zdroje dat jako seznam dotazů. Tyto prostředky ukládá služba, ve které se lze na data dotazovat a interpretovat. Služba poskytuje také dotazovací službu, která pomáhá filtrovat data podle nastavené podmínky nebo upřesnit podmnožiny dat. Tyto dotazy jsou určeny pro daný typ prostředku a umožňují vám přistupovat k prostředku specifického typu. Služba ID2 schopná tvorby sestav může vystavovat řadu typ prostředků, jako např. požadavky na změnu produktu nebo uživatele. Služba dotazu pomáhá uživateli načítat data efektivně nebo jako podmnožinu dat, ale to není povinné. Služba dotazu je k dispozici pro všechny prostředky. Každý produkt může definovat vlastní prostředky a dotazy pro přístup k těmto prostředkům.
    2. Typ ověřování: Vyberte ze seznamu typ ověřování.
    3. Uživatel: Pokud je prostředek na zabezpečeném serveru, zadejte jméno uživatele.
    4. Heslo: Pokud je prostředek na zabezpečeném serveru, zadejte heslo.
  3. Klepněte na tlačítko Další.
  4. Vyberte službu REST v2 a k ní příslušný dotaz a klepněte na tlačítko Další. Zobrazí se vlastnosti vybraných služeb.
  5. V seznamu označte požadované vlastnosti a klepněte na volbu Testovat oslc.select. Okno Potvrzení výsledku zobrazí vybrané služby. Potvrďte, že služby jsou správně. Když klepnete na tlačítko Správně, změní se stav pole Testovat oslc.select na hodnotu true. Klepněte na tlačítko Další.

    Pole Testovat oslc.properties se nepoužívá často.

  6. Do polí Dotaz obsahuje klauzuli oslc.where a Dotaz obsahuje klauzuli oslc.orderBy musíte zadat pouze filtr nebo klauzuli řazení dotazu, jako např. cq:Product{cq:Product="Rational Publishing Engine"}.
  7. Klepnutím na volbu Testovat oslc.where a Testovat oslc.orderBy ověříte připojení. Produkt Rational Publishing Engine vytváří pomocí definovaných voleb úplný požadavek.
  8. Klepněte na tlačítko Další. Zobrazí se shrnutí vašeho dotazu. Klepněte na tlačítko Dokončit. Průvodce se dokončí a zobrazí adresu URL v okně Konfigurace. Je-li prostředek na zabezpečeném serveru, můžete v okně Konfigurace zadat jméno a heslo uživatele.

Zpětná vazba