Working with rulesets

  • Article

 

Applies To: Forefront Identity Manager

In the BHOLD Analytics module of the Microsoft BHOLD Suite Service Pack 1 (SP1), a ruleset is a named collection of rules. You can use rulesets to group rules to make it easier to work with them as a group. Every rule must belong to a ruleset. For more information about creating and using rules, see Working with rules elsewhere in this guide.

You can create a ruleset, and you can copy a ruleset. You can also use rulesets to help you create batch reports that show the results of analysis of multiple rules.

This topic contains the following procedures:

  • Creating a ruleset

  • Saving a ruleset

  • Loading a ruleset

  • Copying a ruleset

  • Deleting or renaming a ruleset

  • Creating a batch report

All of the procedures in this topic are performed by using the BHOLD Analytics portal. To open the BHOLD Analytics portal, log on the computer where BHOLD Analytics is installed by using the root account or another account with the necessary BHOLD permissions, and then double-click the Microsoft BHOLD Suite—Analytics shortcut on the desktop. If the shortcut is not available, open a web browser and then type the following URL into the address bar:

https:// <server> : <port> /BHOLD/Analytics

where <server> is the name or IP address of the server running BHOLD Core and BHOLD Analytics, and <port> is the port number that was specified when BHOLD Core was installed.

Creating a ruleset

Before you create a rule, you should create an empty ruleset to contain it.

To create a ruleset

  1. In the BHOLD Analytics portal, under Ruleset, click New.

  2. Under Ruleset, click Save As.

  3. In the Save Ruleset dialog box, type a name for the ruleset, and then click Save.

Saving a ruleset

After adding, removing, or modifying a rule in a ruleset, you should save the ruleset to ensure that your changes are kept. For more information about creating and using rules, see Working with rules elsewhere in this guide.

Note

You cannot save a ruleset until you have used Save As to give it a name.

To save a ruleset

  • In the BHOLD Analytics portal, under Ruleset, click Save.

Loading a ruleset

You can load any previously saved ruleset. The ruleset that you load replaces the current ruleset in the BHOLD Analytics portal. Because of this, before you load a saved ruleset, you should save the current ruleset to avoid losing any changes that you have made.

To load a ruleset

  1. In the BHOLD Analytics portal, under Ruleset, click Load.

  2. In the Load Ruleset dialog box, click the ruleset you want to load, and then click Load.

Copying a ruleset

To copy a ruleset, you save the ruleset under a different name.

To copy a ruleset

  1. If you have not done so already, load the ruleset you want to copy. See Loading a ruleset for instructions.

  2. In the BHOLD Analytics portal, under Ruleset, click Save As.

  3. In the Save Ruleset dialog box, type a name for the ruleset, and then click Save.

Deleting or renaming a ruleset

To delete or rename a ruleset, you must delete or rename the ruleset XML file located in %ProgramFiles(x86)%\BHOLD\Analytics\log. For example, to rename a ruleset named User Cardinality, browse to that directory and then rename the User Cardinality.xml file.

Creating a batch report

You can create a report that incorporates the results of multiple rules in a ruleset. The report is saved in the following folder:

%ProgramFiles(86)%\BHOLD\Analytics\log\<ruleset>.xml.reports

where <ruleset> is the name of the ruleset containing the rules that the reports were generated from.

The report for each rule is located in its own folder; the folder name is an arbitrary number used internally by BHOLD to identify the rule. Each folder contains one or more consecutively numbered report files, depending on how many times a report has been run for the rule. In addition to the rule-specific folders, the <ruleset>.xml.reports folder contains a compressed (zipped) folder containing the most recent report for each rule. When you create the batch report, you can download a copy of the compressed folder to a location that you choose.

Note

If the analysis of a rule does not produce any noncompliant records, BHOLD Analytics does not create a report for that rule.

To create a batch report

  1. In the BHOLD Analytics portal, in the rules list, do one of the following:

    • Select the check box next to each rule that you want to produce a report for.

    • Select the All check box to select all of the rules in the ruleset.

  2. In the left pane, click Batch Report.

  3. To download a compressed folder containing the batch report, in the Batch Result message box, click Download; otherwise click OK.

See also