Is Jira Connect dashboard item example working?

Following instructions in "Guide - Building a dashboard item for a JIRA Connect add-on" I cloned the only one example  (



After installing the add-on, I did not found the example gadget into gadget directory list adding into a Dashboard.


2 answers

0 votes

Hi Xavi,

  • Are you getting any error when you attempt to run node app.js?
  • Do you get a Local tunnel established message?
  • Do you see that it registered the add-on?
  • If you go to the localBaseUrl what message do you get back?

Let me know if all that checks out and we'll go from there.



My dashboard item is still not working; It currently shows, but it cannot save its configuration (yet).

To get the example to show my gadget in the list, running Node.js, I had to make the following changes:

1. Update the dependencies (package.json):

"dependencies": {
"atlassian-connect-express": "^3.0.0",
"body-parser": "^1.14.2",
"compression": "^1.6.0",
"cookie-parser": "^1.4.0",
"errorhandler": "^1.4.2",
"express": "^4.13.3",
"express-hbs": "*",
"morgan": "^1.6.1",
"ngrok": "2.2.10",
"sleep": "^5.1.1",
"sqlite3": "^4.0.2",
"static-expiry": ">=0.0.5"

2. Replaced the app.js with one that is coded for Express v4+:

3. Updated the config to use sequelize (config.json):

"store": {
"adapter": "sequelize",
"type": "memory"

4. Removed the condition portion in the descriptor (atlassian-connect.json); see updated definition:

"jiraDashboardItems": [
"key": "dashboard-item-key",
"name": {
"value": "Search Issue",
"i18n": ""
"description": {
"value": "Search for issues based on properties.",
"i18n": ""
"url": "/issues-in-project?dashboard={}&dashboardItem={}",
"thumbnailUrl": "/thumbnail.png",
"configurable": true

5. Add/update the script in the header (to avoid getting "AP not defined" exception):

<script src="//" async></script>

Suggest an answer

Log in or Sign up to answer
Community showcase
Published Jan 08, 2019 in Jira

How to Jira for designers

I’m a designer on the Jira team. For a long time, I’ve fielded questions from other designers about how they should be using Jira Software with their design team. I’ve also heard feedback from other ...

1,251 views 5 10
Read article

Atlassian User Groups

Connect with like-minded Atlassian users at free events near you!

Find a group

Connect with like-minded Atlassian users at free events near you!

Find my local user group

Unfortunately there are no AUG chapters near you at the moment.

Start an AUG

You're one step closer to meeting fellow Atlassian users at your local meet up. Learn more about AUGs

Groups near you