从 CLM 应用程序中使用 POX 概要文件创建可跟踪性文档

现在比以前更容易从 CLM 应用程序中创建可跟踪性文档。可以配置 OSLC URL,以在使用 POX (Plain Old XML) 的请求中包含特殊头时返回可报告 REST 表示。

开始之前

您必须已安装 Rational® Publishing Engine 2.1.0 或更高版本以及 Rational solution for CLM 6.0.2 或更高版本。

关于此任务

以前,很难创建可跟踪性文档,因为某些应用程序(例如 Rational Quality ManagerRational Team Concert)使用 OSLC URL,而 Rational Publishing Engine 需要可报告 REST URL。这使模板设计较复杂,因为必须将 URL 从 OSLC 转换为可报告 REST。有时,工件的 OSLC 表示未包含生成文档(例如富文本格式文档)所需的足够信息。

POX 概要文件允许您使用 OSLC URL,就好像它们是可报告 REST API 一样。您可以在 Rational Publishing Engine 中使用 POX 概要文件,以通过提供额外头来直接请求和接收可报告 REST 数据。不再必须转换 URL 或执行复制请求。文档生成服务将在该头存在时返回其他 XML。

示例:创建从 Rational DOORS Next GenerationDesign Management 的可跟踪性文档

过程

  1. 在 Document Studio 中,添加 Rational DOORS Next Generation 模式
  2. 创建模板元素以打印来自工件的信息。
    DNG 元素
  3. 迭代需求中的链接信息。
    DNG 链接
  4. Design Management 中,通过单击面包屑中的显示永久链接图标来复制工件的 URL。
  5. 在 Document Studio 中,打开“添加数据源模式”向导。
  6. (新增内容)模式字段中粘贴该 URL,并将 &?metadata=schema 追加至 URL 末尾。
  7. (新增内容)额外头字段中,选择 POX 概要文件头
    添加具有 POX 概要文件的 DM 模式
  8. 单击下一步,然后单击完成
  9. 在模板中,创建用于将链接反向至 Rational DOORS Next Generation 的模板元素。在“属性”视图中打开“数据源配置”,然后单击“动态配置”选项卡:
    1. (新增内容)在 URI 字段中,输入来自 Rational DOORS Next Generation 的 href。
    2. (新增内容)在接受头字段中,输入 application/xml
    3. (新增内容)在额外头字段中,选择 POX 概要文件链接。 “额外头”字段会使应用程序在即使使用 OSLC URL 的情况下,也使用可报告 REST 信息进行响应。
      POX 概要文件的数据源配置
  10. 创建模板元素以打印 Design Management 信息。
    DM 元素
  11. 切换至 RPE Launcher 以生成文档。
  12. 在“文档规范”视图中,右键单击 Rational DOORS Next Generation 数据源,并选择配置数据源
    1. URL:输入来自 Rational DOORS Next Generation 的永久链接 URL。
    2. 如有必要,请输入用户名和密码。
    3. 认证:选择 OAuth
    4. 接受头:输入 application/xml
    5. (新增内容)额外头:选择 POX 概要文件链接以从 Rational DOORS Next Generation 中请求可报告 REST 数据。
  13. 在主工具栏中,单击生成文档 在“控制台”视图中,您可以看到 Rational Publishing Engine 使用 OSLC URL 从 Design ManagementRational DOORS Next Generation 中请求数据。Design ManagementRational DOORS Next Generation 会重定向至可报告 REST URL。 输出文档包含来自 Rational DOORS Next Generation 的需求以及来自 Design Management 的相关联模型数据。
    正在显示 DNG 数据和 DM 数据的结果