Issue Glance

This module adds a special user interface elements that appears in the right sidebar of the new Jira issue view under the status, and alongside other fields like assignee, priority, and labels.

Glances provide a quick way for a user to get an overview of some information, provided by your app, that relates to an issue. When a user clicks a glance, it will open a sidebar where a user will be shown content from a URL provided by your app (similar to the web panel module). This URL must be a relative URL from your app's server.

The Glance object (which includes your icon, content and URL) is defined using the Issue Glance module.

Setting the status for a Glance

The status of a Glance for a specific an issue can be set using the Set issue property API.

The issue property key needs to be formatted as com.atlassian.jira.issue:[addonKey]:[moduleKey]:status to set the status.

The JSON in your PUT request to set the status should follow this format depending on the type of status you wish you display:

• Lozenge: { type: 'lozenge', value: { label: 'Hello', type: 'default' } }. For available lozenge types, refer to lozenge appearance.
• Icon: { type: 'icon', value: { label: '/img/tick.png' } }. Note that label is the URL relative to your app's base URL.
• Badge: { type: 'badge', value: { label: '123' } }. Note that label must be a numeric string.

More recommended usage and user experience suggestions are available in the design guidelines.

Example

{
  "modules": {
    "jiraIssueGlances": [
      {
        "icon": {
          "width": 0,
          "height": 0,
          "url": "my_icon.svg"
        },
        "content": {
          "type": "label",
          "label": {
            "value": "my label"
          }
        },
        "target": {
          "type": "web_panel",
          "url": "/panel_url"
        },
        "name": {}
      }
    ]
  }
}

Properties

{
  "icon": {
    "width": 16,
    "height": 16,
    "url": "/my-icon.png"
  }
}

{
    "key": "my-addon",
    "modules": {
        "configurePage": {
            "key": "configure-me",
        }
    }
}

{
  "name": {
    "value": "My Label"
  }
}