在将 IBM Rational Team Concert 用作数据源的情况下设计模板

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

开始之前

提示: Rational® Publishing Engine 安装附带一个样本报告集。开始发布文档之前,可以浏览此示例文档生成方案。请参阅创建 REST 样本模板
熟悉使用 Rational Publishing Engine 时从 Rational Team Concert 抽取数据所需的 Rational Team Concert REST 服务和各种 URL。请参阅可报告 REST API Wiki:Rational Team Concert 提供的资源
Rational Team Concert 可报告 REST API 与许多传统的域 API 不同。 可报告 REST API 提供对整体式资源的访问权限,而不是提供指向特定项(例如单个工作项或单个构建结果)的资源 URL。每个整体式资源都是一个容器资源,用于表示针对一个或多个元素的查询结果。
  • foundation:公共工件,例如项目区域、团队区域、添加程序、迭代和链接。
  • workitem:工作项工件,例如摘要、类别、严重性和优先级。
  • apt:敏捷规划工件,例如团队能力、资源调度和缺席情况。
  • generic:通用工件。
  • build:构建工件,例如构建结果、构建结果添加项、构建定义和构建引擎。
  • scm:源代码控制工件,例如流和组件以及流缩放大小变化量。
为报告收集数据时,这些资源使用户能够灵活地执行过滤和查询操作。例如,根据传递至 REST API 的查询或过滤器,工作项资源可能包含一个或多个与工作项相关的元素。

关于此任务

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

过程

  1. 查看设计文档模板,以获取模板开发流程的概述。 开始规划文档的结构以及可包括的数据。 例如,决定是将从一个模板还是从多个模板文件(每个文件都包含可复用的内容部分)生成最终文档。
  2. 在 Document Studio 应用程序中,创建文档模板
  3. 将数据源模式添加至文档模板。 对于 Rational Team Concert,可通过输入应用程序的基本 URL 来发现数据源模式。
    1. 在 Document Studio 中,单击数据 > 添加数据源模式
    2. 如果正使用 RTC 工作项模式,那么可在预定义字段中选择此模式,并跳至步骤 e。
    3. 类型中,从列表中选择模式类型。 对于 Rational Team Concert,选择 REST
    4. 如果需要,编辑模式字段,或单击浏览以选择模式文件的路径。
      • https://server:port/ccm/rpt/repository/foundation
      • https://server:port/ccm/rpt/repository/workitem
      • https://server:port/ccm/rpt/repository/apt
      • https://server:port/ccm/rpt/repository/generic
      • https://server:port/ccm/rpt/repository/scm
      • https://server:port/ccm/rpt/repository/build
    5. 如果 URL 末尾不存在 ?metadata=schema,请将其追加至 URL 末尾。
      • 示例:https://server:port/ccm/rpt/repository/workitem?metadata=schema
    6. 如果资源位于受保护的服务器中,请指定用户名
    7. 如果资源位于受保护的服务器中,请指定密码
    8. 从列表中选择认证类型 针对 Rational Team Concert,可使用认证类型 FormBasicOAuth
    9. 单击完成 您选择的数据源模式会显示在“数据源模式”视图中。
  4. 将元素添加至模板。 Rational Publishing Engine 具有一组全面的模板元素,可以用于构造文档。可以将元素拖动到模板内容编辑器中。例如,可添加容器元素来保存若干段。 每段都可由一个测试条件控制,该条件使该段仅与特定数据关联。关于更多信息,请参阅“选用板”视图中的模板元素将元素添加至模板
  5. 使用查询属性变量来向模板添加数据。这些项指定会在报告中生成哪些信息部分。
  6. 格式设置和样式添加至这些元素,以控制它们在输出中的显示方式。
  7. 创建过滤器,以精简拉入报告中的数据。 过滤器是通用数据源 URI 的详细版本;可以使用过滤器来指向特定的数据子集,以便使 Rational Publishing Engine 在报告生成期间仅尝试从数据源检索必需的信息。这些过滤器必须足够广泛,能够检索由模板引用的所有必需数据,否则生成的报告就无法包含完整的数据。 Rational Team Concert 支持在本机过滤器中使用可报告 Rest V1 数据源。请参阅Reportable REST API on Jazz.net,以获取更多信息。 示例:
    [projectArea/name="JKESample"]/*
    解析请求:
    https://server:port/ccm/rpt/repository/workitem?fields=workitem/workItem[projectArea/name="JKESample"]/(@href|summary)
    注: 并非所有字段都可以进行本机过滤。
  8. 创建排序,以对报告中的数据进行组织。

反馈