可以将 Rational® Quality Manager 定义为 Rational Publishing Engine 中的数据源。使用 Rational Quality Manager REST API 来抽取数据。此接口由应用程序安装和实现,独立于 Rational Publishing Engine 而工作。
提示: Rational Publishing Engine 附带一组样本报告。开始发布文档之前,可以浏览此示例文档生成方案。请参阅
创建 REST 样本模板。
开始之前
- 熟悉使用 Rational Publishing Engine 从 Rational Quality Manager 抽取数据所需的 Rational Quality Manager REST 服务和各种 URL。请参阅 Rational Quality Manager REST API 文档。
- 连接至数据源模式。请参阅添加数据源模式。
- 模式可以位于本地文件系统上。例如,https://server:port/jazz/service/com.ibm.rqm.integration.service.IntegrationService/schema/feed.xsd 是一个使用 feed 参数的模式文件。可以使用此模式从 Rational Quality Manager 项目添加特定数据部分(例如测试用例详细信息或测试脚本),或者以已知 URL 访问单个资源。
- 如果您正在使用 REST V2 API 来生成文档,那么必须向服务提供者(而不是根目录)提供数据源模式 URL。 示例:
- 不正确:https://server:port/qm/oslc_qm/catalog
- 正确:https://server:port/qm/oslc_qm/catalog/repository/db/schema_repository/
可以使用数据源模式中的元素在模板中添加查询。这些查询指定在报告中生成的信息。要确保您可以接收到 Rational Quality Manager 订阅源数据源所返回内容的完整列表,您必须将模式类型设为“通用 XML”并将 ?abbreviate=false 添加至 URI 的末尾。示例:https://rqmserver:9443/qm/service/com.ibm.rqm.integration.service.IIntegrationService/resources/JKE
Banking (Quality Management)/testcase?abbreviate=false
- 连接至数据源模式之后,可以创建或导入模板设计。使用 Rational Publishing Engine Document Studio,可以构建报告模板设计。此设计将确定报告的布局。请参阅使用 Document Studio 来编写模板。
- 规划文档的结构并定义内容以抽取数据。请参阅设计文档模板,以获取模板开发流程的概述。对于大型文档,可以为每个文档块创建单独的模板。
- Rational Publishing Engine 具有可用来构造文档的全面模板元素集。可以将元素拖到模板内容编辑器。有关更多详细信息,请参阅 “选用板”视图中的模板元素。
- 使用查询、属性和变量将数据添加至模板。
- 可以使用数据源配置元素来定义运行时的一些未知属性。请参阅添加数据源配置元素。例如,根据 feed 数据模式动态设置 qm 数据模式。总是使用此模式,并从 Rational Quality Manager 项目针对模板中的特定数据部分,动态配置此模式。
- 可以使用过滤器(常规数据源 URI 的更具体版本)来指向特定的数据子集,以免 Rational Publishing Engine 在生成报告期间尝试从 Rational Quality Manager 存储库检索额外的信息。这些过滤器必须足够广泛才能检索到模板引用的所有必需数据,否则生成的报告无法包含完整数据。请参阅使用 Rational Publishing Engine 过滤器来抽取数据。
- 创建报告模板并填之以 Rational Quality Manager 数据点之后,可以生成各种格式的报告。生成报告时,必须连接至包含有关要运行报告的信息的数据源。指定一个 URI,该 URI 指向内含相关数据的 Rational Quality Manager 存储库。要指向相关数据,请参阅连接至数据源。
注: 对于 IBM Rational Quality Manager OSLC API,缺省情况下,如果未在文档规范中指定接受头,那么 Rational Quality Manager 返回资源的 HTML 表示。必须将接受头设为 application/xml 才能获取 XML 数据。
- 如果在将某个模板分配给文档规范之后又向该模板添加了数据源模式,那么该文档规范将不同步。可以手动同步文档规范,或选择首选项来使文档规范与当前模板自动同步。请参阅设置文档设计首选项以获取有关如何设置是否使文档规范与当前模板保持同步?首选项的信息。
- 发布文档之前,请参阅指定输出属性主题,以获取有关可以选择的可用输出选项以及哪个选项对于模板中所使用元素最适用的更多信息。
- 您现在已准备就绪,可以发布文档。请参阅生成文档。