View the Getting Started guide for Cleaner for Jira on the Server deployment optionOnce you have installed the App from the Marketplace and obtained a license, you can start using the plugin by following the guide below.
Opening the App
To open Cleaner for Jira, you can use 2 different options:
- Open Jira
- Press the <dot> (.) key on your keyboard
- Type Cleaner into the box
- Press Enter to open the interface
- Open JIRA
- Click on the Settings Cog in the top-right of the interface (on the navigation bar)
- Click on the Cleaner option
Opening the Cleaner page takes you to the Overview page, which runs 8 scans to highlight problematic areas. Any warnings can be clicked to go directly to the relevant Cleaner page.
Viewing Unused Configuration Items
On each pages, there are several options available:
- Use the checkboxes to select and delete configuration items in bulk
- Click on the name of the item to open it's configuration in Jira
- Click on the Issue Count of the item to open the Issue Navigator to show issues using the item
- Click on any relations of the item to open the cross-reference window e.g. See screens contained in a Screen Scheme
Available Configuration Items
Using the links on the Cleaner sidebar, you can browse through the various configuration items available which can be deleted from within the interface:
- Custom Fields
- Issue Types
- Issue Type Schemes
- Workflow Schemes
- Screen Schemes
- Issue Type Screen Schemes
Deleting Items in Bulk
Follow the instructions below to delete items in bulk:
- Open the page which contains the items you wish to delete - e.g. Projects
- Use the Column Headings to order the table contents as required
- Use the Checkboxes next to the items to select the items to delete. Some sections also support the Auto-Suggest feature which can select these for you automatically.
- When you are ready to delete the items, click on the Delete button
- Check each item you have selected to delete and if you are sure, press Confirm
Viewing Empty or Inactive Projects
You can view Projects which are either empty or have not been used recently by using the Projects link in the Cleaner sidebar.
The last update and number of issues is shown for each Project.
- Sort by clicking a column header.
- Click a project's name, the project lead, or the number of issues to see more details on that aspect.
- Delete a project outright by clicking the 'Bin' icon at the left. This will bring up a confirmation screen.
Viewing Inactive Users
You can set an inactive period and populate a list of all users matching that criteria by clicking on the Inactive Users item on the Cleaner sidebar.
Cleaner for Jira can detect Users who haven't logged in recently, according to your specifications.
It can present these as a list and if you are using a supported User Directory, can bulk disable these users.
Cleaner for Jira can only disable users when you are using either the Local Jira Directory or an External User Directory that allows local administration of User Status, see here for more information.
The scan will identify users who haven't logged in since the "Inactive Period" and the "Remember Me Period" combined.
Click the Scan button on the bottom right, and it will take you to the results page.
In the results, you can see users who have not logged in during the time period specified, as well as what licenses they hold.
This lets you choose users who you wish to disable, for example if they have left your company and therefore are inactive. Select them, then click "Disable" in the bottom right. You may also select all inactive users with a login date with "Auto-Suggest".
This can save you money, as you do not pay for users who you do not need!