The reference data configuration is meant to map technical identifiers to human readable labels. A typical use case is when you have an integer column with a few different values which have meaning.

As an example, let's say we have a payments table and this table has a status column which is of type integer. Typically this column would be filled by values associated to constants in application code. The application code would also contain labels to display the values properly within the application. However DbInsights cannot know about these labels and only sees the values in the database. We thus have to create a reference datum object to document this column.

The reference datum object allows to associate values with labels for a specific column of a table.

Reference datum configuration

This documentation can serve as a reference when specifying conditions for creating a graph for instance. The values will show up in the column listing on the right when creating charts.

Column listing

And they are also used when displaying pies, graphs or query results.

Graph legends

Pie labels

Query results

You can follow the Reference data tutorial to see this feature in action on the sandbox account.