Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Excerpt
hiddentrue
First steps with Table Grid in Jira Cloud. Let's go and create a table to structure your data together!
Info

Table Grid for Cloud offers a user-friendly solution for tables in JIRA Cloud. It allows you to gather and structure your data related to an issue in one single table. 

Table of Contents
minLevel1
maxLevel6
outlinefalse
typelist
printablefalse

First steps with Table Grid in JIRA Cloud

Table Grid for Cloud offers a user-friendly solution for tables in JIRA Cloud. It allows you to gather and structure your data related to an issue in one single table. 

Let's go and create a table to structure your data together!

List of Grids

Once the plugin is installed, on the Administration page left menu bar, a separate block called 'Table Grid' with one link 'Grids' will appear. 'Grids' is what we call our tables. When you click this link, it will lead you to the page where all the grids for all projects and issues can be configured. This is where we go to create our first grid.

Image Removed

Once you've installed the plugin, your list of grids is obviously empty. However, not for long as we're up to change it by clicking the blue button in the right corner 'Add Grid'.

1. Create project

In Projects section, click Create project to create new project.

image-20240120-033817.pngImage Added

User choose a Project templates

In this example, writer used Kanban software development board.

image-20240120-034140.pngImage Added

The system will display the software development information for user to follow. User can click “Use template” to process next step.

image-20240120-035335.pngImage Added

With Kanban board, user can choose a project type which are “Select a team-managed project” or “Select a company-managed project”. Please note that in other project template, there will be different project type.

image-20240120-035903.pngImage Added

In Add project details, user can type Name and key of a project, the information of project type will be displayed in the right side of the screen.

image-20240120-040344.pngImage Added

Click Next button to save the project information.

User can connect the project with different spaces such as Confluence by clicking the (blue star) button.

image-20240120-040524.pngImage Added

Click Continue button to proceed next part.

User can see the project board like the example below.

image-20240120-040817.pngImage Added

2a. Create Grid Fields

Add a Grid Field if the data in the grid should be modified from the issue view or if you want to populate the data manually. 

With Table Grid application you can create two types of table grids for different purposes: 

  • Grid fields

  • View fields

The main difference between them is the ability to edit grid content from the issue view.

a. Navigate to Jira Administration

Navigate to Jira Administration by clicking button (blue star) → Click Apps to navigate to Table Grid

image-20240119-101411.pngImage Added

In Grids main page, click Add Grid button to add new grid

image-20240119-101746.pngImage Added

There will be a pop-up that shows the grid type, user choose Grid fields by clicking the circle.

image-20240119-101822.pngImage Added

Click Confirm button to select grids type

Now let's go and create some tables to structure your data together!

b. Create a Grid

This is the page

which

that will help you configure your first grid.

Image Removed

Firstly, give a

name

Name and

description

Description for your new grid, it will help you distinguish your table and give a hint of its purpose once you have multiple grids in your JIRA.

Secondly, since you may want to display your grid only for specific projects and issue types, you need to define them in the 'Scope' section.

These are the projects and issue types where the grid will be displayed.

You can click the (blue star) button to select a Projects to display the grid and Issue Types in the project.

In this example. writer used “Test 1” for both Name and Description of the grid. In Scopes, writer choose project “QSG and “Task”, “Epic”, “Story”, “Bug” and “Subtask” for Issue Type in QSG.

image-20240120-041029.pngImage Added

By default, the field is already filled with some basic configuration for your convenience which you can easily adjust to your needs. 

Image Removed

image-20240119-102712.pngImage Added

That's it for the configurations. You can click Save button to save the information

When save the grid, user can see the list of grids in Grids main page.

image-20240120-030016.pngImage Added

2b. Create a View Field

Now let's take a look at the other type of grid - View Field. This grid cannot be edited from the issue view, it is mostly used to show grid data to customers, or project members that don't need to have editing access. 

a. Connect data source

Navigate to Jira Administration by clicking button (blue star) → Click Apps to navigate to Table Grid

on issue view

To see your Grid on the issue view, create an issue within the respective project and relevant issue type, then enjoy the fruits of your hard work!

Image Removed

Oh, wait... We still need to fill up our grid with data. Just click the Image Removed Edit Grid icon in the top right corner of the grid. It will open the edit mode for you.  

Image Removed

In TABLE GRID section on the left side of the screen, click Data Sources

image-20240122-074227.pngImage Added

Click Add Data Source button to add new data

image-20240122-074529.pngImage Added

Read more information about Data Sources and how to connect a data source.

image-20240122-074709.pngImage Added

In this example, writer chose SQL for Datasource type.

image-20240122-075028.pngImage Added

User click the Test connection to see if the connection works. If it is successful there will be a pop-up message that shows on the right side of the screen like below.

image-20240122-075132.pngImage Added

Click Save button to save the information.

b. Navigate to Jira Administration

Navigate to Jira Administration by clicking button (blue star) → Click Apps to navigate to Table Grid

image-20240119-101411.pngImage Added

In Grids main page, click Add Grid button to add new grid

image-20240119-101746.pngImage Added

In select grids type pop-up, choose View fields then click Confirm to proceed next step.

image-20240120-025609.pngImage Added

The next step is very similar to the Grid Field creation. Give the grid a Name and Description and Select project scope in Scopes section.  

In this example, writer used “View Fields Grid” for Name and Description then select “Quick Start Guide” - “QSG” project.

image-20240122-071554.pngImage Added

In Configuration section, user create new columns by clicking “Add new column” line

User can delete default column by clicking the (blue star) button in the column name.

image-20240122-072002.pngImage Added

In this example, writer create 4 new column

With the first column

  • Choose String for Column type

  • Choose “pcategory” for Identifier and “Category” for Title.

Click Add button to save the column information.

image-20240122-072538.pngImage Added

With the second column

  • Choose String for Column type

  • Choose “pmanufacturer” for Identifier and “Manufacturer” for Title.

Click Add button to save the column information.

image-20240122-072814.pngImage Added

With the third column

  • Choose Number for Column type

  • Choose “pprice” for Identifier and “Price” for Title.

Click Add button to save the column information.

image-20240122-072904.pngImage Added

With the fourth column

  • Choose String for Column type

  • Choose “pmodel” for Identifier and “Model” for Title.

Click Add button to save the column information.

image-20240122-073021.pngImage Added

Configure required columns and switch to the Data Receiver tab. Here you can connect the data source to your table and map the columns of the external database with your newly created table columns.

Choose your Data Source by clicking the (blue star) button, then type a SQL query.

In this example, writer used:

  • “TEST1” for Data Source

  • Code Block
    SELECT * FROM tablegrid.invoice_11; 

    for SQL Query

image-20240122-035530.pngImage Added

In this step, please note that the column name must match with the column database then user can mapping columns and display the data.

In Mapping section, map the columns name with the database column. If it is successful, the full table will display as result below:

image-20240122-035611.pngImage Added

Clicking in Columns, user can see the full table

Click Save button to save the configuration.

image-20240122-081750.pngImage Added

3. View grid on issue view

a. Choose a project

In the main taskbar, select a project

In this example, writer used Quick Start Guide (QSG) project.

image-20240122-082608.pngImage Added

b. Create new issue

In project board, click Create button to create new issue.

image-20240122-083016.pngImage Added

Type for issue Summary

Click Create to save the issue information.

image-20240122-082801.pngImage Added

User click on Grid button to see the grid available for the project.

image-20240122-083400.pngImage Added

For the Grid Fields, user can edit the column by clicking the (blue star) icon.

After fill all of the information, user can click (blue star) button to save or click (blue star) to cancel any changes.

image-20240120-042842.pngImage Added

In the edit mode you can add more rows by clicking

Image Removed Add row

(blue star) button. Use inline editing to fill them up, and save the data by clicking the check mark in the bottom right corner of the grid whenever you're ready. 

That's how easy it is!

The final result will look like this

image-20240120-042405.pngImage Added

View Field grid in read-only mode is available for demonstration. In View Fields Grid, user can

  • 1: Reload grid

  • 2: Filter rows

  • 3: Group by column

  • 4: Export data.

image-20240122-084340.pngImage Added

In future versions, we plan to significantly extend the functionality of the grid. We'll support different database sources, additional data types, and use of formulas. Don't miss our updates!

Still have questions? Visit User guides page for more details.

Panel
borderColorgrey
bgColorwhite
borderWidth1
titleBGColorwhite
titleQuick start guide
Table of Contents