在将
Rational Focal Point
用作数据源的情况下设计模板
报告设计者可使用 Document Studio 来导入数据源模式和构建报告模板。
开始之前
提示:
Rational® Publishing Engine
安装附带一个样本报告集。开始发布文档之前,可以浏览此示例文档生成方案。请参阅
创建 REST 样本模板
。
熟悉使用
Rational Publishing Engine
时从
Rational Focal Point™
抽取数据所需的
Rational Focal Point
REST 服务和各种 URL。要找到适用于
Rational Focal Point
版本的信息中心,请参阅
关于
Rational Focal Point
信息中心
。
关于此任务
使用 REST API 来抽取数据。此接口通过数据源应用程序安装和实现,独立于
Rational Publishing Engine
工作。有关数据源的 REST API 的更多信息,请参阅该数据源的文档。
过程
查看
设计文档模板
,以获取模板开发流程的概述。
开始规划文档的结构以及可包括的数据。 例如,决定是将从一个模板还是从多个模板文件(每个文件都包含可复用的内容部分)生成最终文档。
在 Document Studio 应用程序中,
创建文档模板
。
识别数据源中的数据源模式。
要从
Rational Focal Point
项目添加特定数据片段,或者要通过已知 URL 访问单个资源,请构造使用
resources
参数的 URL。打开数据源模式,然后从 XML 文件中获取特定资源的 URI。
示例:
http://
server
:
port
/fp/resources
注:
Rational Focal Point
模式特定于应用程序的每个安装。这意味着为一个
Rational Focal Point
服务器创建的模板无法在其他
Rational Focal Point
服务器上复用。
如果要使用
Rational Requirements Composer
可报告 REST API,请输入采用以下格式的 URL:
https://
server
:
port
/
rm
/publish/
artifact
将数据源模式添加至文档模板。
对于
Rational Focal Point
,可完成下列步骤:
在 Document Studio 中,单击
数据
>
添加数据源模式
。
在
类型
中,从列表中选择模式类型。
对于
Rational Focal Point
,选择
Generic XML
。
在
模式文件
字段中,粘贴标识为数据源模式的 URL。
将
?metadata=schema
追加至该 URL 的末尾。
示例:
http://
server
:
port
/fp/resources?metadata=schema
如果要使用
Rational Requirements Composer
可报告 REST API,请输入采用以下格式的 URL:
示例:
https://
server
:
port
/
rm
/publish/
artifact
?metadata=schema
如果资源位于受保护的服务器中,请指定
用户名
。
如果资源位于受保护的服务器中,请指定
密码
。
从列表中选择
认证类型
。
对于
Rational Focal Point
,认证类型为
OAuth
。如果没有选择
OAuth
,那么会测试每种认证类型,直到找到正确的类型,这会延长文档生成时间。
将元素添加至模板。
Rational Publishing Engine
具有一组全面的模板元素,可以用于构造文档。可以将元素拖动到模板内容编辑器中。例如,可添加容器元素来保存若干段。 每段都可由一个测试条件控制,该条件使该段仅与特定数据关联。关于更多信息,请参阅
“选用板”视图中的模板元素
和
将元素添加至模板
。
使用
查询
、
属性
和
变量
来向模板添加数据。这些项指定会在报告中生成哪些信息部分。
将
格式设置和样式
添加至这些元素,以控制它们在输出中的显示方式。
创建
过滤器
,以精简拉入报告中的数据。
过滤器是通用数据源 URI 的详细版本;可以使用过滤器来指向特定的数据子集,以便使
Rational Publishing Engine
在报告生成期间仅尝试从数据源检索必需的信息。这些过滤器必须足够广泛,能够检索由模板引用的所有必需数据,否则生成的报告就无法包含完整的数据。
创建
排序
,以对报告中的数据进行组织。
上一主题:
配置 Rational Focal Point 与 Rational Publishing Engine 之间的集成
下一主题:
在将 Rational Focal Point 用作数据源的情况下生成文档
反馈