You can tailor data products to your organization by defining custom properties to extend the default set of properties. You can create custom properties that apply widely to data products or that apply to the items in a data product. The custom properties are listed on the Additional information tab for a data product. The custom properties for items in a data product are listed on the Data product contents tab when you select an item. Custom properties, together with the default properties, help to clearly define your data products.
You can create up to 1000 custom properties.
- Required roles to complete this task
- IAM Platform role: Account owner or Administrator for the Data Product Hub service
- IAM Service role: Manager for the IBM Cloud Pak for Data service
- Data Product Hub collaborator role: Admin
Custom properties provide additional information about data products to further define your data products. Administrators define properties that are relevant to their organization. Producers can edit the values for custom properties when creating a data product. Custom properties are available to all producers in your Data Product Hub community for use in their data products.
Data Product Hub also imports properties defined for assets when adding assets from a catalog into your data product. The properties for an imported asset cannot be edited in Data Product Hub.
To create custom properties:
- Select Configuration and settings>Custom properties>Customize.
- Select the asset type for the custom properties, either Data product, for data product wide properties, or Data product part, for data product item properties.
- Add a new group to organize your custom properties. Custom properties must be added to a group.
- Open the group and select New property.
- Select the basic parameters and advanced settings for each property.
Define the custom property
Use these parameters to define a custom property:
Parameter | Description and restrictions |
---|---|
Name | Names must be unique. The character limit is 255. |
Unique identifier | Generated identifier which can be edited. |
Description | Optional. The character limit is 255. |
Property type | Type cannot be changed after a custom property is created. Choose from: • Text • Integer • Decimal • Date • User and user group • Predefined values |
Types for custom properties
The property type determines the values that can be entered for the property.
Type | Entry options for producers |
---|---|
Text | Text entry |
Integer | Whole numbers |
Decimal | Decimal numbers |
Date | Accepts dates only. Valid date format is mm/dd/yyyy |
User and user group | Select from menu. Generates a list of community members. |
Predefined values | Select from menu. Generates a dropdown menu containing the specified predefined values. |
Select advanced settings
Use the advanced settings to further define the property:
- Make searchable and visible for filtering
- Enable this option so that producers and users can search for properties using the search field and filters. Search by property is available on the Home page, the Search data products page, and My work page.
- Modifying this setting after the custom property is created does not apply the change to existing assets that use the property.
- Allow multiple values
- Enable this option to allow the producer to enter or select multiple values for the same property. If you do not select this option, only one value per property is allowed. This option cannot be edited after the property is saved. For entry fields such as Text and Integer, you can add multiple fields. For menus such as Predefined values and User and user groups, you can select more than one value.
Editing properties
Select Configuration and settings>Custom properties>Customize>Asset type to view a list of custom properties by group. Locate the property that you want to edit and select Edit from the Actions menu .
The following parameters cannot be edited after the property is created:
- Property type
- Allow multiple values
If you change the setting for Make searchable, the property is not automatically updated for existing assets. You must edit the value of the custom property directly on the asset for the change to take effect.
Deleting properties
To delete a property, select Delete from the Actions menu . If you delete a custom property, the property and its values are removed from all assets that include this property. You cannot undo deletion for a custom property.
Learn more
Parent topic: Setting up Data Product Hub