Home > Blog > Data Modeling
Enrich Your Metadata with User-Defined Properties
|
The Datanamic Team |
Sometimes, the default properties in your data model just aren't enough. Adding extra details to your metadata can provide valuable business context, making your data models smarter, more informative, and better aligned with your project's needs. Enter user-defined properties - your flexible tool for enriching metadata.
User-defined properties let you add custom metadata to any object in your data model, including entities, attributes, relationships, views, and procedures. Whether you're tracking sensitive data, adding technical notes, or defining business-critical details, these properties are:
- Flexible: Adapt them to fit your project's specific requirements.
- Customizable: Use preset values, text, numbers, or yes/no options.
- Versatile: Apply them to multiple object types across your model.
Example Use Case:
Need to track sensitive information? Add a property like "Personally Identifiable Information (PII)" with values such as Non-PII, Sensitive PII, or Non-Sensitive PII.
Create and Manage Properties
Use the User-Defined Properties dialog to create, update, and maintain your properties. Define attributes such as:
- Unique property name
- Type (Value from list, Text, Yes/No, Number)
- Description and optional default value
- Applicable object types (e.g., entities, attributes, relationships, etc.)
Create, update, and maintain properties in the user defined properties dialog.
Streamline Metadata Management
Once created, user-defined properties are visible in the User-Defined Properties tab of the relevant object type. For instance, if applied to attributes, these properties will appear in the Attributes tab within the entity dialog.
User defined properties tab for an attribute in the entity dialog.
Take It Further: Documentation & Exporting
Database Documentation: User-defined properties won't be generated into your database, but they will enhance your project documentation. Include them in reports using the Generate Report tool, just like any standard field.
CSV Export: Export your data dictionary to CSV files, and your user-defined properties will automatically be included. The field names will combine the property's group and name for clarity.
Add user defined properties to your database documentation.
Export data dictionary to CSV files and include user defined properties.
Generated database documentation with user defined property.
Why It Matters
A data model enriched with user-defined properties goes beyond basic structure - it offers deeper context that aligns with business requirements, security standards, and project-specific details. This makes your models more robust, insightful, and ready to tackle complex challenges.
Ready to Elevate Your Data Models?
Get started with DeZign for Databases today and build smarter, more mature data models that go beyond structure to deliver true business value.