> For the complete documentation index, see [llms.txt](https://docs.openg2p.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.openg2p.org/products/registry/registry/developer-zone/building-a-registry/concepts/registry-and-register-metadata/g2pregisteruitab.md).

# G2PRegisterUITab

g2p\_register\_ui\_tabs - UI Configuration (Tabs) for Registers & Program Registers

The [`g2p_register_tabs`](https://github.com/OpenG2P/registry-platform/blob/develop/core/openg2p-registry-core/src/openg2p_registry_core/models/g2p_register_metadata.py) table stores **tab definitions for registers** within the OpenG2P Registry platform.

This configuration is applicable only to datasets classified as:

* **REGISTER**
* **PROGRAM\_REGISTER**

The **Registry Staff UI** uses this metadata to dynamically render the **tabbed interface** when viewing or managing records within a register.

In addition to defining UI tabs, this table is also used to configure **Intake Forms**, which serve as input channels for creating new records in registers.

A register or program register may have **multiple intake forms**, each designed for different operational channels such as:

* Staff Portal
* Agent Portal
* Beneficiary Portal

***

### Attributes

| Attribute        | Description                                                                    |
| ---------------- | ------------------------------------------------------------------------------ |
| **tab\_id**      | Primary key. Uniquely identifies a tab.                                        |
| **register\_id** | Register to which the tab belongs.                                             |
| **tab\_label**   | Label displayed in the UI (translated when language configuration is present). |
| **tab\_order**   | Display order. Lower values appear first.                                      |

***

### Intake form fields (legacy)

Some deployments store intake-form flags on register tabs. When using dedicated intake form tables (G2PIntakeFormDefinition), prefer seeding `g2p_intake_form_*` metadata instead.

| Attribute                           | Description                                    |
| ----------------------------------- | ---------------------------------------------- |
| **used\_for\_new\_intake\_form**    | Tab represents an intake form for new records. |
| **intake\_form\_name**              | Display name when multiple intake forms exist. |
| **intake\_form\_description**       | Short description of the form.                 |
| **no\_of\_verifications\_required** | Verifications before intake approval.          |
| **intake\_form\_auto\_approve**     | Auto-approve intake submissions.               |

***

### Lifecycle

| Attribute      | Description                                                  |
| -------------- | ------------------------------------------------------------ |
| **is\_active** | When `FALSE`, tab is retired without deleting configuration. |

***

### Related metadata

Sections are linked to tabs through G2PRegisterUITabSection.

| Table                          | Document                                                                                                                                           |
| ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| `g2p_register_ui_tab_sections` | G2PRegisterUITabSection                                                                                                                            |
| `g2p_register_sections`        | [G2PRegisterSection](/products/registry/registry/developer-zone/building-a-registry/concepts/registry-and-register-metadata/g2pregistersection.md) |

***

## Reference Implementation

Reference implementation of this table for a Farmer Registry can be found in the Farmer Extension repository - [here](https://github.com/OpenG2P/farmer-registry/blob/develop/farmer-extension/src/openg2p_registry_farmer_extension/db_scripts/register-metadata/g2p_register_ui_tabs.sql).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.openg2p.org/products/registry/registry/developer-zone/building-a-registry/concepts/registry-and-register-metadata/g2pregisteruitab.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.