xCharts is a charting app that allows to generate custom charts & reports directly within Jira to visualize project and issue analysis. New charts can easily be created in no time by using chart & report templates. Furthermore, these templates can be expanded by just scripting own charts using Groovy and Javascript.

Install xCharts

Install xCharts directly from your Jira instance.

You need to be a Jira administrator to install apps!

Click on the cog icon on the top right bar and select Manage apps

The Atlassian Marketplace will be displayed, in the search bar type in xCharts

The app will appear on the list, click on Install and then Accept & install.

After the installation, a charts tab will appear on your Jira's navigation bar and you're ready to get started!


If you still have questions, feel free to refer to our support team.

First steps

xCharts is a charting app that allows generating custom charts & reports directly within Jira to visualize projects and issue analysis. New charts can easily be created in no time by using chart & report templates. Furthermore, these templates can be expanded by just scripting your own charts using Groovy and Javascript.

After installing xCharts, a charts tab will appear on your Jira's navigation bar:

 

Get to know xCharts

Chart browser

The Chart browser can be used for browsing through all created charts, grouped by:

  • Favorites: Lists all charts that are marked as favorite
  • Configured charts: Lists all saved chart configurations based on Built-in charts.
  • Custom charts: Lists all saved chart configurations based on Scripted charts.
  • Built-in charts: Lists all built-in charts where no configuration is needed

Additionally, it is possible to:

  1. Open the chart in a new tab
  2. Edit the chart configuration
  3. Export the chart as PNG or SVG.
Charts

Here are all charts listed that can be viewed by the current user. If he does not have the required permission, the chart won't be shown.

Charts can be viewed by clicking on the chart name.

Favorite: Shows whether a chart is marked as favorite or not.

Available chart types:

Chart templates

This page gives you an overview about all configurable built-in & scripted charts. New charts can be created by clicking the + button.  

Name: Displays the name and a description of a template. 

Parameters: Show all parameters, which can be defined for a chart 

Chart Type: Shows whether a chart is a built-in or a scripted chart. 

Gadgets

Currently there are two gadgets available within xCharts:

They can be used for displaying the created charts right on the dashboard.


Charts in projects and issues

xCharts adds a "Charts" tab to the project navigation providing quick and easy access to relevant charts relevant for the project, e.g. Tickets over Time.

Favorite charts

When marking a chart as favorite chart, it will be available in the drop-down menu on the "Chart browser" page and in the drop-down "Charts" menu in the Jira top navigation bar.

Glossary

Built-in chart: Chart that is bundled in the plugin (configurable or not)

Scripted chart: Chart created by users, written in Groovy Script.

Javascript layout: The JS function that generates the c3.js chart and displays it.


If you still have questions, feel free to refer to our support team.

Create your first chart

Creating a brand new chart can easily be done by using one of the many built-in templates.

Head over to the new tab Charts → Chart templates and click on the + button under actions

On the upcoming page, the chart can be configured according to the specific needs by e.g. entering a JQL or selecting a Field to be summed up.

After setting the chart up it can be previewed by hitting "Chart preview".

Finally, the chart can be saved by clicking on "Save as chart".

Created charts can then be accessed by either going to the "Chart browser" or by clicking "Charts" in the sidebar.


If you still have questions, feel free to refer to our support team.


Highlights

Built-in chart templates for every need

The presentation of data is so essential that no user should need programming skills to visualize the company, project, or issue data. And you don't have to!

  • The choice is yours - choose from more than a dozen templates to let your data shine.
  • Something for every taste - layouts range from pie charts to multiple types of bars, tables, and line charts.
  • Just a click away - easily manage created charts and templates using the chart browser directly from the Jira top menu navigation.

Dashboard gadgets with static and live configuration

Two gadgets are enough for all the charts in the world. And that's exactly the amount of gadgets that come with xCharts for Jira. They complement each other to satisfy the entire range of your reporting needs.

  • Play it safe - use our standard dashboard gadget for static display of charts on as many dashboards as you like.
  • Designed for interaction - use the xChart Gadget+ to enhance the built-in charts with configurable parameters directly on the dashboard.
  • Works in Confluence - use our standard gadget on any Confluence page to visualize Jira content and break down the reporting data silo.

Scripting capabilities for custom charts to go beyond

There is no single diagram that works for all reporting needs. Implement your own custom data visualization using Groovy scripts. Build them from scratch or modify existing templates and create highly customizable diagrams ranging from fully parameterized charts to pre-defined charts offering more guidance and leaving less room for misconfiguration - nothing is impossible!

  • Smart and beautiful - the support of the C3.js library opens up extensive customization possibilities.
  • Extend and brand - Add your own resources like Javascript libraries or CSS files for reusing them across charts and additional customizing options.
  • Connect the dots - pull in data from external sources like databases or web services.

Advanced permission management

A straightforward and simple permissions management helps you meet all your users' needs while granting privileges based on their abilities. This is just an option - not an obligation.

  • Reporting only - Grant access to configured charts in the chart browser and the dashboards gadgets.
  • Contributors welcome - Enable users to create new charts from templates to meet new requirements.
  • The real reporting MVP - Create scripted charts and make them available as templates for further use.

Publishing and migrating charts & reports

xCharts for Jira is designed as an open system. Scripted charts can be easily moved between instances with built-in functionality. In addition, you can take advantage of the expressiveness of your charts to enhance documents and presentations by simply exporting them to graphic files.

  • Test and deploy - easily migrate your chart scripts between instances as scripted chart bundles.
  • Show and tell - export charts and reports as PNG and SVG graphic file formats from the chart browser.
  • Need inspiration? Download as many chart examples as you like from our documentation - at no cost.