Enrich Metadata Using Custom Properties

At times, the default properties that are created during the harvest of a data source are not sufficient to capture all the context for a data catalog object. Adding details such as business description, update frequency, certification status, or data owners can provide more business context to the technical metadata and benefit the data users. Similarly, business metadata can help data consumers in understanding, discovery, classification, and collaboration. For example, a data analyst cannot get any information except technical metadata while looking at the Revenue table of a Car Accessories division if the data entity is without any custom properties.

The Custom Properties feature of the OCI Data Catalog allows you to capture and customize technical and business metadata to enrich a specific object. For example, for a table, you can define its data owner, validity, and frequency of update. Custom properties are flexible, configurable, and easy to use.

In this tutorial, you:
  • Create the following custom properties and associate them to object types:
    • Data Owners
    • Business Description
    • Data Sensitivity
    • Certified
    • Archival Date
  • Populate values for the properties for different objects.
  • Search, filter, and explore data using custom properties.
  • Edit a custom property configuration.
  • Delete a custom property.

Before You Begin

To perform this tutorial, you must have the following requirements:

1. Create Access Policies

You require the CATALOG_NAMESPACE_UPDATE permission to create custom properties.

Add Compartment Policy

If your username is in the Administrators group, then skip this section. Otherwise, have your administrator add the following policy to your tenancy:

allow group <the-group-your-username-belongs> to manage compartments in tenancy

With this privilege, you can create a compartment for all the resources in your tutorial.

Steps to Add the Policy
  1. In the Console's top navigation bar, open the Profile menu (your avatar).
  2. Click your username.
  3. In the left pane, click Groups.
  4. In a notepad, copy the Group Name that your username belongs.
  5. In the top navigation bar, open the navigation menu that lists the services.
  6. Open the navigation menu and click Identity & Security. Under Identity, click Policies.
  7. Click Create Policy.
  8. Fill in the following information:
    • Name: manage-compartments
    • Description: Allow the group <the-group-your-username-belongs> to list, create, update, delete and recover compartments in the tenancy.
    • Compartment: <your-tenancy>(root)
  9. For Policy Builder, click Customize (Advanced).
  10. Paste in the following policy:
    allow group <the-group-your-username-belongs> to manage compartments in tenancy
  11. Click Create.
Create a Compartment

Create a compartment for the resources that you create in this tutorial.

  1. Open the navigation menu and click Identity & Security. Under Identity, click Compartments.
  2. Click Create Compartment.
  3. Fill in the following information:
    • Name: <your-compartment-name>
    • Description: Compartment for <your-description>.
    • Parent Compartment: <your-tenancy>(root)
  4. Click Create Compartment.
Create a Policy

2. Create Custom Properties

Learn how to create various custom properties.

Data Owners
  1. Go to the Home tab of the data catalog for which you want to create the data owners custom property.
  2. Click Custom Properties. Alternatively, from the Quick Links section of the Home tab, click Manage Custom Properties.
  3. On the Custom Properties page that appears, click Create Custom Property.
  4. In the Create Custom Property panel, enter the following details:
    • Name - Enter Data Owners.
      Note

      You cannot use the following special characters in the name:

      & < > " ' / \ = ;

    • Description - Add a description.
    • Datatype - Select String (Plain Text), as the values for data owners (such as email addresses) are simple string texts.
    • Value options - Use this field to configure how values must be entered for the custom property. As there can be multiple data owners of a table, select Allow multiple values.
    • Data catalog object types - Use this field to select the object types with which you want to associate data owners. For example, select Data Entity, Folder.
    • Search results options - Use this field to configure the behavior of the custom property in search results. For the data owners custom property, select:
      • Show in search results: To view data owners right away in the search summary table
      • Allow filtering: To filter the search results based on the names of the data owners
      Note

      • You can configure up to seven custom properties for the Show in search results option.
      • You can configure up to seven custom properties for the Allow sorting option.
      • You can configure up to 20 custom properties for the Allow filtering option.
    • View and edit options - If you want to configure the data owners custom property to appear in the Attributes table of a data entity, select the Allow view and edit check box.
  5. Click Create.
Business Description
  1. Go to the Home tab of the data catalog for which you want to create the business description custom property.
  2. Click Custom Properties. Alternatively, from the Quick Links section of the Home tab, click Manage Custom Properties.
  3. On the Custom Properties page that appears, click Create Custom Property.
  4. In the Create Custom Property panel, enter the following details:
    • Name - Enter Business Description.
      Note

      You cannot use the following special characters in the name:

      & < > " ' / \ = ;

    • Description - Add a description.
    • Datatype - Select String (Rich Text), as the value for business description can have descriptive information.
    • Data catalog object types - Use this field to select the object types with which you want to associate business description. For example, select Data Assets, Attributes.
    • Search results options - Use this field to configure the behavior of the custom property in search results.
      Note

      • You can configure up to seven custom properties for the Show in search results option.
      • You can configure up to seven custom properties for the Allow sorting option.
      • You can configure up to 20 custom properties for the Allow filtering option.
  5. Click Create.
Data Sensitivity

  1. Go to the Home tab of the data catalog for which you want to create the data sensitivity custom property.
  2. Click Custom Properties. Alternatively, from the Quick Links section of the Home tab, click Manage Custom Properties.
  3. On the Custom Properties page that appears, click Create Custom Property.
  4. In the Create Custom Property panel, enter the following details:
    • Name - Enter Data Sensitivity.
      Note

      You cannot use the following special characters in the name:

      & < > " ' / \ = ;

    • Description - Add a description.
    • Datatype - Select Number, as the values for data sensitivity (such as 1, 5, 9) are numbers.
    • Value options - Use this field to configure how values must be entered for the custom property. To allow only a fixed set of values for data sensitivity, select Use list of values. When you select this option, List of values appears and you can enter one or more values for the custom property. You can enter more values for the custom property later; however, you cannot delete the values that are already specified.
    • Data catalog object types - Use this field to select the object types with which you want to associate data sensitivity. For example, select Glossary, Term, Category.
    • Search results options - Use this field to configure the behavior of the custom property in search results.
      Note

      • You can configure up to seven custom properties for the Show in search results option.
      • You can configure up to seven custom properties for the Allow sorting option.
      • You can configure up to 20 custom properties for the Allow filtering option.
    • View and edit options - If you want to configure the data sensitivity custom property to appear in the Attributes table of a data entity, select the Allow view and edit check box.
  5. Click Create.
Certified
  1. Go to the Home tab of the data catalog for which you want to create the certified custom property.
  2. Click Custom Properties. Alternatively, from the Quick Links section of the Home tab, click Manage Custom Properties.
  3. On the Custom Properties page that appears, click Create Custom Property.
  4. In the Create Custom Property panel, enter the following details:
    • Name - Enter Certified.
      Note

      You cannot use the following special characters in the name:

      & < > " ' / \ = ;

    • Description - Add a description.
    • Datatype - Select Boolean.
    • Data catalog object types - Use this field to select the object types with which you want to associate the certified custom property. For example, select Data Entity.
    • Search results options - Use this field to configure the behavior of the custom property in search results.
      Note

      • You can configure up to seven custom properties for the Show in search results option.
      • You can configure up to seven custom properties for the Allow sorting option.
      • You can configure up to 20 custom properties for the Allow filtering option.
    • View and edit options - If you want to configure the certified custom property to appear in the Attributes table of a data entity, Select the Allow view and edit check box.
  5. Click Create.
Archival Date
  1. Go to the Home tab of the data catalog for which you want to create the archival date custom property.
  2. Click Custom Properties. Alternatively, from the Quick Links section of the Home tab, click Manage Custom Properties.
  3. On the Custom Properties page that appears, click Create Custom Property.
  4. In the Create Custom Property panel, enter the following details:
    • Name - Enter Archival Date.
      Note

      You cannot use the following special characters in the name:

      & < > " ' / \ = ;

    • Description - Add a description.
    • Datatype - Select Date.
    • Data catalog object types - Use this field to select the object types with which you want to associate business description. For example, select Data Entity.
    • Search results options - Use this field to configure the behavior of the custom property in search results. For example, you can select Allow sorting so that you can sort the search results based on dates.
      Note

      • You can configure up to seven custom properties for the Show in search results option.
      • You can configure up to seven custom properties for the Allow sorting option.
      • You can configure up to 20 custom properties for the Allow filtering option.
    • View and edit options - If you want to configure the archival date custom property to appear in the Attributes table of a data entity, select the Allow view and edit check box.
  5. Click Create.

3. Set Values for Custom Properties

From the object detail tabs of the data catalog object type with which you have associated a custom property, you can set, view, and modify the values for the property. Learn how to set the values for the custom properties that you created in the previous topic.

Data Entity Custom Properties

While creating custom properties, you associated Data Owners, Certified, and Archival Date with data entity. To set values for the properties, follow these steps:

  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. In the Custom Properties section, you can see that the Data Owners, Certified, and Archival Date custom properties are listed.
  3. In the Custom Properties section, click the Edit link.
  4. In the Edit Custom Properties panel that opens as an overlay, do the following:
    • In the Data Owners field, add one or more values.
    • In the Certified field, select True or False, based on whether the data entity is certified.
    • In the Archival Date field, select the date on which the data needs to be archived.
  5. Click Save Changes.
Data Asset Custom Properties

While creating custom properties, you associated Business Description with data assets. To set values for the property, follow these steps:

  1. Access the Data Assets tab by clicking Data Assets on the Home tab.
  2. In the Data Assets list, click the data asset you want to edit. The data asset details tab opens. In the Custom Properties section, you can see that the Business Description custom property is listed.
  3. In the Custom Properties section, click the Edit link.
  4. In the Edit Custom Properties panel that opens as an overlay, do the following:
    • In the Business Description field, enter information about the data.
  5. Click Save Changes.
Attribute Custom Properties

While creating custom properties, you associated Business Description with attributes. To set values for the property, follow these steps:

  1. Click + from tabs and select Attributes.
  2. In the Attributes list, select the attribute you want to edit. The attribute details tab opens. In the Custom Properties section, you can see that the Business Description custom property is listed.
  3. In the Custom Properties section, click the Edit link.
  4. In the Edit Custom Properties panel that opens as an overlay, do the following:
    • In the Business Description field, enter information about the data.
  5. Click Save Changes.
Glossary, Category, or Term Custom Properties

While creating custom properties, you associated Data Sensitivity with glossary, category, and Term. To set values for the property, follow these steps:

  1. Access the glossary details tab.
  2. In the Hierarchy pane, select the glossary, category, or term that you want to edit.
  3. Click Edit from Custom Properties. The Edit Custom Properties panel opens as an overlay. In the Custom Properties section, you can see that the Data Sensitivity custom property is listed.
  4. In the Edit Custom Properties panel that opens as an overlay, do the following:
    • In the Data Sensitivity field, select the value describe the sensitivity of the data. The list of values appears based on the values that you configured while creating the property.
  5. Click Save Changes.

4. Search and Filter Using Custom Properties

Customize your search results to use the custom properties you create in data catalog. The following procedure describes how you can customize your search results to use the Data owners custom property.

  1. From Home, click Data Entities.
  2. In the Data Entities list, view the Data owners custom property for all the data entities in the search summary.
  3. The Data owners custom property also shows up under Custom Filters. Select a data owner. The Data Entities list is updated to show only the results that match the selected data owner.
  4. From the sort list, select either ascending or descending for Data owners. The Data Entities list is updated to show the results in the selected order by data owner.

5. Edit a Custom Property Configuration

  1. On the Custom Properties page, from the list of custom properties, click the Actions icon (three dots) of the custom property that you want to edit, and then click Edit. Alternatively, select the custom property and on the Custom Properties: <property name> page, click Edit.
  2. Modify the custom property according to your requirement.
    Note

    • You cannot change the datatype for the custom property.
    • You cannot clear an already selected Allow multiple values if it was selected previously.
    • You can only add more values for the custom property. You cannot delete existing values.
    • You can associate more data catalog objects with the custom property or disassociate an existing data catalog object. You can disassociate a custom property only if the usage of the custom property in any object of that type is zero. When you disassociate an object, a delete job is created.
    • If any data catalog object types are already associated with the custom property, any changes you make impacts the associated types.
  3. Click Save Changes.

6. Delete a Custom Property

  1. On the Custom Properties page, from the list of custom properties, click the Actions icon (three dots) of the custom property that you want to delete, and then click Delete. Alternatively, select the custom property and on the Custom Properties: <property name> page, click Delete.
  2. In the Delete Custom Property confirmation box that appears, type Delete to confirm the deletion. When you delete a custom property, any association of the custom property to data catalog objects are removed.
  3. Click Delete.

What's Next?

You can now create other custom properties and set values for them.