介绍这个插件之前,肯定会有人问,JIRA自己不是提供了导出的功能吗?干嘛还需要额外的导出插件呢

存在即有原因的(我想这句话这么翻译是准确的),我们先来回顾一下JIRA提供了什么样的导出功能?有什么问题?满足不了什么诉求?

JIRA 自身导出功能及问题

JIRA本身提供了导出的功能

  • 在Issue响应页面单个JIRA Issue 可以导出成Word、html 格式
  • 搜多的issue列表可以导出成csv、html等格式

JIRA自己有导出功能,但比较简陋,又有诸多问题

  • 无法自定义模板
  • 导出格式比较简单,不能定义,无法输出出一个漂亮的报告,往往还需要后期加工才能使用
  • 导出的字段名称不能自己修改和定义
  • 支持导出的文件格式较少
  • 一些特殊的数据,比如时间之类的格式不能额外处理
  • csv的导出是utf-8格式的编码,使用excel打开中文乱码,需要先转编码

Xporter功能特点

那么为什么要导出Issue呢? 有这样一些常见的场景,也是Xporter等导出工具要解决的问题

  • 我希望可以定义一个Excel文件模板,数据报表的格式也都做好了,只需要在JIRA上点一个按钮可以把我要的数据导出到这个Excel模板中,生成一个报告,什么额外的工作也不用做,给客户或领导汇报时直接拿出这个报告就可以直接用
  • 版本发布时,自动生成一个Release Note,这个Release Note可以交付给客户
  • 一些Critical的问题要讨论时,可以一键生成这个问题的详解内容
  • ...

Xporter提供了丰富的功能来满足这些导出需求

  • 可以自定义模板
    • 模板可以根据自己的需求灵活编辑
    • JIRA管理员和项目管理员都可以添加模板
    • 模板市场提供了丰富的模板供使用,而且基本都是免费的
  • 支持多种格式的输出
    • word, excel, pdf, txt, json, html 以及常用的图片个格式等
  • 导出方式多样
    • 用户手动导出
    • 定义时间自动导出
    • 加到工作流中的post function中, 执行工作流操作的时候导出,可以生成Issue的附件
    • 可以发送邮件,或推送到文件服务器上

Xporter的使用

Xporter模板

首先需要模板,Xporter 默认提供了一些模板,最好自己定义一些,方法很简单,把Xporter的模板下载下来,然后修改一下再传上去就可以用了

模板管理入口

JIRA系统管理员在 ⚙︎管理 -》 插件 -》Xporter 中管理整个系统的模板


项目管理员在 项目设置 -》 Xporter -》Template   中添加项目的模板


下载、编辑模板

你可以现在系统模板,或者从模板市场下载一个模板编辑

在系统模板里下载模板


以 issue List Excel这个模板为例,下载后编辑,如下


其中如果想添加自定义的字段就用  ${字段名称} 就可以了,如 ${Summary}

上面例子的报告人和分配人 还加了一些链接

&{for issues} ... {end} 代表把issue列表迭代输出

更多语法和详细介绍,请参见 Xporter 官方文档中 template 的说明

编辑好的Excel文件附件如下,您可以下载参考


上传模板


添加模板时需要指定几项内容

  • 模板名称
  • 模板描述
  • Scope范围,即哪里要用到这个模板
  • 模板附件


使用Xporter导出

模板上传好之后,我们就可以使用这个模板导出Issue列表了

先使用查询语句查出需要导出的Issue,然后右上角导出中选择  Xporter


选择Xporter的模板,刚才上传的那个模板



然后点击 Export ,等导出成功之后就可以下载



导出后的效果如下


具体Excel 文件效果可以在这里下载