ParameterDefinition element

Article
05/31/2018

Information that fully describes an assessment parameter.

Usage

<ParameterDefinition>
  child elements
</ParameterDefinition>

Attributes

There are no attributes.

Child elements

Element	Description
BenchmarkValue	Contains a benchmark value.
CommandLineFormat	Describes how a parameter is formatted for the assessment command line.
Constraints	Constraints specified for a parameter's value.
DefaultValue	Contains a default value for the parameter.
Description	Provides a human-readable description about a manifest or metric.
Enumerations	Contains one or more Enumeration elements.
Flags	Contains one or more Flag elements.
Inclusion	Describes a value.
PresentWith	Describes other parameters that must be present for this parameter to be valid.
StandardType	Describes the data type of an item.

Child element sequence

(
  Description, 
  StandardType, 
  Inclusion, 
  DefaultValue, 
  BenchmarkValue, 
  Enumerations, 
  Flags, 
  PresentWith, 
  Constraints, 
  CommandLineFormat
)

Parent elements

Element	Description
ParameterDefinitions	This element holds a collection of ParameterDefinition elements.

Remarks

A parameter definition is the meta information that fully describes an assessment parameter. This information is used by AXE solutions (UX or scripts) to add, validate and otherwise manipulate parameter values.

Note that parameter definitions are separate from parameter values. Definitions are static and defined by an assessment author when an assessment is authored. Values are defined by a user (or script) using an AXE solution. Solutions can be any program that uses the AXE API s to create and run jobs. This includes UX based tools and PowerShell scripts.

The order of ParameterDefinition elements in the ParameterDefinitions elements is significant. AXE assessment authoring tools should maintain the order. The order determines how a assessment s command line is formatted (if there is one). Parameters should be put on the assessment command line in the same order as in ParameterDefinitions. This means each parameter has an implicit zero based index based on its position in the ParameterDefinitions collection.

Each of the ParameterDefinition nodes in the ParameterDefinitions collection must each have a unique programmatic name.

Element information


Can be empty	No