User`s guide
25 Create Model Advisor Checks
25-22
Data File for Configuration Parameter Check
You use an XML data file to create a configuration parameter check. To create the data
file, you can use Advisor.authoring.generateConfigurationParameterDataFile
or manually create the file yourself. The data file contains tagging that specifies check
behavior. Each model configuration parameter specified in the data file is a subcheck.
The structure for the data file is as follows:
<?xml version="1.0" encoding="utf-8"?>
<customcheck xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="http://www.w3schools.com
MySchema.xsd">
<messages>
<Description>Description of check</Description>
<PassMessage>Pass message</PassMessage>
<FailMessage>Fail message</FailMessage>
<RecommendedActions>Recommended action</RecommendedActions>
</messages>
<checkdata>
<!--Command-line name of configuration parameter-->
<PositiveModelParameterConstraint>
<parameter>Command-line name of configuration parameter</parameter>
<value>Value that you want configuration parameter to have</value>
<fixvalue>Specify value for a fix action</fixvalue>
<dependson>ID of configuration parameter subcheck that must pass
before this subcheck runs</value>
</PositiveModelParameterConstraint>
<!-- Command-line name of configuration parameter-->
<NegativeModelParameterConstraint>
<parameter>Command-line name of configuration parameter</parameter>
<value>Value that you do not want configuration parameter to have</value>
<fixvalue>Specify value for a fix action</fixvalue>
<dependson>ID of configuration parameter subcheck that must pass
before this subcheck runs</value>
</NegativeModelParameterConstraint>
</checkdata>
</customcheck>
The <messages> tagging is optional.
Advisor.authoring.generateConfigurationParameterDataFile does not
generate <messages> tagging. The <messages> tagging contains:
• <Description> - Description of the check. Displayed in Model Advisor window.
Optional.
• <PassMessage> - Pass message displayed in Model Advisor window. Optional.
• <FailMessage> - Fail message displayed in Model Advisor window. Optional.
• <RecommendedActions> - Recommended actions displayed in Model Advisor window
when check does not pass. Optional.