---
alias: user-guide-lookup-tables-index
description: "This documentation explains a system for managing hierarchical data sets with value-description pairs"
---

# Lookup Tables

**Lookup Tables** provide a system-wide mechanism to store hierarchical sets of (value, description) pairs, used primarily to feed selection lists.

All **Lookup Table** values are stored in the same table, in the database.

## System Lookup Tables

The system comes with a set of **Lookup Tables** which are necessary for the normal functioning of the system. You can see the list of tables below:

{% include-markdown 'includes/docsync/lookup_table_list.md' %}

## Lookup Table Page Views

### Data View

Lists all the data rows that are included in the **Lookup Table**. You can edit existing rows or add new ones.

![Data view of the Lookup Table page][table_lookup_data_view]

### Definition View

Displays information on the actual table definition.

![Definition view of the Lookup Table page][table_lookup_definition_view]

### History View

Combines information concerning other objects that have references to the current **Lookup Table** object:

* **History** - displays operations, associated information, user(s) performing the changes and date and time of the changes.

## Creating a Lookup Table

:lock: LookupTable.**Create**

### Step 1: General Data

1. Enter a name for the **Lookup Table**.
2. Optionally, enter the description.
3. Specify whether the table should only show values that are enabled in the table when performing a selection.
4. Select **Create** to finish the process.

![table_lookup_create_step_one][table_lookup_create_step_one]

## Editing a Lookup Table Definition

:lock: LookupTable.**Edit**

To edit the definition of the **Lookup Table**, open the **Definition View** and select :material-pencil:. A wizard will be displayed to allow editing the basic details as well as adding or removing properties. Select **Create** to save the new settings.

!!! warning
	It is only possible to edit the definition of a table you created.

![table_lookup_definition_edit][table_lookup_definition_edit]

## Terminating a Lookup Table

:lock: LookupTable.**Delete**

To terminate a **Lookup Table**, it is necessary to open the **Lookup Table** details and select **Terminate**.

!!! warning
	A Lookup Table cannot be terminated if referenced by an active object.

## Unterminating a Lookup Table

:lock: LookupTable.**Unterminate**

To unterminate a **Lookup Table**, it is necessary to open the **Lookup Table** details and select **Unterminate**.

## Editing Lookup Tables Data

:lock: LookupTable.**EditData**

1. Open the **Data View**.
2. Select :material-pencil: on the top ribbon.
3. Add new entries by selecting :material-plus: and adding the values on the right side panel.
4. Disable existing records by selecting the values and activating the Enable switch accordingly.
5. If desired, sub-level entries can be added by selecting **Options** on the top right and checking Allow Sub-levels. This will create a vertical division in the left side panel, allowing the user to add child values and add them to existing parent values.
6. Select **Save** to commit the changes.

![table_lookup_data_edit][table_lookup_data_edit]

[table_lookup_data_view]: ../../images/table_lookup_data_view.png
[table_lookup_data_edit]: ../../images/table_lookup_data_edit.png
[table_lookup_definition_view]: ../../images/table_lookup_definition_view.png
[table_lookup_create_step_one]: ../../images/table_lookup_create_step_one.png
[table_lookup_definition_edit]: ../../images/table_lookup_definition_edit.png