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

Rules

If you have a Data Quality Administrator role, you can use the Data Storage Optimizer rules engine to simplify data management by setting up rules and rule definitions to enable automation tasks such as data tiering and deletion. The rules engine can automatically handle processes like tiering data from one source to another or purging. By automating these processes, you can save time and effort while minimizing the potential for errors, making data management more efficient. See Manage users.

The rules framework in Data Storage Optimizer enables you to define, execute, and manage rules. The workflow within the rules framework should occur in the following order:

  1. Create a rule definition. You create a rule definition by setting the criteria and the action. The rule criteria define the rule that is translated and evaluated into a query for execution against every qualifying resource.
  2. Create a rule. A rule action can perform an array of tasks.

NoteTo perform rules-governed tiering or purging of files, actions in Data Catalog may also be required. See Workflows.

Creating a rule definition to tier files

You must have a Data Quality Administrator role to perform this task.

Perform the following steps to create a rule definition to tier files:

Procedure

  1. On the Menu, click Management.

    The Manage Your Environment page opens.
  2. On the Rules card, click Add New, and then select Add Rule Definition from the menu.

    The Rule Definition page opens.

    Rule definition page

  3. Enter a name and description for your rule definition.

  4. In the Rule Criteria section, click File to set the object type.

  5. Click Create a Condition to define your rule's conditions.

    1. In Attribute, select Business Terms.

    2. In Operator, select the operator that you want to use. For example, Contains.

      NoteAvailable operators will depend on the selected attribute.
    3. In Value, select the value you want to use. For example, Cold.

      NoteValue will vary based on the chosen operator.
    4. In the Rule Actions section, click Add Action and select Start Process.

    5. In Select Process, click Move and then in Destination Data Asset, select your data target for tiering.

  6. Click Save.

    The rule definition is saved, and file tiering begins.

Results

To monitor the tiering progress, on the Menu, click Management. On the Manage Your Environment page, click Completed on the Data Operations card. On the Data Operations page, locate the files to view the status.

In the data source, stub files are created to rehydrate the tiered files, as needed. See Rehydration.

Creating a rule definition to purge files

You must have a Data Quality Administrator role to perform this task.

CautionWhen you purge files, they are permanently removed from the data source.

Perform the following steps to create a rule definition to purge files:

Procedure

  1. On the Menu, click Management.

    The Manage Your Environment page opens.
  2. On the Rules card, click Add New, and then select Add Rule Definition from the menu.

    The Rule Definition page opens.

    Rule definition page

  3. Enter a name and description for your rule definition.

  4. In the Rule Criteria section, click File to set the object type.

  5. Click Create a Condition to define your rule's conditions.

    1. In Attribute, select Business Terms.

    2. In Operator, select the operator that you want to use. For example, Contains.

      NoteAvailable operators will depend on the selected attribute.
    3. In Value, select the value you want to use. For example, Frozen.

      NoteValue will vary based on the chosen operator.
    4. In the Rule Actions section, click Add Action and select Start Process.

    5. In Select Process, click Delete.

  6. Click Save.

    The rule definition is saved, and file purging begins.

Results

To monitor the purging progress, on the Menu, click Management. On the Manage Your Environment page, click Completed on the Data Operations card. On the Data Operations page, locate the files to view the status.

Creating a rule

You must have a Data Quality Administrator role to perform this task.

Perform the following steps to create a new rule:

Procedure

  1. On the Menu, click Management.

    The Manage Your Environment page opens.
  2. On the Rules card, click Add New, and then select Add Rule from the menu.

    The Add Rule page opens.

    Add Rule page

  3. Enter the Rule Name and select the 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.

  5. To execute the rule, select Run rule definition now. Alternatively, if you want to schedule the rule to run, see step 6.

  6. Select Add Schedule to set the schedule to Daily or On a date.

  7. Click Apply.

    The rule is created and applied.

Results

To monitor the progress of the rule, on the Menu, click Management. On the Manage Your Environment page, click Definitions on the Rules card. On the Manage Rule Definitions page, locate the rule and select View. On the Rule Definition page, click the History tab to view the status.