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
- Create a directory for the JIRA plug-in shell. For example, C:\OpenSocialPlugin
- 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.
- Go to the folder where you created the JIRA plug-in shell.
- Find the atlassian-plugin.xml file
in the src/main/resources directory.
- 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>
- Save the file and exit.
- Go to the root of your plug-in and find the pom.xml file.
- Edit the pom.xml file.
- Add your company name and website to the organization element.
<organization>
<name>Company Name</name>
<url>http://www.yourcompanyname.com/</url>
<organization/>
- Add text about your plug-in in the description element.
<description>This plug-in provides additional JIRA OpenSocial gadgets <description/>
- Save the file and exit.
- 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.
- 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
- Click at the upper right of
the page.
You might be prompted to enter your JIRA
administrative credentials.
- On the Administration page, click Manage
Add-ons. The Manage Add-ons page
opens.
- 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.
- 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.
- 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.