Java API の初期化と準備

文書仕様の構成と文書の生成を始める前に、 Java™ API を初期化してロギング・メソッドを選択する必要があります。

手順

  1. 必須: API を初期化するメソッドを 選択します。
    • 自動的に行う場合: %RPE_HOME% 環境変数が Rational® Publishing Engine インストールの config および source ディレクトリーへの パスを識別するために使用されます。
    • プログラムで行う場合: AppUtils.setProductHome(path) を 使用して、Rational Publishing Engine インストールの config および source ディレクトリーへのパスを 設定します。
    ヒント: API をプログラムで初期化するメソッドを 推奨します。API をプログラムで初期化すると、アプリケーションは Rational Publishing Engine インストール内のディレクトリーに依存するのではなく、config ディレクトリーおよび source ディレクトリーがアプリケーションに付属します。
  2. オプション: ロギングするメソッドを選択します。
    • Rational Publishing Engine を構成して、ロガーをアプリケーション内で使用するようにします。
      • ロギング用の org.apache.commons.logging.Log クラスのインスタンスを 作成します。
      • ご使用のアプリケーションで共通ロギングを使用しない場合、Rational Publishing EngineIRPELogger インターフェースを実装するクラスのインスタンスを提供できます。 このクラスは、Rational Publishing Engine ロギング呼び出しを、ご使用のアプリケーションのロギングへの呼び出しに変換します。
    • アプリケーションで Rational Publishing Engine ロガー を構成します。
      • アプリケーションで Rational Publishing Engine ロガーを使用します。例:
        AppUtils.getLogger().info( "Starting RPE");
      • どの Rational Publishing Engine 関数であってもそれを使用する前に、次のように Log4j ロガーを構成します。
        • log4j.properties ファイルがプロジェクトのルート・フォルダーに ある場合、次のように Log4j ロガーを初期化します。
          PropertyConfigurator.configure( this.class.getClassLoader().getResource("./log4j.properties"));
        • log4j.properties ファイルがプロジェクトのルート・フォルダーにない場合、次のように Log4j ロガーを初期化します。
          PropertyConfigurator.configure( new File( AppUtils.getConfigFilePath(), "log4j.properties").getAbsolutePath());
  3. オプション: 進行状況通知に接続します。 レポート生成者には、RPEListener を通じて通知メッセージを送信できます。 これらのメッセージは、 文書の生成中にランチャー・アプリケーションが進行状況ウィンドウに 表示するメッセージと同じです。

フィードバック