Skip to main content

Pentaho+ documentation has moved!

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

 

Hitachi Vantara Lumada and Pentaho Documentation

Manage metadata rules

If Pentaho Data Catalog has Pentaho Data Storage Optimizer integrated and you have the Data Quality Administrator role, you can see an additional tile Metadata Rules in Management. Leveraging the Data Storage Optimizer metadata rule engine capabilities, you can easily manage the data by creating metadata rules. These metadata rules enable you to tag, assign business terms, and add properties to the database resources. By doing so, you can streamline the process of searching for data and make it more efficient.

Create a metadata rule definition

You can create a metadata rule definition by setting the rule criteria and the action. The rule criteria define the conditions that are translated and evaluated into a query for execution against every qualifying resource. A rule action is what the rule does, and it can involve various tasks.

Perform the following steps to create a metadata rule definition:

Procedure

  1. In the left navigation menu, click Management.

    The Manage Your Environment page opens.
  2. In the Metadata Rules tile, click Add New and then select Add Rule Definition.

    The Add Rule Definition page opens.
  3. In the Name box, enter a name.

  4. In the Description box, enter a description for the rule definition.

  5. To set the Rule Criteria, select the object type from the list, which includes File, Column, Table, and Folder.

  6. Click Create a Condition or Create a Condition Group to define the rule's conditions.

  7. In the Attribute list, select an attribute.

    NoteThe list of available attributes changes based on the object type you selected.
    ObjectAttributeDescription
    FileNameThe name of the file.
    File TypeThe format or category of the file that indicates its nature.
    Last Scanned DateThe most recent date when the file was scanned.
    Creation DateThe date when the file was created.
    Last Modified DateThe most recent date when the file content was changed.
    Last Access DateThe latest date the file was opened or accessed.
    ColumnNameThe name of the column.
    Data TypeThe type of data that the column can store, such as text, number, or date.
    TableThe table to which the column belongs.
    Last Profile DateThe most recent date when the column was profiled or analyzed.
    TableNameThe name of the table.
    Schema NameThe name of the schema to which the table belongs.
    Database NameThe name of the database where the table is stored.
    Last Profile DateThe most recent date when the table was profiled or analyzed.
    FolderNameThe name of the folder.
    Last Scanned DateThe most recent date when the folder was scanned.
    Creation DateThe date when the folder was created.
    Last Modified DateThe most recent date when the content of the folder was changed.
    Last Access DateThe latest date the folder was opened or accessed.
  8. In the Operator box, select an operator and specify the corresponding value. The query is generated based on the selections.

    NoteThe available operators depend on the selected attribute, and the value type varies based on the selected operator.

    For example, to manage and access documents efficiently, to keep track of the most recent and relevant information. You can assign a business term for the data that is recently modified or accessed. To achieve this, select File as an Object and set the Attribute as the Last Modified Date and Last Access Date.Create metada rule definition block

    The query is generated based on the selections.Create metadata rule definition query

  9. In the Rule Actions box, set an action type from the following list.

    Action TypeDescription
    Apply Business TermsSelect the term name that you want to add and select the object. This action applies to the Current Object or Parent Object.
    Add Property

    Select the property that you want to add and select the object.

    This action applies to the Current Object or Parent Object.

    Remove Property

    Select the property that you want to add, and then select the object.

    This action applies to the Current Object or Parent Object.

    Apply TagsEnter the tag that you want to apply and then click Enter.
    Remove TagsEnter the tag that you want to remove, and then click Enter.
    Remove Business Terms

    Select the term name that you want to remove, and then select the object.

    This action applies to the Current Object or the Parent Object.

    For example, based on the conditions, set the action Apply Business Term as Latest Updates. If the two conditions mentioned above are met, then the Latest Updates business term will be assigned to all the related metadata that fulfills these criteria.

  10. Click Save.

Results

You have successfully created a metadata rule definition.

Update a metadata rule definition

Perform the following steps to create a new rule:
NoteYou cannot edit the metadata rule definition if it is mapped to an existing rule.

Procedure

  1. In the left navigation menu, click Management.

    The Manage Your Environment page opens.
  2. In the Metadata Rules tile, click Definitions.

  3. Locate the rule definition you want to edit in the rule definition table, click the More actions (three dots) icon, and then click Edit.

  4. Edit the required fields and then click Save.

Results

You have successfully updated the metadata rule definition.

Delete a metadata rule definition

To delete a metadata rule definition that is currently in use, you must first disconnect it from any linked metadata rules.
NoteYou cannot delete the metadata rule definition if it is mapped to an existing metadata rule.

Perform the following step to delete the metadata rule definition:

Procedure

  1. In the left navigation menu, click Management.

    The Manage Your Environment page opens.
  2. In the Metadata Rules tile, click Definitions.

    The Manage Rule Definitions page opens.
  3. Locate the metadata rule definition you want to delete in the metadata rule definition list, click the More actions (three dots) icon, and then click Delete.

Results

You have successfully deleted the metadata rule definition.

Create a metadata rule

Perform the following steps to create a new rule:

Procedure

  1. 1. In the left navigation menu, click Management.

    The Manage Your Environment page opens.
  2. In the Metadata Rules tile, click Add New, and then select Add Rule.

    The Add Rule page opens.
  3. Enter a name in Rule Name and select a data source in Source Data Asset.

  4. In Select rule definition, select the rule definition if you have already created it or click Create Rule Definition to create a rule definition.

    For more information, see Create a metadata rule definition.
  5. Select the Run rule definition now checkbox to run the rule. Alternatively, you can also schedule to run the rule daily or on a specific day.

  6. Click Add Schedule and select Daily or On a date to set the schedule as required.

Results

You have successfully created a metadata rule. To monitor the progress of the run, go to Rules > Definitions > History tab.

Update a metadata rule

Perform the following steps to edit an existing metadata rule:
NoteIf the rule definition is not mapped to a rule, then you can edit all the fields.

Procedure

  1. In the left navigation menu, click Management.

    The Manage Your Environment page opens.
  2. In the Metadata Rules tile, click Rules.

    The Metadata Rules page opens.
  3. Locate the metadata rule you want to edit in the metadata rules list, click the More actions (three dots) icon, and then select Edit.

    The Rule page opens.
  4. Edit the required fields and click Apply.

Results

You have successfully updated the metadata rule.

Delete a rule

If a rule is no longer needed, you can delete it. Perform the following steps to delete a rule:

Procedure

  1. In the left navigation menu, click Management.

    The Manage Your Environment page opens.
  2. In the Metadata Rules tile, click Rules.

    The Metadata Rules page opens.
  3. Locate the metadata rule you want to delete in the metadata rules list, click the More actions (three dots) icon, and then select Delete.

Results

You have successfully deleted the metadata rule.