Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The Analysis Description file provides detailed information about the various sections of an Analysis.

A parameter element with key <outputKey>.resultName is required. This is the only way to change a resultName for a given output.

Code Block

<parameter key="mappingResult.resultName" group="Required" phylum="string" cardinality="single" friendly-name="Result Name" />

...

<output friendly-name="Mapping Result" key="mappingResult" phylum="dataset">
...

<analysis-description>

Attributes

...

Code Block
<groups>
    <group-name>Required</group-name>
</groups>

<parameter>

A parameter element with key <outputKey>.resultName is required. This is the only way to change a resultName for a given output.

Code Block

<parameter key="mappingResult.resultName" group="Required" phylum="string" cardinality="single" friendly-name="Result Name" />

...

<output friendly-name="Mapping Result" key="mappingResult" phylum="dataset">
...

Attributes

NAME

DEFAULT VALUE

DESCRIPTION

group

(required)

a string which must match a member of <groups> above

format

*

the format of whatever phylum of parameter this is.  For datasets, indicates what type of dataset (mapping, shapefile,etc)

phylum

(required)

the type of the parameter, currently supports string, dataset, or boolean

cardinality

(required)

how many of this type, currently supports single or multiple

key

(required)

name of property for which value should be added

friendly-name

{required)

name of property for which value should be added

optional

false

A value of true denotes that this parameter need not have a value

...