Running the Analyzer utility to identify non-permitted customizations
If you are a BMC Helix user, before upgrading AR System, you can run the Analyzer utility to identify non-permitted customizations. This utility helps identify the customization that is not supported by AR System. A performance issue might occur if you a customization that is not supported by AR System.
Before running the Analyzer utility, ensure the following:
- The Java Home is set.
- The Java heap size is set as per your requirements. We recommend to have minimum 1 GB or maximum 2 GB as Java heap size. you can change the Java heap size from the Analyzer.bat file located in the analyzer folder.
The Analyzer utility and options
Copy the Analyzer utility on your computer. The Analyzer utility (analyzer.bat) is available in the analyzer folder. You can also run the Analyzer utility from a remote server.
The following table describes the command-line options in the Analyzer utility. You can use the options in any order in the command:
Option | Description |
|---|---|
-u | Name that identifies the user account for the AR System server. |
-p | Password for the user account. If you have a blank password, you can ignore this option. |
-x | Name of the server to connect to. |
-w | Name of external authentication string or Microsoft Windows domain. |
-portnum | TCP port number to connect to. If the port number is unknown, use -portnum 0. |
-o | The CSV file path for obtaining the results from the Analyzer utility. |
-excludeIgnoredResults | Reports the results that are marked as ignored. |
The following table describes the nested options in the Analyzer utility:
Option | Description |
|---|---|
-i | Definition file path for specifying objects to be analyzed. |
-a | Name of an active link. |
-A | All active links name. |
-f | Name of a form. |
-F | All form names. |
-n | Name of an application. |
-N | All application names. |
-q | Name of an escalation. |
-Q | All escalation names. |
-t | Name of a filter. |
-T | All filter names. |
-r | Include related objects for analysis. The valid options are as follows:
|
-c | The XML configuration file path for setting advance options. |
-og | Overlay group. Set value to 1. |
The following table describes the rules that are run by the Analyzer utility:
Rule Name | Severity | Description | Solution |
|---|---|---|---|
CMDBCustomizationsRule | Medium | This rule applies when you create an overlay of a CMDB form. | Do not create overlay of CMDB forms. |
CustomFieldOrViewIDRangeRule | High | This rule applies when you use BMC reserve range for Field ID or View ID. | Use the Field ID range reserved for customers. For information about reserved field ranges, see Reserved-field-ranges. |
NonBMCUserModificationsRule | Low | This rule applies when an unauthorized user tries to modify an object. | Only a valid user should modify the objects. The list of valid user is specified in the SaasAnalyzerRules.xml |
FullViewOverlayRule | High | This rule applies when you add all fields to a view overlay. | You must add only the fields that you want to customize and relocate. |
SelectionItemNumberRule: | Medium | This rule applies when the Selection ID for overlay selection fields is not an odd number. | Use odd number for Selection ID field. |
UnqualifiedEscalationsRule | Medium | This rule applies when an escalation does not have a qualification. | Add a qualification for every escalation. |
DirectSQLRule | Medium | This rule applies when any overlay or a custom object has a direct SQL action. | Do not add direct SQL action to an overlay or custom object. |
RunProcessActionRule | Medium | This rule applies when the overlay or custom object has RunProcessAction. | Do not run any operating system command or binaries through RunProcessAction. |
UnqualifiedSetPushFieldsRule | Medium | This rule applies when any overlay or custom object has a qualification. | Add a qualification to a Push field action. |