Component Shelf for Jira: Documentation

Component Shelf helps project admins keep Jira components tidy: archive and restore them, copy them to other projects, merge duplicates and export them to CSV.

Getting started

  1. Install the app from the Atlassian Marketplace.
  2. Open a project, go to Project settings, and open Component Shelf. Only project admins (and Jira admins) can use it. Team-managed projects do not have components, so the app is for company-managed projects.

The page has five tabs: Components, Copy to projects, Merge, Archive shelf and Activity.

About archiving (please read)

Jira Cloud does not have an archive flag for components. Jira Data Center has one, but Jira Cloud does not yet (JRACLOUD-10507). Component Shelf therefore emulates archiving in one of two ways, and saves everything it needs to undo it on the Archive shelf:

Rename Remove
What happens in Jira The component is renamed to “[Archived] Name” The component is deleted from Jira
Shows in the component picker Yes, with the “[Archived]” prefix No
Issues keep it Yes No. The app saves the list of issues first, and can give them a replacement component
Filters and reports by component Keep working (same component ID) Saved filters that used it stop matching until it is restored
Restore Renames it back Creates it again with the same fields and puts it back on its issues. Jira gives it a new ID

Remove mode records at most 20,000 issues per component. A component with more issues can only be archived with Rename.

Components tab

Lists every component with its description, lead, default assignee and number of issues. Select components here to archive them or to copy them. Export CSV downloads the list plus the Archive shelf.

Archive and restore

  1. Select components on the Components tab and choose Rename or Remove.
  2. In Remove mode you can pick a replacement component that the issues get instead.
  3. Add an optional note, then archive.

On the Archive shelf, select archived components and Restore. Options: - Put restored components back on the issues they had (Remove mode). - Take the replacement component off issues that only got it from the archive or merge. Issues that already had the replacement before are left alone.

Restored entries stay on the shelf as history until you remove them with Forget.

Copy to projects

  1. Select components on the Components tab.
  2. Pick target projects (only projects you administer are listed).
  3. Choose which fields to copy with the name: description, lead and default assignee.
  4. Choose what happens if a target already has a component with the same name: Skip it or Merge (update it with the chosen fields).
  5. Run a Dry run to see exactly what would be created, updated or skipped, then Copy.

If a lead cannot be set in a target project, the component is created without a lead and the result says so. Undo in the Activity tab deletes the components the copy created and reverts the ones it updated. Components someone changed since, or that issues already use, are left alone and reported.

Merge

Choose Merge this component and Into this component, then Preview to see sample issues. Every issue with the first component gets the second one instead, and the first component is then archived (renamed or removed, as you choose). Watchers are not emailed about these edits. A merge cannot be stopped halfway, so its undo log is always complete; Undo puts every issue back afterwards.

Activity

Every job (dry runs too) appears in the Activity tab with progress, counts and per-component results (the first 200 lines). Running copy, archive and restore jobs can be cancelled between batches. Only one job runs per project at a time. Job history and copy undo data are kept for 30 days. Archive shelf entries are kept until you forget them or uninstall the app.

Licensing

Viewing components, the shelf and the activity log works without a license. Every change (copy, archive, merge, restore, undo) needs an active subscription.

Limits

Help

Email joesimo@mail.grokbot.com. See the support page.