如何通过API或其他方式获取IBM DOORS健康数据以搭建仪表盘？

先理清基础前提 #

• 确认DOORS版本：DOORS 9和DOORS Next Generation（DNG）的API体系完全不同，先明确你用的是哪款——DOORS 9依赖DXL+COM，DNG有标准REST API。
• 搞定权限：必须拿到项目读取或管理员权限，健康数据（模块状态、系统指标、用户活动）属于敏感数据，没有对应权限无法调用相关接口。
• 测试环境练手：别直接操作生产数据，先在测试环境跑通API调用和数据导出流程，避免误操作影响业务。

分版本选择API方案 #

针对DOORS 9

• 优先用DXL脚本：这是DOORS 9的原生扩展语言，能直接读取系统健康数据，写个简单脚本就能导出结构化数据（JSON/CSV）供仪表盘使用。示例片段：

// 导出当前模块的核心健康指标
Module currentMod = current
string result = "模块名称,未解决批注数,断链数量\n"
result += fullName(currentMod) + "," + string(count(find(currentMod, "Comment", "Unresolved"))) + "," + string(count(brokenLinks(currentMod)))
print result

写完脚本后，可通过DOORS命令行执行并输出到文件：doors.exe -batch -run export_health.dxl > health_data.csv

• 备选COM接口：用VBA或.NET调用DOORS的COM对象远程拉取数据，但稳定性不如DXL，适合需要跨程序集成的场景。

针对DOORS Next Generation（DNG）

• 使用官方REST API：DNG有专门的健康数据端点，核心几个如下：
  • 项目健康状态：/rm/publish/resources/project/{projectId}/health
  • 模块完整性检测：/rm/publish/resources/module/{moduleId}/health
  • 系统性能指标：/rm/admin/monitoring/metrics
• 调用流程：先通过OAuth2获取访问令牌，请求头带上Authorization: Bearer <你的令牌>，返回的JSON数据可直接供仪表盘解析。

数据适配仪表盘的实用技巧 #

• 统一数据格式：把API返回的数据转换为JSON/CSV格式，绝大多数仪表盘工具（Tableau、Power BI、自定义Web面板）都支持这两种格式。
• 定时同步：健康数据需要一定的实时性，写个定时脚本（比如用Python的requests库调用DNG API，或用批处理执行DXL），每天/每几小时导出一次数据并推送到仪表盘数据源。
• 聚焦关键指标：别贪多，先抓核心健康维度：
  • 模块断链占比（反映需求一致性）
  • 未解决批注数量（跟踪待处理问题）
  • 系统响应时间（DNG专属，监控服务状态）
  • 活跃用户数（查看项目使用热度）

避坑提醒 #

• 版本兼容：DNG的REST API会随版本更新调整端点，要对照你当前版本的本地官方文档调整请求路径。
• 性能优化：批量拉取数据时使用分页参数（比如?pageSize=50&pageNumber=1），避免一次性拉取过大数据集导致超时。
• 错误处理：API调用要加重试机制，处理权限不足、服务临时不可用等异常，避免仪表盘因单次调用失败而无法正常展示数据。

内容的提问来源于stack exchange，提问作者Shahana Shaikh