| Table of Contents | ||||
|---|---|---|---|---|
|
Overview
Depending on its size, Jira project can contain a lot of components. Components help split a project into smaller parts and group project issues to simplify search and project reporting.
...
| Tip |
|---|
With Subcomponents you can:
|
Key features
Here is the list of key Subcomponents features:
add new or existing components
manage all component details without switching between project tabs
view all component details in the hierarchy tree grid
add components more than once in different places
group components using folders (virtual components)
search components in the hierarchy
find issues for any part of a project represented by components hierarchy
select components from the hierarchy when creating (including Service Desk customer portal) or editing issues
perform all operations with components hierarchy via REST API
use custom JQL functions to search issues
export/import subcomponents hierarchy
Glossary
Throughout the documentation, we use some terms which we'd like to briefly explain before you continue.
Term | Comment |
|---|---|
Subcomponents | Subcomponents are the hierarchy of components. Below are other ways we call subcomponents:
|
Item | Item or hierarchy item is an element which is added to the hierarchy. It is the link to a project component or folder |
Component | The component is a native project component |
Folder | Custom hierarchy item type implemented in Subcomponents App |
Subcomponents picker | The extension of Components field to select components from the hierarchy |
Quick start guide
After installing the app a new project tab "Subcomponents" is added to all your Jira projects. It is the home of the components hierarchy for a particular project.
...
When you first land on the Subcomponents tab and no hierarchy has been defined yet, we recommend you take our Quick Tour to familiarize yourself with key features. All project users can always access Quick Tour using the link in the Help menu.
...
Overview
Subcomponents project page consists of two parts:
hierarchy toolbar on top of the page
hierarchy itself under the toolbar
Hierarchy toolbar
All users who can browse a project can also view its subcomponents hierarchy.
...
Add existing component/folder - add one or more existing components/folders to the top of the hierarchy
Add new component/folder - create and add a new component/folder to the top of the hierarchy
...
Hierarchy item toolbar
Subcomponents hierarchy consists of hierarchy items - links to corresponding components or folders.
...
| Info |
|---|
A confirmation dialog is displayed before the item is removed and contains the following information:
|
Manage hierarchy
Add new component
You can add a new component to the top of the hierarchy via Add new component action of the hierarchy toolbar or under a target hierarchy item using its context menu.
...
By default new component is added as the last child of the target item. But you can change the position to add the component after the target item on the same level.
...
Add a new folder
When you start with Subcomponents app you don't have any folders.
...
When a folder is created from the item context menu its relative position can be adjusted in the same way as in components.
Add existing components
When you start with Subcomponents app your project might already have some components you want to add to the hierarchy.
...
name - free text input
usage in a hierarchy - dropdown with the options: used, unused, all
Add existing folders
Adding existing folders to hierarchy is done via Add folders dialog. It is opened when you click Add existing (folders) from Subcomponents toolbar or hierarchy item context menu.
...
name - free text input
usage in a hierarchy - dropdown with the options: used, unused, all
Manage components
In addition to adding components to the hierarchy, you can fully manage components on Add components dialog without switching to Components project tab.
...
Component action | Description |
|---|---|
Create | When a new component is created from Add components dialog it is not added to hierarchy automatically. You will then need to select and add it explicitly. |
Edit | When a component is updated the hierarchy is updated with new details automatically. |
Delete | When a component is deleted all its references from hierarchy are removed. All children items of a deleted component are removed from hierarchy as well. If a removed component is associated with some issues a popup dialog is displayed with options to swap issues to another component. |
Manage folders
Add folders dialog is where you can manage project folders.
...
Component action | Description |
|---|---|
Create | When a new folder is created from Add folders dialog it is not added to hierarchy automatically. You need to select and add it explicitly. |
Edit | When a folder is updated the hierarchy is updated with new details automatically. |
Delete | When a folder is deleted all its references from hierarchy are removed. All children items of a deleted component are removed from hierarchy as well. |
Find issues
You can find issues for a particular part of the project represented by some root component and its children items.
...
via hierarchy item View issues context action
via JQL search with the help of custom JQL functions: subcomponents() and subfolder()
View issues
Click on the “View issues” action in the item context menu to open the View issues dialog with the list of issues.
...
In the background View issues screen utilizes JQL search capabilities to find the required issues and you can switch to Jira Issue Navigator to get more details about the issues.
JQL search
Subcomponents app adds two custom JQL functions to search issues in the subcomponents hierarchy: subcomponents and subfolder.
...
Function | Parameters | Examples |
|---|---|---|
subcomponents() |
You can optionally provide the third parameter as "false" to exclude issues of parent component and only keep those for its children components |
|
subfolder() |
|
|
Select components in issue
Now let's explore how users can select components from the hierarchy using Subcomponents picker to add components to issue.
Subcomponents picker
Subcomponents picker is invoked via action button with the hierarchy icon located next to Components field on issue Create/Edit screen.
...
| Info |
|---|
Subcomponents hierarchy and Issue picker are fully supported in Service Desk projects. Customer portal users can take advantage of selecting components from subcomponents hierarchy when creating issues in the customer portal. |
Subcomponents picker settings
Users can configure the hierarchy being displayed expanded or collapsed by default in Subcomponents picker via settings.
...
Option | Description |
|---|---|
Bulk check parents | When a component is selected also select all its parent components |
Bulk check siblings | When a component is selected also select all its sibling components |
Bulk check children | When a component is selected also select all its children components |
Bulk uncheck parents | When a component is unselected also unselect all its parent components |
Bulk uncheck siblings | When a component is unselected also unselect all its sibling components |
Bulk uncheck children | When a component is unselected also unselect all its children components |
Export/import subcomponents hierarchy
You can export subcomponents hierarchy and then import it into another project. It works for different Jira instances and for different Jira deployment types. So you can export data from one project in Jira Server/DC and then import it into another project in Jira Cloud and vice versa.
...