Chat now with support
Chat with Support

Classification Module 6.1.3 - User Guide

Introduction Deploying Classification in Identity Manager Configuring Classification: Taxonomies, Categories, and Rules
An Overview of Classification Configuration Steps Required to Implement Classification Creating Taxonomies Implementing Rules for Automated Categorization Classifying Resources When Do Categorization and Classification Occur? Managing the Life Cycle of Taxonomies and Categories
Working with Categorized Resources Appendix A: PowerShell Commands Appendix B: Oracle Configuration Appendix C: Classifying Data with Data Governance Templates Appendix D: Creating a Taxonomy to Classify Data

Elements of Rule XML

By understanding the rule elements, and examining the sample rules included in Quest One Identity Manager Data Governance Edition, you can write your own rules, or edit existing ones.

The rule has one or more <if> sub-elements, each of which represents a condition to be evaluated and an action to be applied if the condition evaluates to true. The rules engine evaluates <if> blocks in order; when it discovers an <if> whose condition returns true, no further <if> blocks are evaluated against that content.

<if>

<if> represents a condition to be evaluated against some content, and an action to be taken if the condition evaluates to true.

The <if> must contain exactly two sub-elements. The first is the condition to be evaluated; the second is the action to be taken. The following condition elements are supported:<and/>
<find/>
<true/>
<false/>The following action elements are supported:<match/>
<stop/>

<and>

<and> represents a compound condition. It has one or more sub-elements, each of which is itself a condition.

The <and> evaluates to true if every one of its sub-elements evaluates to true. Overlaps are not allowed. If one sub-element evaluates to false, then no further sub-elements are evaluated. The <and> element may contain several sub-elements. In this case, the rule evaluates to true only if the same number of non-overlapped text entities are found as there are elements (if there are more, they are disregarded).

The matches-within attribute is optional. It can be used when an <and> condition has only one sub-element nested <and> conditions included. If specified, the mincount attribute must be specified. If present, the number of characters between adjacent matches of the sub-element cannot exceed the specified number of characters. If the attribute is not specified, then there are no restrictions on the relative positions of matched text entities. In the above example, the outer <and> condition will only evaluate to true if the compound “name/address” value is found a minimum of 5 times in the document with each match being no more than 50 characters from the next.

The mincount attribute is optional if matches-within is not present. If provided, the <and> evaluates to true if the combined match is found at least that many times in the text. If the attribute is not provided, a default value of 1 per sub-element is assumed.

The parts-within attribute is optional. It is only used when an <and> condition has more than one sub-element. If present, the number of characters between adjacent matched sub-elements cannot exceed the specified number of characters. If the attribute is not specified, then there are no restrictions on the relative positions of matched text entities. In the above example, the inner <and> condition will only evaluate to true if a “name” value is found within 10 characters of an “address” value.

The ordered attribute is optional. It can only be specified if there is more than one nested condition that can produce matches (<and> or <find>). If present and its value true, then text entities referenced within the conditional must follow in the same order as specified in the rule. If the attribute is not specified or false, then there are no restrictions on the relative positions of matched text entities.

<find>

<find> invokes a text extractor. You can use any text extractor available in your system. For example,

<if>
<find id="Dell/Extractors.Person.Name" />
<match strength="1" />
</if>

The id attribute is required.

The rules engine returns detailed information about the number of matches, and the position of each match within the text. If the referenced entity does not exist, there is no match.

The mincount attribute is optional. If provided, then the <find> evaluates to true if the named text extractor found at least that many matches in the text. If the attribute is not provided, a default value of 1 is assumed.

<true>

<true> is a condition that always evaluates to true. It is useful in expressing an “otherwise” action.

<false>

<false> is a condition that always evaluates to false. It may be used to disable an <if> during development and testing of a rule.

<match>

<match> is an action that causes a rule to match the content being processed. The strength attribute is optional. It provides the strength of match for the content being processed. If the attribute is missing, a value of one is assumed. Match strength works with the rule weight on a category, and the category threshold to determine if there is a potential categorization. For more information, see How Rules Affect Categorization.

<stop>

<stop> is an action that causes the rule to fail. No further conditions or actions are evaluated for the current text fragment.

Viewing XML Rules

To view a list of all XML rules in the classification system with PowerShell

  1. Run the Get-QXmlRules command with the following mandatory parameter:
    1. ServerAddress
      Provide the name of the computer hosting the Data Governance server, and the port. Enter in the form computername:port number. The default port is 8723.

To view the parameters of a specific rule with PowerShell

  1. Make sure you know the ID of the rule you want.
    You can use the Get-QXmlRules command for a full listing of all rules in the system.
  2. Run the Get-QXmlRule command with the following mandatory parameter:
    1. ServerAddress
      Provide the name of the computer hosting the Data Governance server, and the port. Enter in the form computername:port number. The default port is 8723.
    2. Id

Editing a Rule

Remember that rules and text extractors can be shared across multiple taxonomies, so you should not change them in isolation without understand where your changes may have an effect.

Because a single rule can be associated with numerous categories, they should be edited with care. You can view all associated categories by selecting the Associated tab when editing a rule.

To edit a rule using the web portal

  1. Select Governed Data | Categorization Manager | Rules.
  2. Select the required rule, and click Edit.
  3. If required, edit the name and description, and save your changes.
  4. Select the Definition tab and update the rule as required through the XML editor. For details on the options, see Writing XML Rules.
  5. Save your changes.
  6. If required, select the General tab, and click Enable to add the rule to the classification system or Disable to stop it from processing against resources.

To edit a rule with PowerShell

  1. Make sure you know the ID of the rule you want.
    You can use the Get-QXmlRules command for a full listing of all rules in the system.
  2. Run the Set-QXmlRule command with the following mandatory parameters:
    1. ServerAddress
      Provide the name of the computer hosting the Data Governance server, and the port. Enter in the form computername:port number. The default port is 8723.
    2. Id
  3. Modify any of the following optional parameters:
    1. Name
    2. XmlFile
      When you import a new rule XML file, the old rule is overwritten with the contents of this file.
    3. Description
    4. IsEnabled
      A rule must be set to $true in order to be used in categorization.

Associating Rules to Categories and Applying Rule Weights

Rules do not affect categorization until they are associated with a category and given a weight. The default category weight is one. Make sure you understand the impact you expect the rule to have on potential categorization. For more information see How Rules Affect Categorization.

You can associate a rule when you create it or by editing existing categories. For details, see Creating a Rule.

To associate rules with a category and apply the rule weight using the web portal

  1. Select Governed Data | Categorization Manager | Taxonomies.
  2. Locate the row containing the taxonomy with the desired category, and click Edit.
  3. Select the category to edit.
  4. Click Modify Rule Associations.
  5. Click the Associate new rule, select the rule to associate, and set the required weight.

    -OR-

    Select the rule and click Remove to remove it.

    -OR-

    Select the rules and click Edit Weight to adjust the weight.
  6. Save your changes.

To associate a rule with a category and apply the rule weight with PowerShell

  1. Make sure you know the ID of the category.
    For more information, see Finding a Taxonomy, Category, or Extractor ID using PowerShell.
  2. Make sure you know the ID of the rule.
    For more information, see Managing Rules in the Classification System.
  3. Run the Add-QRuleToCategory command with the following mandatory parameters:
    1. ServerAddress
      Provide the name of the computer hosting the Data Governance server, and the port. Enter in the form computername:port number. The default port is 8723.
    2. RuleId
    3. CategoryId
  4. If you want to change the weight, use the optional parameter -Weight.
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating