在将 Rational Quality Manager 用作数据源的情况下设计模板

报告设计者可使用 Document Studio 来导入数据源模式和构建报告模板。

开始之前

提示: Rational® Publishing Engine 安装附带一个样本报告集。开始发布文档之前,可以浏览此示例文档生成方案。请参阅创建 REST 样本模板
熟悉使用 Rational Publishing EngineRational Quality Manager 抽取数据所需的 Rational Quality Manager REST 服务和各种 URL。请参阅 Rational Quality Manager REST API 文档

关于此任务

使用 REST API 来抽取数据。此接口通过数据源应用程序安装和实现,独立于 Rational Publishing Engine 工作。有关数据源的 REST API 的更多信息,请参阅该数据源的文档。

过程

  1. 查看设计文档模板,以获取模板开发流程的概述。 开始规划文档的结构以及可包括的数据。 例如,决定是将从一个模板还是从多个模板文件(每个文件都包含可复用的内容部分)生成最终文档。
  2. 在 Document Studio 应用程序中,创建文档模板
  3. 识别数据源中的数据源模式。
    • 要从 Rational Quality Manager 项目添加来自集合的特定数据片段(例如测试用例详细信息或测试脚本),或者要通过已知 URL 访问单个资源,请构造使用 feed 参数的 URL。总是使用此模式,并从 Rational Quality Manager 项目针对模板中的特定数据部分,动态配置此模式。
      • 示例:https://server:port/qm/service/com.ibm.rqm.integration.service.IIntegrationService/schema/feed.xsd
    • 要从 Rational Quality Manager 项目添加来自单个资源的特定数据片段(例如测试用例详细信息或测试脚本),或者要通过已知 URL 访问单个资源,请构造使用 qm 参数的 URL:
      • 示例:https://server:port/qm/service/com.ibm.rqm.integration.service.IIntegrationService/schema/qm.xsd
    • 如果要使用 REST V2 API 来生成文档,那么必须向服务提供者(而不是向根条目)提供数据源模式 URL。示例:
      • 不正确:https://server:port/qm/oslc_qm/catalog
      • 正确:https://server:port/qm/oslc_qm/catalog/repository/db/schema_repository/
  4. 将数据源模式添加至文档模板。 对于 Rational Quality Manager,可完成下列步骤:
    1. 在 Document Studio 中,单击数据 > 添加数据源模式
    2. 预定义字段中,选择其中一个 RQM 模式。
    3. 类型中,从列表中选择模式类型。 对于 Rational Quality Manager,选择 Generic XML
    4. 如果需要,编辑模式字段,或单击浏览以选择模式文件的路径。
    5. ?abbreviate=false 追加至该 URL 的末尾。
      • 示例:https://server:port/qm/service/com.ibm.rqm.integration.service.IIntegrationService/resources/JKE Banking (Quality Management)/testcase?abbreviate=false
    6. 如果资源位于受保护的服务器中,请指定用户名
    7. 如果资源位于受保护的服务器中,请指定密码
    8. 从列表中选择认证类型 针对 Rational Quality Manager,可使用认证类型 FormBasicOAuth
  5. 将元素添加至模板。 Rational Publishing Engine 具有一组全面的模板元素,可以用于构造文档。可以将元素拖动到模板内容编辑器中。例如,可添加容器元素来保存若干段。 每段都可由一个测试条件控制,该条件使该段仅与特定数据关联。关于更多信息,请参阅“选用板”视图中的模板元素将元素添加至模板
  6. 使用查询属性变量来向模板添加数据。这些项指定会在报告中生成哪些信息部分。
  7. 格式设置和样式添加至这些元素,以控制它们在输出中的显示方式。
  8. 创建过滤器,以精简拉入报告中的数据。 过滤器是通用数据源 URI 的详细版本;可以使用过滤器来指向特定的数据子集,以便使 Rational Publishing Engine 在报告生成期间仅尝试从数据源检索必需的信息。这些过滤器必须足够广泛,能够检索由模板引用的所有必需数据,否则生成的报告就无法包含完整的数据。 请参阅 Rational Quality Manager 可报告 REST API,以获取更多信息。
  9. 创建排序,以对报告中的数据进行组织。

反馈