Documentation

Dashboard Item

Dashboard items allow add-on to display a summary information data on the dashboard. Each dashboard-item can be configured to display information relevant to a particular user.

Example

For a full add-on example, see dashboard item example add-on.

{ "jiraDashboardItems": [ { "description": { "value": "Dashboard item description" }, "url": "/dashboard-item-test?dashboardItemId={dashboardItem.id}&dashboardId={dashboard.id}&view={dashboardItem.viewType}", "configurable": true, "thumbnailUrl": "atlassian-icon-16.png", "key": "dashboard-item-key", "name": { "value": "Dashboard item title" } } ] }

Properties

description

Type
i18n Property
Required
Yes
Description

Description of the dashboard item. This will be displayed for a user in the directory.

name

Type
i18n Property
Required
Yes
Description

A human readable name.

key

Type
string

^[a-zA-Z0-9-]+$
Required
Yes
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:

{ "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.

thumbnailUrl

Type
string

uri-template
Required
Yes
Description

URI of the dashboard item thumbnail which is displayed in the directory.

url

Type
string

uri-template
Required
Yes
Description

The URL of the service which will render the dashboard item. Following context parameters are supported in url.

  • dashboard.id unique id of the dashboard on which the item is rendered. This parameter is passed only on default view
  • dashboardItem.id unique id of the dashboard item which is rendered. This parameter is passed only on default view
  • dashboardItem.key key of the dashboard item. This parameter is passed in both: default and directory view
  • dashboardItem.viewType type of the view in which dashboard item is displayed. Default (for dashboard) and directory. This list may be extended

conditions

Type
[ Single Condition, Composite Condition, … ]
Description

Conditions can be added to display only when all the given conditions are true.

configurable

Type
boolean
Defaults to
false
Description

Specify if the dashboard-item is configurable or not. Configurable dashboard items should render configuration view if there is no configuration stored for the dashboard item. Dashboard item properties can be used for configuration storage.

In addition, configurable dashboard items should register a javascript callback for edit click.

 AP.require(['jira'], function (jira) { jira.DashboardItem.onDashboardItemEdit(function() { // render dashboard item configuration now }); });

It is a common case to give users ability to set the name of the dashboard item. This can be achieved with a following JS code:

 AP.require(['jira'], function(jira) { jira.setDashboardItemTitle("Setting title works"); });

params

Type
object
Description

This object represents a map of key/value pairs, where each property name and value corresponds to the parameter name and value respectively.

Example

{ "params": { "someOtherProperty": "someValue", "myCustomProperty": "myValue" } }