Report

Allow add-ons to define a new report, which is linked from a project page.

Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
{
  "modules": {
    "jiraReports": [
      {
        "url": "/report?projectKey={project.key}",
        "description": {
          "value": "This is an example report"
        },
        "reportCategory": "agile",
        "thumbnailUrl": "http://example.com/images/report-example-thumbnail.png",
        "name": {
          "value": "Example Report"
        },
        "key": "report-example"
      }
    ]
  }
}

Properties

description

Type
i18n Property
Required
Yes
Description

A human-readable description of this report module. This description is displayed on the reports list.

Represents a string that can be resolved via a localization properties file. You can use the same i18n Property key and value in multiple places if you like, but identical keys must have identical values.

Example

1
2
3
{
  "value": "My text"
}

Properties

value
Type
string
Required
Yes
Description

The human-readable default value. This will be used if no translation exists. Only the following HTML tags are supported: b, i, strong, em, and code.

i18n
Type
string
Description

The localization key for the human-readable value. Translations for the keys are defined at the top level of the add-on descriptor.

key

Type
string
Max length
100
Required
Yes
Pattern
^[a-zA-Z0-9-]+$
Description

A key to identify this module.

This key must be unique relative to the add on, with the exception of Confluence macros: Their keys need to be globally unique.

Keys must only contain alphanumeric characters and dashes.

The key is used to generate the url to your add-on's module. The url is generated as a combination of your add-on key and module key. For example, an add-on which looks like:

1
2
3
4
5
6
7
8
{
    "key": "my-addon",
    "modules": {
        "configurePage": {
            "key": "configure-me",
        }
    }
}

Will have a configuration page module with a URL of /plugins/servlet/ac/my-addon/configure-me.

name

Type
i18n Property
Required
Yes
Description

A human readable name.

Represents a string that can be resolved via a localization properties file. You can use the same i18n Property key and value in multiple places if you like, but identical keys must have identical values.

Example

1
2
3
{
  "value": "My text"
}

Properties

value
Type
string
Required
Yes
Description

The human-readable default value. This will be used if no translation exists. Only the following HTML tags are supported: b, i, strong, em, and code.

i18n
Type
string
Description

The localization key for the human-readable value. Translations for the keys are defined at the top level of the add-on descriptor.

url

Type
string
Format
uri-template
Required
Yes
Description

Specifies the URL targeted by the report. The URL is relative to the add-on's base URL.

reportCategory

Type
string
Defaults to
other
Allowed values
  • agile
  • AGILE
  • issue_analysis
  • ISSUE_ANALYSIS
  • forecast_management
  • FORECAST_MANAGEMENT
  • other
  • OTHER
    • Description

    The category of the report. The default category is other.

    thumbnailUrl

    Type
    string
    Format
    uri-template
    Description

    Specifies the URL of the report thumbnail. The URL is relative to the add-on's base URL.