Configuration

The configuration page is essentially used for customizing the display and management of issues in Jira, tailored to the specific needs of the team or project. It offers flexibility in organizing and filtering issues, customizing fields for data representation, and ensuring that all changes are intentional and saved appropriately. The user-friendly interface, with its simple tab navigation and clear options for adding, editing, and deleting configurations, makes it accessible for users with varying levels of expertise in Jira.

Project settings page

Each project features a dedicated settings page for the app, enabling the project administrators to tailor the application according to their preferences. This also means that each project possesses its own individual configuration.

You can find the project settings page inside each project in the Apps section of the project menu.

Open

Empty settings

If the project did not contain any previous settings, then the first thing you will see is an empty settings page, where your only option is to create a new configuration for your project.

Open

To create a new tab from an empty settings, follow these steps:

• Click on Create to make your first configuration tab

• This will pop up a modal where you have to give a unique name to your tab

• Click on Add and wait a few seconds for your configuration tab

Creating additional tabs

You can create multiple tabs for one project, where every tab can hold a configuration for the configured issue type. You can save as many tab settings as many issue type the project contains.

To create additional config tabs in your configuration, follow these steps:

• Click on the menu icon located at the top right of the configuration page.

• From the menu, select Add new Tab.

• A dialogue panel will appear where you can set the new tab’s name.

• Press Add to create the tab.

• A new tab will be added, and you can start configuring it according to your needs.

Renaming a tab

You also have the ability to rename tabs, ensuring they reflect the configurations' purpose better.

To rename an existing tab:

• Click on the tab you want to edit.

• Click on the menu icon located at the top right of the configuration page.

• From the menu, select Edit name.

• A dialogue panel will appear where you can set your existing tab’s new name

• Press Edit to save the changes

Copying a tab

It is possible to copy a tab to create a new tab with predefined configuration. This action will copy the custom fields of the tab and the filtering options but not the issue type since it can not be duplicated.

To copy a tab:

• Click on the tab you want to copy.

• Click on the menu icon and choose Copy Tab.

• A dialogue panel will appear where you can set the new tab’s name.

• Press Add to create the tab.

• A new tab will be added most of the configuration from the copied tab.

Deleting a tab

You can also delete existing tabs when you are no longer in need of it.

To delete a tab:

• Click on the tab you want to delete.

• Click on the menu icon and choose Delete Tab.

• Confirm the deletion when prompted.

Switching between Tabs

Users can switch between tabs by clicking on their names.

In case of having more than five tabs, the interface incorporates a navigation arrow to facilitate moving between tab pages.

Sections - Issues

In the Issues section, users are provided with the capability to customize the display of issues in the panel based on their requirements. The Issues section will be responsible for configuring what type of issues you want to query in your panel and what issue type this should be displayed on.

Issue type

In the Issues section, choose an Issue Type from the dropdown menu. You can select from issue types that are available in the current project, ensuring that the panel only displays the types of issues relevant to their current needs or tasks. You can choose multiple issue types for the same configuration, which would mean that you will see the same issue panel on different issues.

Filter type

Filter types offer filtering capabilities to refine the display of issues within the panel. Each option dynamically changes the subsequent field based on its specific data requirements. This feature includes several filtering options:

• Link Type: This option allows users to filter issues based on their linkage to other issues. Users can specify a linked issue type, and the panel will dynamically display only those issues that have the defined linkage. This is particularly useful in complex projects where understanding the relationship between different issues is crucial.

• Filter: Our plugin allows you to integrate Jira Filters directly into your configuration, enabling you to reuse the same JQL query across multiple setups. By referencing a single Jira Filter, any changes to the query need to be made only once, automatically updating all configurations that use it. You have to type the name of the Filter into the search bar, and a user can set any filter that they can access. This option requires permission for the user to see the Filter they want to configure.

• JQL: For users who require more advanced and customized filtering, the JQL filter option enables the creation of specific queries using Jira Query Language. The results of these JQL queries are then presented in the panel, offering a tailored view of issues based on the user-defined criteria. This feature is ideal for users who are familiar with JQL and need to perform complex searches or data segmentation. This options also includes a feature to validate your query by clicking the text below the JQL field.

• Child Issue: This filter is designed to show only the child issues of a selected parent issue. It's particularly useful in scenarios where tracking the progress or details of sub-tasks or dependent issues is necessary. By focusing on child issues, users can easily manage and navigate through the hierarchical structure of tasks.

Sections - Fields

In the Fields section, users have the option to add custom fields to their issue display panel. Users can select from a range of available fields to be displayed for each filtered issue, ensuring that only relevant information is presented on the panel.

Aggregation Options

Furthermore, the Fields section provides aggregation options for these number type fields, enhancing the analytical capabilities of the interface:

1. Average Aggregation: This option allows users to calculate and display the average value of a selected field across all displayed issues. It is particularly useful for fields that contain numerical data, where an average value can provide meaningful insights, such as average cost, or other quantifiable metrics.

2. Sum Aggregation: Users can also opt for the sum aggregation, which calculates the total sum of values for a selected field across all issues displayed in the panel. This feature is extremely valuable for fields where the total value is more informative than individual entries, such as total expenses, or any other cumulative data points.

3. Count Aggregation: The Count option allows users to calculate how many custom field values are filled in the configured column. When it comes to custom fields where multiple options can be selected, each selected value will count as one.

Field Configuration

The issue key is a default field when you create a new tab, but you can also add new fields to your configuration manually.

• In the Fields section, each row represents a field configuration.

• To add a new field to your panel, click on the + button on the bottom of the section.

• Use the select field in each row to choose a custom field.

• Use the Aggregation select field to choose Average, Sum, or both for a numeric field.

• Delete a row by clicking the icon at the end of the row.

Reordering Fields

To change the arrangement of fields to your specific needs, use the dotted part located at the beginning of each row. By grabbing and drag-dropping these dotted sections, you can change the order of the fields. This customized order determines the column order of the fields on the issue panel. This feature allows you to organize the display according to your preferences.

Saving

Save Settings

Click the Save settings button at the end of the page to save all the configured settings. A flag will be displayed to indicate whether the saving operation was successful. It will also indicate if something is missing from the configuration.

Cancel

Click the Cancel button at the end of the page to revert any unsaved changes.

By following these instructions, you can efficiently manage and customize your Jira tool configuration to suit your project requirements.