HowTo: Hide JIRA Agile Gadgets from Unauthenticated Users on the System Dashboard

Still need help?

The Atlassian Community is here for you.

Ask the community

Symptoms

The system dashboard is configured with JIRA Agile gadgets such as Days Remaining or Burndown Charts. When a user browses to your JIRA prior to login, they see these gadgets in a broken state.

Cause

Specific directives (roles-required) were omitted from the atlassian-plugin.xml file.

Resolution

Resolving this issue will require modifying the JIRA Agile plugin .JAR file. Please do not proceed if you are uncomfortable with the command line, editing XML files, or compiling .JAR files.

 

  1. Download a fresh copy of the JIRA Agile plugin from Marketplace.
  2. Move the file to a clean folder
  3. Decompress the file
  4. Locate the atlassian-plugin.xml file
  5. Find the section labeled <!-- GADGETS -->
  6. A number of stanzas will follow, similar to this:
    1. <gadget key="greenhopper-gadget-project-dashboard" name="GreenHopper Gadget" location="gadgets/greenhopper-project-dashboard.xml">
      <param name="roles-required">browse</param>
      </gadget>
  7. As described in  JRA-21505 - Getting issue details... STATUS , add the <param name="roles-required">browse</param> directive to each stanza that describes a gadget that ought to be hidden
    1. Note that "browse" is an example role, and corresponds to Browse Projects. A full list of roles can be found in permissions.java in the JIRA source code, but some are mentioned here for reference:

      ValuesDescription
      useJIRA Users Permission
      adminJIRA Administrators
      browseBrowse Projects
      sysadminJIRA System Administrators
      pickusersBrowse Users
  8. Compile the resulting files into a new .JAR file:
    1. jar cf <target-file-name> *
  9. Uninstall JIRA Agile
  10. Upload this new .JAR file to the server using the Upload Plugins function in the Universal Plugin Manager
Last modified on Feb 23, 2016

Was this helpful?

Yes
No
Provide feedback about this article
Powered by Confluence and Scroll Viewport.