跳到主要内容

从 Jira 仪表板导入

Exportelier 可以读取 Jira 仪表板,并根据读到的内容构建一个报表。你选择一个仪表板,Exportelier 逐个小工具告诉你它理解了什么,你补齐 Jira 未提供的部分,最终得到一个普通的可编辑报表。

开始之前有两件事值得了解,因为它们决定了本页其余的全部内容。

这是语义导入,不是截图

Exportelier 导入的是仪表板的配置——用的是哪个过滤器、哪个字段、哪种图表类型——并用自己的组件重新构建。结果不是屏幕截图,不是像素级复刻,也不是嵌入的 Jira 页面。列宽、小工具外框和精确间距都不会被复现,因为 Jira 的公开 API 并不暴露这些信息。

手动修补是常态,不是缺陷

Atlassian 并不保证内置小工具的设置可以通过公开 API 读取。当某项设置无法读取时,Exportelier 会请你自行选择。它绝不猜测你指的是哪个过滤器或哪个字段。

可导入的内容

Jira 小工具转换为说明
Filter Results工作项表格保留小工具选定的列及其顺序
Pie Chart分类图表(饼图)使用小工具的统计类型
Work Item Statistics分类图表(柱状图)使用小工具的统计类型
Two Dimensional Filter Statistics矩阵使用两个坐标轴字段
Created vs. Resolved Chart时间序列图表保留小工具的统计周期与回溯范围——参见下方限制
Sprint Burndown——需要历史冲刺数据,Exportelier 目前尚未提供
其他任何小工具——会被列出并排除,绝不静默丢弃

仪表板上的每个小工具都会得到且仅得到一种状态:

  • 就绪 —— 已识别,且所需信息全部可读。
  • 需要修补 —— 已识别,但你需要补充某项缺失的设置。
  • 后续支持 —— 已识别,但对应的 Exportelier 组件尚不存在。Sprint Burndown 属于此类。
  • 不支持 —— 第三方或未知小工具。它会被列出名称,而不是被隐藏。
  • 错误 —— Jira 不允许 Exportelier 读取它,或读到的内容自相矛盾。这一类会阻止导入,直到你在 Jira 中修复为止。

识别依据是小工具的技术标识,绝不依据其标题。在 Jira 中重命名小工具,或把 Jira 切换成另一种语言,都不会改变 Exportelier 对它的判断——把某个自定义小工具命名为 “Pie Chart” 也不会让它变成饼图。

Created vs. Resolved 图表展示的内容

导入后的 Created vs. Resolved 图表统计的是其保存的过滤器在今天所匹配的工作项的创建日期与解决日期。它不会重建该过滤器在过去所匹配的工作项集合。

当过滤器的成员范围发生过变化时,这一点就很重要。如果某个工作项被移出了过滤器覆盖的项目,它会从图表的每一个区间中消失——包括移动之前的区间。Jira 自带的小工具出于同样的原因也是如此,但在比较相隔数月的两份导出前,仍值得先了解这一点。

此外还可能存在三处差异,每一处在适用时都会写进报表的完整性提示中:

  • 统计周期。 按日、按周和按月会被精确复现。按小时会变为按日,按季度和按年会变为按月——总数不变,只是每个区间的宽度不同。
  • 未解决趋势线。 Jira 可以叠加第三条线,表示随时间变化的未完成工作项。Exportelier 的图表只显示创建和已解决两个序列。
  • 回溯范围。 超过 366 天的周期会被缩短为 366 天。

其余内容——过滤器、累计模式以及数值本身——都会原样保留,并且之后你可以在设计器中编辑上述每一项设置。

导入

  1. 打开报表,选择从 Jira 仪表板导入
  2. 选择一个仪表板。这里只会出现 Jira 本来就向你显示的仪表板——身为 Exportelier 站点管理员并不会扩大这个列表。
  3. 阅读分析结果。每个小工具都会列出其状态。
  4. 修补需要修补的项。你通过常规选择器来选取保存的过滤器和字段;按设计,这里没有原始 JQL 输入框。
  5. 检查完整性。所有将被排除的内容都会按名称列出,你必须明确确认这些排除项,报表才能创建。
  6. 创建报表。它会在常规设计器中打开,完全可编辑。

任何仍标记为需要修补错误的项都会阻止创建。Exportelier 宁可拒绝,也不愿生成一份悄悄遗漏了半个仪表板的报表。

完整性提示

每份导入的报表都以完整性提示开头——它是文档中真实存在的组件,而不是界面上的一条提示。它会写明来源仪表板、导入时间、仪表板中有多少小工具被包含在内,以及所有未被包含的小工具的标题。

全部导入成功时,它是一条信息提示;有任何内容被排除时,它是一条警告。它在 PDF、Word 和 Markdown 中同样会出现。

只要报表仍与其导入源相关联,该提示就由 Exportelier 管理:你可以自由调整版面的其余部分,但不能删除或改写该提示。如果它仍被移除或修改,报表将无法导出——一份声称代表某个仪表板、却又悄悄遗漏其中一部分的文档,比没有文档更糟。

如果你想要一份不带该提示的报表,请复制它。副本是一份普通报表,背后没有导入源,也没有受管理的提示。

与仪表板保持同步

导入是对仪表板配置的一次快照。数据保持实时:报表始终在导出时读取其保存的过滤器,因此即使在导入数月之后,数字依然是最新的。

不会自动更新的是版面与配置。如果有人在 Jira 中新增了一个小工具,或把某个小工具指向了另一个过滤器,在你另行处理之前,你的报表会完全照旧继续工作。

打开报表并使用检查变更。Exportelier 会重新读取该仪表板,并把每个小工具归类为新增、移除、移动、配置已更改或未更改。随后由重新导入来应用这些变更:

  • 未更改和仅移动的小工具保持原样;
  • 你手动添加到报表中的内容不会被触碰;
  • 已更改和新增的小工具会获取最新内容;
  • 若某个小工具的新配置无法自动解析,重新导入会停下并转入修补流程,而不是用猜测覆盖你的成果;
  • 此前因“后续支持”而被排除、且较新版本的 Exportelier 现已能够导入的小工具会显示为已更改,重新导入会把它追加到报表末尾。现有报表绝不会仅仅因为发布了新版本就自动多出一个组件——必须由你主动要求。

重新导入之前会自动保存一个模板版本,因此恢复版本可以撤销这一操作。

没有调度器,也没有后台同步。重新导入只在你要求时发生。

权限

导入、重新导入和删除导入都是站点管理员操作。

每一次仪表板、小工具和过滤器的读取,都以执行导入的那个人的身份运行——站点管理员无法导入 Jira 不向其显示的仪表板。之后的导出会以执行导出者的身份重新读取报表的过滤器,因此导入不会扩大任何人对 Jira 数据的访问范围。参见权限与角色

限制

限制项数值
每次导入分析的小工具数12
超出该上限后可供选择的小工具数60

小工具超过十二个的仪表板不会被截断。系统会请你选择要导入哪些小工具,未选中的那些会像其他排除项一样写进完整性提示。

导入生成的报表就是普通报表,并继承全部报表限制——数据源、组件、每个数据源的工作项数量。参见限制参考

关于所使用的 Jira API

Exportelier 只通过 Atlassian 已公开文档化的 Jira Cloud 仪表板 REST API 读取仪表板。它不解析 Jira 网页,不读取小工具 iframe,不截图,也不使用未公开的端点。

其中一个操作——用于列出仪表板小工具的 Get gadgets——被 Atlassian 标记为实验性。这意味着 Atlassian 可能在不提供 API 其余部分那种稳定性保证的情况下更改它。如果它的变更方式是 Exportelier 无法识别的,仪表板导入会自行关闭并给出说明,而不是导入一份它已经误读的内容。发生这种情况时,你现有的报表、模板和导出都不受影响。

相关页面