General Tab

The General tab contains the following options:

• Rule ID —Unique identifier for the rule . Choose an identifier that is unique to the rules on your computer and unique to the rules on computers to which you might deploy the rule. National Instruments recommends that you add a company name as a prefix to the rule ID to avoid potential conflicts with other custom rule IDs. The TestStand Sequence Analyzer shows the rule ID only in the Edit Rule dialog box and on the Rules tab of the Configure Sequence Analyzer Available Rules dialog box.
• Category —Category to which the rule belongs. The Rules pane of the Current Sequence Analyzer Project window in the TestStand Sequence Editor and the Rules tab of the stand-alone TestStand Sequence Analyzer application group rules by categories. You can select a built-in category or create a custom category. Specify subcategories by separating category names with a period. For example, the category NI.General specifies a General subcategory within the top-level NI category. Add strings to the ANALYZER_RULE_CATEGORIES section in a string resource file to localize category names.
• Severity —Default severity level of the rule. Use this ring control to specify the severity level of a custom rule on the Rules pane of the Current Sequence Analyzer Project window and on the Rules tab of the sequence analyzer application. Sequence analyzer projects store the severity level of all rules. When you change the severity level of a rule on the Rules pane of the Current Sequence Analyzer Project window and on the Rules tab of the sequence analyzer application, the severity level changes to bold text to indicate that the severity level of the rule is a non-default value for the project. In general, use the Information severity level for statistical or descriptive information. When the sequence analyzer generates a message with an Error severity level before you execute a sequence in the TestStand Sequence Editor , the sequence editor launches a dialog box to prompt you to view the errors.
• Name —Short descriptive name that appears on the Rules pane of the Current Sequence Analyzer Project window, on the Analysis Results pane, and on the Rules tab and Messages tab of the sequence analyzer application.
• Description —Detailed description of the rule that appears on the Rules pane of the Current Sequence Analyzer Project window, on the Analysis Results pane, and on the Rules tab and Messages tab of the sequence analyzer application. Include a description of the issue that generates a message, the motivation for the rule, and an explanation of how to fix the issue. Including information about the setting values prevents users from having to launch a dialog box to review the settings and includes the settings used for analysis in sequence analyzer reports you save. When you add the text %( SettingName ) to this control, the sequence analyzer replaces each instance of the string %( SettingName ) in the rule description with the value for the setting named SettingName.

See Also

Analysis Results Pane

Configure Sequence Analyzer Available Rules dialog box

Creating Custom Rules

Current Sequence Analyzer Project Window

TestStand Sequence Analyzer Application