**Source URL:** https://limited.veevavault.dev/mdl/component-types/tab

# Tab

**Class:** `metadata`

A Tab within the UI of Vault.

Learn about [Tabs in Vault Help](https://platform.veevavault.help/en/lr/24023).

| Attribute | Metadata | Description |
| --- | --- | --- |
| `label` | Type: String **Required** Max length: 40 | UI-friendly string in the Vault's base language. |
| `order` | Type: Number **Required** | The relative order of the tabs within Vault's navigation bar. |
| `dashboard` | Type: String Max length: 50 | When set to the name of a dashboard, sets this component to a dashboard Tab. |
| `object` | Type: String Max length: 50 | (Object tabs) The `Object` to display records for e.g. `product__v`. |
| `doctype` | Type: String Max length: 50 | (Document type tab) The `Doctype` to display documents for e.g., `promotional_piece__c`. |
| `subtype` | Type: String Max length: 100 | (Document type tab) The `Doctype` subtype to display documents for e.g. `promotional_piece__c.advertising__c`. |
| `classification` | Type: String Max length: 150 | (Document type tab) The `Doctype` classification to display documents for e.g. `promotional_piece__c.advertising__c.print__c`. |
| `url` | Type: LongString Max length: 2048 | The target URL (if a web Tab). |
| `send_session_via_post_message` | Type: Boolean | Whether to send the user's current session token (if a web Tab). |
| `parent` | Type: String Max length: 43 | Name of the parent `Tab`. |
| `all_view_label` | Type: String Max length: 50 | UI-friendly string in All view. |
| `my_view_label` | Type: String Max length: 50 | UI-friendly string in My view. |
| `recent_view_label` | Type: String Max length: 50 | UI-friendly string in Recent view. |
| `vault_target` | Type: String Max length: 50 | For internal Veeva use only. |
| `object_type` | Type: Component Multi-value | The `Objecttype` (if an object type Tab). |
| `active` | Type: Boolean | Indicates whether the component is active. |
| `filter_criteria` | Type: String Max length: 32000 | Contains the set of fields, operators, and values to be applied as filters for the search results in the tab. |
| `prevent_create` | Type: Boolean | Indicates whether record creation is allowed in an object tab. |
| `modal_create_record` | Type: Boolean | Determines if a new record should be created in a pop-up modal. |
| `related_object_ids` | Type: String Max length: 1500 | Contains a list of object API keys to be used as related object filters in the tab. |
| `admin_tab` | Type: Boolean | For internal Veeva use only. |
| `page` | Type: Component | References a `Page` component. |
| `default_view` | Type: Component | The `Savedview` that Vault displays to users who are viewing the tab for the first time or have not selected another view. You can only set the default view to mandatory saved views. |
| `enable_global_search` | Type: Boolean | For internal Veeva use only. |
| `global_search_placeholder` | Type: String Max length: 1500 | For internal Veeva use only. |
| `related_section` | Type: String Max length: 1500 | When a user creates a  for a related list in a dynamic tab, Vault creates a Tab record and indicates the source page layout and related object type in this field. |

### Subtab

| Attribute | Metadata | Description |
| --- | --- | --- |
| `label` | Type: String **Required** Max length: 40 | UI-friendly string in the Vault's base language. |
| `order` | Type: Number **Required** | The relative order of the tabs within Vault's navigation bar. |
| `dashboard` | Type: String Max length: 50 | When set to the name of a dashboard, sets this component to a dashboard Tab. |
| `object` | Type: String Max length: 50 | (Object tabs) The `Object` to display records for e.g. `product__v`. |
| `doctype` | Type: String Max length: 50 | (Document type tab) The `Doctype` to display documents for e.g., `promotional_piece__c`. |
| `subtype` | Type: String Max length: 100 | (Document type tab) The `Doctype` subtype to display documents for e.g. `promotional_piece__c.advertising__c`. |
| `classification` | Type: String Max length: 150 | (Document type tab) The `Doctype` classification to display documents for e.g. `promotional_piece__c.advertising__c.print__c`. |
| `url` | Type: LongString Max length: 2048 | The target URL (if a web Tab). |
| `send_session_via_post_message` | Type: Boolean | Whether to send the user's current session token (if a web Tab). |
| `parent` | Type: String Max length: 43 | Name of the parent `Tab`. |
| `all_view_label` | Type: String Max length: 50 | UI-friendly string in All view. |
| `my_view_label` | Type: String Max length: 50 | UI-friendly string in My view. |
| `recent_view_label` | Type: String Max length: 50 | UI-friendly string in Recent view. |
| `vault_target` | Type: String Max length: 50 | For internal Veeva use only. |
| `object_type` | Type: Component Multi-value | The `Objecttype` (if an object type Tab). |
| `active` | Type: Boolean | Indicates whether the component is active. |
| `filter_criteria` | Type: String Max length: 32000 | Contains the set of fields, operators, and values to be applied as filters for the search results in the tab. |
| `prevent_create` | Type: Boolean | Indicates whether record creation is allowed in an object tab. |
| `modal_create_record` | Type: Boolean | Determines if a new record should be created in a pop-up modal. |
| `related_object_ids` | Type: String Max length: 1500 | Contains a list of object API keys to be used as related object filters in the tab. |
| `admin_tab` | Type: Boolean | For internal Veeva use only. |
| `page` | Type: Component | References a `Page` component. |
| `default_view` | Type: Component | The `Savedview` that Vault displays to users who are viewing the tab for the first time or have not selected another view. You can only set the default view to mandatory saved views. |
| `enable_global_search` | Type: Boolean | For internal Veeva use only. |
| `global_search_placeholder` | Type: String Max length: 1500 | For internal Veeva use only. |
| `related_section` | Type: String Max length: 1500 | When a user creates a  for a related list in a dynamic tab, Vault creates a Tab record and indicates the source page layout and related object type in this field. |

### Supported Operations

| Operation | Support |
| --- | --- |
| Create | Yes |
| Recreate | Yes |
| Alter | Yes |
| Drop | Yes |
| Rename | Yes |
| Describe | Yes |
| Generate Recreate | Yes |
| Queryable | No |

---

**Previous:** [Signaturepage](/mdl/component-types/signaturepage)  
**Next:** [Tabcollection](/mdl/component-types/tabcollection)