> ## Documentation Index
> Fetch the complete documentation index at: https://docs.open-metadata.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Intake Forms | OpenMetadata Governance Guide

> Require specific fields to be filled in before a Data Product, Domain, or Glossary Term can be created or updated using Intake Forms.

# Intake Forms

Intake Forms let you require specific fields to be filled in before a **Data Product**, **Domain**, or **Glossary Term** can be created or updated. Use them to make sure every new asset of these types has the ownership, classification, or descriptive metadata your organization needs from the start. This way, reviewers don't have to catch gaps after the fact.

Only one Intake Form can exist per entity type. OpenMetadata enforces it at both the API and UI layers, so a required field can't be skipped by using the API directly either.

Fields the entity's own schema already requires, such as name and description, are always enforced. They aren't configurable here. An Intake Form only adds further, organization-specific requirements on top of them.

## Creating an Intake Form

You must have the Admin role to create and manage Intake Forms.

Navigate to **Settings** > **Governance** > **Intake Forms**. Select the tab below for the entity type you want to configure. An entity type that already has a form shows as already configured and can't be selected again.

<img src="https://mintcdn.com/openmetadata/UN8QCnD-tgQ-Ig6O/public/images/how-to-guides/governance/intake-forms/access-intake-form.png?fit=max&auto=format&n=UN8QCnD-tgQ-Ig6O&q=85&s=758422ea39009a9bb887b550637a2f2f" alt="Intake Forms card under Settings > Governance" data-og-width="3010" width="3010" data-og-height="1592" height="1592" data-path="public/images/how-to-guides/governance/intake-forms/access-intake-form.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/openmetadata/UN8QCnD-tgQ-Ig6O/public/images/how-to-guides/governance/intake-forms/access-intake-form.png?w=280&fit=max&auto=format&n=UN8QCnD-tgQ-Ig6O&q=85&s=94557fdb5eab5e53ca9b05882e88927f 280w, https://mintcdn.com/openmetadata/UN8QCnD-tgQ-Ig6O/public/images/how-to-guides/governance/intake-forms/access-intake-form.png?w=560&fit=max&auto=format&n=UN8QCnD-tgQ-Ig6O&q=85&s=77e4aa6d8214a29385324fb0160baf00 560w, https://mintcdn.com/openmetadata/UN8QCnD-tgQ-Ig6O/public/images/how-to-guides/governance/intake-forms/access-intake-form.png?w=840&fit=max&auto=format&n=UN8QCnD-tgQ-Ig6O&q=85&s=83ad8e3bddb06a41f4086864e8bfef45 840w, https://mintcdn.com/openmetadata/UN8QCnD-tgQ-Ig6O/public/images/how-to-guides/governance/intake-forms/access-intake-form.png?w=1100&fit=max&auto=format&n=UN8QCnD-tgQ-Ig6O&q=85&s=c408bc567d4894d5ec0372cd8f0ad934 1100w, https://mintcdn.com/openmetadata/UN8QCnD-tgQ-Ig6O/public/images/how-to-guides/governance/intake-forms/access-intake-form.png?w=1650&fit=max&auto=format&n=UN8QCnD-tgQ-Ig6O&q=85&s=be5c7413b981f8417f7f929284ed0471 1650w, https://mintcdn.com/openmetadata/UN8QCnD-tgQ-Ig6O/public/images/how-to-guides/governance/intake-forms/access-intake-form.png?w=2500&fit=max&auto=format&n=UN8QCnD-tgQ-Ig6O&q=85&s=a899e165dec1e4b948cd429d8be06ca2 2500w" />

<Tabs>
  <Tab title="Data Product">
    1. Click **Add Intake Form**, then select **Data Product**.

    2. Optional: Add a **Description** explaining what this form enforces.

    3. Optional: Toggle **Enabled** off to save the form without enforcing it yet. It's on by default.

    4. Under **Native Fields**, do the following. Only fields that are optional at the schema level are listed here. Schema-required fields such as name and description are always enforced and don't appear.
       * Check the **Required** box for any of the following fields you want to enforce.

         | Field | Description |
         | - | - |
         | **Display Name** | Name used for display purposes. |
         | **Data Product Type** | The product's type in the Open Data Product Standard (ODPS) taxonomy, such as Dataset or Derived Data. |
         | **Visibility** | Who can discover and access the data product: Private, Invitation, Organisation, Dataspace, or Public. |
         | **Portfolio Priority** | The product's priority in your data product portfolio: Critical, High, Medium, or Low. |
         | **Tags** | Tags associated with the data product. |
         | **Owners** | Owners of the data product. |
         | **Reviewers** | Users who review the data product. |
         | **Experts** | Users who are experts for the data product. |

       * Optional: Enter a custom error message for a required field, shown instead of the default message when that field is missing.

    5. Under **Custom Properties**, do the following:
       * Select **Include** for any custom property defined on Data Product that you want to add to the form.
       * Check the **Required** box for any included property that must be filled in.
       * Optional: Enter a custom error message for a required field, shown instead of the default message when that field is missing.

    6. Click **Create**.

    The following image shows the saved form in edit mode.

    <img src="https://mintcdn.com/openmetadata/UN8QCnD-tgQ-Ig6O/public/images/how-to-guides/governance/intake-forms/data-product-intake-form.png?fit=max&auto=format&n=UN8QCnD-tgQ-Ig6O&q=85&s=3cc5146e6dbf7733fb37f81b3198602d" alt="Data Product Intake Form" width="3020" height="1674" data-path="public/images/how-to-guides/governance/intake-forms/data-product-intake-form.png" />
  </Tab>

  <Tab title="Domain">
    1. Click **Add Intake Form**, then select **Domain**.

    2. Optional: Add a **Description** explaining what this form enforces.

    3. Optional: Toggle **Enabled** off to save the form without enforcing it yet. It's on by default.

    4. Under **Native Fields**, do the following. Only fields that are optional at the schema level are listed here. Schema-required fields such as name and description are always enforced and don't appear.
       * Check the **Required** box for any of the following fields you want to enforce.

         | Field | Description |
         | - | - |
         | **Display Name** | Name used for display purposes. |
         | **Tags** | Tags associated with the domain. |
         | **Owners** | Owners of the domain. |
         | **Experts** | Users who are experts in the domain. |

       * Optional: Enter a custom error message for a required field, shown instead of the default message when that field is missing.

    5. Under **Custom Properties**, do the following:
       * Select **Include** for any custom property defined on Domain that you want to add to the form.
       * Check the **Required** box for any included property that must be filled in.
       * Optional: Enter a custom error message for a required field, shown instead of the default message when that field is missing.

    6. Click **Create**.

    The following image shows the saved form in edit mode.

    <img src="https://mintcdn.com/openmetadata/UN8QCnD-tgQ-Ig6O/public/images/how-to-guides/governance/intake-forms/domain-intake-form.png?fit=max&auto=format&n=UN8QCnD-tgQ-Ig6O&q=85&s=7ef1a62653259f3ec83562eebb9e1481" alt="Domain Intake Form" width="3008" height="1696" data-path="public/images/how-to-guides/governance/intake-forms/domain-intake-form.png" />
  </Tab>

  <Tab title="Glossary Term">
    1. Click **Add Intake Form**, then select **Glossary Term**.

    2. Optional: Add a **Description** explaining what this form enforces.

    3. Optional: Toggle **Enabled** off to save the form without enforcing it yet. It's on by default.

    4. Under **Native Fields**, do the following. Only fields that are optional at the schema level are listed here. Schema-required fields such as name and description are always enforced and don't appear.
       * Check the **Required** box for any of the following fields you want to enforce.

         | Field | Description |
         | - | - |
         | **Display Name** | Display name of the glossary term. |
         | **Synonyms** | Alternate names that are synonyms or near-synonyms for the term. |
         | **Tags** | Tags associated with the term. |
         | **Reviewers** | Users who review the term. |

       * Optional: Enter a custom error message for a required field, shown instead of the default message when that field is missing.

    5. Under **Custom Properties**, do the following:
       * Select **Include** for any custom property defined on Glossary Term that you want to add to the form.
       * Check the **Required** box for any included property that must be filled in.
       * Optional: Enter a custom error message for a required field, shown instead of the default message when that field is missing.

    6. Click **Create**.

    The following image shows the saved form in edit mode.

    <img src="https://mintcdn.com/openmetadata/UN8QCnD-tgQ-Ig6O/public/images/how-to-guides/governance/intake-forms/glossary-intake-form.png?fit=max&auto=format&n=UN8QCnD-tgQ-Ig6O&q=85&s=c24e3174eddf456c913ba0845fcbae41" alt="Glossary Term Intake Form" width="3016" height="1680" data-path="public/images/how-to-guides/governance/intake-forms/glossary-intake-form.png" />
  </Tab>
</Tabs>

## Managing Intake Forms

After you add the Intake Form, it appears in the Intake Forms list. From there, do any of the following:

<img src="https://mintcdn.com/openmetadata/UN8QCnD-tgQ-Ig6O/public/images/how-to-guides/governance/intake-forms/manage-intake-form.png?fit=max&auto=format&n=UN8QCnD-tgQ-Ig6O&q=85&s=772bf8b6013cad0725d343d417072a2d" alt="Intake Forms list" width="2862" height="1152" data-path="public/images/how-to-guides/governance/intake-forms/manage-intake-form.png" />

* **Enabled** toggle: Use this to turn the form's enforcement on or off without deleting it. A disabled form doesn't block anything.
* **Actions**: In the Actions column, do any of the following:
  * **Edit**: Click the **Edit** icon, modify the details, and click **Save**.
  * **Delete**: Click the **Delete** icon, then confirm the deletion in the dialog.

## What Happens When a Required Field Is Missing

If a required field's value is missing when someone creates or updates a matching entity, OpenMetadata rejects the request and lists which fields are missing. It shows your custom error message instead, if you set one for that field.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.