Using Custom Properties

You use custom properties to define metadata to capture business context for data catalog object.

When you harvest a data source using Data Catalog, some default properties are created in your data catalog for data entities and attributes. For example, description, data entity type, updated by, and last updated. Similar default properties are also available for data catalog objects like glossaries, categories, and terms.

The default properties may not be sufficient to capture all the context for a data catalog object. More details such as business description, update frequency, certification status, or data owners, can provide more business context to the technical metadata. Business metadata help data consumers in understanding, discovery, classification, and collaboration.

Typical tasks you perform using custom properties include:

Creating Custom Properties

Important

You must have the CATALOG_NAMESPACE_UPDATE permission to create custom properties.

Here's how you create a custom property:

  1. On your data catalog instance Home tab, click Custom Properties to access the Custom Properties tab.
  2. Click Create Custom Property.
  3. In the Create Custom Property panel, enter the Name for your custom property.
  4. (Optional) Enter the Description for the custom property. This description shows up as the tooltip for the custom property in the associated object details tabs.
  5. Select a Datatype for the custom property. You can choose from the following options:
    • String (Plain Text): The value for the custom property is only a simple string text. For example, Source system.
    • String (Rich Text): The value for the custom property can be a rich string text or simple string text. For example, Business description.
    • Number: The value for the custom property is only a number. For example, Confidentiality level.
    • Boolean: The value for the custom property is only True or False, or Yes or No. For example, Certified.
    • Date: The value for the custom property is only a date. For example, Archival date.
  6. In Value options, configure how values should be entered for the custom property. Value options are available only for the String (Plain Text) and Number datatypes. You can specify the following two options:
    • Use list of values: Select this option if you want to predefine only specific values to be available to users for populating the custom property values. For example, Update frequency custom property could have values Hourly, Daily, and Weekly. When you select this option, List of values displays and you can enter one or more values for the custom property. You can enter more values for the custom property later, but you can't delete the values already specified for the custom property.
    • Allow multiple values: Select this option if you want to permit multiple values for the custom property. For example, Data owners custom property can have multiple values.
  7. Select one or more Data catalog object types that you want to associate with the custom property. For example, Business description custom property can be associated to All Data Entities and to Attributes. Update Frequency custom property can be applied to All Data Entities. Database Administrators can be associated only to data assets of type Oracle Database. You can add more data catalog object types later, but you can't delete the types already specified for the custom property.
  8. In Search result options, configure how you want the custom property to behave in search results. You can select the following options:
    • Show in search results: Select this option if you want the custom property to be displayed in the search results list. You can select this option for up to four custom properties. Only one of these four custom properties can be of the String (Rich Text) datatype.
      Note

      All custom properties are searchable. But when you select this option, the custom property and its value show up in the search result summary. We recommend you select this option for important custom properties that need to be seen right away in search results. For example, Business description or Data owner.
    • Allow filtering: Select this option if you want the custom property to be displayed in the search results as Custom Filters. Typically, this option is selected for custom properties with the List of values option selected as well. For example, Update frequency or Department. You can select this option for up to five custom properties.
    • Allow sorting: Select this option if you want the search results to be sortable using the custom property. For example, Archival date or Confidentiality level. You can select this option for up to three custom properties.
  9. Click Create.

Viewing Custom Properties

Here's how you can view custom property details:
  1. On your data catalog instance Home tab, click Custom Properties to access the Custom Properties tab. You can also click + from tabs and select Custom Properties.
  2. All custom properties created in your data catalog are listed in the Custom Properties tab. Use the available filters to refine the list to display custom properties of selected datatypes or associated to selected data catalog object types.
  3. Click a custom property name. Alternatively, click the Actions icon (three dots) for the custom property and select View Details. The custom property details tab displays the custom property information. For example: such as description, datatype, updated by, last updated, value options, values, search results options, associated types, and usage count. From the custom property details tab you can also view information about the associated data catalog objects that are using the custom property.
From the Custom Properties tab, you can also create, edit, or delete a custom property.

Viewing and Setting Custom Property Values

After you associate a custom property with different data catalog object types, the custom properties are displayed in the details tab of those data catalog objects.

For example, custom properties associated with data assets are listed in the data asset details tab. Custom properties associated with glossaries are listed in the glossary details tab.

You can view and modify the values for custom properties from the object detail tabs of the associated data catalog object types.

Here’s how you edit the custom properties for a data entity:

  1. Access the Data Entities tab by clicking Data Entities on the Home tab.
  2. In the Data Entity list, select the data entity you want to edit. The data entity details tab opens.
  3. Click the Edit link from the Custom Properties section. The Edit Custom Properties panel opens as an overlay.
  4. Make the required edits to the data entity custom properties.
  5. Click Save Changes.
A notification displays indicating that the changes were saved successfully and the Edit Custom Properties panel closes.

Similarly, you can view and edit custom properties for other data catalog object types.

Editing a Custom Property Configuration

Here's how you edit a custom property:
  1. On your data catalog instance Home tab, click Custom Properties to access the Custom Properties tab.
  2. In the Custom Properties list, click the Actions icon (three dots) for the custom property you want to edit and select Edit. The Edit Custom Property panel opens. You can also edit a custom property by using the Edit button on the custom property's details page.
  3. Make the required edits to the custom property.
    Important

    • You cannot change the datatype for the custom property.
    • You cannot deselect Allow multiple values if it was selected previously.
    • You can only add additional values for the custom property, or associate additional data catalog objects with the custom property. You cannot delete existing values or remove associated types.
    • If any data catalog object types are already associated with the custom property, any changes you make impacts the associated types.
  4. Click Save Changes.
Your custom property is successfully updated.

Deleting a Custom Property

When you delete a custom property that is associated with one or more data catalog objects, the custom property is no longer displayed in the data catalog object details.

Here's how you delete a custom property:
  1. On your data catalog instance Home tab, click Custom Properties to access the Custom Properties tab.
  2. In the Custom Properties list, click the Actions icon (three dots) for the custom property you want to delete and select Delete. The Delete Custom Property dialog opens. You can also delete a custom property by using the Delete button on the custom property's details page.
  3. Type Delete to confirm delete. When you delete a custom property, any association of the custom property to data catalog objects are removed.
  4. Click Delete.
The custom property is successfully deleted.