Documentation Pane
When you select an individual rule and certain categories from the list in the Rule Categories pane, the Documentation pane populates with documentation for the selected rule. For categories, the information is usually descriptive, but the individual rules documentation has the database names for the rule, its attributes, and valid values. If there are related rules, the related rule will be included and will link to the documentation content for that rule.
Example
If you select the Broadcast related rules category, the Documentation pane populates with:
These rules control how calls and events get broadcast, including which calls appear in the viewer.
If you select the Broadcast Clues rule, the Documentation pane will update with documentation for broadcastClues (the database name). Part of the broadcastClues description includes a link to the documentation page for the related broadcastIncidents rule, which broadcastClues is normally used with.
The friendly names in the Currently Configured Rules pane correspond to the database names as follows:
Friendly Name
Database Name
Database Description
Set Name
set_name
A name used to identify what set a rule should belong to.
Incident Type
incident_type
See each individual rule description for valid value for this column.
Rule Name
rule_name
The name of the rule.
Rule Value 1
rule_value_1
A character string. See each individual rule description for valid and default values, if applicable.
Rule Value 2
rule_value_2
An integer value. See each individual rule description for valid and default values, if applicable.
NCG CLS
ncg_cls
Used in conjunction with the ncg_idx value to narrow the application of a rule to a specific control zone.
NCG Index
ncg_idx
Used in conjunction with the ncg_cls value to narrow the application of a rule to a specific control zone.
Zone
N/A
The name of the control zone as derived from NCG CLS and NCG Index (as queried from the control_zones table).
Rule Value Integer 1
rule_value_integer_1
An integer value. See each individual rule description for valid and default values.
Rule Value Integer 2
rule_value_integer_2
An integer value. See each individual rule description for valid and default values.
Rule Value Integer 3
rule_value_integer_3
An integer value. See each individual rule description for valid and default values.
Rule Value Integer 4
rule_value_integer_4
An integer value. See each individual rule description for valid and default values.
Rule Value Integer 5
rule_value_integer_5
An integer value. See each individual rule description for valid and default values, if applicable.
Active
rule_active
The active state of the rule.
Working with Rules