Set up your first grid

We assume you already have a good understanding of setting up custom fields in JIRA and configuring access to relational databases. This getting-started guide shows you how to setup your first table grid.

We will create a very simple grid listing family members. For each family member we document the first name, date of birth, gender and role in the family.

The configuration is set up without any external storage (in a later stage we will add external storage).

Create a new custom field of type Table Grid Editor

Select the Table Grid Editor custom field type 

Add a name 'Family List'

Configure the grid

The grid custom field is always created with default value.

Go to the field configuration page and open the default value configuration box:

Copy paste the configuration below into the custom field default value (there's no problem if you replace the existing default setup).

Grid configuration
gd.columns=name,dob,gender,relation gd.tablename=Family_list gd.ds=jira col.name=First name col.name.type=string col.name.width = 40 col.dob=Date of Birth col.dob.type=date col.dob.width=60 col.dob.editable=true col.gender=Gender col.gender.width=30 col.gender.editable=true col.gender.sortable=true col.gender.type=radio col.gender.list.size=2 col.gender.name1=Male col.gender.value1=M col.gender.name2=Female col.gender.value2=F col.relation=Role col.relation.width=30 col.relation.sortable=true col.relation.type=list col.relation.list.size=4 col.relation.name1=Father col.relation.value1=Dad col.relation.name2=Mother col.relation.value2=Mom col.relation.name3=Son col.relation.value3=S col.relation.name4=Daughter col.relation.value4=D

After saving the default value you should see :

Put this custom field on an appropriate screen attached to a specific issue type.

Test the new grid

Create a new issue which contains the grid custom field, and press to add a new row

A popup form is displayed, allowing you to add family members.

Go ahead and add a couple more - get to know the different functions to edit a grid.
You should be able to enter the names of a complete family: