Dashboard Pack - Jira Health dashboard

This article describes how to download a specific dashboard pack. You can download dashboard packs from dashboards.squaredup.com and learn more about how dashboard packs work here: Dashboard Packs

Description

This dashboard shows a quick view of the state of your next release and overall Jira project.

One of the main issues to overcome when returning a large number of items from Jira is that the API has a 100 issue limit. This is resolved here by using a PowerShell tile and making multiple API calls.

Release completion is calculated by total issues Closed or Merged, divided by the total issues in the release. This could be further fine tuned to only look at specific issue types that you care about by changing the API call in the script. Similarly on the Project side the Top 10 list (Web API) could be set to be any issue type by adjusting the API call. The trend line is calculated by creating an array.

How do I import and configure this dashboard?

1. Ensure you're using Dashboard Server v5.3 or above.

   Already a SquaredUp customer?

   Get the latest version of Azure Edition

   New to SquaredUp?

   Try it for free

2. Create a Web API provider to connect with your Jira environment.

   Use the following settings:

   Type	Basic Auth
   Name	Jira API basic Note: The name is case-sensitive and must be entered exactly like given here for the tiles to recognize the provider automatically. If you name it differently, you will need to select the provider manually for each tile on the dashboard.
   URL	URL of your Jira instance API endpoint, for example https://<JIRA domain>.atlassian.net/rest/api/3/
   Username	The Jira user account name you will use to access the API
   Password	Paste in the new API token created according to How to create an API token from your Atlassian account

   How to create a Web API provider

   1. In Dashboard Server navigate to the right-hand menu ☰ > system > Integrations

   2. Under Integrations click on Web API and choose either Simple, Basic Auth or OAuth depending on the API you are using.

      

      About the different types of Integrations and Web API providers

      Simple	No authentication, basic authentication (username and password in a header) or Windows authentication (configured automatically to use the application pool identity account).
      Basic auth	Basic authentication. Your specified username and password will be Base64 encoded automatically.
      OAuth	Token-based authentication according to the OAuth 2.0 standard. Many APIs use OAuth 2.0 for authorization, and will require an OAuth provider to include the additional information about how to authorize against the service.

      Note: When adding an OAuth provider you may get an message that the provider is not authorized if some of the provider configuration is incorrect (for example the username, password, secret etc), or if you use a proxy it could be that the proxy is not configured. See How to configure Dashboard Server to use a proxy

   3. Complete the provider fields, using your API provider's online documentation as a guide.

   4. You are now ready to use this provider in a Web API tile (see How to use the Web Content tile).

3. Create a PowerShell profile in Dashboard Server with the following settings:

   Name	Jira PS Note: The name is case-sensitive and must be entered exactly as given here for the tiles to recognize the profile automatically. If you name it differently, you will need to select the profile manually for each tile on the dashboard.
   Description	Contains an encoded version of the username and password pair that will be sent in the Header variable of the API, the Jira API URL for row links.
   Script	Copy and paste the script below. Replace username and password with the credentials for the user account you are using to access the API, and replace <JIRA domain> with your Jira domain details to form the correct URL.

   PowerShell profile script

   Copy

   
   $user = "username"
   $pass = "password"
   $org = "https://<JIRA domain>.atlassian.net/rest/api/3/"
                   
   $pair = "$($user):$($pass)"
   
   $encodedCreds = [System.Convert]::ToBase64String([System.Text.Encoding]::ASCII.GetBytes($pair))
   
   $basicAuthValue = "Basic $encodedCreds"
   
   $Headers = @{
   Authorization = $basicAuthValue
   }                

   How to create a PowerShell profile

   1. From the top right hand menu ☰ click system.
   2. Go to the PowerShell tab.
   3. Click add new profile.
   4. Enter a name and a description for the new profile.
   5. Enter the profile script.
   6. Click add profile.
      The profile is now saved and can be used in a PowerShell tile.

   For more help creating a PowerShell profile see How to use the PowerShell tile

4. Download and import this dashboard pack.

   How to import a dashboard pack

   1. Download the dashboard pack zip file for the dashboard pack you wish to import.

      There may be additional steps before or after the import to get the dashboard working in your environment.

   2. In Azure Edition go to the top right hand menu ☰ > Import Dashboard Packs and drag the zip file into the Manual Import box.

       

      

   3. The dashboard pack is imported and if the pack contains top-level dashboards, these will automatically appear in the navigation bar, usually in a folder called 'Community Dashboards' for dashboard packs from the SquaredUp Community.

   4. Carry out any additional steps required to make the dashboard work in your environment. These steps will be described on the download page for each dashboard. For example, you may need to create the correctly named Web API provider, create a PowerShell profile, or edit tile scopes.

   5. Edit the imported dashboard as required.