Skip to main content

Pentaho+ documentation has moved!

The new product documentation portal is here. Check it out now at docs.hitachivantara.com. 

 
Version LDC
Hitachi Vantara Lumada and Pentaho Documentation

Manage custom properties

  1. Last updated
  2. Save as PDF

Parent article

In Lumada 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. You can group these properties together in custom property groups based on their business value or category and move the properties individually or in bulk across custom property groups. You can use these custom property groups as custom facets in the search results with search dimensions. Note that custom properties apply to only data resources.

To add custom data resource properties, navigate to Management and then click View Properties.

While the Properties page lists a variety of properties, users can only manage custom properties in Data Catalog.

Parent Topic
Child Topics

Add a custom property

In Lumada Data Catalog, you can create custom properties that collect metadata about business environment resources. For example, you can define a custom property to include a business username for a data resource, or you could define a property that includes values used by system-level processes. Custom properties apply only to data resources.

  1. On the Data Catalog navigation menu, click Management, and then click View Properties.

  2. Click +Add New.

  3. Enter the following information:

    • Display Name: A name for the custom property that users see in the resource view. A display name must begin with an alphabetic character and can include the following:
      • Alphanumeric characters
      • Special characters
      • Hyphens
      • Underscores
    • Property Name: Required field name that uniquely identifies the property to store internally. A property name can include the following:
      • Alphanumeric characters
      • Hyphens
      • Underscores
    • Description: A brief description of how the property is used and what values it can hold. This field is not included in metadata processing.
    • Value Type: Allowed value types are:
      • Predefined - a value type defined in the Data Catalog library.
      • User Entered - Default value. A type defined by the user.
    • Data Type: Allowed data types are:
      • Numeric
      • String (Default value)
      • Date
    • Available Values: This field appears if the value for Value Type is Predefined. Define the comma- separated values based on the data type selection. These values can be chosen when a property is added to a resource.
    • Default Value: A pre-existing value to display when no specific value is explicitly defined for the property.
    • Value Required check box: If this check box is selected, you must enter a value in the Default Value field.
    • Allow Blank: Select the check box to allow the property without any value.
    • Scope: Define the resources for property execution.
      NoteThe Scope field is pre-populated as Resources and disabled. You cannot modify the field.
    • Add to Group: Select one of the existing groups from the list to assign the property to a group.
    • Searchable: Select the check box to make the custom property searchable.

      The resources that have a defined value for this property appear in the search results for this property value. For example, if resource R has the defined value "Red" for the searchable custom property "Color", a search for "Red" lists resource R in the search results. If "Color" is not marked as searchable, the resource R does not appear in the search results for "Red."

    • Facetable: Select the check box to make the custom property facetable.

      If you choose to make this property a facet, then based on the search dimension settings for a user, it shows as a facet in the search results to narrow the results list for this property.

      NoteIf a property is marked as Facetable but not Searchable, the facetable definition takes precedence and the property appears in the facets of the search results. You can change the searchable and facetable values during the entire life cycle of the custom property.
    • Write Roles: Select the user access level allowed to write the custom property.
    • Read Roles: Select the user access level allowed to read the custom property.

  4. Click Create Property.

    A custom property is created.
Parent Topic

Edit a custom property

You can edit a custom property.

Procedure

  1. On the Data Catalog main menu, click Management, and then click View Properties.

  2. Click the arrow at the end of the row you want to edit.

    The Custom Property Details page opens.

  3. Edit the information and click Save Property.

Parent Topic

Remove a custom property
You can remove a custom property.
You must manually disassocaite the roles to remove the custom properties or groups are assigned to roles. It is a best practice to avoid removing more than one custom property at a time.

If you remove a custom property group, the properties within the group are removed from the group and have None as the group association.

Procedure

  1. On the Data Catalog main menu, click Management, and then click View Properties.

    A list of the properties is displayed.

  2. To remove a property, select the check box next to the property you want to delete and click Remove at the bottom of the page.

  3. Type YES to confirm the deletion and click Confirm.

    The custom property is removed.
Parent Topic

Add a custom property group

You can group the custom properties in a custom property group based on their business value or category and move custom properties individually or in bulk across custom property groups. You can use these custom property groups as custom facets in the search results with search dimensions.

However, you cannot create a custom property group within another custom property group.

Procedure

  1. On the Data Catalog main menu, click Management, and then click View Properties.

  2. Click Property Groups and click +Add New.

  3. (Optional) In the Group Display Name field, enter a name to be displayed for the property group.

  4. Enter a name for the property group in Group Name.

    A name must start with an alphanumeric character, and can include the following:
    • Alphanumeric characters
    • Digits 0 to 9
    • Hyphen (-) and underscore (_)
    NoteData Catalog does not support spaces or special characters in the Group Name field. Also, ensure that the name strings do not match any Data Catalog reserved names. For more information, see Data Catalog reserved names.

  5. Provide a description for the property in the Description box.

  6. Click + Add Property and select the properties to assign to this property group. Click Assign <count>.

  7. Click Create Property Group.

    The custom property group is created.
Parent Topic

Edit a custom property group

You can edit an existing custom property group.

Procedure

  1. On the Data Catalog main menu, click Management, and then click View Properties.

  2. Click the Property Groups tab.

  3. Click the arrow at the end of the row you want to edit.

    The Property Group Details page opens.

  4. Edit the Group Name, Description fields and add or remove properties from the group as needed, and then click Save Property Group.

Parent Topic