docs/features/feature-guides/properties/create-a-property.md
import FeatureAvailability from '@site/src/components/FeatureAvailability';
This guide walks you through creating a Structured Property via the DataHub UI, including:
:::note To learn more about creating and assigning Structured Properties via the CLI, please see the Create Structured Properties tutorial. :::
To create, edit, or remove Structured Properties, you must have the View Structured Properties and Manage Structured Properties platform privileges.
To add an existing Structured Property to an Asset, change its value, or remove it from an Asset, you must have the Edit Properties metadata privilege.
From the navigation bar, go to Govern > Structured Properties.
Click + Create to start defining your Property.
<p align="center"> </p>First, provide the following details:
:::caution Once you you save a Structured Property, you cannot edit or remove Allowed Values. However, you can add additional Allowed Values. :::
For example, imagine your organization wants to standardize how data assets (e.g., Datasets, Tasks, Pipelines) are categorized during their development cycle. By creating a Lifecycle Stage Structured Property, you can set a pre-defined list of allowed statuses, such as Draft, Review, and Prod, ensuring consistency and transparency.
<p align="center"> </p>When defining a Structured Property, you can customize how it will be visible to DataHub users. By default, Structured Properties are visible in an Asset's Properties tab but can be conditionally configured with the following options:
Hide Property:
Use this option if the Structured Property contains sensitive metadata that should not be visible to DataHub users via the UI. This ensures that only users with the necessary permissions can view or interact with the property values.
Customize Visibility:
Decide where the Structured Property appears across the DataHub UI:
Show in Search Filters:
Enable this option to allow users to filter Assets by the values of this Structured Property. This improves discoverability and facilitates searches for Assets with specific attributes or classifications.
Show in Columns Table:
Use this option to display the Structured Property value in the Dataset Schema view’s Columns Table. This is particularly useful for capturing field-level custom metadata and making it accessible alongside schema details.
For the Lifecycle Stage example, imagine you want to allow users to filter by lifecycle status and view it at a glance during data discovery. To achieve this, you would enable Show in Search Filters, Asset Badge, and Asset Sidebar:
<p align="center"> </p>Once a Structured Property has been defined, you can add it to the designated Asset Types.
From an Asset's Properties tab, click the + button to see a drop-down list of all available Structured Properties. For example, you can now see Lifecycle Stage as an option for the pet_profiles Dataset:
Continuing with the Lifecycle Stage example, designate the pet_profiles Dataset as being in Prod:
After clicking Save, the Lifecycle Stage for pet_profiles will appear in the following sections of the Asset Page:
:::info DataHub Compliance Forms make it easy to update values for multiple Assets at once! :::
After a Structured Property has been added to an Asset, users can modify its value or remove the property entirely using the More menu:
<p align="center"> </p>For Structured Properties that have Show in Search Filters enabled, users can filter search results based on allowed values.
For example, with the Lifecycle Stage property enabled as a filter, users can find it under the More dropdown in the Search interface:
<p align="center"> </p>From here, you can quickly narrow down Search results based on the desired stage, such as Prod:
<p align="center"> </p>Notice how the Prod value is displayed prominently on the pet_profiles Asset Badge:
Structured Properties can be applied at the column level, providing deeper context for how individual dataset fields relate to business concepts or terminology. In this example, we’ll create a Structured Property called Business Label to help business users understand how dataset columns align with common terminology, acronyms, or key business concepts.
Follow these steps to define and configure the Business Label Structured Property:
Property Details:
Display Preferences:
:::caution While the column sidebar provides convenient access to assigned properties, adding too many Structured Properties can clutter the view. Limit the number of properties shown in the sidebar to maintain clarity and usability. :::
Once configured, the Business Label Structured Property will automatically be added to all columns on dataset assets within DataHub.
For example, after assigning the property, it will appear in two key areas of the pet_profiles Asset Page:
By applying column-level Structured Properties like Business Label, you enhance data discoverability and provide business users with valuable insights while keeping the interface user-friendly.
<p align="center"> </p>When selecting a specific column in the UI, the Business Label Structured Property will be visible in the column’s sidebar. Users with appropriate permissions can view or update the value directly from this interface.
<p align="center"> </p>This setup ensures that column-specific metadata, such as the Business Label, is accessible and actionable, helping business users better understand the dataset's structure and its alignment with key business concepts.
Once a Structured Property has been defined, only certain aspects can be modified:
You can change:
You cannot change: