Create a Custom Property for a Data Asset

OpenMetadata uses a schema-first approach, and that’s why we support custom properties for all types of data assets. Organizations can extend the attributes as required to capture custom metadata. You can view the Custom Properties tab in the detailed view for all types of data assets.

Supported Types

Custom properties support the following types.

Create a Custom Property

To create a Custom Property:

1. Navigate to Settings > Custom Properties.
2. Click the type of data asset you want to create a custom property for, such as Tables or Articles. Properties you define under Articles appear on the Custom Properties tab of every Context Center article. The Articles page has an Add Custom Property button, which opens a form for the property’s name, display name, type, and description.
3. Click Add Custom Property. In AI mode, the button is in the modal header. In Classic mode, the button is labeled Add Property.
4. Enter the following details. Turn on Show Help Text at the top of the panel for an explanation of each field.
   • Name (required): Start with a lowercase letter, preferably in camelCase. You can use uppercase letters and numbers. Spaces, underscores, and dots are not supported.
   • Display Name: A friendlier label to show instead of the name.
   • Type (required): Select the type of custom property, such as entityReference or email. For the full list, see Supported Types.
   • Description (required): Describe what the property is for, so your team knows how to use it.
   
5. Click Create.

Add and Edit Custom Property Values

Once the custom property has been created for a type of data asset, you can add the values for the custom property from the Custom Properties tab in the detailed view of the data asset. The tab shows each property as a card.

Find a Property

• Search: Type in the search box to filter the cards by name or description.
• Sort: Use the Sort dropdown to order the cards by Name, Type, or With value first.

Most cards sit in two columns. Properties with larger values (Table, SQL Query, Markdown, and Time Interval) take the full width and appear after the others.

Read a Card

Each card shows an icon for the property type, the property name, a type badge, and the description.

• No value yet: The card shows “No value yet”, an example of a valid value, and a button to add one. The button label depends on the property type, such as Add text, Add email, Add number, Add link, Add query, Add row, Choose value, Set date, Set time, or Set interval.
• Has a value: The card shows the value and an edit (pencil) icon.
• Long lists: Enum and Entity Reference List values show the first few items. Click +N more to see the rest, and Show less to collapse them.

Add or Edit a Value

1. Click the add button on a card with no value, or the edit (pencil) icon on a card that has one.
2. Enter the value in the window that opens. The editor matches the property type:
   • String, Integer, Number, Email, Timestamp, Duration: A text field. OpenMetadata checks the format before you can save.
   • Date, Date Time, Time: Date and time pickers. Date Time and Time values keep seconds.
   • Enum and Entity Reference: A list to select from.
   • Hyperlink: A URL and optional display text. Only http and https links are accepted.
   • Table: Editable rows.
   • SQL Query: A code editor. Press Cmd+Enter (macOS) or Ctrl+Enter to save.
   • Markdown: A rich text editor.
   • Time Interval: A start and end time, with quick picks, a range calendar, and manual entry. Choose Local or UTC time. The end must be after the start.
3. Click Save.

If the save fails, the window stays open and shows an error, so you don’t lose what you entered.

Custom Properties for Teams and Users

Custom properties aren’t limited to data assets. Define them for Teams and Users as well, to capture details such as a cost center or an employee type.

Define the Property

1. Click the Profile icon in the sidebar and select Settings. Then click Custom Properties in the Workspace group.
2. Click the Teams or Users card. The page opens with the Custom Properties and Schema tabs, a Search Properties box, and a Type filter.
3. Click Add Custom Property in the modal header and fill in the fields as described in Create a Custom Property. The Users page and form work the same way.

Set a Value on a Team

Open the team from Settings > Members > Teams, and then click its Custom Properties tab. The tab lists one row for each property defined for teams. Each row shows:

• Type icon: An icon for the property type.
• Name: The property name with a badge for its type.
• Description: What the property captures.
• Value: The current value. Properties with no value show --.

To find and order properties:

• Search Properties: Enter a property name to filter the list.
• Sort: Open the menu to sort by Name (the default), Type, or With value first.

To set or change a value:

1. Click the pencil icon on the row. The row expands to show the value editor. You see the pencil icon only if you have permission to edit.
2. Enter the value.
3. Click Save changes. The button stays disabled until the value changes. Click Cancel to discard your edit.

Set a Value on a User

Open the user from Settings > Members > Users, and then click the Custom Properties tab. For more information about the user view, see User Details. The tab has the same rows, Search Properties box, and Sort menu as the team tab. Click the pencil icon on a row, enter the value, and click Save changes. If no custom properties are defined for users, the tab shows No custom properties for users and points you to Custom Properties in the Workspace group.

Manage Custom Properties

You can edit or delete a custom property from the same page where you create it.

Edit a Custom Property

1. Navigate to Settings > Custom Properties.
2. Click the type of data asset the property belongs to, such as Tables.
3. Find the property in the list and click the edit (pencil) icon in the Actions column.
4. Update the details in the Edit Property window:
   • Display Name: The label shown for the property.
   • Description (required): What the property is for.
   • Type settings: Settings specific to the property type. For an Enum property, you can change the Enum Values and turn Multi Select on or off.
   
5. Click Save. Click Cancel to close the window without saving.

Delete a Custom Property

1. Navigate to Settings > Custom Properties.
2. Click the type of data asset the property belongs to, such as Tables.
3. Find the property in the list and click the delete (trash can) icon in the Actions column.
4. In the Delete Property window, click Confirm. Click Cancel to keep the property.
   Deleting a custom property can’t be undone. OpenMetadata also removes the values stored for that property on every asset.