Complete reference for custom metadata property configuration, including all field types, settings, and asset targeting options.
Custom metadata properties
Custom metadata properties enable you to extend Atlan's built-in metadata with organization-specific fields that capture unique business context and requirements. Properties are defined within custom metadata structures and can be configured with specific data types, validation rules, and asset targeting.
This reference provides complete configuration details for custom metadata properties. Use this page to look up specific property definitions, valid values, and configuration options when setting up custom metadata for your organization.
Name
Specifies the display name for the custom metadata property. This name appears in the Atlan interface when users view or edit custom metadata values on assets.
- Must be unique within the custom metadata structure
- must be descriptive and clear to end users
- can't be changed after the property is created
Example:
License Type
Description
Provides additional context about the property's purpose, usage guidelines, or business meaning. This helps users understand when and how to use the property correctly. Descriptions can be up to 280 characters.
Example:
Defines the licensing terms under which this data asset can be used, including any restrictions or requirements for attribution.
Text
Enables free-form text input with no specific format requirements. Use this type for descriptive fields, notes, or any content that doesn't fit other specific types.
Example values:
"Customer data for Q4 analysis"
"Internal use only"
"ABC-123-XYZ"
Integer
Restricts input to whole numbers only (no decimal points). Use this type for counts, IDs, or any numeric values that don't require fractional precision. Integer values range from negative 2,147,483,648 to 2,147,483,647. For larger whole numbers, use Long.
Example values:
42
1000
-5
Long
Restricts input to whole numbers only (no decimal points), with a much larger range than Integer. Use this type for whole numbers that can exceed 2,147,483,647, such as row counts for large tables, file sizes in bytes, or timestamps in milliseconds. When you enter values in Atlan, Long accepts whole numbers from negative 999,999,999,999,999 to 999,999,999,999,999.
You can't change a property's type after you create it, so choose Long instead of Integer up front if values can grow beyond the Integer range.
Example values:
5000000000
1735689600000
-9000000000
Decimal
Enables fractional numbers with decimal points. Use this type for measurements, percentages, or any numeric values requiring precision.
Example values:
3.14159
99.5
-12.75
Boolean
Restricts input to true/false values only. Use this type for yes/no questions or binary states.
Example values:
Yes
No
Date
Enables date and time values in a standardized format. Use this type for timestamps, deadlines, or any time-based information.
Format: Day, month, year, hours, minutes, and seconds
Example values:
2024-01-15 14:30:00
2024-12-31 23:59:59
Options
Restricts input to a predefined set of valid values. Use this type when you need to standardize responses and make sure data consistency.
Configuration options:
- Select existing options: Choose from previously created option sets
- Create new options: Define a new set of valid values
Example option sets:
Status: Active, Inactive, Pending, Deprecated
Priority: High, Medium, Low, Critical
Environment: Development, Staging, Production
Users
Restricts input to existing Atlan users only. Use this type for fields that reference specific people in your organization.
Example values:
john.doe@company.com
jane.smith@company.com
Groups
Restricts input to existing Atlan groups only. Use this type for fields that reference teams or organizational units.
Example values:
data-governance-team
analytics-department
security-reviewers
URL
Restricts input to valid web links only. Use this type for fields that reference external resources or documentation.
Example values:
https://docs.company.com/data-catalog
https://github.com/company/data-pipeline
https://jira.company.com/browse/DATA-123
SQL
Restricts input to valid SQL code only. Use this type for fields that contain database queries or SQL-related content.
Example values:
SELECT * FROM customers WHERE created_date >= '2024-01-01'
UPDATE orders SET status = 'processed' WHERE order_id = ?
Rich text
Enables formatted text input with support for markdown-style formatting, links, lists, and other rich content. Use this type for fields that need multiple readme-style fields on an asset without bloating the typedef for customers who don't need it.
Example values:
# Data Processing Notes
This table contains **customer transaction data** for Q4 analysis.
## Key Information
- Updated daily at 2 AM
- Contains PII data
- [Documentation](https://docs.company.com/customer-data)
> **Note:** This data is sensitive and requires proper handling.
Select options
Choose from existing option sets that have been previously created in your Atlan workspace. This promotes consistency across multiple properties that use the same set of values.
Create new
Define a new set of options specifically for this property. This is useful when you need unique values that aren't used elsewhere.
Configuration:
- Option name: A descriptive name for the option set
- Values: List of valid values separated by semicolons (
;)
Example:
Option name: Data Classification Levels
Values: Public;Internal;Confidential;Restricted
Connections
Specifies which data connections can use this property. This is useful when you want to limit certain metadata to specific data sources.
Example:
Production Snowflake
Development PostgreSQL
Applicable asset types
Defines which types of assets can be enriched with this property. This helps make sure that metadata is only applied to relevant assets.
Available asset types:
- Database assets: Tables, views, columns, schemas, databases
- BI assets: Dashboards, charts, reports, datasets
- File assets: Files, folders
- API assets: APIs, endpoints, operations
- Process assets: Workflows, jobs, pipelines
Example:
Tables, Views, Columns
Dashboards, Charts
Glossaries
Specifies which glossaries can use this property. This enables you to apply different metadata standards to different business domains.
Example:
Finance Business Graph
Marketing Business Graph
Applicable asset types
Defines which glossary asset types can use this property.
Available glossary asset types:
- Business Graph: The glossary itself
- Category: Business Graph categories
- Term: Individual glossary terms
Example:
Terms, Categories
Domains
Specifies which data domains or subdomains can use this property. This enables domain-specific metadata governance.
Example:
Customer Data Domain
Financial Data Subdomain
Applicable asset types
Defines which domain asset types can use this property.
Available domain asset types:
- Domain: Top-level data domains
- Subdomain: Subdomains within domains
- Product: Products within domains or subdomains
Example:
Domains, Subdomains, Products
Applicable asset types
Defines which non-connection, non-glossary, non-domain assets can use this property.
Currently supported:
- File assets: Files and folders
Example:
Files, Folders
Allow multiple values
Controls whether users can enter more than one value for this property. This setting is only available for certain property types, and you can't change it after you create the property.
Available for:
- Text
- Integer
- Long
- Decimal
- Options
- Users
- Groups
- URL
Boolean, Date, SQL, and Rich text properties hold a single value.
Example with multiple values:
Data Stewards: john.doe@company.com, jane.smith@company.com
Categories: Customer Data, PII, Analytics
Show in filter
Controls whether users can filter assets based on this property's values during asset discovery. This setting is turned on by default for new properties.
Benefits:
- Enhanced search capabilities
- Quick asset discovery
- Improved data governance workflows
Show in overview
Controls whether the property appears in the Overview tab of asset sidebars, in addition to the custom metadata tab.
Benefits:
- Increased visibility for important properties
- Quick access to key metadata
- Better user experience
Show as featured
Controls whether the property appears in the featured custom metadata section of the asset summary. This setting is turned off by default for new properties.