Let us get started with probably the most simple of all plugin modules. The web item plugin module. This allows us to add links in different locations of the JIRA UI. We will add a link to the Atlassian Answers community page from the top navigation bar.

Source code is available at https://bitbucket.org/jiradev-tutorials/web-item

Adding a link to the top navigation bar

  1. Start by creating a plugin skeleton. If you have not finished the tutorial for creating a plugin skeleton, click here. Enter the information below.

    groupId: com.jiradev.jira.plugins

    artifactId: answers-webitem

    version: 1.0

  2. You should now have a new folder called answers-webitem. Within this folder, execute the command atlas-create-jira-plugin-module.

  3. Select option 25 for Web-item and enter the info provided below.

    Enter plugin module name: Answers Link From Navigation

    Enter section: system.top.navigation.bar (Refer to this link)

    Enter link URL: https://answers.atlassian.com/

    Show advanced setup: N

    Add another plugin module: N

  4. Run the JIRA instance using the command atlas-run. You will now see the new link we just created.

  5. But what if we want to make the link visible only to users who are logged in? We can add conditions to web-items. Till this point, we did not have to make any changes to code or any of the data generated by Atlas SDK. But from this point on, using an IDE will make editing these files much easier. The IntelliJ IDEA IDE has been my preferred IDE as it allows me to easily open projects and setup a remote debugger without any configuration. I will be using Idea throughout these tutorials. However, the Atlassian Developer site provides information to setup your IDE if you are using Eclipse or Netbeans. Have a look at the link here.

Opening your project in IntelliJ Idea IDE

  1. Start the IDE and choose to "Open Project". Choose the pom.xml file from your project directory.

  2. Let us take a quick look at the project structure. The src directory contains a folder called main. The main folder contains two folders called java and resources. Java folder will contain all your source code. Resources folder will contain javascript, images and mainly your plugin definition file named atlassian-plugin.xml.

  3. Take a look at the atlassian-plugin.xml file. When you ran the atlas-create-jira-plugin-module command, the SDK has created the definition of the web-item here for you.

Making some changes to your plugin

Great. So we now have an idea about the pom.xml and the atlassian-plugin.xml files. Let us continue making some changes to the web-item we are working on. Firstly, the link is being displayed as "Atlassian link fron navigation". Let us change this to be displayed as "Atlassian Answers". Secondly, we will display it only to users who have logged into JIRA.

  1. Open the atlassian-plugin.xml file and take a look at the web-item definition. The web-item has a label property. These are defined in the file atlassian-webitem.properties file located in your resources folder. Open the properties file and look for the key being used by the label. ie, answers-link-from-navigation.label and update it's value to "Atlassian Answers".

  2. Now let us add a condition such that the link is displayed only to logged in users. Open the atlassian-plugin.xml and add the condition. There are several conditions available. Click here to take a look at the Java API and look for "com.atlassian.jira.plugin.webfragment.conditions". For this example, we will be using the UserLoggedInCondition ie. com.atlassian.jira.plugin.webfragment.conditions.UserLoggedInCondition

  3. UserLoggedInCondition is part of jira-core which is commented by default in the pom.xml file. Uncomment the dependency.

  4. Explicitly import the com.atlassian.jira.plugin.webfragment.conditions package in maven-jira-plugin section of the pom.xml file. For more information on why this is required, refer to https://bitbucket.org/atlassian/atlassian-spring-scanner. Look for the example with com.atlassian.jira.plugin.webfragment.conditions.

Reloading your changes

Once you have made changes to your plugin, you need to recompile and upload the plugin again.

Using Terminal

  1. With the current command prompt where atlas-run is running being open, open a new instance of command prompt and change to your project directory.
  2. Run the atlas-cli command. When prompted with maven>, type "pi" and press enter.

Try accessing JIRA. You will now be seeing the link only upon login.


Show your support by tweeting about this tutorial. Is Jiradev something you would reommend? Let me know.


Do you have a Jira plugin tutorial that can be used on this site? Please do share it with me and I can add it along with the ones available.



Your feedback can help improve the content on this site. If you have anything that you would like me to change/implement on the site.