User Documentation

Owned by Lewis Tanguhwar
Last updated: Sept 05, 2023 by Precious Charles
4 min read

About

This plugin is created by experts in Agile and Scrum and aims to streamline project management. It simplifies tasks by allowing easy extraction of attachments and efficient data backup and restoration, reducing time spent on such tasks. This enables teams to focus more on critical and high priority tasks.

The plugin also assists in handling multiple projects simultaneously. It helps manage releases, prioritize tasks, and track progress, offering an overview of all ongoing projects. This means no task gets overlooked and thereby improving workflows.

Furthermore, this plugin enables better decision-making through its data visualization feature. Teams can customize views and filters to understand project data better. In a nutshell, this tool, built on industry expertise, offers features that enhance productivity, improve project tracking, and facilitate decision-making, proving a game-changer in project management.

Installation

To install Scrum Companion, you need global Administer Jira Permission to install the plugin from Atlassian Market place. If you do not have the required permission you can make a request and an Admin will approve or decline your request.

  1. Log into your Jira instance.

  2. Click the Apps dropdown and choose Find new apps.
    The Find new apps screen loads.

  3. Search for Scrum Companion and click on the app tile.
    The App Details screen loads.

  4. Click Try it free to start installing your app.

  5. You're all set!

There are 4 main features namely: Extract, Visualize, Clone and Migrate.
There are also 4 Jira Entities which can be gotten at the snap of a finger with Scrum Companion namely: Projects, releases, Filters and Sprint (coming soon).

Getting Started

Extract


The Extract feature helps you to quickly get entity count from a selected project, Release, filters or Sprint.
To apply the Extract feature to a project

  1. Click on Projects
    you are now prompted to select a desired project


2. From the search box under Available Projects type in the name of the desired project or simply scroll down and select from the projects options below the search box.
3. Click on the Extract button.

  1. You are presented with the Extracted entity count of the project selected (Effort) in this case, Notice that the Extracted result returned the number of issue types and the number of issues in the project. There is also an additional option to download attachment if needed.

 

 

Visualize a Project

To Visualize a project
1. Select the desired project by typing the name in the search box or choosing from the option provided.
2. Click on Visualize
3. This returns a table with headers Status and Count, and a pie-chart for visualization of issues grouped according to status category


Clone a Project
To clone a project
1. Navigate to projects as shown on the Scrum companion dashbaord of the desired project in the search box provided or choose a project from the options available and click on clone



  1. Upon retrieval of the desired project in the step above, click on the clone button.





Migrate Project

 

  1. Navigate to the Migrate feature and click on Migrate

  2. Choose the desired project from the options of Projects available or search by typing in the search box provided then click on Proceed button.

 

  1. Input the destination url where you desire to migrate to, replacing yourdomain.atlassian.net with your actual domain. Then click on the next button.

 

  1. Input your email in the space provided replacing youremail@yourdomain.com with your actual email address, then click on the next button.

  1. Input your API key in the space provided then click on next.

  1. Note that a user has to generate the API key if it has not been generated previously in order to proceed. The API key can be generated from a user's personal settings by navigating to
    profile settings -->manage account-->Choose the Security tab. Look up this resource for reference on how to generate the API key.

  1. A screen similar to the image below is displayed. Verify that all credentials inputted are correct, then click on start migrating.

  2. At the completion of the migration process, a “Success” message is displayed given that all credentials inputted are correct. You can then check the target instance for the migrated project as confirmation.