Quick Start Guide for v1.4.0 (Data Center Release)

Owned by John Pacheco (Inactive) (Deactivated)
Jul 18, 2022
4 min read

Features:

  • Better visualize the hierarchy of issue links

  • Configure with any fields you want to view

  • Click on an issue to expand for a detailed view of your issue’s data

  • Clean and intuitive interface

Installation

  1. Follow Atlassian’s instructions for installing an app from the marketplace here: Installing Marketplace Apps.

  2. On Jira, click the “Dashboard” menu dropdown and select the name of the project dashboard you want to install the dashboard item on.

  3. Click “add a new gadget”.

  4. Search for “Simple Status Tracker” and click “Add gadget”.

Configuration

  1. You can select the projects to pull issues from within the Project If no projects are selected it will allow you to enter projects in the JQL search.

  2. Select either Use JQL query or Use saved filter in order to select the method of filtering issues.

    • If “Use JQL query” is selected: enter a JQL search into the Enter JQL Search.

    • If “Use saved filter” is selected: choose a saved filter from the dropdown.

    • Please Note: The saved filters referred to are created using the issue search screen in Jira. If none are set the user can go to the issue search screen and save a JQL search in order to use with Simple Status Tracker.

  3. Select which Issue fields you want to view for your issues.

    • The default fields are Time in Status (SST Custom Field), Status, Sum Story Points(SST Custom Field), and Progress Bar(SST Custom Field).

      • The Time in Status field shows the amount of time that has passed since the Issue status was changed.

      • The Status field shows the current status of the issue.

      • The Sum Story points field displays the story points of that issue. If the issue is of the selected Parent type it displays a summation of all linked issues story points.

      • The Progress Bar field displays the amount of story points belonging to linked issues with a status of “done“ if the parent issue is of the Parent type.

  4. If you want to render certain Inward Links (Implemented by, blocked by) you can select those from the Inward Link Type dropdown.

  5. If you want to render certain Outward Links (Implements, Blocks) you can select those from the Outward Link Type dropdown.

*Issues linked by Epic Link are rendered by default.

*Read more about Inward and Outward links here: https://community.atlassian.com/t5/Jira-questions/Issue-links-what-is-the-meaning-of-quot-inward-quot-and-quot/qaq-p/839095

  1. Click on more options to reveal advanced settings.

    • If desired, you can change the name displayed above the dashboard item by typing a new name in the text box labeled Dashboard Item Name.

    • Select the Story Point field used in the selected project from the Story Point Field This field defaults to the Story Point field. Any field may be used as long as it’s a number field.

    • If desired, the height of the dashboard item can be changed as well by typing a new numerical value in the text box labeled Dashboard Item Size (in px).

    • Max Depth defaults to 4. Changing this number allows you to set how deep you want to render issues. Anything deeper than 4 may cause performance issues.

    • If desired, auto-refresh can be enabled or disabled by checking or unchecking the box labeled Auto-refresh.

  2. After you are finished setting up the dashboard item, click Save to save your configuration. You will be taken automatically to the main view of the dashboard item.

  3. Click the “…” ellipsis in the upper right-hand corner of the dashboard item, then click “edit” to return to the settings view to make any changes or updates to the dashboard item.

  4. Upon returning to the configuration screen after the initial setup: Click Cancel if you want to discard changes made to the configuration.

 

App Usage

Usage Tips:

  • The app will display the first 20 issues from the query.

    • If more issues should need to be pulled scroll to the bottom of the issues and click the Click to render more issues button.

  • A JQL search can also be made using the search bar at the top of the This will repopulate the table with the new data from the search. If the search contents are removed and the search button is pressed again the original search data will repopulate the table.

  • If an issue has linked issues a dropdown arrow will display on the left side of the row and can be clicked in order to reveal the linked issues belonging to that issue.

    • If there are issues linked by the Parent-link type set on the configuration screen, a “Linked Issues” header will be shown and all issues linked to the parent will be displayed.

    • If there are any inward or outward issue links, for example, “clones” and “is cloned by” headers for each type will be created and issues will be displayed under the relevant header.

  • If Progress Bar is selected, the user can hover over the progress bar to view the progress percent.

Displayed Data Overview:

  • From the main, view you are met with a list of all of the issues pulled using either the JQL search or Filter set on the config screen.

  • The table will always show an Issue Summary column

    • The Issue Summary column contains the issue type icon, Issue key and summary