Adding to the JIRA dashboard

Add several gadgets at one time to a JIRA dashboard with a shell script that is provided in the Atlassian plug-in SDK.

Before you begin

Secure communications between the CLM application server and the JIRA server.

About this task

Use the atlas-create-jira-plugin shell script, which is included in the Atlassian plug-in SDK to create a JIRA plug-in shell. Then, use that shell to add several OpenSocial CLM gadgets to the JIRA dashboard.

Procedure

  1. Create a directory for the JIRA plug-in shell. For example, C:\OpenSocialPlugin
  2. Go to the directory that you created in the previous step and type the command:
    atlas-create-jira-plugin --artifact-id OpenSocialPlugin --group-id groupone --version 1.0 --non-interactive

    For more information about atlas-create-jira-plugin, see the Atlassian plug-in SDK documentation.

    The JIRA plug-in shell is created.
  3. Go to the folder where you created the JIRA plug-in shell.
  4. Find the atlassian-plugin.xml file in the src/main/resources directory.
  5. Edit the atlassian-plugin.xml file to add OpenSocial CLM gadgets. For each OpenSocial gadget that you want to add, replace the key parameter with a unique key and the location parameter with the OpenSocial gadget URL such as https://Host:9443/ccm/gadgetAdapter?viewletEntryId=com.ibm.team.workitem.viewlet.entry.queryresults
    <atlassian-plugin key="${project.groupId}.${project.artifactId}" name="${project.name}" plugins-version="1.0">
    	.
    	.
     <gadget key="UniqueKey" location="https://host:port/mygadget"/>
     <gadget key="UniqueKey" location="https://host:port/mygadget"/>
    
    </atlassian-plugin>
  6. Save the file and exit.
  7. Go to the root of your plug-in and find the pom.xml file.
  8. Edit the pom.xml file.
    1. Add your company name and website to the organization element.
      <organization>
      	<name>Company Name</name>
      	<url>http://www.yourcompanyname.com/</url>
      <organization/>
    2. Add text about your plug-in in the description element.
      <description>This plug-in provides additional JIRA OpenSocial gadgets	<description/>
    3. Save the file and exit.
  9. Create a JAR file of your plug-in. From the root of your plug-in, type this command:
    atlas-mvn package

    For more information about atlas-mvn package, see the Atlassian plug-in SDK documentation.

  10. Start the JIRA server if it is not already started. Log in to your JIRA server with administrative privileges.

    For example, http://YourJIRAhostname:8080/rest/oslc/latest

  11. Click Administration > Add ons at the upper right of the page.

    You might be prompted to enter your JIRA administrative credentials.

  12. On the Administration page, click Manage Add-ons. The Manage Add-ons page opens.
  13. On the Manage Add-ons page, click the Upload add-on, and in the dialog that opens, browse to the location where you created a JAR file of your plug-in step 5.
  14. Select the JAR file, click Open and then click Upload. A message shows indicating that the plug-in was successfully installed.
    Important: Another message shows about reindexing the JIRA database. Since reindexing can take some time to complete, you can choose to reindex the JIRA database at a convenient time.
  15. Restart the JIRA server.

Results

The OpenSocial gadget plug-in is installed into the JIRA application. The OpenSocial gadgets are added to the Other folder of the Gadget Directory window.

What to do next

Use the CLM OpenSocial gadgets, when you use the JIRA adapter, see Adding OpenSocial Gadgets to a JIRA gadget directory.

Feedback