Skip to main content

How to Create a Custom Property for a Data Asset

Collate uses a schema-first approach and supports custom properties for all types of data assets. Organizations can extend the default attributes to capture metadata that matters to them, such as business owner, SLA tier, compliance classification, and more. Custom property values can be viewed and edited from the Custom Properties tab on any data asset detail page.

Creating a Custom Property

  1. Navigate to Settings > Custom Properties. Custom Properties card on the Settings page
  2. Choose the type of data asset you want to define a custom property for, such as Database, Table, Dashboard, and so on. Select a data asset type to define custom properties for
  3. On the asset type page, click Add Property. Asset type page with the Add Property button and the list of custom properties The page has two tabs:
    • Custom Properties: The properties defined for this asset type, with a count. Use Search Properties to find one, and the Type filter to narrow the list by property type. The table has these columns:
      • Property: The property name and its description. Click the column heading to sort.
      • Type: The property type, for example String, Enum, or Table.
      • Configuration: The settings of the property. An Enum property shows its allowed values and whether it is Multi Select. A Table property shows its columns. Properties with no extra settings show a dash.
      • Actions: The ⋮ menu with Edit and Delete. For more information, see Edit or Delete Custom Properties.
    • Schema: The JSON schema of the asset type. Click the copy icon to copy it.
    Schema tab showing the JSON schema of the Table asset type
  4. In the Add Custom Property panel, fill in the following fields:
    • Name (required): Must start with a lowercase letter, preferably in camelCase format. Uppercase letters and numbers are allowed. Spaces, underscores, and dots aren’t.
    • Display Name: A human-readable label shown on the data asset page.
    • Type (required): The data type for this property. Select it from the dropdown. For more information, see Supported Property Types.
    • Description (required): Describe what this property captures to help your team understand its purpose. The field has a rich text editor.
    Add Custom Property panel with Name, Display Name, Type, and Description Turn on Show Help Text at the top of the panel to see guidance for each field next to the form. The help text covers Name, Display Name, Type, and Description. It also explains Enum Values and Multi Select, which apply to Enum properties. Add Custom Property panel with the help text panel open
  5. Click Create to save the property.

Supported Property Types

When adding a custom property, select one of the types from the Type dropdown. The dropdown is long, so these three images show it from top to bottom. The table after the images describes each type. Type dropdown, part 1: Date through Enum Type dropdown, part 2: Enum through SQL Query Type dropdown, part 3: Number through Timestamp

Enum Properties

When you select Enum as the Type, two more fields appear in the panel:
  • Enum Values (required): The values users can choose from.
  • Multi Select: Turn on to let users choose more than one value. It is off by default.
Add Custom Property panel with Enum selected, showing Enum Values and Multi Select

Adding Values to Custom Properties

After a custom property is defined, set its value directly from the data asset detail page:
  1. Open any data asset and click the Custom Properties tab. Custom Properties tab on a data asset showing a card for each property The tab shows one card for each custom property defined for that asset type. Each card shows:
    • Name and type: The property name with a badge for its type, for example Date & Time or Duration.
    • Description: What the property captures.
    • Value: The current value, or No value yet when none is set. A format hint shows the expected format, for example 16-10-2026 18:58:23 for a date and time, or an ISO 8601 duration such as PnYnMnDTnHnMnS.
    • Set button: The action to add a value. Its label matches the type, for example Set date and time or Set duration.
  2. To find a property, enter its name in Search Properties. Use the Sort menu to change the order. The default is Sort: Type.
  3. Click the set button on the card of the property you want to update, enter the value, and save.

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. Navigate to Settings > Custom Properties.
  2. Click the Teams or Users card.
  3. Click Add Property and fill in the fields as described in Creating a Custom Property.

Set a Value on a Team

  1. Navigate to Settings > Team & User Management > Teams. Team and User Management page with the Teams, Users, Admins, Online Users, and Provisioning cards
  2. Open the team and click its Custom Properties tab. Team Custom Properties tab with a costCenter property and an Add text button
The tab shows one card for each property defined for teams, with its name, type, description, and current value. Use Search Properties to find a property and the Sort menu to change the order. The default is Sort: Name. To set a value, click the button on the card. Its label matches the type, for example Add text for a String property. The Set window that opens is the same as for users. For more information, see Set a Value on a User. Set costCenter window with the Enter Property Value field, Cancel, and Save

Set a Value on a User

  1. Navigate to Settings > Team & User Management > Users.
  2. Click the Custom Properties tab. User page with the Custom Properties tab showing a costCenter property and an Add text button
  3. Find the property card and click its button to set a value, for example Add text for a String property. A Set window opens with the property name in its title, for example Set costCenter. Enter the value in Enter Property Value and click Save. Click Cancel to close the window without saving. Set costCenter window with the Enter Property Value field, Cancel, and Save
The tab has the same Search Properties box and Sort menu as the team tab.

Edit or Delete Custom Properties

To edit or delete a custom property definition:
  1. Navigate to Settings > Custom Properties.
  2. Select an asset type.
  3. In the Actions column of the property, click the ⋮ icon and select an option:
    • Edit: Open the Edit Property window.
    • Delete: Permanently remove the property and all its values.
    Actions menu with Edit and Delete options for a custom property

Edit a Property

The Edit Property window shows the property name in its title. Change the following:
  • Display Name: The label shown on the data asset page.
  • Description (required): What the property captures.
Edit Property window with Display Name and Description The Name and Type of a property aren’t shown, so you can’t change them after the property is created. For an Enum property, the window also shows:
  • Enum Values (required): The values users can choose from. Click the x on a value to remove it, or type to add one.
  • Multi Select: Turn on to let users choose more than one value.
Edit Property window for an Enum property with Enum Values and Multi Select Click Save to apply your changes, or Cancel to discard them.

Delete a Property

Select Delete from the ⋮ menu. A confirmation window asks whether you are sure you want to delete the property. Click Confirm to delete it, or Cancel to keep it. Delete Property confirmation window with Cancel and Confirm buttons
Deleting a property permanently removes it and all its values from the assets that use it.

Overview of Announcements

Learn more about the announcements in Collate