Page tree
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Current »

Input

Root

NameTypeAllowed ValuesDescription
idString
The identifier of the input
nameString
The name of the input (human readable)
descriptionString
The description of the input (human readable)
obligationBoolean

true

false

This is true if the input is mandatory, false otherwise
hasDefaultBoolean

true

false

This is true if the input has a default value, false otherwise
inputTypeString

individual

array

This property defines if this input is a single object (individual) or a list of objects (array).
valueTypeString

value

keyValue

This property defines if the value for this input is expected to be a value or a key-value pair (encoded as key=value).
valueKeyJSON Object
This property describes the key object of inputs whose valueType is 'keyValue’.
valueSchemaString

url

bbox

This property defines the schema of the value, i.e. how the value is interpreted.

When the value schema is url, the value is expected to be valid 'ready to use’ URL.

When the value schema is bbox, the value is expected to be a bounding box in the form west,south,east,north.

When the schema is one of bbox, number_parameter, string_parameter then the input object is saved as a model parameter (see here).

valueString
The value of this input. This property is taken into account only if this input has inputType=individual.
valueArrayString Array
The array of values of this input. This property is taken into account only if this input has inputType=array.
valueKeyArrayJSON Object Array
The array of valid keys for setting the values in valueArray of this input in case the valueType is 'keyValue'. The objects of this array must of type valueKey.
valueArrayInterpretationString

replace

extend

This property defines the interpretation of the provided valueArray for an input of type array. When this property is set to extend, the list in valueArray is used to extend the default list for this input. When this property is set to replace, the list in valueArray is used to replace the default list for this input. When this property is not set, the extend strategy is applied.
targetString
The target path where to store this input
defaultValueString
The default value for this input (this is used only if valueType is individual)
defaultValueArrayString Array
The default value array for this input (this is used only if valueType is array)


ValueKey

NameTypeAllowed ValuesDescription
keyString
The key
labelString
A human-readable label for this key

Model Parameters

Model Parameters are saved in a json file called 

vlabparams.json

The file is saved in the home directory of the execution. I.e. assuming your model is triggered by a run.sh defined by the following

{
"repoPath": "run.sh",
"targetPath": "run.sh",
"pathType": "FILE"
}


you can print the vlabparams.json by adding the following line at the beginning of the run.sh

less vlabparams.json

An example of vlabparams.json is the following:

{
"bboxid": "-10.1,-5.0,20.0,30.4",
"param1Numericid": 2,
"param2Numericid": 3.9,
"param2Stringid": "example"
}


It is up to model developers to read and parse the vlabparams.json file.

Output

Root

NameTypeAllowed ValuesDescription
idString
The identifier of the output
nameString
The name of the output (human readable)
descriptionString
The description of the output (human readable)
outputTypeString

individual

array

This property defines if this output is a single object (individual) or a list of objects (array).
valueTypeString

value

keyValue

This property defines if the value for this output is expected to be a value or a key-value pair (encoded as key=value).
valueSchemaString

url

bbox

wms

This property defines the schema of the value, i.e. how the value is interpreted.

When the value schema is url, the value is expected to be valid 'ready to use’ URL.

When the value schema is bbox, the value is expected to be a bounding box in the form west,south,east,north.

When the value schema is wms, the value is expected to be JSON Object representing a wms layer.

valueString
The value of this input. This property is taken into account only if this output has outputType=individual.
valueArrayString Array
The array of values of this input. This property is taken into account only if this output has outputType=array.
targetString
The target path where to this output is stored


WMS Layer

NameTypeAllowed ValuesDescription
urlString
The base URL of the WMS
nameString
The layer name to be displayed
protocolString
The protocol, including the version. E.g. urn:ogc:serviceType:WebMapService:1.1.1:HTTP
  • No labels