报告设计者可使用 Document Studio 来导入数据源模式和构建报告模板。
提示: Rational® Publishing Engine 安装附带一个样本报告集。开始发布文档之前,可以浏览此示例文档生成方案。请参阅
创建 REST 样本模板。
熟悉
Rational ClearQuest® REST 服务和使用
Rational Publishing Engine 从
Rational ClearQuest 抽取数据所需的各种 URL。请参阅
关于 Rational ClearQuest 信息中心。
使用 REST API 来抽取数据。此接口通过数据源应用程序安装和实现,独立于 Rational Publishing Engine 工作。有关数据源的 REST API 的更多信息,请参阅该数据源的文档。
- 查看设计文档模板,以获取模板开发流程的概述。 开始规划文档的结构以及可包括的数据。 例如,决定是将从一个模板还是从多个模板文件(每个文件都包含可复用的内容部分)生成最终文档。
- 在 Document Studio 应用程序中,创建文档模板。
- 将数据源模式添加至文档模板。 对于 Rational ClearQuest,可通过输入应用程序的基本 URL 来发现数据源模式。
- 打开适用于 Rational ClearQuest
版本的模式发现向导
- 对于使用 REST V1 的早期 Rational ClearQuest
版本,单击。
- 对于使用 REST V2 的较新 Rational ClearQuest
版本,单击。
- 指定资源的基本 URL。
- 对于 Rational ClearQuest
的 REST V1 版本,Rational Publishing Engine
会使用 Rational 数据服务来发现模式和查询数据。以下是这些数据服务的基本 URL:https://server:port/DataServices/ClearQuest
- 对于 Rational ClearQuest
的 REST V2 版本,从 ServiceProvider URL 启动。用户可以通过访问 Rational ClearQuest REST V2 ServiceCatalog URL(例如 https://server:port/context/oslc)来获取 ServiceProvider URL。将 HTTP 头 OSLC-Core-Version 设置为 2.0,并接受 application/rdf+xml。可以从返回的结果找到 ServiceProvider URL rdf:about。
如果要使用 REST V2 API 来生成文档,那么必须向服务提供者(而不是向根条目)提供数据源模式 URL。示例:
- 不正确:https://server:port/cqweb/oslc
- 正确:https://server:port/cqweb/oslc/repo/repository/db/schema_repository/
- 从列表中选择认证类型。 如果没有选择类型,那么会测试每种类型,直到找到正确的类型,这会延长文档生成时间。
- 如果资源位于受保护的服务器中,请指定用户名。
- 如果资源位于受保护的服务器中,请指定密码。
- 单击下一步。 会对您输入的基本 URL 自动追加 ?metadata=schema。示例:https://server:port/service/cq/records/defects?metadata=schema
- 单击完成。 您选择的数据源模式会显示在“数据源模式”视图中。
- 将元素添加至模板。 Rational Publishing Engine 具有一组全面的模板元素,可以用于构造文档。可以将元素拖动到模板内容编辑器中。例如,可添加容器元素来保存若干段。
每段都可由一个测试条件控制,该条件使该段仅与特定数据关联。关于更多信息,请参阅“选用板”视图中的模板元素和将元素添加至模板。
- 使用查询、属性和变量来向模板添加数据。这些项指定会在报告中生成哪些信息部分。
- 将格式设置和样式添加至这些元素,以控制它们在输出中的显示方式。
- 创建过滤器,以精简拉入报告中的数据。 过滤器是通用数据源 URI 的详细版本;可以使用过滤器来指向特定的数据子集,以便使 Rational Publishing Engine 在报告生成期间仅尝试从数据源检索必需的信息。这些过滤器必须足够广泛,能够检索由模板引用的所有必需数据,否则生成的报告就无法包含完整的数据。
Rational ClearQuest
适配器支持从可报告 REST V1 数据源进行本机过滤。 在可报告 Rest V1 本机过滤器中,只需要在方括号
[] 之间输入文本。过滤器的其余部分由 Rational Publishing Engine 生成。 请参阅Reportable Rest v1,以获取更多信息。
不带适配器的 Rational ClearQuest
V8 支持从可报告 Rest V2 数据源进行本机过滤。有关更多信息,请参阅 Rational ClearQuest OSLC
CM REST API。
样本变量过滤器:
cq:Product{cq:Product="${productName}")
样本解析过滤器,其中
productName 是
Rational Publishing Engine:
cq:Product{cq:Product="Rational Publishing Engine")
注: - 只有在需要时才向数据源发出请求。例如,您可以使用条件只让元素在其包含数据时显示在输出中。容器元素上的条件可能是 variable == "true"。
如果不满足此条件并且没有任何数据与变量条件相匹配,那么不会向数据源发出任何请求。
- 在发出请求之前,您可以计算本机过滤器。本机过滤器在遇到查询时进行计算并使用该点处的变量值。因此,可在模板中执行计算,这会影响本机过滤器。
- 创建排序,以对报告中的数据进行组织。