文書仕様でのデータ・ソースに対する認証タイプの指定

データ・ソースに認証が必要な場合、正しい認証タイプが見つかるまで、Rational® Publishing Engine がサポートする各認証タイプ (FormBasicOAuth、または OAuth-OSLC) がテストされます。 認証タイプを指定することで、テスト・プロセスを回避できます。

認証タイプを指定する場合、正しいプロトコルが最初に使用され、不要な要求は実行されないことが Rational Publishing Engine によって保証されます。 データ・ソースに BasicOAuth、または OAuth-OSLC 認証が必要な場合、あるいはデータ・ソースからの多くの要求が必要な複合テンプレートを使用する場合、文書生成時間において大幅なパフォーマンスの改善が見られることがあります。 認証タイプが指定されていない場合は、それぞれの認証タイプが試行されます。

このタスクについて

HTML、XSL-FO、およびレガシー PDF 文書の生成におけるパフォーマンスを向上させるには、このタスクを実行します。

ユーザー名とパスワードの保管方法について詳しくは、『IBM® Rational Publishing Engine のセキュリティーの考慮事項』を参照してください。

手順

  1. ランチャー・アプリケーションを開きます。
  2. 文書仕様を作成します。
  3. データ・ソースを構成します。
  4. データ・ソースを選択します。 「プロパティー」ビューが開きます。
  5. 「authentication」フィールドで、データ・ソースに適用される認証タイプを入力します。 大/小文字を区別する、以下のいずれかの認証タイプを入力できます。
    • Form
    • Basic
    • OAuth
    • OAuth-OSLC
  6. 必要な場合には、資格情報を入力して、ユーザー名とパスワードが含まれるデータ・ソースを使用して認証します。
  7. 文書仕様を保存します。

次のタスク

既存の文書仕様で認証プロパティーを更新します。

OAuth-OSLC 認証用の oslcServiceProviders.xml ファイルの作成

OAuth-OSLC 認証を必要とする汎用 XML、REST v1、または REST v2 データ・ソースを使用する場合、base_urlconsumer_key、および secret の各プロパティー値を保管するための oslcServiceProviders.xml を最初に作成する必要があります。

このタスクについて

デフォルトでは、製品は RPE_HOME/config ディレクトリーで oslcServiceProviders.xml ファイルを検索します。 このデフォルト RPE_HOME/config ディレクトリーの下に oslcServiceProviders.xml ファイルを作成する利点は、これ以上の構成を行う必要がないことです。 ただし、製品を新しいバージョンにアップグレードするときには、このファイルのバックアップを作成することを忘れないでください。 インストールおよびアップグレードを行った後、新たにインストールした製品の RPE_HOME/config ディレクトリーにバックアップ oslcServiceProviders.xml ファイルを入れることができます。
oslcServiceProviders.xml ファイルをデフォルトの RPE_HOME/config ディレクトリー外に指定することはできますが、その場合は com.ibm.rational.rpe.config.oslcServiceProviders プロパティーで oslcServiceProviders.xml ファイルの場所を指定する必要があります。 ロケーションが HTTP セキュア・パスである場合、com.ibm.rational.rpe.config.oslcServiceProviders.usr および com.ibm.rational.rpe.config.oslcServiceProviders.pwd プロパティーで認証資格情報を指定する必要があります。 以下のいずれかのスコープを使用して、これらのプロパティーを指定してください。

oslcServiceProviders.xml ファイルをデフォルト RPE_HOME/config ディレクトリー外に作成することにより、チーム・コラボレーション環境がサポートされます。 oslcServiceProviders.xml ファイルは、共有ロケーションに置かれ、その共有ロケーションを指すように com.ibm.rational.rpe.config.oslcServiceProviders プロパティーが設定されていれば、複数のユーザーが再利用できます。

手順

  1. Rational Publishing Engine インストール・ディレクトリーにあるサンプル RPE_HOME/config/oslcServiceProviders-sample.xml のコピーを作成します。
  2. テキスト・エディターで、oslcServiceProviders.xml ファイルのコピーを開きます。
  3. title タグで、データ・ソース・プロバイダーの名前を入力します。
  4. description タグで、データ・ソース・プロバイダーの説明または注を入力します。
  5. base_url タグで、データ・ソースへの基本 URL を入力します。 例: https://server:port/oslcCatalog
  6. pattern タグで、データ・ソースの URL パターンを入力します。 oslcServiceProviders.xml ファイルに指定されているデータ・ソースのリストがある場合、このパターンを使用して、どのデータ・ソース詳細がデータ・ソース要件に一致するかを識別します。 例: https://server:port/contextroot
  7. consumer_key タグで、データ・ソースからのコンシューマー・キーを入力します。
  8. secret タグで、データ・ソースからの秘密値を入力します。
  9. oslcServiceProviders.xml ファイルを、Rational Publishing Engine インストール・ディレクトリー外のロケーションに保存します。