Diagnostic parameters

---

lang: en

Language: English · Русский

Property	Type	Description	Example
Type	string	The rule type in the configuration file: custom, collision, parameter or builtIn. Selected when the rule is loaded.	custom
Code	string	A unique diagnostic identifier in the format [Prefix][Number]. The prefix indicates the diagnostic's category.	SHRD001
Description	string	A brief description of what the diagnostic checks.	Checks families for usage in the document.
MessageFormat	string	The message template shown to the user. Supports placeholders in curly braces { } for substituting values at runtime.	Element with name [['{elementName}'
DefaultSeverity	[[DiagnosticSeverity	Diagnostic severity]]	The severity level declared in code or in the rule; the user can change it in diagnostics.config.yaml or in the Diagnostics pane.
IsActive	bool	Whether the diagnostic is enabled by default. If false, it does not run until the user explicitly activates it.	true
IsHidden	bool	Whether the diagnostic is hidden from the panes, the run list and the reports and does not run. Stronger than IsActive. Defaults to false.	false
IsObsolete	bool	Whether the diagnostic is marked as obsolete. Obsolete diagnostics may be removed in future versions.	false
ObsoleteDescription	string	An explanation for the obsolescence. Contains information about a replacement or the reason for removal. Empty if the diagnostic is still relevant.	Use SHRD003 instead of this check.
Tags	string[]	Free-text tags used to find the diagnostic in the panes and shown in the reports. The matching ignores case. A rule states the document kinds it applies to with the ordinary tags Project and Family. Besides those tags, the product adds its own reserved system tags, which are always English and cannot be set from a rule. See Diagnostic tags for the full list and how the tag list is built.	["MEP", "Systems", "Project"]
Visualizations	{ Name, Steps[] }[]	Named visualization pipelines available for an element diagnostic. See Visualization pipelines.	[{ Name: Locate, Steps: [{ Type: Show }] }]