Managing rules

"ruleScope": {
        "virtualFolders": [
            "DQM"
        ],
        "sourcePropertyFilters": { 
            "domain": "Finance, Banking" 
        },
        "fieldTerms": [
            "Built-in_Terms/Last_Name",
            "Built-in_Terms/US_Address"
        ],
        "resourceTerms": [
            "CA/Employee"
        ],
        "termStates": [
            "ACCEPTED",
            "SUGGESTED"
        ]
    }

Parent Topic

• Rule components

Parent Topic

• Rule components

The rule action defines the action to take if the ruleCriteria evaluates to true. A rule action is an array of actions and an action can only apply one term. To apply multiple terms, you must submit a ruleAction for each term.

Actions can be one of the following:

• AddBusinessTerms
• RemoveBusinessTerms
• SetProperties
• ResetProperties

When creating a rule action, include the following parts:

• actionType

  Set to the action taken by the rule.

• actionName

  Enter the name of the action.

• actionAttributes

  In the body, use the following guidelines:

  • The inclusion of the rule_action_field entry indicates field tagging. The field name specified is tagged with the term provided in the rule_action_term_name.
  • The exclusion of the rule_action_field entry implies resource tagging. The resource is tagged with the term provided in the rule_action_term_name.
  • The rule_action_threshold entry is used only with a data rule. It defines the percentage of rows that satisfy the rule before the rule action is applied. In a metadata rule, this entry is mandatory and will result in an error if not present. In metadata rules, the recommended threshold value is 0 or 1.

You can define the rule action by specifying action types in the Rule Actions window. The rule action includes the following types:

• AddBusinessTerm

  When actionType is set to AddBusinessTerm, the ruleAction makes term associations based on rule evaluation. A term suggestion can be applied on a specific field or on a qualifying resource. When applying a term suggestion of a field, the field is identified with a full field name.

  NoteThe Data Catalog rule framework does not create new terms. Any term suggestions to be applied as part of rule action must be for existing terms. If an associated term does not exist, Data Catalog displays an error message.

• RemoveBusinessTerm

  When actionType is set to RemoveBusinessTerm, the ruleAction removes the term associations based on the rule evaluation.

• SetProperties and ResetProperties

  When actionType is set to SetProperties or ResetProperties, the ruleAction sets or resets custom property values.

  Property values are strings. If you specify property names with @@, then the value of its string is substituted for the property name. You can use property actions to set and reset property values. To reset a property value, use ResetProperties.

In the action attributes field, rule_action_property_name is used to mention the custom property name and rule_action_property_value is used to set the value for that property, as in the following example:

"actionAttributes": { 
	"rule_action_property_name": "domain", 
	"rule_action_property_value": "Finance",
	"rule_action_threshold": "1" 
}

The following code sample provides an example of each action type:

[
	{
		"actionType": "AddBusinessTerms",
		"actionName": "",
		"actionAttributes": {
			"rule_action_term_name": "PII/Sensitive",
			"rule_action_threshold": "40",
			"rule_action_field": "SSN"
		}
	},
	{
		"actionType": "AddBusinessTerms",
		"actionName": "",
		"actionAttributes": {
			"rule_action_term_name": "PII/Sensitive",
			"rule_action_threshold": "40"
		}
	},
	{
		"actionType": "AddBusinessTerms",
		"actionName": "",
		"actionAttributes": {
			"rule_action_term_name": "PII/Sensitive",
			"rule_action_threshold": "40",
			"rule_action_stats_field": "SSN"
		}
	},
	{
		"actionType": "RemoveBusinessTerms",
		"actionName": "Remove Field Term",
		"actionAttributes": {
			"rule_action_term_name": "PII/Sensitive",
			"rule_action_threshold": "40",
			"rule_action_field": "SSN"
		}
	},
	{
		"actionType": "RemoveBusinessTerms",
		"actionName": "Remove Resource Term",
		"actionAttributes": {
			"rule_action_term_name": "PII/Sensitive",
			"rule_action_threshold": "40"
		}
	},
	{
		"actionType": "setProperties",
		"actionName": "Update Custom Property value based on threshold",
		"actionAttributes": {
			"rule_action_property_name": "domain",
			"rule_action_property_value": "Finance",
			"rule_action_threshold": "1"
		}
	},
	{
		"actionType": "setProperties",
		"actionName": "Update Custom Property value",
		"actionAttributes": {
			"rule_action_property_name": "domain",
			"rule_action_property_value": "Finance"
		}
	},
	{
		"actionType": "ResetProperties",
		"actionName": "reset proprerty value",
		"actionAttributes": {
			"rule_action_property_name": "domain",
			"rule_action_property_value": ""
		}
	}
]

Parent Topic

• Rule components

Procedure

1. Click Management on the menu bar to open the Manage Your Environment page, and then select Business Rules to open the Business Rules page. Click Add Business Rule.

   The Create Business Rule page opens.

2. Enter the rule name and description.

3. Set the Rule Scope. The rule scope includes the following parameters:

   You can create your own scope and save it for future use by yourself or another user or select one of the existing ones using the Load Scope option.

   • Virtual Folders

     Select virtual folders on which the rule should be executed. You must include at least one virtual folder for the rule to compile. When a single virtual folder is listed, rule execution is run against all the resources in the listed virtual folder. You can select additional virtual folders. If a folder no longer exists when the rule is executed, it is ignored.

   • Resource Terms

     Select business terms to filter the virtual folder resources.

   • Column terms

     Select the business terms associated with the fields or columns to filter the virtual folder resources.

   • Custom Properties

     Select the custom properties to filter the virtual folder resources.

   • Term State

     You can further filter the virtual folder resources based on the term association state. The possible values are ACCEPTED, REJECTED, and SUGGESTED. If you do not specify a term association state, all states are included.

4. Set the Rule Criteria.

   You can create your rule criteriaand save it for future use by yourself or another user or select one of the existing ones using the Load Scope option.

   Define the rule's criteria for evaluation using rule syntax, with MetadataRule or DataRule. See the following examples:

   • MetadataRule

     For dealing with metadata stored in the database. Syntax is:

     • hasResourceTerm(TermFullyQualifiedName) =1

       Work on the resources that have the given resource term associated with them

     • hasFieldTerm(fieldName) =1

       Work on the fields/columns that have the given field term associated with them

   • DataRules

     For dealing with actual data present in the resource. Syntax is to specify the column name directly or use @TermFullyQualifiedName equivalent to the field with the given term name. Use @@customPropertyName to specify the custom property with specific values.

5. Set the Rule Actions. The rule actions include the following action types.

   You can create rule actions and save them for future use by yourself or another user or select one of the existing ones using the Load Scope option.

   Action Type	Description
   Add Business Terms	Business Term Select the term name that you want to add. Action Field Specify the field name if the associated action should be performed on a specific field. The field name specified is tagged with the term provided in the Add Business Terms. If the field name is not specified, then the action will be performed at the resource level. Set Threshold Specify the threshold value at which to perform the rule action.
   Remove Business Terms	Business Term Select the term name that you want to remove. Action Field Specify the field name if the associated action should be performed at the column level. The field name specified is tagged with the term provided in the Remove Business Terms. If the field name is not specified, then the action will be performed at the resource level. Set Threshold Specify the threshold value at which to perform the rule action.
   Set Properties	Select Property Select the property for which you want to set the custom properties. Action Field Specify the field name if the associated action should be performed on a field. Set Threshold Specify the threshold value at which to perform the rule action.
   Reset Properties	Select Property Select the property for which you want to reset the custom properties. Action Field Specify the field name if the associated action should be performed on a field. Set Threshold Specify the threshold value at which to perform the rule action.
   Set Quality Dimension	Set Quality Dimension Select the data quality dimension that defines your rule. This dimension is reflected in the data quality graph on the Data Canvas page. Options include: None This rule is not used as a data quality metric. Accuracy The degree to which data correctly describes the "real world" object or event being described. Completeness The proportion of stored data against the business definition of “100% complete”. Consistency The absence of difference when comparing two or more representations of an item against a definition. Each data item is measured against itself or its counterpart in another data set. Note that consistency assessment may not be applicable to all data items. Uniqueness The inverse of an assessment of the level of duplication. Validity Data is valid if it conforms to the syntax (format, type, range) of its business definition. Typically, this value is the overall measure of data quality. Timeliness The degree to which data represent reality from the required point in time. This is measured by the time distance between each correct and incorrect data point. Action Field Specify the field name if the associated action should be performed at the column level. The field name specified is tagged with the term provided in the Set Quality Dimension. If the field name is not specified, then the action will be performed at the resource level Set Low Threshold Specify the threshold value at which to perform the rule action. Default is 50. Set High Threshold Specify the threshold value at which to perform the rule action. Default is 90. You can view the following data quality values in a donut chart for the column. <low = red >low<high = orange >high = green

6. Click Create Rule.

Next steps

Parent Topic

• Rule workflow

Procedure

1. Click Management on the menu bar to open the Manage Your Environment page, and then select Business Rules to open the Business Rules page.

   The Business Rules page opens.

2. Locate the business rule you want to configure in the table of rules and select the View Details button (greater-than sign) in its row.

   If you have a large number of rules, select Show Filters to help you find the rule you want to edit.The Business Rule page opens for the selected rule.

3. Edit the fields as needed and click Save Rules.

   The rule is saved with your changes. If there is a problem while creating your rule, an error notification displays at the top of the page. Resolve the error and click Save Rules.

Parent Topic

• Rule workflow

Procedure

1. Click Management on the menu bar to open the Manage Your Environment page, and then select Business Rules.

   The Business Rules page opens.

2. Use the check box to select the rule you want to delete.

3. Click the Actions menu and then click Remove. Optionally, select the More actions icon, then click Remove from the drop-down menu.

   A message appears confirming your business rule is now deleted.

4. Click Close on the message box to return to the Business Rules page.

Parent Topic

• Rule workflow

Procedure

1. Go to Management and click Business Rules.

   The list of all rules in Data Catalog is shown.

2. To view the rules associated with the specific resource. Navigate to Explore Your Data > Virtual folders > Specific file.

3. Click Rules tab.

   Rules specific to that file are shown.

Parent Topic

• Rule workflow

Procedure

1. Go to Management and click Business Rules.

2. Click the Blocks tab.

3. Click Add New Block, and select the scope, criteria, or actions for which you want to create a block.

   NoteIf you make any changes to the block, the rules that are using these blocks are impacted.

Parent Topic

• Rule workflow

-generateReport true -reportName <Name of the report being generated>

Parent Topic

• Execute rules