スキーマ・ディスカバリー・ウィザードを使用した REST データ・ソース・スキーマの追加

データ・ソース・スキーマは、REST データ・ソースに対して作成できます。 スキーマを作成すると、同じ構造、および同じまたは類似の属性リストを持つモジュールの文書テンプレートを簡単にオーサリングできます。

このタスクについて

データ・ソース・スキーマの作成にスキーマ・ディスカバリー・ウィザードを使用する場合は、アプリケーションがサポートできる 2 つのレポート可能 REST オプションである REST API 1.0 または REST API 2.0 のいずれかから選択できます。 ご使用のアプリケーションがサポートする REST API のバージョンが分からない場合は、システム管理者に問い合わせてください。

スキーマ・ディスカバリー (REST API 1.0)

手順

  1. Document Studio で、「データ」 > 「スキーマ・ディスカバリー」 > 「REST スキーマ・ディスカバリー」をクリックします。
  2. 次のようにして、接続詳細を指定します。
    1. データ・ソースの「名前」を入力します。
    2. データ・ソースの「説明」を入力します。
    3. リソースの「基本 URL」を指定します。
    4. リストから「認証タイプ」を選択します。 タイプが選択されていない場合、正しいタイプが見つかるまで、各認証タイプがテストされます。 タイプを指定すると、このプロセスは省略できます。
    5. リソースがセキュア・サーバーにある場合、「ユーザー名」を指定します。
    6. リソースがセキュア・サーバーにある場合、「パスワード」を指定します。
  3. 「次へ」をクリックします。
  4. データ・ソースがデータ・サービスを使用するかどうかに応じて、以下のいずれかのウィンドウが表示されます。

    データ・ソースがデータ・サービスを使用しない場合、「リソースの作成 (Create a Resource)」ウィンドウが表示されます。

    1. 新規リソースの「名前」を入力します。
    2. 新規リソースの「説明」を入力します。
    3. 新規リソースの「相対パス」を入力します。
    REST データ・ソースがレポート作成データ・サービス・アダプターによりアクセス可能な場合、「データ・サービスを使用して探索」ウィンドウが表示されます。
    1. XML スキーマ・ツリーからエレメントを選択します。
    2. 属性リストから href 値を選択します。
    3. 「次へ」をクリックします。 選択したリソースに対してリソース URL が表示されます。
  5. URL を選択して、「終了」をクリックするか、または URL を使用して子リソースを見つけます。 子リソースを見つけるには、次のようにします。
    1. リソース URL を選択して、「次へ」をクリックします。
    2. XML スキーマ・ペインからエレメントを選択します。
    3. 属性リストから href を選択します。
  6. 子リソースを見つけたら、「終了」をクリックします。 ウィザードが完了し、URL が「構成」ウィンドウに表示されます。 リソースがセキュア・サーバー上にある場合は、構成ウィンドウでユーザー名とパスワードを入力します。

スキーマ・ディスカバリー (REST API 2.0)

このタスクについて

注: Rational® Publishing Engine は、短縮 RDF のみをサポートします。 プロバイダーは、application/xml 要求を受け入れる必要があります。 『Open Services for Lifecycle Collaboration Core Specification Version 2.0』を参照してください。
Rational Publishing Engine は、レポート可能 REST v2 の仕様に従う OSLC v2 プロバイダーのみをサポートします。
  • OSLC サービスには、レポート作成を意図したすべてのリソースに対して、サービス・リソースで定義されている照会機能が必要です。
  • レポート作成用の各照会機能は、以下のものが必要です。
    • レポート作成を意図したリソースのリストがあるリソースを指す oslc:queryBase が必要です。 リスト内のリソースは、リスト・リソースのリソース形状リソース内で、oslc:isMemberProperty として識別される必要があります。
    • リスト・リソースを説明する oslc:resourceShape が必要です。

手順

  1. 「データ」 > 「スキーマ・ディスカバリー」 > 「REST v2 スキーマ・ディスカバリー」をクリックします。
  2. 次のようにして、接続詳細を指定します。
    1. リソースの「基本 URL」を指定します。
      受け入れたいサービス・プロバイダーの URL は知っている必要があります。 この URL は、レポート可能 REST データ・ソースのレポート作成データ・サービス・アプリケーション URL の対になります。Rational Publishing Engine は、データ・ソースからデータを照会のリストとして取り出します。 これらのリソースは、データを照会して解釈できるサービスによって保管されます。 さらにこのサービスは、一連の条件に応じてデータをフィルタリングしたり、データのサブセットを絞り込んだりできる照会サービスを提供します。 これらの照会はリソースのタイプに合わせたものであり、特定のタイプのリソースにアクセスすることができます。 レポート可能 ID2 サービスは、製品やユーザー変更要求などの多くのリソース・タイプを公開できます。 照会サービスによって、ユーザーはデータまたはデータのサブセットを効率的に取得できます。ただしこれは必須ではありません。 照会サービスはすべてのリソースを対象にしています。 すべての製品はそのリソースと、そのリソースにアクセスする照会とを定義できます。
    2. リストから「認証タイプ」を選択します。
    3. リソースがセキュア・サーバーにある場合、「ユーザー名」を指定します。
    4. リソースがセキュア・サーバーにある場合、「パスワード」を指定します。
  3. 「次へ」をクリックします。
  4. REST v2 サービスとその対応する照会を選択し、「次へ」をクリックします。 選択したサービスのプロパティーが表示されます。
  5. リストから必要なプロパティーを選択し、「Test oslc.select」をクリックします。 「結果の確認」ウィンドウに、選択したサービスが表示されます。 サービスが正しいことを確認します。 「正しい」をクリックすると、「Test oslc.select」フィールドの状況が true に代わります。 「次へ」

    をクリックします。「Test oslc.properties」フィールドは頻繁には使用されません。

  6. 照会のフィルター節またはソート節のみ (例えば cq:Product{cq:Product="Rational Publishing Engine"} など) を、「oslc.where 節を組み込む照会」および「oslc.orderBy 節を組み込む照会」に入力する必要があります。
  7. 「Test oslc.where」および「Test oslc.orderBy」をクリックし、接続を確認します。 Rational Publishing Engine は、定義されたオプションを使用して要求全体を作成します。
  8. 「次へ」をクリックします。 照会の要約が表示されます。 「終了」をクリックします。 ウィザードが完了し、URL が「構成」ウィンドウに表示されます。 リソースがセキュア・サーバーにある場合は、ユーザー名とパスワードを「構成」ウィンドウに入力できます。

フィードバック