AssessmentManifest element

Article
10/13/2013

The root node of the assessment.

Usage

<AssessmentManifest>
  child elements
</AssessmentManifest>

Attributes

There are no attributes.

Child elements

Element	Description
Description	This node intended to provide descriptive information about a manifest that is interesting to a person.
Execution	This node describes how AXE executes an assessment.
MetricDefinitions	This element contains a collection of MetricDefinition elements.
MetricThresholds	This node contains one or more metric thresholds.
MinimumAxeVersionRequired	This node describes the minimum AXE version required for this assessment.
ParameterDefinitions	A collection of ParameterDefinition elements.
Properties	This node describes properties.
SolutionData	This node contains XML that is specific to a solution or assessment.
VersionedId	The unique identity of the assessment.

Child element sequence

(
  VersionedId, 
  MinimumAxeVersionRequired, 
  Description, 
  Properties, 
  ParameterDefinitions, 
  MetricDefinitions, 
  MetricThresholds, 
  Execution, 
  SolutionData
)

Parent elements

Element	Description
AssessmentManifests	Contains one or more AssessmentManifest elements.

AssessmentManifests

Contains one or more AssessmentManifest elements.

Remarks

When a Job manifest is fixed the assessment management object model will marshal the entire assessment manifest into the job manifest.

Examples

Here is an example of a minimal manifest. This assessment “wraps” a simple and existing test EXE named AppRKVdt.exe which tests an applications register key values for consistency. This is an old test and has been around a long time. It uses the common convention of return a process exit code of zero for success, and a non-zero value for failure.

<AssessmentManifest>
  <Id>
    <Guid>{73F635A4-0F2A-44e1-A7B7-927A17088561}</Guid>
    <Version>
      <Major>1</Major> <Minor>0</Minor> <Build>0</Build> <Revision>0</Revision>
    </Version>
  </Id>

  <MinimumAxeVersionRequired>
    <Major>1</Major> <Minor>0</Minor> <Build>7751</Build> <Revision>1000</Revision>
  </MinimumAxeVersionRequired>

  <Description>
    <ProgrammaticName>CheckAppRegKeyConsistency</ProgrammaticName>
    <Name>Check Registry Key Consistency</Name>
    <ToolTip>Checks the application registry key and ensures all the 
             values are there are valid.</ToolTip>
  </Description>

  <Meta>
    <ExitValueMeaning> <ZeroIsSuccess/> </ExitValueMeaning>
  </Meta>

  <Execution>
    <CreateProcess>
      <ApplicationName>AppRKVdt.exe >%Results%\  AppRKVdt.txt</ApplicationName>
    </CreateProcess>
  </Execution>
</AssessmentManifest>

Here is what the above manifest does:

Gives the legacy test an Identity and version that can be used by a test harness system like the WLK or the Ecosystem suite.
Specifies the minimum version of AXE needed to interpret this manifest and run the test.
Gives the assessment a programmatic name (that is never localized) that test harness can use to lookup this information in collections it may maintain.
Gives the exe a human readable name and short “tool tip” description.
Tells AXE that an exit value of zero means the test was successful and that any other value means failure.
Instructs AXE to use the Win32 API CreateProcess() to execute the EXE and put the console output in the results directory in the AppRKVdt.txt file.

Element information

Can be empty

Share via