We are at Atlassian Summit - which will affect our response times. Meet us there (if you happen to be in San Jose)

Skip to end of metadata
Go to start of metadata

The table grid editor documentation has moved to Table Grid Editor for Jira Server Documentation.

Overview Table Grid Editor Table Grid Reader Multi Level Cascade Still working on multiple issue trackers ? Synchronize any data flexibly with exalate


All properties listed alphabetically can be found on the Grid Property - full list

Grid detail properties

More information on this topic can be found on grid details

gd.allowAddRows Enable or disable the possibility to add rows
gd.cleanupTable Delete rows from the gridtable when containing issue is deleted.
gd.columns Use this to specify what columns should be displayed on the grid
gd.decimalSeparator Use this to specify <span>the default decimal separator for any grid column of type &apos;number&apos;</span>
gd.delete.allowed Allow or disallow users to delete individual rows on a grid
gd.delete.confirmation When enabled, the grid will ask for confirmation before deleting a set of rows using the &apos;delete non modified&apos; or &apos;delete duplicates&apos;
gd.emptyRows Use this to initialize the grid with a number of empty rows. Property is applied when you create a new issue. Columns are initialized with their default value
gd.enableXSSValidation <span style="color: rgb(0,0,0);">This property is in the first place meant to protect against XSS attacks. Use this property to block submission of html based data into a grid cell (string or textarea). </span>
gd.filter Enable filtering capabilities on the grid such that a user can filter out rows based on a search term
gd.insertChangeComments Insert grid changes as comments to the issue
gd.readonly When you want to use the grid for displaying purposes only
gd.sample.size Generate a number of rows with randomly generated content for each of the columns such that a grid can be tested.
gd.selector Enables selection capabilities on the grid such that a user can select one row. Cell value that resides in the selected row and selector column is accessible in other grid queries using {customfield:XXXXX} notation
gd.tablename Provide the base name of the grid table
gd.tracking When enabled, adds 4 tracking columns to the grid table to know who and when a grid row has been added and/or updated.

Grid display properties


Properties used to specify the display (height, width, ...) properties of a grid

gd.caption Sets grid caption
gd.collapseDefault Use collapseDefault to indicate what the collapse status of a grid is when viewed for the first time by a user.
gd.displayCondition Specify the condition when a grid should be showed in the view edit screen
gd.extraHeight Add some extra space below the last row, to avoid that the horizontal scroll bar potentially overlaps the last row.
gd.fitcolumns The columns in the grid are by default resized such that the complete grid does fit into the area provided by JIRA. The aim is to avoid an horizontal scroll bar. When the grid has a lot of columns this results in an  unreadable configuration. <br />gd.fitcolumns allows to change the behaviour, such that the columns are resized or not.
gd.hideFooter Hides grid footer (toolbar with pagination and all buttons in edit mode)
gd.hideHeader Hides grid header
gd.issueNavigatorLayout.header Defines the visibility of a grid&apos;s header in issue navigator
gd.maxDisplayGridHeight Maximum height of a non collapsed grid expressed in pixels
gd.maxDisplayRowCount  maximum number of rows to display
gd.maxDisplayRowHeight Allows to limit the height of a row - for instance when it contains large chunks of text.
gd.minDisplayGridHeight Minimum height of a non collapsed grid expressed in pixels
gd.minDisplayRowCount Minimum number of rows to display.
gd.minDisplayRowHeight Minimum height of a row expressed in pixels
gd.pagination.size Specifies the number of rows on a single grid page
gd.rownumbers If this option is set to true a new column at the left of the grid is created containing the sequence number of the row in the grid.
gd.toolbar.disable Hide particular buttons on the grid toolbar
gd.visiblerows specify how many rows a grid should contain

Grid Initialization properties


You don't need to start with an empty grid. Check grid reload for more details.

gd.ds Use gd.ds to select the database where the grid table should be maintained
gd.initFromClone When gd.initFromClone is true, and an issue is cloned, all rows which are linked to the original issue, will be duplicated to the new (cloned) issue
gd.initFromParent When gd.initFromParent is true, and a sub-task of the issue is created, all rows which are linked to the parent issue, will be duplicated to the created sub-task
gd.query A query, used to initialize the grid when the issue is created, when the grid is reloaded using the <strong>reload button</strong> or when a dependent custom field is changed.<p>Note that this property is applied only on the creation of the issue.</p>
gd.query.columns Use this property to specify which columns should be initialized with the results of a query.
gd.query.ds Specify on which datasource a query needs to be run.
gd.query.keepOnRefresh specifies which rows can be removed when reloading the grid
gd.query.reloadOnCustomFieldChange Allows to disable automatic reloading of the grid on Create Issue and Edit Issue screens triggered by on custom field change
gd.query.reloadTrigger Allows to reload the grid on issue view or update
gd.query.row Use this property to initialize a grid with static data.

Column detail properties


For each column specified in gd.columns, one or more properties can be defined. xyz is a placeholder for the actual column id.

col.xyz Define the column header of a single column
col.xyz.align Horizontal align the content of a column left, middle or center
col.xyz.allow.disabled The col.xyz.type = userlist allows to list all users in a dropdown. The normal behaviour is to list only the active users. This property allows to modify to include the disabled users.
col.xyz.allow.groups Used in the context of a userlist column type - allows to limit the listed users to specific groups
col.xyz.allow.roles Used in the context of a userlist column type - allows to limit the listed users to specific groups
col.xyz.autocomplete When you want a type-ahead drop down list allowing to filter on specific values in the list.
col.xyz.checked When the checkbox is checked - show this value
col.xyz.cols  Specify the number of characters on a single line when editing a cell of a textarea column
col.xyz.defaultDate  initialize a date column with a date calculated from now.
col.xyz.defaultSort Use this property to specify a default sorting when viewing a grid
col.xyz.defaultValue Specify a default value for a column when adding one or more rows
col.xyz.editable Use this to indicate if a column should be readonly or not
col.xyz.firstDayOfTheWeek <span style="color: rgb(0,0,0);">Specifies first day of the week in the datepicker for date and datetime columns</span>
col.xyz.formatDate Format the date when a column is a date type
col.xyz.formatnumber Use this property to format a number according to a particular pattern.
col.xyz.formatnumber.decimalSeparator Use this property to change the decimal separator when using the property col.xyz.formatnumber
col.xyz.formatnumber.groupingSeparator Use this property to change the grouping separator when using the col.xyz.formatnumber property
col.xyz.formatUser Set the format of options of the userlist column
col.xyz.formula Use the formula property to calculate the content of a column. String, math and conditional expressions are supported
col.xyz.hidden Hide a column from displaying on the grid
col.xyz.hidemode The col.xyz.hidemode allows to specify in which grid mode a field must be hidden.
col.xyz.initialValue Set the first value of a sequence
col.xyz.list.size In case of a static list, specify the number of list entries
col.xyz.maxLength Limits the number of characters which can be entered in a text or textarea columns
col.xyz.maxValue Specify a maximum value for a number or integer column. Will show an alert if the number is higher than the maxValue
col.xyz.minValue Specify a mininum value for a number or integer column. Will show an alert if the number is lower than the minValue
col.xyz.name When the name of the attribute in the grid table (in the database) should be different from the column identifier
col.xyz.name=<tracking field> When you want to display in a grid the values of a tracking field. <br />(A tracking field keeps track when and by whom a row in the grid table has been created / updated)
col.xyz.nameX Used to specify the label of a static list entry
col.xyz.parseurl By default, the grid addon will process any character sequence of the form &apos;a:b&apos; in columns of type textarea and string and turn these into a clickable url.<br />This property allows to disable this behaviour 
col.xyz.plain.width Specify the width of the column in pixels for raw grid representation (Issue Search, Printable export)
col.xyz.query Specify a source to initialize a list
col.xyz.query - customfield When you want to reuse options provided in a custom field
col.xyz.query.ds When a list is initialized with a query, use this property to specify which database should be used.
col.xyz.renderer Specify how the content of a string or textarea should be rendered. Two options - text or wiki
col.xyz.required Specify if a column can be empty or not
col.xyz.rows Specify the number of lines of the textarea when editing a cell of a textarea column
col.xyz.sequencePrefix Use this label to prefix the sequence number when viewing the rows in a grid
col.xyz.sortable Specify if a column is sortable or not
col.xyz.summary Adds an additonal row with a summary of the column. This summary can be either &apos;sum&apos;, &apos;avg&apos;, &apos;count&apos;, &apos;min&apos;, &apos;max&apos; or just a label such as &apos;total:&apos;
col.xyz.tooltip Add a short explaination what is expected to be filled in a column
col.xyz.unchecked When the checkbox is unchecked - show this value
col.xyz.uniqueSequence  This property defines if the sequence is unique (is restarted) for each Jira issue or not.
col.xyz.valueX Specify a value for a specific entry in a list
col.xyz.width Specify the width of the column in pixels

Column types

col.xyz.type Specify what type of values can be stored in a column, defines the behaviour of the plugin.
col.xyz.type = checkbox  Show checkbox options when editing a cell.
col.xyz.type = date Formats the column as a date. When editing a cell, brings up a calendar popup.
col.xyz.type = datetime Enter a date time field
col.xyz.type = integer Use this when the column should store plain integer number fields such as 1234, -789, ...
col.xyz.type = list Create a dropdown list which is either initialized using a static list or using a query.
col.xyz.type = number Use this when the column should store number fields with a decimal (such as 1.5, -212.34 ...)
col.xyz.type = radio  To present a radio button group to the user
col.xyz.type = sequence Give each row in the grid a unique id.
col.xyz.type = string The column is used to enter a single line of text.
col.xyz.type = textarea This type allows the user to enter multiple lines of text
col.xyz.type = userlist This column type provides a dropdown listing JIRA users. This type has additional properties allowing to filter the users


Datasource detail properties


These properties are meant to setup a configuration specific connection to a database.
Alternatively (and recommended approach) is to use the Datasource Specifications  

datasource.names define the datasources in use in this grid. Further specified in [database detail
ds.xyz.connection.type = mysql Use this to create a database source which connects to a mysql type of database.
ds.xyz.connection.type = oracle Use this to create a database source which connects to an oracle database.
ds.xyz.connection.type = postgres Use this to create a database source which connects to a postgres database.
ds.xyz.connection.type = sqlserver Use this to create a database source which connects to a MS Sql Server type of database.
ds.xyz.connection.type = sybase Use this to create a database source which connects to an sybase database.


Deprecated properties


Following properties have been replaced with new capabilities of the addon.

Search documentation

Table of contents