Get started

Built-in charts & reports

Dashboard gadgets

Self scripted charts

Manage permissions


Import and export scripted charts


xCharts API Javadoc


Chart scripting examples

Additional product info

Versions Compared

Old Version 5

changes.mady.by.user Iheb Kharab

Saved on

compared with

New Version Current

changes.mady.by.user Iheb Kharab

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


UI Text Box
sizemedium
typeinfo

The idea behind parameters is that maybe an administrator wants to create a template script, like we have created our own script templates, but allow users of this particular script to configure projects, fields, etc according to their own needs.

This makes reusing scripted charts very easy because different configurations with different parameters can be saved based on a single scripted chart!

Since parameters are useful in scripting own charts, we create new types with different releases. 

For now, there are 3 main types of parameters available:

  • TEXT: simple text field
  • BOOLEAN: checkbox parameter (since version 1.2.0)
  • PICKER: different pickers for Jira Fields, Issues, Grouping, Intervals, Dates, Chart Options, etc.

Since the boolean and text pickers are straightforward to use, we will dive into explaining the Picker parameters.



Picker parameterPicker typeDescriptionAvailable since
Jira Software Picker

Sprint pickerPick any sprint to use in the data scriptVersion 1.3.0
Board pickerPick any boardVersion 1.3.0
Common PickerVersion pickerSelect any versionVersion 1.3.0
Group by pickerAllows grouping of data according to selected fieldsVersion 1.1.4
Interval picker

This parameter has two possible inputs:

  • absolute time
  • relative time

Absolute Time: a simple date picker for each field

Relative Time: relative time to the current date, useful for periodic reports 

This option can be either manually set, by writing in the field a value in this form:

-2m, where:

- means it goes backward from today

2 is the amount

m: time unit, in this case, months (can be: d - day, w - week, m - month, q - quarter, h - half year, y - year)

or it can be selected by clicking on and selecting manually the amount, time unit, and positive or negative direction on the time axis.

Version 1.1.4
Time period picker
  • This picker extracts values from certain fields (ex. Story Points field, will take the SP value: 5 SP)
  • By default, only the fields that have values to be extracted will be displayed as options in this field
Version 1.1.4
SQL text area pickerUseful for SQL queries, highlights the syntax, making it easier to write SQL queriesVersion 1.1.4
Chart type picker
  • Sets the chart type
  • Available values (from the c3.js library): line, spline, step, area, area-spline, area-step, bar, scatter, pie, donut, gauge.

Issue/Project picker (single and multi values)

Choose projects and or issues (single or multi) as input for your chart data  (alternative to JQL Parameter)


Group/User picker (single and multi-selection)

User and group picker (single and multi-selection) - same Jira functionality as normal Jira Group and User Picker


Date field picker (single and multi-selection)

Allows the user to select one or more date fields from Jira, both system and custom fields



Excerpt Include
DECADIS:Contact support
DECADIS:Contact support
nopaneltrue