Versions Compared

Old Version 19

changes.mady.by.user Nathan Tolbert

Saved on

compared with

New Version 20

changes.mady.by.user Nathan Tolbert

Saved on

Key

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

...

Groups are currently unused by the analysis system. See the optional and advanced attributes instead. If groups are included in the analysis description, they are ignored.

Attributes

This element has no attributes.

Elements

NAME

REQUIRED

CARDINALITY

DESCRIPTION

<group-name>

(required)

1-many

Group to which the parameters can be associated.

Text

This element has no text.

Example

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"  phylum="string" cardinality="single" friendly-name="Result Name" />

...

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

Attributes

NAME

DEFAULT VALUE

DESCRIPTION

group

(unused)

a string which must match a member of <groups> above --currently unused

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

advanced

false

A value of true denotes that this is an advanced parameter

Elements

NAME

REQUIRED

CARDINALITY

DESCRIPTION

<types>

(optional)

0-many

A list of types that are accepted by this <parameter>.

Text

This element has no text.

Example

Code Block
<parameter group="Required" format="dataset" cardinality="single" key="functionalityTable" friendly-name="Functionality Table">
    <types>
        <type>bridgeFunctionality</type>
    </types>
</parameter>

...

  • base-dataset-key - The key of the <parameter> which is the base for this new Dataset
  • schema - The id of the schema that this Dataset implements.

Attributes

NAME

DEFAULT VALUE

DESCRIPTION

format

(required)

the format of the parameter, currently supports string or dataset

key

(required)

name of property for which value should be added. No spaces allowed.

friendly-name

{required)

name of property for which value should be added

Elements

NAME

REQUIRED

CARDINALITY

DESCRIPTION

<property>

(optional)

0-many

a ncsa.tools.common.Property object. Additional properties required by the <output>.

Text

This element has no text.

Example

Code Block
<output friendly-name="Bridge Functionality" key="bridgeFunctionality" format="dataset">
    <property name="base-dataset-key" value="bridgeDamage" />
    <property name="schema" value="ncsa.maeviz.schemas.bridgeFunctionalityResults.v1.0" />
</output>

...