Reporting Jira Data Provider macro allows reading of Jira issue data from the specified Jira instance. The issues are searched by specified JQL query. The max number of issues may be specified, but cannot be higher than 1000 items. Data providers in Reporting return data in a form of an array of JSON objects - one JSON object per each report line. Then, in Reporting Table Item formulas these objects may be accessed via CurrentItem variable.

Reporting table of Jira stories sorted by priority and limited to five rows

Example: Jira stories returned by the Jira Data Provider, sorted by priority and limited to five rows.

Reporting Jira Data Provider macro has the following parameters:

Parameter Description
[String] Source (default=''(Empty value))

Data Center: the Application Link name of the Jira instance to read data from. Cloud: not used - data is always read from the Jira Cloud site connected to your Confluence site (a value kept from a page migrated from Data Center is ignored).

Examples:

  • [Server/Datacenter] '' (Empty value) - Jira instance on Primary Link will be used.
  • [Server/Datacenter] 'My Company Jira' - Jira instance with App Link name 'My Company Jira' will be used.
[String] Query (default=''(Empty value))

A JQL query to be used to search for Jira issues. This parameter cannot be empty.

Examples:

  • 'Project = TST' - returns all issues of the TST project.

New! The query may contain variables that are replaced with the current page's values before the query runs, so the same report placed in a page template works on every page created from it:

  • '${page.title}' - the title of the page
  • '${page.id}' - the page ID
  • '${space.key}' - the key of the page's space
  • '${today}' - today's date as YYYY-MM-DD

Put them inside quotes, e.g. 'project = "${space.key}" and labels = "${page.title}"' or 'duedate < "${today}"' - quotes inside the values are escaped automatically.
[String] Fields (default=''(Empty value))

A list of fields to return for each issue, use it to retrieve a subset of fields. This parameter accepts a comma-separated list.

Examples:

  • 'summary,comment' - Returns only the summary and comments fields.
[String] Filter (default=''(Empty value))

The formula, which filters out the values when it returns False. Ignored if empty. A comparison that cannot be evaluated – a number against text, or an empty field – counts as False (since Reporting 14.1.0).

Examples:

  • 'FIND("Report", CurrentItem.fields.summary) > 0' - Returns True for the issues with the summary, which contains a 'Report' word. So this formula helps to create a report with the issues, which have 'Report' word in its summary.
  • 'CurrentItem.fields.timeestimate > Average(AllItems.fields.timeestimate)' – New! – keeps only the issues whose remaining estimate is above the average remaining estimate across all the (unfiltered) fetched issues. In addition to CurrentItem, the Filter formula may now reference AllItems / AllItems.<path> – a range covering every fetched issue's value at that path – so aggregate functions like Sum, Average, Max, Min can be used to build "above the average" / "equal to the max" style filters.
[Long] Max results (default=1000) The maximum amount of issues to be returned. This feature is convenient to create the lists of TOP Something, when the issues are sorted in JQL query and the amount is limited with this parameter.

More examples

Jira stories with more story points than the average of all stories, with the sum in the footer

Example: Filter CurrentItem.fields.customfield_10016 > Average(AllItems.fields.customfield_10016) keeps only the stories estimated above the average.

Jira stories with the Story points custom field, assignee and priority, story points summed in the footer

Example: Fields = summary,assignee,priority,customfield_10016 - a custom field is read by its ID like any other field.