Manage custom properties
In Pentaho Data Catalog, you can create custom properties that collect additional metadata about resources specific to their business environment or engagement. For example, you can define a custom property to include a business username for a data resource. Alternatively, you could define a property that includes values that are used by system-level processes. To know more, see Resource properties in the Use Pentaho Data Catalog guide.
Add a custom property
You can add custom properties to various asset types, including Data Canvas resources, Business Glossaries, Applications, Policies, Physical Assets, Machine Learning (ML) Models, Business Intelligence, Reference Data, and Data Collections.
Perform the following steps to add a custom property to any supported asset.
Procedure
On the Data Catalog home page, go to the asset type where you want to add a custom property. For example, select a table, column, or file from the Data Canvas, a business term from the Glossary, an application from Applications, or other supported asset types such as policies and standards, Physical Assets, or Machine Learning (ML) Models.
Go to the Custom Properties tab and click Add Custom Property. The Create Custom Property dialog box appears.
In the Create Custom Property dialog box, enter the following information:
Property Name: The unique name of the custom property. Note: If you want to create a standard custom property, do not toggle the Data Label switch. Toggle the switch only if you want to create a data label. See Manage data labels for more information.
Field Type: Select how users will enter values for the property:
Free Text: Allows users to enter any text value.
Select Value: Enables a drop-down list of predefined values.
Available Values (Displayed only if Select Value is chosen.) Define one or more values for the property. Click Add Value to add new entries, and for each value, you can also provide a Description to explain its meaning or usage. These values appear as selectable options when users assign this property to a catalog asset.
Default Value: Select a value from the defined list to appear automatically when no specific value is assigned.
Allow Blank: Select this checkbox to allow the property to remain empty.
Click Save.
Result
You have successfully created a custom property and added to the selected asset. You can view this under the Custom Properties tab of the asset and you can further edit or delete it. If you selected Select Value as the field type, the defined values now appear as drop-down options when users assign this property to assets.
Edit a custom property
You can modify an existing custom property in Data Catalog. Editing custom properties lets you update the property name, add new values, edit or delete existing values, and allow the blank selection so your metadata stays accurate and useful.
You cannot change the Field Type for an existing property.
Perform the following steps to edit a custom property.
Procedure
On the Data Catalog home page, go to the asset type where you want to edit a custom property. For example, choose a table, column, or file from the Data Canvas; a business term from Glossary; an application from Applications; or other supported asset types such as policies and standards, Physical Assets, or Machine Learning (ML) Models.
Go to the Custom Properties tab. The list of existing custom properties appears.
Find the custom property you want to change and click the Edit (pencil) icon. The Edit Custom Property dialog box opens.
Update the fields as needed:
Property Name: Change the name if required.
Available Values (shown only when the property is Select Value type):
Click Add Value to add a new value.
Edit an existing value if required.
Use the Delete icon to remove an option.
(Optional) Add a Description for each value to clarify usage.
Default Value: Pick the value that should be selected by default.
Allow Blank: Select or clear to allow or prevent empty values.
Click Save.
Result
Your changes are applied across all catalog objects that use this custom property. If you edited selectable values, those updates are reflected in the property’s drop-down wherever it appears. All changes are recorded for administrative traceability.
Delete a custom property
You can permanently remove or delete a custom property from Data Catalog. Deleting unused or obsolete properties keeps your catalog clean and prevents inconsistent metadata.
When you delete a custom property that is associated with one or more entities, Data Catalog automatically removes all mappings before permanently deleting the property.
Because you cannot recover this data, use caution when deleting custom properties.
Perform the following steps to remove or delete a custom property.
Procedure
On the Data Catalog home page, select the asset that contains the property you want to delete. For example, choose a table, column, or file from Data Canvas; a business term from Glossary; an application from Applications; or other supported asset types such as policies and standards, Physical Assets, or Machine Learning (ML) Models.
Go to the Custom Properties tab. The list of existing custom properties appears.
Find the property you want to remove and click the Delete (trash) icon. A confirmation dialog opens to confirm the deletion.
Click Confirm to delete the selected custom property. If the property is used by other objects, Data Catalog first disassociates it from all linked entities and then deletes it. If the property isn’t used elsewhere, it is deleted immediately.
Result
You have successfully removed the custom property from the catalog and from all data resources or assets where it was previously associated.
Last updated
Was this helpful?