Quick start guide for creating a portlet plugin - deprecated
This page is intended to get you up and running with writing your own JIRA portlet within no time. It actually is a combination of several examples included in the plugin development kit which were broken. The portlet which is explained below lets you configure 3 parameters and will result in table of books that match the searchcriterium:
- subscriptionId (Needed to use an Amazon webservice)
- searchParameter (What book property will we be looking for ? E.g. Title, Author, ...)
- searchArgument (The argument which will be searched for. E.g. "Java" or "Ruby")
Screenshot 1: Configuration of portlet
Screenshot 2: result of search (parameter = 'Author' & argument = 'Sierra')
Screenshot 3: result of search (parameter = 'Title' & argument = 'Java')
My installed software:
- JDK 1.6.0_03
- Eclipse 3.3.0
- Maven 2.0.7
- Jira enterprise edition 3.12.2
You will need to make some changes to your $maven_home/conf/settings.xml.
See also how to build an Atlassian plugin.
Next we will create a new plugin project based on a plugin archetype. In a DOS-box, run following command:
and replace $MY_PACKAGE$ and $MY_PLUGIN$ according to your project. Make sure you remove the backslashes "\" so the complete command is one 1 line before you execute it.
Maven will create a new folder $MY_PLUGIN$ and provide some default files. Check the JIRA:attachment for how the plugin works.