REST-Datenquellenschema mit dem Schemaerkennungsassistenten hinzufügen

Für eine REST-Datenquelle kann ein Datenquellenschema erstellt werden. Die Datenquellenschemas vereinfachen das Authoring von Dokumentvorlagen für Module mit derselben Struktur und derselben oder einer ähnlichen Attributliste.

Informationen zu diesem Vorgang

Wenn Sie den Assistenten Schemaerkennung verwenden, um Datenquellenschemas zu erstellen, können Sie unter zwei möglichen Reportable-REST-Optionen auswählen, die Ihre Anwendung möglicherweise unterstützt: REST-API 1.0 oder REST-API 2.0. Wenden Sie sich an Ihren Systemadministrator, wenn Sie nicht wissen, welche REST-API-Version von Ihrer Anwendung unterstützt wird.

Schemaerkennung (REST-API 1.0)

Informationen zu diesem Vorgang

Anmerkung: Führen Sie diese Aufgabe aus, um das Schema in Rational Team Concert und Datenquellen, die die Anwendung "Data Services" verwenden, aufzufinden. Informationen zum Generieren von Schemas für andere REST-basierte Anwendungen entnehmen Sie der Produktdokumentation.

Vorgehensweise

  1. Klicken Sie in Document Studio auf Daten > Schemaerkennung > REST-Schemaerkennung.
  2. Geben Sie die Verbindungsdetails an:
    1. Name: Geben Sie einen Namen für die Datenquelle ein.
    2. Beschreibung: Geben Sie eine Beschreibung für die Datenquelle ein.
    3. Basis-URL: Geben Sie den Basis-URL für die Ressource an.
    4. Authentifizierungstyp: Wählen Sie den Authentifizierungstyp in der Liste aus.
    5. Benutzer: Wenn die Ressource ein sicherer Server ist, geben Sie den Benutzernamen an.
    6. Kennwort: Wenn die Ressource ein sicherer Server ist, geben Sie das Kennwort an.
  3. Klicken Sie auf Weiter.
  4. Geben Sie im Fenster Ressource erstellen die Details für die neue Ressource an:
    1. Name: Geben Sie einen Namen für die neue Ressource ein.
    2. Beschreibung: Geben Sie eine Beschreibung für die neue Ressource ein.
    3. Relativer Pfad: Geben Sie einen relativen Pfad für die neue Ressource ein.
    Wenn die REST-Datenquelle über die Data-Services-Adapter für Berichterstellung zugänglich ist, wählen Sie Locate using data service aus, um die Ressource aufzufinden. Die Ressourcennavigation ist für Ressourcen mit einem href-Attribut verfügbar. Erweitern Sie die Liste, um die Ressource zu finden.
  5. Gehen Sie wie folgt vor, um die Ressourcen auszuwählen:
    1. Wählen Sie in der Baumstruktur des XML-Schemas ein Element aus.
    2. Wählen Sie in der Attributliste den Wert href aus.
    3. Klicken Sie auf Weiter. Der Ressourcen-URL für die ausgewählte Ressource wird angezeigt.
  6. Wählen Sie den URL aus, und klicken Sie auf Fertigstellen, oder verwenden Sie den URL, um die untergeordnete Ressource aufzufinden. Gehen Sie wie folgt vor, um die untergeordnete Ressource aufzufinden:
    1. Wählen Sie den Ressourcen-URL aus, und klicken Sie auf Weiter.
    2. Wählen Sie in der Baumstruktur des XML-Schemas ein Element aus.
    3. Wählen Sie in der Attributliste den Wert href aus.
  7. Klicken Sie auf Fertigstellen. Der Assistent wird ausgeführt, und im Konfigurationsfenster wird der URL angezeigt. Wenn sich die Ressource auf einem sicheren Server befindet, geben Sie im Konfigurationsfenster einen Benutzernamen und ein Kennwort ein.

Nächste Schritte

Fügen Sie dieses Schema Ihrer Vorlage hinzu. Weitere Informationen finden Sie unter Datenquellenschemas hinzufügen.

Schemaerkennung (REST-API 2.0)

Informationen zu diesem Vorgang

Anmerkung: Rational Publishing Engine unterstützt nur abgekürztes RDF. Die Provider müssen application/xml-Anforderungen akzeptieren und berücksichtigen. Weitere Informationen finden Sie unter Open Services for Lifecycle Collaboration Core Specification Version 2.0.
Rational Publishing Engine unterstützt nur OSLC-v2-Provider, die die Spezifikation Reportable REST v2 beachten.
  • Für einen OSLC-Service müssen in der Serviceressource für alle zur Berichterstellung vorgesehenen Ressourcen Abfragefunktionen (Query Capabilities) definiert sein.
  • Für jede Abfragefunktion zur Berichterstellung (Query Capability for Reporting) muss Folgendes gelten:
    • oslc:queryBase muss auf die Ressource verweisen, die eine Liste der zur Berichterstellung (Reporting) vorgesehenen Ressourcen umfasst. Die Ressourcen in der Liste müssen in der Resource-Shape-Ressource der Listenressource als oslc:isMemberProperty angegeben sein.
    • oslc:resourceShape muss zum Beschreiben der Listenressource verwendet werden.

Vorgehensweise

  1. Klicken Sie auf Daten > Schemaerkennung > REST-v2-Schemaerkennung.
  2. Geben Sie die Verbindungsdetails an:
    1. Basis-URL: Geben Sie den Basis-URL für die Ressource an.
      Der URL des Service-Providers, der akzeptiert werden soll, muss bekannt sein. Dieser URL ist die Entsprechung für den URL der Anwendung "Data Services" für die Reportable-REST-Datenquelle. Rational Publishing Engine ruft die Daten aus der Datenquelle als Liste von Abfragen ab. Diese Ressourcen werden von dem Service gespeichert, von dem Daten abgefragt und interpretiert werden können. Außerdem stellt der Service einen Abfrageservice bereit. Damit können Sie die Daten entsprechend einer festgelegten Bedingung filtern oder Teilmengen der Daten eingrenzen. Diese Abfragen gelten für einen bestimmten Ressourcentyp und ermöglichen den Zugriff auf eine Ressource eines bestimmten Typs. Ein Reportable-ID2-Service kann viele Ressourcentypen bereitstellen, z. B. eine Produkt- oder Benutzeränderungsanforderung. Der Abfrageservice unterstützt den Benutzer dabei, die Daten effizient abzurufen oder eine Teilmenge der Daten abzurufen. Er ist jedoch nicht verbindlich. Der Abfrageservice ist für alle Ressourcen vorhanden. Jedes Produkt kann eigene Ressourcen und die Abfragen zum Zugriff auf diese Ressourcen definieren.
    2. Authentifizierungstyp: Wählen Sie den Authentifizierungstyp in der Liste aus.
    3. Benutzer: Wenn die Ressource ein sicherer Server ist, geben Sie den Benutzernamen an.
    4. Kennwort: Wenn die Ressource ein sicherer Server ist, geben Sie das Kennwort an.
  3. Klicken Sie auf Weiter.
  4. Wählen Sie einen REST-v2-Service und die zugehörige Abfrage aus, und klicken Sie auf Weiter. Die Eigenschaften der ausgewählten Services werden angezeigt.
  5. Wählen Sie die erforderlichen Eigenschaften in der Liste aus, und klicken Sie auf Test oslc.select. Das Fenster Ergebnisbestätigung wird mit den ausgewählten Services angezeigt. Prüfen Sie, ob die Services richtig sind. Wenn Sie auf Korrekt klicken, ändert sich der Status von Test oslc.select in true. Klicken Sie auf Weiter.

    Das Feld Test oslc.properties wird nicht oft verwendet.

  6. Sie müssen in den Feldern Abfrage mit Klausel oslc.where und Abfrage mit Klausel oslc.orderBy nur die Filter- oder die Sortierklausel der Abfrage eingeben, z. B. cq:Product{cq:Product="Rational Publishing Engine"}.
  7. Klicken Sie auf Test oslc.where und Test oslc.orderBy, um die Verbindung zu prüfen. Rational Publishing Engine erstellt die vollständige Anforderung mit den definierten Optionen.
  8. Klicken Sie auf Weiter. Die Zusammenfassung für Ihre Abfrage wird angezeigt. Klicken Sie auf Fertigstellen. Der Assistent wird ausgeführt, und der URL wird im Fenster Konfiguration angezeigt. Wenn sich die Ressource auf einem sicheren Server befindet, geben Sie im Fenster Konfiguration einen Benutzernamen und ein Kennwort an.

Feedback