Advanced exports – iceScrum

Obsolete iceScrum documention (R6#14+) This documentation applies only to old iceScrum R6. For new iceScrum v7, click here.

The publish feature is useful for printing out iceScrum elements, but isn’t suited for raw data export. That’s why we introduced new exports that include more data and are easier to process (CSV format).

These exports are contextual: choose exactly what to export thanks to regular filtering or advanced filtering from the Finder view.

Usage

Advanced exports are available in most iceScrum views from the toolbar, just like the publish feature. Since they allow exporting a significant amount of data, they are available only for members of your team.

Export are available for the following views:
sandbox: outputs the sandbox stories,
backlog: outputs the backlog stories,
release plan: outputs the release stories ordered by sprint,
sprint plan: outputs the sprint tasks,
timeline: outputs a zip that contains two files, one for sprints and one for releases,
actors: outputs actors,
features: outputs features,
finder: outputs a zip that contains elements according to your needs (using filters).

Format

We chose a very light format in order to allow simple processing of exported data: CSV, which stands for Coma Separated Value.

When clicking on “export”, a dialog allows you to customize the CSV format according to your needs, by choosing the field separator and the character used to encapsulate data (quote separator).

Both are required to ensure the export format consistency. Here are possible values:
– field separator: coma (default), semicolon (choose semicolons if you use Excel), tabs (enter “tab”)…
– quote separator: double-quote (default), single quote…

Important notice: in the dialog, you can choose to remove the column headers. However, for most usages, this is not recommended. Indeed, as iceScrum evolves, data structures may change so you can’t rely on the order of fields. Thus, we strongly recommend that you rather use column headers in order to identify these fields.

The output is encoded with UTF-8 so if you have trouble when reading it, try to switch encoding in your tool.

Custom content

Contrary to printing features that allow exporting whole iceScrum views, advanced exports are context-sensitive. Basically, this means that only displayed elements are exported. This allows you to use filters to choose which elements your want to export.

This is also true from the finder view, so you can use its powerful filters to export exactly what you want. For instance, you can search for defects that affect the version 2.5 of your product, and export them all. This is even more powerful is you use this in combination to Web Services, see the next section.

Web Services API

Exports Web Services are available only if Web Services are enabled for the project. Please refer to the main iceScrum API documentation for more information.

Choose the view :view in the URL: sandbox, backlog, releasePlan, sprintPlan, timeline, actor, feature, finder.

GET http://:server/ws/p/:pkey/:view/csv

For releasePlan and sprintPlan, the current release or sprint is exported respectively. You can choose another sprint / release by providing its identifier :id in the URL:

GET http://:server/ws/p/:pkey/:view/:id/csv

If you don’t want to use the default format, you can define a custom format using GET parameters:

Input


separator
Optional - field separator

quote
Optional - character used to encapsulate data

headers
Optional boolean - whether to export headers

filename
Optional

Please note that the finder has its own parameters, please refer to the finder Web Services documentation.


Try it for free now
All you need for your Agile project management