Creating a custom issue link dialog for remote issue links

This guide will show you how to create a custom dialog for creating issue links, which makes it easier for users to create remote links to a third-party application in JIRA.

Steps

1. Insert a web item in your atlassian-plugin.xml with a section attribute having a value of 'create-issue-link-types'.

   1
   2
   3
   4
   5
   6

   <web-item key="add-myapp-link" section="create-issue-link-types" weight="100">
     <label key="add.myapp.link.label" />
     <link linkId="add-myapp-link-link">
       /secure/LinkMyAppEntity!default.jspa?id=${issueId}
     </link>
   </web-item>

2. Insert a webwork action in your atlassian-plugin.xml with an alias attribute matching the link destination defined in the web item above.

   1
   2
   3
   4
   5
   6
   7
   8

   <webwork1 key="link-myapp-entity" name="Link My Application Entities" class="java.lang.Object">
     <actions>
       <action name="com.mycompany.myapp.LinkMyAppEntity" alias="LinkMyAppEntity">
         <view name="error">/templates/dialog/linkmyappentity.vm</view>
         <view name="input">/templates/dialog/linkmyappentity.vm</view>
       </action>
     </actions>
   </webwork1>

3. Write a matching webwork action and a velocity template. Examples:

   • com.atlassian.jira.plugin.link.remotejira.LinkRemoteJiraIssue
   • linkremotejiraissue.vm