初始化和准备 Rational Publishing Engine Java API

在开始配置文档规范和生成文档之前,必须先初始化 Java™ API 并选择日志记录方法。

过程

  1. 必需: 选择用于初始化 API 的方法:
    • 自动:%RPE_HOME% 环境变量用于识别 Rational® Publishing Engine 安装中 configsource 目录的路径。
    • 编程方式:使用 AppUtils.setProductHome(path) 设置 Rational Publishing Engine 安装中 configsource 目录的路径。
    提示: 建议使用以编程方式初始化 API 这一方法。以编程方式初始化 API 时,应用程序与 configsource 目录一起交付,而不依赖于 Rational Publishing Engine 安装中的目录。
  2. 可选: 选择用于日志记录的方法:
    • 配置 Rational Publishing Engine 以在应用程序中使用记录器:
      • 为日志记录创建 org.apache.commons.logging.Log 类的实例。
      • 如果应用程序不使用公共日志记录,那么您可以向 Rational Publishing Engine 提供用于实现 IRPELogger 接口的类的实例。 此类会将 Rational Publishing Engine 日志记录调用转换成对您应用程序的日志记录的调用。
    • 在应用程序中配置 Rational Publishing Engine 记录器:
      • 在应用程序中使用 Rational Publishing Engine 记录器。示例:
        AppUtils.getLogger().info( Starting RPE);
  3. 如果在上一步中已选择在应用程序中配置 Rational Publishing Engine 记录器,请先配置 Log4j 记录器再使用任何 Rational Publishing Engine 功能。
    • 如果 log4j.properties 文件在您项目的根文件夹中,请通过以下方法来初始化 Log4j 记录器:
      PropertyConfigurator.configure( this.class.getClassLoader().getResource(“./log4j.properties”));
    • 如果 log4j.properties 文件在您项目的根文件夹中,请通过以下方法来初始化 Log4j 记录器:
      PropertyConfigurator.configure( new File( AppUtils.getConfigFilePath(), “log4j.properties”).getAbsolutePath());
  4. 可选: 连接至进度通知。 可通过 RPEListener 向报告生成器发送通知消息。这些消息与生成文档时 Launcher 应用程序在进度窗口中显示的消息相同。

反馈