VI Analyzer Configuration File - Revision history

Logmanoriginal: Clarify formats, clarify example, remove stub label

2024-08-16T08:11:18Z

Clarify formats, clarify example, remove stub label

← Older revision		Revision as of 08:11, 16 August 2024
Line 1:		Line 1:
	~~{{stub}}~~
	The '''VI Analyzer Configuration File''' contains the configuration and settings for a [[VI Analyzer Task]], including the list of items to analyze, the tests to perform, and test configurations. It can be created manually, from the [[Analyze VIs]] command, or programmatically with the [[LabVIEW VI Analyzer Toolkit]] add-on.		The '''VI Analyzer Configuration File''' contains the configuration and settings for a [[VI Analyzer Task]], including the list of items to analyze, the tests to perform, and test configurations. It can be created manually, from the [[Analyze VIs]] command, or programmatically with the [[LabVIEW VI Analyzer Toolkit]] add-on.

Line 6:		Line 5:

	===Legacy format (.cfg)===		===Legacy format (.cfg)===
	The legacy configuration file format was used until [[VI Analyzer 2017]]. In [[VI Analyzer 2018]] and later, legacy configuration files can still be loaded but are read-only.		The legacy configuration file format is a proprietary binary format that was used until [[VI Analyzer 2017]]. In [[VI Analyzer 2018]] and later, legacy configuration files can still be loaded but are read-only and can only be saved in the XML-based format.

	===XML-based format (.viancfg)===		===XML-based format (.viancfg)===
	The XML-based configuration file format was first introduced in [[VI Analyzer 2018]].		The XML-based configuration file format was first introduced in [[VI Analyzer 2018]] and provides the same functionality as the legacy format while being easier to maintain and compare in a [[wikipedia:version control system\|version control system]].

	'''Example'''		'''Example''' (comments added for explanation)
	<syntaxhighlight lang="xml">		<syntaxhighlight lang="xml">
	<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>		<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
	<Config>		<Config>
	<FileFormatVersion>1</FileFormatVersion>		<FileFormatVersion>1</FileFormatVersion>
	<AnalyzeProject>FALSE</AnalyzeProject>		<AnalyzeProject>FALSE</AnalyzeProject><!-- Indicates whether the configuration file applies to the project specified in <ProjectPath /> (TRUE) or only the items listed under <ItemsToAnalyze /> (FALSE). -->
	<ProjectPath>""</ProjectPath>		<ProjectPath>""</ProjectPath>
	<TargetIndex>0</TargetIndex>		<TargetIndex>0</TargetIndex><!-- Index of the project target in the project specified in <ProjectPath /> -->
	<ItemsToAnalyze>		<ItemsToAnalyze>
	<Item>		<Item>
	<Path></Path>		<Path></Path><!-- Absolute or relative path to an item, LLB, or folder. -->
	<Removed>FALSE</Removed>		<Removed>FALSE</Removed><!-- Indicates whether <Path /> is removed from the analysis. -->
	</Item>		</Item>
	</ItemsToAnalyze>		</ItemsToAnalyze>
	<TestConfigData>		<TestConfigData>
	<Test>		<Test>
	<Name>"Arrays and Strings in Loops"</Name>		<Name>"Arrays and Strings in Loops"</Name>
	<Ranking>0</Ranking>		<Ranking>0</Ranking>
	<MaxFailures>5</MaxFailures>		<MaxFailures>5</MaxFailures><!-- Maximum number of failures to detect in an item. The analyzer skips searching when the maximum number is reached and moves on to the next test. -->
	<BasePath>"LabVIEW"</BasePath>		<BasePath>"LabVIEW"</BasePath><!-- Base path for <RelativePath />. This can be an absolute path or a symbolic path. -->
	<RelativePath>"project\\_VI Analyzer\\_tests\\Block Diagram\\Performance\\Arrays and Strings in Loops.llb"</RelativePath>		<RelativePath>"project\\_VI Analyzer\\_tests\\Block Diagram\\Performance\\Arrays and Strings in Loops.llb"</RelativePath><!-- Relative path starting from <BasePath />. -->
	<Selected>TRUE</Selected>		<Selected>TRUE</Selected><!-- Indicates whether the test is enabled or disabled. -->
	<Controls>		<Controls><!-- List of additional properties for the test. Available options depend on the kind of test. -->
	<Control>		<Control>
	<Name>"Functions"</Name>		<Name>"Functions"</Name>
	<Type>"Int"</Type>		<Type>"Int"</Type>
	<Value>1</Value>		<Value>1</Value>
	</Control>		</Control>
	</Controls>		</Controls>
	</Test>		</Test>
	</TestConfigData>		</TestConfigData>
	<ExclusionData>		<ExclusionData>
	<Item>		<Item>
	<Path></Path>		<Path></Path><!-- Path to the item that the exclusion applies. -->
	<ExcludedTests>"Arrays and Strings in Loops"</ExcludedTests>		<ExcludedTests>"Arrays and Strings in Loops"</ExcludedTests>
	</Item>		</Item>
	</ExclusionData>		</ExclusionData>
	</Config>		</Config>
	</syntaxhighlight>		</syntaxhighlight>
Line 56:		Line 55:

	==External links==		==External links==
	*[https://forums.ni.com/t5/VI-Analyzer-Enthusiasts/VI-Analyzer-CFG-Exporter/ta-p/3507591 VI Analyzer CFG Exporter]		*[https://forums.ni.com/t5/VI-Analyzer-Enthusiasts/VI-Analyzer-CFG-Exporter/ta-p/3507591 VI Analyzer CFG Exporter (VI Analyzer Enthusiasts Documents)]
			*[https://forums.ni.com/t5/VI-Analyzer-Enthusiasts/CFG-Files-Diff-Tool/ta-p/3625989 CFG Files Diff Tool (VI Analyzer Enthusiasts Documents)]

	[[Category:VI Analyzer]]		[[Category:VI Analyzer]]
	[[Category:LabVIEW VI Analyzer Toolkit]]		[[Category:LabVIEW VI Analyzer Toolkit]]

Logmanoriginal: Logmanoriginal moved page Configuration file (VI Analyzer) to VI Analyzer Configuration File: Use the natual name

2024-08-16T07:40:38Z

Logmanoriginal moved page Configuration file (VI Analyzer) to VI Analyzer Configuration File: Use the natual name

← Older revision	Revision as of 07:40, 16 August 2024
(No difference)

Logmanoriginal: Created page with "{{stub}} The '''VI Analyzer Configuration File''' contains the configuration and settings for a VI Analyzer Task, including the list of items to analyze, the tests to perf..."

2024-08-14T13:16:20Z

Created page with "{{stub}} The '''VI Analyzer Configuration File''' contains the configuration and settings for a VI Analyzer Task, including the list of items to analyze, the tests to perf..."

New page

{{stub}}
The '''VI Analyzer Configuration File''' contains the configuration and settings for a [[VI Analyzer Task]], including the list of items to analyze, the tests to perform, and test configurations. It can be created manually, from the [[Analyze VIs]] command, or programmatically with the [[LabVIEW VI Analyzer Toolkit]] add-on.

==File format==
VI Analyzer supports two configuration file formats. The legacy format (.cfg), and the [[wikipedia:XML|XML]]-based format (.viancfg).

===Legacy format (.cfg)===
The legacy configuration file format was used until [[VI Analyzer 2017]]. In [[VI Analyzer 2018]] and later, legacy configuration files can still be loaded but are read-only.

===XML-based format (.viancfg)===
The XML-based configuration file format was first introduced in [[VI Analyzer 2018]].

'''Example'''
<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<Config>
<FileFormatVersion>1</FileFormatVersion>
<AnalyzeProject>FALSE</AnalyzeProject>
<ProjectPath>""</ProjectPath>
<TargetIndex>0</TargetIndex>
<ItemsToAnalyze>
<Item>
<Path></Path>
<Removed>FALSE</Removed>
</Item>
</ItemsToAnalyze>
<TestConfigData>
<Test>
<Name>"Arrays and Strings in Loops"</Name>
<Ranking>0</Ranking>
<MaxFailures>5</MaxFailures>
<BasePath>"LabVIEW"</BasePath>
<RelativePath>"project\\_VI Analyzer\\_tests\\Block Diagram\\Performance\\Arrays and Strings in Loops.llb"</RelativePath>
<Selected>TRUE</Selected>
<Controls>
<Control>
<Name>"Functions"</Name>
<Type>"Int"</Type>
<Value>1</Value>
</Control>
</Controls>
</Test>
</TestConfigData>
<ExclusionData>
<Item>
<Path></Path>
<ExcludedTests>"Arrays and Strings in Loops"</ExcludedTests>
</Item>
</ExclusionData>
</Config>
</syntaxhighlight>

==See also==
*[[VI Analyzer]]
*[[LabVIEW VI Analyzer Toolkit]]

==External links==
*[https://forums.ni.com/t5/VI-Analyzer-Enthusiasts/VI-Analyzer-CFG-Exporter/ta-p/3507591 VI Analyzer CFG Exporter]

[[Category:VI Analyzer]]
[[Category:LabVIEW VI Analyzer Toolkit]]