SquaredUp logo
  • Product
    • Community Edition
      Dashboard any data for free
    • Azure Edition
      Take control of Azure costs and performance
    • SCOM Edition
      Unlock insights from Microsoft SCOM
    • Compare Editions
    • Integrations
      Bring together data from anywhere
    • Dashboard Gallery
      Find inspiration and real-life dashboard use cases
  • Pricing
  • Resources
    • Blog
      Discover tips, tricks, news, and more
    • Learn
      Master SCOM and Azure Monitor with help from our experts
    • Webinars and Events
      Sign up for the next event or watch a replay on-demand
    • Downloads
      Download the latest releases, tools, scripts, and more
    • Datasheets
      Get concise SquaredUp overviews to share with the team
    • SCOMathon
      The hub for all things SCOM
  • Support
    • Support Portal
      Search for answers or submit a request to our experts
    • Community Answers
      Connect with a community of experts to ask questions and find answers
  • Company
    • Company
      Find out more about SquaredUp’s vision, people, and values
    • Careers
      Join our growing team – we’re hiring!
    • Customers
      Learn how our customers are taming complex IT landscapes
  • Download now
  • Dashboard Fridays
  • Jira
  • PowerShell
  • Web API
  • Donut
  • Grid / Table
  • Performance
  • Scalar
  • Status
  • DevOps
  • IT
Dashboard Gallery

Jira Health Dashboard

This Jira Health dashboard offers a quick view of the state of your next release, alongside the health of the Jira project as a whole. It uses SquaredUp’s Web API and PowerShell tiles to improve on Jira’s native dashboarding capabilities.

Tim Wheeler , SquaredUp
How do I get it?

Challenge

While the querying and visualizations in Jira are decent, it is not possible to combine them with data from any other sources. It is also a known limitation that when accessing the Jira Web API, you are often limited to 100 results per query. Moreover, any dashboard you build can only be shared with people with a Jira license, severely limiting its reach.

Solution

Using SquaredUp Dashboard Server, we have solved all three of these problems easily with the Web API and PowerShell tiles, as well as the Open Access feature. Using this example Jira health dashboard, you can easily show the state of your next release alongside the health of the Jira project.

While we’ve focused on Jira content in this dashboard, you can easily link to other sources using SquaredUp’s native integrations as well as its Web API tile – such as linking your bugs to support tickets from ServiceNow or Zendesk.

You can also use the SquaredUp PowerShell tile to loop through multiple calls and return exactly the data you require, circumventing Jira’s limit of 100 results. 

With Open Access, you can easily share the dashboard with the Support Team or with Senior Management so they can see the next release’s progress. It’s as easy as sending a link, or putting your dashboard on a wall monitor or website. No additional licenses required!

Feel free to add other sources or mix and match from SquaredUp’s other example dashboards as you see fit.

Dashboard walk-through

The dashboard is split into two columns. The first column focuses on the next release using the Jira field ‘fixVersion’. You can see the release roadmap, release completion, epic status, task status and bug fixes.

Jira Health Dashboard built in SquaredUp

The second column groups data based on the name of a specific project. You can see the Top 10 epic backlog, bugs over time, as well as the bug trend, severity and priority.

To clarify, release completion is calculated by total issues Closed or Merged, divided by the total issues in the release. This can be further fine-tuned to only look at the specific issue types that are important to you by changing the API call in the PowerShell script.

Release completion and task status from Jira dashboard

Similarly, on the Project side, the Top 10 list (Web API) can be set to any issue type by adjusting the API call. The bug trend line is calculated in the PowerShell script with the formula “total bugs open + new bugs – bugs closed or merged”.

Top 10 epics and bug trend for Jira dashboard

How do I import and configure this dashboard

  1. Ensure you’re using Dashboard Server v5.4 or above.

    Already a SquaredUp customer?

    Get the latest version of SCOM 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
    ClosedHow 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.

      ClosedAbout 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 API 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.
    ClosedPowerShell 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
    }                
    ClosedHow 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.

    ClosedHow 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 SCOM 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. If the dashboard pack also contains perspectives (see Working with perspectives), then you’ll see these when you drilldown to the relevant object.

    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.

    Download zip for SquaredUp Azure Edition
    Download zip for SquaredUp SCOM Edition
    Download zip for SquaredUp Community Edition
GET STARTED TODAY

Zero to dashboard hero in 60 seconds

Start now with hundreds of customizable dashboards.

  • Sites
    • Support
    • Download
    • Community Answers
  • Quick Links
    • Webinars and Events
    • About Us
    • Careers
  • Small print
    • Privacy Policy
    • Terms and Conditions
    • Staying COVID-19 Secure
UKAPR 2022-APR 2023

© SquaredUp 2022