Before using the data table custom field, you have to configure it as described in the Data Table Configuration page.
For this example we will use a dynamic SQL script as a data source to retrieve all data from a product table based on the value of another custom field. So the configuration for our custom field will look like this:
{customfield_10001} represents a free text custom field which will be used for filtering the product name.
After the field is configured, when viewing/creating/editing an issue, as well as in a transition screen, the data table custom field will be populated with the values retrieved from running the sql query with the given parameter taken from issue:
Every time the parameter custom field changes the query is re-executed and the grid displays the new results accordingly. Issue standard fields can also be used as dynamic parameters for the query. For more details check out the Dynamic Query (SQL) page.
If the field would be configured without the dynamic parameter in the sql (without the where clause) it would always retrieve all results from the table, as shown below:
You can change the table headers by specifying columns alias in the sql query. For our example, you can change the sql query to display the columns names as Id, Name and Description. You can also specify an order by clause, to display the data in the table grid ordered by the desired column:
SELECT P_NAME AS Name, P_DESCR AS Description, P_ID AS Id FROM PRODUCT ORDER BY P_NAME
After saving the configuration with the modified sql query, the data table custom field will display our data like this:
That's it.