对扩展报告的 OData 支持

ALM 支持 OData (开放数据协议)，这是用于使用 ALM REST API 的基于 OASIS REST 的标准。您可以使用支持 OData 的业务智能 (BI) 工具连接到 ALM 数据并生成图表和报告。除了 ALM 报告和图表提供的功能外，您还可以使用扩展报告功能来可视化和分析 ALM 数据。

此部分描述如何使用 OData 和 ALM。

在本主题中︰

• 概述
• 支持的 OData 版本
• 支持的 ALM 实体类型
• 先决条件
• 身份验证
• 从 BI 工具连接到 ALM 数据
• 在分析之前处理检索到的 ALM 数据

概述

此概述描述了使用 OData 和 ALM 的工作流。

1. 按照先决条件中的说明，准备 OData 连接。

2. 使用支持 OData 的 BI 工具 (例如 Power BI 和 Tableau) 通过 OData 检索 ALM 数据。

   有关详细信息，请参阅从 BI 工具连接到 ALM 数据。

3. 在分析之前处理检索到的 ALM 数据。

4. 使用 BI 工具为 ALM 数据生成报告和图表。

返回页首

支持的 OData 版本

ALM 支持 OData 版本 4.0。

任何支持 OData 版本 4.0 的工具都能够很好地兼容 ALM。

ALM OData 支持已通过 Power BI 和 Excel 的测试。

返回页首

支持的 ALM 实体类型

从 BI 工具连接到 ALM 项目后，您可以检索以下项目数据:

• Releases

• 周期

• 需求

• 测试文件夹

• 测试

• 测试设计步骤

• 测试集文件夹

• 测试集

• 测试实例

• 测试运行

• 用户数

• 缺陷

返回页首

先决条件

在使用 OData 之前，请收集以下连接信息:

先决条件	详细信息
启用 OData 支持	要启用 OData 支持，请将 IS_ODATA_SERVICE_ENABLED 参数设置为 Y。 有关详细信息，请参阅 ALM 站点参数。
ALM 的 OData 数据源 URL	ALM 数据可以通过独特的 OData 数据源 (或 OData 源) 访问，允许用户通过不同的 BI 工具无缝连接到 ALM 数据。 ALM 的 OData 数据源遵循以下 URL 格式: https://<ALM 服务器>/qcbin/odatasvc/domains/<域名>/ projects/<项目名称>。 例如，您使用以下数据源 URL 连接到 DEFAULT/Demo 项目数据。 http://<您的 ALM 服务器>/qcbin/odatasvc/domains/DEFAULT/projects/Demo 要包括多个项目的数据，请逐一输入这些项目的数据源 URL。
登录凭据	您可以使用 API 密钥连接到 ALM OData 数据源。为您的 ALM 帐户完成以下操作: 为您的 ALM 帐户生成 API 密钥。记下客户端 ID 和 API 密钥。 为 API 密钥启用 OData。 有关详细信息，请参阅设置 API 密钥访问权限。
启用全名支持	仅当您想要检索用户的全名时才需要。 默认情况下，仅检索用户的用户名。如果您还想获取全名，请将 IS_ODATA_SHOW_FULL_NAME 站点参数设置为 Y。 注: 在启用全名支持之前，请考虑您组织的策略。

返回页首

身份验证

首次从 BI 工具连接到 ALM OData 数据源时需要进行身份验证。

使用 BI 工具中的基本身份验证选项。

使用与您的 ALM 帐户关联的客户端 ID 和 API 密钥进行身份验证。

字段	描述
用户名	输入客户端 ID。
密码	输入 API 密钥。
选择要将这些设置应用到的级别	因 BI 工具而异。 指定可以共享用户名和密码进行身份验证的级别: http://<您的 ALM 服务器>/qcbin/odatasvc/domains/。您可以使用用户名和密码连接指定服务器中任何域的任何项目。 http://<您的 ALM 服务器>/qcbin/odatasvc/domains/<域名>。您可以使用用户名和密码连接到指定域下的任何项目。

返回页首

从 BI 工具连接到 ALM 数据

您可以使用任何支持 OData 的业务智能工具 (例如 Power BI、Tableau 和 Excel) 连接到 ALM 数据。

示例：从 Power BI 连接到 ALM 数据

1. 打开 Power BI。选择“主页”>“获取数据”>“OData 源”。

   

2. 在“OData 源”对话框中，选择“基本”，输入您的 ALM OData 数据源 URL，然后单击“确定”。

   

3. 选择“基本”，然后输入您的登录凭据。

   

示例：从 Tableau 连接到 ALM 数据

1. 打开 Tableau。从侧边菜单 >“连接”>“到服务器”，选择“更多”，然后选择“OData”。

2. 在“服务器”字段中，输入您的 ALM OData 数据源 URL。

3. 在“身份验证”字段中，选择“用户名和密码”。

4. 输入您的登录凭据。

示例：使用 Excel 连接到 ALM 数据

1. 打开 Excel 工作表。选择“数据”>“获取数据”>“从其他来源”>“来自 OData 源”。

2. 在“OData 源”对话框中，选择“基本”，输入您的 ALM OData 数据源 URL，然后单击“确定”。

3. 选择“基本”，然后输入您的登录凭据。

返回页首

在分析之前处理检索到的 ALM 数据

此部分列出了一些有关在使用 BI 工具处理 ALM 数据之前对其进行处理的建议。

• 筛选数据

• 扩展数据

• 构建实体关系

筛选数据

如果要处理缩小范围的 ALM 数据，您可以按以下类型的表列筛选检索到的数据:

• ID。例如“缺陷 ID”。

• 时间。例如“实际修复时间”。

• 日期。例如“关闭日期”。

  

扩展数据

连接到具有多个表的 ALM 的 OData 数据源时，您可以使用表列上的扩展选项来添加相关表中的其他列。这可以帮助您跨表构建查询。

例如，“缺陷”表包含对多个相关表的引用，其中包括“发布”表。您可以使用“缺陷”表的 target_rel 列上的扩展选项来添加与发布相关的更多列，例如 name 列。扩展 target_rel 列后，“缺陷”表中会再添加一个名为 target_rel.name 的列。

以下是有关扩展“缺陷”表的 detected_by_user 列的另一个示例。选择 full_name，然后将添加 detected_by_user.full_name 列。

构建实体关系

创建表之间的关系以准确计算结果并在分析中显示正确的信息。当您处理 ALM 一对多、多对多或多级实体关系时，这一点尤其必要。

以下是测试集文件夹、测试集、测试实例和测试的关系。

返回页首